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 [ "$errors" ]; then 65 if ! grep -qvi warning <<<"$errors" ; then 66 ret=0 67 fi 68 else 69 ret=0 70 fi 71 fi 72 73 return $ret 74} 75 76run_qemu_status () 77{ 78 local stdout ret 79 80 exec {stdout}>&1 81 lines=$(run_qemu "$@" > >(tee /dev/fd/$stdout)) 82 ret=$? 83 exec {stdout}>&- 84 85 if [ $ret -eq 1 ]; then 86 testret=$(grep '^EXIT: ' <<<"$lines" | head -n1 | sed 's/.*STATUS=\([0-9][0-9]*\).*/\1/') 87 if [ "$testret" ]; then 88 if [ $testret -eq 1 ]; then 89 ret=0 90 else 91 ret=$testret 92 fi 93 fi 94 fi 95 96 return $ret 97} 98 99timeout_cmd () 100{ 101 local s 102 103 if [ "$TIMEOUT" ] && [ "$TIMEOUT" != "0" ]; then 104 if [ "$CONFIG_EFI" = 'y' ]; then 105 s=${TIMEOUT: -1} 106 if [ "$s" = 's' ]; then 107 TIMEOUT=${TIMEOUT:0:-1} 108 ((TIMEOUT += 10)) # Add 10 seconds for booting UEFI 109 TIMEOUT="${TIMEOUT}s" 110 fi 111 fi 112 echo "timeout -k 1s --foreground $TIMEOUT" 113 fi 114} 115 116qmp () 117{ 118 echo '{ "execute": "qmp_capabilities" }{ "execute":' "$2" '}' | ncat -U $1 119} 120 121qmp_events () 122{ 123 while ! test -S "$1"; do sleep 0.1; done 124 echo '{ "execute": "qmp_capabilities" }{ "execute": "cont" }' | 125 ncat --no-shutdown -U $1 | 126 jq -c 'select(has("event"))' 127} 128 129filter_quiet_msgs () 130{ 131 grep -v "Now migrate the VM (quiet)" | 132 grep -v "Skipped VM migration (quiet)" 133} 134 135seen_migrate_msg () 136{ 137 if [ $skip_migration -eq 1 ]; then 138 grep -q -e "Now migrate the VM" < $1 139 else 140 grep -q -e "Now migrate the VM" -e "Skipped VM migration" < $1 141 fi 142} 143 144run_migration () 145{ 146 if ! command -v ncat >/dev/null 2>&1; then 147 echo "${FUNCNAME[0]} needs ncat (netcat)" >&2 148 return 77 149 fi 150 151 migcmdline=$@ 152 153 trap 'trap - TERM ; kill 0 ; exit 2' INT TERM 154 trap 'rm -f ${src_out} ${dst_out} ${src_outfifo} ${dst_outfifo} ${dst_incoming} ${src_qmp} ${dst_qmp} ${src_infifo} ${dst_infifo}' RETURN EXIT 155 156 dst_incoming=$(mktemp -u -t mig-helper-socket-incoming.XXXXXXXXXX) 157 src_out=$(mktemp -t mig-helper-stdout1.XXXXXXXXXX) 158 src_outfifo=$(mktemp -u -t mig-helper-fifo-stdout1.XXXXXXXXXX) 159 dst_out=$(mktemp -t mig-helper-stdout2.XXXXXXXXXX) 160 dst_outfifo=$(mktemp -u -t mig-helper-fifo-stdout2.XXXXXXXXXX) 161 src_qmp=$(mktemp -u -t mig-helper-qmp1.XXXXXXXXXX) 162 dst_qmp=$(mktemp -u -t mig-helper-qmp2.XXXXXXXXXX) 163 src_infifo=$(mktemp -u -t mig-helper-fifo-stdin1.XXXXXXXXXX) 164 dst_infifo=$(mktemp -u -t mig-helper-fifo-stdin2.XXXXXXXXXX) 165 src_qmpout=/dev/null 166 dst_qmpout=/dev/null 167 skip_migration=0 168 169 mkfifo ${src_outfifo} 170 mkfifo ${dst_outfifo} 171 172 # Holding both ends of the input fifo open prevents opens from 173 # blocking and readers getting EOF when a writer closes it. 174 mkfifo ${src_infifo} 175 mkfifo ${dst_infifo} 176 exec {src_infifo_fd}<>${src_infifo} 177 exec {dst_infifo_fd}<>${dst_infifo} 178 179 eval "$migcmdline" \ 180 -chardev socket,id=mon,path=${src_qmp},server=on,wait=off \ 181 -mon chardev=mon,mode=control \ 182 < ${src_infifo} > ${src_outfifo} & 183 live_pid=$! 184 cat ${src_outfifo} | tee ${src_out} | filter_quiet_msgs & 185 186 # Start the first destination QEMU machine in advance of the test 187 # reaching the migration point, since we expect at least one migration. 188 # Then destination machines are started after the test outputs 189 # subsequent "Now migrate the VM" messages. 190 do_migration || return $? 191 192 while ps -p ${live_pid} > /dev/null ; do 193 # Wait for test exit or further migration messages. 194 if ! seen_migrate_msg ${src_out} ; then 195 sleep 0.1 196 elif grep -q "Now migrate the VM" < ${src_out} ; then 197 do_migration || return $? 198 elif [ $skip_migration -eq 0 ] && grep -q "Skipped VM migration" < ${src_out} ; then 199 echo > ${src_infifo} # Resume src and carry on. 200 break; 201 fi 202 done 203 204 wait ${live_pid} 205 ret=$? 206 207 while (( $(jobs -r | wc -l) > 0 )); do 208 sleep 0.1 209 done 210 211 return $ret 212} 213 214do_migration () 215{ 216 eval "$migcmdline" \ 217 -chardev socket,id=mon,path=${dst_qmp},server=on,wait=off \ 218 -mon chardev=mon,mode=control -incoming unix:${dst_incoming} \ 219 < ${dst_infifo} > ${dst_outfifo} & 220 incoming_pid=$! 221 cat ${dst_outfifo} | tee ${dst_out} | filter_quiet_msgs & 222 223 # The test must prompt the user to migrate, so wait for the 224 # "Now migrate VM" or similar console message. 225 while ! seen_migrate_msg ${src_out} ; do 226 if ! ps -p ${live_pid} > /dev/null ; then 227 echo > ${dst_infifo} 228 qmp ${dst_qmp} '"quit"'> ${dst_qmpout} 2>/dev/null 229 echo "ERROR: Test exit before migration point." >&2 230 qmp ${src_qmp} '"quit"'> ${src_qmpout} 2>/dev/null 231 return 3 232 fi 233 sleep 0.1 234 done 235 236 # Wait until the destination has created the incoming and qmp sockets 237 while ! [ -S ${dst_incoming} ] ; do sleep 0.1 ; done 238 while ! [ -S ${dst_qmp} ] ; do sleep 0.1 ; done 239 240 if [ $skip_migration -eq 0 ] && grep -q "Skipped VM migration" < ${src_out} ; then 241 # May not get any migrations, exit to main loop for now... 242 echo > ${dst_infifo} 243 qmp ${dst_qmp} '"quit"'> ${dst_qmpout} 2>/dev/null 244 echo > ${src_infifo} # Resume src and carry on. 245 skip_migration=1 246 return 0 247 fi 248 249 qmp ${src_qmp} '"migrate", "arguments": { "uri": "unix:'${dst_incoming}'" }' > ${src_qmpout} 250 251 # Wait for the migration to complete 252 migstatus=$(qmp ${src_qmp} '"query-migrate"' | grep return) 253 while ! grep -q '"completed"' <<<"$migstatus" ; do 254 sleep 0.1 255 if ! migstatus=$(qmp ${src_qmp} '"query-migrate"'); then 256 echo "ERROR: Querying migration state failed." >&2 257 echo > ${dst_infifo} 258 qmp ${dst_qmp} '"quit"'> ${dst_qmpout} 2>/dev/null 259 return 2 260 fi 261 migstatus=$(grep return <<<"$migstatus") 262 if grep -q '"failed"' <<<"$migstatus"; then 263 echo "ERROR: Migration failed." >&2 264 echo > ${dst_infifo} 265 qmp ${src_qmp} '"quit"'> ${src_qmpout} 2>/dev/null 266 qmp ${dst_qmp} '"quit"'> ${dst_qmpout} 2>/dev/null 267 return 2 268 fi 269 done 270 271 qmp ${src_qmp} '"quit"'> ${src_qmpout} 2>/dev/null 272 273 # keypress to dst so getchar completes and test continues 274 echo > ${dst_infifo} 275 276 # Wait for the incoming socket being removed, ready for next destination 277 while [ -S ${dst_incoming} ] ; do sleep 0.1 ; done 278 279 wait ${live_pid} 280 ret=$? 281 282 # Now flip the variables because destination machine becomes source 283 # for the next migration. 284 live_pid=${incoming_pid} 285 tmp=${src_out} 286 src_out=${dst_out} 287 dst_out=${tmp} 288 tmp=${src_infifo} 289 src_infifo=${dst_infifo} 290 dst_infifo=${tmp} 291 tmp=${src_outfifo} 292 src_outfifo=${dst_outfifo} 293 dst_outfifo=${tmp} 294 tmp=${src_qmp} 295 src_qmp=${dst_qmp} 296 dst_qmp=${tmp} 297 298 return $ret 299} 300 301run_panic () 302{ 303 if ! command -v ncat >/dev/null 2>&1; then 304 echo "${FUNCNAME[0]} needs ncat (netcat)" >&2 305 return 77 306 fi 307 308 if ! command -v jq >/dev/null 2>&1; then 309 echo "${FUNCNAME[0]} needs jq" >&2 310 return 77 311 fi 312 313 trap 'trap - TERM ; kill 0 ; exit 2' INT TERM 314 trap 'rm -f ${qmp}' RETURN EXIT 315 316 qmp=$(mktemp -u -t panic-qmp.XXXXXXXXXX) 317 318 # start VM stopped so we don't miss any events 319 eval "$@" -chardev socket,id=mon,path=${qmp},server=on,wait=off \ 320 -mon chardev=mon,mode=control -S & 321 322 panic_event_count=$(qmp_events ${qmp} | jq -c 'select(.event == "GUEST_PANICKED")' | wc -l) 323 if [ "$panic_event_count" -lt 1 ]; then 324 echo "FAIL: guest did not panic" 325 ret=3 326 else 327 # some QEMU versions report multiple panic events 328 echo "PASS: guest panicked" 329 ret=1 330 fi 331 332 return $ret 333} 334 335migration_cmd () 336{ 337 if [ "$MIGRATION" = "yes" ]; then 338 echo "run_migration" 339 fi 340} 341 342panic_cmd () 343{ 344 if [ "$PANIC" = "yes" ]; then 345 echo "run_panic" 346 fi 347} 348 349search_qemu_binary () 350{ 351 local save_path=$PATH 352 local qemucmd qemu 353 354 : "${QEMU_ARCH:=$ARCH_NAME}" 355 356 export PATH=$PATH:/usr/libexec 357 for qemucmd in ${QEMU:-qemu-system-$QEMU_ARCH qemu-kvm}; do 358 if $qemucmd --help 2>/dev/null | grep -q 'QEMU'; then 359 qemu="$qemucmd" 360 break 361 fi 362 done 363 364 if [ -z "$qemu" ]; then 365 echo "A QEMU binary was not found." >&2 366 echo "You can set a custom location by using the QEMU=<path> environment variable." >&2 367 return 2 368 fi 369 command -v $qemu 370 export PATH=$save_path 371} 372 373initrd_cleanup () 374{ 375 rm -f $KVM_UNIT_TESTS_ENV 376 if [ "$KVM_UNIT_TESTS_ENV_OLD" ]; then 377 export KVM_UNIT_TESTS_ENV="$KVM_UNIT_TESTS_ENV_OLD" 378 else 379 unset KVM_UNIT_TESTS_ENV 380 fi 381 unset KVM_UNIT_TESTS_ENV_OLD 382} 383 384initrd_create () 385{ 386 if [ "$ENVIRON_DEFAULT" = "yes" ]; then 387 trap_exit_push 'initrd_cleanup' 388 [ -f "$KVM_UNIT_TESTS_ENV" ] && export KVM_UNIT_TESTS_ENV_OLD="$KVM_UNIT_TESTS_ENV" 389 export KVM_UNIT_TESTS_ENV=$(mktemp) 390 env_params 391 env_file 392 env_errata || return $? 393 fi 394 395 unset INITRD 396 [ -f "$KVM_UNIT_TESTS_ENV" ] && INITRD="-initrd $KVM_UNIT_TESTS_ENV" 397 398 return 0 399} 400 401env_add_params () 402{ 403 local p 404 405 for p in "$@"; do 406 if eval test -v $p; then 407 eval export "$p" 408 else 409 eval export "$p=" 410 fi 411 grep "^$p=" <(env) >>$KVM_UNIT_TESTS_ENV 412 done 413} 414 415env_params () 416{ 417 local qemu have_qemu 418 local _ rest 419 420 qemu=$(search_qemu_binary) && have_qemu=1 421 422 if [ "$have_qemu" ]; then 423 if [ -n "$ACCEL" ] || [ -n "$QEMU_ACCEL" ]; then 424 [ -n "$ACCEL" ] && QEMU_ACCEL=$ACCEL 425 fi 426 QEMU_VERSION_STRING="$($qemu -h | head -1)" 427 IFS='[ .]' read -r _ _ _ QEMU_MAJOR QEMU_MINOR QEMU_MICRO rest <<<"$QEMU_VERSION_STRING" 428 fi 429 env_add_params QEMU_ACCEL QEMU_VERSION_STRING QEMU_MAJOR QEMU_MINOR QEMU_MICRO 430 431 KERNEL_VERSION_STRING=$(uname -r) 432 IFS=. read -r KERNEL_VERSION KERNEL_PATCHLEVEL rest <<<"$KERNEL_VERSION_STRING" 433 IFS=- read -r KERNEL_SUBLEVEL KERNEL_EXTRAVERSION <<<"$rest" 434 KERNEL_SUBLEVEL=${KERNEL_SUBLEVEL%%[!0-9]*} 435 KERNEL_EXTRAVERSION=${KERNEL_EXTRAVERSION%%[!0-9]*} 436 ! [[ $KERNEL_SUBLEVEL =~ ^[0-9]+$ ]] && unset $KERNEL_SUBLEVEL 437 ! [[ $KERNEL_EXTRAVERSION =~ ^[0-9]+$ ]] && unset $KERNEL_EXTRAVERSION 438 env_add_params KERNEL_VERSION_STRING KERNEL_VERSION KERNEL_PATCHLEVEL KERNEL_SUBLEVEL KERNEL_EXTRAVERSION 439} 440 441env_file () 442{ 443 local line var 444 445 [ ! -f "$KVM_UNIT_TESTS_ENV_OLD" ] && return 446 447 grep -E '^[[:blank:]]*[[:alpha:]_][[:alnum:]_]*=' "$KVM_UNIT_TESTS_ENV_OLD" | while IFS= read -r line ; do 448 var=${line%%=*} 449 if ! grep -q "^$var=" $KVM_UNIT_TESTS_ENV; then 450 eval export "$line" 451 grep "^$var=" <(env) >>$KVM_UNIT_TESTS_ENV 452 fi 453 done 454} 455 456env_errata () 457{ 458 local new_env 459 460 if [ "$ACCEL" = "tcg" ]; then 461 export "ERRATA_FORCE=y" 462 elif [ "$ERRATATXT" ] && [ ! -f "$ERRATATXT" ]; then 463 echo "$ERRATATXT not found. (ERRATATXT=$ERRATATXT)" >&2 464 return 2 465 elif [ "$ERRATATXT" ]; then 466 env_generate_errata 467 fi 468 new_env=$(sort <(env | grep '^ERRATA_') <(grep '^ERRATA_' $KVM_UNIT_TESTS_ENV) | uniq -u) 469 echo "$new_env" >>$KVM_UNIT_TESTS_ENV 470} 471 472env_generate_errata () 473{ 474 local line commit minver errata rest v p s x have 475 476 for line in $(grep -v '^#' "$ERRATATXT" | tr -d '[:blank:]' | cut -d: -f1,2); do 477 commit=${line%:*} 478 minver=${line#*:} 479 480 test -z "$commit" && continue 481 errata="ERRATA_$commit" 482 [ -n "${!errata}" ] && continue 483 484 IFS=. read -r v p rest <<<"$minver" 485 IFS=- read -r s x <<<"$rest" 486 s=${s%%[!0-9]*} 487 x=${x%%[!0-9]*} 488 489 if ! [[ $v =~ ^[0-9]+$ ]] || ! [[ $p =~ ^[0-9]+$ ]]; then 490 echo "Bad minimum kernel version in $ERRATATXT, $minver" 491 return 2 492 fi 493 ! [[ $s =~ ^[0-9]+$ ]] && unset $s 494 ! [[ $x =~ ^[0-9]+$ ]] && unset $x 495 496 if (( $KERNEL_VERSION > $v || 497 ($KERNEL_VERSION == $v && $KERNEL_PATCHLEVEL > $p) )); then 498 have=y 499 elif (( $KERNEL_VERSION == $v && $KERNEL_PATCHLEVEL == $p )); then 500 if [ "$KERNEL_SUBLEVEL" ] && [ "$s" ]; then 501 if (( $KERNEL_SUBLEVEL > $s )); then 502 have=y 503 elif (( $KERNEL_SUBLEVEL == $s )); then 504 if [ "$KERNEL_EXTRAVERSION" ] && [ "$x" ]; then 505 if (( $KERNEL_EXTRAVERSION >= $x )); then 506 have=y 507 else 508 have=n 509 fi 510 elif [ "$x" ] && (( $x != 0 )); then 511 have=n 512 else 513 have=y 514 fi 515 else 516 have=n 517 fi 518 elif [ "$s" ] && (( $s != 0 )); then 519 have=n 520 else 521 have=y 522 fi 523 else 524 have=n 525 fi 526 eval export "$errata=$have" 527 done 528} 529 530trap_exit_push () 531{ 532 local old_exit=$(trap -p EXIT | sed "s/^[^']*'//;s/'[^']*$//") 533 trap -- "$1; $old_exit" EXIT 534} 535 536kvm_available () 537{ 538 [ -c /dev/kvm ] || 539 return 1 540 541 [ "$HOST" = "$ARCH_NAME" ] || 542 ( [ "$HOST" = aarch64 ] && [ "$ARCH" = arm ] ) || 543 ( [ "$HOST" = x86_64 ] && [ "$ARCH" = i386 ] ) 544} 545 546hvf_available () 547{ 548 [ "$(sysctl -n kern.hv_support 2>/dev/null)" = "1" ] || return 1 549 [ "$HOST" = "$ARCH_NAME" ] || 550 ( [ "$HOST" = x86_64 ] && [ "$ARCH" = i386 ] ) 551} 552 553set_qemu_accelerator () 554{ 555 ACCEL_PROPS=${ACCEL#"${ACCEL%%,*}"} 556 ACCEL=${ACCEL%%,*} 557 558 if [ "$ACCEL" = "kvm" ] && ! kvm_available; then 559 echo "KVM is needed, but not available on this host" >&2 560 return 2 561 fi 562 if [ "$ACCEL" = "hvf" ] && ! hvf_available; then 563 echo "HVF is needed, but not available on this host" >&2 564 return 2 565 fi 566 567 if [ -z "$ACCEL" ]; then 568 if kvm_available; then 569 ACCEL="kvm" 570 elif hvf_available; then 571 ACCEL="hvf" 572 else 573 ACCEL="tcg" 574 fi 575 fi 576 577 return 0 578} 579