Spatz mxcore

.github/actions/setup-python/action.yml → .github/actions/setup-container/action.yml

@@ -2,8 +2,8 @@
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
 
-name: setup-python
-description: Install Python dependencies once per job, and cache across jobs
+name: setup-container
+description: Set up the container's Bender and Python dependencies
 
 runs:
   using: "composite"
@@ -30,6 +30,21 @@ runs:
         path: ~/.cache/uv
         key: uvcache-${{ hashFiles('uv.lock', '.python-version') }}
 
+    # Cache the .bender directory (checked out Bender dependencies)
+    - name: Cache Bender dependencies
+      uses: actions/cache@v4
+      with:
+        path: .bender
+        key: bender-${{ hashFiles('Bender.lock') }}
+
+    # In container jobs the entrypoint's `bender checkout` runs before
+    # actions/checkout populates the workspace, so it has no effect here and
+    # we need to check out Bender dependencies again after checkout.
+    - name: Checkout Bender dependencies
+      shell: sh
+      run: |
+        bender checkout
+
     - name: Sync Python environment
       shell: sh
       run: |

.github/workflows/ci.yml

@@ -37,13 +37,19 @@ jobs:
         # commit on this branch: CI doesn't necessarily run on every push
         # (e.g. superseded runs get cancelled), so a plain previous-commit
         # diff could silently skip over a real prerequisite change.
+        #
+        # On forks, `origin` is the fork itself, whose `main` can lag behind
+        # the upstream repo it was forked from, so we always fetch
+        # `main` from the canonical upstream repo instead of `origin`.
         run: |
           if [ "${{ github.ref_name }}" = "main" ]; then
-            echo "sha=${{ github.event.before }}" >> "$GITHUB_OUTPUT"
+            sha="${{ github.event.before }}"
           else
-            git fetch origin main
-            echo "sha=$(git merge-base origin/main HEAD)" >> "$GITHUB_OUTPUT"
+            git fetch https://github.com/pulp-platform/snitch_cluster.git main
+            sha="$(git merge-base FETCH_HEAD HEAD)"
           fi
+          echo "sha=$sha" >> "$GITHUB_OUTPUT"
+          echo "Base SHA: $sha"
 
   ##########################
   # Build Docker Container #
@@ -118,7 +124,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
       - name: Build docs
         run: make docs
 
@@ -133,7 +139,13 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
+      # For some reason, the checkout is done by a different user
+      # than that deploying to Github (root, possibly due to Docker).
+      # So we need to set the repository as a safe directory.
+      - name: Git config safe.directory
+        run: |
+          git config --global --add safe.directory $GITHUB_WORKSPACE
       - name: Generate documentation sources
         run: |
           make doc-srcs
@@ -155,7 +167,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
       - name: Run pytest
         run: pytest
 
@@ -173,7 +185,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
       - name: Hash Verilator prerequisites
         id: list-make-prerequisites
         uses: colluca/list-make-prerequisites@v1.0.0
@@ -203,7 +215,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
       - name: Build Software
         run: |
           make sw -j
@@ -238,7 +250,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
       - name: Hash Verilator prerequisites
         id: list-make-prerequisites
         uses: colluca/list-make-prerequisites@v1.0.0
@@ -260,7 +272,7 @@ jobs:
           make CFG_OVERRIDE=cfg/mempool.json verilator
       - name: Build Software for mempool tests
         run: |
-          make sw CFG_OVERRIDE=cfg/mempool.json SN_MCPU=snitch-mempool -j
+          make sw CFG_OVERRIDE=cfg/mempool.json -j
       - name: Run Tests
         run: |
           cd test
@@ -270,7 +282,54 @@ jobs:
         # testbench does not wait until all the instructions are retired
         # (compiler introduces few instructions after exit routine).
         run: |
