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