tests/qemu-iotests/223

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