blob: 95c12577dd48ef9b07d1ac0ad1533f359dea8ccb [file] [log] [blame]
Philippe Mathieu-Daudé11a82d12019-03-07 15:58:38 +01001#!/usr/bin/env bash
Christoph Hellwig6bf19c92009-06-22 18:29:05 +02002#
Eric Blake43074632023-05-19 10:02:16 -05003# Copyright Red Hat
Christoph Hellwig6bf19c92009-06-22 18:29:05 +02004# Copyright (c) 2000-2006 Silicon Graphics, Inc. All Rights Reserved.
5#
6# This program is free software; you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation; either version 2 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
Christoph Hellwige8c212d2009-07-16 19:26:54 +020017# along with this program. If not, see <http://www.gnu.org/licenses/>.
Christoph Hellwig6bf19c92009-06-22 18:29:05 +020018#
19
Paolo Bonzinif7062522022-05-05 11:47:23 +020020export LANG=C
21
22PATH=".:$PATH"
23
24HOSTOS=$(uname -s)
25arch=$(uname -m)
26[[ "$arch" =~ "ppc64" ]] && qemu_arch=ppc64 || qemu_arch="$arch"
27
28# make sure we have a standard umask
29umask 022
30
Thomas Huth9086c762022-02-16 13:54:54 +010031# bail out, setting up .notrun file
32_notrun()
33{
Hanna Reitz1a8fcca2022-02-21 18:29:09 +010034 echo "$*" >"$TEST_DIR/$seq.notrun"
Thomas Huth9086c762022-02-16 13:54:54 +010035 echo "$seq not run: $*"
36 status=0
37 exit
38}
39
40if ! command -v gsed >/dev/null 2>&1; then
41 if sed --version 2>&1 | grep -v 'not GNU sed' | grep 'GNU sed' > /dev/null;
42 then
43 gsed()
44 {
45 sed "$@"
46 }
47 else
48 gsed()
49 {
50 _notrun "GNU sed not available"
51 }
Philippe Mathieu-Daudébde36af2019-03-07 15:58:39 +010052 fi
Philippe Mathieu-Daudébde36af2019-03-07 15:58:39 +010053fi
54
Christoph Hellwig6bf19c92009-06-22 18:29:05 +020055dd()
56{
57 if [ "$HOSTOS" == "Linux" ]
Kevin Wolf79e40ab2013-09-04 13:16:04 +020058 then
59 command dd --help | grep noxfer > /dev/null 2>&1
60
61 if [ "$?" -eq 0 ]
62 then
63 command dd status=noxfer $@
64 else
65 command dd $@
66 fi
Christoph Hellwig6bf19c92009-06-22 18:29:05 +020067 else
Kevin Wolf79e40ab2013-09-04 13:16:04 +020068 command dd $@
Christoph Hellwig6bf19c92009-06-22 18:29:05 +020069 fi
70}
71
Stefan Hajnoczi23ea2ec2013-08-06 15:44:49 +080072# poke_file 'test.img' 512 '\xff\xfe'
73poke_file()
74{
75 printf "$3" | dd "of=$1" bs=1 "seek=$2" conv=notrunc &>/dev/null
76}
77
Max Reitz2f8bb282020-03-24 18:27:56 +010078# poke_file_le $img_filename $offset $byte_width $value
79# Example: poke_file_le "$TEST_IMG" 512 2 65534
80poke_file_le()
81{
82 local img=$1 ofs=$2 len=$3 val=$4 str=''
83
84 while ((len--)); do
85 str+=$(printf '\\x%02x' $((val & 0xff)))
86 val=$((val >> 8))
87 done
88
89 poke_file "$img" "$ofs" "$str"
90}
91
92# poke_file_be $img_filename $offset $byte_width $value
93# Example: poke_file_be "$TEST_IMG" 512 2 65279
94poke_file_be()
95{
96 local img=$1 ofs=$2 len=$3 val=$4
97 local str=$(printf "%0$((len * 2))x\n" $val | sed 's/\(..\)/\\x\1/g')
98
99 poke_file "$img" "$ofs" "$str"
100}
101
Max Reitzfc8ba422019-10-11 17:28:13 +0200102# peek_file_le 'test.img' 512 2 => 65534
103peek_file_le()
104{
Eric Blake69135eb2020-02-26 06:54:24 -0600105 local val=0 shift=0 byte
106
107 # coreutils' od --endian is not portable, so manually assemble bytes.
108 for byte in $(od -j"$2" -N"$3" -An -v -tu1 "$1"); do
109 val=$(( val | (byte << shift) ))
110 shift=$((shift + 8))
111 done
112 printf %llu $val
Max Reitzfc8ba422019-10-11 17:28:13 +0200113}
114
115# peek_file_be 'test.img' 512 2 => 65279
116peek_file_be()
117{
Eric Blake69135eb2020-02-26 06:54:24 -0600118 local val=0 byte
119
120 # coreutils' od --endian is not portable, so manually assemble bytes.
121 for byte in $(od -j"$2" -N"$3" -An -v -tu1 "$1"); do
122 val=$(( (val << 8) | byte ))
123 done
124 printf %llu $val
Max Reitzfc8ba422019-10-11 17:28:13 +0200125}
126
Eric Blake69135eb2020-02-26 06:54:24 -0600127# peek_file_raw 'test.img' 512 2 => '\xff\xfe'. Do not use if the raw data
128# is likely to contain \0 or trailing \n.
Max Reitzfc8ba422019-10-11 17:28:13 +0200129peek_file_raw()
130{
131 dd if="$1" bs=1 skip="$2" count="$3" status=none
132}
133
Paolo Bonzinif7062522022-05-05 11:47:23 +0200134_optstr_add()
135{
136 if [ -n "$1" ]; then
137 echo "$1,$2"
138 else
139 echo "$2"
140 fi
141}
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200142
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300143# Set the variables to the empty string to turn Valgrind off
144# for specific processes, e.g.
145# $ VALGRIND_QEMU_IO= ./check -qcow2 -valgrind 015
146
147: ${VALGRIND_QEMU_VM=$VALGRIND_QEMU}
148: ${VALGRIND_QEMU_IMG=$VALGRIND_QEMU}
149: ${VALGRIND_QEMU_IO=$VALGRIND_QEMU}
150: ${VALGRIND_QEMU_NBD=$VALGRIND_QEMU}
Max Reitzcc575c32020-10-27 20:05:57 +0100151: ${VALGRIND_QSD=$VALGRIND_QEMU}
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300152
153# The Valgrind own parameters may be set with
154# its environment variable VALGRIND_OPTS, e.g.
155# $ VALGRIND_OPTS="--leak-check=yes" ./check -qcow2 -valgrind 015
156
157_qemu_proc_exec()
158{
159 local VALGRIND_LOGFILE="$1"
160 shift
Andrey Shinkevich8af224d2019-09-04 12:11:20 +0300161 if [[ "${VALGRIND_QEMU}" == "y" && "${NO_VALGRIND}" != "y" ]]; then
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300162 exec valgrind --log-file="${VALGRIND_LOGFILE}" --error-exitcode=99 "$@"
163 else
164 exec "$@"
165 fi
166}
167
168_qemu_proc_valgrind_log()
169{
170 local VALGRIND_LOGFILE="$1"
171 local RETVAL="$2"
Andrey Shinkevich8af224d2019-09-04 12:11:20 +0300172 if [[ "${VALGRIND_QEMU}" == "y" && "${NO_VALGRIND}" != "y" ]]; then
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300173 if [ $RETVAL == 99 ]; then
174 cat "${VALGRIND_LOGFILE}"
175 fi
176 rm -f "${VALGRIND_LOGFILE}"
177 fi
178}
179
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200180_qemu_wrapper()
181{
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300182 local VALGRIND_LOGFILE="${TEST_DIR}"/$$.valgrind
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200183 (
184 if [ -n "${QEMU_NEED_PID}" ]; then
185 echo $BASHPID > "${QEMU_TEST_DIR}/qemu-${_QEMU_HANDLE}.pid"
186 fi
Emanuele Giuseppe Esposito4d14db02021-08-09 11:01:06 +0200187
188 GDB=""
189 if [ -n "${GDB_OPTIONS}" ]; then
190 GDB="gdbserver ${GDB_OPTIONS}"
191 fi
192
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300193 VALGRIND_QEMU="${VALGRIND_QEMU_VM}" _qemu_proc_exec "${VALGRIND_LOGFILE}" \
Emanuele Giuseppe Esposito4d14db02021-08-09 11:01:06 +0200194 $GDB "$QEMU_PROG" $QEMU_OPTIONS "$@"
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200195 )
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300196 RETVAL=$?
197 _qemu_proc_valgrind_log "${VALGRIND_LOGFILE}" $RETVAL
198 return $RETVAL
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200199}
200
201_qemu_img_wrapper()
202{
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300203 local VALGRIND_LOGFILE="${TEST_DIR}"/$$.valgrind
204 (
205 VALGRIND_QEMU="${VALGRIND_QEMU_IMG}" _qemu_proc_exec "${VALGRIND_LOGFILE}" \
206 "$QEMU_IMG_PROG" $QEMU_IMG_OPTIONS "$@"
207 )
208 RETVAL=$?
209 _qemu_proc_valgrind_log "${VALGRIND_LOGFILE}" $RETVAL
210 return $RETVAL
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200211}
212
213_qemu_io_wrapper()
214{
215 local VALGRIND_LOGFILE="${TEST_DIR}"/$$.valgrind
216 local QEMU_IO_ARGS="$QEMU_IO_OPTIONS"
217 if [ "$IMGOPTSSYNTAX" = "true" ]; then
218 QEMU_IO_ARGS="--image-opts $QEMU_IO_ARGS"
219 if [ -n "$IMGKEYSECRET" ]; then
220 QEMU_IO_ARGS="--object secret,id=keysec0,data=$IMGKEYSECRET $QEMU_IO_ARGS"
221 fi
222 fi
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200223 (
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300224 VALGRIND_QEMU="${VALGRIND_QEMU_IO}" _qemu_proc_exec "${VALGRIND_LOGFILE}" \
225 "$QEMU_IO_PROG" $QEMU_IO_ARGS "$@"
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200226 )
227 RETVAL=$?
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300228 _qemu_proc_valgrind_log "${VALGRIND_LOGFILE}" $RETVAL
229 return $RETVAL
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200230}
231
232_qemu_nbd_wrapper()
233{
Andrey Shinkevich036d8cb2019-09-04 12:11:19 +0300234 local VALGRIND_LOGFILE="${TEST_DIR}"/$$.valgrind
235 (
236 VALGRIND_QEMU="${VALGRIND_QEMU_NBD}" _qemu_proc_exec "${VALGRIND_LOGFILE}" \
237 "$QEMU_NBD_PROG" --pid-file="${QEMU_TEST_DIR}/qemu-nbd.pid" \
238 $QEMU_NBD_OPTIONS "$@"
239 )
240 RETVAL=$?
241 _qemu_proc_valgrind_log "${VALGRIND_LOGFILE}" $RETVAL
242 return $RETVAL
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200243}
244
Max Reitzcc575c32020-10-27 20:05:57 +0100245_qemu_storage_daemon_wrapper()
246{
247 local VALGRIND_LOGFILE="${TEST_DIR}"/$$.valgrind
248 (
249 if [ -n "${QSD_NEED_PID}" ]; then
250 echo $BASHPID > "${QEMU_TEST_DIR}/qemu-storage-daemon.pid"
251 fi
252 VALGRIND_QEMU="${VALGRIND_QSD}" _qemu_proc_exec "${VALGRIND_LOGFILE}" \
253 "$QSD_PROG" $QSD_OPTIONS "$@"
254 )
255 RETVAL=$?
256 _qemu_proc_valgrind_log "${VALGRIND_LOGFILE}" $RETVAL
257 return $RETVAL
258}
259
Andrey Shinkevich8af224d2019-09-04 12:11:20 +0300260# Valgrind bug #409141 https://bugs.kde.org/show_bug.cgi?id=409141
261# Until valgrind 3.16+ is ubiquitous, we must work around a hang in
262# valgrind when issuing sigkill. Disable valgrind for this invocation.
263_NO_VALGRIND()
264{
265 NO_VALGRIND="y" "$@"
266}
267
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200268export QEMU=_qemu_wrapper
269export QEMU_IMG=_qemu_img_wrapper
270export QEMU_IO=_qemu_io_wrapper
271export QEMU_NBD=_qemu_nbd_wrapper
Max Reitzcc575c32020-10-27 20:05:57 +0100272export QSD=_qemu_storage_daemon_wrapper
Paolo Bonzinid1f24472017-09-12 16:44:54 +0200273
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100274if [ "$IMGOPTSSYNTAX" = "true" ]; then
275 DRIVER="driver=$IMGFMT"
Paolo Bonzinicce293a2017-09-12 16:44:56 +0200276 QEMU_IMG_EXTRA_ARGS="--image-opts $QEMU_IMG_EXTRA_ARGS"
277 if [ -n "$IMGKEYSECRET" ]; then
278 QEMU_IMG_EXTRA_ARGS="--object secret,id=keysec0,data=$IMGKEYSECRET $QEMU_IMG_EXTRA_ARGS"
279 fi
Daniel P. Berrange4e9b25f2016-05-10 17:11:29 +0100280 if [ "$IMGFMT" = "luks" ]; then
281 DRIVER="$DRIVER,key-secret=keysec0"
282 fi
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100283 if [ "$IMGPROTO" = "file" ]; then
284 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
285 TEST_IMG="$DRIVER,file.filename=$TEST_DIR/t.$IMGFMT"
286 elif [ "$IMGPROTO" = "nbd" ]; then
287 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
Max Reitzeb4ea9a2019-12-18 11:48:55 +0100288 TEST_IMG="$DRIVER,file.driver=nbd,file.type=unix"
289 TEST_IMG="$TEST_IMG,file.path=$SOCK_DIR/nbd"
Max Reitzf96ac062020-10-27 20:05:58 +0100290 elif [ "$IMGPROTO" = "fuse" ]; then
291 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
292 TEST_IMG="$DRIVER,file.filename=$SOCK_DIR/fuse-t.$IMGFMT"
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100293 elif [ "$IMGPROTO" = "ssh" ]; then
294 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
295 TEST_IMG="$DRIVER,file.driver=ssh,file.host=127.0.0.1,file.path=$TEST_IMG_FILE"
296 elif [ "$IMGPROTO" = "nfs" ]; then
297 TEST_DIR="$DRIVER,file.driver=nfs,file.filename=nfs://127.0.0.1/$TEST_DIR"
Kevin Wolfe5b77ee2016-10-27 13:16:56 +0200298 TEST_IMG=$TEST_DIR/t.$IMGFMT
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100299 else
300 TEST_IMG="$DRIVER,file.driver=$IMGPROTO,file.filename=$TEST_DIR/t.$IMGFMT"
301 fi
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900302else
Paolo Bonzinicce293a2017-09-12 16:44:56 +0200303 QEMU_IMG_EXTRA_ARGS=
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100304 if [ "$IMGPROTO" = "file" ]; then
305 TEST_IMG=$TEST_DIR/t.$IMGFMT
306 elif [ "$IMGPROTO" = "nbd" ]; then
307 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
Eric Blakef3923a72019-11-14 15:34:13 -0600308 TEST_IMG="nbd+unix:///?socket=$SOCK_DIR/nbd"
Max Reitzf96ac062020-10-27 20:05:58 +0100309 elif [ "$IMGPROTO" = "fuse" ]; then
310 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
311 TEST_IMG="$SOCK_DIR/fuse-t.$IMGFMT"
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100312 elif [ "$IMGPROTO" = "ssh" ]; then
313 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
Max Reitzb8c1f902019-02-25 20:08:27 +0100314 REMOTE_TEST_DIR="ssh://\\($USER@\\)\\?127.0.0.1\\(:[0-9]\\+\\)\\?$TEST_DIR"
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100315 TEST_IMG="ssh://127.0.0.1$TEST_IMG_FILE"
316 elif [ "$IMGPROTO" = "nfs" ]; then
Kevin Wolf655ae6b2018-05-17 17:26:14 +0200317 TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
Kevin Wolf8908b252018-05-17 18:33:52 +0200318 REMOTE_TEST_DIR="nfs://127.0.0.1$TEST_DIR"
Kevin Wolf655ae6b2018-05-17 17:26:14 +0200319 TEST_IMG="nfs://127.0.0.1$TEST_IMG_FILE"
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100320 else
321 TEST_IMG=$IMGPROTO:$TEST_DIR/t.$IMGFMT
322 fi
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900323fi
Max Reitzd2d53102020-10-27 20:05:54 +0100324ORIG_TEST_IMG_FILE=$TEST_IMG_FILE
Kevin Wolf59fa68f2017-07-27 15:13:20 +0200325ORIG_TEST_IMG="$TEST_IMG"
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200326
Max Reitzf96ac062020-10-27 20:05:58 +0100327FUSE_PIDS=()
328FUSE_EXPORTS=()
329
Paolo Bonzinicce293a2017-09-12 16:44:56 +0200330if [ -z "$TEST_DIR" ]; then
Mao Zhongyie8d81a62018-11-16 14:33:03 -0600331 TEST_DIR=$PWD/scratch
Paolo Bonzinicce293a2017-09-12 16:44:56 +0200332fi
333
334QEMU_TEST_DIR="${TEST_DIR}"
335
336if [ ! -e "$TEST_DIR" ]; then
337 mkdir "$TEST_DIR"
338fi
339
340if [ ! -d "$TEST_DIR" ]; then
Cleber Rosa49cedf12018-10-04 12:18:46 -0400341 echo "common.rc: Error: \$TEST_DIR ($TEST_DIR) is not a directory"
Paolo Bonzinicce293a2017-09-12 16:44:56 +0200342 exit 1
343fi
344
Kevin Wolf8908b252018-05-17 18:33:52 +0200345if [ -z "$REMOTE_TEST_DIR" ]; then
346 REMOTE_TEST_DIR="$TEST_DIR"
347fi
348
Paolo Bonzinicce293a2017-09-12 16:44:56 +0200349if [ ! -d "$SAMPLE_IMG_DIR" ]; then
Cleber Rosa49cedf12018-10-04 12:18:46 -0400350 echo "common.rc: Error: \$SAMPLE_IMG_DIR ($SAMPLE_IMG_DIR) is not a directory"
Paolo Bonzinicce293a2017-09-12 16:44:56 +0200351 exit 1
352fi
353
Jeff Cody85edbd32013-09-25 08:12:20 -0400354_use_sample_img()
355{
356 SAMPLE_IMG_FILE="${1%\.bz2}"
357 TEST_IMG="$TEST_DIR/$SAMPLE_IMG_FILE"
358 bzcat "$SAMPLE_IMG_DIR/$1" > "$TEST_IMG"
359 if [ $? -ne 0 ]
360 then
361 echo "_use_sample_img error, cannot extract '$SAMPLE_IMG_DIR/$1'"
362 exit 1
363 fi
364}
365
Fam Zheng2f9d4082018-07-11 14:40:46 +0800366_stop_nbd_server()
367{
368 if [ -f "${QEMU_TEST_DIR}/qemu-nbd.pid" ]; then
369 local QEMU_NBD_PID
370 read QEMU_NBD_PID < "${QEMU_TEST_DIR}/qemu-nbd.pid"
371 kill ${QEMU_NBD_PID}
Eric Blakef3923a72019-11-14 15:34:13 -0600372 rm -f "${QEMU_TEST_DIR}/qemu-nbd.pid" "$SOCK_DIR/nbd"
Fam Zheng2f9d4082018-07-11 14:40:46 +0800373 fi
374}
375
Max Reitz1b35b852019-11-07 17:37:08 +0100376# Gets the data_file value from IMGOPTS and replaces the '$TEST_IMG'
377# pattern by '$1'
378# Caution: The replacement is done with sed, so $1 must be escaped
379# properly. (The delimiter is '#'.)
380_get_data_file()
381{
382 if ! echo "$IMGOPTS" | grep -q 'data_file='; then
383 return 1
384 fi
385
386 echo "$IMGOPTS" | sed -e 's/.*data_file=\([^,]*\).*/\1/' \
387 | sed -e "s#\\\$TEST_IMG#$1#"
388}
389
Max Reitzd2d53102020-10-27 20:05:54 +0100390# Translate a $TEST_IMG to its corresponding $TEST_IMG_FILE for
391# different protocols
392_test_img_to_test_img_file()
393{
394 case "$IMGPROTO" in
395 file)
396 echo "$1"
397 ;;
398
Max Reitzf96ac062020-10-27 20:05:58 +0100399 fuse)
400 echo "$1" | sed -e "s#$SOCK_DIR/fuse-#$TEST_DIR/#"
401 ;;
402
Max Reitzd2d53102020-10-27 20:05:54 +0100403 nfs)
404 echo "$1" | sed -e "s#nfs://127.0.0.1##"
405 ;;
406
407 ssh)
408 echo "$1" | \
409 sed -e "s#ssh://\\($USER@\\)\\?127.0.0.1\\(:[0-9]\\+\\)\\?##"
410 ;;
411
412 *)
413 return 1
414 ;;
415 esac
416}
417
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200418_make_test_img()
419{
420 # extra qemu-img options can be added by tests
421 # at least one argument (the image size) needs to be added
Stefan Weil21af8142012-03-14 19:57:23 +0100422 local extra_img_options=""
Kevin Wolf89004362012-03-27 13:45:14 +0200423 local optstr=""
Nick Thomasa9660662012-11-02 13:01:23 +0000424 local img_name=""
Jeff Cody0018c032013-10-31 11:57:37 -0400425 local use_backing=0
426 local backing_file=""
Daniel P. Berrangeb7e875b2016-05-10 17:11:28 +0100427 local object_options=""
Max Reitz8b6d7be2019-11-07 17:36:55 +0100428 local opts_param=false
Max Reitzeea871d2019-11-07 17:36:54 +0100429 local misc_params=()
Nick Thomasa9660662012-11-02 13:01:23 +0000430
Max Reitzf96ac062020-10-27 20:05:58 +0100431 if [[ $IMGPROTO == fuse && $TEST_IMG == $SOCK_DIR/fuse-* ]]; then
432 # The caller may be trying to overwrite an existing image
433 _rm_test_img "$TEST_IMG"
434 fi
435
Max Reitzd2d53102020-10-27 20:05:54 +0100436 if [ -z "$TEST_IMG_FILE" ]; then
Nick Thomasa9660662012-11-02 13:01:23 +0000437 img_name=$TEST_IMG
Max Reitzd2d53102020-10-27 20:05:54 +0100438 elif [ "$IMGOPTSSYNTAX" != "true" -a \
439 "$TEST_IMG_FILE" = "$ORIG_TEST_IMG_FILE" ]; then
440 # Handle cases of tests only updating TEST_IMG, but not TEST_IMG_FILE
441 img_name=$(_test_img_to_test_img_file "$TEST_IMG")
442 if [ "$?" != 0 ]; then
443 img_name=$TEST_IMG_FILE
444 fi
445 else
446 # $TEST_IMG_FILE is not the default value, so it definitely has been
447 # modified by the test
448 img_name=$TEST_IMG_FILE
Nick Thomasa9660662012-11-02 13:01:23 +0000449 fi
Kevin Wolf89004362012-03-27 13:45:14 +0200450
451 if [ -n "$IMGOPTS" ]; then
Max Reitz1b35b852019-11-07 17:37:08 +0100452 imgopts_expanded=$(echo "$IMGOPTS" | sed -e "s#\\\$TEST_IMG#$img_name#")
453 optstr=$(_optstr_add "$optstr" "$imgopts_expanded")
Kevin Wolf89004362012-03-27 13:45:14 +0200454 fi
Daniel P. Berrangeb7e875b2016-05-10 17:11:28 +0100455 if [ -n "$IMGKEYSECRET" ]; then
456 object_options="--object secret,id=keysec0,data=$IMGKEYSECRET"
457 optstr=$(_optstr_add "$optstr" "key-secret=keysec0")
458 fi
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200459
Max Reitzeea871d2019-11-07 17:36:54 +0100460 for param; do
461 if [ "$use_backing" = "1" -a -z "$backing_file" ]; then
462 backing_file=$param
463 continue
Max Reitz8b6d7be2019-11-07 17:36:55 +0100464 elif $opts_param; then
465 optstr=$(_optstr_add "$optstr" "$param")
466 opts_param=false
467 continue
Max Reitzeea871d2019-11-07 17:36:54 +0100468 fi
469
470 case "$param" in
471 -b)
472 use_backing=1
473 ;;
474
Max Reitz8b6d7be2019-11-07 17:36:55 +0100475 -o)
476 opts_param=true
477 ;;
478
479 --no-opts)
480 optstr=""
481 ;;
482
Max Reitzeea871d2019-11-07 17:36:54 +0100483 *)
484 misc_params=("${misc_params[@]}" "$param")
485 ;;
486 esac
487 done
488
Stefan Hajnoczif5a4bbd2010-10-31 16:10:20 -0400489 if [ \( "$IMGFMT" = "qcow2" -o "$IMGFMT" = "qed" \) -a -n "$CLUSTER_SIZE" ]; then
Kevin Wolf89004362012-03-27 13:45:14 +0200490 optstr=$(_optstr_add "$optstr" "cluster_size=$CLUSTER_SIZE")
491 fi
492
493 if [ -n "$optstr" ]; then
494 extra_img_options="-o $optstr $extra_img_options"
Kevin Wolf8fc10242009-10-01 14:29:59 -0300495 fi
496
Fam Zheng2f9d4082018-07-11 14:40:46 +0800497 if [ $IMGPROTO = "nbd" ]; then
498 _stop_nbd_server
499 fi
500
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200501 # XXX(hch): have global image options?
Jeff Cody0018c032013-10-31 11:57:37 -0400502 (
503 if [ $use_backing = 1 ]; then
Max Reitzeea871d2019-11-07 17:36:54 +0100504 $QEMU_IMG create $object_options -f $IMGFMT $extra_img_options -b "$backing_file" "$img_name" "${misc_params[@]}" 2>&1
Jeff Cody0018c032013-10-31 11:57:37 -0400505 else
Max Reitzeea871d2019-11-07 17:36:54 +0100506 $QEMU_IMG create $object_options -f $IMGFMT $extra_img_options "$img_name" "${misc_params[@]}" 2>&1
Jeff Cody0018c032013-10-31 11:57:37 -0400507 fi
Kevin Wolf6ffb4cb2014-08-19 19:28:58 +0200508 ) | _filter_img_create
Nick Thomasa9660662012-11-02 13:01:23 +0000509
Eric Blakef3923a72019-11-14 15:34:13 -0600510 # Start an NBD server on the image file, which is what we'll be talking to.
511 # Once NBD gains resize support, we may also want to use -f raw at the
512 # server and interpret format over NBD, but for now, the format is
513 # interpreted at the server and raw data sent over NBD.
Nick Thomasa9660662012-11-02 13:01:23 +0000514 if [ $IMGPROTO = "nbd" ]; then
Max Reitz03a0aa32017-04-26 16:14:07 +0200515 # Pass a sufficiently high number to -e that should be enough for all
516 # tests
Eric Blakef3923a72019-11-14 15:34:13 -0600517 eval "$QEMU_NBD -v -t -k '$SOCK_DIR/nbd' -f $IMGFMT -e 42 -x '' $TEST_IMG_FILE >/dev/null &"
Nick Thomasa9660662012-11-02 13:01:23 +0000518 sleep 1 # FIXME: qemu-nbd needs to be listening before we continue
519 fi
Max Reitzf96ac062020-10-27 20:05:58 +0100520
521 if [ $IMGPROTO = "fuse" -a -f "$img_name" ]; then
522 local export_mp
523 local pid
524 local pidfile
525 local timeout
526
527 export_mp=$(echo "$img_name" | sed -e "s#$TEST_DIR/#$SOCK_DIR/fuse-#")
528 if ! echo "$export_mp" | grep -q "^$SOCK_DIR"; then
529 echo 'Cannot use FUSE exports with images outside of TEST_DIR' >&2
530 return 1
531 fi
532
533 touch "$export_mp"
534 rm -f "$SOCK_DIR/fuse-output"
535
536 # Usually, users would export formatted nodes. But we present fuse as a
537 # protocol-level driver here, so we have to leave the format to the
538 # client.
Max Reitz8fc54f92021-06-25 16:23:13 +0200539 # Switch off allow-other, because in general we do not need it for
540 # iotests. The default allow-other=auto has the downside of printing a
541 # fusermount error on its first attempt if allow_other is not
542 # permissible, which we would need to filter.
Max Reitzf96ac062020-10-27 20:05:58 +0100543 QSD_NEED_PID=y $QSD \
544 --blockdev file,node-name=export-node,filename=$img_name,discard=unmap \
Max Reitz8fc54f92021-06-25 16:23:13 +0200545 --export fuse,id=fuse-export,node-name=export-node,mountpoint="$export_mp",writable=on,growable=on,allow-other=off \
Max Reitzf96ac062020-10-27 20:05:58 +0100546 &
547
548 pidfile="$QEMU_TEST_DIR/qemu-storage-daemon.pid"
549
550 # Wait for the PID file
551 while [ ! -f "$pidfile" ]; do
552 sleep 0.5
553 done
554
555 pid=$(cat "$pidfile")
556 rm -f "$pidfile"
557
558 FUSE_PIDS+=($pid)
559 FUSE_EXPORTS+=("$export_mp")
560 fi
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200561}
562
Fam Zheng487c1912013-11-26 14:40:34 +0800563_rm_test_img()
564{
565 local img=$1
Max Reitzf96ac062020-10-27 20:05:58 +0100566
567 if [[ $IMGPROTO == fuse && $img == $SOCK_DIR/fuse-* ]]; then
568 # Drop a FUSE export
569 local df_output
570 local i
571 local image_file
572 local index=''
573 local timeout
574
575 for i in "${!FUSE_EXPORTS[@]}"; do
576 if [ "${FUSE_EXPORTS[i]}" = "$img" ]; then
577 index=$i
578 break
579 fi
580 done
581
582 if [ -z "$index" ]; then
583 # Probably gone already
584 return 0
585 fi
586
587 kill "${FUSE_PIDS[index]}"
588
589 # Wait until the mount is gone
590 timeout=10 # *0.5 s
591 while true; do
592 # Will show the mount point; if the mount is still there,
593 # it will be $img.
594 df_output=$(df "$img" 2>/dev/null)
595
596 # But df may also show an error ("Transpoint endpoint not
597 # connected"), so retry in such cases
598 if [ -n "$df_output" ]; then
599 if ! echo "$df_output" | grep -q "$img"; then
600 break
601 fi
602 fi
603
604 sleep 0.5
605
606 timeout=$((timeout - 1))
607 if [ "$timeout" = 0 ]; then
608 echo 'Failed to take down FUSE export' >&2
609 return 1
610 fi
611 done
612
613 rm -f "$img"
614
615 unset "FUSE_PIDS[$index]"
616 unset "FUSE_EXPORTS[$index]"
617
618 image_file=$(echo "$img" | sed -e "s#$SOCK_DIR/fuse-#$TEST_DIR/#")
619 _rm_test_img "$image_file"
620 return
621 fi
622
Fam Zheng487c1912013-11-26 14:40:34 +0800623 if [ "$IMGFMT" = "vmdk" ]; then
624 # Remove all the extents for vmdk
Jeff Codyc5575272014-04-10 16:47:39 -0400625 "$QEMU_IMG" info "$img" 2>/dev/null | grep 'filename:' | cut -f 2 -d: \
Fam Zheng487c1912013-11-26 14:40:34 +0800626 | xargs -I {} rm -f "{}"
Max Reitz1b35b852019-11-07 17:37:08 +0100627 elif [ "$IMGFMT" = "qcow2" ]; then
628 # Remove external data file
629 if data_file=$(_get_data_file "$img"); then
630 rm -f "$data_file"
631 fi
Fam Zheng487c1912013-11-26 14:40:34 +0800632 fi
Jeff Codyc5575272014-04-10 16:47:39 -0400633 rm -f "$img"
Fam Zheng487c1912013-11-26 14:40:34 +0800634}
635
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200636_cleanup_test_img()
637{
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900638 case "$IMGPROTO" in
639
Nick Thomasa9660662012-11-02 13:01:23 +0000640 nbd)
Fam Zheng2f9d4082018-07-11 14:40:46 +0800641 _stop_nbd_server
Jeff Codyfef9c192013-09-25 08:12:22 -0400642 rm -f "$TEST_IMG_FILE"
Nick Thomasa9660662012-11-02 13:01:23 +0000643 ;;
Ashish Mittalae0c0a32017-04-03 20:48:09 -0700644
Max Reitzf96ac062020-10-27 20:05:58 +0100645 fuse)
646 local mp
647
648 for mp in "${FUSE_EXPORTS[@]}"; do
649 _rm_test_img "$mp"
650 done
651
652 FUSE_PIDS=()
653 FUSE_EXPORTS=()
654 ;;
655
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900656 file)
Fam Zheng487c1912013-11-26 14:40:34 +0800657 _rm_test_img "$TEST_DIR/t.$IMGFMT"
658 _rm_test_img "$TEST_DIR/t.$IMGFMT.orig"
659 _rm_test_img "$TEST_DIR/t.$IMGFMT.base"
Jeff Cody85edbd32013-09-25 08:12:20 -0400660 if [ -n "$SAMPLE_IMG_FILE" ]
661 then
662 rm -f "$TEST_DIR/$SAMPLE_IMG_FILE"
Kevin Wolf59fa68f2017-07-27 15:13:20 +0200663 SAMPLE_IMG_FILE=
664 TEST_IMG="$ORIG_TEST_IMG"
Jeff Cody85edbd32013-09-25 08:12:20 -0400665 fi
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900666 ;;
667
668 rbd)
Loic Dachary9147d012014-01-08 21:05:38 +0100669 rbd --no-progress rm "$TEST_DIR/t.$IMGFMT" > /dev/null
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900670 ;;
671
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900672 esac
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200673}
674
675_check_test_img()
676{
Daniel P. Berrange076003f2016-05-10 17:11:27 +0100677 (
678 if [ "$IMGOPTSSYNTAX" = "true" ]; then
679 $QEMU_IMG check $QEMU_IMG_EXTRA_ARGS "$@" "$TEST_IMG" 2>&1
680 else
681 $QEMU_IMG check "$@" -f $IMGFMT "$TEST_IMG" 2>&1
682 fi
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200683 ) | _filter_testdir | _filter_qemu_img_check
Vladimir Sementsov-Ogievskiyee1e66d2019-09-16 20:53:20 +0300684
685 # return real qemu_img check status, to analyze in
686 # _check_test_img_ignore_leaks
687 return ${PIPESTATUS[0]}
688}
689
690_check_test_img_ignore_leaks()
691{
692 out=$(_check_test_img "$@")
693 status=$?
694 if [ $status = 3 ]; then
695 # This must correspond to success output in dump_human_image_check()
696 echo "No errors were found on the image."
697 return 0
698 fi
699 echo "$out"
700 return $status
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200701}
702
Stefan Hajnoczi514d9da2012-10-17 14:02:32 +0200703_img_info()
704{
Kevin Wolfe800e5d2014-11-27 15:03:53 +0100705 if [[ "$1" == "--format-specific" ]]; then
706 local format_specific=1
707 shift
708 else
709 local format_specific=0
710 fi
711
Max Reitz4c2e9462013-10-09 10:46:19 +0200712 discard=0
713 regex_json_spec_start='^ *"format-specific": \{'
Hanna Reitzbcc67772022-06-20 18:27:01 +0200714 regex_json_child_start='^ *"children": \['
Kevin Wolfd06195e2018-03-02 18:38:14 +0100715 $QEMU_IMG info $QEMU_IMG_EXTRA_ARGS "$@" "$TEST_IMG" 2>&1 | \
Kevin Wolf8908b252018-05-17 18:33:52 +0200716 sed -e "s#$REMOTE_TEST_DIR#TEST_DIR#g" \
717 -e "s#$IMGPROTO:$TEST_DIR#TEST_DIR#g" \
Stefan Hajnoczi514d9da2012-10-17 14:02:32 +0200718 -e "s#$TEST_DIR#TEST_DIR#g" \
Max Reitzf96ac062020-10-27 20:05:58 +0100719 -e "s#$SOCK_DIR/fuse-#TEST_DIR/#g" \
Eric Blake43074632023-05-19 10:02:16 -0500720 -e "s#$SOCK_DIR/#SOCK_DIR/#g" \
Stefan Hajnoczi514d9da2012-10-17 14:02:32 +0200721 -e "s#$IMGFMT#IMGFMT#g" \
Vladimir Sementsov-Ogievskiydba5aee2021-12-23 17:01:41 +0100722 -e 's/\(compression type: \)\(zlib\|zstd\)/\1COMPRESSION_TYPE/' \
Stefan Hajnoczi514d9da2012-10-17 14:02:32 +0200723 -e "/^disk size:/ D" \
Max Reitz4c2e9462013-10-09 10:46:19 +0200724 -e "/actual-size/ D" | \
Max Reitz6dd6d7a2017-11-23 03:08:20 +0100725 while IFS='' read -r line; do
Hanna Reitzbcc67772022-06-20 18:27:01 +0200726 if [[ $discard == 0 ]]; then
727 if [[ $format_specific == 0 && $line == "Format specific information:" ]]; then
728 discard=1
729 elif [[ $line =~ "Child node '/" ]]; then
730 discard=1
731 elif [[ $format_specific == 0 && $line =~ $regex_json_spec_start ]]; then
732 discard=2
733 regex_json_end="^${line%%[^ ]*}\\},? *$"
734 elif [[ $line =~ $regex_json_child_start ]]; then
735 discard=2
736 regex_json_end="^${line%%[^ ]*}\\],? *$"
737 fi
Max Reitz4c2e9462013-10-09 10:46:19 +0200738 fi
739 if [[ $discard == 0 ]]; then
740 echo "$line"
741 elif [[ $discard == 1 && ! $line ]]; then
742 echo
743 discard=0
Hanna Reitzbcc67772022-06-20 18:27:01 +0200744 elif [[ $discard == 2 && $line =~ $regex_json_end ]]; then
Max Reitz4c2e9462013-10-09 10:46:19 +0200745 discard=0
746 fi
747 done
Stefan Hajnoczi514d9da2012-10-17 14:02:32 +0200748}
749
Andrey Shinkevich5ff1c2c2019-09-04 12:11:21 +0300750# bail out, setting up .casenotrun file
751# The function _casenotrun() is used as a notifier. It is the
752# caller's responsibility to make skipped a particular test.
753#
754_casenotrun()
755{
Hanna Reitz1a8fcca2022-02-21 18:29:09 +0100756 echo " [case not run] $*" >>"$TEST_DIR/$seq.casenotrun"
Andrey Shinkevich5ff1c2c2019-09-04 12:11:21 +0300757}
758
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200759# just plain bail out
760#
761_fail()
762{
Hanna Reitz1a8fcca2022-02-21 18:29:09 +0100763 echo "$*" | tee -a "$TEST_DIR/$seq.full"
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200764 echo "(see $seq.full for details)"
765 status=1
766 exit 1
767}
768
769# tests whether $IMGFMT is one of the supported image formats for a test
770#
771_supported_fmt()
772{
Stefan Hajnoczi47f73da2014-03-26 13:05:23 +0100773 # "generic" is suitable for most image formats. For some formats it doesn't
774 # work, however (most notably read-only formats), so they can opt out by
775 # setting IMGFMT_GENERIC to false.
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200776 for f; do
Jeff Cody89e91182013-09-27 08:48:15 -0400777 if [ "$f" = "$IMGFMT" -o "$f" = "generic" -a "$IMGFMT_GENERIC" = "true" ]; then
Max Reitzd2a839e2020-06-25 14:55:35 +0200778 if [ "$IMGFMT" = "luks" ]; then
779 _require_working_luks
780 fi
Kevin Wolf79e40ab2013-09-04 13:16:04 +0200781 return
782 fi
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200783 done
784
785 _notrun "not suitable for this image format: $IMGFMT"
786}
787
Nir Sofferb4a2caa2017-02-01 02:31:19 +0200788# tests whether $IMGFMT is one of the unsupported image format for a test
789#
790_unsupported_fmt()
791{
792 for f; do
793 if [ "$f" = "$IMGFMT" ]; then
794 _notrun "not suitable for this image format: $IMGFMT"
795 fi
796 done
797}
798
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900799# tests whether $IMGPROTO is one of the supported image protocols for a test
800#
801_supported_proto()
802{
803 for f; do
Kevin Wolf79e40ab2013-09-04 13:16:04 +0200804 if [ "$f" = "$IMGPROTO" -o "$f" = "generic" ]; then
805 return
806 fi
MORITA Kazutaka9cdfa1b2011-01-18 02:01:17 +0900807 done
808
809 _notrun "not suitable for this image protocol: $IMGPROTO"
810}
811
Jeff Codydfac03d2017-02-14 11:21:17 -0500812# tests whether $IMGPROTO is specified as an unsupported image protocol for a test
813#
814_unsupported_proto()
815{
816 for f; do
817 if [ "$f" = "$IMGPROTO" ]; then
818 _notrun "not suitable for this image protocol: $IMGPROTO"
819 return
820 fi
821 done
822}
823
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200824# tests whether the host OS is one of the supported OSes for a test
825#
826_supported_os()
827{
828 for h
829 do
Kevin Wolf79e40ab2013-09-04 13:16:04 +0200830 if [ "$h" = "$HOSTOS" ]
831 then
832 return
833 fi
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200834 done
835
836 _notrun "not suitable for this OS: $HOSTOS"
837}
838
Fam Zhengf210a832013-12-04 09:07:00 +0800839_supported_cache_modes()
Stefan Hajnoczi166f3c72012-08-09 13:05:57 +0100840{
Fam Zhengf210a832013-12-04 09:07:00 +0800841 for mode; do
842 if [ "$mode" = "$CACHEMODE" ]; then
843 return
844 fi
Stefan Hajnoczi166f3c72012-08-09 13:05:57 +0100845 done
Fam Zhengf210a832013-12-04 09:07:00 +0800846 _notrun "not suitable for cache mode: $CACHEMODE"
847}
848
Vladimir Sementsov-Ogievskiycfdca2b2020-04-30 15:47:06 +0300849# Check whether the filesystem supports O_DIRECT
850_check_o_direct()
851{
Vladimir Sementsov-Ogievskiy0c8de0a2020-12-18 21:20:12 +0300852 testfile="$TEST_DIR"/_check_o_direct
853 $QEMU_IMG create -f raw "$testfile" 1M > /dev/null
854 out=$($QEMU_IO -f raw -t none -c quit "$testfile" 2>&1)
855 rm -f "$testfile"
Vladimir Sementsov-Ogievskiycfdca2b2020-04-30 15:47:06 +0300856
857 [[ "$out" != *"O_DIRECT"* ]]
858}
859
860_require_o_direct()
861{
862 if ! _check_o_direct; then
863 _notrun "file system on $TEST_DIR does not support O_DIRECT"
864 fi
865}
866
867_check_cache_mode()
868{
869 if [ $CACHEMODE == "none" ] || [ $CACHEMODE == "directsync" ]; then
870 _require_o_direct
871 fi
872}
873
874_check_cache_mode
875
876# $1 - cache mode to use by default
877# $2 - (optional) cache mode to use by default if O_DIRECT is not supported
Fam Zhengf210a832013-12-04 09:07:00 +0800878_default_cache_mode()
879{
880 if $CACHEMODE_IS_DEFAULT; then
Vladimir Sementsov-Ogievskiycfdca2b2020-04-30 15:47:06 +0300881 if [ -z "$2" ] || _check_o_direct; then
882 CACHEMODE="$1"
883 else
884 CACHEMODE="$2"
885 fi
886 QEMU_IO="$QEMU_IO --cache $CACHEMODE"
887 _check_cache_mode
Fam Zhengf210a832013-12-04 09:07:00 +0800888 return
889 fi
Stefan Hajnoczi166f3c72012-08-09 13:05:57 +0100890}
Aarushi Mehta7156ca42020-01-20 14:18:57 +0000891_supported_aio_modes()
892{
893 for mode; do
894 if [ "$mode" = "$AIOMODE" ]; then
895 return
896 fi
897 done
898 _notrun "not suitable for aio mode: $AIOMODE"
899}
900_default_aio_mode()
901{
902 AIOMODE="$1"
903 QEMU_IO="$QEMU_IO --aio $1"
904}
Stefan Hajnoczi166f3c72012-08-09 13:05:57 +0100905
Fam Zheng2c77f522013-11-26 14:40:32 +0800906_unsupported_imgopts()
907{
908 for bad_opt
909 do
Max Reitzb34cdf32021-02-10 10:51:28 +0100910 # Add a space so tests can match for whitespace that marks the
911 # end of an option (\b or \> are not portable)
912 if echo "$IMGOPTS " | grep -q 2>/dev/null "$bad_opt"
Fam Zheng2c77f522013-11-26 14:40:32 +0800913 then
914 _notrun "not suitable for image option: $bad_opt"
915 fi
916 done
917}
918
Max Reitzdc4ab022020-06-25 14:55:32 +0200919# Caution: Overwrites $TEST_DIR/t.luks
920_require_working_luks()
921{
922 file="$TEST_DIR/t.luks"
923
924 output=$(
925 $QEMU_IMG create -f luks \
926 --object secret,id=sec0,data=hunter0 \
927 -o key-secret=sec0 \
928 -o iter-time=10 \
929 "$file" \
930 1M \
931 2>&1
932 )
933 status=$?
934
935 IMGFMT='luks' _rm_test_img "$file"
936
937 if [ $status != 0 ]; then
Thomas Huth9086c762022-02-16 13:54:54 +0100938 reason=$(echo "$output" | grep "$file:" | sed -e "s#.*$file: *##")
Max Reitzdc4ab022020-06-25 14:55:32 +0200939 if [ -z "$reason" ]; then
940 reason="Failed to create a LUKS image"
941 fi
942 _notrun "$reason"
943 fi
944}
945
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200946# this test requires that a specified command (executable) exists
947#
948_require_command()
949{
Max Reitz934659c2015-09-02 20:52:27 +0200950 if [ "$1" = "QEMU" ]; then
951 c=$QEMU_PROG
952 elif [ "$1" = "QEMU_IMG" ]; then
953 c=$QEMU_IMG_PROG
954 elif [ "$1" = "QEMU_IO" ]; then
955 c=$QEMU_IO_PROG
956 elif [ "$1" = "QEMU_NBD" ]; then
957 c=$QEMU_NBD_PROG
958 else
959 eval c=\$$1
960 fi
Wenchao Xia9c468a02013-12-04 17:10:56 +0800961 [ -x "$c" ] || _notrun "$1 utility required, skipped this test"
Christoph Hellwig6bf19c92009-06-22 18:29:05 +0200962}
963
Thomas Huth21b43d02019-08-23 15:35:52 +0200964# Check that a set of drivers has been whitelisted in the QEMU binary
965#
966_require_drivers()
967{
968 available=$($QEMU -drive format=help | \
969 sed -e '/Supported formats:/!d' -e 's/Supported formats://')
970 for driver
971 do
972 if ! echo "$available" | grep -q " $driver\( \|$\)"; then
973 _notrun "$driver not available"
974 fi
975 done
976}
977
Thomas Huth059f7082019-12-02 11:16:29 +0100978# Check that we have a file system that allows huge (but very sparse) files
979#
980_require_large_file()
981{
Denis V. Lunev0189c272023-09-06 16:09:15 +0200982 if [ -z "$TEST_IMG_FILE" ]; then
983 FILENAME="$TEST_IMG"
984 else
985 FILENAME="$TEST_IMG_FILE"
986 fi
987 if ! truncate --size="$1" "$FILENAME"; then
Thomas Huth059f7082019-12-02 11:16:29 +0100988 _notrun "file system on $TEST_DIR does not support large enough files"
989 fi
Denis V. Lunev0189c272023-09-06 16:09:15 +0200990 rm "$FILENAME"
Thomas Huth059f7082019-12-02 11:16:29 +0100991}
992
Thomas Huth9bdabfb2020-01-21 10:52:03 +0100993# Check that a set of devices is available in the QEMU binary
994#
995_require_devices()
996{
Cole Robinsone13fe272022-06-05 10:57:17 -0400997 available=$($QEMU -M none -device help 2> /dev/null | \
Thomas Huth9bdabfb2020-01-21 10:52:03 +0100998 grep ^name | sed -e 's/^name "//' -e 's/".*$//')
999 for device
1000 do
1001 if ! echo "$available" | grep -q "$device" ; then
1002 _notrun "$device not available"
1003 fi
1004 done
1005}
1006
Laurent Vivier359a8562021-03-23 16:53:07 +00001007_require_one_device_of()
1008{
Cole Robinsone13fe272022-06-05 10:57:17 -04001009 available=$($QEMU -M none -device help 2> /dev/null | \
Laurent Vivier359a8562021-03-23 16:53:07 +00001010 grep ^name | sed -e 's/^name "//' -e 's/".*$//')
1011 for device
1012 do
1013 if echo "$available" | grep -q "$device" ; then
1014 return
1015 fi
1016 done
1017 _notrun "$* not available"
1018}
1019
Vladimir Sementsov-Ogievskiyc5e627a2021-12-23 17:01:38 +01001020_qcow2_dump_header()
1021{
Vladimir Sementsov-Ogievskiydba5aee2021-12-23 17:01:41 +01001022 if [[ "$1" == "--no-filter-compression" ]]; then
1023 local filter_compression=0
1024 shift
1025 else
1026 local filter_compression=1
1027 fi
1028
Vladimir Sementsov-Ogievskiyc5e627a2021-12-23 17:01:38 +01001029 img="$1"
1030 if [ -z "$img" ]; then
1031 img="$TEST_IMG"
1032 fi
1033
Vladimir Sementsov-Ogievskiydba5aee2021-12-23 17:01:41 +01001034 if [[ $filter_compression == 0 ]]; then
1035 $PYTHON qcow2.py "$img" dump-header
1036 else
1037 $PYTHON qcow2.py "$img" dump-header | _filter_qcow2_compression_type_bit
1038 fi
Vladimir Sementsov-Ogievskiyc5e627a2021-12-23 17:01:38 +01001039}
1040
Christoph Hellwig6bf19c92009-06-22 18:29:05 +02001041# make sure this script returns success
Fam Zhenga2d9c0c2015-01-04 09:53:48 +08001042true