[nix] refactor test case

* cases is now under the ip scope * replace isFp detect with features abstract layer, so that tests can have more extensible way to declare their required emulator type. Signed-off-by: Avimitin <[email protected]>
chipsalliance · Aug 1, 2024 · 00aec1f · 00aec1f
1 parent 162704e
commit 00aec1f
Show file tree

Hide file tree

Showing 21 changed files with 181 additions and 106 deletions.
diff --git a/.github/workflows/vcs.yml b/.github/workflows/vcs.yml
@@ -45,7 +45,7 @@ jobs:
           nix build '.#t1.${{ matrix.config }}.ip.vcs-emu' --impure --no-link --cores 64
       - name: "Build all testcases"
         run: |
-          nix build ".#t1.${{ matrix.config }}.cases.all" --max-jobs auto --no-link --cores 64
+          nix build ".#t1.${{ matrix.config }}.ip.cases.all" --max-jobs auto --no-link --cores 64
 
   gen-matrix:
     name: "Prepare for running testcases"

diff --git a/.github/workflows/verilator.yml b/.github/workflows/verilator.yml
@@ -34,7 +34,7 @@ jobs:
       - name: "Build all testcases"
         run: |
           # Build testcases with vlen 1024 and vlen 4096
-          nix build ".#t1.${{ matrix.config }}.cases.all" --max-jobs auto -L --no-link --cores 64
+          nix build ".#t1.${{ matrix.config }}.ip.cases.all" --max-jobs auto -L --no-link --cores 64
 
   gen-matrix:
     name: "Prepare for running testcases"
@@ -91,4 +91,4 @@ jobs:
         run: |
           nix run ".#ci-helper" -- postCI --failed-tests-file-path ./failed-tests.md --cycle-update-file-path ./cycle-update.md
           cat ./failed-tests.md >> $GITHUB_STEP_SUMMARY
-          cat ./cycle-update.md >> $GITHUB_STEP_SUMMARY
+          cat ./cycle-update.md >> $GITHUB_STEP_SUMMARY
diff --git a/nix/t1/default.nix b/nix/t1/default.nix
@@ -3,6 +3,7 @@
 , stdenv
 , useMoldLinker
 , newScope
+, runCommand
 
 , pkgsX86
 }:
@@ -51,16 +52,6 @@ lib.makeScope newScope
         elaborateConfigJson = configPath;
         elaborateConfig = builtins.fromJSON (lib.readFile configPath);
 
-        cases = innerSelf.callPackage ../../tests {
-          inherit (ip) verilator-emu verilator-emu-trace vcs-emu vcs-emu-trace;
-        };
-
-        # for the convenience to use x86 cases on non-x86 machines, avoiding the extra build time
-        cases-x86 =
-          if system == "x86-64-linux"
-          then self.cases
-          else pkgsX86.t1."${configName}".cases;
-
         ip = rec {
           recurseForDerivations = true;
 
@@ -80,8 +71,31 @@ lib.makeScope newScope
               "--lowering-options=verifLabels,omitVersionComment,emittedLineLength=240,locationInfoStyle=none"
             ];
           };
-          omreader = self.omreader-unwrapped.mkWrapper { inherit mlirbc; };
+
           om = innerSelf.callPackage ./om.nix { inherit mlirbc; };
+          omreader = self.omreader-unwrapped.mkWrapper { inherit mlirbc; };
+
+          emu-om = innerSelf.callPackage ./om.nix { mlirbc = emu-mlirbc; };
+          emu-omreader = self.omreader-unwrapped.mkWrapper { mlirbc = emu-mlirbc; };
+          omGet = args: lib.fileContents (runCommand "get-${args}" { } ''
+            ${emu-omreader}/bin/omreader ${args} > $out
+          '');
+          rtlDesignMetadata = {
+            march = omGet "march";
+            extensions = builtins.fromJSON (omGet "extensionsJson");
+            vlen = omGet "vlen";
+            dlen = omGet "dlen";
+          };
+
+          cases = innerSelf.callPackage ../../tests {
+            inherit (ip) verilator-emu verilator-emu-trace vcs-emu vcs-emu-trace rtlDesignMetadata;
+          };
+
+          # for the convenience to use x86 cases on non-x86 machines, avoiding the extra build time
+          cases-x86 =
+            if system == "x86-64-linux"
+            then self.cases
+            else pkgsX86.t1."${configName}".cases;
 
           emu-elaborate = innerSelf.callPackage ./elaborate.nix { target = "ipemu"; };
           emu-mlirbc = innerSelf.callPackage ./mlirbc.nix { elaborate = emu-elaborate; };

diff --git a/script/ci/src/Main.scala b/script/ci/src/Main.scala
@@ -162,8 +162,8 @@ object Main:
 
         val testAttr = testType.toLowerCase() match
           case "verilator" =>
