xref: /kvm-unit-tests/scripts/arch-run.bash (revision c604fa931a1cb70c3649ac1b7223178fc79eab6a)
1##############################################################################
2# run_qemu translates the ambiguous exit status in Table1 to that in Table2.
3# Table3 simply documents the complete status table.
4#
5# Table1: Before fixup
6# --------------------
7# 0      - Unexpected exit from QEMU (possible signal), or the unittest did
8#          not use debug-exit
9# 1      - most likely unittest succeeded, or QEMU failed
10#
11# Table2: After fixup
12# -------------------
13# 0      - Everything succeeded
14# 1      - most likely QEMU failed
15#
16# Table3: Complete table
17# ----------------------
18# 0      - SUCCESS
19# 1      - most likely QEMU failed
20# 2      - most likely a run script failed
21# 3      - most likely the unittest failed
22# 124    - most likely the unittest timed out
23# 127    - most likely the unittest called abort()
24# 1..127 - FAILURE (could be QEMU, a run script, or the unittest)
25# >= 128 - Signal (signum = status - 128)
26##############################################################################
27run_qemu ()
28{
29	local stdout errors ret sig
30
31	initrd_create || return $?
32	echo -n "$@"
33	[ "$ENVIRON_DEFAULT" = "yes" ] && echo -n " #"
34	echo " $INITRD"
35
36	# stdout to {stdout}, stderr to $errors and stderr
37	exec {stdout}>&1
38	errors=$("${@}" $INITRD </dev/null 2> >(tee /dev/stderr) > /dev/fd/$stdout)
39	ret=$?
40	exec {stdout}>&-
41
42	[ $ret -eq 134 ] && echo "QEMU Aborted" >&2
43
44	if [ "$errors" ]; then
45		sig=$(grep 'terminating on signal' <<<"$errors")
46		if [ "$sig" ]; then
47			sig=$(sed 's/.*terminating on signal \([0-9][0-9]*\).*/\1/' <<<"$sig")
48		fi
49	fi
50
51	if [ $ret -eq 0 ]; then
52		# Some signals result in a zero return status, but the
53		# error log tells the truth.
54		if [ "$sig" ]; then
55			((ret=sig+128))
56		else
57			# Exiting with zero (non-debugexit) is an error
58			ret=1
59		fi
60	elif [ $ret -eq 1 ]; then
61		# Even when ret==1 (unittest success) if we also got stderr
62		# logs, then we assume a QEMU failure. Otherwise we translate
63		# status of 1 to 0 (SUCCESS)
64		if [ -z "$(echo "$errors" | grep -vi warning)" ]; then
65			ret=0
66		fi
67	fi
68
69	return $ret
70}
71
72run_qemu_status ()
73{
74	local stdout ret
75
76	exec {stdout}>&1
77	lines=$(run_qemu "$@" > >(tee /dev/fd/$stdout))
78	ret=$?
79	exec {stdout}>&-
80
81	if [ $ret -eq 1 ]; then
82		testret=$(grep '^EXIT: ' <<<"$lines" | sed 's/.*STATUS=\([0-9][0-9]*\).*/\1/')
83		if [ "$testret" ]; then
84			if [ $testret -eq 1 ]; then
85				ret=0
86			else
87				ret=$testret
88			fi
89		fi
90	fi
91
92	return $ret
93}
94
95timeout_cmd ()
96{
97	if [ "$TIMEOUT" ] && [ "$TIMEOUT" != "0" ]; then
98		echo "timeout -k 1s --foreground $TIMEOUT"
99	fi
100}
101
102qmp ()
103{
104	echo '{ "execute": "qmp_capabilities" }{ "execute":' "$2" '}' | ncat -U $1
105}
106
107run_migration ()
108{
109	if ! command -v ncat >/dev/null 2>&1; then
110		echo "${FUNCNAME[0]} needs ncat (netcat)" >&2
111		return 77
112	fi
113
114	migsock=$(mktemp -u -t mig-helper-socket.XXXXXXXXXX)
115	migout1=$(mktemp -t mig-helper-stdout1.XXXXXXXXXX)
116	qmp1=$(mktemp -u -t mig-helper-qmp1.XXXXXXXXXX)
117	qmp2=$(mktemp -u -t mig-helper-qmp2.XXXXXXXXXX)
118	fifo=$(mktemp -u -t mig-helper-fifo.XXXXXXXXXX)
119	qmpout1=/dev/null
120	qmpout2=/dev/null
121
122	trap 'kill 0; exit 2' INT TERM
123	trap 'rm -f ${migout1} ${migsock} ${qmp1} ${qmp2} ${fifo}' RETURN EXIT
124
125	eval "$@" -chardev socket,id=mon1,path=${qmp1},server=on,wait=off \
126		-mon chardev=mon1,mode=control | tee ${migout1} &
127
128	# We have to use cat to open the named FIFO, because named FIFO's, unlike
129	# pipes, will block on open() until the other end is also opened, and that
130	# totally breaks QEMU...
131	mkfifo ${fifo}
132	eval "$@" -chardev socket,id=mon2,path=${qmp2},server=on,wait=off \
133		-mon chardev=mon2,mode=control -incoming unix:${migsock} < <(cat ${fifo}) &
134	incoming_pid=`jobs -l %+ | awk '{print$2}'`
135
136	# The test must prompt the user to migrate, so wait for the "migrate" keyword
137	while ! grep -q -i "migrate" < ${migout1} ; do
138		sleep 1
139	done
140
141	qmp ${qmp1} '"migrate", "arguments": { "uri": "unix:'${migsock}'" }' > ${qmpout1}
142
143	# Wait for the migration to complete
144	migstatus=`qmp ${qmp1} '"query-migrate"' | grep return`
145	while ! grep -q '"completed"' <<<"$migstatus" ; do
146		sleep 1
147		migstatus=`qmp ${qmp1} '"query-migrate"' | grep return`
148		if grep -q '"failed"' <<<"$migstatus" ; then
149			echo "ERROR: Migration failed." >&2
150			qmp ${qmp1} '"quit"'> ${qmpout1} 2>/dev/null
151			qmp ${qmp2} '"quit"'> ${qmpout2} 2>/dev/null
152			return 2
153		fi
154	done
155	qmp ${qmp1} '"quit"'> ${qmpout1} 2>/dev/null
156	echo > ${fifo}
157	wait $incoming_pid
158	ret=$?
159
160	while (( $(jobs -r | wc -l) > 0 )); do
161		sleep 0.5
162	done
163
164	return $ret
165}
166
167migration_cmd ()
168{
169	if [ "$MIGRATION" = "yes" ]; then
170		echo "run_migration"
171	fi
172}
173
174search_qemu_binary ()
175{
176	local save_path=$PATH
177	local qemucmd qemu
178
179	: "${QEMU_ARCH:=$ARCH_NAME}"
180
181	export PATH=$PATH:/usr/libexec
182	for qemucmd in ${QEMU:-qemu-system-$QEMU_ARCH qemu-kvm}; do
183		if $qemucmd --help 2>/dev/null | grep -q 'QEMU'; then
184			qemu="$qemucmd"
185			break
186		fi
187	done
188
189	if [ -z "$qemu" ]; then
190		echo "A QEMU binary was not found." >&2
191		echo "You can set a custom location by using the QEMU=<path> environment variable." >&2
192		return 2
193	fi
194	command -v $qemu
195	export PATH=$save_path
196}
197
198initrd_create ()
199{
200	if [ "$ENVIRON_DEFAULT" = "yes" ]; then
201		trap_exit_push 'rm -f $KVM_UNIT_TESTS_ENV; [ "$KVM_UNIT_TESTS_ENV_OLD" ] && export KVM_UNIT_TESTS_ENV="$KVM_UNIT_TESTS_ENV_OLD" || unset KVM_UNIT_TESTS_ENV; unset KVM_UNIT_TESTS_ENV_OLD'
202		[ -f "$KVM_UNIT_TESTS_ENV" ] && export KVM_UNIT_TESTS_ENV_OLD="$KVM_UNIT_TESTS_ENV"
203		export KVM_UNIT_TESTS_ENV=$(mktemp)
204		env_params
205		env_file
206		env_errata || return $?
207	fi
208
209	unset INITRD
210	[ -f "$KVM_UNIT_TESTS_ENV" ] && INITRD="-initrd $KVM_UNIT_TESTS_ENV"
211
212	return 0
213}
214
215env_add_params ()
216{
217	local p
218
219	for p in "$@"; do
220		if eval test -v $p; then
221			eval export "$p"
222		else
223			eval export "$p="
224		fi
225		grep "^$p=" <(env) >>$KVM_UNIT_TESTS_ENV
226	done
227}
228
229env_params ()
230{
231	local qemu have_qemu
232	local _ rest
233
234	qemu=$(search_qemu_binary) && have_qemu=1
235
236	if [ "$have_qemu" ]; then
237		if [ -n "$ACCEL" ] || [ -n "$QEMU_ACCEL" ]; then
238			[ -n "$ACCEL" ] && QEMU_ACCEL=$ACCEL
239		fi
240		QEMU_VERSION_STRING="$($qemu -h | head -1)"
241		IFS='[ .]' read -r _ _ _ QEMU_MAJOR QEMU_MINOR QEMU_MICRO rest <<<"$QEMU_VERSION_STRING"
242	fi
243	env_add_params QEMU_ACCEL QEMU_VERSION_STRING QEMU_MAJOR QEMU_MINOR QEMU_MICRO
244
245	KERNEL_VERSION_STRING=$(uname -r)
246	IFS=. read -r KERNEL_VERSION KERNEL_PATCHLEVEL rest <<<"$KERNEL_VERSION_STRING"
247	IFS=- read -r KERNEL_SUBLEVEL KERNEL_EXTRAVERSION <<<"$rest"
248	KERNEL_SUBLEVEL=${KERNEL_SUBLEVEL%%[!0-9]*}
249	KERNEL_EXTRAVERSION=${KERNEL_EXTRAVERSION%%[!0-9]*}
250	! [[ $KERNEL_SUBLEVEL =~ ^[0-9]+$ ]] && unset $KERNEL_SUBLEVEL
251	! [[ $KERNEL_EXTRAVERSION =~ ^[0-9]+$ ]] && unset $KERNEL_EXTRAVERSION
252	env_add_params KERNEL_VERSION_STRING KERNEL_VERSION KERNEL_PATCHLEVEL KERNEL_SUBLEVEL KERNEL_EXTRAVERSION
253}
254
255env_file ()
256{
257	local line var
258
259	[ ! -f "$KVM_UNIT_TESTS_ENV_OLD" ] && return
260
261	for line in $(grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD"); do
262		var=${line%%=*}
263		if ! grep -q "^$var=" $KVM_UNIT_TESTS_ENV; then
264			eval export "$line"
265			grep "^$var=" <(env) >>$KVM_UNIT_TESTS_ENV
266		fi
267	done
268}
269
270env_errata ()
271{
272	if [ "$ACCEL" = "tcg" ]; then
273		export "ERRATA_FORCE=y"
274	elif [ "$ERRATATXT" ] && [ ! -f "$ERRATATXT" ]; then
275		echo "$ERRATATXT not found. (ERRATATXT=$ERRATATXT)" >&2
276		return 2
277	elif [ "$ERRATATXT" ]; then
278		env_generate_errata
279	fi
280	sort <(env | grep '^ERRATA_') <(grep '^ERRATA_' $KVM_UNIT_TESTS_ENV) | uniq -u >>$KVM_UNIT_TESTS_ENV
281}
282
283env_generate_errata ()
284{
285	local line commit minver errata rest v p s x have
286
287	for line in $(grep -v '^#' "$ERRATATXT" | tr -d '[:blank:]' | cut -d: -f1,2); do
288		commit=${line%:*}
289		minver=${line#*:}
290
291		test -z "$commit" && continue
292		errata="ERRATA_$commit"
293		[ -n "${!errata}" ] && continue
294
295		IFS=. read -r v p rest <<<"$minver"
296		IFS=- read -r s x <<<"$rest"
297		s=${s%%[!0-9]*}
298		x=${x%%[!0-9]*}
299
300		if ! [[ $v =~ ^[0-9]+$ ]] || ! [[ $p =~ ^[0-9]+$ ]]; then
301			echo "Bad minimum kernel version in $ERRATATXT, $minver"
302			return 2
303		fi
304		! [[ $s =~ ^[0-9]+$ ]] && unset $s
305		! [[ $x =~ ^[0-9]+$ ]] && unset $x
306
307		if (( $KERNEL_VERSION > $v ||
308		      ($KERNEL_VERSION == $v && $KERNEL_PATCHLEVEL > $p) )); then
309			have=y
310		elif (( $KERNEL_VERSION == $v && $KERNEL_PATCHLEVEL == $p )); then
311			if [ "$KERNEL_SUBLEVEL" ] && [ "$s" ]; then
312				if (( $KERNEL_SUBLEVEL > $s )); then
313					have=y
314				elif (( $KERNEL_SUBLEVEL == $s )); then
315					if [ "$KERNEL_EXTRAVERSION" ] && [ "$x" ]; then
316						if (( $KERNEL_EXTRAVERSION >= $x )); then
317							have=y
318						else
319							have=n
320						fi
321					elif [ "$x" ] && (( $x != 0 )); then
322						have=n
323					else
324						have=y
325					fi
326				else
327					have=n
328				fi
329			elif [ "$s" ] && (( $s != 0 )); then
330				have=n
331			else
332				have=y
333			fi
334		else
335			have=n
336		fi
337		eval export "$errata=$have"
338	done
339}
340
341trap_exit_push ()
342{
343	local old_exit=$(trap -p EXIT | sed "s/^[^']*'//;s/'[^']*$//")
344	trap -- "$1; $old_exit" EXIT
345}
346
347kvm_available ()
348{
349	[ -c /dev/kvm ] ||
350		return 1
351
352	[ "$HOST" = "$ARCH_NAME" ] ||
353		( [ "$HOST" = aarch64 ] && [ "$ARCH" = arm ] ) ||
354		( [ "$HOST" = x86_64 ] && [ "$ARCH" = i386 ] )
355}
356
357hvf_available ()
358{
359	[ "$(sysctl -n kern.hv_support 2>/dev/null)" = "1" ] || return 1
360	[ "$HOST" = "$ARCH_NAME" ] ||
361		( [ "$HOST" = x86_64 ] && [ "$ARCH" = i386 ] )
362}
363
364get_qemu_accelerator ()
365{
366	if [ "$ACCEL" = "kvm" ] && ! kvm_available; then
367		echo "KVM is needed, but not available on this host" >&2
368		return 2
369	fi
370	if [ "$ACCEL" = "hvf" ] && ! hvf_available; then
371		echo "HVF is needed, but not available on this host" >&2
372		return 2
373	fi
374
375	if [ "$ACCEL" ]; then
376		echo $ACCEL
377	elif kvm_available; then
378		echo kvm
379	elif hvf_available; then
380		echo hvf
381	else
382		echo tcg
383	fi
384}
385