Link against CIRCT and use it for codegen

.github/build-circt.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+set -e
+
+mkdir -p circt/build
+mkdir -p circt/install
+cd circt/build
+cmake .. \
+    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_INSTALL_PREFIX=../install \
+    -DMLIR_DIR=$PWD/../llvm/build/lib/cmake/mlir \
+    -DLLVM_DIR=$PWD/../llvm/build/lib/cmake/llvm \
+    -DLLVM_ENABLE_ASSERTIONS=ON
+
+cmake --build . --target install -- -j$(nproc)

.github/build-llvm.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+set -e
+
+mkdir -p circt/llvm/build
+mkdir -p circt/llvm/install
+cd 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 -- -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" }

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)))
 

src/bin/moore.rs

@@ -5,9 +5,10 @@
 #[macro_use]
 extern crate log;
 
+use circt::{mlir, prelude::*};
 use clap::{App, Arg, ArgMatches};
 use llhd;
-use llhd::opt::{Pass, PassContext};
+// use llhd::opt::{Pass, PassContext};
 use moore::common::score::NodeRef;
 use moore::errors::*;
 use moore::name::Name;
@@ -144,7 +145,13 @@ fn main() {
                 .long("format")
                 .help("Output format")
                 .takes_value(true)
-                .possible_values(&["llhd", "mlir"]),
+                .possible_values(&["llhd", "mlir", "mlir-native"]),
+        )
+        .arg(
+            Arg::with_name("debug-info")
+                .short("g")
+                .long("debug-info")
+                .help("Emit location information as part of the output"),
         )
         .arg(
             Arg::with_name("INPUT")
@@ -487,21 +494,31 @@ fn elaborate_name(
                 svlog::InstVerbosityVisitor::new(ctx.svlog).visit_node_with_id(m, false);
             }
 
-            let mut cg = svlog::CodeGenerator::new(ctx.svlog);
+            let mlir_cx = mlir::OwnedContext::new();
+            mlir_cx.load_dialect(circt::std::dialect());
+            mlir_cx.load_dialect(circt::hw::dialect());
+            mlir_cx.load_dialect(circt::comb::dialect());
+            mlir_cx.load_dialect(circt::llhd::dialect());
+            mlir_cx.load_dialect(circt::seq::dialect());
+
+            let mlir_module = circt::ModuleOp::new(*mlir_cx);
+
+            let mut cg = svlog::CodeGenerator::new(ctx.svlog, mlir_module);
             cg.emit_module(m)?;
-            let mut module = cg.finalize();
-            let pass_ctx = PassContext;
-            if ctx.sess.opts.opt_level > 0 {
-                llhd::pass::ConstFolding::run_on_module(&pass_ctx, &mut module);
-                // llhd::pass::VarToPhiPromotion::run_on_module(&pass_ctx, &mut module); // broken in llhd 0.13
-                llhd::pass::DeadCodeElim::run_on_module(&pass_ctx, &mut module);
-                llhd::pass::GlobalCommonSubexprElim::run_on_module(&pass_ctx, &mut module);
-                llhd::pass::InstSimplification::run_on_module(&pass_ctx, &mut module);
-                llhd::pass::DeadCodeElim::run_on_module(&pass_ctx, &mut module);
-            }
+            let module = cg.finalize();
+            // let mut module = cg.finalize();
+            // let pass_ctx = PassContext;
+            // if ctx.sess.opts.opt_level > 0 {
+            //     llhd::pass::ConstFolding::run_on_module(&pass_ctx, &mut module);
+            //     llhd::pass::VarToPhiPromotion::run_on_module(&pass_ctx, &mut module); // broken in llhd 0.13
+            //     llhd::pass::DeadCodeElim::run_on_module(&pass_ctx, &mut module);
+            //     llhd::pass::GlobalCommonSubexprElim::run_on_module(&pass_ctx, &mut module);
+            //     llhd::pass::InstSimplification::run_on_module(&pass_ctx, &mut module);
+            //     llhd::pass::DeadCodeElim::run_on_module(&pass_ctx, &mut module);
+            // }
 
             // Decide what format to use for the output.
-            emit_output(matches, ctx, &module)?;
+            emit_output(matches, ctx, &module, mlir_module)?
         }
     }
     Ok(())
@@ -511,17 +528,20 @@ fn elaborate_name(
 enum OutputFormat {
     Llhd,
     Mlir,
+    MlirNative,
 }
 
 fn emit_output(
     matches: &ArgMatches,
     ctx: &ScoreContext,
     module: &llhd::ir::Module,
+    mlir_module: circt::ModuleOp,
 ) -> Result<(), ()> {
     // Check if the user has provided an explicit output format.
     let fmt = match matches.value_of("output-format") {
         Some("llhd") => Some(OutputFormat::Llhd),
         Some("mlir") => Some(OutputFormat::Mlir),
+        Some("mlir-native") => Some(OutputFormat::MlirNative),
         Some(x) => {
             ctx.sess.emit(DiagBuilder2::fatal(format!(
                 "unknown output format: `{}`",
@@ -566,6 +586,7 @@ fn emit_output(
     match fmt {
         OutputFormat::Llhd => llhd::assembly::write_module(output, &module),
         OutputFormat::Mlir => llhd::mlir::write_module(output, &module),
+        OutputFormat::MlirNative => mlir_module.print(output, matches.is_present("debug-info")),
     };
     Ok(())
 }

src/circt-sys/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "circt-sys"
+version = "0.1.0"
+authors = ["Fabian Schuiki <fabian@schuiki.ch>"]
+edition = "2018"
+
+[dependencies]
+libc = "0.2"
+
+[build-dependencies]
+bindgen = "0.59.0"
+cc = "1.0"