-            s".#t1.$config.cases.$caseName.emu-result.with-offline"
-          case "vcs" => s".#t1.$config.cases.$caseName.emu-result.with-vcs"
+            s".#t1.$config.ip.cases.$caseName.emu-result.with-offline"
+          case "vcs" => s".#t1.$config.ip.cases.$caseName.emu-result.with-vcs"
           case _     => Logger.fatal(s"Invalid test type ${testType}")
         val testResultPath =
           try
@@ -186,7 +186,7 @@ object Main:
           os.read(testResultPath / "offline-check-status").trim() == "0"
         if !testSuccess then
           Logger.error(s"Offline check FAILED for $caseName ($config)")
-          allFailedTest :+ s"t1.$config.cases.$caseName"
+          allFailedTest :+ s"t1.$config.ip.cases.$caseName"
         else
           Logger.info(s"Offline check PASS for $caseName ($config)")
           allFailedTest
@@ -268,8 +268,8 @@ object Main:
         Logger.info("Fetching CI results")
         val resultAttr = emuType.toLowerCase() match
           case "verilator" =>
-            s".#t1.$config.cases._allEmuResult"
-          case "vcs" => s".#t1.$config.cases._allVCSEmuResult"
+            s".#t1.$config.ip.cases._allEmuResult"
+          case "vcs" => s".#t1.$config.ip.cases._allVCSEmuResult"
           case _     => Logger.fatal(s"Invalid test type ${emuType}")
         val emuResultPath = os.Path(nixResolvePath(
           resultAttr,
@@ -359,7 +359,7 @@ object Main:
 
     import scala.util.chaining._
     val testPlans: Seq[String] = emulatorConfigs.flatMap: configName =>
-      val allCasesPath = nixResolvePath(s".#t1.$configName.cases.all")
+      val allCasesPath = nixResolvePath(s".#t1.$configName.ip.cases.all")
       os.walk(os.Path(allCasesPath) / "configs")
         .filter: path =>
           path.ext == "json"

diff --git a/tests/asm/default.nix b/tests/asm/default.nix
@@ -3,6 +3,7 @@
 , makeBuilder
 , findAndBuild
 , t1main
+, getTestRequiredFeatures
 }:
 
 let
@@ -13,6 +14,7 @@ let
 
       src = sourcePath;
 
+      featuresRequired = getTestRequiredFeatures sourcePath;
       isFp = lib.pathExists (lib.path.append sourcePath "isFp");
 
       buildPhase = ''
@@ -29,5 +31,5 @@ let
       meta.description = "test case '${caseName}', written in C assembly";
     };
 in
-  findAndBuild ./. build
+findAndBuild ./. build
 
diff --git a/tests/asm/fpsmoke/features-required.json b/tests/asm/fpsmoke/features-required.json
@@ -0,0 +1 @@
+["zve32f"]
diff --git a/tests/asm/fpsmoke/isFp b/tests/asm/fpsmoke/isFp
diff --git a/tests/builder.nix b/tests/builder.nix
@@ -2,9 +2,7 @@
 { stdenv
 , lib
 , jq
-, elaborateConfig
-, isFp
-, vLen
+, rtlDesignMetadata
 
 , makeEmuResult
 }:
@@ -28,22 +26,17 @@ let
 
     CC = "${stdenv.targetPlatform.config}-cc";
 
-    NIX_CFLAGS_COMPILE =
-      let
-        march = (if isFp then "rv32gc_zve32f" else "rv32gc_zve32x")
-          + "_zvl${toString (lib.min 1024 vLen)}b";
-      in
-      [
-        "-mabi=ilp32f"
-        "-march=${march}"
-        "-mno-relax"
-        "-static"
-        "-mcmodel=medany"
-        "-fvisibility=hidden"
-        "-fno-PIC"
-        "-g"
-        "-O3"
-      ];
+    NIX_CFLAGS_COMPILE = [
+      "-mabi=ilp32f"
+      "-march=${rtlDesignMetadata.march}"
+      "-mno-relax"
+      "-static"
+      "-mcmodel=medany"
+      "-fvisibility=hidden"
+      "-fno-PIC"
+      "-g"
+      "-O3"
+    ];
 
     installPhase = ''
       runHook preInstall
@@ -63,7 +56,10 @@ let
 
     dontFixup = true;
 
-    passthru.emu-result = makeEmuResult caseDrv;
+    passthru = {
+      inherit rtlDesignMetadata;
+      emu-result = makeEmuResult caseDrv;
+    };
 
   } // overrides);
 in

diff --git a/tests/codegen/default.nix b/tests/codegen/default.nix
@@ -2,55 +2,63 @@
 , linkerScript
 , rvv-codegen
 , makeBuilder
