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