1#!/bin/bash
2# SPDX-License-Identifier: GPL-2.0+
3#
4# Shell functions for the rest of the scripts.
5#
6# Copyright (C) IBM Corporation, 2013
7#
8# Authors: Paul E. McKenney <paulmck@linux.ibm.com>
9
10# bootparam_hotplug_cpu bootparam-string
11#
12# Returns 1 if the specified boot-parameter string tells rcutorture to
13# test CPU-hotplug operations.
14bootparam_hotplug_cpu () {
15	echo "$1" | grep -q "rcutorture\.onoff_"
16}
17
18# checkarg --argname argtype $# arg mustmatch cannotmatch
19#
20# Checks the specified argument "arg" against the mustmatch and cannotmatch
21# patterns.
22checkarg () {
23	if test $3 -le 1
24	then
25		echo $1 needs argument $2 matching \"$5\"
26		usage
27	fi
28	if echo "$4" | grep -q -e "$5"
29	then
30		:
31	else
32		echo $1 $2 \"$4\" must match \"$5\"
33		usage
34	fi
35	if echo "$4" | grep -q -e "$6"
36	then
37		echo $1 $2 \"$4\" must not match \"$6\"
38		usage
39	fi
40}
41
42# configfrag_boot_params bootparam-string config-fragment-file
43#
44# Adds boot parameters from the .boot file, if any.
45configfrag_boot_params () {
46	if test -r "$2.boot"
47	then
48		echo $1 `grep -v '^#' "$2.boot" | tr '\012' ' '`
49	else
50		echo $1
51	fi
52}
53
54# configfrag_boot_cpus bootparam-string config-fragment-file config-cpus
55#
56# Decreases number of CPUs based on any nr_cpus= boot parameters specified.
57configfrag_boot_cpus () {
58	local bootargs="`configfrag_boot_params "$1" "$2"`"
59	local nr_cpus
60	if echo "${bootargs}" | grep -q 'nr_cpus=[0-9]'
61	then
62		nr_cpus="`echo "${bootargs}" | sed -e 's/^.*nr_cpus=\([0-9]*\).*$/\1/'`"
63		if test "$3" -gt "$nr_cpus"
64		then
65			echo $nr_cpus
66		else
67			echo $3
68		fi
69	else
70		echo $3
71	fi
72}
73
74# configfrag_boot_maxcpus bootparam-string config-fragment-file config-cpus
75#
76# Decreases number of CPUs based on any maxcpus= boot parameters specified.
77# This allows tests where additional CPUs come online later during the
78# test run.  However, the torture parameters will be set based on the
79# number of CPUs initially present, so the scripting should schedule
80# test runs based on the maxcpus= boot parameter controlling the initial
81# number of CPUs instead of on the ultimate number of CPUs.
82configfrag_boot_maxcpus () {
83	local bootargs="`configfrag_boot_params "$1" "$2"`"
84	local maxcpus
85	if echo "${bootargs}" | grep -q 'maxcpus=[0-9]'
86	then
87		maxcpus="`echo "${bootargs}" | sed -e 's/^.*maxcpus=\([0-9]*\).*$/\1/'`"
88		if test "$3" -gt "$maxcpus"
89		then
90			echo $maxcpus
91		else
92			echo $3
93		fi
94	else
95		echo $3
96	fi
97}
98
99# configfrag_hotplug_cpu config-fragment-file
100#
101# Returns 1 if the config fragment specifies hotplug CPU.
102configfrag_hotplug_cpu () {
103	if test ! -r "$1"
104	then
105		echo Unreadable config fragment "$1" 1>&2
106		exit -1
107	fi
108	grep -q '^CONFIG_HOTPLUG_CPU=y$' "$1"
109}
110
111# identify_boot_image qemu-cmd
112#
113# Returns the relative path to the kernel build image.  This will be
114# arch/<arch>/boot/bzImage or vmlinux if bzImage is not a target for the
115# architecture, unless overridden with the TORTURE_BOOT_IMAGE environment
116# variable.
117identify_boot_image () {
118	if test -n "$TORTURE_BOOT_IMAGE"
119	then
120		echo $TORTURE_BOOT_IMAGE
121	else
122		case "$1" in
123		qemu-system-x86_64|qemu-system-i386)
124			echo arch/x86/boot/bzImage
125			;;
126		qemu-system-aarch64)
127			echo arch/arm64/boot/Image
128			;;
129		*)
130			echo vmlinux
131			;;
132		esac
133	fi
134}
135
136# identify_qemu builddir
137#
138# Returns our best guess as to which qemu command is appropriate for
139# the kernel at hand.  Override with the TORTURE_QEMU_CMD environment variable.
140identify_qemu () {
141	local u="`file "$1"`"
142	if test -n "$TORTURE_QEMU_CMD"
143	then
144		echo $TORTURE_QEMU_CMD
145	elif echo $u | grep -q x86-64
146	then
147		echo qemu-system-x86_64
148	elif echo $u | grep -q "Intel 80386"
149	then
150		echo qemu-system-i386
151	elif echo $u | grep -q aarch64
152	then
153		echo qemu-system-aarch64
154	elif uname -a | grep -q ppc64
155	then
156		echo qemu-system-ppc64
157	else
158		echo Cannot figure out what qemu command to use! 1>&2
159		echo file $1 output: $u
160		# Usually this will be one of /usr/bin/qemu-system-*
161		# Use TORTURE_QEMU_CMD environment variable or appropriate
162		# argument to top-level script.
163		exit 1
164	fi
165}
166
167# identify_qemu_append qemu-cmd
168#
169# Output arguments for the qemu "-append" string based on CPU type
170# and the TORTURE_QEMU_INTERACTIVE environment variable.
171identify_qemu_append () {
172	local console=ttyS0
173	case "$1" in
174	qemu-system-x86_64|qemu-system-i386)
175		echo noapic selinux=0 initcall_debug debug
176		;;
177	qemu-system-aarch64)
178		console=ttyAMA0
179		;;
180	esac
181	if test -n "$TORTURE_QEMU_INTERACTIVE"
182	then
183		echo root=/dev/sda
184	else
185		echo console=$console
186	fi
187}
188
189# identify_qemu_args qemu-cmd serial-file
190#
191# Output arguments for qemu arguments based on the TORTURE_QEMU_MAC
192# and TORTURE_QEMU_INTERACTIVE environment variables.
193identify_qemu_args () {
194	case "$1" in
195	qemu-system-x86_64|qemu-system-i386)
196		;;
197	qemu-system-aarch64)
198		echo -machine virt,gic-version=host -cpu host
199		;;
200	qemu-system-ppc64)
201		echo -enable-kvm -M pseries -nodefaults
202		echo -device spapr-vscsi
203		if test -n "$TORTURE_QEMU_INTERACTIVE" -a -n "$TORTURE_QEMU_MAC"
204		then
205			echo -device spapr-vlan,netdev=net0,mac=$TORTURE_QEMU_MAC
206			echo -netdev bridge,br=br0,id=net0
207		elif test -n "$TORTURE_QEMU_INTERACTIVE"
208		then
209			echo -net nic -net user
210		fi
211		;;
212	esac
213	if test -n "$TORTURE_QEMU_INTERACTIVE"
214	then
215		echo -monitor stdio -serial pty -S
216	else
217		echo -serial file:$2
218	fi
219}
220
221# identify_qemu_vcpus
222#
223# Returns the number of virtual CPUs available to the aggregate of the
224# guest OSes.
225identify_qemu_vcpus () {
226	lscpu | grep '^CPU(s):' | sed -e 's/CPU(s)://'
227}
228
229# print_bug
230#
231# Prints "BUG: " in red followed by remaining arguments
232print_bug () {
233	printf '\033[031mBUG: \033[m'
234	echo $*
235}
236
237# print_warning
238#
239# Prints "WARNING: " in yellow followed by remaining arguments
240print_warning () {
241	printf '\033[033mWARNING: \033[m'
242	echo $*
243}
244
245# specify_qemu_cpus qemu-cmd qemu-args #cpus
246#
247# Appends a string containing "-smp XXX" to qemu-args, unless the incoming
248# qemu-args already contains "-smp".
249specify_qemu_cpus () {
250	local nt;
251
252	if echo $2 | grep -q -e -smp
253	then
254		echo $2
255	else
256		case "$1" in
257		qemu-system-x86_64|qemu-system-i386|qemu-system-aarch64)
258			echo $2 -smp $3
259			;;
260		qemu-system-ppc64)
261			nt="`lscpu | grep '^NUMA node0' | sed -e 's/^[^,]*,\([0-9]*\),.*$/\1/'`"
262			echo $2 -smp cores=`expr \( $3 + $nt - 1 \) / $nt`,threads=$nt
263			;;
264		esac
265	fi
266}
267