tests/test-eflags.sh

   1 #!/usr/bin/env bash
   2 # nbdkit
   3 # Copyright (C) 2018 Red Hat Inc.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met:
   8 #
   9 # * Redistributions of source code must retain the above copyright
  10 # notice, this list of conditions and the following disclaimer.
  11 #
  12 # * Redistributions in binary form must reproduce the above copyright
  13 # notice, this list of conditions and the following disclaimer in the
  14 # documentation and/or other materials provided with the distribution.
  15 #
  16 # * Neither the name of Red Hat nor the names of its contributors may be
  17 # used to endorse or promote products derived from this software without
  18 # specific prior written permission.
  19 #
  20 # THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22 # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  23 # PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  24 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  27 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  28 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 # SUCH DAMAGE.
  32
  33 # Test export flags.
  34 #
  35 # Run nbdkit with various can_* callbacks defined and with or without
  36 # the -r flag, and check that nbdkit constructs the export flags
  37 # controlling READ_ONLY, ROTATIONAL, SEND_TRIM, etc. as expected.
  38 #
  39 # We use the shell plugin because it gives maximum control over the
  40 # can_* callbacks (at least, max without having to write a C plugin).
  41
  42 source ./functions.sh
  43 set -e
  44
  45 requires qemu-nbd --version
  46
  47 # This test uses the ‘qemu-nbd --list’ option added in qemu 4.0.
  48 if ! qemu-nbd --help | grep -sq -- --list; then
  49     echo "$0: skipping because qemu-nbd does not support the --list option"
  50     exit 77
  51 fi
  52
  53 files="eflags.out"
  54 rm -f $files
  55 cleanup_fn rm -f $files
  56
  57 # The export flags.
  58 # See also common/protocol/protocol.h
  59 HAS_FLAGS=$((         1 <<  0 ))
  60 READ_ONLY=$((         1 <<  1 ))
  61 SEND_FLUSH=$((        1 <<  2 ))
  62 SEND_FUA=$((          1 <<  3 ))
  63 ROTATIONAL=$((        1 <<  4 ))
  64 SEND_TRIM=$((         1 <<  5 ))
  65 SEND_WRITE_ZEROES=$(( 1 <<  6 ))
  66 SEND_DF=$((           1 <<  7 ))
  67 CAN_MULTI_CONN=$((    1 <<  8 ))
  68 SEND_RESIZE=$((       1 <<  9 ))
  69 SEND_CACHE=$((        1 << 10 ))
  70
  71 do_nbdkit ()
  72 {
  73     nbdkit -v -U - "$@" sh - --run 'qemu-nbd --list -k $unixsocket' |
  74         grep -E "flags: 0x" | grep -Eoi '0x[a-f0-9]+' > eflags.out
  75     echo -n eflags=; cat eflags.out
  76
  77     # Convert hex flags to decimal and assign it to $eflags.
  78     eflags=$(printf "%d" $(cat eflags.out))
  79 }
  80
  81 fail ()
  82 {
  83     echo "error: $@ (actual flags were $eflags)"
  84     exit 1
  85 }
  86
  87 #----------------------------------------------------------------------
  88 # can_write=false
  89
  90 do_nbdkit <<'EOF'
  91 case "$1" in
  92      get_size) echo 1M ;;
  93      *) exit 2 ;;
  94 esac
  95 EOF
  96
  97 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|SEND_DF )) ] ||
  98     fail "expected HAS_FLAGS|READ_ONLY|SEND_DF"
  99
 100 #----------------------------------------------------------------------
 101 # -r
 102 # can_write=false
 103
 104 do_nbdkit -r <<'EOF'
 105 case "$1" in
 106      get_size) echo 1M ;;
 107      *) exit 2 ;;
 108 esac
 109 EOF
 110
 111 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|SEND_DF )) ] ||
 112     fail "expected HAS_FLAGS|READ_ONLY|SEND_DF"
 113
 114 #----------------------------------------------------------------------
 115 # can_write=true
 116 #
 117 # NBD_FLAG_SEND_WRITE_ZEROES is always set on writable connections
 118 # even if can_zero returns false, because nbdkit reckons it can
 119 # emulate zeroing using pwrite.
 120
 121 do_nbdkit <<'EOF'
 122 case "$1" in
 123      get_size) echo 1M ;;
 124      can_write) exit 0 ;;
 125      *) exit 2 ;;
 126 esac
 127 EOF
 128
 129 [ $eflags -eq $(( HAS_FLAGS|SEND_WRITE_ZEROES|SEND_DF )) ] ||
 130     fail "expected HAS_FLAGS|SEND_WRITE_ZEROES|SEND_DF"
 131
 132 #----------------------------------------------------------------------
 133 # -r
 134 # can_write=true
 135 #
 136 # The -r flag overrides the plugin so this behaves as if can_write is
 137 # false.
 138
 139 do_nbdkit -r <<'EOF'
 140 case "$1" in
 141      get_size) echo 1M ;;
 142      can_write) exit 0 ;;
 143      *) exit 2 ;;
 144 esac
 145 EOF
 146
 147 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|SEND_DF )) ] ||
 148     fail "expected HAS_FLAGS|READ_ONLY|SEND_DF"
 149
 150 #----------------------------------------------------------------------
 151 # can_write=false
 152 # can_trim=true
 153 # can_zero=true
 154 #
 155 # If writing is not possible then trim and zero are always disabled.
 156
 157 do_nbdkit <<'EOF'
 158 case "$1" in
 159      get_size) echo 1M ;;
 160      can_write) exit 3 ;;
 161      can_trim) exit 0 ;;
 162      can_zero) exit 0 ;;
 163      *) exit 2 ;;
 164 esac
 165 EOF
 166
 167 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|SEND_DF )) ] ||
 168     fail "expected HAS_FLAGS|READ_ONLY|SEND_DF"
 169
 170 #----------------------------------------------------------------------
 171 # -r
 172 # can_write=false
 173 # can_trim=true
 174 # can_zero=true
 175 #
 176 # This is a formality, but check it's the same as above.
 177
 178 do_nbdkit -r <<'EOF'
 179 case "$1" in
 180      get_size) echo 1M ;;
 181      can_write) exit 3 ;;
 182      can_trim) exit 0 ;;
 183      can_zero) exit 0 ;;
 184      *) exit 2 ;;
 185 esac
 186 EOF
 187
 188 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|SEND_DF )) ] ||
 189     fail "expected HAS_FLAGS|READ_ONLY|SEND_DF"
 190
 191 #----------------------------------------------------------------------
 192 # can_write=true
 193 # can_trim=true
 194
 195 do_nbdkit <<'EOF'
 196 case "$1" in
 197      get_size) echo 1M ;;
 198      can_write) exit 0 ;;
 199      can_trim) exit 0 ;;
 200      *) exit 2 ;;
 201 esac
 202 EOF
 203
 204 [ $eflags -eq $(( HAS_FLAGS|SEND_TRIM|SEND_WRITE_ZEROES|SEND_DF )) ] ||
 205     fail "expected HAS_FLAGS|SEND_TRIM|SEND_WRITE_ZEROES|SEND_DF"
 206
 207 #----------------------------------------------------------------------
 208 # can_write=true
 209 # is_rotational=true
 210
 211 do_nbdkit <<'EOF'
 212 case "$1" in
 213      get_size) echo 1M ;;
 214      can_write) exit 0 ;;
 215      is_rotational) exit 0 ;;
 216      *) exit 2 ;;
 217 esac
 218 EOF
 219
 220 [ $eflags -eq $(( HAS_FLAGS|ROTATIONAL|SEND_WRITE_ZEROES|SEND_DF )) ] ||
 221     fail "expected HAS_FLAGS|ROTATIONAL|SEND_WRITE_ZEROES|SEND_DF"
 222
 223 #----------------------------------------------------------------------
 224 # -r
 225 # can_write=true
 226 # is_rotational=true
 227
 228 do_nbdkit -r <<'EOF'
 229 case "$1" in
 230      get_size) echo 1M ;;
 231      can_write) exit 0 ;;
 232      is_rotational) exit 0 ;;
 233      *) exit 2 ;;
 234 esac
 235 EOF
 236
 237 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|ROTATIONAL|SEND_DF )) ] ||
 238     fail "expected HAS_FLAGS|READ_ONLY|ROTATIONAL|SEND_DF"
 239
 240 #----------------------------------------------------------------------
 241 # can_write=true
 242 # can_fua=native
 243
 244 do_nbdkit <<'EOF'
 245 case "$1" in
 246      get_size) echo 1M ;;
 247      can_write) exit 0 ;;
 248      can_fua) echo "native" ;;
 249      *) exit 2 ;;
 250 esac
 251 EOF
 252
 253 [ $eflags -eq $(( HAS_FLAGS|SEND_FUA|SEND_WRITE_ZEROES|SEND_DF )) ] ||
 254     fail "expected HAS_FLAGS|SEND_FUA|SEND_WRITE_ZEROES|SEND_DF"
 255
 256 #----------------------------------------------------------------------
 257 # -r
 258 # can_write=true
 259 # can_fua=native
 260 #
 261 # Setting read-only should ignore can_fua.
 262
 263 do_nbdkit -r <<'EOF'
 264 case "$1" in
 265      get_size) echo 1M ;;
 266      can_write) exit 0 ;;
 267      can_fua) echo "native" ;;
 268      *) exit 2 ;;
 269 esac
 270 EOF
 271
 272 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|SEND_DF )) ] ||
 273     fail "expected HAS_FLAGS|READ_ONLY|SEND_DF"
 274
 275 #----------------------------------------------------------------------
 276 # -r
 277 # can_multi_conn=true
 278
 279 do_nbdkit -r <<'EOF'
 280 case "$1" in
 281      get_size) echo 1M ;;
 282      can_multi_conn) echo 0 ;;
 283      *) exit 2 ;;
 284 esac
 285 EOF
 286
 287 [ $eflags -eq $(( HAS_FLAGS|READ_ONLY|SEND_DF|CAN_MULTI_CONN )) ] ||
 288     fail "expected HAS_FLAGS|READ_ONLY|SEND_DF|CAN_MULTI_CONN"