4 # Test qcow2 image compression
6 # Copyright (C) 2018 Igalia, S.L.
7 # Author: Alberto Garcia <berto@igalia.com>
9 # This program is free software; you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 2 of the License, or
12 # (at your option) any later version.
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
24 echo "QA output created by $seq"
26 status=1 # failure is the default!
32 trap "_cleanup; exit \$status" 0 1 2 3 15
34 # get standard environment, filters and checks
39 _supported_proto file fuse
41 # Repairing the corrupted image requires qemu-img check to store a
42 # refcount up to 3, which requires at least two refcount bits.
43 # External data files do not support compressed clusters.
44 _unsupported_imgopts 'refcount_bits=1[^0-9]' data_file
48 echo "=== Corrupted size field in compressed cluster descriptor ==="
50 # Create an empty image and fill half of it with compressed data.
51 # The L2 entries of the two compressed clusters are located at
52 # 0x800000 and 0x800008, their original values are 0x4008000000a00000
53 # and 0x4008000000a00802 (5 sectors for compressed data each).
54 _make_test_img 8M -o cluster_size=2M,compression_type=zlib
55 $QEMU_IO -c "write -c -P 0x11 0 2M" -c "write -c -P 0x11 2M 2M" "$TEST_IMG" \
56 2>&1 | _filter_qemu_io | _filter_testdir
58 # Reduce size of compressed data to 4 sectors: this corrupts the image.
59 poke_file "$TEST_IMG" $((0x800000)) "\x40\x06"
60 $QEMU_IO -c "read -P 0x11 0 4M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
62 # 'qemu-img check' however doesn't see anything wrong because it
63 # doesn't try to decompress the data and the refcounts are consistent.
64 # TODO: update qemu-img so this can be detected.
67 # Increase size of compressed data to the maximum (8192 sectors).
68 # This makes QEMU read more data (8192 sectors instead of 5, host
69 # addresses [0xa00000, 0xdfffff]), but the decompression algorithm
70 # stops once we have enough to restore the uncompressed cluster, so
71 # the rest of the data is ignored.
72 poke_file "$TEST_IMG" $((0x800000)) "\x7f\xfe"
73 # Do it also for the second compressed cluster (L2 entry at 0x800008).
74 # In this case the compressed data would span 3 host clusters
75 # (host addresses: [0xa00802, 0xe00801])
76 poke_file "$TEST_IMG" $((0x800008)) "\x7f\xfe"
78 # Here the image is too small so we're asking QEMU to read beyond the
80 $QEMU_IO -c "read -P 0x11 0 4M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
81 # But if we grow the image we won't be reading beyond its end anymore.
82 $QEMU_IO -c "write -P 0x22 4M 4M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
83 $QEMU_IO -c "read -P 0x11 0 4M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
85 # The refcount data is however wrong because due to the increased size
86 # of the compressed data it now reaches the following host clusters.
87 # This can be repaired by qemu-img check by increasing the refcount of
89 # TODO: update qemu-img to correct the compressed cluster size instead.
90 _check_test_img -r all
91 $QEMU_IO -c "read -P 0x11 0 4M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
92 $QEMU_IO -c "read -P 0x22 4M 4M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
95 echo "=== Write compressed data of multiple clusters ==="
98 _make_test_img 2M -o cluster_size=$cluster_size
100 echo "Write uncompressed data:"
101 let data_size="8 * $cluster_size"
102 $QEMU_IO -c "write -P 0xaa 0 $data_size" "$TEST_IMG" \
103 2>&1 | _filter_qemu_io | _filter_testdir
104 sizeA=$($QEMU_IMG info --output=json "$TEST_IMG" |
105 sed -n '/"actual-size":/ s/[^0-9]//gp' |
108 _make_test_img 2M -o cluster_size=$cluster_size
109 echo "Write compressed data:"
110 let data_size="3 * $cluster_size + $cluster_size / 2"
111 # Set compress on. That will align the written data
112 # by the cluster size and will write them compressed.
113 QEMU_IO_OPTIONS=$QEMU_IO_OPTIONS_NO_FMT \
114 $QEMU_IO -c "write -P 0xbb 0 $data_size" --image-opts \
115 "driver=compress,file.driver=$IMGFMT,file.file.driver=file,file.file.filename=$TEST_IMG" \
116 2>&1 | _filter_qemu_io | _filter_testdir
118 let offset="4 * $cluster_size + $cluster_size / 4"
119 QEMU_IO_OPTIONS=$QEMU_IO_OPTIONS_NO_FMT \
120 $QEMU_IO -c "write -P 0xcc $offset $data_size" "json:{\
121 'driver': 'compress',
122 'file': {'driver': '$IMGFMT',
123 'file': {'driver': 'file',
124 'filename': '$TEST_IMG'}}}" | \
125 _filter_qemu_io | _filter_testdir
127 sizeB=$($QEMU_IMG info --output=json "$TEST_IMG" |
128 sed -n '/"actual-size":/ s/[^0-9]//gp' |
131 if [ $sizeA -lt $sizeB ]
133 echo "Compression ERROR ($sizeA < $sizeB)"
136 $QEMU_IMG check --output=json "$TEST_IMG" |
137 sed -n 's/,$//; /"compressed-clusters":/ s/^ *//p'