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 # Usage: $(call quiet-command,command and args,"NAME","args to print")
  18 # This will run "command and args", and either:
  19 #  if V=1 just print the whole command and args
  20 #  otherwise print the 'quiet' output in the format "  NAME     args to print"
  21 # NAME should be a short name of the command, 7 letters or fewer.
  22 # If called with only a single argument, will print nothing in quiet mode.
  23 quiet-command-run = $(if $(V),,$(if $2,printf "  %-7s %s\n" $2 $3 && ))$1
  24 quiet-@ = $(if $(V),,@)
  25 quiet-command = $(quiet-@)$(call quiet-command-run,$1,$2,$3)
  26
  27 UNCHECKED_GOALS := %clean TAGS cscope ctags dist \
  28     help check-help print-% \
  29     docker docker-% vm-help vm-test vm-build-%
  30
  31 # All following code might depend on configuration variables
  32 ifneq ($(wildcard config-host.mak),)
  33 # Put the all: rule here so that config-host.mak can contain dependencies.
  34 all:
  35 include config-host.mak
  36
  37 git-submodule-update:
  38
  39 .PHONY: git-submodule-update
  40
  41 git_module_status := $(shell \
  42   cd '$(SRC_PATH)' && \
  43   GIT="$(GIT)" ./scripts/git-submodule.sh status $(GIT_SUBMODULES); \
  44   echo $$?; \
  45 )
  46
  47 ifeq (1,$(git_module_status))
  48 ifeq (no,$(GIT_UPDATE))
  49 git-submodule-update:
  50         $(call quiet-command, \
  51             echo && \
  52             echo "GIT submodule checkout is out of date. Please run" && \
  53             echo "  scripts/git-submodule.sh update $(GIT_SUBMODULES)" && \
  54             echo "from the source directory checkout $(SRC_PATH)" && \
  55             echo && \
  56             exit 1)
  57 else
  58 git-submodule-update:
  59         $(call quiet-command, \
  60           (cd $(SRC_PATH) && GIT="$(GIT)" ./scripts/git-submodule.sh update $(GIT_SUBMODULES)), \
  61           "GIT","$(GIT_SUBMODULES)")
  62 endif
  63 endif
  64
  65 export NINJA=./ninjatool
  66
  67 # Running meson regenerates both build.ninja and ninjatool, and that is
  68 # enough to prime the rest of the build.
  69 ninjatool: build.ninja
  70
  71 Makefile.ninja: build.ninja ninjatool
  72         ./ninjatool -t ninja2make --omit clean dist uninstall cscope TAGS ctags < $< > $@
  73 -include Makefile.ninja
  74
  75 ${ninja-targets-c_COMPILER} ${ninja-targets-cpp_COMPILER}: .var.command += -MP
  76
  77 # If MESON is empty, the rule will be re-evaluated after Makefiles are
  78 # reread (and MESON won't be empty anymore).
  79 ifneq ($(MESON),)
  80 Makefile.mtest: build.ninja scripts/mtest2make.py
  81         $(MESON) introspect --targets --tests --benchmarks | $(PYTHON) scripts/mtest2make.py > $@
  82 -include Makefile.mtest
  83 endif
  84
  85 Makefile: .git-submodule-status
  86 .git-submodule-status: git-submodule-update config-host.mak
  87
  88 # Check that we're not trying to do an out-of-tree build from
  89 # a tree that's been used for an in-tree build.
  90 ifneq ($(realpath $(SRC_PATH)),$(realpath .))
  91 ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
  92 $(error This is an out of tree build but your source tree ($(SRC_PATH)) \
  93 seems to have been used for an in-tree build. You can fix this by running \
  94 "$(MAKE) distclean && rm -rf *-linux-user *-softmmu" in your source tree)
  95 endif
  96 endif
  97
  98 config-host.mak: $(SRC_PATH)/configure $(SRC_PATH)/pc-bios $(SRC_PATH)/VERSION
  99         @echo $@ is out-of-date, running configure
 100         @if test -f meson-private/coredata.dat; then \
 101           ./config.status --skip-meson; \
 102         else \
 103           ./config.status; \
 104         fi
 105
 106 # Force configure to re-run if the API symbols are updated
 107 ifeq ($(CONFIG_PLUGIN),y)
 108 config-host.mak: $(SRC_PATH)/plugins/qemu-plugins.symbols
 109
 110 .PHONY: plugins
 111 plugins:
 112         $(call quiet-command,\
 113                 $(MAKE) $(SUBDIR_MAKEFLAGS) -C contrib/plugins V="$(V)", \
 114                 "BUILD", "example plugins")
 115 endif
 116
 117 else
 118 config-host.mak:
 119 ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
 120         @echo "Please call configure before running make!"
 121         @exit 1
 122 endif
 123 endif
 124
 125 # Only needed in case Makefile.ninja does not exist.
 126 .PHONY: ninja-clean ninja-distclean clean-ctlist
 127 clean-ctlist:
 128 ninja-clean::
 129 ninja-distclean::
 130 build.ninja: config-host.mak
 131
 132 # Don't try to regenerate Makefile or configure
 133 # We don't generate any of them
 134 Makefile: ;
 135 configure: ;
 136
 137 .PHONY: all clean distclean install \
 138         recurse-all dist msi FORCE
 139
 140 SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet)
 141
 142 include $(SRC_PATH)/tests/Makefile.include
 143
 144 all: recurse-all
 145 Makefile:
 146
 147 ROM_DIRS = $(addprefix pc-bios/, $(ROMS))
 148 ROM_DIRS_RULES=$(foreach t, all clean, $(addsuffix /$(t), $(ROM_DIRS)))
 149 # Only keep -O and -g cflags
 150 .PHONY: $(ROM_DIRS_RULES)
 151 $(ROM_DIRS_RULES):
 152         $(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
 153
 154 .PHONY: recurse-all recurse-clean
 155 recurse-all: $(addsuffix /all, $(ROM_DIRS))
 156 recurse-clean: $(addsuffix /clean, $(ROM_DIRS))
 157
 158 ######################################################################
 159
 160 clean: recurse-clean ninja-clean clean-ctlist
 161         if test -f ninjatool; then ./ninjatool $(if $(V),-v,) -t clean; fi
 162 # avoid old build problems by removing potentially incorrect old files
 163         rm -f config.mak op-i386.h opc-i386.h gen-op-i386.h op-arm.h opc-arm.h gen-op-arm.h
 164         find . \( -name '*.so' -o -name '*.dll' -o -name '*.[oda]' \) -type f \
 165                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
 166                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
 167                 -exec rm {} +
 168         rm -f TAGS cscope.* *.pod *~ */*~
 169         rm -f fsdev/*.pod scsi/*.pod
 170
 171 VERSION = $(shell cat $(SRC_PATH)/VERSION)
 172
 173 dist: qemu-$(VERSION).tar.bz2
 174
 175 qemu-%.tar.bz2:
 176         $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
 177
 178 distclean: clean ninja-distclean
 179         -test -f ninjatool && ./ninjatool $(if $(V),-v,) -t clean -g
 180         rm -f config-host.mak config-host.h*
 181         rm -f tests/tcg/config-*.mak
 182         rm -f config-all-disas.mak config.status
 183         rm -f tests/qemu-iotests/common.env
 184         rm -f roms/seabios/config.mak roms/vgabios/config.mak
 185         rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
 186         rm -f *-config-target.h *-config-devices.mak *-config-devices.h
 187         rm -rf meson-private meson-logs meson-info compile_commands.json
 188         rm -f Makefile.ninja ninjatool ninjatool.stamp Makefile.mtest
 189         rm -f config.log
 190         rm -f linux-headers/asm
 191         rm -Rf .sdk
 192
 193 find-src-path = find "$(SRC_PATH)/" -path "$(SRC_PATH)/meson" -prune -o -name "*.[chsS]"
 194
 195 .PHONY: ctags
 196 ctags:
 197         rm -f "$(SRC_PATH)/"tags
 198         $(find-src-path) -exec ctags -f "$(SRC_PATH)/"tags --append {} +
 199
 200 .PHONY: TAGS
 201 TAGS:
 202         rm -f "$(SRC_PATH)/"TAGS
 203         $(find-src-path) -exec etags -f "$(SRC_PATH)/"TAGS --append {} +
 204
 205 .PHONY: cscope
 206 cscope:
 207         rm -f "$(SRC_PATH)"/cscope.*
 208         $(find-src-path) -print | sed -e 's,^\./,,' > "$(SRC_PATH)/cscope.files"
 209         cscope -b -i"$(SRC_PATH)/cscope.files" -f"$(SRC_PATH)"/cscope.out
 210
 211 # Needed by "meson install"
 212 export DESTDIR
 213
 214 include $(SRC_PATH)/tests/docker/Makefile.include
 215 include $(SRC_PATH)/tests/vm/Makefile.include
 216
 217 print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
 218 print-help = $(quiet-@)$(call print-help-run,$1,$2)
 219
 220 .PHONY: help
 221 help:
 222         @echo  'Generic targets:'
 223         $(call print-help,all,Build all)
 224         $(call print-help,dir/file.o,Build specified target only)
 225         $(call print-help,install,Install QEMU, documentation and tools)
 226         $(call print-help,ctags/TAGS,Generate tags file for editors)
 227         $(call print-help,cscope,Generate cscope index)
 228         $(call print-help,sparse,Run sparse on the QEMU source)
 229         @echo  ''
 230 ifeq ($(CONFIG_PLUGIN),y)
 231         @echo  'Plugin targets:'
 232         $(call print-help,plugins,Build the example TCG plugins)
 233         @echo  ''
 234 endif
 235         @echo  'Cleaning targets:'
 236         $(call print-help,clean,Remove most generated files but keep the config)
 237         $(call print-help,distclean,Remove all generated files)
 238         $(call print-help,dist,Build a distributable tarball)
 239         @echo  ''
 240         @echo  'Test targets:'
 241         $(call print-help,check,Run all tests (check-help for details))
 242         $(call print-help,bench,Run all benchmarks)
 243         $(call print-help,docker,Help about targets running tests inside containers)
 244         $(call print-help,vm-help,Help about targets running tests inside VM)
 245         @echo  ''
 246         @echo  'Documentation targets:'
 247         $(call print-help,html man,Build documentation in specified format)
 248         @echo  ''
 249 ifdef CONFIG_WIN32
 250         @echo  'Windows targets:'
 251         $(call print-help,installer,Build NSIS-based installer for QEMU)
 252 ifdef CONFIG_QGA_MSI
 253         $(call print-help,msi,Build MSI-based installer for qemu-ga)
 254 endif
 255         @echo  ''
 256 endif
 257         $(call print-help,$(MAKE) [targets],(quiet build, default))
 258         $(call print-help,$(MAKE) V=1 [targets],(verbose build))
 259
 260 # will delete the target of a rule if commands exit with a nonzero exit status
 261 .DELETE_ON_ERROR:
 262
 263 print-%:
 264         @echo '$*=$($*)'