Update riscv vector test compilation to be more efficient and fix workflow file

Author: MichaelJSr

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
@@ -71,7 +71,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install Dependencies
         run: |
@@ -114,70 +114,16 @@ jobs:
   tests:
     runs-on: ubuntu-20.04
     needs: build
+    timeout-minutes: 90
     strategy:
       fail-fast: false
       matrix:
-        name: [regression, opencl, cache, config1, config2, debug, scope, stress, synthesis, vm]
+        name: [regression, opencl, cache, config1, config2, debug, scope, stress, synthesis, vm, vector]
         xlen: [32, 64]
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Install Dependencies
-        run: |
-          sudo bash ./ci/install_dependencies.sh
-
-      - name: Cache Toolchain Directory
-        id: cache-toolchain
-        uses: actions/cache@v4
-        with:
-          path: tools
-          key: ${{ runner.os }}-toolchain-v0.1
-          restore-keys: |
-            ${{ runner.os }}-toolchain-
-
-      - name: Cache Third Party Directory
-        id: cache-thirdparty
-        uses: actions/cache@v4
-        with:
-          path: third_party
-          key: ${{ runner.os }}-thirdparty-v0.1
-          restore-keys: |
-            ${{ runner.os }}-thirdparty-
-
-      - name: Download Build Artifact
-        uses: actions/download-artifact@v4
-        with:
-          name: build-${{ matrix.xlen }}
-          path: build${{ matrix.xlen }}
-
-      - name: Run tests
-        run: |
-          cd build${{ matrix.xlen }}
-          source ci/toolchain_env.sh
-          chmod -R +x . # Ensure all files have executable permissions
-          if [ "${{ matrix.name }}" == "regression" ]; then
-            ./ci/regression.sh --unittest
-            ./ci/regression.sh --isa
-            ./ci/regression.sh --kernel
-            ./ci/regression.sh --regression
-          else
-            ./ci/regression.sh --${{ matrix.name }}
-          fi
-
-  vector-tests:
-    runs-on: ubuntu-22.04
-    needs: build
-    strategy:
-      fail-fast: false
-      matrix:
-        name: [vector]
-        xlen: [32, 64]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install Dependencies
         run: |

ci/regression.sh.in

@@ -221,6 +221,12 @@ config1()
     CONFIGS="-DISSUE_WIDTH=2" ./ci/blackbox.sh --driver=simx --app=diverge
     CONFIGS="-DISSUE_WIDTH=4" ./ci/blackbox.sh --driver=simx --app=diverge
 
+    # simd width
+    CONFIGS="-DSIMD_WIDTH=1" ./ci/blackbox.sh --driver=rtlsim --app=dogfood --args="-ttrig"
+    CONFIGS="-DSIMD_WIDTH=2" ./ci/blackbox.sh --driver=rtlsim --app=dogfood --args="-ttrig"
+    CONFIGS="-DSIMD_WIDTH=1" ./ci/blackbox.sh --driver=simx --app=dogfood --args="-ttrig"
+    CONFIGS="-DSIMD_WIDTH=2" ./ci/blackbox.sh --driver=simx --app=dogfood --args="-ttrig"
+
     # ALU scaling
     CONFIGS="-DISSUE_WIDTH=2 -DNUM_ALU_BLOCK=1 -DNUM_ALU_LANES=2" ./ci/blackbox.sh --driver=rtlsim --app=diverge
     CONFIGS="-DISSUE_WIDTH=4 -DNUM_ALU_BLOCK=4 -DNUM_ALU_LANES=4" ./ci/blackbox.sh --driver=rtlsim --app=diverge
@@ -394,8 +400,8 @@ vector()
 {
     echo "begin vector tests..."
 
-    make -C sim/simx clean && CONFIGS="-DEXT_V_ENABLE" make -C sim/simx
-    TOOLDIR=@TOOLDIR@ XLEN=@XLEN@ VLEN=256 REG_TESTS=1 GEN_TESTS=1 ./tests/riscv/riscv-vector-tests/run-test.sh
+    make -C sim/simx clean && CONFIGS="-DVLEN=256 -DEXT_V_ENABLE" make -C sim/simx
+    VLEN=256 REG_TESTS=1 GEN_TESTS=1 ./tests/riscv/riscv-vector-tests/run-test.sh
 
     echo "vector tests done!"
 }

tests/riscv/riscv-vector-tests/gen-test.sh.in

@@ -1,29 +1,30 @@
 #!/bin/bash
 
