4 # Test qcow2 with external data files
6 # Copyright (C) 2019 Red Hat, Inc.
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 owner=kwolf@redhat.com
26 echo "QA output created by $seq"
28 status=1 # failure is the default!
33 _rm_test_img "$TEST_IMG.data"
34 _rm_test_img "$TEST_IMG.src"
36 trap "_cleanup; exit \$status" 0 1 2 3 15
38 # get standard environment, filters and checks
46 # External data files do not work with compat=0.10, and because we use
47 # our own external data file, we cannot let the user specify one
48 _unsupported_imgopts 'compat=0.10' data_file
51 echo "=== Create and open image with external data file ==="
54 echo "With data file name in the image:"
55 _make_test_img -o "data_file=$TEST_IMG.data" 64M
58 $QEMU_IO -c "open $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
59 $QEMU_IO -c "open -odata-file.filename=$TEST_IMG.data $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
60 $QEMU_IO -c "open -odata-file.filename=inexistent $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
63 echo "Data file required, but without data file name in the image:"
64 $QEMU_IMG amend -odata_file= $TEST_IMG
66 $QEMU_IO -c "open $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
67 $QEMU_IO -c "open -odata-file.filename=$TEST_IMG.data $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
68 $QEMU_IO -c "open -odata-file.filename=inexistent $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
71 echo "Setting data-file for an image with internal data:"
74 $QEMU_IO -c "open -odata-file.filename=$TEST_IMG.data $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
75 $QEMU_IO -c "open -odata-file.filename=inexistent $TEST_IMG" -c "read -P 0 0 64k" 2>&1 | _filter_qemu_io | _filter_testdir
78 echo "=== Conflicting features ==="
81 echo "Convert to compressed target with data file:"
82 TEST_IMG="$TEST_IMG.src" _make_test_img 64M
84 $QEMU_IO -c 'write -P 0x11 0 1M' \
85 -f $IMGFMT "$TEST_IMG.src" |
88 $QEMU_IMG convert -f $IMGFMT -O $IMGFMT -c -odata_file="$TEST_IMG.data" \
89 "$TEST_IMG.src" "$TEST_IMG"
92 echo "Convert uncompressed, then write compressed data manually:"
93 $QEMU_IMG convert -f $IMGFMT -O $IMGFMT -odata_file="$TEST_IMG.data" \
94 "$TEST_IMG.src" "$TEST_IMG"
95 $QEMU_IMG compare "$TEST_IMG.src" "$TEST_IMG"
97 $QEMU_IO -c 'write -c -P 0x22 0 1M' \
98 -f $IMGFMT "$TEST_IMG" |
103 echo "Take an internal snapshot:"
105 $QEMU_IMG snapshot -c test "$TEST_IMG"
109 echo "=== Standalone image with external data file (efficient) ==="
112 _make_test_img -o "data_file=$TEST_IMG.data" 64M
114 echo -n "qcow2 file size before I/O: "
115 du -b $TEST_IMG | cut -f1
117 # Create image with the following layout
118 # 0-1 MB: Unallocated
119 # 1-2 MB: Written (pattern 0x11)
121 # 3-4 MB: Zero write over discarded space
122 # 4-5 MB: Zero write over written space
123 # 5-6 MB: Zero write over unallocated space
126 $QEMU_IO -c 'write -P 0x11 1M 4M' \
128 -c 'write -z 3M 3M' \
129 -f $IMGFMT "$TEST_IMG" |
134 $QEMU_IMG map --output=json "$TEST_IMG"
137 $QEMU_IO -c 'read -P 0 0 1M' \
138 -c 'read -P 0x11 1M 1M' \
139 -c 'read -P 0 2M 4M' \
140 -f $IMGFMT "$TEST_IMG" |
143 # Zero clusters are only marked as such in the qcow2 metadata, but contain
144 # stale data in the external data file
146 $QEMU_IO -c 'read -P 0 0 1M' \
147 -c 'read -P 0x11 1M 1M' \
148 -c 'read -P 0x11 4M 1M' \
149 -c 'read -P 0 5M 1M' \
150 -f raw "$TEST_IMG.data" |
154 echo -n "qcow2 file size after I/O: "
155 du -b $TEST_IMG | cut -f1
158 echo "=== Standalone image with external data file (valid raw) ==="
161 _make_test_img -o "data_file=$TEST_IMG.data,data_file_raw=on" 64M
163 echo -n "qcow2 file size before I/O: "
164 du -b $TEST_IMG | cut -f1
167 $QEMU_IO -c 'write -P 0x11 1M 4M' \
169 -c 'write -z 3M 3M' \
170 -f $IMGFMT "$TEST_IMG" |
175 $QEMU_IMG map --output=json "$TEST_IMG"
178 $QEMU_IO -c 'read -P 0 0 1M' \
179 -c 'read -P 0x11 1M 1M' \
180 -c 'read -P 0 2M 4M' \
181 -f $IMGFMT "$TEST_IMG" |
184 # Discarded clusters are only marked as such in the qcow2 metadata, but
185 # they can contain stale data in the external data file. Instead, zero
186 # clusters must be zeroed in the external data file too.
188 $QEMU_IO -c 'read -P 0 0 1M' \
189 -c 'read -P 0x11 1M 1M' \
190 -c 'read -P 0 3M 3M' \
191 -f raw "$TEST_IMG".data |
194 echo -n "qcow2 file size after I/O: "
195 du -b $TEST_IMG | cut -f1
198 echo "=== bdrv_co_block_status test for file and offset=0 ==="
201 _make_test_img -o "data_file=$TEST_IMG.data" 64M
203 $QEMU_IO -c 'write -P 0x11 0 1M' -f $IMGFMT "$TEST_IMG" | _filter_qemu_io
204 $QEMU_IO -c 'read -P 0x11 0 1M' -f $IMGFMT "$TEST_IMG" | _filter_qemu_io
205 $QEMU_IMG map --output=human "$TEST_IMG" | _filter_testdir
206 $QEMU_IMG map --output=json "$TEST_IMG"
209 echo "=== Copy offloading ==="
212 # Make use of copy offloading if the test host can provide it
213 _make_test_img -o "data_file=$TEST_IMG.data" 64M
214 $QEMU_IMG convert -f $IMGFMT -O $IMGFMT -n -C "$TEST_IMG.src" "$TEST_IMG"
215 $QEMU_IMG compare -f $IMGFMT -F $IMGFMT "$TEST_IMG.src" "$TEST_IMG"
217 # blkdebug doesn't support copy offloading, so this tests the error path
218 $QEMU_IMG amend -f $IMGFMT -o "data_file=blkdebug::$TEST_IMG.data" "$TEST_IMG"
219 $QEMU_IMG convert -f $IMGFMT -O $IMGFMT -n -C "$TEST_IMG.src" "$TEST_IMG"
220 $QEMU_IMG compare -f $IMGFMT -F $IMGFMT "$TEST_IMG.src" "$TEST_IMG"
223 echo "=== Flushing should flush the data file ==="
226 # We are going to flush a qcow2 file with a blkdebug node inserted
227 # between the qcow2 node and its data file node. The blkdebug node
228 # will return an error for all flushes and so we if the data file is
229 # flushed, we will see qemu-io return an error.
231 # We need to write something or the flush will not do anything; we
232 # also need -t writeback so the write is not done as a FUA write
233 # (which would then fail thanks to the implicit flush)
234 $QEMU_IO -c 'write 0 512' -c flush \
240 'filename': '$TEST_IMG'
243 'driver': 'blkdebug',
250 'filename': '$TEST_IMG.data'
256 result=${PIPESTATUS[0]}
261 echo "ERROR: qemu-io succeeded, so the data file was not flushed"
264 echo "Success: qemu-io failed, so the data file was flushed"
267 echo "ERROR: qemu-io returned unknown exit code $result"
272 echo '=== Preallocation with data-file-raw ==='
275 echo '--- Using a non-zeroed data file ---'
277 # Using data-file-raw must enforce at least metadata preallocation so
278 # that it does not matter whether one reads the raw file or the qcow2
281 # Pre-create the data file, write some data. Real-world use cases for
282 # this are adding a qcow2 metadata file to a block device (i.e., using
283 # the device as the data file) or adding qcow2 features to pre-existing
284 # raw images (e.g. because the user now wants persistent dirty bitmaps).
285 truncate -s 1M "$TEST_IMG.data"
286 $QEMU_IO -f raw -c 'write -P 42 0 1M' "$TEST_IMG.data" | _filter_qemu_io
288 # We cannot use qemu-img to create the qcow2 image, because it would
289 # clear the data file. Use the blockdev-create job instead, which will
290 # only format the qcow2 image file.
293 -blockdev file,node-name=data,filename="$TEST_IMG.data" \
294 -blockdev file,node-name=meta,filename="$TEST_IMG"
296 _send_qemu_cmd $QEMU_HANDLE '{ "execute": "qmp_capabilities" }' 'return'
298 _send_qemu_cmd $QEMU_HANDLE \
299 '{ "execute": "blockdev-create",
304 "size": '"$((1 * 1024 * 1024))"',
307 "data-file-raw": true
309 '"status": "concluded"'
311 _send_qemu_cmd $QEMU_HANDLE \
312 '{ "execute": "job-dismiss", "arguments": { "id": "create" } }' \
318 echo 'Comparing pattern:'
320 # Reading from either the qcow2 file or the data file should return
322 $QEMU_IO -f raw -c 'read -P 42 0 1M' "$TEST_IMG.data" | _filter_qemu_io
323 $QEMU_IO -f $IMGFMT -c 'read -P 42 0 1M' "$TEST_IMG" | _filter_qemu_io
326 $QEMU_IMG compare -f raw "$TEST_IMG.data" "$TEST_IMG"
329 echo '--- Truncation (growing) ---'
331 # Append some new data to the raw file, then resize the qcow2 image
332 # accordingly and see whether the new data is visible. Technically
333 # that is not allowed, but it is reasonable behavior, so test it.
334 truncate -s 2M "$TEST_IMG.data"
335 $QEMU_IO -f raw -c 'write -P 84 1M 1M' "$TEST_IMG.data" | _filter_qemu_io
337 $QEMU_IMG resize "$TEST_IMG" 2M
340 echo 'Comparing pattern:'
342 $QEMU_IO -f raw -c 'read -P 42 0 1M' -c 'read -P 84 1M 1M' "$TEST_IMG.data" \
344 $QEMU_IO -f $IMGFMT -c 'read -P 42 0 1M' -c 'read -P 84 1M 1M' "$TEST_IMG" \
347 $QEMU_IMG compare -f raw "$TEST_IMG.data" "$TEST_IMG"
350 echo '--- Giving a backing file at runtime ---'
352 # qcow2 files with data-file-raw cannot have backing files given by
353 # their image header, but qemu will allow you to set a backing node at
354 # runtime -- it should not have any effect, though (because reading
355 # from the qcow2 node should return the same data as reading from the
358 _make_test_img -o "data_file=$TEST_IMG.data,data_file_raw=on" 1M
359 TEST_IMG="$TEST_IMG.base" _make_test_img 1M
361 # Write something that is not zero into the base image
362 $QEMU_IO -c 'write -P 42 0 1M' "$TEST_IMG.base" | _filter_qemu_io
365 echo 'Comparing qcow2 image and raw data file:'
367 # $TEST_IMG and $TEST_IMG.data must show the same data at all times;
368 # that is, the qcow2 node must not fall through to the backing image
370 $QEMU_IMG compare --image-opts \
371 "driver=raw,file.filename=$TEST_IMG.data" \
372 "file.filename=$TEST_IMG,backing.file.filename=$TEST_IMG.base"