yosys show 网表图:从 RTL 到门级两张图的分步生成与读图法
这是「EDA 开源工具实操」系列综合段的第一篇。仿真段我们用 iverilog 仿真入门 跑通了「编译 → 运行 → 看波形」的闭环,解决了「设计行为对不对」的问题;从本篇开始换一个问题:这段 Verilog 综合出来到底长什么样。商用流程里这对应逻辑综合环节(背景知识见 逻辑综合与 Design Compiler),开源世界的答案是 Yosys + 它的 show 命令——一条命令把内部网表画成 SVG,综合器每一步干了什么全都看得见。
写 RTL 的人最常见的困惑是「我写的 if-else 变成了几个 mux?那个 +1 综合成多大的加法器?」靠猜没用,把网表画出来看最直接。yosys show 网表图就是干这个的:它把 Yosys 内部的 RTLIL 网表导出成 Graphviz 的 dot 格式,再由 dot 渲染成 SVG/PNG。本篇用一个 8 位计数器实跑两条路径——proc 之后立刻出图(RTL 级形态)和 synth 完整综合后出图(门级形态),两张图放在一起对比,「综合做了什么」一目了然。
本文要回答的问题
show命令依赖什么?为什么单独装 yosys 出不了图?- 为什么
show之前必须跑proc?直接read_verilog后show会看到什么? - RTL 级网表图里,寄存器、加法器、多选器、归约与门各长什么样?
synth之后门级图和 RTL 图差在哪?$_SDFFE_、$_XOR_这些单元名怎么读?show的常用参数(-format、-prefix、-colors、select局部出图)怎么用?
一、环境:geek-eda:0.1 容器一键复现
实验统一跑在 Docker 容器 geek-eda:0.1 里(Ubuntu 24.04),本篇工具版本均为容器内实测:
- Yosys 0.33(
yosys -V输出:Yosys 0.33 (git sha1 2584903a060)) - Graphviz
dot(apt 版,负责把 yosys 导出的.dot渲染成 SVG) - make、bash、gawk
运行命令(把公开仓库的 experiments/ 挂进容器,一条命令出全部产物):
docker run --rm --user $(id -u):$(id -g) -e HOME=/tmp \
-v ~/Project/geek-doc.cn/experiments:/work \
-w /work/eda-lab-yosys-show geek-eda:0.1 make run代码获取:本实验完整代码(
counter.v)、Makefile 与真实运行输出(out/netlist_rtl.svg、out/netlist_gate.svg、out/show_rtl.log、out/show_gate.log、out/stat.txt)见公开仓库 derekzhuo/geek-doc.cn 的experiments/eda-lab-yosys-show/。克隆后make run即可复现。
这里有个容易忽略的依赖关系:yosys 的 show 自己不会画图。它只做前半段——遍历网表、生成 dot 文本(日志里的 Generating Graphviz representation of design);后半段「dot 文本 → 图片」交给 Graphviz 的 dot 程序。容器里两个都装好了;本机用 brew 的话需要 brew install yosys graphviz 两个包(本机 yosys 编译目前有工具链问题,建议直接用容器,见环境版本登记说明)。
二、实验设计:一个 8 位计数器,两条出图路径
被综合对象是仿真段那个计数器的加长版——8 位、同步低有效复位、使能计数,外加一个「全 1 溢出」标志:
// counter.v —— 8 位带使能与同步复位的计数器
module counter (
input wire clk,
input wire rst_n,
input wire en,
output reg [7:0] count,
output wire overflow
);
always @(posedge clk) begin
if (!rst_n)
count <= 8'd0;
else if (en)
count <= count + 8'd1;
end
assign overflow = &count; // 全 1 时溢出
endmodule选它的原因:代码只有十几行,但故意凑齐四类典型硬件——时序逻辑(count 寄存器)、算术运算(+1)、数据选择(if-else 隐含的二选一)、归约运算(&count)。四类东西在网表图里形态完全不同,一张小图就能练会读图。
Makefile 里安排了两条出图路径,这也是本篇的核心对照实验:
# 路径 1:proc 之后立刻出图 —— RTL 级形态
yosys -p 'read_verilog counter.v; hierarchy -top counter; proc; \
show -format dot -prefix out/netlist_rtl'
# 路径 2:synth 完整综合后出图 —— 门级形态
yosys -p 'read_verilog counter.v; synth -top counter; \
show -format dot -prefix out/netlist_gate'两条路径在 Yosys 内部的处理深度不同,用一张流程卡把「同样的 counter.v 经过哪些 pass 才走到 show」画出来:
路径一只走到 proc 就停,图里是 $dff、$add、$mux 这类「行为级单元」,最接近 RTL 代码的原意;路径二多走了 synth 全家桶(优化、FSM 提取、techmap、ABC 工艺映射),图里只剩 $_AND_、$_XOR_、$_SDFFE_ 这些真实逻辑门。下面分两节各看一张。
容器里 make run 跑完的真实产物清单(out/ 目录,ls -la 实测输出):
netlist_rtl.dot netlist_rtl.svg # 路径一:RTL 级 dot 源 + 渲染图
netlist_gate.dot netlist_gate.svg # 路径二:门级 dot 源 + 渲染图
show_rtl.log show_gate.log # 两次 yosys 运行的完整日志
stat.txt # synth 后的单元统计报表注意 RTL 图只有 18 KB,门级图却有 120 KB——文件体积的 6 倍差距本身就是「综合让网表变复杂」的直观证据:27 个单元、几十条线的图比 5 个单元的图信息量大得多。dot 是文本源、SVG 是渲染结果,Makefile 里 dot -Tsvg 那一步就是两者的桥。
三、路径一:proc 后出图,RTL 级网表长这样
先看日志(out/show_rtl.log)里四个关键 pass 各干了什么:
1. Executing Verilog-2005 frontend: counter.v
Generating RTLIL representation for module `\counter'.
2. Executing HIERARCHY pass (managing design hierarchy).
Top module: \counter
3. Executing PROC pass (convert processes to netlists).
3.7. Executing PROC_MUX pass (convert decision trees to multiplexers).
Creating decoders for process `\counter.$proc$counter.v:9$1'
3.9. Executing PROC_DFF pass (convert process syncs to FFs).
created $dff cell `$procdff$10' with positive edge clock.
4. Generating Graphviz representation of design.
Writing dot description to `out/netlist_rtl.dot'.逐条解读:
read_verilog把源码解析成 Yosys 的内部表示 RTLIL。注意此时always块还是一个「进程」(process),不是硬件单元——这就是不能直接read_verilog; show的原因。我实测过这条错路:read_verilog counter.v; hierarchy -top counter; show跑完不报错,但生成的 dot 里always块被画成一个圆角方框(p1 [shape=box, style=rounded, label="PROC $1 counter.v:9.5-14.8"]),时钟、复位、使能、输出全糊进这一个框里,$dff、$mux一个都没有——等于只看到了端口,没看到电路。必须先由proc把进程翻译成单元。hierarchy -top counter明确顶层模块。单文件单模块时它几乎无事可做,但多模块设计少了这步,yosys 可能猜错顶层或留着未例化的模块。proc是本节主角,它内部一串子 pass 把always块拆成硬件:PROC_MUX把if (!rst_n) ... else if (en) ...的判定树变成级联多选器;PROC_DFF认出posedge clk的赋值该变成触发器,日志里created $dff cell ... with positive edge clock就是那 8 位寄存器落锤的瞬间。show最后遍历网表写出 dot。渲染出的 SVG 如下:
对源码逐块认一认这张图(dot 源文件 out/netlist_rtl.dot 里能查到每个单元的类型标注):
| 图里的单元 | 类型 | 对应源码 | 形态特征 |
|---|---|---|---|
$procdff$10 | $dff(D 触发器) | count <= ... | 宽 8 位,D/Q/CLK 三个端口,CLK 单独走线 |
$add$counter.v:13$3 | $add(加法器) | count + 8'd1 | A、B 两个 8 位输入,B 口接常数 1 |
两个 $mux | 多选器 | if (!rst_n) 与 else if (en) | 级联:en 选「加一/保持」,rst_n 选「清零/上行」 |
$reduce_and | 归约与门 | &count | 8 位进、1 位出,输出直送 overflow |
数据通路在图里是闭环:寄存器 Q 口 → 加法器 A 口 → 加法结果回 mux → mux 输出回寄存器 D 口。这个「寄存器 + 组合逻辑 + 回环」的结构就是一切同步时序电路的标准长相,在 RTL 级图上看得最清楚。
顺带看一眼中间产物 dot 文件本身,能帮你理解 show 到底在做什么。out/netlist_rtl.dot 里每个单元就是一行 record 节点,每条连线就是一条带端口引用的边:
c17 [ shape=record, label="{{<p14> CLK|<p15> D}|$10\n$dff|{<p16> Q}}" ];
n1:e -> c17:p15:w [ style="setlinewidth(3)" ]; // mux 输出 → 触发器 D 口
c17:p16:e -> n10:w [ style="setlinewidth(3)" ]; // 触发器 Q 口 → count 线网shape=record 是 Graphviz 的多格矩形,p10/p11 是端口锚点,setlinewidth(3) 把多比特总线画成粗线(单比特信号是细线)——所以看 SVG 时「粗线 = 总线、细线 = 控制信号」是一个免费的读图线索,复位/使能/时钟那几根细线一眼就能从 8 位粗线里挑出来。
四、路径二:synth 后出图,门级世界完全变样
synth 是 Yosys 的「全家桶」命令,内部顺序执行几十个子 pass。out/show_gate.log 有 500 行,挑改变网表形态的三处:
2.9. Executing WREDUCE pass (reducing word size of cells).
Removed top 7 bits (of 8) from port B of cell ... ($add).
2.12. Executing ALUMACC pass (create $alu and $macc cells).
created 1 $alu and 0 $macc cells.
2.22. Executing ABC pass (technology mapping using ABC).
Extracted 19 gates and 27 wires to a netlist network ...
ABC RESULTS: XOR cells: 6 NAND cells: 3 AND cells: 3 ...WREDUCE发现加法器 B 口恒为常数 1,把高 7 位砍掉——加一不需要完整加法器;ALUMACC把退化后的$add归并进$alu;- 压轴的
ABC把所有行为级单元映射成真实逻辑门(NOT/AND/OR/XOR/NAND……),这就是「工艺映射」。
映射后的规模可以从 stat 报表精确读出(out/stat.txt,完整解读留给 stat 专篇,这里只取结论):
| 指标 | 数值 | 说明 |
|---|---|---|
| cells 总数 | 27 | 19 个组合门 + 8 个触发器 |
$_SDFFE_PN0P_ | 8 | 带同步复位(S)和使能(E)的 D 触发器,一位一个 |
$_XOR_ | 6 | 加一器的逐位半加逻辑 |
$_AND_ / $_NAND_ / $_ANDNOT_ | 3+3+3 | 进位链与溢出归约 |
$_NOT_ / $_OR_ / $_ORNOT_ / $_XNOR_ | 各 1 | 胶水逻辑 |
门级图渲染出来是下面这样(单元多、线密,建议打开 SVG 放大看):
打开这张门级 SVG 时的读图顺序建议:先找 8 个整齐排成一列的 $_SDFFE_(它们的位置最有规律,是整张图的「骨架」),再顺着每个触发器的 D 输入往回追组合逻辑,最后看 overflow 那根输出线连着哪几个与门。不要试图一次看懂所有连线——门级图的单元间互连是 ABC 映射器按优化目标摆的,布局没有源码层面的含义,重点是「有哪些单元、谁喂谁」,而不是「为什么这个门画在左上角」。
和 RTL 图对比,三个结构性变化最值得记住:
- 一个
count寄存器碎成了 8 个$_SDFFE_。RTL 级是「一根 8 位总线进一根出」,门级每一位都是独立触发器,SDFFE 这个名字本身就是规格书:S(同步复位)+ D(数据)+ FF(触发器)+ E(使能),PN0P后缀描述复位/时钟极性。源码里rst_n和en两个if没有变成 mux,而是被吸收进触发器自带的 SRST 和 EN 引脚——日志 2.8.6 节的Adding SRST signal ... Adding EN signal ...记录的正是这次吸收,比外挂 mux 省面积。 $add消失了,取而代之的是 XOR/AND 搭出的进位链。加一的本质是「从低位起连续求反直到遇到第一个 0」,6 个 XOR 加若干与门就是它的门级实现。$reduce_and也拆成了多极与门组合(AND/NAND/ANDNOT 各贡献一部分),overflow依然是纯组合输出。
一句话概括两图差异:RTL 图回答「设计在做什么」,门级图回答「设计用什么做」。调功能看前者,估面积/时序看后者。
实战里两张图各有用武之地,常见场景对照如下:
| 场景 | 看哪张图 | 看什么 |
|---|---|---|
| 怀疑自己写出了锁存器 | RTL 图 | 有没有 $dlatch 单元混进来 |
| 确认复位/使能有没有生效 | RTL 图 → 门级图 | RTL 看 mux,门级看 SRST/EN 引脚 |
| 估算设计规模、对比实现方案 | 门级图 + stat | 单元数、触发器位数 |
| 排查「综合后行为变了」 | 两张对比 | proc 后结构与 synth 后结构是否对应 |
五、show 命令的实用参数速查
本篇用到的是最朴素的 show -format dot -prefix <前缀>,日常还有几个高频参数:
| 参数 | 作用 | 例子 |
|---|---|---|
-format | 输出格式:dot/svg/pdf/ps | 装了 xdot 可直接 -format xdot 交互查看 |
-prefix | 输出文件名前缀(不带扩展名) | -prefix out/netlist_rtl |
-colors <seed> | 换一套配色(seed 为整数) | 线太密时换色帮助追线 |
-width | 给线网标注位宽 | show -width,调位宽错误必备 |
-viewer <程序> | 自定义看图程序 | 默认调系统关联程序 |
select + show | 只画选中的单元/线网 | 大设计局部出图的关键 |
大设计的全图根本没法看(几千个单元糊成一团),实战套路是先 select 圈出局部再 show。例如只画触发器和它的输入锥(input cone,即「哪些组合逻辑在喂它」):
yosys -p 'read_verilog counter.v; proc; select t:$dff %ci1:+; show -format dot -prefix out/dff_cone'这条命令我在容器里实测通过,日志末尾从 Dumping module counter to page 1 变成了 Dumping selected parts of module counter to page 1——只有被选中的局部入图。语法拆开看:t:$dff 选中所有类型为 $dff 的单元;%ci1 沿输入方向向外扩一级组合逻辑(数字换成 2、3 就扩两三级,* 表示一路扩到寄存器边界);:+ 表示把扩展结果并回当前选择。选择语法是 Yosys 的半部内功心法,help select 里有完整算子表(%c/%x/%ci/%co/%a 等),值得通读一遍。
顺带记录一个真实踩坑:我最初凭记忆写的是 select count %ci+(+ 紧跟 %ci),yosys 0.33 直接报 ERROR: Unknown selection operator '%ci+'——并集符号必须写成 :+ 后缀,不能拍脑袋简写。报错信息很直白,照着 help select 改就行。
六、常见报错与坑
实验过程中实测/复现的三个高频坑:
| 现象 | 原因 | 处置 |
|---|---|---|
show 输出 dot 后没有图片 | 没装 Graphviz,dot 不存在 | 容器已内置;本机 brew install graphviz,或手动 dot -Tsvg x.dot -o x.svg |
read_verilog; show 出图只有一个 PROC 方框 | 没跑 proc,always 块还是进程不是单元 | 出图前至少 proc;要门级图则 synth |
多模块设计报 Top module ... not found 或顶层猜错 | 没跑 hierarchy -top <名> | 显式指定顶层,顺带清掉未例化模块 |
ERROR: Unknown selection operator '%ci+' | select 并集写法错误 | 写成 ... %ci1:+,+ 前面要有冒号 |
还有一个不是报错但常让人困惑的点:-prefix 后面不要带扩展名。yosys 会自己拼 .dot,写成 -prefix out/a.dot 会得到 a.dot.dot。
这一篇在知识体系里的位置
本篇是综合段的起点,横向和纵向都有接续:
- 仿真视角的同一个计数器:iverilog 仿真入门(行为对不对)与本篇(综合成什么)是同一设计的两面;
- 看波形请去 iverilog VCD 波形;上板前的 lint 见 verilator lint;
- 本篇只取了
stat报表的一行结论,面积与单元的完整解读见 yosys stat 报表解读;synth内部几十个子 pass 的单步拆解见 yosys synth 流程拆解;综合阶段的报错处置见 yosys 常见报错; - 商用综合流程的背景知识在 逻辑综合与 Design Compiler 与 netlist 交接与门级仿真,开源/商用概念可一一对照。
总结
yosys show 网表图是「综合器透视镜」:read_verilog → hierarchy → proc → show 出 RTL 级图看行为结构($dff/$add/$mux/$reduce_and),synth → show 出门级图看真实标准单元(8 个 $SDFFE 触发器加 19 个逻辑门),同一计数器两张图并排,综合从 RTL 到门做了什么就再不是黑盒。