xref: /freebsd-head/tests/ci/Makefile (revision 5ea28c51397906a7cabb06089974feb21e2a7979) 
1# SPDX-License-Identifier: BSD-2-Clause
2#
3# Copyright (c) 2024 The FreeBSD Foundation
4#
5# This software was developed by Cybermancer Infosec <bofh@FreeBSD.org>
6# under sponsorship from the FreeBSD Foundation.
7#
8# Makefile for CI testing.
9#
10# User-driven targets:
11#  ci: Run CI tests
12#  ci-smoke: Run smoke tests which is simply booting the image
13#  ci-full: Run full tests
14#
15# Variables affecting the build process:
16#  TARGET/TARGET_ARCH: architecture of built release (default: same as build host)
17#  KERNELCONF: kernel configuration to use
18#  USE_QEMU: Use QEMU for testing rather than bhyve
19#
20
21WORLDDIR?=	${.CURDIR}/../..
22RELEASEDIR=	${WORLDDIR}/release
23MAKECONF?=	/dev/null
24SRCCONF?=	/dev/null
25_MEMORY!=sysctl -n hw.physmem 2>/dev/null
26PARALLEL_JOBS!=sysctl -n hw.ncpu 2>/dev/null || nproc 2>/dev/null
27TOTAL_MEMORY!=expr ${_MEMORY} / 1073741824
28KERNCONF?=	GENERIC
29LOCALBASE?=	/usr/local
30
31.if !defined(TARGET) || empty(TARGET)
32TARGET=		${MACHINE}
33.endif
34.if !defined(TARGET_ARCH) || empty(TARGET_ARCH)
35.if ${TARGET} == ${MACHINE}
36TARGET_ARCH=	${MACHINE_ARCH}
37.else
38TARGET_ARCH=	${TARGET}
39.endif
40.endif
41IMAKE=		${MAKE} TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}
42
43.if defined(CROSS_TOOLCHAIN) || !empty(CROSS_TOOLCHAIN)
44CROSS_TOOLCHAIN_PARAM=	"CROSS_TOOLCHAIN=${CROSS_TOOLCHAIN}"
45.endif
46
47# Define OSRELEASE by using newvers.sh
48.if !defined(OSRELEASE) || empty(OSRELEASE)
49.for _V in TYPE BRANCH REVISION
50. if !defined(${_V}) || empty(${_V})
51${_V}!=	eval $$(awk '/^${_V}=/{print}' ${.CURDIR}/../../sys/conf/newvers.sh); echo $$${_V}
52. endif
53.endfor
54.for _V in ${TARGET_ARCH}
55.if !empty(TARGET:M${_V})
56OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}
57VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET}
58.else
59OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}-${TARGET_ARCH}
60VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET_ARCH}
61.endif
62.endfor
63.endif
64
65.if exists(${.CURDIR}/tools/ci.conf) && !defined(CICONF)
66CICONF?=	${.CURDIR}/tools/ci.conf
67.endif
68SWAPSIZE?=	1g
69VMFS?=		ufs
70FORMAT=		raw
71CIIMAGE=	ci-${OSRELEASE}-${GITREV}-${KERNCONF}.${FORMAT}
72CIDISK?=	${.OBJDIR}/${CIIMAGE}
73VMSIZE?=	6g
74CITYPE?=	full
75META_TAR!=mktemp /tmp/meta.XXXXXX
76META_DIR!=mktemp -d /tmp/meta.XXXXXX
77META_DIROUT!=mktemp -d /tmp/meta.XXXXXX
78DISC_CAM!=truncate -s 128m /tmp/disk-cam
79EXTRA_DISK_NUM?=5
80DISK_NUMBERS!=jot - 1 ${EXTRA_DISK_NUM}
81BHYVE_EXTRA_DISK_PARAM?=
82BHYVE_EXTRA_DISK_PARAM+=-s 4:0,ahci-hd,/tmp/disk-cam
83.for i in ${DISK_NUMBERS}
84NEW_DISK!=truncate -s 128m /tmp/disk${i}
85BHYVE_EXTRA_DISK_PARAM+=-s $$((${i} + 4)):0,virtio-blk,/tmp/disk${i}
86CLEANFILES+=/tmp/disk${i}
87.endfor
88TEST_VM_NAME=	ci-${OSRELEASE}-${GITREV}-${KERNCONF}
89.if ${TOTAL_MEMORY} >= 16
90VM_MEM=8
91.elif ${TOTAL_MEMORY} >=4
92VM_MEM=${TOTAL_MEMORY}
93.else
94echo "Please increase the memory to at least 4GB"
95exit 0
96.endif
97VM_MEM_SIZE?=${VM_MEM}g
98TIMEOUT_MS?=5400000
99TIMEOUT=$$((${TIMEOUT_MS} / 1000))
100TIMEOUT_EXPECT=$$((${TIMEOUT} - 60))
101TIMEOUT_VM=$$((${TIMEOUT_EXPECT} - 120))
102.if exists(${.CURDIR}/Makefile.${TARGET_ARCH})
103.	include "${.CURDIR}/Makefile.${TARGET_ARCH}"
104.endif
105.if ${TARGET_ARCH} != ${MACHINE_ARCH}
106.if ( ${TARGET_ARCH} != "i386" ) || ( ${MACHINE_ARCH} != "amd64" )
107QEMUSTATIC=/usr/local/bin/qemu-${QEMU_ARCH}-static
108QEMUTGT=portinstall-qemu
109.endif
110.endif
111QEMUTGT?=
112QEMU_DEVICES?=-device virtio-blk,drive=hd0
113QEMU_EXTRA_PARAM?=
114QEMU_MACHINE?=virt
115QEMUBIN=/usr/local/bin/qemu-system-${QEMU_ARCH}
116.if ${PARALLEL_JOBS} >= ${QEMU_MAX_CPU_COUNT}
117QEMU_CPU_COUNT=${QEMU_MAX_CPU_COUNT}
118.else
119QEMU_CPU_COUNT=${PARALLEL_JOBS}
120.endif
121.if ${VM_MEM} >= ${QEMU_MAX_MEM_SIZE}
122VM_MEM_SIZE=${QEMU_MAX_MEM_SIZE}g
123.else
124VM_MEM_SIZE=${VM_MEM}g
125.endif
126VMGUEST!=sysctl -n kern.vm_guest 2>/dev/null || true
127.if ${VMGUEST} != "none"
128USE_QEMU?=1
129.endif
130KLDFILEMONISLOADED!=kldload -q -n filemon 2>/dev/null && echo "1" || echo "0"
131.if ${KLDFILEMONISLOADED} == "1"
132METAMODE?=-DWITH_META_MODE
133.endif
134
135CLEANFILES+=	${.OBJDIR}/${CIIMAGE} ${.OBJDIR}/ci.img ${META_TAR}
136CLEANDIRS+=	${.OBJDIR}/ci-buildimage
137
138portinstall: portinstall-pkg portinstall-qemu portinstall-expect portinstall-${TARGET_ARCH:tl} .PHONY
139
140portinstall-pkg: .PHONY
141.if !exists(/usr/local/sbin/pkg-static)
142	env ASSUME_ALWAYS_YES=yes pkg bootstrap
143.endif
144
145portinstall-qemu: portinstall-pkg .PHONY
146.if !exists(/usr/local/bin/qemu-${TARGET_ARCH}-static)
147	env ASSUME_ALWAYS_YES=yes pkg install emulators/qemu-user-static
148.endif
149.if !exists(/usr/local/bin/qemu-system-${QEMU_ARCH})
150	env ASSUME_ALWAYS_YES=yes pkg install emulators/qemu@nox11
151.endif
152
153portinstall-expect: portinstall-pkg .PHONY
154.if !exists(/usr/local/bin/expect)
155	env ASSUME_ALWAYS_YES=yes pkg install lang/expect
156.endif
157
158beforeclean: .PHONY
159	chflags -R noschg ${.OBJDIR}/${.TARGET}
160
161.include <bsd.obj.mk>
162clean: beforeclean .PHONY
163
164cleandir: beforeclean .PHONY
165
166ci-buildworld: .PHONY
167	@echo "Building world for ${TARGET_ARCH}"
168	${IMAKE} -j${PARALLEL_JOBS} -C ${WORLDDIR} ${METAMODE} \
169		${CROSS_TOOLCHAIN_PARAM} __MAKE_CONF=${MAKECONF} SRCCONF=${SRCCONF} \
170		buildworld > ${.CURDIR}/_.${TARGET_ARCH}.${.TARGET} 2>&1 || \
171		(echo "${.TARGET} failed, check _.${TARGET_ARCH}.${.TARGET} for details" ; false)
172
173
174ci-buildkernel: ci-buildworld-${TARGET_ARCH:tl} .PHONY
175	@echo "Building kernel for ${TARGET_ARCH"}"
176	${IMAKE} -j${PARALLEL_JOBS} -C ${WORLDDIR} ${METAMODE} \
177		${CROSS_TOOLCHAIN_PARAM} __MAKE_CONF=${MAKECONF} \
178		SRCCONF=${SRCCONF} buildkernel > ${.CURDIR}/_.${TARGET_ARCH}.${.TARGET} 2>&1 || \
179		(echo "${.TARGET} failed, check _.${TARGET_ARCH}.${.TARGET} for details" ; false)
180
181ci-buildimage: ${QEMUTGT} ci-buildkernel-${TARGET_ARCH:tl} .PHONY
182	@echo "Building ci image for ${TARGET_ARCH"}"
183	mkdir -p ${.OBJDIR}/${.TARGET}
184	env TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH} SWAPSIZE=${SWAPSIZE} \
185		QEMUSTATIC=${QEMUSTATIC} CITYPE=${CITYPE} \
186		${RELEASEDIR}/scripts/mk-vmimage.sh \
187		-C ${RELEASEDIR}/tools/vmimage.subr -d ${.OBJDIR}/${.TARGET} -F ${VMFS} \
188		-i ${.OBJDIR}/ci.img -s ${VMSIZE} -f ${FORMAT} \
189		-S ${WORLDDIR} -o ${.OBJDIR}/${CIIMAGE} -c ${CICONF} \
190		> ${.CURDIR}/_.${TARGET_ARCH}.${.TARGET} 2>&1 || \
191		(echo "${.TARGET} failed, check _.${TARGET_ARCH}.${.TARGET} for details" ; false)
192	touch ${.TARGET}
193
194ci-set-smoke-var: .PHONY
195CITYPE=smoke
196
197ci-set-full-var: .PHONY
198CITYPE=full
199
200ci-create-meta: .PHONY
201	truncate -s 512M ${META_TAR}
202	tar rvf ${META_TAR} -C ${META_DIR} .
203
204ci-extract-meta: .PHONY
205	tar xfv ${META_TAR} -C ${META_DIROUT}
206	@echo "Extracted kyua reports to ${META_DIROUT}"
207
208ci-runtest: ci-buildimage-${TARGET_ARCH:tl} portinstall .PHONY
209.if ${MACHINE} == "amd64" && ( ${TARGET_ARCH} == "amd64" || ${TARGET_ARCH} == "i386" ) && ( !defined(USE_QEMU) || empty(USE_QEMU) )
210	/usr/sbin/bhyvectl --vm=${TEST_VM_NAME} --destroy || true
211	/usr/sbin/bhyveload -c stdio -m ${VM_MEM_SIZE} -d ${CIDISK} ${TEST_VM_NAME}
212	expect -c "set timeout ${TIMEOUT_EXPECT}; \
213		spawn /usr/bin/timeout -k 60 ${TIMEOUT_VM} /usr/sbin/bhyve \
214		-c ${PARALLEL_JOBS} -m ${VM_MEM_SIZE} -A -H -P \
215		-s 0:0,hostbridge \
216		-s 1:0,lpc \
217		-s 2:0,virtio-blk,${CIDISK} \
218		-s 3:0,virtio-blk,${META_TAR} \
219		${BHYVE_EXTRA_DISK_PARAM} \
220		-l com1,stdio \
221		${TEST_VM_NAME}; \
222		expect { eof }"
223	/usr/sbin/bhyvectl --vm=${TEST_VM_NAME} --destroy
224.else
225	timeout -k 60 ${TIMEOUT_VM} ${QEMUBIN} \
226		-machine ${QEMU_MACHINE} \
227		-smp ${QEMU_CPU_COUNT} \
228		-m ${VM_MEM_SIZE} \
229		-nographic \
230		-no-reboot \
231		${QEMU_EXTRA_PARAM} \
232		-drive if=none,file=${CIDISK},format=raw,id=hd0 \
233		-drive if=none,file=${META_TAR},format=raw,id=hd1 \
234		${QEMU_DEVICES}
235.endif
236
237ci-checktarget: .PHONY
238.if ${TARGET_ARCH} != "aarch64" && \
239	${TARGET_ARCH} != "amd64" && \
240	${TARGET_ARCH} != "armv7" && \
241	${TARGET_ARCH} != "powerpc64" && \
242	${TARGET_ARCH} != "powerpc64le" && \
243	${TARGET_ARCH} != "riscv64"
244	@false
245.ERROR:
246	@echo "Error: ${TARGET_ARCH} is not supported on ${TYPE} ${REVISION} ${BRANCH}"
247.endif
248
249ci-smoke: ci-set-smoke-var ci-create-meta ci-checktarget .WAIT ci-runtest-${TARGET_ARCH:tl} .PHONY
250
251ci-full: ci-set-full-var ci-create-meta ci-checktarget .WAIT ci-runtest-${TARGET_ARCH:tl} ci-extract-meta .PHONY
252
253ci: ci-${CITYPE:tl} .PHONY
254
255.include "${RELEASEDIR}/Makefile.inc1"
256