xref: /qemu/Makefile (revision f9734d5d) 
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)/pc-bios $(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
127endif
128
129# 4. Rules to bridge to other makefiles
130
131ifneq ($(NINJA),)
132# Filter out long options to avoid flags like --no-print-directory which
133# may result in false positive match for MAKE.n
134MAKE.n = $(findstring n,$(firstword $(filter-out --%,$(MAKEFLAGS))))
135MAKE.k = $(findstring k,$(firstword $(filter-out --%,$(MAKEFLAGS))))
136MAKE.q = $(findstring q,$(firstword $(filter-out --%,$(MAKEFLAGS))))
137MAKE.nq = $(if $(word 2, $(MAKE.n) $(MAKE.q)),nq)
138NINJAFLAGS = $(if $V,-v) $(if $(MAKE.n), -n) $(if $(MAKE.k), -k0) \
139        $(filter-out -j, $(lastword -j1 $(filter -l% -j%, $(MAKEFLAGS)))) \
140
141ninja-cmd-goals = $(or $(MAKECMDGOALS), all)
142ninja-cmd-goals += $(foreach t, $(.tests), $(.test.deps.$t))
143
144makefile-targets := build.ninja ctags TAGS cscope dist clean uninstall
145# "ninja -t targets" also lists all prerequisites.  If build system
146# files are marked as PHONY, however, Make will always try to execute
147# "ninja build.ninja".
148ninja-targets := $(filter-out $(build-files) $(makefile-targets), $(ninja-targets))
149.PHONY: $(ninja-targets) run-ninja
150$(ninja-targets): run-ninja
151
152# Use "| cat" to give Ninja a more "make-y" output.  Use "+" to bypass the
153# --output-sync line.
154run-ninja: config-host.mak
155ifneq ($(filter $(ninja-targets), $(ninja-cmd-goals)),)
156	+$(quiet-@)$(if $(MAKE.nq),@:, $(NINJA) -d keepdepfile \
157	   $(NINJAFLAGS) $(sort $(filter $(ninja-targets), $(ninja-cmd-goals))) | cat)
158endif
159endif
160
161# Force configure to re-run if the API symbols are updated
162ifeq ($(CONFIG_PLUGIN),y)
163config-host.mak: $(SRC_PATH)/plugins/qemu-plugins.symbols
164
165.PHONY: plugins
166plugins:
167	$(call quiet-command,\
168		$(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
169		"BUILD", "example plugins")
170endif # $(CONFIG_PLUGIN)
171
172else # config-host.mak does not exist
173config-host.mak:
174ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
175	@echo "Please call configure before running make!"
176	@exit 1
177endif
178endif # config-host.mak does not exist
179
180SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
181
182include $(SRC_PATH)/tests/Makefile.include
183
184all: recurse-all
185
186ROM_DIRS = $(addprefix pc-bios/, $(ROMS))
187ROM_DIRS_RULES=$(foreach t, all clean, $(addsuffix /$(t), $(ROM_DIRS)))
188# Only keep -O and -g cflags
189.PHONY: $(ROM_DIRS_RULES)
190$(ROM_DIRS_RULES):
191	$(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
192
193.PHONY: recurse-all recurse-clean
194recurse-all: $(addsuffix /all, $(ROM_DIRS))
195recurse-clean: $(addsuffix /clean, $(ROM_DIRS))
196
197######################################################################
198
199clean: recurse-clean
200	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
201	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
202# avoid old build problems by removing potentially incorrect old files
203	rm -f config.mak op-i386.h opc-i386.h gen-op-i386.h op-arm.h opc-arm.h gen-op-arm.h
204	find . \( -name '*.so' -o -name '*.dll' -o -name '*.[oda]' \) -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.* *.pod *~ */*~
209	rm -f fsdev/*.pod scsi/*.pod
210
211VERSION = $(shell cat $(SRC_PATH)/VERSION)
212
213dist: qemu-$(VERSION).tar.bz2
214
215qemu-%.tar.bz2:
216	$(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
217
218distclean: clean
219	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
220	rm -f config-host.mak config-host.h* config-poison.h
221	rm -f tests/tcg/config-*.mak
222	rm -f config-all-disas.mak config.status
223	rm -f roms/seabios/config.mak roms/vgabios/config.mak
224	rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
225	rm -f *-config-target.h *-config-devices.mak *-config-devices.h
226	rm -rf meson-private meson-logs meson-info compile_commands.json
227	rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
228	rm -f config.log
229	rm -f linux-headers/asm
230	rm -Rf .sdk
231
232find-src-path = find "$(SRC_PATH)/" -path "$(SRC_PATH)/meson" -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) | 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/docker/Makefile.include
284include $(SRC_PATH)/tests/vm/Makefile.include
285
286print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
287print-help = @$(call print-help-run,$1,$2)
288
289.PHONY: help
290help:
291	@echo  'Generic targets:'
292	$(call print-help,all,Build all)
293	$(call print-help,dir/file.o,Build specified target only)
294	$(call print-help,install,Install QEMU, documentation and tools)
295	$(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
296	$(call print-help,cscope,Generate cscope index)
297	$(call print-help,sparse,Run sparse on the QEMU source)
298	@echo  ''
299ifeq ($(CONFIG_PLUGIN),y)
300	@echo  'Plugin targets:'
301	$(call print-help,plugins,Build the example TCG plugins)
302	@echo  ''
303endif
304	@echo  'Cleaning targets:'
305	$(call print-help,clean,Remove most generated files but keep the config)
306	$(call print-help,distclean,Remove all generated files)
307	$(call print-help,dist,Build a distributable tarball)
308	@echo  ''
309	@echo  'Test targets:'
310	$(call print-help,check,Run all tests (check-help for details))
311	$(call print-help,bench,Run all benchmarks)
312	$(call print-help,docker-help,Help about targets running tests inside containers)
313	$(call print-help,vm-help,Help about targets running tests inside VM)
314	@echo  ''
315	@echo  'Documentation targets:'
316	$(call print-help,html man,Build documentation in specified format)
317	@echo  ''
318ifdef CONFIG_WIN32
319	@echo  'Windows targets:'
320	$(call print-help,installer,Build NSIS-based installer for QEMU)
321	$(call print-help,msi,Build MSI-based installer for qemu-ga)
322	@echo  ''
323endif
324	$(call print-help,$(MAKE) [targets],(quiet build, default))
325	$(call print-help,$(MAKE) V=1 [targets],(verbose build))
326
327# will delete the target of a rule if commands exit with a nonzero exit status
328.DELETE_ON_ERROR:
329
330print-%:
331	@echo '$*=$($*)'
332