Link against CIRCT and use it for codegen

.github/build-circt.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -e
+
+mkdir -p circt/build
+cd 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 . -- -j$(nproc)

.github/build-llvm.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -e
+
+mkdir -p circt/llvm/build
+cd 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=""
+
+cmake --build . -- -j$(nproc)

.github/workflows/ci.yml

@@ -3,67 +3,119 @@ on: [push, pull_request]
 name: CI
 
 jobs:
-  check:
-    name: Check
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        name: "source checkout"
-      - uses: actions-rs/toolchain@v1
-        name: "toolchain installation"
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - uses: actions-rs/cargo@v1
-        name: "cargo check"
-        with:
-          command: check
-
   lints:
     name: Lints
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-        name: "source checkout"
-      - uses: actions-rs/toolchain@v1
-        name: "toolchain installation"
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           override: true
           components: rustfmt, clippy
 
-      - uses: actions-rs/cargo@v1
-        name: "cargo fmt"
+      - name: Run rustfmt
+        uses: actions-rs/cargo@v1
         with:
           command: fmt
           args: --all -- --check
 
-      - uses: actions-rs/cargo@v1
-        name: "cargo clippy"
-        continue-on-error: true  # TODO: Remove once we have fixed the mall
+      - name: Run clippy
+        uses: actions-rs/cargo@v1
+        continue-on-error: true  # TODO: Remove once we have fixed them all
         with:
           command: clippy
 
-  test:
-    name: Tests
+  check:
+    name: Checks
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-        name: "source checkout"
+      - name: Checkout sources
+        uses: actions/checkout@v2
         with:
           submodules: recursive
-      - uses: actions-rs/toolchain@v1
-        name: "toolchain installation"
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           override: true
-      - uses: actions-rs/cargo@v1
-        name: "cargo test"
+          components: rustfmt, clippy
+
+      - name: Configure Environment
+        id: env
+        run: |
+          echo "CIRCT_SYS_CIRCT_DIR=$GITHUB_WORKSPACE/circt" >> $GITHUB_ENV
+          echo "::set-output name=circt-hash::$(git rev-parse @:./circt)"
+          echo "::set-output name=llvm-hash::$(cd circt && git rev-parse @:./llvm)"
+
+      # Fetch LLVM from the cache if possible, otherwise rebuild it.
+      - name: Fetch LLVM from cache
+        id: cache-llvm
+        uses: martijnhols/actions-cache/restore@v3
+        with:
+          path: circt/llvm/build
+          key: ${{ runner.os }}-llvm-${{ hashFiles('.github/build-llvm.sh') }}-${{ steps.env.outputs.llvm-hash }}
+
+      - name: Rebuild LLVM
+        if: steps.cache-llvm.outputs.cache-hit != 'true'
+        run: .github/build-llvm.sh
+
+      - name: Upload LLVM to cache
+        if: steps.cache-llvm.outputs.cache-hit != 'true'
+        uses: martijnhols/actions-cache/save@v3
+        with:
+          path: circt/llvm/build
+          key: ${{ steps.cache-llvm.outputs.primary-key }}
+
+      # Fetch CIRCT from the cache if possible, otherwise rebuild it.
+      - name: Fetch CIRCT from cache
+        id: cache-circt
+        uses: martijnhols/actions-cache/restore@v3
+        with:
+          path: circt/build
+          key: ${{ runner.os }}-circt-${{ hashFiles('.github/build-circt.sh') }}-${{ steps.env.outputs.circt-hash }}
+
+      - name: Rebuild CIRCT
+        if: steps.cache-circt.outputs.cache-hit != 'true'
+        run: .github/build-circt.sh
+
+      - name: Upload CIRCT to cache
+        if: steps.cache-circt.outputs.cache-hit != 'true'
+        uses: martijnhols/actions-cache/save@v3
+        with:
+          path: circt/build
+          key: ${{ steps.cache-circt.outputs.primary-key }}
+
+      # Run the quick check build.
+      - name: Run "cargo check"
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --all
+
+      # Run the regular build.
+      - name: Run "cargo build"
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+
+      # Run the unit tests.
+      - name: Run "cargo test"
+        uses: actions-rs/cargo@v1
         with:
           command: test
           args: --all
