xref: /kvm-unit-tests/scripts/runtime.bash (revision 2c96b77ec9d3b1fcec7525174e23a6240ee05949)
1: "${RUNTIME_arch_run?}"
2: ${MAX_SMP:=$(getconf _NPROCESSORS_ONLN)}
3: ${TIMEOUT:=90s}
4
5PASS() { echo -ne "\e[32mPASS\e[0m"; }
6SKIP() { echo -ne "\e[33mSKIP\e[0m"; }
7FAIL() { echo -ne "\e[31mFAIL\e[0m"; }
8
9extract_summary()
10{
11    local cr=$'\r'
12    tail -3 | grep '^SUMMARY: ' | sed 's/^SUMMARY: /(/;s/'"$cr"'\{0,1\}$/)/'
13}
14
15# We assume that QEMU is going to work if it tried to load the kernel
16premature_failure()
17{
18    local log="$(eval $(get_cmdline _NO_FILE_4Uhere_) 2>&1)"
19
20    echo "$log" | grep "_NO_FILE_4Uhere_" |
21        grep -q -e "could not \(load\|open\) kernel" -e "error loading" &&
22        return 1
23
24    RUNTIME_log_stderr <<< "$log"
25
26    echo "$log"
27    return 0
28}
29
30get_cmdline()
31{
32    local kernel=$1
33    echo "TESTNAME=$testname TIMEOUT=$timeout ACCEL=$accel $RUNTIME_arch_run $kernel -smp $smp $opts"
34}
35
36skip_nodefault()
37{
38    [ "$run_all_tests" = "yes" ] && return 1
39    [ "$STANDALONE" != "yes" ] && return 0
40
41    while true; do
42        read -r -p "Test marked not to be run by default, are you sure (y/N)? " yn
43        case $yn in
44            "Y" | "y" | "Yes" | "yes")
45                return 1
46                ;;
47            "" | "N" | "n" | "No" | "no" | "q" | "quit" | "exit")
48                return 0
49                ;;
50        esac
51    done
52}
53
54function print_result()
55{
56    local status="$1"
57    local testname="$2"
58    local summary="$3"
59    local reason="$4"
60
61    if [ -z "$reason" ]; then
62        echo "`$status` $testname $summary"
63    else
64        echo "`$status` $testname ($reason)"
65    fi
66}
67
68function find_word()
69{
70    grep -Fq " $1 " <<< " $2 "
71}
72
73function run()
74{
75    local testname="$1"
76    local groups="$2"
77    local smp="$3"
78    local kernel="$4"
79    local opts="$5"
80    local arch="$6"
81    local check="${CHECK:-$7}"
82    local accel="$8"
83    local timeout="${9:-$TIMEOUT}" # unittests.cfg overrides the default
84
85    if [ "${TARGET_EFI}" == "y" ]; then
86        kernel=$(basename $kernel .flat)
87    fi
88
89    if [ -z "$testname" ]; then
90        return
91    fi
92
93    if [ -n "$only_tests" ] && ! find_word "$testname" "$only_tests"; then
94        return
95    fi
96
97    if [ -n "$only_group" ] && ! find_word "$only_group" "$groups"; then
98        return
99    fi
100
101    if [ -z "$only_group" ] && find_word nodefault "$groups" &&
102            skip_nodefault; then
103        print_result "SKIP" $testname "" "test marked as manual run only"
104        return;
105    fi
106
107    if [ -n "$arch" ] && [ "$arch" != "$ARCH" ]; then
108        print_result "SKIP" $testname "" "$arch only"
109        return 2
110    fi
111
112    if [ -n "$accel" ] && [ -n "$ACCEL" ] && [ "$accel" != "$ACCEL" ]; then
113        print_result "SKIP" $testname "" "$accel only, but ACCEL=$ACCEL"
114        return 2
115    elif [ -n "$ACCEL" ]; then
116        accel="$ACCEL"
117    fi
118
119    # check a file for a particular value before running a test
120    # the check line can contain multiple files to check separated by a space
121    # but each check parameter needs to be of the form <path>=<value>
122    if [ "$check" ]; then
123        for check_param in "${check[@]}"; do
124            path=${check_param%%=*}
125            value=${check_param#*=}
126            if ! [ -f "$path" ] || [ "$(cat $path)" != "$value" ]; then
127                print_result "SKIP" $testname "" "$path not equal to $value"
128                return 2
129            fi
130        done
131    fi
132
133    last_line=$(premature_failure > >(tail -1)) && {
134        skip=true
135        if [ "${TARGET_EFI}" == "y" ] && [[ "${last_line}" =~ "enabling apic" ]]; then
136            skip=false
137        fi
138        if [ ${skip} == true ]; then
139            print_result "SKIP" $testname "" "$last_line"
140            return 77
141        fi
142    }
143
144    cmdline=$(get_cmdline $kernel)
145    if find_word "migration" "$groups"; then
146        cmdline="MIGRATION=yes $cmdline"
147    fi
148    if [ "$verbose" = "yes" ]; then
149        echo $cmdline
150    fi
151
152    # extra_params in the config file may contain backticks that need to be
153    # expanded, so use eval to start qemu.  Use "> >(foo)" instead of a pipe to
154    # preserve the exit status.
155    summary=$(eval $cmdline 2> >(RUNTIME_log_stderr $testname) \
156                             > >(tee >(RUNTIME_log_stdout $testname $kernel) | extract_summary))
157    ret=$?
158    [ "$STANDALONE" != "yes" ] && echo > >(RUNTIME_log_stdout $testname $kernel)
159
160    if [ $ret -eq 0 ]; then
161        print_result "PASS" $testname "$summary"
162    elif [ $ret -eq 77 ]; then
163        print_result "SKIP" $testname "$summary"
164    elif [ $ret -eq 124 ]; then
165        print_result "FAIL" $testname "" "timeout; duration=$timeout"
166    elif [ $ret -gt 127 ]; then
167        print_result "FAIL" $testname "" "terminated on SIG$(kill -l $(($ret - 128)))"
168    else
169        print_result "FAIL" $testname "$summary"
170    fi
171
172    return $ret
173}
174
175#
176# Probe for MAX_SMP, in case it's less than the number of host cpus.
177#
178# This probing currently only works for ARM, as x86 bails on another
179# error first. Also, this probing isn't necessary for any ARM hosts
180# running kernels later than v4.3, i.e. those including ef748917b52
181# "arm/arm64: KVM: Remove 'config KVM_ARM_MAX_VCPUS'". So, at some
182# point when maintaining the while loop gets too tiresome, we can
183# just remove it...
184while $RUNTIME_arch_run _NO_FILE_4Uhere_ -smp $MAX_SMP \
185		|& grep -qi 'exceeds max CPUs'; do
186	MAX_SMP=$((MAX_SMP >> 1))
187done
188