blob: fe6fb5dc1d19716fba52e8b900e2763aad25f601 [file] [log] [blame]
Markus Armbruster666daa62010-06-02 18:48:27 +02001/*
2 * QEMU host block devices
3 *
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 *
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
Markus Armbruster3618a092013-03-14 13:59:53 +01008 *
9 * This file incorporates work covered by the following copyright and
10 * permission notice:
11 *
12 * Copyright (c) 2003-2008 Fabrice Bellard
13 *
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
30 * THE SOFTWARE.
Markus Armbruster666daa62010-06-02 18:48:27 +020031 */
32
Peter Maydelld38ea872016-01-29 17:50:05 +000033#include "qemu/osdep.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020034#include "sysemu/block-backend.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010035#include "sysemu/blockdev.h"
Paolo Bonzini0d09e412013-02-05 17:06:20 +010036#include "hw/block/block.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010037#include "block/blockjob.h"
Max Reitz609f45e2018-06-14 21:14:28 +020038#include "block/qdict.h"
Alberto Garcia76f4afb2015-06-08 18:17:44 +020039#include "block/throttle-groups.h"
Paolo Bonzini83c90892012-12-17 18:19:49 +010040#include "monitor/monitor.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010041#include "qemu/error-report.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010042#include "qemu/option.h"
Markus Armbrustercdcd4362019-04-17 21:06:38 +020043#include "qemu/qemu-print.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010044#include "qemu/config-file.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010045#include "qapi/qapi-commands-block.h"
46#include "qapi/qapi-commands-transaction.h"
47#include "qapi/qapi-visit-block-core.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010048#include "qapi/qmp/qdict.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010049#include "qapi/qmp/qnum.h"
Markus Armbruster6b673952018-02-01 12:18:35 +010050#include "qapi/qmp/qstring.h"
Markus Armbrustere688df62018-02-01 12:18:31 +010051#include "qapi/error.h"
Markus Armbrustercc7a8ea2015-03-17 17:22:46 +010052#include "qapi/qmp/qerror.h"
Markus Armbruster47e6b292018-02-01 12:18:38 +010053#include "qapi/qmp/qlist.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +010054#include "qapi/qobject-output-visitor.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010055#include "sysemu/sysemu.h"
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +000056#include "sysemu/iothread.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010057#include "block/block_int.h"
Daniel P. Berrange0ab8ed12017-01-25 16:14:15 +000058#include "block/trace.h"
Paolo Bonzini9c17d612012-12-17 18:20:04 +010059#include "sysemu/arch_init.h"
Thomas Huthc616f162017-05-12 12:33:49 +020060#include "sysemu/qtest.h"
Markus Armbruster54d31232019-08-12 07:23:59 +020061#include "sysemu/runstate.h"
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +030062#include "sysemu/replay.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020063#include "qemu/cutils.h"
64#include "qemu/help_option.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020065#include "qemu/main-loop.h"
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +010066#include "qemu/throttle-options.h"
Markus Armbruster666daa62010-06-02 18:48:27 +020067
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{
73 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
74}
75
Markus Armbruster19609662011-01-28 11:21:39 +010076static const char *const if_name[IF_COUNT] = {
77 [IF_NONE] = "none",
78 [IF_IDE] = "ide",
79 [IF_SCSI] = "scsi",
80 [IF_FLOPPY] = "floppy",
81 [IF_PFLASH] = "pflash",
82 [IF_MTD] = "mtd",
83 [IF_SD] = "sd",
84 [IF_VIRTIO] = "virtio",
85 [IF_XEN] = "xen",
86};
87
John Snow21dff8c2014-10-01 14:19:25 -040088static int if_max_devs[IF_COUNT] = {
Markus Armbruster27d6bf42011-01-28 11:21:40 +010089 /*
90 * Do not change these numbers! They govern how drive option
91 * index maps to unit and bus. That mapping is ABI.
92 *
Wei Jiangang547cb152016-04-26 18:12:43 +080093 * All controllers used to implement if=T drives need to support
Markus Armbruster27d6bf42011-01-28 11:21:40 +010094 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
95 * Otherwise, some index values map to "impossible" bus, unit
96 * values.
97 *
98 * For instance, if you change [IF_SCSI] to 255, -drive
99 * if=scsi,index=12 no longer means bus=1,unit=5, but
100 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
101 * the drive can't be set up. Regression.
102 */
103 [IF_IDE] = 2,
104 [IF_SCSI] = 7,
Markus Armbruster19609662011-01-28 11:21:39 +0100105};
106
John Snow21dff8c2014-10-01 14:19:25 -0400107/**
108 * Boards may call this to offer board-by-board overrides
109 * of the default, global values.
110 */
111void override_max_devs(BlockInterfaceType type, int max_devs)
112{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200113 BlockBackend *blk;
John Snow21dff8c2014-10-01 14:19:25 -0400114 DriveInfo *dinfo;
115
116 if (max_devs <= 0) {
117 return;
118 }
119
Markus Armbruster18e46a02014-10-07 13:59:06 +0200120 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
121 dinfo = blk_legacy_dinfo(blk);
John Snow21dff8c2014-10-01 14:19:25 -0400122 if (dinfo->type == type) {
123 fprintf(stderr, "Cannot override units-per-bus property of"
124 " the %s interface, because a drive of that type has"
125 " already been added.\n", if_name[type]);
126 g_assert_not_reached();
127 }
128 }
129
130 if_max_devs[type] = max_devs;
131}
132
Markus Armbruster14bafc52010-06-25 08:09:10 +0200133/*
134 * We automatically delete the drive when a device using it gets
135 * unplugged. Questionable feature, but we can't just drop it.
136 * Device models call blockdev_mark_auto_del() to schedule the
137 * automatic deletion, and generic qdev code calls blockdev_auto_del()
138 * when deletion is actually safe.
139 */
Markus Armbruster4be74632014-10-07 13:59:18 +0200140void blockdev_mark_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200141{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200142 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300143 BlockJob *job;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200144
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200145 if (!dinfo) {
Kevin Wolf2d246f02013-09-18 15:14:47 +0200146 return;
147 }
148
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300149 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
150 if (block_job_has_bdrv(job, blk_bs(blk))) {
151 AioContext *aio_context = job->job.aio_context;
152 aio_context_acquire(aio_context);
Stefan Hajnoczi91fddb02014-10-21 12:03:52 +0100153
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300154 job_cancel(&job->job, false);
155
156 aio_context_release(aio_context);
Max Reitz5433c242015-10-19 17:53:29 +0200157 }
Paolo Bonzini12bde0e2012-03-30 13:17:10 +0200158 }
Stefan Hajnoczi91fddb02014-10-21 12:03:52 +0100159
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200160 dinfo->auto_del = 1;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200161}
162
Markus Armbruster4be74632014-10-07 13:59:18 +0200163void blockdev_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200164{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200165 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Markus Armbruster14bafc52010-06-25 08:09:10 +0200166
Ryan Harper0fc0f1f2010-12-08 10:05:00 -0600167 if (dinfo && dinfo->auto_del) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100168 monitor_remove_blk(blk);
Markus Armbrusterb9fe8a72014-10-07 13:59:09 +0200169 blk_unref(blk);
Markus Armbruster14bafc52010-06-25 08:09:10 +0200170 }
171}
172
John Snowd8f94e12014-10-01 14:19:27 -0400173/**
174 * Returns the current mapping of how many units per bus
175 * a particular interface can support.
176 *
177 * A positive integer indicates n units per bus.
178 * 0 implies the mapping has not been established.
179 * -1 indicates an invalid BlockInterfaceType was given.
180 */
181int drive_get_max_devs(BlockInterfaceType type)
182{
183 if (type >= IF_IDE && type < IF_COUNT) {
184 return if_max_devs[type];
185 }
186
187 return -1;
188}
189
Markus Armbruster505a7fb2011-01-28 11:21:43 +0100190static int drive_index_to_bus_id(BlockInterfaceType type, int index)
191{
192 int max_devs = if_max_devs[type];
193 return max_devs ? index / max_devs : 0;
194}
195
196static int drive_index_to_unit_id(BlockInterfaceType type, int index)
197{
198 int max_devs = if_max_devs[type];
199 return max_devs ? index % max_devs : index;
200}
201
Markus Armbruster2292dda2011-01-28 11:21:41 +0100202QemuOpts *drive_def(const char *optstr)
203{
Markus Armbruster70b94332015-02-13 12:50:26 +0100204 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100205}
206
207QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
Markus Armbruster5645b0f2011-01-31 11:50:09 +0100208 const char *optstr)
Markus Armbruster666daa62010-06-02 18:48:27 +0200209{
Markus Armbruster666daa62010-06-02 18:48:27 +0200210 QemuOpts *opts;
211
Markus Armbruster2292dda2011-01-28 11:21:41 +0100212 opts = drive_def(optstr);
Markus Armbruster666daa62010-06-02 18:48:27 +0200213 if (!opts) {
214 return NULL;
215 }
Markus Armbruster2292dda2011-01-28 11:21:41 +0100216 if (type != IF_DEFAULT) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100217 qemu_opt_set(opts, "if", if_name[type], &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100218 }
219 if (index >= 0) {
Markus Armbrustera8b18f82015-02-13 15:50:43 +0100220 qemu_opt_set_number(opts, "index", index, &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100221 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200222 if (file)
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100223 qemu_opt_set(opts, "file", file, &error_abort);
Markus Armbruster666daa62010-06-02 18:48:27 +0200224 return opts;
225}
226
227DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
228{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200229 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200230 DriveInfo *dinfo;
231
Markus Armbruster18e46a02014-10-07 13:59:06 +0200232 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
233 dinfo = blk_legacy_dinfo(blk);
234 if (dinfo && dinfo->type == type
235 && dinfo->bus == bus && dinfo->unit == unit) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200236 return dinfo;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200237 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200238 }
239
240 return NULL;
241}
242
Markus Armbrustera1b40bd2020-06-22 11:42:19 +0200243void drive_mark_claimed_by_board(void)
244{
245 BlockBackend *blk;
246 DriveInfo *dinfo;
247
248 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
249 dinfo = blk_legacy_dinfo(blk);
250 if (dinfo && blk_get_attached_dev(blk)) {
251 dinfo->claimed_by_board = true;
252 }
253 }
254}
255
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100256void drive_check_orphaned(void)
John Snowa66c9dc2014-10-01 14:19:24 -0400257{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200258 BlockBackend *blk;
John Snowa66c9dc2014-10-01 14:19:24 -0400259 DriveInfo *dinfo;
Markus Armbruster664cc622017-02-15 11:05:45 +0100260 Location loc;
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100261 bool orphans = false;
John Snowa66c9dc2014-10-01 14:19:24 -0400262
Markus Armbruster18e46a02014-10-07 13:59:06 +0200263 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
264 dinfo = blk_legacy_dinfo(blk);
Markus Armbrustera1b40bd2020-06-22 11:42:19 +0200265 if (dinfo->is_default || dinfo->type == IF_NONE) {
266 continue;
267 }
268 if (!blk_get_attached_dev(blk)) {
Markus Armbruster664cc622017-02-15 11:05:45 +0100269 loc_push_none(&loc);
270 qemu_opts_loc_restore(dinfo->opts);
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100271 error_report("machine type does not support"
Markus Armbruster664cc622017-02-15 11:05:45 +0100272 " if=%s,bus=%d,unit=%d",
273 if_name[dinfo->type], dinfo->bus, dinfo->unit);
274 loc_pop(&loc);
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100275 orphans = true;
Markus Armbrustera1b40bd2020-06-22 11:42:19 +0200276 continue;
277 }
278 if (!dinfo->claimed_by_board && dinfo->type != IF_VIRTIO) {
279 loc_push_none(&loc);
280 qemu_opts_loc_restore(dinfo->opts);
281 warn_report("bogus if=%s is deprecated, use if=none",
282 if_name[dinfo->type]);
283 loc_pop(&loc);
John Snowa66c9dc2014-10-01 14:19:24 -0400284 }
285 }
286
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100287 if (orphans) {
288 exit(1);
289 }
John Snowa66c9dc2014-10-01 14:19:24 -0400290}
291
Markus Armbrusterf1bd51a2011-01-28 11:21:44 +0100292DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
293{
294 return drive_get(type,
295 drive_index_to_bus_id(type, index),
296 drive_index_to_unit_id(type, index));
297}
298
Markus Armbruster666daa62010-06-02 18:48:27 +0200299int drive_get_max_bus(BlockInterfaceType type)
300{
301 int max_bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200302 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200303 DriveInfo *dinfo;
304
305 max_bus = -1;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200306 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
307 dinfo = blk_legacy_dinfo(blk);
308 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200309 max_bus = dinfo->bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200310 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200311 }
312 return max_bus;
313}
314
Markus Armbruster13839972011-01-28 11:21:37 +0100315/* Get a block device. This should only be used for single-drive devices
316 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
317 appropriate bus. */
318DriveInfo *drive_get_next(BlockInterfaceType type)
319{
320 static int next_block_unit[IF_COUNT];
321
322 return drive_get(type, 0, next_block_unit[type]++);
323}
324
Markus Armbruster666daa62010-06-02 18:48:27 +0200325static void bdrv_format_print(void *opaque, const char *name)
326{
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200327 qemu_printf(" %s", name);
Markus Armbruster666daa62010-06-02 18:48:27 +0200328}
329
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000330typedef struct {
331 QEMUBH *bh;
Fam Zhengfa510eb2013-08-23 09:14:51 +0800332 BlockDriverState *bs;
333} BDRVPutRefBH;
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000334
Kevin Wolfb6810722013-09-20 11:33:11 +0200335static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200336{
337 if (!strcmp(buf, "ignore")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200338 return BLOCKDEV_ON_ERROR_IGNORE;
Markus Armbruster666daa62010-06-02 18:48:27 +0200339 } else if (!is_read && !strcmp(buf, "enospc")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200340 return BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200341 } else if (!strcmp(buf, "stop")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200342 return BLOCKDEV_ON_ERROR_STOP;
Markus Armbruster666daa62010-06-02 18:48:27 +0200343 } else if (!strcmp(buf, "report")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200344 return BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200345 } else {
Kevin Wolfb6810722013-09-20 11:33:11 +0200346 error_setg(errp, "'%s' invalid %s error action",
347 buf, is_read ? "read" : "write");
Markus Armbruster666daa62010-06-02 18:48:27 +0200348 return -1;
349 }
350}
351
Alberto Garcia40119ef2015-11-16 11:28:38 +0200352static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
353 Error **errp)
354{
355 const QListEntry *entry;
356 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
357 switch (qobject_type(entry->value)) {
358
359 case QTYPE_QSTRING: {
360 unsigned long long length;
Max Reitz7dc847e2018-02-24 16:40:29 +0100361 const char *str = qstring_get_str(qobject_to(QString,
362 entry->value));
Alberto Garcia40119ef2015-11-16 11:28:38 +0200363 if (parse_uint_full(str, &length, 10) == 0 &&
364 length > 0 && length <= UINT_MAX) {
365 block_acct_add_interval(stats, (unsigned) length);
366 } else {
367 error_setg(errp, "Invalid interval length: %s", str);
368 return false;
369 }
370 break;
371 }
372
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400373 case QTYPE_QNUM: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100374 int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400375
Alberto Garcia40119ef2015-11-16 11:28:38 +0200376 if (length > 0 && length <= UINT_MAX) {
377 block_acct_add_interval(stats, (unsigned) length);
378 } else {
379 error_setg(errp, "Invalid interval length: %" PRId64, length);
380 return false;
381 }
382 break;
383 }
384
385 default:
386 error_setg(errp, "The specification of stats-intervals is invalid");
387 return false;
388 }
389 }
390 return true;
391}
392
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200393typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
394
Max Reitzfbf81752015-10-19 17:53:31 +0200395/* All parameters but @opts are optional and may be set to NULL. */
396static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
397 const char **throttling_group, ThrottleConfig *throttle_cfg,
398 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
399{
Max Reitzfbf81752015-10-19 17:53:31 +0200400 Error *local_error = NULL;
401 const char *aio;
402
403 if (bdrv_flags) {
Max Reitzfbf81752015-10-19 17:53:31 +0200404 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
405 *bdrv_flags |= BDRV_O_COPY_ON_READ;
406 }
407
Max Reitzfbf81752015-10-19 17:53:31 +0200408 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
Aarushi Mehtaf80f2672020-01-20 14:18:50 +0000409 if (bdrv_parse_aio(aio, bdrv_flags) < 0) {
410 error_setg(errp, "invalid aio option");
411 return;
Max Reitzfbf81752015-10-19 17:53:31 +0200412 }
413 }
414 }
415
416 /* disk I/O throttling */
417 if (throttling_group) {
418 *throttling_group = qemu_opt_get(opts, "throttling.group");
419 }
420
421 if (throttle_cfg) {
Alberto Garcia1588ab52016-02-18 12:27:00 +0200422 throttle_config_init(throttle_cfg);
Max Reitzfbf81752015-10-19 17:53:31 +0200423 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
424 qemu_opt_get_number(opts, "throttling.bps-total", 0);
425 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
426 qemu_opt_get_number(opts, "throttling.bps-read", 0);
427 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
428 qemu_opt_get_number(opts, "throttling.bps-write", 0);
429 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
430 qemu_opt_get_number(opts, "throttling.iops-total", 0);
431 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
432 qemu_opt_get_number(opts, "throttling.iops-read", 0);
433 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
434 qemu_opt_get_number(opts, "throttling.iops-write", 0);
435
436 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
437 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
438 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
439 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
440 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
441 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
442 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
443 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
444 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
445 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
446 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
447 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
448
Alberto Garcia8a0fc182016-02-18 12:27:02 +0200449 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
450 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
451 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
452 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
453 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
454 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
455 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
456 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
457 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
458 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
459 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
460 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
461
Max Reitzfbf81752015-10-19 17:53:31 +0200462 throttle_cfg->op_size =
463 qemu_opt_get_number(opts, "throttling.iops-size", 0);
464
Alberto Garciad5851082016-02-18 12:26:59 +0200465 if (!throttle_is_valid(throttle_cfg, errp)) {
Max Reitzfbf81752015-10-19 17:53:31 +0200466 return;
467 }
468 }
469
470 if (detect_zeroes) {
471 *detect_zeroes =
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200472 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
Max Reitzfbf81752015-10-19 17:53:31 +0200473 qemu_opt_get(opts, "detect-zeroes"),
Max Reitzfbf81752015-10-19 17:53:31 +0200474 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
475 &local_error);
476 if (local_error) {
477 error_propagate(errp, local_error);
478 return;
479 }
Max Reitzfbf81752015-10-19 17:53:31 +0200480 }
481}
482
Kevin Wolff298d072013-09-10 12:01:20 +0200483/* Takes the ownership of bs_opts */
Markus Armbruster18e46a02014-10-07 13:59:06 +0200484static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
485 Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200486{
487 const char *buf;
Markus Armbruster666daa62010-06-02 18:48:27 +0200488 int bdrv_flags = 0;
489 int on_read_error, on_write_error;
Alberto Garcia362e9292015-10-28 17:33:04 +0200490 bool account_invalid, account_failed;
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300491 bool writethrough, read_only;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200492 BlockBackend *blk;
Markus Armbrustera0f1eab2014-09-12 21:26:21 +0200493 BlockDriverState *bs;
Benoît Canetcc0681c2013-09-02 14:14:39 +0200494 ThrottleConfig cfg;
Markus Armbruster666daa62010-06-02 18:48:27 +0200495 int snapshot = 0;
Stefan Hajnoczic5461942013-02-13 16:53:42 +0100496 Error *error = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100497 QemuOpts *opts;
Alberto Garcia40119ef2015-11-16 11:28:38 +0200498 QDict *interval_dict = NULL;
499 QList *interval_list = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100500 const char *id;
Max Reitzfbf81752015-10-19 17:53:31 +0200501 BlockdevDetectZeroesOptions detect_zeroes =
502 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
503 const char *throttling_group = NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200504
Kevin Wolff298d072013-09-10 12:01:20 +0200505 /* Check common options by copying from bs_opts to opts, all other options
506 * stay in bs_opts for processing by bdrv_open(). */
507 id = qdict_get_try_str(bs_opts, "id");
Markus Armbrusterc6ecec42020-07-07 18:05:35 +0200508 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, errp);
509 if (!opts) {
Markus Armbruster6376f952014-05-28 11:17:01 +0200510 goto err_no_opts;
Kevin Wolf00063832013-03-15 10:35:07 +0100511 }
512
Markus Armbruster668f62e2020-07-07 18:06:02 +0200513 if (!qemu_opts_absorb_qdict(opts, bs_opts, errp)) {
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100514 goto early_err;
Kevin Wolf00063832013-03-15 10:35:07 +0100515 }
516
517 if (id) {
518 qdict_del(bs_opts, "id");
519 }
520
Markus Armbruster666daa62010-06-02 18:48:27 +0200521 /* extract parameters */
Markus Armbruster666daa62010-06-02 18:48:27 +0200522 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
Markus Armbruster666daa62010-06-02 18:48:27 +0200523
Alberto Garcia362e9292015-10-28 17:33:04 +0200524 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
525 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
526
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100527 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
528
Alberto Garciaff356ee2016-07-08 17:03:00 +0300529 id = qemu_opts_id(opts);
530
Alberto Garcia40119ef2015-11-16 11:28:38 +0200531 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
532 qdict_array_split(interval_dict, &interval_list);
533
534 if (qdict_size(interval_dict) != 0) {
535 error_setg(errp, "Invalid option stats-intervals.%s",
536 qdict_first(interval_dict)->key);
537 goto early_err;
538 }
Alberto Garcia2be55062015-10-28 17:33:07 +0200539
Max Reitzfbf81752015-10-19 17:53:31 +0200540 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
541 &detect_zeroes, &error);
542 if (error) {
543 error_propagate(errp, error);
544 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200545 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200546
547 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
Peter Maydellc8057f92012-08-02 13:45:54 +0100548 if (is_help_option(buf)) {
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200549 qemu_printf("Supported formats:");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300550 bdrv_iterate_format(bdrv_format_print, NULL, false);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200551 qemu_printf("\nSupported formats (read-only):");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300552 bdrv_iterate_format(bdrv_format_print, NULL, true);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200553 qemu_printf("\n");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100554 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200555 }
Kevin Wolf74fe54f2013-07-09 11:09:02 +0200556
Max Reitze4342ce2015-02-05 13:58:14 -0500557 if (qdict_haskey(bs_opts, "driver")) {
558 error_setg(errp, "Cannot specify both 'driver' and 'format'");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100559 goto early_err;
Mike Qiu6db5f5d2013-08-08 10:45:16 -0400560 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500561 qdict_put_str(bs_opts, "driver", buf);
Markus Armbruster666daa62010-06-02 18:48:27 +0200562 }
563
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200564 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200565 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200566 on_write_error = parse_block_error_action(buf, 0, &error);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100567 if (error) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200568 error_propagate(errp, error);
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100569 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200570 }
571 }
572
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200573 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200574 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200575 on_read_error = parse_block_error_action(buf, 1, &error);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100576 if (error) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200577 error_propagate(errp, error);
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100578 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200579 }
580 }
581
Max Reitz5ec18f82015-10-19 17:53:30 +0200582 if (snapshot) {
Kevin Wolf91a097e2015-05-08 17:49:53 +0200583 bdrv_flags |= BDRV_O_SNAPSHOT;
Max Reitz5ec18f82015-10-19 17:53:30 +0200584 }
585
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300586 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
587
Kevin Wolf326642b2013-07-11 12:52:34 +0200588 /* init */
Kevin Wolf39c4ae92015-11-13 14:45:42 +0100589 if ((!file || !*file) && !qdict_size(bs_opts)) {
Max Reitz5ec18f82015-10-19 17:53:30 +0200590 BlockBackendRootState *blk_rs;
591
Kevin Wolfd861ab32019-04-25 14:25:10 +0200592 blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
Max Reitz5ec18f82015-10-19 17:53:30 +0200593 blk_rs = blk_get_root_state(blk);
594 blk_rs->open_flags = bdrv_flags;
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300595 blk_rs->read_only = read_only;
Max Reitz5ec18f82015-10-19 17:53:30 +0200596 blk_rs->detect_zeroes = detect_zeroes;
597
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200598 qobject_unref(bs_opts);
Max Reitze4342ce2015-02-05 13:58:14 -0500599 } else {
600 if (file && !*file) {
601 file = NULL;
602 }
603
Kevin Wolf91a097e2015-05-08 17:49:53 +0200604 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
605 * with other callers) rather than what we want as the real defaults.
606 * Apply the defaults here instead. */
Kevin Wolf91a097e2015-05-08 17:49:53 +0200607 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
608 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300609 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
610 read_only ? "on" : "off");
Kevin Wolf9384a442018-10-17 18:24:30 +0200611 qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
Kevin Wolf72e775c2016-03-15 14:34:37 +0100612 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
Kevin Wolf91a097e2015-05-08 17:49:53 +0200613
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100614 if (runstate_check(RUN_STATE_INMIGRATE)) {
615 bdrv_flags |= BDRV_O_INACTIVE;
616 }
617
Max Reitzefaa7c42016-03-16 19:54:38 +0100618 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
Max Reitze4342ce2015-02-05 13:58:14 -0500619 if (!blk) {
620 goto err_no_bs_opts;
621 }
622 bs = blk_bs(blk);
Max Reitze4342ce2015-02-05 13:58:14 -0500623
Max Reitz5ec18f82015-10-19 17:53:30 +0200624 bs->detect_zeroes = detect_zeroes;
625
Paolo Bonzini9caa6f32017-06-05 14:39:07 +0200626 block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
Alberto Garcia2be55062015-10-28 17:33:07 +0200627
Alberto Garcia40119ef2015-11-16 11:28:38 +0200628 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
629 blk_unref(blk);
630 blk = NULL;
631 goto err_no_bs_opts;
Alberto Garcia2be55062015-10-28 17:33:07 +0200632 }
Max Reitz5ec18f82015-10-19 17:53:30 +0200633 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200634
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100635 /* disk I/O throttling */
636 if (throttle_enabled(&cfg)) {
637 if (!throttling_group) {
Alberto Garciaff356ee2016-07-08 17:03:00 +0300638 throttling_group = id;
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100639 }
640 blk_io_limits_enable(blk, throttling_group);
641 blk_set_io_limits(blk, &cfg);
642 }
643
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100644 blk_set_enable_write_cache(blk, !writethrough);
Max Reitz373340b2015-10-19 17:53:22 +0200645 blk_set_on_error(blk, on_read_error, on_write_error);
Markus Armbrusterabd7f682010-06-02 18:55:17 +0200646
Alberto Garciaff356ee2016-07-08 17:03:00 +0300647 if (!monitor_add_blk(blk, id, errp)) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100648 blk_unref(blk);
649 blk = NULL;
650 goto err_no_bs_opts;
651 }
652
Max Reitze4342ce2015-02-05 13:58:14 -0500653err_no_bs_opts:
Kevin Wolf00063832013-03-15 10:35:07 +0100654 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200655 qobject_unref(interval_dict);
656 qobject_unref(interval_list);
Markus Armbruster18e46a02014-10-07 13:59:06 +0200657 return blk;
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100658
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100659early_err:
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100660 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200661 qobject_unref(interval_dict);
662 qobject_unref(interval_list);
Markus Armbruster6376f952014-05-28 11:17:01 +0200663err_no_opts:
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200664 qobject_unref(bs_opts);
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100665 return NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200666}
667
Max Reitzbd745e22015-10-19 17:53:32 +0200668/* Takes the ownership of bs_opts */
Maxim Levitsky89802d52020-03-08 11:24:40 +0200669BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
Max Reitzbd745e22015-10-19 17:53:32 +0200670{
Max Reitzbd745e22015-10-19 17:53:32 +0200671 int bdrv_flags = 0;
672
Kevin Wolfa81d6162016-03-07 14:23:04 +0100673 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
674 * with other callers) rather than what we want as the real defaults.
675 * Apply the defaults here instead. */
Kevin Wolfa81d6162016-03-07 14:23:04 +0100676 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
677 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300678 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
Kevin Wolfa81d6162016-03-07 14:23:04 +0100679
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100680 if (runstate_check(RUN_STATE_INMIGRATE)) {
681 bdrv_flags |= BDRV_O_INACTIVE;
682 }
683
Kevin Wolf74e1ae72016-09-20 20:48:52 +0200684 return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
Max Reitzbd745e22015-10-19 17:53:32 +0200685}
686
Max Reitz9c4218e2016-01-29 16:36:12 +0100687void blockdev_close_all_bdrv_states(void)
688{
689 BlockDriverState *bs, *next_bs;
690
691 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
692 AioContext *ctx = bdrv_get_aio_context(bs);
693
694 aio_context_acquire(ctx);
695 bdrv_unref(bs);
696 aio_context_release(ctx);
697 }
698}
699
Max Reitz262b4e82016-03-16 19:54:41 +0100700/* Iterates over the list of monitor-owned BlockDriverStates */
701BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
702{
703 return bs ? QTAILQ_NEXT(bs, monitor_list)
704 : QTAILQ_FIRST(&monitor_bdrv_states);
705}
706
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200707static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200708 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200709{
710 const char *value;
711
712 value = qemu_opt_get(opts, from);
713 if (value) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200714 if (qemu_opt_find(opts, to)) {
715 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
716 "same time", to, from);
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200717 return false;
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200718 }
Jun Li20d6cd42014-09-24 13:45:27 +0800719 }
720
721 /* rename all items in opts */
722 while ((value = qemu_opt_get(opts, from))) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100723 qemu_opt_set(opts, to, value, &error_abort);
Kevin Wolf57975222013-07-17 14:41:54 +0200724 qemu_opt_unset(opts, from);
725 }
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200726 return true;
Kevin Wolf57975222013-07-17 14:41:54 +0200727}
728
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200729QemuOptsList qemu_legacy_drive_opts = {
730 .name = "drive",
731 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
732 .desc = {
733 {
Kevin Wolf87a899c2013-09-10 15:48:13 +0200734 .name = "bus",
735 .type = QEMU_OPT_NUMBER,
736 .help = "bus number",
737 },{
738 .name = "unit",
739 .type = QEMU_OPT_NUMBER,
740 .help = "unit number (i.e. lun for scsi)",
741 },{
742 .name = "index",
743 .type = QEMU_OPT_NUMBER,
744 .help = "index number",
745 },{
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200746 .name = "media",
747 .type = QEMU_OPT_STRING,
748 .help = "media type (disk, cdrom)",
Kevin Wolf593d4642013-08-28 17:24:51 +0200749 },{
750 .name = "if",
751 .type = QEMU_OPT_STRING,
752 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
Kevin Wolfb41a7332013-09-09 16:49:49 +0200753 },{
Max Reitzd095b462013-12-20 19:28:14 +0100754 .name = "file",
755 .type = QEMU_OPT_STRING,
756 .help = "file name",
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200757 },
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200758
759 /* Options that are passed on, but have special semantics with -drive */
760 {
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300761 .name = BDRV_OPT_READ_ONLY,
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200762 .type = QEMU_OPT_BOOL,
763 .help = "open drive file as read-only",
764 },{
Kevin Wolfee13ed12014-02-09 09:52:32 +0100765 .name = "rerror",
766 .type = QEMU_OPT_STRING,
767 .help = "read error action",
768 },{
769 .name = "werror",
770 .type = QEMU_OPT_STRING,
771 .help = "write error action",
772 },{
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200773 .name = "copy-on-read",
774 .type = QEMU_OPT_BOOL,
775 .help = "copy read data from backing file into image file",
776 },
777
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200778 { /* end of list */ }
779 },
780};
781
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200782DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
783 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200784{
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200785 const char *value;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200786 BlockBackend *blk;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200787 DriveInfo *dinfo = NULL;
Kevin Wolff298d072013-09-10 12:01:20 +0200788 QDict *bs_opts;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200789 QemuOpts *legacy_opts;
790 DriveMediaType media = MEDIA_DISK;
Kevin Wolf593d4642013-08-28 17:24:51 +0200791 BlockInterfaceType type;
Kevin Wolf87a899c2013-09-10 15:48:13 +0200792 int max_devs, bus_id, unit_id, index;
Kevin Wolfee13ed12014-02-09 09:52:32 +0100793 const char *werror, *rerror;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800794 bool read_only = false;
795 bool copy_on_read;
Max Reitzd095b462013-12-20 19:28:14 +0100796 const char *filename;
Kevin Wolf247147f2014-09-24 16:37:14 +0200797 int i;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200798
Kevin Wolf57975222013-07-17 14:41:54 +0200799 /* Change legacy command line options into QMP ones */
Kevin Wolf247147f2014-09-24 16:37:14 +0200800 static const struct {
801 const char *from;
802 const char *to;
803 } opt_renames[] = {
804 { "iops", "throttling.iops-total" },
805 { "iops_rd", "throttling.iops-read" },
806 { "iops_wr", "throttling.iops-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200807
Kevin Wolf247147f2014-09-24 16:37:14 +0200808 { "bps", "throttling.bps-total" },
809 { "bps_rd", "throttling.bps-read" },
810 { "bps_wr", "throttling.bps-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200811
Kevin Wolf247147f2014-09-24 16:37:14 +0200812 { "iops_max", "throttling.iops-total-max" },
813 { "iops_rd_max", "throttling.iops-read-max" },
814 { "iops_wr_max", "throttling.iops-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200815
Kevin Wolf247147f2014-09-24 16:37:14 +0200816 { "bps_max", "throttling.bps-total-max" },
817 { "bps_rd_max", "throttling.bps-read-max" },
818 { "bps_wr_max", "throttling.bps-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200819
Kevin Wolf247147f2014-09-24 16:37:14 +0200820 { "iops_size", "throttling.iops-size" },
Benoît Canet2024c1d2013-09-02 14:14:41 +0200821
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200822 { "group", "throttling.group" },
823
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300824 { "readonly", BDRV_OPT_READ_ONLY },
Kevin Wolf247147f2014-09-24 16:37:14 +0200825 };
826
827 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200828 if (!qemu_opt_rename(all_opts, opt_renames[i].from,
Markus Armbruster668f62e2020-07-07 18:06:02 +0200829 opt_renames[i].to, errp)) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200830 return NULL;
831 }
Kevin Wolf247147f2014-09-24 16:37:14 +0200832 }
Kevin Wolf0f227a92013-07-19 20:07:29 +0200833
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200834 value = qemu_opt_get(all_opts, "cache");
835 if (value) {
836 int flags = 0;
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100837 bool writethrough;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200838
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100839 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200840 error_setg(errp, "invalid cache option");
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200841 return NULL;
842 }
843
844 /* Specific options take precedence */
Kevin Wolf54861b92015-04-07 16:55:00 +0200845 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
846 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100847 !writethrough, &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200848 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200849 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
850 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100851 !!(flags & BDRV_O_NOCACHE), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200852 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200853 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
854 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100855 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200856 }
857 qemu_opt_unset(all_opts, "cache");
858 }
859
Kevin Wolff298d072013-09-10 12:01:20 +0200860 /* Get a QDict for processing the options */
861 bs_opts = qdict_new();
862 qemu_opts_to_qdict(all_opts, bs_opts);
863
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800864 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
865 &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200866 if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200867 goto fail;
868 }
869
870 /* Media type */
871 value = qemu_opt_get(legacy_opts, "media");
872 if (value) {
873 if (!strcmp(value, "disk")) {
874 media = MEDIA_DISK;
875 } else if (!strcmp(value, "cdrom")) {
876 media = MEDIA_CDROM;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800877 read_only = true;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200878 } else {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200879 error_setg(errp, "'%s' invalid media", value);
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200880 goto fail;
881 }
882 }
883
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200884 /* copy-on-read is disabled with a warning for read-only devices */
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300885 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200886 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
887
888 if (read_only && copy_on_read) {
Alistair Francis3dc6f862017-07-12 06:57:41 -0700889 warn_report("disabling copy-on-read on read-only drive");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200890 copy_on_read = false;
891 }
892
Eric Blake46f5ac22017-04-27 16:58:17 -0500893 qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
894 qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200895
Kevin Wolf593d4642013-08-28 17:24:51 +0200896 /* Controller type */
897 value = qemu_opt_get(legacy_opts, "if");
898 if (value) {
899 for (type = 0;
900 type < IF_COUNT && strcmp(value, if_name[type]);
901 type++) {
902 }
903 if (type == IF_COUNT) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200904 error_setg(errp, "unsupported bus type '%s'", value);
Kevin Wolf593d4642013-08-28 17:24:51 +0200905 goto fail;
906 }
907 } else {
908 type = block_default_type;
909 }
910
Kevin Wolf87a899c2013-09-10 15:48:13 +0200911 /* Device address specified by bus/unit or index.
912 * If none was specified, try to find the first free one. */
913 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
914 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
915 index = qemu_opt_get_number(legacy_opts, "index", -1);
916
917 max_devs = if_max_devs[type];
918
919 if (index != -1) {
920 if (bus_id != 0 || unit_id != -1) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200921 error_setg(errp, "index cannot be used with bus and unit");
Kevin Wolf87a899c2013-09-10 15:48:13 +0200922 goto fail;
923 }
924 bus_id = drive_index_to_bus_id(type, index);
925 unit_id = drive_index_to_unit_id(type, index);
926 }
927
928 if (unit_id == -1) {
929 unit_id = 0;
930 while (drive_get(type, bus_id, unit_id) != NULL) {
931 unit_id++;
932 if (max_devs && unit_id >= max_devs) {
933 unit_id -= max_devs;
934 bus_id++;
935 }
936 }
937 }
938
939 if (max_devs && unit_id >= max_devs) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200940 error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200941 goto fail;
942 }
943
944 if (drive_get(type, bus_id, unit_id) != NULL) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200945 error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
946 bus_id, unit_id, index);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200947 goto fail;
948 }
949
950 /* no id supplied -> create one */
951 if (qemu_opts_id(all_opts) == NULL) {
952 char *new_id;
953 const char *mediastr = "";
954 if (type == IF_IDE || type == IF_SCSI) {
955 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
956 }
957 if (max_devs) {
958 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
959 mediastr, unit_id);
960 } else {
961 new_id = g_strdup_printf("%s%s%i", if_name[type],
962 mediastr, unit_id);
963 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500964 qdict_put_str(bs_opts, "id", new_id);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200965 g_free(new_id);
966 }
967
Kevin Wolf394c7d42013-09-13 14:09:17 +0200968 /* Add virtio block device */
Kevin Wolf394c7d42013-09-13 14:09:17 +0200969 if (type == IF_VIRTIO) {
970 QemuOpts *devopts;
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800971 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
972 &error_abort);
Kevin Wolf394c7d42013-09-13 14:09:17 +0200973 if (arch_type == QEMU_ARCH_S390X) {
Alexander Graf1f68f1d2015-06-16 23:06:33 +0200974 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
Kevin Wolf394c7d42013-09-13 14:09:17 +0200975 } else {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100976 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
Kevin Wolf394c7d42013-09-13 14:09:17 +0200977 }
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100978 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
979 &error_abort);
Kevin Wolf394c7d42013-09-13 14:09:17 +0200980 }
981
Max Reitzd095b462013-12-20 19:28:14 +0100982 filename = qemu_opt_get(legacy_opts, "file");
983
Kevin Wolfee13ed12014-02-09 09:52:32 +0100984 /* Check werror/rerror compatibility with if=... */
985 werror = qemu_opt_get(legacy_opts, "werror");
986 if (werror != NULL) {
987 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
988 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200989 error_setg(errp, "werror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +0100990 goto fail;
991 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500992 qdict_put_str(bs_opts, "werror", werror);
Kevin Wolfee13ed12014-02-09 09:52:32 +0100993 }
994
995 rerror = qemu_opt_get(legacy_opts, "rerror");
996 if (rerror != NULL) {
997 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
998 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200999 error_setg(errp, "rerror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +01001000 goto fail;
1001 }
Eric Blake46f5ac22017-04-27 16:58:17 -05001002 qdict_put_str(bs_opts, "rerror", rerror);
Kevin Wolfee13ed12014-02-09 09:52:32 +01001003 }
1004
Kevin Wolf2d246f02013-09-18 15:14:47 +02001005 /* Actual block device init: Functionality shared with blockdev-add */
Markus Armbruster992861f2020-07-07 18:06:04 +02001006 blk = blockdev_init(filename, bs_opts, errp);
Markus Armbruster3cb0e252014-05-28 11:17:02 +02001007 bs_opts = NULL;
Markus Armbruster18e46a02014-10-07 13:59:06 +02001008 if (!blk) {
Kevin Wolf2d246f02013-09-18 15:14:47 +02001009 goto fail;
1010 }
1011
Markus Armbruster26f8b3a2014-10-07 13:59:22 +02001012 /* Create legacy DriveInfo */
1013 dinfo = g_malloc0(sizeof(*dinfo));
Kevin Wolff298d072013-09-10 12:01:20 +02001014 dinfo->opts = all_opts;
Kevin Wolf2d246f02013-09-18 15:14:47 +02001015
Kevin Wolfee13ed12014-02-09 09:52:32 +01001016 dinfo->type = type;
Kevin Wolf87a899c2013-09-10 15:48:13 +02001017 dinfo->bus = bus_id;
1018 dinfo->unit = unit_id;
Kevin Wolfbcf83152014-06-06 15:21:48 +02001019
Markus Armbruster26f8b3a2014-10-07 13:59:22 +02001020 blk_set_legacy_dinfo(blk, dinfo);
1021
Kevin Wolfe34ef042013-09-19 14:24:10 +02001022 switch(type) {
1023 case IF_IDE:
1024 case IF_SCSI:
1025 case IF_XEN:
1026 case IF_NONE:
1027 dinfo->media_cd = media == MEDIA_CDROM;
1028 break;
1029 default:
1030 break;
1031 }
1032
Kevin Wolf2d246f02013-09-18 15:14:47 +02001033fail:
Kevin Wolf33cb7dc2013-08-28 17:00:13 +02001034 qemu_opts_del(legacy_opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001035 qobject_unref(bs_opts);
Kevin Wolf2d246f02013-09-18 15:14:47 +02001036 return dinfo;
Kevin Wolf57975222013-07-17 14:41:54 +02001037}
1038
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001039static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1040{
1041 BlockDriverState *bs;
1042
1043 bs = bdrv_lookup_bs(name, name, errp);
1044 if (bs == NULL) {
1045 return NULL;
1046 }
1047
1048 if (!bdrv_is_root_node(bs)) {
1049 error_setg(errp, "Need a root block node");
1050 return NULL;
1051 }
1052
1053 if (!bdrv_is_inserted(bs)) {
1054 error_setg(errp, "Device has no medium");
1055 return NULL;
1056 }
1057
1058 return bs;
1059}
1060
Eric Blake10f75902016-03-03 09:16:50 -07001061static void blockdev_do_action(TransactionAction *action, Error **errp)
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001062{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001063 TransactionActionList list;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001064
Eric Blake10f75902016-03-03 09:16:50 -07001065 list.value = action;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001066 list.next = NULL;
John Snow94d16a62015-11-05 18:13:18 -05001067 qmp_transaction(&list, false, NULL, errp);
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001068}
1069
Benoît Canet0901f672014-01-23 21:31:38 +01001070void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1071 bool has_node_name, const char *node_name,
1072 const char *snapshot_file,
1073 bool has_snapshot_node_name,
1074 const char *snapshot_node_name,
Luiz Capitulino6106e242011-11-25 16:15:19 -02001075 bool has_format, 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 = {
Benoît Canet0901f672014-01-23 21:31:38 +01001079 .has_device = has_device,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001080 .device = (char *) device,
Benoît Canet0901f672014-01-23 21:31:38 +01001081 .has_node_name = has_node_name,
1082 .node_name = (char *) node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001083 .snapshot_file = (char *) snapshot_file,
Benoît Canet0901f672014-01-23 21:31:38 +01001084 .has_snapshot_node_name = has_snapshot_node_name,
1085 .snapshot_node_name = (char *) snapshot_node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001086 .has_format = has_format,
1087 .format = (char *) format,
1088 .has_mode = has_mode,
1089 .mode = mode,
1090 };
Eric Blake10f75902016-03-03 09:16:50 -07001091 TransactionAction action = {
1092 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001093 .u.blockdev_snapshot_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001094 };
1095 blockdev_do_action(&action, errp);
Jes Sorensenf8882562010-12-16 13:52:16 +01001096}
1097
Alberto Garcia43de7e22015-10-26 14:27:16 +02001098void qmp_blockdev_snapshot(const char *node, const char *overlay,
1099 Error **errp)
1100{
1101 BlockdevSnapshot snapshot_data = {
1102 .node = (char *) node,
1103 .overlay = (char *) overlay
1104 };
Eric Blake10f75902016-03-03 09:16:50 -07001105 TransactionAction action = {
1106 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
Eric Blake32bafa82016-03-17 16:48:37 -06001107 .u.blockdev_snapshot.data = &snapshot_data,
Eric Blake10f75902016-03-03 09:16:50 -07001108 };
1109 blockdev_do_action(&action, errp);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001110}
1111
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001112void qmp_blockdev_snapshot_internal_sync(const char *device,
1113 const char *name,
1114 Error **errp)
1115{
1116 BlockdevSnapshotInternal snapshot = {
1117 .device = (char *) device,
1118 .name = (char *) name
1119 };
Eric Blake10f75902016-03-03 09:16:50 -07001120 TransactionAction action = {
1121 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001122 .u.blockdev_snapshot_internal_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001123 };
1124 blockdev_do_action(&action, errp);
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001125}
1126
Wenchao Xia44e3e052013-09-11 14:04:36 +08001127SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1128 bool has_id,
1129 const char *id,
1130 bool has_name,
1131 const char *name,
1132 Error **errp)
1133{
Fam Zhenga0e85442015-03-02 19:36:48 +08001134 BlockDriverState *bs;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001135 AioContext *aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001136 QEMUSnapshotInfo sn;
1137 Error *local_err = NULL;
1138 SnapshotInfo *info = NULL;
1139 int ret;
1140
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001141 bs = qmp_get_root_bs(device, errp);
1142 if (!bs) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001143 return NULL;
1144 }
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001145 aio_context = bdrv_get_aio_context(bs);
Max Reitz5433c242015-10-19 17:53:29 +02001146 aio_context_acquire(aio_context);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001147
1148 if (!has_id) {
1149 id = NULL;
1150 }
1151
1152 if (!has_name) {
1153 name = NULL;
1154 }
1155
1156 if (!id && !name) {
1157 error_setg(errp, "Name or id must be provided");
Max Reitz5433c242015-10-19 17:53:29 +02001158 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001159 }
1160
Stefan Hajnoczi0b928852014-11-19 14:19:43 +00001161 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1162 goto out_aio_context;
1163 }
1164
Wenchao Xia44e3e052013-09-11 14:04:36 +08001165 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001166 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001167 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001168 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001169 }
1170 if (!ret) {
1171 error_setg(errp,
1172 "Snapshot with id '%s' and name '%s' does not exist on "
1173 "device '%s'",
1174 STR_OR_NULL(id), STR_OR_NULL(name), device);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001175 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001176 }
1177
1178 bdrv_snapshot_delete(bs, id, name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001179 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001180 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001181 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001182 }
1183
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001184 aio_context_release(aio_context);
1185
Markus Armbruster5839e532014-08-19 10:31:08 +02001186 info = g_new0(SnapshotInfo, 1);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001187 info->id = g_strdup(sn.id_str);
1188 info->name = g_strdup(sn.name);
1189 info->date_nsec = sn.date_nsec;
1190 info->date_sec = sn.date_sec;
1191 info->vm_state_size = sn.vm_state_size;
1192 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1193 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001194 if (sn.icount != -1ULL) {
1195 info->icount = sn.icount;
1196 info->has_icount = true;
1197 }
Wenchao Xia44e3e052013-09-11 14:04:36 +08001198
1199 return info;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001200
1201out_aio_context:
1202 aio_context_release(aio_context);
1203 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001204}
Jeff Cody8802d1f2012-02-28 15:54:06 -05001205
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00001206/* New and old BlockDriverState structs for atomic group operations */
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001207
John Snow50f43f02015-11-05 18:13:09 -05001208typedef struct BlkActionState BlkActionState;
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001209
John Snow50f43f02015-11-05 18:13:09 -05001210/**
1211 * BlkActionOps:
1212 * Table of operations that define an Action.
1213 *
1214 * @instance_size: Size of state struct, in bytes.
1215 * @prepare: Prepare the work, must NOT be NULL.
1216 * @commit: Commit the changes, can be NULL.
1217 * @abort: Abort the changes on fail, can be NULL.
1218 * @clean: Clean up resources after all transaction actions have called
1219 * commit() or abort(). Can be NULL.
1220 *
1221 * Only prepare() may fail. In a single transaction, only one of commit() or
1222 * abort() will be called. clean() will always be called if it is present.
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001223 */
John Snow50f43f02015-11-05 18:13:09 -05001224typedef struct BlkActionOps {
1225 size_t instance_size;
1226 void (*prepare)(BlkActionState *common, Error **errp);
1227 void (*commit)(BlkActionState *common);
1228 void (*abort)(BlkActionState *common);
1229 void (*clean)(BlkActionState *common);
1230} BlkActionOps;
1231
1232/**
1233 * BlkActionState:
1234 * Describes one Action's state within a Transaction.
1235 *
1236 * @action: QAPI-defined enum identifying which Action to perform.
1237 * @ops: Table of ActionOps this Action can perform.
John Snow94d16a62015-11-05 18:13:18 -05001238 * @block_job_txn: Transaction which this action belongs to.
John Snow50f43f02015-11-05 18:13:09 -05001239 * @entry: List membership for all Actions in this Transaction.
1240 *
1241 * This structure must be arranged as first member in a subclassed type,
1242 * assuming that the compiler will also arrange it to the same offsets as the
1243 * base class.
1244 */
1245struct BlkActionState {
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001246 TransactionAction *action;
John Snow50f43f02015-11-05 18:13:09 -05001247 const BlkActionOps *ops;
Kevin Wolf62c9e412018-04-19 16:09:52 +02001248 JobTxn *block_job_txn;
John Snow94d16a62015-11-05 18:13:18 -05001249 TransactionProperties *txn_props;
John Snowf4de0f82019-01-11 11:59:16 -06001250 QTAILQ_ENTRY(BlkActionState) entry;
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001251};
1252
Wenchao Xiabbe86012013-09-11 14:04:34 +08001253/* internal snapshot private data */
1254typedef struct InternalSnapshotState {
John Snow50f43f02015-11-05 18:13:09 -05001255 BlkActionState common;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001256 BlockDriverState *bs;
1257 QEMUSnapshotInfo sn;
Fam Zheng507306c2015-10-23 11:08:13 +08001258 bool created;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001259} InternalSnapshotState;
1260
John Snow94d16a62015-11-05 18:13:18 -05001261
1262static int action_check_completion_mode(BlkActionState *s, Error **errp)
1263{
1264 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1265 error_setg(errp,
1266 "Action '%s' does not support Transaction property "
1267 "completion-mode = %s",
Markus Armbruster977c7362017-08-24 10:46:08 +02001268 TransactionActionKind_str(s->action->type),
1269 ActionCompletionMode_str(s->txn_props->completion_mode));
John Snow94d16a62015-11-05 18:13:18 -05001270 return -1;
1271 }
1272 return 0;
1273}
1274
John Snow50f43f02015-11-05 18:13:09 -05001275static void internal_snapshot_prepare(BlkActionState *common,
Wenchao Xiabbe86012013-09-11 14:04:34 +08001276 Error **errp)
1277{
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001278 Error *local_err = NULL;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001279 const char *device;
1280 const char *name;
1281 BlockDriverState *bs;
1282 QEMUSnapshotInfo old_sn, *sn;
1283 bool ret;
1284 qemu_timeval tv;
1285 BlockdevSnapshotInternal *internal;
1286 InternalSnapshotState *state;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001287 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001288 int ret1;
1289
Eric Blake6a8f9662015-10-26 16:34:54 -06001290 g_assert(common->action->type ==
Wenchao Xiabbe86012013-09-11 14:04:34 +08001291 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
Eric Blake32bafa82016-03-17 16:48:37 -06001292 internal = common->action->u.blockdev_snapshot_internal_sync.data;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001293 state = DO_UPCAST(InternalSnapshotState, common, common);
1294
1295 /* 1. parse input */
1296 device = internal->device;
1297 name = internal->name;
1298
1299 /* 2. check for validation */
John Snow94d16a62015-11-05 18:13:18 -05001300 if (action_check_completion_mode(common, errp) < 0) {
1301 return;
1302 }
1303
Kevin Wolf75dfd402016-06-23 14:20:24 +02001304 bs = qmp_get_root_bs(device, errp);
1305 if (!bs) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001306 return;
1307 }
1308
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001309 aio_context = bdrv_get_aio_context(bs);
1310 aio_context_acquire(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001311
Fam Zheng507306c2015-10-23 11:08:13 +08001312 state->bs = bs;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001313
1314 /* Paired with .clean() */
Fam Zheng507306c2015-10-23 11:08:13 +08001315 bdrv_drained_begin(bs);
1316
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001317 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001318 goto out;
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001319 }
1320
Wenchao Xiabbe86012013-09-11 14:04:34 +08001321 if (bdrv_is_read_only(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001322 error_setg(errp, "Device '%s' is read only", device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001323 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001324 }
1325
1326 if (!bdrv_can_snapshot(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001327 error_setg(errp, "Block format '%s' used by device '%s' "
1328 "does not support internal snapshots",
1329 bs->drv->format_name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001330 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001331 }
1332
1333 if (!strlen(name)) {
1334 error_setg(errp, "Name is empty");
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001335 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001336 }
1337
1338 /* check whether a snapshot with name exist */
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001339 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1340 &local_err);
1341 if (local_err) {
1342 error_propagate(errp, local_err);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001343 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001344 } else if (ret) {
1345 error_setg(errp,
1346 "Snapshot with name '%s' already exists on device '%s'",
1347 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001348 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001349 }
1350
1351 /* 3. take the snapshot */
1352 sn = &state->sn;
1353 pstrcpy(sn->name, sizeof(sn->name), name);
1354 qemu_gettimeofday(&tv);
1355 sn->date_sec = tv.tv_sec;
1356 sn->date_nsec = tv.tv_usec * 1000;
1357 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001358 if (replay_mode != REPLAY_MODE_NONE) {
1359 sn->icount = replay_get_current_icount();
1360 } else {
1361 sn->icount = -1ULL;
1362 }
Wenchao Xiabbe86012013-09-11 14:04:34 +08001363
1364 ret1 = bdrv_snapshot_create(bs, sn);
1365 if (ret1 < 0) {
1366 error_setg_errno(errp, -ret1,
1367 "Failed to create snapshot '%s' on device '%s'",
1368 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001369 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001370 }
1371
1372 /* 4. succeed, mark a snapshot is created */
Fam Zheng507306c2015-10-23 11:08:13 +08001373 state->created = true;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001374
1375out:
1376 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001377}
1378
John Snow50f43f02015-11-05 18:13:09 -05001379static void internal_snapshot_abort(BlkActionState *common)
Wenchao Xiabbe86012013-09-11 14:04:34 +08001380{
1381 InternalSnapshotState *state =
1382 DO_UPCAST(InternalSnapshotState, common, common);
1383 BlockDriverState *bs = state->bs;
1384 QEMUSnapshotInfo *sn = &state->sn;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001385 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001386 Error *local_error = NULL;
1387
Fam Zheng507306c2015-10-23 11:08:13 +08001388 if (!state->created) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001389 return;
1390 }
1391
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001392 aio_context = bdrv_get_aio_context(state->bs);
1393 aio_context_acquire(aio_context);
1394
Wenchao Xiabbe86012013-09-11 14:04:34 +08001395 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001396 error_reportf_err(local_error,
1397 "Failed to delete snapshot with id '%s' and "
1398 "name '%s' on device '%s' in abort: ",
1399 sn->id_str, sn->name,
1400 bdrv_get_device_name(bs));
Wenchao Xiabbe86012013-09-11 14:04:34 +08001401 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001402
1403 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001404}
1405
John Snow50f43f02015-11-05 18:13:09 -05001406static void internal_snapshot_clean(BlkActionState *common)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001407{
1408 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1409 common, common);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001410 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001411
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001412 if (!state->bs) {
1413 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001414 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001415
1416 aio_context = bdrv_get_aio_context(state->bs);
1417 aio_context_acquire(aio_context);
1418
1419 bdrv_drained_end(state->bs);
1420
1421 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001422}
1423
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001424/* external snapshot private data */
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001425typedef struct ExternalSnapshotState {
John Snow50f43f02015-11-05 18:13:09 -05001426 BlkActionState common;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001427 BlockDriverState *old_bs;
1428 BlockDriverState *new_bs;
Kevin Wolf067acf22017-03-02 15:26:18 +01001429 bool overlay_appended;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001430} ExternalSnapshotState;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001431
John Snow50f43f02015-11-05 18:13:09 -05001432static void external_snapshot_prepare(BlkActionState *common,
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001433 Error **errp)
1434{
Max Reitz5b363932016-05-17 16:41:31 +02001435 int flags = 0;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001436 QDict *options = NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001437 Error *local_err = NULL;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001438 /* Device and node name of the image to generate the snapshot from */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001439 const char *device;
Benoît Canet0901f672014-01-23 21:31:38 +01001440 const char *node_name;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001441 /* Reference to the new image (for 'blockdev-snapshot') */
1442 const char *snapshot_ref;
1443 /* File name of the new image (for 'blockdev-snapshot-sync') */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001444 const char *new_image_file;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001445 ExternalSnapshotState *state =
1446 DO_UPCAST(ExternalSnapshotState, common, common);
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001447 TransactionAction *action = common->action;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001448 AioContext *aio_context;
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001449 uint64_t perm, shared;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001450
Alberto Garcia43de7e22015-10-26 14:27:16 +02001451 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1452 * purpose but a different set of parameters */
1453 switch (action->type) {
1454 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1455 {
Eric Blake32bafa82016-03-17 16:48:37 -06001456 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001457 device = s->node;
1458 node_name = s->node;
1459 new_image_file = NULL;
1460 snapshot_ref = s->overlay;
1461 }
1462 break;
1463 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1464 {
Eric Blake32bafa82016-03-17 16:48:37 -06001465 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001466 device = s->has_device ? s->device : NULL;
1467 node_name = s->has_node_name ? s->node_name : NULL;
1468 new_image_file = s->snapshot_file;
1469 snapshot_ref = NULL;
1470 }
1471 break;
1472 default:
1473 g_assert_not_reached();
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001474 }
1475
1476 /* start processing */
John Snow94d16a62015-11-05 18:13:18 -05001477 if (action_check_completion_mode(common, errp) < 0) {
1478 return;
1479 }
1480
Alberto Garcia43de7e22015-10-26 14:27:16 +02001481 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1482 if (!state->old_bs) {
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001483 return;
1484 }
1485
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001486 aio_context = bdrv_get_aio_context(state->old_bs);
1487 aio_context_acquire(aio_context);
1488
1489 /* Paired with .clean() */
Fam Zhengda763e82015-10-23 11:08:10 +08001490 bdrv_drained_begin(state->old_bs);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001491
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001492 if (!bdrv_is_inserted(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001493 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001494 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001495 }
1496
Fam Zheng3718d8a2014-05-23 21:29:43 +08001497 if (bdrv_op_is_blocked(state->old_bs,
1498 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001499 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001500 }
1501
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001502 if (!bdrv_is_read_only(state->old_bs)) {
1503 if (bdrv_flush(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001504 error_setg(errp, QERR_IO_ERROR);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001505 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001506 }
1507 }
1508
Alberto Garcia43de7e22015-10-26 14:27:16 +02001509 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
Eric Blake32bafa82016-03-17 16:48:37 -06001510 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001511 const char *format = s->has_format ? s->format : "qcow2";
1512 enum NewImageMode mode;
1513 const char *snapshot_node_name =
1514 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001515
Alberto Garcia43de7e22015-10-26 14:27:16 +02001516 if (node_name && !snapshot_node_name) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001517 error_setg(errp, "New overlay node name missing");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001518 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001519 }
Alberto Garcia43de7e22015-10-26 14:27:16 +02001520
1521 if (snapshot_node_name &&
1522 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001523 error_setg(errp, "New overlay node name already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001524 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001525 }
1526
1527 flags = state->old_bs->open_flags;
John Snow2a32c6e2017-07-17 20:34:21 -04001528 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1529 flags |= BDRV_O_NO_BACKING;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001530
1531 /* create new image w/backing file */
1532 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1533 if (mode != NEW_IMAGE_MODE_EXISTING) {
Kevin Wolff86b8b52016-03-02 12:16:44 +01001534 int64_t size = bdrv_getlength(state->old_bs);
1535 if (size < 0) {
1536 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001537 goto out;
Kevin Wolff86b8b52016-03-02 12:16:44 +01001538 }
Max Reitzf30c66b2019-02-01 20:29:05 +01001539 bdrv_refresh_filename(state->old_bs);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001540 bdrv_img_create(new_image_file, format,
1541 state->old_bs->filename,
1542 state->old_bs->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08001543 NULL, size, flags, false, &local_err);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001544 if (local_err) {
1545 error_propagate(errp, local_err);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001546 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001547 }
1548 }
1549
1550 options = qdict_new();
Peter Maydelld52e1a02018-11-01 16:30:37 +00001551 if (snapshot_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05001552 qdict_put_str(options, "node-name", snapshot_node_name);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001553 }
Eric Blake46f5ac22017-04-27 16:58:17 -05001554 qdict_put_str(options, "driver", format);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001555 }
1556
Max Reitz5b363932016-05-17 16:41:31 +02001557 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1558 errp);
Max Reitzf67503e2014-02-18 18:33:05 +01001559 /* We will manually add the backing_hd field to the bs later */
Max Reitz5b363932016-05-17 16:41:31 +02001560 if (!state->new_bs) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001561 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001562 }
1563
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001564 /*
1565 * Allow attaching a backing file to an overlay that's already in use only
1566 * if the parents don't assume that they are already seeing a valid image.
1567 * (Specifically, allow it as a mirror target, which is write-only access.)
1568 */
1569 bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1570 if (perm & BLK_PERM_CONSISTENT_READ) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001571 error_setg(errp, "The overlay is already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001572 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001573 }
1574
Max Reitz7cc734a2019-06-12 18:34:46 +02001575 if (state->new_bs->drv->is_filter) {
1576 error_setg(errp, "Filters cannot be used as overlays");
1577 goto out;
1578 }
1579
1580 if (bdrv_cow_child(state->new_bs)) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001581 error_setg(errp, "The overlay already has a backing image");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001582 goto out;
Alberto Garcia08b24cf2015-11-03 12:32:35 +02001583 }
1584
1585 if (!state->new_bs->drv->supports_backing) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001586 error_setg(errp, "The overlay does not support backing images");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001587 goto out;
Kevin Wolfb2c28322017-02-20 12:46:42 +01001588 }
1589
1590 /* This removes our old bs and adds the new bs. This is an operation that
1591 * can fail, so we need to do it in .prepare; undoing it for abort is
1592 * always possible. */
1593 bdrv_ref(state->new_bs);
1594 bdrv_append(state->new_bs, state->old_bs, &local_err);
1595 if (local_err) {
1596 error_propagate(errp, local_err);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001597 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001598 }
Kevin Wolf067acf22017-03-02 15:26:18 +01001599 state->overlay_appended = true;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001600
1601out:
1602 aio_context_release(aio_context);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001603}
1604
John Snow50f43f02015-11-05 18:13:09 -05001605static void external_snapshot_commit(BlkActionState *common)
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001606{
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001607 ExternalSnapshotState *state =
1608 DO_UPCAST(ExternalSnapshotState, common, common);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001609 AioContext *aio_context;
1610
1611 aio_context = bdrv_get_aio_context(state->old_bs);
1612 aio_context_acquire(aio_context);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001613
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001614 /* We don't need (or want) to use the transactional
1615 * bdrv_reopen_multiple() across all the entries at once, because we
1616 * don't want to abort all of them if one of them fails the reopen */
Stefan Hajnoczid73415a2020-09-23 11:56:46 +01001617 if (!qatomic_read(&state->old_bs->copy_on_read)) {
Alberto Garcia1b577742018-11-12 16:00:39 +02001618 bdrv_reopen_set_read_only(state->old_bs, true, NULL);
Kevin Wolf4c844982016-02-29 13:12:26 +01001619 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001620
1621 aio_context_release(aio_context);
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001622}
1623
John Snow50f43f02015-11-05 18:13:09 -05001624static void external_snapshot_abort(BlkActionState *common)
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001625{
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001626 ExternalSnapshotState *state =
1627 DO_UPCAST(ExternalSnapshotState, common, common);
1628 if (state->new_bs) {
Kevin Wolf067acf22017-03-02 15:26:18 +01001629 if (state->overlay_appended) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001630 AioContext *aio_context;
Sergio Lopez377410f2020-01-08 15:31:37 +01001631 AioContext *tmp_context;
1632 int ret;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001633
1634 aio_context = bdrv_get_aio_context(state->old_bs);
1635 aio_context_acquire(aio_context);
1636
Jeff Cody719fc282017-06-07 09:55:22 -04001637 bdrv_ref(state->old_bs); /* we can't let bdrv_set_backind_hd()
1638 close state->old_bs; we need it */
1639 bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
Sergio Lopez377410f2020-01-08 15:31:37 +01001640
1641 /*
1642 * The call to bdrv_set_backing_hd() above returns state->old_bs to
1643 * the main AioContext. As we're still going to be using it, return
1644 * it to the AioContext it was before.
1645 */
1646 tmp_context = bdrv_get_aio_context(state->old_bs);
1647 if (aio_context != tmp_context) {
1648 aio_context_release(aio_context);
1649 aio_context_acquire(tmp_context);
1650
1651 ret = bdrv_try_set_aio_context(state->old_bs,
1652 aio_context, NULL);
1653 assert(ret == 0);
1654
1655 aio_context_release(tmp_context);
1656 aio_context_acquire(aio_context);
1657 }
1658
Kevin Wolf5fe31c22017-03-06 16:20:51 +01001659 bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
Jeff Cody719fc282017-06-07 09:55:22 -04001660 bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001661
1662 aio_context_release(aio_context);
Kevin Wolfb2c28322017-02-20 12:46:42 +01001663 }
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001664 }
Fam Zhengda763e82015-10-23 11:08:10 +08001665}
1666
John Snow50f43f02015-11-05 18:13:09 -05001667static void external_snapshot_clean(BlkActionState *common)
Fam Zhengda763e82015-10-23 11:08:10 +08001668{
1669 ExternalSnapshotState *state =
1670 DO_UPCAST(ExternalSnapshotState, common, common);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001671 AioContext *aio_context;
1672
1673 if (!state->old_bs) {
1674 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001675 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001676
1677 aio_context = bdrv_get_aio_context(state->old_bs);
1678 aio_context_acquire(aio_context);
1679
1680 bdrv_drained_end(state->old_bs);
1681 bdrv_unref(state->new_bs);
1682
1683 aio_context_release(aio_context);
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001684}
1685
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001686typedef struct DriveBackupState {
John Snow50f43f02015-11-05 18:13:09 -05001687 BlkActionState common;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001688 BlockDriverState *bs;
1689 BlockJob *job;
1690} DriveBackupState;
1691
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001692static BlockJob *do_backup_common(BackupCommon *backup,
1693 BlockDriverState *bs,
1694 BlockDriverState *target_bs,
1695 AioContext *aio_context,
1696 JobTxn *txn, Error **errp);
John Snow78f51fd2015-11-05 18:13:17 -05001697
John Snow50f43f02015-11-05 18:13:09 -05001698static void drive_backup_prepare(BlkActionState *common, Error **errp)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001699{
1700 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1701 DriveBackup *backup;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001702 BlockDriverState *bs;
1703 BlockDriverState *target_bs;
1704 BlockDriverState *source = NULL;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001705 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001706 AioContext *old_context;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001707 QDict *options;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001708 Error *local_err = NULL;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001709 int flags;
1710 int64_t size;
1711 bool set_backing_hd = false;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001712 int ret;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001713
Eric Blake6a8f9662015-10-26 16:34:54 -06001714 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
Eric Blake32bafa82016-03-17 16:48:37 -06001715 backup = common->action->u.drive_backup.data;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001716
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001717 if (!backup->has_mode) {
1718 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1719 }
1720
Vladimir Sementsov-Ogievskiy85c9d132019-06-18 17:08:04 +03001721 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001722 if (!bs) {
Fam Zheng1fdd4b72015-10-23 11:08:11 +08001723 return;
1724 }
1725
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001726 if (!bs->drv) {
1727 error_setg(errp, "Device has no medium");
1728 return;
1729 }
1730
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001731 aio_context = bdrv_get_aio_context(bs);
1732 aio_context_acquire(aio_context);
1733
1734 /* Paired with .clean() */
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001735 bdrv_drained_begin(bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001736
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001737 if (!backup->has_format) {
1738 backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
1739 NULL : (char *) bs->drv->format_name;
1740 }
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001741
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001742 /* Early check to avoid creating target */
1743 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
1744 goto out;
1745 }
1746
1747 flags = bs->open_flags | BDRV_O_RDWR;
1748
1749 /*
1750 * See if we have a backing HD we can use to create our new image
1751 * on top of.
1752 */
1753 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
Max Reitz2b088c62019-06-12 17:46:45 +02001754 /*
1755 * Backup will not replace the source by the target, so none
1756 * of the filters skipped here will be removed (in contrast to
1757 * mirror). Therefore, we can skip all of them when looking
1758 * for the first COW relationship.
1759 */
1760 source = bdrv_cow_bs(bdrv_skip_filters(bs));
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001761 if (!source) {
1762 backup->sync = MIRROR_SYNC_MODE_FULL;
1763 }
1764 }
1765 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1766 source = bs;
1767 flags |= BDRV_O_NO_BACKING;
1768 set_backing_hd = true;
1769 }
1770
1771 size = bdrv_getlength(bs);
1772 if (size < 0) {
1773 error_setg_errno(errp, -size, "bdrv_getlength failed");
1774 goto out;
1775 }
1776
1777 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
1778 assert(backup->format);
1779 if (source) {
Max Reitz2b088c62019-06-12 17:46:45 +02001780 /* Implicit filters should not appear in the filename */
1781 BlockDriverState *explicit_backing =
1782 bdrv_skip_implicit_filters(source);
1783
1784 bdrv_refresh_filename(explicit_backing);
1785 bdrv_img_create(backup->target, backup->format,
1786 explicit_backing->filename,
1787 explicit_backing->drv->format_name, NULL,
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001788 size, flags, false, &local_err);
1789 } else {
1790 bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
1791 size, flags, false, &local_err);
1792 }
1793 }
1794
Markus Armbruster84d18f02014-01-30 15:07:28 +01001795 if (local_err) {
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001796 error_propagate(errp, local_err);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001797 goto out;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001798 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001799
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001800 options = qdict_new();
1801 qdict_put_str(options, "discard", "unmap");
1802 qdict_put_str(options, "detect-zeroes", "unmap");
1803 if (backup->format) {
1804 qdict_put_str(options, "driver", backup->format);
1805 }
1806
1807 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
1808 if (!target_bs) {
1809 goto out;
1810 }
1811
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001812 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
1813 old_context = bdrv_get_aio_context(target_bs);
1814 aio_context_release(aio_context);
1815 aio_context_acquire(old_context);
1816
1817 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1818 if (ret < 0) {
1819 bdrv_unref(target_bs);
1820 aio_context_release(old_context);
1821 return;
1822 }
1823
1824 aio_context_release(old_context);
1825 aio_context_acquire(aio_context);
1826
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001827 if (set_backing_hd) {
1828 bdrv_set_backing_hd(target_bs, source, &local_err);
1829 if (local_err) {
1830 goto unref;
1831 }
1832 }
1833
1834 state->bs = bs;
1835
1836 state->job = do_backup_common(qapi_DriveBackup_base(backup),
1837 bs, target_bs, aio_context,
1838 common->block_job_txn, errp);
1839
1840unref:
1841 bdrv_unref(target_bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001842out:
1843 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001844}
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001845
John Snow111049a2016-11-08 01:50:38 -05001846static void drive_backup_commit(BlkActionState *common)
1847{
1848 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001849 AioContext *aio_context;
1850
1851 aio_context = bdrv_get_aio_context(state->bs);
1852 aio_context_acquire(aio_context);
1853
John Snow111049a2016-11-08 01:50:38 -05001854 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001855 job_start(&state->job->job);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001856
1857 aio_context_release(aio_context);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001858}
1859
John Snow50f43f02015-11-05 18:13:09 -05001860static void drive_backup_abort(BlkActionState *common)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001861{
1862 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001863
John Snow111049a2016-11-08 01:50:38 -05001864 if (state->job) {
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001865 AioContext *aio_context;
1866
1867 aio_context = bdrv_get_aio_context(state->bs);
1868 aio_context_acquire(aio_context);
1869
Kevin Wolf3d70ff52018-04-24 16:13:52 +02001870 job_cancel_sync(&state->job->job);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001871
1872 aio_context_release(aio_context);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001873 }
1874}
1875
John Snow50f43f02015-11-05 18:13:09 -05001876static void drive_backup_clean(BlkActionState *common)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001877{
1878 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001879 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001880
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001881 if (!state->bs) {
1882 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001883 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001884
1885 aio_context = bdrv_get_aio_context(state->bs);
1886 aio_context_acquire(aio_context);
1887
1888 bdrv_drained_end(state->bs);
1889
1890 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001891}
1892
Fam Zhengbd8baec2014-12-18 18:37:06 +08001893typedef struct BlockdevBackupState {
John Snow50f43f02015-11-05 18:13:09 -05001894 BlkActionState common;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001895 BlockDriverState *bs;
1896 BlockJob *job;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001897} BlockdevBackupState;
1898
John Snow50f43f02015-11-05 18:13:09 -05001899static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001900{
1901 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1902 BlockdevBackup *backup;
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001903 BlockDriverState *bs;
1904 BlockDriverState *target_bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001905 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001906 AioContext *old_context;
1907 int ret;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001908
Eric Blake6a8f9662015-10-26 16:34:54 -06001909 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
Eric Blake32bafa82016-03-17 16:48:37 -06001910 backup = common->action->u.blockdev_backup.data;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001911
Vladimir Sementsov-Ogievskiy930fe172018-07-02 15:46:29 -04001912 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001913 if (!bs) {
Fam Zhengff52bf32015-10-23 11:08:12 +08001914 return;
1915 }
1916
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001917 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1918 if (!target_bs) {
Fam Zhengbd8baec2014-12-18 18:37:06 +08001919 return;
1920 }
1921
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001922 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001923 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001924 old_context = bdrv_get_aio_context(target_bs);
1925 aio_context_acquire(old_context);
1926
1927 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1928 if (ret < 0) {
1929 aio_context_release(old_context);
1930 return;
1931 }
1932
1933 aio_context_release(old_context);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001934 aio_context_acquire(aio_context);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001935 state->bs = bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001936
1937 /* Paired with .clean() */
Fam Zhengff52bf32015-10-23 11:08:12 +08001938 bdrv_drained_begin(state->bs);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001939
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001940 state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1941 bs, target_bs, aio_context,
1942 common->block_job_txn, errp);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001943
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001944 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001945}
Fam Zhengbd8baec2014-12-18 18:37:06 +08001946
John Snow111049a2016-11-08 01:50:38 -05001947static void blockdev_backup_commit(BlkActionState *common)
1948{
1949 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001950 AioContext *aio_context;
1951
1952 aio_context = bdrv_get_aio_context(state->bs);
1953 aio_context_acquire(aio_context);
1954
John Snow111049a2016-11-08 01:50:38 -05001955 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001956 job_start(&state->job->job);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001957
1958 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001959}
1960
John Snow50f43f02015-11-05 18:13:09 -05001961static void blockdev_backup_abort(BlkActionState *common)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001962{
1963 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001964
John Snow111049a2016-11-08 01:50:38 -05001965 if (state->job) {
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001966 AioContext *aio_context;
1967
1968 aio_context = bdrv_get_aio_context(state->bs);
1969 aio_context_acquire(aio_context);
1970
Kevin Wolf3d70ff52018-04-24 16:13:52 +02001971 job_cancel_sync(&state->job->job);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001972
1973 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001974 }
1975}
1976
John Snow50f43f02015-11-05 18:13:09 -05001977static void blockdev_backup_clean(BlkActionState *common)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001978{
1979 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001980 AioContext *aio_context;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001981
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001982 if (!state->bs) {
1983 return;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001984 }
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001985
1986 aio_context = bdrv_get_aio_context(state->bs);
1987 aio_context_acquire(aio_context);
1988
1989 bdrv_drained_end(state->bs);
1990
1991 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001992}
1993
Fam Zhengdf9a6812015-11-09 18:16:54 +08001994typedef struct BlockDirtyBitmapState {
John Snow50f43f02015-11-05 18:13:09 -05001995 BlkActionState common;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001996 BdrvDirtyBitmap *bitmap;
1997 BlockDriverState *bs;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001998 HBitmap *backup;
1999 bool prepared;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002000 bool was_enabled;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002001} BlockDirtyBitmapState;
2002
John Snow50f43f02015-11-05 18:13:09 -05002003static void block_dirty_bitmap_add_prepare(BlkActionState *common,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002004 Error **errp)
2005{
2006 Error *local_err = NULL;
2007 BlockDirtyBitmapAdd *action;
2008 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2009 common, common);
2010
John Snow94d16a62015-11-05 18:13:18 -05002011 if (action_check_completion_mode(common, errp) < 0) {
2012 return;
2013 }
2014
Eric Blake32bafa82016-03-17 16:48:37 -06002015 action = common->action->u.block_dirty_bitmap_add.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002016 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2017 qmp_block_dirty_bitmap_add(action->node, action->name,
2018 action->has_granularity, action->granularity,
Vladimir Sementsov-Ogievskiyfd5ae4c2017-06-28 15:05:23 +03002019 action->has_persistent, action->persistent,
John Snow0e2b7f02018-12-21 04:35:22 -05002020 action->has_disabled, action->disabled,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002021 &local_err);
2022
2023 if (!local_err) {
2024 state->prepared = true;
2025 } else {
2026 error_propagate(errp, local_err);
2027 }
2028}
2029
John Snow50f43f02015-11-05 18:13:09 -05002030static void block_dirty_bitmap_add_abort(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002031{
2032 BlockDirtyBitmapAdd *action;
2033 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2034 common, common);
2035
Eric Blake32bafa82016-03-17 16:48:37 -06002036 action = common->action->u.block_dirty_bitmap_add.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002037 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2038 * then the node reference and bitmap name must have been valid.
2039 */
2040 if (state->prepared) {
2041 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2042 }
2043}
2044
John Snow50f43f02015-11-05 18:13:09 -05002045static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002046 Error **errp)
2047{
2048 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2049 common, common);
2050 BlockDirtyBitmap *action;
2051
John Snow94d16a62015-11-05 18:13:18 -05002052 if (action_check_completion_mode(common, errp) < 0) {
2053 return;
2054 }
2055
Eric Blake32bafa82016-03-17 16:48:37 -06002056 action = common->action->u.block_dirty_bitmap_clear.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002057 state->bitmap = block_dirty_bitmap_lookup(action->node,
2058 action->name,
2059 &state->bs,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002060 errp);
2061 if (!state->bitmap) {
2062 return;
2063 }
2064
John Snow3ae96d62019-03-12 12:05:49 -04002065 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
Vladimir Sementsov-Ogievskiyd6883bc2017-06-28 15:05:10 +03002066 return;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002067 }
2068
2069 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
Fam Zhengdf9a6812015-11-09 18:16:54 +08002070}
2071
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002072static void block_dirty_bitmap_restore(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002073{
2074 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2075 common, common);
2076
John Snow184dd9c2017-03-15 17:28:11 -04002077 if (state->backup) {
Vladimir Sementsov-Ogievskiy56bd6622018-10-29 16:23:14 -04002078 bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
John Snow184dd9c2017-03-15 17:28:11 -04002079 }
Fam Zhengdf9a6812015-11-09 18:16:54 +08002080}
2081
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002082static void block_dirty_bitmap_free_backup(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002083{
2084 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2085 common, common);
2086
2087 hbitmap_free(state->backup);
2088}
2089
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002090static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2091 Error **errp)
2092{
2093 BlockDirtyBitmap *action;
2094 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2095 common, common);
2096
2097 if (action_check_completion_mode(common, errp) < 0) {
2098 return;
2099 }
2100
John Snow0e2b7f02018-12-21 04:35:22 -05002101 action = common->action->u.block_dirty_bitmap_enable.data;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002102 state->bitmap = block_dirty_bitmap_lookup(action->node,
2103 action->name,
2104 NULL,
2105 errp);
2106 if (!state->bitmap) {
2107 return;
2108 }
2109
John Snow3ae96d62019-03-12 12:05:49 -04002110 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04002111 return;
2112 }
2113
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002114 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2115 bdrv_enable_dirty_bitmap(state->bitmap);
2116}
2117
2118static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2119{
2120 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2121 common, common);
2122
2123 if (!state->was_enabled) {
2124 bdrv_disable_dirty_bitmap(state->bitmap);
2125 }
2126}
2127
2128static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2129 Error **errp)
2130{
2131 BlockDirtyBitmap *action;
2132 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2133 common, common);
2134
2135 if (action_check_completion_mode(common, errp) < 0) {
2136 return;
2137 }
2138
John Snow0e2b7f02018-12-21 04:35:22 -05002139 action = common->action->u.block_dirty_bitmap_disable.data;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002140 state->bitmap = block_dirty_bitmap_lookup(action->node,
2141 action->name,
2142 NULL,
2143 errp);
2144 if (!state->bitmap) {
2145 return;
2146 }
2147
John Snow3ae96d62019-03-12 12:05:49 -04002148 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04002149 return;
2150 }
2151
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002152 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2153 bdrv_disable_dirty_bitmap(state->bitmap);
2154}
2155
2156static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2157{
2158 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2159 common, common);
2160
2161 if (state->was_enabled) {
2162 bdrv_enable_dirty_bitmap(state->bitmap);
2163 }
2164}
2165
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002166static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2167 Error **errp)
2168{
2169 BlockDirtyBitmapMerge *action;
2170 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2171 common, common);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002172
2173 if (action_check_completion_mode(common, errp) < 0) {
2174 return;
2175 }
2176
John Snow0e2b7f02018-12-21 04:35:22 -05002177 action = common->action->u.block_dirty_bitmap_merge.data;
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002178
Eric Blakec6996cf2020-05-12 20:16:43 -05002179 state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2180 action->bitmaps, &state->backup,
2181 errp);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002182}
2183
John Snowc4e4b0f2019-07-29 16:35:54 -04002184static void block_dirty_bitmap_remove_prepare(BlkActionState *common,
2185 Error **errp)
2186{
2187 BlockDirtyBitmap *action;
2188 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2189 common, common);
2190
2191 if (action_check_completion_mode(common, errp) < 0) {
2192 return;
2193 }
2194
2195 action = common->action->u.block_dirty_bitmap_remove.data;
2196
Eric Blakec6996cf2020-05-12 20:16:43 -05002197 state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2198 false, &state->bs, errp);
John Snowc4e4b0f2019-07-29 16:35:54 -04002199 if (state->bitmap) {
2200 bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2201 bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2202 }
2203}
2204
2205static void block_dirty_bitmap_remove_abort(BlkActionState *common)
2206{
2207 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2208 common, common);
2209
2210 if (state->bitmap) {
2211 bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2212 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2213 }
2214}
2215
2216static void block_dirty_bitmap_remove_commit(BlkActionState *common)
2217{
2218 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2219 common, common);
2220
2221 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
Vladimir Sementsov-Ogievskiy5deb6cb2019-09-16 17:19:09 +03002222 bdrv_release_dirty_bitmap(state->bitmap);
John Snowc4e4b0f2019-07-29 16:35:54 -04002223}
2224
John Snow50f43f02015-11-05 18:13:09 -05002225static void abort_prepare(BlkActionState *common, Error **errp)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002226{
2227 error_setg(errp, "Transaction aborted using Abort action");
2228}
2229
John Snow50f43f02015-11-05 18:13:09 -05002230static void abort_commit(BlkActionState *common)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002231{
Stefan Weildfc6f862013-07-25 18:21:28 +02002232 g_assert_not_reached(); /* this action never succeeds */
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002233}
2234
John Snow50f43f02015-11-05 18:13:09 -05002235static const BlkActionOps actions[] = {
Alberto Garcia43de7e22015-10-26 14:27:16 +02002236 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2237 .instance_size = sizeof(ExternalSnapshotState),
2238 .prepare = external_snapshot_prepare,
2239 .commit = external_snapshot_commit,
2240 .abort = external_snapshot_abort,
Alberto Garcia4ad6f3d2015-11-13 15:00:24 +02002241 .clean = external_snapshot_clean,
Alberto Garcia43de7e22015-10-26 14:27:16 +02002242 },
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002243 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002244 .instance_size = sizeof(ExternalSnapshotState),
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002245 .prepare = external_snapshot_prepare,
2246 .commit = external_snapshot_commit,
2247 .abort = external_snapshot_abort,
Fam Zhengda763e82015-10-23 11:08:10 +08002248 .clean = external_snapshot_clean,
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002249 },
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002250 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2251 .instance_size = sizeof(DriveBackupState),
2252 .prepare = drive_backup_prepare,
John Snow111049a2016-11-08 01:50:38 -05002253 .commit = drive_backup_commit,
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002254 .abort = drive_backup_abort,
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00002255 .clean = drive_backup_clean,
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002256 },
Fam Zhengbd8baec2014-12-18 18:37:06 +08002257 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2258 .instance_size = sizeof(BlockdevBackupState),
2259 .prepare = blockdev_backup_prepare,
John Snow111049a2016-11-08 01:50:38 -05002260 .commit = blockdev_backup_commit,
Fam Zhengbd8baec2014-12-18 18:37:06 +08002261 .abort = blockdev_backup_abort,
2262 .clean = blockdev_backup_clean,
2263 },
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002264 [TRANSACTION_ACTION_KIND_ABORT] = {
John Snow50f43f02015-11-05 18:13:09 -05002265 .instance_size = sizeof(BlkActionState),
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002266 .prepare = abort_prepare,
2267 .commit = abort_commit,
2268 },
Wenchao Xiabbe86012013-09-11 14:04:34 +08002269 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2270 .instance_size = sizeof(InternalSnapshotState),
2271 .prepare = internal_snapshot_prepare,
2272 .abort = internal_snapshot_abort,
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00002273 .clean = internal_snapshot_clean,
Wenchao Xiabbe86012013-09-11 14:04:34 +08002274 },
Fam Zhengdf9a6812015-11-09 18:16:54 +08002275 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2276 .instance_size = sizeof(BlockDirtyBitmapState),
2277 .prepare = block_dirty_bitmap_add_prepare,
2278 .abort = block_dirty_bitmap_add_abort,
2279 },
2280 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2281 .instance_size = sizeof(BlockDirtyBitmapState),
2282 .prepare = block_dirty_bitmap_clear_prepare,
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002283 .commit = block_dirty_bitmap_free_backup,
2284 .abort = block_dirty_bitmap_restore,
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002285 },
John Snow0e2b7f02018-12-21 04:35:22 -05002286 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002287 .instance_size = sizeof(BlockDirtyBitmapState),
2288 .prepare = block_dirty_bitmap_enable_prepare,
2289 .abort = block_dirty_bitmap_enable_abort,
2290 },
John Snow0e2b7f02018-12-21 04:35:22 -05002291 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002292 .instance_size = sizeof(BlockDirtyBitmapState),
2293 .prepare = block_dirty_bitmap_disable_prepare,
2294 .abort = block_dirty_bitmap_disable_abort,
John Snow66da04d2018-09-06 09:02:25 -04002295 },
John Snow0e2b7f02018-12-21 04:35:22 -05002296 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002297 .instance_size = sizeof(BlockDirtyBitmapState),
2298 .prepare = block_dirty_bitmap_merge_prepare,
2299 .commit = block_dirty_bitmap_free_backup,
2300 .abort = block_dirty_bitmap_restore,
2301 },
John Snowc4e4b0f2019-07-29 16:35:54 -04002302 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE] = {
2303 .instance_size = sizeof(BlockDirtyBitmapState),
2304 .prepare = block_dirty_bitmap_remove_prepare,
2305 .commit = block_dirty_bitmap_remove_commit,
2306 .abort = block_dirty_bitmap_remove_abort,
2307 },
John Snow66da04d2018-09-06 09:02:25 -04002308 /* Where are transactions for MIRROR, COMMIT and STREAM?
2309 * Although these blockjobs use transaction callbacks like the backup job,
2310 * these jobs do not necessarily adhere to transaction semantics.
2311 * These jobs may not fully undo all of their actions on abort, nor do they
2312 * necessarily work in transactions with more than one job in them.
2313 */
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002314};
2315
John Snow94d16a62015-11-05 18:13:18 -05002316/**
2317 * Allocate a TransactionProperties structure if necessary, and fill
2318 * that structure with desired defaults if they are unset.
2319 */
2320static TransactionProperties *get_transaction_properties(
2321 TransactionProperties *props)
2322{
2323 if (!props) {
2324 props = g_new0(TransactionProperties, 1);
2325 }
2326
2327 if (!props->has_completion_mode) {
2328 props->has_completion_mode = true;
2329 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2330 }
2331
2332 return props;
2333}
2334
Jeff Cody8802d1f2012-02-28 15:54:06 -05002335/*
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002336 * 'Atomic' group operations. The operations are performed as a set, and if
2337 * any fail then we roll back all operations in the group.
Jeff Cody8802d1f2012-02-28 15:54:06 -05002338 */
John Snow94d16a62015-11-05 18:13:18 -05002339void qmp_transaction(TransactionActionList *dev_list,
2340 bool has_props,
2341 struct TransactionProperties *props,
2342 Error **errp)
Jeff Cody8802d1f2012-02-28 15:54:06 -05002343{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002344 TransactionActionList *dev_entry = dev_list;
Kevin Wolf62c9e412018-04-19 16:09:52 +02002345 JobTxn *block_job_txn = NULL;
John Snow50f43f02015-11-05 18:13:09 -05002346 BlkActionState *state, *next;
Luiz Capitulino43e17042012-11-30 10:52:07 -02002347 Error *local_err = NULL;
Jeff Cody8802d1f2012-02-28 15:54:06 -05002348
John Snowf4de0f82019-01-11 11:59:16 -06002349 QTAILQ_HEAD(, BlkActionState) snap_bdrv_states;
2350 QTAILQ_INIT(&snap_bdrv_states);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002351
John Snow94d16a62015-11-05 18:13:18 -05002352 /* Does this transaction get canceled as a group on failure?
Kevin Wolf62c9e412018-04-19 16:09:52 +02002353 * If not, we don't really need to make a JobTxn.
John Snow94d16a62015-11-05 18:13:18 -05002354 */
2355 props = get_transaction_properties(props);
2356 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002357 block_job_txn = job_txn_new();
John Snow94d16a62015-11-05 18:13:18 -05002358 }
2359
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002360 /* drain all i/o before any operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002361 bdrv_drain_all();
2362
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002363 /* We don't do anything in this loop that commits us to the operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002364 while (NULL != dev_entry) {
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002365 TransactionAction *dev_info = NULL;
John Snow50f43f02015-11-05 18:13:09 -05002366 const BlkActionOps *ops;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002367
Jeff Cody8802d1f2012-02-28 15:54:06 -05002368 dev_info = dev_entry->value;
2369 dev_entry = dev_entry->next;
2370
Eric Blake6a8f9662015-10-26 16:34:54 -06002371 assert(dev_info->type < ARRAY_SIZE(actions));
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002372
Eric Blake6a8f9662015-10-26 16:34:54 -06002373 ops = &actions[dev_info->type];
Max Reitzaa3fe712013-09-12 14:57:27 +02002374 assert(ops->instance_size > 0);
2375
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002376 state = g_malloc0(ops->instance_size);
2377 state->ops = ops;
2378 state->action = dev_info;
John Snow94d16a62015-11-05 18:13:18 -05002379 state->block_job_txn = block_job_txn;
2380 state->txn_props = props;
John Snowf4de0f82019-01-11 11:59:16 -06002381 QTAILQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002382
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002383 state->ops->prepare(state, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002384 if (local_err) {
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002385 error_propagate(errp, local_err);
2386 goto delete_and_fail;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002387 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002388 }
2389
John Snowf4de0f82019-01-11 11:59:16 -06002390 QTAILQ_FOREACH(state, &snap_bdrv_states, entry) {
Stefan Hajnoczif9ea81e2013-06-24 17:13:16 +02002391 if (state->ops->commit) {
2392 state->ops->commit(state);
2393 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002394 }
2395
2396 /* success */
2397 goto exit;
2398
2399delete_and_fail:
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002400 /* failure, and it is all-or-none; roll back all operations */
John Snowf4de0f82019-01-11 11:59:16 -06002401 QTAILQ_FOREACH_REVERSE(state, &snap_bdrv_states, entry) {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002402 if (state->ops->abort) {
2403 state->ops->abort(state);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002404 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002405 }
2406exit:
John Snowf4de0f82019-01-11 11:59:16 -06002407 QTAILQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002408 if (state->ops->clean) {
2409 state->ops->clean(state);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002410 }
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002411 g_free(state);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002412 }
John Snow94d16a62015-11-05 18:13:18 -05002413 if (!has_props) {
2414 qapi_free_TransactionProperties(props);
2415 }
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002416 job_txn_unref(block_job_txn);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002417}
2418
Benoît Canet12d3ba82014-01-23 21:31:35 +01002419void qmp_block_passwd(bool has_device, const char *device,
2420 bool has_node_name, const char *node_name,
2421 const char *password, Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +02002422{
Daniel P. Berrangec01c2142017-06-23 17:24:16 +01002423 error_setg(errp,
2424 "Setting block passwords directly is no longer supported");
Markus Armbruster666daa62010-06-02 18:48:27 +02002425}
2426
Vladimir Sementsov-Ogievskiya3b52532017-06-28 15:05:25 +03002427BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2428 const char *name,
2429 Error **errp)
2430{
2431 BdrvDirtyBitmap *bitmap;
2432 BlockDriverState *bs;
2433 BlockDirtyBitmapSha256 *ret = NULL;
2434 char *sha256;
2435
2436 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2437 if (!bitmap || !bs) {
2438 return NULL;
2439 }
2440
2441 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2442 if (sha256 == NULL) {
2443 return NULL;
2444 }
2445
2446 ret = g_new(BlockDirtyBitmapSha256, 1);
2447 ret->sha256 = sha256;
2448
2449 return ret;
2450}
2451
Kevin Wolfeb94b812020-10-05 17:58:55 +02002452void coroutine_fn qmp_block_resize(bool has_device, const char *device,
2453 bool has_node_name, const char *node_name,
2454 int64_t size, Error **errp)
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002455{
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002456 Error *local_err = NULL;
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002457 BlockBackend *blk = NULL;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002458 BlockDriverState *bs;
Kevin Wolfeb94b812020-10-05 17:58:55 +02002459 AioContext *old_ctx;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002460
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002461 bs = bdrv_lookup_bs(has_device ? device : NULL,
2462 has_node_name ? node_name : NULL,
2463 &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002464 if (local_err) {
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002465 error_propagate(errp, local_err);
2466 return;
2467 }
2468
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002469 if (size < 0) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002470 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
Stefan Hajnoczi927e0e72014-08-18 14:52:28 +01002471 goto out;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002472 }
2473
Jeff Cody9c75e162014-06-25 16:55:30 -04002474 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002475 error_setg(errp, QERR_DEVICE_IN_USE, device);
Stefan Hajnoczi927e0e72014-08-18 14:52:28 +01002476 goto out;
Jeff Cody9c75e162014-06-25 16:55:30 -04002477 }
2478
Eric Blakea3aeeab2020-04-28 14:26:46 -05002479 blk = blk_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
2480 if (!blk) {
Kevin Wolfd7086422017-01-13 19:02:32 +01002481 goto out;
2482 }
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002483
John Snow698bdfa2017-05-10 13:39:45 -04002484 bdrv_drained_begin(bs);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002485 old_ctx = bdrv_co_enter(bs);
Eric Blakea3aeeab2020-04-28 14:26:46 -05002486 blk_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002487 bdrv_co_leave(bs, old_ctx);
John Snow698bdfa2017-05-10 13:39:45 -04002488 bdrv_drained_end(bs);
Stefan Hajnoczi927e0e72014-08-18 14:52:28 +01002489
2490out:
Kevin Wolfeb94b812020-10-05 17:58:55 +02002491 bdrv_co_lock(bs);
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002492 blk_unref(blk);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002493 bdrv_co_unlock(bs);
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002494}
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002495
Alberto Garcia23233222016-07-05 17:28:59 +03002496void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002497 bool has_base, const char *base,
Alberto Garcia312fe092016-10-28 10:08:19 +03002498 bool has_base_node, const char *base_node,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002499 bool has_backing_file, const char *backing_file,
2500 bool has_speed, int64_t speed,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002501 bool has_on_error, BlockdevOnError on_error,
John Snow241ca1a2018-09-06 09:02:23 -04002502 bool has_auto_finalize, bool auto_finalize,
2503 bool has_auto_dismiss, bool auto_dismiss,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002504 Error **errp)
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002505{
Alberto Garcia554b6142016-10-28 10:08:11 +03002506 BlockDriverState *bs, *iter;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002507 BlockDriverState *base_bs = NULL;
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002508 AioContext *aio_context;
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002509 Error *local_err = NULL;
Jeff Cody13d8cc52014-06-25 15:40:11 -04002510 const char *base_name = NULL;
John Snowcf6320d2018-09-06 09:02:12 -04002511 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002512
Paolo Bonzini1d809092012-09-28 17:22:59 +02002513 if (!has_on_error) {
2514 on_error = BLOCKDEV_ON_ERROR_REPORT;
2515 }
2516
Alberto Garcia554b6142016-10-28 10:08:11 +03002517 bs = bdrv_lookup_bs(device, device, errp);
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002518 if (!bs) {
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002519 return;
2520 }
2521
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002522 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002523 aio_context_acquire(aio_context);
2524
Alberto Garcia312fe092016-10-28 10:08:19 +03002525 if (has_base && has_base_node) {
2526 error_setg(errp, "'base' and 'base-node' cannot be specified "
2527 "at the same time");
2528 goto out;
2529 }
2530
Jeff Cody13d8cc52014-06-25 15:40:11 -04002531 if (has_base) {
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002532 base_bs = bdrv_find_backing_image(bs, base);
2533 if (base_bs == NULL) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002534 error_setg(errp, QERR_BASE_NOT_FOUND, base);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002535 goto out;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002536 }
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002537 assert(bdrv_get_aio_context(base_bs) == aio_context);
Jeff Cody13d8cc52014-06-25 15:40:11 -04002538 base_name = base;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002539 }
2540
Alberto Garcia312fe092016-10-28 10:08:19 +03002541 if (has_base_node) {
2542 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2543 if (!base_bs) {
2544 goto out;
2545 }
2546 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2547 error_setg(errp, "Node '%s' is not a backing image of '%s'",
2548 base_node, device);
2549 goto out;
2550 }
2551 assert(bdrv_get_aio_context(base_bs) == aio_context);
Max Reitzf30c66b2019-02-01 20:29:05 +01002552 bdrv_refresh_filename(base_bs);
Alberto Garcia312fe092016-10-28 10:08:19 +03002553 base_name = base_bs->filename;
2554 }
2555
Alberto Garcia554b6142016-10-28 10:08:11 +03002556 /* Check for op blockers in the whole chain between bs and base */
Max Reitz67acfd22019-06-12 17:48:11 +02002557 for (iter = bs; iter && iter != base_bs;
2558 iter = bdrv_filter_or_cow_bs(iter))
2559 {
Alberto Garcia554b6142016-10-28 10:08:11 +03002560 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
2561 goto out;
2562 }
2563 }
2564
Jeff Cody13d8cc52014-06-25 15:40:11 -04002565 /* if we are streaming the entire chain, the result will have no backing
2566 * file, and specifying one is therefore an error */
2567 if (base_bs == NULL && has_backing_file) {
2568 error_setg(errp, "backing file specified, but streaming the "
2569 "entire chain");
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002570 goto out;
Jeff Cody13d8cc52014-06-25 15:40:11 -04002571 }
2572
2573 /* backing_file string overrides base bs filename */
2574 base_name = has_backing_file ? backing_file : base_name;
2575
John Snow241ca1a2018-09-06 09:02:23 -04002576 if (has_auto_finalize && !auto_finalize) {
2577 job_flags |= JOB_MANUAL_FINALIZE;
2578 }
2579 if (has_auto_dismiss && !auto_dismiss) {
2580 job_flags |= JOB_MANUAL_DISMISS;
2581 }
2582
Alberto Garcia23233222016-07-05 17:28:59 +03002583 stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
John Snowcf6320d2018-09-06 09:02:12 -04002584 job_flags, has_speed ? speed : 0, on_error, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002585 if (local_err) {
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002586 error_propagate(errp, local_err);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002587 goto out;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002588 }
2589
Vladimir Sementsov-Ogievskiyb23c5802019-06-06 18:41:32 +03002590 trace_qmp_block_stream(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002591
2592out:
2593 aio_context_release(aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002594}
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00002595
Alberto Garciafd62c602016-07-05 17:29:00 +03002596void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
Kevin Wolf3c605f42017-06-27 17:18:20 +02002597 bool has_base_node, const char *base_node,
Jeff Cody7676e2c2014-06-30 15:14:15 +02002598 bool has_base, const char *base,
Kevin Wolf3c605f42017-06-27 17:18:20 +02002599 bool has_top_node, const char *top_node,
Jeff Cody7676e2c2014-06-30 15:14:15 +02002600 bool has_top, const char *top,
Jeff Cody54e26902014-06-25 15:40:10 -04002601 bool has_backing_file, const char *backing_file,
Jeff Codyed61fc12012-09-27 13:29:16 -04002602 bool has_speed, int64_t speed,
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002603 bool has_on_error, BlockdevOnError on_error,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002604 bool has_filter_node_name, const char *filter_node_name,
John Snow96fbf532018-09-06 09:02:21 -04002605 bool has_auto_finalize, bool auto_finalize,
2606 bool has_auto_dismiss, bool auto_dismiss,
Jeff Codyed61fc12012-09-27 13:29:16 -04002607 Error **errp)
2608{
2609 BlockDriverState *bs;
Alberto Garcia058223a2016-10-28 10:08:07 +03002610 BlockDriverState *iter;
Jeff Codyed61fc12012-09-27 13:29:16 -04002611 BlockDriverState *base_bs, *top_bs;
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002612 AioContext *aio_context;
Jeff Codyed61fc12012-09-27 13:29:16 -04002613 Error *local_err = NULL;
John Snow53607822018-09-06 09:02:10 -04002614 int job_flags = JOB_DEFAULT;
Max Reitz05ea3852019-06-11 21:19:26 +02002615 uint64_t top_perm, top_shared;
Jeff Codyed61fc12012-09-27 13:29:16 -04002616
Max Reitz54504662014-04-10 19:36:25 +02002617 if (!has_speed) {
2618 speed = 0;
2619 }
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002620 if (!has_on_error) {
2621 on_error = BLOCKDEV_ON_ERROR_REPORT;
2622 }
Kevin Wolf0db832f2017-02-20 18:10:05 +01002623 if (!has_filter_node_name) {
2624 filter_node_name = NULL;
2625 }
John Snow96fbf532018-09-06 09:02:21 -04002626 if (has_auto_finalize && !auto_finalize) {
2627 job_flags |= JOB_MANUAL_FINALIZE;
2628 }
2629 if (has_auto_dismiss && !auto_dismiss) {
2630 job_flags |= JOB_MANUAL_DISMISS;
2631 }
Max Reitz54504662014-04-10 19:36:25 +02002632
Jeff Cody7676e2c2014-06-30 15:14:15 +02002633 /* Important Note:
2634 * libvirt relies on the DeviceNotFound error class in order to probe for
2635 * live commit feature versions; for this to work, we must make sure to
2636 * perform the device lookup before any generic errors that may occur in a
2637 * scenario in which all optional arguments are omitted. */
Kevin Wolf1d13b162016-06-23 14:20:24 +02002638 bs = qmp_get_root_bs(device, &local_err);
2639 if (!bs) {
2640 bs = bdrv_lookup_bs(device, device, NULL);
2641 if (!bs) {
2642 error_free(local_err);
2643 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2644 "Device '%s' not found", device);
2645 } else {
2646 error_propagate(errp, local_err);
2647 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002648 return;
2649 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002650
Kevin Wolf1d13b162016-06-23 14:20:24 +02002651 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002652 aio_context_acquire(aio_context);
2653
Fam Zhengbb000212014-09-11 13:14:00 +08002654 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002655 goto out;
Fam Zheng628ff682014-05-23 21:29:44 +08002656 }
2657
Jeff Codyed61fc12012-09-27 13:29:16 -04002658 /* default top_bs is the active layer */
2659 top_bs = bs;
2660
Kevin Wolf3c605f42017-06-27 17:18:20 +02002661 if (has_top_node && has_top) {
2662 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
2663 goto out;
2664 } else if (has_top_node) {
2665 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2666 if (top_bs == NULL) {
2667 goto out;
2668 }
2669 if (!bdrv_chain_contains(bs, top_bs)) {
2670 error_setg(errp, "'%s' is not in this backing file chain",
2671 top_node);
2672 goto out;
2673 }
2674 } else if (has_top && top) {
Max Reitzf30c66b2019-02-01 20:29:05 +01002675 /* This strcmp() is just a shortcut, there is no need to
2676 * refresh @bs's filename. If it mismatches,
2677 * bdrv_find_backing_image() will do the refresh and may still
2678 * return @bs. */
Jeff Codyed61fc12012-09-27 13:29:16 -04002679 if (strcmp(bs->filename, top) != 0) {
2680 top_bs = bdrv_find_backing_image(bs, top);
2681 }
2682 }
2683
2684 if (top_bs == NULL) {
2685 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002686 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002687 }
2688
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002689 assert(bdrv_get_aio_context(top_bs) == aio_context);
2690
Kevin Wolf3c605f42017-06-27 17:18:20 +02002691 if (has_base_node && has_base) {
2692 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
2693 goto out;
2694 } else if (has_base_node) {
2695 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2696 if (base_bs == NULL) {
2697 goto out;
2698 }
2699 if (!bdrv_chain_contains(top_bs, base_bs)) {
2700 error_setg(errp, "'%s' is not in this backing file chain",
2701 base_node);
2702 goto out;
2703 }
2704 } else if (has_base && base) {
Jeff Codyd5208c42012-10-16 15:49:10 -04002705 base_bs = bdrv_find_backing_image(top_bs, base);
2706 } else {
2707 base_bs = bdrv_find_base(top_bs);
2708 }
2709
2710 if (base_bs == NULL) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002711 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002712 goto out;
Jeff Codyd5208c42012-10-16 15:49:10 -04002713 }
2714
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002715 assert(bdrv_get_aio_context(base_bs) == aio_context);
2716
Max Reitz9a71b9d2019-06-12 17:47:37 +02002717 for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2718 iter = bdrv_filter_or_cow_bs(iter))
2719 {
Alberto Garcia058223a2016-10-28 10:08:07 +03002720 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2721 goto out;
2722 }
Fam Zhengbb000212014-09-11 13:14:00 +08002723 }
2724
Jeff Cody7676e2c2014-06-30 15:14:15 +02002725 /* Do not allow attempts to commit an image into itself */
2726 if (top_bs == base_bs) {
2727 error_setg(errp, "cannot commit an image into itself");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002728 goto out;
Jeff Cody7676e2c2014-06-30 15:14:15 +02002729 }
2730
Max Reitz05ea3852019-06-11 21:19:26 +02002731 /*
2732 * Active commit is required if and only if someone has taken a
2733 * WRITE permission on the top node. Historically, we have always
2734 * used active commit for top nodes, so continue that practice
2735 * lest we possibly break clients that rely on this behavior, e.g.
2736 * to later attach this node to a writing parent.
2737 * (Active commit is never really wrong.)
2738 */
2739 bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2740 if (top_perm & BLK_PERM_WRITE ||
2741 bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2742 {
Jeff Cody54e26902014-06-25 15:40:10 -04002743 if (has_backing_file) {
Max Reitz05ea3852019-06-11 21:19:26 +02002744 if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2745 error_setg(errp, "'backing-file' specified,"
2746 " but 'top' is the active layer");
2747 } else {
2748 error_setg(errp, "'backing-file' specified, but 'top' has a "
2749 "writer on it");
2750 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002751 goto out;
Jeff Cody54e26902014-06-25 15:40:10 -04002752 }
Max Reitz05ea3852019-06-11 21:19:26 +02002753 if (!has_job_id) {
2754 /*
2755 * Emulate here what block_job_create() does, because it
2756 * is possible that @bs != @top_bs (the block job should
2757 * be named after @bs, even if @top_bs is the actual
2758 * source)
2759 */
2760 job_id = bdrv_get_device_name(bs);
2761 }
2762 commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
Fam Zheng78bbd912017-04-21 20:27:04 +08002763 filter_node_name, NULL, NULL, false, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002764 } else {
Alberto Garcia058223a2016-10-28 10:08:07 +03002765 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2766 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2767 goto out;
2768 }
John Snow53607822018-09-06 09:02:10 -04002769 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
2770 speed, on_error, has_backing_file ? backing_file : NULL,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002771 filter_node_name, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002772 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002773 if (local_err != NULL) {
2774 error_propagate(errp, local_err);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002775 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002776 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002777
2778out:
2779 aio_context_release(aio_context);
Jeff Codyed61fc12012-09-27 13:29:16 -04002780}
2781
John Snow7b0b8702019-07-29 16:35:52 -04002782/* Common QMP interface for drive-backup and blockdev-backup */
2783static BlockJob *do_backup_common(BackupCommon *backup,
2784 BlockDriverState *bs,
2785 BlockDriverState *target_bs,
2786 AioContext *aio_context,
2787 JobTxn *txn, Error **errp)
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002788{
John Snow111049a2016-11-08 01:50:38 -05002789 BlockJob *job = NULL;
John Snowd58d8452015-04-17 19:49:58 -04002790 BdrvDirtyBitmap *bmap = NULL;
John Snow7b0b8702019-07-29 16:35:52 -04002791 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002792
Pavel Butsykin81206a82016-07-22 11:17:50 +03002793 if (!backup->has_speed) {
2794 backup->speed = 0;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002795 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002796 if (!backup->has_on_source_error) {
2797 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002798 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002799 if (!backup->has_on_target_error) {
2800 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002801 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002802 if (!backup->has_job_id) {
2803 backup->job_id = NULL;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002804 }
John Snowb40dacd2018-03-10 03:27:44 -05002805 if (!backup->has_auto_finalize) {
2806 backup->auto_finalize = true;
2807 }
2808 if (!backup->has_auto_dismiss) {
2809 backup->auto_dismiss = true;
2810 }
Pavel Butsykin13b94142016-07-22 11:17:52 +03002811 if (!backup->has_compress) {
2812 backup->compress = false;
2813 }
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002814
John Snowa6c93652019-07-29 16:35:55 -04002815 if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2816 (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2817 /* done before desugaring 'incremental' to print the right message */
2818 if (!backup->has_bitmap) {
2819 error_setg(errp, "must provide a valid bitmap name for "
2820 "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2821 return NULL;
2822 }
2823 }
2824
John Snowc8b56502019-07-29 16:35:52 -04002825 if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2826 if (backup->has_bitmap_mode &&
2827 backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2828 error_setg(errp, "Bitmap sync mode must be '%s' "
2829 "when using sync mode '%s'",
2830 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2831 MirrorSyncMode_str(backup->sync));
2832 return NULL;
2833 }
2834 backup->has_bitmap_mode = true;
2835 backup->sync = MIRROR_SYNC_MODE_BITMAP;
2836 backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2837 }
2838
John Snow7b0b8702019-07-29 16:35:52 -04002839 if (backup->has_bitmap) {
2840 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2841 if (!bmap) {
2842 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2843 return NULL;
2844 }
John Snowc8b56502019-07-29 16:35:52 -04002845 if (!backup->has_bitmap_mode) {
2846 error_setg(errp, "Bitmap sync mode must be given "
2847 "when providing a bitmap");
2848 return NULL;
2849 }
John Snowb30ffbe2019-07-29 16:35:54 -04002850 if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snow7b0b8702019-07-29 16:35:52 -04002851 return NULL;
2852 }
John Snow1a2b8b42019-07-29 16:35:55 -04002853
2854 /* This does not produce a useful bitmap artifact: */
2855 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2856 error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2857 " outputs", MirrorSyncMode_str(backup->sync));
2858 return NULL;
2859 }
2860
2861 /* If the bitmap isn't used for input or output, this is useless: */
2862 if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2863 backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2864 error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2865 " when combined with sync mode '%s'",
2866 BitmapSyncMode_str(backup->bitmap_mode),
2867 MirrorSyncMode_str(backup->sync));
2868 return NULL;
2869 }
2870 }
2871
2872 if (!backup->has_bitmap && backup->has_bitmap_mode) {
2873 error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2874 return NULL;
John Snow7b0b8702019-07-29 16:35:52 -04002875 }
2876
2877 if (!backup->auto_finalize) {
2878 job_flags |= JOB_MANUAL_FINALIZE;
2879 }
2880 if (!backup->auto_dismiss) {
2881 job_flags |= JOB_MANUAL_DISMISS;
2882 }
2883
2884 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
John Snowc8b56502019-07-29 16:35:52 -04002885 backup->sync, bmap, backup->bitmap_mode,
2886 backup->compress,
Vladimir Sementsov-Ogievskiy00e30f02019-10-01 16:14:09 +03002887 backup->filter_node_name,
John Snowc8b56502019-07-29 16:35:52 -04002888 backup->on_source_error,
2889 backup->on_target_error,
John Snow7b0b8702019-07-29 16:35:52 -04002890 job_flags, NULL, NULL, txn, errp);
2891 return job;
2892}
2893
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002894void qmp_drive_backup(DriveBackup *backup, Error **errp)
John Snow7b0b8702019-07-29 16:35:52 -04002895{
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002896 TransactionAction action = {
2897 .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2898 .u.drive_backup.data = backup,
2899 };
2900 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002901}
2902
Peter Krempafacda542020-01-20 09:50:49 +01002903BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2904 bool flat,
2905 Error **errp)
Benoît Canetc13163f2014-01-23 21:31:34 +01002906{
Peter Krempafacda542020-01-20 09:50:49 +01002907 bool return_flat = has_flat && flat;
2908
2909 return bdrv_named_nodes_list(return_flat, errp);
Benoît Canetc13163f2014-01-23 21:31:34 +01002910}
2911
Vladimir Sementsov-Ogievskiy5d3b4e92018-12-21 20:09:07 +03002912XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2913{
2914 return bdrv_get_xdbg_block_graph(errp);
2915}
2916
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002917void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
Fam Zhengc29c1dd2014-12-18 18:37:05 +08002918{
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002919 TransactionAction action = {
2920 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2921 .u.blockdev_backup.data = backup,
2922 };
2923 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002924}
2925
Fam Zheng4193cdd2015-12-24 12:45:03 +08002926/* Parameter check and block job starting for drive mirroring.
2927 * Caller should hold @device and @target's aio context (must be the same).
2928 **/
Alberto Garcia71aa9862016-07-05 17:28:57 +03002929static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002930 BlockDriverState *target,
2931 bool has_replaces, const char *replaces,
2932 enum MirrorSyncMode sync,
Max Reitz274fcce2016-06-10 20:57:47 +02002933 BlockMirrorBackingMode backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02002934 bool zero_target,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002935 bool has_speed, int64_t speed,
2936 bool has_granularity, uint32_t granularity,
2937 bool has_buf_size, int64_t buf_size,
2938 bool has_on_source_error,
2939 BlockdevOnError on_source_error,
2940 bool has_on_target_error,
2941 BlockdevOnError on_target_error,
2942 bool has_unmap, bool unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002943 bool has_filter_node_name,
2944 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02002945 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04002946 bool has_auto_finalize, bool auto_finalize,
2947 bool has_auto_dismiss, bool auto_dismiss,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002948 Error **errp)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002949{
Max Reitz3f072a72019-06-12 16:27:32 +02002950 BlockDriverState *unfiltered_bs;
John Snowa1999b32018-09-06 09:02:11 -04002951 int job_flags = JOB_DEFAULT;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002952
2953 if (!has_speed) {
2954 speed = 0;
2955 }
Paolo Bonzinib952b552012-10-18 16:49:28 +02002956 if (!has_on_source_error) {
2957 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2958 }
2959 if (!has_on_target_error) {
2960 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2961 }
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002962 if (!has_granularity) {
2963 granularity = 0;
2964 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002965 if (!has_buf_size) {
Wen Congyang48ac0a42015-05-15 15:51:36 +08002966 buf_size = 0;
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002967 }
Fam Zheng0fc9f8e2015-06-08 13:56:08 +08002968 if (!has_unmap) {
2969 unmap = true;
2970 }
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002971 if (!has_filter_node_name) {
2972 filter_node_name = NULL;
2973 }
Max Reitz481deba2018-06-13 20:18:22 +02002974 if (!has_copy_mode) {
2975 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
2976 }
John Snowa6b58ad2018-09-06 09:02:22 -04002977 if (has_auto_finalize && !auto_finalize) {
2978 job_flags |= JOB_MANUAL_FINALIZE;
2979 }
2980 if (has_auto_dismiss && !auto_dismiss) {
2981 job_flags |= JOB_MANUAL_DISMISS;
2982 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002983
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002984 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002985 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2986 "a value in range [512B, 64MB]");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002987 return;
2988 }
2989 if (granularity & (granularity - 1)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002990 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2991 "power of 2");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002992 return;
2993 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002994
Fam Zheng4193cdd2015-12-24 12:45:03 +08002995 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
2996 return;
2997 }
Fam Zhenge40e5022015-12-24 12:45:04 +08002998 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
2999 return;
3000 }
Fam Zheng4193cdd2015-12-24 12:45:03 +08003001
Max Reitz3f072a72019-06-12 16:27:32 +02003002 if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
Fam Zheng4193cdd2015-12-24 12:45:03 +08003003 sync = MIRROR_SYNC_MODE_FULL;
3004 }
3005
Max Reitz3f072a72019-06-12 16:27:32 +02003006 if (!has_replaces) {
3007 /* We want to mirror from @bs, but keep implicit filters on top */
3008 unfiltered_bs = bdrv_skip_implicit_filters(bs);
3009 if (unfiltered_bs != bs) {
3010 replaces = unfiltered_bs->node_name;
3011 has_replaces = true;
3012 }
3013 }
3014
Max Reitz74ce9e42019-02-13 23:53:01 +01003015 if (has_replaces) {
3016 BlockDriverState *to_replace_bs;
3017 AioContext *replace_aio_context;
3018 int64_t bs_size, replace_size;
3019
3020 bs_size = bdrv_getlength(bs);
3021 if (bs_size < 0) {
3022 error_setg_errno(errp, -bs_size, "Failed to query device's size");
3023 return;
3024 }
3025
3026 to_replace_bs = check_to_replace_node(bs, replaces, errp);
3027 if (!to_replace_bs) {
3028 return;
3029 }
3030
3031 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3032 aio_context_acquire(replace_aio_context);
3033 replace_size = bdrv_getlength(to_replace_bs);
3034 aio_context_release(replace_aio_context);
3035
3036 if (replace_size < 0) {
3037 error_setg_errno(errp, -replace_size,
3038 "Failed to query the replacement node's size");
3039 return;
3040 }
3041 if (bs_size != replace_size) {
3042 error_setg(errp, "cannot replace image with a mirror image of "
3043 "different size");
3044 return;
3045 }
3046 }
3047
Fam Zheng4193cdd2015-12-24 12:45:03 +08003048 /* pass the node name to replace to mirror start since it's loose coupling
3049 * and will allow to check whether the node still exist at mirror completion
3050 */
Alberto Garcia71aa9862016-07-05 17:28:57 +03003051 mirror_start(job_id, bs, target,
John Snowa1999b32018-09-06 09:02:11 -04003052 has_replaces ? replaces : NULL, job_flags,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003053 speed, granularity, buf_size, sync, backing_mode, zero_target,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003054 on_source_error, on_target_error, unmap, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003055 copy_mode, errp);
Fam Zheng4193cdd2015-12-24 12:45:03 +08003056}
3057
Eric Blakefaecd402016-07-14 16:37:58 -06003058void qmp_drive_mirror(DriveMirror *arg, Error **errp)
Fam Zheng4193cdd2015-12-24 12:45:03 +08003059{
3060 BlockDriverState *bs;
Max Reitz3f072a72019-06-12 16:27:32 +02003061 BlockDriverState *target_backing_bs, *target_bs;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003062 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003063 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003064 BlockMirrorBackingMode backing_mode;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003065 Error *local_err = NULL;
3066 QDict *options = NULL;
3067 int flags;
3068 int64_t size;
Eric Blakefaecd402016-07-14 16:37:58 -06003069 const char *format = arg->format;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003070 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003071 int ret;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003072
Kevin Wolf0524e932016-06-23 14:20:24 +02003073 bs = qmp_get_root_bs(arg->device, errp);
3074 if (!bs) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003075 return;
3076 }
3077
Paolo Bonzinicb2af912018-02-07 17:29:20 +01003078 /* Early check to avoid creating target */
3079 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3080 return;
3081 }
3082
Kevin Wolf0524e932016-06-23 14:20:24 +02003083 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003084 aio_context_acquire(aio_context);
3085
Eric Blakefaecd402016-07-14 16:37:58 -06003086 if (!arg->has_mode) {
3087 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003088 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003089
Eric Blakefaecd402016-07-14 16:37:58 -06003090 if (!arg->has_format) {
3091 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3092 ? NULL : bs->drv->format_name);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003093 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003094
Kevin Wolf61de4c62016-03-18 17:46:45 +01003095 flags = bs->open_flags | BDRV_O_RDWR;
Max Reitz3f072a72019-06-12 16:27:32 +02003096 target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
3097 if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
Eric Blakefaecd402016-07-14 16:37:58 -06003098 arg->sync = MIRROR_SYNC_MODE_FULL;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003099 }
Eric Blakefaecd402016-07-14 16:37:58 -06003100 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
Max Reitz3f072a72019-06-12 16:27:32 +02003101 target_backing_bs = bs;
Max Reitz117e0c82013-11-25 20:28:55 +01003102 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003103
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003104 size = bdrv_getlength(bs);
3105 if (size < 0) {
3106 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003107 goto out;
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003108 }
3109
Eric Blakefaecd402016-07-14 16:37:58 -06003110 if (arg->has_replaces) {
Eric Blakefaecd402016-07-14 16:37:58 -06003111 if (!arg->has_node_name) {
Benoît Canet09158f02014-06-27 18:25:25 +02003112 error_setg(errp, "a node-name must be provided when replacing a"
3113 " named node of the graph");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003114 goto out;
Benoît Canet09158f02014-06-27 18:25:25 +02003115 }
Benoît Canet09158f02014-06-27 18:25:25 +02003116 }
3117
Eric Blakefaecd402016-07-14 16:37:58 -06003118 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
Max Reitz274fcce2016-06-10 20:57:47 +02003119 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3120 } else {
3121 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3122 }
3123
John Snow2a32c6e2017-07-17 20:34:21 -04003124 /* Don't open backing image in create() */
3125 flags |= BDRV_O_NO_BACKING;
3126
Max Reitz3f072a72019-06-12 16:27:32 +02003127 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
Eric Blakefaecd402016-07-14 16:37:58 -06003128 && arg->mode != NEW_IMAGE_MODE_EXISTING)
Max Reitz14526862013-11-06 19:50:44 +01003129 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003130 /* create new image w/o backing file */
Max Reitze6641712015-08-26 19:47:48 +02003131 assert(format);
Eric Blakefaecd402016-07-14 16:37:58 -06003132 bdrv_img_create(arg->target, format,
Fam Zheng92172832017-04-21 20:27:01 +08003133 NULL, NULL, NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003134 } else {
Max Reitz3f072a72019-06-12 16:27:32 +02003135 /* Implicit filters should not appear in the filename */
3136 BlockDriverState *explicit_backing =
3137 bdrv_skip_implicit_filters(target_backing_bs);
3138
Eric Blakefaecd402016-07-14 16:37:58 -06003139 switch (arg->mode) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003140 case NEW_IMAGE_MODE_EXISTING:
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003141 break;
3142 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3143 /* create new image with backing file */
Max Reitz3f072a72019-06-12 16:27:32 +02003144 bdrv_refresh_filename(explicit_backing);
Eric Blakefaecd402016-07-14 16:37:58 -06003145 bdrv_img_create(arg->target, format,
Max Reitz3f072a72019-06-12 16:27:32 +02003146 explicit_backing->filename,
3147 explicit_backing->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08003148 NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003149 break;
3150 default:
3151 abort();
3152 }
3153 }
3154
Markus Armbruster84d18f02014-01-30 15:07:28 +01003155 if (local_err) {
Luiz Capitulinocf8f2422012-11-30 10:52:08 -02003156 error_propagate(errp, local_err);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003157 goto out;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003158 }
3159
Max Reitze6641712015-08-26 19:47:48 +02003160 options = qdict_new();
Eric Blakefaecd402016-07-14 16:37:58 -06003161 if (arg->has_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003162 qdict_put_str(options, "node-name", arg->node_name);
Benoît Canet4c828dc2014-06-16 12:00:55 +02003163 }
Max Reitze6641712015-08-26 19:47:48 +02003164 if (format) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003165 qdict_put_str(options, "driver", format);
Max Reitze6641712015-08-26 19:47:48 +02003166 }
Benoît Canet4c828dc2014-06-16 12:00:55 +02003167
Paolo Bonzinib812f672013-01-21 17:09:43 +01003168 /* Mirroring takes care of copy-on-write using the source's backing
3169 * file.
3170 */
John Snow2a32c6e2017-07-17 20:34:21 -04003171 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
Max Reitz5b363932016-05-17 16:41:31 +02003172 if (!target_bs) {
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003173 goto out;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003174 }
3175
Max Reitzcdf3bc92019-07-24 19:12:30 +02003176 zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3177 (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3178 !bdrv_has_zero_init(target_bs)));
3179
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003180
3181 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3182 old_context = bdrv_get_aio_context(target_bs);
3183 aio_context_release(aio_context);
3184 aio_context_acquire(old_context);
3185
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003186 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3187 if (ret < 0) {
3188 bdrv_unref(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003189 aio_context_release(old_context);
3190 return;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003191 }
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003192
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003193 aio_context_release(old_context);
3194 aio_context_acquire(aio_context);
3195
Eric Blakefaecd402016-07-14 16:37:58 -06003196 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3197 arg->has_replaces, arg->replaces, arg->sync,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003198 backing_mode, zero_target,
3199 arg->has_speed, arg->speed,
Eric Blakefaecd402016-07-14 16:37:58 -06003200 arg->has_granularity, arg->granularity,
3201 arg->has_buf_size, arg->buf_size,
3202 arg->has_on_source_error, arg->on_source_error,
3203 arg->has_on_target_error, arg->on_target_error,
3204 arg->has_unmap, arg->unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003205 false, NULL,
Max Reitz481deba2018-06-13 20:18:22 +02003206 arg->has_copy_mode, arg->copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003207 arg->has_auto_finalize, arg->auto_finalize,
3208 arg->has_auto_dismiss, arg->auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003209 errp);
Kevin Wolfe253f4b2016-04-12 16:17:41 +02003210 bdrv_unref(target_bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003211out:
3212 aio_context_release(aio_context);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003213}
3214
Alberto Garcia71aa9862016-07-05 17:28:57 +03003215void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3216 const char *device, const char *target,
Fam Zhengdf925622015-12-24 12:45:05 +08003217 bool has_replaces, const char *replaces,
3218 MirrorSyncMode sync,
3219 bool has_speed, int64_t speed,
3220 bool has_granularity, uint32_t granularity,
3221 bool has_buf_size, int64_t buf_size,
3222 bool has_on_source_error,
3223 BlockdevOnError on_source_error,
3224 bool has_on_target_error,
3225 BlockdevOnError on_target_error,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003226 bool has_filter_node_name,
3227 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003228 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003229 bool has_auto_finalize, bool auto_finalize,
3230 bool has_auto_dismiss, bool auto_dismiss,
Fam Zhengdf925622015-12-24 12:45:05 +08003231 Error **errp)
3232{
3233 BlockDriverState *bs;
Fam Zhengdf925622015-12-24 12:45:05 +08003234 BlockDriverState *target_bs;
3235 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003236 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003237 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003238 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003239 int ret;
Fam Zhengdf925622015-12-24 12:45:05 +08003240
Kevin Wolf07eec652016-06-23 14:20:24 +02003241 bs = qmp_get_root_bs(device, errp);
Fam Zhengdf925622015-12-24 12:45:05 +08003242 if (!bs) {
Fam Zhengdf925622015-12-24 12:45:05 +08003243 return;
3244 }
3245
3246 target_bs = bdrv_lookup_bs(target, target, errp);
3247 if (!target_bs) {
3248 return;
3249 }
3250
Max Reitzcdf3bc92019-07-24 19:12:30 +02003251 zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3252
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003253 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3254 old_context = bdrv_get_aio_context(target_bs);
Fam Zhengdf925622015-12-24 12:45:05 +08003255 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003256 aio_context_acquire(old_context);
Fam Zhengdf925622015-12-24 12:45:05 +08003257
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003258 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003259
3260 aio_context_release(old_context);
3261 aio_context_acquire(aio_context);
3262
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003263 if (ret < 0) {
3264 goto out;
3265 }
Fam Zhengdf925622015-12-24 12:45:05 +08003266
Alberto Garcia71aa9862016-07-05 17:28:57 +03003267 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
Max Reitz274fcce2016-06-10 20:57:47 +02003268 has_replaces, replaces, sync, backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003269 zero_target, has_speed, speed,
Fam Zhengdf925622015-12-24 12:45:05 +08003270 has_granularity, granularity,
3271 has_buf_size, buf_size,
3272 has_on_source_error, on_source_error,
3273 has_on_target_error, on_target_error,
3274 true, true,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003275 has_filter_node_name, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003276 has_copy_mode, copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003277 has_auto_finalize, auto_finalize,
3278 has_auto_dismiss, auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003279 errp);
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003280out:
Fam Zhengdf925622015-12-24 12:45:05 +08003281 aio_context_release(aio_context);
3282}
3283
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003284/* Get a block job using its ID and acquire its AioContext */
3285static BlockJob *find_block_job(const char *id, AioContext **aio_context,
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003286 Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003287{
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003288 BlockJob *job;
3289
3290 assert(id != NULL);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003291
Max Reitz5433c242015-10-19 17:53:29 +02003292 *aio_context = NULL;
3293
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003294 job = block_job_get(id);
3295
3296 if (!job) {
3297 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3298 "Block job '%s' not found", id);
3299 return NULL;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003300 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003301
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003302 *aio_context = blk_get_aio_context(job->blk);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003303 aio_context_acquire(*aio_context);
3304
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003305 return job;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003306}
3307
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003308void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003309{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003310 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003311 BlockJob *job = find_block_job(device, &aio_context, errp);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003312
3313 if (!job) {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003314 return;
3315 }
3316
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003317 block_job_set_speed(job, speed, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003318 aio_context_release(aio_context);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003319}
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003320
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003321void qmp_block_job_cancel(const char *device,
3322 bool has_force, bool force, Error **errp)
3323{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003324 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003325 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003326
3327 if (!job) {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003328 return;
3329 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003330
3331 if (!has_force) {
3332 force = false;
3333 }
3334
Kevin Wolfb15de822018-04-18 17:10:26 +02003335 if (job_user_paused(&job->job) && !force) {
Cole Robinsonf231b882014-03-21 19:42:26 -04003336 error_setg(errp, "The block job for device '%s' is currently paused",
3337 device);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003338 goto out;
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003339 }
3340
3341 trace_qmp_block_job_cancel(job);
Kevin Wolf3d70ff52018-04-24 16:13:52 +02003342 job_user_cancel(&job->job, force, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003343out:
3344 aio_context_release(aio_context);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003345}
3346
3347void qmp_block_job_pause(const char *device, Error **errp)
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003348{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003349 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003350 BlockJob *job = find_block_job(device, &aio_context, errp);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003351
John Snow0ec4dfb2018-03-10 03:27:32 -05003352 if (!job) {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003353 return;
3354 }
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003355
3356 trace_qmp_block_job_pause(job);
Kevin Wolfb15de822018-04-18 17:10:26 +02003357 job_user_pause(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003358 aio_context_release(aio_context);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003359}
3360
3361void qmp_block_job_resume(const char *device, Error **errp)
3362{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003363 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003364 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003365
John Snow0ec4dfb2018-03-10 03:27:32 -05003366 if (!job) {
Paolo Bonzini8acc72a2012-09-28 17:22:50 +02003367 return;
3368 }
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003369
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003370 trace_qmp_block_job_resume(job);
Kevin Wolfb15de822018-04-18 17:10:26 +02003371 job_user_resume(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003372 aio_context_release(aio_context);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003373}
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003374
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003375void qmp_block_job_complete(const char *device, Error **errp)
3376{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003377 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003378 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003379
3380 if (!job) {
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003381 return;
3382 }
3383
3384 trace_qmp_block_job_complete(job);
Kevin Wolf3453d972018-04-23 12:24:16 +02003385 job_complete(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003386 aio_context_release(aio_context);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003387}
3388
John Snow11b61fb2018-03-10 03:27:43 -05003389void qmp_block_job_finalize(const char *id, Error **errp)
3390{
3391 AioContext *aio_context;
3392 BlockJob *job = find_block_job(id, &aio_context, errp);
3393
3394 if (!job) {
3395 return;
3396 }
3397
3398 trace_qmp_block_job_finalize(job);
Stefan Reiterb660a842020-04-07 13:56:49 +02003399 job_ref(&job->job);
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02003400 job_finalize(&job->job, errp);
Stefan Reiterb660a842020-04-07 13:56:49 +02003401
3402 /*
3403 * Job's context might have changed via job_finalize (and job_txn_apply
3404 * automatically acquires the new one), so make sure we release the correct
3405 * one.
3406 */
3407 aio_context = blk_get_aio_context(job->blk);
3408 job_unref(&job->job);
John Snow11b61fb2018-03-10 03:27:43 -05003409 aio_context_release(aio_context);
3410}
3411
John Snow75f71052018-03-10 03:27:36 -05003412void qmp_block_job_dismiss(const char *id, Error **errp)
3413{
3414 AioContext *aio_context;
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003415 BlockJob *bjob = find_block_job(id, &aio_context, errp);
3416 Job *job;
John Snow75f71052018-03-10 03:27:36 -05003417
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003418 if (!bjob) {
John Snow75f71052018-03-10 03:27:36 -05003419 return;
3420 }
3421
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003422 trace_qmp_block_job_dismiss(bjob);
3423 job = &bjob->job;
3424 job_dismiss(&job, errp);
John Snow75f71052018-03-10 03:27:36 -05003425 aio_context_release(aio_context);
3426}
3427
Jeff Codyfa40e652014-07-01 09:52:16 +02003428void qmp_change_backing_file(const char *device,
3429 const char *image_node_name,
3430 const char *backing_file,
3431 Error **errp)
3432{
3433 BlockDriverState *bs = NULL;
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003434 AioContext *aio_context;
Jeff Codyfa40e652014-07-01 09:52:16 +02003435 BlockDriverState *image_bs = NULL;
3436 Error *local_err = NULL;
3437 bool ro;
Jeff Codyfa40e652014-07-01 09:52:16 +02003438 int ret;
3439
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003440 bs = qmp_get_root_bs(device, errp);
3441 if (!bs) {
Jeff Codyfa40e652014-07-01 09:52:16 +02003442 return;
3443 }
3444
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003445 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003446 aio_context_acquire(aio_context);
3447
Jeff Codyfa40e652014-07-01 09:52:16 +02003448 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3449 if (local_err) {
3450 error_propagate(errp, local_err);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003451 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003452 }
3453
3454 if (!image_bs) {
3455 error_setg(errp, "image file not found");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003456 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003457 }
3458
3459 if (bdrv_find_base(image_bs) == image_bs) {
3460 error_setg(errp, "not allowing backing file change on an image "
3461 "without a backing file");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003462 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003463 }
3464
3465 /* even though we are not necessarily operating on bs, we need it to
3466 * determine if block ops are currently prohibited on the chain */
3467 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003468 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003469 }
3470
3471 /* final sanity check */
3472 if (!bdrv_chain_contains(bs, image_bs)) {
3473 error_setg(errp, "'%s' and image file are not in the same chain",
3474 device);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003475 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003476 }
3477
3478 /* if not r/w, reopen to make r/w */
Jeff Codyfa40e652014-07-01 09:52:16 +02003479 ro = bdrv_is_read_only(image_bs);
3480
3481 if (ro) {
Alberto Garcia051a60f2018-11-12 16:00:38 +02003482 if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003483 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003484 }
3485 }
3486
3487 ret = bdrv_change_backing_file(image_bs, backing_file,
Eric Blakee54ee1b2020-07-06 15:39:53 -05003488 image_bs->drv ? image_bs->drv->format_name : "",
3489 false);
Jeff Codyfa40e652014-07-01 09:52:16 +02003490
3491 if (ret < 0) {
3492 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3493 backing_file);
3494 /* don't exit here, so we can try to restore open flags if
3495 * appropriate */
3496 }
3497
3498 if (ro) {
Markus Armbruster992861f2020-07-07 18:06:04 +02003499 bdrv_reopen_set_read_only(image_bs, true, errp);
Jeff Codyfa40e652014-07-01 09:52:16 +02003500 }
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003501
3502out:
3503 aio_context_release(aio_context);
Jeff Codyfa40e652014-07-01 09:52:16 +02003504}
3505
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003506void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3507{
Max Reitzbe4b67b2015-10-19 17:53:09 +02003508 BlockDriverState *bs;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003509 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01003510 Visitor *v = qobject_output_visitor_new(&obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003511 QDict *qdict;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003512
Markus Armbruster1f584242020-04-24 10:43:35 +02003513 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
Eric Blake3b098d52016-06-09 10:48:43 -06003514 visit_complete(v, &obj);
Max Reitz7dc847e2018-02-24 16:40:29 +01003515 qdict = qobject_to(QDict, obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003516
3517 qdict_flatten(qdict);
3518
Kevin Wolf9ec88732016-09-21 14:56:11 +02003519 if (!qdict_get_try_str(qdict, "node-name")) {
3520 error_setg(errp, "'node-name' must be specified for the root node");
3521 goto fail;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003522 }
3523
Kevin Wolf9ec88732016-09-21 14:56:11 +02003524 bs = bds_tree_init(qdict, errp);
3525 if (!bs) {
3526 goto fail;
3527 }
3528
Maxim Levitsky89802d52020-03-08 11:24:40 +02003529 bdrv_set_monitor_owned(bs);
Kevin Wolf9ec88732016-09-21 14:56:11 +02003530
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003531fail:
Eric Blake3b098d52016-06-09 10:48:43 -06003532 visit_free(v);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003533}
3534
Alberto Garcia1479c732019-03-12 18:48:51 +02003535void qmp_x_blockdev_reopen(BlockdevOptions *options, Error **errp)
3536{
3537 BlockDriverState *bs;
3538 AioContext *ctx;
3539 QObject *obj;
3540 Visitor *v = qobject_output_visitor_new(&obj);
Alberto Garcia1479c732019-03-12 18:48:51 +02003541 BlockReopenQueue *queue;
3542 QDict *qdict;
3543
3544 /* Check for the selected node name */
3545 if (!options->has_node_name) {
3546 error_setg(errp, "Node name not specified");
3547 goto fail;
3548 }
3549
3550 bs = bdrv_find_node(options->node_name);
3551 if (!bs) {
3552 error_setg(errp, "Cannot find node named '%s'", options->node_name);
3553 goto fail;
3554 }
3555
3556 /* Put all options in a QDict and flatten it */
Markus Armbruster1f584242020-04-24 10:43:35 +02003557 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
Alberto Garcia1479c732019-03-12 18:48:51 +02003558 visit_complete(v, &obj);
3559 qdict = qobject_to(QDict, obj);
3560
3561 qdict_flatten(qdict);
3562
3563 /* Perform the reopen operation */
3564 ctx = bdrv_get_aio_context(bs);
3565 aio_context_acquire(ctx);
3566 bdrv_subtree_drained_begin(bs);
3567 queue = bdrv_reopen_queue(NULL, bs, qdict, false);
3568 bdrv_reopen_multiple(queue, errp);
3569 bdrv_subtree_drained_end(bs);
3570 aio_context_release(ctx);
3571
3572fail:
3573 visit_free(v);
3574}
3575
Markus Armbruster79b7a772017-03-21 17:53:28 +01003576void qmp_blockdev_del(const char *node_name, Error **errp)
Alberto Garcia81b936a2015-11-02 16:51:55 +02003577{
3578 AioContext *aio_context;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003579 BlockDriverState *bs;
3580
Kevin Wolf9ec88732016-09-21 14:56:11 +02003581 bs = bdrv_find_node(node_name);
3582 if (!bs) {
3583 error_setg(errp, "Cannot find node %s", node_name);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003584 return;
3585 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003586 if (bdrv_has_blk(bs)) {
3587 error_setg(errp, "Node %s is in use", node_name);
3588 return;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003589 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003590 aio_context = bdrv_get_aio_context(bs);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003591 aio_context_acquire(aio_context);
3592
Kevin Wolf9ec88732016-09-21 14:56:11 +02003593 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3594 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003595 }
3596
Paolo Bonzini70537ed2018-12-06 23:00:09 +01003597 if (!QTAILQ_IN_USE(bs, monitor_list)) {
Kevin Wolf9ec88732016-09-21 14:56:11 +02003598 error_setg(errp, "Node %s is not owned by the monitor",
3599 bs->node_name);
3600 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003601 }
3602
Kevin Wolf9ec88732016-09-21 14:56:11 +02003603 if (bs->refcnt > 1) {
3604 error_setg(errp, "Block device %s is in use",
3605 bdrv_get_device_or_node_name(bs));
3606 goto out;
3607 }
3608
3609 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3610 bdrv_unref(bs);
3611
Alberto Garcia81b936a2015-11-02 16:51:55 +02003612out:
3613 aio_context_release(aio_context);
3614}
3615
Wen Congyang7f821592016-05-10 15:36:39 +08003616static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3617 const char *child_name)
3618{
3619 BdrvChild *child;
3620
3621 QLIST_FOREACH(child, &parent_bs->children, next) {
3622 if (strcmp(child->name, child_name) == 0) {
3623 return child;
3624 }
3625 }
3626
3627 return NULL;
3628}
3629
3630void qmp_x_blockdev_change(const char *parent, bool has_child,
3631 const char *child, bool has_node,
3632 const char *node, Error **errp)
3633{
3634 BlockDriverState *parent_bs, *new_bs = NULL;
3635 BdrvChild *p_child;
3636
3637 parent_bs = bdrv_lookup_bs(parent, parent, errp);
3638 if (!parent_bs) {
3639 return;
3640 }
3641
3642 if (has_child == has_node) {
3643 if (has_child) {
3644 error_setg(errp, "The parameters child and node are in conflict");
3645 } else {
3646 error_setg(errp, "Either child or node must be specified");
3647 }
3648 return;
3649 }
3650
3651 if (has_child) {
3652 p_child = bdrv_find_child(parent_bs, child);
3653 if (!p_child) {
3654 error_setg(errp, "Node '%s' does not have child '%s'",
3655 parent, child);
3656 return;
3657 }
3658 bdrv_del_child(parent_bs, p_child, errp);
3659 }
3660
3661 if (has_node) {
3662 new_bs = bdrv_find_node(node);
3663 if (!new_bs) {
3664 error_setg(errp, "Node '%s' not found", node);
3665 return;
3666 }
3667 bdrv_add_child(parent_bs, new_bs, errp);
3668 }
3669}
3670
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003671BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3672{
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003673 BlockJobInfoList *head = NULL, **p_next = &head;
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003674 BlockJob *job;
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003675
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003676 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
John Snow559b9352016-10-27 12:06:55 -04003677 BlockJobInfoList *elem;
3678 AioContext *aio_context;
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003679
John Snow559b9352016-10-27 12:06:55 -04003680 if (block_job_is_internal(job)) {
3681 continue;
3682 }
3683 elem = g_new0(BlockJobInfoList, 1);
3684 aio_context = blk_get_aio_context(job->blk);
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003685 aio_context_acquire(aio_context);
John Snow559b9352016-10-27 12:06:55 -04003686 elem->value = block_job_query(job, errp);
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003687 aio_context_release(aio_context);
John Snow559b9352016-10-27 12:06:55 -04003688 if (!elem->value) {
3689 g_free(elem);
3690 qapi_free_BlockJobInfoList(head);
3691 return NULL;
3692 }
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003693 *p_next = elem;
3694 p_next = &elem->next;
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003695 }
3696
3697 return head;
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003698}
Paolo Bonzini4d454572012-11-26 16:03:42 +01003699
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003700void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003701 bool has_force, bool force, Error **errp)
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003702{
3703 AioContext *old_context;
3704 AioContext *new_context;
3705 BlockDriverState *bs;
3706
3707 bs = bdrv_find_node(node_name);
3708 if (!bs) {
3709 error_setg(errp, "Cannot find node %s", node_name);
3710 return;
3711 }
3712
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003713 /* Protects against accidents. */
3714 if (!(has_force && force) && bdrv_has_blk(bs)) {
3715 error_setg(errp, "Node %s is associated with a BlockBackend and could "
3716 "be in use (use force=true to override this check)",
3717 node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003718 return;
3719 }
3720
3721 if (iothread->type == QTYPE_QSTRING) {
3722 IOThread *obj = iothread_by_id(iothread->u.s);
3723 if (!obj) {
3724 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3725 return;
3726 }
3727
3728 new_context = iothread_get_aio_context(obj);
3729 } else {
3730 new_context = qemu_get_aio_context();
3731 }
3732
3733 old_context = bdrv_get_aio_context(bs);
3734 aio_context_acquire(old_context);
3735
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003736 bdrv_try_set_aio_context(bs, new_context, errp);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003737
3738 aio_context_release(old_context);
3739}
3740
Kevin Wolf00063832013-03-15 10:35:07 +01003741QemuOptsList qemu_common_drive_opts = {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003742 .name = "drive",
Kevin Wolf00063832013-03-15 10:35:07 +01003743 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
Paolo Bonzini4d454572012-11-26 16:03:42 +01003744 .desc = {
3745 {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003746 .name = "snapshot",
3747 .type = QEMU_OPT_BOOL,
3748 .help = "enable/disable snapshot mode",
3749 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003750 .name = "aio",
3751 .type = QEMU_OPT_STRING,
Aarushi Mehtaf80f2672020-01-20 14:18:50 +00003752 .help = "host AIO implementation (threads, native, io_uring)",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003753 },{
Kevin Wolfe4b24b42016-03-15 15:39:42 +01003754 .name = BDRV_OPT_CACHE_WB,
3755 .type = QEMU_OPT_BOOL,
3756 .help = "Enable writeback mode",
3757 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003758 .name = "format",
3759 .type = QEMU_OPT_STRING,
3760 .help = "disk format (raw, qcow2, ...)",
3761 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003762 .name = "rerror",
3763 .type = QEMU_OPT_STRING,
3764 .help = "read error action",
3765 },{
3766 .name = "werror",
3767 .type = QEMU_OPT_STRING,
3768 .help = "write error action",
3769 },{
Alberto Garcia4e200cf2016-09-15 17:53:05 +03003770 .name = BDRV_OPT_READ_ONLY,
Paolo Bonzini4d454572012-11-26 16:03:42 +01003771 .type = QEMU_OPT_BOOL,
3772 .help = "open drive file as read-only",
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +01003773 },
3774
3775 THROTTLE_OPTS,
3776
3777 {
Alberto Garcia76f4afb2015-06-08 18:17:44 +02003778 .name = "throttling.group",
3779 .type = QEMU_OPT_STRING,
3780 .help = "name of the block throttling group",
3781 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003782 .name = "copy-on-read",
3783 .type = QEMU_OPT_BOOL,
3784 .help = "copy read data from backing file into image file",
Peter Lieven465bee12014-05-18 00:58:19 +02003785 },{
3786 .name = "detect-zeroes",
3787 .type = QEMU_OPT_STRING,
3788 .help = "try to optimize zero writes (off, on, unmap)",
Alberto Garcia362e9292015-10-28 17:33:04 +02003789 },{
3790 .name = "stats-account-invalid",
3791 .type = QEMU_OPT_BOOL,
3792 .help = "whether to account for invalid I/O operations "
3793 "in the statistics",
3794 },{
3795 .name = "stats-account-failed",
3796 .type = QEMU_OPT_BOOL,
3797 .help = "whether to account for failed I/O operations "
3798 "in the statistics",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003799 },
3800 { /* end of list */ }
3801 },
3802};
Kevin Wolf00063832013-03-15 10:35:07 +01003803
3804QemuOptsList qemu_drive_opts = {
3805 .name = "drive",
3806 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3807 .desc = {
Kevin Wolf492fdc62013-06-19 13:44:17 +02003808 /*
3809 * no elements => accept any params
3810 * validation will happen later
3811 */
Kevin Wolf00063832013-03-15 10:35:07 +01003812 { /* end of list */ }
3813 },
3814};