blob: 392d9476e6acd9c5950b72dd6e696879a9c7e2f5 [file] [log] [blame]
Markus Armbruster666daa62010-06-02 18:48:27 +02001/*
2 * QEMU host block devices
3 *
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 *
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
Markus Armbruster3618a092013-03-14 13:59:53 +01008 *
9 * This file incorporates work covered by the following copyright and
10 * permission notice:
11 *
12 * Copyright (c) 2003-2008 Fabrice Bellard
13 *
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
30 * THE SOFTWARE.
Markus Armbruster666daa62010-06-02 18:48:27 +020031 */
32
Peter Maydelld38ea872016-01-29 17:50:05 +000033#include "qemu/osdep.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020034#include "sysemu/block-backend.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010035#include "sysemu/blockdev.h"
Paolo Bonzini0d09e412013-02-05 17:06:20 +010036#include "hw/block/block.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010037#include "block/blockjob.h"
Max Reitz609f45e2018-06-14 21:14:28 +020038#include "block/qdict.h"
Alberto Garcia76f4afb2015-06-08 18:17:44 +020039#include "block/throttle-groups.h"
Paolo Bonzini83c90892012-12-17 18:19:49 +010040#include "monitor/monitor.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010041#include "qemu/error-report.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010042#include "qemu/option.h"
Markus Armbrustercdcd4362019-04-17 21:06:38 +020043#include "qemu/qemu-print.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010044#include "qemu/config-file.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010045#include "qapi/qapi-commands-block.h"
46#include "qapi/qapi-commands-transaction.h"
47#include "qapi/qapi-visit-block-core.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010048#include "qapi/qmp/qdict.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010049#include "qapi/qmp/qnum.h"
Markus Armbruster6b673952018-02-01 12:18:35 +010050#include "qapi/qmp/qstring.h"
Markus Armbrustere688df62018-02-01 12:18:31 +010051#include "qapi/error.h"
Markus Armbrustercc7a8ea2015-03-17 17:22:46 +010052#include "qapi/qmp/qerror.h"
Markus Armbruster47e6b292018-02-01 12:18:38 +010053#include "qapi/qmp/qlist.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010054#include "qapi/qobject-output-visitor.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010055#include "sysemu/sysemu.h"
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +000056#include "sysemu/iothread.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010057#include "block/block_int.h"
Daniel P. Berrange0ab8ed12017-01-25 16:14:15 +000058#include "block/trace.h"
Markus Armbruster54d31232019-08-12 07:23:59 +020059#include "sysemu/runstate.h"
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +030060#include "sysemu/replay.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020061#include "qemu/cutils.h"
62#include "qemu/help_option.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020063#include "qemu/main-loop.h"
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +010064#include "qemu/throttle-options.h"
Markus Armbruster666daa62010-06-02 18:48:27 +020065
Emanuele Giuseppe Espositoebc27522022-03-03 10:15:56 -050066/* Protected by BQL */
Maxim Levitsky89802d52020-03-08 11:24:40 +020067QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
Max Reitz9c4218e2016-01-29 16:36:12 +010068 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
69
Maxim Levitsky89802d52020-03-08 11:24:40 +020070void bdrv_set_monitor_owned(BlockDriverState *bs)
71{
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -050072 GLOBAL_STATE_CODE();
Maxim Levitsky89802d52020-03-08 11:24:40 +020073 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
74}
75
Markus Armbruster19609662011-01-28 11:21:39 +010076static const char *const if_name[IF_COUNT] = {
77 [IF_NONE] = "none",
78 [IF_IDE] = "ide",
79 [IF_SCSI] = "scsi",
80 [IF_FLOPPY] = "floppy",
81 [IF_PFLASH] = "pflash",
82 [IF_MTD] = "mtd",
83 [IF_SD] = "sd",
84 [IF_VIRTIO] = "virtio",
85 [IF_XEN] = "xen",
86};
87
John Snow21dff8c2014-10-01 14:19:25 -040088static int if_max_devs[IF_COUNT] = {
Markus Armbruster27d6bf42011-01-28 11:21:40 +010089 /*
90 * Do not change these numbers! They govern how drive option
91 * index maps to unit and bus. That mapping is ABI.
92 *
Wei Jiangang547cb152016-04-26 18:12:43 +080093 * All controllers used to implement if=T drives need to support
Markus Armbruster27d6bf42011-01-28 11:21:40 +010094 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
95 * Otherwise, some index values map to "impossible" bus, unit
96 * values.
97 *
98 * For instance, if you change [IF_SCSI] to 255, -drive
99 * if=scsi,index=12 no longer means bus=1,unit=5, but
100 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
101 * the drive can't be set up. Regression.
102 */
103 [IF_IDE] = 2,
104 [IF_SCSI] = 7,
Markus Armbruster19609662011-01-28 11:21:39 +0100105};
106
John Snow21dff8c2014-10-01 14:19:25 -0400107/**
108 * Boards may call this to offer board-by-board overrides
109 * of the default, global values.
110 */
111void override_max_devs(BlockInterfaceType type, int max_devs)
112{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200113 BlockBackend *blk;
John Snow21dff8c2014-10-01 14:19:25 -0400114 DriveInfo *dinfo;
115
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500116 GLOBAL_STATE_CODE();
117
John Snow21dff8c2014-10-01 14:19:25 -0400118 if (max_devs <= 0) {
119 return;
120 }
121
Markus Armbruster18e46a02014-10-07 13:59:06 +0200122 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
123 dinfo = blk_legacy_dinfo(blk);
John Snow21dff8c2014-10-01 14:19:25 -0400124 if (dinfo->type == type) {
125 fprintf(stderr, "Cannot override units-per-bus property of"
126 " the %s interface, because a drive of that type has"
127 " already been added.\n", if_name[type]);
128 g_assert_not_reached();
129 }
130 }
131
132 if_max_devs[type] = max_devs;
133}
134
Markus Armbruster14bafc52010-06-25 08:09:10 +0200135/*
136 * We automatically delete the drive when a device using it gets
137 * unplugged. Questionable feature, but we can't just drop it.
138 * Device models call blockdev_mark_auto_del() to schedule the
139 * automatic deletion, and generic qdev code calls blockdev_auto_del()
140 * when deletion is actually safe.
141 */
Markus Armbruster4be74632014-10-07 13:59:18 +0200142void blockdev_mark_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200143{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200144 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300145 BlockJob *job;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200146
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500147 GLOBAL_STATE_CODE();
148
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200149 if (!dinfo) {
Kevin Wolf2d246f02013-09-18 15:14:47 +0200150 return;
151 }
152
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300153 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
154 if (block_job_has_bdrv(job, blk_bs(blk))) {
155 AioContext *aio_context = job->job.aio_context;
156 aio_context_acquire(aio_context);
Stefan Hajnoczi91fddb02014-10-21 12:03:52 +0100157
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300158 job_cancel(&job->job, false);
159
160 aio_context_release(aio_context);
Max Reitz5433c242015-10-19 17:53:29 +0200161 }
Paolo Bonzini12bde0e2012-03-30 13:17:10 +0200162 }
Stefan Hajnoczi91fddb02014-10-21 12:03:52 +0100163
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200164 dinfo->auto_del = 1;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200165}
166
Markus Armbruster4be74632014-10-07 13:59:18 +0200167void blockdev_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200168{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200169 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500170 GLOBAL_STATE_CODE();
Markus Armbruster14bafc52010-06-25 08:09:10 +0200171
Ryan Harper0fc0f1f2010-12-08 10:05:00 -0600172 if (dinfo && dinfo->auto_del) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100173 monitor_remove_blk(blk);
Markus Armbrusterb9fe8a72014-10-07 13:59:09 +0200174 blk_unref(blk);
Markus Armbruster14bafc52010-06-25 08:09:10 +0200175 }
176}
177
Markus Armbruster505a7fb2011-01-28 11:21:43 +0100178static int drive_index_to_bus_id(BlockInterfaceType type, int index)
179{
180 int max_devs = if_max_devs[type];
181 return max_devs ? index / max_devs : 0;
182}
183
184static int drive_index_to_unit_id(BlockInterfaceType type, int index)
185{
186 int max_devs = if_max_devs[type];
187 return max_devs ? index % max_devs : index;
188}
189
Markus Armbruster2292dda2011-01-28 11:21:41 +0100190QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
Markus Armbruster5645b0f2011-01-31 11:50:09 +0100191 const char *optstr)
Markus Armbruster666daa62010-06-02 18:48:27 +0200192{
Markus Armbruster666daa62010-06-02 18:48:27 +0200193 QemuOpts *opts;
194
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500195 GLOBAL_STATE_CODE();
196
Emanuele Giuseppe Espositocc67f282021-12-15 07:11:39 -0500197 opts = qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
Markus Armbruster666daa62010-06-02 18:48:27 +0200198 if (!opts) {
199 return NULL;
200 }
Markus Armbruster2292dda2011-01-28 11:21:41 +0100201 if (type != IF_DEFAULT) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100202 qemu_opt_set(opts, "if", if_name[type], &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100203 }
204 if (index >= 0) {
Markus Armbrustera8b18f82015-02-13 15:50:43 +0100205 qemu_opt_set_number(opts, "index", index, &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100206 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200207 if (file)
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100208 qemu_opt_set(opts, "file", file, &error_abort);
Markus Armbruster666daa62010-06-02 18:48:27 +0200209 return opts;
210}
211
212DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
213{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200214 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200215 DriveInfo *dinfo;
216
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500217 GLOBAL_STATE_CODE();
218
Markus Armbruster18e46a02014-10-07 13:59:06 +0200219 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
220 dinfo = blk_legacy_dinfo(blk);
221 if (dinfo && dinfo->type == type
222 && dinfo->bus == bus && dinfo->unit == unit) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200223 return dinfo;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200224 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200225 }
226
227 return NULL;
228}
229
Markus Armbrusterfe9f70a2021-03-09 17:12:13 +0100230/*
231 * Check board claimed all -drive that are meant to be claimed.
232 * Fatal error if any remain unclaimed.
233 */
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100234void drive_check_orphaned(void)
John Snowa66c9dc2014-10-01 14:19:24 -0400235{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200236 BlockBackend *blk;
John Snowa66c9dc2014-10-01 14:19:24 -0400237 DriveInfo *dinfo;
Markus Armbruster664cc622017-02-15 11:05:45 +0100238 Location loc;
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100239 bool orphans = false;
John Snowa66c9dc2014-10-01 14:19:24 -0400240
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500241 GLOBAL_STATE_CODE();
242
Markus Armbruster18e46a02014-10-07 13:59:06 +0200243 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
244 dinfo = blk_legacy_dinfo(blk);
Markus Armbrusterfe9f70a2021-03-09 17:12:13 +0100245 /*
246 * Ignore default drives, because we create certain default
247 * drives unconditionally, then leave them unclaimed. Not the
248 * users fault.
249 * Ignore IF_VIRTIO, because it gets desugared into -device,
250 * so we can leave failing to -device.
251 * Ignore IF_NONE, because leaving unclaimed IF_NONE remains
252 * available for device_add is a feature.
253 */
254 if (dinfo->is_default || dinfo->type == IF_VIRTIO
255 || dinfo->type == IF_NONE) {
Markus Armbrustera1b40bd2020-06-22 11:42:19 +0200256 continue;
257 }
258 if (!blk_get_attached_dev(blk)) {
Markus Armbruster664cc622017-02-15 11:05:45 +0100259 loc_push_none(&loc);
260 qemu_opts_loc_restore(dinfo->opts);
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100261 error_report("machine type does not support"
Markus Armbruster664cc622017-02-15 11:05:45 +0100262 " if=%s,bus=%d,unit=%d",
263 if_name[dinfo->type], dinfo->bus, dinfo->unit);
264 loc_pop(&loc);
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100265 orphans = true;
John Snowa66c9dc2014-10-01 14:19:24 -0400266 }
267 }
268
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100269 if (orphans) {
270 exit(1);
271 }
John Snowa66c9dc2014-10-01 14:19:24 -0400272}
273
Markus Armbrusterf1bd51a2011-01-28 11:21:44 +0100274DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
275{
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500276 GLOBAL_STATE_CODE();
Markus Armbrusterf1bd51a2011-01-28 11:21:44 +0100277 return drive_get(type,
278 drive_index_to_bus_id(type, index),
279 drive_index_to_unit_id(type, index));
280}
281
Markus Armbruster666daa62010-06-02 18:48:27 +0200282int drive_get_max_bus(BlockInterfaceType type)
283{
284 int max_bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200285 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200286 DriveInfo *dinfo;
287
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500288 GLOBAL_STATE_CODE();
289
Markus Armbruster666daa62010-06-02 18:48:27 +0200290 max_bus = -1;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200291 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
292 dinfo = blk_legacy_dinfo(blk);
293 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200294 max_bus = dinfo->bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200295 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200296 }
297 return max_bus;
298}
299
Markus Armbruster666daa62010-06-02 18:48:27 +0200300static void bdrv_format_print(void *opaque, const char *name)
301{
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200302 qemu_printf(" %s", name);
Markus Armbruster666daa62010-06-02 18:48:27 +0200303}
304
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000305typedef struct {
306 QEMUBH *bh;
Fam Zhengfa510eb2013-08-23 09:14:51 +0800307 BlockDriverState *bs;
308} BDRVPutRefBH;
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000309
Kevin Wolfb6810722013-09-20 11:33:11 +0200310static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200311{
312 if (!strcmp(buf, "ignore")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200313 return BLOCKDEV_ON_ERROR_IGNORE;
Markus Armbruster666daa62010-06-02 18:48:27 +0200314 } else if (!is_read && !strcmp(buf, "enospc")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200315 return BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200316 } else if (!strcmp(buf, "stop")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200317 return BLOCKDEV_ON_ERROR_STOP;
Markus Armbruster666daa62010-06-02 18:48:27 +0200318 } else if (!strcmp(buf, "report")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200319 return BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200320 } else {
Kevin Wolfb6810722013-09-20 11:33:11 +0200321 error_setg(errp, "'%s' invalid %s error action",
322 buf, is_read ? "read" : "write");
Markus Armbruster666daa62010-06-02 18:48:27 +0200323 return -1;
324 }
325}
326
Alberto Garcia40119ef2015-11-16 11:28:38 +0200327static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
328 Error **errp)
329{
330 const QListEntry *entry;
331 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
332 switch (qobject_type(entry->value)) {
333
334 case QTYPE_QSTRING: {
335 unsigned long long length;
Max Reitz7dc847e2018-02-24 16:40:29 +0100336 const char *str = qstring_get_str(qobject_to(QString,
337 entry->value));
Alberto Garcia40119ef2015-11-16 11:28:38 +0200338 if (parse_uint_full(str, &length, 10) == 0 &&
339 length > 0 && length <= UINT_MAX) {
340 block_acct_add_interval(stats, (unsigned) length);
341 } else {
342 error_setg(errp, "Invalid interval length: %s", str);
343 return false;
344 }
345 break;
346 }
347
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400348 case QTYPE_QNUM: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100349 int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400350
Alberto Garcia40119ef2015-11-16 11:28:38 +0200351 if (length > 0 && length <= UINT_MAX) {
352 block_acct_add_interval(stats, (unsigned) length);
353 } else {
354 error_setg(errp, "Invalid interval length: %" PRId64, length);
355 return false;
356 }
357 break;
358 }
359
360 default:
361 error_setg(errp, "The specification of stats-intervals is invalid");
362 return false;
363 }
364 }
365 return true;
366}
367
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200368typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
369
Max Reitzfbf81752015-10-19 17:53:31 +0200370/* All parameters but @opts are optional and may be set to NULL. */
371static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
372 const char **throttling_group, ThrottleConfig *throttle_cfg,
373 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
374{
Max Reitzfbf81752015-10-19 17:53:31 +0200375 Error *local_error = NULL;
376 const char *aio;
377
378 if (bdrv_flags) {
Max Reitzfbf81752015-10-19 17:53:31 +0200379 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
380 *bdrv_flags |= BDRV_O_COPY_ON_READ;
381 }
382
Max Reitzfbf81752015-10-19 17:53:31 +0200383 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
Aarushi Mehtaf80f2672020-01-20 14:18:50 +0000384 if (bdrv_parse_aio(aio, bdrv_flags) < 0) {
385 error_setg(errp, "invalid aio option");
386 return;
Max Reitzfbf81752015-10-19 17:53:31 +0200387 }
388 }
389 }
390
391 /* disk I/O throttling */
392 if (throttling_group) {
393 *throttling_group = qemu_opt_get(opts, "throttling.group");
394 }
395
396 if (throttle_cfg) {
Alberto Garcia1588ab52016-02-18 12:27:00 +0200397 throttle_config_init(throttle_cfg);
Max Reitzfbf81752015-10-19 17:53:31 +0200398 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
399 qemu_opt_get_number(opts, "throttling.bps-total", 0);
400 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
401 qemu_opt_get_number(opts, "throttling.bps-read", 0);
402 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
403 qemu_opt_get_number(opts, "throttling.bps-write", 0);
404 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
405 qemu_opt_get_number(opts, "throttling.iops-total", 0);
406 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
407 qemu_opt_get_number(opts, "throttling.iops-read", 0);
408 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
409 qemu_opt_get_number(opts, "throttling.iops-write", 0);
410
411 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
412 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
413 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
414 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
415 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
416 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
417 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
418 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
419 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
420 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
421 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
422 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
423
Alberto Garcia8a0fc182016-02-18 12:27:02 +0200424 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
425 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
426 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
427 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
428 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
429 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
430 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
431 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
432 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
433 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
434 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
435 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
436
Max Reitzfbf81752015-10-19 17:53:31 +0200437 throttle_cfg->op_size =
438 qemu_opt_get_number(opts, "throttling.iops-size", 0);
439
Alberto Garciad5851082016-02-18 12:26:59 +0200440 if (!throttle_is_valid(throttle_cfg, errp)) {
Max Reitzfbf81752015-10-19 17:53:31 +0200441 return;
442 }
443 }
444
445 if (detect_zeroes) {
446 *detect_zeroes =
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200447 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
Max Reitzfbf81752015-10-19 17:53:31 +0200448 qemu_opt_get(opts, "detect-zeroes"),
Max Reitzfbf81752015-10-19 17:53:31 +0200449 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
450 &local_error);
451 if (local_error) {
452 error_propagate(errp, local_error);
453 return;
454 }
Max Reitzfbf81752015-10-19 17:53:31 +0200455 }
456}
457
Denis V. Lunevb2aaf352022-08-24 11:50:43 +0200458static OnOffAuto account_get_opt(QemuOpts *opts, const char *name)
459{
460 if (!qemu_opt_find(opts, name)) {
461 return ON_OFF_AUTO_AUTO;
462 }
463 if (qemu_opt_get_bool(opts, name, true)) {
464 return ON_OFF_AUTO_ON;
465 }
466 return ON_OFF_AUTO_OFF;
467}
468
Kevin Wolff298d072013-09-10 12:01:20 +0200469/* Takes the ownership of bs_opts */
Markus Armbruster18e46a02014-10-07 13:59:06 +0200470static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
471 Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200472{
473 const char *buf;
Markus Armbruster666daa62010-06-02 18:48:27 +0200474 int bdrv_flags = 0;
475 int on_read_error, on_write_error;
Denis V. Lunevb2aaf352022-08-24 11:50:43 +0200476 OnOffAuto account_invalid, account_failed;
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300477 bool writethrough, read_only;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200478 BlockBackend *blk;
Markus Armbrustera0f1eab2014-09-12 21:26:21 +0200479 BlockDriverState *bs;
Benoît Canetcc0681c2013-09-02 14:14:39 +0200480 ThrottleConfig cfg;
Markus Armbruster666daa62010-06-02 18:48:27 +0200481 int snapshot = 0;
Stefan Hajnoczic5461942013-02-13 16:53:42 +0100482 Error *error = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100483 QemuOpts *opts;
Alberto Garcia40119ef2015-11-16 11:28:38 +0200484 QDict *interval_dict = NULL;
485 QList *interval_list = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100486 const char *id;
Max Reitzfbf81752015-10-19 17:53:31 +0200487 BlockdevDetectZeroesOptions detect_zeroes =
488 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
489 const char *throttling_group = NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200490
Kevin Wolff298d072013-09-10 12:01:20 +0200491 /* Check common options by copying from bs_opts to opts, all other options
492 * stay in bs_opts for processing by bdrv_open(). */
493 id = qdict_get_try_str(bs_opts, "id");
Markus Armbrusterc6ecec42020-07-07 18:05:35 +0200494 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, errp);
495 if (!opts) {
Markus Armbruster6376f952014-05-28 11:17:01 +0200496 goto err_no_opts;
Kevin Wolf00063832013-03-15 10:35:07 +0100497 }
498
Markus Armbruster668f62e2020-07-07 18:06:02 +0200499 if (!qemu_opts_absorb_qdict(opts, bs_opts, errp)) {
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100500 goto early_err;
Kevin Wolf00063832013-03-15 10:35:07 +0100501 }
502
503 if (id) {
504 qdict_del(bs_opts, "id");
505 }
506
Markus Armbruster666daa62010-06-02 18:48:27 +0200507 /* extract parameters */
Markus Armbruster666daa62010-06-02 18:48:27 +0200508 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
Markus Armbruster666daa62010-06-02 18:48:27 +0200509
Denis V. Lunevb2aaf352022-08-24 11:50:43 +0200510 account_invalid = account_get_opt(opts, "stats-account-invalid");
511 account_failed = account_get_opt(opts, "stats-account-failed");
Alberto Garcia362e9292015-10-28 17:33:04 +0200512
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100513 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
514
Alberto Garciaff356ee2016-07-08 17:03:00 +0300515 id = qemu_opts_id(opts);
516
Alberto Garcia40119ef2015-11-16 11:28:38 +0200517 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
518 qdict_array_split(interval_dict, &interval_list);
519
520 if (qdict_size(interval_dict) != 0) {
521 error_setg(errp, "Invalid option stats-intervals.%s",
522 qdict_first(interval_dict)->key);
523 goto early_err;
524 }
Alberto Garcia2be55062015-10-28 17:33:07 +0200525
Max Reitzfbf81752015-10-19 17:53:31 +0200526 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
527 &detect_zeroes, &error);
528 if (error) {
529 error_propagate(errp, error);
530 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200531 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200532
533 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
Peter Maydellc8057f92012-08-02 13:45:54 +0100534 if (is_help_option(buf)) {
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200535 qemu_printf("Supported formats:");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300536 bdrv_iterate_format(bdrv_format_print, NULL, false);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200537 qemu_printf("\nSupported formats (read-only):");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300538 bdrv_iterate_format(bdrv_format_print, NULL, true);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200539 qemu_printf("\n");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100540 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200541 }
Kevin Wolf74fe54f2013-07-09 11:09:02 +0200542
Max Reitze4342ce2015-02-05 13:58:14 -0500543 if (qdict_haskey(bs_opts, "driver")) {
544 error_setg(errp, "Cannot specify both 'driver' and 'format'");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100545 goto early_err;
Mike Qiu6db5f5d2013-08-08 10:45:16 -0400546 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500547 qdict_put_str(bs_opts, "driver", buf);
Markus Armbruster666daa62010-06-02 18:48:27 +0200548 }
549
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200550 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200551 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200552 on_write_error = parse_block_error_action(buf, 0, &error);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100553 if (error) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200554 error_propagate(errp, error);
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100555 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200556 }
557 }
558
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200559 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200560 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200561 on_read_error = parse_block_error_action(buf, 1, &error);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100562 if (error) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200563 error_propagate(errp, error);
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100564 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200565 }
566 }
567
Max Reitz5ec18f82015-10-19 17:53:30 +0200568 if (snapshot) {
Kevin Wolf91a097e2015-05-08 17:49:53 +0200569 bdrv_flags |= BDRV_O_SNAPSHOT;
Max Reitz5ec18f82015-10-19 17:53:30 +0200570 }
571
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300572 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
573
Kevin Wolf326642b2013-07-11 12:52:34 +0200574 /* init */
Kevin Wolf39c4ae92015-11-13 14:45:42 +0100575 if ((!file || !*file) && !qdict_size(bs_opts)) {
Max Reitz5ec18f82015-10-19 17:53:30 +0200576 BlockBackendRootState *blk_rs;
577
Kevin Wolfd861ab32019-04-25 14:25:10 +0200578 blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
Max Reitz5ec18f82015-10-19 17:53:30 +0200579 blk_rs = blk_get_root_state(blk);
Vladimir Sementsov-Ogievskiy260242a2021-05-27 18:40:56 +0300580 blk_rs->open_flags = bdrv_flags | (read_only ? 0 : BDRV_O_RDWR);
Max Reitz5ec18f82015-10-19 17:53:30 +0200581 blk_rs->detect_zeroes = detect_zeroes;
582
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200583 qobject_unref(bs_opts);
Max Reitze4342ce2015-02-05 13:58:14 -0500584 } else {
585 if (file && !*file) {
586 file = NULL;
587 }
588
Kevin Wolf91a097e2015-05-08 17:49:53 +0200589 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
590 * with other callers) rather than what we want as the real defaults.
591 * Apply the defaults here instead. */
Kevin Wolf91a097e2015-05-08 17:49:53 +0200592 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
593 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300594 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
595 read_only ? "on" : "off");
Kevin Wolf9384a442018-10-17 18:24:30 +0200596 qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
Kevin Wolf72e775c2016-03-15 14:34:37 +0100597 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
Kevin Wolf91a097e2015-05-08 17:49:53 +0200598
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100599 if (runstate_check(RUN_STATE_INMIGRATE)) {
600 bdrv_flags |= BDRV_O_INACTIVE;
601 }
602
Max Reitzefaa7c42016-03-16 19:54:38 +0100603 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
Max Reitze4342ce2015-02-05 13:58:14 -0500604 if (!blk) {
605 goto err_no_bs_opts;
606 }
607 bs = blk_bs(blk);
Max Reitze4342ce2015-02-05 13:58:14 -0500608
Max Reitz5ec18f82015-10-19 17:53:30 +0200609 bs->detect_zeroes = detect_zeroes;
610
Paolo Bonzini9caa6f32017-06-05 14:39:07 +0200611 block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
Alberto Garcia2be55062015-10-28 17:33:07 +0200612
Alberto Garcia40119ef2015-11-16 11:28:38 +0200613 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
614 blk_unref(blk);
615 blk = NULL;
616 goto err_no_bs_opts;
Alberto Garcia2be55062015-10-28 17:33:07 +0200617 }
Max Reitz5ec18f82015-10-19 17:53:30 +0200618 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200619
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100620 /* disk I/O throttling */
621 if (throttle_enabled(&cfg)) {
622 if (!throttling_group) {
Alberto Garciaff356ee2016-07-08 17:03:00 +0300623 throttling_group = id;
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100624 }
625 blk_io_limits_enable(blk, throttling_group);
626 blk_set_io_limits(blk, &cfg);
627 }
628
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100629 blk_set_enable_write_cache(blk, !writethrough);
Max Reitz373340b2015-10-19 17:53:22 +0200630 blk_set_on_error(blk, on_read_error, on_write_error);
Markus Armbrusterabd7f682010-06-02 18:55:17 +0200631
Alberto Garciaff356ee2016-07-08 17:03:00 +0300632 if (!monitor_add_blk(blk, id, errp)) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100633 blk_unref(blk);
634 blk = NULL;
635 goto err_no_bs_opts;
636 }
637
Max Reitze4342ce2015-02-05 13:58:14 -0500638err_no_bs_opts:
Kevin Wolf00063832013-03-15 10:35:07 +0100639 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200640 qobject_unref(interval_dict);
641 qobject_unref(interval_list);
Markus Armbruster18e46a02014-10-07 13:59:06 +0200642 return blk;
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100643
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100644early_err:
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100645 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200646 qobject_unref(interval_dict);
647 qobject_unref(interval_list);
Markus Armbruster6376f952014-05-28 11:17:01 +0200648err_no_opts:
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200649 qobject_unref(bs_opts);
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100650 return NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200651}
652
Max Reitzbd745e22015-10-19 17:53:32 +0200653/* Takes the ownership of bs_opts */
Maxim Levitsky89802d52020-03-08 11:24:40 +0200654BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
Max Reitzbd745e22015-10-19 17:53:32 +0200655{
Max Reitzbd745e22015-10-19 17:53:32 +0200656 int bdrv_flags = 0;
657
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -0500658 GLOBAL_STATE_CODE();
Kevin Wolfa81d6162016-03-07 14:23:04 +0100659 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
660 * with other callers) rather than what we want as the real defaults.
661 * Apply the defaults here instead. */
Kevin Wolfa81d6162016-03-07 14:23:04 +0100662 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
663 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300664 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
Kevin Wolfa81d6162016-03-07 14:23:04 +0100665
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100666 if (runstate_check(RUN_STATE_INMIGRATE)) {
667 bdrv_flags |= BDRV_O_INACTIVE;
668 }
669
Kevin Wolf74e1ae72016-09-20 20:48:52 +0200670 return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
Max Reitzbd745e22015-10-19 17:53:32 +0200671}
672
Max Reitz9c4218e2016-01-29 16:36:12 +0100673void blockdev_close_all_bdrv_states(void)
674{
675 BlockDriverState *bs, *next_bs;
676
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -0500677 GLOBAL_STATE_CODE();
Max Reitz9c4218e2016-01-29 16:36:12 +0100678 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
679 AioContext *ctx = bdrv_get_aio_context(bs);
680
681 aio_context_acquire(ctx);
682 bdrv_unref(bs);
683 aio_context_release(ctx);
684 }
685}
686
Max Reitz262b4e82016-03-16 19:54:41 +0100687/* Iterates over the list of monitor-owned BlockDriverStates */
688BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
689{
Emanuele Giuseppe Espositof791bf72022-03-03 10:15:49 -0500690 GLOBAL_STATE_CODE();
Max Reitz262b4e82016-03-16 19:54:41 +0100691 return bs ? QTAILQ_NEXT(bs, monitor_list)
692 : QTAILQ_FIRST(&monitor_bdrv_states);
693}
694
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200695static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200696 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200697{
698 const char *value;
699
700 value = qemu_opt_get(opts, from);
701 if (value) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200702 if (qemu_opt_find(opts, to)) {
703 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
704 "same time", to, from);
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200705 return false;
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200706 }
Jun Li20d6cd42014-09-24 13:45:27 +0800707 }
708
709 /* rename all items in opts */
710 while ((value = qemu_opt_get(opts, from))) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100711 qemu_opt_set(opts, to, value, &error_abort);
Kevin Wolf57975222013-07-17 14:41:54 +0200712 qemu_opt_unset(opts, from);
713 }
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200714 return true;
Kevin Wolf57975222013-07-17 14:41:54 +0200715}
716
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200717QemuOptsList qemu_legacy_drive_opts = {
718 .name = "drive",
719 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
720 .desc = {
721 {
Kevin Wolf87a899c2013-09-10 15:48:13 +0200722 .name = "bus",
723 .type = QEMU_OPT_NUMBER,
724 .help = "bus number",
725 },{
726 .name = "unit",
727 .type = QEMU_OPT_NUMBER,
728 .help = "unit number (i.e. lun for scsi)",
729 },{
730 .name = "index",
731 .type = QEMU_OPT_NUMBER,
732 .help = "index number",
733 },{
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200734 .name = "media",
735 .type = QEMU_OPT_STRING,
736 .help = "media type (disk, cdrom)",
Kevin Wolf593d4642013-08-28 17:24:51 +0200737 },{
738 .name = "if",
739 .type = QEMU_OPT_STRING,
740 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
Kevin Wolfb41a7332013-09-09 16:49:49 +0200741 },{
Max Reitzd095b462013-12-20 19:28:14 +0100742 .name = "file",
743 .type = QEMU_OPT_STRING,
744 .help = "file name",
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200745 },
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200746
747 /* Options that are passed on, but have special semantics with -drive */
748 {
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300749 .name = BDRV_OPT_READ_ONLY,
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200750 .type = QEMU_OPT_BOOL,
751 .help = "open drive file as read-only",
752 },{
Kevin Wolfee13ed12014-02-09 09:52:32 +0100753 .name = "rerror",
754 .type = QEMU_OPT_STRING,
755 .help = "read error action",
756 },{
757 .name = "werror",
758 .type = QEMU_OPT_STRING,
759 .help = "write error action",
760 },{
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200761 .name = "copy-on-read",
762 .type = QEMU_OPT_BOOL,
763 .help = "copy read data from backing file into image file",
764 },
765
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200766 { /* end of list */ }
767 },
768};
769
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200770DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
771 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200772{
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200773 const char *value;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200774 BlockBackend *blk;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200775 DriveInfo *dinfo = NULL;
Kevin Wolff298d072013-09-10 12:01:20 +0200776 QDict *bs_opts;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200777 QemuOpts *legacy_opts;
778 DriveMediaType media = MEDIA_DISK;
Kevin Wolf593d4642013-08-28 17:24:51 +0200779 BlockInterfaceType type;
Kevin Wolf87a899c2013-09-10 15:48:13 +0200780 int max_devs, bus_id, unit_id, index;
Kevin Wolfee13ed12014-02-09 09:52:32 +0100781 const char *werror, *rerror;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800782 bool read_only = false;
783 bool copy_on_read;
Max Reitzd095b462013-12-20 19:28:14 +0100784 const char *filename;
Kevin Wolf247147f2014-09-24 16:37:14 +0200785 int i;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200786
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500787 GLOBAL_STATE_CODE();
788
Kevin Wolf57975222013-07-17 14:41:54 +0200789 /* Change legacy command line options into QMP ones */
Kevin Wolf247147f2014-09-24 16:37:14 +0200790 static const struct {
791 const char *from;
792 const char *to;
793 } opt_renames[] = {
794 { "iops", "throttling.iops-total" },
795 { "iops_rd", "throttling.iops-read" },
796 { "iops_wr", "throttling.iops-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200797
Kevin Wolf247147f2014-09-24 16:37:14 +0200798 { "bps", "throttling.bps-total" },
799 { "bps_rd", "throttling.bps-read" },
800 { "bps_wr", "throttling.bps-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200801
Kevin Wolf247147f2014-09-24 16:37:14 +0200802 { "iops_max", "throttling.iops-total-max" },
803 { "iops_rd_max", "throttling.iops-read-max" },
804 { "iops_wr_max", "throttling.iops-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200805
Kevin Wolf247147f2014-09-24 16:37:14 +0200806 { "bps_max", "throttling.bps-total-max" },
807 { "bps_rd_max", "throttling.bps-read-max" },
808 { "bps_wr_max", "throttling.bps-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200809
Kevin Wolf247147f2014-09-24 16:37:14 +0200810 { "iops_size", "throttling.iops-size" },
Benoît Canet2024c1d2013-09-02 14:14:41 +0200811
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200812 { "group", "throttling.group" },
813
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300814 { "readonly", BDRV_OPT_READ_ONLY },
Kevin Wolf247147f2014-09-24 16:37:14 +0200815 };
816
817 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200818 if (!qemu_opt_rename(all_opts, opt_renames[i].from,
Markus Armbruster668f62e2020-07-07 18:06:02 +0200819 opt_renames[i].to, errp)) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200820 return NULL;
821 }
Kevin Wolf247147f2014-09-24 16:37:14 +0200822 }
Kevin Wolf0f227a92013-07-19 20:07:29 +0200823
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200824 value = qemu_opt_get(all_opts, "cache");
825 if (value) {
826 int flags = 0;
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100827 bool writethrough;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200828
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100829 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200830 error_setg(errp, "invalid cache option");
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200831 return NULL;
832 }
833
834 /* Specific options take precedence */
Kevin Wolf54861b92015-04-07 16:55:00 +0200835 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
836 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100837 !writethrough, &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200838 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200839 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
840 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100841 !!(flags & BDRV_O_NOCACHE), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200842 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200843 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
844 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100845 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200846 }
847 qemu_opt_unset(all_opts, "cache");
848 }
849
Kevin Wolff298d072013-09-10 12:01:20 +0200850 /* Get a QDict for processing the options */
851 bs_opts = qdict_new();
852 qemu_opts_to_qdict(all_opts, bs_opts);
853
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800854 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
855 &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200856 if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200857 goto fail;
858 }
859
860 /* Media type */
861 value = qemu_opt_get(legacy_opts, "media");
862 if (value) {
863 if (!strcmp(value, "disk")) {
864 media = MEDIA_DISK;
865 } else if (!strcmp(value, "cdrom")) {
866 media = MEDIA_CDROM;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800867 read_only = true;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200868 } else {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200869 error_setg(errp, "'%s' invalid media", value);
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200870 goto fail;
871 }
872 }
873
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200874 /* copy-on-read is disabled with a warning for read-only devices */
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300875 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200876 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
877
878 if (read_only && copy_on_read) {
Alistair Francis3dc6f862017-07-12 06:57:41 -0700879 warn_report("disabling copy-on-read on read-only drive");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200880 copy_on_read = false;
881 }
882
Eric Blake46f5ac22017-04-27 16:58:17 -0500883 qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
884 qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200885
Kevin Wolf593d4642013-08-28 17:24:51 +0200886 /* Controller type */
887 value = qemu_opt_get(legacy_opts, "if");
888 if (value) {
889 for (type = 0;
890 type < IF_COUNT && strcmp(value, if_name[type]);
891 type++) {
892 }
893 if (type == IF_COUNT) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200894 error_setg(errp, "unsupported bus type '%s'", value);
Kevin Wolf593d4642013-08-28 17:24:51 +0200895 goto fail;
896 }
897 } else {
898 type = block_default_type;
899 }
900
Kevin Wolf87a899c2013-09-10 15:48:13 +0200901 /* Device address specified by bus/unit or index.
902 * If none was specified, try to find the first free one. */
903 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
904 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
905 index = qemu_opt_get_number(legacy_opts, "index", -1);
906
907 max_devs = if_max_devs[type];
908
909 if (index != -1) {
910 if (bus_id != 0 || unit_id != -1) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200911 error_setg(errp, "index cannot be used with bus and unit");
Kevin Wolf87a899c2013-09-10 15:48:13 +0200912 goto fail;
913 }
914 bus_id = drive_index_to_bus_id(type, index);
915 unit_id = drive_index_to_unit_id(type, index);
916 }
917
918 if (unit_id == -1) {
919 unit_id = 0;
920 while (drive_get(type, bus_id, unit_id) != NULL) {
921 unit_id++;
922 if (max_devs && unit_id >= max_devs) {
923 unit_id -= max_devs;
924 bus_id++;
925 }
926 }
927 }
928
929 if (max_devs && unit_id >= max_devs) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200930 error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200931 goto fail;
932 }
933
934 if (drive_get(type, bus_id, unit_id) != NULL) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200935 error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
936 bus_id, unit_id, index);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200937 goto fail;
938 }
939
940 /* no id supplied -> create one */
941 if (qemu_opts_id(all_opts) == NULL) {
942 char *new_id;
943 const char *mediastr = "";
944 if (type == IF_IDE || type == IF_SCSI) {
945 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
946 }
947 if (max_devs) {
948 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
949 mediastr, unit_id);
950 } else {
951 new_id = g_strdup_printf("%s%s%i", if_name[type],
952 mediastr, unit_id);
953 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500954 qdict_put_str(bs_opts, "id", new_id);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200955 g_free(new_id);
956 }
957
Kevin Wolf394c7d42013-09-13 14:09:17 +0200958 /* Add virtio block device */
Kevin Wolf394c7d42013-09-13 14:09:17 +0200959 if (type == IF_VIRTIO) {
960 QemuOpts *devopts;
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800961 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
962 &error_abort);
Laurent Vivier9db1d3a2021-03-23 16:53:04 +0000963 qemu_opt_set(devopts, "driver", "virtio-blk", &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100964 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
965 &error_abort);
Kevin Wolf394c7d42013-09-13 14:09:17 +0200966 }
967
Max Reitzd095b462013-12-20 19:28:14 +0100968 filename = qemu_opt_get(legacy_opts, "file");
969
Kevin Wolfee13ed12014-02-09 09:52:32 +0100970 /* Check werror/rerror compatibility with if=... */
971 werror = qemu_opt_get(legacy_opts, "werror");
972 if (werror != NULL) {
973 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
974 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200975 error_setg(errp, "werror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +0100976 goto fail;
977 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500978 qdict_put_str(bs_opts, "werror", werror);
Kevin Wolfee13ed12014-02-09 09:52:32 +0100979 }
980
981 rerror = qemu_opt_get(legacy_opts, "rerror");
982 if (rerror != NULL) {
983 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
984 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200985 error_setg(errp, "rerror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +0100986 goto fail;
987 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500988 qdict_put_str(bs_opts, "rerror", rerror);
Kevin Wolfee13ed12014-02-09 09:52:32 +0100989 }
990
Kevin Wolf2d246f02013-09-18 15:14:47 +0200991 /* Actual block device init: Functionality shared with blockdev-add */
Markus Armbruster992861f2020-07-07 18:06:04 +0200992 blk = blockdev_init(filename, bs_opts, errp);
Markus Armbruster3cb0e252014-05-28 11:17:02 +0200993 bs_opts = NULL;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200994 if (!blk) {
Kevin Wolf2d246f02013-09-18 15:14:47 +0200995 goto fail;
996 }
997
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200998 /* Create legacy DriveInfo */
999 dinfo = g_malloc0(sizeof(*dinfo));
Kevin Wolff298d072013-09-10 12:01:20 +02001000 dinfo->opts = all_opts;
Kevin Wolf2d246f02013-09-18 15:14:47 +02001001
Kevin Wolfee13ed12014-02-09 09:52:32 +01001002 dinfo->type = type;
Kevin Wolf87a899c2013-09-10 15:48:13 +02001003 dinfo->bus = bus_id;
1004 dinfo->unit = unit_id;
Kevin Wolfbcf83152014-06-06 15:21:48 +02001005
Markus Armbruster26f8b3a2014-10-07 13:59:22 +02001006 blk_set_legacy_dinfo(blk, dinfo);
1007
Kevin Wolfe34ef042013-09-19 14:24:10 +02001008 switch(type) {
1009 case IF_IDE:
1010 case IF_SCSI:
1011 case IF_XEN:
1012 case IF_NONE:
1013 dinfo->media_cd = media == MEDIA_CDROM;
1014 break;
1015 default:
1016 break;
1017 }
1018
Kevin Wolf2d246f02013-09-18 15:14:47 +02001019fail:
Kevin Wolf33cb7dc2013-08-28 17:00:13 +02001020 qemu_opts_del(legacy_opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001021 qobject_unref(bs_opts);
Kevin Wolf2d246f02013-09-18 15:14:47 +02001022 return dinfo;
Kevin Wolf57975222013-07-17 14:41:54 +02001023}
1024
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001025static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1026{
1027 BlockDriverState *bs;
1028
1029 bs = bdrv_lookup_bs(name, name, errp);
1030 if (bs == NULL) {
1031 return NULL;
1032 }
1033
1034 if (!bdrv_is_root_node(bs)) {
1035 error_setg(errp, "Need a root block node");
1036 return NULL;
1037 }
1038
1039 if (!bdrv_is_inserted(bs)) {
1040 error_setg(errp, "Device has no medium");
1041 return NULL;
1042 }
1043
1044 return bs;
1045}
1046
Eric Blake10f75902016-03-03 09:16:50 -07001047static void blockdev_do_action(TransactionAction *action, Error **errp)
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001048{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001049 TransactionActionList list;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001050
Eric Blake10f75902016-03-03 09:16:50 -07001051 list.value = action;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001052 list.next = NULL;
John Snow94d16a62015-11-05 18:13:18 -05001053 qmp_transaction(&list, false, NULL, errp);
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001054}
1055
Benoît Canet0901f672014-01-23 21:31:38 +01001056void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1057 bool has_node_name, const char *node_name,
1058 const char *snapshot_file,
1059 bool has_snapshot_node_name,
1060 const char *snapshot_node_name,
Luiz Capitulino6106e242011-11-25 16:15:19 -02001061 bool has_format, const char *format,
Benoît Canet0901f672014-01-23 21:31:38 +01001062 bool has_mode, NewImageMode mode, Error **errp)
Jes Sorensenf8882562010-12-16 13:52:16 +01001063{
Alberto Garciaa911e6a2015-10-26 14:27:14 +02001064 BlockdevSnapshotSync snapshot = {
Benoît Canet0901f672014-01-23 21:31:38 +01001065 .has_device = has_device,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001066 .device = (char *) device,
Benoît Canet0901f672014-01-23 21:31:38 +01001067 .has_node_name = has_node_name,
1068 .node_name = (char *) node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001069 .snapshot_file = (char *) snapshot_file,
Benoît Canet0901f672014-01-23 21:31:38 +01001070 .has_snapshot_node_name = has_snapshot_node_name,
1071 .snapshot_node_name = (char *) snapshot_node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001072 .has_format = has_format,
1073 .format = (char *) format,
1074 .has_mode = has_mode,
1075 .mode = mode,
1076 };
Eric Blake10f75902016-03-03 09:16:50 -07001077 TransactionAction action = {
1078 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001079 .u.blockdev_snapshot_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001080 };
1081 blockdev_do_action(&action, errp);
Jes Sorensenf8882562010-12-16 13:52:16 +01001082}
1083
Alberto Garcia43de7e22015-10-26 14:27:16 +02001084void qmp_blockdev_snapshot(const char *node, const char *overlay,
1085 Error **errp)
1086{
1087 BlockdevSnapshot snapshot_data = {
1088 .node = (char *) node,
1089 .overlay = (char *) overlay
1090 };
Eric Blake10f75902016-03-03 09:16:50 -07001091 TransactionAction action = {
1092 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
Eric Blake32bafa82016-03-17 16:48:37 -06001093 .u.blockdev_snapshot.data = &snapshot_data,
Eric Blake10f75902016-03-03 09:16:50 -07001094 };
1095 blockdev_do_action(&action, errp);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001096}
1097
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001098void qmp_blockdev_snapshot_internal_sync(const char *device,
1099 const char *name,
1100 Error **errp)
1101{
1102 BlockdevSnapshotInternal snapshot = {
1103 .device = (char *) device,
1104 .name = (char *) name
1105 };
Eric Blake10f75902016-03-03 09:16:50 -07001106 TransactionAction action = {
1107 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001108 .u.blockdev_snapshot_internal_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001109 };
1110 blockdev_do_action(&action, errp);
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001111}
1112
Wenchao Xia44e3e052013-09-11 14:04:36 +08001113SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1114 bool has_id,
1115 const char *id,
1116 bool has_name,
1117 const char *name,
1118 Error **errp)
1119{
Fam Zhenga0e85442015-03-02 19:36:48 +08001120 BlockDriverState *bs;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001121 AioContext *aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001122 QEMUSnapshotInfo sn;
1123 Error *local_err = NULL;
1124 SnapshotInfo *info = NULL;
1125 int ret;
1126
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001127 bs = qmp_get_root_bs(device, errp);
1128 if (!bs) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001129 return NULL;
1130 }
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001131 aio_context = bdrv_get_aio_context(bs);
Max Reitz5433c242015-10-19 17:53:29 +02001132 aio_context_acquire(aio_context);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001133
1134 if (!has_id) {
1135 id = NULL;
1136 }
1137
1138 if (!has_name) {
1139 name = NULL;
1140 }
1141
1142 if (!id && !name) {
1143 error_setg(errp, "Name or id must be provided");
Max Reitz5433c242015-10-19 17:53:29 +02001144 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001145 }
1146
Stefan Hajnoczi0b928852014-11-19 14:19:43 +00001147 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1148 goto out_aio_context;
1149 }
1150
Wenchao Xia44e3e052013-09-11 14:04:36 +08001151 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001152 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001153 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001154 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001155 }
1156 if (!ret) {
1157 error_setg(errp,
1158 "Snapshot with id '%s' and name '%s' does not exist on "
1159 "device '%s'",
1160 STR_OR_NULL(id), STR_OR_NULL(name), device);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001161 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001162 }
1163
1164 bdrv_snapshot_delete(bs, id, name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001165 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001166 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001167 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001168 }
1169
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001170 aio_context_release(aio_context);
1171
Markus Armbruster5839e532014-08-19 10:31:08 +02001172 info = g_new0(SnapshotInfo, 1);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001173 info->id = g_strdup(sn.id_str);
1174 info->name = g_strdup(sn.name);
1175 info->date_nsec = sn.date_nsec;
1176 info->date_sec = sn.date_sec;
1177 info->vm_state_size = sn.vm_state_size;
1178 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1179 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001180 if (sn.icount != -1ULL) {
1181 info->icount = sn.icount;
1182 info->has_icount = true;
1183 }
Wenchao Xia44e3e052013-09-11 14:04:36 +08001184
1185 return info;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001186
1187out_aio_context:
1188 aio_context_release(aio_context);
1189 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001190}
Jeff Cody8802d1f2012-02-28 15:54:06 -05001191
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00001192/* New and old BlockDriverState structs for atomic group operations */
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001193
John Snow50f43f02015-11-05 18:13:09 -05001194typedef struct BlkActionState BlkActionState;
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001195
John Snow50f43f02015-11-05 18:13:09 -05001196/**
1197 * BlkActionOps:
1198 * Table of operations that define an Action.
1199 *
1200 * @instance_size: Size of state struct, in bytes.
1201 * @prepare: Prepare the work, must NOT be NULL.
1202 * @commit: Commit the changes, can be NULL.
1203 * @abort: Abort the changes on fail, can be NULL.
1204 * @clean: Clean up resources after all transaction actions have called
1205 * commit() or abort(). Can be NULL.
1206 *
1207 * Only prepare() may fail. In a single transaction, only one of commit() or
1208 * abort() will be called. clean() will always be called if it is present.
Emanuele Giuseppe Espositoebc27522022-03-03 10:15:56 -05001209 *
1210 * Always run under BQL.
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001211 */
John Snow50f43f02015-11-05 18:13:09 -05001212typedef struct BlkActionOps {
1213 size_t instance_size;
1214 void (*prepare)(BlkActionState *common, Error **errp);
1215 void (*commit)(BlkActionState *common);
1216 void (*abort)(BlkActionState *common);
1217 void (*clean)(BlkActionState *common);
1218} BlkActionOps;
1219
1220/**
1221 * BlkActionState:
1222 * Describes one Action's state within a Transaction.
1223 *
1224 * @action: QAPI-defined enum identifying which Action to perform.
1225 * @ops: Table of ActionOps this Action can perform.
John Snow94d16a62015-11-05 18:13:18 -05001226 * @block_job_txn: Transaction which this action belongs to.
John Snow50f43f02015-11-05 18:13:09 -05001227 * @entry: List membership for all Actions in this Transaction.
1228 *
1229 * This structure must be arranged as first member in a subclassed type,
1230 * assuming that the compiler will also arrange it to the same offsets as the
1231 * base class.
1232 */
1233struct BlkActionState {
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001234 TransactionAction *action;
John Snow50f43f02015-11-05 18:13:09 -05001235 const BlkActionOps *ops;
Kevin Wolf62c9e412018-04-19 16:09:52 +02001236 JobTxn *block_job_txn;
John Snow94d16a62015-11-05 18:13:18 -05001237 TransactionProperties *txn_props;
John Snowf4de0f82019-01-11 11:59:16 -06001238 QTAILQ_ENTRY(BlkActionState) entry;
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001239};
1240
Wenchao Xiabbe86012013-09-11 14:04:34 +08001241/* internal snapshot private data */
1242typedef struct InternalSnapshotState {
John Snow50f43f02015-11-05 18:13:09 -05001243 BlkActionState common;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001244 BlockDriverState *bs;
1245 QEMUSnapshotInfo sn;
Fam Zheng507306c2015-10-23 11:08:13 +08001246 bool created;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001247} InternalSnapshotState;
1248
John Snow94d16a62015-11-05 18:13:18 -05001249
1250static int action_check_completion_mode(BlkActionState *s, Error **errp)
1251{
1252 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1253 error_setg(errp,
1254 "Action '%s' does not support Transaction property "
1255 "completion-mode = %s",
Markus Armbruster977c7362017-08-24 10:46:08 +02001256 TransactionActionKind_str(s->action->type),
1257 ActionCompletionMode_str(s->txn_props->completion_mode));
John Snow94d16a62015-11-05 18:13:18 -05001258 return -1;
1259 }
1260 return 0;
1261}
1262
John Snow50f43f02015-11-05 18:13:09 -05001263static void internal_snapshot_prepare(BlkActionState *common,
Wenchao Xiabbe86012013-09-11 14:04:34 +08001264 Error **errp)
1265{
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001266 Error *local_err = NULL;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001267 const char *device;
1268 const char *name;
1269 BlockDriverState *bs;
1270 QEMUSnapshotInfo old_sn, *sn;
1271 bool ret;
Marc-André Lureauf793dde2022-03-07 11:04:00 +04001272 int64_t rt;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001273 BlockdevSnapshotInternal *internal;
1274 InternalSnapshotState *state;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001275 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001276 int ret1;
1277
Eric Blake6a8f9662015-10-26 16:34:54 -06001278 g_assert(common->action->type ==
Wenchao Xiabbe86012013-09-11 14:04:34 +08001279 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
Eric Blake32bafa82016-03-17 16:48:37 -06001280 internal = common->action->u.blockdev_snapshot_internal_sync.data;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001281 state = DO_UPCAST(InternalSnapshotState, common, common);
1282
1283 /* 1. parse input */
1284 device = internal->device;
1285 name = internal->name;
1286
1287 /* 2. check for validation */
John Snow94d16a62015-11-05 18:13:18 -05001288 if (action_check_completion_mode(common, errp) < 0) {
1289 return;
1290 }
1291
Kevin Wolf75dfd402016-06-23 14:20:24 +02001292 bs = qmp_get_root_bs(device, errp);
1293 if (!bs) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001294 return;
1295 }
1296
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001297 aio_context = bdrv_get_aio_context(bs);
1298 aio_context_acquire(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001299
Fam Zheng507306c2015-10-23 11:08:13 +08001300 state->bs = bs;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001301
1302 /* Paired with .clean() */
Fam Zheng507306c2015-10-23 11:08:13 +08001303 bdrv_drained_begin(bs);
1304
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001305 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001306 goto out;
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001307 }
1308
Wenchao Xiabbe86012013-09-11 14:04:34 +08001309 if (bdrv_is_read_only(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001310 error_setg(errp, "Device '%s' is read only", device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001311 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001312 }
1313
1314 if (!bdrv_can_snapshot(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001315 error_setg(errp, "Block format '%s' used by device '%s' "
1316 "does not support internal snapshots",
1317 bs->drv->format_name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001318 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001319 }
1320
1321 if (!strlen(name)) {
1322 error_setg(errp, "Name is empty");
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001323 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001324 }
1325
1326 /* check whether a snapshot with name exist */
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001327 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1328 &local_err);
1329 if (local_err) {
1330 error_propagate(errp, local_err);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001331 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001332 } else if (ret) {
1333 error_setg(errp,
1334 "Snapshot with name '%s' already exists on device '%s'",
1335 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001336 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001337 }
1338
1339 /* 3. take the snapshot */
1340 sn = &state->sn;
1341 pstrcpy(sn->name, sizeof(sn->name), name);
Marc-André Lureauf793dde2022-03-07 11:04:00 +04001342 rt = g_get_real_time();
1343 sn->date_sec = rt / G_USEC_PER_SEC;
1344 sn->date_nsec = (rt % G_USEC_PER_SEC) * 1000;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001345 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001346 if (replay_mode != REPLAY_MODE_NONE) {
1347 sn->icount = replay_get_current_icount();
1348 } else {
1349 sn->icount = -1ULL;
1350 }
Wenchao Xiabbe86012013-09-11 14:04:34 +08001351
1352 ret1 = bdrv_snapshot_create(bs, sn);
1353 if (ret1 < 0) {
1354 error_setg_errno(errp, -ret1,
1355 "Failed to create snapshot '%s' on device '%s'",
1356 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001357 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001358 }
1359
1360 /* 4. succeed, mark a snapshot is created */
Fam Zheng507306c2015-10-23 11:08:13 +08001361 state->created = true;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001362
1363out:
1364 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001365}
1366
John Snow50f43f02015-11-05 18:13:09 -05001367static void internal_snapshot_abort(BlkActionState *common)
Wenchao Xiabbe86012013-09-11 14:04:34 +08001368{
1369 InternalSnapshotState *state =
1370 DO_UPCAST(InternalSnapshotState, common, common);
1371 BlockDriverState *bs = state->bs;
1372 QEMUSnapshotInfo *sn = &state->sn;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001373 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001374 Error *local_error = NULL;
1375
Fam Zheng507306c2015-10-23 11:08:13 +08001376 if (!state->created) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001377 return;
1378 }
1379
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001380 aio_context = bdrv_get_aio_context(state->bs);
1381 aio_context_acquire(aio_context);
1382
Wenchao Xiabbe86012013-09-11 14:04:34 +08001383 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001384 error_reportf_err(local_error,
1385 "Failed to delete snapshot with id '%s' and "
1386 "name '%s' on device '%s' in abort: ",
1387 sn->id_str, sn->name,
1388 bdrv_get_device_name(bs));
Wenchao Xiabbe86012013-09-11 14:04:34 +08001389 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001390
1391 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001392}
1393
John Snow50f43f02015-11-05 18:13:09 -05001394static void internal_snapshot_clean(BlkActionState *common)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001395{
1396 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1397 common, common);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001398 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001399
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001400 if (!state->bs) {
1401 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001402 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001403
1404 aio_context = bdrv_get_aio_context(state->bs);
1405 aio_context_acquire(aio_context);
1406
1407 bdrv_drained_end(state->bs);
1408
1409 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001410}
1411
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001412/* external snapshot private data */
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001413typedef struct ExternalSnapshotState {
John Snow50f43f02015-11-05 18:13:09 -05001414 BlkActionState common;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001415 BlockDriverState *old_bs;
1416 BlockDriverState *new_bs;
Kevin Wolf067acf22017-03-02 15:26:18 +01001417 bool overlay_appended;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001418} ExternalSnapshotState;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001419
John Snow50f43f02015-11-05 18:13:09 -05001420static void external_snapshot_prepare(BlkActionState *common,
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001421 Error **errp)
1422{
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001423 int ret;
Max Reitz5b363932016-05-17 16:41:31 +02001424 int flags = 0;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001425 QDict *options = NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001426 Error *local_err = NULL;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001427 /* Device and node name of the image to generate the snapshot from */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001428 const char *device;
Benoît Canet0901f672014-01-23 21:31:38 +01001429 const char *node_name;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001430 /* Reference to the new image (for 'blockdev-snapshot') */
1431 const char *snapshot_ref;
1432 /* File name of the new image (for 'blockdev-snapshot-sync') */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001433 const char *new_image_file;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001434 ExternalSnapshotState *state =
1435 DO_UPCAST(ExternalSnapshotState, common, common);
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001436 TransactionAction *action = common->action;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001437 AioContext *aio_context;
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001438 uint64_t perm, shared;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001439
Alberto Garcia43de7e22015-10-26 14:27:16 +02001440 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1441 * purpose but a different set of parameters */
1442 switch (action->type) {
1443 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1444 {
Eric Blake32bafa82016-03-17 16:48:37 -06001445 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001446 device = s->node;
1447 node_name = s->node;
1448 new_image_file = NULL;
1449 snapshot_ref = s->overlay;
1450 }
1451 break;
1452 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1453 {
Eric Blake32bafa82016-03-17 16:48:37 -06001454 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001455 device = s->has_device ? s->device : NULL;
1456 node_name = s->has_node_name ? s->node_name : NULL;
1457 new_image_file = s->snapshot_file;
1458 snapshot_ref = NULL;
1459 }
1460 break;
1461 default:
1462 g_assert_not_reached();
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001463 }
1464
1465 /* start processing */
John Snow94d16a62015-11-05 18:13:18 -05001466 if (action_check_completion_mode(common, errp) < 0) {
1467 return;
1468 }
1469
Alberto Garcia43de7e22015-10-26 14:27:16 +02001470 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1471 if (!state->old_bs) {
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001472 return;
1473 }
1474
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001475 aio_context = bdrv_get_aio_context(state->old_bs);
1476 aio_context_acquire(aio_context);
1477
1478 /* Paired with .clean() */
Fam Zhengda763e82015-10-23 11:08:10 +08001479 bdrv_drained_begin(state->old_bs);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001480
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001481 if (!bdrv_is_inserted(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001482 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001483 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001484 }
1485
Fam Zheng3718d8a2014-05-23 21:29:43 +08001486 if (bdrv_op_is_blocked(state->old_bs,
1487 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001488 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001489 }
1490
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001491 if (!bdrv_is_read_only(state->old_bs)) {
1492 if (bdrv_flush(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001493 error_setg(errp, QERR_IO_ERROR);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001494 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001495 }
1496 }
1497
Alberto Garcia43de7e22015-10-26 14:27:16 +02001498 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
Eric Blake32bafa82016-03-17 16:48:37 -06001499 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001500 const char *format = s->has_format ? s->format : "qcow2";
1501 enum NewImageMode mode;
1502 const char *snapshot_node_name =
1503 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001504
Alberto Garcia43de7e22015-10-26 14:27:16 +02001505 if (node_name && !snapshot_node_name) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001506 error_setg(errp, "New overlay node-name missing");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001507 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001508 }
Alberto Garcia43de7e22015-10-26 14:27:16 +02001509
1510 if (snapshot_node_name &&
1511 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001512 error_setg(errp, "New overlay node-name already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001513 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001514 }
1515
1516 flags = state->old_bs->open_flags;
John Snow2a32c6e2017-07-17 20:34:21 -04001517 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1518 flags |= BDRV_O_NO_BACKING;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001519
1520 /* create new image w/backing file */
1521 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1522 if (mode != NEW_IMAGE_MODE_EXISTING) {
Kevin Wolff86b8b52016-03-02 12:16:44 +01001523 int64_t size = bdrv_getlength(state->old_bs);
1524 if (size < 0) {
1525 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001526 goto out;
Kevin Wolff86b8b52016-03-02 12:16:44 +01001527 }
Max Reitzf30c66b2019-02-01 20:29:05 +01001528 bdrv_refresh_filename(state->old_bs);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001529 bdrv_img_create(new_image_file, format,
1530 state->old_bs->filename,
1531 state->old_bs->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08001532 NULL, size, flags, false, &local_err);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001533 if (local_err) {
1534 error_propagate(errp, local_err);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001535 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001536 }
1537 }
1538
1539 options = qdict_new();
Peter Maydelld52e1a02018-11-01 16:30:37 +00001540 if (snapshot_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05001541 qdict_put_str(options, "node-name", snapshot_node_name);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001542 }
Eric Blake46f5ac22017-04-27 16:58:17 -05001543 qdict_put_str(options, "driver", format);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001544 }
1545
Max Reitz5b363932016-05-17 16:41:31 +02001546 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1547 errp);
Max Reitzf67503e2014-02-18 18:33:05 +01001548 /* We will manually add the backing_hd field to the bs later */
Max Reitz5b363932016-05-17 16:41:31 +02001549 if (!state->new_bs) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001550 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001551 }
1552
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001553 /*
1554 * Allow attaching a backing file to an overlay that's already in use only
1555 * if the parents don't assume that they are already seeing a valid image.
1556 * (Specifically, allow it as a mirror target, which is write-only access.)
1557 */
1558 bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1559 if (perm & BLK_PERM_CONSISTENT_READ) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001560 error_setg(errp, "The overlay is already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001561 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001562 }
1563
Max Reitz7cc734a2019-06-12 18:34:46 +02001564 if (state->new_bs->drv->is_filter) {
1565 error_setg(errp, "Filters cannot be used as overlays");
1566 goto out;
1567 }
1568
1569 if (bdrv_cow_child(state->new_bs)) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001570 error_setg(errp, "The overlay already has a backing image");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001571 goto out;
Alberto Garcia08b24cf2015-11-03 12:32:35 +02001572 }
1573
1574 if (!state->new_bs->drv->supports_backing) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001575 error_setg(errp, "The overlay does not support backing images");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001576 goto out;
Kevin Wolfb2c28322017-02-20 12:46:42 +01001577 }
1578
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001579 ret = bdrv_append(state->new_bs, state->old_bs, errp);
1580 if (ret < 0) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001581 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001582 }
Kevin Wolf067acf22017-03-02 15:26:18 +01001583 state->overlay_appended = true;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001584
1585out:
1586 aio_context_release(aio_context);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001587}
1588
John Snow50f43f02015-11-05 18:13:09 -05001589static void external_snapshot_commit(BlkActionState *common)
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001590{
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001591 ExternalSnapshotState *state =
1592 DO_UPCAST(ExternalSnapshotState, common, common);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001593 AioContext *aio_context;
1594
1595 aio_context = bdrv_get_aio_context(state->old_bs);
1596 aio_context_acquire(aio_context);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001597
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001598 /* We don't need (or want) to use the transactional
1599 * bdrv_reopen_multiple() across all the entries at once, because we
1600 * don't want to abort all of them if one of them fails the reopen */
Stefan Hajnoczid73415a2020-09-23 11:56:46 +01001601 if (!qatomic_read(&state->old_bs->copy_on_read)) {
Alberto Garcia1b577742018-11-12 16:00:39 +02001602 bdrv_reopen_set_read_only(state->old_bs, true, NULL);
Kevin Wolf4c844982016-02-29 13:12:26 +01001603 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001604
1605 aio_context_release(aio_context);
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001606}
1607
John Snow50f43f02015-11-05 18:13:09 -05001608static void external_snapshot_abort(BlkActionState *common)
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001609{
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001610 ExternalSnapshotState *state =
1611 DO_UPCAST(ExternalSnapshotState, common, common);
1612 if (state->new_bs) {
Kevin Wolf067acf22017-03-02 15:26:18 +01001613 if (state->overlay_appended) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001614 AioContext *aio_context;
Sergio Lopez377410f2020-01-08 15:31:37 +01001615 AioContext *tmp_context;
1616 int ret;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001617
1618 aio_context = bdrv_get_aio_context(state->old_bs);
1619 aio_context_acquire(aio_context);
1620
Jeff Cody719fc282017-06-07 09:55:22 -04001621 bdrv_ref(state->old_bs); /* we can't let bdrv_set_backind_hd()
1622 close state->old_bs; we need it */
1623 bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
Sergio Lopez377410f2020-01-08 15:31:37 +01001624
1625 /*
1626 * The call to bdrv_set_backing_hd() above returns state->old_bs to
1627 * the main AioContext. As we're still going to be using it, return
1628 * it to the AioContext it was before.
1629 */
1630 tmp_context = bdrv_get_aio_context(state->old_bs);
1631 if (aio_context != tmp_context) {
1632 aio_context_release(aio_context);
1633 aio_context_acquire(tmp_context);
1634
1635 ret = bdrv_try_set_aio_context(state->old_bs,
1636 aio_context, NULL);
1637 assert(ret == 0);
1638
1639 aio_context_release(tmp_context);
1640 aio_context_acquire(aio_context);
1641 }
1642
Kevin Wolf5fe31c22017-03-06 16:20:51 +01001643 bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
Jeff Cody719fc282017-06-07 09:55:22 -04001644 bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001645
1646 aio_context_release(aio_context);
Kevin Wolfb2c28322017-02-20 12:46:42 +01001647 }
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001648 }
Fam Zhengda763e82015-10-23 11:08:10 +08001649}
1650
John Snow50f43f02015-11-05 18:13:09 -05001651static void external_snapshot_clean(BlkActionState *common)
Fam Zhengda763e82015-10-23 11:08:10 +08001652{
1653 ExternalSnapshotState *state =
1654 DO_UPCAST(ExternalSnapshotState, common, common);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001655 AioContext *aio_context;
1656
1657 if (!state->old_bs) {
1658 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001659 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001660
1661 aio_context = bdrv_get_aio_context(state->old_bs);
1662 aio_context_acquire(aio_context);
1663
1664 bdrv_drained_end(state->old_bs);
1665 bdrv_unref(state->new_bs);
1666
1667 aio_context_release(aio_context);
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001668}
1669
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001670typedef struct DriveBackupState {
John Snow50f43f02015-11-05 18:13:09 -05001671 BlkActionState common;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001672 BlockDriverState *bs;
1673 BlockJob *job;
1674} DriveBackupState;
1675
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001676static BlockJob *do_backup_common(BackupCommon *backup,
1677 BlockDriverState *bs,
1678 BlockDriverState *target_bs,
1679 AioContext *aio_context,
1680 JobTxn *txn, Error **errp);
John Snow78f51fd2015-11-05 18:13:17 -05001681
John Snow50f43f02015-11-05 18:13:09 -05001682static void drive_backup_prepare(BlkActionState *common, Error **errp)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001683{
1684 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1685 DriveBackup *backup;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001686 BlockDriverState *bs;
1687 BlockDriverState *target_bs;
1688 BlockDriverState *source = NULL;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001689 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001690 AioContext *old_context;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001691 QDict *options;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001692 Error *local_err = NULL;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001693 int flags;
1694 int64_t size;
1695 bool set_backing_hd = false;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001696 int ret;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001697
Eric Blake6a8f9662015-10-26 16:34:54 -06001698 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
Eric Blake32bafa82016-03-17 16:48:37 -06001699 backup = common->action->u.drive_backup.data;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001700
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001701 if (!backup->has_mode) {
1702 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1703 }
1704
Vladimir Sementsov-Ogievskiy85c9d132019-06-18 17:08:04 +03001705 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001706 if (!bs) {
Fam Zheng1fdd4b72015-10-23 11:08:11 +08001707 return;
1708 }
1709
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001710 if (!bs->drv) {
1711 error_setg(errp, "Device has no medium");
1712 return;
1713 }
1714
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001715 aio_context = bdrv_get_aio_context(bs);
1716 aio_context_acquire(aio_context);
1717
Vladimir Sementsov-Ogievskiy2842ff22021-06-08 10:18:52 -07001718 state->bs = bs;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001719 /* Paired with .clean() */
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001720 bdrv_drained_begin(bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001721
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001722 if (!backup->has_format) {
1723 backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
1724 NULL : (char *) bs->drv->format_name;
1725 }
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001726
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001727 /* Early check to avoid creating target */
1728 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
1729 goto out;
1730 }
1731
1732 flags = bs->open_flags | BDRV_O_RDWR;
1733
1734 /*
1735 * See if we have a backing HD we can use to create our new image
1736 * on top of.
1737 */
1738 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
Max Reitz2b088c62019-06-12 17:46:45 +02001739 /*
1740 * Backup will not replace the source by the target, so none
1741 * of the filters skipped here will be removed (in contrast to
1742 * mirror). Therefore, we can skip all of them when looking
1743 * for the first COW relationship.
1744 */
1745 source = bdrv_cow_bs(bdrv_skip_filters(bs));
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001746 if (!source) {
1747 backup->sync = MIRROR_SYNC_MODE_FULL;
1748 }
1749 }
1750 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1751 source = bs;
1752 flags |= BDRV_O_NO_BACKING;
1753 set_backing_hd = true;
1754 }
1755
1756 size = bdrv_getlength(bs);
1757 if (size < 0) {
1758 error_setg_errno(errp, -size, "bdrv_getlength failed");
1759 goto out;
1760 }
1761
1762 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
1763 assert(backup->format);
1764 if (source) {
Max Reitz2b088c62019-06-12 17:46:45 +02001765 /* Implicit filters should not appear in the filename */
1766 BlockDriverState *explicit_backing =
1767 bdrv_skip_implicit_filters(source);
1768
1769 bdrv_refresh_filename(explicit_backing);
1770 bdrv_img_create(backup->target, backup->format,
1771 explicit_backing->filename,
1772 explicit_backing->drv->format_name, NULL,
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001773 size, flags, false, &local_err);
1774 } else {
1775 bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
1776 size, flags, false, &local_err);
1777 }
1778 }
1779
Markus Armbruster84d18f02014-01-30 15:07:28 +01001780 if (local_err) {
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001781 error_propagate(errp, local_err);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001782 goto out;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001783 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001784
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001785 options = qdict_new();
1786 qdict_put_str(options, "discard", "unmap");
1787 qdict_put_str(options, "detect-zeroes", "unmap");
1788 if (backup->format) {
1789 qdict_put_str(options, "driver", backup->format);
1790 }
1791
1792 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
1793 if (!target_bs) {
1794 goto out;
1795 }
1796
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001797 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
1798 old_context = bdrv_get_aio_context(target_bs);
1799 aio_context_release(aio_context);
1800 aio_context_acquire(old_context);
1801
1802 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1803 if (ret < 0) {
1804 bdrv_unref(target_bs);
1805 aio_context_release(old_context);
1806 return;
1807 }
1808
1809 aio_context_release(old_context);
1810 aio_context_acquire(aio_context);
1811
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001812 if (set_backing_hd) {
Vladimir Sementsov-Ogievskiy5a11a1c2021-02-02 15:49:46 +03001813 if (bdrv_set_backing_hd(target_bs, source, errp) < 0) {
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001814 goto unref;
1815 }
1816 }
1817
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001818 state->job = do_backup_common(qapi_DriveBackup_base(backup),
1819 bs, target_bs, aio_context,
1820 common->block_job_txn, errp);
1821
1822unref:
1823 bdrv_unref(target_bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001824out:
1825 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001826}
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001827
John Snow111049a2016-11-08 01:50:38 -05001828static void drive_backup_commit(BlkActionState *common)
1829{
1830 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001831 AioContext *aio_context;
1832
1833 aio_context = bdrv_get_aio_context(state->bs);
1834 aio_context_acquire(aio_context);
1835
John Snow111049a2016-11-08 01:50:38 -05001836 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001837 job_start(&state->job->job);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001838
1839 aio_context_release(aio_context);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001840}
1841
John Snow50f43f02015-11-05 18:13:09 -05001842static void drive_backup_abort(BlkActionState *common)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001843{
1844 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001845
John Snow111049a2016-11-08 01:50:38 -05001846 if (state->job) {
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001847 AioContext *aio_context;
1848
1849 aio_context = bdrv_get_aio_context(state->bs);
1850 aio_context_acquire(aio_context);
1851
Hanna Reitz4cfb3f02021-10-06 17:19:32 +02001852 job_cancel_sync(&state->job->job, true);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001853
1854 aio_context_release(aio_context);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001855 }
1856}
1857
John Snow50f43f02015-11-05 18:13:09 -05001858static void drive_backup_clean(BlkActionState *common)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001859{
1860 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001861 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001862
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001863 if (!state->bs) {
1864 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001865 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001866
1867 aio_context = bdrv_get_aio_context(state->bs);
1868 aio_context_acquire(aio_context);
1869
1870 bdrv_drained_end(state->bs);
1871
1872 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001873}
1874
Fam Zhengbd8baec2014-12-18 18:37:06 +08001875typedef struct BlockdevBackupState {
John Snow50f43f02015-11-05 18:13:09 -05001876 BlkActionState common;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001877 BlockDriverState *bs;
1878 BlockJob *job;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001879} BlockdevBackupState;
1880
John Snow50f43f02015-11-05 18:13:09 -05001881static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001882{
1883 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1884 BlockdevBackup *backup;
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001885 BlockDriverState *bs;
1886 BlockDriverState *target_bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001887 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001888 AioContext *old_context;
1889 int ret;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001890
Eric Blake6a8f9662015-10-26 16:34:54 -06001891 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
Eric Blake32bafa82016-03-17 16:48:37 -06001892 backup = common->action->u.blockdev_backup.data;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001893
Vladimir Sementsov-Ogievskiy930fe172018-07-02 15:46:29 -04001894 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001895 if (!bs) {
Fam Zhengff52bf32015-10-23 11:08:12 +08001896 return;
1897 }
1898
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001899 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1900 if (!target_bs) {
Fam Zhengbd8baec2014-12-18 18:37:06 +08001901 return;
1902 }
1903
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001904 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001905 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001906 old_context = bdrv_get_aio_context(target_bs);
1907 aio_context_acquire(old_context);
1908
1909 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1910 if (ret < 0) {
1911 aio_context_release(old_context);
1912 return;
1913 }
1914
1915 aio_context_release(old_context);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001916 aio_context_acquire(aio_context);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001917 state->bs = bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001918
1919 /* Paired with .clean() */
Fam Zhengff52bf32015-10-23 11:08:12 +08001920 bdrv_drained_begin(state->bs);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001921
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001922 state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1923 bs, target_bs, aio_context,
1924 common->block_job_txn, errp);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001925
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001926 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001927}
Fam Zhengbd8baec2014-12-18 18:37:06 +08001928
John Snow111049a2016-11-08 01:50:38 -05001929static void blockdev_backup_commit(BlkActionState *common)
1930{
1931 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001932 AioContext *aio_context;
1933
1934 aio_context = bdrv_get_aio_context(state->bs);
1935 aio_context_acquire(aio_context);
1936
John Snow111049a2016-11-08 01:50:38 -05001937 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001938 job_start(&state->job->job);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001939
1940 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001941}
1942
John Snow50f43f02015-11-05 18:13:09 -05001943static void blockdev_backup_abort(BlkActionState *common)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001944{
1945 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001946
John Snow111049a2016-11-08 01:50:38 -05001947 if (state->job) {
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001948 AioContext *aio_context;
1949
1950 aio_context = bdrv_get_aio_context(state->bs);
1951 aio_context_acquire(aio_context);
1952
Hanna Reitz4cfb3f02021-10-06 17:19:32 +02001953 job_cancel_sync(&state->job->job, true);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001954
1955 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001956 }
1957}
1958
John Snow50f43f02015-11-05 18:13:09 -05001959static void blockdev_backup_clean(BlkActionState *common)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001960{
1961 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001962 AioContext *aio_context;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001963
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001964 if (!state->bs) {
1965 return;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001966 }
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001967
1968 aio_context = bdrv_get_aio_context(state->bs);
1969 aio_context_acquire(aio_context);
1970
1971 bdrv_drained_end(state->bs);
1972
1973 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001974}
1975
Fam Zhengdf9a6812015-11-09 18:16:54 +08001976typedef struct BlockDirtyBitmapState {
John Snow50f43f02015-11-05 18:13:09 -05001977 BlkActionState common;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001978 BdrvDirtyBitmap *bitmap;
1979 BlockDriverState *bs;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001980 HBitmap *backup;
1981 bool prepared;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001982 bool was_enabled;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001983} BlockDirtyBitmapState;
1984
John Snow50f43f02015-11-05 18:13:09 -05001985static void block_dirty_bitmap_add_prepare(BlkActionState *common,
Fam Zhengdf9a6812015-11-09 18:16:54 +08001986 Error **errp)
1987{
1988 Error *local_err = NULL;
1989 BlockDirtyBitmapAdd *action;
1990 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1991 common, common);
1992
John Snow94d16a62015-11-05 18:13:18 -05001993 if (action_check_completion_mode(common, errp) < 0) {
1994 return;
1995 }
1996
Eric Blake32bafa82016-03-17 16:48:37 -06001997 action = common->action->u.block_dirty_bitmap_add.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001998 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1999 qmp_block_dirty_bitmap_add(action->node, action->name,
2000 action->has_granularity, action->granularity,
Vladimir Sementsov-Ogievskiyfd5ae4c2017-06-28 15:05:23 +03002001 action->has_persistent, action->persistent,
John Snow0e2b7f02018-12-21 04:35:22 -05002002 action->has_disabled, action->disabled,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002003 &local_err);
2004
2005 if (!local_err) {
2006 state->prepared = true;
2007 } else {
2008 error_propagate(errp, local_err);
2009 }
2010}
2011
John Snow50f43f02015-11-05 18:13:09 -05002012static void block_dirty_bitmap_add_abort(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002013{
2014 BlockDirtyBitmapAdd *action;
2015 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2016 common, common);
2017
Eric Blake32bafa82016-03-17 16:48:37 -06002018 action = common->action->u.block_dirty_bitmap_add.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002019 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2020 * then the node reference and bitmap name must have been valid.
2021 */
2022 if (state->prepared) {
2023 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2024 }
2025}
2026
John Snow50f43f02015-11-05 18:13:09 -05002027static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002028 Error **errp)
2029{
2030 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2031 common, common);
2032 BlockDirtyBitmap *action;
2033
John Snow94d16a62015-11-05 18:13:18 -05002034 if (action_check_completion_mode(common, errp) < 0) {
2035 return;
2036 }
2037
Eric Blake32bafa82016-03-17 16:48:37 -06002038 action = common->action->u.block_dirty_bitmap_clear.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002039 state->bitmap = block_dirty_bitmap_lookup(action->node,
2040 action->name,
2041 &state->bs,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002042 errp);
2043 if (!state->bitmap) {
2044 return;
2045 }
2046
John Snow3ae96d62019-03-12 12:05:49 -04002047 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
Vladimir Sementsov-Ogievskiyd6883bc2017-06-28 15:05:10 +03002048 return;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002049 }
2050
2051 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
Fam Zhengdf9a6812015-11-09 18:16:54 +08002052}
2053
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002054static void block_dirty_bitmap_restore(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002055{
2056 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2057 common, common);
2058
John Snow184dd9c2017-03-15 17:28:11 -04002059 if (state->backup) {
Vladimir Sementsov-Ogievskiy56bd6622018-10-29 16:23:14 -04002060 bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
John Snow184dd9c2017-03-15 17:28:11 -04002061 }
Fam Zhengdf9a6812015-11-09 18:16:54 +08002062}
2063
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002064static void block_dirty_bitmap_free_backup(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002065{
2066 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2067 common, common);
2068
2069 hbitmap_free(state->backup);
2070}
2071
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002072static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2073 Error **errp)
2074{
2075 BlockDirtyBitmap *action;
2076 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2077 common, common);
2078
2079 if (action_check_completion_mode(common, errp) < 0) {
2080 return;
2081 }
2082
John Snow0e2b7f02018-12-21 04:35:22 -05002083 action = common->action->u.block_dirty_bitmap_enable.data;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002084 state->bitmap = block_dirty_bitmap_lookup(action->node,
2085 action->name,
2086 NULL,
2087 errp);
2088 if (!state->bitmap) {
2089 return;
2090 }
2091
John Snow3ae96d62019-03-12 12:05:49 -04002092 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04002093 return;
2094 }
2095
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002096 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2097 bdrv_enable_dirty_bitmap(state->bitmap);
2098}
2099
2100static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2101{
2102 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2103 common, common);
2104
2105 if (!state->was_enabled) {
2106 bdrv_disable_dirty_bitmap(state->bitmap);
2107 }
2108}
2109
2110static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2111 Error **errp)
2112{
2113 BlockDirtyBitmap *action;
2114 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2115 common, common);
2116
2117 if (action_check_completion_mode(common, errp) < 0) {
2118 return;
2119 }
2120
John Snow0e2b7f02018-12-21 04:35:22 -05002121 action = common->action->u.block_dirty_bitmap_disable.data;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002122 state->bitmap = block_dirty_bitmap_lookup(action->node,
2123 action->name,
2124 NULL,
2125 errp);
2126 if (!state->bitmap) {
2127 return;
2128 }
2129
John Snow3ae96d62019-03-12 12:05:49 -04002130 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04002131 return;
2132 }
2133
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002134 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2135 bdrv_disable_dirty_bitmap(state->bitmap);
2136}
2137
2138static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2139{
2140 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2141 common, common);
2142
2143 if (state->was_enabled) {
2144 bdrv_enable_dirty_bitmap(state->bitmap);
2145 }
2146}
2147
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002148static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2149 Error **errp)
2150{
2151 BlockDirtyBitmapMerge *action;
2152 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2153 common, common);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002154
2155 if (action_check_completion_mode(common, errp) < 0) {
2156 return;
2157 }
2158
John Snow0e2b7f02018-12-21 04:35:22 -05002159 action = common->action->u.block_dirty_bitmap_merge.data;
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002160
Eric Blakec6996cf2020-05-12 20:16:43 -05002161 state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2162 action->bitmaps, &state->backup,
2163 errp);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002164}
2165
John Snowc4e4b0f2019-07-29 16:35:54 -04002166static void block_dirty_bitmap_remove_prepare(BlkActionState *common,
2167 Error **errp)
2168{
2169 BlockDirtyBitmap *action;
2170 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2171 common, common);
2172
2173 if (action_check_completion_mode(common, errp) < 0) {
2174 return;
2175 }
2176
2177 action = common->action->u.block_dirty_bitmap_remove.data;
2178
Eric Blakec6996cf2020-05-12 20:16:43 -05002179 state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2180 false, &state->bs, errp);
John Snowc4e4b0f2019-07-29 16:35:54 -04002181 if (state->bitmap) {
2182 bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2183 bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2184 }
2185}
2186
2187static void block_dirty_bitmap_remove_abort(BlkActionState *common)
2188{
2189 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2190 common, common);
2191
2192 if (state->bitmap) {
2193 bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2194 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2195 }
2196}
2197
2198static void block_dirty_bitmap_remove_commit(BlkActionState *common)
2199{
2200 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2201 common, common);
2202
2203 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
Vladimir Sementsov-Ogievskiy5deb6cb2019-09-16 17:19:09 +03002204 bdrv_release_dirty_bitmap(state->bitmap);
John Snowc4e4b0f2019-07-29 16:35:54 -04002205}
2206
John Snow50f43f02015-11-05 18:13:09 -05002207static void abort_prepare(BlkActionState *common, Error **errp)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002208{
2209 error_setg(errp, "Transaction aborted using Abort action");
2210}
2211
John Snow50f43f02015-11-05 18:13:09 -05002212static void abort_commit(BlkActionState *common)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002213{
Stefan Weildfc6f862013-07-25 18:21:28 +02002214 g_assert_not_reached(); /* this action never succeeds */
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002215}
2216
John Snow50f43f02015-11-05 18:13:09 -05002217static const BlkActionOps actions[] = {
Alberto Garcia43de7e22015-10-26 14:27:16 +02002218 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2219 .instance_size = sizeof(ExternalSnapshotState),
2220 .prepare = external_snapshot_prepare,
2221 .commit = external_snapshot_commit,
2222 .abort = external_snapshot_abort,
Alberto Garcia4ad6f3d2015-11-13 15:00:24 +02002223 .clean = external_snapshot_clean,
Alberto Garcia43de7e22015-10-26 14:27:16 +02002224 },
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002225 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002226 .instance_size = sizeof(ExternalSnapshotState),
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002227 .prepare = external_snapshot_prepare,
2228 .commit = external_snapshot_commit,
2229 .abort = external_snapshot_abort,
Fam Zhengda763e82015-10-23 11:08:10 +08002230 .clean = external_snapshot_clean,
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002231 },
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002232 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2233 .instance_size = sizeof(DriveBackupState),
2234 .prepare = drive_backup_prepare,
John Snow111049a2016-11-08 01:50:38 -05002235 .commit = drive_backup_commit,
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002236 .abort = drive_backup_abort,
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00002237 .clean = drive_backup_clean,
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002238 },
Fam Zhengbd8baec2014-12-18 18:37:06 +08002239 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2240 .instance_size = sizeof(BlockdevBackupState),
2241 .prepare = blockdev_backup_prepare,
John Snow111049a2016-11-08 01:50:38 -05002242 .commit = blockdev_backup_commit,
Fam Zhengbd8baec2014-12-18 18:37:06 +08002243 .abort = blockdev_backup_abort,
2244 .clean = blockdev_backup_clean,
2245 },
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002246 [TRANSACTION_ACTION_KIND_ABORT] = {
John Snow50f43f02015-11-05 18:13:09 -05002247 .instance_size = sizeof(BlkActionState),
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002248 .prepare = abort_prepare,
2249 .commit = abort_commit,
2250 },
Wenchao Xiabbe86012013-09-11 14:04:34 +08002251 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2252 .instance_size = sizeof(InternalSnapshotState),
2253 .prepare = internal_snapshot_prepare,
2254 .abort = internal_snapshot_abort,
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00002255 .clean = internal_snapshot_clean,
Wenchao Xiabbe86012013-09-11 14:04:34 +08002256 },
Fam Zhengdf9a6812015-11-09 18:16:54 +08002257 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2258 .instance_size = sizeof(BlockDirtyBitmapState),
2259 .prepare = block_dirty_bitmap_add_prepare,
2260 .abort = block_dirty_bitmap_add_abort,
2261 },
2262 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2263 .instance_size = sizeof(BlockDirtyBitmapState),
2264 .prepare = block_dirty_bitmap_clear_prepare,
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002265 .commit = block_dirty_bitmap_free_backup,
2266 .abort = block_dirty_bitmap_restore,
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002267 },
John Snow0e2b7f02018-12-21 04:35:22 -05002268 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002269 .instance_size = sizeof(BlockDirtyBitmapState),
2270 .prepare = block_dirty_bitmap_enable_prepare,
2271 .abort = block_dirty_bitmap_enable_abort,
2272 },
John Snow0e2b7f02018-12-21 04:35:22 -05002273 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002274 .instance_size = sizeof(BlockDirtyBitmapState),
2275 .prepare = block_dirty_bitmap_disable_prepare,
2276 .abort = block_dirty_bitmap_disable_abort,
John Snow66da04d2018-09-06 09:02:25 -04002277 },
John Snow0e2b7f02018-12-21 04:35:22 -05002278 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002279 .instance_size = sizeof(BlockDirtyBitmapState),
2280 .prepare = block_dirty_bitmap_merge_prepare,
2281 .commit = block_dirty_bitmap_free_backup,
2282 .abort = block_dirty_bitmap_restore,
2283 },
John Snowc4e4b0f2019-07-29 16:35:54 -04002284 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE] = {
2285 .instance_size = sizeof(BlockDirtyBitmapState),
2286 .prepare = block_dirty_bitmap_remove_prepare,
2287 .commit = block_dirty_bitmap_remove_commit,
2288 .abort = block_dirty_bitmap_remove_abort,
2289 },
John Snow66da04d2018-09-06 09:02:25 -04002290 /* Where are transactions for MIRROR, COMMIT and STREAM?
2291 * Although these blockjobs use transaction callbacks like the backup job,
2292 * these jobs do not necessarily adhere to transaction semantics.
2293 * These jobs may not fully undo all of their actions on abort, nor do they
2294 * necessarily work in transactions with more than one job in them.
2295 */
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002296};
2297
John Snow94d16a62015-11-05 18:13:18 -05002298/**
2299 * Allocate a TransactionProperties structure if necessary, and fill
2300 * that structure with desired defaults if they are unset.
2301 */
2302static TransactionProperties *get_transaction_properties(
2303 TransactionProperties *props)
2304{
2305 if (!props) {
2306 props = g_new0(TransactionProperties, 1);
2307 }
2308
2309 if (!props->has_completion_mode) {
2310 props->has_completion_mode = true;
2311 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2312 }
2313
2314 return props;
2315}
2316
Jeff Cody8802d1f2012-02-28 15:54:06 -05002317/*
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002318 * 'Atomic' group operations. The operations are performed as a set, and if
2319 * any fail then we roll back all operations in the group.
Emanuele Giuseppe Espositoebc27522022-03-03 10:15:56 -05002320 *
2321 * Always run under BQL.
Jeff Cody8802d1f2012-02-28 15:54:06 -05002322 */
John Snow94d16a62015-11-05 18:13:18 -05002323void qmp_transaction(TransactionActionList *dev_list,
2324 bool has_props,
2325 struct TransactionProperties *props,
2326 Error **errp)
Jeff Cody8802d1f2012-02-28 15:54:06 -05002327{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002328 TransactionActionList *dev_entry = dev_list;
Kevin Wolf62c9e412018-04-19 16:09:52 +02002329 JobTxn *block_job_txn = NULL;
John Snow50f43f02015-11-05 18:13:09 -05002330 BlkActionState *state, *next;
Luiz Capitulino43e17042012-11-30 10:52:07 -02002331 Error *local_err = NULL;
Jeff Cody8802d1f2012-02-28 15:54:06 -05002332
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05002333 GLOBAL_STATE_CODE();
2334
John Snowf4de0f82019-01-11 11:59:16 -06002335 QTAILQ_HEAD(, BlkActionState) snap_bdrv_states;
2336 QTAILQ_INIT(&snap_bdrv_states);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002337
John Snow94d16a62015-11-05 18:13:18 -05002338 /* Does this transaction get canceled as a group on failure?
Kevin Wolf62c9e412018-04-19 16:09:52 +02002339 * If not, we don't really need to make a JobTxn.
John Snow94d16a62015-11-05 18:13:18 -05002340 */
2341 props = get_transaction_properties(props);
2342 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002343 block_job_txn = job_txn_new();
John Snow94d16a62015-11-05 18:13:18 -05002344 }
2345
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002346 /* drain all i/o before any operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002347 bdrv_drain_all();
2348
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002349 /* We don't do anything in this loop that commits us to the operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002350 while (NULL != dev_entry) {
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002351 TransactionAction *dev_info = NULL;
John Snow50f43f02015-11-05 18:13:09 -05002352 const BlkActionOps *ops;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002353
Jeff Cody8802d1f2012-02-28 15:54:06 -05002354 dev_info = dev_entry->value;
2355 dev_entry = dev_entry->next;
2356
Eric Blake6a8f9662015-10-26 16:34:54 -06002357 assert(dev_info->type < ARRAY_SIZE(actions));
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002358
Eric Blake6a8f9662015-10-26 16:34:54 -06002359 ops = &actions[dev_info->type];
Max Reitzaa3fe712013-09-12 14:57:27 +02002360 assert(ops->instance_size > 0);
2361
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002362 state = g_malloc0(ops->instance_size);
2363 state->ops = ops;
2364 state->action = dev_info;
John Snow94d16a62015-11-05 18:13:18 -05002365 state->block_job_txn = block_job_txn;
2366 state->txn_props = props;
John Snowf4de0f82019-01-11 11:59:16 -06002367 QTAILQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002368
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002369 state->ops->prepare(state, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002370 if (local_err) {
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002371 error_propagate(errp, local_err);
2372 goto delete_and_fail;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002373 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002374 }
2375
John Snowf4de0f82019-01-11 11:59:16 -06002376 QTAILQ_FOREACH(state, &snap_bdrv_states, entry) {
Stefan Hajnoczif9ea81e2013-06-24 17:13:16 +02002377 if (state->ops->commit) {
2378 state->ops->commit(state);
2379 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002380 }
2381
2382 /* success */
2383 goto exit;
2384
2385delete_and_fail:
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002386 /* failure, and it is all-or-none; roll back all operations */
John Snowf4de0f82019-01-11 11:59:16 -06002387 QTAILQ_FOREACH_REVERSE(state, &snap_bdrv_states, entry) {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002388 if (state->ops->abort) {
2389 state->ops->abort(state);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002390 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002391 }
2392exit:
John Snowf4de0f82019-01-11 11:59:16 -06002393 QTAILQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002394 if (state->ops->clean) {
2395 state->ops->clean(state);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002396 }
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002397 g_free(state);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002398 }
John Snow94d16a62015-11-05 18:13:18 -05002399 if (!has_props) {
2400 qapi_free_TransactionProperties(props);
2401 }
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002402 job_txn_unref(block_job_txn);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002403}
2404
Vladimir Sementsov-Ogievskiya3b52532017-06-28 15:05:25 +03002405BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2406 const char *name,
2407 Error **errp)
2408{
2409 BdrvDirtyBitmap *bitmap;
2410 BlockDriverState *bs;
2411 BlockDirtyBitmapSha256 *ret = NULL;
2412 char *sha256;
2413
2414 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2415 if (!bitmap || !bs) {
2416 return NULL;
2417 }
2418
2419 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2420 if (sha256 == NULL) {
2421 return NULL;
2422 }
2423
2424 ret = g_new(BlockDirtyBitmapSha256, 1);
2425 ret->sha256 = sha256;
2426
2427 return ret;
2428}
2429
Kevin Wolfeb94b812020-10-05 17:58:55 +02002430void coroutine_fn qmp_block_resize(bool has_device, const char *device,
2431 bool has_node_name, const char *node_name,
2432 int64_t size, Error **errp)
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002433{
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002434 Error *local_err = NULL;
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002435 BlockBackend *blk;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002436 BlockDriverState *bs;
Kevin Wolfeb94b812020-10-05 17:58:55 +02002437 AioContext *old_ctx;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002438
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002439 bs = bdrv_lookup_bs(has_device ? device : NULL,
2440 has_node_name ? node_name : NULL,
2441 &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002442 if (local_err) {
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002443 error_propagate(errp, local_err);
2444 return;
2445 }
2446
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002447 if (size < 0) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002448 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002449 return;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002450 }
2451
Jeff Cody9c75e162014-06-25 16:55:30 -04002452 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002453 error_setg(errp, QERR_DEVICE_IN_USE, device);
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002454 return;
Jeff Cody9c75e162014-06-25 16:55:30 -04002455 }
2456
Eric Blakea3aeeab2020-04-28 14:26:46 -05002457 blk = blk_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
2458 if (!blk) {
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002459 return;
Kevin Wolfd7086422017-01-13 19:02:32 +01002460 }
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002461
Kevin Wolf8089eab2020-12-03 18:23:10 +01002462 bdrv_co_lock(bs);
John Snow698bdfa2017-05-10 13:39:45 -04002463 bdrv_drained_begin(bs);
Kevin Wolf8089eab2020-12-03 18:23:10 +01002464 bdrv_co_unlock(bs);
2465
Kevin Wolfeb94b812020-10-05 17:58:55 +02002466 old_ctx = bdrv_co_enter(bs);
Eric Blakea3aeeab2020-04-28 14:26:46 -05002467 blk_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002468 bdrv_co_leave(bs, old_ctx);
Stefan Hajnoczi927e0e72014-08-18 14:52:28 +01002469
Kevin Wolfeb94b812020-10-05 17:58:55 +02002470 bdrv_co_lock(bs);
Kevin Wolf8089eab2020-12-03 18:23:10 +01002471 bdrv_drained_end(bs);
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002472 blk_unref(blk);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002473 bdrv_co_unlock(bs);
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002474}
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002475
Alberto Garcia23233222016-07-05 17:28:59 +03002476void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002477 bool has_base, const char *base,
Alberto Garcia312fe092016-10-28 10:08:19 +03002478 bool has_base_node, const char *base_node,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002479 bool has_backing_file, const char *backing_file,
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002480 bool has_bottom, const char *bottom,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002481 bool has_speed, int64_t speed,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002482 bool has_on_error, BlockdevOnError on_error,
Andrey Shinkevich880747a2020-12-16 09:16:54 +03002483 bool has_filter_node_name, const char *filter_node_name,
John Snow241ca1a2018-09-06 09:02:23 -04002484 bool has_auto_finalize, bool auto_finalize,
2485 bool has_auto_dismiss, bool auto_dismiss,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002486 Error **errp)
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002487{
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002488 BlockDriverState *bs, *iter, *iter_end;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002489 BlockDriverState *base_bs = NULL;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002490 BlockDriverState *bottom_bs = NULL;
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002491 AioContext *aio_context;
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002492 Error *local_err = NULL;
John Snowcf6320d2018-09-06 09:02:12 -04002493 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002494
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002495 if (has_base && has_base_node) {
2496 error_setg(errp, "'base' and 'base-node' cannot be specified "
2497 "at the same time");
2498 return;
2499 }
2500
2501 if (has_base && has_bottom) {
2502 error_setg(errp, "'base' and 'bottom' cannot be specified "
2503 "at the same time");
2504 return;
2505 }
2506
2507 if (has_bottom && has_base_node) {
2508 error_setg(errp, "'bottom' and 'base-node' cannot be specified "
2509 "at the same time");
2510 return;
2511 }
2512
Paolo Bonzini1d809092012-09-28 17:22:59 +02002513 if (!has_on_error) {
2514 on_error = BLOCKDEV_ON_ERROR_REPORT;
2515 }
2516
Alberto Garcia554b6142016-10-28 10:08:11 +03002517 bs = bdrv_lookup_bs(device, device, errp);
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002518 if (!bs) {
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002519 return;
2520 }
2521
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002522 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002523 aio_context_acquire(aio_context);
2524
Jeff Cody13d8cc52014-06-25 15:40:11 -04002525 if (has_base) {
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002526 base_bs = bdrv_find_backing_image(bs, base);
2527 if (base_bs == NULL) {
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002528 error_setg(errp, "Can't find '%s' in the backing chain", base);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002529 goto out;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002530 }
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002531 assert(bdrv_get_aio_context(base_bs) == aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002532 }
2533
Alberto Garcia312fe092016-10-28 10:08:19 +03002534 if (has_base_node) {
2535 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2536 if (!base_bs) {
2537 goto out;
2538 }
2539 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2540 error_setg(errp, "Node '%s' is not a backing image of '%s'",
2541 base_node, device);
2542 goto out;
2543 }
2544 assert(bdrv_get_aio_context(base_bs) == aio_context);
Max Reitzf30c66b2019-02-01 20:29:05 +01002545 bdrv_refresh_filename(base_bs);
Alberto Garcia312fe092016-10-28 10:08:19 +03002546 }
2547
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002548 if (has_bottom) {
2549 bottom_bs = bdrv_lookup_bs(NULL, bottom, errp);
2550 if (!bottom_bs) {
2551 goto out;
2552 }
2553 if (!bottom_bs->drv) {
2554 error_setg(errp, "Node '%s' is not open", bottom);
2555 goto out;
2556 }
2557 if (bottom_bs->drv->is_filter) {
2558 error_setg(errp, "Node '%s' is a filter, use a non-filter node "
2559 "as 'bottom'", bottom);
2560 goto out;
2561 }
2562 if (!bdrv_chain_contains(bs, bottom_bs)) {
2563 error_setg(errp, "Node '%s' is not in a chain starting from '%s'",
2564 bottom, device);
2565 goto out;
2566 }
2567 assert(bdrv_get_aio_context(bottom_bs) == aio_context);
2568 }
2569
2570 /*
2571 * Check for op blockers in the whole chain between bs and base (or bottom)
2572 */
2573 iter_end = has_bottom ? bdrv_filter_or_cow_bs(bottom_bs) : base_bs;
2574 for (iter = bs; iter && iter != iter_end;
Max Reitz67acfd22019-06-12 17:48:11 +02002575 iter = bdrv_filter_or_cow_bs(iter))
2576 {
Alberto Garcia554b6142016-10-28 10:08:11 +03002577 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
2578 goto out;
2579 }
2580 }
2581
Jeff Cody13d8cc52014-06-25 15:40:11 -04002582 /* if we are streaming the entire chain, the result will have no backing
2583 * file, and specifying one is therefore an error */
2584 if (base_bs == NULL && has_backing_file) {
2585 error_setg(errp, "backing file specified, but streaming the "
2586 "entire chain");
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002587 goto out;
Jeff Cody13d8cc52014-06-25 15:40:11 -04002588 }
2589
John Snow241ca1a2018-09-06 09:02:23 -04002590 if (has_auto_finalize && !auto_finalize) {
2591 job_flags |= JOB_MANUAL_FINALIZE;
2592 }
2593 if (has_auto_dismiss && !auto_dismiss) {
2594 job_flags |= JOB_MANUAL_DISMISS;
2595 }
2596
Andrey Shinkevich000e5a12020-12-16 09:16:59 +03002597 stream_start(has_job_id ? job_id : NULL, bs, base_bs, backing_file,
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002598 bottom_bs, job_flags, has_speed ? speed : 0, on_error,
Andrey Shinkevich880747a2020-12-16 09:16:54 +03002599 filter_node_name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002600 if (local_err) {
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002601 error_propagate(errp, local_err);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002602 goto out;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002603 }
2604
Vladimir Sementsov-Ogievskiyb23c5802019-06-06 18:41:32 +03002605 trace_qmp_block_stream(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002606
2607out:
2608 aio_context_release(aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002609}
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00002610
Alberto Garciafd62c602016-07-05 17:29:00 +03002611void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
Kevin Wolf3c605f42017-06-27 17:18:20 +02002612 bool has_base_node, const char *base_node,
Jeff Cody7676e2c2014-06-30 15:14:15 +02002613 bool has_base, const char *base,
Kevin Wolf3c605f42017-06-27 17:18:20 +02002614 bool has_top_node, const char *top_node,
Jeff Cody7676e2c2014-06-30 15:14:15 +02002615 bool has_top, const char *top,
Jeff Cody54e26902014-06-25 15:40:10 -04002616 bool has_backing_file, const char *backing_file,
Jeff Codyed61fc12012-09-27 13:29:16 -04002617 bool has_speed, int64_t speed,
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002618 bool has_on_error, BlockdevOnError on_error,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002619 bool has_filter_node_name, const char *filter_node_name,
John Snow96fbf532018-09-06 09:02:21 -04002620 bool has_auto_finalize, bool auto_finalize,
2621 bool has_auto_dismiss, bool auto_dismiss,
Jeff Codyed61fc12012-09-27 13:29:16 -04002622 Error **errp)
2623{
2624 BlockDriverState *bs;
Alberto Garcia058223a2016-10-28 10:08:07 +03002625 BlockDriverState *iter;
Jeff Codyed61fc12012-09-27 13:29:16 -04002626 BlockDriverState *base_bs, *top_bs;
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002627 AioContext *aio_context;
Jeff Codyed61fc12012-09-27 13:29:16 -04002628 Error *local_err = NULL;
John Snow53607822018-09-06 09:02:10 -04002629 int job_flags = JOB_DEFAULT;
Max Reitz05ea3852019-06-11 21:19:26 +02002630 uint64_t top_perm, top_shared;
Jeff Codyed61fc12012-09-27 13:29:16 -04002631
Max Reitz54504662014-04-10 19:36:25 +02002632 if (!has_speed) {
2633 speed = 0;
2634 }
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002635 if (!has_on_error) {
2636 on_error = BLOCKDEV_ON_ERROR_REPORT;
2637 }
Kevin Wolf0db832f2017-02-20 18:10:05 +01002638 if (!has_filter_node_name) {
2639 filter_node_name = NULL;
2640 }
John Snow96fbf532018-09-06 09:02:21 -04002641 if (has_auto_finalize && !auto_finalize) {
2642 job_flags |= JOB_MANUAL_FINALIZE;
2643 }
2644 if (has_auto_dismiss && !auto_dismiss) {
2645 job_flags |= JOB_MANUAL_DISMISS;
2646 }
Max Reitz54504662014-04-10 19:36:25 +02002647
Jeff Cody7676e2c2014-06-30 15:14:15 +02002648 /* Important Note:
2649 * libvirt relies on the DeviceNotFound error class in order to probe for
2650 * live commit feature versions; for this to work, we must make sure to
2651 * perform the device lookup before any generic errors that may occur in a
2652 * scenario in which all optional arguments are omitted. */
Kevin Wolf1d13b162016-06-23 14:20:24 +02002653 bs = qmp_get_root_bs(device, &local_err);
2654 if (!bs) {
2655 bs = bdrv_lookup_bs(device, device, NULL);
2656 if (!bs) {
2657 error_free(local_err);
2658 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2659 "Device '%s' not found", device);
2660 } else {
2661 error_propagate(errp, local_err);
2662 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002663 return;
2664 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002665
Kevin Wolf1d13b162016-06-23 14:20:24 +02002666 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002667 aio_context_acquire(aio_context);
2668
Fam Zhengbb000212014-09-11 13:14:00 +08002669 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002670 goto out;
Fam Zheng628ff682014-05-23 21:29:44 +08002671 }
2672
Jeff Codyed61fc12012-09-27 13:29:16 -04002673 /* default top_bs is the active layer */
2674 top_bs = bs;
2675
Kevin Wolf3c605f42017-06-27 17:18:20 +02002676 if (has_top_node && has_top) {
2677 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
2678 goto out;
2679 } else if (has_top_node) {
2680 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2681 if (top_bs == NULL) {
2682 goto out;
2683 }
2684 if (!bdrv_chain_contains(bs, top_bs)) {
2685 error_setg(errp, "'%s' is not in this backing file chain",
2686 top_node);
2687 goto out;
2688 }
2689 } else if (has_top && top) {
Max Reitzf30c66b2019-02-01 20:29:05 +01002690 /* This strcmp() is just a shortcut, there is no need to
2691 * refresh @bs's filename. If it mismatches,
2692 * bdrv_find_backing_image() will do the refresh and may still
2693 * return @bs. */
Jeff Codyed61fc12012-09-27 13:29:16 -04002694 if (strcmp(bs->filename, top) != 0) {
2695 top_bs = bdrv_find_backing_image(bs, top);
2696 }
2697 }
2698
2699 if (top_bs == NULL) {
2700 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002701 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002702 }
2703
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002704 assert(bdrv_get_aio_context(top_bs) == aio_context);
2705
Kevin Wolf3c605f42017-06-27 17:18:20 +02002706 if (has_base_node && has_base) {
2707 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
2708 goto out;
2709 } else if (has_base_node) {
2710 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2711 if (base_bs == NULL) {
2712 goto out;
2713 }
2714 if (!bdrv_chain_contains(top_bs, base_bs)) {
2715 error_setg(errp, "'%s' is not in this backing file chain",
2716 base_node);
2717 goto out;
2718 }
2719 } else if (has_base && base) {
Jeff Codyd5208c42012-10-16 15:49:10 -04002720 base_bs = bdrv_find_backing_image(top_bs, base);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002721 if (base_bs == NULL) {
2722 error_setg(errp, "Can't find '%s' in the backing chain", base);
2723 goto out;
2724 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002725 } else {
2726 base_bs = bdrv_find_base(top_bs);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002727 if (base_bs == NULL) {
2728 error_setg(errp, "There is no backimg image");
2729 goto out;
2730 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002731 }
2732
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002733 assert(bdrv_get_aio_context(base_bs) == aio_context);
2734
Max Reitz9a71b9d2019-06-12 17:47:37 +02002735 for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2736 iter = bdrv_filter_or_cow_bs(iter))
2737 {
Alberto Garcia058223a2016-10-28 10:08:07 +03002738 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2739 goto out;
2740 }
Fam Zhengbb000212014-09-11 13:14:00 +08002741 }
2742
Jeff Cody7676e2c2014-06-30 15:14:15 +02002743 /* Do not allow attempts to commit an image into itself */
2744 if (top_bs == base_bs) {
2745 error_setg(errp, "cannot commit an image into itself");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002746 goto out;
Jeff Cody7676e2c2014-06-30 15:14:15 +02002747 }
2748
Max Reitz05ea3852019-06-11 21:19:26 +02002749 /*
2750 * Active commit is required if and only if someone has taken a
2751 * WRITE permission on the top node. Historically, we have always
2752 * used active commit for top nodes, so continue that practice
2753 * lest we possibly break clients that rely on this behavior, e.g.
2754 * to later attach this node to a writing parent.
2755 * (Active commit is never really wrong.)
2756 */
2757 bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2758 if (top_perm & BLK_PERM_WRITE ||
2759 bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2760 {
Jeff Cody54e26902014-06-25 15:40:10 -04002761 if (has_backing_file) {
Max Reitz05ea3852019-06-11 21:19:26 +02002762 if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2763 error_setg(errp, "'backing-file' specified,"
2764 " but 'top' is the active layer");
2765 } else {
2766 error_setg(errp, "'backing-file' specified, but 'top' has a "
2767 "writer on it");
2768 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002769 goto out;
Jeff Cody54e26902014-06-25 15:40:10 -04002770 }
Max Reitz05ea3852019-06-11 21:19:26 +02002771 if (!has_job_id) {
2772 /*
2773 * Emulate here what block_job_create() does, because it
2774 * is possible that @bs != @top_bs (the block job should
2775 * be named after @bs, even if @top_bs is the actual
2776 * source)
2777 */
2778 job_id = bdrv_get_device_name(bs);
2779 }
2780 commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
Fam Zheng78bbd912017-04-21 20:27:04 +08002781 filter_node_name, NULL, NULL, false, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002782 } else {
Alberto Garcia058223a2016-10-28 10:08:07 +03002783 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2784 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2785 goto out;
2786 }
John Snow53607822018-09-06 09:02:10 -04002787 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
2788 speed, on_error, has_backing_file ? backing_file : NULL,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002789 filter_node_name, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002790 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002791 if (local_err != NULL) {
2792 error_propagate(errp, local_err);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002793 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002794 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002795
2796out:
2797 aio_context_release(aio_context);
Jeff Codyed61fc12012-09-27 13:29:16 -04002798}
2799
John Snow7b0b8702019-07-29 16:35:52 -04002800/* Common QMP interface for drive-backup and blockdev-backup */
2801static BlockJob *do_backup_common(BackupCommon *backup,
2802 BlockDriverState *bs,
2803 BlockDriverState *target_bs,
2804 AioContext *aio_context,
2805 JobTxn *txn, Error **errp)
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002806{
John Snow111049a2016-11-08 01:50:38 -05002807 BlockJob *job = NULL;
John Snowd58d8452015-04-17 19:49:58 -04002808 BdrvDirtyBitmap *bmap = NULL;
Vladimir Sementsov-Ogievskiy6a30f662021-01-17 00:47:00 +03002809 BackupPerf perf = { .max_workers = 64 };
John Snow7b0b8702019-07-29 16:35:52 -04002810 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002811
Pavel Butsykin81206a82016-07-22 11:17:50 +03002812 if (!backup->has_speed) {
2813 backup->speed = 0;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002814 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002815 if (!backup->has_on_source_error) {
2816 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002817 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002818 if (!backup->has_on_target_error) {
2819 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002820 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002821 if (!backup->has_job_id) {
2822 backup->job_id = NULL;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002823 }
John Snowb40dacd2018-03-10 03:27:44 -05002824 if (!backup->has_auto_finalize) {
2825 backup->auto_finalize = true;
2826 }
2827 if (!backup->has_auto_dismiss) {
2828 backup->auto_dismiss = true;
2829 }
Pavel Butsykin13b94142016-07-22 11:17:52 +03002830 if (!backup->has_compress) {
2831 backup->compress = false;
2832 }
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002833
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002834 if (backup->x_perf) {
2835 if (backup->x_perf->has_use_copy_range) {
2836 perf.use_copy_range = backup->x_perf->use_copy_range;
2837 }
Vladimir Sementsov-Ogievskiy2c59fd82021-01-17 00:46:52 +03002838 if (backup->x_perf->has_max_workers) {
2839 perf.max_workers = backup->x_perf->max_workers;
2840 }
2841 if (backup->x_perf->has_max_chunk) {
2842 perf.max_chunk = backup->x_perf->max_chunk;
2843 }
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002844 }
2845
John Snowa6c93652019-07-29 16:35:55 -04002846 if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2847 (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2848 /* done before desugaring 'incremental' to print the right message */
2849 if (!backup->has_bitmap) {
2850 error_setg(errp, "must provide a valid bitmap name for "
2851 "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2852 return NULL;
2853 }
2854 }
2855
John Snowc8b56502019-07-29 16:35:52 -04002856 if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2857 if (backup->has_bitmap_mode &&
2858 backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2859 error_setg(errp, "Bitmap sync mode must be '%s' "
2860 "when using sync mode '%s'",
2861 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2862 MirrorSyncMode_str(backup->sync));
2863 return NULL;
2864 }
2865 backup->has_bitmap_mode = true;
2866 backup->sync = MIRROR_SYNC_MODE_BITMAP;
2867 backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2868 }
2869
John Snow7b0b8702019-07-29 16:35:52 -04002870 if (backup->has_bitmap) {
2871 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2872 if (!bmap) {
2873 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2874 return NULL;
2875 }
John Snowc8b56502019-07-29 16:35:52 -04002876 if (!backup->has_bitmap_mode) {
2877 error_setg(errp, "Bitmap sync mode must be given "
2878 "when providing a bitmap");
2879 return NULL;
2880 }
John Snowb30ffbe2019-07-29 16:35:54 -04002881 if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snow7b0b8702019-07-29 16:35:52 -04002882 return NULL;
2883 }
John Snow1a2b8b42019-07-29 16:35:55 -04002884
2885 /* This does not produce a useful bitmap artifact: */
2886 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2887 error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2888 " outputs", MirrorSyncMode_str(backup->sync));
2889 return NULL;
2890 }
2891
2892 /* If the bitmap isn't used for input or output, this is useless: */
2893 if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2894 backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2895 error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2896 " when combined with sync mode '%s'",
2897 BitmapSyncMode_str(backup->bitmap_mode),
2898 MirrorSyncMode_str(backup->sync));
2899 return NULL;
2900 }
2901 }
2902
2903 if (!backup->has_bitmap && backup->has_bitmap_mode) {
2904 error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2905 return NULL;
John Snow7b0b8702019-07-29 16:35:52 -04002906 }
2907
2908 if (!backup->auto_finalize) {
2909 job_flags |= JOB_MANUAL_FINALIZE;
2910 }
2911 if (!backup->auto_dismiss) {
2912 job_flags |= JOB_MANUAL_DISMISS;
2913 }
2914
2915 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
John Snowc8b56502019-07-29 16:35:52 -04002916 backup->sync, bmap, backup->bitmap_mode,
2917 backup->compress,
Vladimir Sementsov-Ogievskiy00e30f02019-10-01 16:14:09 +03002918 backup->filter_node_name,
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002919 &perf,
John Snowc8b56502019-07-29 16:35:52 -04002920 backup->on_source_error,
2921 backup->on_target_error,
John Snow7b0b8702019-07-29 16:35:52 -04002922 job_flags, NULL, NULL, txn, errp);
2923 return job;
2924}
2925
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002926void qmp_drive_backup(DriveBackup *backup, Error **errp)
John Snow7b0b8702019-07-29 16:35:52 -04002927{
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002928 TransactionAction action = {
2929 .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2930 .u.drive_backup.data = backup,
2931 };
2932 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002933}
2934
Peter Krempafacda542020-01-20 09:50:49 +01002935BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2936 bool flat,
2937 Error **errp)
Benoît Canetc13163f2014-01-23 21:31:34 +01002938{
Peter Krempafacda542020-01-20 09:50:49 +01002939 bool return_flat = has_flat && flat;
2940
2941 return bdrv_named_nodes_list(return_flat, errp);
Benoît Canetc13163f2014-01-23 21:31:34 +01002942}
2943
Vladimir Sementsov-Ogievskiy5d3b4e92018-12-21 20:09:07 +03002944XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2945{
2946 return bdrv_get_xdbg_block_graph(errp);
2947}
2948
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002949void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
Fam Zhengc29c1dd2014-12-18 18:37:05 +08002950{
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002951 TransactionAction action = {
2952 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2953 .u.blockdev_backup.data = backup,
2954 };
2955 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002956}
2957
Fam Zheng4193cdd2015-12-24 12:45:03 +08002958/* Parameter check and block job starting for drive mirroring.
2959 * Caller should hold @device and @target's aio context (must be the same).
2960 **/
Alberto Garcia71aa9862016-07-05 17:28:57 +03002961static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002962 BlockDriverState *target,
2963 bool has_replaces, const char *replaces,
2964 enum MirrorSyncMode sync,
Max Reitz274fcce2016-06-10 20:57:47 +02002965 BlockMirrorBackingMode backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02002966 bool zero_target,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002967 bool has_speed, int64_t speed,
2968 bool has_granularity, uint32_t granularity,
2969 bool has_buf_size, int64_t buf_size,
2970 bool has_on_source_error,
2971 BlockdevOnError on_source_error,
2972 bool has_on_target_error,
2973 BlockdevOnError on_target_error,
2974 bool has_unmap, bool unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002975 bool has_filter_node_name,
2976 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02002977 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04002978 bool has_auto_finalize, bool auto_finalize,
2979 bool has_auto_dismiss, bool auto_dismiss,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002980 Error **errp)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002981{
Max Reitz3f072a72019-06-12 16:27:32 +02002982 BlockDriverState *unfiltered_bs;
John Snowa1999b32018-09-06 09:02:11 -04002983 int job_flags = JOB_DEFAULT;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002984
2985 if (!has_speed) {
2986 speed = 0;
2987 }
Paolo Bonzinib952b552012-10-18 16:49:28 +02002988 if (!has_on_source_error) {
2989 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2990 }
2991 if (!has_on_target_error) {
2992 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2993 }
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002994 if (!has_granularity) {
2995 granularity = 0;
2996 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002997 if (!has_buf_size) {
Wen Congyang48ac0a42015-05-15 15:51:36 +08002998 buf_size = 0;
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002999 }
Fam Zheng0fc9f8e2015-06-08 13:56:08 +08003000 if (!has_unmap) {
3001 unmap = true;
3002 }
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003003 if (!has_filter_node_name) {
3004 filter_node_name = NULL;
3005 }
Max Reitz481deba2018-06-13 20:18:22 +02003006 if (!has_copy_mode) {
3007 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
3008 }
John Snowa6b58ad2018-09-06 09:02:22 -04003009 if (has_auto_finalize && !auto_finalize) {
3010 job_flags |= JOB_MANUAL_FINALIZE;
3011 }
3012 if (has_auto_dismiss && !auto_dismiss) {
3013 job_flags |= JOB_MANUAL_DISMISS;
3014 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01003015
Paolo Bonzinieee13df2013-01-21 17:09:46 +01003016 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01003017 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3018 "a value in range [512B, 64MB]");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01003019 return;
3020 }
3021 if (granularity & (granularity - 1)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01003022 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
Markus Armbruster6cc06672020-11-13 09:26:26 +01003023 "a power of 2");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01003024 return;
3025 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003026
Fam Zheng4193cdd2015-12-24 12:45:03 +08003027 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3028 return;
3029 }
Fam Zhenge40e5022015-12-24 12:45:04 +08003030 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3031 return;
3032 }
Fam Zheng4193cdd2015-12-24 12:45:03 +08003033
Max Reitz3f072a72019-06-12 16:27:32 +02003034 if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
Fam Zheng4193cdd2015-12-24 12:45:03 +08003035 sync = MIRROR_SYNC_MODE_FULL;
3036 }
3037
Max Reitz3f072a72019-06-12 16:27:32 +02003038 if (!has_replaces) {
3039 /* We want to mirror from @bs, but keep implicit filters on top */
3040 unfiltered_bs = bdrv_skip_implicit_filters(bs);
3041 if (unfiltered_bs != bs) {
3042 replaces = unfiltered_bs->node_name;
3043 has_replaces = true;
3044 }
3045 }
3046
Max Reitz74ce9e42019-02-13 23:53:01 +01003047 if (has_replaces) {
3048 BlockDriverState *to_replace_bs;
3049 AioContext *replace_aio_context;
3050 int64_t bs_size, replace_size;
3051
3052 bs_size = bdrv_getlength(bs);
3053 if (bs_size < 0) {
3054 error_setg_errno(errp, -bs_size, "Failed to query device's size");
3055 return;
3056 }
3057
3058 to_replace_bs = check_to_replace_node(bs, replaces, errp);
3059 if (!to_replace_bs) {
3060 return;
3061 }
3062
3063 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3064 aio_context_acquire(replace_aio_context);
3065 replace_size = bdrv_getlength(to_replace_bs);
3066 aio_context_release(replace_aio_context);
3067
3068 if (replace_size < 0) {
3069 error_setg_errno(errp, -replace_size,
3070 "Failed to query the replacement node's size");
3071 return;
3072 }
3073 if (bs_size != replace_size) {
3074 error_setg(errp, "cannot replace image with a mirror image of "
3075 "different size");
3076 return;
3077 }
3078 }
3079
Fam Zheng4193cdd2015-12-24 12:45:03 +08003080 /* pass the node name to replace to mirror start since it's loose coupling
3081 * and will allow to check whether the node still exist at mirror completion
3082 */
Alberto Garcia71aa9862016-07-05 17:28:57 +03003083 mirror_start(job_id, bs, target,
John Snowa1999b32018-09-06 09:02:11 -04003084 has_replaces ? replaces : NULL, job_flags,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003085 speed, granularity, buf_size, sync, backing_mode, zero_target,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003086 on_source_error, on_target_error, unmap, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003087 copy_mode, errp);
Fam Zheng4193cdd2015-12-24 12:45:03 +08003088}
3089
Eric Blakefaecd402016-07-14 16:37:58 -06003090void qmp_drive_mirror(DriveMirror *arg, Error **errp)
Fam Zheng4193cdd2015-12-24 12:45:03 +08003091{
3092 BlockDriverState *bs;
Max Reitz3f072a72019-06-12 16:27:32 +02003093 BlockDriverState *target_backing_bs, *target_bs;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003094 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003095 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003096 BlockMirrorBackingMode backing_mode;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003097 Error *local_err = NULL;
3098 QDict *options = NULL;
3099 int flags;
3100 int64_t size;
Eric Blakefaecd402016-07-14 16:37:58 -06003101 const char *format = arg->format;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003102 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003103 int ret;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003104
Kevin Wolf0524e932016-06-23 14:20:24 +02003105 bs = qmp_get_root_bs(arg->device, errp);
3106 if (!bs) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003107 return;
3108 }
3109
Paolo Bonzinicb2af912018-02-07 17:29:20 +01003110 /* Early check to avoid creating target */
3111 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3112 return;
3113 }
3114
Kevin Wolf0524e932016-06-23 14:20:24 +02003115 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003116 aio_context_acquire(aio_context);
3117
Eric Blakefaecd402016-07-14 16:37:58 -06003118 if (!arg->has_mode) {
3119 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003120 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003121
Eric Blakefaecd402016-07-14 16:37:58 -06003122 if (!arg->has_format) {
3123 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3124 ? NULL : bs->drv->format_name);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003125 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003126
Kevin Wolf61de4c62016-03-18 17:46:45 +01003127 flags = bs->open_flags | BDRV_O_RDWR;
Max Reitz3f072a72019-06-12 16:27:32 +02003128 target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
3129 if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
Eric Blakefaecd402016-07-14 16:37:58 -06003130 arg->sync = MIRROR_SYNC_MODE_FULL;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003131 }
Eric Blakefaecd402016-07-14 16:37:58 -06003132 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
Max Reitz3f072a72019-06-12 16:27:32 +02003133 target_backing_bs = bs;
Max Reitz117e0c82013-11-25 20:28:55 +01003134 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003135
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003136 size = bdrv_getlength(bs);
3137 if (size < 0) {
3138 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003139 goto out;
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003140 }
3141
Eric Blakefaecd402016-07-14 16:37:58 -06003142 if (arg->has_replaces) {
Eric Blakefaecd402016-07-14 16:37:58 -06003143 if (!arg->has_node_name) {
Benoît Canet09158f02014-06-27 18:25:25 +02003144 error_setg(errp, "a node-name must be provided when replacing a"
3145 " named node of the graph");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003146 goto out;
Benoît Canet09158f02014-06-27 18:25:25 +02003147 }
Benoît Canet09158f02014-06-27 18:25:25 +02003148 }
3149
Eric Blakefaecd402016-07-14 16:37:58 -06003150 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
Max Reitz274fcce2016-06-10 20:57:47 +02003151 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3152 } else {
3153 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3154 }
3155
John Snow2a32c6e2017-07-17 20:34:21 -04003156 /* Don't open backing image in create() */
3157 flags |= BDRV_O_NO_BACKING;
3158
Max Reitz3f072a72019-06-12 16:27:32 +02003159 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
Eric Blakefaecd402016-07-14 16:37:58 -06003160 && arg->mode != NEW_IMAGE_MODE_EXISTING)
Max Reitz14526862013-11-06 19:50:44 +01003161 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003162 /* create new image w/o backing file */
Max Reitze6641712015-08-26 19:47:48 +02003163 assert(format);
Eric Blakefaecd402016-07-14 16:37:58 -06003164 bdrv_img_create(arg->target, format,
Fam Zheng92172832017-04-21 20:27:01 +08003165 NULL, NULL, NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003166 } else {
Max Reitz3f072a72019-06-12 16:27:32 +02003167 /* Implicit filters should not appear in the filename */
3168 BlockDriverState *explicit_backing =
3169 bdrv_skip_implicit_filters(target_backing_bs);
3170
Eric Blakefaecd402016-07-14 16:37:58 -06003171 switch (arg->mode) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003172 case NEW_IMAGE_MODE_EXISTING:
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003173 break;
3174 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3175 /* create new image with backing file */
Max Reitz3f072a72019-06-12 16:27:32 +02003176 bdrv_refresh_filename(explicit_backing);
Eric Blakefaecd402016-07-14 16:37:58 -06003177 bdrv_img_create(arg->target, format,
Max Reitz3f072a72019-06-12 16:27:32 +02003178 explicit_backing->filename,
3179 explicit_backing->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08003180 NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003181 break;
3182 default:
3183 abort();
3184 }
3185 }
3186
Markus Armbruster84d18f02014-01-30 15:07:28 +01003187 if (local_err) {
Luiz Capitulinocf8f2422012-11-30 10:52:08 -02003188 error_propagate(errp, local_err);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003189 goto out;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003190 }
3191
Max Reitze6641712015-08-26 19:47:48 +02003192 options = qdict_new();
Eric Blakefaecd402016-07-14 16:37:58 -06003193 if (arg->has_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003194 qdict_put_str(options, "node-name", arg->node_name);
Benoît Canet4c828dc2014-06-16 12:00:55 +02003195 }
Max Reitze6641712015-08-26 19:47:48 +02003196 if (format) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003197 qdict_put_str(options, "driver", format);
Max Reitze6641712015-08-26 19:47:48 +02003198 }
Benoît Canet4c828dc2014-06-16 12:00:55 +02003199
Paolo Bonzinib812f672013-01-21 17:09:43 +01003200 /* Mirroring takes care of copy-on-write using the source's backing
3201 * file.
3202 */
John Snow2a32c6e2017-07-17 20:34:21 -04003203 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
Max Reitz5b363932016-05-17 16:41:31 +02003204 if (!target_bs) {
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003205 goto out;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003206 }
3207
Max Reitzcdf3bc92019-07-24 19:12:30 +02003208 zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3209 (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3210 !bdrv_has_zero_init(target_bs)));
3211
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003212
3213 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3214 old_context = bdrv_get_aio_context(target_bs);
3215 aio_context_release(aio_context);
3216 aio_context_acquire(old_context);
3217
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003218 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3219 if (ret < 0) {
3220 bdrv_unref(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003221 aio_context_release(old_context);
3222 return;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003223 }
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003224
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003225 aio_context_release(old_context);
3226 aio_context_acquire(aio_context);
3227
Eric Blakefaecd402016-07-14 16:37:58 -06003228 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3229 arg->has_replaces, arg->replaces, arg->sync,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003230 backing_mode, zero_target,
3231 arg->has_speed, arg->speed,
Eric Blakefaecd402016-07-14 16:37:58 -06003232 arg->has_granularity, arg->granularity,
3233 arg->has_buf_size, arg->buf_size,
3234 arg->has_on_source_error, arg->on_source_error,
3235 arg->has_on_target_error, arg->on_target_error,
3236 arg->has_unmap, arg->unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003237 false, NULL,
Max Reitz481deba2018-06-13 20:18:22 +02003238 arg->has_copy_mode, arg->copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003239 arg->has_auto_finalize, arg->auto_finalize,
3240 arg->has_auto_dismiss, arg->auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003241 errp);
Kevin Wolfe253f4b2016-04-12 16:17:41 +02003242 bdrv_unref(target_bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003243out:
3244 aio_context_release(aio_context);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003245}
3246
Alberto Garcia71aa9862016-07-05 17:28:57 +03003247void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3248 const char *device, const char *target,
Fam Zhengdf925622015-12-24 12:45:05 +08003249 bool has_replaces, const char *replaces,
3250 MirrorSyncMode sync,
3251 bool has_speed, int64_t speed,
3252 bool has_granularity, uint32_t granularity,
3253 bool has_buf_size, int64_t buf_size,
3254 bool has_on_source_error,
3255 BlockdevOnError on_source_error,
3256 bool has_on_target_error,
3257 BlockdevOnError on_target_error,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003258 bool has_filter_node_name,
3259 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003260 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003261 bool has_auto_finalize, bool auto_finalize,
3262 bool has_auto_dismiss, bool auto_dismiss,
Fam Zhengdf925622015-12-24 12:45:05 +08003263 Error **errp)
3264{
3265 BlockDriverState *bs;
Fam Zhengdf925622015-12-24 12:45:05 +08003266 BlockDriverState *target_bs;
3267 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003268 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003269 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003270 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003271 int ret;
Fam Zhengdf925622015-12-24 12:45:05 +08003272
Kevin Wolf07eec652016-06-23 14:20:24 +02003273 bs = qmp_get_root_bs(device, errp);
Fam Zhengdf925622015-12-24 12:45:05 +08003274 if (!bs) {
Fam Zhengdf925622015-12-24 12:45:05 +08003275 return;
3276 }
3277
3278 target_bs = bdrv_lookup_bs(target, target, errp);
3279 if (!target_bs) {
3280 return;
3281 }
3282
Max Reitzcdf3bc92019-07-24 19:12:30 +02003283 zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3284
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003285 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3286 old_context = bdrv_get_aio_context(target_bs);
Fam Zhengdf925622015-12-24 12:45:05 +08003287 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003288 aio_context_acquire(old_context);
Fam Zhengdf925622015-12-24 12:45:05 +08003289
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003290 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003291
3292 aio_context_release(old_context);
3293 aio_context_acquire(aio_context);
3294
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003295 if (ret < 0) {
3296 goto out;
3297 }
Fam Zhengdf925622015-12-24 12:45:05 +08003298
Alberto Garcia71aa9862016-07-05 17:28:57 +03003299 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
Max Reitz274fcce2016-06-10 20:57:47 +02003300 has_replaces, replaces, sync, backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003301 zero_target, has_speed, speed,
Fam Zhengdf925622015-12-24 12:45:05 +08003302 has_granularity, granularity,
3303 has_buf_size, buf_size,
3304 has_on_source_error, on_source_error,
3305 has_on_target_error, on_target_error,
3306 true, true,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003307 has_filter_node_name, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003308 has_copy_mode, copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003309 has_auto_finalize, auto_finalize,
3310 has_auto_dismiss, auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003311 errp);
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003312out:
Fam Zhengdf925622015-12-24 12:45:05 +08003313 aio_context_release(aio_context);
3314}
3315
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003316/* Get a block job using its ID and acquire its AioContext */
3317static BlockJob *find_block_job(const char *id, AioContext **aio_context,
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003318 Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003319{
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003320 BlockJob *job;
3321
3322 assert(id != NULL);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003323
Max Reitz5433c242015-10-19 17:53:29 +02003324 *aio_context = NULL;
3325
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003326 job = block_job_get(id);
3327
3328 if (!job) {
3329 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3330 "Block job '%s' not found", id);
3331 return NULL;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003332 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003333
Vladimir Sementsov-Ogievskiydf9a3162021-05-06 17:13:53 +03003334 *aio_context = block_job_get_aio_context(job);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003335 aio_context_acquire(*aio_context);
3336
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003337 return job;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003338}
3339
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003340void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003341{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003342 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003343 BlockJob *job = find_block_job(device, &aio_context, errp);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003344
3345 if (!job) {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003346 return;
3347 }
3348
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003349 block_job_set_speed(job, speed, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003350 aio_context_release(aio_context);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003351}
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003352
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003353void qmp_block_job_cancel(const char *device,
3354 bool has_force, bool force, Error **errp)
3355{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003356 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003357 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003358
3359 if (!job) {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003360 return;
3361 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003362
3363 if (!has_force) {
3364 force = false;
3365 }
3366
Kevin Wolfb15de822018-04-18 17:10:26 +02003367 if (job_user_paused(&job->job) && !force) {
Cole Robinsonf231b882014-03-21 19:42:26 -04003368 error_setg(errp, "The block job for device '%s' is currently paused",
3369 device);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003370 goto out;
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003371 }
3372
3373 trace_qmp_block_job_cancel(job);
Kevin Wolf3d70ff52018-04-24 16:13:52 +02003374 job_user_cancel(&job->job, force, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003375out:
3376 aio_context_release(aio_context);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003377}
3378
3379void qmp_block_job_pause(const char *device, Error **errp)
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003380{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003381 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003382 BlockJob *job = find_block_job(device, &aio_context, errp);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003383
John Snow0ec4dfb2018-03-10 03:27:32 -05003384 if (!job) {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003385 return;
3386 }
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003387
3388 trace_qmp_block_job_pause(job);
Kevin Wolfb15de822018-04-18 17:10:26 +02003389 job_user_pause(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003390 aio_context_release(aio_context);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003391}
3392
3393void qmp_block_job_resume(const char *device, Error **errp)
3394{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003395 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003396 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003397
John Snow0ec4dfb2018-03-10 03:27:32 -05003398 if (!job) {
Paolo Bonzini8acc72a2012-09-28 17:22:50 +02003399 return;
3400 }
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003401
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003402 trace_qmp_block_job_resume(job);
Kevin Wolfb15de822018-04-18 17:10:26 +02003403 job_user_resume(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003404 aio_context_release(aio_context);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003405}
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003406
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003407void qmp_block_job_complete(const char *device, Error **errp)
3408{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003409 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003410 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003411
3412 if (!job) {
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003413 return;
3414 }
3415
3416 trace_qmp_block_job_complete(job);
Kevin Wolf3453d972018-04-23 12:24:16 +02003417 job_complete(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003418 aio_context_release(aio_context);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003419}
3420
John Snow11b61fb2018-03-10 03:27:43 -05003421void qmp_block_job_finalize(const char *id, Error **errp)
3422{
3423 AioContext *aio_context;
3424 BlockJob *job = find_block_job(id, &aio_context, errp);
3425
3426 if (!job) {
3427 return;
3428 }
3429
3430 trace_qmp_block_job_finalize(job);
Stefan Reiterb660a842020-04-07 13:56:49 +02003431 job_ref(&job->job);
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02003432 job_finalize(&job->job, errp);
Stefan Reiterb660a842020-04-07 13:56:49 +02003433
3434 /*
3435 * Job's context might have changed via job_finalize (and job_txn_apply
3436 * automatically acquires the new one), so make sure we release the correct
3437 * one.
3438 */
Vladimir Sementsov-Ogievskiydf9a3162021-05-06 17:13:53 +03003439 aio_context = block_job_get_aio_context(job);
Stefan Reiterb660a842020-04-07 13:56:49 +02003440 job_unref(&job->job);
John Snow11b61fb2018-03-10 03:27:43 -05003441 aio_context_release(aio_context);
3442}
3443
John Snow75f71052018-03-10 03:27:36 -05003444void qmp_block_job_dismiss(const char *id, Error **errp)
3445{
3446 AioContext *aio_context;
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003447 BlockJob *bjob = find_block_job(id, &aio_context, errp);
3448 Job *job;
John Snow75f71052018-03-10 03:27:36 -05003449
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003450 if (!bjob) {
John Snow75f71052018-03-10 03:27:36 -05003451 return;
3452 }
3453
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003454 trace_qmp_block_job_dismiss(bjob);
3455 job = &bjob->job;
3456 job_dismiss(&job, errp);
John Snow75f71052018-03-10 03:27:36 -05003457 aio_context_release(aio_context);
3458}
3459
Jeff Codyfa40e652014-07-01 09:52:16 +02003460void qmp_change_backing_file(const char *device,
3461 const char *image_node_name,
3462 const char *backing_file,
3463 Error **errp)
3464{
3465 BlockDriverState *bs = NULL;
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003466 AioContext *aio_context;
Jeff Codyfa40e652014-07-01 09:52:16 +02003467 BlockDriverState *image_bs = NULL;
3468 Error *local_err = NULL;
3469 bool ro;
Jeff Codyfa40e652014-07-01 09:52:16 +02003470 int ret;
3471
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003472 bs = qmp_get_root_bs(device, errp);
3473 if (!bs) {
Jeff Codyfa40e652014-07-01 09:52:16 +02003474 return;
3475 }
3476
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003477 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003478 aio_context_acquire(aio_context);
3479
Jeff Codyfa40e652014-07-01 09:52:16 +02003480 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3481 if (local_err) {
3482 error_propagate(errp, local_err);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003483 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003484 }
3485
3486 if (!image_bs) {
3487 error_setg(errp, "image file not found");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003488 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003489 }
3490
3491 if (bdrv_find_base(image_bs) == image_bs) {
3492 error_setg(errp, "not allowing backing file change on an image "
3493 "without a backing file");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003494 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003495 }
3496
3497 /* even though we are not necessarily operating on bs, we need it to
3498 * determine if block ops are currently prohibited on the chain */
3499 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003500 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003501 }
3502
3503 /* final sanity check */
3504 if (!bdrv_chain_contains(bs, image_bs)) {
3505 error_setg(errp, "'%s' and image file are not in the same chain",
3506 device);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003507 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003508 }
3509
3510 /* if not r/w, reopen to make r/w */
Jeff Codyfa40e652014-07-01 09:52:16 +02003511 ro = bdrv_is_read_only(image_bs);
3512
3513 if (ro) {
Alberto Garcia051a60f2018-11-12 16:00:38 +02003514 if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003515 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003516 }
3517 }
3518
3519 ret = bdrv_change_backing_file(image_bs, backing_file,
Eric Blakee54ee1b2020-07-06 15:39:53 -05003520 image_bs->drv ? image_bs->drv->format_name : "",
3521 false);
Jeff Codyfa40e652014-07-01 09:52:16 +02003522
3523 if (ret < 0) {
3524 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3525 backing_file);
3526 /* don't exit here, so we can try to restore open flags if
3527 * appropriate */
3528 }
3529
3530 if (ro) {
Markus Armbruster992861f2020-07-07 18:06:04 +02003531 bdrv_reopen_set_read_only(image_bs, true, errp);
Jeff Codyfa40e652014-07-01 09:52:16 +02003532 }
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003533
3534out:
3535 aio_context_release(aio_context);
Jeff Codyfa40e652014-07-01 09:52:16 +02003536}
3537
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003538void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3539{
Max Reitzbe4b67b2015-10-19 17:53:09 +02003540 BlockDriverState *bs;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003541 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01003542 Visitor *v = qobject_output_visitor_new(&obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003543 QDict *qdict;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003544
Markus Armbruster1f584242020-04-24 10:43:35 +02003545 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
Eric Blake3b098d52016-06-09 10:48:43 -06003546 visit_complete(v, &obj);
Max Reitz7dc847e2018-02-24 16:40:29 +01003547 qdict = qobject_to(QDict, obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003548
3549 qdict_flatten(qdict);
3550
Kevin Wolf9ec88732016-09-21 14:56:11 +02003551 if (!qdict_get_try_str(qdict, "node-name")) {
3552 error_setg(errp, "'node-name' must be specified for the root node");
3553 goto fail;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003554 }
3555
Kevin Wolf9ec88732016-09-21 14:56:11 +02003556 bs = bds_tree_init(qdict, errp);
3557 if (!bs) {
3558 goto fail;
3559 }
3560
Maxim Levitsky89802d52020-03-08 11:24:40 +02003561 bdrv_set_monitor_owned(bs);
Kevin Wolf9ec88732016-09-21 14:56:11 +02003562
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003563fail:
Eric Blake3b098d52016-06-09 10:48:43 -06003564 visit_free(v);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003565}
3566
Alberto Garciae60edf62021-07-08 13:47:09 +02003567void qmp_blockdev_reopen(BlockdevOptionsList *reopen_list, Error **errp)
Alberto Garcia1479c732019-03-12 18:48:51 +02003568{
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003569 BlockReopenQueue *queue = NULL;
3570 GSList *drained = NULL;
Kevin Wolfaba82052022-02-03 15:05:33 +01003571 GSList *p;
Alberto Garcia1479c732019-03-12 18:48:51 +02003572
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003573 /* Add each one of the BDS that we want to reopen to the queue */
3574 for (; reopen_list != NULL; reopen_list = reopen_list->next) {
3575 BlockdevOptions *options = reopen_list->value;
3576 BlockDriverState *bs;
3577 AioContext *ctx;
3578 QObject *obj;
3579 Visitor *v;
3580 QDict *qdict;
3581
3582 /* Check for the selected node name */
3583 if (!options->has_node_name) {
3584 error_setg(errp, "node-name not specified");
3585 goto fail;
3586 }
3587
3588 bs = bdrv_find_node(options->node_name);
3589 if (!bs) {
3590 error_setg(errp, "Failed to find node with node-name='%s'",
3591 options->node_name);
3592 goto fail;
3593 }
3594
3595 /* Put all options in a QDict and flatten it */
3596 v = qobject_output_visitor_new(&obj);
3597 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3598 visit_complete(v, &obj);
3599 visit_free(v);
3600
3601 qdict = qobject_to(QDict, obj);
3602
3603 qdict_flatten(qdict);
3604
3605 ctx = bdrv_get_aio_context(bs);
3606 aio_context_acquire(ctx);
3607
3608 bdrv_subtree_drained_begin(bs);
3609 queue = bdrv_reopen_queue(queue, bs, qdict, false);
3610 drained = g_slist_prepend(drained, bs);
3611
3612 aio_context_release(ctx);
Alberto Garcia1479c732019-03-12 18:48:51 +02003613 }
3614
Alberto Garcia1479c732019-03-12 18:48:51 +02003615 /* Perform the reopen operation */
Alberto Garcia1479c732019-03-12 18:48:51 +02003616 bdrv_reopen_multiple(queue, errp);
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003617 queue = NULL;
Alberto Garcia1479c732019-03-12 18:48:51 +02003618
3619fail:
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003620 bdrv_reopen_queue_free(queue);
Kevin Wolfaba82052022-02-03 15:05:33 +01003621 for (p = drained; p; p = p->next) {
3622 BlockDriverState *bs = p->data;
3623 AioContext *ctx = bdrv_get_aio_context(bs);
3624
3625 aio_context_acquire(ctx);
3626 bdrv_subtree_drained_end(bs);
3627 aio_context_release(ctx);
3628 }
3629 g_slist_free(drained);
Alberto Garcia1479c732019-03-12 18:48:51 +02003630}
3631
Markus Armbruster79b7a772017-03-21 17:53:28 +01003632void qmp_blockdev_del(const char *node_name, Error **errp)
Alberto Garcia81b936a2015-11-02 16:51:55 +02003633{
3634 AioContext *aio_context;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003635 BlockDriverState *bs;
3636
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05003637 GLOBAL_STATE_CODE();
3638
Kevin Wolf9ec88732016-09-21 14:56:11 +02003639 bs = bdrv_find_node(node_name);
3640 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003641 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003642 return;
3643 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003644 if (bdrv_has_blk(bs)) {
3645 error_setg(errp, "Node %s is in use", node_name);
3646 return;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003647 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003648 aio_context = bdrv_get_aio_context(bs);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003649 aio_context_acquire(aio_context);
3650
Kevin Wolf9ec88732016-09-21 14:56:11 +02003651 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3652 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003653 }
3654
Paolo Bonzini70537ed2018-12-06 23:00:09 +01003655 if (!QTAILQ_IN_USE(bs, monitor_list)) {
Kevin Wolf9ec88732016-09-21 14:56:11 +02003656 error_setg(errp, "Node %s is not owned by the monitor",
3657 bs->node_name);
3658 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003659 }
3660
Kevin Wolf9ec88732016-09-21 14:56:11 +02003661 if (bs->refcnt > 1) {
3662 error_setg(errp, "Block device %s is in use",
3663 bdrv_get_device_or_node_name(bs));
3664 goto out;
3665 }
3666
3667 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3668 bdrv_unref(bs);
3669
Alberto Garcia81b936a2015-11-02 16:51:55 +02003670out:
3671 aio_context_release(aio_context);
3672}
3673
Wen Congyang7f821592016-05-10 15:36:39 +08003674static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3675 const char *child_name)
3676{
3677 BdrvChild *child;
3678
3679 QLIST_FOREACH(child, &parent_bs->children, next) {
3680 if (strcmp(child->name, child_name) == 0) {
3681 return child;
3682 }
3683 }
3684
3685 return NULL;
3686}
3687
3688void qmp_x_blockdev_change(const char *parent, bool has_child,
3689 const char *child, bool has_node,
3690 const char *node, Error **errp)
3691{
3692 BlockDriverState *parent_bs, *new_bs = NULL;
3693 BdrvChild *p_child;
3694
3695 parent_bs = bdrv_lookup_bs(parent, parent, errp);
3696 if (!parent_bs) {
3697 return;
3698 }
3699
3700 if (has_child == has_node) {
3701 if (has_child) {
3702 error_setg(errp, "The parameters child and node are in conflict");
3703 } else {
3704 error_setg(errp, "Either child or node must be specified");
3705 }
3706 return;
3707 }
3708
3709 if (has_child) {
3710 p_child = bdrv_find_child(parent_bs, child);
3711 if (!p_child) {
3712 error_setg(errp, "Node '%s' does not have child '%s'",
3713 parent, child);
3714 return;
3715 }
3716 bdrv_del_child(parent_bs, p_child, errp);
3717 }
3718
3719 if (has_node) {
3720 new_bs = bdrv_find_node(node);
3721 if (!new_bs) {
3722 error_setg(errp, "Node '%s' not found", node);
3723 return;
3724 }
3725 bdrv_add_child(parent_bs, new_bs, errp);
3726 }
3727}
3728
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003729BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3730{
Eric Blakec3033fd2021-01-13 16:10:12 -06003731 BlockJobInfoList *head = NULL, **tail = &head;
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003732 BlockJob *job;
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003733
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003734 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
Eric Blakec3033fd2021-01-13 16:10:12 -06003735 BlockJobInfo *value;
John Snow559b9352016-10-27 12:06:55 -04003736 AioContext *aio_context;
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003737
John Snow559b9352016-10-27 12:06:55 -04003738 if (block_job_is_internal(job)) {
3739 continue;
3740 }
Vladimir Sementsov-Ogievskiydf9a3162021-05-06 17:13:53 +03003741 aio_context = block_job_get_aio_context(job);
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003742 aio_context_acquire(aio_context);
Eric Blakec3033fd2021-01-13 16:10:12 -06003743 value = block_job_query(job, errp);
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003744 aio_context_release(aio_context);
Eric Blakec3033fd2021-01-13 16:10:12 -06003745 if (!value) {
John Snow559b9352016-10-27 12:06:55 -04003746 qapi_free_BlockJobInfoList(head);
3747 return NULL;
3748 }
Eric Blakec3033fd2021-01-13 16:10:12 -06003749 QAPI_LIST_APPEND(tail, value);
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003750 }
3751
3752 return head;
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003753}
Paolo Bonzini4d454572012-11-26 16:03:42 +01003754
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003755void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003756 bool has_force, bool force, Error **errp)
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003757{
3758 AioContext *old_context;
3759 AioContext *new_context;
3760 BlockDriverState *bs;
3761
3762 bs = bdrv_find_node(node_name);
3763 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003764 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003765 return;
3766 }
3767
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003768 /* Protects against accidents. */
3769 if (!(has_force && force) && bdrv_has_blk(bs)) {
3770 error_setg(errp, "Node %s is associated with a BlockBackend and could "
3771 "be in use (use force=true to override this check)",
3772 node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003773 return;
3774 }
3775
3776 if (iothread->type == QTYPE_QSTRING) {
3777 IOThread *obj = iothread_by_id(iothread->u.s);
3778 if (!obj) {
3779 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3780 return;
3781 }
3782
3783 new_context = iothread_get_aio_context(obj);
3784 } else {
3785 new_context = qemu_get_aio_context();
3786 }
3787
3788 old_context = bdrv_get_aio_context(bs);
3789 aio_context_acquire(old_context);
3790
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003791 bdrv_try_set_aio_context(bs, new_context, errp);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003792
3793 aio_context_release(old_context);
3794}
3795
Kevin Wolf00063832013-03-15 10:35:07 +01003796QemuOptsList qemu_common_drive_opts = {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003797 .name = "drive",
Kevin Wolf00063832013-03-15 10:35:07 +01003798 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
Paolo Bonzini4d454572012-11-26 16:03:42 +01003799 .desc = {
3800 {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003801 .name = "snapshot",
3802 .type = QEMU_OPT_BOOL,
3803 .help = "enable/disable snapshot mode",
3804 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003805 .name = "aio",
3806 .type = QEMU_OPT_STRING,
Aarushi Mehtaf80f2672020-01-20 14:18:50 +00003807 .help = "host AIO implementation (threads, native, io_uring)",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003808 },{
Kevin Wolfe4b24b42016-03-15 15:39:42 +01003809 .name = BDRV_OPT_CACHE_WB,
3810 .type = QEMU_OPT_BOOL,
3811 .help = "Enable writeback mode",
3812 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003813 .name = "format",
3814 .type = QEMU_OPT_STRING,
3815 .help = "disk format (raw, qcow2, ...)",
3816 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003817 .name = "rerror",
3818 .type = QEMU_OPT_STRING,
3819 .help = "read error action",
3820 },{
3821 .name = "werror",
3822 .type = QEMU_OPT_STRING,
3823 .help = "write error action",
3824 },{
Alberto Garcia4e200cf2016-09-15 17:53:05 +03003825 .name = BDRV_OPT_READ_ONLY,
Paolo Bonzini4d454572012-11-26 16:03:42 +01003826 .type = QEMU_OPT_BOOL,
3827 .help = "open drive file as read-only",
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +01003828 },
3829
3830 THROTTLE_OPTS,
3831
3832 {
Alberto Garcia76f4afb2015-06-08 18:17:44 +02003833 .name = "throttling.group",
3834 .type = QEMU_OPT_STRING,
3835 .help = "name of the block throttling group",
3836 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003837 .name = "copy-on-read",
3838 .type = QEMU_OPT_BOOL,
3839 .help = "copy read data from backing file into image file",
Peter Lieven465bee12014-05-18 00:58:19 +02003840 },{
3841 .name = "detect-zeroes",
3842 .type = QEMU_OPT_STRING,
3843 .help = "try to optimize zero writes (off, on, unmap)",
Alberto Garcia362e9292015-10-28 17:33:04 +02003844 },{
3845 .name = "stats-account-invalid",
3846 .type = QEMU_OPT_BOOL,
3847 .help = "whether to account for invalid I/O operations "
3848 "in the statistics",
3849 },{
3850 .name = "stats-account-failed",
3851 .type = QEMU_OPT_BOOL,
3852 .help = "whether to account for failed I/O operations "
3853 "in the statistics",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003854 },
3855 { /* end of list */ }
3856 },
3857};
Kevin Wolf00063832013-03-15 10:35:07 +01003858
3859QemuOptsList qemu_drive_opts = {
3860 .name = "drive",
3861 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3862 .desc = {
Kevin Wolf492fdc62013-06-19 13:44:17 +02003863 /*
3864 * no elements => accept any params
3865 * validation will happen later
3866 */
Kevin Wolf00063832013-03-15 10:35:07 +01003867 { /* end of list */ }
3868 },
3869};