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'
143 rm -f $tmp.list $tmp.tmp $tmp.sed
146 export IMGFMT_GENERIC=true
149 export CACHEMODE="writeback"
150 export AIOMODE="threads"
151 export QEMU_IO_OPTIONS=""
152 export QEMU_IO_OPTIONS_NO_FMT=""
153 export CACHEMODE_IS_DEFAULT=true
154 export VALGRIND_QEMU=
156 export IMGOPTSSYNTAX=false
158 # Save current tty settings, since an aborting qemu call may leave things
162 STTY_RESTORE=$(stty -g)
171 group_list=$(sed -n <"$source_iotests/group" -e 's/$/ /' -e "/^[0-9][0-9][0-9].* $r /"'{
174 if [ -z "$group_list" ]
176 echo "Group \"$r\" is empty or not defined?"
179 [ ! -s $tmp.list ] && touch $tmp.list
182 if grep -s "^$t\$" $tmp.list >/dev/null
186 echo "$t" >>$tmp.list
195 # Populate $tmp.list with all tests
196 awk '/^[0-9]{3,}/ {print $1}' "${source_iotests}/group" > $tmp.list 2>/dev/null
197 group_list=$(sed -n <"$source_iotests/group" -e 's/$/ /' -e "/^[0-9][0-9][0-9].* $r /"'{
200 if [ -z "$group_list" ]
202 echo "Group \"$r\" is empty or not defined?"
209 if [ $numsed -gt 100 ]
211 sed -f $tmp.sed <$tmp.list >$tmp.tmp
212 mv $tmp.tmp $tmp.list
216 echo "/^$t\$/d" >>$tmp.sed
217 numsed=$(expr $numsed + 1)
219 sed -f $tmp.sed <$tmp.list >$tmp.tmp
220 mv $tmp.tmp $tmp.list
232 CACHEMODE_IS_DEFAULT=false
246 -\? | -h | --help) # usage
247 echo "Usage: $0 [options] [testlist]"'
254 -raw test raw (default)
257 -parallels test parallels
268 image protocol options
269 -file test file (default)
271 -sheepdog test sheepdog
278 -xdiff graphical mode diff
279 -nocache use O_DIRECT on backing file
280 -misalign misalign memory allocations
281 -n show me, do not run tests
282 -o options -o options to pass to qemu-img create/convert
285 -makecheck pretty print output for make check
288 -g group[,group...] include tests from these groups
289 -x group[,group...] exclude tests from these groups
291 NNN-NNN include test range (eg. 012-021)
403 CACHEMODE_IS_DEFAULT=false
408 QEMU_IO_OPTIONS="$QEMU_IO_OPTIONS --misalign"
417 -g) # -g group ... pick from group file
422 -xdiff) # graphical diff mode
425 if [ ! -z "$DISPLAY" ]
427 command -v xdiff >/dev/null 2>&1 && diff=xdiff
428 command -v gdiff >/dev/null 2>&1 && diff=gdiff
429 command -v tkdiff >/dev/null 2>&1 && diff=tkdiff
430 command -v xxdiff >/dev/null 2>&1 && diff=xxdiff
433 -makecheck) # makecheck friendly output
437 -n) # show me, don't do it
453 -T) # deprecated timestamp option
464 -x) # -x group ... exclude from group file
468 '[0-9][0-9][0-9] [0-9][0-9][0-9][0-9]')
475 eval $(echo $r | sed -e 's/^/start=/' -e 's/-/ end=/')
479 eval $(echo $r | sed -e 's/^/start=/' -e 's/-//')
480 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/.* //')
483 echo "No tests in range \"$r\"?"
496 # get rid of leading 0s as can be interpreted as octal
497 start=$(echo $start | sed 's/^0*//')
498 end=$(echo $end | sed 's/^0*//')
504 BEGIN { for (t='$start'; t<='$end'; t++) printf "%03d\n",t }' \
507 if grep -s "^$id\( \|\$\)" "$source_iotests/group" >/dev/null
509 # in group file ... OK
512 if [ -f expunged ] && $expunge && egrep "^$id([ ]|\$)" expunged >/dev/null
514 # expunged ... will be reported, but not run, later
518 if [ "$start" == "$end" -a "$id" == "$end" ]
520 echo "$id - unknown test"
523 echo "$id - unknown test, ignored"
532 # Set qemu-io cache mode with $CACHEMODE we have
533 QEMU_IO_OPTIONS="$QEMU_IO_OPTIONS --cache $CACHEMODE"
534 # Set qemu-io aio mode with $AIOMODE we have
535 QEMU_IO_OPTIONS="$QEMU_IO_OPTIONS --aio $AIOMODE"
537 QEMU_IO_OPTIONS_NO_FMT="$QEMU_IO_OPTIONS"
538 if [ "$IMGOPTSSYNTAX" != "true" ]; then
539 QEMU_IO_OPTIONS="$QEMU_IO_OPTIONS -f $IMGFMT"
542 # Set default options for qemu-img create -o if they were not specified
543 if [ "$IMGFMT" == "qcow2" ] && ! (echo "$IMGOPTS" | grep "compat=" > /dev/null); then
544 IMGOPTS=$(_optstr_add "$IMGOPTS" "compat=1.1")
546 if [ "$IMGFMT" == "luks" ] && ! (echo "$IMGOPTS" | grep "iter-time=" > /dev/null); then
547 IMGOPTS=$(_optstr_add "$IMGOPTS" "iter-time=10")
550 if [ -z "$SAMPLE_IMG_DIR" ]; then
551 SAMPLE_IMG_DIR="$source_iotests/sample_images"
556 export SAMPLE_IMG_DIR
560 # found some valid test numbers ... this is good
565 # had test numbers, but none in group file ... do nothing
568 # no test numbers, do everything from group file
569 sed -n -e '/^[0-9][0-9][0-9]*/s/^\([0-9]*\).*/\1/p' <"$source_iotests/group" >$tmp.list
573 # should be sort -n, but this did not work for Linux when this
574 # was ported from IRIX
576 list=$(sort $tmp.list)
577 rm -f $tmp.list $tmp.tmp $tmp.sed
579 if [ -z "$QEMU_PROG" ]
581 if [ -x "$build_iotests/qemu" ]; then
582 export QEMU_PROG="$build_iotests/qemu"
583 elif [ -x "$build_root/${qemu_arch}-softmmu/qemu-system-${qemu_arch}" ]; then
584 export QEMU_PROG="$build_root/${qemu_arch}-softmmu/qemu-system-${qemu_arch}"
586 pushd "$build_root" > /dev/null
587 for binary in *-softmmu/qemu-system-*
591 export QEMU_PROG="$build_root/$binary"
596 [ "$QEMU_PROG" = "" ] && _init_error "qemu not found"
599 export QEMU_PROG="$(type -p "$QEMU_PROG")"
602 *qemu-system-arm|*qemu-system-aarch64)
603 export QEMU_OPTIONS="-nodefaults -display none -machine virt -accel qtest"
605 *qemu-system-tricore)
606 export QEMU_OPTIONS="-nodefaults -display none -machine tricore_testboard -accel qtest"
609 export QEMU_OPTIONS="-nodefaults -display none -accel qtest"
613 if [ -z "$QEMU_IMG_PROG" ]; then
614 if [ -x "$build_iotests/qemu-img" ]; then
615 export QEMU_IMG_PROG="$build_iotests/qemu-img"
616 elif [ -x "$build_root/qemu-img" ]; then
617 export QEMU_IMG_PROG="$build_root/qemu-img"
619 _init_error "qemu-img not found"
622 export QEMU_IMG_PROG="$(type -p "$QEMU_IMG_PROG")"
624 if [ -z "$QEMU_IO_PROG" ]; then
625 if [ -x "$build_iotests/qemu-io" ]; then
626 export QEMU_IO_PROG="$build_iotests/qemu-io"
627 elif [ -x "$build_root/qemu-io" ]; then
628 export QEMU_IO_PROG="$build_root/qemu-io"
630 _init_error "qemu-io not found"
633 export QEMU_IO_PROG="$(type -p "$QEMU_IO_PROG")"
635 if [ -z $QEMU_NBD_PROG ]; then
636 if [ -x "$build_iotests/qemu-nbd" ]; then
637 export QEMU_NBD_PROG="$build_iotests/qemu-nbd"
638 elif [ -x "$build_root/qemu-nbd" ]; then
639 export QEMU_NBD_PROG="$build_root/qemu-nbd"
641 _init_error "qemu-nbd not found"
644 export QEMU_NBD_PROG="$(type -p "$QEMU_NBD_PROG")"
646 if [ -z "$QEMU_VXHS_PROG" ]; then
647 export QEMU_VXHS_PROG="$(set_prog_path qnio_server)"
650 if [ -x "$build_iotests/socket_scm_helper" ]
652 export SOCKET_SCM_HELPER="$build_iotests/socket_scm_helper"
656 if $PYTHON -c 'import sys; sys.exit(0 if sys.version_info >= (3,6) else 1)'
658 # Our python framework also requires virtio-blk
659 if "$QEMU_PROG" -M none -device help | grep -q virtio-blk >/dev/null 2>&1
663 python_unusable_because="Missing virtio-blk in QEMU binary"
666 python_unusable_because="Unsupported Python version"
669 default_machine=$($QEMU_PROG -machine help | sed -n '/(default)/ s/ .*//p')
670 default_alias_machine=$($QEMU_PROG -machine help | \
671 sed -n "/(alias of $default_machine)/ { s/ .*//p; q; }")
672 if [[ "$default_alias_machine" ]]; then
673 default_machine="$default_alias_machine"
676 export QEMU_DEFAULT_MACHINE="$default_machine"
678 TIMESTAMP_FILE=check.time-$IMGPROTO-$IMGFMT
682 date "+%H %M %S" | awk '{ print $1*3600 + $2*60 + $3 }'
692 if [ -f $TIMESTAMP_FILE -a -f $tmp.time ]
694 cat $TIMESTAMP_FILE $tmp.time \
698 for (i in t) print i " " t[i]
702 mv $tmp.out $TIMESTAMP_FILE
705 if [ -f $tmp.expunged ]
707 notrun=$(wc -l <$tmp.expunged | sed -e 's/ *//g')
708 try=$(expr $try - $notrun)
709 list=$(echo "$list" | sed -f $tmp.expunged)
714 echo $list | fmt | sed -e 's/^/ /' >>check.log
715 $interrupt && echo "Interrupted!" >>check.log
717 if [ ! -z "$notrun" ]
719 echo "Not run:$notrun"
720 echo "Not run:$notrun" >>check.log
722 if [ ! -z "$casenotrun" ]
724 echo "Some cases not run in:$casenotrun"
725 echo "Some cases not run in:$casenotrun" >>check.log
727 if [ ! -z "$n_bad" -a $n_bad != 0 ]
730 echo "Failed $n_bad of $try iotests"
731 echo "Failures:$bad" | fmt >>check.log
732 echo "Failed $n_bad of $try iotests" >>check.log
734 echo "Passed all $try iotests"
735 echo "Passed all $try iotests" >>check.log
740 if test -n "$STTY_RESTORE"; then
743 rm -f "${TEST_DIR}"/*.out "${TEST_DIR}"/*.err "${TEST_DIR}"/*.time
744 rm -f "${TEST_DIR}"/check.pid "${TEST_DIR}"/check.sts
753 trap "_wrapup; exit \$status" 0 1 2 3 15
755 # Report the test start and results. For makecheck we want to pretty
756 # print the whole report at the end of the execution.
757 # args: $seq, $starttime, $lasttime
760 if ! $makecheck; then
762 local lasttime=" (last: $3s)"
764 printf "%-8s %-10s [%s] %4s%-14s\r" "$1" "..." "$2" "..." "$lasttime"
767 # args:$seq $status $starttime $lasttime $thistime $details
768 _report_test_result()
770 local status lasttime thistime
772 if [ -n "$2" ] && [ "$2" != "pass" ]; then
775 printf " TEST iotest-$IMGFMT: %s%s\n" "$1" "$status"
780 lasttime=" (last: $4s)"
786 "pass") status=$(printf "\e[32m%-10s\e[0m" "$2") ;;
787 "fail") status=$(printf "\e[1m\e[31m%-10s\e[0m" "$2") ;;
788 "not run") status=$(printf "\e[33m%-10s\e[0m" "$2") ;;
789 *) status=$(printf "%-10s" "$2") ;;
792 printf "%-8s %s [%s] [%s] %4s%-14s %s\n" "$1" "$status" "$3" "$(date '+%T')" "$thistime" "$lasttime" "$6"
795 [ -f $TIMESTAMP_FILE ] || touch $TIMESTAMP_FILE
797 FULL_IMGFMT_DETAILS=$(_full_imgfmt_details)
798 FULL_HOST_DETAILS=$(_full_platform_details)
800 if ! $makecheck; then
806 [ -n "$TESTS_REMAINING_LOG" ] && echo $list > $TESTS_REMAINING_LOG
810 err=false # error flag
811 printdiff=false # show diff to reference output?
812 status="" # test result summary
813 results="" # test result details
814 thistime="" # time the test took
816 if [ -n "$TESTS_REMAINING_LOG" ] ; then
817 sed -e "s/$seq//" -e 's/ / /' -e 's/^ *//' $TESTS_REMAINING_LOG > $TESTS_REMAINING_LOG.tmp
818 mv $TESTS_REMAINING_LOG.tmp $TESTS_REMAINING_LOG
822 lasttime=$(sed -n -e "/^$seq /s/.* //p" <$TIMESTAMP_FILE)
823 starttime=$(date "+%T")
824 _report_test_start $seq $starttime $lasttime
829 elif [ -f expunged ] && $expunge && egrep "^$seq([ ]|\$)" expunged >/dev/null
834 echo "/^$seq\$/d" >>$tmp.expunged
835 elif [ ! -f "$source_iotests/$seq" ]
838 results="no such test?"
839 echo "/^$seq\$/d" >>$tmp.expunged
841 # really going to try and run this one
844 rm -f core $seq.notrun
845 rm -f $seq.casenotrun
849 if [ "$(head -n 1 "$source_iotests/$seq")" == "#!/usr/bin/env python3" ]; then
850 if $python_usable; then
851 run_command="$PYTHON $seq"
854 echo "$python_unusable_because" > $seq.notrun
859 export OUTPUT_DIR=$PWD
861 (cd "$source_iotests";
862 MALLOC_PERTURB_=${MALLOC_PERTURB_:-$(($RANDOM % 255 + 1))} \
863 $run_command -d 2>&1 | tee $tmp.out)
865 (cd "$source_iotests";
866 MALLOC_PERTURB_=${MALLOC_PERTURB_:-$(($RANDOM % 255 + 1))} \
867 $run_command >$tmp.out 2>&1)
876 results="[dumped core] $seq.core"
880 if [ -f $seq.notrun ]
882 # overwrites timestamp output
884 results="$(cat $seq.notrun)"
889 results=$(printf %s "[failed, exit status $sts]")
893 reference="$source_iotests/$seq.out"
894 reference_machine="$source_iotests/$seq.$QEMU_DEFAULT_MACHINE.out"
895 if [ -f "$reference_machine" ]; then
896 reference="$reference_machine"
899 reference_format="$source_iotests/$seq.out.$IMGFMT"
900 if [ -f "$reference_format" ]; then
901 reference="$reference_format"
904 if [ "$CACHEMODE" = "none" ]; then
905 [ -f "$source_iotests/$seq.out.nocache" ] && reference="$source_iotests/$seq.out.nocache"
908 if [ ! -f "$reference" ]
911 results="no qualified output"
914 if diff -w "$reference" $tmp.out >/dev/null 2>&1
918 thistime=$(expr $stop - $start)
919 echo "$seq $thistime" >>$tmp.time
922 mv $tmp.out $seq.out.bad
924 results="output mismatch (see $seq.out.bad)"
930 if [ -f $seq.casenotrun ]
933 casenotrun="$casenotrun $seq"
937 # come here for each test, except when $showme is true
939 _report_test_result $seq "$status" "$starttime" "$lasttime" "$thistime" "$results"
950 $diff -w "$reference" "$PWD"/$seq.out.bad
953 n_bad=$(expr $n_bad + 1)
957 notrun="$notrun $seq"
965 status=$(expr $n_bad)