ci: Verify the backend variants publicly with verilator and slang

.github/actions/verify-setup/action.yml

@@ -0,0 +1,35 @@
+# Copyright 2026 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+# Authors:
+# - Daniel Keller <dankeller@iis.ee.ethz.ch>
+
+name: Set up the public verification toolchain
+description: Bender database cache, uv, Bender and optionally Verilator
+inputs:
+  verilator:
+    description: Install Verilator from apt; ubuntu-24.04 ships 5.020
+    default: 'false'
+runs:
+  using: composite
+  steps:
+    - uses: ./.github/actions/bender-db-cache
+    - uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+    - uses: pulp-platform/pulp-actions/bender-install@v2.5.0
+      with:
+        version: 0.32.0
+    - if: inputs.verilator == 'true'
+      shell: bash
+      run: sudo apt-get update && sudo apt-get install -y verilator
+    - if: inputs.verilator == 'true'
+      shell: bash
+      run: |
+        verilator --version
+        verilator --version | grep -qE '^Verilator 5\.' || {
+          echo "expected Verilator 5.x from apt"; exit 1; }
+    - if: inputs.verilator == 'true'
+      shell: bash
+      run: uv run --locked make idma_verify_toolchain

.github/workflows/ci.yml

@@ -37,8 +37,14 @@ jobs:
     uses: ./.github/workflows/analyze.yml
     secrets: inherit
 
+  verify:
+    needs: lint
+    uses: ./.github/workflows/verify.yml
+    secrets: inherit
+
+  # The licensed EDA pipeline runs only once the license-free matrix is green
   gitlab-ci:
-    needs: build
+    needs: [build, verify]
     uses: ./.github/workflows/gitlab-ci.yml
     secrets: inherit
 

.github/workflows/lint.yml

