Merge branch 'main' into test-sandbox

Author: unlsycn

svsim/src/main/resources/simulation-driver.cpp

@@ -830,17 +830,25 @@ static bool processCommand() {
     }
 
     switch (argument) {
-    case '1':
+    case '1': {
       if (!traceInitialized) {
         traceInitialized = true;
         simulation_initializeTrace(state.simulationTraceFilepath);
       }
-      simulation_enableTrace();
+      int success;
+      simulation_enableTrace(&success);
+      if (!success)
+        failWithError("Cannot enable traces as simulator was not compiled to support them");
       break;
-    case '0':
-      simulation_disableTrace();
+    }
+    case '0': {
+      int success;
+      simulation_disableTrace(&success);
+      if (!success)
+        failWithError("Cannot enable traces as simulator was not compiled to support them");
       break;
     }
+    }
 
     sendAck();
     break;

svsim/src/main/scala/Workspace.scala

@@ -175,25 +175,31 @@ final class Workspace(
       l()
 
       l("  // Tracing")
+      l("  int traceSupported = 0;")
       l("  export \"DPI-C\" function simulation_initializeTrace;")
       l("  function void simulation_initializeTrace;")
       l("    input string traceFilePath;")
       l("    `ifdef SVSIM_ENABLE_VCD_TRACING_SUPPORT")
       l("      $dumpfile({traceFilePath,\".vcd\"});")
       l("      $dumpvars(0, ", dut.instanceName,");")
+      l("      traceSupported = 1;")
       l("    `endif")
       l("    `ifdef SVSIM_ENABLE_VPD_TRACING_SUPPORT")
       l("      $vcdplusfile({traceFilePath,\".vpd\"});")
       l("      $dumpvars(0, ", dut.instanceName,");")
       l("      $vcdpluson(0, ", dut.instanceName,");")
+      l("      traceSupported = 1;")
       l("    `endif")
       l("    `ifdef SVSIM_ENABLE_FSDB_TRACING_SUPPORT")
       l("      $fsdbDumpfile({traceFilePath,\".fsdb\"});")
       l("      $fsdbDumpvars(0, ", dut.instanceName,");")
+      l("      traceSupported = 1;")
       l("    `endif")
       l("  endfunction")
       l("  export \"DPI-C\" function simulation_enableTrace;")
       l("  function void simulation_enableTrace;")
+      l("    output int success;")
+      l("    success = traceSupported;")
       l("    `ifdef SVSIM_ENABLE_VCD_TRACING_SUPPORT")
       l("    $dumpon;")
       l("    `elsif SVSIM_ENABLE_VPD_TRACING_SUPPORT")
@@ -205,6 +211,8 @@ final class Workspace(
       l("  endfunction")
       l("  export \"DPI-C\" function simulation_disableTrace;")
       l("  function void simulation_disableTrace;")
+      l("    output int success;")
+      l("    success = traceSupported;")
       l("    `ifdef SVSIM_ENABLE_VCD_TRACING_SUPPORT")
       l("    $dumpoff;")
       l("    `elsif SVSIM_ENABLE_VPD_TRACING_SUPPORT")

svsim/src/test/scala/BackendSpec.scala

@@ -65,6 +65,38 @@ class VerilatorSpec extends BackendSpec {
     traceStyle = Some(TraceStyle.Vcd(traceUnderscore = false))
   )
   test("verilator", backend)(compilationSettings)
+
+  describe("trace enablement") {
+
+    it("should error if a user requests traces in a simulation that doesn't support them ") {
+      val workspace = new svsim.Workspace(path = s"test_run_dir/${getClass().getSimpleName()}")
+
+      import Resources._
+      workspace.reset()
+      workspace.elaborateGCD()
+      workspace.generateAdditionalSources()
+      val simulation = workspace.compile(
+        backend
+      )(
+        workingDirectoryTag = "verilator",
+        commonSettings = CommonCompilationSettings(),
+        backendSpecificSettings = compilationSettings.copy(traceStyle = None),
+        customSimulationWorkingDirectory = None,
+        verbose = false
+      )
+
+      intercept[svsim.Simulation.Message.Error] {
+        simulation.run(
+          verbose = false,
+          executionScriptLimit = None
+        ) { controller =>
+          controller.setTraceEnabled(true)
+        }
+      }.getMessage must include("Cannot enable traces as simulator was not compiled to support them")
+    }
+
+  }
+
 }
 
 trait BackendSpec extends AnyFunSpec with Matchers {