feat: change vcd format to fst format to improve sim speed

Author: maksyuki

.gitignore

@@ -12,4 +12,5 @@ DRAMsim3
 dramsim3.json
 dramsim3.txt
 dramsim3epoch.json
-*.vcd
+*.vcd
+*.wave

rtl/Makefile

@@ -40,11 +40,13 @@ SOC_VSRC_INCLPATH += -I$(ROOT_PATH)/ysyxSoC/ysyx/peripheral/spi/rtl
 SOC_CSRC_INCLPATH += -I$(SOC_CSRC_HOME)
 SOC_CSRC_INCLPATH += -I$(SOC_CSRC_LIB_HOME)
 
-SOC_CXXFLAGS += -std=c++11 -static -Wall $(SOC_CSRC_INCLPATH)
+# if want to ouput vcd wave, replace '-DDUMP_WAVE_FST' to '-DDUMP_WAVE_VCD',
+# replace '--trace-fst' to '--trace'
+SOC_CXXFLAGS += -std=c++11 -static -Wall $(SOC_CSRC_INCLPATH) -DDUMP_WAVE_FST
 SOC_FLAGS    += --cc --exe --top-module $(SOC_VSRC_TOP) 
 SOC_FLAGS    += --x-assign unique -O3 -CFLAGS "$(SOC_CXXFLAGS)"
-SOC_FLAGS    += --trace --assert --stats-vars --output-split 30000 --output-split-cfuncs 30000 
-SOC_FLAGS    += --timescale "1ns/1ns" -Wno-fatal --trace
+SOC_FLAGS    += --trace-fst --assert --stats-vars --output-split 30000 --output-split-cfuncs 30000 
+SOC_FLAGS    += --timescale "1ns/1ns" -Wno-fatal
 SOC_FLAGS    += -o $(BUILD_DIR)/soc/emu
 SOC_FLAGS    += -Mdir $(BUILD_DIR)/soc/emu-compile
 SOC_FLAGS    += $(SOC_VSRC_INCLPATH) $(SOC_CXXFILES) $(SOC_VXXFILES)
@@ -239,7 +241,7 @@ socLintCheck: socNameCheck
 	$(MAKE) -C $(YSYXSOC_HOME)/lint/ lint-unused
 	@echo -e "\033[1;32mlint-unused check done\033[0m"
 
-socPrevBuild:
+socPrevBuild: diffAllBuild socTopModify
 # FIXME: if only need to moidfy core, commit it
 # @cp $(YSYXSOC_HOME)/soc/ysyxSoCFull.v $(BUILD_DIR)/soc
 	@sed -i s/ysyx_000000/ysyx_210324/g $(BUILD_DIR)/soc/ysyxSoCFull.v

rtl/tc_l2/src/main/csrc/emu.h

@@ -1,7 +1,11 @@
 #include <unistd.h>
 #include <getopt.h>
 
+#ifdef DUMP_WAVE_VCD
 #include <verilated_vcd_c.h>
+#elif DUMP_WAVE_FST
+#include <verilated_fst_c.h>
+#endif
 #include <verilated.h>
 #include <VysyxSoCFull.h>
 
@@ -26,47 +30,53 @@ class Emulator
     flash_init(args.image);
 
     printf("Initializing and resetting DUT ...\n");
-    dut_ptr = new VysyxSoCFull;
-    dut_ptr->reset = 1;
+    dutPtr = new VysyxSoCFull;
+    dutPtr->reset = 1;
     for (int i = 0; i < 10; i++)
     {
-      dut_ptr->clock = 0;
-      dut_ptr->eval();
-      dut_ptr->clock = 1;
-      dut_ptr->eval();
+      dutPtr->clock = 0;
+      dutPtr->eval();
+      dutPtr->clock = 1;
+      dutPtr->eval();
     }
-    dut_ptr->clock = 0;
-    dut_ptr->reset = 0;
-    dut_ptr->eval();
+    dutPtr->clock = 0;
+    dutPtr->reset = 0;
+    dutPtr->eval();
 