-      - run: python3 scripts/test.py --debug --verbose
-        name: "regression tests"
+
+      # Run the tests.
+      - name: Run lit tests
+        run: circt/llvm/build/bin/llvm-lit test -v
+      - name: Run regression tests (old)
+        run: env TERM=xterm-color test/run.sh
+      - name: Run regression tests (new)
+        run: python3 scripts/test.py --debug --verbose

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "test/third-party/common_cells"]
 	path = test/third-party/common_cells
 	url = https://github.com/pulp-platform/common_cells.git
+[submodule "circt"]
+	path = circt
+	url = https://github.com/fabianschuiki/circt.git

Cargo.toml

@@ -19,6 +19,7 @@ moore-common = { path = "src/common", version = "0.13.2" }
 moore-derive = { path = "src/derive", version = "0.13.2" }
 moore-svlog = { path = "src/svlog", version = "0.13.2" }
 moore-vhdl = { path = "src/vhdl", version = "0.13.2" }
+circt = { path = "src/circt" }
 clap = "2"
 llhd = "0.16"
 # llhd = { git = "https://github.com/fabianschuiki/llhd" }

README.md

@@ -12,10 +12,62 @@ Moore is a compiler for hardware description languages that outputs [llhd] assem
 
 ### Installation
 
-You need a working [Rust installation](https://rustup.rs/). Use cargo to install moore:
+You need a working [Rust installation](https://rustup.rs/) to build Moore. The project also depends on the [CIRCT project](https://github.com/llvm/circt) and transitively on MLIR and LLVM. To get a working binary, you generally want to ensure you have the `circt` and `circt/llvm` submodules checked out:
+
+    git submodule update --init --recursive
+
+And then follow these steps:
+
+#### Build LLVM and MLIR
+
+    mkdir -p circt/llvm/build
+    pushd circt/llvm/build
+    cmake ../llvm \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DCMAKE_INSTALL_PREFIX=../install \
+        -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=""
+    cmake --build . --target install
+    popd
+
+#### Build CIRCT
+
+    mkdir -p circt/build
+    pushd circt/build
+    cmake .. \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DCMAKE_INSTALL_PREFIX=../install \
+        -DMLIR_DIR=$PWD/../llvm/install/lib/cmake/mlir \
+        -DLLVM_DIR=$PWD/../llvm/install/lib/cmake/llvm \
+        -DLLVM_ENABLE_ASSERTIONS=ON
+    cmake --build . --target install
+    popd
+
+#### Build Moore
+
+Set the following environment variables to indicate where your LLVM and CIRCT build is:
+
+    export CIRCT_SYS_CIRCT_DIR=$PWD/circt
+    export CIRCT_SYS_CIRCT_BUILD_DIR=$PWD/circt/install
+    export CIRCT_SYS_LLVM_DIR=$PWD/circt/llvm
+    export CIRCT_SYS_LLVM_BUILD_DIR=$PWD/circt/llvm/install
+
+Use cargo to install Moore:
 
     cargo install moore
 
+#### Development
+
+For active development, you'll want to use the usual `check`, `build`, `run`, and `test` subcommands.
+
+You may also find it useful to point the `*_BUILD_DIR` environment variables at the actual build directories (usually `circt/llvm/build` and `circt/build`), such that you don't need to re-install on every change to CIRCT or LLVM.
+
 ### Example
 
 Assume the following input file:

scripts/test.py

@@ -266,7 +266,8 @@ def finish(self):
 else:
     suffices = ["sv", "v", "vhd"]
     third_party = test_dir/"third-party"
-    globs = [[p for p in test_dir.glob("**/*."+suffix) if third_party not in p.parents] for suffix in suffices]
+    mlir = test_dir/"mlir"
+    globs = [[p for p in test_dir.glob("**/*."+suffix) if third_party not in p.parents and mlir not in p.parents] for suffix in suffices]
     tests = [TestCase(p.relative_to(test_dir), p) for p in sorted(itertools.chain(*globs))]
 sys.stdout.write("running {} tests\n".format(len(tests)))