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 local s 98 99 if [ "$TIMEOUT" ] && [ "$TIMEOUT" != "0" ]; then 100 if [ "$CONFIG_EFI" = 'y' ]; then 101 s=${TIMEOUT: -1} 102 if [ "$s" = 's' ]; then 103 TIMEOUT=${TIMEOUT:0:-1} 104 ((TIMEOUT += 10)) # Add 10 seconds for booting UEFI 105 TIMEOUT="${TIMEOUT}s" 106 fi 107 fi 108 echo "timeout -k 1s --foreground $TIMEOUT" 109 fi 110} 111 112qmp () 113{ 114 echo '{ "execute": "qmp_capabilities" }{ "execute":' "$2" '}' | ncat -U $1 115} 116 117qmp_events () 118{ 119 while ! test -S "$1"; do sleep 0.1; done 120 echo '{ "execute": "qmp_capabilities" }{ "execute": "cont" }' | 121 ncat --no-shutdown -U $1 | 122 jq -c 'select(has("event"))' 123} 124 125run_migration () 126{ 127 if ! command -v ncat >/dev/null 2>&1; then 128 echo "${FUNCNAME[0]} needs ncat (netcat)" >&2 129 return 77 130 fi 131 132 migsock=$(mktemp -u -t mig-helper-socket.XXXXXXXXXX) 133 migout1=$(mktemp -t mig-helper-stdout1.XXXXXXXXXX) 134 qmp1=$(mktemp -u -t mig-helper-qmp1.XXXXXXXXXX) 135 qmp2=$(mktemp -u -t mig-helper-qmp2.XXXXXXXXXX) 136 fifo=$(mktemp -u -t mig-helper-fifo.XXXXXXXXXX) 137 qmpout1=/dev/null 138 qmpout2=/dev/null 139 140 trap 'kill 0; exit 2' INT TERM 141 trap 'rm -f ${migout1} ${migsock} ${qmp1} ${qmp2} ${fifo}' RETURN EXIT 142 143 eval "$@" -chardev socket,id=mon1,path=${qmp1},server=on,wait=off \ 144 -mon chardev=mon1,mode=control | tee ${migout1} & 145 146 # We have to use cat to open the named FIFO, because named FIFO's, unlike 147 # pipes, will block on open() until the other end is also opened, and that 148 # totally breaks QEMU... 149 mkfifo ${fifo} 150 eval "$@" -chardev socket,id=mon2,path=${qmp2},server=on,wait=off \ 151 -mon chardev=mon2,mode=control -incoming unix:${migsock} < <(cat ${fifo}) & 152 incoming_pid=`jobs -l %+ | awk '{print$2}'` 153 154 # The test must prompt the user to migrate, so wait for the "migrate" keyword 155 while ! grep -q -i "migrate" < ${migout1} ; do 156 sleep 1 157 done 158 159 qmp ${qmp1} '"migrate", "arguments": { "uri": "unix:'${migsock}'" }' > ${qmpout1} 160 161 # Wait for the migration to complete 162 migstatus=`qmp ${qmp1} '"query-migrate"' | grep return` 163 while ! grep -q '"completed"' <<<"$migstatus" ; do 164 sleep 1 165 migstatus=`qmp ${qmp1} '"query-migrate"' | grep return` 166 if grep -q '"failed"' <<<"$migstatus" ; then 167 echo "ERROR: Migration failed." >&2 168 qmp ${qmp1} '"quit"'> ${qmpout1} 2>/dev/null 169 qmp ${qmp2} '"quit"'> ${qmpout2} 2>/dev/null 170 return 2 171 fi 172 done 173 qmp ${qmp1} '"quit"'> ${qmpout1} 2>/dev/null 174 echo > ${fifo} 175 wait $incoming_pid 176 ret=$? 177 178 while (( $(jobs -r | wc -l) > 0 )); do 179 sleep 0.5 180 done 181 182 return $ret 183} 184 185run_panic () 186{ 187 if ! command -v ncat >/dev/null 2>&1; then 188 echo "${FUNCNAME[0]} needs ncat (netcat)" >&2 189 return 77 190 fi 191 192 if ! command -v jq >/dev/null 2>&1; then 193 echo "${FUNCNAME[0]} needs jq" >&2 194 return 77 195 fi 196 197 qmp=$(mktemp -u -t panic-qmp.XXXXXXXXXX) 198 199 trap 'kill 0; exit 2' INT TERM 200 trap 'rm -f ${qmp}' RETURN EXIT 201 202 # start VM stopped so we don't miss any events 203 eval "$@" -chardev socket,id=mon1,path=${qmp},server=on,wait=off \ 204 -mon chardev=mon1,mode=control -S & 205 206 panic_event_count=$(qmp_events ${qmp} | jq -c 'select(.event == "GUEST_PANICKED")' | wc -l) 207 if [ "$panic_event_count" -lt 1 ]; then 208 echo "FAIL: guest did not panic" 209 ret=3 210 else 211 # some QEMU versions report multiple panic events 212 echo "PASS: guest panicked" 213 ret=1 214 fi 215 216 return $ret 217} 218 219migration_cmd () 220{ 221 if [ "$MIGRATION" = "yes" ]; then 222 echo "run_migration" 223 fi 224} 225 226panic_cmd () 227{ 228 if [ "$PANIC" = "yes" ]; then 229 echo "run_panic" 230 fi 231} 232 233search_qemu_binary () 234{ 235 local save_path=$PATH 236 local qemucmd qemu 237 238 : "${QEMU_ARCH:=$ARCH_NAME}" 239 240 export PATH=$PATH:/usr/libexec 241 for qemucmd in ${QEMU:-qemu-system-$QEMU_ARCH qemu-kvm}; do 242 if $qemucmd --help 2>/dev/null | grep -q 'QEMU'; then 243 qemu="$qemucmd" 244 break 245 fi 246 done 247 248 if [ -z "$qemu" ]; then 249 echo "A QEMU binary was not found." >&2 250 echo "You can set a custom location by using the QEMU=<path> environment variable." >&2 251 return 2 252 fi 253 command -v $qemu 254 export PATH=$save_path 255} 256 257initrd_create () 258{ 259 if [ "$ENVIRON_DEFAULT" = "yes" ]; then 260 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' 261 [ -f "$KVM_UNIT_TESTS_ENV" ] && export KVM_UNIT_TESTS_ENV_OLD="$KVM_UNIT_TESTS_ENV" 262 export KVM_UNIT_TESTS_ENV=$(mktemp) 263 env_params 264 env_file 265 env_errata || return $? 266 fi 267 268 unset INITRD 269 [ -f "$KVM_UNIT_TESTS_ENV" ] && INITRD="-initrd $KVM_UNIT_TESTS_ENV" 270 271 return 0 272} 273 274env_add_params () 275{ 276 local p 277 278 for p in "$@"; do 279 if eval test -v $p; then 280 eval export "$p" 281 else 282 eval export "$p=" 283 fi 284 grep "^$p=" <(env) >>$KVM_UNIT_TESTS_ENV 285 done 286} 287 288env_params () 289{ 290 local qemu have_qemu 291 local _ rest 292 293 qemu=$(search_qemu_binary) && have_qemu=1 294 295 if [ "$have_qemu" ]; then 296 if [ -n "$ACCEL" ] || [ -n "$QEMU_ACCEL" ]; then 297 [ -n "$ACCEL" ] && QEMU_ACCEL=$ACCEL 298 fi 299 QEMU_VERSION_STRING="$($qemu -h | head -1)" 300 IFS='[ .]' read -r _ _ _ QEMU_MAJOR QEMU_MINOR QEMU_MICRO rest <<<"$QEMU_VERSION_STRING" 301 fi 302 env_add_params QEMU_ACCEL QEMU_VERSION_STRING QEMU_MAJOR QEMU_MINOR QEMU_MICRO 303 304 KERNEL_VERSION_STRING=$(uname -r) 305 IFS=. read -r KERNEL_VERSION KERNEL_PATCHLEVEL rest <<<"$KERNEL_VERSION_STRING" 306 IFS=- read -r KERNEL_SUBLEVEL KERNEL_EXTRAVERSION <<<"$rest" 307 KERNEL_SUBLEVEL=${KERNEL_SUBLEVEL%%[!0-9]*} 308 KERNEL_EXTRAVERSION=${KERNEL_EXTRAVERSION%%[!0-9]*} 309 ! [[ $KERNEL_SUBLEVEL =~ ^[0-9]+$ ]] && unset $KERNEL_SUBLEVEL 310 ! [[ $KERNEL_EXTRAVERSION =~ ^[0-9]+$ ]] && unset $KERNEL_EXTRAVERSION 311 env_add_params KERNEL_VERSION_STRING KERNEL_VERSION KERNEL_PATCHLEVEL KERNEL_SUBLEVEL KERNEL_EXTRAVERSION 312} 313 314env_file () 315{ 316 local line var 317 318 [ ! -f "$KVM_UNIT_TESTS_ENV_OLD" ] && return 319 320 for line in $(grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD"); do 321 var=${line%%=*} 322 if ! grep -q "^$var=" $KVM_UNIT_TESTS_ENV; then 323 eval export "$line" 324 grep "^$var=" <(env) >>$KVM_UNIT_TESTS_ENV 325 fi 326 done 327} 328 329env_errata () 330{ 331 if [ "$ACCEL" = "tcg" ]; then 332 export "ERRATA_FORCE=y" 333 elif [ "$ERRATATXT" ] && [ ! -f "$ERRATATXT" ]; then 334 echo "$ERRATATXT not found. (ERRATATXT=$ERRATATXT)" >&2 335 return 2 336 elif [ "$ERRATATXT" ]; then 337 env_generate_errata 338 fi 339 sort <(env | grep '^ERRATA_') <(grep '^ERRATA_' $KVM_UNIT_TESTS_ENV) | uniq -u >>$KVM_UNIT_TESTS_ENV 340} 341 342env_generate_errata () 343{ 344 local line commit minver errata rest v p s x have 345 346 for line in $(grep -v '^#' "$ERRATATXT" | tr -d '[:blank:]' | cut -d: -f1,2); do 347 commit=${line%:*} 348 minver=${line#*:} 349 350 test -z "$commit" && continue 351 errata="ERRATA_$commit" 352 [ -n "${!errata}" ] && continue 353 354 IFS=. read -r v p rest <<<"$minver" 355 IFS=- read -r s x <<<"$rest" 356 s=${s%%[!0-9]*} 357 x=${x%%[!0-9]*} 358 359 if ! [[ $v =~ ^[0-9]+$ ]] || ! [[ $p =~ ^[0-9]+$ ]]; then 360 echo "Bad minimum kernel version in $ERRATATXT, $minver" 361 return 2 362 fi 363 ! [[ $s =~ ^[0-9]+$ ]] && unset $s 364 ! [[ $x =~ ^[0-9]+$ ]] && unset $x 365 366 if (( $KERNEL_VERSION > $v || 367 ($KERNEL_VERSION == $v && $KERNEL_PATCHLEVEL > $p) )); then 368 have=y 369 elif (( $KERNEL_VERSION == $v && $KERNEL_PATCHLEVEL == $p )); then 370 if [ "$KERNEL_SUBLEVEL" ] && [ "$s" ]; then 371 if (( $KERNEL_SUBLEVEL > $s )); then 372 have=y 373 elif (( $KERNEL_SUBLEVEL == $s )); then 374 if [ "$KERNEL_EXTRAVERSION" ] && [ "$x" ]; then 375 if (( $KERNEL_EXTRAVERSION >= $x )); then 376 have=y 377 else 378 have=n 379 fi 380 elif [ "$x" ] && (( $x != 0 )); then 381 have=n 382 else 383 have=y 384 fi 385 else 386 have=n 387 fi 388 elif [ "$s" ] && (( $s != 0 )); then 389 have=n 390 else 391 have=y 392 fi 393 else 394 have=n 395 fi 396 eval export "$errata=$have" 397 done 398} 399 400trap_exit_push () 401{ 402 local old_exit=$(trap -p EXIT | sed "s/^[^']*'//;s/'[^']*$//") 403 trap -- "$1; $old_exit" EXIT 404} 405 406kvm_available () 407{ 408 [ -c /dev/kvm ] || 409 return 1 410 411 [ "$HOST" = "$ARCH_NAME" ] || 412 ( [ "$HOST" = aarch64 ] && [ "$ARCH" = arm ] ) || 413 ( [ "$HOST" = x86_64 ] && [ "$ARCH" = i386 ] ) 414} 415 416hvf_available () 417{ 418 [ "$(sysctl -n kern.hv_support 2>/dev/null)" = "1" ] || return 1 419 [ "$HOST" = "$ARCH_NAME" ] || 420 ( [ "$HOST" = x86_64 ] && [ "$ARCH" = i386 ] ) 421} 422 423set_qemu_accelerator () 424{ 425 ACCEL_PROPS=${ACCEL#"${ACCEL%%,*}"} 426 ACCEL=${ACCEL%%,*} 427 428 if [ "$ACCEL" = "kvm" ] && ! kvm_available; then 429 echo "KVM is needed, but not available on this host" >&2 430 return 2 431 fi 432 if [ "$ACCEL" = "hvf" ] && ! hvf_available; then 433 echo "HVF is needed, but not available on this host" >&2 434 return 2 435 fi 436 437 if [ -z "$ACCEL" ]; then 438 if kvm_available; then 439 ACCEL="kvm" 440 elif hvf_available; then 441 ACCEL="hvf" 442 else 443 ACCEL="tcg" 444 fi 445 fi 446 447 return 0 448} 449