xref: /openbmc/qemu/Makefile (revision b14df228) 
1# Makefile for QEMU.
2
3ifneq ($(words $(subst :, ,$(CURDIR))), 1)
4  $(error main directory cannot contain spaces nor colons)
5endif
6
7# Always point to the root of the build tree (needs GNU make).
8BUILD_DIR=$(CURDIR)
9
10# Before including a proper config-host.mak, assume we are in the source tree
11SRC_PATH=.
12
13# Don't use implicit rules or variables
14# we have explicit rules for everything
15MAKEFLAGS += -rR
16
17SHELL = bash -o pipefail
18
19# Usage: $(call quiet-command,command and args,"NAME","args to print")
20# This will run "command and args", and either:
21#  if V=1 just print the whole command and args
22#  otherwise print the 'quiet' output in the format "  NAME     args to print"
23# NAME should be a short name of the command, 7 letters or fewer.
24# If called with only a single argument, will print nothing in quiet mode.
25quiet-command-run = $(if $(V),,$(if $2,printf "  %-7s %s\n" $2 $3 && ))$1
26quiet-@ = $(if $(V),,@)
27quiet-command = $(quiet-@)$(call quiet-command-run,$1,$2,$3)
28
29UNCHECKED_GOALS := %clean TAGS cscope ctags dist \
30    help check-help print-% \
31    docker docker-% vm-help vm-test vm-build-%
32
33all:
34.PHONY: all clean distclean recurse-all dist msi FORCE
35
36# Don't try to regenerate Makefile or configure
37# We don't generate any of them
38Makefile: ;
39configure: ;
40
41# All following code might depend on configuration variables
42ifneq ($(wildcard config-host.mak),)
43include config-host.mak
44
45git-submodule-update:
46.git-submodule-status: git-submodule-update config-host.mak
47Makefile: .git-submodule-status
48
49.PHONY: git-submodule-update
50git-submodule-update:
51ifneq ($(GIT_SUBMODULES_ACTION),ignore)
52	$(call quiet-command, \
53		(GIT="$(GIT)" "$(SRC_PATH)/scripts/git-submodule.sh" $(GIT_SUBMODULES_ACTION) $(GIT_SUBMODULES)), \
54		"GIT","$(GIT_SUBMODULES)")
55endif
56
57# 0. ensure the build tree is okay
58
59# Check that we're not trying to do an out-of-tree build from
60# a tree that's been used for an in-tree build.
61ifneq ($(realpath $(SRC_PATH)),$(realpath .))
62ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
63$(error This is an out of tree build but your source tree ($(SRC_PATH)) \
64seems to have been used for an in-tree build. You can fix this by running \
65"$(MAKE) distclean && rm -rf *-linux-user *-softmmu" in your source tree)
66endif
67endif
68
69# force a rerun of configure if config-host.mak is too old or corrupted
70ifeq ($(MESON),)
71.PHONY: config-host.mak
72x := $(shell rm -rf meson-private meson-info meson-logs)
73endif
74ifeq ($(NINJA),)
75.PHONY: config-host.mak
76x := $(shell rm -rf meson-private meson-info meson-logs)
77else
78export NINJA
79endif
80ifeq ($(wildcard build.ninja),)
81.PHONY: config-host.mak
82x := $(shell rm -rf meson-private meson-info meson-logs)
83endif
84ifeq ($(origin prefix),file)
85.PHONY: config-host.mak
86x := $(shell rm -rf meson-private meson-info meson-logs)
87endif
88
89# 1. ensure config-host.mak is up-to-date
90config-host.mak: $(SRC_PATH)/configure $(SRC_PATH)/scripts/meson-buildoptions.sh $(SRC_PATH)/VERSION
91	@echo config-host.mak is out-of-date, running configure
92	@if test -f meson-private/coredata.dat; then \
93	  ./config.status --skip-meson; \
94	else \
95	  ./config.status && touch build.ninja.stamp; \
96	fi
97
98# 2. meson.stamp exists if meson has run at least once (so ninja reconfigure
99# works), but otherwise never needs to be updated
100meson-private/coredata.dat: meson.stamp
101meson.stamp: config-host.mak
102	@touch meson.stamp
103
104# 3. ensure generated build files are up-to-date
105
106ifneq ($(NINJA),)
107Makefile.ninja: build.ninja
108	$(quiet-@){ \
109	  echo 'ninja-targets = \'; \
110	  $(NINJA) -t targets all | sed 's/:.*//; $$!s/$$/ \\/'; \
111	  echo 'build-files = \'; \
112	  $(NINJA) -t query build.ninja | sed -n '1,/^  input:/d; /^  outputs:/q; s/$$/ \\/p'; \
113	} > $@.tmp && mv $@.tmp $@
114-include Makefile.ninja
115
116# A separate rule is needed for Makefile dependencies to avoid -n
117build.ninja: build.ninja.stamp
118$(build-files):
119build.ninja.stamp: meson.stamp $(build-files)
120	$(NINJA) $(if $V,-v,) build.ninja && touch $@
121endif
122
123ifneq ($(MESON),)
124Makefile.mtest: build.ninja scripts/mtest2make.py
125	$(MESON) introspect --targets --tests --benchmarks | $(PYTHON) scripts/mtest2make.py > $@
126-include Makefile.mtest
127
128.PHONY: update-buildoptions
129all update-buildoptions: $(SRC_PATH)/scripts/meson-buildoptions.sh
130$(SRC_PATH)/scripts/meson-buildoptions.sh: $(SRC_PATH)/meson_options.txt
131	$(MESON) introspect --buildoptions $(SRC_PATH)/meson.build | $(PYTHON) \
132	  scripts/meson-buildoptions.py > $@.tmp && mv $@.tmp $@
133endif
134
135# 4. Rules to bridge to other makefiles
136
137ifneq ($(NINJA),)
138# Filter out long options to avoid flags like --no-print-directory which
139# may result in false positive match for MAKE.n
140MAKE.n = $(findstring n,$(firstword $(filter-out --%,$(MAKEFLAGS))))
141MAKE.k = $(findstring k,$(firstword $(filter-out --%,$(MAKEFLAGS))))
142MAKE.q = $(findstring q,$(firstword $(filter-out --%,$(MAKEFLAGS))))
143MAKE.nq = $(if $(word 2, $(MAKE.n) $(MAKE.q)),nq)
144NINJAFLAGS = $(if $V,-v) $(if $(MAKE.n), -n) $(if $(MAKE.k), -k0) \
145        $(filter-out -j, $(lastword -j1 $(filter -l% -j%, $(MAKEFLAGS)))) \
146        -d keepdepfile
147ninja-cmd-goals = $(or $(MAKECMDGOALS), all)
148ninja-cmd-goals += $(foreach g, $(MAKECMDGOALS), $(.ninja-goals.$g))))
149
150makefile-targets := build.ninja ctags TAGS cscope dist clean uninstall
151# "ninja -t targets" also lists all prerequisites.  If build system
152# files are marked as PHONY, however, Make will always try to execute
153# "ninja build.ninja".
154ninja-targets := $(filter-out $(build-files) $(makefile-targets), $(ninja-targets))
155.PHONY: $(ninja-targets) run-ninja
156$(ninja-targets): run-ninja
157
158# Use "| cat" to give Ninja a more "make-y" output.  Use "+" to bypass the
159# --output-sync line.
160run-ninja: config-host.mak
161ifneq ($(filter $(ninja-targets), $(ninja-cmd-goals)),)
162	+$(if $(MAKE.nq),@:,$(quiet-@)$(NINJA) $(NINJAFLAGS) \
163	   $(sort $(filter $(ninja-targets), $(ninja-cmd-goals))) | cat)
164endif
165endif
166
167ifeq ($(CONFIG_PLUGIN),y)
168.PHONY: plugins
169plugins:
170	$(call quiet-command,\
171		$(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
172		"BUILD", "example plugins")
173endif # $(CONFIG_PLUGIN)
174
175else # config-host.mak does not exist
176config-host.mak:
177ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
178	@echo "Please call configure before running make!"
179	@exit 1
180endif
181endif # config-host.mak does not exist
182
183SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
184
185include $(SRC_PATH)/tests/Makefile.include
186
187all: recurse-all
188
189ROMS_RULES=$(foreach t, all clean, $(addsuffix /$(t), $(ROMS)))
190.PHONY: $(ROMS_RULES)
191$(ROMS_RULES):
192	$(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
193
194.PHONY: recurse-all recurse-clean
195recurse-all: $(addsuffix /all, $(ROMS))
196recurse-clean: $(addsuffix /clean, $(ROMS))
197
198######################################################################
199
200clean: recurse-clean
201	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
202	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
203	find . \( -name '*.so' -o -name '*.dll' -o \
204		  -name '*.[oda]' -o -name '*.gcno' \) -type f \
205		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
206		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
207		-exec rm {} +
208	rm -f TAGS cscope.* *~ */*~
209
210VERSION = $(shell cat $(SRC_PATH)/VERSION)
211
212dist: qemu-$(VERSION).tar.bz2
213
214qemu-%.tar.bz2:
215	$(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
216
217distclean: clean
218	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
219	rm -f config-host.mak qemu-bundle
220	rm -f tests/tcg/config-*.mak
221	rm -f config.status
222	rm -f roms/seabios/config.mak
223	rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
224	rm -f *-config-target.h *-config-devices.mak *-config-devices.h
225	rm -rf meson-private meson-logs meson-info compile_commands.json
226	rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
227	rm -f config.log
228	rm -f linux-headers/asm
229	rm -Rf .sdk
230
231find-src-path = find "$(SRC_PATH)" -path "$(SRC_PATH)/meson" -prune -o \
232	-type l -prune -o \( -name "*.[chsS]" -o -name "*.[ch].inc" \)
233
234.PHONY: ctags
235ctags:
236	$(call quiet-command, 			\
237		rm -f "$(SRC_PATH)/"tags, 	\
238		"CTAGS", "Remove old tags")
239	$(call quiet-command, \
240		$(find-src-path) -exec ctags 		\
241		-f "$(SRC_PATH)/"tags --append {} +,	\
242		"CTAGS", "Re-index $(SRC_PATH)")
243
244.PHONY: gtags
245gtags:
246	$(call quiet-command, 			\
247		rm -f "$(SRC_PATH)/"GTAGS; 	\
248		rm -f "$(SRC_PATH)/"GRTAGS; 	\
249		rm -f "$(SRC_PATH)/"GPATH, 	\
250		"GTAGS", "Remove old $@ files")
251	$(call quiet-command, 				\
252	        (cd $(SRC_PATH) && 			\
253		 $(find-src-path) -print | gtags -f -),	\
254		"GTAGS", "Re-index $(SRC_PATH)")
255
256.PHONY: TAGS
257TAGS:
258	$(call quiet-command, 			\
259		rm -f "$(SRC_PATH)/"TAGS,	\
260		"TAGS", "Remove old $@")
261	$(call quiet-command, 				\
262		$(find-src-path) -exec etags 		\
263		-f "$(SRC_PATH)/"TAGS --append {} +, 	\
264		"TAGS", "Re-index $(SRC_PATH)")
265
266.PHONY: cscope
267cscope:
268	$(call quiet-command,			\
269		rm -f "$(SRC_PATH)/"cscope.* ,	\
270		"cscope", "Remove old $@ files")
271	$(call quiet-command, 					\
272		($(find-src-path) -print | sed -e 's,^\./,,'    \
273		> "$(SRC_PATH)/cscope.files"), 			\
274		"cscope", "Create file list")
275	$(call quiet-command, 				\
276		cscope -b -i"$(SRC_PATH)/cscope.files" 	\
277		-f"$(SRC_PATH)"/cscope.out, 		\
278		"cscope", "Re-index $(SRC_PATH)")
279
280# Needed by "meson install"
281export DESTDIR
282
283include $(SRC_PATH)/tests/lcitool/Makefile.include
284include $(SRC_PATH)/tests/docker/Makefile.include
285include $(SRC_PATH)/tests/vm/Makefile.include
286
287print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
288print-help = @$(call print-help-run,$1,$2)
289
290.PHONY: help
291help:
292	@echo  'Generic targets:'
293	$(call print-help,all,Build all)
294	$(call print-help,dir/file.o,Build specified target only)
295	$(call print-help,install,Install QEMU, documentation and tools)
296	$(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
297	$(call print-help,cscope,Generate cscope index)
298	$(call print-help,sparse,Run sparse on the QEMU source)
299	@echo  ''
300ifeq ($(CONFIG_PLUGIN),y)
301	@echo  'Plugin targets:'
302	$(call print-help,plugins,Build the example TCG plugins)
303	@echo  ''
304endif
305	@echo  'Cleaning targets:'
306	$(call print-help,clean,Remove most generated files but keep the config)
307	$(call print-help,distclean,Remove all generated files)
308	$(call print-help,dist,Build a distributable tarball)
309	@echo  ''
310	@echo  'Test targets:'
311	$(call print-help,check,Run all tests (check-help for details))
312	$(call print-help,bench,Run all benchmarks)
313	$(call print-help,lcitool-help,Help about targets for managing build environment manifests)
314	$(call print-help,docker-help,Help about targets running tests inside containers)
315	$(call print-help,vm-help,Help about targets running tests inside VM)
316	@echo  ''
317	@echo  'Documentation targets:'
318	$(call print-help,html man,Build documentation in specified format)
319	@echo  ''
320ifdef CONFIG_WIN32
321	@echo  'Windows targets:'
322	$(call print-help,installer,Build NSIS-based installer for QEMU)
323	$(call print-help,msi,Build MSI-based installer for qemu-ga)
324	@echo  ''
325endif
326	$(call print-help,$(MAKE) [targets],(quiet build, default))
327	$(call print-help,$(MAKE) V=1 [targets],(verbose build))
328
329# will delete the target of a rule if commands exit with a nonzero exit status
330.DELETE_ON_ERROR:
331
332print-%:
333	@echo '$*=$($*)'
334