xref: /openbmc/qemu/Makefile (revision c85cad81) 
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-% 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 && touch build.ninja.stamp; \
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
91meson-private/coredata.dat: meson.stamp
92meson.stamp: config-host.mak
93	@touch meson.stamp
94
95# 3. ensure generated build files are up-to-date
96
97ifneq ($(NINJA),)
98Makefile.ninja: build.ninja
99	$(quiet-@){ \
100	  echo 'ninja-targets = \'; \
101	  $(NINJA) -t targets all | sed 's/:.*//; $$!s/$$/ \\/'; \
102	  echo 'build-files = \'; \
103	  $(NINJA) -t query build.ninja | sed -n '1,/^  input:/d; /^  outputs:/q; s/$$/ \\/p'; \
104	} > $@.tmp && mv $@.tmp $@
105-include Makefile.ninja
106endif
107
108ifneq ($(MESON),)
109# A separate rule is needed for Makefile dependencies to avoid -n
110build.ninja: build.ninja.stamp
111$(build-files):
112build.ninja.stamp: meson.stamp $(build-files)
113	$(MESON) setup --reconfigure $(SRC_PATH) && touch $@
114
115Makefile.mtest: build.ninja scripts/mtest2make.py
116	$(MESON) introspect --targets --tests --benchmarks | $(PYTHON) scripts/mtest2make.py > $@
117-include Makefile.mtest
118
119.PHONY: update-buildoptions
120all update-buildoptions: $(SRC_PATH)/scripts/meson-buildoptions.sh
121$(SRC_PATH)/scripts/meson-buildoptions.sh: $(SRC_PATH)/meson_options.txt
122	$(MESON) introspect --buildoptions $(SRC_PATH)/meson.build | $(PYTHON) \
123	  scripts/meson-buildoptions.py > $@.tmp && mv $@.tmp $@
124endif
125
126# 4. Rules to bridge to other makefiles
127
128ifneq ($(NINJA),)
129# Filter out long options to avoid flags like --no-print-directory which
130# may result in false positive match for MAKE.n
131MAKE.n = $(findstring n,$(firstword $(filter-out --%,$(MAKEFLAGS))))
132MAKE.k = $(findstring k,$(firstword $(filter-out --%,$(MAKEFLAGS))))
133MAKE.q = $(findstring q,$(firstword $(filter-out --%,$(MAKEFLAGS))))
134MAKE.nq = $(if $(word 2, $(MAKE.n) $(MAKE.q)),nq)
135NINJAFLAGS = $(if $V,-v) $(if $(MAKE.n), -n) $(if $(MAKE.k), -k0) \
136        $(filter-out -j, $(lastword -j1 $(filter -l% -j%, $(MAKEFLAGS)))) \
137        -d keepdepfile
138ninja-cmd-goals = $(or $(MAKECMDGOALS), all)
139ninja-cmd-goals += $(foreach g, $(MAKECMDGOALS), $(.ninja-goals.$g))
140
141makefile-targets := build.ninja ctags TAGS cscope dist clean
142# "ninja -t targets" also lists all prerequisites.  If build system
143# files are marked as PHONY, however, Make will always try to execute
144# "ninja build.ninja".
145ninja-targets := $(filter-out $(build-files) $(makefile-targets), $(ninja-targets))
146.PHONY: $(ninja-targets) run-ninja
147$(ninja-targets): run-ninja
148
149# Use "| cat" to give Ninja a more "make-y" output.  Use "+" to bypass the
150# --output-sync line.
151run-ninja: config-host.mak
152ifneq ($(filter $(ninja-targets), $(ninja-cmd-goals)),)
153	+$(if $(MAKE.nq),@:,$(quiet-@)$(NINJA) $(NINJAFLAGS) \
154	   $(sort $(filter $(ninja-targets), $(ninja-cmd-goals))) | cat)
155endif
156endif
157
158ifeq ($(CONFIG_PLUGIN),y)
159.PHONY: plugins
160plugins:
161	$(call quiet-command,\
162		$(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
163		"BUILD", "example plugins")
164endif # $(CONFIG_PLUGIN)
165
166else # config-host.mak does not exist
167ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
168$(error Please call configure before running make)
169endif
170endif # config-host.mak does not exist
171
172SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
173
174include $(SRC_PATH)/tests/Makefile.include
175
176all: recurse-all
177
178ROMS_RULES=$(foreach t, all clean distclean, $(addsuffix /$(t), $(ROMS)))
179.PHONY: $(ROMS_RULES)
180$(ROMS_RULES):
181	$(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
182
183.PHONY: recurse-all recurse-clean
184recurse-all: $(addsuffix /all, $(ROMS))
185recurse-clean: $(addsuffix /clean, $(ROMS))
186recurse-distclean: $(addsuffix /distclean, $(ROMS))
187
188######################################################################
189
190clean: recurse-clean
191	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
192	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
193	find . \( -name '*.so' -o -name '*.dll' -o \
194		  -name '*.[oda]' -o -name '*.gcno' \) -type f \
195		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
196		! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
197		-exec rm {} +
198	rm -f TAGS cscope.* *~ */*~
199
200VERSION = $(shell cat $(SRC_PATH)/VERSION)
201
202dist: qemu-$(VERSION).tar.bz2
203
204qemu-%.tar.bz2:
205	$(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
206
207distclean: clean recurse-distclean
208	-$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
209	rm -f config-host.mak Makefile.prereqs
210	rm -f tests/tcg/*/config-target.mak tests/tcg/config-host.mak
211	rm -f config.status
212	rm -f roms/seabios/config.mak
213	rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
214	rm -f *-config-target.h *-config-devices.mak *-config-devices.h
215	rm -rf meson-private meson-logs meson-info compile_commands.json
216	rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
217	rm -f config.log
218	rm -f linux-headers/asm
219	rm -Rf .sdk qemu-bundle
220
221find-src-path = find "$(SRC_PATH)" -path "$(SRC_PATH)/meson" -prune -o \
222	-type l -prune -o \( -name "*.[chsS]" -o -name "*.[ch].inc" \)
223
224.PHONY: ctags
225ctags:
226	$(call quiet-command, 			\
227		rm -f "$(SRC_PATH)/"tags, 	\
228		"CTAGS", "Remove old tags")
229	$(call quiet-command, \
230		$(find-src-path) -exec ctags 		\
231		-f "$(SRC_PATH)/"tags --append {} +,	\
232		"CTAGS", "Re-index $(SRC_PATH)")
233
234.PHONY: gtags
235gtags:
236	$(call quiet-command, 			\
237		rm -f "$(SRC_PATH)/"GTAGS; 	\
238		rm -f "$(SRC_PATH)/"GRTAGS; 	\
239		rm -f "$(SRC_PATH)/"GPATH, 	\
240		"GTAGS", "Remove old $@ files")
241	$(call quiet-command, 				\
242	        (cd $(SRC_PATH) && 			\
243		 $(find-src-path) -print | gtags -f -),	\
244		"GTAGS", "Re-index $(SRC_PATH)")
245
246.PHONY: TAGS
247TAGS:
248	$(call quiet-command, 			\
249		rm -f "$(SRC_PATH)/"TAGS,	\
250		"TAGS", "Remove old $@")
251	$(call quiet-command, 				\
252		$(find-src-path) -exec etags 		\
253		-f "$(SRC_PATH)/"TAGS --append {} +, 	\
254		"TAGS", "Re-index $(SRC_PATH)")
255
256.PHONY: cscope
257cscope:
258	$(call quiet-command,			\
259		rm -f "$(SRC_PATH)/"cscope.* ,	\
260		"cscope", "Remove old $@ files")
261	$(call quiet-command, 					\
262		($(find-src-path) -print | sed -e 's,^\./,,'    \
263		> "$(SRC_PATH)/cscope.files"), 			\
264		"cscope", "Create file list")
265	$(call quiet-command, 				\
266		cscope -b -i"$(SRC_PATH)/cscope.files" 	\
267		-f"$(SRC_PATH)"/cscope.out, 		\
268		"cscope", "Re-index $(SRC_PATH)")
269
270# Needed by "meson install"
271export DESTDIR
272
273include $(SRC_PATH)/tests/lcitool/Makefile.include
274include $(SRC_PATH)/tests/docker/Makefile.include
275include $(SRC_PATH)/tests/vm/Makefile.include
276
277print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
278print-help = @$(call print-help-run,$1,$2)
279
280.PHONY: help
281help:
282	@echo  'Generic targets:'
283	$(call print-help,all,Build all)
284	$(call print-help,dir/file.o,Build specified target only)
285	$(call print-help,install,Install QEMU, documentation and tools)
286	$(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
287	$(call print-help,cscope,Generate cscope index)
288	$(call print-help,sparse,Run sparse on the QEMU source)
289	@echo  ''
290ifeq ($(CONFIG_PLUGIN),y)
291	@echo  'Plugin targets:'
292	$(call print-help,plugins,Build the example TCG plugins)
293	@echo  ''
294endif
295	@echo  'Cleaning targets:'
296	$(call print-help,clean,Remove most generated files but keep the config)
297	$(call print-help,distclean,Remove all generated files)
298	$(call print-help,dist,Build a distributable tarball)
299	@echo  ''
300	@echo  'Test targets:'
301	$(call print-help,check,Run all tests (check-help for details))
302	$(call print-help,bench,Run all benchmarks)
303	$(call print-help,lcitool-help,Help about targets for managing build environment manifests)
304	$(call print-help,docker-help,Help about targets running tests inside containers)
305	$(call print-help,vm-help,Help about targets running tests inside VM)
306	@echo  ''
307	@echo  'Documentation targets:'
308	$(call print-help,html man,Build documentation in specified format)
309	@echo  ''
310ifdef CONFIG_WIN32
311	@echo  'Windows targets:'
312	$(call print-help,installer,Build NSIS-based installer for QEMU)
313	$(call print-help,msi,Build MSI-based installer for qemu-ga)
314	@echo  ''
315endif
316	$(call print-help,$(MAKE) [targets],(quiet build, default))
317	$(call print-help,$(MAKE) V=1 [targets],(verbose build))
318
319# will delete the target of a rule if commands exit with a nonzero exit status
320.DELETE_ON_ERROR:
321
322print-%:
323	@echo '$*=$($*)'
324