1#!/bin/bash
2#
3# Shell functions for the rest of the scripts.
4#
5# This program is free software; you can redistribute it and/or modify
6# it under the terms of the GNU General Public License as published by
7# the Free Software Foundation; either version 2 of the License, or
8# (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program; if not, you can access it online at
17# http://www.gnu.org/licenses/gpl-2.0.html.
18#
19# Copyright (C) IBM Corporation, 2013
20#
21# Authors: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
22
23# bootparam_hotplug_cpu bootparam-string
24#
25# Returns 1 if the specified boot-parameter string tells rcutorture to
26# test CPU-hotplug operations.
27bootparam_hotplug_cpu () {
28	echo "$1" | grep -q "rcutorture\.onoff_"
29}
30
31# checkarg --argname argtype $# arg mustmatch cannotmatch
32#
33# Checks the specified argument "arg" against the mustmatch and cannotmatch
34# patterns.
35checkarg () {
36	if test $3 -le 1
37	then
38		echo $1 needs argument $2 matching \"$5\"
39		usage
40	fi
41	if echo "$4" | grep -q -e "$5"
42	then
43		:
44	else
45		echo $1 $2 \"$4\" must match \"$5\"
46		usage
47	fi
48	if echo "$4" | grep -q -e "$6"
49	then
50		echo $1 $2 \"$4\" must not match \"$6\"
51		usage
52	fi
53}
54
55# configfrag_boot_params bootparam-string config-fragment-file
56#
57# Adds boot parameters from the .boot file, if any.
58configfrag_boot_params () {
59	if test -r "$2.boot"
60	then
61		echo $1 `grep -v '^#' "$2.boot" | tr '\012' ' '`
62	else
63		echo $1
64	fi
65}
66
67# configfrag_hotplug_cpu config-fragment-file
68#
69# Returns 1 if the config fragment specifies hotplug CPU.
70configfrag_hotplug_cpu () {
71	if test ! -r "$1"
72	then
73		echo Unreadable config fragment "$1" 1>&2
74		exit -1
75	fi
76	grep -q '^CONFIG_HOTPLUG_CPU=y$' "$1"
77}
78
79# identify_qemu builddir
80#
81# Returns our best guess as to which qemu command is appropriate for
82# the kernel at hand.  Override with the RCU_QEMU_CMD environment variable.
83identify_qemu () {
84	local u="`file "$1"`"
85	if test -n "$RCU_QEMU_CMD"
86	then
87		echo $RCU_QEMU_CMD
88	elif echo $u | grep -q x86-64
89	then
90		echo qemu-system-x86_64
91	elif echo $u | grep -q "Intel 80386"
92	then
93		echo qemu-system-i386
94	elif uname -a | grep -q ppc64
95	then
96		echo qemu-system-ppc64
97	else
98		echo Cannot figure out what qemu command to use! 1>&2
99		# Usually this will be one of /usr/bin/qemu-system-*
100		# Use RCU_QEMU_CMD environment variable or appropriate
101		# argument to top-level script.
102		exit 1
103	fi
104}
105
106# identify_qemu_append qemu-cmd
107#
108# Output arguments for the qemu "-append" string based on CPU type
109# and the RCU_QEMU_INTERACTIVE environment variable.
110identify_qemu_append () {
111	case "$1" in
112	qemu-system-x86_64|qemu-system-i386)
113		echo noapic selinux=0 initcall_debug debug
114		;;
115	esac
116	if test -n "$RCU_QEMU_INTERACTIVE"
117	then
118		echo root=/dev/sda
119	else
120		echo console=ttyS0
121	fi
122}
123
124# identify_qemu_args qemu-cmd serial-file
125#
126# Output arguments for qemu arguments based on the RCU_QEMU_MAC
127# and RCU_QEMU_INTERACTIVE environment variables.
128identify_qemu_args () {
129	case "$1" in
130	qemu-system-x86_64|qemu-system-i386)
131		;;
132	qemu-system-ppc64)
133		echo -enable-kvm -M pseries -cpu POWER7 -nodefaults
134		echo -device spapr-vscsi
135		if test -n "$RCU_QEMU_INTERACTIVE" -a -n "$RCU_QEMU_MAC"
136		then
137			echo -device spapr-vlan,netdev=net0,mac=$RCU_QEMU_MAC
138			echo -netdev bridge,br=br0,id=net0
139		elif test -n "$RCU_QEMU_INTERACTIVE"
140		then
141			echo -net nic -net user
142		fi
143		;;
144	esac
145	if test -n "$RCU_QEMU_INTERACTIVE"
146	then
147		echo -monitor stdio -serial pty -S
148	else
149		echo -serial file:$2
150	fi
151}
152
153# identify_qemu_vcpus
154#
155# Returns the number of virtual CPUs available to the aggregate of the
156# guest OSes.
157identify_qemu_vcpus () {
158	lscpu | grep '^CPU(s):' | sed -e 's/CPU(s)://'
159}
160
161# print_bug
162#
163# Prints "BUG: " in red followed by remaining arguments
164print_bug () {
165	printf '\033[031mBUG: \033[m'
166	echo $*
167}
168
169# print_warning
170#
171# Prints "WARNING: " in yellow followed by remaining arguments
172print_warning () {
173	printf '\033[033mWARNING: \033[m'
174	echo $*
175}
176
177# specify_qemu_cpus qemu-cmd qemu-args #cpus
178#
179# Appends a string containing "-smp XXX" to qemu-args, unless the incoming
180# qemu-args already contains "-smp".
181specify_qemu_cpus () {
182	local nt;
183
184	if echo $2 | grep -q -e -smp
185	then
186		echo $2
187	else
188		case "$1" in
189		qemu-system-x86_64|qemu-system-i386)
190			echo $2 -smp $3
191			;;
192		qemu-system-ppc64)
193			nt="`lscpu | grep '^NUMA node0' | sed -e 's/^[^,]*,\([0-9]*\),.*$/\1/'`"
194			echo $2 -smp cores=`expr \( $3 + $nt - 1 \) / $nt`,threads=$nt
195			;;
196		esac
197	fi
198}
199