qapi: Rename QAPIDoc.Section.name to .tag
[qemu/kevin.git] / Makefile
blob8f369903356ced3097b1caf1120f923728a7b8d1
1 # Makefile for QEMU.
3 ifneq ($(words $(subst :, ,$(CURDIR))), 1)
4 $(error main directory cannot contain spaces nor colons)
5 endif
7 # Always point to the root of the build tree (needs GNU make).
8 BUILD_DIR=$(CURDIR)
10 # Before including a proper config-host.mak, assume we are in the source tree
11 SRC_PATH=.
13 # Don't use implicit rules or variables
14 # we have explicit rules for everything
15 MAKEFLAGS += -rR
17 SHELL = bash -o pipefail
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.
25 quiet-command-run = $(if $(V),,$(if $2,printf " %-7s %s\n" $2 $3 && ))$1
26 quiet-@ = $(if $(V),,@)
27 quiet-command = $(quiet-@)$(call quiet-command-run,$1,$2,$3)
29 UNCHECKED_GOALS := TAGS gtags cscope ctags dist \
30 help check-help print-% \
31 docker docker-% lcitool-refresh vm-help vm-test vm-build-%
33 all:
34 .PHONY: all clean distclean recurse-all dist msi FORCE
36 # Don't try to regenerate Makefile or configure
37 # We don't generate any of them
38 Makefile: ;
39 configure: ;
41 # All following code might depend on configuration variables
42 ifneq ($(wildcard config-host.mak),)
43 include config-host.mak
45 include Makefile.prereqs
46 Makefile.prereqs: config-host.mak
48 # 0. ensure the build tree is okay
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.
52 ifneq ($(realpath $(SRC_PATH)),$(realpath .))
53 ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
54 $(error This is an out of tree build but your source tree ($(SRC_PATH)) \
55 seems 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)
57 endif
58 endif
60 # force a rerun of configure if config-host.mak is too old or corrupted
61 ifeq ($(MESON),)
62 .PHONY: config-host.mak
63 x := $(shell rm -rf meson-private meson-info meson-logs)
64 endif
65 ifeq ($(NINJA),)
66 .PHONY: config-host.mak
67 x := $(shell rm -rf meson-private meson-info meson-logs)
68 else
69 export NINJA
70 endif
71 ifeq ($(wildcard build.ninja),)
72 .PHONY: config-host.mak
73 x := $(shell rm -rf meson-private meson-info meson-logs)
74 endif
75 ifeq ($(origin prefix),file)
76 .PHONY: config-host.mak
77 x := $(shell rm -rf meson-private meson-info meson-logs)
78 endif
80 # 1. ensure config-host.mak is up-to-date
81 config-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; \
89 # 2. meson.stamp exists if meson has run at least once (so ninja reconfigure
90 # works), but otherwise never needs to be updated
92 meson-private/coredata.dat: meson.stamp
93 meson.stamp: config-host.mak
94 @touch meson.stamp
96 # 3. ensure meson-generated build files are up-to-date
98 ifneq ($(NINJA),)
99 Makefile.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
107 endif
109 ifneq ($(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.
114 build.ninja: build.ninja.stamp
115 $(build-files):
116 build.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)" > $@
124 Makefile.mtest: build.ninja scripts/mtest2make.py
125 $(MESON) introspect --targets --tests --benchmarks | $(PYTHON) scripts/mtest2make.py > $@
126 -include Makefile.mtest
128 .PHONY: update-buildoptions
129 all 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 $@
133 endif
135 # 4. Rules to bridge to other makefiles
137 ifneq ($(NINJA),)
138 # Filter out long options to avoid flags like --no-print-directory which
139 # may result in false positive match for MAKE.n
140 MAKE.n = $(findstring n,$(firstword $(filter-out --%,$(MAKEFLAGS))))
141 MAKE.k = $(findstring k,$(firstword $(filter-out --%,$(MAKEFLAGS))))
142 MAKE.q = $(findstring q,$(firstword $(filter-out --%,$(MAKEFLAGS))))
143 MAKE.nq = $(if $(word 2, $(MAKE.n) $(MAKE.q)),nq)
144 NINJAFLAGS = $(if $V,-v) $(if $(MAKE.n), -n) $(if $(MAKE.k), -k0) \
145 $(filter-out -j, $(lastword -j1 $(filter -l% -j%, $(MAKEFLAGS)))) \
146 -d keepdepfile
147 ninja-cmd-goals = $(or $(MAKECMDGOALS), all)
148 ninja-cmd-goals += $(foreach g, $(MAKECMDGOALS), $(.ninja-goals.$g))
150 makefile-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".
154 ninja-targets := $(filter-out $(build-files) $(makefile-targets), $(ninja-targets))
155 .PHONY: $(ninja-targets) run-ninja
156 $(ninja-targets): run-ninja
158 # Use "| cat" to give Ninja a more "make-y" output. Use "+" to bypass the
159 # --output-sync line.
160 run-ninja: config-host.mak
161 ifneq ($(filter $(ninja-targets), $(ninja-cmd-goals)),)
162 +$(if $(MAKE.nq),@:,$(quiet-@)$(NINJA) $(NINJAFLAGS) \
163 $(sort $(filter $(ninja-targets), $(ninja-cmd-goals))) | cat)
164 endif
165 endif
167 else # config-host.mak does not exist
168 ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
169 $(error Please call configure before running make)
170 endif
171 endif # config-host.mak does not exist
173 SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
175 include $(SRC_PATH)/tests/Makefile.include
177 all: recurse-all
179 SUBDIR_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 $@),)
184 ifneq ($(filter contrib/plugins, $(SUBDIRS)),)
185 .PHONY: plugins
186 plugins: contrib/plugins/all
187 endif
189 .PHONY: recurse-all recurse-clean
190 recurse-all: $(addsuffix /all, $(SUBDIRS))
191 recurse-clean: $(addsuffix /clean, $(SUBDIRS))
192 recurse-distclean: $(addsuffix /distclean, $(SUBDIRS))
194 ######################################################################
196 clean: 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 @$(MAKE) -Ctests/qemu-iotests clean
207 VERSION = $(shell cat $(SRC_PATH)/VERSION)
209 dist: qemu-$(VERSION).tar.bz2
211 qemu-%.tar.bz2:
212 $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
214 distclean: clean recurse-distclean
215 -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
216 rm -f config-host.mak Makefile.prereqs
217 rm -f tests/tcg/*/config-target.mak tests/tcg/config-host.mak
218 rm -f config.status
219 rm -f roms/seabios/config.mak
220 rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
221 rm -f *-config-target.h *-config-devices.mak *-config-devices.h
222 rm -rf meson-private meson-logs meson-info compile_commands.json
223 rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
224 rm -f config.log
225 rm -f linux-headers/asm
226 rm -Rf .sdk qemu-bundle
228 find-src-path = find "$(SRC_PATH)" -path "$(SRC_PATH)/meson" -prune -o \
229 -type l -prune -o \( -name "*.[chsS]" -o -name "*.[ch].inc" \)
231 .PHONY: ctags
232 ctags:
233 $(call quiet-command, \
234 rm -f "$(SRC_PATH)/"tags, \
235 "CTAGS", "Remove old tags")
236 $(call quiet-command, \
237 $(find-src-path) -exec ctags \
238 -f "$(SRC_PATH)/"tags --append {} +, \
239 "CTAGS", "Re-index $(SRC_PATH)")
241 .PHONY: gtags
242 gtags:
243 $(call quiet-command, \
244 rm -f "$(SRC_PATH)/"GTAGS; \
245 rm -f "$(SRC_PATH)/"GRTAGS; \
246 rm -f "$(SRC_PATH)/"GPATH, \
247 "GTAGS", "Remove old $@ files")
248 $(call quiet-command, \
249 (cd $(SRC_PATH) && \
250 $(find-src-path) -print | gtags -f -), \
251 "GTAGS", "Re-index $(SRC_PATH)")
253 .PHONY: TAGS
254 TAGS:
255 $(call quiet-command, \
256 rm -f "$(SRC_PATH)/"TAGS, \
257 "TAGS", "Remove old $@")
258 $(call quiet-command, \
259 $(find-src-path) -exec etags \
260 -f "$(SRC_PATH)/"TAGS --append {} +, \
261 "TAGS", "Re-index $(SRC_PATH)")
263 .PHONY: cscope
264 cscope:
265 $(call quiet-command, \
266 rm -f "$(SRC_PATH)/"cscope.* , \
267 "cscope", "Remove old $@ files")
268 $(call quiet-command, \
269 ($(find-src-path) -print | sed -e 's,^\./,,' \
270 > "$(SRC_PATH)/cscope.files"), \
271 "cscope", "Create file list")
272 $(call quiet-command, \
273 cscope -b -i"$(SRC_PATH)/cscope.files" \
274 -f"$(SRC_PATH)"/cscope.out, \
275 "cscope", "Re-index $(SRC_PATH)")
277 # Needed by "meson install"
278 export DESTDIR
280 include $(SRC_PATH)/tests/lcitool/Makefile.include
281 include $(SRC_PATH)/tests/docker/Makefile.include
282 include $(SRC_PATH)/tests/vm/Makefile.include
284 print-help-run = printf " %-30s - %s\\n" "$1" "$2"
285 print-help = @$(call print-help-run,$1,$2)
287 .PHONY: update-linux-vdso
288 update-linux-vdso:
289 @for m in $(SRC_PATH)/linux-user/*/Makefile.vdso; do \
290 $(MAKE) $(SUBDIR_MAKEFLAGS) -C $$(dirname $$m) -f Makefile.vdso \
291 SRC_PATH=$(SRC_PATH) BUILD_DIR=$(BUILD_DIR); \
292 done
294 .PHONY: help
295 help:
296 @echo 'Generic targets:'
297 $(call print-help,all,Build all)
298 $(call print-help,dir/file.o,Build specified target only)
299 $(call print-help,install,Install QEMU, documentation and tools)
300 $(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
301 $(call print-help,cscope,Generate cscope index)
302 $(call print-help,sparse,Run sparse on the QEMU source)
303 @echo ''
304 ifneq ($(filter contrib/plugins, $(SUBDIRS)),)
305 @echo 'Plugin targets:'
306 $(call print-help,plugins,Build the example TCG plugins)
307 @echo ''
308 endif
309 @echo 'Cleaning targets:'
310 $(call print-help,clean,Remove most generated files but keep the config)
311 $(call print-help,distclean,Remove all generated files)
312 $(call print-help,dist,Build a distributable tarball)
313 @echo ''
314 @echo 'Linux-user targets:'
315 $(call print-help,update-linux-vdso,Build linux-user vdso images)
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,lcitool-help,Help about targets for managing build environment manifests)
321 $(call print-help,docker-help,Help about targets running tests inside containers)
322 $(call print-help,vm-help,Help about targets running tests inside VM)
323 @echo ''
324 @echo 'Documentation targets:'
325 $(call print-help,html man,Build documentation in specified format)
326 @echo ''
327 ifneq ($(filter msi, $(ninja-targets)),)
328 @echo 'Windows targets:'
329 $(call print-help,installer,Build NSIS-based installer for QEMU)
330 $(call print-help,msi,Build MSI-based installer for qemu-ga)
331 @echo ''
332 endif
333 $(call print-help,$(MAKE) [targets],(quiet build, default))
334 $(call print-help,$(MAKE) V=1 [targets],(verbose build))
336 # will delete the target of a rule if commands exit with a nonzero exit status
337 .DELETE_ON_ERROR:
339 print-%:
340 @echo '$*=$($*)'