removed the usage of install-cva6.sh and add setup-env.sh (#1741)

openhwgroup · Jan 3, 2024 · 706daa0 · 706daa0
1 parent 72b8556
commit 706daa0
Show file tree

Hide file tree

Showing 26 changed files with 175 additions and 218 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -50,7 +50,8 @@ jobs:
         name: compiled-tools
     - name: Run Tests
       run: |
+          set -x
           tar xf tools.tar
           tar xf tmp.tar
-          source verif/regress/install-cva6.sh
+          source verif/sim/setup-env.sh
           make run-${{ matrix.testcase}}-verilator target=${{ matrix.target }}
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -216,7 +216,7 @@ asic-synthesis:
     - echo $PERIOD
     - echo $TECH_NAME
     - echo $DV_TARGET
-    - source verif/regress/install-cva6.sh
+    - source ./verif/sim/setup-env.sh
     - echo $SYN_DCSHELL_BASHRC; source $SYN_DCSHELL_BASHRC
     - make -C pd/synth cva6_synth TARGET="$DV_TARGET"
     - mv pd/synth/cva6_${DV_TARGET}_synth_modified.v artifacts/cva6_${DV_TARGET}_synth_modified.v
@@ -233,7 +233,7 @@ fpga-build:
     TARGET: cv32a60x
   script:
     - source $VIVADO_SETUP
-    - source verif/regress/install-cva6.sh
+    - source ./verif/sim/setup-env.sh
     - make fpga target=$TARGET
     - mkdir -p artifacts/reports
     - mv corev_apu/fpga/work-fpga/ariane_xilinx.bit artifacts/ariane_xilinx_$TARGET.bit
@@ -460,8 +460,7 @@ smoke-gate:
     - echo $FOUNDRY_PATH
     - echo $PERIOD
     - echo $TECH_NAME
-    - source verif/regress/install-cva6.sh
-    - source verif/regress/install-riscv-dv.sh
+    - source ./verif/sim/setup-env.sh
     - source verif/regress/install-riscv-tests.sh
     - mv artifacts/cva6_${DV_TARGET}_synth_modified.v pd/synth/cva6_${DV_TARGET}_synth_modified.v
     - cd verif/sim
@@ -481,10 +480,8 @@ fpga-boot:
     DASHBOARD_JOB_DESCRIPTION: "Test of Linux 32 bits boot on FPGA Genesys2"
     DASHBOARD_SORT_INDEX: 10
     DASHBOARD_JOB_CATEGORY: "Synthesis"
-    VERILATOR_INSTALL_DIR: "NO" # Skip install and checks of verilator
-    SPIKE_INSTALL_DIR: "NO"  # Skip install and checks of spike
   script:
-    - source verif/regress/install-cva6.sh
+    - source ./verif/sim/setup-env.sh
     - source $VIVADO2022_SETUP
     - mkdir -p corev_apu/fpga/work-fpga
     - mv artifacts/ariane_xilinx_cv32a60x.bit corev_apu/fpga/work-fpga/ariane_xilinx.bit

diff --git a/README.md b/README.md
@@ -51,7 +51,13 @@ For Debian-based Linux distributions, run :
 sudo apt-get install help2man device-tree-compiler
 ```
 
-5. Run these commands to install a custom Spike and Verilator (i.e. these versions must be used to simulate the CVA6) and [these](#running-regression-tests-simulations) tests suites.
+5. Install the riscv-dv requirements:
+
+```sh
+pip3 install -r verif/sim/dv/requirements.txt
+```
+
+6. Run these commands to install a custom Spike and Verilator (i.e. these versions must be used to simulate the CVA6) and [these](#running-regression-tests-simulations) tests suites.
 ```sh
 # DV_SIMULATORS is detailed in the next section
 export DV_SIMULATORS=veri-testharness,spike
@@ -81,9 +87,9 @@ If exactly 2 simulators are given, their trace is compared ([see the Regression
 Here is how you can run the hello world C program with the Verilator model: 
 
 ```sh
-# Make sure to source these 2 scripts to correctly set the environment variables related to the tools
-source ./verif/regress/install-cva6.sh
-source ./verif/regress/install-riscv-dv.sh
+# Make sure to source this script from the root directory 
+# to correctly set the environment variables related to the tools
+source verif/sim/setup-env.sh
 
 # Set the NUM_JOBS variable to increase the number of parallel make jobs
 # export NUM_JOBS=
@@ -387,4 +393,3 @@ If you use CVA6 in your academic work you can cite us:
 # Acknowledgements
 
 Check out the [acknowledgements](ACKNOWLEDGEMENTS.md).
-
diff --git a/ci/build-riscv-tests.sh b/ci/build-riscv-tests.sh
@@ -1,5 +1,6 @@
 #!/bin/bash
 set -e
+set -x
 ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)
 VERSION="eeacd5507db7a0f50ca8c4f27aff220fcbb60bdf"
 

diff --git a/ci/setup.sh b/ci/setup.sh
@@ -1,5 +1,6 @@
 #!/bin/bash
 set -e
+set -x
 export ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)
 export ROOT_PROJECT=$ROOT
 
@@ -25,5 +26,6 @@ tar -x -f $RISCV64_UNKNOWN_ELF_GCC --strip-components=1 -C $RISCV
 
 sudo apt install libfl-dev help2man
 
-verif/regress/install-cva6.sh
+bash verif/regress/install-verilator.sh
+(source verif/sim/setup-env.sh; bash verif/regress/install-spike.sh)
 ci/build-riscv-tests.sh
diff --git a/verif/regress/benchmark.sh b/verif/regress/benchmark.sh
@@ -14,8 +14,10 @@ if [ -z "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
+
+source ./verif/sim/setup-env.sh
 
 if [ -z "$DV_SIMULATORS" ]; then
   DV_SIMULATORS=veri-testharness,spike

diff --git a/verif/regress/coremark.sh b/verif/regress/coremark.sh
@@ -19,11 +19,13 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-compliance.sh
 source verif/regress/install-riscv-tests.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_SIMULATORS" ]; then
   DV_SIMULATORS=veri-testharness
 fi

diff --git a/verif/regress/dhrystone.sh b/verif/regress/dhrystone.sh
@@ -14,11 +14,13 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-compliance.sh
 source verif/regress/install-riscv-tests.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_SIMULATORS" ]; then
   DV_SIMULATORS=veri-testharness
 fi

diff --git a/verif/regress/dv-csr-embedded-tests.sh b/verif/regress/dv-csr-embedded-tests.sh
@@ -14,8 +14,11 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
+
+source ./verif/sim/setup-env.sh
+
 
 export cov=1 #enable the Code Coverage
 

diff --git a/verif/regress/dv-generated-tests.sh b/verif/regress/dv-generated-tests.sh
@@ -18,9 +18,10 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
-source verif/regress/install-spike.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
+
+source ./verif/sim/setup-env.sh
 
 if ! [ -n "$DV_TARGET" ]; then
   DV_TARGET=cv32a6_embedded

diff --git a/verif/regress/dv-generated-xif-tests.sh b/verif/regress/dv-generated-xif-tests.sh
@@ -18,9 +18,10 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
-source verif/regress/install-spike.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
+
+source ./verif/sim/setup-env.sh
 
 if ! [ -n "$DV_TARGET" ]; then
   DV_TARGET=cv32a6_embedded

diff --git a/verif/regress/dv-riscv-arch-test.sh b/verif/regress/dv-riscv-arch-test.sh
@@ -14,10 +14,12 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-arch-test.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_TARGET" ]; then
   DV_TARGET=cv64a6_imafdc_sv39
 fi

diff --git a/verif/regress/dv-riscv-compliance.sh b/verif/regress/dv-riscv-compliance.sh
@@ -14,10 +14,12 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-compliance.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_TARGET" ]; then
   DV_TARGET=cv64a6_imafdc_sv39
 fi

diff --git a/verif/regress/dv-riscv-csr-access-test.sh b/verif/regress/dv-riscv-csr-access-test.sh
@@ -14,10 +14,12 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-arch-test.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_TARGET" ]; then
   DV_TARGET=cv32a60x
 fi

diff --git a/verif/regress/dv-riscv-mmu-sv32-test.sh b/verif/regress/dv-riscv-mmu-sv32-test.sh
@@ -14,10 +14,12 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-arch-test.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_TARGET" ]; then
   DV_TARGET=cv32a60x
 fi

diff --git a/verif/regress/dv-riscv-tests.sh b/verif/regress/dv-riscv-tests.sh
@@ -14,10 +14,12 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-tests.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_TARGET" ]; then
   DV_TARGET=cv64a6_imafdc_sv39
 fi

diff --git a/verif/regress/hwconfig_tests.sh b/verif/regress/hwconfig_tests.sh
@@ -14,10 +14,12 @@ if ! [ -n "$RISCV" ]; then
 fi
 
 # install the required tools
-source verif/regress/install-cva6.sh
-source verif/regress/install-riscv-dv.sh
+source ./verif/regress/install-verilator.sh
+source ./verif/regress/install-spike.sh
 source verif/regress/install-riscv-tests.sh
 
+source ./verif/sim/setup-env.sh
+
 if ! [ -n "$DV_SIMULATORS" ]; then
   DV_SIMULATORS=veri-testharness,spike
 fi

diff --git a/verif/regress/install-cva6.sh b/verif/regress/install-cva6.sh
diff --git a/verif/regress/install-riscv-dv.sh b/verif/regress/install-riscv-dv.sh