xref: /XiangShan/Makefile (revision ce34d21eb5ac76b5b49df0748e135581b8df51e5)
1#***************************************************************************************
2# Copyright (c) 2024 Beijing Institute of Open Source Chip (BOSC)
3# Copyright (c) 2020-2024 Institute of Computing Technology, Chinese Academy of Sciences
4# Copyright (c) 2020-2021 Peng Cheng Laboratory
5#
6# XiangShan is licensed under Mulan PSL v2.
7# You can use this software according to the terms and conditions of the Mulan PSL v2.
8# You may obtain a copy of Mulan PSL v2 at:
9#          http://license.coscl.org.cn/MulanPSL2
10#
11# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
12# EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
13# MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
14#
15# See the Mulan PSL v2 for more details.
16#***************************************************************************************
17
18BUILD_DIR = ./build
19RTL_DIR = $(BUILD_DIR)/rtl
20
21TOP = $(XSTOP_PREFIX)XSTop
22SIM_TOP = SimTop
23
24FPGATOP = top.TopMain
25SIMTOP  = top.SimTop
26
27RTL_SUFFIX ?= sv
28TOP_V = $(RTL_DIR)/$(TOP).$(RTL_SUFFIX)
29SIM_TOP_V = $(RTL_DIR)/$(SIM_TOP).$(RTL_SUFFIX)
30
31SCALA_FILE = $(shell find ./src/main/scala -name '*.scala')
32TEST_FILE = $(shell find ./src/test/scala -name '*.scala')
33
34MEM_GEN = ./scripts/vlsi_mem_gen
35MEM_GEN_SEP = ./scripts/gen_sep_mem.sh
36
37CONFIG ?= DefaultConfig
38NUM_CORES ?= 1
39ISSUE ?= B
40
41SUPPORT_CHI_ISSUE = B E.b
42ifeq ($(findstring $(ISSUE), $(SUPPORT_CHI_ISSUE)),)
43$(error "Unsupported CHI issue: $(ISSUE)")
44endif
45
46ifneq ($(shell echo "$(MAKECMDGOALS)" | grep ' '),)
47$(error At most one target can be specified)
48endif
49
50ifeq ($(MAKECMDGOALS),)
51GOALS = verilog
52else
53GOALS = $(MAKECMDGOALS)
54endif
55
56# common chisel args
57FPGA_MEM_ARGS = --firtool-opt "--repl-seq-mem --repl-seq-mem-file=$(TOP).$(RTL_SUFFIX).conf"
58SIM_MEM_ARGS = --firtool-opt "--repl-seq-mem --repl-seq-mem-file=$(SIM_TOP).$(RTL_SUFFIX).conf"
59MFC_ARGS = --dump-fir --target systemverilog --split-verilog \
60           --firtool-opt "-O=release --disable-annotation-unknown --lowering-options=explicitBitcast,disallowLocalVariables,disallowPortDeclSharing,locationInfoStyle=none"
61RELEASE_ARGS += $(MFC_ARGS)
62DEBUG_ARGS += $(MFC_ARGS)
63PLDM_ARGS += $(MFC_ARGS)
64
65ifneq ($(XSTOP_PREFIX),)
66RELEASE_ARGS += --xstop-prefix $(XSTOP_PREFIX)
67DEBUG_ARGS += --xstop-prefix $(XSTOP_PREFIX)
68PLDM_ARGS += --xstop-prefix $(XSTOP_PREFIX)
69endif
70
71ifeq ($(IMSIC_USE_TL),1)
72RELEASE_ARGS += --imsic-use-tl
73DEBUG_ARGS += --imsic-use-tl
74PLDM_ARGS += --imsic-use-tl
75endif
76
77# co-simulation with DRAMsim3
78ifeq ($(WITH_DRAMSIM3),1)
79ifndef DRAMSIM3_HOME
80$(error DRAMSIM3_HOME is not set)
81endif
82override SIM_ARGS += --with-dramsim3
83endif
84
85# run emu with chisel-db
86ifeq ($(WITH_CHISELDB),1)
87override SIM_ARGS += --with-chiseldb
88endif
89
90# run emu with chisel-db
91ifeq ($(WITH_ROLLINGDB),1)
92override SIM_ARGS += --with-rollingdb
93endif
94
95# enable ResetGen
96ifeq ($(WITH_RESETGEN),1)
97override SIM_ARGS += --reset-gen
98endif
99
100# run with disable all perf
101ifeq ($(DISABLE_PERF),1)
102override SIM_ARGS += --disable-perf
103endif
104
105# run with disable all db
106ifeq ($(DISABLE_ALWAYSDB),1)
107override SIM_ARGS += --disable-alwaysdb
108endif
109
110# dynamic switch CONSTANTIN
111ifeq ($(WITH_CONSTANTIN),1)
112override SIM_ARGS += --with-constantin
113endif
114
115# emu for the release version
116RELEASE_ARGS += --fpga-platform --disable-all --remove-assert --reset-gen
117DEBUG_ARGS   += --enable-difftest
118PLDM_ARGS    += --fpga-platform --enable-difftest
119ifeq ($(GOALS),verilog)
120RELEASE_ARGS += --disable-always-basic-diff
121endif
122ifeq ($(RELEASE),1)
123override SIM_ARGS += $(RELEASE_ARGS)
124else ifeq ($(PLDM),1)
125override SIM_ARGS += $(PLDM_ARGS)
126else
127override SIM_ARGS += $(DEBUG_ARGS)
128endif
129
130TIMELOG = $(BUILD_DIR)/time.log
131TIME_CMD = time -avp -o $(TIMELOG)
132
133ifeq ($(PLDM),1)
134SED_IFNDEF = `ifndef SYNTHESIS	// src/main/scala/device/RocketDebugWrapper.scala
135SED_ENDIF  = `endif // not def SYNTHESIS
136endif
137
138.DEFAULT_GOAL = verilog
139
140help:
141	mill -i xiangshan.runMain $(FPGATOP) --help
142
143version:
144	mill -i xiangshan.runMain $(FPGATOP) --version
145
146jar:
147	mill -i xiangshan.assembly
148
149test-jar:
150	mill -i xiangshan.test.assembly
151
152$(TOP_V): $(SCALA_FILE)
153	mkdir -p $(@D)
154	$(TIME_CMD) mill -i xiangshan.runMain $(FPGATOP)   \
155		--target-dir $(@D) --config $(CONFIG) --issue $(ISSUE) $(FPGA_MEM_ARGS)		\
156		--num-cores $(NUM_CORES) $(RELEASE_ARGS)
157	$(MEM_GEN_SEP) "$(MEM_GEN)" "[email protected]" "$(@D)"
158	@git log -n 1 >> .__head__
159	@git diff >> .__diff__
160	@sed -i 's/^/\/\// ' .__head__
161	@sed -i 's/^/\/\//' .__diff__
162	@cat .__head__ .__diff__ $@ > .__out__
163	@mv .__out__ $@
164	@rm .__head__ .__diff__
165
166verilog: $(TOP_V)
167
168$(SIM_TOP_V): $(SCALA_FILE) $(TEST_FILE)
169	mkdir -p $(@D)
170	@echo -e "\n[mill] Generating Verilog files..." > $(TIMELOG)
171	@date -R | tee -a $(TIMELOG)
172	$(TIME_CMD) mill -i xiangshan.test.runMain $(SIMTOP)    \
173		--target-dir $(@D) --config $(CONFIG) --issue $(ISSUE) $(SIM_MEM_ARGS)		\
174		--num-cores $(NUM_CORES) $(SIM_ARGS) --full-stacktrace
175	$(MEM_GEN_SEP) "$(MEM_GEN)" "[email protected]" "$(@D)"
176	@git log -n 1 >> .__head__
177	@git diff >> .__diff__
178	@sed -i 's/^/\/\// ' .__head__
179	@sed -i 's/^/\/\//' .__diff__
180	@cat .__head__ .__diff__ $@ > .__out__
181	@mv .__out__ $@
182	@rm .__head__ .__diff__
183ifeq ($(PLDM),1)
184	sed -i -e 's/$$fatal/$$finish/g' $(RTL_DIR)/*.$(RTL_SUFFIX)
185	sed -i -e '/sed/! { \|$(SED_IFNDEF)|, \|$(SED_ENDIF)| { \|$(SED_IFNDEF)|d; \|$(SED_ENDIF)|d; } }' $(RTL_DIR)/*.$(RTL_SUFFIX)
186else
187ifeq ($(ENABLE_XPROP),1)
188	sed -i -e "s/\$$fatal/assert(1\'b0)/g" $(RTL_DIR)/*.$(RTL_SUFFIX)
189else
190	sed -i -e 's/$$fatal/xs_assert_v2(`__FILE__, `__LINE__)/g' $(RTL_DIR)/*.$(RTL_SUFFIX)
191endif
192endif
193	sed -i -e "s/\$$error(/\$$fwrite(32\'h80000002, /g" $(RTL_DIR)/*.$(RTL_SUFFIX)
194
195sim-verilog: $(SIM_TOP_V)
196
197clean:
198	$(MAKE) -C ./difftest clean
199	rm -rf $(BUILD_DIR)
200
201init:
202	git submodule update --init
203	cd rocket-chip && git submodule update --init cde hardfloat
204
205bump:
206	git submodule foreach "git fetch origin&&git checkout master&&git reset --hard origin/master"
207
208bsp:
209	mill -i mill.bsp.BSP/install
210
211idea:
212	mill -i mill.idea.GenIdea/idea
213
214# verilator simulation
215emu: sim-verilog
216	$(MAKE) -C ./difftest emu SIM_TOP=SimTop DESIGN_DIR=$(NOOP_HOME) NUM_CORES=$(NUM_CORES) RTL_SUFFIX=$(RTL_SUFFIX)
217
218emu-run: emu
219	$(MAKE) -C ./difftest emu-run SIM_TOP=SimTop DESIGN_DIR=$(NOOP_HOME) NUM_CORES=$(NUM_CORES) RTL_SUFFIX=$(RTL_SUFFIX)
220
221# vcs simulation
222simv: sim-verilog
223	$(MAKE) -C ./difftest simv SIM_TOP=SimTop DESIGN_DIR=$(NOOP_HOME) NUM_CORES=$(NUM_CORES) RTL_SUFFIX=$(RTL_SUFFIX)
224
225simv-run:
226	$(MAKE) -C ./difftest simv-run SIM_TOP=SimTop DESIGN_DIR=$(NOOP_HOME) NUM_CORES=$(NUM_CORES) RTL_SUFFIX=$(RTL_SUFFIX)
227
228# palladium simulation
229pldm-build: sim-verilog
230	$(MAKE) -C ./difftest pldm-build SIM_TOP=SimTop DESIGN_DIR=$(NOOP_HOME) NUM_CORES=$(NUM_CORES) RTL_SUFFIX=$(RTL_SUFFIX)
231
232pldm-run:
233	$(MAKE) -C ./difftest pldm-run SIM_TOP=SimTop DESIGN_DIR=$(NOOP_HOME) NUM_CORES=$(NUM_CORES) RTL_SUFFIX=$(RTL_SUFFIX)
234
235pldm-debug:
236	$(MAKE) -C ./difftest pldm-debug SIM_TOP=SimTop DESIGN_DIR=$(NOOP_HOME) NUM_CORES=$(NUM_CORES) RTL_SUFFIX=$(RTL_SUFFIX)
237
238include Makefile.test
239
240include src/main/scala/device/standalone/standalone_device.mk
241
242.PHONY: verilog sim-verilog emu clean help init bump bsp $(REF_SO)
243