Partial automation of branch predictor embenching.

bin/parseHPMC.py

@@ -221,9 +221,9 @@ if(sys.argv[1] == '-b'):
     for benchmark in benchmarkAll:
         (name, opt, config, dataDict) = benchmark
         if name+'_'+opt in benchmarkDict:
-            benchmarkDict[name+'_'+opt].append((config, dataDict['BDMR']))
+            benchmarkDict[name+'_'+opt].append((config, dataDict['BTMR']))
         else:
-            benchmarkDict[name+'_'+opt] = [(config, dataDict['BDMR'])]
+            benchmarkDict[name+'_'+opt] = [(config, dataDict['BTMR'])]
 
     size = len(benchmarkDict)
     index = 1

sim/bpred-sim.py

@@ -0,0 +1,143 @@
+#!/usr/bin/python3
+##################################
+#
+# regression-wally
+# David_Harris@Hmc.edu 25 January 2021
+# Modified by Jarred Allen <jaallen@g.hmc.edu>
+#
+# Run a regression with multiple configurations in parallel and exit with
+# non-zero status code if an error happened, as well as printing human-readable
+# output.
+#
+##################################
+import sys,os,shutil
+
+class bcolors:
+    HEADER = '\033[95m'
+    OKBLUE = '\033[94m'
+    OKCYAN = '\033[96m'
+    OKGREEN = '\033[92m'
+    WARNING = '\033[93m'
+    FAIL = '\033[91m'
+    ENDC = '\033[0m'
+    BOLD = '\033[1m'
+    UNDERLINE = '\033[4m'
+
+from collections import namedtuple
+regressionDir = os.path.dirname(os.path.abspath(__file__))
+os.chdir(regressionDir)
+
+TestCase = namedtuple("TestCase", ['name', 'variant', 'cmd', 'grepstr'])
+# name:     the name of this test configuration (used in printing human-readable
+#           output and picking logfile names)
+# cmd:      the command to run to test (should include the logfile as '{}', and
+#           the command needs to write to that file)
+# grepstr:  the string to grep through the log file for. The test succeeds iff
+#           grep finds that string in the logfile (is used by grep, so it may
+#           be any pattern grep accepts, see `man 1 grep` for more info).
+
+# edit this list to add more test cases
+configs = [
+    TestCase(
+        name="lints",
+        variant="all",
+        cmd="./lint-wally | tee {}",
+        grepstr="All lints run with no errors or warnings"
+    )
+]
+
+configOptions = "+define+INSTR_CLASS_PRED=0 +define+BPRED_TYPE=\"BP_TWOBIT\" +define+BPRED_SIZE=6"
+tc = TestCase(
+    name="twobit6",
+    variant="rv32gc",
+    cmd="vsim > {} -c <<!\ndo wally-batch.do  rv32gc configOptions twobit6 embench " + configOptions,
+    grepstr="")
+configs.append(tc)
+
+configOptions = "+define+INSTR_CLASS_PRED=0 +define+BPRED_TYPE=\"BP_TWOBIT\" +define+BPRED_SIZE=8"
+tc = TestCase(
+    name="twobit8",
+    variant="rv32gc",
+    cmd="vsim > {} -c <<!\ndo wally-batch.do rv32gc configOptions twobit8 embench " + configOptions,
+    grepstr="")
+configs.append(tc)
+
+configOptions = "+define+INSTR_CLASS_PRED=0 +define+BPRED_TYPE=\"BP_TWOBIT\" +define+BPRED_SIZE=10"
+tc = TestCase(
+    name="twobit10",
+    variant="rv32gc",
+    cmd="vsim > {} -c <<!\ndo wally-batch.do rv32gc configOptions twobit10 embench " + configOptions,
+    grepstr="")
+configs.append(tc)
+
+
+
+import os
+from multiprocessing import Pool, TimeoutError
+
+def search_log_for_text(text, logfile):
+    """Search through the given log file for text, returning True if it is found or False if it is not"""
+    grepcmd = "grep -e '%s' '%s' > /dev/null" % (text, logfile)
+    return os.system(grepcmd) == 0
+
+def run_test_case(config):
+    """Run the given test case, and return 0 if the test suceeds and 1 if it fails"""
+    logname = "logs/"+config.variant+"_"+config.name+".log"
+    cmd = config.cmd.format(logname)
+    print(cmd)
+    os.chdir(regressionDir)
+    os.system(cmd)
+    if search_log_for_text(config.grepstr, logname):
+        print(f"{bcolors.OKGREEN}%s_%s: Success{bcolors.ENDC}" % (config.variant, config.name))
+        return 0
+    else:
+        print(f"{bcolors.FAIL}%s_%s: Failures detected in output{bcolors.ENDC}" % (config.variant, config.name))
+        print("  Check %s" % logname)
+        return 1
+
+def main():
+    """Run the tests and count the failures"""
+    TIMEOUT_DUR = 10800 # 3 hours
+
+    global configs
+    try:
+        os.chdir(regressionDir)
+        os.mkdir("logs")
+        #print(os.getcwd())
+        #print(regressionDir)
+    except:
+        pass
+    try:
+        shutil.rmtree("wkdir")
+    except:
+        pass
+    finally:
+        os.mkdir("wkdir")
+ 
+    if '-makeTests' in sys.argv:
+        os.chdir(regressionDir)
+        os.system('./make-tests.sh | tee ./logs/make-tests.log')
+
+    # Scale the number of concurrent processes to the number of test cases, but
+    # max out at a limited number of concurrent processes to not overwhelm the system
+    with Pool(processes=min(len(configs),40)) as pool:
+       num_fail = 0
+       results = {}
+       for config in configs:
+           results[config] = pool.apply_async(run_test_case,(config,))
+       for (config,result) in results.items():
+           try:
+             num_fail+=result.get(timeout=TIMEOUT_DUR)
+           except TimeoutError:
+             num_fail+=1
+             print(f"{bcolors.FAIL}%s_%s: Timeout - runtime exceeded %d seconds{bcolors.ENDC}" % (config.variant, config.name, TIMEOUT_DUR))
+
+    # Count the number of failures
+    if num_fail:
+        print(f"{bcolors.FAIL}Regression failed with %s failed configurations{bcolors.ENDC}" % num_fail)
+    else:
+        print(f"{bcolors.OKGREEN}SUCCESS! All tests ran without failures{bcolors.ENDC}")
+    return num_fail
+
+if __name__ == '__main__':
+    exit(main())