+XLEN=${XLEN:-"@XLEN@"}
+TOOLDIR=${TOOLDIR:-"@TOOLDIR@"}
+RISCV_TOOLCHAIN_PATH=${RISCV_TOOLCHAIN_PATH:-"$TOOLDIR/riscv$XLEN-gnu-toolchain"}
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 PREV_DIR=$(pwd)
 
 sudo apt-get install device-tree-compiler
 wget -O- -q https://go.dev/dl/go1.24.0.linux-amd64.tar.gz | tar -xzf -
 
-git clone https://github.com/chipsalliance/riscv-vector-tests.git
+export RISCV=$RISCV_TOOLCHAIN_PATH
+export PATH=$PATH:$PREV_DIR/go/bin:$RISCV/bin
+
+git clone --recursive https://github.com/chipsalliance/riscv-vector-tests.git
 cd riscv-vector-tests
-wget -O- -q https://github.com/riscv-collab/riscv-gnu-toolchain/releases/download/2024.04.12/riscv64-elf-ubuntu-22.04-gcc-nightly-2024.04.12-nightly.tar.gz | tar -xzf -
-export RISCV=$PREV_DIR/riscv-vector-tests/riscv
-export PATH=$PATH:$PREV_DIR/go/bin:$PREV_DIR/riscv-vector-tests/riscv/bin
 
-git clone https://github.com/riscv-software-src/riscv-isa-sim.git
+git clone --recursive https://github.com/riscv-software-src/riscv-isa-sim.git
 cd riscv-isa-sim
 git reset --hard 91793ed7d964aa0031c5a9a31fa05ec3d11b3b0f
 mkdir build && cd build
 ../configure --prefix=$RISCV
 make -j$(nproc) && sudo make install
 cd ../..
 
-cd env
-git clone https://github.com/riscv/riscv-test-env.git
-cd ..
-
-make generate-stage1 --environment-overrides VLEN=$VLEN XLEN=$XLEN MARCH=rv"$XLEN"imafv_zve"$XLEN"f MODE=machine && make all -j$(nproc) --environment-overrides VLEN=$VLEN XLEN=$XLEN MARCH=rv"$XLEN"imafv_zve"$XLEN"f MODE=machine
+make generate-stage1 --environment-overrides VLEN=$VLEN XLEN=$XLEN MARCH=rv"$XLEN"imafv_zve"$XLEN"f MODE=machine
+make all -j$(nproc) --environment-overrides VLEN=$VLEN XLEN=$XLEN MARCH=rv"$XLEN"imafv_zve"$XLEN"f MODE=machine
 mv out/v"$VLEN"x"$XLEN"machine/bin/stage2 $PREV_DIR/v"$VLEN"x"$XLEN"
 
 cd $PREV_DIR

tests/riscv/riscv-vector-tests/run-test.sh.in

@@ -1,13 +1,15 @@
 #!/bin/bash
-RISCV_TOOLCHAIN_PATH=${RISCV_TOOLCHAIN_PATH:-$TOOLDIR"/riscv"$XLEN"-gnu-toolchain"}
 
+XLEN=${XLEN:-"@XLEN@"}
+TOOLDIR=${TOOLDIR:-"@TOOLDIR@"}
+RISCV_TOOLCHAIN_PATH=${RISCV_TOOLCHAIN_PATH:-"$TOOLDIR/riscv$XLEN-gnu-toolchain"}
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-RESTORE_PREV_DIR=$(pwd)
+TEST_DIR=${TEST_DIR:-"$SCRIPT_DIR/testcases"}
 
 VECTOR_TESTS_REPOSITORY=https://github.com/MichaelJSr/testcases/raw/main
 VECTOR_TESTS_BASE_NAME=vector-tests.tar.bz2
 
-vector_tests()
+download_tests()
 {
     parts=$(eval echo {a..z})
     for x in $parts
@@ -20,14 +22,12 @@ vector_tests()
 }
 
 # get selected testcases from command line or run default testcases
-if [ "$#" == "0" ];
-then
+if [ "$#" -eq 0 ]; then
   # write out test case name explicitely if there are collisions with other test names
   testcases=(vmv vslide vmerge vrgather \
              vle8 vle16 vle32 \
              vse8 vse16 vse32 \
              vlseg vlsseg vluxseg vloxseg \
-             vsseg vssseg vsuxseg vsoxseg \
              vlse8 vlse16 vlse32 \
              vsse8 vsse16 vsse32 \
              vloxei vluxei vsoxei vsuxei \
@@ -50,70 +50,74 @@ then
              vadc vmadc vsbc vmsbc \
              vsext vzext \
              vid)
-  if [ $XLEN -eq 32 ]; then
+  if [ "$XLEN" -eq 32 ]; then
     testcases+=()
