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 UNCHECKED_GOALS := %clean TAGS cscope ctags dist \
  14     html info pdf txt \
  15     help check-help print-% \
  16     docker docker-% vm-help vm-test vm-build-%
  17
  18 # All following code might depend on configuration variables
  19 ifneq ($(wildcard config-host.mak),)
  20 # Put the all: rule here so that config-host.mak can contain dependencies.
  21 all:
  22 include config-host.mak
  23
  24 git-submodule-update:
  25
  26 .PHONY: git-submodule-update
  27
  28 git_module_status := $(shell \
  29   cd '$(SRC_PATH)' && \
  30   GIT="$(GIT)" ./scripts/git-submodule.sh status $(GIT_SUBMODULES); \
  31   echo $$?; \
  32 )
  33
  34 ifeq (1,$(git_module_status))
  35 ifeq (no,$(GIT_UPDATE))
  36 git-submodule-update:
  37         $(call quiet-command, \
  38             echo && \
  39             echo "GIT submodule checkout is out of date. Please run" && \
  40             echo "  scripts/git-submodule.sh update $(GIT_SUBMODULES)" && \
  41             echo "from the source directory checkout $(SRC_PATH)" && \
  42             echo && \
  43             exit 1)
  44 else
  45 git-submodule-update:
  46         $(call quiet-command, \
  47           (cd $(SRC_PATH) && GIT="$(GIT)" ./scripts/git-submodule.sh update $(GIT_SUBMODULES)), \
  48           "GIT","$(GIT_SUBMODULES)")
  49 endif
  50 endif
  51
  52 export NINJA=./ninjatool
  53
  54 # Running meson regenerates both build.ninja and ninjatool, and that is
  55 # enough to prime the rest of the build.
  56 ninjatool: build.ninja
  57
  58 # Only needed in case Makefile.ninja does not exist.
  59 .PHONY: ninja-clean ninja-distclean clean-ctlist
  60 clean-ctlist:
  61 ninja-clean::
  62 ninja-distclean::
  63 build.ninja: config-host.mak
  64
  65 Makefile.ninja: build.ninja ninjatool
  66         ./ninjatool -t ninja2make --omit clean dist uninstall < $< > $@
  67 -include Makefile.ninja
  68
  69 ${ninja-targets-c_COMPILER} ${ninja-targets-cpp_COMPILER}: .var.command += -MP
  70
  71 # If MESON is empty, the rule will be re-evaluated after Makefiles are
  72 # reread (and MESON won't be empty anymore).
  73 ifneq ($(MESON),)
  74 Makefile.mtest: build.ninja scripts/mtest2make.py
  75         $(MESON) introspect --tests | $(PYTHON) scripts/mtest2make.py > $@
  76 -include Makefile.mtest
  77 endif
  78
  79 .git-submodule-status: git-submodule-update config-host.mak
  80
  81 # Check that we're not trying to do an out-of-tree build from
  82 # a tree that's been used for an in-tree build.
  83 ifneq ($(realpath $(SRC_PATH)),$(realpath .))
  84 ifneq ($(wildcard $(SRC_PATH)/config-host.mak),)
  85 $(error This is an out of tree build but your source tree ($(SRC_PATH)) \
  86 seems to have been used for an in-tree build. You can fix this by running \
  87 "$(MAKE) distclean && rm -rf *-linux-user *-softmmu" in your source tree)
  88 endif
  89 endif
  90
  91 CONFIG_SOFTMMU := $(if $(filter %-softmmu,$(TARGET_DIRS)),y)
  92 CONFIG_USER_ONLY := $(if $(filter %-user,$(TARGET_DIRS)),y)
  93 CONFIG_XEN := $(CONFIG_XEN_BACKEND)
  94 CONFIG_ALL=y
  95 -include config-all-devices.mak
  96 -include config-all-disas.mak
  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 endif
 110
 111 else
 112 config-host.mak:
 113 ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
 114         @echo "Please call configure before running make!"
 115         @exit 1
 116 endif
 117 endif
 118
 119 include $(SRC_PATH)/rules.mak
 120
 121 # lor is defined in rules.mak
 122 CONFIG_BLOCK := $(call lor,$(CONFIG_SOFTMMU),$(CONFIG_TOOLS))
 123
 124 generated-files-y += module_block.h
 125 generated-files-y += target/s390x/gen-features.h
 126 target/s390x/gen-features.h: Makefile.ninja
 127
 128 generated-files-y += .git-submodule-status
 129
 130 # Don't try to regenerate Makefile or configure
 131 # We don't generate any of them
 132 Makefile: ;
 133 configure: ;
 134
 135 .PHONY: all clean cscope distclean html info install install-doc \
 136         pdf txt recurse-all dist msi FORCE
 137
 138 $(call set-vpath, $(SRC_PATH))
 139
 140 LIBS+=-lz $(LIBS_TOOLS)
 141
 142 HELPERS-y = $(HELPERS)
 143
 144 # Sphinx does not allow building manuals into the same directory as
 145 # the source files, so if we're doing an in-tree QEMU build we must
 146 # build the manuals into a subdirectory (and then install them from
 147 # there for 'make install'). For an out-of-tree build we can just
 148 # use the docs/ subdirectory in the build tree as normal.
 149 ifeq ($(realpath $(SRC_PATH)),$(realpath .))
 150 MANUAL_BUILDDIR := docs/built
 151 else
 152 MANUAL_BUILDDIR := docs
 153 endif
 154
 155 ifdef BUILD_DOCS
 156 DOCS+=$(MANUAL_BUILDDIR)/system/qemu.1
 157 DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-img.1
 158 DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-nbd.8
 159 DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga.8
 160 ifeq ($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_NG),yyy)
 161 DOCS+=$(MANUAL_BUILDDIR)/tools/virtiofsd.1
 162 endif
 163 DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
 164 DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7
 165 DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7
 166 DOCS+=$(MANUAL_BUILDDIR)/system/qemu-cpu-models.7
 167 DOCS+=$(MANUAL_BUILDDIR)/index.html
 168 ifdef CONFIG_VIRTFS
 169 DOCS+=$(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1
 170 endif
 171 ifdef CONFIG_TRACE_SYSTEMTAP
 172 DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-trace-stap.1
 173 endif
 174 else
 175 DOCS=
 176 endif
 177
 178 SUBDIR_MAKEFLAGS=$(if $(V),,--no-print-directory --quiet) BUILD_DIR=$(BUILD_DIR)
 179
 180 ifneq ($(wildcard config-host.mak),)
 181 include $(SRC_PATH)/Makefile.objs
 182 endif
 183
 184 dummy := $(call unnest-vars,, \
 185                 chardev-obj-y \
 186                 block-obj-y \
 187                 block-obj-m \
 188                 storage-daemon-obj-y \
 189                 storage-daemon-obj-m \
 190                 common-obj-y \
 191                 common-obj-m)
 192
 193 include $(SRC_PATH)/tests/Makefile.include
 194
 195 all: $(DOCS) $(if $(BUILD_DOCS),sphinxdocs) $(TOOLS) $(HELPERS-y) recurse-all modules
 196
 197 config-host.h: config-host.h-timestamp
 198 config-host.h-timestamp: config-host.mak
 199
 200 TARGET_DIRS_RULES := $(foreach t, all fuzz clean install, $(addsuffix /$(t), $(TARGET_DIRS)))
 201
 202 SOFTMMU_ALL_RULES=$(filter %-softmmu/all, $(TARGET_DIRS_RULES))
 203 $(SOFTMMU_ALL_RULES): $(authz-obj-y)
 204 $(SOFTMMU_ALL_RULES): $(block-obj-y)
 205 $(SOFTMMU_ALL_RULES): $(storage-daemon-obj-y)
 206 $(SOFTMMU_ALL_RULES): $(chardev-obj-y)
 207 $(SOFTMMU_ALL_RULES): $(crypto-obj-y)
 208 $(SOFTMMU_ALL_RULES): $(io-obj-y)
 209 $(SOFTMMU_ALL_RULES): $(qom-obj-y)
 210 $(SOFTMMU_ALL_RULES): config-all-devices.mak
 211
 212 SOFTMMU_FUZZ_RULES=$(filter %-softmmu/fuzz, $(TARGET_DIRS_RULES))
 213 $(SOFTMMU_FUZZ_RULES): $(authz-obj-y)
 214 $(SOFTMMU_FUZZ_RULES): $(block-obj-y)
 215 $(SOFTMMU_FUZZ_RULES): $(chardev-obj-y)
 216 $(SOFTMMU_FUZZ_RULES): $(crypto-obj-y)
 217 $(SOFTMMU_FUZZ_RULES): $(io-obj-y)
 218 $(SOFTMMU_FUZZ_RULES): config-all-devices.mak
 219 $(SOFTMMU_FUZZ_RULES): $(edk2-decompressed)
 220
 221 # meson: this is sub-optimal but going away after conversion
 222 TARGET_DEPS = $(patsubst %,%-config-target.h, $(TARGET_DIRS))
 223 TARGET_DEPS += $(patsubst %,%-config-devices.h, $(filter %-softmmu,$(TARGET_DIRS)))
 224 TARGET_DEPS += $(patsubst %,libqemu-%.fa, $(TARGET_DIRS))
 225
 226 .PHONY: $(TARGET_DIRS_RULES)
 227 # The $(TARGET_DIRS_RULES) are of the form SUBDIR/GOAL, so that
 228 # $(dir $@) yields the sub-directory, and $(notdir $@) yields the sub-goal
 229 $(TARGET_DIRS_RULES): $(TARGET_DEPS)
 230         $(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" $(notdir $@),)
 231
 232 # LIBFDT_lib="": avoid breaking existing trees with objects requiring -fPIC
 233 DTC_MAKE_ARGS=-I$(SRC_PATH)/dtc VPATH=$(SRC_PATH)/dtc -C dtc V="$(V)" LIBFDT_lib=""
 234 DTC_CFLAGS=$(CFLAGS) $(QEMU_CFLAGS)
 235 DTC_CPPFLAGS=-I$(SRC_PATH)/dtc/libfdt
 236
 237 .PHONY: dtc/all
 238 dtc/all: .git-submodule-status dtc/libfdt
 239         $(call quiet-command,$(MAKE) $(DTC_MAKE_ARGS) CPPFLAGS="$(DTC_CPPFLAGS)" CFLAGS="$(DTC_CFLAGS)" LDFLAGS="$(QEMU_LDFLAGS)" ARFLAGS="$(ARFLAGS)" CC="$(CC)" AR="$(AR)" LD="$(LD)" $(SUBDIR_MAKEFLAGS) libfdt,)
 240
 241 dtc/%: .git-submodule-status
 242         @mkdir -p $@
 243
 244 # Overriding CFLAGS causes us to lose defines added in the sub-makefile.
 245 # Not overriding CFLAGS leads to mis-matches between compilation modes.
 246 # Therefore we replicate some of the logic in the sub-makefile.
 247 # Remove all the extra -Warning flags that QEMU uses that Capstone doesn't;
 248 # no need to annoy QEMU developers with such things.
 249 CAP_CFLAGS = $(patsubst -W%,,$(CFLAGS) $(QEMU_CFLAGS))
 250 CAP_CFLAGS += -DCAPSTONE_USE_SYS_DYN_MEM
 251 CAP_CFLAGS += -DCAPSTONE_HAS_ARM
 252 CAP_CFLAGS += -DCAPSTONE_HAS_ARM64
 253 CAP_CFLAGS += -DCAPSTONE_HAS_POWERPC
 254 CAP_CFLAGS += -DCAPSTONE_HAS_X86
 255
 256 .PHONY: capstone/all
 257 capstone/all: .git-submodule-status
 258         $(call quiet-command,$(MAKE) -C $(SRC_PATH)/capstone CAPSTONE_SHARED=no BUILDDIR="$(BUILD_DIR)/capstone" CC="$(CC)" AR="$(AR)" LD="$(LD)" RANLIB="$(RANLIB)" CFLAGS="$(CAP_CFLAGS)" $(SUBDIR_MAKEFLAGS) $(BUILD_DIR)/capstone/$(LIBCAPSTONE))
 259
 260 .PHONY: slirp/all
 261 slirp/all: .git-submodule-status
 262         $(call quiet-command,$(MAKE) -C $(SRC_PATH)/slirp               \
 263                 BUILD_DIR="$(BUILD_DIR)/slirp"                  \
 264                 PKG_CONFIG="$(PKG_CONFIG)"                              \
 265                 CC="$(CC)" AR="$(AR)"   LD="$(LD)" RANLIB="$(RANLIB)"   \
 266                 CFLAGS="$(QEMU_CFLAGS) $(CFLAGS)" LDFLAGS="$(QEMU_LDFLAGS)")
 267
 268 $(filter %/all, $(TARGET_DIRS_RULES)): libqemuutil.a $(common-obj-y) \
 269         $(qom-obj-y)
 270
 271 $(filter %/fuzz, $(TARGET_DIRS_RULES)): libqemuutil.a $(common-obj-y) \
 272         $(qom-obj-y) $(crypto-user-obj-$(CONFIG_USER_ONLY))
 273
 274 ROM_DIRS = $(addprefix pc-bios/, $(ROMS))
 275 ROM_DIRS_RULES=$(foreach t, all clean, $(addsuffix /$(t), $(ROM_DIRS)))
 276 # Only keep -O and -g cflags
 277 .PHONY: $(ROM_DIRS_RULES)
 278 $(ROM_DIRS_RULES):
 279         $(call quiet-command,$(MAKE) $(SUBDIR_MAKEFLAGS) -C $(dir $@) V="$(V)" TARGET_DIR="$(dir $@)" CFLAGS="$(filter -O% -g%,$(CFLAGS))" $(notdir $@),)
 280
 281 .PHONY: recurse-all recurse-clean recurse-install
 282 recurse-all: $(addsuffix /all, $(TARGET_DIRS) $(ROM_DIRS))
 283 recurse-clean: $(addsuffix /clean, $(TARGET_DIRS) $(ROM_DIRS))
 284 recurse-install: $(addsuffix /install, $(TARGET_DIRS))
 285 $(addsuffix /install, $(TARGET_DIRS)): all
 286
 287 $(BUILD_DIR)/version.o: $(SRC_PATH)/version.rc config-host.h
 288         $(call quiet-command,$(WINDRES) -I$(BUILD_DIR) -o $@ $<,"RC","version.o")
 289
 290 Makefile: $(version-obj-y)
 291
 292 ######################################################################
 293
 294 COMMON_LDADDS = libqemuutil.a
 295
 296 qemu-img.o: qemu-img-cmds.h
 297
 298 qemu-img$(EXESUF): qemu-img.o $(authz-obj-y) $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS)
 299 qemu-nbd$(EXESUF): qemu-nbd.o $(authz-obj-y) $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS)
 300 qemu-io$(EXESUF): qemu-io.o $(authz-obj-y) $(block-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS)
 301 qemu-storage-daemon$(EXESUF): qemu-storage-daemon.o $(authz-obj-y) $(block-obj-y) $(crypto-obj-y) $(chardev-obj-y) $(io-obj-y) $(qom-obj-y) $(storage-daemon-obj-y) $(COMMON_LDADDS)
 302
 303 scsi/qemu-pr-helper$(EXESUF): scsi/qemu-pr-helper.o scsi/utils.o $(authz-obj-y) $(crypto-obj-y) $(io-obj-y) $(qom-obj-y) $(COMMON_LDADDS)
 304 ifdef CONFIG_MPATH
 305 scsi/qemu-pr-helper$(EXESUF): LIBS += -ludev -lmultipath -lmpathpersist
 306 endif
 307
 308 module_block.h: $(SRC_PATH)/scripts/modules/module_block.py config-host.mak
 309         $(call quiet-command,$(PYTHON) $< $@ \
 310         $(addprefix $(SRC_PATH)/,$(patsubst %.mo,%.c,$(block-obj-m))), \
 311         "GEN","$@")
 312
 313 clean: recurse-clean ninja-clean clean-ctlist
 314         -test -f ninjatool && ./ninjatool $(if $(V),-v,) -t clean
 315 # avoid old build problems by removing potentially incorrect old files
 316         rm -f config.mak op-i386.h opc-i386.h gen-op-i386.h op-arm.h opc-arm.h gen-op-arm.h
 317         find . \( -name '*.so' -o -name '*.dll' -o -name '*.mo' -o -name '*.[oda]' \) -type f \
 318                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-aarch64.a \
 319                 ! -path ./roms/edk2/ArmPkg/Library/GccLto/liblto-arm.a \
 320                 ! -path ./roms/edk2/BaseTools/Source/Python/UPT/Dll/sqlite3.dll \
 321                 -exec rm {} +
 322         rm -f $(filter-out %.tlb,$(TOOLS)) $(HELPERS-y) TAGS cscope.* *.pod *~ */*~
 323         rm -f fsdev/*.pod scsi/*.pod
 324         rm -f $(foreach f,$(generated-files-y),$(f) $(f)-timestamp)
 325
 326 VERSION ?= $(shell cat VERSION)
 327
 328 dist: qemu-$(VERSION).tar.bz2
 329
 330 qemu-%.tar.bz2:
 331         $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst qemu-%.tar.bz2,%,$@)"
 332
 333 define clean-manual =
 334 rm -rf $(MANUAL_BUILDDIR)/$1/_static
 335 rm -f $(MANUAL_BUILDDIR)/$1/objects.inv $(MANUAL_BUILDDIR)/$1/searchindex.js $(MANUAL_BUILDDIR)/$1/*.html
 336 endef
 337
 338 distclean: clean ninja-distclean
 339         -test -f ninjatool && ./ninjatool $(if $(V),-v,) -t clean -g
 340         rm -f config-host.mak config-host.h* $(DOCS)
 341         rm -f tests/tcg/config-*.mak
 342         rm -f config-all-disas.mak config.status
 343         rm -f po/*.mo tests/qemu-iotests/common.env
 344         rm -f roms/seabios/config.mak roms/vgabios/config.mak
 345         rm -f qemu-plugins-ld.symbols qemu-plugins-ld64.symbols
 346         rm -rf meson-private meson-logs meson-info compile_commands.json
 347         rm -f Makefile.ninja ninjatool ninjatool.stamp Makefile.mtest
 348         rm -f config.log
 349         rm -f linux-headers/asm
 350         rm -f docs/version.texi
 351         rm -f docs/interop/qemu-ga-qapi.texi docs/interop/qemu-qmp-qapi.texi
 352         rm -f docs/interop/qemu-qmp-ref.7 docs/interop/qemu-ga-ref.7
 353         rm -f docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
 354         rm -f docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
 355         rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html
 356         rm -rf .doctrees
 357         $(call clean-manual,devel)
 358         $(call clean-manual,interop)
 359         $(call clean-manual,specs)
 360         $(call clean-manual,system)
 361         $(call clean-manual,tools)
 362         $(call clean-manual,user)
 363         for d in $(TARGET_DIRS); do \
 364         rm -rf $$d || exit 1 ; \
 365         done
 366         rm -Rf .sdk
 367
 368 KEYMAPS=da     en-gb  et  fr     fr-ch  is  lt  no  pt-br  sv \
 369 ar      de     en-us  fi  fr-be  hr     it  lv  nl         pl  ru     th \
 370 de-ch  es     fo  fr-ca  hu     ja  mk  pt  sl     tr \
 371 bepo    cz
 372
 373 ifdef INSTALL_BLOBS
 374 BLOBS=bios.bin bios-256k.bin bios-microvm.bin sgabios.bin vgabios.bin vgabios-cirrus.bin \
 375 vgabios-stdvga.bin vgabios-vmware.bin vgabios-qxl.bin vgabios-virtio.bin \
 376 vgabios-ramfb.bin vgabios-bochs-display.bin vgabios-ati.bin \
 377 openbios-sparc32 openbios-sparc64 openbios-ppc QEMU,tcx.bin QEMU,cgthree.bin \
 378 pxe-e1000.rom pxe-eepro100.rom pxe-ne2k_pci.rom \
 379 pxe-pcnet.rom pxe-rtl8139.rom pxe-virtio.rom \
 380 efi-e1000.rom efi-eepro100.rom efi-ne2k_pci.rom \
 381 efi-pcnet.rom efi-rtl8139.rom efi-virtio.rom \
 382 efi-e1000e.rom efi-vmxnet3.rom \
 383 qemu-nsis.bmp \
 384 bamboo.dtb canyonlands.dtb petalogix-s3adsp1800.dtb petalogix-ml605.dtb \
 385 multiboot.bin linuxboot.bin linuxboot_dma.bin kvmvapic.bin pvh.bin \
 386 s390-ccw.img s390-netboot.img \
 387 slof.bin skiboot.lid \
 388 palcode-clipper \
 389 u-boot.e500 u-boot-sam460-20100605.bin \
 390 qemu_vga.ndrv \
 391 edk2-licenses.txt \
 392 hppa-firmware.img \
 393 opensbi-riscv32-sifive_u-fw_jump.bin opensbi-riscv32-virt-fw_jump.bin \
 394 opensbi-riscv64-sifive_u-fw_jump.bin opensbi-riscv64-virt-fw_jump.bin
 395 else
 396 BLOBS=
 397 endif
 398
 399 # Note that we manually filter-out the non-Sphinx documentation which
 400 # is currently built into the docs/interop directory in the build tree,
 401 # and also any sphinx-built manpages.
 402 define install-manual =
 403 for d in $$(cd $(MANUAL_BUILDDIR) && find $1 -type d); do $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/$$d"; done
 404 for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name '*.[0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-*-ref.*' ')' ); do $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done
 405 endef
 406
 407 # Note that we deliberately do not install the "devel" manual: it is
 408 # for QEMU developers, and not interesting to our users.
 409 .PHONY: install-sphinxdocs
 410 install-sphinxdocs: sphinxdocs
 411         $(call install-manual,interop)
 412         $(call install-manual,specs)
 413         $(call install-manual,system)
 414         $(call install-manual,tools)
 415         $(call install-manual,user)
 416
 417 install-doc: $(DOCS) install-sphinxdocs
 418         $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
 419         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
 420         $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
 421         $(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
 422         $(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
 423 ifdef CONFIG_POSIX
 424         $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
 425         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu.1 "$(DESTDIR)$(mandir)/man1"
 426         $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7"
 427         $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7"
 428         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7"
 429         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7"
 430 ifeq ($(CONFIG_TOOLS),y)
 431         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-img.1 "$(DESTDIR)$(mandir)/man1"
 432         $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8"
 433         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-nbd.8 "$(DESTDIR)$(mandir)/man8"
 434 endif
 435 ifdef CONFIG_TRACE_SYSTEMTAP
 436         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-trace-stap.1 "$(DESTDIR)$(mandir)/man1"
 437 endif
 438 ifeq ($(CONFIG_GUEST_AGENT),y)
 439         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
 440         $(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
 441         $(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
 442         $(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
 443         $(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7"
 444 endif
 445 endif
 446 ifdef CONFIG_VIRTFS
 447         $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
 448         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1 "$(DESTDIR)$(mandir)/man1"
 449 endif
 450 ifeq ($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_NG),yyy)
 451         $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/virtiofsd.1 "$(DESTDIR)$(mandir)/man1"
 452 endif
 453
 454 install-datadir:
 455         $(INSTALL_DIR) "$(DESTDIR)$(qemu_datadir)"
 456
 457 install-localstatedir:
 458 ifdef CONFIG_POSIX
 459 ifeq ($(CONFIG_GUEST_AGENT),y)
 460         $(INSTALL_DIR) "$(DESTDIR)$(qemu_localstatedir)"/run
 461 endif
 462 endif
 463
 464 ICON_SIZES=16x16 24x24 32x32 48x48 64x64 128x128 256x256 512x512
 465
 466 install-includedir:
 467         $(INSTALL_DIR) "$(DESTDIR)$(includedir)"
 468
 469 # Needed by "meson install"
 470 export DESTDIR
 471 install: all $(if $(BUILD_DOCS),install-doc) \
 472         install-datadir install-localstatedir install-includedir \
 473         recurse-install
 474 ifneq ($(TOOLS),)
 475         $(call install-prog,$(TOOLS),$(DESTDIR)$(bindir))
 476 endif
 477 ifneq ($(CONFIG_MODULES),)
 478         $(INSTALL_DIR) "$(DESTDIR)$(qemu_moddir)"
 479         for s in $(modules-m:.mo=$(DSOSUF)); do \
 480                 t="$(DESTDIR)$(qemu_moddir)/$$(echo $$s | tr / -)"; \
 481                 $(INSTALL_LIB) $$s "$$t"; \
 482                 test -z "$(STRIP)" || $(STRIP) "$$t"; \
 483         done
 484 endif
 485 ifneq ($(HELPERS-y),)
 486         $(call install-prog,$(HELPERS-y),$(DESTDIR)$(libexecdir))
 487 endif
 488 ifdef CONFIG_TRACE_SYSTEMTAP
 489         $(INSTALL_PROG) "scripts/qemu-trace-stap" $(DESTDIR)$(bindir)
 490 endif
 491 ifneq ($(BLOBS),)
 492         set -e; for x in $(BLOBS); do \
 493                 $(INSTALL_DATA) $(SRC_PATH)/pc-bios/$$x "$(DESTDIR)$(qemu_datadir)"; \
 494         done
 495 endif
 496         for s in $(ICON_SIZES); do \
 497                 mkdir -p "$(DESTDIR)$(qemu_icondir)/hicolor/$${s}/apps"; \
 498                 $(INSTALL_DATA) $(SRC_PATH)/ui/icons/qemu_$${s}.png \
 499                         "$(DESTDIR)$(qemu_icondir)/hicolor/$${s}/apps/qemu.png"; \
 500         done; \
 501         mkdir -p "$(DESTDIR)$(qemu_icondir)/hicolor/32x32/apps"; \
 502         $(INSTALL_DATA) $(SRC_PATH)/ui/icons/qemu_32x32.bmp \
 503                 "$(DESTDIR)$(qemu_icondir)/hicolor/32x32/apps/qemu.bmp"; \
 504         mkdir -p "$(DESTDIR)$(qemu_icondir)/hicolor/scalable/apps"; \
 505         $(INSTALL_DATA) $(SRC_PATH)/ui/icons/qemu.svg \
 506                 "$(DESTDIR)$(qemu_icondir)/hicolor/scalable/apps/qemu.svg"
 507         mkdir -p "$(DESTDIR)$(qemu_desktopdir)"
 508         $(INSTALL_DATA) $(SRC_PATH)/ui/qemu.desktop \
 509                 "$(DESTDIR)$(qemu_desktopdir)/qemu.desktop"
 510 ifdef CONFIG_GTK
 511         $(MAKE) -C po $@
 512 endif
 513 ifeq ($(CONFIG_PLUGIN),y)
 514         $(INSTALL_DATA) $(SRC_PATH)/include/qemu/qemu-plugin.h "$(DESTDIR)$(includedir)/qemu-plugin.h"
 515 endif
 516         $(INSTALL_DIR) "$(DESTDIR)$(qemu_datadir)/keymaps"
 517         set -e; for x in $(KEYMAPS); do \
 518                 $(INSTALL_DATA) $(SRC_PATH)/pc-bios/keymaps/$$x "$(DESTDIR)$(qemu_datadir)/keymaps"; \
 519         done
 520         for d in $(TARGET_DIRS); do \
 521         $(MAKE) $(SUBDIR_MAKEFLAGS) TARGET_DIR=$$d/ -C $$d $@ || exit 1 ; \
 522         done
 523
 524 # documentation
 525 MAKEINFO=makeinfo
 526 MAKEINFOINCLUDES= -I docs -I $(<D) -I $(@D)
 527 MAKEINFOFLAGS=--no-split --number-sections $(MAKEINFOINCLUDES)
 528 TEXI2PODFLAGS=$(MAKEINFOINCLUDES) -DVERSION="$(VERSION)" -DCONFDIR="$(qemu_confdir)"
 529 TEXI2PDFFLAGS=$(if $(V),,--quiet) -I $(SRC_PATH) $(MAKEINFOINCLUDES)
 530
 531 docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
 532         $(call quiet-command,(\
 533                 echo "@set VERSION $(VERSION)" && \
 534                 echo "@set CONFDIR $(qemu_confdir)" \
 535         )> $@,"GEN","$@")
 536
 537 %.html: %.texi docs/version.texi
 538         $(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
 539         --html $< -o $@,"GEN","$@")
 540
 541 %.info: %.texi docs/version.texi
 542         $(call quiet-command,$(MAKEINFO) $(MAKEINFOFLAGS) $< -o $@,"GEN","$@")
 543
 544 %.txt: %.texi docs/version.texi
 545         $(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \
 546         --plaintext $< -o $@,"GEN","$@")
 547
 548 %.pdf: %.texi docs/version.texi
 549         $(call quiet-command,texi2pdf $(TEXI2PDFFLAGS) $< -o $@,"GEN","$@")
 550
 551 # Sphinx builds all its documentation at once in one invocation
 552 # and handles "don't rebuild things unless necessary" itself.
 553 # The '.doctrees' files are cached information to speed this up.
 554 .PHONY: sphinxdocs
 555 sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
 556             $(MANUAL_BUILDDIR)/interop/index.html \
 557             $(MANUAL_BUILDDIR)/specs/index.html \
 558             $(MANUAL_BUILDDIR)/system/index.html \
 559             $(MANUAL_BUILDDIR)/tools/index.html \
 560             $(MANUAL_BUILDDIR)/user/index.html
 561
 562 # Canned command to build a single manual
 563 # Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
 564 # Note the use of different doctree for each (manual, builder) tuple;
 565 # this works around Sphinx not handling parallel invocation on
 566 # a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946
 567 build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" $(SPHINX_BUILD) $(if $(V),,-q) $(SPHINX_WERROR) -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
 568 # We assume all RST files in the manual's directory are used in it
 569 manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst $(SRC_PATH)/docs/$1/*/*.rst) \
 570               $(SRC_PATH)/docs/defs.rst.inc \
 571               $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py \
 572               $(SRC_PATH)/docs/sphinx/*.py
 573 # Macro to write out the rule and dependencies for building manpages
 574 # Usage: $(call define-manpage-rule,manualname,manpage1 manpage2...[,extradeps])
 575 # 'extradeps' is optional, and specifies extra files (eg .hx files) that
 576 # the manual page depends on.
 577 define define-manpage-rule
 578 $(call atomic,$(foreach manpage,$2,$(MANUAL_BUILDDIR)/$1/$(manpage)),$(call manual-deps,$1) $3)
 579         $(call build-manual,$1,man)
 580 endef
 581
 582 $(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel)
 583         $(call build-manual,devel,html)
 584
 585 $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)
 586         $(call build-manual,interop,html)
 587
 588 $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
 589         $(call build-manual,specs,html)
 590
 591 $(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system) $(SRC_PATH)/hmp-commands.hx $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/qemu-options.hx
 592         $(call build-manual,system,html)
 593
 594 $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc
 595         $(call build-manual,tools,html)
 596
 597 $(MANUAL_BUILDDIR)/user/index.html: $(call manual-deps,user)
 598         $(call build-manual,user,html)
 599
 600 $(call define-manpage-rule,interop,qemu-ga.8)
 601
 602 $(call define-manpage-rule,system,qemu.1 qemu-block-drivers.7 qemu-cpu-models.7)
 603
 604 $(call define-manpage-rule,tools,\
 605        qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
 606        virtiofsd.1 virtfs-proxy-helper.1,\
 607        $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc)
 608
 609 $(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version.h
 610         @mkdir -p "$(MANUAL_BUILDDIR)"
 611         $(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \
 612              "GEN","$@")
 613
 614 docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi
 615         @cp -p $< $@
 616
 617 docs/interop/qemu-ga-qapi.texi: qga/qga-qapi-doc.texi
 618         @cp -p $< $@
 619
 620 html: docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html sphinxdocs
 621 info: docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info
 622 pdf: docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
 623 txt: docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
 624
 625 docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \
 626     docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \
 627     docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \
 628         docs/interop/qemu-ga-ref.texi docs/interop/qemu-ga-qapi.texi
 629
 630 docs/interop/qemu-qmp-ref.dvi docs/interop/qemu-qmp-ref.html \
 631     docs/interop/qemu-qmp-ref.info docs/interop/qemu-qmp-ref.pdf \
 632     docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7: \
 633         docs/interop/qemu-qmp-ref.texi docs/interop/qemu-qmp-qapi.texi
 634
 635 $(filter %.1 %.7 %.8,$(DOCS)): scripts/texi2pod.pl
 636
 637 # Reports/Analysis
 638
 639 %/coverage-report.html:
 640         @mkdir -p $*
 641         $(call quiet-command,\
 642                 gcovr -r $(SRC_PATH) \
 643                 $(foreach t, $(TARGET_DIRS), --object-directory $(BUILD_DIR)/$(t)) \
 644                  --object-directory $(BUILD_DIR) \
 645                 -p --html --html-details -o $@, \
 646                 "GEN", "coverage-report.html")
 647
 648 .PHONY: coverage-report
 649 coverage-report: $(CURDIR)/reports/coverage/coverage-report.html
 650
 651 ifdef CONFIG_WIN32
 652
 653 INSTALLER = qemu-setup-$(VERSION)$(EXESUF)
 654
 655 nsisflags = -V2 -NOCD
 656
 657 ifneq ($(wildcard $(SRC_PATH)/dll),)
 658 ifeq ($(ARCH),x86_64)
 659 # 64 bit executables
 660 DLL_PATH = $(SRC_PATH)/dll/w64
 661 nsisflags += -DW64
 662 else
 663 # 32 bit executables
 664 DLL_PATH = $(SRC_PATH)/dll/w32
 665 endif
 666 endif
 667
 668 .PHONY: installer
 669 installer: $(INSTALLER)
 670
 671 INSTDIR=/tmp/qemu-nsis
 672
 673 $(INSTALLER): $(SRC_PATH)/qemu.nsi
 674         $(MAKE) install DESTDIR=${INSTDIR}
 675 ifdef SIGNCODE
 676         (cd ${INSTDIR}/${bindir}; \
 677          for i in *.exe; do \
 678            $(SIGNCODE) $${i}; \
 679          done \
 680         )
 681 endif # SIGNCODE
 682         (cd ${INSTDIR}/${bindir}; \
 683          for i in qemu-system-*.exe; do \
 684            arch=$${i%.exe}; \
 685            arch=$${arch#qemu-system-}; \
 686            echo Section \"$$arch\" Section_$$arch; \
 687            echo SetOutPath \"\$$INSTDIR\"; \
 688            echo File \"\$${BINDIR}\\$$i\"; \
 689            echo SectionEnd; \
 690          done \
 691         ) >${INSTDIR}/${bindir}/system-emulations.nsh
 692         makensis $(nsisflags) \
 693                 $(if $(BUILD_DOCS),-DCONFIG_DOCUMENTATION="y") \
 694                 $(if $(CONFIG_GTK),-DCONFIG_GTK="y") \
 695                 -DBINDIR="${INSTDIR}/${bindir}" \
 696                 $(if $(DLL_PATH),-DDLLDIR="$(DLL_PATH)") \
 697                 -DSRCDIR="$(SRC_PATH)" \
 698                 -DOUTFILE="$(INSTALLER)" \
 699                 -DDISPLAYVERSION="$(VERSION)" \
 700                 $(SRC_PATH)/qemu.nsi
 701         rm -r ${INSTDIR}
 702 ifdef SIGNCODE
 703         $(SIGNCODE) $(INSTALLER)
 704 endif # SIGNCODE
 705 endif # CONFIG_WIN
 706
 707 # Add a dependency on the generated files, so that they are always
 708 # rebuilt before other object files
 709 ifneq ($(wildcard config-host.mak),)
 710 ifneq ($(filter-out $(UNCHECKED_GOALS),$(MAKECMDGOALS)),$(if $(MAKECMDGOALS),,fail))
 711 Makefile: $(generated-files-y)
 712 endif
 713 endif
 714
 715 # Include automatically generated dependency files
 716 # Dependencies in Makefile.objs files come from our recursive subdir rules
 717 -include $(wildcard *.d tests/*.d)
 718
 719 include $(SRC_PATH)/tests/docker/Makefile.include
 720 include $(SRC_PATH)/tests/vm/Makefile.include
 721
 722 print-help-run = printf "  %-30s - %s\\n" "$1" "$2"
 723 print-help = $(quiet-@)$(call print-help-run,$1,$2)
 724
 725 .PHONY: help
 726 help:
 727         @echo  'Generic targets:'
 728         $(call print-help,all,Build all)
 729 ifdef CONFIG_MODULES
 730         $(call print-help,modules,Build all modules)
 731 endif
 732         $(call print-help,dir/file.o,Build specified target only)
 733         $(call print-help,install,Install QEMU, documentation and tools)
 734         $(call print-help,ctags/TAGS,Generate tags file for editors)
 735         $(call print-help,cscope,Generate cscope index)
 736         $(call print-help,sparse,Run sparse on the QEMU source)
 737         @echo  ''
 738         @$(if $(TARGET_DIRS), \
 739                 echo 'Architecture specific targets:'; \
 740                 $(foreach t, $(TARGET_DIRS), \
 741                 $(call print-help-run,$(t)/all,Build for $(t)); \
 742                 $(if $(CONFIG_FUZZ), \
 743                         $(if $(findstring softmmu,$(t)), \
 744                                 $(call print-help-run,$(t)/fuzz,Build fuzzer for $(t)); \
 745                 ))) \
 746                 echo '')
 747         @$(if $(HELPERS-y), \
 748                 echo 'Helper targets:'; \
 749                 $(foreach t, $(HELPERS-y), \
 750                 $(call print-help-run,$(t),Build $(shell basename $(t)));) \
 751                 echo '')
 752         @$(if $(TOOLS), \
 753                 echo 'Tools targets:'; \
 754                 $(foreach t, $(TOOLS), \
 755                 $(call print-help-run,$(t),Build $(shell basename $(t)) tool);) \
 756                 echo '')
 757         @echo  'Cleaning targets:'
 758         $(call print-help,clean,Remove most generated files but keep the config)
 759         $(call print-help,distclean,Remove all generated files)
 760         $(call print-help,dist,Build a distributable tarball)
 761         @echo  ''
 762         @echo  'Test targets:'
 763         $(call print-help,check,Run all tests (check-help for details))
 764         $(call print-help,docker,Help about targets running tests inside containers)
 765         $(call print-help,vm-help,Help about targets running tests inside VM)
 766         @echo  ''
 767         @echo  'Documentation targets:'
 768         $(call print-help,html info pdf txt,Build documentation in specified format)
 769         @echo  ''
 770 ifdef CONFIG_WIN32
 771         @echo  'Windows targets:'
 772         $(call print-help,installer,Build NSIS-based installer for QEMU)
 773 ifdef QEMU_GA_MSI_ENABLED
 774         $(call print-help,msi,Build MSI-based installer for qemu-ga)
 775 endif
 776         @echo  ''
 777 endif
 778         $(call print-help,$(MAKE) [targets],(quiet build, default))
 779         $(call print-help,$(MAKE) V=1 [targets],(verbose build))