3 # Copyright (C) 2009 Red Hat, Inc.
4 # Copyright (c) 2000-2002,2006 Silicon Graphics, Inc. All Rights Reserved.
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation.
10 # This program is distributed in the hope that it would 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.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19 # Control script for QA
40 # called from the build tree
41 source_iotests=$(dirname "$(readlink "$0")")
42 if [ -z "$source_iotests" ]
44 _init_error "failed to obtain source tree name from check symlink"
46 source_iotests=$(cd "$source_iotests"; pwd) || _init_error "failed to enter source tree"
49 # called from the source tree
51 # this may be an in-tree build (note that in the following code we may not
52 # assume that it truly is and have to test whether the build results
57 build_root="$build_iotests/../.."
60 if ! . "$build_iotests/common.env"
62 _init_error "failed to source common.env (make sure the qemu-iotests are run from tests/qemu-iotests in the build tree)"
65 # we need common.config
66 if ! . "$source_iotests/common.config"
68 _init_error "failed to source common.config"
71 _full_imgfmt_details()
73 if [ -n "$IMGOPTS" ]; then
74 echo "$IMGFMT ($IMGOPTS)"
80 _full_platform_details()
86 echo "$os/$platform $host $kernel"
92 QEMU -- "$QEMU_PROG" $QEMU_OPTIONS
93 QEMU_IMG -- "$QEMU_IMG_PROG" $QEMU_IMG_OPTIONS
94 QEMU_IO -- "$QEMU_IO_PROG" $QEMU_IO_OPTIONS
95 QEMU_NBD -- "$QEMU_NBD_PROG" $QEMU_NBD_OPTIONS
96 IMGFMT -- $FULL_IMGFMT_DETAILS
98 PLATFORM -- $FULL_HOST_DETAILS
100 SOCK_DIR -- $SOCK_DIR
101 SOCKET_SCM_HELPER -- $SOCKET_SCM_HELPER
106 # $1 = prog to look for
109 p=$(command -v $1 2> /dev/null)
110 if [ -n "$p" -a -x "$p" ]; then
117 if [ -z "$TEST_DIR" ]; then
118 TEST_DIR=$PWD/scratch
120 mkdir -p "$TEST_DIR" || _init_error 'Failed to create TEST_DIR'
123 if [ -z "$SOCK_DIR" ]; then
124 SOCK_DIR=$(mktemp -d)
127 mkdir -p "$SOCK_DIR" || _init_error 'Failed to create SOCK_DIR'
142 rm -f $tmp.list $tmp.tmp $tmp.sed
145 export IMGFMT_GENERIC=true
148 export CACHEMODE="writeback"
149 export QEMU_IO_OPTIONS=""
150 export QEMU_IO_OPTIONS_NO_FMT=""
151 export CACHEMODE_IS_DEFAULT=true
152 export VALGRIND_QEMU=
154 export IMGOPTSSYNTAX=false
156 # Save current tty settings, since an aborting qemu call may leave things
160 STTY_RESTORE=$(stty -g)
169 group_list=$(sed -n <"$source_iotests/group" -e 's/$/ /' -e "/^[0-9][0-9][0-9].* $r /"'{
172 if [ -z "$group_list" ]
174 echo "Group \"$r\" is empty or not defined?"
177 [ ! -s $tmp.list ] && touch $tmp.list
180 if grep -s "^$t\$" $tmp.list >/dev/null
184 echo "$t" >>$tmp.list
193 # Populate $tmp.list with all tests
194 awk '/^[0-9]{3,}/ {print $1}' "${source_iotests}/group" > $tmp.list 2>/dev/null
195 group_list=$(sed -n <"$source_iotests/group" -e 's/$/ /' -e "/^[0-9][0-9][0-9].* $r /"'{
198 if [ -z "$group_list" ]
200 echo "Group \"$r\" is empty or not defined?"
207 if [ $numsed -gt 100 ]
209 sed -f $tmp.sed <$tmp.list >$tmp.tmp
210 mv $tmp.tmp $tmp.list
214 echo "/^$t\$/d" >>$tmp.sed
215 numsed=$(expr $numsed + 1)
217 sed -f $tmp.sed <$tmp.list >$tmp.tmp
218 mv $tmp.tmp $tmp.list
230 CACHEMODE_IS_DEFAULT=false
239 -\? | -h | --help) # usage
240 echo "Usage: $0 [options] [testlist]"'
247 -raw test raw (default)
250 -parallels test parallels
261 image protocol options
262 -file test file (default)
264 -sheepdog test sheepdog
271 -xdiff graphical mode diff
272 -nocache use O_DIRECT on backing file
273 -misalign misalign memory allocations
274 -n show me, do not run tests
275 -o options -o options to pass to qemu-img create/convert
277 -makecheck pretty print output for make check
280 -g group[,group...] include tests from these groups
281 -x group[,group...] exclude tests from these groups
283 NNN-NNN include test range (eg. 012-021)
395 CACHEMODE_IS_DEFAULT=false
400 QEMU_IO_OPTIONS="$QEMU_IO_OPTIONS --misalign"
409 -g) # -g group ... pick from group file
414 -xdiff) # graphical diff mode
417 if [ ! -z "$DISPLAY" ]
419 command -v xdiff >/dev/null 2>&1 && diff=xdiff
420 command -v gdiff >/dev/null 2>&1 && diff=gdiff
421 command -v tkdiff >/dev/null 2>&1 && diff=tkdiff
422 command -v xxdiff >/dev/null 2>&1 && diff=xxdiff
425 -makecheck) # makecheck friendly output
429 -n) # show me, don't do it
441 -T) # deprecated timestamp option
453 -x) # -x group ... exclude from group file
457 '[0-9][0-9][0-9] [0-9][0-9][0-9][0-9]')
464 eval $(echo $r | sed -e 's/^/start=/' -e 's/-/ end=/')
468 eval $(echo $r | sed -e 's/^/start=/' -e 's/-//')
469 end=$(echo [0-9][0-9][0-9] [0-9][0-9][0-9][0-9] | sed -e 's/\[0-9]//g' -e 's/ *$//' -e 's/.* //')
472 echo "No tests in range \"$r\"?"
485 # get rid of leading 0s as can be interpreted as octal
486 start=$(echo $start | sed 's/^0*//')
487 end=$(echo $end | sed 's/^0*//')
493 BEGIN { for (t='$start'; t<='$end'; t++) printf "%03d\n",t }' \
496 if grep -s "^$id\( \|\$\)" "$source_iotests/group" >/dev/null
498 # in group file ... OK
501 if [ -f expunged ] && $expunge && egrep "^$id([ ]|\$)" expunged >/dev/null
503 # expunged ... will be reported, but not run, later
507 if [ "$start" == "$end" -a "$id" == "$end" ]
509 echo "$id - unknown test"
512 echo "$id - unknown test, ignored"
521 # Set qemu-io cache mode with $CACHEMODE we have
522 QEMU_IO_OPTIONS="$QEMU_IO_OPTIONS --cache $CACHEMODE"
524 QEMU_IO_OPTIONS_NO_FMT="$QEMU_IO_OPTIONS"
525 if [ "$IMGOPTSSYNTAX" != "true" ]; then
526 QEMU_IO_OPTIONS="$QEMU_IO_OPTIONS -f $IMGFMT"
529 # Set default options for qemu-img create -o if they were not specified
530 if [ "$IMGFMT" == "qcow2" ] && ! (echo "$IMGOPTS" | grep "compat=" > /dev/null); then
531 IMGOPTS=$(_optstr_add "$IMGOPTS" "compat=1.1")
533 if [ "$IMGFMT" == "luks" ] && ! (echo "$IMGOPTS" | grep "iter-time=" > /dev/null); then
534 IMGOPTS=$(_optstr_add "$IMGOPTS" "iter-time=10")
537 if [ -z "$SAMPLE_IMG_DIR" ]; then
538 SAMPLE_IMG_DIR="$source_iotests/sample_images"
543 export SAMPLE_IMG_DIR
547 # found some valid test numbers ... this is good
552 # had test numbers, but none in group file ... do nothing
555 # no test numbers, do everything from group file
556 sed -n -e '/^[0-9][0-9][0-9]*/s/^\([0-9]*\).*/\1/p' <"$source_iotests/group" >$tmp.list
560 # should be sort -n, but this did not work for Linux when this
561 # was ported from IRIX
563 list=$(sort $tmp.list)
564 rm -f $tmp.list $tmp.tmp $tmp.sed
566 if [ -z "$QEMU_PROG" ]
568 if [ -x "$build_iotests/qemu" ]; then
569 export QEMU_PROG="$build_iotests/qemu"
570 elif [ -x "$build_root/${qemu_arch}-softmmu/qemu-system-${qemu_arch}" ]; then
571 export QEMU_PROG="$build_root/${qemu_arch}-softmmu/qemu-system-${qemu_arch}"
573 pushd "$build_root" > /dev/null
574 for binary in *-softmmu/qemu-system-*
578 export QEMU_PROG="$build_root/$binary"
583 [ "$QEMU_PROG" = "" ] && _init_error "qemu not found"
586 export QEMU_PROG="$(type -p "$QEMU_PROG")"
589 *qemu-system-arm|*qemu-system-aarch64)
590 export QEMU_OPTIONS="-nodefaults -display none -machine virt,accel=qtest"
592 *qemu-system-tricore)
593 export QEMU_OPTIONS="-nodefaults -display none -machine tricore_testboard,accel=qtest"
596 export QEMU_OPTIONS="-nodefaults -display none -machine accel=qtest"
600 if [ -z "$QEMU_IMG_PROG" ]; then
601 if [ -x "$build_iotests/qemu-img" ]; then
602 export QEMU_IMG_PROG="$build_iotests/qemu-img"
603 elif [ -x "$build_root/qemu-img" ]; then
604 export QEMU_IMG_PROG="$build_root/qemu-img"
606 _init_error "qemu-img not found"
609 export QEMU_IMG_PROG="$(type -p "$QEMU_IMG_PROG")"
611 if [ -z "$QEMU_IO_PROG" ]; then
612 if [ -x "$build_iotests/qemu-io" ]; then
613 export QEMU_IO_PROG="$build_iotests/qemu-io"
614 elif [ -x "$build_root/qemu-io" ]; then
615 export QEMU_IO_PROG="$build_root/qemu-io"
617 _init_error "qemu-io not found"
620 export QEMU_IO_PROG="$(type -p "$QEMU_IO_PROG")"
622 if [ -z $QEMU_NBD_PROG ]; then
623 if [ -x "$build_iotests/qemu-nbd" ]; then
624 export QEMU_NBD_PROG="$build_iotests/qemu-nbd"
625 elif [ -x "$build_root/qemu-nbd" ]; then
626 export QEMU_NBD_PROG="$build_root/qemu-nbd"
628 _init_error "qemu-nbd not found"
631 export QEMU_NBD_PROG="$(type -p "$QEMU_NBD_PROG")"
633 if [ -z "$QEMU_VXHS_PROG" ]; then
634 export QEMU_VXHS_PROG="$(set_prog_path qnio_server)"
637 if [ -x "$build_iotests/socket_scm_helper" ]
639 export SOCKET_SCM_HELPER="$build_iotests/socket_scm_helper"
643 if $PYTHON -c 'import sys; sys.exit(0 if sys.version_info >= (3,6) else 1)'
648 default_machine=$($QEMU_PROG -machine help | sed -n '/(default)/ s/ .*//p')
649 default_alias_machine=$($QEMU_PROG -machine help | \
650 sed -n "/(alias of $default_machine)/ { s/ .*//p; q; }")
651 if [[ "$default_alias_machine" ]]; then
652 default_machine="$default_alias_machine"
655 export QEMU_DEFAULT_MACHINE="$default_machine"
657 TIMESTAMP_FILE=check.time-$IMGPROTO-$IMGFMT
661 date "+%H %M %S" | awk '{ print $1*3600 + $2*60 + $3 }'
671 if [ -f $TIMESTAMP_FILE -a -f $tmp.time ]
673 cat $TIMESTAMP_FILE $tmp.time \
677 for (i in t) print i " " t[i]
681 mv $tmp.out $TIMESTAMP_FILE
684 if [ -f $tmp.expunged ]
686 notrun=$(wc -l <$tmp.expunged | sed -e 's/ *//g')
687 try=$(expr $try - $notrun)
688 list=$(echo "$list" | sed -f $tmp.expunged)
693 echo $list | fmt | sed -e 's/^/ /' >>check.log
694 $interrupt && echo "Interrupted!" >>check.log
696 if [ ! -z "$notrun" ]
698 echo "Not run:$notrun"
699 echo "Not run:$notrun" >>check.log
701 if [ ! -z "$casenotrun" ]
703 echo "Some cases not run in:$casenotrun"
704 echo "Some cases not run in:$casenotrun" >>check.log
706 if [ ! -z "$n_bad" -a $n_bad != 0 ]
709 echo "Failed $n_bad of $try iotests"
710 echo "Failures:$bad" | fmt >>check.log
711 echo "Failed $n_bad of $try iotests" >>check.log
713 echo "Passed all $try iotests"
714 echo "Passed all $try iotests" >>check.log
719 if test -n "$STTY_RESTORE"; then
722 rm -f "${TEST_DIR}"/*.out "${TEST_DIR}"/*.err "${TEST_DIR}"/*.time
723 rm -f "${TEST_DIR}"/check.pid "${TEST_DIR}"/check.sts
732 trap "_wrapup; exit \$status" 0 1 2 3 15
734 # Report the test start and results. For makecheck we want to pretty
735 # print the whole report at the end of the execution.
736 # args: $seq, $starttime, $lasttime
739 if ! $makecheck; then
741 local lasttime=" (last: $3s)"
743 printf "%-8s %-10s [%s] %4s%-14s\r" "$1" "..." "$2" "..." "$lasttime"
746 # args:$seq $status $starttime $lasttime $thistime $details
747 _report_test_result()
749 local status lasttime thistime
751 if [ -n "$2" ] && [ "$2" != "pass" ]; then
754 printf " TEST iotest-$IMGFMT: %s%s\n" "$1" "$status"
759 lasttime=" (last: $4s)"
765 "pass") status=$(printf "\e[32m%-10s\e[0m" "$2") ;;
766 "fail") status=$(printf "\e[1m\e[31m%-10s\e[0m" "$2") ;;
767 "not run") status=$(printf "\e[33m%-10s\e[0m" "$2") ;;
768 *) status=$(printf "%-10s" "$2") ;;
771 printf "%-8s %s [%s] [%s] %4s%-14s %s\n" "$1" "$status" "$3" "$(date '+%T')" "$thistime" "$lasttime" "$6"
774 [ -f $TIMESTAMP_FILE ] || touch $TIMESTAMP_FILE
776 FULL_IMGFMT_DETAILS=$(_full_imgfmt_details)
777 FULL_HOST_DETAILS=$(_full_platform_details)
779 if ! $makecheck; then
785 [ -n "$TESTS_REMAINING_LOG" ] && echo $list > $TESTS_REMAINING_LOG
789 err=false # error flag
790 printdiff=false # show diff to reference output?
791 status="" # test result summary
792 results="" # test result details
793 thistime="" # time the test took
795 if [ -n "$TESTS_REMAINING_LOG" ] ; then
796 sed -e "s/$seq//" -e 's/ / /' -e 's/^ *//' $TESTS_REMAINING_LOG > $TESTS_REMAINING_LOG.tmp
797 mv $TESTS_REMAINING_LOG.tmp $TESTS_REMAINING_LOG
801 lasttime=$(sed -n -e "/^$seq /s/.* //p" <$TIMESTAMP_FILE)
802 starttime=$(date "+%T")
803 _report_test_start $seq $starttime $lasttime
808 elif [ -f expunged ] && $expunge && egrep "^$seq([ ]|\$)" expunged >/dev/null
813 echo "/^$seq\$/d" >>$tmp.expunged
814 elif [ ! -f "$source_iotests/$seq" ]
817 results="no such test?"
818 echo "/^$seq\$/d" >>$tmp.expunged
820 # really going to try and run this one
823 rm -f core $seq.notrun
824 rm -f $seq.casenotrun
828 if [ "$(head -n 1 "$source_iotests/$seq")" == "#!/usr/bin/env python" ]; then
829 if $python_usable; then
830 run_command="$PYTHON $seq"
833 echo "Unsupported Python version" > $seq.notrun
838 export OUTPUT_DIR=$PWD
840 (cd "$source_iotests";
841 MALLOC_PERTURB_=${MALLOC_PERTURB_:-$(($RANDOM % 255 + 1))} \
842 $run_command -d 2>&1 | tee $tmp.out)
844 (cd "$source_iotests";
845 MALLOC_PERTURB_=${MALLOC_PERTURB_:-$(($RANDOM % 255 + 1))} \
846 $run_command >$tmp.out 2>&1)
855 results="[dumped core] $seq.core"
859 if [ -f $seq.notrun ]
861 # overwrites timestamp output
863 results="$(cat $seq.notrun)"
868 results=$(printf %s "[failed, exit status $sts]")
872 reference="$source_iotests/$seq.out"
873 reference_machine="$source_iotests/$seq.$QEMU_DEFAULT_MACHINE.out"
874 if [ -f "$reference_machine" ]; then
875 reference="$reference_machine"
878 reference_format="$source_iotests/$seq.out.$IMGFMT"
879 if [ -f "$reference_format" ]; then
880 reference="$reference_format"
883 if [ "$CACHEMODE" = "none" ]; then
884 [ -f "$source_iotests/$seq.out.nocache" ] && reference="$source_iotests/$seq.out.nocache"
887 if [ ! -f "$reference" ]
890 reason="no qualified output"
893 if diff -w "$reference" $tmp.out >/dev/null 2>&1
897 thistime=$(expr $stop - $start)
898 echo "$seq $thistime" >>$tmp.time
901 mv $tmp.out $seq.out.bad
903 results="output mismatch (see $seq.out.bad)"
909 if [ -f $seq.casenotrun ]
912 casenotrun="$casenotrun $seq"
916 # come here for each test, except when $showme is true
918 _report_test_result $seq "$status" "$starttime" "$lasttime" "$thistime" "$results"
929 $diff -w "$reference" "$PWD"/$seq.out.bad
932 n_bad=$(expr $n_bad + 1)
936 notrun="$notrun $seq"
944 status=$(expr $n_bad)