源码编译安装 yosys 在 ubuntu 上

1. 安装依赖1.1. 安装常用依赖$sudoapt-getinstallgawkgitmakepython3 lld bison clang flex\libffi-dev libfl-dev libreadline-dev pkg-config tcl-dev zlib1g-dev\graphviz xdot1.2. 安装 gtestsudoaptinstalllibgtest-dev libgmock-dev2. 编译 yosys下载源码$gitclone https://github.com/YosysHQ/yosys.git $cdyosys $gitcheckout v0.68 $gitsubmodule update--init2.1. 方案1 依赖使用内嵌库 -DYOSYS_USE_BUNDLED_LIBSONcd~/ex_yosys/yosysrm-rfbuild# 先确保所有内嵌子模块都拉完整了gitsubmodule update--init--recursive# 强制使用内嵌依赖跳过所有系统包查找cmake-Bbuild.--fresh\-DYOSYS_USE_BUNDLED_LIBSON\-DCMAKE_BUILD_TYPERelease cmake--buildbuild--parallel$(nproc)sudocmake--installbuild2.2. 方案2 依赖使用系统库 安装依赖2.2.1. 构建命令后边会安装依赖等依赖安装就绪后执行如下构建命令$ cmake-Bbuild.# 查看 tcl 的配置$grep-EYOSYS_WITHOUT_TCL|tcl_INCLUDE_DIRS|tcl_VERSION|tcl_FOUNDbuild/CMakeCache.txt# 输出为# YOSYS_WITHOUT_TCL:BOOLOFF# tcl_FOUND:INTERNAL1# tcl_INCLUDE_DIRS:INTERNAL/usr/include/tcl8.6;/usr/include# tcl_VERSION:INTERNAL8.6.12编译cd~/ex_yosys/tmp01/yosys# 编译cmake--buildbuild -j$(nproc)#检查./build/yosys--version#输出类似# Yosys 0.68 (git sha1 38e001a6f, GNU /usr/bin/c 11.4.0)# 安装sudocmake--installbuild# 验证 Tcl 支持yosys-h|grep-itcl# 应显示# -c, --tcl-scriptfile tcl_scriptfile# execute the commands in the TCL tcl_scriptfile# 确认版本yosys-V2.2.2. 源码装 tomlplusplusYosys 新版本的 CMake 构建系统依赖tomlplusplus库。tomlplusplus是一个 header-only 的 C17 TOML 解析库。Yosys 的 CMake 构建会通过find_package(tomlplusplus)来查找它找不到就会报tomlplusplus_DIR-NOTFOUND。以下是几种解决方法按推荐程度排序方法 1二进制安装 tomlplusplusUbuntu 24.04 可能有包但旧版本 ubuntu 通常没有。可以尝试sudoaptinstalllibtomlplusplus-dev如果没有这个包请使用方法 2。vcpkgvcpkginstalltomlplusplus方法 2手动编译安装 tomlplusplustomlplusplus使用 Meson 构建系统编译安装后会生成 CMake 配置文件Yosys 就能找到了。# 1. 下载源码gitclone https://github.com/marzer/tomlplusplus.gitcdtomlplusplusgitcheckout v3.4.0# 建议用稳定版本# 2. 编译安装需要 meson 和 ninjameson setup build meson compile-Cbuildsudomesoninstall-Cbuild安装后CMake 配置文件通常会在/usr/local/lib/cmake/tomlplusplus/或/usr/lib/cmake/tomlplusplus/方法 3手动指定 tomlplusplus 路径如果你已经安装了tomlplusplus但 CMake 找不到比如装到了非标准路径可以在配置 Yosys 时手动指定cdyosys cmake-Bbuild.\-Dtomlplusplus_DIR/usr/local/lib/cmake/tomlplusplus\-DCMAKE_BUILD_TYPERelease把路径换成你系统中tomlplusplusConfig.cmake所在的实际目录。2.2.3. 验证 tomlplusplus 的安装安装完tomlplusplus后先验证 CMake 能否找到它cmake --find-package-DNAMEtomlplusplus-DCOMPILER_IDGNU-DLANGUAGECXX-DMODEEXIST总结最推荐的方法是方法 1包管理器安装或方法 2手动编译安装。2.2.4. 编译安装 fmtcd~/ex_yosysgitclone https://github.com/fmtlib/fmt.gitcdfmtgitcheckout12.2.0# 或最新稳定版mkdirbuildcdbuild cmake..\-DCMAKE_BUILD_TYPERelease\-DFMT_TESTOFF\-DBUILD_SHARED_LIBSON cmake--build.--parallel$(nproc)sudocmake--install.3. Liberty 文件与 PPALiberty 文件是 PPAPower, Performance, Area验证的基础数据输入。没有它综合工具就无法量化评估这三个指标。1. 为什么 Liberty 文件是 PPA 验证的前提PPA 三个维度都依赖 Liberty 文件中的数据PPA 维度依赖 Liberty 中的数据说明P (Power)internal_power、leakage_power、switching_power每个单元的动态功耗和静态漏电P (Performance)cell_rise、cell_fall、setup、hold门的传播延迟和时序约束A (Area)area每个标准单元的硅面积通常以 μm² 或等价门数表示2. 在 Yosys 中验证 PPA 的流程# 1. 综合并映射到标准单元库 read -sv design.v synth -top top_module dfflibmap -liberty mycells.lib abc -liberty mycells.lib # 2. 生成 PPA 报告 # 面积报告 stat -liberty mycells.lib # 时序报告需要额外的 SDC 约束文件 # Yosys 本身时序分析能力有限通常导出到 OpenSTA write_verilog netlist.v3.stat -liberty输出示例 top_module Number of wires: 123 Number of cells: 89 mylib_INV_X1 23 mylib_NAND2_X1 15 mylib_NOR2_X1 12 mylib_DFF_X1 39 Estimated area: 156.3 -- 来自 Liberty 中各 cell 的 area 字段累加4. 仅有 Liberty 文件够吗不够。完整的 PPA 验证还需要文件作用来源Liberty (.lib)标准单元电气/时序/功耗特性晶圆厂或开源 PDKSDC 约束定义时钟频率、输入/输出延迟、虚假路径设计者编写SPEF/DSPF互连线 RC 寄生参数后布局布线提取工具如 OpenROAD、MagicVCD/SAIF实际开关活动率用于动态功耗仿真器如 Verilator、Icarus5. 各阶段的 PPA 精度阶段工具链面积精度时序精度功耗精度RTL 综合后Yosys Liberty✅ 准确已知 cell area⚠️ 估算无互连线延迟⚠️ 估算无开关活动布局后OpenROAD / OpenLane✅ 准确⚠️ 较准有线载模型⚠️ 较准布线后OpenROAD SPEF✅ 准确✅ 准确含寄生参数✅ 准确含 SAIF6. 如果没有 Liberty 文件会怎样Yosys 默认使用内部通用单元库$lut、$dff、$and等此时Areastat只能报告逻辑门数量无法换算为实际硅面积Performance无法计算真实延迟只能做逻辑级数估算Power完全无法评估# 没有 Liberty 文件时 stat # 输出 # Number of cells: 100 # $and: 30 # $or: 20 # $dff: 50 # 但没有面积、延迟、功耗数据7. 开源 PPA 验证完整工具链如果你要做完整的开源 ASIC 流程 PPA 验证RTL (Verilog) ↓ Yosys (综合, Liberty 输入) ↓ OpenROAD / OpenLane (布局布线, DEF/LEF 输入) ↓ OpenSTA (静态时序分析, Liberty SDC SPEF) ↓ OpenRoad / ptpx (功耗分析, Liberty VCD/SAIF)8. 总结Liberty 文件是 PPA 验证的必要条件但不是充分条件。有 Liberty → 可以做面积估算和粗略时序分析要准确验证 Performance → 还需要SDC SPEF要准确验证 Power → 还需要VCD/SAIF 开关活动数据在纯 Yosys 综合阶段Liberty 文件至少能让你得到相对可靠的面积数据和基于线载模型的粗略时序估计这已经足够用于早期设计空间探索DSE。4. Liberty 文件介绍Liberty通常以.lib为扩展名是 ASIC 设计中最核心的标准单元库描述文件格式由 Synopsys 开发并已成为业界事实标准IEEE 1801 相关。它用类似 Tcl 的语法描述一个工艺节点下所有标准单元Standard Cells的电气特性、时序特性、功耗特性和物理特性。1. 基本结构一个 Liberty 文件通常包含以下层级library (mylib) { // 库级属性 technology (cmos); delay_model : table_lookup; voltage_unit : 1V; time_unit : 1ns; capacitive_load_unit (1, pf); // 工作条件 operating_conditions (typical) { process : 1.0; temperature : 25; voltage : 1.0; } // 标准单元定义 cell (INV_X1) { area : 1.2; pin(A) { direction : input; capacitance : 0.001; } pin(Y) { direction : output; function : !A; timing() { related_pin : A; cell_rise(table_1) { ... } // 上升延迟查找表 cell_fall(table_1) { ... } // 下降延迟查找表 } } } cell (DFF_X1) { area : 3.5; ff(IQ, IQN) { ... } pin(CLK) { ... } pin(D) { ... } pin(Q) { direction : output; timing() { related_pin : CLK; timing_type : rising_edge; cell_rise(table_1) { ... } } } } }2. 关键内容部分说明库属性工艺节点、电压/时间单位、延迟模型如table_lookup、cmos_linearOperating ConditionsPVTProcess/Voltage/Temperature角如 tt典型、ss慢角、ff快角Wire Load Model互连线延迟估算模型用于综合阶段尚未布线时Cell 定义每个标准单元的完整描述Pin 定义引脚方向、电容、驱动能力、功能表达式时序表 (Timing Tables)基于输入转换时间slew和输出负载load的二维查找表描述延迟和转换时间功耗数据内部功耗、漏电功耗、开关功耗Sequential Cell触发器/锁存器的 setup/hold 时间、时钟到输出延迟3. 在 Yosys 中的作用在你贴出的脚本中Liberty 文件被用于两个关键步骤# 1. 将 D 触发器映射到库中的具体单元 dfflibmap -liberty mycells.lib # 2. 用 ABC 将组合逻辑映射到库中的具体门单元 abc -liberty mycells.libdfflibmap扫描网表中的$dff通用 D 触发器根据 Liberty 文件中定义的ff单元映射为具体的 DFF 单元如DFF_X1、DFF_X2等abc将组合逻辑与或非门等映射到库中的标准门单元INV、NAND、NOR、AOI 等同时进行逻辑优化和时序优化4. Liberty 文件类型类型说明.lib人类可读的 ASCII 文本格式上面示例.dbSynopsys 二进制格式由lc或Library Compiler编译.lib生成读取更快CCS / ECSM更先进的电流源模型用于纳米级工艺的高精度时序分析5. 免费开源 Liberty 库资源你提到的链接是 VLSI Technology 提供的开源库适合学习和实验vsclib013130nmhttp://www.vlsitechnology.org/synopsys/vsclib013.lib还有其他工艺节点如 180nm、90nm 等此外著名的开源 PDK 也提供 Liberty 文件SkyWater 130nm (SKY130)sky130_fd_sc_hd__tt_025C_1v80.lib等GF180MCUGlobalFoundries 180nm6. 简单示例解析以 Yosys 自带的examples/cmos/cmos_cells.lib为例library(cmos_cells) { cell(NOT) { pin(A) { direction: input; } pin(Y) { direction: output; function: !A; } } cell(NAND) { pin(A) { direction: input; } pin(B) { direction: input; } pin(Y) { direction: output; function: !(AB); } } cell(DFF) { pin(CLK) { direction: input; clock: true; } pin(D) { direction: input; } pin(Q) { direction: output; } ff(IQ, IQN) { clocked_on: CLK; next_state: D; } } }这是一个极度简化的 Liberty 文件只定义了逻辑功能没有时序和功耗数据。实际的工艺库会有复杂的cell_rise、cell_fall、rise_transition等查找表。7. 总结Liberty 文件是连接 RTL 设计和物理实现的桥梁——它告诉综合工具我的工艺库有哪些门、每个门有多大、多快、功耗多少。Yosys 通过读取 Liberty 文件才能将抽象的 RTL 映射到具体的、可制造的标准单元上。5. README.md 参考: Yosys —— Yosys 开源综合套件这是一个 RTL 综合工具的框架。目前它对 Verilog-2005 提供了广泛的支持并为各种应用领域提供了一套基本的综合算法。Yosys 使用 sv-elab 和 slang 库来提供全面的 SystemVerilog 支持。它支持非正式定义的可综合的 SystemVerilog 子集版本为 IEEE 1800-2017 或 IEEE 1800-2023。Yosys 可以通过组合现有的处理流程算法来执行任何综合任务使用综合脚本并根据需要通过扩展 Yosys C 代码库来添加额外的处理流程。Yosys 是在 ISC 许可证下发布的自由软件一种与 GPL 兼容的许可证在条款上类似于 MIT 许可证或 2 条款 BSD 许可证。与本软件一起分发的第三方软件在兼容的许可证下获得许可。请参阅abc和libs子目录以了解其许可条款。网站及其他资源更多信息和文档可以在 Yosys 网站上找到https://yosyshq.net/yosys/如果您有任何与 Yosys 相关的问题请发布到 Discourse 讨论组https://yosyshq.discourse.group来自本仓库的文档会自动构建并在 Read the Docs 上提供https://yosyshq.readthedocs.io/projects/yosys对形式验证感兴趣的用户可能希望使用 Yosys 的形式验证前端 SBYhttps://yosyshq.readthedocs.io/projects/sby/https://github.com/YosysHQ/sbyYosys 博客上有来自用户的新闻和文章https://blog.yosyshq.com安装Yosys 是 Tabby CAD Suite 和 OSS CAD Suite 的一部分使用 Yosys 最简单的方法是安装二进制软件套件其中包含所有必需的依赖项和相关工具。联系 YosysHQ 获取 Tabby CAD Suite 评估许可证和下载链接或者前往 https://github.com/YosysHQ/oss-cad-suite-build/releases 下载免费的 OSS CAD Suite按照 GitHub 上的安装说明进行操作如果您需要行业级 SystemVerilog 和 VHDL 解析器等功能请务必获取 Tabby CAD Suite 评估许可证有关 Tabby CAD Suite 和 OSS CAD Suite 之间差异的更多信息请访问 https://www.yosyshq.com/tabby-cad-datasheet许多 Linux 发行版也提供 Yosys 二进制文件有些比其他更新。请查看您的包管理器从源码构建更多详细信息以及其他平台的说明请查看 Read the Docs 上的从源码构建。克隆 Yosys 时一些必需的库作为 git 子模块包含在内。确保执行例如$gitclone https://github.com/YosysHQ/yosys.git $cdyosys $gitsubmodule update--init需要支持 C20 的 C 编译器以及一些标准工具如 GNU Flex、GNU Bison (3.8)、CMake (3.28)、Make或其他 CMake 生成器如 Ninja和 Python (3.11)。一些额外的工具readline、libffi、Tcl 和 zlib如果可用将被使用但它们是可选的。Graphviz 和 Xdot 被show命令用于显示原理图。例如在 Ubuntu Linux 22.04 LTS 上以下命令将安装构建 Yosys 的所有先决条件$sudoapt-getinstallgawkgitmakepython3 lld bison clang flex\libffi-dev libfl-dev libreadline-dev pkg-config tcl-dev zlib1g-dev\graphviz xdot注意默认情况下Ubuntu 22.04 LTS 通过apt只能使用 CMake 3.22。要安装更新版本并满足构建 Yosys 的最低要求请使用sudo snap install cmake --classic。CMake 用于构建配置并且需要一个单独的构建目录$ cmake-Bbuild.生成后可用的构建变量可以通过ccmake或打开生成的build/CMakeCache.txt文件来检查和修改$ ccmake build# 或者..$vibuild/CMakeCache.txt设置一次性变量时CMake 提供-D varvalue命令行选项。例如禁用 zlib 支持$ cmake-Bbuild.-DYOSYS_WITHOUT_ZLIBON对于更持久的配置我们建议在根yosys目录中创建并使用CMakeUserPresets.json文件。下面是一个示例文件当调用cmake --preset clang时启用 ccache 并将默认编译器设置为 clang{version:1,configurePresets:[{name:default,binaryDir:build,generator:Unix Makefiles,cacheVariables:{CMAKE_C_COMPILER:clang,CMAKE_CXX_COMPILER:clang,YOSYS_COMPILER_LAUNCHER:ccache}}]}生成后构建系统可以按如下方式运行$ cmake--buildbuild# 或者..$cdbuild $ cmake--build.要使用默认设置快速安装 Yosys$ cmake-Bbuild.-DCMAKE_BUILD_TYPERelease $ cmake--buildbuild--configRelease--parallel$(nproc)$sudocmake--installbuild--strip测试位于 tests 子目录中可以使用test目标执行。请注意您需要 gawk、较新版本的 iverilog 和 gtest。通过以下方式执行测试$ cmake--buildbuild--targettest--parallel$(nproc)快速入门Yosys 可以与交互式命令 shell、综合脚本或命令行参数一起使用。让我们使用交互式命令 shell 执行一个简单的综合任务$ ./build/yosys yosyshelp命令可用于打印所有可用命令的列表help command可用于打印指定命令的详细信息yosyshelphelp使用 Verilog 前端读取和细化设计yosysread-svtests/simple/fiedler-cooley.v yosyshierarchy-topup3down5以 Yosys 内部使用的 RTLIL 格式将设计写入控制台yosyswrite_rtlil将进程always块转换为网表元素并执行一些简单的优化yosysproc;opt使用xdot显示设计网表yosysshow使用gv作为 PostScript 查看器执行相同操作yosysshow-formatps-viewergv将网表转换为门级逻辑并执行一些简单的优化yosystechmap;opt将设计网表写入新的 Verilog 文件yosyswrite_verilog synth.v或者使用简单的综合脚本$catsynth.ysread-svtests/simple/fiedler-cooley.v hierarchy-topup3down5 proc;opt;techmap;opt write_verilog synth.v $ ./yosys synth.ys如果在 Yosys 构建配置中启用了 ABC并且 Liberty 文件mycells.lib中给出了单元库则以下综合脚本将为给定的单元库进行综合# 读取设计 read -sv tests/simple/fiedler-cooley.v hierarchy -top up3down5 # 高层级处理 proc; fsm; opt; memory; opt # 映射到内部单元库 techmap; opt # 将触发器映射到 mycells.lib dfflibmap -liberty mycells.lib # 将逻辑映射到 mycells.lib abc -liberty mycells.lib # 清理 clean如果您没有 Liberty 文件但想测试此综合脚本可以使用 yosys 源代码中的文件examples/cmos/cmos_cells.lib作为简单示例。有关免费和开源 ASIC 标准单元库的 Liberty 文件下载和信息可以在这里找到http://www.vlsitechnology.org/html/libraries.htmlhttp://www.vlsitechnology.org/synopsys/vsclib013.libsynth命令提供了一个很好的默认综合脚本参见help synthread -sv tests/simple/fiedler-cooley.v synth -top up3down5 # 映射到目标单元 dfflibmap -liberty mycells.lib abc -liberty mycells.lib cleanprep命令提供了一个很好的默认字级综合脚本如基于 SMT 的形式验证中所使用的那样。附加信息默认情况下当使用 Verilog 源输入调用read时使用的read_verilog命令不执行语法检查。您应该首先使用其他工具如 [Verilator](https://www.veripool.org/verilator/对源代码进行 lint 检查例如通过调用verilator --lint-only。构建文档请注意如果您只是想阅读手册则无需构建它。只需访问 https://yosys.readthedocs.io/en/latest/ 即可。如果您处于离线状态可以阅读源代码将.../en/latest替换为docs/source。除了上面列出的用于从源码构建 Yosys 的包之外构建网站还需要以下包$sudoaptinstallpdf2svg faketime或者在 MacOS 上使用 homebrew$ brewinstallpdf2svg libfaketime大多数 LaTeX 发行版中包含的 PDFLaTeX 在构建网站期间也需要。或者运行以下命令$sudoaptinstalltexlive-latex-base texlive-latex-extra latexmk或者在 MacOS 上使用 homebrew$ brewinstallbasictex $sudotlmgr update--self$sudotlmgrinstallcollection-latexextra latexmk tex-gyre需要 Python 包 Sphinx以及docs/source/requirements.txt中列出的包$ pipinstall-Usphinx-rdocs/source/requirements.txt文档例如$ cmake--buildbuild--targetdocs-html--parallel这将根据需要构建/重建 yosys然后从 yosys 帮助命令生成网站文档。要构建 pdf 而不是 html请使用docs-latexpdf目标。