15个版本 (重大更新)
0.14.0 | 2022年2月8日 |
---|---|
0.13.2 | 2021年11月11日 |
0.12.1 | 2021年8月18日 |
0.12.0 | 2021年1月9日 |
0.1.0 | 2018年2月27日 |
#348 在 编程语言 中
在 2 个crate中使用 (通过 moore-vhdl)
315KB
8K SLoC
moore
Moore是一个硬件描述语言编译器,输出llhd汇编代码,注重可用性、清晰的错误报告和完整性。其目标是作为硬件设计工具(如综合器、linters或逻辑等价性检查器)的前端。
用法
安装
要构建Moore,您需要一个工作的Rust安装。该项目还依赖于CIRCT项目,以及MLIR和LLVM。为了获得一个可工作的二进制文件,您通常需要确保已经检出circt
和circt/llvm
子模块
git submodule update --init --recursive
然后按照以下步骤操作
构建LLVM和MLIR
mkdir -p circt/llvm/build
pushd circt/llvm/build
cmake ../llvm \
-DCMAKE_BUILD_TYPE=Release \
-DLLVM_BUILD_EXAMPLES=OFF \
-DLLVM_ENABLE_ASSERTIONS=ON \
-DLLVM_ENABLE_BINDINGS=OFF \
-DLLVM_ENABLE_OCAMLDOC=OFF \
-DLLVM_ENABLE_PROJECTS=mlir \
-DLLVM_INSTALL_UTILS=ON \
-DLLVM_OPTIMIZED_TABLEGEN=ON \
-DLLVM_TARGETS_TO_BUILD="host"
cmake --build .
popd
构建CIRCT
mkdir -p circt/build
pushd circt/build
cmake .. \
-DCMAKE_BUILD_TYPE=Release \
-DMLIR_DIR=$PWD/../llvm/build/lib/cmake/mlir \
-DLLVM_DIR=$PWD/../llvm/build/lib/cmake/llvm \
-DLLVM_ENABLE_ASSERTIONS=ON
cmake --build .
popd
构建Moore
设置以下环境变量以指示您的LLVM和CIRCT构建位置
export CIRCT_SYS_CIRCT_DIR=$PWD/circt
export CIRCT_SYS_CIRCT_BUILD_DIR=$PWD/circt/build
export CIRCT_SYS_LLVM_DIR=$PWD/circt/llvm
export CIRCT_SYS_LLVM_BUILD_DIR=$PWD/circt/llvm/build
使用cargo安装Moore
cargo install moore
请注意,在Linux系统上,您很可能需要7或更高版本的libstdc++才能使此操作正常工作。
开发
对于活跃的开发,您可能希望使用常规的check
、build
、run
和test
子命令。
您可能还会发现将*_BUILD_DIR
环境变量指向实际的构建目录(通常是circt/llvm/build
和circt/build
)很有用,这样在CIRCT或LLVM的每次更改时就不需要重新安装。
示例
假设以下输入文件
// foo.sv
module hello_world;
endmodule
要编译foo.sv
并将相应的LLHD汇编代码输出到标准输出,请调用moore并传递文件名和要展开的模块(-e
选项)
moore foo.sv -e hello_world
您可以使用llhd-sim来模拟编译后的模块
moore foo.sv -e hello_world > foo.llhd
llhd-sim foo.llhd
开发
Moore在此存储库中开发,但已分解为以下crate
moore
:将所有内容连接在一起的最顶层umbrella cratemoore-common
:由SystemVerilog和VHDL使用的通用基础设施moore-derive
:过程宏moore-svlog
:SystemVerilog实现moore-svlog-syntax
:SystemVerilog解析器和AST实现moore-vhdl
:VHDL实现moore-vhdl-syntax
:VHDL解析器和AST实现moore-circt
:围绕CIRCT API的Rust包装器moore-circt-sys
:CIRCT的低级语言绑定
在moore上工作的一些有用命令
git submodule init
git submodule update
cargo check
cargo test --all
cargo run -- foo.sv -e foo
scripts/test.py --debug -v
scripts/test.py --debug -v <path-to-test-case>
lit test -v
创建新的版本
要创建新的版本,项目中的各个子crate必须以上述顺序反向发布。遵循以下清单
- 使用
scripts/release_status.sh
查看项目整个moore/llhd crate版本的概览 - 更新所有
Cargo.toml
文件中的版本 - 使用
scripts/release_check.sh
确保所有crate的版本与根版本相同 - 确保cargo运行正常:
cargo check
- 更新
CHANGELOG.md
文件 - 提交:
git commit -am "将版本提升到X.Y.Z
- 标记:
git tag vX.Y.Z
- 使用
cargo publish
以反向顺序发布所有crate
lib.rs
:
根据IEEE 1076-2008对VHDL源文件的词法分析和解析器。
依赖关系
~295–790KB
~14K SLoC