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