cvw/bin/wsim

#!/usr/bin/python3
#
# wsim
# David_Harris@hmc.edu 5 April 2024
# Invoke a Wally simulation for a desired configuration and test suite or ELF on the specified simulator
# usage: wsim CONFIG TESTSUITE [-s/--sim SIMULATOR] [-g/--gui]
# example: wsim rv64gc arch64i
# example: wsim rv64gc tests/riscof/work/riscv-arch-test/rv64i_m/I/src/ref/ref.elf
# example: wsim rv32i arch32i -s verilator
# example: wsim fdqh_ieee_rv64gc add -t testbench_fp        # run TestFloat
#
# SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1

import argparse
import os

########################
# main wsim script
########################

# Parse arguments
parser = argparse.ArgumentParser()
parser.add_argument("config", help="Configuration file")
parser.add_argument("testsuite", help="Test suite or path to .elf file")
parser.add_argument("--elf", "-e", help="ELF File name; use if name does not end in .elf", default="")
parser.add_argument("--sim", "-s", help="Simulator", choices=["questa", "verilator", "vcs"], default="questa")
parser.add_argument("--tb", "-t", help="Testbench", choices=["testbench", "testbench_fp"], default="testbench")
parser.add_argument("--gui", "-g", help="Simulate with GUI", action="store_true")
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("--args", "-a", help="Optional arguments passed to simulator via $value$plusargs", 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("--covlog", "-d", help="Log coverage after n instructions.", default=0)
args = parser.parse_args()
print("Config=" + args.config + " tests=" + args.testsuite + " sim=" + args.sim + " gui=" + str(args.gui) + " args='" + args.args + "'")
ElfFile=""
WALLY = os.environ.get('WALLY')

if(os.path.isfile(args.elf)):
    ElfFile = "+ElfFile=" + os.path.abspath(args.elf)
elif (args.elf != ""):
    print("ELF file not found: " + args.elf)
    exit(1)

if(args.testsuite.endswith('.elf') and args.elf == ""): # No --elf argument; check if testsuite has a .elf extension and use that instead
    if (os.path.isfile(args.testsuite)):
        ElfFile = "+ElfFile=" + os.path.abspath(args.testsuite)
        args.testsuite=args.testsuite.rsplit('/', 1)[1]
    else:
        print("ELF file not found: " + args.testsuite)
        exit(1)
    


# Validate arguments
if (args.gui or args.coverage or args.fcov or args.lockstep):
    if args.sim not in ["questa", "vcs"]:
        print("Option only supported for Questa and VCS")
        exit(1)

if (args.vcd):
    args.args += " -DMAKEVCD=1"

# if lockstep is enabled, then we need to pass the Imperas lockstep arguments
if(int(args.locksteplog) >= 1): EnableLog = 1
else: EnableLog = 0
if (args.lockstep):
    prefix = "IMPERAS_TOOLS=" + WALLY + "/sim/imperas.ic"
    if(args.locksteplog != 0): ImperasPlusArgs = " +IDV_TRACE2LOG=" + str(EnableLog) + " +IDV_TRACE2LOG_AFTER=" + str(args.locksteplog) 
    else: ImperasPlusArgs = ""
    if(args.fcov):
        CovEnableStr = "1" if int(args.covlog) > 0  else "0";
        if(args.covlog >= 1): EnableLog = 1
        else: EnableLog = 0
        ImperasPlusArgs = " +IDV_TRACE2COV=" + str(EnableLog) + " +TRACE2LOG_AFTER=" + str(args.covlog) + " +TRACE2COV_ENABLE=" + CovEnableStr;
        suffix = ""
    else:
        CovEnableStr = ""
        suffix = "--lockstep"
else:
    prefix = ""
    ImperasPlusArgs = ""
    suffix = ""
flags = suffix + " " + ImperasPlusArgs

# other flags
if (args.coverage):
    flags += " --coverage"
if (args.fcov):
    flags += " --fcov"

#  create the output sub-directories.
regressionDir = WALLY + '/sim/'
for d in ["logs", "wkdir", "cov"]:
    try:
        os.mkdir(regressionDir+args.sim+"/"+d)
    except:
        pass

cd = "cd $WALLY/sim/" +args.sim

# per-simulator launch
if (args.sim == "questa"):
    # Questa cannot accept more than 9 arguments.  fcov implies lockstep
    if (args.tb == "testbench_fp"):
        args.args = " -GTEST=\"" + args.testsuite + "\" " + args.args
    cmd = "do wally.do " + args.config + " " + args.testsuite + " " + args.tb + " " + args.args + " " + ElfFile + " " + flags
    if (args.gui):  # launch Questa with GUI; add +acc to keep variables accessible
        if(args.tb == "testbench"): 
            cmd = cd + "; " + prefix + " vsim -do \"" + cmd + " +acc -GDEBUG=1\""
        elif(args.tb == "testbench_fp"):
            cmd = cd + "; " + prefix + " vsim -do \"" + cmd + " +acc\""
    else: # launch Questa in batch mode
        cmd = cd + "; " + prefix + " vsim -c -do \"" + cmd + "\""
    print("Running Questa with command: " + cmd)
    os.system(cmd)
elif (args.sim == "verilator"):
    # PWD=${WALLY}/sim CONFIG=rv64gc TESTSUITE=arch64i
    print(f"Running Verilator on {args.config} {args.testsuite}")
    os.system(f"/usr/bin/make -C {regressionDir}/verilator WALLYCONF={args.config} TEST={args.testsuite} TESTBENCH={args.tb} EXTRA_ARGS='{args.args}'")
elif (args.sim == "vcs"):
    print(f"Running VCS on " + args.config + " " + args.testsuite)
    if (args.gui):  
        args.args += "gui"
    if (args.args == ""):
        vcsargs = ""
    else:
        vcsargs = " --args " + args.args
    if (ElfFile != ""):
        ElfFile = " --elffile " + ElfFile
    cmd = cd + "; " + prefix + " ./run_vcs " + args.config + " " + args.testsuite + vcsargs + ElfFile + " " + flags
    print(cmd)
    os.system(cmd)