From f17c1d8dfef7c6631ae75d0594f52ce45922f819 Mon Sep 17 00:00:00 2001
From: Jiuyue Ma <majiuyue@bosc.ac.cn>
Date: Sat, 8 Feb 2025 17:14:54 +0800
Subject: [PATCH] vcs: Ensure correct execution order of difftest DPI calls
 (#563)

An additional `simv_step_event` was introduced to control the execution
order of the `simv_nstep()` DPI call. The order of DPI calls in different
`always` blocks is inherently unpredictable. Since `simv_nstep()` depends
on the state updated by other `v_difftest_*` DPI calls, a `#0.1` delay was
added to ensure that `simv_nstep()` is executed at the end of each clock
posedge. This modification resolves potential timing issues caused by
the implicit dependency between difftest DPI calls.

Additionally, the file extension of `DifftestEndpoint.v` was changed to
`.sv`, as the `event` mechanism is a feature specific to SystemVerilog.

Signed-off-by: Jiuyue Ma <majiuyue@bosc.ac.cn>
---
 ...DifftestEndpoint.v => DifftestEndpoint.sv} | 41 +++++++++++++++++++
 vcs.mk                                        |  2 +-
 2 files changed, 42 insertions(+), 1 deletion(-)
 rename src/test/vsrc/vcs/{DifftestEndpoint.v => DifftestEndpoint.sv} (89%)

diff --git a/src/test/vsrc/vcs/DifftestEndpoint.v b/src/test/vsrc/vcs/DifftestEndpoint.sv
similarity index 89%
rename from src/test/vsrc/vcs/DifftestEndpoint.v
rename to src/test/vsrc/vcs/DifftestEndpoint.sv
index 7c7032c08..c0355e300 100644
--- a/src/test/vsrc/vcs/DifftestEndpoint.v
+++ b/src/test/vsrc/vcs/DifftestEndpoint.sv
@@ -269,6 +269,13 @@ DeferredControl deferred(
 );
 `else
 reg [7:0] simv_result;
+`ifdef PALLADIUM
+/*
+ * In PALLADIUM, we delay the step signal to next cycle to make sure
+ * `simv_step` was triggered after other DPI calls, which needs more
+ * trick to be correct. Such as introducing `ping-pong buffer` to
+ * handle the delay-step, and dpics at the next cycle coming together.
+ */
 always @(posedge clock) begin
   if (reset || simv_result == `SIMV_DONE) begin
     simv_result <= 8'b0;
@@ -279,6 +286,40 @@ always @(posedge clock) begin
     end
   end
 end
+`else
+/*
+ * for other platform, we introduce a delayed difftest step
+ * mechanism to make sure all difftest state was updated properly
+ * before `simv_step()` called.
+ */
+reg [7:0] _res;
+event simv_step_event;
+// check difftest_step
+always @(posedge clock) begin
+  if (!reset) begin
+    if (n_cycles && |difftest_step) begin
+      // delay a little before trigger the simv step event
+      #0.1 -> simv_step_event;
+    end
+  end
+end
+// all difftest state was updated, step difftest by `simv_nstep()`
+always @(simv_step_event or posedge reset) begin
+  if (reset)
+    _res <= 8'b0;
+  else
+    _res <= simv_nstep(difftest_step);
+end
+// update to `simv_result` at next cycle
+always @(posedge clock) begin
+  if (reset || simv_result == `SIMV_DONE) begin
+    simv_result <= 8'b0;
+  end
+  else begin
+    simv_result <= _res;
+  end
+end
+`endif // PALLADIUM
 `endif // CONFIG_DIFFTEST_DEFERRED_RESULT
 
 /*
diff --git a/vcs.mk b/vcs.mk
index 057d6493c..78ae8a8eb 100644
--- a/vcs.mk
+++ b/vcs.mk
@@ -107,7 +107,7 @@ VCS_FLAGS += +incdir+$(GEN_VSRC_DIR)
 VCS_FLAGS += $(EXTRA)
 
 VCS_VSRC_DIR = $(abspath ./src/test/vsrc/vcs)
-VCS_VFILES   = $(SIM_VSRC) $(shell find $(VCS_VSRC_DIR) -name "*.v")
+VCS_VFILES   = $(SIM_VSRC) $(shell find $(VCS_VSRC_DIR) -name "*.v" -or -name "*.sv")
 $(VCS_TARGET): $(SIM_TOP_V) $(VCS_CXXFILES) $(VCS_VFILES)
 	$(VCS) $(VCS_FLAGS) $(SIM_TOP_V) $(VCS_CXXFILES) $(VCS_VFILES)
 ifeq ($(VCS),verilator)