1 # Makefile for Docker tests
3 .PHONY: docker docker-help docker-test docker-clean docker-image docker-qemu-src
9 HOST_ARCH = $(if $(ARCH),$(ARCH),$(shell uname -m))
11 DOCKER_FILES_DIR := $(SRC_PATH)/tests/docker/dockerfiles
12 ifeq ($(HOST_ARCH),x86_64)
13 DOCKER_DEFAULT_REGISTRY := registry.gitlab.com/qemu-project/qemu
15 DOCKER_REGISTRY := $(if $(REGISTRY),$(REGISTRY),$(DOCKER_DEFAULT_REGISTRY))
18 DOCKER_SCRIPT=$(SRC_PATH)/tests/docker/docker.py --engine $(ENGINE)
20 CUR_TIME := $(shell date +%Y-%m-%d-%H.%M.%S.$$$$)
21 DOCKER_SRC_COPY := $(BUILD_DIR)/docker-src.$(CUR_TIME)
23 .DELETE_ON_ERROR: $(DOCKER_SRC_COPY)
26 $(if $(SRC_ARCHIVE), \
27 $(call quiet-command, cp "$(SRC_ARCHIVE)" $@/qemu.tar, \
28 "CP", "$@/qemu.tar"), \
29 $(call quiet-command, cd $(SRC_PATH) && scripts/archive-source.sh $@/qemu.tar, \
30 "GEN", "$@/qemu.tar"))
31 $(call quiet-command, cp $(SRC_PATH)/tests/docker/run $@/run, \
34 docker-qemu-src: $(DOCKER_SRC_COPY)
36 # General rule for building docker images.
37 docker-image-%: $(DOCKER_FILES_DIR)/%.docker
38 $(call quiet-command,\
39 $(DOCKER_SCRIPT) build -t qemu/$* -f $< \
41 $(if $(NOCACHE),--no-cache, \
42 $(if $(DOCKER_REGISTRY),--registry $(DOCKER_REGISTRY))) \
43 $(if $(NOUSER),,--add-current-user) \
44 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES))\
45 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)),\
48 # Special rule for debootstraped binfmt linux-user images
49 docker-binfmt-image-debian-%: $(DOCKER_FILES_DIR)/debian-bootstrap.docker
51 $(error EXECUTABLE not set, debootstrap of debian-$* would fail))
53 $(error DEB_ARCH not set, debootstrap of debian-$* would fail))
55 $(error DEB_TYPE not set, debootstrap of debian-$* would fail))
56 $(if $(wildcard $(EXECUTABLE)), \
57 $(call quiet-command, \
58 DEB_ARCH=$(DEB_ARCH) \
59 DEB_TYPE=$(DEB_TYPE) \
60 $(if $(DEB_URL),DEB_URL=$(DEB_URL),) \
61 $(DOCKER_SCRIPT) build -t qemu/debian-$* -f $< \
62 $(if $V,,--quiet) $(if $(NOCACHE),--no-cache) \
63 $(if $(NOUSER),,--add-current-user) \
64 $(if $(EXTRA_FILES),--extra-files $(EXTRA_FILES)) \
65 $(if $(EXECUTABLE),--include-executable=$(EXECUTABLE)), \
66 "BUILD","binfmt debian-$* (debootstrapped)"), \
67 $(call quiet-command, \
68 $(DOCKER_SCRIPT) check --quiet qemu/debian-$* $< || \
69 { echo "You will need to build $(EXECUTABLE)"; exit 1;},\
70 "CHECK", "debian-$* exists"))
72 # Enforce dependencies for composite images
73 # we don't run tests on intermediate images (used as base by another image)
74 DOCKER_PARTIAL_IMAGES := debian10 debian11
75 ifeq ($(HOST_ARCH),x86_64)
76 DOCKER_PARTIAL_IMAGES += debian-amd64-cross
78 docker-image-debian-amd64-cross: docker-image-debian10
79 DOCKER_PARTIAL_IMAGES += debian-amd64
82 # For non-x86 hosts not all cross-compilers have been packaged
83 ifneq ($(HOST_ARCH),x86_64)
84 DOCKER_PARTIAL_IMAGES += debian-mipsel-cross debian-mips64el-cross
85 DOCKER_PARTIAL_IMAGES += debian-ppc64el-cross
86 DOCKER_PARTIAL_IMAGES += debian-s390x-cross
87 DOCKER_PARTIAL_IMAGES += fedora
90 # The native build should never use the registry
91 docker-image-debian-native: DOCKER_REGISTRY=
93 # base images should not add a local user
94 docker-image-debian10: NOUSER=1
95 docker-image-debian11: NOUSER=1
97 # alpine has no adduser
98 docker-image-alpine: NOUSER=1
100 debian-toolchain-run = \
102 $(call quiet-command, \
103 $(DOCKER_SCRIPT) build -t qemu/$1 -f $< \
104 $(if $V,,--quiet) --no-cache \
105 --registry $(DOCKER_REGISTRY) --extra-files \
106 $(DOCKER_FILES_DIR)/$1.d/build-toolchain.sh, \
108 $(call quiet-command, \
109 $(DOCKER_SCRIPT) fetch $(if $V,,--quiet) \
110 qemu/$1 $(DOCKER_REGISTRY), \
112 $(call quiet-command, \
113 $(DOCKER_SCRIPT) update $(if $V,,--quiet) \
115 $(if $(NOUSER),,--add-current-user) \
117 debian-toolchain = $(call debian-toolchain-run,$(patsubst docker-image-%,%,$1))
119 docker-image-debian-hexagon-cross: $(DOCKER_FILES_DIR)/debian-hexagon-cross.docker \
120 $(DOCKER_FILES_DIR)/debian-hexagon-cross.d/build-toolchain.sh
121 $(call debian-toolchain, $@)
123 docker-image-debian-microblaze-cross: $(DOCKER_FILES_DIR)/debian-toolchain.docker \
124 $(DOCKER_FILES_DIR)/debian-microblaze-cross.d/build-toolchain.sh
125 $(call debian-toolchain, $@)
127 docker-image-debian-nios2-cross: $(DOCKER_FILES_DIR)/debian-toolchain.docker \
128 $(DOCKER_FILES_DIR)/debian-nios2-cross.d/build-toolchain.sh
129 $(call debian-toolchain, $@)
131 # Specialist build images, sometimes very limited tools
132 docker-image-debian-all-test-cross: docker-image-debian10
133 docker-image-debian-loongarch-cross: docker-image-debian11
134 docker-image-debian-microblaze-cross: docker-image-debian10
135 docker-image-debian-nios2-cross: docker-image-debian10
136 docker-image-debian-riscv64-test-cross: docker-image-debian11
138 # These images may be good enough for building tests but not for test builds
139 DOCKER_PARTIAL_IMAGES += debian-alpha-cross
140 DOCKER_PARTIAL_IMAGES += debian-powerpc-test-cross
141 DOCKER_PARTIAL_IMAGES += debian-hppa-cross
142 DOCKER_PARTIAL_IMAGES += debian-loongarch-cross
143 DOCKER_PARTIAL_IMAGES += debian-m68k-cross debian-mips64-cross
144 DOCKER_PARTIAL_IMAGES += debian-microblaze-cross
145 DOCKER_PARTIAL_IMAGES += debian-mips-cross
146 DOCKER_PARTIAL_IMAGES += debian-nios2-cross
147 DOCKER_PARTIAL_IMAGES += debian-riscv64-test-cross
148 DOCKER_PARTIAL_IMAGES += debian-sh4-cross debian-sparc64-cross
149 DOCKER_PARTIAL_IMAGES += debian-tricore-cross
150 DOCKER_PARTIAL_IMAGES += debian-xtensa-cross
151 DOCKER_PARTIAL_IMAGES += fedora-cris-cross
153 # images that are only used to build other images
154 DOCKER_VIRTUAL_IMAGES := debian-bootstrap debian-toolchain
156 __IMAGES := $(sort $(filter-out $(DOCKER_VIRTUAL_IMAGES), $(notdir $(basename $(wildcard $(DOCKER_FILES_DIR)/*.docker)))))
157 DOCKER_IMAGES := $(if $(IMAGES), $(filter $(IMAGES), $(__IMAGES)), $(__IMAGES))
159 __TESTS := $(notdir $(shell find $(SRC_PATH)/tests/docker/ -name 'test-*' -type f))
160 DOCKER_TESTS := $(if $(TESTS), $(filter $(TESTS), $(__TESTS)), $(__TESTS))
162 # Expand all the pre-requistes for each docker image and test combination
163 $(foreach i,$(filter-out $(DOCKER_PARTIAL_IMAGES),$(DOCKER_IMAGES)), \
164 $(foreach t,$(DOCKER_TESTS), \
165 $(eval .PHONY: docker-$t@$i) \
166 $(eval docker-$t@$i: docker-image-$i; @$(MAKE) docker-run TEST=$t IMAGE=qemu/$i) \
168 $(foreach t,$(DOCKER_TESTS), \
169 $(eval docker-all-tests: docker-$t@$i) \
170 $(eval docker-$t: docker-$t@$i) \
175 @echo 'Build QEMU and run tests inside Docker or Podman containers'
177 @echo 'Available targets:'
179 @echo ' docker: Print this help.'
180 @echo ' docker-all-tests: Run all image/test combinations.'
181 @echo ' docker-TEST: Run "TEST" on all image combinations.'
182 @echo ' docker-clean: Kill and remove residual docker testing containers.'
183 @echo ' docker-TEST@IMAGE: Run "TEST" in container "IMAGE".'
184 @echo ' Note: "TEST" is one of the listed test name,'
185 @echo ' or a script name under $$QEMU_SRC/tests/docker/;'
186 @echo ' "IMAGE" is one of the listed container name.'
187 @echo ' docker-image: Build all images.'
188 @echo ' docker-image-IMAGE: Build image "IMAGE".'
189 @echo ' docker-run: For manually running a "TEST" with "IMAGE".'
191 @echo 'Available container images:'
192 @echo ' $(DOCKER_IMAGES)'
194 @echo 'Available tests:'
195 @echo ' $(DOCKER_TESTS)'
197 @echo 'Special variables:'
198 @echo ' TARGET_LIST=a,b,c Override target list in builds.'
199 @echo ' EXTRA_CONFIGURE_OPTS="..."'
200 @echo ' Extra configure options.'
201 @echo ' IMAGES="a b c ..": Restrict available images to subset.'
202 @echo ' TESTS="x y z .." Restrict available tests to subset.'
203 @echo ' J=[0..9]* Overrides the -jN parameter for make commands'
204 @echo ' (default is 1)'
205 @echo ' DEBUG=1 Stop and drop to shell in the created container'
206 @echo ' before running the command.'
207 @echo ' NETWORK=1 Enable virtual network interface with default backend.'
208 @echo ' NETWORK=$$BACKEND Enable virtual network interface with $$BACKEND.'
209 @echo ' NOUSER=1 Define to disable adding current user to containers passwd.'
210 @echo ' NOCACHE=1 Ignore cache when build images.'
211 @echo ' EXECUTABLE=<path> Include executable in image.'
212 @echo ' EXTRA_FILES="<path> [... <path>]"'
213 @echo ' Include extra files in image.'
214 @echo ' ENGINE=auto/docker/podman'
215 @echo ' Specify which container engine to run.'
216 @echo ' REGISTRY=url Cache builds from registry (default:$(DOCKER_REGISTRY))'
220 # Use a global constant ccache directory to speed up repetitive builds
221 DOCKER_CCACHE_DIR := $$HOME/.cache/qemu-docker-ccache
223 # This rule if for directly running against an arbitrary docker target.
224 # It is called by the expanded docker targets (e.g. make
225 # docker-test-foo@bar) which will also ensure the image is up to date.
227 # For example: make docker-run TEST="test-quick" IMAGE="debian:arm64" EXECUTABLE=./aarch64-linux-user/qemu-aarch64
229 docker-run: docker-qemu-src
230 @mkdir -p "$(DOCKER_CCACHE_DIR)"
231 @if test -z "$(IMAGE)" || test -z "$(TEST)"; \
232 then echo "Invalid target $(IMAGE)/$(TEST)"; exit 1; \
234 $(if $(EXECUTABLE), \
235 $(call quiet-command, \
236 $(DOCKER_SCRIPT) update \
237 $(IMAGE) --executable $(EXECUTABLE), \
238 " COPYING $(EXECUTABLE) to $(IMAGE)"))
239 $(call quiet-command, \
240 $(DOCKER_SCRIPT) run \
241 $(if $(NOUSER),,--run-as-current-user) \
242 --security-opt seccomp=unconfined \
243 $(if $(DEBUG),-ti,) \
244 $(if $(NETWORK),$(if $(subst $(NETWORK),,1),--net=$(NETWORK)),--net=none) \
245 -e TARGET_LIST=$(subst $(SPACE),$(COMMA),$(TARGET_LIST)) \
246 -e EXTRA_CONFIGURE_OPTS="$(EXTRA_CONFIGURE_OPTS)" \
247 -e V=$V -e J=$J -e DEBUG=$(DEBUG) \
248 -e SHOW_ENV=$(SHOW_ENV) \
250 -e CCACHE_DIR=/var/tmp/ccache \
251 -v $(DOCKER_CCACHE_DIR):/var/tmp/ccache:z \
253 -v $$(readlink -e $(DOCKER_SRC_COPY)):/var/tmp/qemu:z$(COMMA)ro \
256 $(TEST), " RUN $(TEST) in ${IMAGE}")
257 $(call quiet-command, rm -r $(DOCKER_SRC_COPY), \
258 " CLEANUP $(DOCKER_SRC_COPY)")
260 docker-image: ${DOCKER_IMAGES:%=docker-image-%}
263 $(call quiet-command, $(DOCKER_SCRIPT) clean)