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
277 -xdiff graphical mode diff
278 -nocache use O_DIRECT on backing file
279 -misalign misalign memory allocations
280 -n show me, do not run tests
281 -o options -o options to pass to qemu-img create/convert
284 -makecheck pretty print output for make check
287 -g group[,group...] include tests from these groups
288 -x group[,group...] exclude tests from these groups
290 NNN-NNN include test range (eg. 012-021)
397 CACHEMODE_IS_DEFAULT
=false
402 QEMU_IO_OPTIONS
="$QEMU_IO_OPTIONS --misalign"
411 -g) # -g group ... pick from group file
416 -xdiff) # graphical diff mode
419 if [ ! -z "$DISPLAY" ]
421 command -v xdiff
>/dev
/null
2>&1 && diff=xdiff
422 command -v gdiff
>/dev
/null
2>&1 && diff=gdiff
423 command -v tkdiff
>/dev
/null
2>&1 && diff=tkdiff
424 command -v xxdiff
>/dev
/null
2>&1 && diff=xxdiff
427 -makecheck) # makecheck friendly output
431 -n) # show me, don't do it
447 -T) # deprecated timestamp option
458 -x) # -x group ... exclude from group file
462 '[0-9][0-9][0-9] [0-9][0-9][0-9][0-9]')
469 eval $
(echo $r |
sed -e 's/^/start=/' -e 's/-/ end=/')
473 eval $
(echo $r |
sed -e 's/^/start=/' -e 's/-//')
474 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/.* //')
477 echo "No tests in range \"$r\"?"
490 # get rid of leading 0s as can be interpreted as octal
491 start
=$
(echo $start |
sed 's/^0*//')
492 end
=$
(echo $end |
sed 's/^0*//')
498 BEGIN { for (t='$start'; t<='$end'; t++) printf "%03d\n",t }' \
501 if grep -s "^$id\( \|\$\)" "$source_iotests/group" >/dev
/null
503 # in group file ... OK
506 if [ -f expunged
] && $expunge && egrep "^$id([ ]|\$)" expunged
>/dev
/null
508 # expunged ... will be reported, but not run, later
512 if [ "$start" == "$end" -a "$id" == "$end" ]
514 echo "$id - unknown test"
517 echo "$id - unknown test, ignored"
526 # Set qemu-io cache mode with $CACHEMODE we have
527 QEMU_IO_OPTIONS
="$QEMU_IO_OPTIONS --cache $CACHEMODE"
528 # Set qemu-io aio mode with $AIOMODE we have
529 QEMU_IO_OPTIONS
="$QEMU_IO_OPTIONS --aio $AIOMODE"
531 QEMU_IO_OPTIONS_NO_FMT
="$QEMU_IO_OPTIONS"
532 if [ "$IMGOPTSSYNTAX" != "true" ]; then
533 QEMU_IO_OPTIONS
="$QEMU_IO_OPTIONS -f $IMGFMT"
536 # Set default options for qemu-img create -o if they were not specified
537 if [ "$IMGFMT" == "qcow2" ] && ! (echo "$IMGOPTS" |
grep "compat=" > /dev
/null
); then
538 IMGOPTS
=$
(_optstr_add
"$IMGOPTS" "compat=1.1")
540 if [ "$IMGFMT" == "luks" ] && ! (echo "$IMGOPTS" |
grep "iter-time=" > /dev
/null
); then
541 IMGOPTS
=$
(_optstr_add
"$IMGOPTS" "iter-time=10")
543 if [ "$IMGFMT" == "vmdk" ] && ! (echo "$IMGOPTS" |
grep "zeroed_grain=" > /dev
/null
); then
544 IMGOPTS
=$
(_optstr_add
"$IMGOPTS" "zeroed_grain=on")
547 if [ -z "$SAMPLE_IMG_DIR" ]; then
548 SAMPLE_IMG_DIR
="$source_iotests/sample_images"
553 export SAMPLE_IMG_DIR
557 # found some valid test numbers ... this is good
562 # had test numbers, but none in group file ... do nothing
565 # no test numbers, do everything from group file
566 sed -n -e '/^[0-9][0-9][0-9]*/s/^\([0-9]*\).*/\1/p' <"$source_iotests/group" >$tmp.list
570 # should be sort -n, but this did not work for Linux when this
571 # was ported from IRIX
573 list
=$
(sort $tmp.list
)
574 rm -f $tmp.list
$tmp.tmp
$tmp.
sed
576 if [ -z "$QEMU_PROG" ]
578 if [ -x "$build_iotests/qemu" ]; then
579 export QEMU_PROG
="$build_iotests/qemu"
580 elif [ -x "$build_root/${qemu_arch}-softmmu/qemu-system-${qemu_arch}" ]; then
581 export QEMU_PROG
="$build_root/${qemu_arch}-softmmu/qemu-system-${qemu_arch}"
583 pushd "$build_root" > /dev
/null
584 for binary
in *-softmmu/qemu-system-
*
588 export QEMU_PROG
="$build_root/$binary"
593 [ "$QEMU_PROG" = "" ] && _init_error
"qemu not found"
596 export QEMU_PROG
="$(type -p "$QEMU_PROG")"
599 *qemu-system-arm|
*qemu-system-aarch64
)
600 export QEMU_OPTIONS
="-nodefaults -display none -machine virt -accel qtest"
602 *qemu-system-tricore
)
603 export QEMU_OPTIONS
="-nodefaults -display none -machine tricore_testboard -accel qtest"
606 export QEMU_OPTIONS
="-nodefaults -display none -accel qtest"
610 if [ -z "$QEMU_IMG_PROG" ]; then
611 if [ -x "$build_iotests/qemu-img" ]; then
612 export QEMU_IMG_PROG
="$build_iotests/qemu-img"
613 elif [ -x "$build_root/qemu-img" ]; then
614 export QEMU_IMG_PROG
="$build_root/qemu-img"
616 _init_error
"qemu-img not found"
619 export QEMU_IMG_PROG
="$(type -p "$QEMU_IMG_PROG")"
621 if [ -z "$QEMU_IO_PROG" ]; then
622 if [ -x "$build_iotests/qemu-io" ]; then
623 export QEMU_IO_PROG
="$build_iotests/qemu-io"
624 elif [ -x "$build_root/qemu-io" ]; then
625 export QEMU_IO_PROG
="$build_root/qemu-io"
627 _init_error
"qemu-io not found"
630 export QEMU_IO_PROG
="$(type -p "$QEMU_IO_PROG")"
632 if [ -z $QEMU_NBD_PROG ]; then
633 if [ -x "$build_iotests/qemu-nbd" ]; then
634 export QEMU_NBD_PROG
="$build_iotests/qemu-nbd"
635 elif [ -x "$build_root/qemu-nbd" ]; then
636 export QEMU_NBD_PROG
="$build_root/qemu-nbd"
638 _init_error
"qemu-nbd not found"
641 export QEMU_NBD_PROG
="$(type -p "$QEMU_NBD_PROG")"
643 if [ -x "$build_iotests/socket_scm_helper" ]
645 export SOCKET_SCM_HELPER
="$build_iotests/socket_scm_helper"
649 if $PYTHON -c 'import sys; sys.exit(0 if sys.version_info >= (3,6) else 1)'
651 # Our python framework also requires virtio-blk
652 if "$QEMU_PROG" -M none
-device help |
grep -q virtio-blk
>/dev
/null
2>&1
656 python_unusable_because
="Missing virtio-blk in QEMU binary"
659 python_unusable_because
="Unsupported Python version"
662 default_machine
=$
($QEMU_PROG -machine help |
sed -n '/(default)/ s/ .*//p')
663 default_alias_machine
=$
($QEMU_PROG -machine help | \
664 sed -n "/(alias of $default_machine)/ { s/ .*//p; q; }")
665 if [[ "$default_alias_machine" ]]; then
666 default_machine
="$default_alias_machine"
669 export QEMU_DEFAULT_MACHINE
="$default_machine"
671 TIMESTAMP_FILE
=check.time-
$IMGPROTO-$IMGFMT
675 date "+%H %M %S" |
awk '{ print $1*3600 + $2*60 + $3 }'
685 if [ -f $TIMESTAMP_FILE -a -f $tmp.
time ]
687 cat $TIMESTAMP_FILE $tmp.
time \
691 for (i in t) print i " " t[i]
695 mv $tmp.out
$TIMESTAMP_FILE
698 if [ -f $tmp.expunged
]
700 notrun
=$
(wc -l <$tmp.expunged |
sed -e 's/ *//g')
701 try
=$
(expr $try - $notrun)
702 list
=$
(echo "$list" |
sed -f $tmp.expunged
)
707 echo $list |
fmt |
sed -e 's/^/ /' >>check.log
708 $interrupt && echo "Interrupted!" >>check.log
710 if [ ! -z "$notrun" ]
712 echo "Not run:$notrun"
713 echo "Not run:$notrun" >>check.log
715 if [ ! -z "$casenotrun" ]
717 echo "Some cases not run in:$casenotrun"
718 echo "Some cases not run in:$casenotrun" >>check.log
720 if [ ! -z "$n_bad" -a $n_bad != 0 ]
723 echo "Failed $n_bad of $try iotests"
724 echo "Failures:$bad" |
fmt >>check.log
725 echo "Failed $n_bad of $try iotests" >>check.log
727 echo "Passed all $try iotests"
728 echo "Passed all $try iotests" >>check.log
733 if test -n "$STTY_RESTORE"; then
736 rm -f "${TEST_DIR}"/*.out "${TEST_DIR}"/*.err "${TEST_DIR}"/*.
time
737 rm -f "${TEST_DIR}"/check.pid
"${TEST_DIR}"/check.sts
746 trap "_wrapup; exit \$status" 0 1 2 3 15
748 # Report the test start and results. For makecheck we want to pretty
749 # print the whole report at the end of the execution.
750 # args: $seq, $starttime, $lasttime
753 if ! $makecheck; then
755 local lasttime
=" (last: $3s)"
757 printf "%-8s %-10s [%s] %4s%-14s\r" "$1" "..." "$2" "..." "$lasttime"
760 # args:$seq $status $starttime $lasttime $thistime $details
761 _report_test_result
()
763 local status lasttime thistime
765 if [ -n "$2" ] && [ "$2" != "pass" ]; then
768 printf " TEST iotest-$IMGFMT: %s%s\n" "$1" "$status"
773 lasttime
=" (last: $4s)"
779 "pass") status
=$
(printf "\e[32m%-10s\e[0m" "$2") ;;
780 "fail") status
=$
(printf "\e[1m\e[31m%-10s\e[0m" "$2") ;;
781 "not run") status
=$
(printf "\e[33m%-10s\e[0m" "$2") ;;
782 *) status
=$
(printf "%-10s" "$2") ;;
785 printf "%-8s %s [%s] [%s] %4s%-14s %s\n" "$1" "$status" "$3" "$(date '+%T')" "$thistime" "$lasttime" "$6"
788 [ -f $TIMESTAMP_FILE ] ||
touch $TIMESTAMP_FILE
790 FULL_IMGFMT_DETAILS
=$
(_full_imgfmt_details
)
791 FULL_HOST_DETAILS
=$
(_full_platform_details
)
793 if ! $makecheck; then
799 [ -n "$TESTS_REMAINING_LOG" ] && echo $list > $TESTS_REMAINING_LOG
803 err
=false
# error flag
804 printdiff
=false
# show diff to reference output?
805 status
="" # test result summary
806 results
="" # test result details
807 thistime
="" # time the test took
809 if [ -n "$TESTS_REMAINING_LOG" ] ; then
810 sed -e "s/$seq//" -e 's/ / /' -e 's/^ *//' $TESTS_REMAINING_LOG > $TESTS_REMAINING_LOG.tmp
811 mv $TESTS_REMAINING_LOG.tmp
$TESTS_REMAINING_LOG
815 lasttime
=$
(sed -n -e "/^$seq /s/.* //p" <$TIMESTAMP_FILE)
816 starttime
=$
(date "+%T")
817 _report_test_start
$seq $starttime $lasttime
822 elif [ -f expunged
] && $expunge && egrep "^$seq([ ]|\$)" expunged
>/dev
/null
827 echo "/^$seq\$/d" >>$tmp.expunged
828 elif [ ! -f "$source_iotests/$seq" ]
831 results
="no such test?"
832 echo "/^$seq\$/d" >>$tmp.expunged
834 # really going to try and run this one
837 rm -f core
$seq.notrun
838 rm -f $seq.casenotrun
842 if [ "$(head -n 1 "$source_iotests/$seq")" == "#!/usr/bin/env python3" ]; then
843 if $python_usable; then
844 run_command
="$PYTHON $seq"
847 echo "$python_unusable_because" > $seq.notrun
852 export OUTPUT_DIR
=$PWD
854 (cd "$source_iotests";
855 MALLOC_PERTURB_
=${MALLOC_PERTURB_:-$(($RANDOM % 255 + 1))} \
856 $run_command -d 2>&1 |
tee $tmp.out
)
858 (cd "$source_iotests";
859 MALLOC_PERTURB_
=${MALLOC_PERTURB_:-$(($RANDOM % 255 + 1))} \
860 $run_command >$tmp.out
2>&1)
869 results
="[dumped core] $seq.core"
873 if [ -f $seq.notrun
]
875 # overwrites timestamp output
877 results
="$(cat $seq.notrun)"
882 results
=$
(printf %s
"[failed, exit status $sts]")
886 reference
="$source_iotests/$seq.out"
887 reference_machine
="$source_iotests/$seq.$QEMU_DEFAULT_MACHINE.out"
888 if [ -f "$reference_machine" ]; then
889 reference
="$reference_machine"
892 reference_format
="$source_iotests/$seq.out.$IMGFMT"
893 if [ -f "$reference_format" ]; then
894 reference
="$reference_format"
897 if [ "$CACHEMODE" = "none" ]; then
898 [ -f "$source_iotests/$seq.out.nocache" ] && reference
="$source_iotests/$seq.out.nocache"
901 if [ ! -f "$reference" ]
904 results
="no qualified output"
907 if diff -w "$reference" $tmp.out
>/dev
/null
2>&1
911 thistime
=$
(expr $stop - $start)
912 echo "$seq $thistime" >>$tmp.
time
915 mv $tmp.out
$seq.out.bad
917 results
="output mismatch (see $seq.out.bad)"
923 if [ -f $seq.casenotrun
]
926 casenotrun
="$casenotrun $seq"
930 # come here for each test, except when $showme is true
932 _report_test_result
$seq "$status" "$starttime" "$lasttime" "$thistime" "$results"
943 $diff -w "$reference" "$PWD"/$seq.out.bad
946 n_bad
=$
(expr $n_bad + 1)
950 notrun
="$notrun $seq"
958 status
=$
(expr $n_bad)