xref: /openbmc/qemu/Makefile (revision afb81fe8) 
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 := TAGS gtags cscope ctags dist \
30    help check-help print-% \
31    docker docker-% lcitool-refresh 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
45include Makefile.prereqs
46Makefile.prereqs: config-host.mak
47
48# 0. ensure the build tree is okay
49
50# Check that we're not trying to do an out-of-tree build from
51# a tree that's been used for an in-tree build.
52ifneq ($(realpath $(SRC_PATH)),$(realpath .))
53ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
54$(error This is an out of tree build but your source tree ($(SRC_PATH)) \
55seems to have been used for an in-tree build. You can fix this by running \
56"$(MAKE) distclean && rm -rf *-linux-user *-softmmu" in your source tree)
57endif
58endif
59
60# force a rerun of configure if config-host.mak is too old or corrupted
61ifeq ($(MESON),)
62.PHONY: config-host.mak
63x := $(shell rm -rf meson-private meson-info meson-logs)
64endif
65ifeq ($(NINJA),)
66.PHONY: config-host.mak
67x := $(shell rm -rf meson-private meson-info meson-logs)
68else
69export NINJA
70endif
71ifeq ($(wildcard build.ninja),)
72.PHONY: config-host.mak
73x := $(shell rm -rf meson-private meson-info meson-logs)
74endif
75ifeq ($(origin prefix),file)
76.PHONY: config-host.mak
77x := $(shell rm -rf meson-private meson-info meson-logs)
78endif
79
80# 1. ensure config-host.mak is up-to-date
81config-host.mak: $(SRC_PATH)/configure $(SRC_PATH)/scripts/meson-buildoptions.sh $(SRC_PATH)/VERSION
82	@echo config-host.mak is out-of-date, running configure
83	@if test -f meson-private/coredata.dat; then \
84	  ./config.status --skip-meson; \
85	else \
86	  ./config.status; \
87	fi
88
89# 2. meson.stamp exists if meson has run at least once (so ninja reconfigure
90# works), but otherwise never needs to be updated
91
92meson-private/coredata.dat: meson.stamp
93meson.stamp: config-host.mak
94	@touch meson.stamp
95
96# 3. ensure meson-generated build files are up-to-date
97
98ifneq ($(NINJA),)
99Makefile.ninja: build.ninja
100	$(quiet-@){ \
101	  echo 'ninja-targets = \'; \
102	  $(NINJA) -t targets all | sed 's/:.*//; $$!s/$$/ \\/'; \
103	  echo 'build-files = \'; \
104	  $(NINJA) -t query build.ninja | sed -n '1,/^  input:/d; /^  outputs:/q; s/$$/ \\/p'; \
105	} > $@.tmp && mv $@.tmp $@
106-include Makefile.ninja
107endif
108
109ifneq ($(MESON),)
110# The path to meson always points to pyvenv/bin/meson, but the absolute
111# paths could change.  In that case, force a regeneration of build.ninja.
112# Note that this invocation of $(NINJA), just like when Make rebuilds
113# Makefiles, does not include -n.
114build.ninja: build.ninja.stamp
115$(build-files):
116build.ninja.stamp: meson.stamp $(build-files)
117	@if test "$$(cat build.ninja.stamp)" = "$(MESON)" && test -n "$(NINJA)"; then \
118	  $(NINJA) build.ninja; \
119	else \
120	  echo "$(MESON) setup --reconfigure $(SRC_PATH)"; \
121	  $(MESON) setup --reconfigure $(SRC_PATH); \
122	fi && echo "$(MESON)" > $@
123
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
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
167else # config-host.mak does not exist
168ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
169$(error Please call configure before running make)
170endif
171endif # config-host.mak does not exist
172
173SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
174
175include $(SRC_PATH)/tests/Makefile.include
176
177all: recurse-all
178
179SUBDIR_RULES=$(foreach t, all clean distclean, $(addsuffix /$(t), $(SUBDIRS)))
180.PHONY: $(SUBDIR_RULES)
181$(SUBDIR_RULES):
182	$(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
183
184ifneq ($(filter contrib/plugins, $(SUBDIRS)),)
185.PHONY: plugins
186plugins: contrib/plugins/all
187endif
188
189.PHONY: recurse-all recurse-clean
190recurse-all: $(addsuffix /all, $(SUBDIRS))
191recurse-clean: $(addsuffix /clean, $(SUBDIRS))
192recurse-distclean: $(addsuffix /distclean, $(SUBDIRS))
193
194######################################################################
195
196clean: recurse-clean
197	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
198	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
199	find . \( -name '*.so' -o -name '*.dll' -o \
200		  -name '*.[oda]' -o -name '*.gcno' \) -type f \
201		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
202		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
203		-exec rm {} +
204	rm -f TAGS cscope.* *~ */*~
205
206VERSION = $(shell cat $(SRC_PATH)/VERSION)
207
208dist: qemu-$(VERSION).tar.bz2
209
210qemu-%.tar.bz2:
211	$(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
212
213distclean: clean recurse-distclean
214	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
215	rm -f config-host.mak Makefile.prereqs
216	rm -f tests/tcg/*/config-target.mak tests/tcg/config-host.mak
217	rm -f config.status
218	rm -f roms/seabios/config.mak
219	rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
220	rm -f *-config-target.h *-config-devices.mak *-config-devices.h
221	rm -rf meson-private meson-logs meson-info compile_commands.json
222	rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
223	rm -f config.log
224	rm -f linux-headers/asm
225	rm -Rf .sdk qemu-bundle
226
227find-src-path = find "$(SRC_PATH)" -path "$(SRC_PATH)/meson" -prune -o \
228	-type l -prune -o \( -name "*.[chsS]" -o -name "*.[ch].inc" \)
229
230.PHONY: ctags
231ctags:
232	$(call quiet-command, 			\
233		rm -f "$(SRC_PATH)/"tags, 	\
234		"CTAGS", "Remove old tags")
235	$(call quiet-command, \
236		$(find-src-path) -exec ctags 		\
237		-f "$(SRC_PATH)/"tags --append {} +,	\
238		"CTAGS", "Re-index $(SRC_PATH)")
239
240.PHONY: gtags
241gtags:
242	$(call quiet-command, 			\
243		rm -f "$(SRC_PATH)/"GTAGS; 	\
244		rm -f "$(SRC_PATH)/"GRTAGS; 	\
245		rm -f "$(SRC_PATH)/"GPATH, 	\
246		"GTAGS", "Remove old $@ files")
247	$(call quiet-command, 				\
248	        (cd $(SRC_PATH) && 			\
249		 $(find-src-path) -print | gtags -f -),	\
250		"GTAGS", "Re-index $(SRC_PATH)")
251
252.PHONY: TAGS
253TAGS:
254	$(call quiet-command, 			\
255		rm -f "$(SRC_PATH)/"TAGS,	\
256		"TAGS", "Remove old $@")
257	$(call quiet-command, 				\
258		$(find-src-path) -exec etags 		\
259		-f "$(SRC_PATH)/"TAGS --append {} +, 	\
260		"TAGS", "Re-index $(SRC_PATH)")
261
262.PHONY: cscope
263cscope:
264	$(call quiet-command,			\
265		rm -f "$(SRC_PATH)/"cscope.* ,	\
266		"cscope", "Remove old $@ files")
267	$(call quiet-command, 					\
268		($(find-src-path) -print | sed -e 's,^\./,,'    \
269		> "$(SRC_PATH)/cscope.files"), 			\
270		"cscope", "Create file list")
271	$(call quiet-command, 				\
272		cscope -b -i"$(SRC_PATH)/cscope.files" 	\
273		-f"$(SRC_PATH)"/cscope.out, 		\
274		"cscope", "Re-index $(SRC_PATH)")
275
276# Needed by "meson install"
277export DESTDIR
278
279include $(SRC_PATH)/tests/lcitool/Makefile.include
280include $(SRC_PATH)/tests/docker/Makefile.include
281include $(SRC_PATH)/tests/vm/Makefile.include
282
283print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
284print-help = @$(call print-help-run,$1,$2)
285
286.PHONY: help
287help:
288	@echo  'Generic targets:'
289	$(call print-help,all,Build all)
290	$(call print-help,dir/file.o,Build specified target only)
291	$(call print-help,install,Install QEMU, documentation and tools)
292	$(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
293	$(call print-help,cscope,Generate cscope index)
294	$(call print-help,sparse,Run sparse on the QEMU source)
295	@echo  ''
296ifneq ($(filter contrib/plugins, $(SUBDIRS)),)
297	@echo  'Plugin targets:'
298	$(call print-help,plugins,Build the example TCG plugins)
299	@echo  ''
300endif
301	@echo  'Cleaning targets:'
302	$(call print-help,clean,Remove most generated files but keep the config)
303	$(call print-help,distclean,Remove all generated files)
304	$(call print-help,dist,Build a distributable tarball)
305	@echo  ''
306	@echo  'Test targets:'
307	$(call print-help,check,Run all tests (check-help for details))
308	$(call print-help,bench,Run all benchmarks)
309	$(call print-help,lcitool-help,Help about targets for managing build environment manifests)
310	$(call print-help,docker-help,Help about targets running tests inside containers)
311	$(call print-help,vm-help,Help about targets running tests inside VM)
312	@echo  ''
313	@echo  'Documentation targets:'
314	$(call print-help,html man,Build documentation in specified format)
315	@echo  ''
316ifneq ($(filter msi, $(ninja-targets)),)
317	@echo  'Windows targets:'
318	$(call print-help,installer,Build NSIS-based installer for QEMU)
319	$(call print-help,msi,Build MSI-based installer for qemu-ga)
320	@echo  ''
321endif
322	$(call print-help,$(MAKE) [targets],(quiet build, default))
323	$(call print-help,$(MAKE) V=1 [targets],(verbose build))
324
325# will delete the target of a rule if commands exit with a nonzero exit status
326.DELETE_ON_ERROR:
327
328print-%:
329	@echo '$*=$($*)'
330