xref: /openbmc/qemu/Makefile (revision 0fbb5d2d) 
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)/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
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
147ninja-cmd-goals = $(or $(MAKECMDGOALS), all)
148ninja-cmd-goals += $(foreach t, $(.check.build-suites), $(.check-$t.deps))
149ninja-cmd-goals += $(foreach t, $(.bench.build-suites), $(.bench-$t.deps))
150
151makefile-targets := build.ninja ctags TAGS cscope dist clean uninstall
152# "ninja -t targets" also lists all prerequisites.  If build system
153# files are marked as PHONY, however, Make will always try to execute
154# "ninja build.ninja".
155ninja-targets := $(filter-out $(build-files) $(makefile-targets), $(ninja-targets))
156.PHONY: $(ninja-targets) run-ninja
157$(ninja-targets): run-ninja
158
159# Use "| cat" to give Ninja a more "make-y" output.  Use "+" to bypass the
160# --output-sync line.
161run-ninja: config-host.mak
162ifneq ($(filter $(ninja-targets), $(ninja-cmd-goals)),)
163	+$(quiet-@)$(if $(MAKE.nq),@:, $(NINJA) -d keepdepfile \
164	   $(NINJAFLAGS) $(sort $(filter $(ninja-targets), $(ninja-cmd-goals))) | cat)
165endif
166endif
167
168# Force configure to re-run if the API symbols are updated
169ifeq ($(CONFIG_PLUGIN),y)
170config-host.mak: $(SRC_PATH)/plugins/qemu-plugins.symbols
171
172.PHONY: plugins
173plugins:
174	$(call quiet-command,\
175		$(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
176		"BUILD", "example plugins")
177endif # $(CONFIG_PLUGIN)
178
179else # config-host.mak does not exist
180config-host.mak:
181ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
182	@echo "Please call configure before running make!"
183	@exit 1
184endif
185endif # config-host.mak does not exist
186
187SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
188
189include $(SRC_PATH)/tests/Makefile.include
190
191all: recurse-all
192
193ROM_DIRS = $(addprefix pc-bios/, $(ROMS))
194ROM_DIRS_RULES=$(foreach t, all clean, $(addsuffix /$(t), $(ROM_DIRS)))
195# Only keep -O and -g cflags
196.PHONY: $(ROM_DIRS_RULES)
197$(ROM_DIRS_RULES):
198	$(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
199
200.PHONY: recurse-all recurse-clean
201recurse-all: $(addsuffix /all, $(ROM_DIRS))
202recurse-clean: $(addsuffix /clean, $(ROM_DIRS))
203
204######################################################################
205
206clean: recurse-clean
207	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
208	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
209# avoid old build problems by removing potentially incorrect old files
210	rm -f config.mak op-i386.h opc-i386.h gen-op-i386.h op-arm.h opc-arm.h gen-op-arm.h
211	find . \( -name '*.so' -o -name '*.dll' -o -name '*.[oda]' \) -type f \
212		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
213		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
214		-exec rm {} +
215	rm -f TAGS cscope.* *.pod *~ */*~
216	rm -f fsdev/*.pod scsi/*.pod
217
218VERSION = $(shell cat $(SRC_PATH)/VERSION)
219
220dist: qemu-$(VERSION).tar.bz2
221
222qemu-%.tar.bz2:
223	$(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
224
225distclean: clean
226	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
227	rm -f config-host.mak config-host.h* config-poison.h
228	rm -f tests/tcg/config-*.mak
229	rm -f config-all-disas.mak config.status
230	rm -f roms/seabios/config.mak roms/vgabios/config.mak
231	rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
232	rm -f *-config-target.h *-config-devices.mak *-config-devices.h
233	rm -rf meson-private meson-logs meson-info compile_commands.json
234	rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
235	rm -f config.log
236	rm -f linux-headers/asm
237	rm -Rf .sdk
238
239find-src-path = find "$(SRC_PATH)" -path "$(SRC_PATH)/meson" -prune -o \
240	-type l -prune -o \( -name "*.[chsS]" -o -name "*.[ch].inc" \)
241
242.PHONY: ctags
243ctags:
244	$(call quiet-command, 			\
245		rm -f "$(SRC_PATH)/"tags, 	\
246		"CTAGS", "Remove old tags")
247	$(call quiet-command, \
248		$(find-src-path) -exec ctags 		\
249		-f "$(SRC_PATH)/"tags --append {} +,	\
250		"CTAGS", "Re-index $(SRC_PATH)")
251
252.PHONY: gtags
253gtags:
254	$(call quiet-command, 			\
255		rm -f "$(SRC_PATH)/"GTAGS; 	\
256		rm -f "$(SRC_PATH)/"GRTAGS; 	\
257		rm -f "$(SRC_PATH)/"GPATH, 	\
258		"GTAGS", "Remove old $@ files")
259	$(call quiet-command, 				\
260	        (cd $(SRC_PATH) && 			\
261		 $(find-src-path) -print | gtags -f -),	\
262		"GTAGS", "Re-index $(SRC_PATH)")
263
264.PHONY: TAGS
265TAGS:
266	$(call quiet-command, 			\
267		rm -f "$(SRC_PATH)/"TAGS,	\
268		"TAGS", "Remove old $@")
269	$(call quiet-command, 				\
270		$(find-src-path) -exec etags 		\
271		-f "$(SRC_PATH)/"TAGS --append {} +, 	\
272		"TAGS", "Re-index $(SRC_PATH)")
273
274.PHONY: cscope
275cscope:
276	$(call quiet-command,			\
277		rm -f "$(SRC_PATH)/"cscope.* ,	\
278		"cscope", "Remove old $@ files")
279	$(call quiet-command, 					\
280		($(find-src-path) -print | sed -e 's,^\./,,'    \
281		> "$(SRC_PATH)/cscope.files"), 			\
282		"cscope", "Create file list")
283	$(call quiet-command, 				\
284		cscope -b -i"$(SRC_PATH)/cscope.files" 	\
285		-f"$(SRC_PATH)"/cscope.out, 		\
286		"cscope", "Re-index $(SRC_PATH)")
287
288# Needed by "meson install"
289export DESTDIR
290
291include $(SRC_PATH)/tests/docker/Makefile.include
292include $(SRC_PATH)/tests/vm/Makefile.include
293
294print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
295print-help = @$(call print-help-run,$1,$2)
296
297.PHONY: help
298help:
299	@echo  'Generic targets:'
300	$(call print-help,all,Build all)
301	$(call print-help,dir/file.o,Build specified target only)
302	$(call print-help,install,Install QEMU, documentation and tools)
303	$(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
304	$(call print-help,cscope,Generate cscope index)
305	$(call print-help,sparse,Run sparse on the QEMU source)
306	@echo  ''
307ifeq ($(CONFIG_PLUGIN),y)
308	@echo  'Plugin targets:'
309	$(call print-help,plugins,Build the example TCG plugins)
310	@echo  ''
311endif
312	@echo  'Cleaning targets:'
313	$(call print-help,clean,Remove most generated files but keep the config)
314	$(call print-help,distclean,Remove all generated files)
315	$(call print-help,dist,Build a distributable tarball)
316	@echo  ''
317	@echo  'Test targets:'
318	$(call print-help,check,Run all tests (check-help for details))
319	$(call print-help,bench,Run all benchmarks)
320	$(call print-help,docker-help,Help about targets running tests inside containers)
321	$(call print-help,vm-help,Help about targets running tests inside VM)
322	@echo  ''
323	@echo  'Documentation targets:'
324	$(call print-help,html man,Build documentation in specified format)
325	@echo  ''
326ifdef CONFIG_WIN32
327	@echo  'Windows targets:'
328	$(call print-help,installer,Build NSIS-based installer for QEMU)
329	$(call print-help,msi,Build MSI-based installer for qemu-ga)
330	@echo  ''
331endif
332	$(call print-help,$(MAKE) [targets],(quiet build, default))
333	$(call print-help,$(MAKE) V=1 [targets],(verbose build))
334
335# will delete the target of a rule if commands exit with a nonzero exit status
336.DELETE_ON_ERROR:
337
338print-%:
339	@echo '$*=$($*)'
340