-          make SIM_DIR=./test/runs/simple SN_MCPU=snitch-mempool DEBUG=ON annotate -j
+          make SIM_DIR=./test/runs/simple DEBUG=ON annotate -j
+
+  ######################################################
+  # Simulate SW on Snitch Cluster (Spatz) w/ Verilator #
+  ######################################################
+
+  snitch-spatz-cluster-vlt:
+    name: Build and Simulate Spatz Snitch Cluster w/ Verilator
+    runs-on: ubuntu-22.04
+    needs: [docker-meta, build-hw-image]
+    container:
+      image: ${{ needs.docker-meta.outputs.hw_image_name }}
+      volumes:
+        - ${{ github.workspace }}:/repo
+    defaults:
+      run:
+        working-directory: /repo
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+      - uses: ./.github/actions/setup-container
+      - name: Hash Verilator prerequisites
+        id: list-make-prerequisites
+        uses: colluca/list-make-prerequisites@v1.0.0
+        with:
+          target: verilator
+          flags: --recursive
+      - name: Set up cache for Verilator build
+        id: verilator-cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            /repo/target/sim/build/bin
+          key: verilator-spatz-${{ steps.list-make-prerequisites.outputs.hash }}
+          restore-keys: |
+            verilator-spatz-
+      - name: Build Hardware
+        if: steps.verilator-cache.outputs.cache-hit != 'true'
+        run: |
+          make CFG_OVERRIDE=cfg/spatz.json verilator
+      - name: Build Software
+        run: |
+          make CFG_OVERRIDE=cfg/spatz.json sw -j
+      - name: Run Tests
+        run: |
+          cd test
+          ../util/experiments/run.py spatz.yaml --simulator verilator -j
 
   #############
   # Synthesis #
@@ -292,10 +351,10 @@ jobs:
         with:
           submodules: 'recursive'
           fetch-depth: 0
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
       - name: Check if Yosys prerequisites changed
         id: make-prerequisites-changed
-        uses: colluca/make-prerequisites-changed@v1.1.1
+        uses: colluca/make-prerequisites-changed@v1.2.0
         with:
           target: yosys
           flags: --recursive
@@ -304,6 +363,15 @@ jobs:
         if: steps.make-prerequisites-changed.outputs.changed == 'true'
         run: |
           make CFG_OVERRIDE=cfg/yosys-ci.json yosys
