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 include Makefile.prereqs
  46 Makefile.prereqs: config-host.mak
  47
  48 git-submodule-update:
  49 .git-submodule-status: git-submodule-update config-host.mak
  50 Makefile: .git-submodule-status
  51
  52 .PHONY: git-submodule-update
  53 git-submodule-update:
  54 ifneq ($(GIT_SUBMODULES_ACTION),ignore)
  55         $(call quiet-command, \
  56                 (GIT="$(GIT)" "$(SRC_PATH)/scripts/git-submodule.sh" $(GIT_SUBMODULES_ACTION) $(GIT_SUBMODULES)), \
  57                 "GIT","$(GIT_SUBMODULES)")
  58 endif
  59
  60 # 0. ensure the build tree is okay
  61
  62 # Check that we're not trying to do an out-of-tree build from
  63 # a tree that's been used for an in-tree build.
  64 ifneq ($(realpath $(SRC_PATH)),$(realpath .))
  65 ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
  66 $(error This is an out of tree build but your source tree ($(SRC_PATH)) \
  67 seems to have been used for an in-tree build. You can fix this by running \
  68 "$(MAKE) distclean && rm -rf *-linux-user *-softmmu" in your source tree)
  69 endif
  70 endif
  71
  72 # force a rerun of configure if config-host.mak is too old or corrupted
  73 ifeq ($(MESON),)
  74 .PHONY: config-host.mak
  75 x := $(shell rm -rf meson-private meson-info meson-logs)
  76 endif
  77 ifeq ($(NINJA),)
  78 .PHONY: config-host.mak
  79 x := $(shell rm -rf meson-private meson-info meson-logs)
  80 else
  81 export NINJA
  82 endif
  83 ifeq ($(wildcard build.ninja),)
  84 .PHONY: config-host.mak
  85 x := $(shell rm -rf meson-private meson-info meson-logs)
  86 endif
  87 ifeq ($(origin prefix),file)
  88 .PHONY: config-host.mak
  89 x := $(shell rm -rf meson-private meson-info meson-logs)
  90 endif
  91
  92 # 1. ensure config-host.mak is up-to-date
  93 config-host.mak: $(SRC_PATH)/configure $(SRC_PATH)/scripts/meson-buildoptions.sh $(SRC_PATH)/VERSION
  94         @echo config-host.mak is out-of-date, running configure
  95         @if test -f meson-private/coredata.dat; then \
  96           ./config.status --skip-meson; \
  97         else \
  98           ./config.status && touch build.ninja.stamp; \
  99         fi
 100
 101 # 2. meson.stamp exists if meson has run at least once (so ninja reconfigure
 102 # works), but otherwise never needs to be updated
 103 meson-private/coredata.dat: meson.stamp
 104 meson.stamp: config-host.mak
 105         @touch meson.stamp
 106
 107 # 3. ensure generated build files are up-to-date
 108
 109 ifneq ($(NINJA),)
 110 Makefile.ninja: build.ninja
 111         $(quiet-@){ \
 112           echo 'ninja-targets = \'; \
 113           $(NINJA) -t targets all | sed 's/:.*//; $$!s/$$/ \\/'; \
 114           echo 'build-files = \'; \
 115           $(NINJA) -t query build.ninja | sed -n '1,/^  input:/d; /^  outputs:/q; s/$$/ \\/p'; \
 116         } > $@.tmp && mv $@.tmp $@
 117 -include Makefile.ninja
 118
 119 # A separate rule is needed for Makefile dependencies to avoid -n
 120 build.ninja: build.ninja.stamp
 121 $(build-files):
 122 build.ninja.stamp: meson.stamp $(build-files)
 123         $(NINJA) $(if $V,-v,) build.ninja && touch $@
 124 endif
 125
 126 ifneq ($(MESON),)
 127 Makefile.mtest: build.ninja scripts/mtest2make.py
 128         $(MESON) introspect --targets --tests --benchmarks | $(PYTHON) scripts/mtest2make.py > $@
 129 -include Makefile.mtest
 130
 131 .PHONY: update-buildoptions
 132 all update-buildoptions: $(SRC_PATH)/scripts/meson-buildoptions.sh
 133 $(SRC_PATH)/scripts/meson-buildoptions.sh: $(SRC_PATH)/meson_options.txt
 134         $(MESON) introspect --buildoptions $(SRC_PATH)/meson.build | $(PYTHON) \
 135           scripts/meson-buildoptions.py > $@.tmp && mv $@.tmp $@
 136 endif
 137
 138 # 4. Rules to bridge to other makefiles
 139
 140 ifneq ($(NINJA),)
 141 # Filter out long options to avoid flags like --no-print-directory which
 142 # may result in false positive match for MAKE.n
 143 MAKE.n = $(findstring n,$(firstword $(filter-out --%,$(MAKEFLAGS))))
 144 MAKE.k = $(findstring k,$(firstword $(filter-out --%,$(MAKEFLAGS))))
 145 MAKE.q = $(findstring q,$(firstword $(filter-out --%,$(MAKEFLAGS))))
 146 MAKE.nq = $(if $(word 2, $(MAKE.n) $(MAKE.q)),nq)
 147 NINJAFLAGS = $(if $V,-v) $(if $(MAKE.n), -n) $(if $(MAKE.k), -k0) \
 148         $(filter-out -j, $(lastword -j1 $(filter -l% -j%, $(MAKEFLAGS)))) \
 149         -d keepdepfile
 150 ninja-cmd-goals = $(or $(MAKECMDGOALS), all)
 151 ninja-cmd-goals += $(foreach g, $(MAKECMDGOALS), $(.ninja-goals.$g))
 152
 153 makefile-targets := build.ninja ctags TAGS cscope dist clean
 154 # "ninja -t targets" also lists all prerequisites.  If build system
 155 # files are marked as PHONY, however, Make will always try to execute
 156 # "ninja build.ninja".
 157 ninja-targets := $(filter-out $(build-files) $(makefile-targets), $(ninja-targets))
 158 .PHONY: $(ninja-targets) run-ninja
 159 $(ninja-targets): run-ninja
 160
 161 # Use "| cat" to give Ninja a more "make-y" output.  Use "+" to bypass the
 162 # --output-sync line.
 163 run-ninja: config-host.mak
 164 ifneq ($(filter $(ninja-targets), $(ninja-cmd-goals)),)
 165         +$(if $(MAKE.nq),@:,$(quiet-@)$(NINJA) $(NINJAFLAGS) \
 166            $(sort $(filter $(ninja-targets), $(ninja-cmd-goals))) | cat)
 167 endif
 168 endif
 169
 170 ifeq ($(CONFIG_PLUGIN),y)
 171 .PHONY: plugins
 172 plugins:
 173         $(call quiet-command,\
 174                 $(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
 175                 "BUILD", "example plugins")
 176 endif # $(CONFIG_PLUGIN)
 177
 178 else # config-host.mak does not exist
 179 config-host.mak:
 180 ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
 181         @echo "Please call configure before running make!"
 182         @exit 1
 183 endif
 184 endif # config-host.mak does not exist
 185
 186 SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
 187
 188 include $(SRC_PATH)/tests/Makefile.include
 189
 190 all: recurse-all
 191
 192 ROMS_RULES=$(foreach t, all clean distclean, $(addsuffix /$(t), $(ROMS)))
 193 .PHONY: $(ROMS_RULES)
 194 $(ROMS_RULES):
 195         $(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
 196
 197 .PHONY: recurse-all recurse-clean
 198 recurse-all: $(addsuffix /all, $(ROMS))
 199 recurse-clean: $(addsuffix /clean, $(ROMS))
 200 recurse-distclean: $(addsuffix /distclean, $(ROMS))
 201
 202 ######################################################################
 203
 204 clean: recurse-clean
 205         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean || :
 206         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) clean-ctlist || :
 207         find . \( -name '*.so' -o -name '*.dll' -o \
 208                   -name '*.[oda]' -o -name '*.gcno' \) -type f \
 209                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
 210                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
 211                 -exec rm {} +
 212         rm -f TAGS cscope.* *~ */*~
 213
 214 VERSION = $(shell cat $(SRC_PATH)/VERSION)
 215
 216 dist: qemu-$(VERSION).tar.bz2
 217
 218 qemu-%.tar.bz2:
 219         $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
 220
 221 distclean: clean recurse-distclean
 222         -$(quiet-@)test -f build.ninja && $(NINJA) $(NINJAFLAGS) -t clean -g || :
 223         rm -f config-host.mak Makefile.prereqs
 224         rm -f tests/tcg/*/config-target.mak tests/tcg/config-host.mak
 225         rm -f config.status
 226         rm -f roms/seabios/config.mak
 227         rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
 228         rm -f *-config-target.h *-config-devices.mak *-config-devices.h
 229         rm -rf meson-private meson-logs meson-info compile_commands.json
 230         rm -f Makefile.ninja Makefile.mtest build.ninja.stamp meson.stamp
 231         rm -f config.log
 232         rm -f linux-headers/asm
 233         rm -Rf .sdk qemu-bundle
 234
 235 find-src-path = find "$(SRC_PATH)" -path "$(SRC_PATH)/meson" -prune -o \
 236         -type l -prune -o \( -name "*.[chsS]" -o -name "*.[ch].inc" \)
 237
 238 .PHONY: ctags
 239 ctags:
 240         $(call quiet-command,                   \
 241                 rm -f "$(SRC_PATH)/"tags,       \
 242                 "CTAGS", "Remove old tags")
 243         $(call quiet-command, \
 244                 $(find-src-path) -exec ctags            \
 245                 -f "$(SRC_PATH)/"tags --append {} +,    \
 246                 "CTAGS", "Re-index $(SRC_PATH)")
 247
 248 .PHONY: gtags
 249 gtags:
 250         $(call quiet-command,                   \
 251                 rm -f "$(SRC_PATH)/"GTAGS;      \
 252                 rm -f "$(SRC_PATH)/"GRTAGS;     \
 253                 rm -f "$(SRC_PATH)/"GPATH,      \
 254                 "GTAGS", "Remove old $@ files")
 255         $(call quiet-command,                           \
 256                 (cd $(SRC_PATH) &&                      \
 257                  $(find-src-path) -print | gtags -f -), \
 258                 "GTAGS", "Re-index $(SRC_PATH)")
 259
 260 .PHONY: TAGS
 261 TAGS:
 262         $(call quiet-command,                   \
 263                 rm -f "$(SRC_PATH)/"TAGS,       \
 264                 "TAGS", "Remove old $@")
 265         $(call quiet-command,                           \
 266                 $(find-src-path) -exec etags            \
 267                 -f "$(SRC_PATH)/"TAGS --append {} +,    \
 268                 "TAGS", "Re-index $(SRC_PATH)")
 269
 270 .PHONY: cscope
 271 cscope:
 272         $(call quiet-command,                   \
 273                 rm -f "$(SRC_PATH)/"cscope.* ,  \
 274                 "cscope", "Remove old $@ files")
 275         $(call quiet-command,                                   \
 276                 ($(find-src-path) -print | sed -e 's,^\./,,'    \
 277                 > "$(SRC_PATH)/cscope.files"),                  \
 278                 "cscope", "Create file list")
 279         $(call quiet-command,                           \
 280                 cscope -b -i"$(SRC_PATH)/cscope.files"  \
 281                 -f"$(SRC_PATH)"/cscope.out,             \
 282                 "cscope", "Re-index $(SRC_PATH)")
 283
 284 # Needed by "meson install"
 285 export DESTDIR
 286
 287 include $(SRC_PATH)/tests/lcitool/Makefile.include
 288 include $(SRC_PATH)/tests/docker/Makefile.include
 289 include $(SRC_PATH)/tests/vm/Makefile.include
 290
 291 print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
 292 print-help = @$(call print-help-run,$1,$2)
 293
 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 ifeq ($(CONFIG_PLUGIN),y)
 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  'Test targets:'
 315         $(call print-help,check,Run all tests (check-help for details))
 316         $(call print-help,bench,Run all benchmarks)
 317         $(call print-help,lcitool-help,Help about targets for managing build environment manifests)
 318         $(call print-help,docker-help,Help about targets running tests inside containers)
 319         $(call print-help,vm-help,Help about targets running tests inside VM)
 320         @echo  ''
 321         @echo  'Documentation targets:'
 322         $(call print-help,html man,Build documentation in specified format)
 323         @echo  ''
 324 ifdef CONFIG_WIN32
 325         @echo  'Windows targets:'
 326         $(call print-help,installer,Build NSIS-based installer for QEMU)
 327         $(call print-help,msi,Build MSI-based installer for qemu-ga)
 328         @echo  ''
 329 endif
 330         $(call print-help,$(MAKE) [targets],(quiet build, default))
 331         $(call print-help,$(MAKE) V=1 [targets],(verbose build))
 332
 333 # will delete the target of a rule if commands exit with a nonzero exit status
 334 .DELETE_ON_ERROR:
 335
 336 print-%:
 337         @echo '$*=$($*)'