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 json 21import os 22import random 23import signal 24import subprocess 25import sys 26import time 27 28import psutil 29 30 31def load_all_gcpt(gcpt_path, json_path): 32 all_gcpt = [] 33 with open(json_path) as f: 34 data = json.load(f) 35 for benchspec in data: 36 for point in data[benchspec]: 37 weight = data[benchspec][point] 38 gcpt = os.path.join(gcpt_path, "_".join([benchspec, point, weight])) 39 bin_dir = os.path.join(gcpt, "0") 40 bin_file = list(os.listdir(bin_dir)) 41 assert(len(bin_file) == 1) 42 bin_path = os.path.join(bin_dir, bin_file[0]) 43 assert(os.path.isfile(bin_path)) 44 all_gcpt.append(bin_path) 45 return all_gcpt 46 47class XSArgs(object): 48 script_path = os.path.realpath(__file__) 49 # default path to the repositories 50 noop_home = os.path.join(os.path.dirname(script_path), "..") 51 nemu_home = os.path.join(noop_home, "../NEMU") 52 am_home = os.path.join(noop_home, "../nexus-am") 53 dramsim3_home = os.path.join(noop_home, "../DRAMsim3") 54 rvtest_home = os.path.join(noop_home, "../riscv-tests") 55 default_wave_home = os.path.join(noop_home, "build") 56 wave_home = default_wave_home 57 58 def __init__(self, args): 59 # all path environment variables that should be set 60 all_path = [ 61 # (python argument, environment variable, default, target function) 62 (None, "NOOP_HOME", self.noop_home, self.set_noop_home), 63 (args.nemu, "NEMU_HOME", self.nemu_home, self.set_nemu_home), 64 (args.am, "AM_HOME", self.am_home, self.set_am_home), 65 (args.dramsim3, "DRAMSIM3_HOME", self.dramsim3_home, self.set_dramsim3_home), 66 (args.rvtest, "RVTEST_HOME", self.rvtest_home, self.set_rvtest_home), 67 ] 68 for (arg_in, env, default, set_func) in all_path: 69 set_func(self.__extract_path(arg_in, env, default)) 70 # Chisel arguments 71 self.enable_log = args.enable_log 72 self.num_cores = args.num_cores 73 # Makefile arguments 74 self.threads = args.threads 75 self.with_dramsim3 = 1 if args.with_dramsim3 else None 76 self.is_release = 1 if args.release else None 77 self.is_spike = "spike" if args.spike else None 78 self.trace = 1 if args.trace or not args.disable_fork else None 79 self.config = args.config 80 # emu arguments 81 self.max_instr = args.max_instr 82 self.seed = random.randint(0, 9999) 83 self.numa = args.numa 84 self.diff = args.diff 85 if args.spike and "nemu" in args.diff: 86 self.diff = self.diff.replace("nemu-interpreter", "spike") 87 self.fork = not args.disable_fork 88 self.disable_diff = args.no_diff 89 # wave dump path 90 if args.wave_dump is not None: 91 self.set_wave_home(args.wave_dump) 92 else: 93 self.set_wave_home(self.default_wave_home) 94 95 def get_env_variables(self): 96 all_env = { 97 "NOOP_HOME" : self.noop_home, 98 "NEMU_HOME" : self.nemu_home, 99 "WAVE_HOME" : self.wave_home, 100 "AM_HOME" : self.am_home, 101 "DRAMSIM3_HOME": self.dramsim3_home 102 } 103 return all_env 104 105 def get_chisel_args(self, prefix=None): 106 chisel_args = [ 107 (self.enable_log, "enable-log") 108 ] 109 args = map(lambda x: x[1], filter(lambda arg: arg[0], chisel_args)) 110 if prefix is not None: 111 args = map(lambda x: prefix + x, args) 112 return args 113 114 def get_makefile_args(self): 115 makefile_args = [ 116 (self.threads, "EMU_THREADS"), 117 (self.with_dramsim3, "WITH_DRAMSIM3"), 118 (self.is_release, "RELEASE"), 119 (self.is_spike, "REF"), 120 (self.trace, "EMU_TRACE"), 121 (self.config, "CONFIG"), 122 (self.num_cores, "NUM_CORES") 123 ] 124 args = filter(lambda arg: arg[0] is not None, makefile_args) 125 return args 126 127 def get_emu_args(self): 128 emu_args = [ 129 (self.max_instr, "max-instr"), 130 (self.diff, "diff"), 131 (self.seed, "seed") 132 ] 133 args = filter(lambda arg: arg[0] is not None, emu_args) 134 return args 135 136 def show(self): 137 print("Extra environment variables:") 138 env = self.get_env_variables() 139 for env_name in env: 140 print(f"{env_name}: {env[env_name]}") 141 print() 142 print("Chisel arguments:") 143 print(" ".join(self.get_chisel_args())) 144 print() 145 print("Makefile arguments:") 146 for val, name in self.get_makefile_args(): 147 print(f"{name}={val}") 148 print() 149 print("emu arguments:") 150 for val, name in self.get_emu_args(): 151 print(f"--{name} {val}") 152 print() 153 154 def __extract_path(self, path, env=None, default=None): 155 if path is None and env is not None: 156 path = os.getenv(env) 157 if path is None and default is not None: 158 path = default 159 path = os.path.realpath(path) 160 return path 161 162 def set_noop_home(self, path): 163 self.noop_home = path 164 165 def set_nemu_home(self, path): 166 self.nemu_home = path 167 168 def set_am_home(self, path): 169 self.am_home = path 170 171 def set_dramsim3_home(self, path): 172 self.dramsim3_home = path 173 174 def set_rvtest_home(self, path): 175 self.rvtest_home = path 176 177 def set_wave_home(self, path): 178 print(f"set wave home to {path}") 179 self.wave_home = path 180 181# XiangShan environment 182class XiangShan(object): 183 def __init__(self, args): 184 self.args = XSArgs(args) 185 self.timeout = args.timeout 186 187 def show(self): 188 self.args.show() 189 190 def make_clean(self): 191 print("Clean up CI workspace") 192 self.show() 193 return_code = self.__exec_cmd(f'make -C $NOOP_HOME clean') 194 return return_code 195 196 def generate_verilog(self): 197 print("Generating XiangShan verilog with the following configurations:") 198 self.show() 199 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 200 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 201 return_code = self.__exec_cmd(f'make -C $NOOP_HOME verilog SIM_ARGS="{sim_args}" {make_args}') 202 return return_code 203 204 def build_emu(self): 205 print("Building XiangShan emu with the following configurations:") 206 self.show() 207 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 208 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 209 return_code = self.__exec_cmd(f'make -C $NOOP_HOME emu -j200 SIM_ARGS="{sim_args}" {make_args}') 210 return return_code 211 212 def run_emu(self, workload): 213 print("Running XiangShan emu with the following configurations:") 214 self.show() 215 emu_args = " ".join(map(lambda arg: f"--{arg[1]} {arg[0]}", self.args.get_emu_args())) 216 print("workload:", workload) 217 numa_args = "" 218 if self.args.numa: 219 numa_info = get_free_cores(self.args.threads) 220 numa_args = f"numactl -m {numa_info[0]} -C {numa_info[1]}-{numa_info[2]}" 221 fork_args = "--enable-fork" if self.args.fork else "" 222 diff_args = "--no-diff" if self.args.disable_diff else "" 223 return_code = self.__exec_cmd(f'{numa_args} $NOOP_HOME/build/emu -i {workload} {emu_args} {fork_args} {diff_args}') 224 return return_code 225 226 def run(self, args): 227 if args.ci is not None: 228 return self.run_ci(args.ci) 229 actions = [ 230 (args.generate, lambda _ : self.generate_verilog()), 231 (args.build, lambda _ : self.build_emu()), 232 (args.workload, lambda args: self.run_emu(args.workload)), 233 (args.clean, lambda _ : self.make_clean()) 234 ] 235 valid_actions = map(lambda act: act[1], filter(lambda act: act[0], actions)) 236 for i, action in enumerate(valid_actions): 237 print(f"Action {i}:") 238 ret = action(args) 239 if ret: 240 return ret 241 return 0 242 243 def __exec_cmd(self, cmd): 244 env = dict(os.environ) 245 env.update(self.args.get_env_variables()) 246 print("subprocess call cmd:", cmd) 247 start = time.time() 248 proc = subprocess.Popen(cmd, shell=True, env=env, preexec_fn=os.setsid) 249 try: 250 return_code = proc.wait(self.timeout) 251 end = time.time() 252 print(f"Elapsed time: {end - start} seconds") 253 return return_code 254 except (KeyboardInterrupt, subprocess.TimeoutExpired): 255 os.killpg(os.getpgid(proc.pid), signal.SIGINT) 256 print(f"KeyboardInterrupt or TimeoutExpired.") 257 return 0 258 259 def __get_ci_cputest(self, name=None): 260 base_dir = os.path.join(self.args.am_home, "tests/cputest/build") 261 cputest = os.listdir(base_dir) 262 cputest = filter(lambda x: x.endswith(".bin"), cputest) 263 cputest = map(lambda x: os.path.join(base_dir, x), cputest) 264 return cputest 265 266 def __get_ci_rvtest(self, name=None): 267 base_dir = os.path.join(self.args.rvtest_home, "isa/build") 268 riscv_tests = os.listdir(base_dir) 269 riscv_tests = filter(lambda x: x.endswith(".bin"), riscv_tests) 270 all_rv_tests = ["rv64ui", "rv64um", "rv64ua", "rv64uf", "rv64ud"] 271 riscv_tests = filter(lambda x: x[:6] in all_rv_tests, riscv_tests) 272 riscv_tests = map(lambda x: os.path.join(base_dir, x), riscv_tests) 273 return riscv_tests 274 275 def __get_ci_misc(self, name=None): 276 base_dir = "/nfs/home/share/ci-workloads" 277 workloads = [ 278 "bitmanip/bitMisc.bin", 279 "crypto/crypto-riscv64-noop.bin", 280 "coremark_rv64gc_o2/coremark-riscv64-xs.bin", 281 "coremark_rv64gc_o3/coremark-riscv64-xs.bin", 282 "coremark_rv64gcb_o3/coremark-riscv64-xs.bin", 283 "ext_intr/amtest-riscv64-xs.bin", 284 "cache-alias/aliastest-riscv64-xs.bin", 285 "Svinval/rv64mi-p-svinval.bin", 286 "pmp/pmp.riscv.bin", 287 "asid/asid.bin", 288 "isa_misc/xret_clear_mprv.bin", 289 "isa_misc/satp_ppn.bin", 290 "cache-management/softprefetchtest-riscv64-xs.bin" 291 ] 292 misc_tests = map(lambda x: os.path.join(base_dir, x), workloads) 293 return misc_tests 294 295 def __get_ci_mc(self, name=None): 296 base_dir = "/nfs/home/share/ci-workloads" 297 workloads = [ 298 "dualcoretest/ldvio-riscv64-xs.bin" 299 ] 300 mc_tests = map(lambda x: os.path.join(base_dir, x), workloads) 301 return mc_tests 302 303 def __get_ci_nodiff(self, name=None): 304 base_dir = "/nfs/home/share/ci-workloads" 305 workloads = [ 306 "cache-management/cacheoptest-riscv64-xs.bin" 307 ] 308 tests = map(lambda x: os.path.join(base_dir, x), workloads) 309 return tests 310 311 def __am_apps_path(self, bench): 312 filename = f"{bench}-riscv64-noop.bin" 313 return [os.path.join(self.args.am_home, "apps", bench, "build", filename)] 314 315 def __get_ci_workloads(self, name): 316 workloads = { 317 "linux-hello": "bbl.bin", 318 "linux-hello-smp": "bbl.bin", 319 "povray": "_700480000000_.gz", 320 "mcf": "_17520000000_.gz", 321 "xalancbmk": "_266100000000_.gz", 322 "gcc": "_39720000000_.gz", 323 "namd": "_434640000000_.gz", 324 "milc": "_103620000000_.gz", 325 "lbm": "_140840000000_.gz", 326 "gromacs": "_275480000000_.gz", 327 "wrf": "_1916220000000_.gz", 328 "astar": "_122060000000_.gz" 329 } 330 if name in workloads: 331 return [os.path.join("/nfs/home/share/ci-workloads", name, workloads[name])] 332 # select a random SPEC checkpoint 333 assert(name == "random") 334 all_cpt = [ 335 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o2_20m/take_cpt", 336 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o3_20m/take_cpt", 337 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_20m/take_cpt", 338 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_50m/take_cpt", 339 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o2_20m/take_cpt", 340 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o3_20m/take_cpt", 341 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gc_o2_50m/take_cpt", 342 "/nfs-nvme/home/share/checkpoints_profiles/spec17_speed_rv64gcb_o3_20m/take_cpt" 343 ] 344 all_json = [ 345 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o2_20m/json/simpoint_summary.json", 346 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o3_20m/simpoint_summary.json", 347 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_20m/simpoint_summary.json", 348 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_50m/simpoint_summary.json", 349 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o2_20m/simpoint_summary.json", 350 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o3_20m/simpoint_summary.json", 351 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gc_o2_50m/simpoint_summary.json", 352 "/nfs-nvme/home/share/checkpoints_profiles/spec17_speed_rv64gcb_o3_20m/simpoint_summary.json" 353 ] 354 assert(len(all_cpt) == len(all_json)) 355 cpt_path, json_path = random.choice(list(zip(all_cpt, all_json))) 356 all_gcpt = load_all_gcpt(cpt_path, json_path) 357 return [random.choice(all_gcpt)] 358 359 def run_ci(self, test): 360 all_tests = { 361 "cputest": self.__get_ci_cputest, 362 "riscv-tests": self.__get_ci_rvtest, 363 "misc-tests": self.__get_ci_misc, 364 "mc-tests": self.__get_ci_mc, 365 "nodiff-tests": self.__get_ci_nodiff, 366 "microbench": self.__am_apps_path, 367 "coremark": self.__am_apps_path 368 } 369 for target in all_tests.get(test, self.__get_ci_workloads)(test): 370 print(target) 371 ret = self.run_emu(target) 372 if ret: 373 if self.args.default_wave_home != self.args.wave_home: 374 print("copy wave file to " + self.args.wave_home) 375 self.__exec_cmd(f"cp $NOOP_HOME/build/*.vcd $WAVE_HOME") 376 self.__exec_cmd(f"cp $NOOP_HOME/build/emu $WAVE_HOME") 377 self.__exec_cmd(f"cp $NOOP_HOME/build/SimTop.v $WAVE_HOME") 378 return ret 379 return 0 380 381def get_free_cores(n): 382 while True: 383 # To avoid potential conflicts, we allow CI to use SMT. 384 num_logical_core = psutil.cpu_count(logical=False) 385 core_usage = psutil.cpu_percent(interval=1, percpu=True) 386 num_window = num_logical_core // n 387 for i in range(num_window): 388 window_usage = core_usage[i * n : i * n + n] 389 if sum(window_usage) < 0.3 * n and True not in map(lambda x: x > 0.5, window_usage): 390 return (((i * n) % 128)// 64, i * n, i * n + n - 1) 391 print(f"No free {n} cores found. CPU usage: {core_usage}\n") 392 393if __name__ == "__main__": 394 parser = argparse.ArgumentParser(description='Python wrapper for XiangShan') 395 parser.add_argument('workload', nargs='?', type=str, default="", 396 help='input workload file in binary format') 397 # actions 398 parser.add_argument('--build', action='store_true', help='build XS emu') 399 parser.add_argument('--generate', action='store_true', help='generate XS verilog') 400 parser.add_argument('--ci', nargs='?', type=str, const="", help='run CI tests') 401 parser.add_argument('--clean', action='store_true', help='clean up XiangShan CI workspace') 402 parser.add_argument('--timeout', nargs='?', type=int, default=None, help='timeout (in seconds)') 403 # environment variables 404 parser.add_argument('--nemu', nargs='?', type=str, help='path to nemu') 405 parser.add_argument('--am', nargs='?', type=str, help='path to nexus-am') 406 parser.add_argument('--dramsim3', nargs='?', type=str, help='path to dramsim3') 407 parser.add_argument('--rvtest', nargs='?', type=str, help='path to riscv-tests') 408 parser.add_argument('--wave-dump', nargs='?', type=str , help='path to dump wave') 409 # chisel arguments 410 parser.add_argument('--enable-log', action='store_true', help='enable log') 411 parser.add_argument('--num-cores', type=int, help='number of cores') 412 # makefile arguments 413 parser.add_argument('--release', action='store_true', help='enable release') 414 parser.add_argument('--spike', action='store_true', help='enable spike diff') 415 parser.add_argument('--with-dramsim3', action='store_true', help='enable dramsim3') 416 parser.add_argument('--threads', nargs='?', type=int, help='number of emu threads') 417 parser.add_argument('--trace', action='store_true', help='enable waveform') 418 parser.add_argument('--config', nargs='?', type=str, help='config') 419 # emu arguments 420 parser.add_argument('--numa', action='store_true', help='use numactl') 421 parser.add_argument('--diff', nargs='?', default="./ready-to-run/riscv64-nemu-interpreter-so", type=str, help='nemu so') 422 parser.add_argument('--max-instr', nargs='?', type=int, help='max instr') 423 parser.add_argument('--disable-fork', action='store_true', help='disable lightSSS') 424 parser.add_argument('--no-diff', action='store_true', help='disable difftest') 425 426 args = parser.parse_args() 427 428 xs = XiangShan(args) 429 ret = xs.run(args) 430 431 sys.exit(ret) 432