-  elif [ $XLEN -eq 64 ]; then
+  elif [ "$XLEN" -eq 64 ]; then
     testcases+=(vle64 vse64 vlse64 vsse64 vfwcvt vfncvt \
-                vfwadd vfwsub \
                 vfwmul vfwred vfwmacc vfwnmacc vfwmsac vfwnmsac )
   fi
 else
   testcases="${@}"
 fi
 
-cd $SCRIPT_DIR
-
 # Fallback #1: If testcases directory exists, use the existing testcases
-if [ ! -d "$SCRIPT_DIR/testcases" ]; then
-  mkdir testcases
-  cd testcases
+if [ ! -d "$TEST_DIR" ]; then
+  mkdir $TEST_DIR
+  pushd $TEST_DIR
   # Fallback #2: Generate testcases
   if [ -n "$GEN_TESTS" ] && [ $GEN_TESTS -eq 1 ]; then
     /bin/bash ../gen-test.sh
+    testcases+=(vsseg vssseg vsuxseg vsoxseg)
+    if [ "$XLEN" -eq 64 ]; then
+      testcases+=(vfwadd vfwsub)
+    fi
   # Fallback #3: Download testcases
   else
-    vector_tests
+    download_tests
   fi
+  popd
 fi
 
-cd $SCRIPT_DIR/testcases/v$VLEN"x"$XLEN
+pushd "$TEST_DIR/v${VLEN}x$XLEN"
 
-rm *".ddr4.log"
+rm -f "*.ddr4.log" > /dev/null 2>&1
 for testcase in ${testcases[@]}; do
-  rm "$testcase"*.elf "$testcase"*.bin "$testcase"*.dump "$testcase"*.log
+  rm -f "$testcase*.bin" "$testcase*.dump" "$testcase*.log" > /dev/null 2>&1
 done
 
 passed=0
 failed=0
-selected=0
-
-# count all available testcases, exclude *.elf, *.bin, *.dump, *.log to prevent double counting
-all=$(($(ls | wc -l) - $(ls -d *.elf | wc -l) - $(ls -d *.bin | wc -l) - $(ls -d *.dump | wc -l) - $(ls -d *.log | wc -l)))
 
 for testcase in ${testcases[@]}; do
-  for f in "$testcase"* ; do 
-    ln -s "$f" "$f.elf";
-    "$RISCV_TOOLCHAIN_PATH"/bin/riscv"$XLEN"-unknown-elf-objdump -D "$f.elf" > "$f.dump";
-    "$RISCV_TOOLCHAIN_PATH"/bin/riscv"$XLEN"-unknown-elf-objcopy -O binary "$f.elf" "$f.bin";
-    $SCRIPT_DIR/../../../sim/simx/simx -v -c 1 "$f.bin" &> "$f.log";
-    if [ $? -eq 1 ]; then
+  echo "Testcase: $testcase"
+  find . -type f -name "${testcase}*" 2>/dev/null | while read -r f; do
+    "$RISCV_TOOLCHAIN_PATH/bin/riscv$XLEN-unknown-elf-objdump" -D "$f" > "$f.dump"
+    "$RISCV_TOOLCHAIN_PATH/bin/riscv$XLEN-unknown-elf-objcopy" -O binary "$f" "$f.bin"
+    echo "running $SCRIPT_DIR/../../../sim/simx/simx -v $f.bin"
+    "$SCRIPT_DIR/../../../sim/simx/simx" -v "$f.bin" > "$f.log"
+    if [ $? -eq 0 ]; then
       echo "$f PASSED"
-      let "passed++"
+      ((passed++))
     else
       echo "$f FAILED"
-      let "failed++"
+      ((failed++))
     fi
     # REG_TESTS=1 informs the script to delete the previous binary after each vector test to save disk space
     # Otherwise, the vector regression tests would run out of disk space eventually
     if [ -n "$REG_TESTS" ] && [ $REG_TESTS -eq 1 ]; then
-      cat $f.log
-      rm $f.*
-      rm $f
+      cat "$f.log"
+      rm -f "$f..bin" "$f.dump" "$f.log" > /dev/null 2>&1
     fi
-    let "selected++"
   done
 done
-cd $RESTORE_PREV_DIR
-echo "Passed $passed out of $selected selected vector tests."
-echo "Total available vector tests: $all"
+
+popd
+
+if [ $failed -eq 0 ]; then
+  echo "All $total vector tests passed."
+else
+  total=$((passed + failed))
+  echo "$failed out of $total vector tests failed."
+fi
+
 exit $failed