1#!/usr/bin/env bash
2# group: rw auto backing
3#
4# Commit changes into backing chains and empty the top image if the
5# backing image is not explicitly specified.
6#
7# Variant of 097, which includes snapshots and persistent bitmaps, to
8# tickle the slow codepath in qcow2. See also 198, for another feature
9# that tickles the slow codepath.
10#
11# Copyright (C) 2014, 2017 Red Hat, Inc.
12#
13# This program is free software; you can redistribute it and/or modify
14# it under the terms of the GNU General Public License as published by
15# the Free Software Foundation; either version 2 of the License, or
16# (at your option) any later version.
17#
18# This program is distributed in the hope that it will be useful,
19# but WITHOUT ANY WARRANTY; without even the implied warranty of
20# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21# GNU General Public License for more details.
22#
23# You should have received a copy of the GNU General Public License
24# along with this program.  If not, see <http://www.gnu.org/licenses/>.
25#
26
27# creator
28owner=mreitz@redhat.com
29
30seq="$(basename $0)"
31echo "QA output created by $seq"
32
33status=1	# failure is the default!
34
35_cleanup()
36{
37    _cleanup_test_img
38    _rm_test_img "$TEST_IMG.itmd"
39}
40trap "_cleanup; exit \$status" 0 1 2 3 15
41
42# get standard environment, filters and checks
43. ./common.rc
44. ./common.filter
45. ./common.pattern
46
47# This test is specific to qcow2
48_supported_fmt qcow2
49_supported_proto file fuse
50_supported_os Linux
51# Persistent dirty bitmaps require compat=1.1;
52# Internal snapshots forbid using an external data file
53# (they work with refcount_bits=1 here, though, because there actually
54# is no data when creating the snapshot)
55_unsupported_imgopts 'compat=0.10' data_file
56
57run_qemu()
58{
59    $QEMU -nographic -qmp stdio -serial none "$@" 2>&1 \
60	| _filter_testdir | _filter_qmp | _filter_qemu \
61        | sed 's/"sha256": ".\{64\}"/"sha256": HASH/'
62}
63
64for reason in snapshot bitmap; do
65
66# Four passes:
67#  0: Two-layer backing chain, commit to upper backing file (implicitly)
68#     (in this case, the top image will be emptied)
69#  1: Two-layer backing chain, commit to upper backing file (explicitly)
70#     (in this case, the top image will implicitly stay unchanged)
71#  2: Two-layer backing chain, commit to upper backing file (implicitly with -d)
72#     (in this case, the top image will explicitly stay unchanged)
73#  3: Two-layer backing chain, commit to lower backing file
74#     (in this case, the top image will implicitly stay unchanged)
75#
76# 020 already tests committing, so this only tests whether image chains are
77# working properly and that all images above the base are emptied; therefore,
78# no complicated patterns are necessary.  Check near the 2G mark, as qcow2
79# has been buggy at that boundary in the past.
80for i in 0 1 2 3; do
81
82echo
83echo "=== Test pass $reason.$i ==="
84echo
85
86len=$((2100 * 1024 * 1024 + 512)) # larger than 2G, and not cluster aligned
87TEST_IMG="$TEST_IMG.base" _make_test_img $len
88TEST_IMG="$TEST_IMG.itmd" _make_test_img -b "$TEST_IMG.base" -F $IMGFMT $len
89_make_test_img -b "$TEST_IMG.itmd" -F $IMGFMT $len
90# Update the top image to use a feature that is incompatible with fast path
91case $reason in
92    snapshot) $QEMU_IMG snapshot -c snap "$TEST_IMG" ;;
93    bitmap)
94	run_qemu <<EOF
95{ "execute": "qmp_capabilities" }
96{ "execute": "blockdev-add",
97  "arguments": { "driver": "qcow2", "node-name": "drive0",
98     "file": { "driver": "file", "filename": "$TEST_IMG" } } }
99{ "execute": "block-dirty-bitmap-add",
100  "arguments": { "node": "drive0", "name": "bitmap0",
101     "persistent": true } }
102{ "execute": "quit" }
103EOF
104	;;
105esac
106
107$QEMU_IO -c "write -P 1 0x7ffd0000 192k" "$TEST_IMG.base" | _filter_qemu_io
108$QEMU_IO -c "write -P 2 0x7ffe0000 128k" "$TEST_IMG.itmd" | _filter_qemu_io
109$QEMU_IO -c "write -P 3 0x7fff0000 64k" "$TEST_IMG" | _filter_qemu_io
110$QEMU_IO -c "write -P 4 $(($len - 512)) 512" "$TEST_IMG" | _filter_qemu_io
111
112if [ $i -lt 3 ]; then
113    if [ $i == 0 ]; then
114        # -b "$TEST_IMG.itmd" should be the default (that is, committing to the
115        # first backing file in the chain)
116        $QEMU_IMG commit "$TEST_IMG"
117    elif [ $i == 1 ]; then
118        # explicitly specify the commit target (this should imply -d)
119        $QEMU_IMG commit -b "$TEST_IMG.itmd" "$TEST_IMG"
120    else
121        # do not explicitly specify the commit target, but use -d to leave the
122        # top image unchanged
123        $QEMU_IMG commit -d "$TEST_IMG"
124    fi
125
126    # Bottom should be unchanged
127    $QEMU_IO -c 'read -P 1 0x7ffd0000 192k' "$TEST_IMG.base" | _filter_qemu_io
128    $QEMU_IO -c "read -P 0 $((len - 512)) 512" "$TEST_IMG.base" | _filter_qemu_io
129
130    # Intermediate should contain changes from top
131    $QEMU_IO -c 'read -P 1 0x7ffd0000 64k' "$TEST_IMG.itmd" | _filter_qemu_io
132    $QEMU_IO -c 'read -P 2 0x7ffe0000 64k' "$TEST_IMG.itmd" | _filter_qemu_io
133    $QEMU_IO -c 'read -P 3 0x7fff0000 64k' "$TEST_IMG.itmd" | _filter_qemu_io
134    $QEMU_IO -c "read -P 4 $((len - 512)) 512" "$TEST_IMG.itmd" | _filter_qemu_io
135
136    # And in pass 0, the top image should be empty, whereas in both other passes
137    # it should be unchanged (which is both checked by qemu-img map)
138else
139    $QEMU_IMG commit -b "$TEST_IMG.base" "$TEST_IMG"
140
141    # Bottom should contain all changes
142    $QEMU_IO -c 'read -P 1 0x7ffd0000 64k' "$TEST_IMG.base" | _filter_qemu_io
143    $QEMU_IO -c 'read -P 2 0x7ffe0000 64k' "$TEST_IMG.base" | _filter_qemu_io
144    $QEMU_IO -c 'read -P 3 0x7fff0000 64k' "$TEST_IMG.base" | _filter_qemu_io
145    $QEMU_IO -c "read -P 4 $((len - 512)) 512" "$TEST_IMG.base" | _filter_qemu_io
146
147    # Both top and intermediate should be unchanged
148fi
149
150$QEMU_IMG map "$TEST_IMG.base" | _filter_qemu_img_map
151$QEMU_IMG map "$TEST_IMG.itmd" | _filter_qemu_img_map
152$QEMU_IMG map "$TEST_IMG" | _filter_qemu_img_map
153
154# Check that the reason for slow path is still present, as appropriate
155case $reason in
156    snapshot)
157	$QEMU_IMG snapshot -l "$TEST_IMG" |
158	    sed 's/^\(.\{20\}\).*/\1/; s/ *$//' ;;
159    bitmap)
160	run_qemu <<EOF
161{ "execute": "qmp_capabilities" }
162{ "execute": "blockdev-add",
163  "arguments": { "driver": "qcow2", "node-name": "drive0",
164     "file": { "driver": "file", "filename": "$TEST_IMG" } } }
165{ "execute": "x-debug-block-dirty-bitmap-sha256",
166  "arguments": { "node": "drive0", "name": "bitmap0" } }
167{ "execute": "quit" }
168EOF
169	;;
170esac
171
172done
173done
174
175# success, all done
176echo "*** done"
177rm -f $seq.full
178status=0
179