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