blob: ff5ee9ff7bb9153ca6d4f4e7ea9a76612f519dac [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"
Markus Armbrustere2c1c342022-12-21 14:35:49 +010038#include "block/dirty-bitmap.h"
Max Reitz609f45e2018-06-14 21:14:28 +020039#include "block/qdict.h"
Alberto Garcia76f4afb2015-06-08 18:17:44 +020040#include "block/throttle-groups.h"
Paolo Bonzini83c90892012-12-17 18:19:49 +010041#include "monitor/monitor.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010042#include "qemu/error-report.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010043#include "qemu/option.h"
Markus Armbrustercdcd4362019-04-17 21:06:38 +020044#include "qemu/qemu-print.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010045#include "qemu/config-file.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010046#include "qapi/qapi-commands-block.h"
47#include "qapi/qapi-commands-transaction.h"
48#include "qapi/qapi-visit-block-core.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010049#include "qapi/qmp/qdict.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010050#include "qapi/qmp/qnum.h"
Markus Armbruster6b673952018-02-01 12:18:35 +010051#include "qapi/qmp/qstring.h"
Markus Armbrustere688df62018-02-01 12:18:31 +010052#include "qapi/error.h"
Markus Armbrustercc7a8ea2015-03-17 17:22:46 +010053#include "qapi/qmp/qerror.h"
Markus Armbruster47e6b292018-02-01 12:18:38 +010054#include "qapi/qmp/qlist.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010055#include "qapi/qobject-output-visitor.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010056#include "sysemu/sysemu.h"
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +000057#include "sysemu/iothread.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010058#include "block/block_int.h"
Daniel P. Berrange0ab8ed12017-01-25 16:14:15 +000059#include "block/trace.h"
Markus Armbruster54d31232019-08-12 07:23:59 +020060#include "sysemu/runstate.h"
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +030061#include "sysemu/replay.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020062#include "qemu/cutils.h"
63#include "qemu/help_option.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020064#include "qemu/main-loop.h"
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +010065#include "qemu/throttle-options.h"
Markus Armbruster666daa62010-06-02 18:48:27 +020066
Emanuele Giuseppe Espositoebc27522022-03-03 10:15:56 -050067/* Protected by BQL */
Maxim Levitsky89802d52020-03-08 11:24:40 +020068QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
Max Reitz9c4218e2016-01-29 16:36:12 +010069 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
70
Maxim Levitsky89802d52020-03-08 11:24:40 +020071void bdrv_set_monitor_owned(BlockDriverState *bs)
72{
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -050073 GLOBAL_STATE_CODE();
Maxim Levitsky89802d52020-03-08 11:24:40 +020074 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
75}
76
Markus Armbruster19609662011-01-28 11:21:39 +010077static const char *const if_name[IF_COUNT] = {
78 [IF_NONE] = "none",
79 [IF_IDE] = "ide",
80 [IF_SCSI] = "scsi",
81 [IF_FLOPPY] = "floppy",
82 [IF_PFLASH] = "pflash",
83 [IF_MTD] = "mtd",
84 [IF_SD] = "sd",
85 [IF_VIRTIO] = "virtio",
86 [IF_XEN] = "xen",
87};
88
John Snow21dff8c2014-10-01 14:19:25 -040089static int if_max_devs[IF_COUNT] = {
Markus Armbruster27d6bf42011-01-28 11:21:40 +010090 /*
91 * Do not change these numbers! They govern how drive option
92 * index maps to unit and bus. That mapping is ABI.
93 *
Wei Jiangang547cb152016-04-26 18:12:43 +080094 * All controllers used to implement if=T drives need to support
Markus Armbruster27d6bf42011-01-28 11:21:40 +010095 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
96 * Otherwise, some index values map to "impossible" bus, unit
97 * values.
98 *
99 * For instance, if you change [IF_SCSI] to 255, -drive
100 * if=scsi,index=12 no longer means bus=1,unit=5, but
101 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
102 * the drive can't be set up. Regression.
103 */
104 [IF_IDE] = 2,
105 [IF_SCSI] = 7,
Markus Armbruster19609662011-01-28 11:21:39 +0100106};
107
John Snow21dff8c2014-10-01 14:19:25 -0400108/**
109 * Boards may call this to offer board-by-board overrides
110 * of the default, global values.
111 */
112void override_max_devs(BlockInterfaceType type, int max_devs)
113{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200114 BlockBackend *blk;
John Snow21dff8c2014-10-01 14:19:25 -0400115 DriveInfo *dinfo;
116
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500117 GLOBAL_STATE_CODE();
118
John Snow21dff8c2014-10-01 14:19:25 -0400119 if (max_devs <= 0) {
120 return;
121 }
122
Markus Armbruster18e46a02014-10-07 13:59:06 +0200123 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
124 dinfo = blk_legacy_dinfo(blk);
John Snow21dff8c2014-10-01 14:19:25 -0400125 if (dinfo->type == type) {
126 fprintf(stderr, "Cannot override units-per-bus property of"
127 " the %s interface, because a drive of that type has"
128 " already been added.\n", if_name[type]);
129 g_assert_not_reached();
130 }
131 }
132
133 if_max_devs[type] = max_devs;
134}
135
Markus Armbruster14bafc52010-06-25 08:09:10 +0200136/*
137 * We automatically delete the drive when a device using it gets
138 * unplugged. Questionable feature, but we can't just drop it.
139 * Device models call blockdev_mark_auto_del() to schedule the
140 * automatic deletion, and generic qdev code calls blockdev_auto_del()
141 * when deletion is actually safe.
142 */
Markus Armbruster4be74632014-10-07 13:59:18 +0200143void blockdev_mark_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200144{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200145 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300146 BlockJob *job;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200147
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500148 GLOBAL_STATE_CODE();
149
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200150 if (!dinfo) {
Kevin Wolf2d246f02013-09-18 15:14:47 +0200151 return;
152 }
153
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400154 JOB_LOCK_GUARD();
155
Kevin Wolfe2626872023-05-03 16:01:42 +0200156 do {
157 job = block_job_next_locked(NULL);
158 while (job && (job->job.cancelled ||
159 job->job.deferred_to_main_loop ||
160 !block_job_has_bdrv(job, blk_bs(blk))))
161 {
162 job = block_job_next_locked(job);
163 }
164 if (job) {
165 /*
166 * This drops the job lock temporarily and polls, so we need to
167 * restart processing the list from the start after this.
168 */
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -0400169 job_cancel_locked(&job->job, false);
Max Reitz5433c242015-10-19 17:53:29 +0200170 }
Kevin Wolfe2626872023-05-03 16:01:42 +0200171 } while (job);
Stefan Hajnoczi91fddb02014-10-21 12:03:52 +0100172
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200173 dinfo->auto_del = 1;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200174}
175
Markus Armbruster4be74632014-10-07 13:59:18 +0200176void blockdev_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200177{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200178 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500179 GLOBAL_STATE_CODE();
Markus Armbruster14bafc52010-06-25 08:09:10 +0200180
Ryan Harper0fc0f1f2010-12-08 10:05:00 -0600181 if (dinfo && dinfo->auto_del) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100182 monitor_remove_blk(blk);
Markus Armbrusterb9fe8a72014-10-07 13:59:09 +0200183 blk_unref(blk);
Markus Armbruster14bafc52010-06-25 08:09:10 +0200184 }
185}
186
Markus Armbruster505a7fb2011-01-28 11:21:43 +0100187static int drive_index_to_bus_id(BlockInterfaceType type, int index)
188{
189 int max_devs = if_max_devs[type];
190 return max_devs ? index / max_devs : 0;
191}
192
193static int drive_index_to_unit_id(BlockInterfaceType type, int index)
194{
195 int max_devs = if_max_devs[type];
196 return max_devs ? index % max_devs : index;
197}
198
Markus Armbruster2292dda2011-01-28 11:21:41 +0100199QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
Markus Armbruster5645b0f2011-01-31 11:50:09 +0100200 const char *optstr)
Markus Armbruster666daa62010-06-02 18:48:27 +0200201{
Markus Armbruster666daa62010-06-02 18:48:27 +0200202 QemuOpts *opts;
203
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500204 GLOBAL_STATE_CODE();
205
Emanuele Giuseppe Espositocc67f282021-12-15 07:11:39 -0500206 opts = qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
Markus Armbruster666daa62010-06-02 18:48:27 +0200207 if (!opts) {
208 return NULL;
209 }
Markus Armbruster2292dda2011-01-28 11:21:41 +0100210 if (type != IF_DEFAULT) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100211 qemu_opt_set(opts, "if", if_name[type], &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100212 }
213 if (index >= 0) {
Markus Armbrustera8b18f82015-02-13 15:50:43 +0100214 qemu_opt_set_number(opts, "index", index, &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100215 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200216 if (file)
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100217 qemu_opt_set(opts, "file", file, &error_abort);
Markus Armbruster666daa62010-06-02 18:48:27 +0200218 return opts;
219}
220
221DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
222{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200223 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200224 DriveInfo *dinfo;
225
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500226 GLOBAL_STATE_CODE();
227
Markus Armbruster18e46a02014-10-07 13:59:06 +0200228 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
229 dinfo = blk_legacy_dinfo(blk);
230 if (dinfo && dinfo->type == type
231 && dinfo->bus == bus && dinfo->unit == unit) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200232 return dinfo;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200233 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200234 }
235
236 return NULL;
237}
238
Markus Armbrusterfe9f70a2021-03-09 17:12:13 +0100239/*
240 * Check board claimed all -drive that are meant to be claimed.
241 * Fatal error if any remain unclaimed.
242 */
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100243void drive_check_orphaned(void)
John Snowa66c9dc2014-10-01 14:19:24 -0400244{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200245 BlockBackend *blk;
John Snowa66c9dc2014-10-01 14:19:24 -0400246 DriveInfo *dinfo;
Markus Armbruster664cc622017-02-15 11:05:45 +0100247 Location loc;
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100248 bool orphans = false;
John Snowa66c9dc2014-10-01 14:19:24 -0400249
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500250 GLOBAL_STATE_CODE();
251
Markus Armbruster18e46a02014-10-07 13:59:06 +0200252 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
253 dinfo = blk_legacy_dinfo(blk);
Markus Armbrusterfe9f70a2021-03-09 17:12:13 +0100254 /*
255 * Ignore default drives, because we create certain default
256 * drives unconditionally, then leave them unclaimed. Not the
257 * users fault.
258 * Ignore IF_VIRTIO, because it gets desugared into -device,
259 * so we can leave failing to -device.
260 * Ignore IF_NONE, because leaving unclaimed IF_NONE remains
261 * available for device_add is a feature.
262 */
263 if (dinfo->is_default || dinfo->type == IF_VIRTIO
264 || dinfo->type == IF_NONE) {
Markus Armbrustera1b40bd2020-06-22 11:42:19 +0200265 continue;
266 }
267 if (!blk_get_attached_dev(blk)) {
Markus Armbruster664cc622017-02-15 11:05:45 +0100268 loc_push_none(&loc);
269 qemu_opts_loc_restore(dinfo->opts);
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100270 error_report("machine type does not support"
Markus Armbruster664cc622017-02-15 11:05:45 +0100271 " if=%s,bus=%d,unit=%d",
272 if_name[dinfo->type], dinfo->bus, dinfo->unit);
273 loc_pop(&loc);
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100274 orphans = true;
John Snowa66c9dc2014-10-01 14:19:24 -0400275 }
276 }
277
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100278 if (orphans) {
279 exit(1);
280 }
John Snowa66c9dc2014-10-01 14:19:24 -0400281}
282
Markus Armbrusterf1bd51a2011-01-28 11:21:44 +0100283DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
284{
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500285 GLOBAL_STATE_CODE();
Markus Armbrusterf1bd51a2011-01-28 11:21:44 +0100286 return drive_get(type,
287 drive_index_to_bus_id(type, index),
288 drive_index_to_unit_id(type, index));
289}
290
Markus Armbruster666daa62010-06-02 18:48:27 +0200291int drive_get_max_bus(BlockInterfaceType type)
292{
293 int max_bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200294 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200295 DriveInfo *dinfo;
296
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500297 GLOBAL_STATE_CODE();
298
Markus Armbruster666daa62010-06-02 18:48:27 +0200299 max_bus = -1;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200300 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
301 dinfo = blk_legacy_dinfo(blk);
302 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200303 max_bus = dinfo->bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200304 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200305 }
306 return max_bus;
307}
308
Markus Armbruster666daa62010-06-02 18:48:27 +0200309static void bdrv_format_print(void *opaque, const char *name)
310{
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200311 qemu_printf(" %s", name);
Markus Armbruster666daa62010-06-02 18:48:27 +0200312}
313
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000314typedef struct {
315 QEMUBH *bh;
Fam Zhengfa510eb2013-08-23 09:14:51 +0800316 BlockDriverState *bs;
317} BDRVPutRefBH;
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000318
Kevin Wolfb6810722013-09-20 11:33:11 +0200319static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200320{
321 if (!strcmp(buf, "ignore")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200322 return BLOCKDEV_ON_ERROR_IGNORE;
Markus Armbruster666daa62010-06-02 18:48:27 +0200323 } else if (!is_read && !strcmp(buf, "enospc")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200324 return BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200325 } else if (!strcmp(buf, "stop")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200326 return BLOCKDEV_ON_ERROR_STOP;
Markus Armbruster666daa62010-06-02 18:48:27 +0200327 } else if (!strcmp(buf, "report")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200328 return BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200329 } else {
Kevin Wolfb6810722013-09-20 11:33:11 +0200330 error_setg(errp, "'%s' invalid %s error action",
331 buf, is_read ? "read" : "write");
Markus Armbruster666daa62010-06-02 18:48:27 +0200332 return -1;
333 }
334}
335
Alberto Garcia40119ef2015-11-16 11:28:38 +0200336static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
337 Error **errp)
338{
339 const QListEntry *entry;
340 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
341 switch (qobject_type(entry->value)) {
342
343 case QTYPE_QSTRING: {
Eric Blakebd1386c2023-05-22 14:04:29 -0500344 uint64_t length;
Max Reitz7dc847e2018-02-24 16:40:29 +0100345 const char *str = qstring_get_str(qobject_to(QString,
346 entry->value));
Eric Blakebd1386c2023-05-22 14:04:29 -0500347 if (parse_uint_full(str, 10, &length) == 0 &&
Alberto Garcia40119ef2015-11-16 11:28:38 +0200348 length > 0 && length <= UINT_MAX) {
349 block_acct_add_interval(stats, (unsigned) length);
350 } else {
351 error_setg(errp, "Invalid interval length: %s", str);
352 return false;
353 }
354 break;
355 }
356
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400357 case QTYPE_QNUM: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100358 int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400359
Alberto Garcia40119ef2015-11-16 11:28:38 +0200360 if (length > 0 && length <= UINT_MAX) {
361 block_acct_add_interval(stats, (unsigned) length);
362 } else {
363 error_setg(errp, "Invalid interval length: %" PRId64, length);
364 return false;
365 }
366 break;
367 }
368
369 default:
370 error_setg(errp, "The specification of stats-intervals is invalid");
371 return false;
372 }
373 }
374 return true;
375}
376
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200377typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
378
Max Reitzfbf81752015-10-19 17:53:31 +0200379/* All parameters but @opts are optional and may be set to NULL. */
380static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
381 const char **throttling_group, ThrottleConfig *throttle_cfg,
382 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
383{
Max Reitzfbf81752015-10-19 17:53:31 +0200384 Error *local_error = NULL;
385 const char *aio;
386
387 if (bdrv_flags) {
Max Reitzfbf81752015-10-19 17:53:31 +0200388 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
389 *bdrv_flags |= BDRV_O_COPY_ON_READ;
390 }
391
Max Reitzfbf81752015-10-19 17:53:31 +0200392 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
Aarushi Mehtaf80f2672020-01-20 14:18:50 +0000393 if (bdrv_parse_aio(aio, bdrv_flags) < 0) {
394 error_setg(errp, "invalid aio option");
395 return;
Max Reitzfbf81752015-10-19 17:53:31 +0200396 }
397 }
398 }
399
400 /* disk I/O throttling */
401 if (throttling_group) {
402 *throttling_group = qemu_opt_get(opts, "throttling.group");
403 }
404
405 if (throttle_cfg) {
Alberto Garcia1588ab52016-02-18 12:27:00 +0200406 throttle_config_init(throttle_cfg);
Max Reitzfbf81752015-10-19 17:53:31 +0200407 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
408 qemu_opt_get_number(opts, "throttling.bps-total", 0);
409 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
410 qemu_opt_get_number(opts, "throttling.bps-read", 0);
411 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
412 qemu_opt_get_number(opts, "throttling.bps-write", 0);
413 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
414 qemu_opt_get_number(opts, "throttling.iops-total", 0);
415 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
416 qemu_opt_get_number(opts, "throttling.iops-read", 0);
417 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
418 qemu_opt_get_number(opts, "throttling.iops-write", 0);
419
420 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
421 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
422 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
423 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
424 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
425 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
426 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
427 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
428 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
429 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
430 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
431 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
432
Alberto Garcia8a0fc182016-02-18 12:27:02 +0200433 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
434 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
435 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
436 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
437 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
438 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
439 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
440 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
441 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
442 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
443 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
444 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
445
Max Reitzfbf81752015-10-19 17:53:31 +0200446 throttle_cfg->op_size =
447 qemu_opt_get_number(opts, "throttling.iops-size", 0);
448
Alberto Garciad5851082016-02-18 12:26:59 +0200449 if (!throttle_is_valid(throttle_cfg, errp)) {
Max Reitzfbf81752015-10-19 17:53:31 +0200450 return;
451 }
452 }
453
454 if (detect_zeroes) {
455 *detect_zeroes =
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200456 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
Max Reitzfbf81752015-10-19 17:53:31 +0200457 qemu_opt_get(opts, "detect-zeroes"),
Max Reitzfbf81752015-10-19 17:53:31 +0200458 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
459 &local_error);
460 if (local_error) {
461 error_propagate(errp, local_error);
462 return;
463 }
Max Reitzfbf81752015-10-19 17:53:31 +0200464 }
465}
466
Denis V. Lunevb2aaf352022-08-24 11:50:43 +0200467static OnOffAuto account_get_opt(QemuOpts *opts, const char *name)
468{
469 if (!qemu_opt_find(opts, name)) {
470 return ON_OFF_AUTO_AUTO;
471 }
472 if (qemu_opt_get_bool(opts, name, true)) {
473 return ON_OFF_AUTO_ON;
474 }
475 return ON_OFF_AUTO_OFF;
476}
477
Kevin Wolff298d072013-09-10 12:01:20 +0200478/* Takes the ownership of bs_opts */
Markus Armbruster18e46a02014-10-07 13:59:06 +0200479static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
480 Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200481{
482 const char *buf;
Markus Armbruster666daa62010-06-02 18:48:27 +0200483 int bdrv_flags = 0;
484 int on_read_error, on_write_error;
Denis V. Lunevb2aaf352022-08-24 11:50:43 +0200485 OnOffAuto account_invalid, account_failed;
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300486 bool writethrough, read_only;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200487 BlockBackend *blk;
Markus Armbrustera0f1eab2014-09-12 21:26:21 +0200488 BlockDriverState *bs;
Benoît Canetcc0681c2013-09-02 14:14:39 +0200489 ThrottleConfig cfg;
Markus Armbruster666daa62010-06-02 18:48:27 +0200490 int snapshot = 0;
Stefan Hajnoczic5461942013-02-13 16:53:42 +0100491 Error *error = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100492 QemuOpts *opts;
Alberto Garcia40119ef2015-11-16 11:28:38 +0200493 QDict *interval_dict = NULL;
494 QList *interval_list = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100495 const char *id;
Max Reitzfbf81752015-10-19 17:53:31 +0200496 BlockdevDetectZeroesOptions detect_zeroes =
497 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
498 const char *throttling_group = NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200499
Kevin Wolff298d072013-09-10 12:01:20 +0200500 /* Check common options by copying from bs_opts to opts, all other options
501 * stay in bs_opts for processing by bdrv_open(). */
502 id = qdict_get_try_str(bs_opts, "id");
Markus Armbrusterc6ecec42020-07-07 18:05:35 +0200503 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, errp);
504 if (!opts) {
Markus Armbruster6376f952014-05-28 11:17:01 +0200505 goto err_no_opts;
Kevin Wolf00063832013-03-15 10:35:07 +0100506 }
507
Markus Armbruster668f62e2020-07-07 18:06:02 +0200508 if (!qemu_opts_absorb_qdict(opts, bs_opts, errp)) {
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100509 goto early_err;
Kevin Wolf00063832013-03-15 10:35:07 +0100510 }
511
512 if (id) {
513 qdict_del(bs_opts, "id");
514 }
515
Markus Armbruster666daa62010-06-02 18:48:27 +0200516 /* extract parameters */
Markus Armbruster666daa62010-06-02 18:48:27 +0200517 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
Markus Armbruster666daa62010-06-02 18:48:27 +0200518
Denis V. Lunevb2aaf352022-08-24 11:50:43 +0200519 account_invalid = account_get_opt(opts, "stats-account-invalid");
520 account_failed = account_get_opt(opts, "stats-account-failed");
Alberto Garcia362e9292015-10-28 17:33:04 +0200521
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100522 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
523
Alberto Garciaff356ee2016-07-08 17:03:00 +0300524 id = qemu_opts_id(opts);
525
Alberto Garcia40119ef2015-11-16 11:28:38 +0200526 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
527 qdict_array_split(interval_dict, &interval_list);
528
529 if (qdict_size(interval_dict) != 0) {
530 error_setg(errp, "Invalid option stats-intervals.%s",
531 qdict_first(interval_dict)->key);
532 goto early_err;
533 }
Alberto Garcia2be55062015-10-28 17:33:07 +0200534
Max Reitzfbf81752015-10-19 17:53:31 +0200535 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
536 &detect_zeroes, &error);
537 if (error) {
538 error_propagate(errp, error);
539 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200540 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200541
542 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
Peter Maydellc8057f92012-08-02 13:45:54 +0100543 if (is_help_option(buf)) {
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200544 qemu_printf("Supported formats:");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300545 bdrv_iterate_format(bdrv_format_print, NULL, false);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200546 qemu_printf("\nSupported formats (read-only):");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300547 bdrv_iterate_format(bdrv_format_print, NULL, true);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200548 qemu_printf("\n");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100549 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200550 }
Kevin Wolf74fe54f2013-07-09 11:09:02 +0200551
Max Reitze4342ce2015-02-05 13:58:14 -0500552 if (qdict_haskey(bs_opts, "driver")) {
553 error_setg(errp, "Cannot specify both 'driver' and 'format'");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100554 goto early_err;
Mike Qiu6db5f5d2013-08-08 10:45:16 -0400555 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500556 qdict_put_str(bs_opts, "driver", buf);
Markus Armbruster666daa62010-06-02 18:48:27 +0200557 }
558
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200559 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200560 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200561 on_write_error = parse_block_error_action(buf, 0, &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
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200568 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200569 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200570 on_read_error = parse_block_error_action(buf, 1, &error);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100571 if (error) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200572 error_propagate(errp, error);
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100573 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200574 }
575 }
576
Max Reitz5ec18f82015-10-19 17:53:30 +0200577 if (snapshot) {
Kevin Wolf91a097e2015-05-08 17:49:53 +0200578 bdrv_flags |= BDRV_O_SNAPSHOT;
Max Reitz5ec18f82015-10-19 17:53:30 +0200579 }
580
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300581 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
582
Kevin Wolf326642b2013-07-11 12:52:34 +0200583 /* init */
Kevin Wolf39c4ae92015-11-13 14:45:42 +0100584 if ((!file || !*file) && !qdict_size(bs_opts)) {
Max Reitz5ec18f82015-10-19 17:53:30 +0200585 BlockBackendRootState *blk_rs;
586
Kevin Wolfd861ab32019-04-25 14:25:10 +0200587 blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
Max Reitz5ec18f82015-10-19 17:53:30 +0200588 blk_rs = blk_get_root_state(blk);
Vladimir Sementsov-Ogievskiy260242a2021-05-27 18:40:56 +0300589 blk_rs->open_flags = bdrv_flags | (read_only ? 0 : BDRV_O_RDWR);
Max Reitz5ec18f82015-10-19 17:53:30 +0200590 blk_rs->detect_zeroes = detect_zeroes;
591
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200592 qobject_unref(bs_opts);
Max Reitze4342ce2015-02-05 13:58:14 -0500593 } else {
594 if (file && !*file) {
595 file = NULL;
596 }
597
Kevin Wolf91a097e2015-05-08 17:49:53 +0200598 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
599 * with other callers) rather than what we want as the real defaults.
600 * Apply the defaults here instead. */
Kevin Wolf91a097e2015-05-08 17:49:53 +0200601 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
602 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300603 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
604 read_only ? "on" : "off");
Kevin Wolf9384a442018-10-17 18:24:30 +0200605 qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
Kevin Wolf72e775c2016-03-15 14:34:37 +0100606 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
Kevin Wolf91a097e2015-05-08 17:49:53 +0200607
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100608 if (runstate_check(RUN_STATE_INMIGRATE)) {
609 bdrv_flags |= BDRV_O_INACTIVE;
610 }
611
Max Reitzefaa7c42016-03-16 19:54:38 +0100612 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
Max Reitze4342ce2015-02-05 13:58:14 -0500613 if (!blk) {
614 goto err_no_bs_opts;
615 }
616 bs = blk_bs(blk);
Max Reitze4342ce2015-02-05 13:58:14 -0500617
Max Reitz5ec18f82015-10-19 17:53:30 +0200618 bs->detect_zeroes = detect_zeroes;
619
Paolo Bonzini9caa6f32017-06-05 14:39:07 +0200620 block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
Alberto Garcia2be55062015-10-28 17:33:07 +0200621
Alberto Garcia40119ef2015-11-16 11:28:38 +0200622 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
623 blk_unref(blk);
624 blk = NULL;
625 goto err_no_bs_opts;
Alberto Garcia2be55062015-10-28 17:33:07 +0200626 }
Max Reitz5ec18f82015-10-19 17:53:30 +0200627 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200628
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100629 /* disk I/O throttling */
630 if (throttle_enabled(&cfg)) {
631 if (!throttling_group) {
Alberto Garciaff356ee2016-07-08 17:03:00 +0300632 throttling_group = id;
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100633 }
634 blk_io_limits_enable(blk, throttling_group);
635 blk_set_io_limits(blk, &cfg);
636 }
637
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100638 blk_set_enable_write_cache(blk, !writethrough);
Max Reitz373340b2015-10-19 17:53:22 +0200639 blk_set_on_error(blk, on_read_error, on_write_error);
Markus Armbrusterabd7f682010-06-02 18:55:17 +0200640
Alberto Garciaff356ee2016-07-08 17:03:00 +0300641 if (!monitor_add_blk(blk, id, errp)) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100642 blk_unref(blk);
643 blk = NULL;
644 goto err_no_bs_opts;
645 }
646
Max Reitze4342ce2015-02-05 13:58:14 -0500647err_no_bs_opts:
Kevin Wolf00063832013-03-15 10:35:07 +0100648 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200649 qobject_unref(interval_dict);
650 qobject_unref(interval_list);
Markus Armbruster18e46a02014-10-07 13:59:06 +0200651 return blk;
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100652
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100653early_err:
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100654 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200655 qobject_unref(interval_dict);
656 qobject_unref(interval_list);
Markus Armbruster6376f952014-05-28 11:17:01 +0200657err_no_opts:
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200658 qobject_unref(bs_opts);
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100659 return NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200660}
661
Max Reitzbd745e22015-10-19 17:53:32 +0200662/* Takes the ownership of bs_opts */
Maxim Levitsky89802d52020-03-08 11:24:40 +0200663BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
Max Reitzbd745e22015-10-19 17:53:32 +0200664{
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +0200665 BlockDriverState *bs;
Max Reitzbd745e22015-10-19 17:53:32 +0200666 int bdrv_flags = 0;
667
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -0500668 GLOBAL_STATE_CODE();
Kevin Wolfa81d6162016-03-07 14:23:04 +0100669 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
670 * with other callers) rather than what we want as the real defaults.
671 * Apply the defaults here instead. */
Kevin Wolfa81d6162016-03-07 14:23:04 +0100672 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
673 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300674 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
Kevin Wolfa81d6162016-03-07 14:23:04 +0100675
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100676 if (runstate_check(RUN_STATE_INMIGRATE)) {
677 bdrv_flags |= BDRV_O_INACTIVE;
678 }
679
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +0200680 aio_context_acquire(qemu_get_aio_context());
681 bs = bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
682 aio_context_release(qemu_get_aio_context());
683
684 return bs;
Max Reitzbd745e22015-10-19 17:53:32 +0200685}
686
Max Reitz9c4218e2016-01-29 16:36:12 +0100687void blockdev_close_all_bdrv_states(void)
688{
689 BlockDriverState *bs, *next_bs;
690
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -0500691 GLOBAL_STATE_CODE();
Max Reitz9c4218e2016-01-29 16:36:12 +0100692 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
693 AioContext *ctx = bdrv_get_aio_context(bs);
694
695 aio_context_acquire(ctx);
696 bdrv_unref(bs);
697 aio_context_release(ctx);
698 }
699}
700
Max Reitz262b4e82016-03-16 19:54:41 +0100701/* Iterates over the list of monitor-owned BlockDriverStates */
702BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
703{
Emanuele Giuseppe Espositof791bf72022-03-03 10:15:49 -0500704 GLOBAL_STATE_CODE();
Max Reitz262b4e82016-03-16 19:54:41 +0100705 return bs ? QTAILQ_NEXT(bs, monitor_list)
706 : QTAILQ_FIRST(&monitor_bdrv_states);
707}
708
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200709static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200710 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200711{
712 const char *value;
713
714 value = qemu_opt_get(opts, from);
715 if (value) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200716 if (qemu_opt_find(opts, to)) {
717 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
718 "same time", to, from);
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200719 return false;
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200720 }
Jun Li20d6cd42014-09-24 13:45:27 +0800721 }
722
723 /* rename all items in opts */
724 while ((value = qemu_opt_get(opts, from))) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100725 qemu_opt_set(opts, to, value, &error_abort);
Kevin Wolf57975222013-07-17 14:41:54 +0200726 qemu_opt_unset(opts, from);
727 }
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200728 return true;
Kevin Wolf57975222013-07-17 14:41:54 +0200729}
730
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200731QemuOptsList qemu_legacy_drive_opts = {
732 .name = "drive",
733 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
734 .desc = {
735 {
Kevin Wolf87a899c2013-09-10 15:48:13 +0200736 .name = "bus",
737 .type = QEMU_OPT_NUMBER,
738 .help = "bus number",
739 },{
740 .name = "unit",
741 .type = QEMU_OPT_NUMBER,
742 .help = "unit number (i.e. lun for scsi)",
743 },{
744 .name = "index",
745 .type = QEMU_OPT_NUMBER,
746 .help = "index number",
747 },{
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200748 .name = "media",
749 .type = QEMU_OPT_STRING,
750 .help = "media type (disk, cdrom)",
Kevin Wolf593d4642013-08-28 17:24:51 +0200751 },{
752 .name = "if",
753 .type = QEMU_OPT_STRING,
754 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
Kevin Wolfb41a7332013-09-09 16:49:49 +0200755 },{
Max Reitzd095b462013-12-20 19:28:14 +0100756 .name = "file",
757 .type = QEMU_OPT_STRING,
758 .help = "file name",
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200759 },
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200760
761 /* Options that are passed on, but have special semantics with -drive */
762 {
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300763 .name = BDRV_OPT_READ_ONLY,
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200764 .type = QEMU_OPT_BOOL,
765 .help = "open drive file as read-only",
766 },{
Kevin Wolfee13ed12014-02-09 09:52:32 +0100767 .name = "rerror",
768 .type = QEMU_OPT_STRING,
769 .help = "read error action",
770 },{
771 .name = "werror",
772 .type = QEMU_OPT_STRING,
773 .help = "write error action",
774 },{
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200775 .name = "copy-on-read",
776 .type = QEMU_OPT_BOOL,
777 .help = "copy read data from backing file into image file",
778 },
779
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200780 { /* end of list */ }
781 },
782};
783
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200784DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
785 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200786{
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200787 const char *value;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200788 BlockBackend *blk;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200789 DriveInfo *dinfo = NULL;
Kevin Wolff298d072013-09-10 12:01:20 +0200790 QDict *bs_opts;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200791 QemuOpts *legacy_opts;
792 DriveMediaType media = MEDIA_DISK;
Kevin Wolf593d4642013-08-28 17:24:51 +0200793 BlockInterfaceType type;
Kevin Wolf87a899c2013-09-10 15:48:13 +0200794 int max_devs, bus_id, unit_id, index;
Kevin Wolfee13ed12014-02-09 09:52:32 +0100795 const char *werror, *rerror;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800796 bool read_only = false;
797 bool copy_on_read;
Max Reitzd095b462013-12-20 19:28:14 +0100798 const char *filename;
Kevin Wolf247147f2014-09-24 16:37:14 +0200799 int i;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200800
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500801 GLOBAL_STATE_CODE();
802
Kevin Wolf57975222013-07-17 14:41:54 +0200803 /* Change legacy command line options into QMP ones */
Kevin Wolf247147f2014-09-24 16:37:14 +0200804 static const struct {
805 const char *from;
806 const char *to;
807 } opt_renames[] = {
808 { "iops", "throttling.iops-total" },
809 { "iops_rd", "throttling.iops-read" },
810 { "iops_wr", "throttling.iops-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200811
Kevin Wolf247147f2014-09-24 16:37:14 +0200812 { "bps", "throttling.bps-total" },
813 { "bps_rd", "throttling.bps-read" },
814 { "bps_wr", "throttling.bps-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200815
Kevin Wolf247147f2014-09-24 16:37:14 +0200816 { "iops_max", "throttling.iops-total-max" },
817 { "iops_rd_max", "throttling.iops-read-max" },
818 { "iops_wr_max", "throttling.iops-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200819
Kevin Wolf247147f2014-09-24 16:37:14 +0200820 { "bps_max", "throttling.bps-total-max" },
821 { "bps_rd_max", "throttling.bps-read-max" },
822 { "bps_wr_max", "throttling.bps-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200823
Kevin Wolf247147f2014-09-24 16:37:14 +0200824 { "iops_size", "throttling.iops-size" },
Benoît Canet2024c1d2013-09-02 14:14:41 +0200825
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200826 { "group", "throttling.group" },
827
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300828 { "readonly", BDRV_OPT_READ_ONLY },
Kevin Wolf247147f2014-09-24 16:37:14 +0200829 };
830
831 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200832 if (!qemu_opt_rename(all_opts, opt_renames[i].from,
Markus Armbruster668f62e2020-07-07 18:06:02 +0200833 opt_renames[i].to, errp)) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200834 return NULL;
835 }
Kevin Wolf247147f2014-09-24 16:37:14 +0200836 }
Kevin Wolf0f227a92013-07-19 20:07:29 +0200837
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200838 value = qemu_opt_get(all_opts, "cache");
839 if (value) {
840 int flags = 0;
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100841 bool writethrough;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200842
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100843 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200844 error_setg(errp, "invalid cache option");
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200845 return NULL;
846 }
847
848 /* Specific options take precedence */
Kevin Wolf54861b92015-04-07 16:55:00 +0200849 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
850 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100851 !writethrough, &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200852 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200853 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
854 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100855 !!(flags & BDRV_O_NOCACHE), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200856 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200857 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
858 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100859 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200860 }
861 qemu_opt_unset(all_opts, "cache");
862 }
863
Kevin Wolff298d072013-09-10 12:01:20 +0200864 /* Get a QDict for processing the options */
865 bs_opts = qdict_new();
866 qemu_opts_to_qdict(all_opts, bs_opts);
867
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800868 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
869 &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200870 if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200871 goto fail;
872 }
873
874 /* Media type */
875 value = qemu_opt_get(legacy_opts, "media");
876 if (value) {
877 if (!strcmp(value, "disk")) {
878 media = MEDIA_DISK;
879 } else if (!strcmp(value, "cdrom")) {
880 media = MEDIA_CDROM;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800881 read_only = true;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200882 } else {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200883 error_setg(errp, "'%s' invalid media", value);
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200884 goto fail;
885 }
886 }
887
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200888 /* copy-on-read is disabled with a warning for read-only devices */
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300889 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200890 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
891
892 if (read_only && copy_on_read) {
Alistair Francis3dc6f862017-07-12 06:57:41 -0700893 warn_report("disabling copy-on-read on read-only drive");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200894 copy_on_read = false;
895 }
896
Eric Blake46f5ac22017-04-27 16:58:17 -0500897 qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
898 qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200899
Kevin Wolf593d4642013-08-28 17:24:51 +0200900 /* Controller type */
901 value = qemu_opt_get(legacy_opts, "if");
902 if (value) {
903 for (type = 0;
904 type < IF_COUNT && strcmp(value, if_name[type]);
905 type++) {
906 }
907 if (type == IF_COUNT) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200908 error_setg(errp, "unsupported bus type '%s'", value);
Kevin Wolf593d4642013-08-28 17:24:51 +0200909 goto fail;
910 }
911 } else {
912 type = block_default_type;
913 }
914
Kevin Wolf87a899c2013-09-10 15:48:13 +0200915 /* Device address specified by bus/unit or index.
916 * If none was specified, try to find the first free one. */
917 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
918 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
919 index = qemu_opt_get_number(legacy_opts, "index", -1);
920
921 max_devs = if_max_devs[type];
922
923 if (index != -1) {
924 if (bus_id != 0 || unit_id != -1) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200925 error_setg(errp, "index cannot be used with bus and unit");
Kevin Wolf87a899c2013-09-10 15:48:13 +0200926 goto fail;
927 }
928 bus_id = drive_index_to_bus_id(type, index);
929 unit_id = drive_index_to_unit_id(type, index);
930 }
931
932 if (unit_id == -1) {
933 unit_id = 0;
934 while (drive_get(type, bus_id, unit_id) != NULL) {
935 unit_id++;
936 if (max_devs && unit_id >= max_devs) {
937 unit_id -= max_devs;
938 bus_id++;
939 }
940 }
941 }
942
943 if (max_devs && unit_id >= max_devs) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200944 error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200945 goto fail;
946 }
947
948 if (drive_get(type, bus_id, unit_id) != NULL) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200949 error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
950 bus_id, unit_id, index);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200951 goto fail;
952 }
953
954 /* no id supplied -> create one */
955 if (qemu_opts_id(all_opts) == NULL) {
956 char *new_id;
957 const char *mediastr = "";
958 if (type == IF_IDE || type == IF_SCSI) {
959 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
960 }
961 if (max_devs) {
962 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
963 mediastr, unit_id);
964 } else {
965 new_id = g_strdup_printf("%s%s%i", if_name[type],
966 mediastr, unit_id);
967 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500968 qdict_put_str(bs_opts, "id", new_id);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200969 g_free(new_id);
970 }
971
Kevin Wolf394c7d42013-09-13 14:09:17 +0200972 /* Add virtio block device */
Kevin Wolf394c7d42013-09-13 14:09:17 +0200973 if (type == IF_VIRTIO) {
974 QemuOpts *devopts;
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800975 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
976 &error_abort);
Laurent Vivier9db1d3a2021-03-23 16:53:04 +0000977 qemu_opt_set(devopts, "driver", "virtio-blk", &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100978 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
979 &error_abort);
Kevin Wolf394c7d42013-09-13 14:09:17 +0200980 }
981
Max Reitzd095b462013-12-20 19:28:14 +0100982 filename = qemu_opt_get(legacy_opts, "file");
983
Kevin Wolfee13ed12014-02-09 09:52:32 +0100984 /* Check werror/rerror compatibility with if=... */
985 werror = qemu_opt_get(legacy_opts, "werror");
986 if (werror != NULL) {
987 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
988 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200989 error_setg(errp, "werror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +0100990 goto fail;
991 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500992 qdict_put_str(bs_opts, "werror", werror);
Kevin Wolfee13ed12014-02-09 09:52:32 +0100993 }
994
995 rerror = qemu_opt_get(legacy_opts, "rerror");
996 if (rerror != NULL) {
997 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
998 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200999 error_setg(errp, "rerror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +01001000 goto fail;
1001 }
Eric Blake46f5ac22017-04-27 16:58:17 -05001002 qdict_put_str(bs_opts, "rerror", rerror);
Kevin Wolfee13ed12014-02-09 09:52:32 +01001003 }
1004
Kevin Wolf2d246f02013-09-18 15:14:47 +02001005 /* Actual block device init: Functionality shared with blockdev-add */
Markus Armbruster992861f2020-07-07 18:06:04 +02001006 blk = blockdev_init(filename, bs_opts, errp);
Markus Armbruster3cb0e252014-05-28 11:17:02 +02001007 bs_opts = NULL;
Markus Armbruster18e46a02014-10-07 13:59:06 +02001008 if (!blk) {
Kevin Wolf2d246f02013-09-18 15:14:47 +02001009 goto fail;
1010 }
1011
Markus Armbruster26f8b3a2014-10-07 13:59:22 +02001012 /* Create legacy DriveInfo */
1013 dinfo = g_malloc0(sizeof(*dinfo));
Kevin Wolff298d072013-09-10 12:01:20 +02001014 dinfo->opts = all_opts;
Kevin Wolf2d246f02013-09-18 15:14:47 +02001015
Kevin Wolfee13ed12014-02-09 09:52:32 +01001016 dinfo->type = type;
Kevin Wolf87a899c2013-09-10 15:48:13 +02001017 dinfo->bus = bus_id;
1018 dinfo->unit = unit_id;
Kevin Wolfbcf83152014-06-06 15:21:48 +02001019
Markus Armbruster26f8b3a2014-10-07 13:59:22 +02001020 blk_set_legacy_dinfo(blk, dinfo);
1021
Kevin Wolfe34ef042013-09-19 14:24:10 +02001022 switch(type) {
1023 case IF_IDE:
1024 case IF_SCSI:
1025 case IF_XEN:
1026 case IF_NONE:
1027 dinfo->media_cd = media == MEDIA_CDROM;
1028 break;
1029 default:
1030 break;
1031 }
1032
Kevin Wolf2d246f02013-09-18 15:14:47 +02001033fail:
Kevin Wolf33cb7dc2013-08-28 17:00:13 +02001034 qemu_opts_del(legacy_opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001035 qobject_unref(bs_opts);
Kevin Wolf2d246f02013-09-18 15:14:47 +02001036 return dinfo;
Kevin Wolf57975222013-07-17 14:41:54 +02001037}
1038
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001039static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1040{
1041 BlockDriverState *bs;
Emanuele Giuseppe Esposito1e97be92023-01-13 21:42:02 +01001042 AioContext *aio_context;
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001043
Kevin Wolf2b3912f2023-09-29 16:51:39 +02001044 GRAPH_RDLOCK_GUARD_MAINLOOP();
1045
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001046 bs = bdrv_lookup_bs(name, name, errp);
1047 if (bs == NULL) {
1048 return NULL;
1049 }
1050
1051 if (!bdrv_is_root_node(bs)) {
1052 error_setg(errp, "Need a root block node");
1053 return NULL;
1054 }
1055
Emanuele Giuseppe Esposito1e97be92023-01-13 21:42:02 +01001056 aio_context = bdrv_get_aio_context(bs);
1057 aio_context_acquire(aio_context);
1058
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001059 if (!bdrv_is_inserted(bs)) {
1060 error_setg(errp, "Device has no medium");
Emanuele Giuseppe Esposito1e97be92023-01-13 21:42:02 +01001061 bs = NULL;
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001062 }
1063
Emanuele Giuseppe Esposito1e97be92023-01-13 21:42:02 +01001064 aio_context_release(aio_context);
1065
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001066 return bs;
1067}
1068
Eric Blake10f75902016-03-03 09:16:50 -07001069static void blockdev_do_action(TransactionAction *action, Error **errp)
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001070{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001071 TransactionActionList list;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001072
Eric Blake10f75902016-03-03 09:16:50 -07001073 list.value = action;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001074 list.next = NULL;
Markus Armbruster238e9202022-11-04 17:07:08 +01001075 qmp_transaction(&list, NULL, errp);
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001076}
1077
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001078void qmp_blockdev_snapshot_sync(const char *device, const char *node_name,
Benoît Canet0901f672014-01-23 21:31:38 +01001079 const char *snapshot_file,
Benoît Canet0901f672014-01-23 21:31:38 +01001080 const char *snapshot_node_name,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001081 const char *format,
Benoît Canet0901f672014-01-23 21:31:38 +01001082 bool has_mode, NewImageMode mode, Error **errp)
Jes Sorensenf8882562010-12-16 13:52:16 +01001083{
Alberto Garciaa911e6a2015-10-26 14:27:14 +02001084 BlockdevSnapshotSync snapshot = {
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001085 .device = (char *) device,
Benoît Canet0901f672014-01-23 21:31:38 +01001086 .node_name = (char *) node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001087 .snapshot_file = (char *) snapshot_file,
Benoît Canet0901f672014-01-23 21:31:38 +01001088 .snapshot_node_name = (char *) snapshot_node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001089 .format = (char *) format,
1090 .has_mode = has_mode,
1091 .mode = mode,
1092 };
Eric Blake10f75902016-03-03 09:16:50 -07001093 TransactionAction action = {
1094 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001095 .u.blockdev_snapshot_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001096 };
1097 blockdev_do_action(&action, errp);
Jes Sorensenf8882562010-12-16 13:52:16 +01001098}
1099
Alberto Garcia43de7e22015-10-26 14:27:16 +02001100void qmp_blockdev_snapshot(const char *node, const char *overlay,
1101 Error **errp)
1102{
1103 BlockdevSnapshot snapshot_data = {
1104 .node = (char *) node,
1105 .overlay = (char *) overlay
1106 };
Eric Blake10f75902016-03-03 09:16:50 -07001107 TransactionAction action = {
1108 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
Eric Blake32bafa82016-03-17 16:48:37 -06001109 .u.blockdev_snapshot.data = &snapshot_data,
Eric Blake10f75902016-03-03 09:16:50 -07001110 };
1111 blockdev_do_action(&action, errp);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001112}
1113
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001114void qmp_blockdev_snapshot_internal_sync(const char *device,
1115 const char *name,
1116 Error **errp)
1117{
1118 BlockdevSnapshotInternal snapshot = {
1119 .device = (char *) device,
1120 .name = (char *) name
1121 };
Eric Blake10f75902016-03-03 09:16:50 -07001122 TransactionAction action = {
1123 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001124 .u.blockdev_snapshot_internal_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001125 };
1126 blockdev_do_action(&action, errp);
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001127}
1128
Wenchao Xia44e3e052013-09-11 14:04:36 +08001129SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
Wenchao Xia44e3e052013-09-11 14:04:36 +08001130 const char *id,
Wenchao Xia44e3e052013-09-11 14:04:36 +08001131 const char *name,
1132 Error **errp)
1133{
Fam Zhenga0e85442015-03-02 19:36:48 +08001134 BlockDriverState *bs;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001135 AioContext *aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001136 QEMUSnapshotInfo sn;
1137 Error *local_err = NULL;
1138 SnapshotInfo *info = NULL;
1139 int ret;
1140
Kevin Wolfa32e7812023-09-29 16:51:42 +02001141 GLOBAL_STATE_CODE();
1142 GRAPH_RDLOCK_GUARD_MAINLOOP();
1143
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001144 bs = qmp_get_root_bs(device, errp);
1145 if (!bs) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001146 return NULL;
1147 }
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001148 aio_context = bdrv_get_aio_context(bs);
Max Reitz5433c242015-10-19 17:53:29 +02001149 aio_context_acquire(aio_context);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001150
Wenchao Xia44e3e052013-09-11 14:04:36 +08001151 if (!id && !name) {
1152 error_setg(errp, "Name or id must be provided");
Max Reitz5433c242015-10-19 17:53:29 +02001153 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001154 }
1155
Stefan Hajnoczi0b928852014-11-19 14:19:43 +00001156 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1157 goto out_aio_context;
1158 }
1159
Wenchao Xia44e3e052013-09-11 14:04:36 +08001160 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001161 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001162 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001163 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001164 }
1165 if (!ret) {
1166 error_setg(errp,
1167 "Snapshot with id '%s' and name '%s' does not exist on "
1168 "device '%s'",
1169 STR_OR_NULL(id), STR_OR_NULL(name), device);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001170 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001171 }
1172
1173 bdrv_snapshot_delete(bs, id, name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001174 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001175 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001176 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001177 }
1178
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001179 aio_context_release(aio_context);
1180
Markus Armbruster5839e532014-08-19 10:31:08 +02001181 info = g_new0(SnapshotInfo, 1);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001182 info->id = g_strdup(sn.id_str);
1183 info->name = g_strdup(sn.name);
1184 info->date_nsec = sn.date_nsec;
1185 info->date_sec = sn.date_sec;
1186 info->vm_state_size = sn.vm_state_size;
1187 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1188 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001189 if (sn.icount != -1ULL) {
1190 info->icount = sn.icount;
1191 info->has_icount = true;
1192 }
Wenchao Xia44e3e052013-09-11 14:04:36 +08001193
1194 return info;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001195
1196out_aio_context:
1197 aio_context_release(aio_context);
1198 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001199}
Jeff Cody8802d1f2012-02-28 15:54:06 -05001200
Wenchao Xiabbe86012013-09-11 14:04:34 +08001201/* internal snapshot private data */
1202typedef struct InternalSnapshotState {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001203 BlockDriverState *bs;
1204 QEMUSnapshotInfo sn;
Fam Zheng507306c2015-10-23 11:08:13 +08001205 bool created;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001206} InternalSnapshotState;
1207
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001208static void internal_snapshot_abort(void *opaque);
1209static void internal_snapshot_clean(void *opaque);
1210TransactionActionDrv internal_snapshot_drv = {
1211 .abort = internal_snapshot_abort,
1212 .clean = internal_snapshot_clean,
1213};
John Snow94d16a62015-11-05 18:13:18 -05001214
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001215static void internal_snapshot_action(BlockdevSnapshotInternal *internal,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001216 Transaction *tran, Error **errp)
Wenchao Xiabbe86012013-09-11 14:04:34 +08001217{
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001218 Error *local_err = NULL;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001219 const char *device;
1220 const char *name;
1221 BlockDriverState *bs;
1222 QEMUSnapshotInfo old_sn, *sn;
1223 bool ret;
Marc-André Lureauf793dde2022-03-07 11:04:00 +04001224 int64_t rt;
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001225 InternalSnapshotState *state = g_new0(InternalSnapshotState, 1);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001226 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001227 int ret1;
1228
Kevin Wolfa32e7812023-09-29 16:51:42 +02001229 GLOBAL_STATE_CODE();
1230 GRAPH_RDLOCK_GUARD_MAINLOOP();
1231
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001232 tran_add(tran, &internal_snapshot_drv, state);
1233
Wenchao Xiabbe86012013-09-11 14:04:34 +08001234 device = internal->device;
1235 name = internal->name;
1236
Kevin Wolf75dfd402016-06-23 14:20:24 +02001237 bs = qmp_get_root_bs(device, errp);
1238 if (!bs) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001239 return;
1240 }
1241
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001242 aio_context = bdrv_get_aio_context(bs);
1243 aio_context_acquire(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001244
Fam Zheng507306c2015-10-23 11:08:13 +08001245 state->bs = bs;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001246
1247 /* Paired with .clean() */
Fam Zheng507306c2015-10-23 11:08:13 +08001248 bdrv_drained_begin(bs);
1249
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001250 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001251 goto out;
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001252 }
1253
Wenchao Xiabbe86012013-09-11 14:04:34 +08001254 if (bdrv_is_read_only(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001255 error_setg(errp, "Device '%s' is read only", device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001256 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001257 }
1258
1259 if (!bdrv_can_snapshot(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001260 error_setg(errp, "Block format '%s' used by device '%s' "
1261 "does not support internal snapshots",
1262 bs->drv->format_name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001263 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001264 }
1265
1266 if (!strlen(name)) {
1267 error_setg(errp, "Name is empty");
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001268 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001269 }
1270
1271 /* check whether a snapshot with name exist */
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001272 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1273 &local_err);
1274 if (local_err) {
1275 error_propagate(errp, local_err);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001276 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001277 } else if (ret) {
1278 error_setg(errp,
1279 "Snapshot with name '%s' already exists on device '%s'",
1280 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001281 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001282 }
1283
1284 /* 3. take the snapshot */
1285 sn = &state->sn;
1286 pstrcpy(sn->name, sizeof(sn->name), name);
Marc-André Lureauf793dde2022-03-07 11:04:00 +04001287 rt = g_get_real_time();
1288 sn->date_sec = rt / G_USEC_PER_SEC;
1289 sn->date_nsec = (rt % G_USEC_PER_SEC) * 1000;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001290 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001291 if (replay_mode != REPLAY_MODE_NONE) {
1292 sn->icount = replay_get_current_icount();
1293 } else {
1294 sn->icount = -1ULL;
1295 }
Wenchao Xiabbe86012013-09-11 14:04:34 +08001296
1297 ret1 = bdrv_snapshot_create(bs, sn);
1298 if (ret1 < 0) {
1299 error_setg_errno(errp, -ret1,
1300 "Failed to create snapshot '%s' on device '%s'",
1301 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001302 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001303 }
1304
1305 /* 4. succeed, mark a snapshot is created */
Fam Zheng507306c2015-10-23 11:08:13 +08001306 state->created = true;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001307
1308out:
1309 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001310}
1311
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001312static void internal_snapshot_abort(void *opaque)
Wenchao Xiabbe86012013-09-11 14:04:34 +08001313{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001314 InternalSnapshotState *state = opaque;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001315 BlockDriverState *bs = state->bs;
1316 QEMUSnapshotInfo *sn = &state->sn;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001317 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001318 Error *local_error = NULL;
1319
Kevin Wolfa32e7812023-09-29 16:51:42 +02001320 GLOBAL_STATE_CODE();
1321 GRAPH_RDLOCK_GUARD_MAINLOOP();
1322
Fam Zheng507306c2015-10-23 11:08:13 +08001323 if (!state->created) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001324 return;
1325 }
1326
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001327 aio_context = bdrv_get_aio_context(state->bs);
1328 aio_context_acquire(aio_context);
1329
Wenchao Xiabbe86012013-09-11 14:04:34 +08001330 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001331 error_reportf_err(local_error,
1332 "Failed to delete snapshot with id '%s' and "
1333 "name '%s' on device '%s' in abort: ",
1334 sn->id_str, sn->name,
1335 bdrv_get_device_name(bs));
Wenchao Xiabbe86012013-09-11 14:04:34 +08001336 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001337
1338 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001339}
1340
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001341static void internal_snapshot_clean(void *opaque)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001342{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001343 g_autofree InternalSnapshotState *state = opaque;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001344 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001345
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001346 if (!state->bs) {
1347 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001348 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001349
1350 aio_context = bdrv_get_aio_context(state->bs);
1351 aio_context_acquire(aio_context);
1352
1353 bdrv_drained_end(state->bs);
1354
1355 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001356}
1357
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001358/* external snapshot private data */
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001359typedef struct ExternalSnapshotState {
Jeff Cody8802d1f2012-02-28 15:54:06 -05001360 BlockDriverState *old_bs;
1361 BlockDriverState *new_bs;
Kevin Wolf067acf22017-03-02 15:26:18 +01001362 bool overlay_appended;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001363} ExternalSnapshotState;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001364
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001365static void external_snapshot_commit(void *opaque);
1366static void external_snapshot_abort(void *opaque);
1367static void external_snapshot_clean(void *opaque);
1368TransactionActionDrv external_snapshot_drv = {
1369 .commit = external_snapshot_commit,
1370 .abort = external_snapshot_abort,
1371 .clean = external_snapshot_clean,
1372};
1373
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001374static void external_snapshot_action(TransactionAction *action,
1375 Transaction *tran, Error **errp)
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001376{
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001377 int ret;
Max Reitz5b363932016-05-17 16:41:31 +02001378 int flags = 0;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001379 QDict *options = NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001380 Error *local_err = NULL;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001381 /* Device and node name of the image to generate the snapshot from */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001382 const char *device;
Benoît Canet0901f672014-01-23 21:31:38 +01001383 const char *node_name;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001384 /* Reference to the new image (for 'blockdev-snapshot') */
1385 const char *snapshot_ref;
1386 /* File name of the new image (for 'blockdev-snapshot-sync') */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001387 const char *new_image_file;
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001388 ExternalSnapshotState *state = g_new0(ExternalSnapshotState, 1);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001389 AioContext *aio_context;
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001390 uint64_t perm, shared;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001391
Kevin Wolfbce73bc2023-09-11 11:46:13 +02001392 /* TODO We'll eventually have to take a writer lock in this function */
1393 GRAPH_RDLOCK_GUARD_MAINLOOP();
1394
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001395 tran_add(tran, &external_snapshot_drv, state);
1396
Alberto Garcia43de7e22015-10-26 14:27:16 +02001397 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1398 * purpose but a different set of parameters */
1399 switch (action->type) {
1400 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1401 {
Eric Blake32bafa82016-03-17 16:48:37 -06001402 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001403 device = s->node;
1404 node_name = s->node;
1405 new_image_file = NULL;
1406 snapshot_ref = s->overlay;
1407 }
1408 break;
1409 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1410 {
Eric Blake32bafa82016-03-17 16:48:37 -06001411 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001412 device = s->device;
1413 node_name = s->node_name;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001414 new_image_file = s->snapshot_file;
1415 snapshot_ref = NULL;
1416 }
1417 break;
1418 default:
1419 g_assert_not_reached();
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001420 }
1421
1422 /* start processing */
John Snow94d16a62015-11-05 18:13:18 -05001423
Alberto Garcia43de7e22015-10-26 14:27:16 +02001424 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1425 if (!state->old_bs) {
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001426 return;
1427 }
1428
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001429 aio_context = bdrv_get_aio_context(state->old_bs);
1430 aio_context_acquire(aio_context);
1431
1432 /* Paired with .clean() */
Fam Zhengda763e82015-10-23 11:08:10 +08001433 bdrv_drained_begin(state->old_bs);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001434
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001435 if (!bdrv_is_inserted(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001436 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001437 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001438 }
1439
Fam Zheng3718d8a2014-05-23 21:29:43 +08001440 if (bdrv_op_is_blocked(state->old_bs,
1441 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001442 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001443 }
1444
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001445 if (!bdrv_is_read_only(state->old_bs)) {
1446 if (bdrv_flush(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001447 error_setg(errp, QERR_IO_ERROR);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001448 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001449 }
1450 }
1451
Alberto Garcia43de7e22015-10-26 14:27:16 +02001452 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
Eric Blake32bafa82016-03-17 16:48:37 -06001453 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001454 const char *format = s->format ?: "qcow2";
Alberto Garcia43de7e22015-10-26 14:27:16 +02001455 enum NewImageMode mode;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001456 const char *snapshot_node_name = s->snapshot_node_name;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001457
Alberto Garcia43de7e22015-10-26 14:27:16 +02001458 if (node_name && !snapshot_node_name) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001459 error_setg(errp, "New overlay node-name missing");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001460 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001461 }
Alberto Garcia43de7e22015-10-26 14:27:16 +02001462
1463 if (snapshot_node_name &&
1464 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001465 error_setg(errp, "New overlay node-name already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001466 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001467 }
1468
1469 flags = state->old_bs->open_flags;
John Snow2a32c6e2017-07-17 20:34:21 -04001470 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1471 flags |= BDRV_O_NO_BACKING;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001472
1473 /* create new image w/backing file */
1474 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1475 if (mode != NEW_IMAGE_MODE_EXISTING) {
Kevin Wolff86b8b52016-03-02 12:16:44 +01001476 int64_t size = bdrv_getlength(state->old_bs);
1477 if (size < 0) {
1478 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001479 goto out;
Kevin Wolff86b8b52016-03-02 12:16:44 +01001480 }
Max Reitzf30c66b2019-02-01 20:29:05 +01001481 bdrv_refresh_filename(state->old_bs);
Kevin Wolfe1355052022-12-07 14:18:30 +01001482
1483 aio_context_release(aio_context);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001484 bdrv_img_create(new_image_file, format,
1485 state->old_bs->filename,
1486 state->old_bs->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08001487 NULL, size, flags, false, &local_err);
Kevin Wolfe1355052022-12-07 14:18:30 +01001488 aio_context_acquire(aio_context);
1489
Alberto Garcia43de7e22015-10-26 14:27:16 +02001490 if (local_err) {
1491 error_propagate(errp, local_err);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001492 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001493 }
1494 }
1495
1496 options = qdict_new();
Peter Maydelld52e1a02018-11-01 16:30:37 +00001497 if (snapshot_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05001498 qdict_put_str(options, "node-name", snapshot_node_name);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001499 }
Eric Blake46f5ac22017-04-27 16:58:17 -05001500 qdict_put_str(options, "driver", format);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001501 }
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001502 aio_context_release(aio_context);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001503
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001504 aio_context_acquire(qemu_get_aio_context());
Max Reitz5b363932016-05-17 16:41:31 +02001505 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1506 errp);
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001507 aio_context_release(qemu_get_aio_context());
1508
Max Reitzf67503e2014-02-18 18:33:05 +01001509 /* We will manually add the backing_hd field to the bs later */
Max Reitz5b363932016-05-17 16:41:31 +02001510 if (!state->new_bs) {
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001511 return;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001512 }
1513
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001514 aio_context_acquire(aio_context);
1515
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001516 /*
1517 * Allow attaching a backing file to an overlay that's already in use only
1518 * if the parents don't assume that they are already seeing a valid image.
1519 * (Specifically, allow it as a mirror target, which is write-only access.)
1520 */
1521 bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1522 if (perm & BLK_PERM_CONSISTENT_READ) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001523 error_setg(errp, "The overlay is already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001524 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001525 }
1526
Max Reitz7cc734a2019-06-12 18:34:46 +02001527 if (state->new_bs->drv->is_filter) {
1528 error_setg(errp, "Filters cannot be used as overlays");
1529 goto out;
1530 }
1531
1532 if (bdrv_cow_child(state->new_bs)) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001533 error_setg(errp, "The overlay already has a backing image");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001534 goto out;
Alberto Garcia08b24cf2015-11-03 12:32:35 +02001535 }
1536
1537 if (!state->new_bs->drv->supports_backing) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001538 error_setg(errp, "The overlay does not support backing images");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001539 goto out;
Kevin Wolfb2c28322017-02-20 12:46:42 +01001540 }
1541
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001542 ret = bdrv_append(state->new_bs, state->old_bs, errp);
1543 if (ret < 0) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001544 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001545 }
Kevin Wolf067acf22017-03-02 15:26:18 +01001546 state->overlay_appended = true;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001547
1548out:
1549 aio_context_release(aio_context);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001550}
1551
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001552static void external_snapshot_commit(void *opaque)
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001553{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001554 ExternalSnapshotState *state = opaque;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001555 AioContext *aio_context;
1556
1557 aio_context = bdrv_get_aio_context(state->old_bs);
1558 aio_context_acquire(aio_context);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001559
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001560 /* We don't need (or want) to use the transactional
1561 * bdrv_reopen_multiple() across all the entries at once, because we
1562 * don't want to abort all of them if one of them fails the reopen */
Stefan Hajnoczid73415a2020-09-23 11:56:46 +01001563 if (!qatomic_read(&state->old_bs->copy_on_read)) {
Alberto Garcia1b577742018-11-12 16:00:39 +02001564 bdrv_reopen_set_read_only(state->old_bs, true, NULL);
Kevin Wolf4c844982016-02-29 13:12:26 +01001565 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001566
1567 aio_context_release(aio_context);
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001568}
1569
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001570static void external_snapshot_abort(void *opaque)
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001571{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001572 ExternalSnapshotState *state = opaque;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001573 if (state->new_bs) {
Kevin Wolf067acf22017-03-02 15:26:18 +01001574 if (state->overlay_appended) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001575 AioContext *aio_context;
Sergio Lopez377410f2020-01-08 15:31:37 +01001576 AioContext *tmp_context;
1577 int ret;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001578
1579 aio_context = bdrv_get_aio_context(state->old_bs);
1580 aio_context_acquire(aio_context);
1581
Jeff Cody719fc282017-06-07 09:55:22 -04001582 bdrv_ref(state->old_bs); /* we can't let bdrv_set_backind_hd()
1583 close state->old_bs; we need it */
1584 bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
Sergio Lopez377410f2020-01-08 15:31:37 +01001585
1586 /*
1587 * The call to bdrv_set_backing_hd() above returns state->old_bs to
1588 * the main AioContext. As we're still going to be using it, return
1589 * it to the AioContext it was before.
1590 */
1591 tmp_context = bdrv_get_aio_context(state->old_bs);
1592 if (aio_context != tmp_context) {
1593 aio_context_release(aio_context);
1594 aio_context_acquire(tmp_context);
1595
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001596 ret = bdrv_try_change_aio_context(state->old_bs,
1597 aio_context, NULL, NULL);
Sergio Lopez377410f2020-01-08 15:31:37 +01001598 assert(ret == 0);
1599
1600 aio_context_release(tmp_context);
1601 aio_context_acquire(aio_context);
1602 }
1603
Kevin Wolf5fe31c22017-03-06 16:20:51 +01001604 bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
Jeff Cody719fc282017-06-07 09:55:22 -04001605 bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001606
1607 aio_context_release(aio_context);
Kevin Wolfb2c28322017-02-20 12:46:42 +01001608 }
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001609 }
Fam Zhengda763e82015-10-23 11:08:10 +08001610}
1611
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001612static void external_snapshot_clean(void *opaque)
Fam Zhengda763e82015-10-23 11:08:10 +08001613{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001614 g_autofree ExternalSnapshotState *state = opaque;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001615 AioContext *aio_context;
1616
1617 if (!state->old_bs) {
1618 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001619 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001620
1621 aio_context = bdrv_get_aio_context(state->old_bs);
1622 aio_context_acquire(aio_context);
1623
1624 bdrv_drained_end(state->old_bs);
1625 bdrv_unref(state->new_bs);
1626
1627 aio_context_release(aio_context);
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001628}
1629
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001630typedef struct DriveBackupState {
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001631 BlockDriverState *bs;
1632 BlockJob *job;
1633} DriveBackupState;
1634
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001635static BlockJob *do_backup_common(BackupCommon *backup,
1636 BlockDriverState *bs,
1637 BlockDriverState *target_bs,
1638 AioContext *aio_context,
1639 JobTxn *txn, Error **errp);
John Snow78f51fd2015-11-05 18:13:17 -05001640
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001641static void drive_backup_commit(void *opaque);
1642static void drive_backup_abort(void *opaque);
1643static void drive_backup_clean(void *opaque);
1644TransactionActionDrv drive_backup_drv = {
1645 .commit = drive_backup_commit,
1646 .abort = drive_backup_abort,
1647 .clean = drive_backup_clean,
1648};
1649
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001650static void drive_backup_action(DriveBackup *backup,
1651 JobTxn *block_job_txn,
1652 Transaction *tran, Error **errp)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001653{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001654 DriveBackupState *state = g_new0(DriveBackupState, 1);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001655 BlockDriverState *bs;
1656 BlockDriverState *target_bs;
1657 BlockDriverState *source = NULL;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001658 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001659 AioContext *old_context;
Markus Armbruster04658a52022-11-04 17:06:50 +01001660 const char *format;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001661 QDict *options;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001662 Error *local_err = NULL;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001663 int flags;
1664 int64_t size;
1665 bool set_backing_hd = false;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001666 int ret;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001667
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001668 tran_add(tran, &drive_backup_drv, state);
1669
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001670 if (!backup->has_mode) {
1671 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1672 }
1673
Vladimir Sementsov-Ogievskiy85c9d132019-06-18 17:08:04 +03001674 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001675 if (!bs) {
Fam Zheng1fdd4b72015-10-23 11:08:11 +08001676 return;
1677 }
1678
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001679 if (!bs->drv) {
1680 error_setg(errp, "Device has no medium");
1681 return;
1682 }
1683
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001684 aio_context = bdrv_get_aio_context(bs);
1685 aio_context_acquire(aio_context);
1686
Vladimir Sementsov-Ogievskiy2842ff22021-06-08 10:18:52 -07001687 state->bs = bs;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001688 /* Paired with .clean() */
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001689 bdrv_drained_begin(bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001690
Markus Armbruster04658a52022-11-04 17:06:50 +01001691 format = backup->format;
1692 if (!format && backup->mode != NEW_IMAGE_MODE_EXISTING) {
1693 format = bs->drv->format_name;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001694 }
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001695
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001696 /* Early check to avoid creating target */
1697 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
1698 goto out;
1699 }
1700
1701 flags = bs->open_flags | BDRV_O_RDWR;
1702
1703 /*
1704 * See if we have a backing HD we can use to create our new image
1705 * on top of.
1706 */
1707 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
Max Reitz2b088c62019-06-12 17:46:45 +02001708 /*
1709 * Backup will not replace the source by the target, so none
1710 * of the filters skipped here will be removed (in contrast to
1711 * mirror). Therefore, we can skip all of them when looking
1712 * for the first COW relationship.
1713 */
1714 source = bdrv_cow_bs(bdrv_skip_filters(bs));
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001715 if (!source) {
1716 backup->sync = MIRROR_SYNC_MODE_FULL;
1717 }
1718 }
1719 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1720 source = bs;
1721 flags |= BDRV_O_NO_BACKING;
1722 set_backing_hd = true;
1723 }
1724
1725 size = bdrv_getlength(bs);
1726 if (size < 0) {
1727 error_setg_errno(errp, -size, "bdrv_getlength failed");
1728 goto out;
1729 }
1730
1731 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
Markus Armbruster04658a52022-11-04 17:06:50 +01001732 assert(format);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001733 if (source) {
Max Reitz2b088c62019-06-12 17:46:45 +02001734 /* Implicit filters should not appear in the filename */
1735 BlockDriverState *explicit_backing =
1736 bdrv_skip_implicit_filters(source);
1737
1738 bdrv_refresh_filename(explicit_backing);
Markus Armbruster04658a52022-11-04 17:06:50 +01001739 bdrv_img_create(backup->target, format,
Max Reitz2b088c62019-06-12 17:46:45 +02001740 explicit_backing->filename,
1741 explicit_backing->drv->format_name, NULL,
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001742 size, flags, false, &local_err);
1743 } else {
Markus Armbruster04658a52022-11-04 17:06:50 +01001744 bdrv_img_create(backup->target, format, NULL, NULL, NULL,
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001745 size, flags, false, &local_err);
1746 }
1747 }
1748
Markus Armbruster84d18f02014-01-30 15:07:28 +01001749 if (local_err) {
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001750 error_propagate(errp, local_err);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001751 goto out;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001752 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001753
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001754 options = qdict_new();
1755 qdict_put_str(options, "discard", "unmap");
1756 qdict_put_str(options, "detect-zeroes", "unmap");
Markus Armbruster04658a52022-11-04 17:06:50 +01001757 if (format) {
1758 qdict_put_str(options, "driver", format);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001759 }
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001760 aio_context_release(aio_context);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001761
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001762 aio_context_acquire(qemu_get_aio_context());
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001763 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001764 aio_context_release(qemu_get_aio_context());
1765
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001766 if (!target_bs) {
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001767 return;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001768 }
1769
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001770 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001771 old_context = bdrv_get_aio_context(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001772 aio_context_acquire(old_context);
1773
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001774 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001775 if (ret < 0) {
1776 bdrv_unref(target_bs);
1777 aio_context_release(old_context);
1778 return;
1779 }
1780
1781 aio_context_release(old_context);
1782 aio_context_acquire(aio_context);
1783
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001784 if (set_backing_hd) {
Vladimir Sementsov-Ogievskiy5a11a1c2021-02-02 15:49:46 +03001785 if (bdrv_set_backing_hd(target_bs, source, errp) < 0) {
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001786 goto unref;
1787 }
1788 }
1789
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001790 state->job = do_backup_common(qapi_DriveBackup_base(backup),
1791 bs, target_bs, aio_context,
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001792 block_job_txn, errp);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001793
1794unref:
1795 bdrv_unref(target_bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001796out:
1797 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001798}
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001799
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001800static void drive_backup_commit(void *opaque)
John Snow111049a2016-11-08 01:50:38 -05001801{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001802 DriveBackupState *state = opaque;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001803 AioContext *aio_context;
1804
1805 aio_context = bdrv_get_aio_context(state->bs);
1806 aio_context_acquire(aio_context);
1807
John Snow111049a2016-11-08 01:50:38 -05001808 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001809 job_start(&state->job->job);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001810
1811 aio_context_release(aio_context);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001812}
1813
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001814static void drive_backup_abort(void *opaque)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001815{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001816 DriveBackupState *state = opaque;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001817
John Snow111049a2016-11-08 01:50:38 -05001818 if (state->job) {
Hanna Reitz4cfb3f02021-10-06 17:19:32 +02001819 job_cancel_sync(&state->job->job, true);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001820 }
1821}
1822
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001823static void drive_backup_clean(void *opaque)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001824{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001825 g_autofree DriveBackupState *state = opaque;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001826 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001827
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001828 if (!state->bs) {
1829 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001830 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001831
1832 aio_context = bdrv_get_aio_context(state->bs);
1833 aio_context_acquire(aio_context);
1834
1835 bdrv_drained_end(state->bs);
1836
1837 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001838}
1839
Fam Zhengbd8baec2014-12-18 18:37:06 +08001840typedef struct BlockdevBackupState {
Fam Zhengbd8baec2014-12-18 18:37:06 +08001841 BlockDriverState *bs;
1842 BlockJob *job;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001843} BlockdevBackupState;
1844
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001845static void blockdev_backup_commit(void *opaque);
1846static void blockdev_backup_abort(void *opaque);
1847static void blockdev_backup_clean(void *opaque);
1848TransactionActionDrv blockdev_backup_drv = {
1849 .commit = blockdev_backup_commit,
1850 .abort = blockdev_backup_abort,
1851 .clean = blockdev_backup_clean,
1852};
1853
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001854static void blockdev_backup_action(BlockdevBackup *backup,
1855 JobTxn *block_job_txn,
1856 Transaction *tran, Error **errp)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001857{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001858 BlockdevBackupState *state = g_new0(BlockdevBackupState, 1);
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001859 BlockDriverState *bs;
1860 BlockDriverState *target_bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001861 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001862 AioContext *old_context;
1863 int ret;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001864
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001865 tran_add(tran, &blockdev_backup_drv, state);
1866
Vladimir Sementsov-Ogievskiy930fe172018-07-02 15:46:29 -04001867 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001868 if (!bs) {
Fam Zhengff52bf32015-10-23 11:08:12 +08001869 return;
1870 }
1871
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001872 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1873 if (!target_bs) {
Fam Zhengbd8baec2014-12-18 18:37:06 +08001874 return;
1875 }
1876
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001877 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001878 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001879 old_context = bdrv_get_aio_context(target_bs);
1880 aio_context_acquire(old_context);
1881
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001882 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001883 if (ret < 0) {
1884 aio_context_release(old_context);
1885 return;
1886 }
1887
1888 aio_context_release(old_context);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001889 aio_context_acquire(aio_context);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001890 state->bs = bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001891
1892 /* Paired with .clean() */
Fam Zhengff52bf32015-10-23 11:08:12 +08001893 bdrv_drained_begin(state->bs);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001894
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001895 state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1896 bs, target_bs, aio_context,
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001897 block_job_txn, errp);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001898
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001899 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001900}
Fam Zhengbd8baec2014-12-18 18:37:06 +08001901
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001902static void blockdev_backup_commit(void *opaque)
John Snow111049a2016-11-08 01:50:38 -05001903{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001904 BlockdevBackupState *state = opaque;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001905 AioContext *aio_context;
1906
1907 aio_context = bdrv_get_aio_context(state->bs);
1908 aio_context_acquire(aio_context);
1909
John Snow111049a2016-11-08 01:50:38 -05001910 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001911 job_start(&state->job->job);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001912
1913 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001914}
1915
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001916static void blockdev_backup_abort(void *opaque)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001917{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001918 BlockdevBackupState *state = opaque;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001919
John Snow111049a2016-11-08 01:50:38 -05001920 if (state->job) {
Hanna Reitz4cfb3f02021-10-06 17:19:32 +02001921 job_cancel_sync(&state->job->job, true);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001922 }
1923}
1924
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001925static void blockdev_backup_clean(void *opaque)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001926{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001927 g_autofree BlockdevBackupState *state = opaque;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001928 AioContext *aio_context;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001929
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001930 if (!state->bs) {
1931 return;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001932 }
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001933
1934 aio_context = bdrv_get_aio_context(state->bs);
1935 aio_context_acquire(aio_context);
1936
1937 bdrv_drained_end(state->bs);
1938
1939 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001940}
1941
Fam Zhengdf9a6812015-11-09 18:16:54 +08001942typedef struct BlockDirtyBitmapState {
Fam Zhengdf9a6812015-11-09 18:16:54 +08001943 BdrvDirtyBitmap *bitmap;
1944 BlockDriverState *bs;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001945 HBitmap *backup;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001946 bool was_enabled;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001947} BlockDirtyBitmapState;
1948
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001949static void block_dirty_bitmap_add_abort(void *opaque);
1950TransactionActionDrv block_dirty_bitmap_add_drv = {
1951 .abort = block_dirty_bitmap_add_abort,
1952 .clean = g_free,
1953};
1954
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001955static void block_dirty_bitmap_add_action(BlockDirtyBitmapAdd *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001956 Transaction *tran, Error **errp)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001957{
1958 Error *local_err = NULL;
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001959 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001960
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001961 tran_add(tran, &block_dirty_bitmap_add_drv, state);
1962
Fam Zhengdf9a6812015-11-09 18:16:54 +08001963 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1964 qmp_block_dirty_bitmap_add(action->node, action->name,
1965 action->has_granularity, action->granularity,
Vladimir Sementsov-Ogievskiyfd5ae4c2017-06-28 15:05:23 +03001966 action->has_persistent, action->persistent,
John Snow0e2b7f02018-12-21 04:35:22 -05001967 action->has_disabled, action->disabled,
Fam Zhengdf9a6812015-11-09 18:16:54 +08001968 &local_err);
1969
1970 if (!local_err) {
Vladimir Sementsov-Ogievskiyc85feaf2023-05-10 18:06:23 +03001971 state->bitmap = block_dirty_bitmap_lookup(action->node, action->name,
1972 NULL, &error_abort);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001973 } else {
1974 error_propagate(errp, local_err);
1975 }
1976}
1977
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001978static void block_dirty_bitmap_add_abort(void *opaque)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001979{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001980 BlockDirtyBitmapState *state = opaque;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001981
Vladimir Sementsov-Ogievskiyc85feaf2023-05-10 18:06:23 +03001982 if (state->bitmap) {
1983 bdrv_release_dirty_bitmap(state->bitmap);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001984 }
1985}
1986
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001987static void block_dirty_bitmap_restore(void *opaque);
1988static void block_dirty_bitmap_free_backup(void *opaque);
1989TransactionActionDrv block_dirty_bitmap_clear_drv = {
1990 .abort = block_dirty_bitmap_restore,
1991 .commit = block_dirty_bitmap_free_backup,
1992 .clean = g_free,
1993};
1994
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001995static void block_dirty_bitmap_clear_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001996 Transaction *tran, Error **errp)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001997{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001998 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001999
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002000 tran_add(tran, &block_dirty_bitmap_clear_drv, state);
2001
Fam Zhengdf9a6812015-11-09 18:16:54 +08002002 state->bitmap = block_dirty_bitmap_lookup(action->node,
2003 action->name,
2004 &state->bs,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002005 errp);
2006 if (!state->bitmap) {
2007 return;
2008 }
2009
John Snow3ae96d62019-03-12 12:05:49 -04002010 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
Vladimir Sementsov-Ogievskiyd6883bc2017-06-28 15:05:10 +03002011 return;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002012 }
2013
2014 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
Fam Zhengdf9a6812015-11-09 18:16:54 +08002015}
2016
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002017static void block_dirty_bitmap_restore(void *opaque)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002018{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002019 BlockDirtyBitmapState *state = opaque;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002020
John Snow184dd9c2017-03-15 17:28:11 -04002021 if (state->backup) {
Vladimir Sementsov-Ogievskiy56bd6622018-10-29 16:23:14 -04002022 bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
John Snow184dd9c2017-03-15 17:28:11 -04002023 }
Fam Zhengdf9a6812015-11-09 18:16:54 +08002024}
2025
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002026static void block_dirty_bitmap_free_backup(void *opaque)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002027{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002028 BlockDirtyBitmapState *state = opaque;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002029
2030 hbitmap_free(state->backup);
2031}
2032
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002033static void block_dirty_bitmap_enable_abort(void *opaque);
2034TransactionActionDrv block_dirty_bitmap_enable_drv = {
2035 .abort = block_dirty_bitmap_enable_abort,
2036 .clean = g_free,
2037};
2038
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002039static void block_dirty_bitmap_enable_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002040 Transaction *tran, Error **errp)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002041{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002042 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002043
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002044 tran_add(tran, &block_dirty_bitmap_enable_drv, state);
2045
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002046 state->bitmap = block_dirty_bitmap_lookup(action->node,
2047 action->name,
2048 NULL,
2049 errp);
2050 if (!state->bitmap) {
2051 return;
2052 }
2053
John Snow3ae96d62019-03-12 12:05:49 -04002054 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04002055 return;
2056 }
2057
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002058 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2059 bdrv_enable_dirty_bitmap(state->bitmap);
2060}
2061
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002062static void block_dirty_bitmap_enable_abort(void *opaque)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002063{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002064 BlockDirtyBitmapState *state = opaque;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002065
2066 if (!state->was_enabled) {
2067 bdrv_disable_dirty_bitmap(state->bitmap);
2068 }
2069}
2070
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002071static void block_dirty_bitmap_disable_abort(void *opaque);
2072TransactionActionDrv block_dirty_bitmap_disable_drv = {
2073 .abort = block_dirty_bitmap_disable_abort,
2074 .clean = g_free,
2075};
2076
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002077static void block_dirty_bitmap_disable_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002078 Transaction *tran, Error **errp)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002079{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002080 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002081
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002082 tran_add(tran, &block_dirty_bitmap_disable_drv, state);
2083
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_disable_dirty_bitmap(state->bitmap);
2098}
2099
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002100static void block_dirty_bitmap_disable_abort(void *opaque)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002101{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002102 BlockDirtyBitmapState *state = opaque;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002103
2104 if (state->was_enabled) {
2105 bdrv_enable_dirty_bitmap(state->bitmap);
2106 }
2107}
2108
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002109TransactionActionDrv block_dirty_bitmap_merge_drv = {
2110 .commit = block_dirty_bitmap_free_backup,
2111 .abort = block_dirty_bitmap_restore,
2112 .clean = g_free,
2113};
2114
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002115static void block_dirty_bitmap_merge_action(BlockDirtyBitmapMerge *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002116 Transaction *tran, Error **errp)
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002117{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002118 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002119
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002120 tran_add(tran, &block_dirty_bitmap_merge_drv, state);
2121
Eric Blakec6996cf2020-05-12 20:16:43 -05002122 state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2123 action->bitmaps, &state->backup,
2124 errp);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002125}
2126
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002127static void block_dirty_bitmap_remove_commit(void *opaque);
2128static void block_dirty_bitmap_remove_abort(void *opaque);
2129TransactionActionDrv block_dirty_bitmap_remove_drv = {
2130 .commit = block_dirty_bitmap_remove_commit,
2131 .abort = block_dirty_bitmap_remove_abort,
2132 .clean = g_free,
2133};
2134
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002135static void block_dirty_bitmap_remove_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002136 Transaction *tran, Error **errp)
John Snowc4e4b0f2019-07-29 16:35:54 -04002137{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002138 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
John Snowc4e4b0f2019-07-29 16:35:54 -04002139
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002140 tran_add(tran, &block_dirty_bitmap_remove_drv, state);
2141
John Snowc4e4b0f2019-07-29 16:35:54 -04002142
Eric Blakec6996cf2020-05-12 20:16:43 -05002143 state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2144 false, &state->bs, errp);
John Snowc4e4b0f2019-07-29 16:35:54 -04002145 if (state->bitmap) {
2146 bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2147 bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2148 }
2149}
2150
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002151static void block_dirty_bitmap_remove_abort(void *opaque)
John Snowc4e4b0f2019-07-29 16:35:54 -04002152{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002153 BlockDirtyBitmapState *state = opaque;
John Snowc4e4b0f2019-07-29 16:35:54 -04002154
2155 if (state->bitmap) {
2156 bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2157 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2158 }
2159}
2160
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002161static void block_dirty_bitmap_remove_commit(void *opaque)
John Snowc4e4b0f2019-07-29 16:35:54 -04002162{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002163 BlockDirtyBitmapState *state = opaque;
John Snowc4e4b0f2019-07-29 16:35:54 -04002164
2165 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
Vladimir Sementsov-Ogievskiy5deb6cb2019-09-16 17:19:09 +03002166 bdrv_release_dirty_bitmap(state->bitmap);
John Snowc4e4b0f2019-07-29 16:35:54 -04002167}
2168
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002169static void abort_commit(void *opaque);
2170TransactionActionDrv abort_drv = {
2171 .commit = abort_commit,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002172};
2173
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002174static void abort_action(Transaction *tran, Error **errp)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002175{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002176 tran_add(tran, &abort_drv, NULL);
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002177 error_setg(errp, "Transaction aborted using Abort action");
2178}
2179
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002180static void abort_commit(void *opaque)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002181{
Stefan Weildfc6f862013-07-25 18:21:28 +02002182 g_assert_not_reached(); /* this action never succeeds */
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002183}
2184
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002185static void transaction_action(TransactionAction *act, JobTxn *block_job_txn,
2186 Transaction *tran, Error **errp)
2187{
2188 switch (act->type) {
2189 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
2190 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
2191 external_snapshot_action(act, tran, errp);
2192 return;
2193 case TRANSACTION_ACTION_KIND_DRIVE_BACKUP:
2194 drive_backup_action(act->u.drive_backup.data,
2195 block_job_txn, tran, errp);
2196 return;
2197 case TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP:
2198 blockdev_backup_action(act->u.blockdev_backup.data,
2199 block_job_txn, tran, errp);
2200 return;
2201 case TRANSACTION_ACTION_KIND_ABORT:
2202 abort_action(tran, errp);
2203 return;
2204 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC:
2205 internal_snapshot_action(act->u.blockdev_snapshot_internal_sync.data,
2206 tran, errp);
2207 return;
2208 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD:
2209 block_dirty_bitmap_add_action(act->u.block_dirty_bitmap_add.data,
2210 tran, errp);
2211 return;
2212 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR:
2213 block_dirty_bitmap_clear_action(act->u.block_dirty_bitmap_clear.data,
2214 tran, errp);
2215 return;
2216 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE:
2217 block_dirty_bitmap_enable_action(act->u.block_dirty_bitmap_enable.data,
2218 tran, errp);
2219 return;
2220 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE:
2221 block_dirty_bitmap_disable_action(
2222 act->u.block_dirty_bitmap_disable.data, tran, errp);
2223 return;
2224 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE:
2225 block_dirty_bitmap_merge_action(act->u.block_dirty_bitmap_merge.data,
2226 tran, errp);
2227 return;
2228 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE:
2229 block_dirty_bitmap_remove_action(act->u.block_dirty_bitmap_remove.data,
2230 tran, errp);
2231 return;
2232 /*
2233 * Where are transactions for MIRROR, COMMIT and STREAM?
John Snow66da04d2018-09-06 09:02:25 -04002234 * Although these blockjobs use transaction callbacks like the backup job,
2235 * these jobs do not necessarily adhere to transaction semantics.
2236 * These jobs may not fully undo all of their actions on abort, nor do they
2237 * necessarily work in transactions with more than one job in them.
2238 */
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002239 case TRANSACTION_ACTION_KIND__MAX:
2240 default:
2241 g_assert_not_reached();
2242 };
2243}
2244
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002245
Jeff Cody8802d1f2012-02-28 15:54:06 -05002246/*
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002247 * 'Atomic' group operations. The operations are performed as a set, and if
2248 * any fail then we roll back all operations in the group.
Emanuele Giuseppe Espositoebc27522022-03-03 10:15:56 -05002249 *
2250 * Always run under BQL.
Jeff Cody8802d1f2012-02-28 15:54:06 -05002251 */
Vladimir Sementsov-Ogievskiy24039692023-05-10 18:06:20 +03002252void qmp_transaction(TransactionActionList *actions,
2253 struct TransactionProperties *properties,
John Snow94d16a62015-11-05 18:13:18 -05002254 Error **errp)
Jeff Cody8802d1f2012-02-28 15:54:06 -05002255{
Vladimir Sementsov-Ogievskiy30c96b52023-05-10 18:06:21 +03002256 TransactionActionList *act;
Kevin Wolf62c9e412018-04-19 16:09:52 +02002257 JobTxn *block_job_txn = NULL;
Luiz Capitulino43e17042012-11-30 10:52:07 -02002258 Error *local_err = NULL;
Vladimir Sementsov-Ogievskiyc85f34c2023-05-10 18:06:22 +03002259 Transaction *tran;
2260 ActionCompletionMode comp_mode =
2261 properties ? properties->completion_mode :
2262 ACTION_COMPLETION_MODE_INDIVIDUAL;
Jeff Cody8802d1f2012-02-28 15:54:06 -05002263
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05002264 GLOBAL_STATE_CODE();
2265
John Snow94d16a62015-11-05 18:13:18 -05002266 /* Does this transaction get canceled as a group on failure?
Kevin Wolf62c9e412018-04-19 16:09:52 +02002267 * If not, we don't really need to make a JobTxn.
John Snow94d16a62015-11-05 18:13:18 -05002268 */
Vladimir Sementsov-Ogievskiyc85f34c2023-05-10 18:06:22 +03002269 if (comp_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2270 for (act = actions; act; act = act->next) {
2271 TransactionActionKind type = act->value->type;
2272
2273 if (type != TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP &&
2274 type != TRANSACTION_ACTION_KIND_DRIVE_BACKUP)
2275 {
2276 error_setg(errp,
2277 "Action '%s' does not support transaction property "
2278 "completion-mode = %s",
2279 TransactionActionKind_str(type),
2280 ActionCompletionMode_str(comp_mode));
2281 return;
2282 }
2283 }
2284
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002285 block_job_txn = job_txn_new();
John Snow94d16a62015-11-05 18:13:18 -05002286 }
2287
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002288 /* drain all i/o before any operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002289 bdrv_drain_all();
2290
Vladimir Sementsov-Ogievskiyc85f34c2023-05-10 18:06:22 +03002291 tran = tran_new();
2292
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002293 /* We don't do anything in this loop that commits us to the operations */
Vladimir Sementsov-Ogievskiy30c96b52023-05-10 18:06:21 +03002294 for (act = actions; act; act = act->next) {
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002295 transaction_action(act->value, block_job_txn, tran, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002296 if (local_err) {
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002297 error_propagate(errp, local_err);
2298 goto delete_and_fail;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002299 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002300 }
2301
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002302 tran_commit(tran);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002303
2304 /* success */
2305 goto exit;
2306
2307delete_and_fail:
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002308 /* failure, and it is all-or-none; roll back all operations */
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002309 tran_abort(tran);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002310exit:
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002311 job_txn_unref(block_job_txn);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002312}
2313
Vladimir Sementsov-Ogievskiya3b52532017-06-28 15:05:25 +03002314BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2315 const char *name,
2316 Error **errp)
2317{
2318 BdrvDirtyBitmap *bitmap;
2319 BlockDriverState *bs;
2320 BlockDirtyBitmapSha256 *ret = NULL;
2321 char *sha256;
2322
2323 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2324 if (!bitmap || !bs) {
2325 return NULL;
2326 }
2327
2328 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2329 if (sha256 == NULL) {
2330 return NULL;
2331 }
2332
2333 ret = g_new(BlockDirtyBitmapSha256, 1);
2334 ret->sha256 = sha256;
2335
2336 return ret;
2337}
2338
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002339void coroutine_fn qmp_block_resize(const char *device, const char *node_name,
Kevin Wolfeb94b812020-10-05 17:58:55 +02002340 int64_t size, Error **errp)
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002341{
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002342 Error *local_err = NULL;
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002343 BlockBackend *blk;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002344 BlockDriverState *bs;
Kevin Wolfeb94b812020-10-05 17:58:55 +02002345 AioContext *old_ctx;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002346
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002347 bs = bdrv_lookup_bs(device, node_name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002348 if (local_err) {
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002349 error_propagate(errp, local_err);
2350 return;
2351 }
2352
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002353 if (size < 0) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002354 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002355 return;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002356 }
2357
Jeff Cody9c75e162014-06-25 16:55:30 -04002358 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002359 error_setg(errp, QERR_DEVICE_IN_USE, device);
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002360 return;
Jeff Cody9c75e162014-06-25 16:55:30 -04002361 }
2362
Kevin Wolf0c7d2042023-05-04 13:57:34 +02002363 blk = blk_co_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
Eric Blakea3aeeab2020-04-28 14:26:46 -05002364 if (!blk) {
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002365 return;
Kevin Wolfd7086422017-01-13 19:02:32 +01002366 }
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002367
Kevin Wolf8089eab2020-12-03 18:23:10 +01002368 bdrv_co_lock(bs);
John Snow698bdfa2017-05-10 13:39:45 -04002369 bdrv_drained_begin(bs);
Kevin Wolf8089eab2020-12-03 18:23:10 +01002370 bdrv_co_unlock(bs);
2371
Kevin Wolfeb94b812020-10-05 17:58:55 +02002372 old_ctx = bdrv_co_enter(bs);
Alberto Faria247cf5c2022-10-13 14:37:11 +02002373 blk_co_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002374 bdrv_co_leave(bs, old_ctx);
Stefan Hajnoczi927e0e72014-08-18 14:52:28 +01002375
Kevin Wolfeb94b812020-10-05 17:58:55 +02002376 bdrv_co_lock(bs);
Kevin Wolf8089eab2020-12-03 18:23:10 +01002377 bdrv_drained_end(bs);
Kevin Wolf0c7d2042023-05-04 13:57:34 +02002378 blk_co_unref(blk);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002379 bdrv_co_unlock(bs);
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002380}
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002381
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002382void qmp_block_stream(const char *job_id, const char *device,
2383 const char *base,
2384 const char *base_node,
2385 const char *backing_file,
2386 const char *bottom,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002387 bool has_speed, int64_t speed,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002388 bool has_on_error, BlockdevOnError on_error,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002389 const char *filter_node_name,
John Snow241ca1a2018-09-06 09:02:23 -04002390 bool has_auto_finalize, bool auto_finalize,
2391 bool has_auto_dismiss, bool auto_dismiss,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002392 Error **errp)
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002393{
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002394 BlockDriverState *bs, *iter, *iter_end;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002395 BlockDriverState *base_bs = NULL;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002396 BlockDriverState *bottom_bs = NULL;
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002397 AioContext *aio_context;
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002398 Error *local_err = NULL;
John Snowcf6320d2018-09-06 09:02:12 -04002399 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002400
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002401 if (base && base_node) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002402 error_setg(errp, "'base' and 'base-node' cannot be specified "
2403 "at the same time");
2404 return;
2405 }
2406
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002407 if (base && bottom) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002408 error_setg(errp, "'base' and 'bottom' cannot be specified "
2409 "at the same time");
2410 return;
2411 }
2412
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002413 if (bottom && base_node) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002414 error_setg(errp, "'bottom' and 'base-node' cannot be specified "
2415 "at the same time");
2416 return;
2417 }
2418
Paolo Bonzini1d809092012-09-28 17:22:59 +02002419 if (!has_on_error) {
2420 on_error = BLOCKDEV_ON_ERROR_REPORT;
2421 }
2422
Alberto Garcia554b6142016-10-28 10:08:11 +03002423 bs = bdrv_lookup_bs(device, device, errp);
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002424 if (!bs) {
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002425 return;
2426 }
2427
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002428 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002429 aio_context_acquire(aio_context);
2430
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002431 if (base) {
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002432 base_bs = bdrv_find_backing_image(bs, base);
2433 if (base_bs == NULL) {
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002434 error_setg(errp, "Can't find '%s' in the backing chain", base);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002435 goto out;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002436 }
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002437 assert(bdrv_get_aio_context(base_bs) == aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002438 }
2439
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002440 if (base_node) {
Alberto Garcia312fe092016-10-28 10:08:19 +03002441 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2442 if (!base_bs) {
2443 goto out;
2444 }
2445 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2446 error_setg(errp, "Node '%s' is not a backing image of '%s'",
2447 base_node, device);
2448 goto out;
2449 }
2450 assert(bdrv_get_aio_context(base_bs) == aio_context);
Max Reitzf30c66b2019-02-01 20:29:05 +01002451 bdrv_refresh_filename(base_bs);
Alberto Garcia312fe092016-10-28 10:08:19 +03002452 }
2453
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002454 if (bottom) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002455 bottom_bs = bdrv_lookup_bs(NULL, bottom, errp);
2456 if (!bottom_bs) {
2457 goto out;
2458 }
2459 if (!bottom_bs->drv) {
2460 error_setg(errp, "Node '%s' is not open", bottom);
2461 goto out;
2462 }
2463 if (bottom_bs->drv->is_filter) {
2464 error_setg(errp, "Node '%s' is a filter, use a non-filter node "
2465 "as 'bottom'", bottom);
2466 goto out;
2467 }
2468 if (!bdrv_chain_contains(bs, bottom_bs)) {
2469 error_setg(errp, "Node '%s' is not in a chain starting from '%s'",
2470 bottom, device);
2471 goto out;
2472 }
2473 assert(bdrv_get_aio_context(bottom_bs) == aio_context);
2474 }
2475
2476 /*
2477 * Check for op blockers in the whole chain between bs and base (or bottom)
2478 */
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002479 iter_end = bottom ? bdrv_filter_or_cow_bs(bottom_bs) : base_bs;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002480 for (iter = bs; iter && iter != iter_end;
Max Reitz67acfd22019-06-12 17:48:11 +02002481 iter = bdrv_filter_or_cow_bs(iter))
2482 {
Alberto Garcia554b6142016-10-28 10:08:11 +03002483 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
2484 goto out;
2485 }
2486 }
2487
Jeff Cody13d8cc52014-06-25 15:40:11 -04002488 /* if we are streaming the entire chain, the result will have no backing
2489 * file, and specifying one is therefore an error */
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002490 if (!base_bs && backing_file) {
Jeff Cody13d8cc52014-06-25 15:40:11 -04002491 error_setg(errp, "backing file specified, but streaming the "
2492 "entire chain");
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002493 goto out;
Jeff Cody13d8cc52014-06-25 15:40:11 -04002494 }
2495
John Snow241ca1a2018-09-06 09:02:23 -04002496 if (has_auto_finalize && !auto_finalize) {
2497 job_flags |= JOB_MANUAL_FINALIZE;
2498 }
2499 if (has_auto_dismiss && !auto_dismiss) {
2500 job_flags |= JOB_MANUAL_DISMISS;
2501 }
2502
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002503 stream_start(job_id, bs, base_bs, backing_file,
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002504 bottom_bs, job_flags, has_speed ? speed : 0, on_error,
Andrey Shinkevich880747a2020-12-16 09:16:54 +03002505 filter_node_name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002506 if (local_err) {
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002507 error_propagate(errp, local_err);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002508 goto out;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002509 }
2510
Vladimir Sementsov-Ogievskiyb23c5802019-06-06 18:41:32 +03002511 trace_qmp_block_stream(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002512
2513out:
2514 aio_context_release(aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002515}
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00002516
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002517void qmp_block_commit(const char *job_id, const char *device,
2518 const char *base_node,
2519 const char *base,
2520 const char *top_node,
2521 const char *top,
2522 const char *backing_file,
Jeff Codyed61fc12012-09-27 13:29:16 -04002523 bool has_speed, int64_t speed,
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002524 bool has_on_error, BlockdevOnError on_error,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002525 const char *filter_node_name,
John Snow96fbf532018-09-06 09:02:21 -04002526 bool has_auto_finalize, bool auto_finalize,
2527 bool has_auto_dismiss, bool auto_dismiss,
Jeff Codyed61fc12012-09-27 13:29:16 -04002528 Error **errp)
2529{
2530 BlockDriverState *bs;
Alberto Garcia058223a2016-10-28 10:08:07 +03002531 BlockDriverState *iter;
Jeff Codyed61fc12012-09-27 13:29:16 -04002532 BlockDriverState *base_bs, *top_bs;
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002533 AioContext *aio_context;
Jeff Codyed61fc12012-09-27 13:29:16 -04002534 Error *local_err = NULL;
John Snow53607822018-09-06 09:02:10 -04002535 int job_flags = JOB_DEFAULT;
Max Reitz05ea3852019-06-11 21:19:26 +02002536 uint64_t top_perm, top_shared;
Jeff Codyed61fc12012-09-27 13:29:16 -04002537
Kevin Wolfbce73bc2023-09-11 11:46:13 +02002538 /* TODO We'll eventually have to take a writer lock in this function */
2539 GRAPH_RDLOCK_GUARD_MAINLOOP();
2540
Max Reitz54504662014-04-10 19:36:25 +02002541 if (!has_speed) {
2542 speed = 0;
2543 }
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002544 if (!has_on_error) {
2545 on_error = BLOCKDEV_ON_ERROR_REPORT;
2546 }
John Snow96fbf532018-09-06 09:02:21 -04002547 if (has_auto_finalize && !auto_finalize) {
2548 job_flags |= JOB_MANUAL_FINALIZE;
2549 }
2550 if (has_auto_dismiss && !auto_dismiss) {
2551 job_flags |= JOB_MANUAL_DISMISS;
2552 }
Max Reitz54504662014-04-10 19:36:25 +02002553
Jeff Cody7676e2c2014-06-30 15:14:15 +02002554 /* Important Note:
2555 * libvirt relies on the DeviceNotFound error class in order to probe for
2556 * live commit feature versions; for this to work, we must make sure to
2557 * perform the device lookup before any generic errors that may occur in a
2558 * scenario in which all optional arguments are omitted. */
Kevin Wolf1d13b162016-06-23 14:20:24 +02002559 bs = qmp_get_root_bs(device, &local_err);
2560 if (!bs) {
2561 bs = bdrv_lookup_bs(device, device, NULL);
2562 if (!bs) {
2563 error_free(local_err);
2564 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2565 "Device '%s' not found", device);
2566 } else {
2567 error_propagate(errp, local_err);
2568 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002569 return;
2570 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002571
Kevin Wolf1d13b162016-06-23 14:20:24 +02002572 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002573 aio_context_acquire(aio_context);
2574
Fam Zhengbb000212014-09-11 13:14:00 +08002575 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002576 goto out;
Fam Zheng628ff682014-05-23 21:29:44 +08002577 }
2578
Jeff Codyed61fc12012-09-27 13:29:16 -04002579 /* default top_bs is the active layer */
2580 top_bs = bs;
2581
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002582 if (top_node && top) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002583 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
2584 goto out;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002585 } else if (top_node) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002586 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2587 if (top_bs == NULL) {
2588 goto out;
2589 }
2590 if (!bdrv_chain_contains(bs, top_bs)) {
2591 error_setg(errp, "'%s' is not in this backing file chain",
2592 top_node);
2593 goto out;
2594 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002595 } else if (top) {
Max Reitzf30c66b2019-02-01 20:29:05 +01002596 /* This strcmp() is just a shortcut, there is no need to
2597 * refresh @bs's filename. If it mismatches,
2598 * bdrv_find_backing_image() will do the refresh and may still
2599 * return @bs. */
Jeff Codyed61fc12012-09-27 13:29:16 -04002600 if (strcmp(bs->filename, top) != 0) {
2601 top_bs = bdrv_find_backing_image(bs, top);
2602 }
2603 }
2604
2605 if (top_bs == NULL) {
2606 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002607 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002608 }
2609
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002610 assert(bdrv_get_aio_context(top_bs) == aio_context);
2611
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002612 if (base_node && base) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002613 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
2614 goto out;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002615 } else if (base_node) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002616 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2617 if (base_bs == NULL) {
2618 goto out;
2619 }
2620 if (!bdrv_chain_contains(top_bs, base_bs)) {
2621 error_setg(errp, "'%s' is not in this backing file chain",
2622 base_node);
2623 goto out;
2624 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002625 } else if (base) {
Jeff Codyd5208c42012-10-16 15:49:10 -04002626 base_bs = bdrv_find_backing_image(top_bs, base);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002627 if (base_bs == NULL) {
2628 error_setg(errp, "Can't find '%s' in the backing chain", base);
2629 goto out;
2630 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002631 } else {
2632 base_bs = bdrv_find_base(top_bs);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002633 if (base_bs == NULL) {
2634 error_setg(errp, "There is no backimg image");
2635 goto out;
2636 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002637 }
2638
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002639 assert(bdrv_get_aio_context(base_bs) == aio_context);
2640
Max Reitz9a71b9d2019-06-12 17:47:37 +02002641 for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2642 iter = bdrv_filter_or_cow_bs(iter))
2643 {
Alberto Garcia058223a2016-10-28 10:08:07 +03002644 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2645 goto out;
2646 }
Fam Zhengbb000212014-09-11 13:14:00 +08002647 }
2648
Jeff Cody7676e2c2014-06-30 15:14:15 +02002649 /* Do not allow attempts to commit an image into itself */
2650 if (top_bs == base_bs) {
2651 error_setg(errp, "cannot commit an image into itself");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002652 goto out;
Jeff Cody7676e2c2014-06-30 15:14:15 +02002653 }
2654
Max Reitz05ea3852019-06-11 21:19:26 +02002655 /*
2656 * Active commit is required if and only if someone has taken a
2657 * WRITE permission on the top node. Historically, we have always
2658 * used active commit for top nodes, so continue that practice
2659 * lest we possibly break clients that rely on this behavior, e.g.
2660 * to later attach this node to a writing parent.
2661 * (Active commit is never really wrong.)
2662 */
2663 bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2664 if (top_perm & BLK_PERM_WRITE ||
2665 bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2666 {
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002667 if (backing_file) {
Max Reitz05ea3852019-06-11 21:19:26 +02002668 if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2669 error_setg(errp, "'backing-file' specified,"
2670 " but 'top' is the active layer");
2671 } else {
2672 error_setg(errp, "'backing-file' specified, but 'top' has a "
2673 "writer on it");
2674 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002675 goto out;
Jeff Cody54e26902014-06-25 15:40:10 -04002676 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002677 if (!job_id) {
Max Reitz05ea3852019-06-11 21:19:26 +02002678 /*
2679 * Emulate here what block_job_create() does, because it
2680 * is possible that @bs != @top_bs (the block job should
2681 * be named after @bs, even if @top_bs is the actual
2682 * source)
2683 */
2684 job_id = bdrv_get_device_name(bs);
2685 }
2686 commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
Fam Zheng78bbd912017-04-21 20:27:04 +08002687 filter_node_name, NULL, NULL, false, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002688 } else {
Alberto Garcia058223a2016-10-28 10:08:07 +03002689 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2690 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2691 goto out;
2692 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002693 commit_start(job_id, bs, base_bs, top_bs, job_flags,
2694 speed, on_error, backing_file,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002695 filter_node_name, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002696 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002697 if (local_err != NULL) {
2698 error_propagate(errp, local_err);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002699 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002700 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002701
2702out:
2703 aio_context_release(aio_context);
Jeff Codyed61fc12012-09-27 13:29:16 -04002704}
2705
John Snow7b0b8702019-07-29 16:35:52 -04002706/* Common QMP interface for drive-backup and blockdev-backup */
2707static BlockJob *do_backup_common(BackupCommon *backup,
2708 BlockDriverState *bs,
2709 BlockDriverState *target_bs,
2710 AioContext *aio_context,
2711 JobTxn *txn, Error **errp)
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002712{
John Snow111049a2016-11-08 01:50:38 -05002713 BlockJob *job = NULL;
John Snowd58d8452015-04-17 19:49:58 -04002714 BdrvDirtyBitmap *bmap = NULL;
Vladimir Sementsov-Ogievskiy6a30f662021-01-17 00:47:00 +03002715 BackupPerf perf = { .max_workers = 64 };
John Snow7b0b8702019-07-29 16:35:52 -04002716 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002717
Pavel Butsykin81206a82016-07-22 11:17:50 +03002718 if (!backup->has_speed) {
2719 backup->speed = 0;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002720 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002721 if (!backup->has_on_source_error) {
2722 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002723 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002724 if (!backup->has_on_target_error) {
2725 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002726 }
John Snowb40dacd2018-03-10 03:27:44 -05002727 if (!backup->has_auto_finalize) {
2728 backup->auto_finalize = true;
2729 }
2730 if (!backup->has_auto_dismiss) {
2731 backup->auto_dismiss = true;
2732 }
Pavel Butsykin13b94142016-07-22 11:17:52 +03002733 if (!backup->has_compress) {
2734 backup->compress = false;
2735 }
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002736
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002737 if (backup->x_perf) {
2738 if (backup->x_perf->has_use_copy_range) {
2739 perf.use_copy_range = backup->x_perf->use_copy_range;
2740 }
Vladimir Sementsov-Ogievskiy2c59fd82021-01-17 00:46:52 +03002741 if (backup->x_perf->has_max_workers) {
2742 perf.max_workers = backup->x_perf->max_workers;
2743 }
2744 if (backup->x_perf->has_max_chunk) {
2745 perf.max_chunk = backup->x_perf->max_chunk;
2746 }
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002747 }
2748
John Snowa6c93652019-07-29 16:35:55 -04002749 if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2750 (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2751 /* done before desugaring 'incremental' to print the right message */
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002752 if (!backup->bitmap) {
John Snowa6c93652019-07-29 16:35:55 -04002753 error_setg(errp, "must provide a valid bitmap name for "
2754 "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2755 return NULL;
2756 }
2757 }
2758
John Snowc8b56502019-07-29 16:35:52 -04002759 if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2760 if (backup->has_bitmap_mode &&
2761 backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2762 error_setg(errp, "Bitmap sync mode must be '%s' "
2763 "when using sync mode '%s'",
2764 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2765 MirrorSyncMode_str(backup->sync));
2766 return NULL;
2767 }
2768 backup->has_bitmap_mode = true;
2769 backup->sync = MIRROR_SYNC_MODE_BITMAP;
2770 backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2771 }
2772
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002773 if (backup->bitmap) {
John Snow7b0b8702019-07-29 16:35:52 -04002774 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2775 if (!bmap) {
2776 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2777 return NULL;
2778 }
John Snowc8b56502019-07-29 16:35:52 -04002779 if (!backup->has_bitmap_mode) {
2780 error_setg(errp, "Bitmap sync mode must be given "
2781 "when providing a bitmap");
2782 return NULL;
2783 }
John Snowb30ffbe2019-07-29 16:35:54 -04002784 if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snow7b0b8702019-07-29 16:35:52 -04002785 return NULL;
2786 }
John Snow1a2b8b42019-07-29 16:35:55 -04002787
2788 /* This does not produce a useful bitmap artifact: */
2789 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2790 error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2791 " outputs", MirrorSyncMode_str(backup->sync));
2792 return NULL;
2793 }
2794
2795 /* If the bitmap isn't used for input or output, this is useless: */
2796 if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2797 backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2798 error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2799 " when combined with sync mode '%s'",
2800 BitmapSyncMode_str(backup->bitmap_mode),
2801 MirrorSyncMode_str(backup->sync));
2802 return NULL;
2803 }
2804 }
2805
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002806 if (!backup->bitmap && backup->has_bitmap_mode) {
John Snow1a2b8b42019-07-29 16:35:55 -04002807 error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2808 return NULL;
John Snow7b0b8702019-07-29 16:35:52 -04002809 }
2810
2811 if (!backup->auto_finalize) {
2812 job_flags |= JOB_MANUAL_FINALIZE;
2813 }
2814 if (!backup->auto_dismiss) {
2815 job_flags |= JOB_MANUAL_DISMISS;
2816 }
2817
2818 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
John Snowc8b56502019-07-29 16:35:52 -04002819 backup->sync, bmap, backup->bitmap_mode,
2820 backup->compress,
Vladimir Sementsov-Ogievskiy00e30f02019-10-01 16:14:09 +03002821 backup->filter_node_name,
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002822 &perf,
John Snowc8b56502019-07-29 16:35:52 -04002823 backup->on_source_error,
2824 backup->on_target_error,
John Snow7b0b8702019-07-29 16:35:52 -04002825 job_flags, NULL, NULL, txn, errp);
2826 return job;
2827}
2828
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002829void qmp_drive_backup(DriveBackup *backup, Error **errp)
John Snow7b0b8702019-07-29 16:35:52 -04002830{
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002831 TransactionAction action = {
2832 .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2833 .u.drive_backup.data = backup,
2834 };
2835 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002836}
2837
Peter Krempafacda542020-01-20 09:50:49 +01002838BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2839 bool flat,
2840 Error **errp)
Benoît Canetc13163f2014-01-23 21:31:34 +01002841{
Peter Krempafacda542020-01-20 09:50:49 +01002842 bool return_flat = has_flat && flat;
2843
2844 return bdrv_named_nodes_list(return_flat, errp);
Benoît Canetc13163f2014-01-23 21:31:34 +01002845}
2846
Vladimir Sementsov-Ogievskiy5d3b4e92018-12-21 20:09:07 +03002847XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2848{
Kevin Wolf15f3f1f2023-09-29 16:51:44 +02002849 GRAPH_RDLOCK_GUARD_MAINLOOP();
2850
Vladimir Sementsov-Ogievskiy5d3b4e92018-12-21 20:09:07 +03002851 return bdrv_get_xdbg_block_graph(errp);
2852}
2853
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002854void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
Fam Zhengc29c1dd2014-12-18 18:37:05 +08002855{
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002856 TransactionAction action = {
2857 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2858 .u.blockdev_backup.data = backup,
2859 };
2860 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002861}
2862
Fam Zheng4193cdd2015-12-24 12:45:03 +08002863/* Parameter check and block job starting for drive mirroring.
2864 * Caller should hold @device and @target's aio context (must be the same).
2865 **/
Alberto Garcia71aa9862016-07-05 17:28:57 +03002866static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002867 BlockDriverState *target,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002868 const char *replaces,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002869 enum MirrorSyncMode sync,
Max Reitz274fcce2016-06-10 20:57:47 +02002870 BlockMirrorBackingMode backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02002871 bool zero_target,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002872 bool has_speed, int64_t speed,
2873 bool has_granularity, uint32_t granularity,
2874 bool has_buf_size, int64_t buf_size,
2875 bool has_on_source_error,
2876 BlockdevOnError on_source_error,
2877 bool has_on_target_error,
2878 BlockdevOnError on_target_error,
2879 bool has_unmap, bool unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002880 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02002881 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04002882 bool has_auto_finalize, bool auto_finalize,
2883 bool has_auto_dismiss, bool auto_dismiss,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002884 Error **errp)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002885{
Max Reitz3f072a72019-06-12 16:27:32 +02002886 BlockDriverState *unfiltered_bs;
John Snowa1999b32018-09-06 09:02:11 -04002887 int job_flags = JOB_DEFAULT;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002888
Kevin Wolf533c6e42023-05-04 13:57:49 +02002889 GLOBAL_STATE_CODE();
2890 GRAPH_RDLOCK_GUARD_MAINLOOP();
2891
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002892 if (!has_speed) {
2893 speed = 0;
2894 }
Paolo Bonzinib952b552012-10-18 16:49:28 +02002895 if (!has_on_source_error) {
2896 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2897 }
2898 if (!has_on_target_error) {
2899 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2900 }
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002901 if (!has_granularity) {
2902 granularity = 0;
2903 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002904 if (!has_buf_size) {
Wen Congyang48ac0a42015-05-15 15:51:36 +08002905 buf_size = 0;
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002906 }
Fam Zheng0fc9f8e2015-06-08 13:56:08 +08002907 if (!has_unmap) {
2908 unmap = true;
2909 }
Max Reitz481deba2018-06-13 20:18:22 +02002910 if (!has_copy_mode) {
2911 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
2912 }
John Snowa6b58ad2018-09-06 09:02:22 -04002913 if (has_auto_finalize && !auto_finalize) {
2914 job_flags |= JOB_MANUAL_FINALIZE;
2915 }
2916 if (has_auto_dismiss && !auto_dismiss) {
2917 job_flags |= JOB_MANUAL_DISMISS;
2918 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002919
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002920 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002921 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2922 "a value in range [512B, 64MB]");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002923 return;
2924 }
2925 if (granularity & (granularity - 1)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002926 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
Markus Armbruster6cc06672020-11-13 09:26:26 +01002927 "a power of 2");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002928 return;
2929 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002930
Fam Zheng4193cdd2015-12-24 12:45:03 +08002931 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
2932 return;
2933 }
Fam Zhenge40e5022015-12-24 12:45:04 +08002934 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
2935 return;
2936 }
Fam Zheng4193cdd2015-12-24 12:45:03 +08002937
Max Reitz3f072a72019-06-12 16:27:32 +02002938 if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
Fam Zheng4193cdd2015-12-24 12:45:03 +08002939 sync = MIRROR_SYNC_MODE_FULL;
2940 }
2941
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002942 if (!replaces) {
Max Reitz3f072a72019-06-12 16:27:32 +02002943 /* We want to mirror from @bs, but keep implicit filters on top */
2944 unfiltered_bs = bdrv_skip_implicit_filters(bs);
2945 if (unfiltered_bs != bs) {
2946 replaces = unfiltered_bs->node_name;
Max Reitz3f072a72019-06-12 16:27:32 +02002947 }
2948 }
2949
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002950 if (replaces) {
Max Reitz74ce9e42019-02-13 23:53:01 +01002951 BlockDriverState *to_replace_bs;
2952 AioContext *replace_aio_context;
2953 int64_t bs_size, replace_size;
2954
2955 bs_size = bdrv_getlength(bs);
2956 if (bs_size < 0) {
2957 error_setg_errno(errp, -bs_size, "Failed to query device's size");
2958 return;
2959 }
2960
2961 to_replace_bs = check_to_replace_node(bs, replaces, errp);
2962 if (!to_replace_bs) {
2963 return;
2964 }
2965
2966 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
2967 aio_context_acquire(replace_aio_context);
2968 replace_size = bdrv_getlength(to_replace_bs);
2969 aio_context_release(replace_aio_context);
2970
2971 if (replace_size < 0) {
2972 error_setg_errno(errp, -replace_size,
2973 "Failed to query the replacement node's size");
2974 return;
2975 }
2976 if (bs_size != replace_size) {
2977 error_setg(errp, "cannot replace image with a mirror image of "
2978 "different size");
2979 return;
2980 }
2981 }
2982
Fam Zheng4193cdd2015-12-24 12:45:03 +08002983 /* pass the node name to replace to mirror start since it's loose coupling
2984 * and will allow to check whether the node still exist at mirror completion
2985 */
Alberto Garcia71aa9862016-07-05 17:28:57 +03002986 mirror_start(job_id, bs, target,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002987 replaces, job_flags,
Max Reitzcdf3bc92019-07-24 19:12:30 +02002988 speed, granularity, buf_size, sync, backing_mode, zero_target,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002989 on_source_error, on_target_error, unmap, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02002990 copy_mode, errp);
Fam Zheng4193cdd2015-12-24 12:45:03 +08002991}
2992
Eric Blakefaecd402016-07-14 16:37:58 -06002993void qmp_drive_mirror(DriveMirror *arg, Error **errp)
Fam Zheng4193cdd2015-12-24 12:45:03 +08002994{
2995 BlockDriverState *bs;
Max Reitz3f072a72019-06-12 16:27:32 +02002996 BlockDriverState *target_backing_bs, *target_bs;
Fam Zheng4193cdd2015-12-24 12:45:03 +08002997 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01002998 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02002999 BlockMirrorBackingMode backing_mode;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003000 Error *local_err = NULL;
3001 QDict *options = NULL;
3002 int flags;
3003 int64_t size;
Eric Blakefaecd402016-07-14 16:37:58 -06003004 const char *format = arg->format;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003005 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003006 int ret;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003007
Kevin Wolf0524e932016-06-23 14:20:24 +02003008 bs = qmp_get_root_bs(arg->device, errp);
3009 if (!bs) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003010 return;
3011 }
3012
Paolo Bonzinicb2af912018-02-07 17:29:20 +01003013 /* Early check to avoid creating target */
3014 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3015 return;
3016 }
3017
Kevin Wolf0524e932016-06-23 14:20:24 +02003018 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003019 aio_context_acquire(aio_context);
3020
Eric Blakefaecd402016-07-14 16:37:58 -06003021 if (!arg->has_mode) {
3022 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003023 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003024
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003025 if (!arg->format) {
Eric Blakefaecd402016-07-14 16:37:58 -06003026 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3027 ? NULL : bs->drv->format_name);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003028 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003029
Kevin Wolf61de4c62016-03-18 17:46:45 +01003030 flags = bs->open_flags | BDRV_O_RDWR;
Max Reitz3f072a72019-06-12 16:27:32 +02003031 target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
3032 if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
Eric Blakefaecd402016-07-14 16:37:58 -06003033 arg->sync = MIRROR_SYNC_MODE_FULL;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003034 }
Eric Blakefaecd402016-07-14 16:37:58 -06003035 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
Max Reitz3f072a72019-06-12 16:27:32 +02003036 target_backing_bs = bs;
Max Reitz117e0c82013-11-25 20:28:55 +01003037 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003038
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003039 size = bdrv_getlength(bs);
3040 if (size < 0) {
3041 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003042 goto out;
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003043 }
3044
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003045 if (arg->replaces) {
3046 if (!arg->node_name) {
Benoît Canet09158f02014-06-27 18:25:25 +02003047 error_setg(errp, "a node-name must be provided when replacing a"
3048 " named node of the graph");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003049 goto out;
Benoît Canet09158f02014-06-27 18:25:25 +02003050 }
Benoît Canet09158f02014-06-27 18:25:25 +02003051 }
3052
Eric Blakefaecd402016-07-14 16:37:58 -06003053 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
Max Reitz274fcce2016-06-10 20:57:47 +02003054 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3055 } else {
3056 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3057 }
3058
John Snow2a32c6e2017-07-17 20:34:21 -04003059 /* Don't open backing image in create() */
3060 flags |= BDRV_O_NO_BACKING;
3061
Max Reitz3f072a72019-06-12 16:27:32 +02003062 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
Eric Blakefaecd402016-07-14 16:37:58 -06003063 && arg->mode != NEW_IMAGE_MODE_EXISTING)
Max Reitz14526862013-11-06 19:50:44 +01003064 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003065 /* create new image w/o backing file */
Max Reitze6641712015-08-26 19:47:48 +02003066 assert(format);
Eric Blakefaecd402016-07-14 16:37:58 -06003067 bdrv_img_create(arg->target, format,
Fam Zheng92172832017-04-21 20:27:01 +08003068 NULL, NULL, NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003069 } else {
Max Reitz3f072a72019-06-12 16:27:32 +02003070 /* Implicit filters should not appear in the filename */
3071 BlockDriverState *explicit_backing =
3072 bdrv_skip_implicit_filters(target_backing_bs);
3073
Eric Blakefaecd402016-07-14 16:37:58 -06003074 switch (arg->mode) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003075 case NEW_IMAGE_MODE_EXISTING:
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003076 break;
3077 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3078 /* create new image with backing file */
Max Reitz3f072a72019-06-12 16:27:32 +02003079 bdrv_refresh_filename(explicit_backing);
Eric Blakefaecd402016-07-14 16:37:58 -06003080 bdrv_img_create(arg->target, format,
Max Reitz3f072a72019-06-12 16:27:32 +02003081 explicit_backing->filename,
3082 explicit_backing->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08003083 NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003084 break;
3085 default:
3086 abort();
3087 }
3088 }
3089
Markus Armbruster84d18f02014-01-30 15:07:28 +01003090 if (local_err) {
Luiz Capitulinocf8f2422012-11-30 10:52:08 -02003091 error_propagate(errp, local_err);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003092 goto out;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003093 }
3094
Max Reitze6641712015-08-26 19:47:48 +02003095 options = qdict_new();
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003096 if (arg->node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003097 qdict_put_str(options, "node-name", arg->node_name);
Benoît Canet4c828dc2014-06-16 12:00:55 +02003098 }
Max Reitze6641712015-08-26 19:47:48 +02003099 if (format) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003100 qdict_put_str(options, "driver", format);
Max Reitze6641712015-08-26 19:47:48 +02003101 }
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02003102 aio_context_release(aio_context);
Benoît Canet4c828dc2014-06-16 12:00:55 +02003103
Paolo Bonzinib812f672013-01-21 17:09:43 +01003104 /* Mirroring takes care of copy-on-write using the source's backing
3105 * file.
3106 */
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02003107 aio_context_acquire(qemu_get_aio_context());
John Snow2a32c6e2017-07-17 20:34:21 -04003108 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02003109 aio_context_release(qemu_get_aio_context());
3110
Max Reitz5b363932016-05-17 16:41:31 +02003111 if (!target_bs) {
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02003112 return;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003113 }
3114
Max Reitzcdf3bc92019-07-24 19:12:30 +02003115 zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3116 (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3117 !bdrv_has_zero_init(target_bs)));
3118
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003119
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003120 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003121 old_context = bdrv_get_aio_context(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003122 aio_context_acquire(old_context);
3123
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003124 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003125 if (ret < 0) {
3126 bdrv_unref(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003127 aio_context_release(old_context);
3128 return;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003129 }
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003130
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003131 aio_context_release(old_context);
3132 aio_context_acquire(aio_context);
3133
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003134 blockdev_mirror_common(arg->job_id, bs, target_bs,
3135 arg->replaces, arg->sync,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003136 backing_mode, zero_target,
3137 arg->has_speed, arg->speed,
Eric Blakefaecd402016-07-14 16:37:58 -06003138 arg->has_granularity, arg->granularity,
3139 arg->has_buf_size, arg->buf_size,
3140 arg->has_on_source_error, arg->on_source_error,
3141 arg->has_on_target_error, arg->on_target_error,
3142 arg->has_unmap, arg->unmap,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003143 NULL,
Max Reitz481deba2018-06-13 20:18:22 +02003144 arg->has_copy_mode, arg->copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003145 arg->has_auto_finalize, arg->auto_finalize,
3146 arg->has_auto_dismiss, arg->auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003147 errp);
Kevin Wolfe253f4b2016-04-12 16:17:41 +02003148 bdrv_unref(target_bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003149out:
3150 aio_context_release(aio_context);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003151}
3152
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003153void qmp_blockdev_mirror(const char *job_id,
Alberto Garcia71aa9862016-07-05 17:28:57 +03003154 const char *device, const char *target,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003155 const char *replaces,
Fam Zhengdf925622015-12-24 12:45:05 +08003156 MirrorSyncMode sync,
3157 bool has_speed, int64_t speed,
3158 bool has_granularity, uint32_t granularity,
3159 bool has_buf_size, int64_t buf_size,
3160 bool has_on_source_error,
3161 BlockdevOnError on_source_error,
3162 bool has_on_target_error,
3163 BlockdevOnError on_target_error,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003164 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003165 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003166 bool has_auto_finalize, bool auto_finalize,
3167 bool has_auto_dismiss, bool auto_dismiss,
Fam Zhengdf925622015-12-24 12:45:05 +08003168 Error **errp)
3169{
3170 BlockDriverState *bs;
Fam Zhengdf925622015-12-24 12:45:05 +08003171 BlockDriverState *target_bs;
3172 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003173 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003174 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003175 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003176 int ret;
Fam Zhengdf925622015-12-24 12:45:05 +08003177
Kevin Wolf07eec652016-06-23 14:20:24 +02003178 bs = qmp_get_root_bs(device, errp);
Fam Zhengdf925622015-12-24 12:45:05 +08003179 if (!bs) {
Fam Zhengdf925622015-12-24 12:45:05 +08003180 return;
3181 }
3182
3183 target_bs = bdrv_lookup_bs(target, target, errp);
3184 if (!target_bs) {
3185 return;
3186 }
3187
Max Reitzcdf3bc92019-07-24 19:12:30 +02003188 zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3189
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003190 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003191 old_context = bdrv_get_aio_context(target_bs);
Fam Zhengdf925622015-12-24 12:45:05 +08003192 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003193 aio_context_acquire(old_context);
Fam Zhengdf925622015-12-24 12:45:05 +08003194
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003195 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003196
3197 aio_context_release(old_context);
3198 aio_context_acquire(aio_context);
3199
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003200 if (ret < 0) {
3201 goto out;
3202 }
Fam Zhengdf925622015-12-24 12:45:05 +08003203
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003204 blockdev_mirror_common(job_id, bs, target_bs,
3205 replaces, sync, backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003206 zero_target, has_speed, speed,
Fam Zhengdf925622015-12-24 12:45:05 +08003207 has_granularity, granularity,
3208 has_buf_size, buf_size,
3209 has_on_source_error, on_source_error,
3210 has_on_target_error, on_target_error,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003211 true, true, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003212 has_copy_mode, copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003213 has_auto_finalize, auto_finalize,
3214 has_auto_dismiss, auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003215 errp);
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003216out:
Fam Zhengdf925622015-12-24 12:45:05 +08003217 aio_context_release(aio_context);
3218}
3219
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003220/*
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003221 * Get a block job using its ID. Called with job_mutex held.
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003222 */
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003223static BlockJob *find_block_job_locked(const char *id, Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003224{
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003225 BlockJob *job;
3226
3227 assert(id != NULL);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003228
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003229 job = block_job_get_locked(id);
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003230
3231 if (!job) {
3232 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3233 "Block job '%s' not found", id);
3234 return NULL;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003235 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003236
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003237 return job;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003238}
3239
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003240void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003241{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003242 BlockJob *job;
3243
3244 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003245 job = find_block_job_locked(device, errp);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003246
3247 if (!job) {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003248 return;
3249 }
3250
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003251 block_job_set_speed_locked(job, speed, errp);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003252}
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003253
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003254void qmp_block_job_cancel(const char *device,
3255 bool has_force, bool force, Error **errp)
3256{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003257 BlockJob *job;
3258
3259 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003260 job = find_block_job_locked(device, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003261
3262 if (!job) {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003263 return;
3264 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003265
3266 if (!has_force) {
3267 force = false;
3268 }
3269
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003270 if (job_user_paused_locked(&job->job) && !force) {
Cole Robinsonf231b882014-03-21 19:42:26 -04003271 error_setg(errp, "The block job for device '%s' is currently paused",
3272 device);
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003273 return;
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003274 }
3275
3276 trace_qmp_block_job_cancel(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003277 job_user_cancel_locked(&job->job, force, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003278}
3279
3280void qmp_block_job_pause(const char *device, Error **errp)
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003281{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003282 BlockJob *job;
3283
3284 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003285 job = find_block_job_locked(device, errp);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003286
John Snow0ec4dfb2018-03-10 03:27:32 -05003287 if (!job) {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003288 return;
3289 }
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003290
3291 trace_qmp_block_job_pause(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003292 job_user_pause_locked(&job->job, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003293}
3294
3295void qmp_block_job_resume(const char *device, Error **errp)
3296{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003297 BlockJob *job;
3298
3299 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003300 job = find_block_job_locked(device, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003301
John Snow0ec4dfb2018-03-10 03:27:32 -05003302 if (!job) {
Paolo Bonzini8acc72a2012-09-28 17:22:50 +02003303 return;
3304 }
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003305
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003306 trace_qmp_block_job_resume(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003307 job_user_resume_locked(&job->job, errp);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003308}
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003309
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003310void qmp_block_job_complete(const char *device, Error **errp)
3311{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003312 BlockJob *job;
3313
3314 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003315 job = find_block_job_locked(device, errp);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003316
3317 if (!job) {
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003318 return;
3319 }
3320
3321 trace_qmp_block_job_complete(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003322 job_complete_locked(&job->job, errp);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003323}
3324
John Snow11b61fb2018-03-10 03:27:43 -05003325void qmp_block_job_finalize(const char *id, Error **errp)
3326{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003327 BlockJob *job;
3328
3329 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003330 job = find_block_job_locked(id, errp);
John Snow11b61fb2018-03-10 03:27:43 -05003331
3332 if (!job) {
3333 return;
3334 }
3335
3336 trace_qmp_block_job_finalize(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003337 job_ref_locked(&job->job);
3338 job_finalize_locked(&job->job, errp);
Stefan Reiterb660a842020-04-07 13:56:49 +02003339
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003340 job_unref_locked(&job->job);
John Snow11b61fb2018-03-10 03:27:43 -05003341}
3342
John Snow75f71052018-03-10 03:27:36 -05003343void qmp_block_job_dismiss(const char *id, Error **errp)
3344{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003345 BlockJob *bjob;
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003346 Job *job;
John Snow75f71052018-03-10 03:27:36 -05003347
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003348 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003349 bjob = find_block_job_locked(id, errp);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003350
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003351 if (!bjob) {
John Snow75f71052018-03-10 03:27:36 -05003352 return;
3353 }
3354
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003355 trace_qmp_block_job_dismiss(bjob);
3356 job = &bjob->job;
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003357 job_dismiss_locked(&job, errp);
John Snow75f71052018-03-10 03:27:36 -05003358}
3359
Jeff Codyfa40e652014-07-01 09:52:16 +02003360void qmp_change_backing_file(const char *device,
3361 const char *image_node_name,
3362 const char *backing_file,
3363 Error **errp)
3364{
3365 BlockDriverState *bs = NULL;
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003366 AioContext *aio_context;
Jeff Codyfa40e652014-07-01 09:52:16 +02003367 BlockDriverState *image_bs = NULL;
3368 Error *local_err = NULL;
3369 bool ro;
Jeff Codyfa40e652014-07-01 09:52:16 +02003370 int ret;
3371
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003372 bs = qmp_get_root_bs(device, errp);
3373 if (!bs) {
Jeff Codyfa40e652014-07-01 09:52:16 +02003374 return;
3375 }
3376
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003377 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003378 aio_context_acquire(aio_context);
3379
Jeff Codyfa40e652014-07-01 09:52:16 +02003380 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3381 if (local_err) {
3382 error_propagate(errp, local_err);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003383 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003384 }
3385
3386 if (!image_bs) {
3387 error_setg(errp, "image file not found");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003388 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003389 }
3390
3391 if (bdrv_find_base(image_bs) == image_bs) {
3392 error_setg(errp, "not allowing backing file change on an image "
3393 "without a backing file");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003394 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003395 }
3396
3397 /* even though we are not necessarily operating on bs, we need it to
3398 * determine if block ops are currently prohibited on the chain */
3399 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003400 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003401 }
3402
3403 /* final sanity check */
3404 if (!bdrv_chain_contains(bs, image_bs)) {
3405 error_setg(errp, "'%s' and image file are not in the same chain",
3406 device);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003407 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003408 }
3409
3410 /* if not r/w, reopen to make r/w */
Jeff Codyfa40e652014-07-01 09:52:16 +02003411 ro = bdrv_is_read_only(image_bs);
3412
3413 if (ro) {
Alberto Garcia051a60f2018-11-12 16:00:38 +02003414 if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003415 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003416 }
3417 }
3418
3419 ret = bdrv_change_backing_file(image_bs, backing_file,
Eric Blakee54ee1b2020-07-06 15:39:53 -05003420 image_bs->drv ? image_bs->drv->format_name : "",
3421 false);
Jeff Codyfa40e652014-07-01 09:52:16 +02003422
3423 if (ret < 0) {
3424 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3425 backing_file);
3426 /* don't exit here, so we can try to restore open flags if
3427 * appropriate */
3428 }
3429
3430 if (ro) {
Markus Armbruster992861f2020-07-07 18:06:04 +02003431 bdrv_reopen_set_read_only(image_bs, true, errp);
Jeff Codyfa40e652014-07-01 09:52:16 +02003432 }
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003433
3434out:
3435 aio_context_release(aio_context);
Jeff Codyfa40e652014-07-01 09:52:16 +02003436}
3437
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003438void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3439{
Max Reitzbe4b67b2015-10-19 17:53:09 +02003440 BlockDriverState *bs;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003441 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01003442 Visitor *v = qobject_output_visitor_new(&obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003443 QDict *qdict;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003444
Markus Armbruster1f584242020-04-24 10:43:35 +02003445 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
Eric Blake3b098d52016-06-09 10:48:43 -06003446 visit_complete(v, &obj);
Max Reitz7dc847e2018-02-24 16:40:29 +01003447 qdict = qobject_to(QDict, obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003448
3449 qdict_flatten(qdict);
3450
Kevin Wolf9ec88732016-09-21 14:56:11 +02003451 if (!qdict_get_try_str(qdict, "node-name")) {
3452 error_setg(errp, "'node-name' must be specified for the root node");
3453 goto fail;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003454 }
3455
Kevin Wolf9ec88732016-09-21 14:56:11 +02003456 bs = bds_tree_init(qdict, errp);
3457 if (!bs) {
3458 goto fail;
3459 }
3460
Maxim Levitsky89802d52020-03-08 11:24:40 +02003461 bdrv_set_monitor_owned(bs);
Kevin Wolf9ec88732016-09-21 14:56:11 +02003462
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003463fail:
Eric Blake3b098d52016-06-09 10:48:43 -06003464 visit_free(v);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003465}
3466
Alberto Garciae60edf62021-07-08 13:47:09 +02003467void qmp_blockdev_reopen(BlockdevOptionsList *reopen_list, Error **errp)
Alberto Garcia1479c732019-03-12 18:48:51 +02003468{
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003469 BlockReopenQueue *queue = NULL;
Alberto Garcia1479c732019-03-12 18:48:51 +02003470
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003471 /* Add each one of the BDS that we want to reopen to the queue */
3472 for (; reopen_list != NULL; reopen_list = reopen_list->next) {
3473 BlockdevOptions *options = reopen_list->value;
3474 BlockDriverState *bs;
3475 AioContext *ctx;
3476 QObject *obj;
3477 Visitor *v;
3478 QDict *qdict;
3479
3480 /* Check for the selected node name */
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003481 if (!options->node_name) {
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003482 error_setg(errp, "node-name not specified");
3483 goto fail;
3484 }
3485
3486 bs = bdrv_find_node(options->node_name);
3487 if (!bs) {
3488 error_setg(errp, "Failed to find node with node-name='%s'",
3489 options->node_name);
3490 goto fail;
3491 }
3492
3493 /* Put all options in a QDict and flatten it */
3494 v = qobject_output_visitor_new(&obj);
3495 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3496 visit_complete(v, &obj);
3497 visit_free(v);
3498
3499 qdict = qobject_to(QDict, obj);
3500
3501 qdict_flatten(qdict);
3502
3503 ctx = bdrv_get_aio_context(bs);
3504 aio_context_acquire(ctx);
3505
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003506 queue = bdrv_reopen_queue(queue, bs, qdict, false);
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003507
3508 aio_context_release(ctx);
Alberto Garcia1479c732019-03-12 18:48:51 +02003509 }
3510
Alberto Garcia1479c732019-03-12 18:48:51 +02003511 /* Perform the reopen operation */
Alberto Garcia1479c732019-03-12 18:48:51 +02003512 bdrv_reopen_multiple(queue, errp);
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003513 queue = NULL;
Alberto Garcia1479c732019-03-12 18:48:51 +02003514
3515fail:
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003516 bdrv_reopen_queue_free(queue);
Alberto Garcia1479c732019-03-12 18:48:51 +02003517}
3518
Markus Armbruster79b7a772017-03-21 17:53:28 +01003519void qmp_blockdev_del(const char *node_name, Error **errp)
Alberto Garcia81b936a2015-11-02 16:51:55 +02003520{
3521 AioContext *aio_context;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003522 BlockDriverState *bs;
3523
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05003524 GLOBAL_STATE_CODE();
Kevin Wolf2b3912f2023-09-29 16:51:39 +02003525 GRAPH_RDLOCK_GUARD_MAINLOOP();
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05003526
Kevin Wolf9ec88732016-09-21 14:56:11 +02003527 bs = bdrv_find_node(node_name);
3528 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003529 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003530 return;
3531 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003532 if (bdrv_has_blk(bs)) {
3533 error_setg(errp, "Node %s is in use", node_name);
3534 return;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003535 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003536 aio_context = bdrv_get_aio_context(bs);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003537 aio_context_acquire(aio_context);
3538
Kevin Wolf9ec88732016-09-21 14:56:11 +02003539 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3540 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003541 }
3542
Paolo Bonzini70537ed2018-12-06 23:00:09 +01003543 if (!QTAILQ_IN_USE(bs, monitor_list)) {
Kevin Wolf9ec88732016-09-21 14:56:11 +02003544 error_setg(errp, "Node %s is not owned by the monitor",
3545 bs->node_name);
3546 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003547 }
3548
Kevin Wolf9ec88732016-09-21 14:56:11 +02003549 if (bs->refcnt > 1) {
3550 error_setg(errp, "Block device %s is in use",
3551 bdrv_get_device_or_node_name(bs));
3552 goto out;
3553 }
3554
3555 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3556 bdrv_unref(bs);
3557
Alberto Garcia81b936a2015-11-02 16:51:55 +02003558out:
3559 aio_context_release(aio_context);
3560}
3561
Kevin Wolf9def6082023-09-11 11:46:20 +02003562static BdrvChild * GRAPH_RDLOCK
3563bdrv_find_child(BlockDriverState *parent_bs, const char *child_name)
Wen Congyang7f821592016-05-10 15:36:39 +08003564{
3565 BdrvChild *child;
3566
3567 QLIST_FOREACH(child, &parent_bs->children, next) {
3568 if (strcmp(child->name, child_name) == 0) {
3569 return child;
3570 }
3571 }
3572
3573 return NULL;
3574}
3575
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003576void qmp_x_blockdev_change(const char *parent, const char *child,
Wen Congyang7f821592016-05-10 15:36:39 +08003577 const char *node, Error **errp)
3578{
3579 BlockDriverState *parent_bs, *new_bs = NULL;
3580 BdrvChild *p_child;
3581
Kevin Wolf9def6082023-09-11 11:46:20 +02003582 bdrv_graph_wrlock(NULL);
3583
Wen Congyang7f821592016-05-10 15:36:39 +08003584 parent_bs = bdrv_lookup_bs(parent, parent, errp);
3585 if (!parent_bs) {
Kevin Wolf9def6082023-09-11 11:46:20 +02003586 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003587 }
3588
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003589 if (!child == !node) {
3590 if (child) {
Wen Congyang7f821592016-05-10 15:36:39 +08003591 error_setg(errp, "The parameters child and node are in conflict");
3592 } else {
3593 error_setg(errp, "Either child or node must be specified");
3594 }
Kevin Wolf9def6082023-09-11 11:46:20 +02003595 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003596 }
3597
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003598 if (child) {
Wen Congyang7f821592016-05-10 15:36:39 +08003599 p_child = bdrv_find_child(parent_bs, child);
3600 if (!p_child) {
3601 error_setg(errp, "Node '%s' does not have child '%s'",
3602 parent, child);
Kevin Wolf9def6082023-09-11 11:46:20 +02003603 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003604 }
3605 bdrv_del_child(parent_bs, p_child, errp);
3606 }
3607
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003608 if (node) {
Wen Congyang7f821592016-05-10 15:36:39 +08003609 new_bs = bdrv_find_node(node);
3610 if (!new_bs) {
3611 error_setg(errp, "Node '%s' not found", node);
Kevin Wolf9def6082023-09-11 11:46:20 +02003612 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003613 }
3614 bdrv_add_child(parent_bs, new_bs, errp);
3615 }
Kevin Wolf9def6082023-09-11 11:46:20 +02003616
3617out:
3618 bdrv_graph_wrunlock();
Wen Congyang7f821592016-05-10 15:36:39 +08003619}
3620
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003621BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3622{
Eric Blakec3033fd2021-01-13 16:10:12 -06003623 BlockJobInfoList *head = NULL, **tail = &head;
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003624 BlockJob *job;
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003625
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -04003626 JOB_LOCK_GUARD();
3627
3628 for (job = block_job_next_locked(NULL); job;
3629 job = block_job_next_locked(job)) {
Eric Blakec3033fd2021-01-13 16:10:12 -06003630 BlockJobInfo *value;
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003631
John Snow559b9352016-10-27 12:06:55 -04003632 if (block_job_is_internal(job)) {
3633 continue;
3634 }
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -04003635 value = block_job_query_locked(job, errp);
Eric Blakec3033fd2021-01-13 16:10:12 -06003636 if (!value) {
John Snow559b9352016-10-27 12:06:55 -04003637 qapi_free_BlockJobInfoList(head);
3638 return NULL;
3639 }
Eric Blakec3033fd2021-01-13 16:10:12 -06003640 QAPI_LIST_APPEND(tail, value);
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003641 }
3642
3643 return head;
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003644}
Paolo Bonzini4d454572012-11-26 16:03:42 +01003645
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003646void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003647 bool has_force, bool force, Error **errp)
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003648{
3649 AioContext *old_context;
3650 AioContext *new_context;
3651 BlockDriverState *bs;
3652
Kevin Wolf2b3912f2023-09-29 16:51:39 +02003653 GRAPH_RDLOCK_GUARD_MAINLOOP();
3654
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003655 bs = bdrv_find_node(node_name);
3656 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003657 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003658 return;
3659 }
3660
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003661 /* Protects against accidents. */
3662 if (!(has_force && force) && bdrv_has_blk(bs)) {
3663 error_setg(errp, "Node %s is associated with a BlockBackend and could "
3664 "be in use (use force=true to override this check)",
3665 node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003666 return;
3667 }
3668
3669 if (iothread->type == QTYPE_QSTRING) {
3670 IOThread *obj = iothread_by_id(iothread->u.s);
3671 if (!obj) {
3672 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3673 return;
3674 }
3675
3676 new_context = iothread_get_aio_context(obj);
3677 } else {
3678 new_context = qemu_get_aio_context();
3679 }
3680
3681 old_context = bdrv_get_aio_context(bs);
3682 aio_context_acquire(old_context);
3683
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003684 bdrv_try_change_aio_context(bs, new_context, NULL, errp);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003685
3686 aio_context_release(old_context);
3687}
3688
Kevin Wolf00063832013-03-15 10:35:07 +01003689QemuOptsList qemu_common_drive_opts = {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003690 .name = "drive",
Kevin Wolf00063832013-03-15 10:35:07 +01003691 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
Paolo Bonzini4d454572012-11-26 16:03:42 +01003692 .desc = {
3693 {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003694 .name = "snapshot",
3695 .type = QEMU_OPT_BOOL,
3696 .help = "enable/disable snapshot mode",
3697 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003698 .name = "aio",
3699 .type = QEMU_OPT_STRING,
Aarushi Mehtaf80f2672020-01-20 14:18:50 +00003700 .help = "host AIO implementation (threads, native, io_uring)",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003701 },{
Kevin Wolfe4b24b42016-03-15 15:39:42 +01003702 .name = BDRV_OPT_CACHE_WB,
3703 .type = QEMU_OPT_BOOL,
3704 .help = "Enable writeback mode",
3705 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003706 .name = "format",
3707 .type = QEMU_OPT_STRING,
3708 .help = "disk format (raw, qcow2, ...)",
3709 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003710 .name = "rerror",
3711 .type = QEMU_OPT_STRING,
3712 .help = "read error action",
3713 },{
3714 .name = "werror",
3715 .type = QEMU_OPT_STRING,
3716 .help = "write error action",
3717 },{
Alberto Garcia4e200cf2016-09-15 17:53:05 +03003718 .name = BDRV_OPT_READ_ONLY,
Paolo Bonzini4d454572012-11-26 16:03:42 +01003719 .type = QEMU_OPT_BOOL,
3720 .help = "open drive file as read-only",
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +01003721 },
3722
3723 THROTTLE_OPTS,
3724
3725 {
Alberto Garcia76f4afb2015-06-08 18:17:44 +02003726 .name = "throttling.group",
3727 .type = QEMU_OPT_STRING,
3728 .help = "name of the block throttling group",
3729 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003730 .name = "copy-on-read",
3731 .type = QEMU_OPT_BOOL,
3732 .help = "copy read data from backing file into image file",
Peter Lieven465bee12014-05-18 00:58:19 +02003733 },{
3734 .name = "detect-zeroes",
3735 .type = QEMU_OPT_STRING,
3736 .help = "try to optimize zero writes (off, on, unmap)",
Alberto Garcia362e9292015-10-28 17:33:04 +02003737 },{
3738 .name = "stats-account-invalid",
3739 .type = QEMU_OPT_BOOL,
3740 .help = "whether to account for invalid I/O operations "
3741 "in the statistics",
3742 },{
3743 .name = "stats-account-failed",
3744 .type = QEMU_OPT_BOOL,
3745 .help = "whether to account for failed I/O operations "
3746 "in the statistics",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003747 },
3748 { /* end of list */ }
3749 },
3750};
Kevin Wolf00063832013-03-15 10:35:07 +01003751
3752QemuOptsList qemu_drive_opts = {
3753 .name = "drive",
3754 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3755 .desc = {
Kevin Wolf492fdc62013-06-19 13:44:17 +02003756 /*
3757 * no elements => accept any params
3758 * validation will happen later
3759 */
Kevin Wolf00063832013-03-15 10:35:07 +01003760 { /* end of list */ }
3761 },
3762};