1#*************************************************************************************** 2# Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences 3# Copyright (c) 2020-2021 Peng Cheng Laboratory 4# 5# XiangShan is licensed under Mulan PSL v2. 6# You can use this software according to the terms and conditions of the Mulan PSL v2. 7# You may obtain a copy of Mulan PSL v2 at: 8# http://license.coscl.org.cn/MulanPSL2 9# 10# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, 11# EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, 12# MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. 13# 14# See the Mulan PSL v2 for more details. 15#*************************************************************************************** 16 17# Simple version of xiangshan python wrapper 18 19import argparse 20import os 21import random 22import subprocess 23import sys 24import time 25 26 27class XSArgs(object): 28 script_path = os.path.realpath(__file__) 29 # default path to the repositories 30 noop_home = os.path.join(os.path.dirname(script_path), "..") 31 nemu_home = os.path.join(noop_home, "../NEMU") 32 am_home = os.path.join(noop_home, "../nexus-am") 33 dramsim3_home = os.path.join(noop_home, "../DRAMsim3") 34 rvtest_home = os.path.join(noop_home, "../riscv-tests") 35 default_wave_home = os.path.join(noop_home, "build") 36 wave_home = default_wave_home 37 38 def __init__(self, args): 39 # all path environment variables that should be set 40 all_path = [ 41 # (python argument, environment variable, default, target function) 42 (None, "NOOP_HOME", self.noop_home, self.set_noop_home), 43 (args.nemu, "NEMU_HOME", self.nemu_home, self.set_nemu_home), 44 (args.am, "AM_HOME", self.am_home, self.set_am_home), 45 (args.dramsim3, "DRAMSIM3_HOME", self.dramsim3_home, self.set_dramsim3_home), 46 (args.rvtest, "RVTEST_HOME", self.rvtest_home, self.set_rvtest_home), 47 ] 48 for (arg_in, env, default, set_func) in all_path: 49 set_func(self.__extract_path(arg_in, env, default)) 50 # Chisel arguments 51 self.enable_log = args.enable_log 52 self.num_cores = args.num_cores 53 # Makefile arguments 54 self.threads = args.threads 55 self.with_dramsim3 = 1 if args.with_dramsim3 else None 56 self.is_release = 1 if args.release else None 57 self.trace = 1 if args.trace or not args.disable_fork else None 58 self.config = args.config 59 # emu arguments 60 self.max_instr = args.max_instr 61 self.seed = random.randint(0, 9999) 62 self.numa = args.numa 63 self.diff = args.diff 64 self.fork = not args.disable_fork 65 # wave dump path 66 if args.wave_dump is not None: 67 self.set_wave_home(args.wave_dump) 68 else: 69 self.set_wave_home(self.default_wave_home) 70 71 def get_env_variables(self): 72 all_env = { 73 "NOOP_HOME" : self.noop_home, 74 "NEMU_HOME" : self.nemu_home, 75 "WAVE_HOME" : self.wave_home, 76 "AM_HOME" : self.am_home, 77 "DRAMSIM3_HOME": self.dramsim3_home 78 } 79 return all_env 80 81 def get_chisel_args(self, prefix=None): 82 chisel_args = [ 83 (self.enable_log, "enable-log") 84 ] 85 args = map(lambda x: x[1], filter(lambda arg: arg[0], chisel_args)) 86 if prefix is not None: 87 args = map(lambda x: prefix + x, args) 88 return args 89 90 def get_makefile_args(self): 91 makefile_args = [ 92 (self.threads, "EMU_THREADS"), 93 (self.with_dramsim3, "WITH_DRAMSIM3"), 94 (self.is_release, "RELEASE"), 95 (self.trace, "EMU_TRACE"), 96 (self.config, "CONFIG"), 97 (self.num_cores, "NUM_CORES") 98 ] 99 args = filter(lambda arg: arg[0] is not None, makefile_args) 100 return args 101 102 def get_emu_args(self): 103 emu_args = [ 104 (self.max_instr, "max-instr"), 105 (self.diff, "diff"), 106 (self.seed, "seed") 107 ] 108 args = filter(lambda arg: arg[0] is not None, emu_args) 109 return args 110 111 def show(self): 112 print("Extra environment variables:") 113 env = self.get_env_variables() 114 for env_name in env: 115 print(f"{env_name}: {env[env_name]}") 116 print() 117 print("Chisel arguments:") 118 print(" ".join(self.get_chisel_args())) 119 print() 120 print("Makefile arguments:") 121 for val, name in self.get_makefile_args(): 122 print(f"{name}={val}") 123 print() 124 print("emu arguments:") 125 for val, name in self.get_emu_args(): 126 print(f"--{name} {val}") 127 print() 128 129 def __extract_path(self, path, env=None, default=None): 130 if path is None and env is not None: 131 path = os.getenv(env) 132 if path is None and default is not None: 133 path = default 134 path = os.path.realpath(path) 135 return path 136 137 def set_noop_home(self, path): 138 self.noop_home = path 139 140 def set_nemu_home(self, path): 141 self.nemu_home = path 142 143 def set_am_home(self, path): 144 self.am_home = path 145 146 def set_dramsim3_home(self, path): 147 self.dramsim3_home = path 148 149 def set_rvtest_home(self, path): 150 self.rvtest_home = path 151 152 def set_wave_home(self, path): 153 print(f"set wave home to {path}") 154 self.wave_home = path 155 156# XiangShan environment 157class XiangShan(object): 158 def __init__(self, args): 159 self.args = XSArgs(args) 160 161 def show(self): 162 self.args.show() 163 164 def generate_verilog(self): 165 print("Generating XiangShan verilog with the following configurations:") 166 self.show() 167 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 168 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 169 return_code = self.__exec_cmd(f'make -C $NOOP_HOME verilog SIM_ARGS="{sim_args}" {make_args}') 170 return return_code 171 172 def build_emu(self): 173 print("Building XiangShan emu with the following configurations:") 174 self.show() 175 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 176 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 177 return_code = self.__exec_cmd(f'make -C $NOOP_HOME emu -j200 SIM_ARGS="{sim_args}" {make_args}') 178 return return_code 179 180 def run_emu(self, workload): 181 print("Running XiangShan emu with the following configurations:") 182 self.show() 183 emu_args = " ".join(map(lambda arg: f"--{arg[1]} {arg[0]}", self.args.get_emu_args())) 184 print("workload:", workload) 185 numa_args = f"numactl -m 1 -C 64-{64+self.args.threads-1}" if self.args.numa else "" 186 fork_args = "--enable-fork" if self.args.fork else "" 187 return_code = self.__exec_cmd(f'{numa_args} $NOOP_HOME/build/emu -i {workload} {emu_args} {fork_args}') 188 return return_code 189 190 def run(self, args): 191 if args.ci is not None: 192 return self.run_ci(args.ci) 193 actions = [ 194 (args.generate, lambda _ : self.generate_verilog()), 195 (args.build, lambda _ : self.build_emu()), 196 (args.workload, lambda args: self.run_emu(args.workload)) 197 ] 198 valid_actions = map(lambda act: act[1], filter(lambda act: act[0], actions)) 199 for i, action in enumerate(valid_actions): 200 print(f"Action {i}:") 201 ret = action(args) 202 if ret: 203 return ret 204 return 0 205 206 def __exec_cmd(self, cmd): 207 env = dict(os.environ) 208 env.update(self.args.get_env_variables()) 209 print("subprocess call cmd:", cmd) 210 start = time.time() 211 return_code = subprocess.call(cmd, shell=True, env=env) 212 end = time.time() 213 print(f"Elapsed time: {end - start} seconds") 214 return return_code 215 216 def __get_ci_cputest(self, name=None): 217 base_dir = os.path.join(self.args.am_home, "tests/cputest/build") 218 cputest = os.listdir(base_dir) 219 cputest = filter(lambda x: x.endswith(".bin"), cputest) 220 cputest = map(lambda x: os.path.join(base_dir, x), cputest) 221 return cputest 222 223 def __get_ci_rvtest(self, name=None): 224 base_dir = os.path.join(self.args.rvtest_home, "isa/build") 225 riscv_tests = os.listdir(base_dir) 226 riscv_tests = filter(lambda x: x.endswith(".bin"), riscv_tests) 227 all_rv_tests = ["rv64ui", "rv64um", "rv64ua", "rv64uf", "rv64ud"] 228 riscv_tests = filter(lambda x: x[:6] in all_rv_tests, riscv_tests) 229 riscv_tests = map(lambda x: os.path.join(base_dir, x), riscv_tests) 230 return riscv_tests 231 232 def __get_ci_misc(self, name=None): 233 base_dir = "/home/ci-runner/xsenv/workloads" 234 workloads = [ 235 "bitmanip/bitMisc.bin", 236 "crypto/crypto-riscv64-noop.bin", 237 "coremark_rv64gc_o2/coremark-riscv64-xs.bin", 238 "coremark_rv64gc_o3/coremark-riscv64-xs.bin", 239 "coremark_rv64gcb_o3/coremark-riscv64-xs.bin", 240 "ext_intr/amtest-riscv64-xs.bin", 241 "cache-alias/aliastest-riscv64-xs.bin", 242 "Svinval/rv64mi-p-svinval.bin", 243 "pmp/pmp.riscv.bin", 244 "asid/asid.bin", 245 "cache-management/softprefetch-riscv64-noop.bin" 246 ] 247 misc_tests = map(lambda x: os.path.join(base_dir, x), workloads) 248 return misc_tests 249 250 def __am_apps_path(self, bench): 251 filename = f"{bench}-riscv64-noop.bin" 252 return [os.path.join(self.args.am_home, "apps", bench, "build", filename)] 253 254 def __get_ci_workloads(self, name): 255 workloads = { 256 "linux-hello": "bbl.bin", 257 "povray": "_700480000000_.gz", 258 "mcf": "_17520000000_.gz", 259 "xalancbmk": "_266100000000_.gz", 260 "gcc": "_39720000000_.gz", 261 "namd": "_434640000000_.gz", 262 "milc": "_103620000000_.gz", 263 "lbm": "_140840000000_.gz", 264 "gromacs": "_275480000000_.gz", 265 "wrf": "_1916220000000_.gz", 266 "astar": "_122060000000_.gz" 267 } 268 return [os.path.join("/home/ci-runner/xsenv/workloads", name, workloads[name])] 269 270 def run_ci(self, test): 271 all_tests = { 272 "cputest": self.__get_ci_cputest, 273 "riscv-tests": self.__get_ci_rvtest, 274 "misc-tests": self.__get_ci_misc, 275 "microbench": self.__am_apps_path, 276 "coremark": self.__am_apps_path 277 } 278 for target in all_tests.get(test, self.__get_ci_workloads)(test): 279 print(target) 280 ret = self.run_emu(target) 281 if ret: 282 if self.args.default_wave_home != self.args.wave_home: 283 print("copy wave file to " + self.args.wave_home) 284 self.__exec_cmd(f"cp $NOOP_HOME/build/*.vcd $WAVE_HOME") 285 self.__exec_cmd(f"cp $NOOP_HOME/build/emu $WAVE_HOME") 286 self.__exec_cmd(f"cp $NOOP_HOME/build/SimTop.v $WAVE_HOME") 287 return ret 288 return 0 289 290if __name__ == "__main__": 291 parser = argparse.ArgumentParser(description='Python wrapper for XiangShan') 292 parser.add_argument('workload', nargs='?', type=str, default="", 293 help='input workload file in binary format') 294 # actions 295 parser.add_argument('--build', action='store_true', help='build XS emu') 296 parser.add_argument('--generate', action='store_true', help='generate XS verilog') 297 parser.add_argument('--ci', nargs='?', type=str, const="", help='run CI tests') 298 # environment variables 299 parser.add_argument('--nemu', nargs='?', type=str, help='path to nemu') 300 parser.add_argument('--am', nargs='?', type=str, help='path to nexus-am') 301 parser.add_argument('--dramsim3', nargs='?', type=str, help='path to dramsim3') 302 parser.add_argument('--rvtest', nargs='?', type=str, help='path to riscv-tests') 303 parser.add_argument('--wave-dump', nargs='?', type=str , help='path to dump wave') 304 # chisel arguments 305 parser.add_argument('--enable-log', action='store_true', help='enable log') 306 parser.add_argument('--num-cores', type=int, help='number of cores') 307 # makefile arguments 308 parser.add_argument('--release', action='store_true', help='enable release') 309 parser.add_argument('--with-dramsim3', action='store_true', help='enable dramsim3') 310 parser.add_argument('--threads', nargs='?', type=int, help='number of emu threads') 311 parser.add_argument('--trace', action='store_true', help='enable waveform') 312 parser.add_argument('--config', nargs='?', type=str, help='config') 313 # emu arguments 314 parser.add_argument('--numa', action='store_true', help='use numactl') 315 parser.add_argument('--diff', nargs='?', default="./ready-to-run/riscv64-nemu-interpreter-so", type=str, help='nemu so') 316 parser.add_argument('--max-instr', nargs='?', type=int, help='max instr') 317 parser.add_argument('--disable-fork', action='store_true', help='disable lightSSS') 318 # ci action head sha 319 320 args = parser.parse_args() 321 322 xs = XiangShan(args) 323 ret = xs.run(args) 324 325 sys.exit(ret) 326