1#!/bin/bash
2# SPDX-License-Identifier: GPL-2.0+
3#
4# Run a kvm-based test of the specified tree on the specified configs.
5# Fully automated run and error checking, no graphics console.
6#
7# Execute this in the source tree.  Do not run it as a background task
8# because qemu does not seem to like that much.
9#
10# Usage: kvm-test-1-run.sh config builddir resdir seconds qemu-args boot_args
11#
12# qemu-args defaults to "-enable-kvm -nographic", along with arguments
13#			specifying the number of CPUs and other options
14#			generated from the underlying CPU architecture.
15# boot_args defaults to value returned by the per_version_boot_params
16#			shell function.
17#
18# Anything you specify for either qemu-args or boot_args is appended to
19# the default values.  The "-smp" value is deduced from the contents of
20# the config fragment.
21#
22# More sophisticated argument parsing is clearly needed.
23#
24# Copyright (C) IBM Corporation, 2011
25#
26# Authors: Paul E. McKenney <paulmck@linux.ibm.com>
27
28T=${TMPDIR-/tmp}/kvm-test-1-run.sh.$$
29trap 'rm -rf $T' 0
30mkdir $T
31
32. functions.sh
33. $CONFIGFRAG/ver_functions.sh
34
35config_template=${1}
36config_dir=`echo $config_template | sed -e 's,/[^/]*$,,'`
37title=`echo $config_template | sed -e 's/^.*\///'`
38builddir=${2}
39resdir=${3}
40if test -z "$resdir" -o ! -d "$resdir" -o ! -w "$resdir"
41then
42	echo "kvm-test-1-run.sh :$resdir: Not a writable directory, cannot store results into it"
43	exit 1
44fi
45echo ' ---' `date`: Starting build
46echo ' ---' Kconfig fragment at: $config_template >> $resdir/log
47touch $resdir/ConfigFragment.input
48
49# Combine additional Kconfig options into an existing set such that
50# newer options win.  The first argument is the Kconfig source ID, the
51# second the to-be-updated file within $T, and the third and final the
52# list of additional Kconfig options.  Note that a $2.tmp file is
53# created when doing the update.
54config_override_param () {
55	if test -n "$3"
56	then
57		echo $3 | sed -e 's/^ *//' -e 's/ *$//' | tr -s " " "\012" > $T/Kconfig_args
58		echo " --- $1" >> $resdir/ConfigFragment.input
59		cat $T/Kconfig_args >> $resdir/ConfigFragment.input
60		config_override.sh $T/$2 $T/Kconfig_args > $T/$2.tmp
61		mv $T/$2.tmp $T/$2
62		# Note that "#CHECK#" is not permitted on commandline.
63	fi
64}
65
66echo > $T/KcList
67config_override_param "$config_dir/CFcommon" KcList "`cat $config_dir/CFcommon 2> /dev/null`"
68config_override_param "$config_template" KcList "`cat $config_template 2> /dev/null`"
69config_override_param "--gdb options" KcList "$TORTURE_KCONFIG_GDB_ARG"
70config_override_param "--kasan options" KcList "$TORTURE_KCONFIG_KASAN_ARG"
71config_override_param "--kcsan options" KcList "$TORTURE_KCONFIG_KCSAN_ARG"
72config_override_param "--kconfig argument" KcList "$TORTURE_KCONFIG_ARG"
73cp $T/KcList $resdir/ConfigFragment
74
75base_resdir=`echo $resdir | sed -e 's/\.[0-9]\+$//'`
76if test "$base_resdir" != "$resdir" -a -f $base_resdir/bzImage -a -f $base_resdir/vmlinux
77then
78	# Rerunning previous test, so use that test's kernel.
79	QEMU="`identify_qemu $base_resdir/vmlinux`"
80	BOOT_IMAGE="`identify_boot_image $QEMU`"
81	KERNEL=$base_resdir/${BOOT_IMAGE##*/} # use the last component of ${BOOT_IMAGE}
82	ln -s $base_resdir/Make*.out $resdir  # for kvm-recheck.sh
83	ln -s $base_resdir/.config $resdir  # for kvm-recheck.sh
84	# Arch-independent indicator
85	touch $resdir/builtkernel
86elif kvm-build.sh $T/KcList $resdir
87then
88	# Had to build a kernel for this test.
89	QEMU="`identify_qemu vmlinux`"
90	BOOT_IMAGE="`identify_boot_image $QEMU`"
91	cp vmlinux $resdir
92	cp .config $resdir
93	cp Module.symvers $resdir > /dev/null || :
94	cp System.map $resdir > /dev/null || :
95	if test -n "$BOOT_IMAGE"
96	then
97		cp $BOOT_IMAGE $resdir
98		KERNEL=$resdir/${BOOT_IMAGE##*/}
99		# Arch-independent indicator
100		touch $resdir/builtkernel
101	else
102		echo No identifiable boot image, not running KVM, see $resdir.
103		echo Do the torture scripts know about your architecture?
104	fi
105	parse-build.sh $resdir/Make.out $title
106else
107	# Build failed.
108	cp .config $resdir || :
109	echo Build failed, not running KVM, see $resdir.
110	if test -f $builddir.wait
111	then
112		mv $builddir.wait $builddir.ready
113	fi
114	exit 1
115fi
116if test -f $builddir.wait
117then
118	mv $builddir.wait $builddir.ready
119fi
120while test -f $builddir.ready
121do
122	sleep 1
123done
124seconds=$4
125qemu_args=$5
126boot_args=$6
127
128kstarttime=`gawk 'BEGIN { print systime() }' < /dev/null`
129if test -z "$TORTURE_BUILDONLY"
130then
131	echo ' ---' `date`: Starting kernel
132fi
133
134# Generate -smp qemu argument.
135qemu_args="-enable-kvm -nographic $qemu_args"
136cpu_count=`configNR_CPUS.sh $resdir/ConfigFragment`
137cpu_count=`configfrag_boot_cpus "$boot_args" "$config_template" "$cpu_count"`
138if test "$cpu_count" -gt "$TORTURE_ALLOTED_CPUS"
139then
140	echo CPU count limited from $cpu_count to $TORTURE_ALLOTED_CPUS | tee -a $resdir/Warnings
141	cpu_count=$TORTURE_ALLOTED_CPUS
142fi
143qemu_args="`specify_qemu_cpus "$QEMU" "$qemu_args" "$cpu_count"`"
144qemu_args="`specify_qemu_net "$qemu_args"`"
145
146# Generate architecture-specific and interaction-specific qemu arguments
147qemu_args="$qemu_args `identify_qemu_args "$QEMU" "$resdir/console.log"`"
148
149# Generate qemu -append arguments
150qemu_append="`identify_qemu_append "$QEMU"`"
151
152# Pull in Kconfig-fragment boot parameters
153boot_args="`configfrag_boot_params "$boot_args" "$config_template"`"
154# Generate kernel-version-specific boot parameters
155boot_args="`per_version_boot_params "$boot_args" $resdir/.config $seconds`"
156if test -n "$TORTURE_BOOT_GDB_ARG"
157then
158	boot_args="$boot_args $TORTURE_BOOT_GDB_ARG"
159fi
160echo $QEMU $qemu_args -m $TORTURE_QEMU_MEM -kernel $KERNEL -append \"$qemu_append $boot_args\" $TORTURE_QEMU_GDB_ARG > $resdir/qemu-cmd
161
162if test -n "$TORTURE_BUILDONLY"
163then
164	echo Build-only run specified, boot/test omitted.
165	touch $resdir/buildonly
166	exit 0
167fi
168
169# Decorate qemu-cmd with redirection, backgrounding, and PID capture
170sed -e 's/$/ 2>\&1 \&/' < $resdir/qemu-cmd > $T/qemu-cmd
171echo 'echo $! > $resdir/qemu_pid' >> $T/qemu-cmd
172
173# In case qemu refuses to run...
174echo "NOTE: $QEMU either did not run or was interactive" > $resdir/console.log
175
176# Attempt to run qemu
177( . $T/qemu-cmd; wait `cat  $resdir/qemu_pid`; echo $? > $resdir/qemu-retval ) &
178commandcompleted=0
179if test -z "$TORTURE_KCONFIG_GDB_ARG"
180then
181	sleep 10 # Give qemu's pid a chance to reach the file
182	if test -s "$resdir/qemu_pid"
183	then
184		qemu_pid=`cat "$resdir/qemu_pid"`
185		echo Monitoring qemu job at pid $qemu_pid
186	else
187		qemu_pid=""
188		echo Monitoring qemu job at yet-as-unknown pid
189	fi
190fi
191if test -n "$TORTURE_KCONFIG_GDB_ARG"
192then
193	echo Waiting for you to attach a debug session, for example: > /dev/tty
194	echo "    gdb $base_resdir/vmlinux" > /dev/tty
195	echo 'After symbols load and the "(gdb)" prompt appears:' > /dev/tty
196	echo "    target remote :1234" > /dev/tty
197	echo "    continue" > /dev/tty
198	kstarttime=`gawk 'BEGIN { print systime() }' < /dev/null`
199fi
200while :
201do
202	if test -z "$qemu_pid" -a -s "$resdir/qemu_pid"
203	then
204		qemu_pid=`cat "$resdir/qemu_pid"`
205	fi
206	kruntime=`gawk 'BEGIN { print systime() - '"$kstarttime"' }' < /dev/null`
207	if test -z "$qemu_pid" || kill -0 "$qemu_pid" > /dev/null 2>&1
208	then
209		if test $kruntime -ge $seconds -o -f "$TORTURE_STOPFILE"
210		then
211			break;
212		fi
213		sleep 1
214	else
215		commandcompleted=1
216		if test $kruntime -lt $seconds
217		then
218			echo Completed in $kruntime vs. $seconds >> $resdir/Warnings 2>&1
219			grep "^(qemu) qemu:" $resdir/kvm-test-1-run.sh.out >> $resdir/Warnings 2>&1
220			killpid="`sed -n "s/^(qemu) qemu: terminating on signal [0-9]* from pid \([0-9]*\).*$/\1/p" $resdir/Warnings`"
221			if test -n "$killpid"
222			then
223				echo "ps -fp $killpid" >> $resdir/Warnings 2>&1
224				ps -fp $killpid >> $resdir/Warnings 2>&1
225			fi
226		else
227			echo ' ---' `date`: "Kernel done"
228		fi
229		break
230	fi
231done
232if test -z "$qemu_pid" -a -s "$resdir/qemu_pid"
233then
234	qemu_pid=`cat "$resdir/qemu_pid"`
235fi
236if test $commandcompleted -eq 0 -a -n "$qemu_pid"
237then
238	if ! test -f "$TORTURE_STOPFILE"
239	then
240		echo Grace period for qemu job at pid $qemu_pid
241	fi
242	oldline="`tail $resdir/console.log`"
243	while :
244	do
245		if test -f "$TORTURE_STOPFILE"
246		then
247			echo "PID $qemu_pid killed due to run STOP request" >> $resdir/Warnings 2>&1
248			kill -KILL $qemu_pid
249			break
250		fi
251		kruntime=`gawk 'BEGIN { print systime() - '"$kstarttime"' }' < /dev/null`
252		if kill -0 $qemu_pid > /dev/null 2>&1
253		then
254			:
255		else
256			break
257		fi
258		must_continue=no
259		newline="`tail $resdir/console.log`"
260		if test "$newline" != "$oldline" && echo $newline | grep -q ' [0-9]\+us : '
261		then
262			must_continue=yes
263		fi
264		last_ts="`tail $resdir/console.log | grep '^\[ *[0-9]\+\.[0-9]\+]' | tail -1 | sed -e 's/^\[ *//' -e 's/\..*$//'`"
265		if test -z "$last_ts"
266		then
267			last_ts=0
268		fi
269		if test "$newline" != "$oldline" -a "$last_ts" -lt $((seconds + $TORTURE_SHUTDOWN_GRACE))
270		then
271			must_continue=yes
272		fi
273		if test $must_continue = no -a $kruntime -ge $((seconds + $TORTURE_SHUTDOWN_GRACE))
274		then
275			echo "!!! PID $qemu_pid hung at $kruntime vs. $seconds seconds" >> $resdir/Warnings 2>&1
276			kill -KILL $qemu_pid
277			break
278		fi
279		oldline=$newline
280		sleep 10
281	done
282elif test -z "$qemu_pid"
283then
284	echo Unknown PID, cannot kill qemu command
285fi
286
287parse-console.sh $resdir/console.log $title
288