From d5159d35a2bd69eb85ca5f0cf9caadc49f491867 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Mon, 2 Dec 2024 13:32:23 -0800
Subject: [PATCH 01/34] Remove locksteplog

---
 bin/wsim | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 91f8e30ab..740193e0f 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -31,7 +31,6 @@ def parseArgs():
     parser.add_argument("--params", "-p", help="Optional top-level parameter overrides of the form param=value", default="")
     parser.add_argument("--vcd", "-v", help="Generate testbench.vcd", action="store_true")
     parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and compare.", action="store_true")
-    parser.add_argument("--locksteplog", "-b", help="Retired instruction number to be begin logging.", default=0)
     parser.add_argument("--lockstepverbose", "-lv", help="Run ImperasDV lock, step, and compare with tracing enabled", action="store_true")
     parser.add_argument("--covlog", "-d", help="Log coverage after n instructions.", default=0)
     parser.add_argument("--rvvi", "-r", help="Simulate rvvi hardware interface and ethernet.", action="store_true")
@@ -99,8 +98,6 @@ def lockstepSetup(args):
     suffix = ""
     ImperasPlusArgs = ""
 
-    if(int(args.locksteplog) >= 1): EnableLog = 1
-    else: EnableLog = 0
     if (args.lockstep or args.lockstepverbose or args.fcov):
         imperasicPath = os.path.join(WALLY, "config", args.config, "imperas.ic")
         if not os.path.isfile(imperasicPath): # If config is a derivative, look for imperas.ic in derivative configs
@@ -111,7 +108,6 @@ def lockstepSetup(args):
         prefix += f"IMPERAS_TOOLS={imperasicPath}"
 
     if (args.lockstep or args.lockstepverbose):
-        if(args.locksteplog != 0): ImperasPlusArgs = f" +IDV_TRACE2LOG={EnableLog} +IDV_TRACE2LOG_AFTER={args.locksteplog}"
         if(args.fcov):
             CovEnableStr = "1" if int(args.covlog) > 0  else "0"
             if(args.covlog >= 1): EnableLog = 1

From 783b81f8b8fcca56483167d1b86bedaa871dd1ad Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Mon, 2 Dec 2024 13:52:44 -0800
Subject: [PATCH 02/34] VCD support in all simulators

---
 bin/wsim               | 2 +-
 testbench/testbench.sv | 9 +++++----
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 740193e0f..9defcc1c9 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -78,7 +78,7 @@ def elfFileCheck(args):
 def prepSim(args, ElfFile):
     flags = ""
     if args.vcd:
-        args.args += " -DMAKEVCD=1"
+        args.params += " MAKE_VCD=1 "
     if args.rvvi:
         args.params += " RVVI_SYNTH_SUPPORTED=1 "
     if args.tb == "testbench_fp":
diff --git a/testbench/testbench.sv b/testbench/testbench.sv
index c777fdf3f..40f5410ef 100644
--- a/testbench/testbench.sv
+++ b/testbench/testbench.sv
@@ -44,6 +44,7 @@ module testbench;
   parameter I_CACHE_ADDR_LOGGER=0;
   parameter D_CACHE_ADDR_LOGGER=0;
   parameter RVVI_SYNTH_SUPPORTED=0;
