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