blob: 6740663fda220f94d0791d23cb97bea220b4fc2f [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.
David Woodhoused3256f82023-10-16 13:01:39 +0100258 * Ignore IF_VIRTIO or IF_XEN, because it gets desugared into
259 * -device, so we can leave failing to -device.
Markus Armbrusterfe9f70a2021-03-09 17:12:13 +0100260 * 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
David Woodhoused3256f82023-10-16 13:01:39 +0100264 || dinfo->type == IF_XEN || 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{
Max Reitzbd745e22015-10-19 17:53:32 +0200665 int bdrv_flags = 0;
666
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -0500667 GLOBAL_STATE_CODE();
Kevin Wolfa81d6162016-03-07 14:23:04 +0100668 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
669 * with other callers) rather than what we want as the real defaults.
670 * Apply the defaults here instead. */
Kevin Wolfa81d6162016-03-07 14:23:04 +0100671 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
672 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300673 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
Kevin Wolfa81d6162016-03-07 14:23:04 +0100674
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100675 if (runstate_check(RUN_STATE_INMIGRATE)) {
676 bdrv_flags |= BDRV_O_INACTIVE;
677 }
678
Stefan Hajnoczib49f4752023-12-05 13:20:03 -0500679 return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
Max Reitzbd745e22015-10-19 17:53:32 +0200680}
681
Max Reitz9c4218e2016-01-29 16:36:12 +0100682void blockdev_close_all_bdrv_states(void)
683{
684 BlockDriverState *bs, *next_bs;
685
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -0500686 GLOBAL_STATE_CODE();
Max Reitz9c4218e2016-01-29 16:36:12 +0100687 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
Max Reitz9c4218e2016-01-29 16:36:12 +0100688 bdrv_unref(bs);
Max Reitz9c4218e2016-01-29 16:36:12 +0100689 }
690}
691
Max Reitz262b4e82016-03-16 19:54:41 +0100692/* Iterates over the list of monitor-owned BlockDriverStates */
693BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
694{
Emanuele Giuseppe Espositof791bf72022-03-03 10:15:49 -0500695 GLOBAL_STATE_CODE();
Max Reitz262b4e82016-03-16 19:54:41 +0100696 return bs ? QTAILQ_NEXT(bs, monitor_list)
697 : QTAILQ_FIRST(&monitor_bdrv_states);
698}
699
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200700static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200701 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200702{
703 const char *value;
704
705 value = qemu_opt_get(opts, from);
706 if (value) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200707 if (qemu_opt_find(opts, to)) {
708 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
709 "same time", to, from);
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200710 return false;
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200711 }
Jun Li20d6cd42014-09-24 13:45:27 +0800712 }
713
714 /* rename all items in opts */
715 while ((value = qemu_opt_get(opts, from))) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100716 qemu_opt_set(opts, to, value, &error_abort);
Kevin Wolf57975222013-07-17 14:41:54 +0200717 qemu_opt_unset(opts, from);
718 }
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200719 return true;
Kevin Wolf57975222013-07-17 14:41:54 +0200720}
721
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200722QemuOptsList qemu_legacy_drive_opts = {
723 .name = "drive",
724 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
725 .desc = {
726 {
Kevin Wolf87a899c2013-09-10 15:48:13 +0200727 .name = "bus",
728 .type = QEMU_OPT_NUMBER,
729 .help = "bus number",
730 },{
731 .name = "unit",
732 .type = QEMU_OPT_NUMBER,
733 .help = "unit number (i.e. lun for scsi)",
734 },{
735 .name = "index",
736 .type = QEMU_OPT_NUMBER,
737 .help = "index number",
738 },{
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200739 .name = "media",
740 .type = QEMU_OPT_STRING,
741 .help = "media type (disk, cdrom)",
Kevin Wolf593d4642013-08-28 17:24:51 +0200742 },{
743 .name = "if",
744 .type = QEMU_OPT_STRING,
745 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
Kevin Wolfb41a7332013-09-09 16:49:49 +0200746 },{
Max Reitzd095b462013-12-20 19:28:14 +0100747 .name = "file",
748 .type = QEMU_OPT_STRING,
749 .help = "file name",
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200750 },
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200751
752 /* Options that are passed on, but have special semantics with -drive */
753 {
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300754 .name = BDRV_OPT_READ_ONLY,
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200755 .type = QEMU_OPT_BOOL,
756 .help = "open drive file as read-only",
757 },{
Kevin Wolfee13ed12014-02-09 09:52:32 +0100758 .name = "rerror",
759 .type = QEMU_OPT_STRING,
760 .help = "read error action",
761 },{
762 .name = "werror",
763 .type = QEMU_OPT_STRING,
764 .help = "write error action",
765 },{
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200766 .name = "copy-on-read",
767 .type = QEMU_OPT_BOOL,
768 .help = "copy read data from backing file into image file",
769 },
770
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200771 { /* end of list */ }
772 },
773};
774
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200775DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
776 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200777{
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200778 const char *value;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200779 BlockBackend *blk;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200780 DriveInfo *dinfo = NULL;
Kevin Wolff298d072013-09-10 12:01:20 +0200781 QDict *bs_opts;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200782 QemuOpts *legacy_opts;
783 DriveMediaType media = MEDIA_DISK;
Kevin Wolf593d4642013-08-28 17:24:51 +0200784 BlockInterfaceType type;
Kevin Wolf87a899c2013-09-10 15:48:13 +0200785 int max_devs, bus_id, unit_id, index;
Kevin Wolfee13ed12014-02-09 09:52:32 +0100786 const char *werror, *rerror;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800787 bool read_only = false;
788 bool copy_on_read;
Max Reitzd095b462013-12-20 19:28:14 +0100789 const char *filename;
Kevin Wolf247147f2014-09-24 16:37:14 +0200790 int i;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200791
Emanuele Giuseppe Espositoc5be7442022-03-03 10:16:06 -0500792 GLOBAL_STATE_CODE();
793
Kevin Wolf57975222013-07-17 14:41:54 +0200794 /* Change legacy command line options into QMP ones */
Kevin Wolf247147f2014-09-24 16:37:14 +0200795 static const struct {
796 const char *from;
797 const char *to;
798 } opt_renames[] = {
799 { "iops", "throttling.iops-total" },
800 { "iops_rd", "throttling.iops-read" },
801 { "iops_wr", "throttling.iops-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200802
Kevin Wolf247147f2014-09-24 16:37:14 +0200803 { "bps", "throttling.bps-total" },
804 { "bps_rd", "throttling.bps-read" },
805 { "bps_wr", "throttling.bps-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200806
Kevin Wolf247147f2014-09-24 16:37:14 +0200807 { "iops_max", "throttling.iops-total-max" },
808 { "iops_rd_max", "throttling.iops-read-max" },
809 { "iops_wr_max", "throttling.iops-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200810
Kevin Wolf247147f2014-09-24 16:37:14 +0200811 { "bps_max", "throttling.bps-total-max" },
812 { "bps_rd_max", "throttling.bps-read-max" },
813 { "bps_wr_max", "throttling.bps-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200814
Kevin Wolf247147f2014-09-24 16:37:14 +0200815 { "iops_size", "throttling.iops-size" },
Benoît Canet2024c1d2013-09-02 14:14:41 +0200816
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200817 { "group", "throttling.group" },
818
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300819 { "readonly", BDRV_OPT_READ_ONLY },
Kevin Wolf247147f2014-09-24 16:37:14 +0200820 };
821
822 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200823 if (!qemu_opt_rename(all_opts, opt_renames[i].from,
Markus Armbruster668f62e2020-07-07 18:06:02 +0200824 opt_renames[i].to, errp)) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200825 return NULL;
826 }
Kevin Wolf247147f2014-09-24 16:37:14 +0200827 }
Kevin Wolf0f227a92013-07-19 20:07:29 +0200828
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200829 value = qemu_opt_get(all_opts, "cache");
830 if (value) {
831 int flags = 0;
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100832 bool writethrough;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200833
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100834 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200835 error_setg(errp, "invalid cache option");
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200836 return NULL;
837 }
838
839 /* Specific options take precedence */
Kevin Wolf54861b92015-04-07 16:55:00 +0200840 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
841 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100842 !writethrough, &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200843 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200844 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
845 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100846 !!(flags & BDRV_O_NOCACHE), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200847 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200848 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
849 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100850 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200851 }
852 qemu_opt_unset(all_opts, "cache");
853 }
854
Kevin Wolff298d072013-09-10 12:01:20 +0200855 /* Get a QDict for processing the options */
856 bs_opts = qdict_new();
857 qemu_opts_to_qdict(all_opts, bs_opts);
858
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800859 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
860 &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200861 if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200862 goto fail;
863 }
864
865 /* Media type */
866 value = qemu_opt_get(legacy_opts, "media");
867 if (value) {
868 if (!strcmp(value, "disk")) {
869 media = MEDIA_DISK;
870 } else if (!strcmp(value, "cdrom")) {
871 media = MEDIA_CDROM;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800872 read_only = true;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200873 } else {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200874 error_setg(errp, "'%s' invalid media", value);
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200875 goto fail;
876 }
877 }
878
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200879 /* copy-on-read is disabled with a warning for read-only devices */
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300880 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200881 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
882
883 if (read_only && copy_on_read) {
Alistair Francis3dc6f862017-07-12 06:57:41 -0700884 warn_report("disabling copy-on-read on read-only drive");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200885 copy_on_read = false;
886 }
887
Eric Blake46f5ac22017-04-27 16:58:17 -0500888 qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
889 qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200890
Kevin Wolf593d4642013-08-28 17:24:51 +0200891 /* Controller type */
892 value = qemu_opt_get(legacy_opts, "if");
893 if (value) {
894 for (type = 0;
895 type < IF_COUNT && strcmp(value, if_name[type]);
896 type++) {
897 }
898 if (type == IF_COUNT) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200899 error_setg(errp, "unsupported bus type '%s'", value);
Kevin Wolf593d4642013-08-28 17:24:51 +0200900 goto fail;
901 }
902 } else {
903 type = block_default_type;
904 }
905
Kevin Wolf87a899c2013-09-10 15:48:13 +0200906 /* Device address specified by bus/unit or index.
907 * If none was specified, try to find the first free one. */
908 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
909 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
910 index = qemu_opt_get_number(legacy_opts, "index", -1);
911
912 max_devs = if_max_devs[type];
913
914 if (index != -1) {
915 if (bus_id != 0 || unit_id != -1) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200916 error_setg(errp, "index cannot be used with bus and unit");
Kevin Wolf87a899c2013-09-10 15:48:13 +0200917 goto fail;
918 }
919 bus_id = drive_index_to_bus_id(type, index);
920 unit_id = drive_index_to_unit_id(type, index);
921 }
922
923 if (unit_id == -1) {
924 unit_id = 0;
925 while (drive_get(type, bus_id, unit_id) != NULL) {
926 unit_id++;
927 if (max_devs && unit_id >= max_devs) {
928 unit_id -= max_devs;
929 bus_id++;
930 }
931 }
932 }
933
934 if (max_devs && unit_id >= max_devs) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200935 error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200936 goto fail;
937 }
938
939 if (drive_get(type, bus_id, unit_id) != NULL) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200940 error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
941 bus_id, unit_id, index);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200942 goto fail;
943 }
944
945 /* no id supplied -> create one */
946 if (qemu_opts_id(all_opts) == NULL) {
947 char *new_id;
948 const char *mediastr = "";
949 if (type == IF_IDE || type == IF_SCSI) {
950 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
951 }
952 if (max_devs) {
953 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
954 mediastr, unit_id);
955 } else {
956 new_id = g_strdup_printf("%s%s%i", if_name[type],
957 mediastr, unit_id);
958 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500959 qdict_put_str(bs_opts, "id", new_id);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200960 g_free(new_id);
961 }
962
Kevin Wolf394c7d42013-09-13 14:09:17 +0200963 /* Add virtio block device */
Kevin Wolf394c7d42013-09-13 14:09:17 +0200964 if (type == IF_VIRTIO) {
965 QemuOpts *devopts;
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800966 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
967 &error_abort);
Laurent Vivier9db1d3a2021-03-23 16:53:04 +0000968 qemu_opt_set(devopts, "driver", "virtio-blk", &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100969 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
970 &error_abort);
David Woodhoused3256f82023-10-16 13:01:39 +0100971 } else if (type == IF_XEN) {
972 QemuOpts *devopts;
973 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
974 &error_abort);
975 qemu_opt_set(devopts, "driver",
976 (media == MEDIA_CDROM) ? "xen-cdrom" : "xen-disk",
977 &error_abort);
978 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;
1042
Kevin Wolf2b3912f2023-09-29 16:51:39 +02001043 GRAPH_RDLOCK_GUARD_MAINLOOP();
1044
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001045 bs = bdrv_lookup_bs(name, name, errp);
1046 if (bs == NULL) {
1047 return NULL;
1048 }
1049
1050 if (!bdrv_is_root_node(bs)) {
1051 error_setg(errp, "Need a root block node");
1052 return NULL;
1053 }
1054
1055 if (!bdrv_is_inserted(bs)) {
1056 error_setg(errp, "Device has no medium");
Emanuele Giuseppe Esposito1e97be92023-01-13 21:42:02 +01001057 bs = NULL;
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001058 }
1059
1060 return bs;
1061}
1062
Eric Blake10f75902016-03-03 09:16:50 -07001063static void blockdev_do_action(TransactionAction *action, Error **errp)
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001064{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001065 TransactionActionList list;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001066
Eric Blake10f75902016-03-03 09:16:50 -07001067 list.value = action;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001068 list.next = NULL;
Markus Armbruster238e9202022-11-04 17:07:08 +01001069 qmp_transaction(&list, NULL, errp);
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001070}
1071
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001072void qmp_blockdev_snapshot_sync(const char *device, const char *node_name,
Benoît Canet0901f672014-01-23 21:31:38 +01001073 const char *snapshot_file,
Benoît Canet0901f672014-01-23 21:31:38 +01001074 const char *snapshot_node_name,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001075 const char *format,
Benoît Canet0901f672014-01-23 21:31:38 +01001076 bool has_mode, NewImageMode mode, Error **errp)
Jes Sorensenf8882562010-12-16 13:52:16 +01001077{
Alberto Garciaa911e6a2015-10-26 14:27:14 +02001078 BlockdevSnapshotSync snapshot = {
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001079 .device = (char *) device,
Benoît Canet0901f672014-01-23 21:31:38 +01001080 .node_name = (char *) node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001081 .snapshot_file = (char *) snapshot_file,
Benoît Canet0901f672014-01-23 21:31:38 +01001082 .snapshot_node_name = (char *) snapshot_node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001083 .format = (char *) format,
1084 .has_mode = has_mode,
1085 .mode = mode,
1086 };
Eric Blake10f75902016-03-03 09:16:50 -07001087 TransactionAction action = {
1088 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001089 .u.blockdev_snapshot_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001090 };
1091 blockdev_do_action(&action, errp);
Jes Sorensenf8882562010-12-16 13:52:16 +01001092}
1093
Alberto Garcia43de7e22015-10-26 14:27:16 +02001094void qmp_blockdev_snapshot(const char *node, const char *overlay,
1095 Error **errp)
1096{
1097 BlockdevSnapshot snapshot_data = {
1098 .node = (char *) node,
1099 .overlay = (char *) overlay
1100 };
Eric Blake10f75902016-03-03 09:16:50 -07001101 TransactionAction action = {
1102 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
Eric Blake32bafa82016-03-17 16:48:37 -06001103 .u.blockdev_snapshot.data = &snapshot_data,
Eric Blake10f75902016-03-03 09:16:50 -07001104 };
1105 blockdev_do_action(&action, errp);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001106}
1107
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001108void qmp_blockdev_snapshot_internal_sync(const char *device,
1109 const char *name,
1110 Error **errp)
1111{
1112 BlockdevSnapshotInternal snapshot = {
1113 .device = (char *) device,
1114 .name = (char *) name
1115 };
Eric Blake10f75902016-03-03 09:16:50 -07001116 TransactionAction action = {
1117 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001118 .u.blockdev_snapshot_internal_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001119 };
1120 blockdev_do_action(&action, errp);
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001121}
1122
Wenchao Xia44e3e052013-09-11 14:04:36 +08001123SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
Wenchao Xia44e3e052013-09-11 14:04:36 +08001124 const char *id,
Wenchao Xia44e3e052013-09-11 14:04:36 +08001125 const char *name,
1126 Error **errp)
1127{
Fam Zhenga0e85442015-03-02 19:36:48 +08001128 BlockDriverState *bs;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001129 QEMUSnapshotInfo sn;
1130 Error *local_err = NULL;
1131 SnapshotInfo *info = NULL;
1132 int ret;
1133
Kevin Wolfa32e7812023-09-29 16:51:42 +02001134 GLOBAL_STATE_CODE();
1135 GRAPH_RDLOCK_GUARD_MAINLOOP();
1136
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001137 bs = qmp_get_root_bs(device, errp);
1138 if (!bs) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001139 return NULL;
1140 }
1141
Wenchao Xia44e3e052013-09-11 14:04:36 +08001142 if (!id && !name) {
1143 error_setg(errp, "Name or id must be provided");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001144 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001145 }
1146
Stefan Hajnoczi0b928852014-11-19 14:19:43 +00001147 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001148 return NULL;
Stefan Hajnoczi0b928852014-11-19 14:19:43 +00001149 }
1150
Wenchao Xia44e3e052013-09-11 14:04:36 +08001151 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001152 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001153 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001154 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001155 }
1156 if (!ret) {
1157 error_setg(errp,
1158 "Snapshot with id '%s' and name '%s' does not exist on "
1159 "device '%s'",
1160 STR_OR_NULL(id), STR_OR_NULL(name), device);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001161 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001162 }
1163
1164 bdrv_snapshot_delete(bs, id, name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001165 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001166 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001167 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001168 }
1169
Markus Armbruster5839e532014-08-19 10:31:08 +02001170 info = g_new0(SnapshotInfo, 1);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001171 info->id = g_strdup(sn.id_str);
1172 info->name = g_strdup(sn.name);
1173 info->date_nsec = sn.date_nsec;
1174 info->date_sec = sn.date_sec;
1175 info->vm_state_size = sn.vm_state_size;
1176 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1177 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001178 if (sn.icount != -1ULL) {
1179 info->icount = sn.icount;
1180 info->has_icount = true;
1181 }
Wenchao Xia44e3e052013-09-11 14:04:36 +08001182
1183 return info;
1184}
Jeff Cody8802d1f2012-02-28 15:54:06 -05001185
Wenchao Xiabbe86012013-09-11 14:04:34 +08001186/* internal snapshot private data */
1187typedef struct InternalSnapshotState {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001188 BlockDriverState *bs;
1189 QEMUSnapshotInfo sn;
Fam Zheng507306c2015-10-23 11:08:13 +08001190 bool created;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001191} InternalSnapshotState;
1192
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001193static void internal_snapshot_abort(void *opaque);
1194static void internal_snapshot_clean(void *opaque);
1195TransactionActionDrv internal_snapshot_drv = {
1196 .abort = internal_snapshot_abort,
1197 .clean = internal_snapshot_clean,
1198};
John Snow94d16a62015-11-05 18:13:18 -05001199
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001200static void internal_snapshot_action(BlockdevSnapshotInternal *internal,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001201 Transaction *tran, Error **errp)
Wenchao Xiabbe86012013-09-11 14:04:34 +08001202{
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001203 Error *local_err = NULL;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001204 const char *device;
1205 const char *name;
1206 BlockDriverState *bs;
1207 QEMUSnapshotInfo old_sn, *sn;
1208 bool ret;
Marc-André Lureauf793dde2022-03-07 11:04:00 +04001209 int64_t rt;
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001210 InternalSnapshotState *state = g_new0(InternalSnapshotState, 1);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001211 int ret1;
1212
Kevin Wolfa32e7812023-09-29 16:51:42 +02001213 GLOBAL_STATE_CODE();
1214 GRAPH_RDLOCK_GUARD_MAINLOOP();
1215
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001216 tran_add(tran, &internal_snapshot_drv, state);
1217
Wenchao Xiabbe86012013-09-11 14:04:34 +08001218 device = internal->device;
1219 name = internal->name;
1220
Kevin Wolf75dfd402016-06-23 14:20:24 +02001221 bs = qmp_get_root_bs(device, errp);
1222 if (!bs) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001223 return;
1224 }
1225
Fam Zheng507306c2015-10-23 11:08:13 +08001226 state->bs = bs;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001227
1228 /* Paired with .clean() */
Fam Zheng507306c2015-10-23 11:08:13 +08001229 bdrv_drained_begin(bs);
1230
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001231 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001232 return;
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001233 }
1234
Wenchao Xiabbe86012013-09-11 14:04:34 +08001235 if (bdrv_is_read_only(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001236 error_setg(errp, "Device '%s' is read only", device);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001237 return;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001238 }
1239
1240 if (!bdrv_can_snapshot(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001241 error_setg(errp, "Block format '%s' used by device '%s' "
1242 "does not support internal snapshots",
1243 bs->drv->format_name, device);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001244 return;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001245 }
1246
1247 if (!strlen(name)) {
1248 error_setg(errp, "Name is empty");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001249 return;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001250 }
1251
1252 /* check whether a snapshot with name exist */
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001253 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1254 &local_err);
1255 if (local_err) {
1256 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001257 return;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001258 } else if (ret) {
1259 error_setg(errp,
1260 "Snapshot with name '%s' already exists on device '%s'",
1261 name, device);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001262 return;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001263 }
1264
1265 /* 3. take the snapshot */
1266 sn = &state->sn;
1267 pstrcpy(sn->name, sizeof(sn->name), name);
Marc-André Lureauf793dde2022-03-07 11:04:00 +04001268 rt = g_get_real_time();
1269 sn->date_sec = rt / G_USEC_PER_SEC;
1270 sn->date_nsec = (rt % G_USEC_PER_SEC) * 1000;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001271 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001272 if (replay_mode != REPLAY_MODE_NONE) {
1273 sn->icount = replay_get_current_icount();
1274 } else {
1275 sn->icount = -1ULL;
1276 }
Wenchao Xiabbe86012013-09-11 14:04:34 +08001277
1278 ret1 = bdrv_snapshot_create(bs, sn);
1279 if (ret1 < 0) {
1280 error_setg_errno(errp, -ret1,
1281 "Failed to create snapshot '%s' on device '%s'",
1282 name, device);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001283 return;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001284 }
1285
1286 /* 4. succeed, mark a snapshot is created */
Fam Zheng507306c2015-10-23 11:08:13 +08001287 state->created = true;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001288}
1289
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001290static void internal_snapshot_abort(void *opaque)
Wenchao Xiabbe86012013-09-11 14:04:34 +08001291{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001292 InternalSnapshotState *state = opaque;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001293 BlockDriverState *bs = state->bs;
1294 QEMUSnapshotInfo *sn = &state->sn;
1295 Error *local_error = NULL;
1296
Kevin Wolfa32e7812023-09-29 16:51:42 +02001297 GLOBAL_STATE_CODE();
1298 GRAPH_RDLOCK_GUARD_MAINLOOP();
1299
Fam Zheng507306c2015-10-23 11:08:13 +08001300 if (!state->created) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001301 return;
1302 }
1303
1304 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001305 error_reportf_err(local_error,
1306 "Failed to delete snapshot with id '%s' and "
1307 "name '%s' on device '%s' in abort: ",
1308 sn->id_str, sn->name,
1309 bdrv_get_device_name(bs));
Wenchao Xiabbe86012013-09-11 14:04:34 +08001310 }
1311}
1312
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001313static void internal_snapshot_clean(void *opaque)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001314{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001315 g_autofree InternalSnapshotState *state = opaque;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001316
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001317 if (!state->bs) {
1318 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001319 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001320
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001321 bdrv_drained_end(state->bs);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001322}
1323
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001324/* external snapshot private data */
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001325typedef struct ExternalSnapshotState {
Jeff Cody8802d1f2012-02-28 15:54:06 -05001326 BlockDriverState *old_bs;
1327 BlockDriverState *new_bs;
Kevin Wolf067acf22017-03-02 15:26:18 +01001328 bool overlay_appended;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001329} ExternalSnapshotState;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001330
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001331static void external_snapshot_commit(void *opaque);
1332static void external_snapshot_abort(void *opaque);
1333static void external_snapshot_clean(void *opaque);
1334TransactionActionDrv external_snapshot_drv = {
1335 .commit = external_snapshot_commit,
1336 .abort = external_snapshot_abort,
1337 .clean = external_snapshot_clean,
1338};
1339
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001340static void external_snapshot_action(TransactionAction *action,
1341 Transaction *tran, Error **errp)
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001342{
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001343 int ret;
Max Reitz5b363932016-05-17 16:41:31 +02001344 int flags = 0;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001345 QDict *options = NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001346 Error *local_err = NULL;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001347 /* Device and node name of the image to generate the snapshot from */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001348 const char *device;
Benoît Canet0901f672014-01-23 21:31:38 +01001349 const char *node_name;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001350 /* Reference to the new image (for 'blockdev-snapshot') */
1351 const char *snapshot_ref;
1352 /* File name of the new image (for 'blockdev-snapshot-sync') */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001353 const char *new_image_file;
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001354 ExternalSnapshotState *state = g_new0(ExternalSnapshotState, 1);
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001355 uint64_t perm, shared;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001356
Kevin Wolfbce73bc2023-09-11 11:46:13 +02001357 /* TODO We'll eventually have to take a writer lock in this function */
1358 GRAPH_RDLOCK_GUARD_MAINLOOP();
1359
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001360 tran_add(tran, &external_snapshot_drv, state);
1361
Alberto Garcia43de7e22015-10-26 14:27:16 +02001362 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1363 * purpose but a different set of parameters */
1364 switch (action->type) {
1365 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1366 {
Eric Blake32bafa82016-03-17 16:48:37 -06001367 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001368 device = s->node;
1369 node_name = s->node;
1370 new_image_file = NULL;
1371 snapshot_ref = s->overlay;
1372 }
1373 break;
1374 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1375 {
Eric Blake32bafa82016-03-17 16:48:37 -06001376 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001377 device = s->device;
1378 node_name = s->node_name;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001379 new_image_file = s->snapshot_file;
1380 snapshot_ref = NULL;
1381 }
1382 break;
1383 default:
1384 g_assert_not_reached();
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001385 }
1386
1387 /* start processing */
John Snow94d16a62015-11-05 18:13:18 -05001388
Alberto Garcia43de7e22015-10-26 14:27:16 +02001389 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1390 if (!state->old_bs) {
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001391 return;
1392 }
1393
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001394 /* Paired with .clean() */
Fam Zhengda763e82015-10-23 11:08:10 +08001395 bdrv_drained_begin(state->old_bs);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001396
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001397 if (!bdrv_is_inserted(state->old_bs)) {
Philippe Mathieu-Daudéa95921f2024-03-12 15:13:36 +01001398 error_setg(errp, "Device '%s' has no medium",
Markus Armbruster7fcb8c82024-03-06 15:28:31 +01001399 bdrv_get_device_or_node_name(state->old_bs));
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001400 return;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001401 }
1402
Fam Zheng3718d8a2014-05-23 21:29:43 +08001403 if (bdrv_op_is_blocked(state->old_bs,
1404 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001405 return;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001406 }
1407
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001408 if (!bdrv_is_read_only(state->old_bs)) {
Markus Armbruster540d91b2024-05-13 16:16:58 +02001409 ret = bdrv_flush(state->old_bs);
1410 if (ret < 0) {
1411 error_setg_errno(errp, -ret, "Write to node '%s' failed",
1412 bdrv_get_device_or_node_name(state->old_bs));
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001413 return;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001414 }
1415 }
1416
Alberto Garcia43de7e22015-10-26 14:27:16 +02001417 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
Eric Blake32bafa82016-03-17 16:48:37 -06001418 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001419 const char *format = s->format ?: "qcow2";
Alberto Garcia43de7e22015-10-26 14:27:16 +02001420 enum NewImageMode mode;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01001421 const char *snapshot_node_name = s->snapshot_node_name;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001422
Alberto Garcia43de7e22015-10-26 14:27:16 +02001423 if (node_name && !snapshot_node_name) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001424 error_setg(errp, "New overlay node-name missing");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001425 return;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001426 }
Alberto Garcia43de7e22015-10-26 14:27:16 +02001427
1428 if (snapshot_node_name &&
1429 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001430 error_setg(errp, "New overlay node-name already in use");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001431 return;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001432 }
1433
1434 flags = state->old_bs->open_flags;
John Snow2a32c6e2017-07-17 20:34:21 -04001435 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1436 flags |= BDRV_O_NO_BACKING;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001437
1438 /* create new image w/backing file */
1439 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1440 if (mode != NEW_IMAGE_MODE_EXISTING) {
Kevin Wolff86b8b52016-03-02 12:16:44 +01001441 int64_t size = bdrv_getlength(state->old_bs);
1442 if (size < 0) {
1443 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001444 return;
Kevin Wolff86b8b52016-03-02 12:16:44 +01001445 }
Max Reitzf30c66b2019-02-01 20:29:05 +01001446 bdrv_refresh_filename(state->old_bs);
Kevin Wolfe1355052022-12-07 14:18:30 +01001447
Alberto Garcia43de7e22015-10-26 14:27:16 +02001448 bdrv_img_create(new_image_file, format,
1449 state->old_bs->filename,
1450 state->old_bs->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08001451 NULL, size, flags, false, &local_err);
Kevin Wolfe1355052022-12-07 14:18:30 +01001452
Alberto Garcia43de7e22015-10-26 14:27:16 +02001453 if (local_err) {
1454 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001455 return;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001456 }
1457 }
1458
1459 options = qdict_new();
Peter Maydelld52e1a02018-11-01 16:30:37 +00001460 if (snapshot_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05001461 qdict_put_str(options, "node-name", snapshot_node_name);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001462 }
Eric Blake46f5ac22017-04-27 16:58:17 -05001463 qdict_put_str(options, "driver", format);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001464 }
1465
Max Reitz5b363932016-05-17 16:41:31 +02001466 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1467 errp);
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001468
Max Reitzf67503e2014-02-18 18:33:05 +01001469 /* We will manually add the backing_hd field to the bs later */
Max Reitz5b363932016-05-17 16:41:31 +02001470 if (!state->new_bs) {
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001471 return;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001472 }
1473
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001474 /*
1475 * Allow attaching a backing file to an overlay that's already in use only
1476 * if the parents don't assume that they are already seeing a valid image.
1477 * (Specifically, allow it as a mirror target, which is write-only access.)
1478 */
1479 bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1480 if (perm & BLK_PERM_CONSISTENT_READ) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001481 error_setg(errp, "The overlay is already in use");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001482 return;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001483 }
1484
Max Reitz7cc734a2019-06-12 18:34:46 +02001485 if (state->new_bs->drv->is_filter) {
1486 error_setg(errp, "Filters cannot be used as overlays");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001487 return;
Max Reitz7cc734a2019-06-12 18:34:46 +02001488 }
1489
1490 if (bdrv_cow_child(state->new_bs)) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001491 error_setg(errp, "The overlay already has a backing image");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001492 return;
Alberto Garcia08b24cf2015-11-03 12:32:35 +02001493 }
1494
1495 if (!state->new_bs->drv->supports_backing) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001496 error_setg(errp, "The overlay does not support backing images");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001497 return;
Kevin Wolfb2c28322017-02-20 12:46:42 +01001498 }
1499
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001500 ret = bdrv_append(state->new_bs, state->old_bs, errp);
1501 if (ret < 0) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001502 return;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001503 }
Kevin Wolf067acf22017-03-02 15:26:18 +01001504 state->overlay_appended = true;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001505}
1506
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001507static void external_snapshot_commit(void *opaque)
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001508{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001509 ExternalSnapshotState *state = opaque;
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001510
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001511 /* We don't need (or want) to use the transactional
1512 * bdrv_reopen_multiple() across all the entries at once, because we
1513 * don't want to abort all of them if one of them fails the reopen */
Stefan Hajnoczid73415a2020-09-23 11:56:46 +01001514 if (!qatomic_read(&state->old_bs->copy_on_read)) {
Alberto Garcia1b577742018-11-12 16:00:39 +02001515 bdrv_reopen_set_read_only(state->old_bs, true, NULL);
Kevin Wolf4c844982016-02-29 13:12:26 +01001516 }
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001517}
1518
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001519static void external_snapshot_abort(void *opaque)
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001520{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001521 ExternalSnapshotState *state = opaque;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001522 if (state->new_bs) {
Kevin Wolf067acf22017-03-02 15:26:18 +01001523 if (state->overlay_appended) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001524 AioContext *aio_context;
Sergio Lopez377410f2020-01-08 15:31:37 +01001525 AioContext *tmp_context;
1526 int ret;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001527
1528 aio_context = bdrv_get_aio_context(state->old_bs);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001529
Jeff Cody719fc282017-06-07 09:55:22 -04001530 bdrv_ref(state->old_bs); /* we can't let bdrv_set_backind_hd()
1531 close state->old_bs; we need it */
1532 bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
Sergio Lopez377410f2020-01-08 15:31:37 +01001533
1534 /*
1535 * The call to bdrv_set_backing_hd() above returns state->old_bs to
1536 * the main AioContext. As we're still going to be using it, return
1537 * it to the AioContext it was before.
1538 */
1539 tmp_context = bdrv_get_aio_context(state->old_bs);
1540 if (aio_context != tmp_context) {
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001541 ret = bdrv_try_change_aio_context(state->old_bs,
1542 aio_context, NULL, NULL);
Sergio Lopez377410f2020-01-08 15:31:37 +01001543 assert(ret == 0);
Sergio Lopez377410f2020-01-08 15:31:37 +01001544 }
1545
Kevin Wolfccd6a372023-10-27 17:53:25 +02001546 bdrv_drained_begin(state->new_bs);
Stefan Hajnoczi6bc30f12023-12-05 13:20:02 -05001547 bdrv_graph_wrlock();
Kevin Wolf5fe31c22017-03-06 16:20:51 +01001548 bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
Stefan Hajnoczi6bc30f12023-12-05 13:20:02 -05001549 bdrv_graph_wrunlock();
Kevin Wolfccd6a372023-10-27 17:53:25 +02001550 bdrv_drained_end(state->new_bs);
1551
Jeff Cody719fc282017-06-07 09:55:22 -04001552 bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
Kevin Wolfb2c28322017-02-20 12:46:42 +01001553 }
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001554 }
Fam Zhengda763e82015-10-23 11:08:10 +08001555}
1556
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001557static void external_snapshot_clean(void *opaque)
Fam Zhengda763e82015-10-23 11:08:10 +08001558{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001559 g_autofree ExternalSnapshotState *state = opaque;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001560
1561 if (!state->old_bs) {
1562 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001563 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001564
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001565 bdrv_drained_end(state->old_bs);
1566 bdrv_unref(state->new_bs);
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001567}
1568
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001569typedef struct DriveBackupState {
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001570 BlockDriverState *bs;
1571 BlockJob *job;
1572} DriveBackupState;
1573
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001574static BlockJob *do_backup_common(BackupCommon *backup,
1575 BlockDriverState *bs,
1576 BlockDriverState *target_bs,
1577 AioContext *aio_context,
1578 JobTxn *txn, Error **errp);
John Snow78f51fd2015-11-05 18:13:17 -05001579
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001580static void drive_backup_commit(void *opaque);
1581static void drive_backup_abort(void *opaque);
1582static void drive_backup_clean(void *opaque);
1583TransactionActionDrv drive_backup_drv = {
1584 .commit = drive_backup_commit,
1585 .abort = drive_backup_abort,
1586 .clean = drive_backup_clean,
1587};
1588
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001589static void drive_backup_action(DriveBackup *backup,
1590 JobTxn *block_job_txn,
1591 Transaction *tran, Error **errp)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001592{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001593 DriveBackupState *state = g_new0(DriveBackupState, 1);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001594 BlockDriverState *bs;
1595 BlockDriverState *target_bs;
1596 BlockDriverState *source = NULL;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001597 AioContext *aio_context;
Markus Armbruster04658a52022-11-04 17:06:50 +01001598 const char *format;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001599 QDict *options;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001600 Error *local_err = NULL;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001601 int flags;
1602 int64_t size;
1603 bool set_backing_hd = false;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001604 int ret;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001605
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02001606 GLOBAL_STATE_CODE();
1607
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001608 tran_add(tran, &drive_backup_drv, state);
1609
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001610 if (!backup->has_mode) {
1611 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1612 }
1613
Vladimir Sementsov-Ogievskiy85c9d132019-06-18 17:08:04 +03001614 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001615 if (!bs) {
Fam Zheng1fdd4b72015-10-23 11:08:11 +08001616 return;
1617 }
1618
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001619 if (!bs->drv) {
1620 error_setg(errp, "Device has no medium");
1621 return;
1622 }
1623
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001624 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001625
Vladimir Sementsov-Ogievskiy2842ff22021-06-08 10:18:52 -07001626 state->bs = bs;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001627 /* Paired with .clean() */
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001628 bdrv_drained_begin(bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001629
Markus Armbruster04658a52022-11-04 17:06:50 +01001630 format = backup->format;
1631 if (!format && backup->mode != NEW_IMAGE_MODE_EXISTING) {
1632 format = bs->drv->format_name;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001633 }
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001634
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001635 /* Early check to avoid creating target */
Kevin Wolf277f2002023-09-29 16:51:52 +02001636 bdrv_graph_rdlock_main_loop();
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001637 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
Kevin Wolf277f2002023-09-29 16:51:52 +02001638 bdrv_graph_rdunlock_main_loop();
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001639 return;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001640 }
1641
1642 flags = bs->open_flags | BDRV_O_RDWR;
1643
1644 /*
1645 * See if we have a backing HD we can use to create our new image
1646 * on top of.
1647 */
1648 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
Max Reitz2b088c62019-06-12 17:46:45 +02001649 /*
1650 * Backup will not replace the source by the target, so none
1651 * of the filters skipped here will be removed (in contrast to
1652 * mirror). Therefore, we can skip all of them when looking
1653 * for the first COW relationship.
1654 */
1655 source = bdrv_cow_bs(bdrv_skip_filters(bs));
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001656 if (!source) {
1657 backup->sync = MIRROR_SYNC_MODE_FULL;
1658 }
1659 }
1660 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1661 source = bs;
1662 flags |= BDRV_O_NO_BACKING;
1663 set_backing_hd = true;
1664 }
Kevin Wolfad747512023-10-27 17:53:17 +02001665 bdrv_graph_rdunlock_main_loop();
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001666
1667 size = bdrv_getlength(bs);
1668 if (size < 0) {
1669 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001670 return;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001671 }
1672
1673 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
Markus Armbruster04658a52022-11-04 17:06:50 +01001674 assert(format);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001675 if (source) {
Max Reitz2b088c62019-06-12 17:46:45 +02001676 /* Implicit filters should not appear in the filename */
Kevin Wolf430da832023-10-27 17:53:16 +02001677 BlockDriverState *explicit_backing;
Max Reitz2b088c62019-06-12 17:46:45 +02001678
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02001679 bdrv_graph_rdlock_main_loop();
Kevin Wolf430da832023-10-27 17:53:16 +02001680 explicit_backing = bdrv_skip_implicit_filters(source);
Max Reitz2b088c62019-06-12 17:46:45 +02001681 bdrv_refresh_filename(explicit_backing);
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02001682 bdrv_graph_rdunlock_main_loop();
1683
Markus Armbruster04658a52022-11-04 17:06:50 +01001684 bdrv_img_create(backup->target, format,
Max Reitz2b088c62019-06-12 17:46:45 +02001685 explicit_backing->filename,
1686 explicit_backing->drv->format_name, NULL,
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001687 size, flags, false, &local_err);
1688 } else {
Markus Armbruster04658a52022-11-04 17:06:50 +01001689 bdrv_img_create(backup->target, format, NULL, NULL, NULL,
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001690 size, flags, false, &local_err);
1691 }
1692 }
1693
Markus Armbruster84d18f02014-01-30 15:07:28 +01001694 if (local_err) {
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001695 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05001696 return;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001697 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001698
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001699 options = qdict_new();
1700 qdict_put_str(options, "discard", "unmap");
1701 qdict_put_str(options, "detect-zeroes", "unmap");
Markus Armbruster04658a52022-11-04 17:06:50 +01001702 if (format) {
1703 qdict_put_str(options, "driver", format);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001704 }
1705
1706 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
1707 if (!target_bs) {
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02001708 return;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001709 }
1710
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001711 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001712 if (ret < 0) {
1713 bdrv_unref(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001714 return;
1715 }
1716
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001717 if (set_backing_hd) {
Vladimir Sementsov-Ogievskiy5a11a1c2021-02-02 15:49:46 +03001718 if (bdrv_set_backing_hd(target_bs, source, errp) < 0) {
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001719 goto unref;
1720 }
1721 }
1722
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001723 state->job = do_backup_common(qapi_DriveBackup_base(backup),
1724 bs, target_bs, aio_context,
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001725 block_job_txn, errp);
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001726
1727unref:
1728 bdrv_unref(target_bs);
John Snow111049a2016-11-08 01:50:38 -05001729}
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001730
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001731static void drive_backup_commit(void *opaque)
John Snow111049a2016-11-08 01:50:38 -05001732{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001733 DriveBackupState *state = opaque;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001734
John Snow111049a2016-11-08 01:50:38 -05001735 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001736 job_start(&state->job->job);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001737}
1738
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001739static void drive_backup_abort(void *opaque)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001740{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001741 DriveBackupState *state = opaque;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001742
John Snow111049a2016-11-08 01:50:38 -05001743 if (state->job) {
Hanna Reitz4cfb3f02021-10-06 17:19:32 +02001744 job_cancel_sync(&state->job->job, true);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001745 }
1746}
1747
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001748static void drive_backup_clean(void *opaque)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001749{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001750 g_autofree DriveBackupState *state = opaque;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001751
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001752 if (!state->bs) {
1753 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001754 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001755
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001756 bdrv_drained_end(state->bs);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001757}
1758
Fam Zhengbd8baec2014-12-18 18:37:06 +08001759typedef struct BlockdevBackupState {
Fam Zhengbd8baec2014-12-18 18:37:06 +08001760 BlockDriverState *bs;
1761 BlockJob *job;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001762} BlockdevBackupState;
1763
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001764static void blockdev_backup_commit(void *opaque);
1765static void blockdev_backup_abort(void *opaque);
1766static void blockdev_backup_clean(void *opaque);
1767TransactionActionDrv blockdev_backup_drv = {
1768 .commit = blockdev_backup_commit,
1769 .abort = blockdev_backup_abort,
1770 .clean = blockdev_backup_clean,
1771};
1772
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001773static void blockdev_backup_action(BlockdevBackup *backup,
1774 JobTxn *block_job_txn,
1775 Transaction *tran, Error **errp)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001776{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001777 BlockdevBackupState *state = g_new0(BlockdevBackupState, 1);
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001778 BlockDriverState *bs;
1779 BlockDriverState *target_bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001780 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001781 int ret;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001782
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001783 tran_add(tran, &blockdev_backup_drv, state);
1784
Vladimir Sementsov-Ogievskiy930fe172018-07-02 15:46:29 -04001785 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001786 if (!bs) {
Fam Zhengff52bf32015-10-23 11:08:12 +08001787 return;
1788 }
1789
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001790 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1791 if (!target_bs) {
Fam Zhengbd8baec2014-12-18 18:37:06 +08001792 return;
1793 }
1794
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001795 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001796 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001797
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04001798 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001799 if (ret < 0) {
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001800 return;
1801 }
1802
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001803 state->bs = bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001804
1805 /* Paired with .clean() */
Fam Zhengff52bf32015-10-23 11:08:12 +08001806 bdrv_drained_begin(state->bs);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001807
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001808 state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1809 bs, target_bs, aio_context,
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001810 block_job_txn, errp);
John Snow111049a2016-11-08 01:50:38 -05001811}
Fam Zhengbd8baec2014-12-18 18:37:06 +08001812
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001813static void blockdev_backup_commit(void *opaque)
John Snow111049a2016-11-08 01:50:38 -05001814{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001815 BlockdevBackupState *state = opaque;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001816
John Snow111049a2016-11-08 01:50:38 -05001817 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001818 job_start(&state->job->job);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001819}
1820
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001821static void blockdev_backup_abort(void *opaque)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001822{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001823 BlockdevBackupState *state = opaque;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001824
John Snow111049a2016-11-08 01:50:38 -05001825 if (state->job) {
Hanna Reitz4cfb3f02021-10-06 17:19:32 +02001826 job_cancel_sync(&state->job->job, true);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001827 }
1828}
1829
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001830static void blockdev_backup_clean(void *opaque)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001831{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001832 g_autofree BlockdevBackupState *state = opaque;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001833
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001834 if (!state->bs) {
1835 return;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001836 }
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001837
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001838 bdrv_drained_end(state->bs);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001839}
1840
Fam Zhengdf9a6812015-11-09 18:16:54 +08001841typedef struct BlockDirtyBitmapState {
Fam Zhengdf9a6812015-11-09 18:16:54 +08001842 BdrvDirtyBitmap *bitmap;
1843 BlockDriverState *bs;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001844 HBitmap *backup;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001845 bool was_enabled;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001846} BlockDirtyBitmapState;
1847
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001848static void block_dirty_bitmap_add_abort(void *opaque);
1849TransactionActionDrv block_dirty_bitmap_add_drv = {
1850 .abort = block_dirty_bitmap_add_abort,
1851 .clean = g_free,
1852};
1853
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001854static void block_dirty_bitmap_add_action(BlockDirtyBitmapAdd *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001855 Transaction *tran, Error **errp)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001856{
1857 Error *local_err = NULL;
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001858 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001859
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001860 tran_add(tran, &block_dirty_bitmap_add_drv, state);
1861
Fam Zhengdf9a6812015-11-09 18:16:54 +08001862 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1863 qmp_block_dirty_bitmap_add(action->node, action->name,
1864 action->has_granularity, action->granularity,
Vladimir Sementsov-Ogievskiyfd5ae4c2017-06-28 15:05:23 +03001865 action->has_persistent, action->persistent,
John Snow0e2b7f02018-12-21 04:35:22 -05001866 action->has_disabled, action->disabled,
Fam Zhengdf9a6812015-11-09 18:16:54 +08001867 &local_err);
1868
1869 if (!local_err) {
Vladimir Sementsov-Ogievskiyc85feaf2023-05-10 18:06:23 +03001870 state->bitmap = block_dirty_bitmap_lookup(action->node, action->name,
1871 NULL, &error_abort);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001872 } else {
1873 error_propagate(errp, local_err);
1874 }
1875}
1876
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001877static void block_dirty_bitmap_add_abort(void *opaque)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001878{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001879 BlockDirtyBitmapState *state = opaque;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001880
Vladimir Sementsov-Ogievskiyc85feaf2023-05-10 18:06:23 +03001881 if (state->bitmap) {
1882 bdrv_release_dirty_bitmap(state->bitmap);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001883 }
1884}
1885
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001886static void block_dirty_bitmap_restore(void *opaque);
1887static void block_dirty_bitmap_free_backup(void *opaque);
1888TransactionActionDrv block_dirty_bitmap_clear_drv = {
1889 .abort = block_dirty_bitmap_restore,
1890 .commit = block_dirty_bitmap_free_backup,
1891 .clean = g_free,
1892};
1893
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001894static void block_dirty_bitmap_clear_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001895 Transaction *tran, Error **errp)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001896{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001897 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001898
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001899 tran_add(tran, &block_dirty_bitmap_clear_drv, state);
1900
Fam Zhengdf9a6812015-11-09 18:16:54 +08001901 state->bitmap = block_dirty_bitmap_lookup(action->node,
1902 action->name,
1903 &state->bs,
Fam Zhengdf9a6812015-11-09 18:16:54 +08001904 errp);
1905 if (!state->bitmap) {
1906 return;
1907 }
1908
John Snow3ae96d62019-03-12 12:05:49 -04001909 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
Vladimir Sementsov-Ogievskiyd6883bc2017-06-28 15:05:10 +03001910 return;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001911 }
1912
1913 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
Fam Zhengdf9a6812015-11-09 18:16:54 +08001914}
1915
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001916static void block_dirty_bitmap_restore(void *opaque)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001917{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001918 BlockDirtyBitmapState *state = opaque;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001919
John Snow184dd9c2017-03-15 17:28:11 -04001920 if (state->backup) {
Vladimir Sementsov-Ogievskiy56bd6622018-10-29 16:23:14 -04001921 bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
John Snow184dd9c2017-03-15 17:28:11 -04001922 }
Fam Zhengdf9a6812015-11-09 18:16:54 +08001923}
1924
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001925static void block_dirty_bitmap_free_backup(void *opaque)
Fam Zhengdf9a6812015-11-09 18:16:54 +08001926{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001927 BlockDirtyBitmapState *state = opaque;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001928
1929 hbitmap_free(state->backup);
1930}
1931
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001932static void block_dirty_bitmap_enable_abort(void *opaque);
1933TransactionActionDrv block_dirty_bitmap_enable_drv = {
1934 .abort = block_dirty_bitmap_enable_abort,
1935 .clean = g_free,
1936};
1937
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001938static void block_dirty_bitmap_enable_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001939 Transaction *tran, Error **errp)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001940{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001941 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001942
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001943 tran_add(tran, &block_dirty_bitmap_enable_drv, state);
1944
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001945 state->bitmap = block_dirty_bitmap_lookup(action->node,
1946 action->name,
1947 NULL,
1948 errp);
1949 if (!state->bitmap) {
1950 return;
1951 }
1952
John Snow3ae96d62019-03-12 12:05:49 -04001953 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04001954 return;
1955 }
1956
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001957 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
1958 bdrv_enable_dirty_bitmap(state->bitmap);
1959}
1960
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001961static void block_dirty_bitmap_enable_abort(void *opaque)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001962{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001963 BlockDirtyBitmapState *state = opaque;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001964
1965 if (!state->was_enabled) {
1966 bdrv_disable_dirty_bitmap(state->bitmap);
1967 }
1968}
1969
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001970static void block_dirty_bitmap_disable_abort(void *opaque);
1971TransactionActionDrv block_dirty_bitmap_disable_drv = {
1972 .abort = block_dirty_bitmap_disable_abort,
1973 .clean = g_free,
1974};
1975
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001976static void block_dirty_bitmap_disable_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001977 Transaction *tran, Error **errp)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001978{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03001979 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001980
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001981 tran_add(tran, &block_dirty_bitmap_disable_drv, state);
1982
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001983 state->bitmap = block_dirty_bitmap_lookup(action->node,
1984 action->name,
1985 NULL,
1986 errp);
1987 if (!state->bitmap) {
1988 return;
1989 }
1990
John Snow3ae96d62019-03-12 12:05:49 -04001991 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04001992 return;
1993 }
1994
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001995 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
1996 bdrv_disable_dirty_bitmap(state->bitmap);
1997}
1998
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03001999static void block_dirty_bitmap_disable_abort(void *opaque)
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002000{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002001 BlockDirtyBitmapState *state = opaque;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002002
2003 if (state->was_enabled) {
2004 bdrv_enable_dirty_bitmap(state->bitmap);
2005 }
2006}
2007
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002008TransactionActionDrv block_dirty_bitmap_merge_drv = {
2009 .commit = block_dirty_bitmap_free_backup,
2010 .abort = block_dirty_bitmap_restore,
2011 .clean = g_free,
2012};
2013
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002014static void block_dirty_bitmap_merge_action(BlockDirtyBitmapMerge *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002015 Transaction *tran, Error **errp)
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002016{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002017 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002018
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002019 tran_add(tran, &block_dirty_bitmap_merge_drv, state);
2020
Eric Blakec6996cf2020-05-12 20:16:43 -05002021 state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2022 action->bitmaps, &state->backup,
2023 errp);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002024}
2025
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002026static void block_dirty_bitmap_remove_commit(void *opaque);
2027static void block_dirty_bitmap_remove_abort(void *opaque);
2028TransactionActionDrv block_dirty_bitmap_remove_drv = {
2029 .commit = block_dirty_bitmap_remove_commit,
2030 .abort = block_dirty_bitmap_remove_abort,
2031 .clean = g_free,
2032};
2033
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002034static void block_dirty_bitmap_remove_action(BlockDirtyBitmap *action,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002035 Transaction *tran, Error **errp)
John Snowc4e4b0f2019-07-29 16:35:54 -04002036{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002037 BlockDirtyBitmapState *state = g_new0(BlockDirtyBitmapState, 1);
John Snowc4e4b0f2019-07-29 16:35:54 -04002038
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002039 tran_add(tran, &block_dirty_bitmap_remove_drv, state);
2040
John Snowc4e4b0f2019-07-29 16:35:54 -04002041
Eric Blakec6996cf2020-05-12 20:16:43 -05002042 state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2043 false, &state->bs, errp);
John Snowc4e4b0f2019-07-29 16:35:54 -04002044 if (state->bitmap) {
2045 bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2046 bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2047 }
2048}
2049
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002050static void block_dirty_bitmap_remove_abort(void *opaque)
John Snowc4e4b0f2019-07-29 16:35:54 -04002051{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002052 BlockDirtyBitmapState *state = opaque;
John Snowc4e4b0f2019-07-29 16:35:54 -04002053
2054 if (state->bitmap) {
2055 bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2056 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2057 }
2058}
2059
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002060static void block_dirty_bitmap_remove_commit(void *opaque)
John Snowc4e4b0f2019-07-29 16:35:54 -04002061{
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002062 BlockDirtyBitmapState *state = opaque;
John Snowc4e4b0f2019-07-29 16:35:54 -04002063
2064 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
Vladimir Sementsov-Ogievskiy5deb6cb2019-09-16 17:19:09 +03002065 bdrv_release_dirty_bitmap(state->bitmap);
John Snowc4e4b0f2019-07-29 16:35:54 -04002066}
2067
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002068static void abort_commit(void *opaque);
2069TransactionActionDrv abort_drv = {
2070 .commit = abort_commit,
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002071};
2072
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002073static void abort_action(Transaction *tran, Error **errp)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002074{
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002075 tran_add(tran, &abort_drv, NULL);
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002076 error_setg(errp, "Transaction aborted using Abort action");
2077}
2078
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002079static void abort_commit(void *opaque)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002080{
Stefan Weildfc6f862013-07-25 18:21:28 +02002081 g_assert_not_reached(); /* this action never succeeds */
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002082}
2083
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002084static void transaction_action(TransactionAction *act, JobTxn *block_job_txn,
2085 Transaction *tran, Error **errp)
2086{
2087 switch (act->type) {
2088 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
2089 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
2090 external_snapshot_action(act, tran, errp);
2091 return;
2092 case TRANSACTION_ACTION_KIND_DRIVE_BACKUP:
2093 drive_backup_action(act->u.drive_backup.data,
2094 block_job_txn, tran, errp);
2095 return;
2096 case TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP:
2097 blockdev_backup_action(act->u.blockdev_backup.data,
2098 block_job_txn, tran, errp);
2099 return;
2100 case TRANSACTION_ACTION_KIND_ABORT:
2101 abort_action(tran, errp);
2102 return;
2103 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC:
2104 internal_snapshot_action(act->u.blockdev_snapshot_internal_sync.data,
2105 tran, errp);
2106 return;
2107 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD:
2108 block_dirty_bitmap_add_action(act->u.block_dirty_bitmap_add.data,
2109 tran, errp);
2110 return;
2111 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR:
2112 block_dirty_bitmap_clear_action(act->u.block_dirty_bitmap_clear.data,
2113 tran, errp);
2114 return;
2115 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE:
2116 block_dirty_bitmap_enable_action(act->u.block_dirty_bitmap_enable.data,
2117 tran, errp);
2118 return;
2119 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE:
2120 block_dirty_bitmap_disable_action(
2121 act->u.block_dirty_bitmap_disable.data, tran, errp);
2122 return;
2123 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE:
2124 block_dirty_bitmap_merge_action(act->u.block_dirty_bitmap_merge.data,
2125 tran, errp);
2126 return;
2127 case TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE:
2128 block_dirty_bitmap_remove_action(act->u.block_dirty_bitmap_remove.data,
2129 tran, errp);
2130 return;
2131 /*
2132 * Where are transactions for MIRROR, COMMIT and STREAM?
John Snow66da04d2018-09-06 09:02:25 -04002133 * Although these blockjobs use transaction callbacks like the backup job,
2134 * these jobs do not necessarily adhere to transaction semantics.
2135 * These jobs may not fully undo all of their actions on abort, nor do they
2136 * necessarily work in transactions with more than one job in them.
2137 */
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002138 case TRANSACTION_ACTION_KIND__MAX:
2139 default:
2140 g_assert_not_reached();
2141 };
2142}
2143
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002144
Jeff Cody8802d1f2012-02-28 15:54:06 -05002145/*
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002146 * 'Atomic' group operations. The operations are performed as a set, and if
2147 * any fail then we roll back all operations in the group.
Emanuele Giuseppe Espositoebc27522022-03-03 10:15:56 -05002148 *
2149 * Always run under BQL.
Jeff Cody8802d1f2012-02-28 15:54:06 -05002150 */
Vladimir Sementsov-Ogievskiy24039692023-05-10 18:06:20 +03002151void qmp_transaction(TransactionActionList *actions,
2152 struct TransactionProperties *properties,
John Snow94d16a62015-11-05 18:13:18 -05002153 Error **errp)
Jeff Cody8802d1f2012-02-28 15:54:06 -05002154{
Vladimir Sementsov-Ogievskiy30c96b52023-05-10 18:06:21 +03002155 TransactionActionList *act;
Kevin Wolf62c9e412018-04-19 16:09:52 +02002156 JobTxn *block_job_txn = NULL;
Luiz Capitulino43e17042012-11-30 10:52:07 -02002157 Error *local_err = NULL;
Vladimir Sementsov-Ogievskiyc85f34c2023-05-10 18:06:22 +03002158 Transaction *tran;
2159 ActionCompletionMode comp_mode =
2160 properties ? properties->completion_mode :
2161 ACTION_COMPLETION_MODE_INDIVIDUAL;
Jeff Cody8802d1f2012-02-28 15:54:06 -05002162
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05002163 GLOBAL_STATE_CODE();
2164
John Snow94d16a62015-11-05 18:13:18 -05002165 /* Does this transaction get canceled as a group on failure?
Kevin Wolf62c9e412018-04-19 16:09:52 +02002166 * If not, we don't really need to make a JobTxn.
John Snow94d16a62015-11-05 18:13:18 -05002167 */
Vladimir Sementsov-Ogievskiyc85f34c2023-05-10 18:06:22 +03002168 if (comp_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2169 for (act = actions; act; act = act->next) {
2170 TransactionActionKind type = act->value->type;
2171
2172 if (type != TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP &&
2173 type != TRANSACTION_ACTION_KIND_DRIVE_BACKUP)
2174 {
2175 error_setg(errp,
2176 "Action '%s' does not support transaction property "
2177 "completion-mode = %s",
2178 TransactionActionKind_str(type),
2179 ActionCompletionMode_str(comp_mode));
2180 return;
2181 }
2182 }
2183
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002184 block_job_txn = job_txn_new();
John Snow94d16a62015-11-05 18:13:18 -05002185 }
2186
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002187 /* drain all i/o before any operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002188 bdrv_drain_all();
2189
Vladimir Sementsov-Ogievskiyc85f34c2023-05-10 18:06:22 +03002190 tran = tran_new();
2191
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002192 /* We don't do anything in this loop that commits us to the operations */
Vladimir Sementsov-Ogievskiy30c96b52023-05-10 18:06:21 +03002193 for (act = actions; act; act = act->next) {
Vladimir Sementsov-Ogievskiyd53c89a2023-05-10 18:06:24 +03002194 transaction_action(act->value, block_job_txn, tran, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002195 if (local_err) {
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002196 error_propagate(errp, local_err);
2197 goto delete_and_fail;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002198 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002199 }
2200
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002201 tran_commit(tran);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002202
2203 /* success */
2204 goto exit;
2205
2206delete_and_fail:
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002207 /* failure, and it is all-or-none; roll back all operations */
Vladimir Sementsov-Ogievskiy8187f632023-05-10 18:06:19 +03002208 tran_abort(tran);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002209exit:
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002210 job_txn_unref(block_job_txn);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002211}
2212
Vladimir Sementsov-Ogievskiya3b52532017-06-28 15:05:25 +03002213BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2214 const char *name,
2215 Error **errp)
2216{
2217 BdrvDirtyBitmap *bitmap;
2218 BlockDriverState *bs;
2219 BlockDirtyBitmapSha256 *ret = NULL;
2220 char *sha256;
2221
2222 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2223 if (!bitmap || !bs) {
2224 return NULL;
2225 }
2226
2227 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2228 if (sha256 == NULL) {
2229 return NULL;
2230 }
2231
2232 ret = g_new(BlockDirtyBitmapSha256, 1);
2233 ret->sha256 = sha256;
2234
2235 return ret;
2236}
2237
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002238void coroutine_fn qmp_block_resize(const char *device, const char *node_name,
Kevin Wolfeb94b812020-10-05 17:58:55 +02002239 int64_t size, Error **errp)
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002240{
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002241 Error *local_err = NULL;
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002242 BlockBackend *blk;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002243 BlockDriverState *bs;
Kevin Wolfeb94b812020-10-05 17:58:55 +02002244 AioContext *old_ctx;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002245
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002246 bs = bdrv_lookup_bs(device, node_name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002247 if (local_err) {
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002248 error_propagate(errp, local_err);
2249 return;
2250 }
2251
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002252 if (size < 0) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002253 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002254 return;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002255 }
2256
Kevin Wolf277f2002023-09-29 16:51:52 +02002257 bdrv_graph_co_rdlock();
Markus Armbruster9fe07532024-03-06 14:10:54 +01002258 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, errp)) {
Kevin Wolf277f2002023-09-29 16:51:52 +02002259 bdrv_graph_co_rdunlock();
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002260 return;
Jeff Cody9c75e162014-06-25 16:55:30 -04002261 }
Kevin Wolf277f2002023-09-29 16:51:52 +02002262 bdrv_graph_co_rdunlock();
Jeff Cody9c75e162014-06-25 16:55:30 -04002263
Kevin Wolf0c7d2042023-05-04 13:57:34 +02002264 blk = blk_co_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
Eric Blakea3aeeab2020-04-28 14:26:46 -05002265 if (!blk) {
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002266 return;
Kevin Wolfd7086422017-01-13 19:02:32 +01002267 }
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002268
John Snow698bdfa2017-05-10 13:39:45 -04002269 bdrv_drained_begin(bs);
Kevin Wolf8089eab2020-12-03 18:23:10 +01002270
Kevin Wolfeb94b812020-10-05 17:58:55 +02002271 old_ctx = bdrv_co_enter(bs);
Alberto Faria247cf5c2022-10-13 14:37:11 +02002272 blk_co_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002273 bdrv_co_leave(bs, old_ctx);
Stefan Hajnoczi927e0e72014-08-18 14:52:28 +01002274
Kevin Wolf8089eab2020-12-03 18:23:10 +01002275 bdrv_drained_end(bs);
Kevin Wolf755ae382023-12-08 13:43:52 +01002276 blk_co_unref(blk);
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002277}
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002278
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002279void qmp_block_stream(const char *job_id, const char *device,
2280 const char *base,
2281 const char *base_node,
2282 const char *backing_file,
Peter Krempa72098a32023-12-05 18:14:42 +01002283 bool has_backing_mask_protocol,
2284 bool backing_mask_protocol,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002285 const char *bottom,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002286 bool has_speed, int64_t speed,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002287 bool has_on_error, BlockdevOnError on_error,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002288 const char *filter_node_name,
John Snow241ca1a2018-09-06 09:02:23 -04002289 bool has_auto_finalize, bool auto_finalize,
2290 bool has_auto_dismiss, bool auto_dismiss,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002291 Error **errp)
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002292{
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002293 BlockDriverState *bs, *iter, *iter_end;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002294 BlockDriverState *base_bs = NULL;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002295 BlockDriverState *bottom_bs = NULL;
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002296 AioContext *aio_context;
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002297 Error *local_err = NULL;
John Snowcf6320d2018-09-06 09:02:12 -04002298 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002299
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02002300 GLOBAL_STATE_CODE();
2301
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002302 if (base && base_node) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002303 error_setg(errp, "'base' and 'base-node' cannot be specified "
2304 "at the same time");
2305 return;
2306 }
2307
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002308 if (base && bottom) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002309 error_setg(errp, "'base' and 'bottom' cannot be specified "
2310 "at the same time");
2311 return;
2312 }
2313
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002314 if (bottom && base_node) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002315 error_setg(errp, "'bottom' and 'base-node' cannot be specified "
2316 "at the same time");
2317 return;
2318 }
2319
Peter Krempa72098a32023-12-05 18:14:42 +01002320 if (!has_backing_mask_protocol) {
2321 backing_mask_protocol = false;
2322 }
2323
Paolo Bonzini1d809092012-09-28 17:22:59 +02002324 if (!has_on_error) {
2325 on_error = BLOCKDEV_ON_ERROR_REPORT;
2326 }
2327
Alberto Garcia554b6142016-10-28 10:08:11 +03002328 bs = bdrv_lookup_bs(device, device, errp);
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002329 if (!bs) {
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002330 return;
2331 }
2332
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002333 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002334
Kevin Wolf79bb7622023-10-27 17:53:19 +02002335 bdrv_graph_rdlock_main_loop();
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002336 if (base) {
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002337 base_bs = bdrv_find_backing_image(bs, base);
2338 if (base_bs == NULL) {
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002339 error_setg(errp, "Can't find '%s' in the backing chain", base);
Kevin Wolf79bb7622023-10-27 17:53:19 +02002340 goto out_rdlock;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002341 }
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002342 assert(bdrv_get_aio_context(base_bs) == aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002343 }
2344
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002345 if (base_node) {
Alberto Garcia312fe092016-10-28 10:08:19 +03002346 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2347 if (!base_bs) {
Kevin Wolf79bb7622023-10-27 17:53:19 +02002348 goto out_rdlock;
Alberto Garcia312fe092016-10-28 10:08:19 +03002349 }
2350 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2351 error_setg(errp, "Node '%s' is not a backing image of '%s'",
2352 base_node, device);
Kevin Wolf79bb7622023-10-27 17:53:19 +02002353 goto out_rdlock;
Alberto Garcia312fe092016-10-28 10:08:19 +03002354 }
2355 assert(bdrv_get_aio_context(base_bs) == aio_context);
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02002356
Max Reitzf30c66b2019-02-01 20:29:05 +01002357 bdrv_refresh_filename(base_bs);
Alberto Garcia312fe092016-10-28 10:08:19 +03002358 }
2359
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002360 if (bottom) {
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002361 bottom_bs = bdrv_lookup_bs(NULL, bottom, errp);
2362 if (!bottom_bs) {
Kevin Wolf79bb7622023-10-27 17:53:19 +02002363 goto out_rdlock;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002364 }
2365 if (!bottom_bs->drv) {
2366 error_setg(errp, "Node '%s' is not open", bottom);
Kevin Wolf79bb7622023-10-27 17:53:19 +02002367 goto out_rdlock;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002368 }
2369 if (bottom_bs->drv->is_filter) {
2370 error_setg(errp, "Node '%s' is a filter, use a non-filter node "
2371 "as 'bottom'", bottom);
Kevin Wolf79bb7622023-10-27 17:53:19 +02002372 goto out_rdlock;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002373 }
2374 if (!bdrv_chain_contains(bs, bottom_bs)) {
2375 error_setg(errp, "Node '%s' is not in a chain starting from '%s'",
2376 bottom, device);
Kevin Wolf79bb7622023-10-27 17:53:19 +02002377 goto out_rdlock;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002378 }
2379 assert(bdrv_get_aio_context(bottom_bs) == aio_context);
2380 }
2381
2382 /*
2383 * Check for op blockers in the whole chain between bs and base (or bottom)
2384 */
Kevin Wolf372b69f2023-10-27 17:53:15 +02002385 iter_end = bottom ? bdrv_filter_or_cow_bs(bottom_bs) : base_bs;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002386 for (iter = bs; iter && iter != iter_end;
Max Reitz67acfd22019-06-12 17:48:11 +02002387 iter = bdrv_filter_or_cow_bs(iter))
2388 {
Alberto Garcia554b6142016-10-28 10:08:11 +03002389 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
Kevin Wolf79bb7622023-10-27 17:53:19 +02002390 goto out_rdlock;
Alberto Garcia554b6142016-10-28 10:08:11 +03002391 }
2392 }
Kevin Wolf277f2002023-09-29 16:51:52 +02002393 bdrv_graph_rdunlock_main_loop();
Alberto Garcia554b6142016-10-28 10:08:11 +03002394
Jeff Cody13d8cc52014-06-25 15:40:11 -04002395 /* if we are streaming the entire chain, the result will have no backing
2396 * file, and specifying one is therefore an error */
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002397 if (!base_bs && backing_file) {
Jeff Cody13d8cc52014-06-25 15:40:11 -04002398 error_setg(errp, "backing file specified, but streaming the "
2399 "entire chain");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002400 return;
Jeff Cody13d8cc52014-06-25 15:40:11 -04002401 }
2402
John Snow241ca1a2018-09-06 09:02:23 -04002403 if (has_auto_finalize && !auto_finalize) {
2404 job_flags |= JOB_MANUAL_FINALIZE;
2405 }
2406 if (has_auto_dismiss && !auto_dismiss) {
2407 job_flags |= JOB_MANUAL_DISMISS;
2408 }
2409
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002410 stream_start(job_id, bs, base_bs, backing_file,
Peter Krempa72098a32023-12-05 18:14:42 +01002411 backing_mask_protocol,
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002412 bottom_bs, job_flags, has_speed ? speed : 0, on_error,
Andrey Shinkevich880747a2020-12-16 09:16:54 +03002413 filter_node_name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002414 if (local_err) {
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002415 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002416 return;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002417 }
2418
Vladimir Sementsov-Ogievskiyb23c5802019-06-06 18:41:32 +03002419 trace_qmp_block_stream(bs);
Kevin Wolf79bb7622023-10-27 17:53:19 +02002420 return;
2421
2422out_rdlock:
2423 bdrv_graph_rdunlock_main_loop();
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002424}
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00002425
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002426void qmp_block_commit(const char *job_id, const char *device,
2427 const char *base_node,
2428 const char *base,
2429 const char *top_node,
2430 const char *top,
2431 const char *backing_file,
Peter Krempa4b028cb2023-12-05 18:14:41 +01002432 bool has_backing_mask_protocol,
2433 bool backing_mask_protocol,
Jeff Codyed61fc12012-09-27 13:29:16 -04002434 bool has_speed, int64_t speed,
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002435 bool has_on_error, BlockdevOnError on_error,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002436 const char *filter_node_name,
John Snow96fbf532018-09-06 09:02:21 -04002437 bool has_auto_finalize, bool auto_finalize,
2438 bool has_auto_dismiss, bool auto_dismiss,
Jeff Codyed61fc12012-09-27 13:29:16 -04002439 Error **errp)
2440{
2441 BlockDriverState *bs;
Alberto Garcia058223a2016-10-28 10:08:07 +03002442 BlockDriverState *iter;
Jeff Codyed61fc12012-09-27 13:29:16 -04002443 BlockDriverState *base_bs, *top_bs;
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002444 AioContext *aio_context;
Jeff Codyed61fc12012-09-27 13:29:16 -04002445 Error *local_err = NULL;
John Snow53607822018-09-06 09:02:10 -04002446 int job_flags = JOB_DEFAULT;
Max Reitz05ea3852019-06-11 21:19:26 +02002447 uint64_t top_perm, top_shared;
Jeff Codyed61fc12012-09-27 13:29:16 -04002448
Kevin Wolfbce73bc2023-09-11 11:46:13 +02002449 /* TODO We'll eventually have to take a writer lock in this function */
2450 GRAPH_RDLOCK_GUARD_MAINLOOP();
2451
Max Reitz54504662014-04-10 19:36:25 +02002452 if (!has_speed) {
2453 speed = 0;
2454 }
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002455 if (!has_on_error) {
2456 on_error = BLOCKDEV_ON_ERROR_REPORT;
2457 }
John Snow96fbf532018-09-06 09:02:21 -04002458 if (has_auto_finalize && !auto_finalize) {
2459 job_flags |= JOB_MANUAL_FINALIZE;
2460 }
2461 if (has_auto_dismiss && !auto_dismiss) {
2462 job_flags |= JOB_MANUAL_DISMISS;
2463 }
Peter Krempa4b028cb2023-12-05 18:14:41 +01002464 if (!has_backing_mask_protocol) {
2465 backing_mask_protocol = false;
2466 }
Max Reitz54504662014-04-10 19:36:25 +02002467
Jeff Cody7676e2c2014-06-30 15:14:15 +02002468 /* Important Note:
2469 * libvirt relies on the DeviceNotFound error class in order to probe for
2470 * live commit feature versions; for this to work, we must make sure to
2471 * perform the device lookup before any generic errors that may occur in a
2472 * scenario in which all optional arguments are omitted. */
Kevin Wolf1d13b162016-06-23 14:20:24 +02002473 bs = qmp_get_root_bs(device, &local_err);
2474 if (!bs) {
2475 bs = bdrv_lookup_bs(device, device, NULL);
2476 if (!bs) {
2477 error_free(local_err);
2478 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2479 "Device '%s' not found", device);
2480 } else {
2481 error_propagate(errp, local_err);
2482 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002483 return;
2484 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002485
Kevin Wolf1d13b162016-06-23 14:20:24 +02002486 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002487
Fam Zhengbb000212014-09-11 13:14:00 +08002488 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002489 return;
Fam Zheng628ff682014-05-23 21:29:44 +08002490 }
2491
Jeff Codyed61fc12012-09-27 13:29:16 -04002492 /* default top_bs is the active layer */
2493 top_bs = bs;
2494
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002495 if (top_node && top) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002496 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002497 return;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002498 } else if (top_node) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002499 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2500 if (top_bs == NULL) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002501 return;
Kevin Wolf3c605f42017-06-27 17:18:20 +02002502 }
2503 if (!bdrv_chain_contains(bs, top_bs)) {
2504 error_setg(errp, "'%s' is not in this backing file chain",
2505 top_node);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002506 return;
Kevin Wolf3c605f42017-06-27 17:18:20 +02002507 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002508 } else if (top) {
Max Reitzf30c66b2019-02-01 20:29:05 +01002509 /* This strcmp() is just a shortcut, there is no need to
2510 * refresh @bs's filename. If it mismatches,
2511 * bdrv_find_backing_image() will do the refresh and may still
2512 * return @bs. */
Jeff Codyed61fc12012-09-27 13:29:16 -04002513 if (strcmp(bs->filename, top) != 0) {
2514 top_bs = bdrv_find_backing_image(bs, top);
2515 }
2516 }
2517
2518 if (top_bs == NULL) {
2519 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002520 return;
Jeff Codyed61fc12012-09-27 13:29:16 -04002521 }
2522
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002523 assert(bdrv_get_aio_context(top_bs) == aio_context);
2524
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002525 if (base_node && base) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002526 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002527 return;
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002528 } else if (base_node) {
Kevin Wolf3c605f42017-06-27 17:18:20 +02002529 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2530 if (base_bs == NULL) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002531 return;
Kevin Wolf3c605f42017-06-27 17:18:20 +02002532 }
2533 if (!bdrv_chain_contains(top_bs, base_bs)) {
2534 error_setg(errp, "'%s' is not in this backing file chain",
2535 base_node);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002536 return;
Kevin Wolf3c605f42017-06-27 17:18:20 +02002537 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002538 } else if (base) {
Jeff Codyd5208c42012-10-16 15:49:10 -04002539 base_bs = bdrv_find_backing_image(top_bs, base);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002540 if (base_bs == NULL) {
2541 error_setg(errp, "Can't find '%s' in the backing chain", base);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002542 return;
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002543 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002544 } else {
2545 base_bs = bdrv_find_base(top_bs);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002546 if (base_bs == NULL) {
2547 error_setg(errp, "There is no backimg image");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002548 return;
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002549 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002550 }
2551
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002552 assert(bdrv_get_aio_context(base_bs) == aio_context);
2553
Max Reitz9a71b9d2019-06-12 17:47:37 +02002554 for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2555 iter = bdrv_filter_or_cow_bs(iter))
2556 {
Alberto Garcia058223a2016-10-28 10:08:07 +03002557 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002558 return;
Alberto Garcia058223a2016-10-28 10:08:07 +03002559 }
Fam Zhengbb000212014-09-11 13:14:00 +08002560 }
2561
Jeff Cody7676e2c2014-06-30 15:14:15 +02002562 /* Do not allow attempts to commit an image into itself */
2563 if (top_bs == base_bs) {
2564 error_setg(errp, "cannot commit an image into itself");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002565 return;
Jeff Cody7676e2c2014-06-30 15:14:15 +02002566 }
2567
Max Reitz05ea3852019-06-11 21:19:26 +02002568 /*
2569 * Active commit is required if and only if someone has taken a
2570 * WRITE permission on the top node. Historically, we have always
2571 * used active commit for top nodes, so continue that practice
2572 * lest we possibly break clients that rely on this behavior, e.g.
2573 * to later attach this node to a writing parent.
2574 * (Active commit is never really wrong.)
2575 */
2576 bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2577 if (top_perm & BLK_PERM_WRITE ||
2578 bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2579 {
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002580 if (backing_file) {
Max Reitz05ea3852019-06-11 21:19:26 +02002581 if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2582 error_setg(errp, "'backing-file' specified,"
2583 " but 'top' is the active layer");
2584 } else {
2585 error_setg(errp, "'backing-file' specified, but 'top' has a "
2586 "writer on it");
2587 }
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002588 return;
Jeff Cody54e26902014-06-25 15:40:10 -04002589 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002590 if (!job_id) {
Max Reitz05ea3852019-06-11 21:19:26 +02002591 /*
2592 * Emulate here what block_job_create() does, because it
2593 * is possible that @bs != @top_bs (the block job should
2594 * be named after @bs, even if @top_bs is the actual
2595 * source)
2596 */
2597 job_id = bdrv_get_device_name(bs);
2598 }
2599 commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
Fam Zheng78bbd912017-04-21 20:27:04 +08002600 filter_node_name, NULL, NULL, false, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002601 } else {
Alberto Garcia058223a2016-10-28 10:08:07 +03002602 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2603 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002604 return;
Alberto Garcia058223a2016-10-28 10:08:07 +03002605 }
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002606 commit_start(job_id, bs, base_bs, top_bs, job_flags,
2607 speed, on_error, backing_file,
Peter Krempa4b028cb2023-12-05 18:14:41 +01002608 backing_mask_protocol,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002609 filter_node_name, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002610 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002611 if (local_err != NULL) {
2612 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002613 return;
Jeff Codyed61fc12012-09-27 13:29:16 -04002614 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002615}
2616
John Snow7b0b8702019-07-29 16:35:52 -04002617/* Common QMP interface for drive-backup and blockdev-backup */
2618static BlockJob *do_backup_common(BackupCommon *backup,
2619 BlockDriverState *bs,
2620 BlockDriverState *target_bs,
2621 AioContext *aio_context,
2622 JobTxn *txn, Error **errp)
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002623{
John Snow111049a2016-11-08 01:50:38 -05002624 BlockJob *job = NULL;
John Snowd58d8452015-04-17 19:49:58 -04002625 BdrvDirtyBitmap *bmap = NULL;
Vladimir Sementsov-Ogievskiy6a30f662021-01-17 00:47:00 +03002626 BackupPerf perf = { .max_workers = 64 };
John Snow7b0b8702019-07-29 16:35:52 -04002627 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002628
Pavel Butsykin81206a82016-07-22 11:17:50 +03002629 if (!backup->has_speed) {
2630 backup->speed = 0;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002631 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002632 if (!backup->has_on_source_error) {
2633 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002634 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002635 if (!backup->has_on_target_error) {
2636 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002637 }
John Snowb40dacd2018-03-10 03:27:44 -05002638 if (!backup->has_auto_finalize) {
2639 backup->auto_finalize = true;
2640 }
2641 if (!backup->has_auto_dismiss) {
2642 backup->auto_dismiss = true;
2643 }
Pavel Butsykin13b94142016-07-22 11:17:52 +03002644 if (!backup->has_compress) {
2645 backup->compress = false;
2646 }
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002647
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002648 if (backup->x_perf) {
2649 if (backup->x_perf->has_use_copy_range) {
2650 perf.use_copy_range = backup->x_perf->use_copy_range;
2651 }
Vladimir Sementsov-Ogievskiy2c59fd82021-01-17 00:46:52 +03002652 if (backup->x_perf->has_max_workers) {
2653 perf.max_workers = backup->x_perf->max_workers;
2654 }
2655 if (backup->x_perf->has_max_chunk) {
2656 perf.max_chunk = backup->x_perf->max_chunk;
2657 }
Fiona Ebner6252deb2024-07-11 14:09:15 +02002658 if (backup->x_perf->has_min_cluster_size) {
2659 perf.min_cluster_size = backup->x_perf->min_cluster_size;
2660 }
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002661 }
2662
John Snowa6c93652019-07-29 16:35:55 -04002663 if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2664 (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2665 /* done before desugaring 'incremental' to print the right message */
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002666 if (!backup->bitmap) {
John Snowa6c93652019-07-29 16:35:55 -04002667 error_setg(errp, "must provide a valid bitmap name for "
2668 "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2669 return NULL;
2670 }
2671 }
2672
John Snowc8b56502019-07-29 16:35:52 -04002673 if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2674 if (backup->has_bitmap_mode &&
2675 backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2676 error_setg(errp, "Bitmap sync mode must be '%s' "
2677 "when using sync mode '%s'",
2678 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2679 MirrorSyncMode_str(backup->sync));
2680 return NULL;
2681 }
2682 backup->has_bitmap_mode = true;
2683 backup->sync = MIRROR_SYNC_MODE_BITMAP;
2684 backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2685 }
2686
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002687 if (backup->bitmap) {
John Snow7b0b8702019-07-29 16:35:52 -04002688 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2689 if (!bmap) {
2690 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2691 return NULL;
2692 }
John Snowc8b56502019-07-29 16:35:52 -04002693 if (!backup->has_bitmap_mode) {
2694 error_setg(errp, "Bitmap sync mode must be given "
2695 "when providing a bitmap");
2696 return NULL;
2697 }
John Snowb30ffbe2019-07-29 16:35:54 -04002698 if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snow7b0b8702019-07-29 16:35:52 -04002699 return NULL;
2700 }
John Snow1a2b8b42019-07-29 16:35:55 -04002701
2702 /* This does not produce a useful bitmap artifact: */
2703 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2704 error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2705 " outputs", MirrorSyncMode_str(backup->sync));
2706 return NULL;
2707 }
2708
2709 /* If the bitmap isn't used for input or output, this is useless: */
2710 if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2711 backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2712 error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2713 " when combined with sync mode '%s'",
2714 BitmapSyncMode_str(backup->bitmap_mode),
2715 MirrorSyncMode_str(backup->sync));
2716 return NULL;
2717 }
2718 }
2719
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002720 if (!backup->bitmap && backup->has_bitmap_mode) {
John Snow1a2b8b42019-07-29 16:35:55 -04002721 error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2722 return NULL;
John Snow7b0b8702019-07-29 16:35:52 -04002723 }
2724
2725 if (!backup->auto_finalize) {
2726 job_flags |= JOB_MANUAL_FINALIZE;
2727 }
2728 if (!backup->auto_dismiss) {
2729 job_flags |= JOB_MANUAL_DISMISS;
2730 }
2731
2732 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
John Snowc8b56502019-07-29 16:35:52 -04002733 backup->sync, bmap, backup->bitmap_mode,
Vladimir Sementsov-Ogievskiy0fd05c82024-03-13 18:28:21 +03002734 backup->compress, backup->discard_source,
Vladimir Sementsov-Ogievskiy00e30f02019-10-01 16:14:09 +03002735 backup->filter_node_name,
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002736 &perf,
John Snowc8b56502019-07-29 16:35:52 -04002737 backup->on_source_error,
2738 backup->on_target_error,
John Snow7b0b8702019-07-29 16:35:52 -04002739 job_flags, NULL, NULL, txn, errp);
2740 return job;
2741}
2742
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002743void qmp_drive_backup(DriveBackup *backup, Error **errp)
John Snow7b0b8702019-07-29 16:35:52 -04002744{
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002745 TransactionAction action = {
2746 .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2747 .u.drive_backup.data = backup,
2748 };
2749 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002750}
2751
Peter Krempafacda542020-01-20 09:50:49 +01002752BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2753 bool flat,
2754 Error **errp)
Benoît Canetc13163f2014-01-23 21:31:34 +01002755{
Peter Krempafacda542020-01-20 09:50:49 +01002756 bool return_flat = has_flat && flat;
2757
2758 return bdrv_named_nodes_list(return_flat, errp);
Benoît Canetc13163f2014-01-23 21:31:34 +01002759}
2760
Vladimir Sementsov-Ogievskiy5d3b4e92018-12-21 20:09:07 +03002761XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2762{
Kevin Wolf15f3f1f2023-09-29 16:51:44 +02002763 GRAPH_RDLOCK_GUARD_MAINLOOP();
2764
Vladimir Sementsov-Ogievskiy5d3b4e92018-12-21 20:09:07 +03002765 return bdrv_get_xdbg_block_graph(errp);
2766}
2767
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002768void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
Fam Zhengc29c1dd2014-12-18 18:37:05 +08002769{
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002770 TransactionAction action = {
2771 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2772 .u.blockdev_backup.data = backup,
2773 };
2774 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002775}
2776
Fam Zheng4193cdd2015-12-24 12:45:03 +08002777/* Parameter check and block job starting for drive mirroring.
2778 * Caller should hold @device and @target's aio context (must be the same).
2779 **/
Alberto Garcia71aa9862016-07-05 17:28:57 +03002780static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002781 BlockDriverState *target,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002782 const char *replaces,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002783 enum MirrorSyncMode sync,
Max Reitz274fcce2016-06-10 20:57:47 +02002784 BlockMirrorBackingMode backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02002785 bool zero_target,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002786 bool has_speed, int64_t speed,
2787 bool has_granularity, uint32_t granularity,
2788 bool has_buf_size, int64_t buf_size,
2789 bool has_on_source_error,
2790 BlockdevOnError on_source_error,
2791 bool has_on_target_error,
2792 BlockdevOnError on_target_error,
2793 bool has_unmap, bool unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002794 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02002795 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04002796 bool has_auto_finalize, bool auto_finalize,
2797 bool has_auto_dismiss, bool auto_dismiss,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002798 Error **errp)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002799{
Max Reitz3f072a72019-06-12 16:27:32 +02002800 BlockDriverState *unfiltered_bs;
John Snowa1999b32018-09-06 09:02:11 -04002801 int job_flags = JOB_DEFAULT;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002802
Kevin Wolf533c6e42023-05-04 13:57:49 +02002803 GLOBAL_STATE_CODE();
2804 GRAPH_RDLOCK_GUARD_MAINLOOP();
2805
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002806 if (!has_speed) {
2807 speed = 0;
2808 }
Paolo Bonzinib952b552012-10-18 16:49:28 +02002809 if (!has_on_source_error) {
2810 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2811 }
2812 if (!has_on_target_error) {
2813 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2814 }
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002815 if (!has_granularity) {
2816 granularity = 0;
2817 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002818 if (!has_buf_size) {
Wen Congyang48ac0a42015-05-15 15:51:36 +08002819 buf_size = 0;
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002820 }
Fam Zheng0fc9f8e2015-06-08 13:56:08 +08002821 if (!has_unmap) {
2822 unmap = true;
2823 }
Max Reitz481deba2018-06-13 20:18:22 +02002824 if (!has_copy_mode) {
2825 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
2826 }
John Snowa6b58ad2018-09-06 09:02:22 -04002827 if (has_auto_finalize && !auto_finalize) {
2828 job_flags |= JOB_MANUAL_FINALIZE;
2829 }
2830 if (has_auto_dismiss && !auto_dismiss) {
2831 job_flags |= JOB_MANUAL_DISMISS;
2832 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002833
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002834 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002835 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2836 "a value in range [512B, 64MB]");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002837 return;
2838 }
2839 if (granularity & (granularity - 1)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002840 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
Markus Armbruster6cc06672020-11-13 09:26:26 +01002841 "a power of 2");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002842 return;
2843 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002844
Fam Zheng4193cdd2015-12-24 12:45:03 +08002845 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
2846 return;
2847 }
Fam Zhenge40e5022015-12-24 12:45:04 +08002848 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
2849 return;
2850 }
Fam Zheng4193cdd2015-12-24 12:45:03 +08002851
Max Reitz3f072a72019-06-12 16:27:32 +02002852 if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
Fam Zheng4193cdd2015-12-24 12:45:03 +08002853 sync = MIRROR_SYNC_MODE_FULL;
2854 }
2855
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002856 if (!replaces) {
Max Reitz3f072a72019-06-12 16:27:32 +02002857 /* We want to mirror from @bs, but keep implicit filters on top */
2858 unfiltered_bs = bdrv_skip_implicit_filters(bs);
2859 if (unfiltered_bs != bs) {
2860 replaces = unfiltered_bs->node_name;
Max Reitz3f072a72019-06-12 16:27:32 +02002861 }
2862 }
2863
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002864 if (replaces) {
Max Reitz74ce9e42019-02-13 23:53:01 +01002865 BlockDriverState *to_replace_bs;
Max Reitz74ce9e42019-02-13 23:53:01 +01002866 int64_t bs_size, replace_size;
2867
2868 bs_size = bdrv_getlength(bs);
2869 if (bs_size < 0) {
2870 error_setg_errno(errp, -bs_size, "Failed to query device's size");
2871 return;
2872 }
2873
2874 to_replace_bs = check_to_replace_node(bs, replaces, errp);
2875 if (!to_replace_bs) {
2876 return;
2877 }
2878
Max Reitz74ce9e42019-02-13 23:53:01 +01002879 replace_size = bdrv_getlength(to_replace_bs);
Max Reitz74ce9e42019-02-13 23:53:01 +01002880
2881 if (replace_size < 0) {
2882 error_setg_errno(errp, -replace_size,
2883 "Failed to query the replacement node's size");
2884 return;
2885 }
2886 if (bs_size != replace_size) {
2887 error_setg(errp, "cannot replace image with a mirror image of "
2888 "different size");
2889 return;
2890 }
2891 }
2892
Fam Zheng4193cdd2015-12-24 12:45:03 +08002893 /* pass the node name to replace to mirror start since it's loose coupling
2894 * and will allow to check whether the node still exist at mirror completion
2895 */
Alberto Garcia71aa9862016-07-05 17:28:57 +03002896 mirror_start(job_id, bs, target,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002897 replaces, job_flags,
Max Reitzcdf3bc92019-07-24 19:12:30 +02002898 speed, granularity, buf_size, sync, backing_mode, zero_target,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002899 on_source_error, on_target_error, unmap, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02002900 copy_mode, errp);
Fam Zheng4193cdd2015-12-24 12:45:03 +08002901}
2902
Eric Blakefaecd402016-07-14 16:37:58 -06002903void qmp_drive_mirror(DriveMirror *arg, Error **errp)
Fam Zheng4193cdd2015-12-24 12:45:03 +08002904{
2905 BlockDriverState *bs;
Max Reitz3f072a72019-06-12 16:27:32 +02002906 BlockDriverState *target_backing_bs, *target_bs;
Fam Zheng4193cdd2015-12-24 12:45:03 +08002907 AioContext *aio_context;
Max Reitz274fcce2016-06-10 20:57:47 +02002908 BlockMirrorBackingMode backing_mode;
Fam Zheng4193cdd2015-12-24 12:45:03 +08002909 Error *local_err = NULL;
2910 QDict *options = NULL;
2911 int flags;
2912 int64_t size;
Eric Blakefaecd402016-07-14 16:37:58 -06002913 const char *format = arg->format;
Max Reitzcdf3bc92019-07-24 19:12:30 +02002914 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02002915 int ret;
Fam Zheng4193cdd2015-12-24 12:45:03 +08002916
Kevin Wolf0524e932016-06-23 14:20:24 +02002917 bs = qmp_get_root_bs(arg->device, errp);
2918 if (!bs) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002919 return;
2920 }
2921
Paolo Bonzinicb2af912018-02-07 17:29:20 +01002922 /* Early check to avoid creating target */
Kevin Wolf277f2002023-09-29 16:51:52 +02002923 bdrv_graph_rdlock_main_loop();
Paolo Bonzinicb2af912018-02-07 17:29:20 +01002924 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
Kevin Wolf277f2002023-09-29 16:51:52 +02002925 bdrv_graph_rdunlock_main_loop();
Paolo Bonzinicb2af912018-02-07 17:29:20 +01002926 return;
2927 }
2928
Kevin Wolf0524e932016-06-23 14:20:24 +02002929 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01002930
Eric Blakefaecd402016-07-14 16:37:58 -06002931 if (!arg->has_mode) {
2932 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
Fam Zheng4193cdd2015-12-24 12:45:03 +08002933 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002934
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002935 if (!arg->format) {
Eric Blakefaecd402016-07-14 16:37:58 -06002936 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
2937 ? NULL : bs->drv->format_name);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002938 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002939
Kevin Wolf61de4c62016-03-18 17:46:45 +01002940 flags = bs->open_flags | BDRV_O_RDWR;
Max Reitz3f072a72019-06-12 16:27:32 +02002941 target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
2942 if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
Eric Blakefaecd402016-07-14 16:37:58 -06002943 arg->sync = MIRROR_SYNC_MODE_FULL;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002944 }
Eric Blakefaecd402016-07-14 16:37:58 -06002945 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
Max Reitz3f072a72019-06-12 16:27:32 +02002946 target_backing_bs = bs;
Max Reitz117e0c82013-11-25 20:28:55 +01002947 }
Kevin Wolfad747512023-10-27 17:53:17 +02002948 bdrv_graph_rdunlock_main_loop();
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002949
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02002950 size = bdrv_getlength(bs);
2951 if (size < 0) {
2952 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002953 return;
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02002954 }
2955
Markus Armbruster54fde4f2022-11-04 17:06:52 +01002956 if (arg->replaces) {
2957 if (!arg->node_name) {
Benoît Canet09158f02014-06-27 18:25:25 +02002958 error_setg(errp, "a node-name must be provided when replacing a"
2959 " named node of the graph");
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05002960 return;
Benoît Canet09158f02014-06-27 18:25:25 +02002961 }
Benoît Canet09158f02014-06-27 18:25:25 +02002962 }
2963
Eric Blakefaecd402016-07-14 16:37:58 -06002964 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
Max Reitz274fcce2016-06-10 20:57:47 +02002965 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
2966 } else {
2967 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
2968 }
2969
John Snow2a32c6e2017-07-17 20:34:21 -04002970 /* Don't open backing image in create() */
2971 flags |= BDRV_O_NO_BACKING;
2972
Max Reitz3f072a72019-06-12 16:27:32 +02002973 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
Eric Blakefaecd402016-07-14 16:37:58 -06002974 && arg->mode != NEW_IMAGE_MODE_EXISTING)
Max Reitz14526862013-11-06 19:50:44 +01002975 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002976 /* create new image w/o backing file */
Max Reitze6641712015-08-26 19:47:48 +02002977 assert(format);
Eric Blakefaecd402016-07-14 16:37:58 -06002978 bdrv_img_create(arg->target, format,
Fam Zheng92172832017-04-21 20:27:01 +08002979 NULL, NULL, NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002980 } else {
Kevin Wolf430da832023-10-27 17:53:16 +02002981 BlockDriverState *explicit_backing;
Max Reitz3f072a72019-06-12 16:27:32 +02002982
Eric Blakefaecd402016-07-14 16:37:58 -06002983 switch (arg->mode) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002984 case NEW_IMAGE_MODE_EXISTING:
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002985 break;
2986 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
Kevin Wolf430da832023-10-27 17:53:16 +02002987 /*
2988 * Create new image with backing file.
2989 * Implicit filters should not appear in the filename.
2990 */
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02002991 bdrv_graph_rdlock_main_loop();
Kevin Wolf430da832023-10-27 17:53:16 +02002992 explicit_backing = bdrv_skip_implicit_filters(target_backing_bs);
Max Reitz3f072a72019-06-12 16:27:32 +02002993 bdrv_refresh_filename(explicit_backing);
Kevin Wolfb7cfc7d2023-09-29 16:51:45 +02002994 bdrv_graph_rdunlock_main_loop();
2995
Eric Blakefaecd402016-07-14 16:37:58 -06002996 bdrv_img_create(arg->target, format,
Max Reitz3f072a72019-06-12 16:27:32 +02002997 explicit_backing->filename,
2998 explicit_backing->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08002999 NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003000 break;
3001 default:
3002 abort();
3003 }
3004 }
3005
Markus Armbruster84d18f02014-01-30 15:07:28 +01003006 if (local_err) {
Luiz Capitulinocf8f2422012-11-30 10:52:08 -02003007 error_propagate(errp, local_err);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05003008 return;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003009 }
3010
Max Reitze6641712015-08-26 19:47:48 +02003011 options = qdict_new();
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003012 if (arg->node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003013 qdict_put_str(options, "node-name", arg->node_name);
Benoît Canet4c828dc2014-06-16 12:00:55 +02003014 }
Max Reitze6641712015-08-26 19:47:48 +02003015 if (format) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003016 qdict_put_str(options, "driver", format);
Max Reitze6641712015-08-26 19:47:48 +02003017 }
Benoît Canet4c828dc2014-06-16 12:00:55 +02003018
Paolo Bonzinib812f672013-01-21 17:09:43 +01003019 /* Mirroring takes care of copy-on-write using the source's backing
3020 * file.
3021 */
John Snow2a32c6e2017-07-17 20:34:21 -04003022 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
Max Reitz5b363932016-05-17 16:41:31 +02003023 if (!target_bs) {
Kevin Wolfc6e0a6d2023-05-25 14:47:04 +02003024 return;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003025 }
3026
Kevin Wolf06717982023-10-27 17:53:11 +02003027 bdrv_graph_rdlock_main_loop();
Max Reitzcdf3bc92019-07-24 19:12:30 +02003028 zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3029 (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3030 !bdrv_has_zero_init(target_bs)));
Kevin Wolf06717982023-10-27 17:53:11 +02003031 bdrv_graph_rdunlock_main_loop();
Max Reitzcdf3bc92019-07-24 19:12:30 +02003032
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003033
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003034 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003035 if (ret < 0) {
3036 bdrv_unref(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003037 return;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003038 }
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003039
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003040 blockdev_mirror_common(arg->job_id, bs, target_bs,
3041 arg->replaces, arg->sync,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003042 backing_mode, zero_target,
3043 arg->has_speed, arg->speed,
Eric Blakefaecd402016-07-14 16:37:58 -06003044 arg->has_granularity, arg->granularity,
3045 arg->has_buf_size, arg->buf_size,
3046 arg->has_on_source_error, arg->on_source_error,
3047 arg->has_on_target_error, arg->on_target_error,
3048 arg->has_unmap, arg->unmap,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003049 NULL,
Max Reitz481deba2018-06-13 20:18:22 +02003050 arg->has_copy_mode, arg->copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003051 arg->has_auto_finalize, arg->auto_finalize,
3052 arg->has_auto_dismiss, arg->auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003053 errp);
Kevin Wolfe253f4b2016-04-12 16:17:41 +02003054 bdrv_unref(target_bs);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003055}
3056
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003057void qmp_blockdev_mirror(const char *job_id,
Alberto Garcia71aa9862016-07-05 17:28:57 +03003058 const char *device, const char *target,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003059 const char *replaces,
Fam Zhengdf925622015-12-24 12:45:05 +08003060 MirrorSyncMode sync,
3061 bool has_speed, int64_t speed,
3062 bool has_granularity, uint32_t granularity,
3063 bool has_buf_size, int64_t buf_size,
3064 bool has_on_source_error,
3065 BlockdevOnError on_source_error,
3066 bool has_on_target_error,
3067 BlockdevOnError on_target_error,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003068 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003069 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003070 bool has_auto_finalize, bool auto_finalize,
3071 bool has_auto_dismiss, bool auto_dismiss,
Fam Zhengdf925622015-12-24 12:45:05 +08003072 Error **errp)
3073{
3074 BlockDriverState *bs;
Fam Zhengdf925622015-12-24 12:45:05 +08003075 BlockDriverState *target_bs;
3076 AioContext *aio_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003077 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003078 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003079 int ret;
Fam Zhengdf925622015-12-24 12:45:05 +08003080
Kevin Wolf07eec652016-06-23 14:20:24 +02003081 bs = qmp_get_root_bs(device, errp);
Fam Zhengdf925622015-12-24 12:45:05 +08003082 if (!bs) {
Fam Zhengdf925622015-12-24 12:45:05 +08003083 return;
3084 }
3085
3086 target_bs = bdrv_lookup_bs(target, target, errp);
3087 if (!target_bs) {
3088 return;
3089 }
3090
Max Reitzcdf3bc92019-07-24 19:12:30 +02003091 zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3092
Fam Zhengdf925622015-12-24 12:45:05 +08003093 aio_context = bdrv_get_aio_context(bs);
Fam Zhengdf925622015-12-24 12:45:05 +08003094
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003095 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003096 if (ret < 0) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05003097 return;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003098 }
Fam Zhengdf925622015-12-24 12:45:05 +08003099
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003100 blockdev_mirror_common(job_id, bs, target_bs,
3101 replaces, sync, backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003102 zero_target, has_speed, speed,
Fam Zhengdf925622015-12-24 12:45:05 +08003103 has_granularity, granularity,
3104 has_buf_size, buf_size,
3105 has_on_source_error, on_source_error,
3106 has_on_target_error, on_target_error,
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003107 true, true, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003108 has_copy_mode, copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003109 has_auto_finalize, auto_finalize,
3110 has_auto_dismiss, auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003111 errp);
Fam Zhengdf925622015-12-24 12:45:05 +08003112}
3113
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003114/*
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003115 * Get a block job using its ID. Called with job_mutex held.
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003116 */
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003117static BlockJob *find_block_job_locked(const char *id, Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003118{
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003119 BlockJob *job;
3120
3121 assert(id != NULL);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003122
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003123 job = block_job_get_locked(id);
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003124
3125 if (!job) {
3126 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3127 "Block job '%s' not found", id);
3128 return NULL;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003129 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003130
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003131 return job;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003132}
3133
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003134void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003135{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003136 BlockJob *job;
3137
3138 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003139 job = find_block_job_locked(device, errp);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003140
3141 if (!job) {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003142 return;
3143 }
3144
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003145 block_job_set_speed_locked(job, speed, errp);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003146}
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003147
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003148void qmp_block_job_cancel(const char *device,
3149 bool has_force, bool force, Error **errp)
3150{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003151 BlockJob *job;
3152
3153 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003154 job = find_block_job_locked(device, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003155
3156 if (!job) {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003157 return;
3158 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003159
3160 if (!has_force) {
3161 force = false;
3162 }
3163
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003164 if (job_user_paused_locked(&job->job) && !force) {
Cole Robinsonf231b882014-03-21 19:42:26 -04003165 error_setg(errp, "The block job for device '%s' is currently paused",
3166 device);
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003167 return;
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003168 }
3169
3170 trace_qmp_block_job_cancel(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003171 job_user_cancel_locked(&job->job, force, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003172}
3173
3174void qmp_block_job_pause(const char *device, Error **errp)
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003175{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003176 BlockJob *job;
3177
3178 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003179 job = find_block_job_locked(device, errp);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003180
John Snow0ec4dfb2018-03-10 03:27:32 -05003181 if (!job) {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003182 return;
3183 }
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003184
3185 trace_qmp_block_job_pause(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003186 job_user_pause_locked(&job->job, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003187}
3188
3189void qmp_block_job_resume(const char *device, Error **errp)
3190{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003191 BlockJob *job;
3192
3193 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003194 job = find_block_job_locked(device, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003195
John Snow0ec4dfb2018-03-10 03:27:32 -05003196 if (!job) {
Paolo Bonzini8acc72a2012-09-28 17:22:50 +02003197 return;
3198 }
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003199
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003200 trace_qmp_block_job_resume(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003201 job_user_resume_locked(&job->job, errp);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003202}
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003203
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003204void qmp_block_job_complete(const char *device, Error **errp)
3205{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003206 BlockJob *job;
3207
3208 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003209 job = find_block_job_locked(device, errp);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003210
3211 if (!job) {
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003212 return;
3213 }
3214
3215 trace_qmp_block_job_complete(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003216 job_complete_locked(&job->job, errp);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003217}
3218
John Snow11b61fb2018-03-10 03:27:43 -05003219void qmp_block_job_finalize(const char *id, Error **errp)
3220{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003221 BlockJob *job;
3222
3223 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003224 job = find_block_job_locked(id, errp);
John Snow11b61fb2018-03-10 03:27:43 -05003225
3226 if (!job) {
3227 return;
3228 }
3229
3230 trace_qmp_block_job_finalize(job);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003231 job_ref_locked(&job->job);
3232 job_finalize_locked(&job->job, errp);
Stefan Reiterb660a842020-04-07 13:56:49 +02003233
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003234 job_unref_locked(&job->job);
John Snow11b61fb2018-03-10 03:27:43 -05003235}
3236
John Snow75f71052018-03-10 03:27:36 -05003237void qmp_block_job_dismiss(const char *id, Error **errp)
3238{
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003239 BlockJob *bjob;
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003240 Job *job;
John Snow75f71052018-03-10 03:27:36 -05003241
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003242 JOB_LOCK_GUARD();
Emanuele Giuseppe Esposito6f592e52022-09-26 05:32:11 -04003243 bjob = find_block_job_locked(id, errp);
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003244
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003245 if (!bjob) {
John Snow75f71052018-03-10 03:27:36 -05003246 return;
3247 }
3248
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003249 trace_qmp_block_job_dismiss(bjob);
3250 job = &bjob->job;
Emanuele Giuseppe Esposito96241122022-09-26 05:32:01 -04003251 job_dismiss_locked(&job, errp);
John Snow75f71052018-03-10 03:27:36 -05003252}
3253
Fiona Ebner61a3a5a2023-10-31 14:54:22 +01003254void qmp_block_job_change(BlockJobChangeOptions *opts, Error **errp)
3255{
3256 BlockJob *job;
3257
3258 JOB_LOCK_GUARD();
3259 job = find_block_job_locked(opts->id, errp);
3260
3261 if (!job) {
3262 return;
3263 }
3264
3265 block_job_change_locked(job, opts, errp);
3266}
3267
Jeff Codyfa40e652014-07-01 09:52:16 +02003268void qmp_change_backing_file(const char *device,
3269 const char *image_node_name,
3270 const char *backing_file,
3271 Error **errp)
3272{
3273 BlockDriverState *bs = NULL;
3274 BlockDriverState *image_bs = NULL;
3275 Error *local_err = NULL;
3276 bool ro;
Jeff Codyfa40e652014-07-01 09:52:16 +02003277 int ret;
3278
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003279 bs = qmp_get_root_bs(device, errp);
3280 if (!bs) {
Jeff Codyfa40e652014-07-01 09:52:16 +02003281 return;
3282 }
3283
Kevin Wolf79bb7622023-10-27 17:53:19 +02003284 bdrv_graph_rdlock_main_loop();
3285
Jeff Codyfa40e652014-07-01 09:52:16 +02003286 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3287 if (local_err) {
3288 error_propagate(errp, local_err);
Kevin Wolf79bb7622023-10-27 17:53:19 +02003289 goto out_rdlock;
Jeff Codyfa40e652014-07-01 09:52:16 +02003290 }
3291
3292 if (!image_bs) {
3293 error_setg(errp, "image file not found");
Kevin Wolf79bb7622023-10-27 17:53:19 +02003294 goto out_rdlock;
Jeff Codyfa40e652014-07-01 09:52:16 +02003295 }
3296
3297 if (bdrv_find_base(image_bs) == image_bs) {
3298 error_setg(errp, "not allowing backing file change on an image "
3299 "without a backing file");
Kevin Wolf79bb7622023-10-27 17:53:19 +02003300 goto out_rdlock;
Jeff Codyfa40e652014-07-01 09:52:16 +02003301 }
3302
3303 /* even though we are not necessarily operating on bs, we need it to
3304 * determine if block ops are currently prohibited on the chain */
3305 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
Kevin Wolf79bb7622023-10-27 17:53:19 +02003306 goto out_rdlock;
Jeff Codyfa40e652014-07-01 09:52:16 +02003307 }
3308
3309 /* final sanity check */
3310 if (!bdrv_chain_contains(bs, image_bs)) {
3311 error_setg(errp, "'%s' and image file are not in the same chain",
3312 device);
Kevin Wolf79bb7622023-10-27 17:53:19 +02003313 goto out_rdlock;
Jeff Codyfa40e652014-07-01 09:52:16 +02003314 }
Kevin Wolf79bb7622023-10-27 17:53:19 +02003315 bdrv_graph_rdunlock_main_loop();
Jeff Codyfa40e652014-07-01 09:52:16 +02003316
3317 /* if not r/w, reopen to make r/w */
Jeff Codyfa40e652014-07-01 09:52:16 +02003318 ro = bdrv_is_read_only(image_bs);
3319
3320 if (ro) {
Alberto Garcia051a60f2018-11-12 16:00:38 +02003321 if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05003322 return;
Jeff Codyfa40e652014-07-01 09:52:16 +02003323 }
3324 }
3325
3326 ret = bdrv_change_backing_file(image_bs, backing_file,
Eric Blakee54ee1b2020-07-06 15:39:53 -05003327 image_bs->drv ? image_bs->drv->format_name : "",
3328 false);
Jeff Codyfa40e652014-07-01 09:52:16 +02003329
3330 if (ret < 0) {
3331 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3332 backing_file);
3333 /* don't exit here, so we can try to restore open flags if
3334 * appropriate */
3335 }
3336
3337 if (ro) {
Markus Armbruster992861f2020-07-07 18:06:04 +02003338 bdrv_reopen_set_read_only(image_bs, true, errp);
Jeff Codyfa40e652014-07-01 09:52:16 +02003339 }
Kevin Wolf79bb7622023-10-27 17:53:19 +02003340 return;
3341
3342out_rdlock:
3343 bdrv_graph_rdunlock_main_loop();
Jeff Codyfa40e652014-07-01 09:52:16 +02003344}
3345
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003346void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3347{
Max Reitzbe4b67b2015-10-19 17:53:09 +02003348 BlockDriverState *bs;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003349 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01003350 Visitor *v = qobject_output_visitor_new(&obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003351 QDict *qdict;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003352
Markus Armbruster1f584242020-04-24 10:43:35 +02003353 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
Eric Blake3b098d52016-06-09 10:48:43 -06003354 visit_complete(v, &obj);
Max Reitz7dc847e2018-02-24 16:40:29 +01003355 qdict = qobject_to(QDict, obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003356
3357 qdict_flatten(qdict);
3358
Kevin Wolf9ec88732016-09-21 14:56:11 +02003359 if (!qdict_get_try_str(qdict, "node-name")) {
3360 error_setg(errp, "'node-name' must be specified for the root node");
3361 goto fail;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003362 }
3363
Kevin Wolf9ec88732016-09-21 14:56:11 +02003364 bs = bds_tree_init(qdict, errp);
3365 if (!bs) {
3366 goto fail;
3367 }
3368
Maxim Levitsky89802d52020-03-08 11:24:40 +02003369 bdrv_set_monitor_owned(bs);
Kevin Wolf9ec88732016-09-21 14:56:11 +02003370
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003371fail:
Eric Blake3b098d52016-06-09 10:48:43 -06003372 visit_free(v);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003373}
3374
Alberto Garciae60edf62021-07-08 13:47:09 +02003375void qmp_blockdev_reopen(BlockdevOptionsList *reopen_list, Error **errp)
Alberto Garcia1479c732019-03-12 18:48:51 +02003376{
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003377 BlockReopenQueue *queue = NULL;
Alberto Garcia1479c732019-03-12 18:48:51 +02003378
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003379 /* Add each one of the BDS that we want to reopen to the queue */
3380 for (; reopen_list != NULL; reopen_list = reopen_list->next) {
3381 BlockdevOptions *options = reopen_list->value;
3382 BlockDriverState *bs;
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003383 QObject *obj;
3384 Visitor *v;
3385 QDict *qdict;
3386
3387 /* Check for the selected node name */
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003388 if (!options->node_name) {
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003389 error_setg(errp, "node-name not specified");
3390 goto fail;
3391 }
3392
3393 bs = bdrv_find_node(options->node_name);
3394 if (!bs) {
3395 error_setg(errp, "Failed to find node with node-name='%s'",
3396 options->node_name);
3397 goto fail;
3398 }
3399
3400 /* Put all options in a QDict and flatten it */
3401 v = qobject_output_visitor_new(&obj);
3402 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3403 visit_complete(v, &obj);
3404 visit_free(v);
3405
3406 qdict = qobject_to(QDict, obj);
3407
3408 qdict_flatten(qdict);
3409
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003410 queue = bdrv_reopen_queue(queue, bs, qdict, false);
Alberto Garcia1479c732019-03-12 18:48:51 +02003411 }
3412
Alberto Garcia1479c732019-03-12 18:48:51 +02003413 /* Perform the reopen operation */
Alberto Garcia1479c732019-03-12 18:48:51 +02003414 bdrv_reopen_multiple(queue, errp);
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003415 queue = NULL;
Alberto Garcia1479c732019-03-12 18:48:51 +02003416
3417fail:
Alberto Garcia3908b7a2021-07-08 13:47:07 +02003418 bdrv_reopen_queue_free(queue);
Alberto Garcia1479c732019-03-12 18:48:51 +02003419}
3420
Markus Armbruster79b7a772017-03-21 17:53:28 +01003421void qmp_blockdev_del(const char *node_name, Error **errp)
Alberto Garcia81b936a2015-11-02 16:51:55 +02003422{
Alberto Garcia81b936a2015-11-02 16:51:55 +02003423 BlockDriverState *bs;
3424
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05003425 GLOBAL_STATE_CODE();
Kevin Wolf2b3912f2023-09-29 16:51:39 +02003426 GRAPH_RDLOCK_GUARD_MAINLOOP();
Emanuele Giuseppe Espositob4ad82a2022-03-03 10:15:57 -05003427
Kevin Wolf9ec88732016-09-21 14:56:11 +02003428 bs = bdrv_find_node(node_name);
3429 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003430 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003431 return;
3432 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003433 if (bdrv_has_blk(bs)) {
3434 error_setg(errp, "Node %s is in use", node_name);
3435 return;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003436 }
Alberto Garcia81b936a2015-11-02 16:51:55 +02003437
Kevin Wolf9ec88732016-09-21 14:56:11 +02003438 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05003439 return;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003440 }
3441
Paolo Bonzini70537ed2018-12-06 23:00:09 +01003442 if (!QTAILQ_IN_USE(bs, monitor_list)) {
Kevin Wolf9ec88732016-09-21 14:56:11 +02003443 error_setg(errp, "Node %s is not owned by the monitor",
3444 bs->node_name);
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05003445 return;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003446 }
3447
Kevin Wolf9ec88732016-09-21 14:56:11 +02003448 if (bs->refcnt > 1) {
3449 error_setg(errp, "Block device %s is in use",
3450 bdrv_get_device_or_node_name(bs));
Stefan Hajnoczib49f4752023-12-05 13:20:03 -05003451 return;
Kevin Wolf9ec88732016-09-21 14:56:11 +02003452 }
3453
3454 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3455 bdrv_unref(bs);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003456}
3457
Kevin Wolf9def6082023-09-11 11:46:20 +02003458static BdrvChild * GRAPH_RDLOCK
3459bdrv_find_child(BlockDriverState *parent_bs, const char *child_name)
Wen Congyang7f821592016-05-10 15:36:39 +08003460{
3461 BdrvChild *child;
3462
3463 QLIST_FOREACH(child, &parent_bs->children, next) {
3464 if (strcmp(child->name, child_name) == 0) {
3465 return child;
3466 }
3467 }
3468
3469 return NULL;
3470}
3471
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003472void qmp_x_blockdev_change(const char *parent, const char *child,
Wen Congyang7f821592016-05-10 15:36:39 +08003473 const char *node, Error **errp)
3474{
3475 BlockDriverState *parent_bs, *new_bs = NULL;
3476 BdrvChild *p_child;
3477
Stefan Hajnoczi6bc30f12023-12-05 13:20:02 -05003478 bdrv_graph_wrlock();
Kevin Wolf9def6082023-09-11 11:46:20 +02003479
Wen Congyang7f821592016-05-10 15:36:39 +08003480 parent_bs = bdrv_lookup_bs(parent, parent, errp);
3481 if (!parent_bs) {
Kevin Wolf9def6082023-09-11 11:46:20 +02003482 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003483 }
3484
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003485 if (!child == !node) {
3486 if (child) {
Wen Congyang7f821592016-05-10 15:36:39 +08003487 error_setg(errp, "The parameters child and node are in conflict");
3488 } else {
3489 error_setg(errp, "Either child or node must be specified");
3490 }
Kevin Wolf9def6082023-09-11 11:46:20 +02003491 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003492 }
3493
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003494 if (child) {
Wen Congyang7f821592016-05-10 15:36:39 +08003495 p_child = bdrv_find_child(parent_bs, child);
3496 if (!p_child) {
3497 error_setg(errp, "Node '%s' does not have child '%s'",
3498 parent, child);
Kevin Wolf9def6082023-09-11 11:46:20 +02003499 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003500 }
3501 bdrv_del_child(parent_bs, p_child, errp);
3502 }
3503
Markus Armbruster54fde4f2022-11-04 17:06:52 +01003504 if (node) {
Wen Congyang7f821592016-05-10 15:36:39 +08003505 new_bs = bdrv_find_node(node);
3506 if (!new_bs) {
3507 error_setg(errp, "Node '%s' not found", node);
Kevin Wolf9def6082023-09-11 11:46:20 +02003508 goto out;
Wen Congyang7f821592016-05-10 15:36:39 +08003509 }
3510 bdrv_add_child(parent_bs, new_bs, errp);
3511 }
Kevin Wolf9def6082023-09-11 11:46:20 +02003512
3513out:
Stefan Hajnoczi6bc30f12023-12-05 13:20:02 -05003514 bdrv_graph_wrunlock();
Wen Congyang7f821592016-05-10 15:36:39 +08003515}
3516
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003517BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3518{
Eric Blakec3033fd2021-01-13 16:10:12 -06003519 BlockJobInfoList *head = NULL, **tail = &head;
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003520 BlockJob *job;
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003521
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -04003522 JOB_LOCK_GUARD();
3523
3524 for (job = block_job_next_locked(NULL); job;
3525 job = block_job_next_locked(job)) {
Eric Blakec3033fd2021-01-13 16:10:12 -06003526 BlockJobInfo *value;
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003527
John Snow559b9352016-10-27 12:06:55 -04003528 if (block_job_is_internal(job)) {
3529 continue;
3530 }
Emanuele Giuseppe Esposito880eeec2022-09-26 05:32:04 -04003531 value = block_job_query_locked(job, errp);
Eric Blakec3033fd2021-01-13 16:10:12 -06003532 if (!value) {
John Snow559b9352016-10-27 12:06:55 -04003533 qapi_free_BlockJobInfoList(head);
3534 return NULL;
3535 }
Eric Blakec3033fd2021-01-13 16:10:12 -06003536 QAPI_LIST_APPEND(tail, value);
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003537 }
3538
3539 return head;
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003540}
Paolo Bonzini4d454572012-11-26 16:03:42 +01003541
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003542void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003543 bool has_force, bool force, Error **errp)
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003544{
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003545 AioContext *new_context;
3546 BlockDriverState *bs;
3547
Kevin Wolf2b3912f2023-09-29 16:51:39 +02003548 GRAPH_RDLOCK_GUARD_MAINLOOP();
3549
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003550 bs = bdrv_find_node(node_name);
3551 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003552 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003553 return;
3554 }
3555
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003556 /* Protects against accidents. */
3557 if (!(has_force && force) && bdrv_has_blk(bs)) {
3558 error_setg(errp, "Node %s is associated with a BlockBackend and could "
3559 "be in use (use force=true to override this check)",
3560 node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003561 return;
3562 }
3563
3564 if (iothread->type == QTYPE_QSTRING) {
3565 IOThread *obj = iothread_by_id(iothread->u.s);
3566 if (!obj) {
3567 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3568 return;
3569 }
3570
3571 new_context = iothread_get_aio_context(obj);
3572 } else {
3573 new_context = qemu_get_aio_context();
3574 }
3575
Emanuele Giuseppe Esposito142e6902022-10-25 04:49:52 -04003576 bdrv_try_change_aio_context(bs, new_context, NULL, errp);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003577}
3578
Kevin Wolf00063832013-03-15 10:35:07 +01003579QemuOptsList qemu_common_drive_opts = {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003580 .name = "drive",
Kevin Wolf00063832013-03-15 10:35:07 +01003581 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
Paolo Bonzini4d454572012-11-26 16:03:42 +01003582 .desc = {
3583 {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003584 .name = "snapshot",
3585 .type = QEMU_OPT_BOOL,
3586 .help = "enable/disable snapshot mode",
3587 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003588 .name = "aio",
3589 .type = QEMU_OPT_STRING,
Aarushi Mehtaf80f2672020-01-20 14:18:50 +00003590 .help = "host AIO implementation (threads, native, io_uring)",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003591 },{
Kevin Wolfe4b24b42016-03-15 15:39:42 +01003592 .name = BDRV_OPT_CACHE_WB,
3593 .type = QEMU_OPT_BOOL,
3594 .help = "Enable writeback mode",
3595 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003596 .name = "format",
3597 .type = QEMU_OPT_STRING,
3598 .help = "disk format (raw, qcow2, ...)",
3599 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003600 .name = "rerror",
3601 .type = QEMU_OPT_STRING,
3602 .help = "read error action",
3603 },{
3604 .name = "werror",
3605 .type = QEMU_OPT_STRING,
3606 .help = "write error action",
3607 },{
Alberto Garcia4e200cf2016-09-15 17:53:05 +03003608 .name = BDRV_OPT_READ_ONLY,
Paolo Bonzini4d454572012-11-26 16:03:42 +01003609 .type = QEMU_OPT_BOOL,
3610 .help = "open drive file as read-only",
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +01003611 },
3612
3613 THROTTLE_OPTS,
3614
3615 {
Alberto Garcia76f4afb2015-06-08 18:17:44 +02003616 .name = "throttling.group",
3617 .type = QEMU_OPT_STRING,
3618 .help = "name of the block throttling group",
3619 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003620 .name = "copy-on-read",
3621 .type = QEMU_OPT_BOOL,
3622 .help = "copy read data from backing file into image file",
Peter Lieven465bee12014-05-18 00:58:19 +02003623 },{
3624 .name = "detect-zeroes",
3625 .type = QEMU_OPT_STRING,
3626 .help = "try to optimize zero writes (off, on, unmap)",
Alberto Garcia362e9292015-10-28 17:33:04 +02003627 },{
3628 .name = "stats-account-invalid",
3629 .type = QEMU_OPT_BOOL,
3630 .help = "whether to account for invalid I/O operations "
3631 "in the statistics",
3632 },{
3633 .name = "stats-account-failed",
3634 .type = QEMU_OPT_BOOL,
3635 .help = "whether to account for failed I/O operations "
3636 "in the statistics",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003637 },
3638 { /* end of list */ }
3639 },
3640};
Kevin Wolf00063832013-03-15 10:35:07 +01003641
3642QemuOptsList qemu_drive_opts = {
3643 .name = "drive",
3644 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3645 .desc = {
Kevin Wolf492fdc62013-06-19 13:44:17 +02003646 /*
3647 * no elements => accept any params
3648 * validation will happen later
3649 */
Kevin Wolf00063832013-03-15 10:35:07 +01003650 { /* end of list */ }
3651 },
3652};