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 os 21import random 22import subprocess 23import sys 24import time 25 26import psutil 27 28 29class XSArgs(object): 30 script_path = os.path.realpath(__file__) 31 # default path to the repositories 32 noop_home = os.path.join(os.path.dirname(script_path), "..") 33 nemu_home = os.path.join(noop_home, "../NEMU") 34 am_home = os.path.join(noop_home, "../nexus-am") 35 dramsim3_home = os.path.join(noop_home, "../DRAMsim3") 36 rvtest_home = os.path.join(noop_home, "../riscv-tests") 37 default_wave_home = os.path.join(noop_home, "build") 38 wave_home = default_wave_home 39 40 def __init__(self, args): 41 # all path environment variables that should be set 42 all_path = [ 43 # (python argument, environment variable, default, target function) 44 (None, "NOOP_HOME", self.noop_home, self.set_noop_home), 45 (args.nemu, "NEMU_HOME", self.nemu_home, self.set_nemu_home), 46 (args.am, "AM_HOME", self.am_home, self.set_am_home), 47 (args.dramsim3, "DRAMSIM3_HOME", self.dramsim3_home, self.set_dramsim3_home), 48 (args.rvtest, "RVTEST_HOME", self.rvtest_home, self.set_rvtest_home), 49 ] 50 for (arg_in, env, default, set_func) in all_path: 51 set_func(self.__extract_path(arg_in, env, default)) 52 # Chisel arguments 53 self.enable_log = args.enable_log 54 self.num_cores = args.num_cores 55 # Makefile arguments 56 self.threads = args.threads 57 self.with_dramsim3 = 1 if args.with_dramsim3 else None 58 self.is_release = 1 if args.release else None 59 self.trace = 1 if args.trace or not args.disable_fork else None 60 self.config = args.config 61 # emu arguments 62 self.max_instr = args.max_instr 63 self.seed = random.randint(0, 9999) 64 self.numa = args.numa 65 self.diff = args.diff 66 self.fork = not args.disable_fork 67 # wave dump path 68 if args.wave_dump is not None: 69 self.set_wave_home(args.wave_dump) 70 else: 71 self.set_wave_home(self.default_wave_home) 72 73 def get_env_variables(self): 74 all_env = { 75 "NOOP_HOME" : self.noop_home, 76 "NEMU_HOME" : self.nemu_home, 77 "WAVE_HOME" : self.wave_home, 78 "AM_HOME" : self.am_home, 79 "DRAMSIM3_HOME": self.dramsim3_home 80 } 81 return all_env 82 83 def get_chisel_args(self, prefix=None): 84 chisel_args = [ 85 (self.enable_log, "enable-log") 86 ] 87 args = map(lambda x: x[1], filter(lambda arg: arg[0], chisel_args)) 88 if prefix is not None: 89 args = map(lambda x: prefix + x, args) 90 return args 91 92 def get_makefile_args(self): 93 makefile_args = [ 94 (self.threads, "EMU_THREADS"), 95 (self.with_dramsim3, "WITH_DRAMSIM3"), 96 (self.is_release, "RELEASE"), 97 (self.trace, "EMU_TRACE"), 98 (self.config, "CONFIG"), 99 (self.num_cores, "NUM_CORES") 100 ] 101 args = filter(lambda arg: arg[0] is not None, makefile_args) 102 return args 103 104 def get_emu_args(self): 105 emu_args = [ 106 (self.max_instr, "max-instr"), 107 (self.diff, "diff"), 108 (self.seed, "seed") 109 ] 110 args = filter(lambda arg: arg[0] is not None, emu_args) 111 return args 112 113 def show(self): 114 print("Extra environment variables:") 115 env = self.get_env_variables() 116 for env_name in env: 117 print(f"{env_name}: {env[env_name]}") 118 print() 119 print("Chisel arguments:") 120 print(" ".join(self.get_chisel_args())) 121 print() 122 print("Makefile arguments:") 123 for val, name in self.get_makefile_args(): 124 print(f"{name}={val}") 125 print() 126 print("emu arguments:") 127 for val, name in self.get_emu_args(): 128 print(f"--{name} {val}") 129 print() 130 131 def __extract_path(self, path, env=None, default=None): 132 if path is None and env is not None: 133 path = os.getenv(env) 134 if path is None and default is not None: 135 path = default 136 path = os.path.realpath(path) 137 return path 138 139 def set_noop_home(self, path): 140 self.noop_home = path 141 142 def set_nemu_home(self, path): 143 self.nemu_home = path 144 145 def set_am_home(self, path): 146 self.am_home = path 147 148 def set_dramsim3_home(self, path): 149 self.dramsim3_home = path 150 151 def set_rvtest_home(self, path): 152 self.rvtest_home = path 153 154 def set_wave_home(self, path): 155 print(f"set wave home to {path}") 156 self.wave_home = path 157 158# XiangShan environment 159class XiangShan(object): 160 def __init__(self, args): 161 self.args = XSArgs(args) 162 163 def show(self): 164 self.args.show() 165 166 def generate_verilog(self): 167 print("Generating XiangShan verilog with the following configurations:") 168 self.show() 169 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 170 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 171 return_code = self.__exec_cmd(f'make -C $NOOP_HOME verilog SIM_ARGS="{sim_args}" {make_args}') 172 return return_code 173 174 def build_emu(self): 175 print("Building XiangShan emu with the following configurations:") 176 self.show() 177 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 178 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 179 return_code = self.__exec_cmd(f'make -C $NOOP_HOME emu -j200 SIM_ARGS="{sim_args}" {make_args}') 180 return return_code 181 182 def run_emu(self, workload): 183 print("Running XiangShan emu with the following configurations:") 184 self.show() 185 emu_args = " ".join(map(lambda arg: f"--{arg[1]} {arg[0]}", self.args.get_emu_args())) 186 print("workload:", workload) 187 numa_info = get_free_cores(self.args.threads) 188 numa_args = f"numactl -m {numa_info[0]} -C {numa_info[1]}-{numa_info[2]}" if self.args.numa else "" 189 fork_args = "--enable-fork" if self.args.fork else "" 190 return_code = self.__exec_cmd(f'{numa_args} $NOOP_HOME/build/emu -i {workload} {emu_args} {fork_args}') 191 return return_code 192 193 def run(self, args): 194 if args.ci is not None: 195 return self.run_ci(args.ci) 196 actions = [ 197 (args.generate, lambda _ : self.generate_verilog()), 198 (args.build, lambda _ : self.build_emu()), 199 (args.workload, lambda args: self.run_emu(args.workload)) 200 ] 201 valid_actions = map(lambda act: act[1], filter(lambda act: act[0], actions)) 202 for i, action in enumerate(valid_actions): 203 print(f"Action {i}:") 204 ret = action(args) 205 if ret: 206 return ret 207 return 0 208 209 def __exec_cmd(self, cmd): 210 env = dict(os.environ) 211 env.update(self.args.get_env_variables()) 212 print("subprocess call cmd:", cmd) 213 start = time.time() 214 return_code = subprocess.call(cmd, shell=True, env=env) 215 end = time.time() 216 print(f"Elapsed time: {end - start} seconds") 217 return return_code 218 219 def __get_ci_cputest(self, name=None): 220 base_dir = os.path.join(self.args.am_home, "tests/cputest/build") 221 cputest = os.listdir(base_dir) 222 cputest = filter(lambda x: x.endswith(".bin"), cputest) 223 cputest = map(lambda x: os.path.join(base_dir, x), cputest) 224 return cputest 225 226 def __get_ci_rvtest(self, name=None): 227 base_dir = os.path.join(self.args.rvtest_home, "isa/build") 228 riscv_tests = os.listdir(base_dir) 229 riscv_tests = filter(lambda x: x.endswith(".bin"), riscv_tests) 230 all_rv_tests = ["rv64ui", "rv64um", "rv64ua", "rv64uf", "rv64ud"] 231 riscv_tests = filter(lambda x: x[:6] in all_rv_tests, riscv_tests) 232 riscv_tests = map(lambda x: os.path.join(base_dir, x), riscv_tests) 233 return riscv_tests 234 235 def __get_ci_misc(self, name=None): 236 base_dir = "/home/ci-runner/xsenv/workloads" 237 workloads = [ 238 "bitmanip/bitMisc.bin", 239 "crypto/crypto-riscv64-noop.bin", 240 "coremark_rv64gc_o2/coremark-riscv64-xs.bin", 241 "coremark_rv64gc_o3/coremark-riscv64-xs.bin", 242 "coremark_rv64gcb_o3/coremark-riscv64-xs.bin", 243 "ext_intr/amtest-riscv64-xs.bin", 244 "cache-alias/aliastest-riscv64-xs.bin", 245 "Svinval/rv64mi-p-svinval.bin", 246 "pmp/pmp.riscv.bin", 247 "asid/asid.bin", 248 "cache-management/softprefetch-riscv64-noop.bin" 249 ] 250 misc_tests = map(lambda x: os.path.join(base_dir, x), workloads) 251 return misc_tests 252 253 def __am_apps_path(self, bench): 254 filename = f"{bench}-riscv64-noop.bin" 255 return [os.path.join(self.args.am_home, "apps", bench, "build", filename)] 256 257 def __get_ci_workloads(self, name): 258 workloads = { 259 "linux-hello": "bbl.bin", 260 "povray": "_700480000000_.gz", 261 "mcf": "_17520000000_.gz", 262 "xalancbmk": "_266100000000_.gz", 263 "gcc": "_39720000000_.gz", 264 "namd": "_434640000000_.gz", 265 "milc": "_103620000000_.gz", 266 "lbm": "_140840000000_.gz", 267 "gromacs": "_275480000000_.gz", 268 "wrf": "_1916220000000_.gz", 269 "astar": "_122060000000_.gz" 270 } 271 return [os.path.join("/home/ci-runner/xsenv/workloads", name, workloads[name])] 272 273 def run_ci(self, test): 274 all_tests = { 275 "cputest": self.__get_ci_cputest, 276 "riscv-tests": self.__get_ci_rvtest, 277 "misc-tests": self.__get_ci_misc, 278 "microbench": self.__am_apps_path, 279 "coremark": self.__am_apps_path 280 } 281 for target in all_tests.get(test, self.__get_ci_workloads)(test): 282 print(target) 283 ret = self.run_emu(target) 284 if ret: 285 if self.args.default_wave_home != self.args.wave_home: 286 print("copy wave file to " + self.args.wave_home) 287 self.__exec_cmd(f"cp $NOOP_HOME/build/*.vcd $WAVE_HOME") 288 self.__exec_cmd(f"cp $NOOP_HOME/build/emu $WAVE_HOME") 289 self.__exec_cmd(f"cp $NOOP_HOME/build/SimTop.v $WAVE_HOME") 290 return ret 291 return 0 292 293def get_free_cores(n): 294 while True: 295 # To avoid potential conflicts, we allow CI to use SMT. 296 num_logical_core = psutil.cpu_count(logical=True) 297 core_usage = psutil.cpu_percent(interval=1, percpu=True) 298 num_window = num_logical_core // n 299 for i in range(num_window): 300 window_usage = core_usage[i * n : i * n + n] 301 if sum(window_usage) < 0.3 * n and True not in map(lambda x: x > 0.5, window_usage): 302 return (((i * n) % 128)// 64, i * n, i * n + n - 1) 303 print(f"No free {n} cores found. CPU usage: {core_usage}\n") 304 305if __name__ == "__main__": 306 parser = argparse.ArgumentParser(description='Python wrapper for XiangShan') 307 parser.add_argument('workload', nargs='?', type=str, default="", 308 help='input workload file in binary format') 309 # actions 310 parser.add_argument('--build', action='store_true', help='build XS emu') 311 parser.add_argument('--generate', action='store_true', help='generate XS verilog') 312 parser.add_argument('--ci', nargs='?', type=str, const="", help='run CI tests') 313 # environment variables 314 parser.add_argument('--nemu', nargs='?', type=str, help='path to nemu') 315 parser.add_argument('--am', nargs='?', type=str, help='path to nexus-am') 316 parser.add_argument('--dramsim3', nargs='?', type=str, help='path to dramsim3') 317 parser.add_argument('--rvtest', nargs='?', type=str, help='path to riscv-tests') 318 parser.add_argument('--wave-dump', nargs='?', type=str , help='path to dump wave') 319 # chisel arguments 320 parser.add_argument('--enable-log', action='store_true', help='enable log') 321 parser.add_argument('--num-cores', type=int, help='number of cores') 322 # makefile arguments 323 parser.add_argument('--release', action='store_true', help='enable release') 324 parser.add_argument('--with-dramsim3', action='store_true', help='enable dramsim3') 325 parser.add_argument('--threads', nargs='?', type=int, help='number of emu threads') 326 parser.add_argument('--trace', action='store_true', help='enable waveform') 327 parser.add_argument('--config', nargs='?', type=str, help='config') 328 # emu arguments 329 parser.add_argument('--numa', action='store_true', help='use numactl') 330 parser.add_argument('--diff', nargs='?', default="./ready-to-run/riscv64-nemu-interpreter-so", type=str, help='nemu so') 331 parser.add_argument('--max-instr', nargs='?', type=int, help='max instr') 332 parser.add_argument('--disable-fork', action='store_true', help='disable lightSSS') 333 # ci action head sha 334 335 args = parser.parse_args() 336 337 xs = XiangShan(args) 338 ret = xs.run(args) 339 340 sys.exit(ret) 341