★ FEATURED ARTICLE 如果你正在被 chipyard 安装折腾得怀疑人生那这篇教程应该能帮你少走很多弯路。chipyard 是 UC Berkeley 开源的一套基于 RISC-V 的 SoC 生成框架简单说它能让你用一套配置描述生成一个完整的 SoC——从 CPU 核、缓存、总线到外设都有现成组件可以拼装——然后进一步做仿真、FPGA 验证甚至流片。很多人第一次接触它是因为想做体系结构实验或者科研项目结果卡在了安装这一步还没看到 RTL 长什么样就先被工具链劝退了。说实话chipyard 的安装难度并不在代码本身而在于它背后挂着一整条工具链链条Chisel、FIRRTL、Rocket Chip、BOOM、riscv-gnu-toolchain、Verilator……任何一个环节版本不对、依赖缺失、资源不足都会让你在最后关头看到一条完全不认识的报错。网上教程不少但要么讲得过于简略要么直接照搬 README根本解释不清为什么要做这一步。这篇文章我会从实际安装经验出发把环境准备、完整安装流程、常见问题排查都过一遍给出可以直接照做的命令和参数。适合第一次接触 chipyard 的读者也适合已经被安装折磨到想骂人的朋友——先把整个安装逻辑搞清楚再动手比你盲目重试十条命令管用得多。1. 动手之前先搞明白 chipyard 到底在装什么1.1 chipyard 不是单个工具而是一整套生成流水线很多人第一次看到 chipyard 的安装脚本时会在心里犯嘀咕为什么装一个框架要搞出那么多依赖这要从它的设计说起。chipyard 不是一个“装完就能跑”的软件它更像一套积木加流水线的组合硬件描述用 Chisel 写经过 FIRRTL 编译器转换成 Verilog之后再用仿真器或物理实现工具继续处理。CPU 核心可以选择 Rocket顺序双发射、BOOM乱序超标量也可以挂上定制加速器SoC 总线、中断控制器、调试模块都有现成的 generators 仓库。所以你在安装时看到的 rocket-chip、boom、riscv-tools、firrtl 这些目录不是“可选项”而是这条流水线的各个工位。装 chipyard 的本质是把这些组件按指定版本拉到本地、把交叉编译工具链编出来、把仿真环境搭好。理解了这一点后面遇到任何报错都不会慌因为你至少知道它是哪一环出了问题也知道该去哪儿查日志。1.2 你准备拿 chipyard 干什么决定了你要装哪些组件chipyard 的 build-setup.sh 支持不同的工具链选项最常见的两个是 riscv-tools 和 esp-tools。riscv-tools 会编译完整的 riscv-gnu-toolchain能编译 Linux 内核和用户态程序esp-tools 目标更轻量一般用于嵌入式类快速测试。如果你之后想跑 Linux 启动、跑 SPEC 或 CoreMark 这类负载选 riscv-tools 基本不会错。如果只是想做功能验证esp-tools 可以省下不少编译时间。脚本里还有 llvm 相关的选项也会拉取依赖但对大多数第一次安装的人来说不是必须的。我个人的建议很明确第一次装不要贪多选一个 riscv-tools 把主链路跑通即可。等熟悉了流程再回过头补装别的否则光是编译时间就够你喝一壶的。这里省下来的时间拿去把后面的验证实验做一遍收获会大得多。1.3 三个容易被低估的资源磁盘、内存、网络在正式跑安装命令之前请先认真检查你的机器。第一是磁盘chipyard 所有源码加子模块、工具链编译产物、Conda 环境加起来 30GB 到 60GB 非常常见。建议预留至少 50GB低于这个数很容易在编译中段把磁盘写满而写满磁盘带来的失败往往比报错本身更令人崩溃因为它会以各种奇怪的段错误形式出现让你怀疑是代码问题。第二是内存编译 RISC-V 工具链时并行度开高以后内存很容易吃紧4GB 内存的机器基本没有还手之力。建议 16GB 以上实在不够就先加 swap后面我会给出具体命令。第三是网络chipyard 的仓库体积大、子模块又多clone 和 submodule update 的过程对网络质量比较敏感这一步失败后最常见的表现就是“明明重试了好几次还是卡在同一个位置”。2. 环境准备把半路翻车的风险提前处理掉2.1 操作系统选型能省事就别自找麻烦从社区的使用情况和我自己的测试来看Ubuntu 20.04 和 22.04 的安装体验最顺畅依赖包基本都能通过 apt 直接装齐。CentOS/RHEL 系统也能装但需要额外处理 EPEL 仓库和部分包的命名差异折腾成本会高一些macOS 可以跑通不过在编译工具链阶段碰到奇怪问题的时候也不少。如果你是第一次装我建议直接上 Ubuntu 的 LTS 版本不要用太新的滚动发行版也不要拿精简版系统硬扛缺少基础开发包会让安装脚本在多个环节报错。系统准备好之后先把基础包补齐。下面这组命令以 Ubuntu 为例sudo apt update sudo apt install -y build-essential bison flex autoconf automake \ libtool python3 python3-pip python3-dev curl wget git \ device-tree-compiler libncurses-dev libssl-dev gawk texinfo \ help2man libgtk-3-dev rsync不同 release 版本的依赖清单会略有差异装完之后最好打开 chipyard 仓库的 README 对照一眼重点看有没有额外说明。这个步骤花不了几分钟但能避免后面“编译到一半发现缺 autoconf”这种低级中断尤其是当你正在用 tee 保存日志时回头翻日志找这种错误会非常浪费时间。2.2 了解工具链在链条里的位置为什么它非编不可这里多解释一句riscv-tools 不是芯片设计工具而是 RISC-V 的交叉编译工具链。chipyard 生成的是处理器 RTL但你要让这个处理器跑起程序来总得有办法把 C 语言编译成 RISC-V 指令。工具链里包含 gcc、binutils、glibc或 newlib等这些编译完会被放到 tools/riscv-tools 目录下。每次跑 chipyard 的仿真流程系统都会去找riscv64-unknown-elf-gcc找不到就直接报错。这也是很多人“装完之后用不了”的原因build-setup.sh 正常结束不等于你可以在任意路径下调用工具链。你需要执行source env.sh把 PATH、RISCV、CHIPYARD 这些环境变量加载到当前终端。注意是source不是直接执行./env.sh后者只会在子 shell 里生效当前终端依然找不到工具链这个细节特别容易坑到第一次接触 Linux 环境的同学。提示env.sh必须用source env.sh加载不能直接运行./env.sh否则环境变量不会进入当前 shell。2.3 用三条命令判断机器到底行不行在跑大安装之前我习惯先做一次快速体检三分钟能省下三个小时的怀疑人生df -h ~ # 看剩余磁盘空间 free -h # 看内存重点关注 available nproc # 看 CPU 核数决定编译并行度如果你的 available 内存小于 8GB建议先把 swap 加上。创建 swap 的命令很简单sudo fallocate -l 16G /swapfile sudo chmod 600 /swapfile sudo mkswap /swapfile sudo swapon /swapfile想开机自动挂载的话把/swapfile none swap sw 0 0追加到 /etc/fstab 末尾。机器配置确认到位后再开始正式安装速度会快很多而且不容易在半夜被 OOM 叫醒。3. 完整安装实操从拉源码到跑通第一个程序3.1 拉取 chipyard 源码这一步决定了你后面能否复现教程先说一个很多教程没提的细节chipyard 的 master 分支变动非常频繁而且子模块的版本是被上层 commit 锁死的不同 tag 对应的代码和脚本行为可能差异很大。如果照着老教程配最新代码十有八九会踩到 API 变更的坑。所以我的建议是先指定版本再安装。以某个 release 版本为例git clone https://github.com/ucb-bar/chipyard.git cd chipyard git checkout 1.11.0 # 具体版本以官方仓库 release tag 为准如果你不关心历史提交想减少 clone 的网络压力也可以用git clone --depth 1 -b 1.11.0 ...的方式只拉取指定 tag 的浅克隆。这里必须注意浅克隆之后如果还想切换其他 tag需要先取消 shallow 限制所以第一次就选好版本很重要。这也是我强烈建议在开始之前想清楚自己要用哪个版本的原因而不是随手拉一个 master 就往下走否则后续所有命令都可能因为版本变化而偏离教程。子模块是 chipyard 安装里最磨人的一环。所谓子模块就是 rocket-chip、boom、firrtl 这些以独立 Git 仓库形式挂在主仓库下的组件。主仓库记录了它们应该对应的 commitgit submodule update --init --recursive会把这些仓库拉下来。手动执行这个命令可以但更推荐直接走 build-setup.sh它会自动检查并补齐子模块比手动操作更省心。3.2 编译 RISC-V 工具链耐心和时间都要准备好如果你的需求是跑通完整的软件仿真链路直接在主目录执行./build-setup.sh riscv-tools这条命令会依次完成初始化子模块、建立 Conda 环境、编译 RISC-V 工具链、编译 FIRRTL 工具以及 Verilator 仿真器。整个过程非常耗时在一台 8 核 16GB 内存的机器上编译 RISC-V 工具链本身就要一个小时起步再加上其他环节全部跑完两三个小时很正常。建议用tee保存日志方便出错时回看也方便你在群里问别人的时候直接贴出有用的片段./build-setup.sh riscv-tools 21 | tee build.log机器核心多可以适当提高并行度但要守住内存红线。内存 16GB 的机器上把并行度压到 4 是比较稳妥的MAKEFLAGS-j4 ./build-setup.sh riscv-tools 21 | tee build.log如果内存只有 8GB建议老老实实MAKEFLAGS-j2慢了顶多多等一会总比编到一半被系统杀死进程强。看到这里你应该也明白了chipyard 安装更像是一场资源管理游戏而不是单纯的“跑脚本等结果”。3.3 验证安装结果能编出 hello world 才算数编译结束后在 chipyard 根目录执行source env.sh然后检查工具链是否可用riscv64-unknown-elf-gcc --version能看到版本号说明交叉编译器已经就位。但工具链能编译程序不等于整个 chipyard 链路没问题还需要跑一次最小仿真。最简单的做法是写一个极简 C 程序用自己的工具链编译然后送到 Verilator 仿真器里跑mkdir -p $HOME/chipyard-test cat $HOME/chipyard-test/hello.c EOF #include stdio.h int main() { printf(Hello Chipyard!\n); return 0; } EOF riscv64-unknown-elf-gcc -static -O2 $HOME/chipyard-test/hello.c -o $HOME/chipyard-test/hello.riscv make -C sims/verilator run-binary BINARY$HOME/chipyard-test/hello.riscv默认的仿真配置是 RocketConfig生成一个最小 SoC 并运行你的二进制。看到程序里 printf 的内容打印出来同时仿真器报告正常退出就说明从 RTL 生成、仿真器到交叉工具链的整条链路已经打通了。到这个节点你的 chipyard 安装才算真正有了意义。4. 安装过程中我踩过的坑常见问题与排查思路4.1 编到一半 OOM内存不足是最常见的杀手RISC-V 工具链编译过程中有几个编译单元非常吃内存尤其是 glibc 和 gcc 的某些 C 文件单个编译进程吃几个 GB 内存也不稀奇。并行度开高之后系统内存被瞬间打满内核就会启动 OOM Killer表现就是终端里出现Killed编译进程无端消失。看到这种提示先别怀疑代码第一件事确认内存余量。处理办法有两个一是把编译并行度降下来二是加 swap。降并行度最直接8GB 内存就老老实实用-j1或-j2。加 swap 则是给系统兜底哪怕编完之后把它关掉都行。我自己的经验是16GB 内存加-j4整个过程非常从容如果只有 8GB 还强行开-j4基本都会在半路见到 Killed。4.2 clone 和子模块反复失败网络问题要巧处理chipyard 主仓库加全部子模块体积相当可观网络稍有波动就可能中断。如果遇到git clone或git submodule update失败先别重复机械地跑同一条命令可以做三件事第一增大 Git 的单次传输缓冲减少大对象传输中途报错git config --global http.postBuffer 524288000第二用浅克隆减少数据量比如git clone --depth 1降低网络传输时间。第三子模块更新可以用git submodule update --init --recursive多跑几次因为 git 会对已拉取的内容做增量重试成本不高每次失败后重新执行一般两三轮就能补齐。需要提醒的是这类网络问题没有银弹能做的就是控制单次传输规模、提升重试效率。如果换了多个网络环境仍然频繁中断那就要先检查基础网络连通性确认没问题再继续别陷入“反复重试—反复失败”的循环里出不来。4.3 教程版本和代码版本对不上别拿旧经验套新代码chipyard 迭代速度很快甚至同一个脚本在不同版本里的参数含义都不完全一致。我在某个版本里就遇到过 build-setup.sh 的选项已经换了一轮网上老教程里写的命令在新版本里直接报错的情况。遇到这种情况不要硬套命令先看官方 README再看脚本本身的 help 输出。如果你是要做长期项目务必记录自己用的版本号最好把 git tag 写进项目的 README方便以后回溯。这也是我在 3.1 强调先 checkout 一个 release tag 的原因。固定版本后安装步骤、子模块 commit、辅助脚本行为都会被锁定至少不会因为上游对 master 的改动把你的环境搞乱。如果你因为某些原因必须用 master那就做好“教程可能过期”的心理准备。4.4 系统里装了 Anaconda 导致环境混乱chipyard 自己在安装过程中会创建一个 Conda 环境如果系统里已经装了 Anaconda 或 Miniconda可能出现环境名冲突或者 PATH 指向错误。典型表现是conda命令版本不对或者 build-setup 创建的 chipyard 环境里缺少某些 Python 包。解决思路是让 chipyard 管理自己的 Conda不要让它和系统级 Anaconda 互相干扰。运行source env.sh之前用conda env list看一下当前环境如果发现冲突先conda deactivate退出所有环境再重新source env.sh。另外特别提醒一句不要用 root 用户跑 build-setup.sh否则生成的文件属主都是 root之后普通用户清理和修改会非常难受这个坑我见过不止一次。4.5 其他零碎问题JDK 版本、Verilator、磁盘权限再列几个不太起眼但真实存在的坑。JDK 版本不对时mill 或 sbt 会报出奇怪的编译错误chipyard 不同版本对 JDK 的要求不同有的要求 11有的要求 17按 README 配好即可。Verilator 编译失败经常是缺少 Perl 相关模块可以单独 apt 安装libperl-dev后再重试。磁盘写满时编译进程往往不会马上报“磁盘满”而是出现各种奇怪的段错误所以df -h应该成为你排查问题的第一步。下面给一个速查表方便对照定位现象大概率原因首选处理方式编译进程被 Killed内存不足看 free -h降并行度或加 swapsubmodule update 反复中断网络波动、仓库过大调大 http.postBuffer多次重试命令与教程对不上版本差异固定 release tag按 README 执行conda 环境冲突系统已有 Anacondasource 前退出当前环境mill/sbt 报 JDK 错误JDK 版本不匹配按官方要求安装指定 JDK编译出现奇怪段错误磁盘写满或内存耗尽先查 df -h 和 free -h排查这类问题有一个基本原则先排除环境因素再怀疑代码。绝大多数 chipyard 安装失败根因都不在芯片框架本身而是磁盘、内存、网络、版本这四件事。5. 安装完成之后验证、进阶与使用建议5.1 最小仿真验证通过后再试试其他配置默认的 RocketConfig 只是最小验证。接下来你可以尝试生成 BOOM 乱序核的 SoC或者在同一个 SoC 里配置多个核心方法是在 make 命令里指定 CONFIGmake -C sims/verilator CONFIGBOOMConfig run-binary BINARY$HOME/chipyard-test/hello.riscvBOOM 的生成和编译时间会比 Rocket 长不少因为乱序核的 RTL 复杂度高了一个量级仿真速度也会慢很多。不过这一步能让你直观感受到“配置驱动 SoC 生成”的威力——不用改一行 RTL只要换个 Config就能得到完全不同的处理器微架构。对做体系结构研究的同学来说这个阶段才算真正进入主题。5.2 如果最小仿真没通过按这个顺序排查先确认source env.sh是否在当前终端生效用which riscv64-unknown-elf-gcc检查然后确认 Verilator 版本是否在脚本要求的范围内接着看 logs 目录里最近生成的日志文件尾部定位是哪一步断的。多数情况下“不通过”不是环境彻底坏了而是卡在某一步留下的残留状态清掉对应目录重新编译即可恢复不必推倒重来。如果日志里出现了和 FIRRTL 相关的报错还可以检查一下 JAVA 版本和mill的缓存目录必要时清理~/.cache/mill再重试。这些操作都很常规但能帮你避免“明明啥都没改重新跑一遍却过了”的玄学问题。5.3 从“装好”到“用好”还有很长的路chipyard 的价值不只是“装好以后能跑 hello world”。它真正让人兴奋的地方在于你可以通过修改 config 和 generator 代码快速比较不同微架构方案的性能差异可以用 FireSim 在 FPGA 上做大规模仿真跑 Linux 工作负载也可以把生成的 Verilog 交给后端工具做物理设计。安装只是进入这个世界的第一道门但它确实是最劝退的一关。我第一次装 chipyard前后在三台机器上分别踩了内存不足、JDK 版本和子模块网络三个坑最后发现没有一个是 chipyard 代码本身的问题。装完之后回头看这个框架对自己的抗挫力要求不低但它背后的设计思想——用高级语言描述硬件、用配置驱动复杂 SoC 生成、用统一脚本管理整套工具链——确实值得花时间彻底搞明白。如果你正在安装的过程里受折磨记住三点资源给足、日志记牢、版本固定剩下的交给时间。
阅读完成 · 觉得有帮助？
