10个版本 (6个重大更改)

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.8.0 2020年5月23日

#7#llhd


3 个crate 中使用

Apache-2.0 OR MIT

49KB
1K SLoC

moore

Build Status Released API docs Crates.io Crates.io dependency status

Moore是一个用于硬件描述语言的编译器,输出llhd汇编代码,注重易用性、清晰的错误报告和完整性。其目标是作为合成器、代码检查器或逻辑等价性检查器等硬件设计工具的前端。

使用方法

安装

要构建Moore,您需要一个工作状态的Rust安装。该项目还依赖于CIRCT项目以及MLIR和LLVM。为了获得一个可工作的二进制文件,您通常需要确保已经检出circtcirct/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++才能使此功能正常工作。

开发

对于积极开发,您可能想要使用常用的checkbuildruntest子命令。

您可能还会发现将*_BUILD_DIR环境变量指向实际的构建目录(通常是circt/llvm/buildcirct/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:顶层伞形 crate,将所有内容连接在一起
  • moore-common:SystemVerilog 和 VHDL 共享的基础设施
  • moore-derive:过程宏
  • moore-svlog:SystemVerilog 实现
  • moore-svlog-syntax:SystemVerilog 解析器和 AST 实现
  • moore-vhdl:VHDL 实现
  • moore-vhdl-syntax:VHDL 解析器和 AST 实现
  • moore-circt:Rust 对 CIRCT API 的封装
  • 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 必须按照上述相反的顺序发布。遵循以下清单

  1. 使用 scripts/release_status.sh 查看项目中使用的 moore/llhd crate 版本概述
  2. 更新所有 Cargo.toml 文件中的版本
  3. 使用 scripts/release_check.sh 确保所有 crate 的版本与根版本相同
  4. 确保 cargo 满意:cargo check
  5. 更新 CHANGELOG.md 文件
  6. 提交:git commit -am "Bump version to X.Y.Z
  7. 标记:git tag vX.Y.Z
  8. 使用 cargo publish 反向顺序发布所有 crate

lib.rs:

moore 编译器的过程宏。

依赖关系

~2MB
~43K SLoC