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.disable_log = args.disable_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.trace = 1 if args.trace or not args.disable_fork else None 57 self.config = args.config 58 # emu arguments 59 self.max_instr = args.max_instr 60 self.seed = random.randint(0, 9999) 61 self.numa = args.numa 62 self.fork = not args.disable_fork 63 # wave dump path 64 if args.wave_dump is not None: 65 self.set_wave_home(args.wave_dump) 66 else: 67 self.set_wave_home(self.default_wave_home) 68 69 def get_env_variables(self): 70 all_env = { 71 "NOOP_HOME" : self.noop_home, 72 "NEMU_HOME" : self.nemu_home, 73 "WAVE_HOME" : self.wave_home, 74 "AM_HOME" : self.am_home, 75 "DRAMSIM3_HOME": self.dramsim3_home 76 } 77 return all_env 78 79 def get_chisel_args(self, prefix=None): 80 chisel_args = [ 81 (self.disable_log, "disable-log") 82 ] 83 args = map(lambda x: x[1], filter(lambda arg: arg[0], chisel_args)) 84 if prefix is not None: 85 args = map(lambda x: prefix + x, args) 86 return args 87 88 def get_makefile_args(self): 89 makefile_args = [ 90 (self.threads, "EMU_THREADS"), 91 (self.with_dramsim3, "WITH_DRAMSIM3"), 92 (self.trace, "EMU_TRACE"), 93 (self.config, "CONFIG"), 94 (self.num_cores, "NUM_CORES") 95 ] 96 args = filter(lambda arg: arg[0] is not None, makefile_args) 97 return args 98 99 def get_emu_args(self): 100 emu_args = [ 101 (self.max_instr, "max-instr"), 102 (self.seed, "seed") 103 ] 104 args = filter(lambda arg: arg[0] is not None, emu_args) 105 return args 106 107 def show(self): 108 print("Extra environment variables:") 109 env = self.get_env_variables() 110 for env_name in env: 111 print(f"{env_name}: {env[env_name]}") 112 print() 113 print("Chisel arguments:") 114 print(" ".join(self.get_chisel_args())) 115 print() 116 print("Makefile arguments:") 117 for val, name in self.get_makefile_args(): 118 print(f"{name}={val}") 119 print() 120 print("emu arguments:") 121 for val, name in self.get_emu_args(): 122 print(f"--{name} {val}") 123 print() 124 125 def __extract_path(self, path, env=None, default=None): 126 if path is None and env is not None: 127 path = os.getenv(env) 128 if path is None and default is not None: 129 path = default 130 path = os.path.realpath(path) 131 return path 132 133 def set_noop_home(self, path): 134 self.noop_home = path 135 136 def set_nemu_home(self, path): 137 self.nemu_home = path 138 139 def set_am_home(self, path): 140 self.am_home = path 141 142 def set_dramsim3_home(self, path): 143 self.dramsim3_home = path 144 145 def set_rvtest_home(self, path): 146 self.rvtest_home = path 147 148 def set_wave_home(self, path): 149 print(f"set wave home to {path}") 150 self.wave_home = path 151 152# XiangShan environment 153class XiangShan(object): 154 def __init__(self, args): 155 self.args = XSArgs(args) 156 157 def show(self): 158 self.args.show() 159 160 def generate_verilog(self): 161 print("Generating XiangShan verilog with the following configurations:") 162 self.show() 163 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 164 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 165 return_code = self.__exec_cmd(f'make -C $NOOP_HOME verilog SIM_ARGS="{sim_args}" {make_args}') 166 return return_code 167 168 def build_emu(self): 169 print("Building XiangShan emu with the following configurations:") 170 self.show() 171 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 172 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 173 return_code = self.__exec_cmd(f'make -C $NOOP_HOME emu -j200 SIM_ARGS="{sim_args}" {make_args}') 174 return return_code 175 176 def run_emu(self, workload): 177 print("Running XiangShan emu with the following configurations:") 178 self.show() 179 emu_args = " ".join(map(lambda arg: f"--{arg[1]} {arg[0]}", self.args.get_emu_args())) 180 print("workload:", workload) 181 numa_args = f"numactl -m 1 -C 64-{64+self.args.threads-1}" if self.args.numa else "" 182 fork_args = "--enable-fork" if self.args.fork else "" 183 return_code = self.__exec_cmd(f'{numa_args} $NOOP_HOME/build/emu -i {workload} {emu_args} {fork_args}') 184 return return_code 185 186 def run(self, args): 187 if args.ci is not None: 188 return self.run_ci(args.ci) 189 actions = [ 190 (args.generate, lambda _ : self.generate_verilog()), 191 (args.build, lambda _ : self.build_emu()), 192 (args.workload, lambda args: self.run_emu(args.workload)) 193 ] 194 valid_actions = map(lambda act: act[1], filter(lambda act: act[0], actions)) 195 for i, action in enumerate(valid_actions): 196 print(f"Action {i}:") 197 ret = action(args) 198 if ret: 199 return ret 200 return 0 201 202 def __exec_cmd(self, cmd): 203 env = dict(os.environ) 204 env.update(self.args.get_env_variables()) 205 print("subprocess call cmd:", cmd) 206 start = time.time() 207 return_code = subprocess.call(cmd, shell=True, env=env) 208 end = time.time() 209 print(f"Elapsed time: {end - start} seconds") 210 return return_code 211 212 def __get_ci_cputest(self, name=None): 213 base_dir = os.path.join(self.args.am_home, "tests/cputest/build") 214 cputest = os.listdir(base_dir) 215 cputest = filter(lambda x: x.endswith(".bin"), cputest) 216 cputest = map(lambda x: os.path.join(base_dir, x), cputest) 217 return cputest 218 219 def __get_ci_rvtest(self, name=None): 220 base_dir = os.path.join(self.args.rvtest_home, "isa/build") 221 riscv_tests = os.listdir(base_dir) 222 riscv_tests = filter(lambda x: x.endswith(".bin"), riscv_tests) 223 all_rv_tests = ["rv64ui", "rv64um", "rv64ua", "rv64uf", "rv64ud"] 224 riscv_tests = filter(lambda x: x[:6] in all_rv_tests, riscv_tests) 225 riscv_tests = map(lambda x: os.path.join(base_dir, x), riscv_tests) 226 return riscv_tests 227 228 def __get_ci_misc(self, name=None): 229 base_dir = "/home/ci-runner/xsenv/workloads" 230 workloads = [ 231 "bitmanip/bitMisc.bin", 232 "crypto/crypto-riscv64-noop.bin", 233 "coremark_rv64gc_o2/coremark-riscv64-xs.bin", 234 "coremark_rv64gc_o3/coremark-riscv64-xs.bin", 235 "coremark_rv64gcb_o3/coremark-riscv64-xs.bin", 236 "ext_intr/amtest-riscv64-xs.bin", 237 "cache-alias/aliastest-riscv64-xs.bin", 238 "pmp/pmp.riscv.bin", 239 "cache-management/softprefetch-riscv64-noop.bin" 240 ] 241 misc_tests = map(lambda x: os.path.join(base_dir, x), workloads) 242 return misc_tests 243 244 def __am_apps_path(self, bench): 245 filename = f"{bench}-riscv64-noop.bin" 246 return [os.path.join(self.args.am_home, "apps", bench, "build", filename)] 247 248 def __get_ci_workloads(self, name): 249 workloads = { 250 "linux-hello": "bbl.bin", 251 "povray": "_700480000000_.gz", 252 "mcf": "_17520000000_.gz", 253 "xalancbmk": "_266100000000_.gz", 254 "gcc": "_39720000000_.gz", 255 "namd": "_434640000000_.gz", 256 "milc": "_103620000000_.gz", 257 "lbm": "_140840000000_.gz", 258 "gromacs": "_275480000000_.gz", 259 "wrf": "_1916220000000_.gz", 260 "astar": "_122060000000_.gz" 261 } 262 return [os.path.join("/home/ci-runner/xsenv/workloads", name, workloads[name])] 263 264 def run_ci(self, test): 265 all_tests = { 266 "cputest": self.__get_ci_cputest, 267 "riscv-tests": self.__get_ci_rvtest, 268 "misc-tests": self.__get_ci_misc, 269 "microbench": self.__am_apps_path, 270 "coremark": self.__am_apps_path 271 } 272 for target in all_tests.get(test, self.__get_ci_workloads)(test): 273 print(target) 274 ret = self.run_emu(target) 275 if ret: 276 if self.args.default_wave_home != self.args.wave_home: 277 print("copy wave file to " + self.args.wave_home) 278 self.__exec_cmd(f"cp $NOOP_HOME/build/*.vcd $WAVE_HOME") 279 return ret 280 return 0 281 282if __name__ == "__main__": 283 parser = argparse.ArgumentParser(description='Python wrapper for XiangShan') 284 parser.add_argument('workload', nargs='?', type=str, default="", 285 help='input workload file in binary format') 286 # actions 287 parser.add_argument('--build', action='store_true', help='build XS emu') 288 parser.add_argument('--generate', action='store_true', help='generate XS verilog') 289 parser.add_argument('--ci', nargs='?', type=str, const="", help='run CI tests') 290 # environment variables 291 parser.add_argument('--nemu', nargs='?', type=str, help='path to nemu') 292 parser.add_argument('--am', nargs='?', type=str, help='path to nexus-am') 293 parser.add_argument('--dramsim3', nargs='?', type=str, help='path to dramsim3') 294 parser.add_argument('--rvtest', nargs='?', type=str, help='path to riscv-tests') 295 parser.add_argument('--wave-dump', nargs='?', type=str , help='path to dump wave') 296 # chisel arguments 297 parser.add_argument('--disable-log', action='store_true', help='disable log') 298 parser.add_argument('--num-cores', type=int, help='number of cores') 299 # makefile arguments 300 parser.add_argument('--with-dramsim3', action='store_true', help='enable dramsim3') 301 parser.add_argument('--threads', nargs='?', type=int, help='number of emu threads') 302 parser.add_argument('--trace', action='store_true', help='enable waveform') 303 parser.add_argument('--config', nargs='?', type=str, help='config') 304 # emu arguments 305 parser.add_argument('--numa', action='store_true', help='use numactl') 306 parser.add_argument('--max-instr', nargs='?', type=int, help='max instr') 307 parser.add_argument('--disable-fork', action='store_true', help='disable lightSSS') 308 # ci action head sha 309 310 args = parser.parse_args() 311 312 xs = XiangShan(args) 313 ret = xs.run(args) 314 315 sys.exit(ret) 316