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