]> Git Repo - qemu.git/blob - Makefile
docs/devel: clean-up the CI links in the docs
[qemu.git] / Makefile
1 # Makefile for QEMU.
2
3 ifneq ($(words $(subst :, ,$(CURDIR))), 1)
4   $(error main directory cannot contain spaces nor colons)
5 endif
6
7 # Always point to the root of the build tree (needs GNU make).
8 BUILD_DIR=$(CURDIR)
9
10 # Before including a proper config-host.mak, assume we are in the source tree
11 SRC_PATH=.
12
13 # Don't use implicit rules or variables
14 # we have explicit rules for everything
15 MAKEFLAGS += -rR
16
17 SHELL = 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.
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)
28
29 UNCHECKED_GOALS := %clean TAGS cscope ctags dist \
30     help check-help print-% \
31     docker docker-% vm-help vm-test vm-build-%
32
33 all:
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
38 Makefile: ;
39 configure: ;
40
41 # All following code might depend on configuration variables
42 ifneq ($(wildcard config-host.mak),)
43 include config-host.mak
44
45 git-submodule-update:
46 .git-submodule-status: git-submodule-update config-host.mak
47 Makefile: .git-submodule-status
48
49 .PHONY: git-submodule-update
50 git-submodule-update:
51 ifneq ($(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)")
55 endif
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.
61 ifneq ($(realpath $(SRC_PATH)),$(realpath .))
62 ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
63 $(error This is an out of tree build but your source tree ($(SRC_PATH)) \
64 seems 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)
66 endif
67 endif
68
69 # force a rerun of configure if config-host.mak is too old or corrupted
70 ifeq ($(MESON),)
71 .PHONY: config-host.mak
72 x := $(shell rm -rf meson-private meson-info meson-logs)
73 endif
74 ifeq ($(NINJA),)
75 .PHONY: config-host.mak
76 x := $(shell rm -rf meson-private meson-info meson-logs)
77 else
78 export NINJA
79 endif
80 ifeq ($(wildcard build.ninja),)
81 .PHONY: config-host.mak
82 x := $(shell rm -rf meson-private meson-info meson-logs)
83 endif
84 ifeq ($(origin prefix),file)
85 .PHONY: config-host.mak
86 x := $(shell rm -rf meson-private meson-info meson-logs)
87 endif
88
89 # 1. ensure config-host.mak is up-to-date
90 config-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
100 meson-private/coredata.dat: meson.stamp
101 meson.stamp: config-host.mak
102         @touch meson.stamp
103
104 # 3. ensure generated build files are up-to-date
105
106 ifneq ($(NINJA),)
107 Makefile.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         } > [email protected] && mv [email protected] $@
114 -include Makefile.ninja
115
116 # A separate rule is needed for Makefile dependencies to avoid -n
117 build.ninja: build.ninja.stamp
118 $(build-files):
119 build.ninja.stamp: meson.stamp $(build-files)
120         $(NINJA) $(if $V,-v,) build.ninja && touch $@
121 endif
122
123 ifneq ($(MESON),)
124 Makefile.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
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 > [email protected] && mv [email protected] $@
133 endif
134
135 # 4. Rules to bridge to other makefiles
136
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))))
149
150 makefile-targets := build.ninja ctags TAGS cscope dist clean uninstall
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
157
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
166
167 ifeq ($(CONFIG_PLUGIN),y)
168 .PHONY: plugins
169 plugins:
170         $(call quiet-command,\
171                 $(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
172                 "BUILD", "example plugins")
173 endif # $(CONFIG_PLUGIN)
174
175 else # config-host.mak does not exist
176 config-host.mak:
177 ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
178         @echo "Please call configure before running make!"
179         @exit 1
180 endif
181 endif # config-host.mak does not exist
182
183 SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
184
185 include $(SRC_PATH)/tests/Makefile.include
186
187 all: recurse-all
188
189 ROM_DIRS = $(addprefix pc-bios/, $(ROMS))
190 ROM_DIRS_RULES=$(foreach t, all clean, $(addsuffix /$(t), $(ROM_DIRS)))
191 # Only keep -O and -g cflags
192 .PHONY: $(ROM_DIRS_RULES)
193 $(ROM_DIRS_RULES):
194         $(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
195
196 .PHONY: recurse-all recurse-clean
197 recurse-all: $(addsuffix /all, $(ROM_DIRS))
198 recurse-clean: $(addsuffix /clean, $(ROM_DIRS))
199
200 ######################################################################
201
202 clean: recurse-clean
203         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
204         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
205         find . \( -name '*.so' -o -name '*.dll' -o \
206                   -name '*.[oda]' -o -name '*.gcno' \) -type f \
207                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
208                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
209                 -exec rm {} +
210         rm -f TAGS cscope.* *~ */*~
211
212 VERSION = $(shell cat $(SRC_PATH)/VERSION)
213
214 dist: qemu-$(VERSION).tar.bz2
215
216 qemu-%.tar.bz2:
217         $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
218
219 distclean: clean
220         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
221         rm -f config-host.mak
222         rm -f tests/tcg/config-*.mak
223         rm -f config.status
224         rm -f roms/seabios/config.mak
225         rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
226         rm -f *-config-target.h *-config-devices.mak *-config-devices.h
227         rm -rf meson-private meson-logs meson-info compile_commands.json
228         rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
229         rm -f config.log
230         rm -f linux-headers/asm
231         rm -Rf .sdk
232
233 find-src-path = find "$(SRC_PATH)" -path "$(SRC_PATH)/meson" -prune -o \
234         -type l -prune -o \( -name "*.[chsS]" -o -name "*.[ch].inc" \)
235
236 .PHONY: ctags
237 ctags:
238         $(call quiet-command,                   \
239                 rm -f "$(SRC_PATH)/"tags,       \
240                 "CTAGS", "Remove old tags")
241         $(call quiet-command, \
242                 $(find-src-path) -exec ctags            \
243                 -f "$(SRC_PATH)/"tags --append {} +,    \
244                 "CTAGS", "Re-index $(SRC_PATH)")
245
246 .PHONY: gtags
247 gtags:
248         $(call quiet-command,                   \
249                 rm -f "$(SRC_PATH)/"GTAGS;      \
250                 rm -f "$(SRC_PATH)/"GRTAGS;     \
251                 rm -f "$(SRC_PATH)/"GPATH,      \
252                 "GTAGS", "Remove old $@ files")
253         $(call quiet-command,                           \
254                 (cd $(SRC_PATH) &&                      \
255                  $(find-src-path) -print | gtags -f -), \
256                 "GTAGS", "Re-index $(SRC_PATH)")
257
258 .PHONY: TAGS
259 TAGS:
260         $(call quiet-command,                   \
261                 rm -f "$(SRC_PATH)/"TAGS,       \
262                 "TAGS", "Remove old $@")
263         $(call quiet-command,                           \
264                 $(find-src-path) -exec etags            \
265                 -f "$(SRC_PATH)/"TAGS --append {} +,    \
266                 "TAGS", "Re-index $(SRC_PATH)")
267
268 .PHONY: cscope
269 cscope:
270         $(call quiet-command,                   \
271                 rm -f "$(SRC_PATH)/"cscope.* ,  \
272                 "cscope", "Remove old $@ files")
273         $(call quiet-command,                                   \
274                 ($(find-src-path) -print | sed -e 's,^\./,,'    \
275                 > "$(SRC_PATH)/cscope.files"),                  \
276                 "cscope", "Create file list")
277         $(call quiet-command,                           \
278                 cscope -b -i"$(SRC_PATH)/cscope.files"  \
279                 -f"$(SRC_PATH)"/cscope.out,             \
280                 "cscope", "Re-index $(SRC_PATH)")
281
282 # Needed by "meson install"
283 export DESTDIR
284
285 include $(SRC_PATH)/tests/lcitool/Makefile.include
286 include $(SRC_PATH)/tests/docker/Makefile.include
287 include $(SRC_PATH)/tests/vm/Makefile.include
288
289 print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
290 print-help = @$(call print-help-run,$1,$2)
291
292 .PHONY: help
293 help:
294         @echo  'Generic targets:'
295         $(call print-help,all,Build all)
296         $(call print-help,dir/file.o,Build specified target only)
297         $(call print-help,install,Install QEMU, documentation and tools)
298         $(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
299         $(call print-help,cscope,Generate cscope index)
300         $(call print-help,sparse,Run sparse on the QEMU source)
301         @echo  ''
302 ifeq ($(CONFIG_PLUGIN),y)
303         @echo  'Plugin targets:'
304         $(call print-help,plugins,Build the example TCG plugins)
305         @echo  ''
306 endif
307         @echo  'Cleaning targets:'
308         $(call print-help,clean,Remove most generated files but keep the config)
309         $(call print-help,distclean,Remove all generated files)
310         $(call print-help,dist,Build a distributable tarball)
311         @echo  ''
312         @echo  'Test targets:'
313         $(call print-help,check,Run all tests (check-help for details))
314         $(call print-help,bench,Run all benchmarks)
315         $(call print-help,lcitool-help,Help about targets for managing build environment manifests)
316         $(call print-help,docker-help,Help about targets running tests inside containers)
317         $(call print-help,vm-help,Help about targets running tests inside VM)
318         @echo  ''
319         @echo  'Documentation targets:'
320         $(call print-help,html man,Build documentation in specified format)
321         @echo  ''
322 ifdef CONFIG_WIN32
323         @echo  'Windows targets:'
324         $(call print-help,installer,Build NSIS-based installer for QEMU)
325         $(call print-help,msi,Build MSI-based installer for qemu-ga)
326         @echo  ''
327 endif
328         $(call print-help,$(MAKE) [targets],(quiet build, default))
329         $(call print-help,$(MAKE) V=1 [targets],(verbose build))
330
331 # will delete the target of a rule if commands exit with a nonzero exit status
332 .DELETE_ON_ERROR:
333
334 print-%:
335         @echo '$*=$($*)'
This page took 0.043042 seconds and 4 git commands to generate.