fix: cppEmitter do not add additional code when waveform is disabled

Author: Wolf-Tungsten

Makefile

@@ -8,6 +8,9 @@ mainargs ?= ready-to-run/bin/linux.bin
 # uncomment this line to let this file be part of dependency of each .o file
 THIS_MAKEFILE = Makefile
 
+WAVEFORM ?= 0
+WAVEFORM_PATH ?= $(WORK_DIR)/waveform.fst
+
 ifeq ($(dutName),ysyx3)
 	NAME ?= newtop
 	TEST_FILE = $(NAME)-ysyx3
@@ -59,6 +62,12 @@ include mk/toolchain.mk
 SHELL := /bin/bash
 TIME = /usr/bin/time
 LOG_FILE = $(WORK_DIR)/$(dutName).log
+WAVE_LOG_FILE = $(WORK_DIR)/$(dutName)-wave.log
+EMU_RUN_ENV :=
+ifeq ($(WAVEFORM),1)
+GSIM_FLAGS_EXTRA += --trace-fst
+EMU_RUN_ENV += GSIM_ENABLE_WAVEFORM=1 GSIM_WAVEFORM_PATH=$(WAVEFORM_PATH)
+endif
 
 CFLAGS_DUT = -DDUT_NAME=S$(NAME) -DDUT_HEADER=\"$(NAME).h\" -D__DUT_$(shell echo $(dutName) | tr - _)__
 
@@ -214,11 +223,13 @@ else
 EMU_MAIN_SRCS = emu/emu.cpp
 endif
 EMU_GEN_SRCS = $(shell find $(GEN_CPP_DIR) -name "*.cpp" 2> /dev/null)
+EMU_SRCS += emu/gsim_fst_impl.cpp
 EMU_SRCS += $(EMU_MAIN_SRCS) $(EMU_GEN_SRCS)
 
-EMU_CFLAGS := -O1 -MMD $(addprefix -I, $(abspath $(GEN_CPP_DIR))) $(EMU_CFLAGS) # allow to overwrite optimization level
-EMU_CFLAGS += $(MODE_FLAGS) $(CFLAGS_DUT) -Wno-parentheses-equality
+EMU_CFLAGS := -O1 -MMD $(addprefix -I, $(abspath $(GEN_CPP_DIR))) -I$(abspath include) $(EMU_CFLAGS) # allow to overwrite optimization level
+EMU_CFLAGS += $(MODE_FLAGS) $(CFLAGS_DUT) -Wno-parentheses-equality -pthread
 EMU_CFLAGS += -fbracket-depth=2048
+EMU_LDFLAGS += -lz
 #EMU_CFLAGS += -fsanitize=address -fsanitize-address-use-after-scope
 #EMU_CFLAGS += -fsanitize=undefined -fsanitize=pointer-compare -fsanitize=pointer-subtract
 #EMU_CFLAGS += -pg -ggdb
@@ -237,7 +248,7 @@ run-emu-simpoint: $(EMU_BIN)
 	@echo 'Please run "$^ <gcpt> <checkpoint>" manually'
 
 run-emu: $(EMU_BIN)
-	$(TIME) taskset 0x1 $^ $(mainargs)
+	env $(EMU_RUN_ENV) $(TIME) taskset 0x1 $^ $(mainargs)
 
 clean-emu:
 	-rm -rf $(EMU_BUILD_DIR) $(EMU_BIN)
@@ -376,6 +387,9 @@ run:
 	mkdir -p $(dir $(LOG_FILE))
 	set -o pipefail && $(TIME) $(MAKE) run-internal 2>&1 | tee $(LOG_FILE)
 
+run-waveform:
+	$(MAKE) run WAVEFORM=1 LOG_FILE=$(WAVE_LOG_FILE) WAVE_LOG_FILE=$(WAVE_LOG_FILE) WAVEFORM_PATH=$(WAVEFORM_PATH)
+
 diff:
 	mkdir -p $(dir $(LOG_FILE))
 	set -o pipefail && $(TIME) $(MAKE) diff-internal 2>&1 | tee $(LOG_FILE)

emu/emu.cpp

@@ -8,6 +8,8 @@
 #include <fstream>
 #include <csignal>
 #include <chrono>
+#include <cstdlib>
+#include <string>
 #include <sys/mman.h>
 #include <sys/stat.h>
 #include <fcntl.h>
