block: copy-before-write: on-cbw-error behavior
cover block: copy-before-write: on-cbw-error behavior
Hi all!
Here is a new option for copy-before-write filter, to alter its behavior on copy-before-write operation failure.
Based-on: <[email protected]>
([PATCH v5 00/16] Make image fleecing more usable)
Vladimir Sementsov-Ogievskiy (3):
block/copy-before-write: refactor option parsing block/copy-before-write: add on-cbw-error open parameter
iotests: add copy-before-write: on-cbw-error tests
qapi/block-core.json | 27 +++- block/copy-before-write.c | 123 ++++++++++++----- tests/qemu-iotests/tests/copy-before-write | 128 ++++++++++++++++++ .../qemu-iotests/tests/copy-before-write.out | 5 + 4 files changed, 248 insertions(+), 35 deletions(-) create mode 100755 tests/qemu-iotests/tests/copy-before-write create mode 100644 tests/qemu-iotests/tests/copy-before-write.out
Signature · 1 line
2.31.1
PATCH 1/3 block/copy-before-write: refactor option parsing
We are going to add one more option of enum type. Let's refactor option parsing so that we can simply work with BlockdevOptionsCbw object.
--- block/copy-before-write.c | 66 ++++++++++++++++++++++++--------------- 1 file changed, 40 insertions(+), 26 deletions(-)
block/copy-before-write.c +40 -26
@@ -24,6 +24,7 @@*/ #include "qemu/osdep.h" +#include "qapi/qmp/qjson.h" #include "sysemu/block-backend.h" #include "qemu/cutils.h"
@@ -328,46 +329,49 @@ static void cbw_child_perm(BlockDriverState *bs, BdrvChild *c, } } -static bool cbw_parse_bitmap_option (QDict *options,BdrvDirtyBitmap **bitmap, -Error **errp) +static BlockdevOptionsCbw *cbw_parse_options (QDict *options,Error **errp) { -QDict *bitmap_qdict =NULL ; -BlockDirtyBitmap *bmp_param =NULL ; +QDict *cbw_qdict =NULL ; +BlockdevOptionsCbw *opts =NULL ;Visitor *v =NULL ; -bool ret = false; - *bitmap =NULL ; + cbw_qdict =qdict_clone_shallow (options); -qdict_extract_subqdict (options, &bitmap_qdict,"bitmap." ); -if (!qdict_size (bitmap_qdict)) { - ret = true; - goto out; - } +/* +* Delete BlockdevOptions base fields, that are not part of +* BlockdevOptionsCbw. +*/ +qdict_del (cbw_qdict,"driver" ); +qdict_del (cbw_qdict,"node-name" ); +qdict_del (cbw_qdict,"discard" ); +qdict_del (cbw_qdict,"cache" ); +qdict_extract_subqdict (cbw_qdict,NULL ,"cache." ); +qdict_del (cbw_qdict,"read-only" ); +qdict_del (cbw_qdict,"auto-read-only" ); +qdict_del (cbw_qdict,"force-share" ); +qdict_del (cbw_qdict,"detect-zeroes" ); - v =qobject_input_visitor_new_flat_confused (bitmap_qdict, errp); + v =qobject_input_visitor_new_flat_confused (cbw_qdict, errp);if (!v) { goto out; } -visit_type_BlockDirtyBitmap (v,NULL , &bmp_param, errp); -if (!bmp_param) { +visit_type_BlockdevOptionsCbw (v,NULL , &opts, errp); +if (!opts) { goto out; } - *bitmap =block_dirty_bitmap_lookup (bmp_param->node, bmp_param->name,NULL , - errp); -if (!*bitmap) { - goto out; - } - - ret = true; +/* +* Delete options which we are going to parse through BlockdevOptionsCbw +* object for original options. +*/ +qdict_extract_subqdict (options,NULL ,"bitmap" ); out: -qapi_free_BlockDirtyBitmap (bmp_param);visit_free (v); -qobject_unref (bitmap_qdict); +qobject_unref (cbw_qdict); -return ret; +return opts; } static int cbw_open(BlockDriverState *bs, QDict *options, int flags,
@@ -376,6 +380,12 @@ static int cbw_open(BlockDriverState *bs, QDict *options, int flags,BDRVCopyBeforeWriteState *s = bs->opaque;BdrvDirtyBitmap *bitmap =NULL ;int64_t cluster_size; +g_autoptr (BlockdevOptionsCbw) opts =NULL ; + + opts =cbw_parse_options (options, errp); +if (!opts) { +return -EINVAL ; + } bs->file = bdrv_open_child(NULL, options, "file", bs, &child_of_bds, BDRV_CHILD_FILTERED | BDRV_CHILD_PRIMARY,
@@ -390,8 +400,12 @@ static int cbw_open(BlockDriverState *bs, QDict *options, int flags,return -EINVAL ; } -if (!cbw_parse_bitmap_option (options, &bitmap, errp)) { -return -EINVAL ; +if (opts->has_bitmap) { + bitmap =block_dirty_bitmap_lookup (opts->bitmap->node, + opts->bitmap->name,NULL , errp); +if (!bitmap) { +return -EINVAL ; + } } bs->total_sectors = bs->file->bs->total_sectors;
Signature · 1 line
2.31.1
PATCH 2/3 block/copy-before-write: add on-cbw-error open parameter
In reply to Vladimir Sementsov-OgievskiyCurrently, behavior on copy-before-write operation failure is simple:
report error to the guest.
Let's implement alternative behavior: break the whole copy-before-write process (and corresponding backup job or NBD client) but keep guest working. It's needed if we consider guest stability as more important.
The realisation is simple: on copy-before-write failure we immediately continue guest write operation and set s->snapshot_ret variable which will lead to all further and in-flight snapshot-API requests failure.
--- qapi/block-core.json | 27 ++++++++++++++++++- block/copy-before-write.c | 57 +++++++++++++++++++++++++++++++++------ 2 files changed, 75 insertions(+), 9 deletions(-)
qapi/block-core.json +26 -1
@@ -4159,6 +4159,27 @@ 'base': 'BlockdevOptionsGenericFormat', 'data': { '*bottom': 'str' } } +## +# @OnCbwError: +# +# An enumeration of possible behaviors for copy-before-write operation +# failures. +# +# @break-guest-write: report the error to the guest. This way the state +# of copy-before-write process is kept OK and +# copy-before-write filter continues to work normally. +# +# @break-snapshot: continue guest write. Since this, the snapshot state +# provided by copy-before-write filter becomes broken. +# So, all in-flight and all further snapshot-access +# operations (through snapshot-access block driver) +# will fail. +# +# Since: 7.0 +## +{ 'enum': 'OnCbwError', + 'data': [ 'break-guest-write', 'break-snapshot' ] } + ## # @BlockdevOptionsCbw: #
@@ -4180,11 +4201,15 @@ # modifications (or removing) of specified bitmap doesn't # influence the filter. (Since 7.0) # +# @on-cbw-error: Behavior on failure of copy-before-write operation. +# Default is @break-guest-write. (Since 7.0) +# # Since: 6.2 ## { 'struct': 'BlockdevOptionsCbw', 'base': 'BlockdevOptionsGenericFormat', - 'data': { 'target': 'BlockdevRef', '*bitmap': 'BlockDirtyBitmap' } } + 'data': { 'target': 'BlockdevRef', '*bitmap': 'BlockDirtyBitmap', + '*on-cbw-error': 'OnCbwError' } } ## # @BlockdevOptions:
block/copy-before-write.c +49 -8
142 lines not on this page · raw message
Signature · 1 line
2.31.1
Re: [PATCH 2/3] block/copy-before-write: add on-cbw-error open parameter
block/copy-before-write.c cbw_co_snapshot_block_status(BlockDriverState *bs, · line 316
Quoted 9 lines · Vladimir Sementsov-Ogievskiy
block/copy-before-write.c +2
-2@@ -273,9 +311,9 @@ cbw_co_snapshot_block_status(BlockDriverState *bs,assert (ret &BDRV_BLOCK_ALLOCATED ); } -cbw_snapshot_read_unlock (bs, req); + ret2 =cbw_snapshot_read_unlock (bs, req); -return ret; +return ret <0 ? ret : ret2;
Oops. On success we should return ret, as it's a block-status
Signature · 2 lines
Best regards, Vladimir
PATCH 3/3 iotests: add copy-before-write: on-cbw-error tests
In reply to Vladimir Sementsov-OgievskiyAdd tests for new option of copy-before-write filter: on-cbw-error.
--- tests/qemu-iotests/tests/copy-before-write | 128 ++++++++++++++++++ .../qemu-iotests/tests/copy-before-write.out | 5 + 2 files changed, 133 insertions(+) create mode 100755 tests/qemu-iotests/tests/copy-before-write create mode 100644 tests/qemu-iotests/tests/copy-before-write.out
tests/qemu-iotests/tests/copy-before-write new file +128 -0
@@ -0,0 +1,128 @@ +#!/usr/bin/env python3 +# group: auto backup +# +# Copyright (c) 2022 Virtuozzo International GmbH +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. +# + +import os +import re + +import iotests +from iotests import qemu_img_create, qemu_io + + +temp_img = os.path.join(iotests.test_dir, 'temp') +source_img = os.path.join(iotests.test_dir, 'source') +size = '1M' + + +class TestCbwError(iotests.QMPTestCase): + def tearDown(self): + self.vm.shutdown() + os.remove(temp_img) + os.remove(source_img) + + def setUp(self): + qemu_img_create('-f', iotests.imgfmt, source_img, size) + qemu_img_create('-f', iotests.imgfmt, temp_img, size) + qemu_io('-c', 'write 0 1M', source_img) + + self.vm = iotests.VM() + self.vm.launch() + + def do_cbw_error(self, on_cbw_error): + result = self.vm.qmp('blockdev-add', { + 'node-name': 'cbw', + 'driver': 'copy-before-write', + 'on-cbw-error': on_cbw_error, + 'file': { + 'driver': iotests.imgfmt, + 'file': { + 'driver': 'file', + 'filename': source_img, + } + }, + 'target': { + 'driver': iotests.imgfmt, + 'file': { + 'driver': 'blkdebug', + 'image': { + 'driver': 'file', + 'filename': temp_img + }, + 'inject-error': [ + { + 'event': 'write_aio', + 'errno': 5, + 'immediately': False, + 'once': True + } + ] + } + } + }) + self.assert_qmp(result, 'return', {}) + + result = self.vm.qmp('blockdev-add', { + 'node-name': 'access', + 'driver': 'snapshot-access', + 'file': 'cbw' + }) + self.assert_qmp(result, 'return', {}) + + result = self.vm.hmp_qemu_io('cbw', 'write 0 1M') + self.assert_qmp(result, 'return', '') + + result = self.vm.hmp_qemu_io('access', 'read 0 1M') + self.assert_qmp(result, 'return', '') + + self.vm.shutdown() + log = self.vm.get_log() + log = re.sub(r'^\[I \d+\.\d+\] OPENED\n', '', log) + log = re.sub(r'\[I \+\d+\.\d+\] CLOSED\n?$', '', log) + log = iotests.filter_qemu_io(log) + return log + + def test_break_snapshot_on_cbw_error(self): + """break-snapshot behavior: + Guest write succeed, but further snapshot-read fails, as snapshot is + broken. + """ + log = self.do_cbw_error('break-snapshot') + + self.assertEqual(log, """\ +wrote 1048576/1048576 bytes at offset 0 +1 MiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec) +read failed: Permission denied +""") + + def test_break_guest_write_on_cbw_error(self): + """break-guest-write behavior: + Guest write fails, but snapshot-access continues working and further + snapshot-read succeeds. + """ + log = self.do_cbw_error('break-guest-write') + + self.assertEqual(log, """\ +write failed: Input/output error +read 1048576/1048576 bytes at offset 0 +1 MiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec) +""") + + +if __name__ == '__main__': + iotests.main(supported_fmts=['qcow2'], + supported_protocols=['file'])
tests/qemu-iotests/tests/copy-before-write.out new file +5 -0
@@ -0,0 +1,5 @@ +.. +---------------------------------------------------------------------- +Ran 2 tests + +OK
Signature · 1 line
2.31.1