1#!/usr/bin/env bash
2# group: rw quick
3#
4# Test drive-mirror with quorum
5#
6# The goal of this test is to check how the quorum driver reports
7# regions that are known to read as zeroes (BDRV_BLOCK_ZERO). The idea
8# is that drive-mirror will try the efficient representation of zeroes
9# in the destination image instead of writing actual zeroes.
10#
11# Copyright (C) 2020 Igalia, S.L.
12# Author: Alberto Garcia <berto@igalia.com>
13#
14# This program is free software; you can redistribute it and/or modify
15# it under the terms of the GNU General Public License as published by
16# the Free Software Foundation; either version 2 of the License, or
17# (at your option) any later version.
18#
19# This program is distributed in the hope that it will be useful,
20# but WITHOUT ANY WARRANTY; without even the implied warranty of
21# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22# GNU General Public License for more details.
23#
24# You should have received a copy of the GNU General Public License
25# along with this program.  If not, see <http://www.gnu.org/licenses/>.
26#
27
28# creator
29owner=berto@igalia.com
30
31seq=`basename $0`
32echo "QA output created by $seq"
33
34status=1	# failure is the default!
35
36_cleanup()
37{
38    _rm_test_img "$TEST_IMG.0"
39    _rm_test_img "$TEST_IMG.1"
40    _rm_test_img "$TEST_IMG.2"
41    _rm_test_img "$TEST_IMG.3"
42    _cleanup_qemu
43}
44trap "_cleanup; exit \$status" 0 1 2 3 15
45
46# get standard environment, filters and checks
47. ./common.rc
48. ./common.filter
49. ./common.qemu
50
51_supported_fmt qcow2
52_supported_proto file
53_supported_os Linux
54_unsupported_imgopts cluster_size data_file
55
56echo
57echo '### Create all images' # three source (quorum), one destination
58echo
59TEST_IMG="$TEST_IMG.0" _make_test_img -o cluster_size=64k 10M
60TEST_IMG="$TEST_IMG.1" _make_test_img -o cluster_size=64k 10M
61TEST_IMG="$TEST_IMG.2" _make_test_img -o cluster_size=64k 10M
62TEST_IMG="$TEST_IMG.3" _make_test_img -o cluster_size=64k 10M
63
64quorum="driver=raw,file.driver=quorum,file.vote-threshold=2"
65quorum="$quorum,file.children.0.file.filename=$TEST_IMG.0"
66quorum="$quorum,file.children.1.file.filename=$TEST_IMG.1"
67quorum="$quorum,file.children.2.file.filename=$TEST_IMG.2"
68quorum="$quorum,file.children.0.driver=$IMGFMT"
69quorum="$quorum,file.children.1.driver=$IMGFMT"
70quorum="$quorum,file.children.2.driver=$IMGFMT"
71
72echo
73echo '### Output of qemu-img map (empty quorum)'
74echo
75$QEMU_IMG map --image-opts $quorum | _filter_qemu_img_map
76
77# Now we write data to the quorum. All three images will read as
78# zeroes in all cases, but with different ways to represent them
79# (unallocated clusters, zero clusters, data clusters with zeroes)
80# that will have an effect on how the data will be mirrored and the
81# output of qemu-img map on the resulting image.
82echo
83echo '### Write data to the quorum'
84echo
85# Test 1: data regions surrounded by unallocated clusters.
86# Three data regions, the largest one (0x30000) will be picked, end result:
87# offset 0x10000, length 0x30000 -> data
88$QEMU_IO -c "write -P 0 $((0x10000)) $((0x10000))" "$TEST_IMG.0" | _filter_qemu_io
89$QEMU_IO -c "write -P 0 $((0x10000)) $((0x30000))" "$TEST_IMG.1" | _filter_qemu_io
90$QEMU_IO -c "write -P 0 $((0x10000)) $((0x20000))" "$TEST_IMG.2" | _filter_qemu_io
91
92# Test 2: zero regions surrounded by data clusters.
93# First we allocate the data clusters.
94$QEMU_IO -c "open -o $quorum" -c "write -P 0 $((0x100000)) $((0x40000))" | _filter_qemu_io
95
96# Three zero regions, the smallest one (0x10000) will be picked, end result:
97# offset 0x100000, length 0x10000 -> data
98# offset 0x110000, length 0x10000 -> zeroes
99# offset 0x120000, length 0x20000 -> data
100$QEMU_IO -c "write -z $((0x110000)) $((0x10000))" "$TEST_IMG.0" | _filter_qemu_io
101$QEMU_IO -c "write -z $((0x110000)) $((0x30000))" "$TEST_IMG.1" | _filter_qemu_io
102$QEMU_IO -c "write -z $((0x110000)) $((0x20000))" "$TEST_IMG.2" | _filter_qemu_io
103
104# Test 3: zero clusters surrounded by unallocated clusters.
105# Everything reads as zeroes, no effect on the end result.
106$QEMU_IO -c "write -z $((0x150000)) $((0x10000))" "$TEST_IMG.0" | _filter_qemu_io
107$QEMU_IO -c "write -z $((0x150000)) $((0x30000))" "$TEST_IMG.1" | _filter_qemu_io
108$QEMU_IO -c "write -z $((0x150000)) $((0x20000))" "$TEST_IMG.2" | _filter_qemu_io
109
110# Test 4: mix of data and zero clusters.
111# The zero region will be ignored in favor of the largest data region
112# (0x20000), end result:
113# offset 0x200000, length 0x20000 -> data
114$QEMU_IO -c "write -P 0 $((0x200000)) $((0x10000))" "$TEST_IMG.0" | _filter_qemu_io
115$QEMU_IO -c "write -z   $((0x200000)) $((0x30000))" "$TEST_IMG.1" | _filter_qemu_io
116$QEMU_IO -c "write -P 0 $((0x200000)) $((0x20000))" "$TEST_IMG.2" | _filter_qemu_io
117
118# Test 5: write data to a region and then zeroize it, doing it
119# directly on the quorum device instead of the individual images.
120# This has no effect on the end result but proves that the quorum driver
121# supports 'write -z'.
122$QEMU_IO -c "open -o $quorum" -c "write -P 1 $((0x250000)) $((0x10000))" | _filter_qemu_io
123# Verify the data that we just wrote
124$QEMU_IO -c "open -o $quorum" -c "read -P 1 $((0x250000)) $((0x10000))" | _filter_qemu_io
125$QEMU_IO -c "open -o $quorum" -c "write -z $((0x250000)) $((0x10000))" | _filter_qemu_io
126# Now it should read back as zeroes
127$QEMU_IO -c "open -o $quorum" -c "read -P 0 $((0x250000)) $((0x10000))" | _filter_qemu_io
128
129echo
130echo '### Launch the drive-mirror job'
131echo
132qemu_comm_method="qmp" _launch_qemu -drive if=virtio,"$quorum"
133h=$QEMU_HANDLE
134_send_qemu_cmd $h "{ 'execute': 'qmp_capabilities' }" 'return'
135
136_send_qemu_cmd $h \
137    "{'execute': 'drive-mirror',
138                 'arguments': {'device': 'virtio0',
139                               'format': '$IMGFMT',
140                               'target': '$TEST_IMG.3',
141                               'sync':   'full',
142                               'mode':   'existing' }}"    \
143     "BLOCK_JOB_READY.*virtio0"
144
145_send_qemu_cmd $h \
146    "{ 'execute': 'block-job-complete',
147       'arguments': { 'device': 'virtio0' } }" \
148    'BLOCK_JOB_COMPLETED'
149
150_send_qemu_cmd $h "{ 'execute': 'quit' }" ''
151
152echo
153echo '### Output of qemu-img map (destination image)'
154echo
155$QEMU_IMG map "$TEST_IMG.3" | _filter_qemu_img_map
156
157# success, all done
158echo "*** done"
159rm -f $seq.full
160status=0
161