rtl: Implement dev-container setup for generated RTL project (#790)

Author: rascmatt

vadl/main/resources/templates/rtl/.devcontainer/devcontainer.json

@@ -0,0 +1,15 @@
+{
+  "name": "rtl (base: rtl-test-base)",
+  "dockerComposeFile": "docker-compose.yaml",
+  "service": "dev",
+  "workspaceFolder": "/rtl",
+  "shutdownAction": "stopCompose",
+  "remoteUser": "root",
+  "customizations": {
+    "jetbrains": {
+      "plugins": [
+        "org.intellij.scala"
+      ]
+    }
+  }
+}

vadl/main/resources/templates/rtl/.devcontainer/docker-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  dev:
+    image: [(${image})]
+    working_dir: /rtl
+
+    command: sleep infinity
+    tty: true
+    stdin_open: true
+
+    volumes:
+      # Additional mounts
+      # - ../vadl/test/resources/scripts/rtl:/scripts
+
+      # Persist tool caches
+      - m2:/root/.m2
+      - gradle:/root/.gradle
+      - sdkman:/root/.sdkman
+volumes:
+  m2:
+  gradle:
+  sdkman:

vadl/main/resources/templates/rtl/Makefile

@@ -57,7 +57,7 @@ SCALAFMT_FILE = scalafmt-$(SCALAFMT_ARCH)-$(SCALAFMT_OS).zip
 SCALAFMT_URL = https://github.com/scalameta/scalafmt/releases/download/v$(SCALAFMT_VER)/$(SCALAFMT_FILE)
 
 .scalafmt/$(SCALAFMT_FILE):
-	mkdir -p $@
+	mkdir -p $(dir $@)
 	curl -L --output $@ "$(SCALAFMT_URL)"
 .scalafmt/scalafmt$(SCALAFMT_EXT): .scalafmt/$(SCALAFMT_FILE)
 	unzip -od .scalafmt/ $<

vadl/main/vadl/pass/PassOrders.java

@@ -131,6 +131,8 @@
 import vadl.rtl.passes.EmitElfSimPass;
 import vadl.rtl.passes.EmitModulesPass;
 import vadl.rtl.passes.EmitRVFIOutputsPass;
+import vadl.rtl.passes.EmitRtlDevcontainerConfigPass;
+import vadl.rtl.passes.EmitRtlDevcontainerDockerComposePass;
 import vadl.rtl.passes.EmitRtlMakefilePass;
 import vadl.rtl.passes.EmitScalafmtConfigPass;
 import vadl.rtl.passes.EmitSimMemCppPass;
@@ -792,6 +794,9 @@ private static void addRtlEmitPasses(PassOrder order, RtlConfiguration config) {
         // build files
         .add(new EmitScalafmtConfigPass(config))
         .add(new EmitRtlMakefilePass(config))
+        // devcontainer
+        .add(new EmitRtlDevcontainerConfigPass(config))
+        .add(new EmitRtlDevcontainerDockerComposePass(config))
         .add(new CleanupEmitDirectoryPass(config));
   }
 

vadl/main/vadl/rtl/passes/EmitRtlDevcontainerConfigPass.java

@@ -0,0 +1,54 @@
+// SPDX-FileCopyrightText : © 2026 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.passes;
+
+import java.util.Map;
+import vadl.configuration.GeneralConfiguration;
+import vadl.pass.PassResults;
+import vadl.template.AbstractTemplateRenderingPass;
+import vadl.viam.Specification;
+
+/**
+ * Emit the RTL Devcontainer JSON Config.
+ */
+public class EmitRtlDevcontainerConfigPass extends AbstractTemplateRenderingPass {
+
+  /**
+   * Construct the RTL Devcontainer JSON emit pass.
+   *
+   * @param configuration the configuration
+   */
+  public EmitRtlDevcontainerConfigPass(GeneralConfiguration configuration) {
+    super(configuration, "rtl");
+  }
+
+  @Override
+  protected String getTemplatePath() {
+    return "rtl/.devcontainer/devcontainer.json";
+  }
+
+  @Override
+  protected String getOutputPath() {
+    return ".devcontainer/devcontainer.json";
+  }
+
+  @Override
+  protected Map<String, Object> createVariables(PassResults passResults,
+                                                Specification specification) {
+    return Map.of();
+  }
+}

vadl/main/vadl/rtl/passes/EmitRtlDevcontainerDockerComposePass.java

@@ -0,0 +1,64 @@
+// SPDX-FileCopyrightText : © 2026 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.passes;
+
+import java.util.Map;
+import vadl.configuration.GeneralConfiguration;
+import vadl.pass.PassResults;
+import vadl.template.AbstractTemplateRenderingPass;
+import vadl.viam.Specification;
+
+/**
+ * Emit the RTL Devcontainer Docker Compose Specification.
+ */
+public class EmitRtlDevcontainerDockerComposePass extends AbstractTemplateRenderingPass {
+
+  public static final String RTL_BASE_IMAGE = "ghcr.io/openvadl/rtl-test-base"
+      + "@sha256:975bacbae46da25dda52340a18772d349c7e43e3dd8aae43be61f254fc728ca8";
+
+  /**
+   * Construct the RTL Devcontainer Docker Compose emit pass.
+   *
+   * @param configuration the configuration
+   */
+  public EmitRtlDevcontainerDockerComposePass(GeneralConfiguration configuration) {
+    super(configuration, "rtl");
+  }
+
+  @Override
+  protected String getTemplatePath() {
+    return "rtl/.devcontainer/docker-compose.yaml";
+  }
+
+  @Override
+  protected String getOutputPath() {
+    return ".devcontainer/docker-compose.yaml";
+  }
+
+  @Override
+  protected String lineComment() {
+    return "#";
+  }
+
+  @Override
+  protected Map<String, Object> createVariables(PassResults passResults,
+                                                Specification specification) {
+    return Map.of(
+        "image", RTL_BASE_IMAGE
+    );
+  }
+}

vadl/test/vadl/rtl/RtlDockerTest.java

@@ -16,6 +16,8 @@
 
 package vadl.rtl;
 
+import static vadl.rtl.passes.EmitRtlDevcontainerDockerComposePass.RTL_BASE_IMAGE;
+
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.Set;
@@ -28,9 +30,6 @@
 
 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<>();