@@ -97,6 +99,8 @@ extern "C" void sd_read(int* data){
 #if defined(GSIM)
 #include DUT_HEADER
 static DUT_NAME* dut;
+static bool waveform_enabled = false;
+static std::string waveform_path;
 
 void dut_init(DUT_NAME *dut) {
 #if defined(__DUT_NutShell__)
@@ -126,6 +130,24 @@ void dut_hook(DUT_NAME *dut) {
   }
 #endif
 }
+
+static void maybe_enable_waveform(DUT_NAME *dut) {
+  const char* env_enable = std::getenv("GSIM_ENABLE_WAVEFORM");
+  if (env_enable == nullptr || env_enable[0] == '0') return;
+  const char* env_path = std::getenv("GSIM_WAVEFORM_PATH");
+  waveform_path = env_path ? std::string(env_path) : std::string("waveform.fst");
+  dut->setWaveformPath(waveform_path);
+  dut->enableWaveform();
+  waveform_enabled = true;
+}
+
+static void flush_waveform_if_needed() {
+  if (waveform_enabled && dut) {
+    dut->flushWaveform();
+  }
+}
+#else
+static inline void flush_waveform_if_needed() {}
 #endif
 
 #if defined(VERILATOR)
@@ -253,6 +275,7 @@ int main(int argc, char** argv) {
   dut = new DUT_NAME();
   memcpy(&dut->DUT_MEMORY, program, program_sz);
   dut_init(dut);
+  maybe_enable_waveform(dut);
   dut_reset();
 #endif
 #ifdef VERILATOR
@@ -298,6 +321,7 @@ int main(int argc, char** argv) {
       printf("ALL diffs: dut -- ref\n");
       printf("Failed after %ld cycles\n", cycles);
       checkSignals(false);
+      flush_waveform_if_needed();
       return -1;
     }
 #endif
@@ -335,9 +359,17 @@ int main(int argc, char** argv) {
       }
 #endif
 #if defined(PERF) || defined(PERF_CYCLE)
-      if (cycles >= CYCLE_MAX_PERF) return 0;
+      if (cycles >= CYCLE_MAX_PERF) {
+        flush_waveform_if_needed();
+        return 0;
+      }
 #endif
-      if (cycles == CYCLE_MAX_SIM) return 0;
+      if (cycles == CYCLE_MAX_SIM) {
+        flush_waveform_if_needed();
+        return 0;
+      }
     }
   }
+  flush_waveform_if_needed();
+  return 0;
 }

emu/gsim_fst_impl.cpp

@@ -0,0 +1,2 @@
+#define GSIM_FST_IMPL 1
+#include "gsimFst.h"

src/cppEmitter.cpp

@@ -600,12 +600,13 @@ int graph::translateInst(InstInfo inst, int indent, std::string flagName) {
           if (inst.node->isArray() || inst.node->type == NODE_WRITER) activateUncondNext(inst.node, inst.node->nextActiveId, false, flagName, indent);
           else activateNext(inst.node, inst.node->nextActiveId, oldName(inst.node), false, flagName, indent);
         }
-        if (fstWaveNodeSet.count(inst.node)) {
+        if (globalConfig.TraceFst && fstWaveNodeSet.count(inst.node)) {
+          emitBodyLock(indent, "if (dumpWaveformFlag && fstCtx) {\n");
           std::vector<int> dims = nodeArrayDims(inst.node);
           if (dims.empty()) {
-            emitBodyLock(indent, "updateFstSignal(\"%s\", &%s, %d);\n", inst.node->name.c_str(), inst.node->name.c_str(), inst.node->width);
+            emitBodyLock(indent + 1, "updateFstSignal(\"%s\", &%s, %d);\n", inst.node->name.c_str(), inst.node->name.c_str(), inst.node->width);
           } else {
-            int curIndent = indent;
+            int curIndent = indent + 1;
             for (size_t i = 0; i < dims.size(); i ++) {
               emitBodyLock(curIndent ++, "for (int i%zu = 0; i%zu < %d; i%zu ++) {\n", i, i, dims[i], i);
             }
@@ -620,6 +621,7 @@ int graph::translateInst(InstInfo inst, int indent, std::string flagName) {
               emitBodyLock(-- curIndent, "}\n");
             }
           }
+          emitBodyLock(indent, "}\n");
         }
         if (skipActivate) break;
       }