+  parameter MAKE_VCD=0;
 
   `ifdef USE_IMPERAS_DV
     import idvPkg::*;
@@ -230,10 +231,10 @@ module testbench;
       end
       $finish;
     end
-`ifdef MAKEVCD
-    $dumpfile("testbench.vcd");
-    $dumpvars;
-`endif
+    if (MAKE_VCD) begin
+      $dumpfile("testbench.vcd");
+      $dumpvars;
+    end
   end // initial begin
 
   // Model the testbench as an fsm.

From edf96a7211763ebdd5f413d417121eacd76b3e9d Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Mon, 2 Dec 2024 13:56:34 -0800
Subject: [PATCH 03/34] Move wsim debug flag to common flags section

---
 bin/wsim | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 9defcc1c9..8766957b1 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -85,6 +85,8 @@ def prepSim(args, ElfFile):
         args.params += f' TEST="{args.testsuite}" '
     if ElfFile != "":
         args.args += f" {ElfFile}"
+    if args.gui and args.tb == "testbench":
+        args.params += " DEBUG=1 "
     if args.ccov:
         flags += " --ccov"
     if args.fcov:
@@ -135,8 +137,6 @@ def runSim(args, flags, prefix):
 def runQuesta(args, flags, prefix):
     # Force Questa to use 64-bit mode, sometimes it defaults to 32-bit even on 64-bit machines
     prefix = "MTI_VCO_MODE=64 " + prefix
-    if (args.gui) and (args.tb == "testbench"):
-        args.params += "DEBUG=1"
     if (args.args != ""):
         args.args = f' --args \\"{args.args}\\"'
     if (args.params != ""):

From 479c6667fe7a0d408ba4e27e874e19e9a9873650 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Mon, 2 Dec 2024 14:02:33 -0800
Subject: [PATCH 04/34] Generalize wsim gui flag and simplify questa launch
 command

---
 bin/wsim            | 9 +++------
 sim/questa/wally.do | 4 ++--
 2 files changed, 5 insertions(+), 8 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 8766957b1..512ee5e42 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -91,6 +91,8 @@ def prepSim(args, ElfFile):
         flags += " --ccov"
     if args.fcov:
         flags += " --fcov"
+    if args.gui:
+        flags += " --gui"
     prefix, suffix = lockstepSetup(args)
     flags += suffix
     return flags, prefix
@@ -143,10 +145,7 @@ def runQuesta(args, flags, prefix):
         args.params = f' --params \\"{args.params}\\"'
     # Questa cannot accept more than 9 arguments.  fcov implies lockstep
     cmd = f"do wally.do {args.config} {args.testsuite} {args.tb} {args.args} {args.params} {flags}"
-    if (args.gui):  # launch Questa with GUI; add +acc to keep variables accessible
-        cmd = f'cd $WALLY/sim/questa; {prefix} vsim -do "{cmd}  +acc"'
-    else: # launch Questa in batch mode
-        cmd = f'cd $WALLY/sim/questa; {prefix} vsim -c -do "{cmd}"'
+    cmd = f'cd $WALLY/sim/questa; {prefix} vsim {"-c" if not args.gui else ""} -do "{cmd}"'
     print(f"Running Questa with command: {cmd}")
     os.system(cmd)
 
@@ -156,8 +155,6 @@ def runVerilator(args, flags, prefix):
 
 def runVCS(args, flags, prefix):
     print(f"Running VCS on {args.config} {args.testsuite}")
-    # if (args.gui):
-    #     flags += " --gui"
     if (args.args != ""):
         args.args = f' --args "{args.args}" '
     if (args.params != ""):
diff --git a/sim/questa/wally.do b/sim/questa/wally.do
index f42bf4930..3935d7a25 100644
--- a/sim/questa/wally.do
+++ b/sim/questa/wally.do
@@ -8,7 +8,7 @@
 #
 # Takes 1:10 to run RV64IC tests using gui
 
-# Usage: do wally.do <config> <testcases> <testbench> [--ccov] [--fcov] [+acc] [--args "any number of +value"] [--params "any number of VAR=VAL parameter overrides"]
+# Usage: do wally.do <config> <testcases> <testbench> [--ccov] [--fcov] [--gui] [--args "any number of +value"] [--params "any number of VAR=VAL parameter overrides"]
 # Example: do wally.do rv64gc arch64i testbench
 
 # Use this wally.do file to run this example.
@@ -91,7 +91,7 @@ echo "number of args = $argc"
 echo "lst = $lst"
 
 # if +acc found set flag and remove from list
-if {[lcheck lst "+acc"]} {
+if {[lcheck lst "--gui"]} {
     set GUI 1
     set accFlag "+acc"
 }

From bd9ca6ada6d0fac5dd67b3ac7a1cedc31c1ac91e Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Tue, 3 Dec 2024 00:18:00 -0800
Subject: [PATCH 05/34] Remove covlog

---
 bin/wsim | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 512ee5e42..1b0a848bf 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -32,7 +32,6 @@ def parseArgs():
     parser.add_argument("--vcd", "-v", help="Generate testbench.vcd", action="store_true")
     parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and compare.", action="store_true")
     parser.add_argument("--lockstepverbose", "-lv", help="Run ImperasDV lock, step, and compare with tracing enabled", action="store_true")
-    parser.add_argument("--covlog", "-d", help="Log coverage after n instructions.", default=0)
     parser.add_argument("--rvvi", "-r", help="Simulate rvvi hardware interface and ethernet.", action="store_true")
     return parser.parse_args()
 
@@ -113,10 +112,7 @@ def lockstepSetup(args):
 
     if (args.lockstep or args.lockstepverbose):
         if(args.fcov):
-            CovEnableStr = "1" if int(args.covlog) > 0  else "0"
-            if(args.covlog >= 1): EnableLog = 1
-            else: EnableLog = 0
-            ImperasPlusArgs = f" +IDV_TRACE2COV={EnableLog} +TRACE2LOG_AFTER={args.covlog} +TRACE2COV_ENABLE={CovEnableStr}"
+            ImperasPlusArgs = f" +IDV_TRACE2COV={0} +TRACE2LOG_AFTER={0} +TRACE2COV_ENABLE={0}"
         else:
             suffix = "--lockstep"
         if(args.lockstepverbose):

From 9f92572f2bd9fe3c4061a36a3b612761154072a4 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Tue, 3 Dec 2024 01:26:31 -0800
Subject: [PATCH 06/34] Significantly simplify lockstepSetup function now that
 covlog and locksteplog are removed

---
 bin/wsim | 38 ++++++++++++++------------------------
 1 file changed, 14 insertions(+), 24 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 1b0a848bf..0db6bb68d 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -76,6 +76,7 @@ def elfFileCheck(args):
 
 def prepSim(args, ElfFile):
     flags = ""
+    prefix = ""
     if args.vcd:
         args.params += " MAKE_VCD=1 "
     if args.rvvi:
@@ -92,33 +93,22 @@ def prepSim(args, ElfFile):
         flags += " --fcov"
     if args.gui:
         flags += " --gui"
-    prefix, suffix = lockstepSetup(args)
-    flags += suffix
+    if args.lockstep or args.lockstepverbose:
+        flags += " --lockstep"
+    if args.lockstep or args.lockstepverbose or args.fcov:
+        prefix = lockstepSetup(args)
     return flags, prefix
 
 def lockstepSetup(args):
-    prefix = ""
-    suffix = ""
-    ImperasPlusArgs = ""
-
-    if (args.lockstep or args.lockstepverbose or args.fcov):
-        imperasicPath = os.path.join(WALLY, "config", args.config, "imperas.ic")
-        if not os.path.isfile(imperasicPath): # If config is a derivative, look for imperas.ic in derivative configs
-            imperasicPath = os.path.join(WALLY, "config", "deriv", args.config, "imperas.ic")
-            if not os.path.isfile(imperasicPath):
-                print("Error: imperas.ic not found")
-                exit(1)
-        prefix += f"IMPERAS_TOOLS={imperasicPath}"
-
-    if (args.lockstep or args.lockstepverbose):
-        if(args.fcov):
-            ImperasPlusArgs = f" +IDV_TRACE2COV={0} +TRACE2LOG_AFTER={0} +TRACE2COV_ENABLE={0}"
-        else:
-            suffix = "--lockstep"
-        if(args.lockstepverbose):
-            prefix += f":{WALLY}/sim/imperas-verbose.ic"
-    args.args += ImperasPlusArgs
-    return prefix, suffix
+    imperasicVerbosePath = os.path.join(WALLY, "sim", "imperas-verbose.ic")
+    imperasicPath = os.path.join(WALLY, "config", args.config, "imperas.ic")
+    if not os.path.isfile(imperasicPath): # If config is a derivative, look for imperas.ic in derivative configs
+        imperasicPath = os.path.join(WALLY, "config", "deriv", args.config, "imperas.ic")
+        if not os.path.isfile(imperasicPath):
+            print("Error: imperas.ic not found")
+            exit(1)
+    prefix = f"IMPERAS_TOOLS={imperasicPath}{f':{imperasicVerbosePath}' if args.lockstepverbose else ''} "
+    return prefix
 
 def createDirs(args):
     for d in ["logs", "wkdir", "cov", "ucdb", "fcov", "fcov_ucdb"]:

From 8bd4b8b235bb8e843ccf9d54a6e12eabbb6944d3 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Tue, 3 Dec 2024 04:08:23 -0800
Subject: [PATCH 07/34] Simplify wsim createDirs function

---
 bin/wsim | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 0db6bb68d..a2527205a 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -110,9 +110,9 @@ def lockstepSetup(args):
     prefix = f"IMPERAS_TOOLS={imperasicPath}{f':{imperasicVerbosePath}' if args.lockstepverbose else ''} "
     return prefix
 
-def createDirs(args):
+def createDirs(sim):
     for d in ["logs", "wkdir", "cov", "ucdb", "fcov", "fcov_ucdb"]:
-        os.makedirs(os.path.join(WALLY, "sim", args.sim, d), exist_ok=True)
+        os.makedirs(os.path.join(WALLY, "sim", sim, d), exist_ok=True)
 
 def runSim(args, flags, prefix):
     if (args.sim == "questa"):
@@ -155,5 +155,5 @@ if __name__ == "__main__":
     print(f"Config={args.config} tests={args.testsuite} sim={args.sim} gui={args.gui} args='{args.args}' params='{args.params}'")
     ElfFile = elfFileCheck(args)
     flags, prefix = prepSim(args, ElfFile)
-    createDirs(args)
+    createDirs(args.sim)
     exit(runSim(args, flags, prefix))

From a3cd2669672f8566e6710cf7277632ad93c8f7a9 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 12:54:51 -0800
Subject: [PATCH 08/34] Fix run_vcs code coverage flag

---
 sim/vcs/run_vcs | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/sim/vcs/run_vcs b/sim/vcs/run_vcs
index 1234ac4c8..fb04d0fd2 100755
--- a/sim/vcs/run_vcs
+++ b/sim/vcs/run_vcs
@@ -24,8 +24,8 @@ parser = argparse.ArgumentParser()
 parser.add_argument("config", help="Configuration file")
 parser.add_argument("testsuite", help="Test suite (or none, when running a single ELF file) ")
 parser.add_argument("--tb", "-t", help="Testbench", choices=["testbench", "testbench_fp"], default="testbench")
-parser.add_argument("--coverage", "-c", help="Code & Functional Coverage", action="store_true")
-parser.add_argument("--fcov", "-f", help="Code & Functional Coverage", action="store_true")
+parser.add_argument("--ccov", "-c", help="Code Coverage", action="store_true")
+parser.add_argument("--fcov", "-f", help="Functional Coverage", action="store_true")
 parser.add_argument("--args", "-a", help="Optional arguments passed to simulator via $value$plusargs", default="")
 parser.add_argument("--params", "-p", help="Optional top-level parameter overrides of the form param=value", default="")
 parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and compare.", action="store_true")
@@ -65,7 +65,7 @@ else:
     LOCKSTEP_SIMV = ""
 
 # coverage mode
-if (args.coverage):
+if (args.ccov):
     COV_OPTIONS = "-cm line+cond+branch+fsm+tgl -cm_log " + wkdir + "/coverage.log -cm_dir " + wkdir + "/coverage"
 else:
     COV_OPTIONS = ""
@@ -93,6 +93,6 @@ SIMV_CMD= wkdir + "/" + OUTPUT + " +TEST=" + args.testsuite + " " + args.args +
 print("Executing: " + str(VCS) )
 subprocess.run(VCS, shell=True)
 subprocess.run(SIMV_CMD, shell=True)
-if (args.coverage):
+if (args.ccov):
     COV_RUN = "urg -dir " + wkdir + "/coverage.vdb -format text -report IndividualCovReport/" + args.config + "_" + args.testsuite
     subprocess.run(COV_RUN, shell=True)

From 14ad03cde13b3d33cd6d56f538d6ccf00baca3c4 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 12:55:48 -0800
Subject: [PATCH 09/34] Add .memfile to gitignore

---
 .gitignore | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.gitignore b/.gitignore
index 9a0f35cc1..1a8b66e80 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,6 +12,7 @@
 *.map
 *.elf*
 *.list
+*.memfile
 
 # General directories to ignore
 .vscode/

From 95a5070a729915f7bd56330e7e88746a48802ba4 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 12:56:12 -0800
Subject: [PATCH 10/34] Move IMPERAS_HOME in wally.do to avoid issue if not set

---
 sim/questa/wally.do | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sim/questa/wally.do b/sim/questa/wally.do
index 3935d7a25..6e073ea87 100644
--- a/sim/questa/wally.do
+++ b/sim/questa/wally.do
@@ -40,7 +40,6 @@ set TESTSUITE ${2}
 set TESTBENCH ${3}
 set WKDIR wkdir/${CFG}_${TESTSUITE}
 set WALLY $::env(WALLY)
-set IMPERAS_HOME $::env(IMPERAS_HOME)
 set CONFIG ${WALLY}/config
 set SRC ${WALLY}/src
 set TB ${WALLY}/testbench
@@ -118,6 +117,7 @@ if {[lcheck lst "--fcov"]} {
 
 # if --lockstep or --fcov found set flag and remove from list
 if {[lcheck lst "--lockstep"] || $FunctCoverage == 1} {
+    set IMPERAS_HOME $::env(IMPERAS_HOME)
     set lockstep 1
     set lockstepvlog "+define+USE_IMPERAS_DV \
                       +incdir+${IMPERAS_HOME}/ImpPublic/include/host \

From 25cdf83aaee202eeb4c4c371f090efe0552ef884 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:13:35 -0800
Subject: [PATCH 11/34] Remove extra spaces and use lists for assembling args
 and params

---
 bin/wsim | 40 +++++++++++++++++++++++-----------------
 1 file changed, 23 insertions(+), 17 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index a2527205a..1fde4eda1 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -39,7 +39,7 @@ def validateArgs(args):
     if not args.testsuite and not args.elf:
         print("Error: Missing test suite or ELF file")
         exit(1)
-    if args.lockstep and not args.testsuite.endswith('.elf') and args.testsuite != "buildroot" :
+    if args.lockstep and not args.testsuite.endswith('.elf') and args.testsuite != "buildroot":
         print(f"Invalid Options. Cannot run a testsuite, {args.testsuite} with lockstep. Must run a single elf or buildroot.")
         exit(1)
     elif (args.gui or args.ccov or args.fcov or args.lockstep or args.lockstepverbose) and args.sim not in ["questa", "vcs"]:
@@ -75,28 +75,34 @@ def elfFileCheck(args):
     return ElfFile
 
 def prepSim(args, ElfFile):
-    flags = ""
     prefix = ""
+    params = []
+    args = []
+    flags = []
     if args.vcd:
-        args.params += " MAKE_VCD=1 "
+        params.append("MAKE_VCD=1")
     if args.rvvi:
-        args.params += " RVVI_SYNTH_SUPPORTED=1 "
+        params.append("RVVI_SYNTH_SUPPORTED=1")
     if args.tb == "testbench_fp":
-        args.params += f' TEST="{args.testsuite}" '
-    if ElfFile != "":
-        args.args += f" {ElfFile}"
+        params.append(f'TEST="{args.testsuite}"')
+    if ElfFile:
+        args.append += f"{ElfFile}"
     if args.gui and args.tb == "testbench":
-        args.params += " DEBUG=1 "
+        params.append("DEBUG=1")
     if args.ccov:
-        flags += " --ccov"
+        flags.append("--ccov")
     if args.fcov:
-        flags += " --fcov"
+        flags.append("--fcov")
     if args.gui:
-        flags += " --gui"
+        flags.append("--gui")
     if args.lockstep or args.lockstepverbose:
-        flags += " --lockstep"
+        flags.append("--lockstep")
     if args.lockstep or args.lockstepverbose or args.fcov:
         prefix = lockstepSetup(args)
+    # Combine into a single string
+    args.args += " ".join(args)
+    args.params += " ".join(params)
+    flags = " ".join(flags)
     return flags, prefix
 
 def lockstepSetup(args):
@@ -107,7 +113,7 @@ def lockstepSetup(args):
         if not os.path.isfile(imperasicPath):
             print("Error: imperas.ic not found")
             exit(1)
-    prefix = f"IMPERAS_TOOLS={imperasicPath}{f':{imperasicVerbosePath}' if args.lockstepverbose else ''} "
+    prefix = f"IMPERAS_TOOLS={imperasicPath}{f':{imperasicVerbosePath}' if args.lockstepverbose else ''}"
     return prefix
 
 def createDirs(sim):
@@ -126,9 +132,9 @@ def runQuesta(args, flags, prefix):
     # Force Questa to use 64-bit mode, sometimes it defaults to 32-bit even on 64-bit machines
     prefix = "MTI_VCO_MODE=64 " + prefix
     if (args.args != ""):
-        args.args = f' --args \\"{args.args}\\"'
+        args.args = fr'--args \"{args.args}\"'
     if (args.params != ""):
-        args.params = f' --params \\"{args.params}\\"'
+        args.params = fr'--params \"{args.params}\"'
     # Questa cannot accept more than 9 arguments.  fcov implies lockstep
     cmd = f"do wally.do {args.config} {args.testsuite} {args.tb} {args.args} {args.params} {flags}"
     cmd = f'cd $WALLY/sim/questa; {prefix} vsim {"-c" if not args.gui else ""} -do "{cmd}"'
@@ -142,9 +148,9 @@ def runVerilator(args, flags, prefix):
 def runVCS(args, flags, prefix):
     print(f"Running VCS on {args.config} {args.testsuite}")
     if (args.args != ""):
-        args.args = f' --args "{args.args}" '
+        args.args = f'--args "{args.args}"'
     if (args.params != ""):
-        args.params = f' --params "{args.params}" '
+        args.params = f'--params "{args.params}"'
     cmd = f"cd $WALLY/sim/vcs; {prefix} ./run_vcs {args.config} {args.testsuite} --tb {args.tb} {args.args} {args.params} {flags}"
     print(cmd)
     os.system(cmd)

From bdc20243a6d183ca73bd8d7d9e317c46becdf551 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:18:03 -0800
Subject: [PATCH 12/34] Fix overriding args

---
 bin/wsim | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 1fde4eda1..9bc3252bc 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -76,33 +76,33 @@ def elfFileCheck(args):
 
 def prepSim(args, ElfFile):
     prefix = ""
-    params = []
-    args = []
-    flags = []
+    paramsList = []
+    argsList = []
+    flagsList = []
     if args.vcd:
-        params.append("MAKE_VCD=1")
+        paramsList.append("MAKE_VCD=1")
     if args.rvvi:
-        params.append("RVVI_SYNTH_SUPPORTED=1")
+        paramsList.append("RVVI_SYNTH_SUPPORTED=1")
     if args.tb == "testbench_fp":
-        params.append(f'TEST="{args.testsuite}"')
+        paramsList.append(f'TEST="{args.testsuite}"')
     if ElfFile:
-        args.append += f"{ElfFile}"
+        argsList.append += f"{ElfFile}"
     if args.gui and args.tb == "testbench":
-        params.append("DEBUG=1")
+        paramsList.append("DEBUG=1")
     if args.ccov:
-        flags.append("--ccov")
+        flagsList.append("--ccov")
     if args.fcov:
-        flags.append("--fcov")
+        flagsList.append("--fcov")
     if args.gui:
-        flags.append("--gui")
+        flagsList.append("--gui")
     if args.lockstep or args.lockstepverbose:
-        flags.append("--lockstep")
+        flagsList.append("--lockstep")
     if args.lockstep or args.lockstepverbose or args.fcov:
         prefix = lockstepSetup(args)
     # Combine into a single string
-    args.args += " ".join(args)
-    args.params += " ".join(params)
-    flags = " ".join(flags)
+    args.args += " ".join(argsList)
+    args.params += " ".join(paramsList)
+    flags = " ".join(flagsList)
     return flags, prefix
 
 def lockstepSetup(args):

From 59bedb78c58377df3844d27cdafcf97e65226856 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:24:10 -0800
Subject: [PATCH 13/34] Cleanup verilator paths

---
 sim/verilator/Makefile | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/sim/verilator/Makefile b/sim/verilator/Makefile
index 6a6ad267a..666516c2d 100644
--- a/sim/verilator/Makefile
+++ b/sim/verilator/Makefile
@@ -17,12 +17,10 @@ EXPANDED_PARAM_ARGS:=$(patsubst %,-G%,$(PARAM_ARGS))
 
 WALLYCONF?=rv64gc
 TEST?=arch64i
-TESTBENCH?=testbench 	
+TESTBENCH?=testbench
 
 # constants
 # assume WALLY variable is correctly configured in the shell environment
-WORKING_DIR=${WALLY}/sim/verilator
-TARGET=$(WORKING_DIR)/target
 # INCLUDE_PATH are pathes that Verilator should search for files it needs
 INCLUDE_PATH="-I${WALLY}/config/shared" "-I${WALLY}/config/$(WALLYCONF)" "-I${WALLY}/config/deriv/$(WALLYCONF)"
 # SOURCES are source files
@@ -30,6 +28,8 @@ SOURCES=${WALLY}/src/cvw.sv ${WALLY}/testbench/${TESTBENCH}.sv ${WALLY}/testbenc
 # DEPENDENCIES are configuration files and source files, which leads to recompilation of executables
 DEPENDENCIES=${WALLY}/config/shared/*.vh $(SOURCES)
 
+WORKDIR = $(VERILATOR_DIR)/wkdir/$(WALLYCONF)_$(TEST)
+
 # regular testbench requires a wrapper defining getenvval
 ifeq ($(TESTBENCH), testbench)
 	WRAPPER=${WALLY}/sim/verilator/wrapper.c
@@ -41,9 +41,9 @@ endif
 
 default: run
 
-run: wkdir/$(WALLYCONF)_$(TEST)/V${TESTBENCH}
+run: $(WORKDIR)/V${TESTBENCH}
 	mkdir -p $(VERILATOR_DIR)/logs
-	wkdir/$(WALLYCONF)_$(TEST)/V${TESTBENCH} ${ARGTEST} $(PLUS_ARGS)
+	$(WORKDIR)/V${TESTBENCH} ${ARGTEST} $(PLUS_ARGS)
 
 profile: obj_dir_profiling/V${TESTBENCH}_$(WALLYCONF)
 	$(VERILATOR_DIR)/obj_dir_profiling/V${TESTBENCH}_$(WALLYCONF) ${ARGTEST}
@@ -54,10 +54,10 @@ profile: obj_dir_profiling/V${TESTBENCH}_$(WALLYCONF)
 	mv gmon_$(WALLYCONF)* $(VERILATOR_DIR)/logs_profiling
 	echo "Please check $(VERILATOR_DIR)/logs_profiling/gmon_$(WALLYCONF)* for logs and output files."
 
-wkdir/$(WALLYCONF)_$(TEST)/V${TESTBENCH}: $(DEPENDENCIES)
-	mkdir -p wkdir/$(WALLYCONF)_$(TEST)
+$(WORKDIR)/V${TESTBENCH}: $(DEPENDENCIES)
+	mkdir -p $(WORKDIR)
 	verilator \
-	--Mdir wkdir/$(WALLYCONF)_$(TEST) -o V${TESTBENCH} \
+	--Mdir $(WORKDIR) -o V${TESTBENCH} \
 	--binary --trace \
 	$(OPT) $(PARAMS) $(NONPROF) \
 	--top-module ${TESTBENCH}  --relative-includes \

From 8b2a053bd430972b74122ef935359500d1b0bc17 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:32:56 -0800
Subject: [PATCH 14/34] Remove unnecessary parentheses in wsim

---
 bin/wsim | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 9bc3252bc..597d7f111 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -121,19 +121,19 @@ def createDirs(sim):
         os.makedirs(os.path.join(WALLY, "sim", sim, d), exist_ok=True)
 
 def runSim(args, flags, prefix):
-    if (args.sim == "questa"):
+    if args.sim == "questa":
         runQuesta(args, flags, prefix)
-    elif (args.sim == "verilator"):
+    elif args.sim == "verilator":
         runVerilator(args, flags, prefix)
-    elif (args.sim == "vcs"):
+    elif args.sim == "vcs":
         runVCS(args, flags, prefix)
 
 def runQuesta(args, flags, prefix):
     # Force Questa to use 64-bit mode, sometimes it defaults to 32-bit even on 64-bit machines
     prefix = "MTI_VCO_MODE=64 " + prefix
-    if (args.args != ""):
+    if args.args != "":
         args.args = fr'--args \"{args.args}\"'
-    if (args.params != ""):
+    if args.params != "":
         args.params = fr'--params \"{args.params}\"'
     # Questa cannot accept more than 9 arguments.  fcov implies lockstep
     cmd = f"do wally.do {args.config} {args.testsuite} {args.tb} {args.args} {args.params} {flags}"

From 8fc907a4966a0ace4998d9d681e492cf759eee3c Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:33:14 -0800
Subject: [PATCH 15/34] Switch to sys.exit in wsim

---
 bin/wsim | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 597d7f111..95bbda312 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -13,6 +13,7 @@
 
 import argparse
 import os
+import sys
 
 # Global variable
 WALLY = os.environ.get('WALLY')
@@ -38,16 +39,16 @@ def parseArgs():
 def validateArgs(args):
     if not args.testsuite and not args.elf:
         print("Error: Missing test suite or ELF file")
-        exit(1)
+        sys.exit(1)
     if args.lockstep and not args.testsuite.endswith('.elf') and args.testsuite != "buildroot":
         print(f"Invalid Options. Cannot run a testsuite, {args.testsuite} with lockstep. Must run a single elf or buildroot.")
-        exit(1)
+        sys.exit(1)
     elif (args.gui or args.ccov or args.fcov or args.lockstep or args.lockstepverbose) and args.sim not in ["questa", "vcs"]:
         print("Option only supported for Questa and VCS")
-        exit(1)
+        sys.exit(1)
     elif (args.tb == "testbench_fp" and args.sim != "questa"):
         print("Error: testbench_fp presently only supported by Questa, not VCS or Verilator, because of a touchy testbench")
-        exit(1)
+        sys.exit(1)
 
 def elfFileCheck(args):
     ElfFile = ""
@@ -55,23 +56,23 @@ def elfFileCheck(args):
         ElfFile = f"+ElfFile={os.path.abspath(args.elf)}"
     elif args.elf != "":
         print(f"ELF file not found: {args.elf}")
-        exit(1)
+        sys.exit(1)
     elif args.testsuite.endswith('.elf'): # No --elf argument; check if testsuite has a .elf extension and use that instead
         if os.path.isfile(args.testsuite):
             ElfFile = f"+ElfFile={os.path.abspath(args.testsuite)}"
             # extract the elf name from the path to be the test suite
             fields = args.testsuite.rsplit('/', 3)
             # if the name is just ref.elf in a deep path (riscv-arch-test/wally-riscv-arch-test), then use the directory name as the test suite to make it unique; otherwise work directory will have duplicates.
-            if (len(fields) > 3):
-                if (fields[2] == "ref"):
+            if len(fields) > 3:
+                if fields[2] == "ref":
                     args.testsuite = f"{fields[1]}_{fields[3]}"
                 else:
                     args.testsuite = f"{fields[2]}_{fields[3]}"
-            elif ('/' in args.testsuite):
+            elif '/' in args.testsuite:
                 args.testsuite=args.testsuite.rsplit('/', 1)[1] # strip off path if present
         else:
             print(f"ELF file not found: {args.testsuite}")
-            exit(1)
+            sys.exit(1)
     return ElfFile
 
 def prepSim(args, ElfFile):
@@ -112,7 +113,7 @@ def lockstepSetup(args):
         imperasicPath = os.path.join(WALLY, "config", "deriv", args.config, "imperas.ic")
         if not os.path.isfile(imperasicPath):
             print("Error: imperas.ic not found")
-            exit(1)
+            sys.exit(1)
     prefix = f"IMPERAS_TOOLS={imperasicPath}{f':{imperasicVerbosePath}' if args.lockstepverbose else ''}"
     return prefix
 
@@ -147,9 +148,9 @@ def runVerilator(args, flags, prefix):
 
 def runVCS(args, flags, prefix):
     print(f"Running VCS on {args.config} {args.testsuite}")
-    if (args.args != ""):
+    if args.args != "":
         args.args = f'--args "{args.args}"'
-    if (args.params != ""):
+    if args.params != "":
         args.params = f'--params "{args.params}"'
     cmd = f"cd $WALLY/sim/vcs; {prefix} ./run_vcs {args.config} {args.testsuite} --tb {args.tb} {args.args} {args.params} {flags}"
     print(cmd)
@@ -162,4 +163,4 @@ if __name__ == "__main__":
     ElfFile = elfFileCheck(args)
     flags, prefix = prepSim(args, ElfFile)
     createDirs(args.sim)
-    exit(runSim(args, flags, prefix))
+    sys.exit(runSim(args, flags, prefix))

From c178180b0f50cda7de4098e46a2d51fdddc2491e Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:53:18 -0800
Subject: [PATCH 16/34] A bit more cleanup

---
 bin/wsim | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 95bbda312..dbe106280 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -43,7 +43,7 @@ def validateArgs(args):
     if args.lockstep and not args.testsuite.endswith('.elf') and args.testsuite != "buildroot":
         print(f"Invalid Options. Cannot run a testsuite, {args.testsuite} with lockstep. Must run a single elf or buildroot.")
         sys.exit(1)
-    elif (args.gui or args.ccov or args.fcov or args.lockstep or args.lockstepverbose) and args.sim not in ["questa", "vcs"]:
+    elif any([args.gui, args.ccov, args.fcov, args.lockstep, args.lockstepverbose]) and args.sim not in ["questa", "vcs"]:
         print("Option only supported for Questa and VCS")
         sys.exit(1)
     elif (args.tb == "testbench_fp" and args.sim != "questa"):
@@ -125,7 +125,7 @@ def runSim(args, flags, prefix):
     if args.sim == "questa":
         runQuesta(args, flags, prefix)
     elif args.sim == "verilator":
-        runVerilator(args, flags, prefix)
+        runVerilator(args)
     elif args.sim == "vcs":
         runVCS(args, flags, prefix)
 
@@ -142,7 +142,7 @@ def runQuesta(args, flags, prefix):
     print(f"Running Questa with command: {cmd}")
     os.system(cmd)
 
-def runVerilator(args, flags, prefix):
+def runVerilator(args):
     print(f"Running Verilator on {args.config} {args.testsuite}")
     os.system(f'make -C {WALLY}/sim/verilator WALLYCONF={args.config} TEST={args.testsuite} TESTBENCH={args.tb} PLUS_ARGS="{args.args}" PARAM_ARGS="{args.params}"')
 

From c9885ff495ad6f314cb6bfddeb888336db6008b8 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:54:47 -0800
Subject: [PATCH 17/34] Change wsim main function for potential use as imported
 module in regression-wally

---
 bin/wsim | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index dbe106280..55ca015e6 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -156,11 +156,14 @@ def runVCS(args, flags, prefix):
     print(cmd)
     os.system(cmd)
 
-if __name__ == "__main__":
-    args = parseArgs()
+def main(args):
     validateArgs(args)
     print(f"Config={args.config} tests={args.testsuite} sim={args.sim} gui={args.gui} args='{args.args}' params='{args.params}'")
     ElfFile = elfFileCheck(args)
     flags, prefix = prepSim(args, ElfFile)
     createDirs(args.sim)
     sys.exit(runSim(args, flags, prefix))
+
+if __name__ == "__main__":
+    args = parseArgs()
+    main(args)

From 464a516e989309a2a134e3be48bcb6da47666147 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 13:58:45 -0800
Subject: [PATCH 18/34] Disable fcov on testsuite

---
 bin/wsim | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 55ca015e6..e8862ec95 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -40,8 +40,8 @@ def validateArgs(args):
     if not args.testsuite and not args.elf:
         print("Error: Missing test suite or ELF file")
         sys.exit(1)
-    if args.lockstep and not args.testsuite.endswith('.elf') and args.testsuite != "buildroot":
-        print(f"Invalid Options. Cannot run a testsuite, {args.testsuite} with lockstep. Must run a single elf or buildroot.")
+    if any([args.lockstep, args.lockstepverbose, args.fcov]) and not (args.testsuite.endswith('.elf') or args.elf) and args.testsuite != "buildroot":
+        print(f"Invalid Options. Cannot run a testsuite, {args.testsuite} with lockstep or fcov. Must run a single elf or buildroot.")
         sys.exit(1)
     elif any([args.gui, args.ccov, args.fcov, args.lockstep, args.lockstepverbose]) and args.sim not in ["questa", "vcs"]:
         print("Option only supported for Questa and VCS")

From 256211e4dcc3bfb806ba5d97ea25886aa06a8f4d Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sat, 7 Dec 2024 14:06:31 -0800
Subject: [PATCH 19/34] Fix wsim elfile handling

---
 bin/wsim | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bin/wsim b/bin/wsim
index e8862ec95..ebee44883 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -87,7 +87,7 @@ def prepSim(args, ElfFile):
     if args.tb == "testbench_fp":
         paramsList.append(f'TEST="{args.testsuite}"')
     if ElfFile:
-        argsList.append += f"{ElfFile}"
+        argsList.append(f"{ElfFile}")
     if args.gui and args.tb == "testbench":
         paramsList.append("DEBUG=1")
     if args.ccov:

From 1c0e5de07b4544164b86c1642a24694966dcd49e Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 01:46:44 -0800
Subject: [PATCH 20/34] Add --define to wsim

---
 bin/wsim | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/bin/wsim b/bin/wsim
index ebee44883..acb5cec76 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -30,6 +30,7 @@ def parseArgs():
     parser.add_argument("--fcov", "-f", help="Functional Coverage with cvw-arch-verif, implies lockstep", action="store_true")
     parser.add_argument("--args", "-a", help="Optional arguments passed to simulator via $value$plusargs", default="")
     parser.add_argument("--params", "-p", help="Optional top-level parameter overrides of the form param=value", default="")
+    parser.add_argument("--define", "-d", help="Optional define macros passed to simulator", default="")
     parser.add_argument("--vcd", "-v", help="Generate testbench.vcd", action="store_true")
     parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and compare.", action="store_true")
     parser.add_argument("--lockstepverbose", "-lv", help="Run ImperasDV lock, step, and compare with tracing enabled", action="store_true")
@@ -136,6 +137,8 @@ def runQuesta(args, flags, prefix):
         args.args = fr'--args \"{args.args}\"'
     if args.params != "":
         args.params = fr'--params \"{args.params}\"'
+    if args.define != "":
+        args.define = fr'--define \"{args.define}\"'
     # Questa cannot accept more than 9 arguments.  fcov implies lockstep
     cmd = f"do wally.do {args.config} {args.testsuite} {args.tb} {args.args} {args.params} {flags}"
     cmd = f'cd $WALLY/sim/questa; {prefix} vsim {"-c" if not args.gui else ""} -do "{cmd}"'
@@ -144,7 +147,7 @@ def runQuesta(args, flags, prefix):
 
 def runVerilator(args):
     print(f"Running Verilator on {args.config} {args.testsuite}")
-    os.system(f'make -C {WALLY}/sim/verilator WALLYCONF={args.config} TEST={args.testsuite} TESTBENCH={args.tb} PLUS_ARGS="{args.args}" PARAM_ARGS="{args.params}"')
+    os.system(f'make -C {WALLY}/sim/verilator WALLYCONF={args.config} TEST={args.testsuite} TESTBENCH={args.tb} PLUS_ARGS="{args.args}" PARAM_ARGS="{args.params}" DEFINE_ARGS="{args.define}"')
 
 def runVCS(args, flags, prefix):
     print(f"Running VCS on {args.config} {args.testsuite}")
@@ -152,6 +155,8 @@ def runVCS(args, flags, prefix):
         args.args = f'--args "{args.args}"'
     if args.params != "":
         args.params = f'--params "{args.params}"'
+    if args.define != "":
+        args.define = f'--define "{args.define}"'
     cmd = f"cd $WALLY/sim/vcs; {prefix} ./run_vcs {args.config} {args.testsuite} --tb {args.tb} {args.args} {args.params} {flags}"
     print(cmd)
     os.system(cmd)

From f4473c03abdf7dd2e1321fee0545f0c16ebad749 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 01:47:23 -0800
Subject: [PATCH 21/34] add --define support to questa

---
 sim/questa/wally.do | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/sim/questa/wally.do b/sim/questa/wally.do
index 6e073ea87..639539e02 100644
--- a/sim/questa/wally.do
+++ b/sim/questa/wally.do
@@ -54,6 +54,7 @@ vlib ${WKDIR}
 set PlusArgs ""
 set ParamArgs ""
 set ExpandedParamArgs {}
+set DefineArgs ""
 
 set ccov 0
 set CoverageVoptArg ""
@@ -62,7 +63,6 @@ set CoverageVsimArg ""
 set FunctCoverage 0
 set FCvlog ""
 set FCvopt ""
-set FCdefineCOVER_EXTS {}
 
 set lockstep 0
 set lockstepvlog ""
@@ -106,13 +106,11 @@ if {[lcheck lst "--ccov"]} {
 if {[lcheck lst "--fcov"]} {
     set FunctCoverage 1
     # COVER_BASE_RV32I is just needed to keep riscvISACOV happy, but no longer affects tests
-         set FCvlog "+define+INCLUDE_TRACE2COV \
+    set FCvlog "+define+INCLUDE_TRACE2COV \
                 +define+IDV_INCLUDE_TRACE2COV \
                 +define+COVER_BASE_RV32I \
-                +incdir+$env(WALLY)/addins/cvw-arch-verif/riscvISACOV/source \
-		"
+                +incdir+$env(WALLY)/addins/cvw-arch-verif/riscvISACOV/source"
     set FCvopt "+TRACE2COV_ENABLE=1 +IDV_TRACE2COV=1"
-
 }
 
 # if --lockstep or --fcov found set flag and remove from list
@@ -145,6 +143,13 @@ if {$ParamArgsIndex >= 0} {
     set lst [lreplace $lst $ParamArgsIndex [expr {$ParamArgsIndex + 1}]]
 }
 
+# Set +define macros passed using the --define flag
+set DefineArgsIndex [lsearch -exact $lst "--define"]
+if {$DefineArgsIndex >= 0} {
+    set DefineArgs [lindex $lst [expr {$DefineArgsIndex + 1}]]
+    set lst [lreplace $lst $DefineArgsIndex [expr {$DefineArgsIndex + 1}]]
+}
+
 # Debug print statements
 if {$DEBUG > 0} {
     echo "GUI = $GUI"
@@ -153,7 +158,8 @@ if {$DEBUG > 0} {
     echo "FunctCoverage = $FunctCoverage"
     echo "remaining list = $lst"
     echo "Extra +args = $PlusArgs"
-    echo "Extra -args = $ExpandedParamArgs"
+    echo "Extra params = $ExpandedParamArgs"
+    echo "Extra defines = $DefineArgs"
 }
 
 # compile source files
@@ -162,7 +168,7 @@ if {$DEBUG > 0} {
 # because vsim will run vopt
 set INC_DIRS "+incdir+${CONFIG}/${CFG} +incdir+${CONFIG}/deriv/${CFG} +incdir+${CONFIG}/shared +incdir+${FCRVVI} +incdir+${FCRVVI}/rv32 +incdir+${FCRVVI}/rv64 +incdir+${FCRVVI}/rv64_priv +incdir+${FCRVVI}/priv +incdir+${FCRVVI}/rv32_priv +incdir+${FCRVVI}/common +incdir+${FCRVVI}"
 set SOURCES "${SRC}/cvw.sv ${TB}/${TESTBENCH}.sv ${TB}/common/*.sv ${SRC}/*/*.sv ${SRC}/*/*/*.sv ${WALLY}/addins/verilog-ethernet/*/*.sv ${WALLY}/addins/verilog-ethernet/*/*/*/*.sv"
-vlog -permissive -lint -work ${WKDIR} {*}${INC_DIRS} {*}${FCvlog} {*}${FCdefineCOVER_EXTS} {*}${lockstepvlog} {*}${SOURCES} -suppress 2282,2583,7053,7063,2596,13286
+vlog -permissive -lint -work ${WKDIR} {*}${INC_DIRS} {*}{$DefineArgs} {*}${FCvlog} {*}${lockstepvlog} {*}${SOURCES} -suppress 2282,2583,7053,7063,2596,13286
 
 # start and run simulation
 # remove +acc flag for faster sim during regressions if there is no need to access internal signals

From f856ed15ba1adff7ce40cfe37781344620b48af1 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 01:51:08 -0800
Subject: [PATCH 22/34] add --define support to VCS

---
 sim/vcs/run_vcs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/sim/vcs/run_vcs b/sim/vcs/run_vcs
index fb04d0fd2..7e2c7aca8 100755
--- a/sim/vcs/run_vcs
+++ b/sim/vcs/run_vcs
@@ -28,11 +28,12 @@ parser.add_argument("--ccov", "-c", help="Code Coverage", action="store_true")
 parser.add_argument("--fcov", "-f", help="Functional Coverage", action="store_true")
 parser.add_argument("--args", "-a", help="Optional arguments passed to simulator via $value$plusargs", default="")
 parser.add_argument("--params", "-p", help="Optional top-level parameter overrides of the form param=value", default="")
+parser.add_argument("--define", "-d", help="Optional define macros passed to simulator", default="")
 parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and compare.", action="store_true")
 # GUI not yet implemented
 #parser.add_argument("--gui", "-g", help="Simulate with GUI", action="store_true")
 args = parser.parse_args()
-print("run_vcs Config=" + args.config + " tests=" + args.testsuite + " lockstep=" + str(args.lockstep) + " args='" + args.args + "' params='" + args.params + "'")
+print("run_vcs Config=" + args.config + " tests=" + args.testsuite + " lockstep=" + str(args.lockstep) + " args='" + args.args + "' params='" + args.params + "'" + " define='" + args.define + "'")
 
 cfgdir = "$WALLY/config"
 srcdir = "$WALLY/src"
@@ -85,7 +86,7 @@ PARAM_OVERRIDES=" -parameters " + wkdir + "/param_overrides.txt "
 
 # Simulation commands
 OUTPUT="sim_out"
-VCS_CMD="vcs +lint=all,noGCWM,noUI,noSVA-UA,noIDTS,noNS,noULCO,noCAWM-L,noWMIA-L,noSV-PIU,noSTASKW_CO,noSTASKW_CO1,noSTASKW_RMCOF -suppress +warn -sverilog +vc -Mupdate -line -full64 -lca -ntb_opts sensitive_dyn " + "-top " + args.tb + PARAM_OVERRIDES + INCLUDE_PATH # Disabled Debug flags; add them back for a GUI mode -debug_access+all+reverse  -kdb +vcs+vcdpluson
+VCS_CMD="vcs +lint=all,noGCWM,noUI,noSVA-UA,noIDTS,noNS,noULCO,noCAWM-L,noWMIA-L,noSV-PIU,noSTASKW_CO,noSTASKW_CO1,noSTASKW_RMCOF -suppress +warn -sverilog +vc -Mupdate -line -full64 -lca -ntb_opts sensitive_dyn " + "-top " + args.tb + " " + args.define + " " + PARAM_OVERRIDES + INCLUDE_PATH # Disabled Debug flags; add them back for a GUI mode -debug_access+all+reverse  -kdb +vcs+vcdpluson
 VCS = VCS_CMD + " -Mdir=" + wkdir + " " + srcdir + "/cvw.sv " + LOCKSTEP_OPTIONS + " " + COV_OPTIONS + " " + RTL_FILES + " -o " + wkdir + "/" + OUTPUT + " -work " + wkdir + " -Mlib=" + wkdir + " -l " + logdir + "/" + args.config + "_" + args.testsuite + ".log"
 SIMV_CMD= wkdir + "/" + OUTPUT + " +TEST=" + args.testsuite + " " + args.args + " -no_save " + LOCKSTEP_SIMV
 

From 410c279396e764f18d9110b8079272e43e4d931c Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 01:55:15 -0800
Subject: [PATCH 23/34] add --define support to verilator

---
 sim/verilator/Makefile | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/sim/verilator/Makefile b/sim/verilator/Makefile
index 666516c2d..ecb6b5f42 100644
--- a/sim/verilator/Makefile
+++ b/sim/verilator/Makefile
@@ -13,6 +13,7 @@ VERILATOR_DIR=${WALLY}/sim/verilator
 SOURCE=${WALLY}/config/shared/*.vh ${WALLY}/config/${WALLYCONF} ${WALLY}/config/deriv/${WALLYCONF} ${WALLY}/src/cvw.sv ${WALLY}/testbench/*.sv ${WALLY}/testbench/common/*.sv ${WALLY}/src/*/*.sv ${WALLY}/src/*/*/*.sv
 PLUS_ARGS=
 PARAM_ARGS=
+DEFINE_ARGS=
 EXPANDED_PARAM_ARGS:=$(patsubst %,-G%,$(PARAM_ARGS))
 
 WALLYCONF?=rv64gc
@@ -63,6 +64,7 @@ $(WORKDIR)/V${TESTBENCH}: $(DEPENDENCIES)
 	--top-module ${TESTBENCH}  --relative-includes \
 	$(INCLUDE_PATH) \
 	${WRAPPER} \
+	${DEFINE_ARGS} \
 	${EXPANDED_PARAM_ARGS} \
 	$(SOURCES)
 
@@ -75,6 +77,7 @@ obj_dir_profiling/V${TESTBENCH}_$(WALLYCONF): $(DEPENDENCIES)
 	--top-module ${TESTBENCH}  --relative-includes \
 	$(INCLUDE_PATH) \
 	${WRAPPER} \
+	${DEFINE_ARGS} \
 	${EXPANDED_PARAM_ARGS} \
 	$(SOURCES)
 

From fe4a0c1b7b9b82d2257c3cdc65ebec7b0a328d19 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 02:47:04 -0800
Subject: [PATCH 24/34] Move most of the fcov defines and args into wsim

---
 bin/wsim            | 11 ++++++++---
 sim/questa/wally.do | 13 +++----------
 sim/vcs/run_vcs     |  2 +-
 3 files changed, 12 insertions(+), 14 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index acb5cec76..3c7bdc554 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -81,6 +81,7 @@ def prepSim(args, ElfFile):
     paramsList = []
     argsList = []
     flagsList = []
+    defineList = []
     if args.vcd:
         paramsList.append("MAKE_VCD=1")
     if args.rvvi:
@@ -95,15 +96,19 @@ def prepSim(args, ElfFile):
         flagsList.append("--ccov")
     if args.fcov:
         flagsList.append("--fcov")
+        defineList.append("+define+INCLUDE_TRACE2COV", "+define+IDV_INCLUDE_TRACE2COV", "+define+COVER_BASE_RV32I") # COVER_BASE_RV32I is just needed to keep riscvISACOV happy, but does not affect tests
+        argsList.append("+TRACE2COV_ENABLE=1", "+IDV_TRACE2COV=1")
     if args.gui:
         flagsList.append("--gui")
     if args.lockstep or args.lockstepverbose:
         flagsList.append("--lockstep")
     if args.lockstep or args.lockstepverbose or args.fcov:
         prefix = lockstepSetup(args)
+        defineList.append("+define+USE_IMPERAS_DV")
     # Combine into a single string
     args.args += " ".join(argsList)
     args.params += " ".join(paramsList)
+    args.define += " ".join(defineList)
     flags = " ".join(flagsList)
     return flags, prefix
 
@@ -140,7 +145,7 @@ def runQuesta(args, flags, prefix):
     if args.define != "":
         args.define = fr'--define \"{args.define}\"'
     # Questa cannot accept more than 9 arguments.  fcov implies lockstep
-    cmd = f"do wally.do {args.config} {args.testsuite} {args.tb} {args.args} {args.params} {flags}"
+    cmd = f"do wally.do {args.config} {args.testsuite} {args.tb} {args.args} {args.params} {args.define} {flags}"
     cmd = f'cd $WALLY/sim/questa; {prefix} vsim {"-c" if not args.gui else ""} -do "{cmd}"'
     print(f"Running Questa with command: {cmd}")
     os.system(cmd)
@@ -157,13 +162,13 @@ def runVCS(args, flags, prefix):
         args.params = f'--params "{args.params}"'
     if args.define != "":
         args.define = f'--define "{args.define}"'
-    cmd = f"cd $WALLY/sim/vcs; {prefix} ./run_vcs {args.config} {args.testsuite} --tb {args.tb} {args.args} {args.params} {flags}"
+    cmd = f"cd $WALLY/sim/vcs; {prefix} ./run_vcs {args.config} {args.testsuite} --tb {args.tb} {args.args} {args.params} {args.define} {flags}"
     print(cmd)
     os.system(cmd)
 
 def main(args):
     validateArgs(args)
-    print(f"Config={args.config} tests={args.testsuite} sim={args.sim} gui={args.gui} args='{args.args}' params='{args.params}'")
+    print(f"Config={args.config} tests={args.testsuite} sim={args.sim} gui={args.gui} args='{args.args}' params='{args.params}' define='{args.define}'")
     ElfFile = elfFileCheck(args)
     flags, prefix = prepSim(args, ElfFile)
     createDirs(args.sim)
diff --git a/sim/questa/wally.do b/sim/questa/wally.do
index 639539e02..34cafeb77 100644
--- a/sim/questa/wally.do
+++ b/sim/questa/wally.do
@@ -62,7 +62,6 @@ set CoverageVsimArg ""
 
 set FunctCoverage 0
 set FCvlog ""
-set FCvopt ""
 
 set lockstep 0
 set lockstepvlog ""
@@ -105,20 +104,14 @@ if {[lcheck lst "--ccov"]} {
 # if --fcov found set flag and remove from list
 if {[lcheck lst "--fcov"]} {
     set FunctCoverage 1
-    # COVER_BASE_RV32I is just needed to keep riscvISACOV happy, but no longer affects tests
-    set FCvlog "+define+INCLUDE_TRACE2COV \
-                +define+IDV_INCLUDE_TRACE2COV \
-                +define+COVER_BASE_RV32I \
-                +incdir+$env(WALLY)/addins/cvw-arch-verif/riscvISACOV/source"
-    set FCvopt "+TRACE2COV_ENABLE=1 +IDV_TRACE2COV=1"
+    set FCvlog "+incdir+$env(WALLY)/addins/cvw-arch-verif/riscvISACOV/source"
 }
 
 # if --lockstep or --fcov found set flag and remove from list
 if {[lcheck lst "--lockstep"] || $FunctCoverage == 1} {
     set IMPERAS_HOME $::env(IMPERAS_HOME)
     set lockstep 1
-    set lockstepvlog "+define+USE_IMPERAS_DV \
-                      +incdir+${IMPERAS_HOME}/ImpPublic/include/host \
+    set lockstepvlog "+incdir+${IMPERAS_HOME}/ImpPublic/include/host \
                       +incdir+${IMPERAS_HOME}/ImpProprietary/include/host \
                       ${IMPERAS_HOME}/ImpPublic/source/host/rvvi/*.sv \
                       ${IMPERAS_HOME}/ImpProprietary/source/host/idv/*.sv"
@@ -174,7 +167,7 @@ vlog -permissive -lint -work ${WKDIR} {*}${INC_DIRS} {*}{$DefineArgs} {*}${FCvlo
 # remove +acc flag for faster sim during regressions if there is no need to access internal signals
 vopt $accFlag wkdir/${CFG}_${TESTSUITE}.${TESTBENCH} -work ${WKDIR} {*}${ExpandedParamArgs} -o testbenchopt ${CoverageVoptArg}
 
-vsim -lib ${WKDIR} testbenchopt +TEST=${TESTSUITE} {*}${PlusArgs} -fatal 7 {*}${SVLib} {*}${FCvopt} -suppress 3829 ${CoverageVsimArg}
+vsim -lib ${WKDIR} testbenchopt +TEST=${TESTSUITE} {*}${PlusArgs} -fatal 7 {*}${SVLib} -suppress 3829 ${CoverageVsimArg}
 
 # power add generates the logging necessary for saif generation.
 # power add -r /dut/core/*
diff --git a/sim/vcs/run_vcs b/sim/vcs/run_vcs
index 7e2c7aca8..e062205ae 100755
--- a/sim/vcs/run_vcs
+++ b/sim/vcs/run_vcs
@@ -59,7 +59,7 @@ INCLUDE_PATH="+incdir+" + cfgdir + "/" + args.config + " +incdir+" + cfgdir + "/
 
 # lockstep mode
 if (args.lockstep):
-    LOCKSTEP_OPTIONS = " +define+USE_IMPERAS_DV +incdir+$IMPERAS_HOME/ImpPublic/include/host  +incdir+$IMPERAS_HOME/ImpProprietary/include/host  $IMPERAS_HOME/ImpPublic/source/host/rvvi/*.sv $IMPERAS_HOME/ImpProprietary/source/host/idv/*.sv " + tbdir + "/common/wallyTracer.sv"
+    LOCKSTEP_OPTIONS = " +incdir+$IMPERAS_HOME/ImpPublic/include/host  +incdir+$IMPERAS_HOME/ImpProprietary/include/host  $IMPERAS_HOME/ImpPublic/source/host/rvvi/*.sv $IMPERAS_HOME/ImpProprietary/source/host/idv/*.sv " + tbdir + "/common/wallyTracer.sv"
     LOCKSTEP_SIMV = "-sv_lib $IMPERAS_HOME/lib/Linux64/ImperasLib/imperas.com/verification/riscv/1.0/model"
 else:
     LOCKSTEP_OPTIONS = ""

From 922bdb5cca695ce5ff73948981de26a67a7e1767 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 02:50:25 -0800
Subject: [PATCH 25/34] Fix typo

---
 sim/questa/wally.do | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sim/questa/wally.do b/sim/questa/wally.do
index 34cafeb77..31599fcdd 100644
--- a/sim/questa/wally.do
+++ b/sim/questa/wally.do
@@ -161,7 +161,7 @@ if {$DEBUG > 0} {
 # because vsim will run vopt
 set INC_DIRS "+incdir+${CONFIG}/${CFG} +incdir+${CONFIG}/deriv/${CFG} +incdir+${CONFIG}/shared +incdir+${FCRVVI} +incdir+${FCRVVI}/rv32 +incdir+${FCRVVI}/rv64 +incdir+${FCRVVI}/rv64_priv +incdir+${FCRVVI}/priv +incdir+${FCRVVI}/rv32_priv +incdir+${FCRVVI}/common +incdir+${FCRVVI}"
 set SOURCES "${SRC}/cvw.sv ${TB}/${TESTBENCH}.sv ${TB}/common/*.sv ${SRC}/*/*.sv ${SRC}/*/*/*.sv ${WALLY}/addins/verilog-ethernet/*/*.sv ${WALLY}/addins/verilog-ethernet/*/*/*/*.sv"
-vlog -permissive -lint -work ${WKDIR} {*}${INC_DIRS} {*}{$DefineArgs} {*}${FCvlog} {*}${lockstepvlog} {*}${SOURCES} -suppress 2282,2583,7053,7063,2596,13286
+vlog -permissive -lint -work ${WKDIR} {*}${INC_DIRS} {*}${DefineArgs} {*}${FCvlog} {*}${lockstepvlog} {*}${SOURCES} -suppress 2282,2583,7053,7063,2596,13286
 
 # start and run simulation
 # remove +acc flag for faster sim during regressions if there is no need to access internal signals

From b58ab831e7f1c23f69e0d67ab0eea58c3bc7a476 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 14:20:55 -0800
Subject: [PATCH 26/34] more cleanup

---
 bin/wsim | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 3c7bdc554..051d32ce2 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -55,7 +55,7 @@ def elfFileCheck(args):
     ElfFile = ""
     if os.path.isfile(args.elf):
         ElfFile = f"+ElfFile={os.path.abspath(args.elf)}"
-    elif args.elf != "":
+    elif args.elf:
         print(f"ELF file not found: {args.elf}")
         sys.exit(1)
     elif args.testsuite.endswith('.elf'): # No --elf argument; check if testsuite has a .elf extension and use that instead
@@ -138,11 +138,11 @@ def runSim(args, flags, prefix):
 def runQuesta(args, flags, prefix):
     # Force Questa to use 64-bit mode, sometimes it defaults to 32-bit even on 64-bit machines
     prefix = "MTI_VCO_MODE=64 " + prefix
-    if args.args != "":
+    if args.args:
         args.args = fr'--args \"{args.args}\"'
-    if args.params != "":
+    if args.params:
         args.params = fr'--params \"{args.params}\"'
-    if args.define != "":
+    if args.define:
         args.define = fr'--define \"{args.define}\"'
     # Questa cannot accept more than 9 arguments.  fcov implies lockstep
     cmd = f"do wally.do {args.config} {args.testsuite} {args.tb} {args.args} {args.params} {args.define} {flags}"
@@ -156,11 +156,11 @@ def runVerilator(args):
 
 def runVCS(args, flags, prefix):
     print(f"Running VCS on {args.config} {args.testsuite}")
-    if args.args != "":
+    if args.args:
         args.args = f'--args "{args.args}"'
-    if args.params != "":
+    if args.params:
         args.params = f'--params "{args.params}"'
-    if args.define != "":
+    if args.define:
         args.define = f'--define "{args.define}"'
     cmd = f"cd $WALLY/sim/vcs; {prefix} ./run_vcs {args.config} {args.testsuite} --tb {args.tb} {args.args} {args.params} {args.define} {flags}"
     print(cmd)

From 33904cffe27a97013d98923da469b258afa91fd0 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 17:05:44 -0800
Subject: [PATCH 27/34] Fix wsim fcov

---
 bin/wsim | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/bin/wsim b/bin/wsim
index 051d32ce2..a89a546b7 100755
--- a/bin/wsim
+++ b/bin/wsim
@@ -96,8 +96,8 @@ def prepSim(args, ElfFile):
         flagsList.append("--ccov")
     if args.fcov:
         flagsList.append("--fcov")
-        defineList.append("+define+INCLUDE_TRACE2COV", "+define+IDV_INCLUDE_TRACE2COV", "+define+COVER_BASE_RV32I") # COVER_BASE_RV32I is just needed to keep riscvISACOV happy, but does not affect tests
-        argsList.append("+TRACE2COV_ENABLE=1", "+IDV_TRACE2COV=1")
+        defineList.extend(["+define+INCLUDE_TRACE2COV", "+define+IDV_INCLUDE_TRACE2COV", "+define+COVER_BASE_RV32I"]) # COVER_BASE_RV32I is just needed to keep riscvISACOV happy, but does not affect tests
+        argsList.extend(["+TRACE2COV_ENABLE=1", "+IDV_TRACE2COV=1"])
     if args.gui:
         flagsList.append("--gui")
     if args.lockstep or args.lockstepverbose:

From 9c19321bdb4a078c843475b84db17b115411753a Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 17:13:31 -0800
Subject: [PATCH 28/34] Update fcov incdirs for wally.do

---
 sim/questa/wally.do | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/sim/questa/wally.do b/sim/questa/wally.do
index 31599fcdd..be47abb4f 100644
--- a/sim/questa/wally.do
+++ b/sim/questa/wally.do
@@ -104,7 +104,10 @@ if {[lcheck lst "--ccov"]} {
 # if --fcov found set flag and remove from list
 if {[lcheck lst "--fcov"]} {
     set FunctCoverage 1
-    set FCvlog "+incdir+$env(WALLY)/addins/cvw-arch-verif/riscvISACOV/source"
+    set FCvlog "+incdir+$env(WALLY)/addins/cvw-arch-verif/riscvISACOV/source \
+                +incdir+${FCRVVI}/rv32 +incdir+${FCRVVI}/rv64 \
+                +incdir+${FCRVVI}/priv +incdir+${FCRVVI}/rv64_priv +incdir+${FCRVVI}/rv32_priv \
+                +incdir+${FCRVVI}/common +incdir+${FCRVVI}"
 }
 
 # if --lockstep or --fcov found set flag and remove from list
@@ -159,7 +162,7 @@ if {$DEBUG > 0} {
 # suppress spurious warnngs about
 # "Extra checking for conflicts with always_comb done at vopt time"
 # because vsim will run vopt
-set INC_DIRS "+incdir+${CONFIG}/${CFG} +incdir+${CONFIG}/deriv/${CFG} +incdir+${CONFIG}/shared +incdir+${FCRVVI} +incdir+${FCRVVI}/rv32 +incdir+${FCRVVI}/rv64 +incdir+${FCRVVI}/rv64_priv +incdir+${FCRVVI}/priv +incdir+${FCRVVI}/rv32_priv +incdir+${FCRVVI}/common +incdir+${FCRVVI}"
+set INC_DIRS "+incdir+${CONFIG}/${CFG} +incdir+${CONFIG}/deriv/${CFG} +incdir+${CONFIG}/shared"
 set SOURCES "${SRC}/cvw.sv ${TB}/${TESTBENCH}.sv ${TB}/common/*.sv ${SRC}/*/*.sv ${SRC}/*/*/*.sv ${WALLY}/addins/verilog-ethernet/*/*.sv ${WALLY}/addins/verilog-ethernet/*/*/*/*.sv"
 vlog -permissive -lint -work ${WKDIR} {*}${INC_DIRS} {*}${DefineArgs} {*}${FCvlog} {*}${lockstepvlog} {*}${SOURCES} -suppress 2282,2583,7053,7063,2596,13286
 

From 19136c0851a77ad8a1589fb897b42e925a4631bc Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 04:50:22 -0800
Subject: [PATCH 29/34] Begin refactoring run_vcs script

---
 sim/questa/wally.do |  2 +-
 sim/vcs/run_vcs     | 42 +++++++++++++++++++++---------------------
 2 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/sim/questa/wally.do b/sim/questa/wally.do
index be47abb4f..3c7046a37 100644
--- a/sim/questa/wally.do
+++ b/sim/questa/wally.do
@@ -3,7 +3,7 @@
 #
 # Modification by Oklahoma State University & Harvey Mudd College
 # Use with Testbench
-# James Stine, 2008; David Harris 2021
+# James Stine, 2008; David Harris 2021; Jordan Carlin 2024
 # Go Cowboys!!!!!!
 #
 # Takes 1:10 to run RV64IC tests using gui
diff --git a/sim/vcs/run_vcs b/sim/vcs/run_vcs
index e062205ae..7aa0a44e6 100755
--- a/sim/vcs/run_vcs
+++ b/sim/vcs/run_vcs
@@ -2,6 +2,7 @@
 
 # run_vcs
 # David_Harris@hmc.edu 2 July 2024
+# Modified Jordan Carlin jcarlin@hmc.edu Dec 9 2024
 # Run VCS on a given file, passing appropriate flags
 # SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
 
@@ -33,7 +34,7 @@ parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and comp
 # GUI not yet implemented
 #parser.add_argument("--gui", "-g", help="Simulate with GUI", action="store_true")
 args = parser.parse_args()
-print("run_vcs Config=" + args.config + " tests=" + args.testsuite + " lockstep=" + str(args.lockstep) + " args='" + args.args + "' params='" + args.params + "'" + " define='" + args.define + "'")
+print(f"run_vcs Config={args.config} tests={args.testsuite} lockstep={args.lockstep} args='{args.args}' params='{args.params}' define='{args.define}'")
 
 cfgdir = "$WALLY/config"
 srcdir = "$WALLY/src"
@@ -42,20 +43,20 @@ wkdir = "$WALLY/sim/vcs/wkdir/" + args.config + "_" + args.testsuite
 covdir = "$WALLY/sim/vcs/cov/" + args.config + "_" + args.testsuite
 logdir = "$WALLY/sim/vcs/logs"
 
-os.system("mkdir -p " + wkdir)
-os.system("mkdir -p " + covdir)
-os.system("mkdir -p " + logdir)
+os.makedirs(wkdir, exist_ok=True)
+os.makedirs(covdir, exist_ok=True)
+os.makedirs(logdir, exist_ok=True)
 
 # Find RTL source files
-rtlsrc_cmd = "find " + srcdir + ' -name "*.sv" ! -path "' + srcdir + '/generic/mem/rom1p1r_128x64.sv" ! -path "' + srcdir + '/generic/mem/ram2p1r1wbe_128x64.sv" ! -path "' + srcdir + '/generic/mem/rom1p1r_128x32.sv" ! -path "' + srcdir + '/generic/mem/ram2p1r1wbe_2048x64.sv"'
+rtlsrc_cmd = f'find {srcdir} -name "*.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x64.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_128x64.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x32.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_2048x64.sv"'
 rtlsrc_files = runfindcmd(rtlsrc_cmd)
-tbcommon_cmd = 'find ' + tbdir+'/common -name "*.sv" ! -path "' + tbdir+'/common/wallyTracer.sv"'
+tbcommon_cmd = f'find {tbdir}/common -name "*.sv" ! -path "{tbdir}/common/wallyTracer.sv"'
 tbcommon_files = runfindcmd(tbcommon_cmd)
-tb_file = tbdir + "/" + args.tb + ".sv"
-RTL_FILES = tb_file + ' ' + str(rtlsrc_files) + ' '  + str(tbcommon_files)
+tb_file = f'{tbdir}/{args.tb}.sv'
+RTL_FILES = f"{tb_file} {rtlsrc_files} {tbcommon_files}"
 
 # Include directories
-INCLUDE_PATH="+incdir+" + cfgdir + "/" + args.config + " +incdir+" + cfgdir + "/deriv/" + args.config + " +incdir+" + cfgdir + "/shared +incdir+$WALLY/tests +incdir+" + tbdir + " +incdir+" + srcdir
+INCLUDE_PATH=f"+incdir+{cfgdir}/{args.config} +incdir+{cfgdir}/deriv/{args.config} +incdir+{cfgdir}/shared +incdir+$WALLY/tests +incdir+{tbdir} +incdir+{srcdir}"
 
 # lockstep mode
 if (args.lockstep):
@@ -67,7 +68,7 @@ else:
 
 # coverage mode
 if (args.ccov):
-    COV_OPTIONS = "-cm line+cond+branch+fsm+tgl -cm_log " + wkdir + "/coverage.log -cm_dir " + wkdir + "/coverage"
+    COV_OPTIONS = f"-cm line+cond+branch+fsm+tgl -cm_log {wkdir}/coverage.log -cm_dir {wkdir}/coverage"
 else:
     COV_OPTIONS = ""
 
@@ -75,25 +76,24 @@ else:
 f = open(os.path.expandvars(wkdir) + "/param_overrides.txt", "w")
 for param in args.params.split():
     [param, value] = param.split("=")
-    if "\\'" in value: # for bit values
-        value = value.replace("\\'", "'")
+    if fr"\'" in value: # for bit values
+        value = value.replace(rf"\'", "'")
     else:              # for strings
-        value = "\"" + value + "\""
-    # print("param=" + param + " value=" + value)
-    f.write("assign " + value + " " + args.tb + "/" + param + "\n")
+        value = f'"{value}"'
+    f.write(f"assign {value} {args.tb}/{param}\n")
 f.close()
-PARAM_OVERRIDES=" -parameters " + wkdir + "/param_overrides.txt "
+PARAM_OVERRIDES=f" -parameters {wkdir}/param_overrides.txt "
 
 # Simulation commands
 OUTPUT="sim_out"
-VCS_CMD="vcs +lint=all,noGCWM,noUI,noSVA-UA,noIDTS,noNS,noULCO,noCAWM-L,noWMIA-L,noSV-PIU,noSTASKW_CO,noSTASKW_CO1,noSTASKW_RMCOF -suppress +warn -sverilog +vc -Mupdate -line -full64 -lca -ntb_opts sensitive_dyn " + "-top " + args.tb + " " + args.define + " " + PARAM_OVERRIDES + INCLUDE_PATH # Disabled Debug flags; add them back for a GUI mode -debug_access+all+reverse  -kdb +vcs+vcdpluson
-VCS = VCS_CMD + " -Mdir=" + wkdir + " " + srcdir + "/cvw.sv " + LOCKSTEP_OPTIONS + " " + COV_OPTIONS + " " + RTL_FILES + " -o " + wkdir + "/" + OUTPUT + " -work " + wkdir + " -Mlib=" + wkdir + " -l " + logdir + "/" + args.config + "_" + args.testsuite + ".log"
-SIMV_CMD= wkdir + "/" + OUTPUT + " +TEST=" + args.testsuite + " " + args.args + " -no_save " + LOCKSTEP_SIMV
+VCS_CMD=f"vcs +lint=all,noGCWM,noUI,noSVA-UA,noIDTS,noNS,noULCO,noCAWM-L,noWMIA-L,noSV-PIU,noSTASKW_CO,noSTASKW_CO1,noSTASKW_RMCOF -suppress +warn -sverilog +vc -Mupdate -line -full64 -lca -ntb_opts sensitive_dyn -top {args.tb} {args.define} {PARAM_OVERRIDES} {INCLUDE_PATH}" # Disabled Debug flags; add them back for a GUI mode -debug_access+all+reverse  -kdb +vcs+vcdpluson
+VCS = f'{VCS_CMD} -Mdir={wkdir} {srcdir}/cvw.sv {LOCKSTEP_OPTIONS} {COV_OPTIONS} {RTL_FILES} -o {wkdir}/{OUTPUT} -work {wkdir} -Mlib={wkdir} -l {logdir}/{args.config}_{args.testsuite}.log'
+SIMV_CMD= f'wkdir/{OUTPUT} +TEST={args.testsuite} {args.args} -no_save {LOCKSTEP_SIMV}'
 
 # Run simulation
-print("Executing: " + str(VCS) )
+print(f"Executing: {VCS}")
 subprocess.run(VCS, shell=True)
 subprocess.run(SIMV_CMD, shell=True)
 if (args.ccov):
-    COV_RUN = "urg -dir " + wkdir + "/coverage.vdb -format text -report IndividualCovReport/" + args.config + "_" + args.testsuite
+    COV_RUN = f"urg -dir {wkdir}/coverage.vdb -format text -report IndividualCovReport/{args.config}_{args.testsuite}"
     subprocess.run(COV_RUN, shell=True)

From 12966c33b5b9437178832021751a3b7d5fc65534 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 18:18:34 -0800
Subject: [PATCH 30/34] initial attempt at totally refactored run_vcs script

---
 sim/vcs/run_vcs | 165 +++++++++++++++++++++++++++---------------------
 1 file changed, 93 insertions(+), 72 deletions(-)

diff --git a/sim/vcs/run_vcs b/sim/vcs/run_vcs
index 7aa0a44e6..a9041e650 100755
--- a/sim/vcs/run_vcs
+++ b/sim/vcs/run_vcs
@@ -6,94 +6,115 @@
 # Run VCS on a given file, passing appropriate flags
 # SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
 
-
 import argparse
 import os
 import subprocess
+import sys
+
+# Global variables
+WALLY  = os.environ.get('WALLY')
+simdir = f"{WALLY}/sim/vcs"
+cfgdir = f"{WALLY}/config"
+srcdir = f"{WALLY}/src"
+tbdir  = f"{WALLY}/testbench"
+logdir = f"{simdir}/logs"
 
 # run a Linux command and return the result as a string in a form that VCS can use
-def runfindcmd(cmd):
-#    print("Executing: " + str(cmd) )
-    res = subprocess.check_output(cmd, shell=True)
+def runFindCommand(cmd):
+    res = subprocess.check_output(cmd, shell=True, )
     res = str(res)
     res = res.replace("\\n", " ")  # replace newline with space
     res = res.replace("\'", "")  # strip off quotation marks
     res = res[1:] # strip off leading b from byte string
     return res
 
-parser = argparse.ArgumentParser()
-parser.add_argument("config", help="Configuration file")
-parser.add_argument("testsuite", help="Test suite (or none, when running a single ELF file) ")
-parser.add_argument("--tb", "-t", help="Testbench", choices=["testbench", "testbench_fp"], default="testbench")
-parser.add_argument("--ccov", "-c", help="Code Coverage", action="store_true")
-parser.add_argument("--fcov", "-f", help="Functional Coverage", action="store_true")
-parser.add_argument("--args", "-a", help="Optional arguments passed to simulator via $value$plusargs", default="")
-parser.add_argument("--params", "-p", help="Optional top-level parameter overrides of the form param=value", default="")
-parser.add_argument("--define", "-d", help="Optional define macros passed to simulator", default="")
-parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and compare.", action="store_true")
-# GUI not yet implemented
-#parser.add_argument("--gui", "-g", help="Simulate with GUI", action="store_true")
-args = parser.parse_args()
-print(f"run_vcs Config={args.config} tests={args.testsuite} lockstep={args.lockstep} args='{args.args}' params='{args.params}' define='{args.define}'")
+def parseArgs():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("config", help="Configuration file")
+    parser.add_argument("testsuite", help="Test suite (or none, when running a single ELF file) ")
+    parser.add_argument("--tb", "-t", help="Testbench", choices=["testbench", "testbench_fp"], default="testbench")
+    parser.add_argument("--ccov", "-c", help="Code Coverage", action="store_true")
+    parser.add_argument("--fcov", "-f", help="Functional Coverage", action="store_true")
+    parser.add_argument("--args", "-a", help="Optional arguments passed to simulator via $value$plusargs", default="")
+    parser.add_argument("--params", "-p", help="Optional top-level parameter overrides of the form param=value", default="")
+    parser.add_argument("--define", "-d", help="Optional define macros passed to simulator", default="")
+    parser.add_argument("--lockstep", "-l", help="Run ImperasDV lock, step, and compare.", action="store_true")
+    #parser.add_argument("--gui", "-g", help="Simulate with GUI", action="store_true") # GUI not yet implemented
+    return parser.parse_args()
 
-cfgdir = "$WALLY/config"
-srcdir = "$WALLY/src"
-tbdir = "$WALLY/testbench"
-wkdir = "$WALLY/sim/vcs/wkdir/" + args.config + "_" + args.testsuite
-covdir = "$WALLY/sim/vcs/cov/" + args.config + "_" + args.testsuite
-logdir = "$WALLY/sim/vcs/logs"
+def createDirs(args):
+    wkdir  = f"{simdir}/wkdir/{args.config}_{args.testsuite}"
+    covdir = f"{simdir}/cov/{args.config}_{args.testsuite}"
+    os.makedirs(wkdir, exist_ok=True)
+    os.makedirs(covdir, exist_ok=True)
+    os.makedirs(logdir, exist_ok=True)
+    return wkdir, covdir
 
-os.makedirs(wkdir, exist_ok=True)
-os.makedirs(covdir, exist_ok=True)
-os.makedirs(logdir, exist_ok=True)
+def generateFileList():
+    rtlsrc_cmd = f'find {srcdir} -name "*.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x64.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_128x64.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x32.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_2048x64.sv"'
+    rtlsrc_files = runFindCommand(rtlsrc_cmd)
+    tbcommon_cmd = f'find {tbdir}/common -name "*.sv" ! -path "{tbdir}/common/wallyTracer.sv"'
+    tbcommon_files = runFindCommand(tbcommon_cmd)
+    tb_file = f'{tbdir}/{args.tb}.sv'
+    return f"{tb_file} {rtlsrc_files} {tbcommon_files}"
 
-# Find RTL source files
-rtlsrc_cmd = f'find {srcdir} -name "*.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x64.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_128x64.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x32.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_2048x64.sv"'
-rtlsrc_files = runfindcmd(rtlsrc_cmd)
-tbcommon_cmd = f'find {tbdir}/common -name "*.sv" ! -path "{tbdir}/common/wallyTracer.sv"'
-tbcommon_files = runfindcmd(tbcommon_cmd)
-tb_file = f'{tbdir}/{args.tb}.sv'
-RTL_FILES = f"{tb_file} {rtlsrc_files} {tbcommon_files}"
+def processArgs(wkdir, args):
+    compileOptions = []
+    simvOptions = []
+    if args.lockstep:
+        compileOptions.extend(["+incdir+$IMPERAS_HOME/ImpPublic/include/host",
+                                "+incdir+$IMPERAS_HOME/ImpProprietary/include/host",
+                                "$IMPERAS_HOME/ImpPublic/source/host/rvvi/*.sv",
+                                "$IMPERAS_HOME/ImpProprietary/source/host/idv/*.sv",
+                                f"{tbdir}/common/wallyTracer.sv"])
+        simvOptions.append("-sv_lib $IMPERAS_HOME/lib/Linux64/ImperasLib/imperas.com/verification/riscv/1.0/model")
+    if args.ccov:
+        compileOptions.extend(["-cm line+cond+branch+fsm+tgl", f"-cm_log {wkdir}/coverage.log", f"-cm_dir {wkdir}/coverage"])
+    if args.params:
+        compileOptions.append(setupParamOverrides(wkdir, args))
+    if args.define:
+        compileOptions.append(args.define)
+    # if args.gui:
+    #     compileOptions.append("-debug_access+all+reverse -kdb +vcs+vcdpluson")
+    compileOptions = " ".join(compileOptions)
+    simvOptions =  " ".join(simvOptions)
+    return compileOptions, simvOptions
 
-# Include directories
-INCLUDE_PATH=f"+incdir+{cfgdir}/{args.config} +incdir+{cfgdir}/deriv/{args.config} +incdir+{cfgdir}/shared +incdir+$WALLY/tests +incdir+{tbdir} +incdir+{srcdir}"
+def setupParamOverrides(wkdir, args):
+    paramOverrideFile = os.path.join(wkdir, "param_overrides.txt")
+    with open(paramOverrideFile, "w") as f:
+        for param in args.params.split():
+            [param, value] = param.split("=")
+            if fr"\'" in value: # for bit values
+                value = value.replace(fr"\'", "'")
+            else:  # for strings
+                value = f'"{value}"'
+            f.write(f"assign {value} {args.tb}/{param}\n")
+    return f" -parameters {wkdir}/param_overrides.txt "
 
-# lockstep mode
-if (args.lockstep):
-    LOCKSTEP_OPTIONS = " +incdir+$IMPERAS_HOME/ImpPublic/include/host  +incdir+$IMPERAS_HOME/ImpProprietary/include/host  $IMPERAS_HOME/ImpPublic/source/host/rvvi/*.sv $IMPERAS_HOME/ImpProprietary/source/host/idv/*.sv " + tbdir + "/common/wallyTracer.sv"
-    LOCKSTEP_SIMV = "-sv_lib $IMPERAS_HOME/lib/Linux64/ImperasLib/imperas.com/verification/riscv/1.0/model"
-else:
-    LOCKSTEP_OPTIONS = ""
-    LOCKSTEP_SIMV = ""
+def setupCommands(wkdir, rtlFiles, compileOptions, simvOptions, args):
+    includePath=f"+incdir+{cfgdir}/{args.config} +incdir+{cfgdir}/deriv/{args.config} +incdir+{cfgdir}/shared +incdir+$WALLY/tests +incdir+{tbdir} +incdir+{srcdir}"
+    vcsStandardFlags = "+lint=all,noGCWM,noUI,noSVA-UA,noIDTS,noNS,noULCO,noCAWM-L,noWMIA-L,noSV-PIU,noSTASKW_CO,noSTASKW_CO1,noSTASKW_RMCOF -suppress +warn -sverilog +vc -Mupdate -line -full64 -lca -ntb_opts sensitive_dyn"
+    vcsCMD = f"vcs {vcsStandardFlags} -top {args.tb} {compileOptions} -Mdir={wkdir} {includePath} {srcdir}/cvw.sv {rtlFiles} -o {wkdir}/sim_out -work {wkdir} -Mlib={wkdir} -l {logdir}/{args.config}_{args.testsuite}.log"
+    simvCMD = f"{wkdir}/sim_out +TEST={args.testsuite} {args.args} -no_save {simvOptions}"
+    return vcsCMD, simvCMD
 
-# coverage mode
-if (args.ccov):
-    COV_OPTIONS = f"-cm line+cond+branch+fsm+tgl -cm_log {wkdir}/coverage.log -cm_dir {wkdir}/coverage"
-else:
-    COV_OPTIONS = ""
+def runVCS(wkdir, vcsCMD, simvCMD):
+    print(f"Executing: {vcsCMD}")
+    subprocess.run(vcsCMD, shell=True)
+    subprocess.run(simvCMD, shell=True)
+    if (args.ccov):
+        COV_RUN = f"urg -dir {wkdir}/coverage.vdb -format text -report IndividualCovReport/{args.config}_{args.testsuite}"
+        subprocess.run(COV_RUN, shell=True)
 
-# Write parameter overrides to a file
-f = open(os.path.expandvars(wkdir) + "/param_overrides.txt", "w")
-for param in args.params.split():
-    [param, value] = param.split("=")
-    if fr"\'" in value: # for bit values
-        value = value.replace(rf"\'", "'")
-    else:              # for strings
-        value = f'"{value}"'
-    f.write(f"assign {value} {args.tb}/{param}\n")
-f.close()
-PARAM_OVERRIDES=f" -parameters {wkdir}/param_overrides.txt "
+def main(args):
+    print(f"run_vcs Config={args.config} tests={args.testsuite} lockstep={args.lockstep} args='{args.args}' params='{args.params}' define='{args.define}'")
+    wkdir, covdir = createDirs(args)
+    rtlFiles = generateFileList()
+    compileOptions, simvOptions = processArgs(wkdir, args)
+    vcsCMD, simvCMD = setupCommands(wkdir, rtlFiles, compileOptions, simvOptions)
+    runVCS(wkdir, vcsCMD, simvCMD)
 
-# Simulation commands
-OUTPUT="sim_out"
-VCS_CMD=f"vcs +lint=all,noGCWM,noUI,noSVA-UA,noIDTS,noNS,noULCO,noCAWM-L,noWMIA-L,noSV-PIU,noSTASKW_CO,noSTASKW_CO1,noSTASKW_RMCOF -suppress +warn -sverilog +vc -Mupdate -line -full64 -lca -ntb_opts sensitive_dyn -top {args.tb} {args.define} {PARAM_OVERRIDES} {INCLUDE_PATH}" # Disabled Debug flags; add them back for a GUI mode -debug_access+all+reverse  -kdb +vcs+vcdpluson
-VCS = f'{VCS_CMD} -Mdir={wkdir} {srcdir}/cvw.sv {LOCKSTEP_OPTIONS} {COV_OPTIONS} {RTL_FILES} -o {wkdir}/{OUTPUT} -work {wkdir} -Mlib={wkdir} -l {logdir}/{args.config}_{args.testsuite}.log'
-SIMV_CMD= f'wkdir/{OUTPUT} +TEST={args.testsuite} {args.args} -no_save {LOCKSTEP_SIMV}'
-
-# Run simulation
-print(f"Executing: {VCS}")
-subprocess.run(VCS, shell=True)
-subprocess.run(SIMV_CMD, shell=True)
-if (args.ccov):
-    COV_RUN = f"urg -dir {wkdir}/coverage.vdb -format text -report IndividualCovReport/{args.config}_{args.testsuite}"
-    subprocess.run(COV_RUN, shell=True)
+if __name__ == "__main__":
+    args = parseArgs()
+    sys.exit(main(args))

From a9aefc01054c4fcc48f1b709e090b8db98b969fc Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Sun, 8 Dec 2024 20:50:08 -0800
Subject: [PATCH 31/34] Small VCS fixes after refactor

---
 sim/vcs/run_vcs | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/sim/vcs/run_vcs b/sim/vcs/run_vcs
index a9041e650..7437d2725 100755
--- a/sim/vcs/run_vcs
+++ b/sim/vcs/run_vcs
@@ -53,7 +53,7 @@ def createDirs(args):
 def generateFileList():
     rtlsrc_cmd = f'find {srcdir} -name "*.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x64.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_128x64.sv" ! -path "{srcdir}/generic/mem/rom1p1r_128x32.sv" ! -path "{srcdir}/generic/mem/ram2p1r1wbe_2048x64.sv"'
     rtlsrc_files = runFindCommand(rtlsrc_cmd)
-    tbcommon_cmd = f'find {tbdir}/common -name "*.sv" ! -path "{tbdir}/common/wallyTracer.sv"'
+    tbcommon_cmd = f'find {tbdir}/common -name "*.sv"'
     tbcommon_files = runFindCommand(tbcommon_cmd)
     tb_file = f'{tbdir}/{args.tb}.sv'
     return f"{tb_file} {rtlsrc_files} {tbcommon_files}"
@@ -65,8 +65,7 @@ def processArgs(wkdir, args):
         compileOptions.extend(["+incdir+$IMPERAS_HOME/ImpPublic/include/host",
                                 "+incdir+$IMPERAS_HOME/ImpProprietary/include/host",
                                 "$IMPERAS_HOME/ImpPublic/source/host/rvvi/*.sv",
-                                "$IMPERAS_HOME/ImpProprietary/source/host/idv/*.sv",
-                                f"{tbdir}/common/wallyTracer.sv"])
+                                "$IMPERAS_HOME/ImpProprietary/source/host/idv/*.sv"])
         simvOptions.append("-sv_lib $IMPERAS_HOME/lib/Linux64/ImperasLib/imperas.com/verification/riscv/1.0/model")
     if args.ccov:
         compileOptions.extend(["-cm line+cond+branch+fsm+tgl", f"-cm_log {wkdir}/coverage.log", f"-cm_dir {wkdir}/coverage"])
@@ -112,7 +111,7 @@ def main(args):
     wkdir, covdir = createDirs(args)
     rtlFiles = generateFileList()
     compileOptions, simvOptions = processArgs(wkdir, args)
-    vcsCMD, simvCMD = setupCommands(wkdir, rtlFiles, compileOptions, simvOptions)
+    vcsCMD, simvCMD = setupCommands(wkdir, rtlFiles, compileOptions, simvOptions, args)
     runVCS(wkdir, vcsCMD, simvCMD)
 
 if __name__ == "__main__":

From 421da19b8fd07e64ed87a4466ea8347422fc68b9 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 9 Dec 2024 13:20:11 +0000
Subject: [PATCH 32/34] Bump addins/cvw-arch-verif from `b37edba` to `95f849e`

Bumps [addins/cvw-arch-verif](https://github.com/openhwgroup/cvw-arch-verif) from `b37edba` to `95f849e`.
- [Commits](https://github.com/openhwgroup/cvw-arch-verif/compare/b37edba7f625cc3bc2b161d03bc1cd90df0fa2e3...95f849e42ef81562376fdc8fc4b91824fe7b5a36)

---
updated-dependencies:
- dependency-name: addins/cvw-arch-verif
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
---
 addins/cvw-arch-verif | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/addins/cvw-arch-verif b/addins/cvw-arch-verif
index b37edba7f..95f849e42 160000
--- a/addins/cvw-arch-verif
+++ b/addins/cvw-arch-verif
@@ -1 +1 @@
-Subproject commit b37edba7f625cc3bc2b161d03bc1cd90df0fa2e3
+Subproject commit 95f849e42ef81562376fdc8fc4b91824fe7b5a36

From 66a4655cb9663ed0c52a0969812ef29211b20a7a Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Mon, 9 Dec 2024 09:07:35 -0800
Subject: [PATCH 33/34] Initial attempt at Ubuntu derivative distro support,
 focusing on Linux Mint

---
 bin/wally-distro-check.sh | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/bin/wally-distro-check.sh b/bin/wally-distro-check.sh
index 7a519478a..2f24c3daf 100755
--- a/bin/wally-distro-check.sh
+++ b/bin/wally-distro-check.sh
@@ -76,10 +76,28 @@ if [[ "$ID" == rhel || "$ID_LIKE" == *rhel* ]]; then
 elif [[ "$ID" == ubuntu || "$ID_LIKE" == *ubuntu* ]]; then
     export FAMILY=ubuntu
     if [ "$ID" != ubuntu ]; then
-        printf "${WARNING_COLOR}%s%s\n${ENDC}" "For Ubuntu family distros, the Wally installation script has only been tested on standard Ubuntu. Your distro " \
+        printf "${WARNING_COLOR}%s%s\n${ENDC}" "For Ubuntu family distros, the Wally installation script is only tested on standard Ubuntu. Your distro " \
             "is $PRETTY_NAME. The regular Ubuntu install will be attempted, but there may be issues."
+        # Ubuntu derivates may use different version numbers. Attempt to derive version from Ubuntu codename
+        case "$UBUNTU_CODENAME" in
+            noble)
+                export UBUNTU_VERSION=24
+                ;;
+            jammy)
+                export UBUNTU_VERSION=22
+                ;;
+            focal)
+                export UBUNTU_VERSION=20
+                ;;
+            *)
+                printf "${FAIL_COLOR}%s\n${ENDC}" "Unable to determine which base Ubuntu version you are using."
+                exit 1
+                ;;
+        esac
+        echo "Detected Ubuntu derivative baesd on Ubuntu $UBUNTU_VERSION.04."
+    else
+        export UBUNTU_VERSION="${VERSION_ID:0:2}"
     fi
-    export UBUNTU_VERSION="${VERSION_ID:0:2}"
     if (( UBUNTU_VERSION < 20 )); then
         printf "${FAIL_COLOR}%s\n${ENDC}" "The Wally installation script has only been tested with Ubuntu versions 20.04 LTS, 22.04 LTS, and 24.04 LTS. You have version $VERSION."
         exit 1

From d10082113c5e564407f18e3fb5a0137fea335b77 Mon Sep 17 00:00:00 2001
From: Jordan Carlin <jordanmcarlin@gmail.com>
Date: Wed, 11 Dec 2024 15:26:10 -0800
Subject: [PATCH 34/34] Update wsim commands in README

---
 README.md | 32 +++++++++++++++++---------------
 1 file changed, 17 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 8b20d6d8f..32b93d36d 100644
--- a/README.md
+++ b/README.md
@@ -227,26 +227,28 @@ This utility will take up approximately 100 GB on your hard drive. You can also
 
 wsim runs one of multiple simulators, Questa, VCS, or Verilator using a specific configuration and either a suite of tests or a specific elf file.
 The general syntax is
-`wsim <config> <suite or elf file or directory> [--options]`
+`wsim <config> <suite or elf file> [--options]`
 
 Parameters and options:
 
 ```
 -h, --help                                                   show this help message and exit
