RTL riscv instruction tests (#583)

* rtl: prepare RTL test base

- refactor firtool build image
- prepare dependencies for test-base image

* rtl: Integrate RTL tests into openvadl tests

* fix: checkstyle issue

* rtl: Add build action for rtl-test-base image

* rtl: Fix signal name conflict

* rtl: Add image digest to firtool image import

* rtl: Use ghcr rtl-test-base image

* ci: Add test-rtl task to CI workflow

* rtl: Use latest rtl-test-base image

Author: rascmatt

.github/workflows/openvadl-ci.yml

@@ -41,7 +41,7 @@ jobs:
     uses: ./.github/workflows/reusable-test.yml
     strategy:
       matrix:
-        task: [ test-lcb, test-common, test-iss ]
+        task: [ test-lcb, test-common, test-iss, test-rtl ]
         include:
           - runner: self-hosted
     with:
@@ -60,4 +60,4 @@ jobs:
         run: exit 0
       - name: Failing CI
         if: ${{ contains(needs.*.result, 'failure') }}
-        run: exit 1
+        run: exit 1

docker/rtl/test-base/Dockerfile

@@ -1,5 +1,5 @@
 FROM ghcr.io/openvadl/merged-toolchain@sha256:2ceaf5369996a5f3db0e0bb8e16ae5fe53003d6ac180bd9e60a9ced954f99a9a AS toolchains
-FROM ghcr.io/openvadl/firtool AS firtool
+FROM ghcr.io/openvadl/firtool@sha256:84c7b84322068a9b800c908a13656a6d756a507751230dad1c99c38b96bad335 AS firtool
 
 FROM ubuntu:22.04 AS build
 

vadl/build.gradle.kts

@@ -135,7 +135,7 @@ tasks.withType<Test> {
 }
 
 // generators to be tested separately
-val generators = listOf("iss", "lcb")
+val generators = listOf("iss", "lcb", "rtl")
 
 for (gen in generators) {
     tasks.register<Test>("test-$gen") {

vadl/main/resources/templates/rtl/CoreTest.scala

@@ -51,7 +51,7 @@ class CoreTest extends AnyFunSpec with ChiselSim {
     simulate(new [(${topModule})]) { dut =>
       enableWaves()
 
-      new java.io.File("riscv-tests/isa").listFiles(_.getName.matches("[(${#strings.substring(isaName, 0, 4).toLowerCase()})]ui-p-[^.]*"))
+      new java.io.File("/riscv-tests/isa").listFiles(_.getName.matches("[(${#strings.substring(isaName, 0, 4).toLowerCase()})]ui-p-[^.]*"))
         .filter(file => !file.getName.contains("fence")) // not supported
         .foreach(file => {
           println(f"test $file")

vadl/main/resources/templates/rtl/Makefile

@@ -1,6 +1,11 @@
 # Makefile for [(${projectName})]
 
-test: riscv-tests
+SHELL=/bin/bash
+
+test:
+	mkdir -p build
+	touch build/[(${topModule})]-riscv-tests.log
+	set -o pipefail # Preserve test exit code when piping to tee
 	sbt test 2>&1 | tee build/[(${topModule})]-riscv-tests.log
 
 riscv-tests:
@@ -52,4 +57,4 @@ SCALAFMT_URL = https://github.com/scalameta/scalafmt/releases/download/v$(SCALAF
 
 format: .scalafmt/scalafmt$(SCALAFMT_EXT)
 	$< [# th:each="file : ${scalaFiles}"]\
-		[(${file})][/]
+		[(${file})][/]

vadl/main/vadl/rtl/template/HdlEmitContext.java

@@ -102,6 +102,7 @@ public String name(Collection<Node> inlinedNodes, Set<String> existing,
                 nodeContext.shortestNameHint(existing, 30)
                     .or(() -> fallback(inlinedNode, existing))
                     .orElse("n_" + nodeContext.node().id().numericId()))
+            .filter(name -> !existing.contains(name))
             .orElseGet(() -> {
               if (fallback == null || existing.contains(fallback)) {
                 return fallback(inlinedNode, existing)

vadl/test/resources/scripts/rtl/test.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+cd /rtl
+
+mkdir -p build
+touch build/rv32i-riscv-tests.log
+
+# Preserve sbt exit code when piping to tee
+set -o pipefail
+
+sbt test 2>&1 | tee build/rv32i-riscv-tests.log

vadl/test/vadl/rtl/RtlDockerTest.java

@@ -0,0 +1,91 @@
+// SPDX-FileCopyrightText : © 2025 TU Wien <vadl@tuwien.ac.at>
+// SPDX-License-Identifier: GPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package vadl.rtl;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import org.testcontainers.images.builder.ImageFromDockerfile;
+import vadl.DockerExecutionTest;
+import vadl.configuration.RtlConfiguration;
+import vadl.pass.PassOrders;
+import vadl.pass.exception.DuplicatedPassKeyException;
+
+public abstract class RtlDockerTest extends DockerExecutionTest {
+
+  private static final String RTL_BASE_IMAGE =
+      "ghcr.io/openvadl/rtl-test-base@sha256:975bacbae46da25dda52340a18772d349c7e43e3dd8aae43be61f254fc728ca8";
+
+  private static final ConcurrentHashMap<String, ImageFromDockerfile> imageCache =
+      new ConcurrentHashMap<>();
+
+  protected ImageFromDockerfile generateRtlImage(String specPath,
+                                                 RtlConfiguration configuration) {
+
+    final var cacheKey = String.valueOf(Set.of(specPath, configuration).hashCode());
+    return RtlDockerTest.imageCache.computeIfAbsent(cacheKey, (k) -> {
+
+      try {
+        // Generate RTL core
+        setupPassManagerAndRunSpec(specPath, PassOrders.rtl(configuration));
+
+        // Return image with generated files
+        return getImage(configuration);
+      } catch (IOException | DuplicatedPassKeyException e) {
+        throw new RuntimeException(e);
+      }
+    });
+  }
+
+  private ImageFromDockerfile getImage(RtlConfiguration configuration
+  ) {
+
+    // find output dir
+    var outputPath = Path.of(configuration.outputPath() + "/rtl").toAbsolutePath();
+    if (!outputPath.toFile().exists()) {
+      throw new IllegalStateException("RTL output path was not found (not generated?)");
+    }
+
+    // Get redis cache for faster compilation using sccache
+    var redisCache = getRunningRedisCache();
+
+    var dockerImage = new ImageFromDockerfile()
+        .withDockerfileFromBuilder(d -> {
+              d.from(RTL_BASE_IMAGE);
+
+              d.workDir("/rtl");
+
+              // Copy files into container
+              d.copy("/rtl", "/rtl");
+              d.copy("/scripts", "/scripts");
+
+              d.run("chmod +x /scripts/*");
+
+              d.build();
+            }
+        )
+        // Make generated sources available to image builder
+        .withFileFromPath("/rtl", outputPath)
+        // make scripts available to image builder
+        .withFileFromClasspath("/scripts", "/scripts/rtl");
+
+    // As we have to use the same network as the redis cache, we have to build it there
+    return redisCache.setupEnv(dockerImage);
+  }
+
+}

vadl/test/vadl/rtl/riscv/RiscVInstructionTest.java

@@ -0,0 +1,51 @@
+// SPDX-FileCopyrightText : © 2025 TU Wien <vadl@tuwien.ac.at>
+// SPDX-License-Identifier: GPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package vadl.rtl.riscv;
+
+import java.nio.file.Path;
+import org.junit.jupiter.api.Test;
+import vadl.configuration.DecoderOptions;
+import vadl.configuration.GeneralConfiguration;
+import vadl.configuration.RtlConfiguration;
+import vadl.rtl.RtlDockerTest;
+
+public class RiscVInstructionTest extends RtlDockerTest {
+
+  @Test
+  void rv32imTest() {
+
+    /* GIVEN */
+    var generalConfig =
+        new GeneralConfiguration(Path.of("build/test-output"), false);
+    var config = new RtlConfiguration(generalConfig);
+
+    var decoderOptions = new DecoderOptions();
+    decoderOptions.setGenerator(DecoderOptions.Generator.REGULAR);
+    config.setDecoderOptions(decoderOptions);
+
+    var image = generateRtlImage("sys/risc-v/rv32im.vadl", config);
+
+    runContainer(image,
+        /* WHEN */
+        c -> c.withCommand("/scripts/test.sh"),
+        /* THEN */
+        c -> {
+          // No post actions for now, we rely on the exit code instead
+        });
+  }
+
+}