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