+--elf ELF, -e ELF                                            ELF File name; use if name does not end in .elf
 --sim {questa,verilator,vcs}, -s {questa,verilator,vcs}      Simulator
 --tb {testbench,testbench_fp}, -t {testbench,testbench_fp}   Testbench
 --gui, -g                                                    Simulate with GUI
---coverage, -c                                               Code & Functional Coverage
---fcov, -f                                                   Code & Functional Coverage
+--ccov, -c                                                   Code Coverage
+--fcov, -f                                                   Functional Coverage with cvw-arch-verif, implies lockstep
 --args ARGS, -a ARGS                                         Optional arguments passed to simulator via $value$plusargs
+--params PARAMS, -p PARAMS            			 								 Optional top-level parameter overrides of the form param=value
+--define DEFINE, -d DEFINE            											 Optional define macros passed to simulator
 --vcd, -v                                                    Generate testbench.vcd
 --lockstep, -l                                               Run ImperasDV lock, step, and compare.
---locksteplog LOCKSTEPLOG, -b LOCKSTEPLOG                    Retired instruction number to be begin logging.
---covlog COVLOG, -d COVLOG                                   Log coverage after n instructions.
---elfext ELFEXT, -e ELFEXT                                   When searching for elf files only includes ones which end in this extension
+--lockstepverbose, -lv                                       Run ImperasDV lock, step, and compare with tracing enabled
+--rvvi, -r                                                   Simulate rvvi hardware interface and ethernet.
 ```
 
-Run basic test with questa
+Run basic test with Questa
 
 ```bash
 wsim rv64gc arch64i