sim/wally-batch.do

@@ -26,6 +26,14 @@ if {$2 eq "ahb"} {
         vdel -lib wkdir/work_${1}_${2}_${3}_${4} -all
     }
     vlib wkdir/work_${1}_${2}_${3}_${4}
+
+
+} elseif {$2 eq "configOptions"} {
+    if [file exists wkdir/work_${1}_${3}_${4}] {
+        vdel -lib wkdir/work_${1}_${3}_${4} -all
+    }
+    vlib wkdir/work_${1}_${3}_${4}
+
 } else {
     if [file exists wkdir/work_${1}_${2}] {
         vdel -lib wkdir/work_${1}_${2} -all
@@ -76,6 +84,30 @@ if {$2 eq "buildroot" || $2 eq "buildroot-checkpoint"} {
     # power add -r /dut/core/*
     run -all
     # power off -r /dut/core/*
+
+} elseif {$2 eq "configOptions"} {
+    # set arguments " "
+    # for {set i 5} {$i <= $argc} {incr i} {
+    # 	append arguments "\$$i "
+    # }
+    # puts $arguments
+    # set options eval $arguments
+    # **** fix this so we can pass any number of +defines.
+    # only allows 3 right now
+
+    vlog -lint -work wkdir/work_${1}_${3}_${4} +incdir+../config/$1 +incdir+../config/shared ../testbench/testbench.sv ../testbench/common/*.sv   ../src/*/*.sv ../src/*/*/*.sv -suppress 2583 -suppress 7063,2596,13286 $5 $6 $7
+    # start and run simulation
+    # remove +acc flag for faster sim during regressions if there is no need to access internal signals
+    vopt wkdir/work_${1}_${3}_${4}.testbench -work wkdir/work_${1}_${3}_${4} -G TEST=$4 -o testbenchopt
+    vsim -lib wkdir/work_${1}_${3}_${4} testbenchopt  -fatal 7 -suppress 3829
+    # Adding coverage increases runtime from 2:00 to 4:29.  Can't run it all the time
+    #vopt work_$2.testbench -work work_$2 -o workopt_$2 +cover=sbectf
+    #vsim -coverage -lib work_$2 workopt_$2
+    # power add generates the logging necessary for said generation.
+    # power add -r /dut/core/*
+    run -all
+    # power off -r /dut/core/*
+
 } else {
     vlog -lint -work wkdir/work_${1}_${2} +incdir+../config/$1 +incdir+../config/shared ../testbench/testbench.sv ../testbench/common/*.sv   ../src/*/*.sv ../src/*/*/*.sv -suppress 2583 -suppress 7063,2596,13286
     # start and run simulation