⚡️ "CIRCT" / 电路IR编译器和工具

"CIRCT"代表"电路中间表示（IR）编译器和工具"。也可以递归地解释为"CIRCT IR编译器和工具"。T可以选择性地扩展为工具、转换器、团队、技术、目标、树、类型等，我们对这种模糊性持开放态度。

CIRCT社区是一个开放和欢迎的社区。如果你想参与，可以通过以下几种不同的方式：

加入我们在LLVM Discourse服务器上的Discourse论坛。要获得类似"邮件列表"的体验，请点击右上角的铃铛图标并切换到"关注"。同时，进入你的Discourse个人资料，然后进入"电子邮件"标签，勾选"启用邮件列表模式"也很有帮助。你还可以在LLVM discord服务器的CIRCT频道与我们聊天。
加入我们的每周视频聊天。请查看会议记录文档以获取更多信息。
贡献代码。CIRCT遵循所有LLVM政策：你可以为CIRCT仓库创建拉取请求，并使用标准LLVM政策获取提交权限。

动机

EDA行业有著名且广泛使用的专有和开源工具。然而，这些工具不一致，存在可用性问题，且没有被设计成一个共同的平台。此外，这些工具通常以Verilog（也包括VHDL）作为它们交换的IR。Verilog有众所周知的设计问题和限制，例如缺乏良好的位置跟踪支持。

CIRCT项目是一项（实验性的！）努力，旨在将MLIR和LLVM开发方法应用于硬件设计工具领域。我们中的许多人梦想拥有可重用的基础设施，这些基础设施是模块化的，使用基于库的设计技术，更加一致，并建立在编译器基础设施和编译器设计技术的最佳实践之上。

通过共同努力，我们希望能够建立一个新的重心，吸引那些从事开放硬件工具工作的小型（但热情！）社区的贡献。反过来，我们希望这将推动开放工具向前发展，使硬件设计能够使用新的更高级别的抽象，也许某些部分最终甚至可能被专有工具采用。

欲了解更多信息，请查看我们更长的章程文档。

设置

可以使用以下命令来设置CIRCT项目：

根据说明安装LLVM/MLIR的依赖项，包括cmake和ninja。
检出LLVM和CIRCT仓库。 CIRCT包含LLVM作为git子模块。这里的LLVM仓库包括对MLIR的分阶段更改，这可能是支持CIRCT所必需的。它还代表了经过测试的LLVM版本。MLIR仍在相对快速地变化，所以随意使用当前版本的LLVM，但API可能已经改变。

$ git clone git@github.com:llvm/circt.git
$ cd circt
$ git submodule init
$ git submodule update

注意： 仓库设置为git submodule update执行浅克隆，这意味着它只下载足够的LLVM仓库来检出当前指定的提交。如果你希望使用LLVM仓库的完整历史，可以手动"取消浅克隆"子模块：

$ cd llvm
$ git fetch --unshallow

构建并测试LLVM/MLIR：

$ cd circt
$ mkdir llvm/build
$ cd llvm/build
$ cmake -G Ninja ../llvm \
    -DLLVM_ENABLE_PROJECTS="mlir" \
    -DLLVM_TARGETS_TO_BUILD="host" \
    -DLLVM_ENABLE_ASSERTIONS=ON \
    -DCMAKE_BUILD_TYPE=DEBUG \
    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
$ ninja
$ ninja check-mlir

构建并测试CIRCT：

$ cd circt
$ mkdir build
$ cd build
$ cmake -G Ninja .. \
    -DMLIR_DIR=$PWD/../llvm/build/lib/cmake/mlir \
    -DLLVM_DIR=$PWD/../llvm/build/lib/cmake/llvm \
    -DLLVM_ENABLE_ASSERTIONS=ON \
    -DCMAKE_BUILD_TYPE=DEBUG \
    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
$ ninja
$ ninja check-circt
$ ninja check-circt-integration # 运行集成测试。

-DCMAKE_BUILD_TYPE=DEBUG标志启用调试信息，这会使整个树编译得更慢，但允许你逐步调试进入LLVM和MLIR框架。-DCMAKE_EXPORT_COMPILE_COMMANDS=ON标志生成一个build/compile_commands.json文件，编辑器（或插件）可以使用该文件进行自动完成和/或IDE类功能。

要获得运行速度快的版本，使用-DCMAKE_BUILD_TYPE=Release或-DCMAKE_BUILD_TYPE=RelWithDebInfo（如果你想要快速运行并可选地包含调试信息）。Release模式在性能上有很大的差异。

有关配置和编译CIRCT的详细信息，请查阅入门页面。

如果你主要对从Python提示符或脚本使用CIRCT感兴趣，请查阅Python绑定页面。