+      - name: Upload Yosys logs
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: yosys-synthesis-logs
+          path: |
+            target/asic/yosys/*.log
+            target/asic/yosys/reports/
+          if-no-files-found: warn
 
   ######################
   # Sources Up-to-Date #
@@ -324,7 +392,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
-      - uses: ./.github/actions/setup-python
+      - uses: ./.github/actions/setup-container
       - name: Generate opcodes
         run: |
           ./util/clustergen/generate-opcodes.sh

.gitignore

@@ -4,7 +4,8 @@
 !/nonfree/util/.gitignore
 .cockpitgroup
 
-# Dependency files
+# Dependencies
+/deps
 /.bender/
 
 # Modelsim files

.gitlab-ci.yml

@@ -4,6 +4,7 @@
 
 variables:
   GIT_STRATEGY: clone
+  GIT_DEPTH: 0
   # Enable colors in CI terminal
   TERM: ansi
   FORCE_COLOR: 1
@@ -108,12 +109,9 @@ snitch-ip-tests:
           - snitch_cluster
           - tcdm_interface
           - snitch_ssr
-          - reqrsp_interface
   script:
     - make rtl -j
-    - cd hw/$IP
-    - ./util/compile.sh
-    - ./util/run_vsim.sh
+    - make test-$IP
 
 ####################
 # Simulation tests #
@@ -123,15 +121,15 @@ snitch-ip-tests:
 snitch-cluster-vlt:
   needs: [snitch-cluster-sw]
   script:
-    - make verilator
+    - make verilator TRACE=OFF -j
     - cd test
     - ../util/experiments/run.py run.yaml --simulator verilator -j --run-dir runs/vlt
 
 # VCS
 snitch-cluster-vcs:
   needs: [snitch-cluster-sw]
   script:
-    - make vcs
+    - make vcs TRACE=OFF -j
     - cd test
     - ../util/experiments/run.py run.yaml --simulator vcs -j --run-dir runs/vcs
 
@@ -164,42 +162,50 @@ snitch-cluster-vsim:
 snitch-cluster-omega-vsim:
   script:
     - make CFG_OVERRIDE=cfg/omega.json sw -j
-    - make vsim -j
+    - make vsim TRACE=OFF -j
     - cd test
     - ../util/experiments/run.py run.yaml --simulator vsim -j --run-dir runs/vsim
 
 # Test Multi-channel DMA
 snitch-cluster-mchan-vsim:
   script:
     - make CFG_OVERRIDE=cfg/dma_mchan.json sw -j
-    - make vsim -j
+    - make vsim TRACE=OFF -j
     - cd test
     - ../util/experiments/run.py dma_mchan.yaml --simulator vsim -j --run-dir runs/vsim
 
 # Test Mempool configuration
 snitch-cluster-mempool-vsim:
   script:
-    - make CFG_OVERRIDE=cfg/mempool.json SN_MCPU=snitch-mempool sw -j
+    - make CFG_OVERRIDE=cfg/mempool.json sw -j
     - make vsim -j
     - cd test
     - ../util/experiments/run.py mempool.yaml --simulator vsim -j --run-dir runs/vsim
-    - make -C .. SIM_DIR=$PWD/runs/vsim/simple SN_MCPU=snitch-mempool annotate -j
+    - make -C .. SIM_DIR=$PWD/runs/vsim/simple annotate -j
 
 # Additional tests for different FREP configurations
 snitch-cluster-frep-vsim:
   script:
     # Large FREP configuration
     - make CFG_OVERRIDE=cfg/frep_xl.json sw -j
-    - make vsim -j
+    - make vsim TRACE=OFF -j
     - cd test
     - ../util/experiments/run.py frep_xl.yaml --simulator vsim -j --run-dir runs/vsim
     - cd -
     # Small FREP configuration
     - make CFG_OVERRIDE=cfg/frep_xs.json sw -j
-    - make vsim -j
+    - make vsim TRACE=OFF -j
     - cd test
     - ../util/experiments/run.py frep_xs.yaml --simulator vsim -j --run-dir runs/vsim
 
+# Test Spatz configuration
+snitch-cluster-spatz-vsim:
+  script:
+    - make CFG_OVERRIDE=cfg/spatz.json sw -j
+    - make vsim TRACE=OFF -j
+    - cd test
+    - ../util/experiments/run.py spatz.yaml --simulator vsim -j --run-dir runs/vsim
+
 # COPIFT experiments
 snitch-cluster-copift-vsim:
   script:

Bender.lock

@@ -55,6 +55,22 @@ packages:
     source:
       Git: https://github.com/pulp-platform/common_verification.git
     dependencies: []
+  core_ips:
+    revision: e1a85a7f72d0d799dd9ecc4deb40e2e41969b88e
+    version: null
+    source:
+      Git: https://github.com/colluca/core_ips.git
+    dependencies:
+    - axi
+    - common_cells
+    - reqrsp_interface
+  core_v_xif:
+    revision: fad32c62f07ec7304a7169640eaf946da3727f77
+    version: null
+    source:
+      Git: https://github.com/pulp-platform/core-v-xif.git
+    dependencies:
+    - common_cells
   fpnew:
     revision: 46cb33a4ce6b04b83ec38ebd288dd58a031a6390
     version: null
@@ -101,6 +117,15 @@ packages:
     - axi
     - common_cells
     - common_verification
+  reqrsp_interface:
+    revision: 521f457d754471d9174d27c7c6c6c3892f3387a2
+    version: null
+    source:
+      Git: https://github.com/colluca/reqrsp_interface.git
+    dependencies:
+    - axi
+    - common_cells
+    - tech_cells_generic
   riscv-dbg:
     revision: 358f90110220adf7a083f8b65d157e836d706236
     version: 0.8.1
@@ -116,6 +141,17 @@ packages:
       Git: https://github.com/pulp-platform/scm.git
     dependencies:
     - tech_cells_generic
+  spatz_vpu:
+    revision: 0266c93f3e660db0d2eb756a00fa622b9076ddd9
+    version: null
+    source:
+      Git: https://github.com/pulp-platform/spatz_vpu.git
+    dependencies:
+    - common_cells
+    - core_ips
+    - fpnew
+    - reqrsp_interface
+    - tech_cells_generic
   tech_cells_generic:
     revision: 3a3de73632a06826b1bd9c65a0a2e92b32016845
     version: 0.2.14