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 and not args.trace_fst else None 79 self.trace_fst = "fst" if args.trace_fst else None 80 self.config = args.config 81 # emu arguments 82 self.max_instr = args.max_instr 83 self.ram_size = args.ram_size 84 self.seed = random.randint(0, 9999) 85 self.numa = args.numa 86 self.diff = args.diff 87 if args.spike and "nemu" in args.diff: 88 self.diff = self.diff.replace("nemu-interpreter", "spike") 89 self.fork = not args.disable_fork 90 self.disable_diff = args.no_diff 91 self.disable_db = args.no_db 92 # wave dump path 93 if args.wave_dump is not None: 94 self.set_wave_home(args.wave_dump) 95 else: 96 self.set_wave_home(self.default_wave_home) 97 98 def get_env_variables(self): 99 all_env = { 100 "NOOP_HOME" : self.noop_home, 101 "NEMU_HOME" : self.nemu_home, 102 "WAVE_HOME" : self.wave_home, 103 "AM_HOME" : self.am_home, 104 "DRAMSIM3_HOME": self.dramsim3_home, 105 "MODULEPATH": "/usr/share/Modules/modulefiles:/etc/modulefiles" 106 } 107 return all_env 108 109 def get_chisel_args(self, prefix=None): 110 chisel_args = [ 111 (self.enable_log, "enable-log") 112 ] 113 args = map(lambda x: x[1], filter(lambda arg: arg[0], chisel_args)) 114 if prefix is not None: 115 args = map(lambda x: prefix + x, args) 116 return args 117 118 def get_makefile_args(self): 119 makefile_args = [ 120 (self.threads, "EMU_THREADS"), 121 (self.with_dramsim3, "WITH_DRAMSIM3"), 122 (self.is_release, "RELEASE"), 123 (self.is_spike, "REF"), 124 (self.trace, "EMU_TRACE"), 125 (self.trace_fst, "EMU_TRACE"), 126 (self.config, "CONFIG"), 127 (self.num_cores, "NUM_CORES") 128 ] 129 args = filter(lambda arg: arg[0] is not None, makefile_args) 130 return args 131 132 def get_emu_args(self): 133 emu_args = [ 134 (self.max_instr, "max-instr"), 135 (self.diff, "diff"), 136 (self.seed, "seed"), 137 (self.ram_size, "ram-size"), 138 ] 139 args = filter(lambda arg: arg[0] is not None, emu_args) 140 return args 141 142 def show(self): 143 print("Extra environment variables:") 144 env = self.get_env_variables() 145 for env_name in env: 146 print(f"{env_name}: {env[env_name]}") 147 print() 148 print("Chisel arguments:") 149 print(" ".join(self.get_chisel_args())) 150 print() 151 print("Makefile arguments:") 152 for val, name in self.get_makefile_args(): 153 print(f"{name}={val}") 154 print() 155 print("emu arguments:") 156 for val, name in self.get_emu_args(): 157 print(f"--{name} {val}") 158 print() 159 160 def __extract_path(self, path, env=None, default=None): 161 if path is None and env is not None: 162 path = os.getenv(env) 163 if path is None and default is not None: 164 path = default 165 path = os.path.realpath(path) 166 return path 167 168 def set_noop_home(self, path): 169 self.noop_home = path 170 171 def set_nemu_home(self, path): 172 self.nemu_home = path 173 174 def set_am_home(self, path): 175 self.am_home = path 176 177 def set_dramsim3_home(self, path): 178 self.dramsim3_home = path 179 180 def set_rvtest_home(self, path): 181 self.rvtest_home = path 182 183 def set_wave_home(self, path): 184 print(f"set wave home to {path}") 185 self.wave_home = path 186 187# XiangShan environment 188class XiangShan(object): 189 def __init__(self, args): 190 self.args = XSArgs(args) 191 self.timeout = args.timeout 192 193 def show(self): 194 self.args.show() 195 196 def make_clean(self): 197 print("Clean up CI workspace") 198 self.show() 199 return_code = self.__exec_cmd(f'make -C $NOOP_HOME clean') 200 return return_code 201 202 def generate_verilog(self): 203 print("Generating XiangShan verilog with the following configurations:") 204 self.show() 205 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 206 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 207 return_code = self.__exec_cmd(f'make -C $NOOP_HOME verilog SIM_ARGS="{sim_args}" {make_args}') 208 return return_code 209 210 def generate_sim_verilog(self): 211 print("Generating XiangShan sim-verilog with the following configurations:") 212 self.show() 213 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 214 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 215 return_code = self.__exec_cmd(f'make -C $NOOP_HOME sim-verilog SIM_ARGS="{sim_args}" {make_args}') 216 return return_code 217 218 def build_emu(self): 219 print("Building XiangShan emu with the following configurations:") 220 self.show() 221 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 222 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 223 return_code = self.__exec_cmd(f'make -C $NOOP_HOME emu -j200 SIM_ARGS="{sim_args}" {make_args}') 224 return return_code 225 226 def build_simv(self): 227 print("Building XiangShan simv with the following configurations") 228 self.show() 229 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 230 # TODO: make the following commands grouped as unseen scripts 231 return_code = self.__exec_cmd(f'\ 232 eval `/usr/bin/modulecmd zsh load license`;\ 233 eval `/usr/bin/modulecmd zsh load synopsys/vcs/Q-2020.03-SP2`;\ 234 eval `/usr/bin/modulecmd zsh load synopsys/verdi/S-2021.09-SP1`;\ 235 VERDI_HOME=/nfs/tools/synopsys/verdi/S-2021.09-SP1 \ 236 make -C $NOOP_HOME simv {make_args} CONSIDER_FSDB=1') # set CONSIDER_FSDB for compatibility 237 return return_code 238 239 def run_emu(self, workload): 240 print("Running XiangShan emu with the following configurations:") 241 self.show() 242 emu_args = " ".join(map(lambda arg: f"--{arg[1]} {arg[0]}", self.args.get_emu_args())) 243 print("workload:", workload) 244 numa_args = "" 245 if self.args.numa: 246 numa_info = get_free_cores(self.args.threads) 247 numa_args = f"numactl -m {numa_info[0]} -C {numa_info[1]}-{numa_info[2]}" 248 fork_args = "--enable-fork" if self.args.fork else "" 249 diff_args = "--no-diff" if self.args.disable_diff else "" 250 chiseldb_args = "--dump-db" if not self.args.disable_db else "" 251 return_code = self.__exec_cmd(f'{numa_args} $NOOP_HOME/build/emu -i {workload} {emu_args} {fork_args} {diff_args} {chiseldb_args}') 252 return return_code 253 254 def run_simv(self, workload): 255 print("Running XiangShan simv with the following configurations:") 256 self.show() 257 diff_args = "$NOOP_HOME/"+ args.diff 258 return_code = self.__exec_cmd(f'$NOOP_HOME/difftest/simv +workload={workload} +diff={diff_args}') 259 return return_code 260 261 def run(self, args): 262 if args.ci is not None: 263 return self.run_ci(args.ci) 264 if args.ci_vcs is not None: 265 return self.run_ci_vcs(args.ci_vcs) 266 actions = [ 267 (args.generate, lambda _ : self.generate_verilog()), 268 (args.vcs_gen, lambda _ : self.generate_sim_verilog()), 269 (args.build, lambda _ : self.build_emu()), 270 (args.vcs_build, lambda _ : self.build_simv()), 271 (args.workload, lambda args: self.run_emu(args.workload)), 272 (args.clean, lambda _ : self.make_clean()) 273 ] 274 valid_actions = map(lambda act: act[1], filter(lambda act: act[0], actions)) 275 for i, action in enumerate(valid_actions): 276 print(f"Action {i}:") 277 ret = action(args) 278 if ret: 279 return ret 280 return 0 281 282 def __exec_cmd(self, cmd): 283 env = dict(os.environ) 284 env.update(self.args.get_env_variables()) 285 print("subprocess call cmd:", cmd) 286 start = time.time() 287 proc = subprocess.Popen(cmd, shell=True, env=env, preexec_fn=os.setsid) 288 try: 289 return_code = proc.wait(self.timeout) 290 end = time.time() 291 print(f"Elapsed time: {end - start} seconds") 292 return return_code 293 except (KeyboardInterrupt, subprocess.TimeoutExpired): 294 os.killpg(os.getpgid(proc.pid), signal.SIGINT) 295 print(f"KeyboardInterrupt or TimeoutExpired.") 296 return 0 297 298 def __get_ci_cputest(self, name=None): 299 base_dir = os.path.join(self.args.am_home, "tests/cputest/build") 300 cputest = os.listdir(base_dir) 301 cputest = filter(lambda x: x.endswith(".bin"), cputest) 302 cputest = map(lambda x: os.path.join(base_dir, x), cputest) 303 return cputest 304 305 def __get_ci_rvtest(self, name=None): 306 base_dir = os.path.join(self.args.rvtest_home, "isa/build") 307 riscv_tests = os.listdir(base_dir) 308 riscv_tests = filter(lambda x: x.endswith(".bin"), riscv_tests) 309 all_rv_tests = ["rv64ui", "rv64um", "rv64ua", "rv64uf", "rv64ud"] 310 riscv_tests = filter(lambda x: x[:6] in all_rv_tests, riscv_tests) 311 riscv_tests = map(lambda x: os.path.join(base_dir, x), riscv_tests) 312 return riscv_tests 313 314 def __get_ci_misc(self, name=None): 315 base_dir = "/nfs/home/share/ci-workloads" 316 workloads = [ 317 "bitmanip/bitMisc.bin", 318 "crypto/crypto-riscv64-noop.bin", 319 "coremark_rv64gc_o2/coremark-riscv64-xs.bin", 320 "coremark_rv64gc_o3/coremark-riscv64-xs.bin", 321 "coremark_rv64gcb_o3/coremark-riscv64-xs.bin", 322 "ext_intr/amtest-riscv64-xs.bin", 323 "cache-alias/aliastest-riscv64-xs.bin", 324 "Svinval/rv64mi-p-svinval.bin", 325 "pmp/pmp.riscv.bin", 326 "pmp/pmp-am/amtest-riscv64-xs.bin", 327 "pmp/hugepage-pmp-atom/amtest-riscv64-xs.bin", 328 "asid/asid.bin", 329 "isa_misc/xret_clear_mprv.bin", 330 "isa_misc/satp_ppn.bin", 331 "cache-management/softprefetchtest-riscv64-xs.bin" 332 ] 333 misc_tests = map(lambda x: os.path.join(base_dir, x), workloads) 334 return misc_tests 335 336 def __get_ci_mc(self, name=None): 337 base_dir = "/nfs/home/share/ci-workloads" 338 workloads = [ 339 "dualcoretest/ldvio-riscv64-xs.bin" 340 ] 341 mc_tests = map(lambda x: os.path.join(base_dir, x), workloads) 342 return mc_tests 343 344 def __get_ci_nodiff(self, name=None): 345 base_dir = "/nfs/home/share/ci-workloads" 346 workloads = [ 347 "cache-management/cacheoptest-riscv64-xs.bin" 348 ] 349 tests = map(lambda x: os.path.join(base_dir, x), workloads) 350 return tests 351 352 def __am_apps_path(self, bench): 353 filename = f"{bench}-riscv64-noop.bin" 354 return [os.path.join(self.args.am_home, "apps", bench, "build", filename)] 355 356 def __get_ci_workloads(self, name): 357 workloads = { 358 "linux-hello": "bbl.bin", 359 "linux-hello-smp": "bbl.bin", 360 "povray": "_700480000000_.gz", 361 "mcf": "_17520000000_.gz", 362 "xalancbmk": "_266100000000_.gz", 363 "gcc": "_39720000000_.gz", 364 "namd": "_434640000000_.gz", 365 "milc": "_103620000000_.gz", 366 "lbm": "_140840000000_.gz", 367 "gromacs": "_275480000000_.gz", 368 "wrf": "_1916220000000_.gz", 369 "astar": "_122060000000_.gz" 370 } 371 if name in workloads: 372 return [os.path.join("/nfs/home/share/ci-workloads", name, workloads[name])] 373 # select a random SPEC checkpoint 374 assert(name == "random") 375 all_cpt = [ 376 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o2_20m/take_cpt", 377 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o3_20m/take_cpt", 378 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_20m/take_cpt", 379 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_50m/take_cpt", 380 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o2_20m/take_cpt", 381 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o3_20m/take_cpt", 382 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gc_o2_50m/take_cpt", 383 "/nfs-nvme/home/share/checkpoints_profiles/spec17_speed_rv64gcb_o3_20m/take_cpt" 384 ] 385 all_json = [ 386 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o2_20m/json/simpoint_summary.json", 387 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gcb_o3_20m/simpoint_summary.json", 388 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_20m/simpoint_summary.json", 389 "/nfs-nvme/home/share/checkpoints_profiles/spec06_rv64gc_o2_50m/simpoint_summary.json", 390 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o2_20m/simpoint_summary.json", 391 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gcb_o3_20m/simpoint_summary.json", 392 "/nfs-nvme/home/share/checkpoints_profiles/spec17_rv64gc_o2_50m/simpoint_summary.json", 393 "/nfs-nvme/home/share/checkpoints_profiles/spec17_speed_rv64gcb_o3_20m/simpoint_summary.json" 394 ] 395 assert(len(all_cpt) == len(all_json)) 396 cpt_path, json_path = random.choice(list(zip(all_cpt, all_json))) 397 all_gcpt = load_all_gcpt(cpt_path, json_path) 398 return [random.choice(all_gcpt)] 399 400 def run_ci(self, test): 401 all_tests = { 402 "cputest": self.__get_ci_cputest, 403 "riscv-tests": self.__get_ci_rvtest, 404 "misc-tests": self.__get_ci_misc, 405 "mc-tests": self.__get_ci_mc, 406 "nodiff-tests": self.__get_ci_nodiff, 407 "microbench": self.__am_apps_path, 408 "coremark": self.__am_apps_path 409 } 410 for target in all_tests.get(test, self.__get_ci_workloads)(test): 411 print(target) 412 ret = self.run_emu(target) 413 if ret: 414 if self.args.default_wave_home != self.args.wave_home: 415 print("copy wave file to " + self.args.wave_home) 416 self.__exec_cmd(f"cp $NOOP_HOME/build/*.vcd $WAVE_HOME") 417 self.__exec_cmd(f"cp $NOOP_HOME/build/emu $WAVE_HOME") 418 self.__exec_cmd(f"cp $NOOP_HOME/build/SimTop.v $WAVE_HOME") 419 self.__exec_cmd(f"cp $NOOP_HOME/build/*.db $WAVE_HOME") 420 return ret 421 return 0 422 423 def run_ci_vcs(self, test): 424 all_tests = { 425 "cputest": self.__get_ci_cputest, 426 "riscv-tests": self.__get_ci_rvtest, 427 "misc-tests": self.__get_ci_misc, 428 "mc-tests": self.__get_ci_mc, 429 "nodiff-tests": self.__get_ci_nodiff, 430 "microbench": self.__am_apps_path, 431 "coremark": self.__am_apps_path 432 } 433 for target in all_tests.get(test, self.__get_ci_workloads)(test): 434 print(target) 435 ret = self.run_simv(target) 436 if ret: 437 if self.args.default_wave_home != self.args.wave_home: 438 print("copy wave file to " + self.args.wave_home) 439 self.__exec_cmd(f"cp $NOOP_HOME/build/*.vcd $WAVE_HOME") 440 self.__exec_cmd(f"cp $NOOP_HOME/build/emu $WAVE_HOME") 441 self.__exec_cmd(f"cp $NOOP_HOME/build/SimTop.v $WAVE_HOME") 442 self.__exec_cmd(f"cp $NOOP_HOME/build/*.db $WAVE_HOME") 443 return ret 444 return 0 445 446def get_free_cores(n): 447 while True: 448 # To avoid potential conflicts, we allow CI to use SMT. 449 num_logical_core = psutil.cpu_count(logical=False) 450 core_usage = psutil.cpu_percent(interval=1, percpu=True) 451 num_window = num_logical_core // n 452 for i in range(num_window): 453 window_usage = core_usage[i * n : i * n + n] 454 if sum(window_usage) < 30 * n and True not in map(lambda x: x > 90, window_usage): 455 return (((i * n) % 128)// 64, i * n, i * n + n - 1) 456 print(f"No free {n} cores found. CPU usage: {core_usage}\n") 457 458if __name__ == "__main__": 459 parser = argparse.ArgumentParser(description='Python wrapper for XiangShan') 460 parser.add_argument('workload', nargs='?', type=str, default="", 461 help='input workload file in binary format') 462 # actions 463 parser.add_argument('--build', action='store_true', help='build XS emu') 464 parser.add_argument('--generate', action='store_true', help='generate XS verilog') 465 parser.add_argument('--vcs-gen', action='store_true', help='generate XS sim verilog for vcs') 466 parser.add_argument('--vcs-build', action='store_true', help='build XS simv') 467 parser.add_argument('--ci', nargs='?', type=str, const="", help='run CI tests') 468 parser.add_argument('--ci-vcs', nargs='?', type=str, const="", help='run CI tests on simv') 469 parser.add_argument('--clean', action='store_true', help='clean up XiangShan CI workspace') 470 parser.add_argument('--timeout', nargs='?', type=int, default=None, help='timeout (in seconds)') 471 # environment variables 472 parser.add_argument('--nemu', nargs='?', type=str, help='path to nemu') 473 parser.add_argument('--am', nargs='?', type=str, help='path to nexus-am') 474 parser.add_argument('--dramsim3', nargs='?', type=str, help='path to dramsim3') 475 parser.add_argument('--rvtest', nargs='?', type=str, help='path to riscv-tests') 476 parser.add_argument('--wave-dump', nargs='?', type=str , help='path to dump wave') 477 # chisel arguments 478 parser.add_argument('--enable-log', action='store_true', help='enable log') 479 parser.add_argument('--num-cores', type=int, help='number of cores') 480 # makefile arguments 481 parser.add_argument('--release', action='store_true', help='enable release') 482 parser.add_argument('--spike', action='store_true', help='enable spike diff') 483 parser.add_argument('--with-dramsim3', action='store_true', help='enable dramsim3') 484 parser.add_argument('--threads', nargs='?', type=int, help='number of emu threads') 485 parser.add_argument('--trace', action='store_true', help='enable vcd waveform') 486 parser.add_argument('--trace-fst', action='store_true', help='enable fst waveform') 487 parser.add_argument('--config', nargs='?', type=str, help='config') 488 # emu arguments 489 parser.add_argument('--numa', action='store_true', help='use numactl') 490 parser.add_argument('--diff', nargs='?', default="./ready-to-run/riscv64-nemu-interpreter-so", type=str, help='nemu so') 491 parser.add_argument('--max-instr', nargs='?', type=int, help='max instr') 492 parser.add_argument('--disable-fork', action='store_true', help='disable lightSSS') 493 parser.add_argument('--no-diff', action='store_true', help='disable difftest') 494 parser.add_argument('--ram-size', nargs='?', type=str, help='manually set simulation memory size (8GB by default)') 495 parser.add_argument('--no-db', action='store_true', help='disable chiseldb dump') 496 497 args = parser.parse_args() 498 499 xs = XiangShan(args) 500 ret = xs.run(args) 501 502 sys.exit(ret) 503