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