feat(ssa): SSA CLI (#9826)

Author: aakoshh

.github/actions/download-noir-ssa/action.yml

@@ -0,0 +1,18 @@
+name: Download noir-ssa
+description: Downloads the noir-ssa binary from an artifact and adds it to the path
+
+runs:
+  using: composite
+  steps:
+    - name: Download noir-ssa binary
+      uses: actions/download-artifact@v4
+      with:
+        name: noir-ssa
+        path: ./noir-ssa
+
+    - name: Set noir-ssa on PATH
+      shell: bash
+      run: |
+        noir_binary="${{ github.workspace }}/noir-ssa/noir-ssa"
+        chmod +x $noir_binary
+        echo "$(dirname $noir_binary)" >> $GITHUB_PATH

.github/workflows/test-js-packages.yml

@@ -99,7 +99,7 @@ jobs:
           cache-on-failure: true
           save-if: ${{ github.event_name != 'merge_group' }}
 
-      - name: Build noir-execute
+      - name: Build artifact
         run: cargo build --package noir_artifact_cli --release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -111,6 +111,37 @@ jobs:
           path: ./target/release/noir-execute
           retention-days: 3
 
+  build-noir-ssa:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 30
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout Noir repo
+        uses: actions/checkout@v5
+
+      - name: Setup toolchain
+        uses: dtolnay/[email protected]
+
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: x86_64-unknown-linux-gnu
+          cache-on-failure: true
+          save-if: ${{ github.event_name != 'merge_group' }}
+
+      - name: Build artifact
+        run: cargo build --package noir_ssa_cli --release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: noir-ssa
+          path: ./target/release/noir-ssa
+          retention-days: 3
+
   build-noirc-abi:
     runs-on: ubuntu-22.04
     timeout-minutes: 30
@@ -533,7 +564,7 @@ jobs:
   test-examples:
     name: Example scripts
     runs-on: ubuntu-24.04
-    needs: [build-nargo, build-noir-execute, build-acvm-js, build-noirc-abi]
+    needs: [build-nargo, build-noir-execute, build-noir-ssa, build-acvm-js, build-noirc-abi]
     timeout-minutes: 30
     permissions:
       contents: read
@@ -567,6 +598,9 @@ jobs:
       - name: Download noir-execute binary
         uses: ./.github/actions/download-noir-execute
 
+      - name: Download noir-ssa binary
+        uses: ./.github/actions/download-noir-ssa
+
       - name: Download acvm_js package artifact
         uses: actions/download-artifact@v4
         with:

Cargo.lock

@@ -43,6 +43,7 @@ members = [
     # Utility crates
     "utils/iter-extended",
 
+    "tooling/ssa_cli",
     "tooling/ssa_fuzzer",
     "tooling/ssa_fuzzer/fuzzer",
     "tooling/ssa_verification",
@@ -53,6 +54,7 @@ default-members = [
     "tooling/nargo_cli",
     "tooling/acvm_cli",
     "tooling/artifact_cli",
+    "tooling/ssa_cli",
     "tooling/profiler",
     "tooling/inspector",
 ]

Cargo.toml

@@ -10,11 +10,8 @@ pub use position::{Located, Location, Position};
 pub use reporter::{CustomDiagnostic, DiagnosticKind};
 use std::io::Write;
 
-/// Print the input to stdout, and exit gracefully if `SIGPIPE` is received.
-/// Rust ignores `SIGPIPE` by default, converting pipe errors into `ErrorKind::BrokenPipe`
-pub fn print_to_stdout(args: std::fmt::Arguments) {
-    let mut stdout = std::io::stdout();
-    if let Err(e) = stdout.write_fmt(args) {
+pub fn print_args_or_exit<W: Write>(args: std::fmt::Arguments, mut out: W) {
+    if let Err(e) = out.write_fmt(args) {
         if e.kind() == std::io::ErrorKind::BrokenPipe {
             // Gracefully exit on broken pipe
             std::process::exit(0);
@@ -24,6 +21,18 @@ pub fn print_to_stdout(args: std::fmt::Arguments) {
     }
 }
 
+/// Print the input to stdout, and exit gracefully if `SIGPIPE` is received.
+/// Rust ignores `SIGPIPE` by default, converting pipe errors into `ErrorKind::BrokenPipe`
+pub fn print_to_stdout(args: std::fmt::Arguments) {
+    print_args_or_exit(args, std::io::stdout());
+}
+
+/// Print the input to stderr, and exit gracefully if `SIGPIPE` is received.
+/// Rust ignores `SIGPIPE` by default, converting pipe errors into `ErrorKind::BrokenPipe`
+pub fn print_to_stderr(args: std::fmt::Arguments) {
+    print_args_or_exit(args, std::io::stderr());
+}
+
 /// Macro to print formatted output to stdout
 #[macro_export]
 macro_rules! print_to_stdout {
@@ -32,9 +41,26 @@ macro_rules! print_to_stdout {
     };
 }
 
+/// Macro to print formatted output to stdout
 #[macro_export]
 macro_rules! println_to_stdout {
     ($($arg:tt)*) => {
         noirc_errors::print_to_stdout(format_args!("{}\n", format!($($arg)*)))
     };
 }
+
+/// Macro to print formatted output to stderr
+#[macro_export]
+macro_rules! print_to_stderr {
+    ($($arg:tt)*) => {
+        noirc_errors::print_to_stderr(format_args!($($arg)*))
+    };
+}
+
+/// Macro to print formatted output to stderr
+#[macro_export]
+macro_rules! println_to_stderr {
+    ($($arg:tt)*) => {
+        noirc_errors::print_to_stderr(format_args!("{}\n", format!($($arg)*)))
+    };
+}

compiler/noirc_errors/src/lib.rs

@@ -190,16 +190,7 @@ impl<'local> SsaBuilder<'local> {
             self.ssa.normalize_ids();
         }
 
-        let print_ssa_pass = match &self.ssa_logging {
-            SsaLogging::None => false,
-            SsaLogging::All => true,
-            SsaLogging::Contains(strings) => strings.iter().any(|string| {
-                let string = string.to_lowercase();
-                let string = string.strip_prefix("after ").unwrap_or(&string);
-                let string = string.strip_suffix(':').unwrap_or(string);
-                msg.to_lowercase().contains(string)
-            }),
-        };
+        let print_ssa_pass = self.ssa_logging.matches(msg);
 
         if print_ssa_pass {
             println_to_stdout!("After {msg}:\n{}", self.ssa.print_with(self.files));

compiler/noirc_evaluator/src/ssa/builder.rs

@@ -239,6 +239,16 @@ impl Function {
     pub fn has_data_bus_return_data(&self) -> bool {
         self.dfg.data_bus.return_data.is_some()
     }
+
+    /// Return the types of the function parameters.
+    pub fn parameter_types(&self) -> Vec<Type> {
+        vecmap(self.parameters(), |p| self.dfg.type_of_value(*p))
+    }
+
+    /// Return the types of the returned values, if there are any.
+    pub fn return_types(&self) -> Option<Vec<Type>> {
+        self.returns().map(|rs| vecmap(rs, |p| self.dfg.type_of_value(*p)))
+    }
 }
 
 impl Clone for Function {

compiler/noirc_evaluator/src/ssa/ir/function.rs

@@ -60,6 +60,22 @@ pub enum SsaLogging {
     Contains(Vec<String>),
 }
 
+impl SsaLogging {
+    /// Check if an SSA pass should be printed.
+    pub fn matches(&self, msg: &str) -> bool {
+        match self {
+            SsaLogging::None => false,
+            SsaLogging::All => true,
+            SsaLogging::Contains(strings) => strings.iter().any(|string| {
+                let string = string.to_lowercase();
+                let string = string.strip_prefix("after ").unwrap_or(&string);
+                let string = string.strip_suffix(':').unwrap_or(string);
+                msg.to_lowercase().contains(string)
+            }),
+        }
+    }
+}
+
 #[derive(Debug, Clone)]
 pub struct SsaEvaluatorOptions {
     /// Emit debug information for the intermediate SSA IR

compiler/noirc_evaluator/src/ssa/mod.rs

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -eu
+
+cd $(dirname $0)
+
+# This file is used for Noir CI and is not required.
+
+./transform_and_interpret_ssa.sh

examples/ssa_cli/test.sh

@@ -0,0 +1,22 @@
+acir(inline) fn main f0 {
+  b0(v0: [[u8; 2]; 2], v1: u1, v2: u32):
+    jmpif v1 then: b1, else: b2
+  b1():
+    v3 = array_get v0, index v2 -> [u8; 2]
+    v4 = array_get v3, index v2 -> u8
+    call f1(v4)
+    jmp b2()
+  b2():
+    return
+}
+acir(inline) fn println f1 {
+  b0(v0: u8):
+    call f2(u1 1, v0)
+    return
+}
+brillig(inline) fn print_unconstrained f2 {
+  b0(v0: u1, v1: u8):
+    v20 = make_array b"{\"kind\":\"unsignedinteger\",\"width\":8}"
+    call print(v0, v1, v20, u1 0)
+    return
+}