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 := TAGS gtags cscope ctags dist \
  30     help check-help print-% \
  31     docker docker-% lcitool-refresh 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 include Makefile.prereqs
  46 Makefile.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.
  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
  59
  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
  79
  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; \
  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
  91
  92 meson-private/coredata.dat: meson.stamp
  93 meson.stamp: config-host.mak
  94         @touch meson.stamp
  95
  96 # 3. ensure meson-generated build files are up-to-date
  97
  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
 108
 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)" > $@
 123
 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 > $@.tmp && mv $@.tmp $@
 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 = \
 145         $(if $V,-v) \
 146         $(if $(MAKE.n), -n) \
 147         $(if $(MAKE.k), -k0) \
 148         $(filter-out -j, \
 149           $(or $(filter -l% -j%, $(MAKEFLAGS)), \
 150                $(if $(filter --jobserver-auth=%, $(MAKEFLAGS)),, -j1))) \
 151         -d keepdepfile
 152 ninja-cmd-goals = $(or $(MAKECMDGOALS), all)
 153 ninja-cmd-goals += $(foreach g, $(MAKECMDGOALS), $(.ninja-goals.$g))
 154
 155 makefile-targets := build.ninja ctags TAGS cscope dist clean
 156 # "ninja -t targets" also lists all prerequisites.  If build system
 157 # files are marked as PHONY, however, Make will always try to execute
 158 # "ninja build.ninja".
 159 ninja-targets := $(filter-out $(build-files) $(makefile-targets), $(ninja-targets))
 160 .PHONY: $(ninja-targets) run-ninja
 161 $(ninja-targets): run-ninja
 162
 163 # Use "| cat" to give Ninja a more "make-y" output.  Use "+" to bypass the
 164 # --output-sync line.
 165 run-ninja: config-host.mak
 166 ifneq ($(filter $(ninja-targets), $(ninja-cmd-goals)),)
 167         +$(if $(MAKE.nq),@:,$(quiet-@)$(NINJA) $(NINJAFLAGS) \
 168            $(sort $(filter $(ninja-targets), $(ninja-cmd-goals))) | cat)
 169 endif
 170 endif
 171
 172 else # config-host.mak does not exist
 173 ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
 174 $(error Please call configure before running make)
 175 endif
 176 endif # config-host.mak does not exist
 177
 178 SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
 179
 180 include $(SRC_PATH)/tests/Makefile.include
 181
 182 all: recurse-all
 183
 184 SUBDIR_RULES=$(foreach t, all clean distclean, $(addsuffix /$(t), $(SUBDIRS)))
 185 .PHONY: $(SUBDIR_RULES)
 186 $(SUBDIR_RULES):
 187         $(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
 188
 189 ifneq ($(filter contrib/plugins, $(SUBDIRS)),)
 190 .PHONY: plugins
 191 plugins: contrib/plugins/all
 192 endif
 193
 194 .PHONY: recurse-all recurse-clean
 195 recurse-all: $(addsuffix /all, $(SUBDIRS))
 196 recurse-clean: $(addsuffix /clean, $(SUBDIRS))
 197 recurse-distclean: $(addsuffix /distclean, $(SUBDIRS))
 198
 199 ######################################################################
 200
 201 clean: recurse-clean
 202         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
 203         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
 204         find . \( -name '*.so' -o -name '*.dll' -o \
 205                   -name '*.[oda]' -o -name '*.gcno' \) -type f \
 206                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
 207                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
 208                 -exec rm {} +
 209         rm -f TAGS cscope.* *~ */*~
 210         @$(MAKE) -Ctests/qemu-iotests clean
 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 recurse-distclean
 220         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
 221         rm -f config-host.mak Makefile.prereqs
 222         rm -f tests/tcg/*/config-target.mak tests/tcg/config-host.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 qemu-bundle
 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: update-linux-vdso
 293 update-linux-vdso:
 294         @for m in $(SRC_PATH)/linux-user/*/Makefile.vdso; do \
 295           $(MAKE) $(SUBDIR_MAKEFLAGS) -C $$(dirname $$m) -f Makefile.vdso \
 296                 SRC_PATH=$(SRC_PATH) BUILD_DIR=$(BUILD_DIR); \
 297         done
 298
 299 .PHONY: help
 300 help:
 301         @echo  'Generic targets:'
 302         $(call print-help,all,Build all)
 303         $(call print-help,dir/file.o,Build specified target only)
 304         $(call print-help,install,Install QEMU, documentation and tools)
 305         $(call print-help,ctags/gtags/TAGS,Generate tags file for editors)
 306         $(call print-help,cscope,Generate cscope index)
 307         $(call print-help,sparse,Run sparse on the QEMU source)
 308         @echo  ''
 309 ifneq ($(filter contrib/plugins, $(SUBDIRS)),)
 310         @echo  'Plugin targets:'
 311         $(call print-help,plugins,Build the example TCG plugins)
 312         @echo  ''
 313 endif
 314         @echo  'Cleaning targets:'
 315         $(call print-help,clean,Remove most generated files but keep the config)
 316         $(call print-help,distclean,Remove all generated files)
 317         $(call print-help,dist,Build a distributable tarball)
 318         @echo  ''
 319         @echo  'Linux-user targets:'
 320         $(call print-help,update-linux-vdso,Build linux-user vdso images)
 321         @echo  ''
 322         @echo  'Test targets:'
 323         $(call print-help,check,Run all tests (check-help for details))
 324         $(call print-help,bench,Run all benchmarks)
 325         $(call print-help,lcitool-help,Help about targets for managing build environment manifests)
 326         $(call print-help,docker-help,Help about targets running tests inside containers)
 327         $(call print-help,vm-help,Help about targets running tests inside VM)
 328         @echo  ''
 329         @echo  'Documentation targets:'
 330         $(call print-help,html man,Build documentation in specified format)
 331         @echo  ''
 332 ifneq ($(filter msi, $(ninja-targets)),)
 333         @echo  'Windows targets:'
 334         $(call print-help,installer,Build NSIS-based installer for QEMU)
 335         $(call print-help,msi,Build MSI-based installer for qemu-ga)
 336         @echo  ''
 337 endif
 338         $(call print-help,$(MAKE) [targets],(quiet build, default))
 339         $(call print-help,$(MAKE) V=1 [targets],(verbose build))
 340
 341 # will delete the target of a rule if commands exit with a nonzero exit status
 342 .DELETE_ON_ERROR:
 343
 344 print-%:
 345         @echo '$*=$($*)'