1. 代码开发工具链里的 Lint 自动化:为什么我把 VC Spyglass 的手工点选换成了 TCL 脚本
Lint 检查跑得慢,很多时候不是工具慢,是每次换设计都在用鼠标把同一套环境重建一遍。VC Spyglass 这类代码开发工具明明提供了脚本入口,不少人却停在项目文件模式:打开界面、加载工程、勾规则、跑完再把报告拖出来。我后来把读设计、精化、设目标、跑检查、出报告这几件事写成一份 TCL 脚本,放在工程根目录,换设计只改文件列表和顶层名。它适合每天要跑 Lint 的 RTL 前端,也适合想把检查接进提交前回归的人。下面先从两种驱动模式怎么选讲起,再把一个最小可运行版本跑通,最后说参数和踩过的坑。
需要模型API调用? 免费领10W Token,多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. VCUM 还是 SGUM:两种驱动模式的取舍与脚本落脚点
2.1 两种模式的分界:项目文件驱动与原生 TCL 驱动
VC Spyglass 有两种主要运行模式。一种是 Spyglass 使用模式(SGUM),它兼容传统的 Spyglass 项目文件(.prj);另一种是 VC 使用模式(VCUM),直接使用原生 TCL 命令来驱动。这个区分不是名词游戏,它决定了脚本能不能脱离图形界面独立存在。SGUM 更像“打开一个既有项目继续干活”,VCUM 更像“从零把一套检查流程用命令描述出来”。
| 维度 | SGUM | VCUM |
|---|---|---|
| 驱动载体 | .prj 项目文件 |
原生 TCL 命令 |
| 典型场景 | 沿用旧工程、图形界面操作 | 脚本自动化、批量回归 |
| 版本管理 | 工具状态文件,差异噪音大 | 纯文本脚本,便于评审 |
| 参数化能力 | 受项目结构约束 | 可在脚本里集中定义变量 |
| 出错定位 | 依赖界面状态 | 看脚本执行到哪一行、日志停在哪一步 |
我第一次迁移时吃过亏:拿着旧工程的 .prj 思路去写 VCUM 脚本,里面混进了项目加载命令,结果工具报未知命令,折腾半天才发现是两套命令集。后来我把这条边界记死了:自动化脚本只走 VCUM,.prj 留给还在用界面的同事。
2.2 自动化脚本为什么落在 VCUM
选 VCUM 不是为了显得高级,是因为它把“读设计—精化—设目标—跑检查—出报告”这条链拆成了可组合的命令。每一步都能单独验证,出错时能定位到具体环节,而不是对着一个项目文件猜哪项设置没生效。脚本本身是纯文本,能进版本库,能 code review,也能在持续集成里按批次跑。
另一个现实原因是可复现。.prj 里往往带着工具生成的路径和界面操作留下的状态,换一台机器、换一个工作目录就可能解析不到文件;TCL 脚本把路径写成变量,把文件列表集中在一处,换环境只改变量值。对需要每天跑、每周对比结果的 Lint 来说,这种确定性比“点几下就能跑”更重要。
2.3 脚本落地前的三项环境检查
在写第一行脚本之前,先确认工具环境和目录结构,不然后面所有报错都会指向同一个模糊原因。我一般先跑三条检查:
bash复制# 1. 工具环境变量是否已经指向安装目录
echo $VC_STATIC_HOME
# 2. 工作目录下至少要能看到设计、库和链接库
ls ./rtl ./libs
ls ./libs/GTECH.db
# 3. 确认当前目录就是脚本里 [pwd] 的基准
pwd
VC_STATIC_HOME 是工具内部路径的基准,通常在 shell 里已经配好,脚本里不再重复设置。./rtl 放设计源文件,./libs 放工艺库,GTECH.db 是链接库文件名,后面 link_library 会直接引用它。pwd 决定脚本里 [pwd] 取到哪个目录,也决定输出目录落在哪里。这三项任何一项不对,后面 read_hdl 或 elaborate 都会以“找不到文件”的形式报出来,但根因不在命令本身。
3. 六步搭出第一个 VC Spyglass Lint 脚本:从 set_db 到 quit 的完整骨架
下面按六步拆,拼起来就是一份可以直接保存为 run_lint_basic.tcl 的脚本。每一步单独给代码块,后面说清楚这行在做什么、参数怎么改。
3.1 第一步:固定工作目录与输出目录
tcl复制# 以脚本启动时的目录为基准,所有输出都收在 lint_run_1 下
set WORK_DIR [pwd]
set OUT_DIR "${WORK_DIR}/lint_run_1"
file mkdir $OUT_DIR
[pwd] 取当前工作目录,脚本从哪里启动,输出就落在哪里,所以启动脚本前要先 cd 到工程根目录。${WORK_DIR}/lint_run_1 用花括号把变量名包起来,避免和后面的字符粘连。file mkdir 先建目录,后面 report 的 -out 才有地方写文件。我一般会把目录名带上运行批次,第二次跑不覆盖第一次的报告,回看时能对上时间。
3.2 第二步:设置搜索路径与链接库
tcl复制# 设计文件、库文件、链接库的查找基准
set_db hdl_search_path {. ./rtl ../ip}
set_db lib_search_path {./libs}
set_db link_library {GTECH.db}
hdl_search_path 是 Verilog 文件相对路径的解析基准,列表里的 . ./rtl ../ip 分别对应当前目录、rtl 子目录和上级 ip 目录。lib_search_path 告诉工具去哪里找库文件,这里指向 ./libs。link_library 指定链接库,用于黑盒或工艺映射。这三个 set_db 要放在 read_hdl 之前,顺序反了,工具会按默认路径去找,报错信息只会说文件不存在,不会提醒你设晚了。
3.3 第三步:读入设计并精化
tcl复制# 读入多个 Verilog 文件,再以 top 为顶层建立层次
read_hdl -language verilog [list \
./rtl/top.v \
./rtl/submodule_a.v \
./rtl/submodule_b.v \
]
elaborate top
-language verilog 指定源文件语言,脚本里出现 VHDL 文件时再换对应参数。[list ...] 把多个路径收成一个 TCL 列表,路径里带空格也不会被拆成两个参数。elaborate top 以 top 为顶层建立层次结构,这一步失败,后面的 goal 和 report 都没有意义。我的习惯是先拿一个最小设计跑通 elaborate,再把完整文件列表加进来,避免一次面对几十条路径报错。
3.4 第四步:指定 Lint 目标和规则开关
tcl复制# 选定 lint_rtl 目标,并按规则名单独开关
set_goal lint/lint_rtl
# 示例:只关闭一条明确不适用于当前设计的规则
set_db rule_handlers {STARC05-2.1.4.5 off}
set_goal lint/lint_rtl 选定 Lint 分析目标,goal 名一般为 lint 或 lint_rtl,具体以工具里可用的 goal 列表为准。set_db rule_handlers 用来按规则名开关,示例里的 STARC05-2.1.4.5 off 是关闭一条规则。这里最容易图省事写成大范围关闭,报告是干净了,真正该报的问题也一起消失。规则开关应该按项目基线走,后面第 5 章会专门说这个坑。
3.5 第五步:运行并生成三种报告
tcl复制# 执行目标后,分别出文本、网页和摘要报告
run_goal
report -type lint -format text -out ${OUT_DIR}/lint_report.rpt
report -type lint -format html -out ${OUT_DIR}/lint_report.html
report -type summary -format text -out ${OUT_DIR}/summary.rpt
run_goal 真正执行前面设定的目标。-type lint 出详细 Lint 报告,-format text 给脚本或 grep 用,-format html 给人看,定位违例时比纯文本直观。-type summary 出违反规则的摘要,适合做回归门禁,只关心数量和规则分布时不用翻详细报告。三份报告各有用处,只留 html 会让自动比对很难做。
3.6 第六步:保存会话并退出
tcl复制# 保存会话便于后续在图形界面定位违例,然后正常退出
save_session ${OUT_DIR}/lint_session
quit
save_session 把当前会话存到输出目录,后面可以用图形界面打开,直接跳到具体违例的位置,比在文本报告里搜文件名快。quit 让批处理正常结束,脚本中途报错时不会执行到这一行,所以日志最后停在哪一步,基本就是出问题的位置。会话目录没生成,通常说明前面的 set_goal 或 run_goal 没走完。
4. 把脚本丢进终端:vc_static_shell 的调用、日志与首跑检查
4.1 用 -f 指定脚本文件
bash复制# 前台跑一遍,先确认脚本没有语法错误
vc_static_shell -f run_lint_basic.tcl
-f 后面跟 TCL 脚本文件,工具会按顺序执行脚本里的命令。第一次不要在后台跑,前台能直接看到第一条报错,改起来快。等小设计跑通、报告能正常生成,再考虑挂到长任务或回归里。这个顺序反过来,等半小时才发现第一行路径写错,时间就白花了。
4.2 把输出收进日志
bash复制# 常见做法:标准输出和错误输出合并到同一份日志,方便回看
vc_static_shell -f run_lint_basic.tcl > lint_run.log 2>&1
> 是覆盖写,2>&1 把错误输出并进标准输出,这样一份日志里既有工具的正常信息,也有报错。日志里重点看三类行:工具启动时的版本与环境、read_hdl 和 elaborate 阶段的路径解析、run_goal 结束后报告落盘的位置。我一般先 grep 一遍 Error 和 Cannot,再从头看,避免被大量正常输出淹没。
4.3 第一次运行的检查清单
| 检查点 | 看什么 | 不通过时先改哪里 |
|---|---|---|
| 工具启动 | 日志开头有没有版本和环境信息 | 检查 VC_STATIC_HOME 和启动目录 |
| 路径解析 | read_hdl 是否逐个找到文件 |
补 hdl_search_path 或改用工程根目录启动 |
| 精化结果 | elaborate top 是否建立层次 |
核对顶层名和文件列表是否完整 |
| 目标执行 | run_goal 是否正常结束 |
看日志最后停在哪条命令 |
| 报告落盘 | 输出目录里有没有三份报告 | 检查 OUT_DIR 和 file mkdir |
这张表我贴在工程 README 里,换人接手时按顺序走一遍,比直接读脚本快。检查清单不替代日志,它只是把“先看哪里”固定下来。
5. 避坑:路径、库、模式混用与规则开关的五个翻车现场
5.1 读设计和精化阶段的路径坑
坑一:找不到源文件,elaborate 后层次为空。 现象是 read_hdl 报某个 .v 文件不存在,或者文件读进去了但 elaborate 之后顶层下面没有子模块。原因通常是 hdl_search_path 没覆盖 ./rtl,或者脚本不是从工程根目录启动,[pwd] 取到了别的路径,相对路径全部解析偏了。解决方式是先 pwd 确认启动目录,把 ./rtl 加进 hdl_search_path,并统一从工程根目录启动脚本。我现在的习惯是脚本第一行就打印 pwd,日志里一眼能看到基准目录。
坑二:链接库打不开,黑盒解析失败。 现象是 elaborate 阶段报链接库无法打开,或者某个黑盒模块找不到定义。原因多半是 lib_search_path 指向的目录里没有 GTECH.db,或者文件名大小写和脚本里写的不一致。解决方式是先用 ls ./libs/GTECH.db 确认文件真实存在,再让 lib_search_path 指到它所在目录,link_library 里只写文件名,不写全路径。路径和文件名分开放,迁移目录时只改一个变量。
5.2 模式与命令的混用坑
坑三:把 .prj 思路搬进 VCUM 脚本。 现象是脚本执行到某条项目加载命令时报未知命令,或者项目状态为空,后面的 goal 根本设不上。原因是 SGUM 和 VCUM 的命令集不同,VCUM 要用原生 TCL 命令组织流程,不能混入 .prj 的加载方式。解决方式是自动化脚本统一走 read_hdl、elaborate、set_goal、run_goal 这条链,旧工程的 .prj 只作为参考,不往新脚本里搬命令。这个坑我踩过一次,后来在脚本开头写了注释,提醒自己别混。
5.3 规则与报告阶段的坑
坑四:规则关太多,报告干净得反常。 现象是某次跑完,报告里几乎没有违例,和上一版差距很大。原因是 rule_handlers 里一次关了一串规则,或者规则名拼错导致关闭没生效、但人以为生效了。解决方式是一次只关一条明确不适用的规则,关之前先在报告里确认这条规则确实在报,关之后对比前后两版报告的数量变化。规则开关最好集中在一段里,旁边写清楚为什么关。
坑五:报告目录不存在,跑完找不到文件。 现象是 report 命令报无法写入,或者脚本正常结束但输出目录里是空的。原因是 OUT_DIR 没提前 file mkdir,或者路径里变量拼错,报告写到了别的目录。解决方式是脚本开头先建目录,所有 -out 统一用 ${OUT_DIR}/... 拼接,不在中间临时改路径。跑完先 ls $OUT_DIR 看一眼,三份报告都在,再去看内容。
6. 把一次性脚本变成代码开发工具资产:参数化、规则基线与报告归档
6.1 把可变项提到文件头
脚本跑通之后,第一件事是把散在流程里的可变项收到文件头。换设计只改这几行,下面的步骤不动:
tcl复制# 可变项集中定义,流程部分不再出现硬编码路径
set WORK_DIR [pwd]
set RUN_ID "run_001"
set OUT_DIR "${WORK_DIR}/lint_${RUN_ID}"
set TOP_MODULE "top"
set RTL_FILES [list ./rtl/top.v ./rtl/submodule_a.v ./rtl/submodule_b.v]
RUN_ID 用来区分批次,每次跑换一个值,报告不互相覆盖。TOP_MODULE 和 RTL_FILES 提到前面,read_hdl 和 elaborate 直接引用变量,后面加文件只改一处。
6.2 规则基线单独维护
规则开关不要散在流程中间,集中成一段,旁边写清楚适用条件:
| 规则名 | 状态 | 适用条件 | 维护人 |
|---|---|---|---|
| STARC05-2.1.4.5 | off | 当前设计不使用该结构 | 前端负责人 |
| 其他规则 | 默认 | 按项目基线执行 | 前端负责人 |
关规则的理由要写下来,不然下一个人接手时不敢动,也不知道为什么报告里少了一类检查。
6.3 报告归档与门禁
每次运行的目录按 RUN_ID 分开,text 报告留给检索,html 报告留给评审,summary 报告拿去做门禁:只比规则数量和新增项,不逐行读详细报告。我现在的习惯是,新写或改完一个 Lint 脚本,先拿最小设计前台跑一遍,确认三份报告都落盘,再挂到回归里。从那以后我每次换设计,都先把路径和顶层名提到文件头,跑通最小用例才敢加文件。希望帮到你。