-, xLen
-, vLen
-, isFp
+  # Instead of testing feature is supported on TOP level,
+  # codegen case are always generated with supported code.
+, currentFeatures
 }:
 
 let
   builder = makeBuilder { casePrefix = "codegen"; };
   makeCaseName = lib.replaceStrings [ "." ] [ "_" ];
+  extraValueFromFeatures = pattern:
+    lib.last
+      (lib.splitString ":"
+        (lib.head
+          (lib.filter
+            (lib.hasPrefix pattern)
+            currentFeatures)));
+  vlen = extraValueFromFeatures "vlen";
+  xlen = extraValueFromFeatures "xlen";
 
-  build = { rawCaseName, isFp }:
-    builder rec {
-      caseName = makeCaseName rawCaseName;
+  build = { rawCaseName, extra }:
+    builder
+      rec {
+        caseName = makeCaseName rawCaseName;
 
-      includeArgs = [
-        "-I${./override_include}"
-        "-I${rvv-codegen}/include"
-      ];
+        includeArgs = [
+          "-I${./override_include}"
+          "-I${rvv-codegen}/include"
+        ];
 
-      dontUnpack = true;
+        dontUnpack = true;
 
-      inherit isFp;
+        buildPhase = ''
+          runHook preBuild
 
-      buildPhase = ''
-        runHook preBuild
+          ${rvv-codegen}/bin/single \
+            -VLEN "${vlen}" \
+            -XLEN "${xlen}" \
+            -repeat 16 \
+            -testfloat3level 2 \
+            -configfile ${rvv-codegen}/configs/${rawCaseName}.toml \
+            -outputfile $pname.S
 
-        ${rvv-codegen}/bin/single \
-          -VLEN "${toString vLen}" \
-          -XLEN "${toString xLen}" \
-          -repeat 16 \
-          -testfloat3level 2 \
-          -configfile ${rvv-codegen}/configs/${rawCaseName}.toml \
-          -outputfile $pname.S
+          # temporary fix, to be extended later
+          if $CC $pname.S -T ${linkerScript} $includeArgs -o $pname.elf ; then
+            echo "link with 4M SRAM succeded"
+          else
+            echo "link with 4M SRAM failed, use DDR instead"
+            sed 's/>SRAM/>DDR/' ${linkerScript} > t1-ddr.ld
+            $CC $pname.S -T t1-ddr.ld $includeArgs -o $pname.elf
+          fi
 
-        # temporary fix, to be extended later
-        if $CC $pname.S -T ${linkerScript} $includeArgs -o $pname.elf ; then
-          echo "link with 4M SRAM succeded"
-        else
-          echo "link with 4M SRAM failed, use DDR instead"
-          sed 's/>SRAM/>DDR/' ${linkerScript} > t1-ddr.ld
-          $CC $pname.S -T t1-ddr.ld $includeArgs -o $pname.elf
-        fi
+          runHook postBuild
+        '';
 
-        runHook postBuild
-      '';
+        meta.description = "test case '${caseName}' generated by codegen";
+      } // extra;
 
-      meta.description = "test case '${caseName}' generated by codegen";
-    };
-
-  buildTestsFromFile = file: { isFp ? false }:
+  buildTestsFromFile = file: extra:
     with lib;
     let
       rawCaseNames = lib.splitString "\n" (lib.fileContents file);
@@ -59,17 +67,18 @@ let
       (map
         (rawCaseName: nameValuePair
           (makeCaseName rawCaseName)
-          (build { inherit rawCaseName isFp; })
+          (build { inherit rawCaseName extra; })
         )
         rawCaseNames));
 
-  commonTests = buildTestsFromFile ./common.txt { };
-  fpTests = buildTestsFromFile ./fp.txt { isFp = true; };
-
+  commonTests = buildTestsFromFile ./common.txt { featuresRequired = [ ]; };
+  fpTests = buildTestsFromFile ./fp.txt { featuresRequired = [ "zve32f" ]; };
+  zvbbTests = buildTestsFromFile ./zvbb.txt { featuresRequired = [ "zvbb" ]; };
+  hasFeature = feat: lib.any (f: feat == f) currentFeatures;
 in
 lib.recurseIntoAttrs (
-    if isFp
-    then commonTests // fpTests
-    else commonTests
+  commonTests //
+  lib.optionalAttrs (hasFeature "zve32f") fpTests //
+  lib.optionalAttrs (hasFeature "zvbb") zvbbTests
 )
 
diff --git a/tests/codegen/zvbb.txt b/tests/codegen/zvbb.txt
@@ -0,0 +1,16 @@
+vandn.vv
+vandn.vx
+vbrev.v
+vbreav8.v
+vclz.v
+vcpop.v
+vctz.v
+vrev8.v
+vrol.vv
+vrol.vx
+vror.vi
+vror.vv
+vror.vx
+vwsll.vi
+vwsll.vv
+vwsll.vx