@@ -258,26 +260,26 @@ Run Questa with gui
 wsim rv64gc wally64priv --gui
 ```
 
-Run lockstep against ImperasDV with a single elf file in the gui.  Lockstep requires single elf.
+Run basic test with Verilator
 
 ```bash
-wsim rv64gc ../../tests/riscof/work/riscv-arch-test/rv64i_m/I/src/add-01.S/ref/ref.elf --lockstep --gui
+wsim rv32i arch32i --sim verilator
 ```
 
-Run lockstep against ImperasDV with a single elf file.  Compute coverage.
+Run lockstep against ImperasDV with a single elf file in the gui. Lockstep requires single elf.
 
 ```bash
-wsim rv64gc ../../tests/riscof/work/riscv-arch-test/rv64i_m/I/src/add-01.S/ref/ref.elf --lockstep --coverage
+wsim rv64gc $WALLY/tests/riscof/work/riscv-arch-test/rv64i_m/I/src/add-01.S/ref/ref.elf --lockstep --gui
 ```
 
-Run lockstep against ImperasDV with directory file.
+Run lockstep against ImperasDV with a single elf file. Collect functional coverage.
 
 ```bash
-wsim rv64gc ../../tests/riscof/work/riscv-arch-test/rv64i_m/I/src/ --lockstep
+wsim rv64gc $WALLY/addins/cvw-arch-verif/tests/rv64/Zicsr/WALLY-COV-ALL.elf --fcov
 ```
 
-Run lockstep against ImperasDV with directory file and specify specific extension.
+Run Linux boot simulation in lock step between Wally and ImperasDV
 
 ```bash
-wsim rv64gc ../../tests/riscof/work/riscv-arch-test/rv64i_m/I/src/ --lockstep --elfext ref.elf
+wsim buildroot buildroot --args +INSTR_LIMIT=600000000 --lockstep
 ```