treewide: Miscellaneous changes to bump dependency in Occamy (#193)

* treewide: Remove verible, unused in Snitch

* treewide: Update after iDMA integration

* treewide: Bump `cluster_icache`

* target: Turn assertions off for Verilator

Required to bump to common_cells 1.38.0

* bender: Bump dependencies

* target: Do not generate `*.dep` files on any `clean` target

* target: Remove DWARF targets and dumps when `DEBUG=OFF`

* target: Improve Makefile reusability for use in Occamy

* target: Use Verilator to generate accurate dependency files

* snRuntime: Rename `snitch_cluster_start.S` to `snrt.S`

The shift to a name which is not specific to a particular system
makes building system-specific snRuntime implementations easier,
as these can reuse existing build scripts directly.

* snRuntime: Improve all-to-all reduction routine

* snRuntime: Improve `riscv_decls.h`

* snRuntime: Explicitize transfer dependency in `snrt_init_tls`

* util/sim: Improve Python imports in simulation classes

* util/sim: Report interrupted processes as not completed

* util/trace: Log line number on exception in DMA trace

* ci: Encode `build-docker`->`deploy-docs` dependency

* ci: Enable Docker build on forks

* docs: Add missing `snitch_occupancy` metric

Author: colluca

.github/workflows/ci.yml

@@ -39,26 +39,48 @@ jobs:
           cache-to: type=gha,mode=max`
           file: util/container/Dockerfile
           push: true
-          tags: ghcr.io/pulp-platform/snitch_cluster:${{ github.ref_name }}
+          tags: ghcr.io/${{ github.repository_owner }}/snitch_cluster:${{ github.ref_name }}
 
   ########
   # Docs #
   ########
 
-  docs:
+  build-docs:
     name: Build documentation
     runs-on: ubuntu-22.04
     needs: build-docker
     if: >
       github.event_name != 'pull_request' ||
       github.event.pull_request.head.repo.full_name != github.repository
     container:
-      image: ghcr.io/pulp-platform/snitch_cluster:${{ github.ref_name }}
+      image: ghcr.io/${{ github.repository_owner }}/snitch_cluster:${{ github.ref_name }}
     steps:
       - uses: actions/checkout@v2
       - name: Build docs
         run: make docs
 
+  deploy-docs:
+    name: Deploy documentation
+    runs-on: ubuntu-22.04
+    needs: build-docker
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    container:
+      image: ghcr.io/pulp-platform/snitch_cluster:${{ github.ref_name }}
+    steps:
+      - uses: actions/checkout@v2
+      # 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
+          make doxygen-docs
+      - name: Build and deploy documentation
+        run: mkdocs gh-deploy --force
+
   #####################
   # Python unit tests #
   #####################
@@ -71,7 +93,7 @@ jobs:
       github.event_name != 'pull_request' ||
       github.event.pull_request.head.repo.full_name != github.repository
     container:
-      image: ghcr.io/pulp-platform/snitch_cluster:${{ github.ref_name }}
+      image: ghcr.io/${{ github.repository_owner }}/snitch_cluster:${{ github.ref_name }}
     steps:
       - uses: actions/checkout@v2
       - name: Run pytest
@@ -89,7 +111,7 @@ jobs:
       github.event_name != 'pull_request' ||
       github.event.pull_request.head.repo.full_name != github.repository
     container:
-      image: ghcr.io/pulp-platform/snitch_cluster:${{ github.ref_name }}
+      image: ghcr.io/${{ github.repository_owner }}/snitch_cluster:${{ github.ref_name }}
     steps:
       - uses: actions/checkout@v2
         with:
@@ -139,7 +161,7 @@ jobs:
       github.event_name != 'pull_request' ||
       github.event.pull_request.head.repo.full_name != github.repository
     container:
-      image: ghcr.io/pulp-platform/snitch_cluster:${{ github.ref_name }}
+      image: ghcr.io/${{ github.repository_owner }}/snitch_cluster:${{ github.ref_name }}
     steps:
       - uses: actions/checkout@v4
         with:

.github/workflows/publish-docs.yml

@@ -7,8 +7,8 @@ packages:
     dependencies:
     - common_cells
   axi:
-    revision: 4e54ac6766b160217a83a74d5a23af9bbf59e6ee
-    version: null
+    revision: 39f5f2d51c5e524f6fc5cf8b6e901f7dcc5622d7
+    version: 0.39.6
     source:
       Git: https://github.com/pulp-platform/axi
     dependencies:
@@ -32,8 +32,8 @@ packages:
     dependencies:
     - common_cells
   cluster_icache:
-    revision: 0e1fb6751d9684d968ba7fb40836e6118b448ecd
-    version: 0.1.1
+    revision: 64e21ae455bbdde850c4df13bef86ea55ac42537
+    version: 0.2.0
     source:
       Git: https://github.com/pulp-platform/cluster_icache.git
     dependencies:
@@ -42,16 +42,16 @@ packages:
     - scm
     - tech_cells_generic
   common_cells:
-    revision: c27bce39ebb2e6bae52f60960814a2afca7bd4cb
-    version: 1.37.0
+    revision: 9afda9abb565971649c2aa0985639c096f351171
+    version: 1.38.0
     source:
       Git: https://github.com/pulp-platform/common_cells
     dependencies:
     - common_verification
     - tech_cells_generic
   common_verification:
-    revision: 9c07fa860593b2caabd9b5681740c25fac04b878
-    version: 0.2.3
+    revision: fb1885f48ea46164a10568aeff51884389f67ae3
+    version: 0.2.5
     source:
       Git: https://github.com/pulp-platform/common_verification.git
     dependencies: []
@@ -71,8 +71,8 @@ packages:
     dependencies:
     - common_cells
   idma:
-    revision: 1a42da9d5c76f1cff0bcdaaacc474ed85631d734
-    version: null
+    revision: ff5d56fffb3767814db88d6bf8f381974ea33aa5
+    version: 0.6.4
     source:
       Git: https://github.com/pulp-platform/iDMA
     dependencies:
@@ -83,16 +83,16 @@ packages:
     - obi
     - register_interface
   obi:
-    revision: 5321106817e177d6c16ecc4daa922b96b1bc946b
-    version: 0.1.5
+    revision: 8097928cf1b43712f93d5356f336397879b4ad2c
+    version: 0.1.6
     source:
       Git: https://github.com/pulp-platform/obi.git
     dependencies:
     - common_cells
     - common_verification
   register_interface:
-    revision: ae616e5a1ec2b41e72d200e5ab09c65e94aebd3d
-    version: 0.4.4
+    revision: 5daa85d164cf6b54ad061ea1e4c6f3624556e467
+    version: 0.4.5
     source:
       Git: https://github.com/pulp-platform/register_interface
     dependencies:
@@ -109,11 +109,12 @@ packages:
     - common_cells
     - tech_cells_generic
   scm:
-    revision: 998466d2a3c2d7d572e43d2666d93c4f767d8d60
-    version: 1.1.1
+    revision: 472f99affe44ff7b282b519c047a3cfeb35b16c6
+    version: 1.2.0
     source:
       Git: https://github.com/pulp-platform/scm.git
-    dependencies: []
+    dependencies:
+    - tech_cells_generic
   tech_cells_generic:
     revision: 7968dd6e6180df2c644636bc6d2908a49f2190cf
     version: 0.2.13

Bender.lock

@@ -19,15 +19,15 @@ package:
     - Matheus Cavalcante <matheusd@iis.ee.ethz.ch>
 
 dependencies:
-  axi:                { git: https://github.com/pulp-platform/axi,                rev:  4e54ac6766b160217a83a74d5a23af9bbf59e6ee  }
-  axi_riscv_atomics:  { git: https://github.com/pulp-platform/axi_riscv_atomics,  version:  0.6.0   }
-  common_cells:       { git: https://github.com/pulp-platform/common_cells,       version:  1.35.0  }
-  FPnew:              { git: "https://github.com/pulp-platform/cvfpu.git",        rev:      pulp-v0.1.3 }
-  register_interface: { git: https://github.com/pulp-platform/register_interface, version:  0.4.2   }
-  tech_cells_generic: { git: https://github.com/pulp-platform/tech_cells_generic, version:  0.2.11  }
-  riscv-dbg:          { git: https://github.com/pulp-platform/riscv-dbg,          version:  0.8.0   }
-  cluster_icache:     { git: https://github.com/pulp-platform/cluster_icache.git, version:  0.1.0   }
-  idma:               { git: https://github.com/pulp-platform/iDMA,               rev: __deploy__9cbcd30__snitch-tracing }
+  axi:                { git: https://github.com/pulp-platform/axi,                version:  0.39.6      }
+  axi_riscv_atomics:  { git: https://github.com/pulp-platform/axi_riscv_atomics,  version:  0.6.0       }
+  common_cells:       { git: https://github.com/pulp-platform/common_cells,       version:  1.35.0      }
+  FPnew:              { git: https://github.com/pulp-platform/cvfpu.git,          rev:      pulp-v0.1.3 }
+  register_interface: { git: https://github.com/pulp-platform/register_interface, version:  0.4.2       }
+  tech_cells_generic: { git: https://github.com/pulp-platform/tech_cells_generic, version:  0.2.13      }
+  riscv-dbg:          { git: https://github.com/pulp-platform/riscv-dbg,          version:  0.8.0       }
+  cluster_icache:     { git: https://github.com/pulp-platform/cluster_icache.git, rev: 64e21ae455bbdde850c4df13bef86ea55ac42537 }
+  idma:               { git: https://github.com/pulp-platform/iDMA,               version:  0.6.4       }
 
 export_include_dirs:
   - hw/reqrsp_interface/include
@@ -185,10 +185,10 @@ sources:
       - target/common/test/tb_bin.sv
 
   # target/snitch_cluster
-  - target: snitch_cluster
+  - target: snitch_cluster_wrapper
     files:
       - target/snitch_cluster/generated/snitch_cluster_wrapper.sv
-  - target: all(snitch_cluster, any(simulation, verilator))
+  - target: all(snitch_cluster_wrapper, any(simulation, verilator))
     files:
       - target/snitch_cluster/test/vip_snitch_cluster.sv
       - target/snitch_cluster/test/testharness.sv

Bender.yml

@@ -27,7 +27,7 @@ ROOT = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 ############
 
 NONFREE_REMOTE ?= git@iis-git.ee.ethz.ch:pulp-restricted/snitch-cluster-nonfree.git
-NONFREE_COMMIT ?= e30961e20a23a76442da27d2ba07c9fe20f3b575
+NONFREE_COMMIT ?= 35cdb5b03778d3ec52e6d8fa0856ee789489b25a
 NONFREE_DIR = $(ROOT)/nonfree
 
 all: nonfree

Makefile

@@ -128,6 +128,7 @@ In the following table you can find a complete list of all the performance metri
 |`snitch_issues`           |Total number of instructions issued by Snitch, excluding those offloaded to the FPSS (see `snitch_fseq_offloads`).                                                                                  |
 |`snitch_fseq_offloads`    |Total number of instructions offloaded by Snitch to the FPSS.                                                                                                                                       |
 |`snitch_fseq_rel_offloads`|The ratio between `snitch_fseq_offloads` and the total number of instructions issued by Snitch core proper, i.e. `snitch_issues + snitch_fseq_offloads`.                                            |
+|`snitch_occupancy`        |IPC of the Snitch core, calculated as `snitch_issues / cycles`.                                                                                                                                     |
 |`fpss_issues`             |Total number of instructions issued by the FPSS. It counts repeated issues from the FREP sequencer.                                                                                                 |
 |`fpss_fpu_issues`         |Similar to `fpss_issues`, but counts only instructions destined to the FPU proper. It does not for instance include instructions issued to the FPSS's LSU.                                          |
 |`fseq_yield`              |The ratio between `fpss_issues` and `snitch_fseq_offloads`. The difference lies in the FREP sequencer possibly replicating instructions. If the sequencer is not used this ratio should amount to 1.|

docs/ug/trace_analysis.md

@@ -22,6 +22,7 @@
 /// Snitch Cluster Top-Level.
 module snitch_cluster
   import snitch_pkg::*;
+  import snitch_icache_pkg::*;
 #(
   /// Width of physical address.
   parameter int unsigned PhysicalAddrWidth  = 48,
@@ -66,8 +67,8 @@ module snitch_cluster
   parameter int unsigned ICacheLineWidth [NrHives] = '{default: 0},
   /// Number of icache lines per set.
   parameter int unsigned ICacheLineCount [NrHives] = '{default: 0},
-  /// Number of icache sets.
-  parameter int unsigned ICacheSets [NrHives]      = '{default: 0},
+  /// Number of icache ways.
+  parameter int unsigned ICacheWays [NrHives]      = '{default: 0},
   /// Enable virtual memory support.
   parameter bit          VMSupport          = 1,
   /// Per-core enabling of the standard `E` ISA reduced-register extension.
@@ -523,10 +524,10 @@ module snitch_cluster
   tcdm_req_t [NrTCDMPortsCores-1:0] tcdm_req;
   tcdm_rsp_t [NrTCDMPortsCores-1:0] tcdm_rsp;
 
-  core_events_t [NrCores-1:0]                      core_events;
-  tcdm_events_t                                    tcdm_events;
-  dma_events_t [DMANumChannels-1:0]                dma_events;
-  snitch_icache_pkg::icache_events_t [NrCores-1:0] icache_events;
+  core_events_t      [NrCores-1:0]        core_events;
+  tcdm_events_t                           tcdm_events;
+  dma_events_t       [DMANumChannels-1:0] dma_events;
+  icache_l0_events_t [NrCores-1:0]        icache_events;
 
   // 4. Memory Subsystem (Core side).
   reqrsp_req_t [NrCores-1:0] core_req;
@@ -981,7 +982,7 @@ module snitch_cluster
       hive_req_t [HiveSize-1:0] hive_req_reshape;
       hive_rsp_t [HiveSize-1:0] hive_rsp_reshape;
 
-      snitch_icache_pkg::icache_events_t [HiveSize-1:0] icache_events_reshape;
+      icache_l0_events_t [HiveSize-1:0] icache_events_reshape;
 
       for (genvar j = 0; j < NrCores; j++) begin : gen_hive_matrix
         // Check whether the core actually belongs to the current hive.
@@ -1005,7 +1006,7 @@ module snitch_cluster
         .CoreCount (HiveSize),
         .ICacheLineWidth (ICacheLineWidth[i]),
         .ICacheLineCount (ICacheLineCount[i]),
-        .ICacheSets (ICacheSets[i]),
+        .ICacheWays (ICacheWays[i]),
         .IsoCrossing (IsoCrossing),
         .sram_cfg_t  (sram_cfg_t),
         .sram_cfgs_t (sram_cfgs_t),

hw/snitch_cluster/src/snitch_cluster.sv

@@ -8,6 +8,7 @@
 
 module snitch_cluster_peripheral
   import snitch_pkg::*;
+  import snitch_icache_pkg::*;
   import snitch_cluster_peripheral_reg_pkg::*;
 #(
   // Nr of cores in the cluster
@@ -20,24 +21,24 @@ module snitch_cluster_peripheral
   parameter type tcdm_events_t = logic,
   parameter type dma_events_t = logic
 ) (
-  input  logic                       clk_i,
-  input  logic                       rst_ni,
-
-  input  reg_req_t                   reg_req_i,
-  output reg_rsp_t                   reg_rsp_o,
-
-  output logic                       icache_prefetch_enable_o,
-  output logic [NrCores-1:0]         cl_clint_o,
-  input  core_events_t [NrCores-1:0]                      core_events_i,
-  input  tcdm_events_t                                    tcdm_events_i,
-  input  dma_events_t [DMANumChannels-1:0]                dma_events_i,
-  input  snitch_icache_pkg::icache_events_t [NrCores-1:0] icache_events_i
+  input  logic                                   clk_i,
+  input  logic                                   rst_ni,
+
+  input  reg_req_t                               reg_req_i,
+  output reg_rsp_t                               reg_rsp_o,
+
+  output logic                                   icache_prefetch_enable_o,
+  output logic              [NrCores-1:0]        cl_clint_o,
+  input  core_events_t      [NrCores-1:0]        core_events_i,
+  input  tcdm_events_t                           tcdm_events_i,
+  input  dma_events_t       [DMANumChannels-1:0] dma_events_i,
+  input  icache_l0_events_t [NrCores-1:0]        icache_events_i
 );
 
   // Pipeline register to ease timing.
   tcdm_events_t tcdm_events_q;
   dma_events_t [DMANumChannels-1:0] dma_events_q;
-  snitch_icache_pkg::icache_events_t [NrCores-1:0] icache_events_q;
+  icache_l0_events_t [NrCores-1:0] icache_events_q;
   `FF(tcdm_events_q, tcdm_events_i, '0)
   `FF(dma_events_q, dma_events_i, '0)
   `FF(icache_events_q, icache_events_i, '0)

hw/snitch_cluster/src/snitch_cluster_peripheral/snitch_cluster_peripheral.sv

@@ -75,7 +75,7 @@ package ${cfg['cluster']['name']}_pkg;
 
   localparam int unsigned ICacheLineWidth [NrHives] = '{${icache_cfg('cacheline')}};
   localparam int unsigned ICacheLineCount [NrHives] = '{${icache_cfg('depth')}};
-  localparam int unsigned ICacheSets [NrHives] = '{${icache_cfg('sets')}};
+  localparam int unsigned ICacheWays [NrHives] = '{${icache_cfg('ways')}};
 
   localparam int unsigned Hive [NrCores] = '{${core_cfg('hive')}};
 
@@ -288,7 +288,7 @@ module ${cfg['cluster']['name']}_wrapper (
     .DMANumChannels (${cfg['cluster']['dma_nr_channels']}),
     .ICacheLineWidth (${cfg['cluster']['name']}_pkg::ICacheLineWidth),
     .ICacheLineCount (${cfg['cluster']['name']}_pkg::ICacheLineCount),
-    .ICacheSets (${cfg['cluster']['name']}_pkg::ICacheSets),
+    .ICacheWays (${cfg['cluster']['name']}_pkg::ICacheWays),
     .VMSupport (${int(cfg['cluster']['vm_support'])}),
     .RVE (${core_isa('e')}),
     .RVF (${core_isa('f')}),