@@ -32,6 +32,23 @@ jobs:
         exclude_paths: |
           target/sim/vsim/wave/tpl/*.do.tpl
 
+  # lint-sv is -diff scoped; this one checks all of src/
+  lint-sv-tree:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v5
+      -
+        name: Install Verible
+        uses: chipsalliance/verible-actions-common/install-verible@main
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          verible_version: "v0.0-3318-g8d254167"
+      -
+        name: Lint all of src
+        run: make idma_lint_sv
+
   lint-sv:
     runs-on: ubuntu-latest
     steps:
@@ -48,29 +65,6 @@ jobs:
         fail_on_error: true
         reviewdog_reporter: github-check
 
-#  lint-cxx:
-#    runs-on: ubuntu-latest
-#    steps:
-#    -
-#      name: Checkout
-#      uses: actions/checkout@v3
-#    -
-#      name: Run Clang-format
-#      uses: DoozyX/clang-format-lint-action@v0.14
-#      with:
-#        extensions: 'c,h,cpp'
-#        clangFormatVersion: 14
-#        style: >
-#          {
-#          IndentWidth: 4,
-#          ColumnLimit: 100,
-#          AlignEscapedNewlines: DontAlign,
-#          SortIncludes: false,
-#          AllowShortFunctionsOnASingleLine: None,
-#          AllowShortIfStatementsOnASingleLine: true,
-#          AllowShortLoopsOnASingleLine: true
-#          }
-
   lint-python:
     runs-on: ubuntu-latest
     steps:

.github/workflows/verify.yml

@@ -0,0 +1,157 @@
+# Copyright 2026 ETH Zurich and University of Bologna.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+# Author:
+# - Daniel Keller <dankeller@iis.ee.ethz.ch>
+
+# License-free verification matrix; the run set is src/db/verify.yml
+
+name: verify
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+
+  # jobs.json and the generated tree must still describe the same design
+  codegen-consistency:
+    runs-on: ubuntu-24.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up toolchain
+        uses: ./.github/actions/verify-setup
+      -
+        name: Check jobs.json, the CI matrix and codegen determinism
+        run: uv run --locked make idma_verify_codegen
+
+  # One backend variant: its jobs.json parameters, a width sweep, its testbench
+  elab-backend:
+    strategy:
+      fail-fast: false
+      matrix:
+        id:
+          - rw_axi
+          - r_obi_w_axi
+          - r_axi_w_obi
+          - rw_axi_rw_axis
+          - rw_obi
+          - r_obi_rw_init_w_axi
+          - r_axi_rw_init_rw_obi
+          - rw_axi_rw_init_rw_obi
+    runs-on: ubuntu-24.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up toolchain
+        uses: ./.github/actions/verify-setup
+        with:
+          verilator: 'true'
+      -
+        name: Generate RTL
+        run: uv run --locked make idma_hw_all
+      -
+        name: Elaborate ${{ matrix.id }}
+        run: uv run --locked make idma_verify_backend IDMA_VERIFY_ID=${{ matrix.id }}
+
+  # The non-backend synthesis tops, plus the inst64 testbench
+  elab-shared-tops:
+    runs-on: ubuntu-24.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up toolchain
+        uses: ./.github/actions/verify-setup
+        with:
+          verilator: 'true'
+      -
+        name: Generate RTL
+        run: uv run --locked make idma_hw_all
+      -
+        name: Elaborate the shared synthesis tops
+        run: uv run --locked make idma_verify_shared
+
+  # Testbench tops; verilator cannot parse the verification stack, so slang only
+  elab-tb-shared:
+    runs-on: ubuntu-24.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up toolchain
+        uses: ./.github/actions/verify-setup
+      -
+        name: Generate RTL
+        run: uv run --locked make idma_hw_all
+      -
+        name: Elaborate the shared testbenches
+        run: uv run --locked make idma_verify_tb_shared
+
+  # Out-of-tree multi-head build; license-free but generated only on request
+  elab-multihead:
+    runs-on: ubuntu-24.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up toolchain
+        uses: ./.github/actions/verify-setup
+        with:
+          verilator: 'true'
+      -
+        name: Elaborate the multi-head variants and testbenches
+        run: uv run --locked make idma_verify_multihead
+
+  # The suite list comes from the database, so a new suite needs no edit here
+  sim-matrix:
+    needs: [elab-backend, elab-shared-tops, elab-tb-shared]
+    runs-on: ubuntu-24.04
+    outputs:
+      suites: ${{ steps.legs.outputs.suites }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up toolchain
+        uses: ./.github/actions/verify-setup
+      -
+        name: Read the suites from the verification database
+        id: legs
+        run: |
+          suites=$(uv run --locked python util/run_verify.py --emit-matrix suites)
+          echo "suites=$suites" >> "$GITHUB_OUTPUT"
+
+  # Real simulation; run_verify.py knows which suites are negative tests
+  simulate:
+    needs: sim-matrix
+    if: needs.sim-matrix.outputs.suites != ''
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJSON(needs.sim-matrix.outputs.suites) }}
+    runs-on: ubuntu-24.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up toolchain
+        uses: ./.github/actions/verify-setup
+        with:
+          verilator: 'true'
+      -
+        name: Generate RTL
+        run: uv run --locked make idma_hw_all
+      -
+        name: Simulate ${{ matrix.suite }}
+        run: uv run --locked make idma_verify_sim_${{ matrix.suite }} IDMA_VLT_MAKEFLAGS=-j4

Bender.yml

@@ -136,6 +136,7 @@ sources:
   - target: idma_test
     files:
       - target/rtl/tb_idma_generated.sv
+      - test/tb_idma_otf_transpose.sv
       - test/tb_idma_transpose_nd.sv
       - test/tb_idma_transpose_b2b.sv
       - test/tb_idma_mxquant.sv

CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+## Unreleased
+
+### Changed
+- **Breaking**: the tracer is generated one header per backend id. `idma/tracer.svh` now only holds the id-independent helpers; the `IDMA_TRACER_<ID>` macro of a variant lives in `idma/tracer_<id>.svh`, which includes `idma/tracer.svh` itself. Downstream users replace `` `include "idma/tracer.svh" `` with the per-id header of the variant they trace.
+
+
 ## 0.6.5 - 2025-07-15
 
 ### Added

doc/site/src/content/docs/architecture/backend.md

@@ -90,7 +90,9 @@ Each backend variant combines a set of read and write protocols:
 | `r_axi_rw_init_rw_obi` | AXI4 | INIT + OBI |
 | `rw_axi_rw_init_rw_obi` | AXI4 | AXI4 + INIT + OBI |
 
-The active set is `IDMA_BACKEND_IDS` in `idma.mk`; extend it with `IDMA_ADD_IDS` for custom protocol combinations.
+The tracked set is `IDMA_TREE_IDS` in `idma.mk`; extend it with `IDMA_ADD_IDS` for custom protocol combinations. Add-id variants are generated by `make idma_hw_all idma_add_all IDMA_ADD_IDS="..."` into `target/rtl/idma_generated_add.sv` and reach Bender through the `add_ids` target.
+
+Each variant also gets its own tracer header, `idma/tracer_<id>.svh`, holding the `IDMA_TRACER_<ID>` macro; `idma/tracer.svh` carries only the id-independent helpers and is included by the per-id headers.
 
 ![Variant Matrix](/iDMA/fig/variant_matrix.svg)