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 os 20import argparse 21import sys 22import subprocess 23 24 25class XSArgs(object): 26 script_path = os.path.realpath(__file__) 27 # default path to the repositories 28 noop_home = os.path.join(os.path.dirname(script_path), "..") 29 nemu_home = os.path.join(noop_home, "../NEMU") 30 am_home = os.path.join(noop_home, "../nexus-am") 31 dramsim3_home = os.path.join(noop_home, "../DRAMsim3") 32 rvtest_home = os.path.join(noop_home, "../riscv-tests") 33 34 def __init__(self, args): 35 # all path environment variables that should be set 36 all_path = [ 37 # (python argument, environment variable, default, target function) 38 (None, "NOOP_HOME", self.noop_home, self.set_noop_home), 39 (args.nemu, "NEMU_HOME", self.nemu_home, self.set_nemu_home), 40 (args.am, "AM_HOME", self.am_home, self.set_am_home), 41 (args.dramsim3, "DRAMSIM3_HOME", self.dramsim3_home, self.set_dramsim3_home), 42 (args.rvtest, "RVTEST_HOME", self.rvtest_home, self.set_rvtest_home), 43 ] 44 for (arg_in, env, default, set_func) in all_path: 45 set_func(self.__extract_path(arg_in, env, default)) 46 # Chisel arguments 47 self.disable_log = args.disable_log 48 self.dual_core = args.dual_core 49 # Makefile arguments 50 self.threads = args.threads 51 self.with_dramsim3 = 1 if args.with_dramsim3 else None 52 self.trace = 1 if args.trace else None 53 # emu arguments 54 self.max_instr = args.max_instr 55 self.numa = args.numa 56 57 def get_env_variables(self): 58 all_env = { 59 "NOOP_HOME" : self.noop_home, 60 "NEMU_HOME" : self.nemu_home, 61 "AM_HOME" : self.am_home, 62 "DRAMSIM3_HOME": self.dramsim3_home 63 } 64 return all_env 65 66 def get_chisel_args(self, prefix=None): 67 chisel_args = [ 68 (self.disable_log, "disable-log"), 69 (self.dual_core, "dual-core") 70 ] 71 args = map(lambda x: x[1], filter(lambda arg: arg[0], chisel_args)) 72 if prefix is not None: 73 args = map(lambda x: prefix + x, args) 74 return args 75 76 def get_makefile_args(self): 77 makefile_args = [ 78 (self.threads, "EMU_THREADS"), 79 (self.with_dramsim3, "WITH_DRAMSIM3"), 80 (self.trace, "EMU_TRACE") 81 ] 82 args = filter(lambda arg: arg[0] is not None, makefile_args) 83 return args 84 85 def get_emu_args(self): 86 emu_args = [ 87 (self.max_instr, "max-instr") 88 ] 89 args = filter(lambda arg: arg[0] is not None, emu_args) 90 return args 91 92 def show(self): 93 print("Extra environment variables:") 94 env = self.get_env_variables() 95 for env_name in env: 96 print(f"{env_name}: {env[env_name]}") 97 print() 98 print("Chisel arguments:") 99 print(" ".join(self.get_chisel_args())) 100 print() 101 print("Makefile arguments:") 102 for val, name in self.get_makefile_args(): 103 print(f"{name}={val}") 104 print() 105 print("emu arguments:") 106 for val, name in self.get_emu_args(): 107 print(f"--{name} {val}") 108 print() 109 110 def __extract_path(self, path, env=None, default=None): 111 if path is None and env is not None: 112 path = os.getenv(env) 113 if path is None and default is not None: 114 path = default 115 path = os.path.realpath(path) 116 return path 117 118 def set_noop_home(self, path): 119 self.noop_home = path 120 121 def set_nemu_home(self, path): 122 self.nemu_home = path 123 124 def set_am_home(self, path): 125 self.am_home = path 126 127 def set_dramsim3_home(self, path): 128 self.dramsim3_home = path 129 130 def set_rvtest_home(self, path): 131 self.rvtest_home = path 132 133# XiangShan environment 134class XiangShan(object): 135 def __init__(self, args): 136 self.args = XSArgs(args) 137 138 def show(self): 139 self.args.show() 140 141 def generate_verilog(self): 142 print("Generating XiangShan verilog with the following configurations:") 143 self.show() 144 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 145 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 146 return_code = self.__exec_cmd(f'make -C $NOOP_HOME verilog SIM_ARGS="{sim_args}" {make_args}') 147 return return_code 148 149 def build_emu(self): 150 print("Building XiangShan emu with the following configurations:") 151 self.show() 152 sim_args = " ".join(self.args.get_chisel_args(prefix="--")) 153 make_args = " ".join(map(lambda arg: f"{arg[1]}={arg[0]}", self.args.get_makefile_args())) 154 return_code = self.__exec_cmd(f'make -C $NOOP_HOME ./build/emu -j200 SIM_ARGS="{sim_args}" {make_args}') 155 return return_code 156 157 def run_emu(self, workload): 158 print("Running XiangShan emu with the following configurations:") 159 self.show() 160 emu_args = " ".join(map(lambda arg: f"--{arg[1]} {arg[0]}", self.args.get_emu_args())) 161 print("workload:", workload) 162 numa_args = f"numactl -m 1 -C 64-{64+self.args.threads-1}" if self.args.numa else "" 163 return_code = self.__exec_cmd(f'{numa_args} $NOOP_HOME/build/emu -i {workload} {emu_args}') 164 return return_code 165 166 def run(self, args): 167 if args.ci is not None: 168 return self.run_ci(args.ci) 169 actions = [ 170 (args.generate, lambda _ : self.generate_verilog()), 171 (args.build, lambda _ : self.build_emu()), 172 (args.workload, lambda args: self.run_emu(args.workload)) 173 ] 174 valid_actions = map(lambda act: act[1], filter(lambda act: act[0], actions)) 175 for i, action in enumerate(valid_actions): 176 print(f"Action {i}:") 177 ret = action(args) 178 if ret: 179 return ret 180 return 0 181 182 def __exec_cmd(self, cmd): 183 env = dict(os.environ) 184 env.update(self.args.get_env_variables()) 185 print("subprocess call cmd:", cmd) 186 return_code = subprocess.call(cmd, shell=True, env=env) 187 return return_code 188 189 def __get_ci_cputest(self, name=None): 190 base_dir = os.path.join(self.args.am_home, "tests/cputest/build") 191 cputest = os.listdir(base_dir) 192 cputest = filter(lambda x: x.endswith(".bin"), cputest) 193 cputest = map(lambda x: os.path.join(base_dir, x), cputest) 194 return cputest 195 196 def __get_ci_rvtest(self, name=None): 197 base_dir = os.path.join(self.args.rvtest_home, "isa/build") 198 riscv_tests = os.listdir(base_dir) 199 riscv_tests = filter(lambda x: x.endswith(".bin"), riscv_tests) 200 all_rv_tests = ["rv64ui", "rv64um", "rv64ua", "rv64uf", "rv64ud"] 201 riscv_tests = filter(lambda x: x[:6] in all_rv_tests, riscv_tests) 202 riscv_tests = map(lambda x: os.path.join(base_dir, x), riscv_tests) 203 return riscv_tests 204 205 def __am_apps_path(self, bench): 206 filename = f"{bench}-riscv64-noop.bin" 207 return [os.path.join(self.args.am_home, "apps", bench, "build", filename)] 208 209 def __get_ci_workloads(self, name): 210 workloads = { 211 "linux-hello": "bbl.bin", 212 "povray": "_3400001000_.gz", 213 "mcf": "_2550001000_.gz", 214 "xalancbmk": "_6600001000_.gz", 215 "gcc": "_1250001000_.gz", 216 "namd": "_4850001000_.gz", 217 "milc": "_4150001000_.gz", 218 "lbm": "_7550001000_.gz", 219 "gromacs": "_3150001000_.gz" 220 } 221 return [os.path.join("/home/ci-runner/xsenv/workloads", name, workloads[name])] 222 223 def run_ci(self, test): 224 all_tests = { 225 "cputest": self.__get_ci_cputest, 226 "riscv-tests": self.__get_ci_rvtest, 227 "microbench": self.__am_apps_path, 228 "coremark": self.__am_apps_path 229 } 230 for target in all_tests.get(test, self.__get_ci_workloads)(test): 231 print(target) 232 ret = self.run_emu(target) 233 if ret: 234 return ret 235 return 0 236 237if __name__ == "__main__": 238 parser = argparse.ArgumentParser(description='Python wrapper for XiangShan') 239 parser.add_argument('workload', nargs='?', type=str, default="", 240 help='input workload file in binary format') 241 # actions 242 parser.add_argument('--build', action='store_true', help='build XS emu') 243 parser.add_argument('--generate', action='store_true', help='generate XS verilog') 244 parser.add_argument('--ci', nargs='?', type=str, const="", help='run CI tests') 245 # environment variables 246 parser.add_argument('--nemu', nargs='?', type=str, help='path to nemu') 247 parser.add_argument('--am', nargs='?', type=str, help='path to nexus-am') 248 parser.add_argument('--dramsim3', nargs='?', type=str, help='path to dramsim3') 249 parser.add_argument('--rvtest', nargs='?', type=str, help='path to riscv-tests') 250 # chisel arguments 251 parser.add_argument('--disable-log', action='store_true', help='disable log') 252 parser.add_argument('--dual-core', action='store_true', help='dual core') 253 # makefile arguments 254 parser.add_argument('--with-dramsim3', action='store_true', help='enable dramsim3') 255 parser.add_argument('--threads', nargs='?', type=int, help='number of emu threads') 256 parser.add_argument('--trace', action='store_true', help='enable waveform') 257 # emu arguments 258 parser.add_argument('--numa', action='store_true', help='use numactl') 259 parser.add_argument('--max-instr', nargs='?', type=int, help='max instr') 260 261 args = parser.parse_args() 262 263 xs = XiangShan(args) 264 ret = xs.run(args) 265 266 sys.exit(ret) 267