-    if (args.dump_wave)
+    if (args.dumpWave)
     {
+#ifdef DUMP_WAVE_VCD
+      wavePtr = new VerilatedVcdC;
+#elif DUMP_WAVE_FST
+      wavePtr = new VerilatedFstC;
+#endif
       Verilated::traceEverOn(true);
-      printf("`dump-wave` enabled, waves will be written to \"soc.vcd\".\n");
-      fp = new VerilatedVcdC;
-      dut_ptr->trace(fp, 1);
-      fp->open("soc.vcd");
-      fp->dump(0);
+      printf("`dump-wave` enabled, waves will be written to \"soc.wave\".\n");
+      dutPtr->trace(wavePtr, 1);
+      wavePtr->open("soc.wave");
+      wavePtr->dump(0);
     }
   }
   ~Emulator()
   {
-    if (args.dump_wave)
+    if (args.dumpWave)
     {
-      fp->close();
-      delete fp;
+      wavePtr->close();
+      delete wavePtr;
     }
   }
 
   void step()
   {
-    dut_ptr->clock = 1;
-    dut_ptr->eval();
+    dutPtr->clock = 1;
+    dutPtr->eval();
     cycle++;
-    if (args.dump_wave && args.dump_begin <= cycle && cycle <= args.dump_end)
-      fp->dump((vluint64_t)cycle);
-    dut_ptr->clock = 0;
-    dut_ptr->eval();
+    if (args.dumpWave && args.dumpBegin <= cycle && cycle <= args.dumpEnd)
+    {
+        wavePtr->dump((vluint64_t)cycle);
+    }
+    dutPtr->clock = 0;
+    dutPtr->eval();
   }
 
   unsigned long long get_cycle()
@@ -77,7 +87,6 @@ class Emulator
 private:
   void parseArgs(int argc, char *argv[])
   {
-
     int long_index;
     const struct option long_options[] = {
         {"dump-wave", 0, NULL, 0},
@@ -97,7 +106,7 @@ class Emulator
         switch (long_index)
         {
         case 0:
-          args.dump_wave = true;
+          args.dumpWave = true;
           continue;
         }
         // fall through
@@ -108,10 +117,10 @@ class Emulator
         args.image = optarg;
         break;
       case 'b':
-        args.dump_begin = atoll(optarg);
+        args.dumpBegin = atoll(optarg);
         break;
       case 'e':
-        args.dump_end = atoll(optarg);
+        args.dumpEnd = atoll(optarg);
         break;
       }
     }
@@ -123,24 +132,33 @@ class Emulator
   {
     printf("Usage: %s [OPTION...]\n", file);
     printf("\n");
-    printf("  -i, --image=FILE           run with this image file\n");
-    printf("      --dump-wave            dump waveform when log is enabled\n");
-    printf("  -b, --log-begin=NUM        display log from NUM th cycle\n");
-    printf("  -e, --log-end=NUM          stop display log at NUM th cycle\n");
-    printf("  -h, --help                 print program help info\n");
+    printf("  -i, --image=FILE    run with this image file\n");
+    printf("      --dump-wave     dump vcd(fst) format waveform when log is enabled.\n");
+    printf("                      recommand use fst format, becuase fst format wave\n");
+    printf("                      file is much smaller than vcd format. You need to\n");
+    printf("                      change compiler option in Makefile to switch format.\n");
+    printf("  -b, --log-begin=NUM display log from NUM th cycle\n");
+    printf("  -e, --log-end=NUM   stop display log at NUM th cycle\n");
+    printf("  -h, --help          print program help info\n");
     printf("\n");
   }
 
   unsigned long long cycle = 0;
 
   struct Args
   {
-    bool dump_wave = false;
-    unsigned long dump_begin = 0;
-    unsigned long dump_end = -1;
+    bool dumpWave = false;
+    unsigned long dumpBegin = 0;
+    unsigned long dumpEnd = -1;
     const char *image = nullptr;
   } args;
 
-  VysyxSoCFull *dut_ptr = nullptr;
-  VerilatedVcdC *fp = nullptr;
+  VysyxSoCFull *dutPtr = nullptr;
+
+#ifdef DUMP_WAVE_VCD
+  VerilatedVcdC *wavePtr = nullptr;
+#elif DUMP_WAVE_FST
+  VerilatedFstC *wavePtr = nullptr;
+#endif
+  
 };