3 # Test for configuring cache modes of arbitrary nodes (requires O_DIRECT)
5 # Copyright (C) 2015 Red Hat, Inc.
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.
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.
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/>.
22 owner=kwolf@redhat.com
25 echo "QA output created by $seq"
27 status=1 # failure is the default!
32 _rm_test_img "$TEST_IMG.snap"
34 trap "_cleanup; exit \$status" 0 1 2 3 15
36 # get standard environment, filters and checks
43 # We test all cache modes anyway, but O_DIRECT needs to be supported
44 _default_cache_mode none
45 _supported_cache_modes none directsync
57 ) | $QEMU -nographic -monitor stdio -nodefaults "$@"
63 do_run_qemu "$@" 2>&1 | _filter_testdir | _filter_qemu | _filter_hmp
68 TEST_IMG="$TEST_IMG.base" _make_test_img $size
69 TEST_IMG="$TEST_IMG.snap" _make_test_img $size
70 _make_test_img -b "$TEST_IMG.base" $size -F $IMGFMT
73 echo === Simple test for all cache modes ===
76 run_qemu -drive file="$TEST_IMG",cache=none
77 run_qemu -drive file="$TEST_IMG",cache=directsync
78 run_qemu -drive file="$TEST_IMG",cache=writeback
79 run_qemu -drive file="$TEST_IMG",cache=writethrough
80 run_qemu -drive file="$TEST_IMG",cache=unsafe
81 run_qemu -drive file="$TEST_IMG",cache=invalid_value
84 echo === Check inheritance of cache modes ===
87 files="if=none,file=$TEST_IMG,backing.file.filename=$TEST_IMG.base"
88 ids="node-name=image,backing.node-name=backing,backing.file.node-name=backing-file,file.node-name=file"
92 # cache.direct is supposed to be inherited by both bs->file and
95 printf "cache.direct=on on none0\n"
96 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",cache.direct=on | grep -e "Cache" -e "[Cc]annot|[Cc]ould not|[Cc]an't"
97 printf "\ncache.direct=on on file\n"
98 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",file.cache.direct=on | grep -e "Cache" -e "[Cc]annot|[Cc]ould not|[Cc]an't"
99 printf "\ncache.direct=on on backing\n"
100 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",backing.cache.direct=on | grep -e "Cache" -e "[Cc]annot|[Cc]ould not|[Cc]an't"
101 printf "\ncache.direct=on on backing-file\n"
102 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",backing.file.cache.direct=on | grep -e "Cache" -e "[Cc]annot|[Cc]ould not|[Cc]an't"
104 # cache.writeback is supposed to be inherited by bs->backing; bs->file
105 # always gets cache.writeback=on
107 printf "\n\ncache.writeback=off on none0\n"
108 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",cache.writeback=off | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
109 printf "\ncache.writeback=off on file\n"
110 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",file.cache.writeback=off | grep -e "doesn't" -e "does not"
111 printf "\ncache.writeback=off on backing\n"
112 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",backing.cache.writeback=off | grep -e "doesn't" -e "does not"
113 printf "\ncache.writeback=off on backing-file\n"
114 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",backing.file.cache.writeback=off | grep -e "doesn't" -e "does not"
116 # cache.no-flush is supposed to be inherited by both bs->file and bs->backing
118 printf "\n\ncache.no-flush=on on none0\n"
119 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",cache.no-flush=on | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
120 printf "\ncache.no-flush=on on file\n"
121 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",file.cache.no-flush=on | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
122 printf "\ncache.no-flush=on on backing\n"
123 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",backing.cache.no-flush=on | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
124 printf "\ncache.no-flush=on on backing-file\n"
125 echo "$hmp_cmds" | run_qemu -drive "$files","$ids",backing.file.cache.no-flush=on | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
129 echo "--- Configure cache modes on the command line ---"
132 # First check the inherited cache mode after opening the image.
134 hmp_cmds="info block none0
138 info block backing-file"
143 echo "--- Cache modes after reopen (live snapshot) ---"
146 # Then trigger a reopen and check that the cache modes are still the same.
148 hmp_cmds="snapshot_blkdev -n none0 $TEST_IMG.snap $IMGFMT
153 info block backing-file"
158 echo "--- Change cache modes with reopen (qemu-io command, flags) ---"
161 # This one actually changes the cache mode with the reopen. For this test, the
162 # new cache mode is specified in the flags, not as an option.
164 hmp_cmds='qemu-io none0 "reopen -c none"
169 info block backing-file'
174 echo "--- Change cache modes with reopen (qemu-io command, options) ---"
177 # This one actually changes the cache mode with the reopen. For this test, the
178 # new cache mode is specified as an option, not in the flags.
180 hmp_cmds='qemu-io none0 "reopen -o cache.direct=on"
185 info block backing-file'
190 echo "--- Change cache modes after snapshot ---"
193 # This checks that the original image doesn't inherit from the snapshot
195 hmp_cmds="snapshot_blkdev -n none0 $TEST_IMG.snap $IMGFMT
196 qemu-io none0 \"reopen -c none\"
201 info block backing-file"
206 echo "--- Change cache mode in parent, child has explicit option in JSON ---"
209 # This checks that children with options explicitly set by the json:
210 # pseudo-protocol don't inherit these options from their parents.
212 # Yes, blkdebug::json:... is criminal, but I can't see another way to have a
213 # BDS initialised with the json: pseudo-protocol, but still have it inherit
214 # options from its parent node.
216 hmp_cmds="qemu-io none0 \"reopen -o cache.direct=on,cache.no-flush=on\"
222 echo "$hmp_cmds" | run_qemu -drive if=none,file="blkdebug::json:{\"filename\":\"$TEST_IMG\",,\"cache\":{\"direct\":false}}",node-name=image,file.node-name=blkdebug,file.image.node-name=file | grep "Cache"
225 echo "=== Check that referenced BDSes don't inherit ==="
228 drv_bkfile="if=none,driver=file,filename=$TEST_IMG.base,node-name=backing-file"
229 drv_bk="if=none,file=json:{'driver':'$IMGFMT',,'file':'backing-file',,'node-name':'backing'}"
230 drv_file="if=none,driver=file,filename=$TEST_IMG,node-name=file"
231 drv_img="if=none,id=blk,file=json:{'driver':'$IMGFMT',,'file':'file',,'backing':'backing',,'node-name':'image'}"
233 check_cache_all_separate()
237 printf "cache.direct=on on blk\n"
238 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk" -drive "$drv_file" -drive "$drv_img",cache.direct=on | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
239 printf "\ncache.direct=on on file\n"
240 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk" -drive "$drv_file",cache.direct=on -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
241 printf "\ncache.direct=on on backing\n"
242 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk",cache.direct=on -drive "$drv_file" -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
243 printf "\ncache.direct=on on backing-file\n"
244 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile",cache.direct=on -drive "$drv_bk" -drive "$drv_file" -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
246 # Check cache.writeback
248 printf "\n\ncache.writeback=off on blk\n"
249 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk" -drive "$drv_file" -drive "$drv_img",cache.writeback=off | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
250 printf "\ncache.writeback=off on file\n"
251 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk" -drive "$drv_file",cache.writeback=off -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
252 printf "\ncache.writeback=off on backing\n"
253 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk",cache.writeback=off -drive "$drv_file" -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
254 printf "\ncache.writeback=off on backing-file\n"
255 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile",cache.writeback=off -drive "$drv_bk" -drive "$drv_file" -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
257 # Check cache.no-flush
259 printf "\n\ncache.no-flush=on on blk\n"
260 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk" -drive "$drv_file" -drive "$drv_img",cache.no-flush=on | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
261 printf "\ncache.no-flush=on on file\n"
262 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk" -drive "$drv_file",cache.no-flush=on -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
263 printf "\ncache.no-flush=on on backing\n"
264 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile" -drive "$drv_bk",cache.no-flush=on -drive "$drv_file" -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
265 printf "\ncache.no-flush=on on backing-file\n"
266 echo "$hmp_cmds" | run_qemu -drive "$drv_bkfile",cache.no-flush=on -drive "$drv_bk" -drive "$drv_file" -drive "$drv_img" | grep -e "Cache" -e "[Cc]annot\|[Cc]ould not\|[Cc]an't"
270 echo "--- Configure cache modes on the command line ---"
273 # First check the inherited cache mode after opening the image.
275 hmp_cmds="info block image
278 info block backing-file"
280 check_cache_all_separate
283 echo "--- Cache modes after reopen (live snapshot) ---"
286 # Then trigger a reopen and check that the cache modes are still the same.
288 hmp_cmds="snapshot_blkdev -n blk $TEST_IMG.snap $IMGFMT
293 info block backing-file"
295 check_cache_all_separate
298 echo "--- Change cache modes with reopen (qemu-io command, flags) ---"
301 # This one actually changes the cache mode with the reopen. For this test, the
302 # new cache mode is specified as flags, not as option.
304 hmp_cmds='qemu-io blk "reopen -c none"
308 info block backing-file'
310 check_cache_all_separate
314 echo "=== Reopening children instead of the root ==="
317 files="if=none,file=$TEST_IMG,backing.file.filename=$TEST_IMG.base"
318 ids="node-name=image,backing.node-name=backing,backing.file.node-name=backing-file,file.node-name=file"
321 echo "--- Basic reopen ---"
324 hmp_cmds='qemu-io none0 "reopen -o backing.cache.direct=on"
329 info block backing-file'
334 echo "--- Change cache mode after reopening child ---"
337 # This checks that children with options explicitly set with reopen don't
338 # inherit these options from their parents any more
340 # TODO Implement node-name support for 'qemu-io' HMP command for -c
341 # Can use only -o to access child node options for now
343 hmp_cmds="qemu-io none0 \"reopen -o file.cache.direct=off,file.cache.no-flush=off\"
344 qemu-io none0 \"reopen -o backing.file.cache.direct=off,backing.file.cache.no-flush=on\"
345 qemu-io none0 \"reopen -c none\"
349 info block backing-file"
351 echo "$hmp_cmds" | run_qemu -drive "$files","$ids" | grep "Cache"
354 echo "--- Alignment after changing O_DIRECT ---"
357 # Directly test the protocol level: Can unaligned requests succeed even if
358 # O_DIRECT was only enabled through a reopen and vice versa?
360 # Ensure image size is a multiple of the sector size (required for O_DIRECT)
361 $QEMU_IMG create -f file "$TEST_IMG" 1M | _filter_img_create
363 # And write some data (not strictly necessary, but it feels better to actually
364 # have something to be read)
365 $QEMU_IO -f file -c 'write 0 4096' "$TEST_IMG" | _filter_qemu_io
367 $QEMU_IO --cache=writeback -f file $TEST_IMG <<EOF | _filter_qemu_io
369 reopen -o cache.direct=on
371 reopen -o cache.direct=off
374 $QEMU_IO --cache=none -f file $TEST_IMG <<EOF | _filter_qemu_io
376 reopen -o cache.direct=off
378 reopen -o cache.direct=on