xref: /openbmc/qemu/tests/qemu-iotests/223 (revision fc8c745d)
1#!/usr/bin/env bash
2# group: rw quick
3#
4# Test reading dirty bitmap over NBD
5#
6# Copyright (C) 2018-2020 Red Hat, Inc.
7#
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.
12#
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.
17#
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/>.
20#
21
22seq="$(basename $0)"
23echo "QA output created by $seq"
24
25status=1 # failure is the default!
26
27_cleanup()
28{
29    nbd_server_stop
30    _cleanup_test_img
31    _cleanup_qemu
32    rm -f "$SOCK_DIR/nbd"
33}
34trap "_cleanup; exit \$status" 0 1 2 3 15
35
36# get standard environment, filters and checks
37. ./common.rc
38. ./common.filter
39. ./common.qemu
40. ./common.nbd
41
42_supported_fmt qcow2
43_supported_proto file # uses NBD as well
44_supported_os Linux
45# Persistent dirty bitmaps require compat=1.1
46_unsupported_imgopts 'compat=0.10'
47
48do_run_qemu()
49{
50    echo Testing: "$@"
51    $QEMU -nographic -qmp stdio -serial none "$@"
52    echo
53}
54
55run_qemu()
56{
57    do_run_qemu "$@" 2>&1 | _filter_testdir | _filter_qmp \
58                          | _filter_qemu | _filter_imgfmt \
59                          | _filter_actual_image_size
60}
61
62echo
63echo "=== Create partially sparse image, then add dirty bitmaps ==="
64echo
65
66# Two bitmaps, to contrast granularity issues
67# Also note that b will be disabled, while b2 is left enabled, to
68# check for read-only interactions
69_make_test_img -o cluster_size=4k 4M
70$QEMU_IO -c 'w -P 0x11 1M 2M' "$TEST_IMG" | _filter_qemu_io
71run_qemu <<EOF
72{ "execute": "qmp_capabilities" }
73{ "execute": "blockdev-add",
74  "arguments": {
75    "driver": "$IMGFMT",
76    "node-name": "n",
77    "file": {
78      "driver": "file",
79      "filename": "$TEST_IMG"
80    }
81  }
82}
83{ "execute": "block-dirty-bitmap-add",
84  "arguments": {
85    "node": "n",
86    "name": "b",
87    "persistent": true,
88    "granularity": 65536
89  }
90}
91{ "execute": "block-dirty-bitmap-add",
92  "arguments": {
93    "node": "n",
94    "name": "b2",
95    "persistent": true,
96    "granularity": 512
97  }
98}
99{ "execute": "quit" }
100EOF
101
102echo
103echo "=== Write part of the file under active bitmap ==="
104echo
105
106$QEMU_IO -c 'w -P 0x22 512 512' -c 'w -P 0x33 2M 2M' "$TEST_IMG" \
107    | _filter_qemu_io
108
109echo
110echo "=== End dirty bitmaps, and start serving image over NBD ==="
111echo
112
113_launch_qemu -object iothread,id=io0 2> >(_filter_nbd)
114
115# Intentionally provoke some errors as well, to check error handling
116silent=
117_send_qemu_cmd $QEMU_HANDLE '{"execute":"qmp_capabilities"}' "return"
118_send_qemu_cmd $QEMU_HANDLE '{"execute":"blockdev-add",
119  "arguments":{"driver":"qcow2", "node-name":"n",
120    "file":{"driver":"file", "filename":"'"$TEST_IMG"'"}}}' "return"
121_send_qemu_cmd $QEMU_HANDLE '{"execute":"block-dirty-bitmap-disable",
122  "arguments":{"node":"n", "name":"b"}}' "return"
123
124for attempt in normal iothread; do
125
126echo
127echo "=== Set up NBD with $attempt access ==="
128echo
129if [ $attempt = iothread ]; then
130_send_qemu_cmd $QEMU_HANDLE '{"execute":"x-blockdev-set-iothread",
131  "arguments":{"node-name":"n", "iothread":"io0"}}' "return"
132fi
133
134_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-add",
135  "arguments":{"device":"n"}}' "error" # Attempt add without server
136_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-start",
137  "arguments":{"addr":{"type":"unix",
138    "data":{"path":"'"$SOCK_DIR/nbd"'"}}}}' "return"
139_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-start",
140  "arguments":{"addr":{"type":"unix",
141    "data":{"path":"'"$SOCK_DIR/nbd"1'"}}}}' "error" # Attempt second server
142$QEMU_NBD_PROG -L -k "$SOCK_DIR/nbd"
143_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-add",
144  "arguments":{"device":"n", "bitmap":"b"}}' "return"
145_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-add",
146  "arguments":{"device":"nosuch"}}' "error" # Attempt to export missing node
147_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-add",
148  "arguments":{"device":"n"}}' "error" # Attempt to export same name twice
149_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-add",
150  "arguments":{"device":"n", "name":"n2",
151  "bitmap":"b2"}}' "error" # enabled vs. read-only
152_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-add",
153  "arguments":{"device":"n", "name":"n2",
154  "bitmap":"b3"}}' "error" # Missing bitmap
155_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-add",
156  "arguments":{"device":"n", "name":"n2", "writable":true,
157  "description":"some text", "bitmap":"b2"}}' "return"
158$QEMU_NBD_PROG -L -k "$SOCK_DIR/nbd"
159
160echo
161echo "=== Contrast normal status to large granularity dirty-bitmap ==="
162echo
163
164QEMU_IO_OPTIONS=$QEMU_IO_OPTIONS_NO_FMT
165IMG="driver=nbd,export=n,server.type=unix,server.path=$SOCK_DIR/nbd"
166$QEMU_IO -r -c 'r -P 0x22 512 512' -c 'r -P 0 512k 512k' -c 'r -P 0x11 1m 1m' \
167  -c 'r -P 0x33 2m 2m' --image-opts "$IMG" | _filter_qemu_io
168$QEMU_IMG map --output=json --image-opts \
169  "$IMG" | _filter_qemu_img_map
170$QEMU_IMG map --output=json --image-opts \
171  "$IMG,x-dirty-bitmap=qemu:dirty-bitmap:b" | _filter_qemu_img_map
172
173echo
174echo "=== Contrast to small granularity dirty-bitmap ==="
175echo
176
177IMG="driver=nbd,export=n2,server.type=unix,server.path=$SOCK_DIR/nbd"
178$QEMU_IMG map --output=json --image-opts \
179  "$IMG,x-dirty-bitmap=qemu:dirty-bitmap:b2" | _filter_qemu_img_map
180
181echo
182echo "=== End qemu NBD server ==="
183echo
184
185_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-remove",
186  "arguments":{"name":"n"}}' "return"
187_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-remove",
188  "arguments":{"name":"n2"}}' "return"
189_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-remove",
190  "arguments":{"name":"n2"}}' "error" # Attempt duplicate clean
191_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-stop"}' "return"
192_send_qemu_cmd $QEMU_HANDLE '{"execute":"nbd-server-stop"}' "error" # Again
193
194done
195
196_send_qemu_cmd $QEMU_HANDLE '{"execute":"quit"}' "return"
197wait=yes _cleanup_qemu
198
199echo
200echo "=== Use qemu-nbd as server ==="
201echo
202
203nbd_server_start_unix_socket -r -f $IMGFMT -B b "$TEST_IMG"
204IMG="driver=nbd,server.type=unix,server.path=$nbd_unix_socket"
205$QEMU_IMG map --output=json --image-opts \
206  "$IMG,x-dirty-bitmap=qemu:dirty-bitmap:b" | _filter_qemu_img_map
207
208nbd_server_start_unix_socket -f $IMGFMT -B b2 "$TEST_IMG"
209IMG="driver=nbd,server.type=unix,server.path=$nbd_unix_socket"
210$QEMU_IMG map --output=json --image-opts --max-length=12345 \
211  "$IMG,x-dirty-bitmap=qemu:dirty-bitmap:b2" | _filter_qemu_img_map
212$QEMU_IMG map --output=json --image-opts --start-offset=12345 \
213  "$IMG,x-dirty-bitmap=qemu:dirty-bitmap:b2" | _filter_qemu_img_map
214
215# success, all done
216echo '*** done'
217rm -f $seq.full
218status=0
219