blob: 834c2304a1c60296c75ef6102c425fb4f5564d02 [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"
Markus Armbruster54d31232019-08-12 07:23:59 +020060#include "sysemu/runstate.h"
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +030061#include "sysemu/replay.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020062#include "qemu/cutils.h"
63#include "qemu/help_option.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020064#include "qemu/main-loop.h"
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +010065#include "qemu/throttle-options.h"
Markus Armbruster666daa62010-06-02 18:48:27 +020066
Maxim Levitsky89802d52020-03-08 11:24:40 +020067QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
Max Reitz9c4218e2016-01-29 16:36:12 +010068 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
69
Maxim Levitsky89802d52020-03-08 11:24:40 +020070void bdrv_set_monitor_owned(BlockDriverState *bs)
71{
72 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
73}
74
Markus Armbruster19609662011-01-28 11:21:39 +010075static const char *const if_name[IF_COUNT] = {
76 [IF_NONE] = "none",
77 [IF_IDE] = "ide",
78 [IF_SCSI] = "scsi",
79 [IF_FLOPPY] = "floppy",
80 [IF_PFLASH] = "pflash",
81 [IF_MTD] = "mtd",
82 [IF_SD] = "sd",
83 [IF_VIRTIO] = "virtio",
84 [IF_XEN] = "xen",
85};
86
John Snow21dff8c2014-10-01 14:19:25 -040087static int if_max_devs[IF_COUNT] = {
Markus Armbruster27d6bf42011-01-28 11:21:40 +010088 /*
89 * Do not change these numbers! They govern how drive option
90 * index maps to unit and bus. That mapping is ABI.
91 *
Wei Jiangang547cb152016-04-26 18:12:43 +080092 * All controllers used to implement if=T drives need to support
Markus Armbruster27d6bf42011-01-28 11:21:40 +010093 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
94 * Otherwise, some index values map to "impossible" bus, unit
95 * values.
96 *
97 * For instance, if you change [IF_SCSI] to 255, -drive
98 * if=scsi,index=12 no longer means bus=1,unit=5, but
99 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
100 * the drive can't be set up. Regression.
101 */
102 [IF_IDE] = 2,
103 [IF_SCSI] = 7,
Markus Armbruster19609662011-01-28 11:21:39 +0100104};
105
John Snow21dff8c2014-10-01 14:19:25 -0400106/**
107 * Boards may call this to offer board-by-board overrides
108 * of the default, global values.
109 */
110void override_max_devs(BlockInterfaceType type, int max_devs)
111{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200112 BlockBackend *blk;
John Snow21dff8c2014-10-01 14:19:25 -0400113 DriveInfo *dinfo;
114
115 if (max_devs <= 0) {
116 return;
117 }
118
Markus Armbruster18e46a02014-10-07 13:59:06 +0200119 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
120 dinfo = blk_legacy_dinfo(blk);
John Snow21dff8c2014-10-01 14:19:25 -0400121 if (dinfo->type == type) {
122 fprintf(stderr, "Cannot override units-per-bus property of"
123 " the %s interface, because a drive of that type has"
124 " already been added.\n", if_name[type]);
125 g_assert_not_reached();
126 }
127 }
128
129 if_max_devs[type] = max_devs;
130}
131
Markus Armbruster14bafc52010-06-25 08:09:10 +0200132/*
133 * We automatically delete the drive when a device using it gets
134 * unplugged. Questionable feature, but we can't just drop it.
135 * Device models call blockdev_mark_auto_del() to schedule the
136 * automatic deletion, and generic qdev code calls blockdev_auto_del()
137 * when deletion is actually safe.
138 */
Markus Armbruster4be74632014-10-07 13:59:18 +0200139void blockdev_mark_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200140{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200141 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300142 BlockJob *job;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200143
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200144 if (!dinfo) {
Kevin Wolf2d246f02013-09-18 15:14:47 +0200145 return;
146 }
147
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300148 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
149 if (block_job_has_bdrv(job, blk_bs(blk))) {
150 AioContext *aio_context = job->job.aio_context;
151 aio_context_acquire(aio_context);
Stefan Hajnoczi91fddb02014-10-21 12:03:52 +0100152
Vladimir Sementsov-Ogievskiy81641022019-06-06 18:41:31 +0300153 job_cancel(&job->job, false);
154
155 aio_context_release(aio_context);
Max Reitz5433c242015-10-19 17:53:29 +0200156 }
Paolo Bonzini12bde0e2012-03-30 13:17:10 +0200157 }
Stefan Hajnoczi91fddb02014-10-21 12:03:52 +0100158
Markus Armbruster26f8b3a2014-10-07 13:59:22 +0200159 dinfo->auto_del = 1;
Markus Armbruster14bafc52010-06-25 08:09:10 +0200160}
161
Markus Armbruster4be74632014-10-07 13:59:18 +0200162void blockdev_auto_del(BlockBackend *blk)
Markus Armbruster14bafc52010-06-25 08:09:10 +0200163{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200164 DriveInfo *dinfo = blk_legacy_dinfo(blk);
Markus Armbruster14bafc52010-06-25 08:09:10 +0200165
Ryan Harper0fc0f1f2010-12-08 10:05:00 -0600166 if (dinfo && dinfo->auto_del) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100167 monitor_remove_blk(blk);
Markus Armbrusterb9fe8a72014-10-07 13:59:09 +0200168 blk_unref(blk);
Markus Armbruster14bafc52010-06-25 08:09:10 +0200169 }
170}
171
John Snowd8f94e12014-10-01 14:19:27 -0400172/**
173 * Returns the current mapping of how many units per bus
174 * a particular interface can support.
175 *
176 * A positive integer indicates n units per bus.
177 * 0 implies the mapping has not been established.
178 * -1 indicates an invalid BlockInterfaceType was given.
179 */
180int drive_get_max_devs(BlockInterfaceType type)
181{
182 if (type >= IF_IDE && type < IF_COUNT) {
183 return if_max_devs[type];
184 }
185
186 return -1;
187}
188
Markus Armbruster505a7fb2011-01-28 11:21:43 +0100189static int drive_index_to_bus_id(BlockInterfaceType type, int index)
190{
191 int max_devs = if_max_devs[type];
192 return max_devs ? index / max_devs : 0;
193}
194
195static int drive_index_to_unit_id(BlockInterfaceType type, int index)
196{
197 int max_devs = if_max_devs[type];
198 return max_devs ? index % max_devs : index;
199}
200
Markus Armbruster2292dda2011-01-28 11:21:41 +0100201QemuOpts *drive_def(const char *optstr)
202{
Markus Armbruster70b94332015-02-13 12:50:26 +0100203 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100204}
205
206QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
Markus Armbruster5645b0f2011-01-31 11:50:09 +0100207 const char *optstr)
Markus Armbruster666daa62010-06-02 18:48:27 +0200208{
Markus Armbruster666daa62010-06-02 18:48:27 +0200209 QemuOpts *opts;
210
Markus Armbruster2292dda2011-01-28 11:21:41 +0100211 opts = drive_def(optstr);
Markus Armbruster666daa62010-06-02 18:48:27 +0200212 if (!opts) {
213 return NULL;
214 }
Markus Armbruster2292dda2011-01-28 11:21:41 +0100215 if (type != IF_DEFAULT) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100216 qemu_opt_set(opts, "if", if_name[type], &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100217 }
218 if (index >= 0) {
Markus Armbrustera8b18f82015-02-13 15:50:43 +0100219 qemu_opt_set_number(opts, "index", index, &error_abort);
Markus Armbruster2292dda2011-01-28 11:21:41 +0100220 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200221 if (file)
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100222 qemu_opt_set(opts, "file", file, &error_abort);
Markus Armbruster666daa62010-06-02 18:48:27 +0200223 return opts;
224}
225
226DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
227{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200228 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200229 DriveInfo *dinfo;
230
Markus Armbruster18e46a02014-10-07 13:59:06 +0200231 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
232 dinfo = blk_legacy_dinfo(blk);
233 if (dinfo && dinfo->type == type
234 && dinfo->bus == bus && dinfo->unit == unit) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200235 return dinfo;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200236 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200237 }
238
239 return NULL;
240}
241
Markus Armbrusterfe9f70a2021-03-09 17:12:13 +0100242/*
243 * Check board claimed all -drive that are meant to be claimed.
244 * Fatal error if any remain unclaimed.
245 */
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100246void drive_check_orphaned(void)
John Snowa66c9dc2014-10-01 14:19:24 -0400247{
Markus Armbruster18e46a02014-10-07 13:59:06 +0200248 BlockBackend *blk;
John Snowa66c9dc2014-10-01 14:19:24 -0400249 DriveInfo *dinfo;
Markus Armbruster664cc622017-02-15 11:05:45 +0100250 Location loc;
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100251 bool orphans = false;
John Snowa66c9dc2014-10-01 14:19:24 -0400252
Markus Armbruster18e46a02014-10-07 13:59:06 +0200253 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
254 dinfo = blk_legacy_dinfo(blk);
Markus Armbrusterfe9f70a2021-03-09 17:12:13 +0100255 /*
256 * Ignore default drives, because we create certain default
257 * drives unconditionally, then leave them unclaimed. Not the
258 * users fault.
259 * Ignore IF_VIRTIO, because it gets desugared into -device,
260 * so we can leave failing to -device.
261 * Ignore IF_NONE, because leaving unclaimed IF_NONE remains
262 * available for device_add is a feature.
263 */
264 if (dinfo->is_default || dinfo->type == IF_VIRTIO
265 || dinfo->type == IF_NONE) {
Markus Armbrustera1b40bd2020-06-22 11:42:19 +0200266 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;
John Snowa66c9dc2014-10-01 14:19:24 -0400276 }
277 }
278
Markus Armbruster720b8dc2017-02-15 11:05:46 +0100279 if (orphans) {
280 exit(1);
281 }
John Snowa66c9dc2014-10-01 14:19:24 -0400282}
283
Markus Armbrusterf1bd51a2011-01-28 11:21:44 +0100284DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
285{
286 return drive_get(type,
287 drive_index_to_bus_id(type, index),
288 drive_index_to_unit_id(type, index));
289}
290
Markus Armbruster666daa62010-06-02 18:48:27 +0200291int drive_get_max_bus(BlockInterfaceType type)
292{
293 int max_bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200294 BlockBackend *blk;
Markus Armbruster666daa62010-06-02 18:48:27 +0200295 DriveInfo *dinfo;
296
297 max_bus = -1;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200298 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
299 dinfo = blk_legacy_dinfo(blk);
300 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
Markus Armbruster666daa62010-06-02 18:48:27 +0200301 max_bus = dinfo->bus;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200302 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200303 }
304 return max_bus;
305}
306
Markus Armbruster13839972011-01-28 11:21:37 +0100307/* Get a block device. This should only be used for single-drive devices
308 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
309 appropriate bus. */
310DriveInfo *drive_get_next(BlockInterfaceType type)
311{
312 static int next_block_unit[IF_COUNT];
313
314 return drive_get(type, 0, next_block_unit[type]++);
315}
316
Markus Armbruster666daa62010-06-02 18:48:27 +0200317static void bdrv_format_print(void *opaque, const char *name)
318{
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200319 qemu_printf(" %s", name);
Markus Armbruster666daa62010-06-02 18:48:27 +0200320}
321
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000322typedef struct {
323 QEMUBH *bh;
Fam Zhengfa510eb2013-08-23 09:14:51 +0800324 BlockDriverState *bs;
325} BDRVPutRefBH;
Stefan Hajnocziaa398a52012-01-18 14:40:50 +0000326
Kevin Wolfb6810722013-09-20 11:33:11 +0200327static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200328{
329 if (!strcmp(buf, "ignore")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200330 return BLOCKDEV_ON_ERROR_IGNORE;
Markus Armbruster666daa62010-06-02 18:48:27 +0200331 } else if (!is_read && !strcmp(buf, "enospc")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200332 return BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200333 } else if (!strcmp(buf, "stop")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200334 return BLOCKDEV_ON_ERROR_STOP;
Markus Armbruster666daa62010-06-02 18:48:27 +0200335 } else if (!strcmp(buf, "report")) {
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200336 return BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200337 } else {
Kevin Wolfb6810722013-09-20 11:33:11 +0200338 error_setg(errp, "'%s' invalid %s error action",
339 buf, is_read ? "read" : "write");
Markus Armbruster666daa62010-06-02 18:48:27 +0200340 return -1;
341 }
342}
343
Alberto Garcia40119ef2015-11-16 11:28:38 +0200344static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
345 Error **errp)
346{
347 const QListEntry *entry;
348 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
349 switch (qobject_type(entry->value)) {
350
351 case QTYPE_QSTRING: {
352 unsigned long long length;
Max Reitz7dc847e2018-02-24 16:40:29 +0100353 const char *str = qstring_get_str(qobject_to(QString,
354 entry->value));
Alberto Garcia40119ef2015-11-16 11:28:38 +0200355 if (parse_uint_full(str, &length, 10) == 0 &&
356 length > 0 && length <= UINT_MAX) {
357 block_acct_add_interval(stats, (unsigned) length);
358 } else {
359 error_setg(errp, "Invalid interval length: %s", str);
360 return false;
361 }
362 break;
363 }
364
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400365 case QTYPE_QNUM: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100366 int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400367
Alberto Garcia40119ef2015-11-16 11:28:38 +0200368 if (length > 0 && length <= UINT_MAX) {
369 block_acct_add_interval(stats, (unsigned) length);
370 } else {
371 error_setg(errp, "Invalid interval length: %" PRId64, length);
372 return false;
373 }
374 break;
375 }
376
377 default:
378 error_setg(errp, "The specification of stats-intervals is invalid");
379 return false;
380 }
381 }
382 return true;
383}
384
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200385typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
386
Max Reitzfbf81752015-10-19 17:53:31 +0200387/* All parameters but @opts are optional and may be set to NULL. */
388static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
389 const char **throttling_group, ThrottleConfig *throttle_cfg,
390 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
391{
Max Reitzfbf81752015-10-19 17:53:31 +0200392 Error *local_error = NULL;
393 const char *aio;
394
395 if (bdrv_flags) {
Max Reitzfbf81752015-10-19 17:53:31 +0200396 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
397 *bdrv_flags |= BDRV_O_COPY_ON_READ;
398 }
399
Max Reitzfbf81752015-10-19 17:53:31 +0200400 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
Aarushi Mehtaf80f2672020-01-20 14:18:50 +0000401 if (bdrv_parse_aio(aio, bdrv_flags) < 0) {
402 error_setg(errp, "invalid aio option");
403 return;
Max Reitzfbf81752015-10-19 17:53:31 +0200404 }
405 }
406 }
407
408 /* disk I/O throttling */
409 if (throttling_group) {
410 *throttling_group = qemu_opt_get(opts, "throttling.group");
411 }
412
413 if (throttle_cfg) {
Alberto Garcia1588ab52016-02-18 12:27:00 +0200414 throttle_config_init(throttle_cfg);
Max Reitzfbf81752015-10-19 17:53:31 +0200415 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
416 qemu_opt_get_number(opts, "throttling.bps-total", 0);
417 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
418 qemu_opt_get_number(opts, "throttling.bps-read", 0);
419 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
420 qemu_opt_get_number(opts, "throttling.bps-write", 0);
421 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
422 qemu_opt_get_number(opts, "throttling.iops-total", 0);
423 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
424 qemu_opt_get_number(opts, "throttling.iops-read", 0);
425 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
426 qemu_opt_get_number(opts, "throttling.iops-write", 0);
427
428 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
429 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
430 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
431 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
432 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
433 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
434 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
435 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
436 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
437 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
438 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
439 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
440
Alberto Garcia8a0fc182016-02-18 12:27:02 +0200441 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
442 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
443 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
444 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
445 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
446 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
447 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
448 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
449 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
450 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
451 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
452 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
453
Max Reitzfbf81752015-10-19 17:53:31 +0200454 throttle_cfg->op_size =
455 qemu_opt_get_number(opts, "throttling.iops-size", 0);
456
Alberto Garciad5851082016-02-18 12:26:59 +0200457 if (!throttle_is_valid(throttle_cfg, errp)) {
Max Reitzfbf81752015-10-19 17:53:31 +0200458 return;
459 }
460 }
461
462 if (detect_zeroes) {
463 *detect_zeroes =
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200464 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
Max Reitzfbf81752015-10-19 17:53:31 +0200465 qemu_opt_get(opts, "detect-zeroes"),
Max Reitzfbf81752015-10-19 17:53:31 +0200466 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
467 &local_error);
468 if (local_error) {
469 error_propagate(errp, local_error);
470 return;
471 }
Max Reitzfbf81752015-10-19 17:53:31 +0200472 }
473}
474
Kevin Wolff298d072013-09-10 12:01:20 +0200475/* Takes the ownership of bs_opts */
Markus Armbruster18e46a02014-10-07 13:59:06 +0200476static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
477 Error **errp)
Markus Armbruster666daa62010-06-02 18:48:27 +0200478{
479 const char *buf;
Markus Armbruster666daa62010-06-02 18:48:27 +0200480 int bdrv_flags = 0;
481 int on_read_error, on_write_error;
Alberto Garcia362e9292015-10-28 17:33:04 +0200482 bool account_invalid, account_failed;
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300483 bool writethrough, read_only;
Markus Armbruster26f54e92014-10-07 13:59:04 +0200484 BlockBackend *blk;
Markus Armbrustera0f1eab2014-09-12 21:26:21 +0200485 BlockDriverState *bs;
Benoît Canetcc0681c2013-09-02 14:14:39 +0200486 ThrottleConfig cfg;
Markus Armbruster666daa62010-06-02 18:48:27 +0200487 int snapshot = 0;
Stefan Hajnoczic5461942013-02-13 16:53:42 +0100488 Error *error = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100489 QemuOpts *opts;
Alberto Garcia40119ef2015-11-16 11:28:38 +0200490 QDict *interval_dict = NULL;
491 QList *interval_list = NULL;
Kevin Wolf00063832013-03-15 10:35:07 +0100492 const char *id;
Max Reitzfbf81752015-10-19 17:53:31 +0200493 BlockdevDetectZeroesOptions detect_zeroes =
494 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
495 const char *throttling_group = NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200496
Kevin Wolff298d072013-09-10 12:01:20 +0200497 /* Check common options by copying from bs_opts to opts, all other options
498 * stay in bs_opts for processing by bdrv_open(). */
499 id = qdict_get_try_str(bs_opts, "id");
Markus Armbrusterc6ecec42020-07-07 18:05:35 +0200500 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, errp);
501 if (!opts) {
Markus Armbruster6376f952014-05-28 11:17:01 +0200502 goto err_no_opts;
Kevin Wolf00063832013-03-15 10:35:07 +0100503 }
504
Markus Armbruster668f62e2020-07-07 18:06:02 +0200505 if (!qemu_opts_absorb_qdict(opts, bs_opts, errp)) {
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100506 goto early_err;
Kevin Wolf00063832013-03-15 10:35:07 +0100507 }
508
509 if (id) {
510 qdict_del(bs_opts, "id");
511 }
512
Markus Armbruster666daa62010-06-02 18:48:27 +0200513 /* extract parameters */
Markus Armbruster666daa62010-06-02 18:48:27 +0200514 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
Markus Armbruster666daa62010-06-02 18:48:27 +0200515
Alberto Garcia362e9292015-10-28 17:33:04 +0200516 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
517 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
518
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100519 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
520
Alberto Garciaff356ee2016-07-08 17:03:00 +0300521 id = qemu_opts_id(opts);
522
Alberto Garcia40119ef2015-11-16 11:28:38 +0200523 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
524 qdict_array_split(interval_dict, &interval_list);
525
526 if (qdict_size(interval_dict) != 0) {
527 error_setg(errp, "Invalid option stats-intervals.%s",
528 qdict_first(interval_dict)->key);
529 goto early_err;
530 }
Alberto Garcia2be55062015-10-28 17:33:07 +0200531
Max Reitzfbf81752015-10-19 17:53:31 +0200532 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
533 &detect_zeroes, &error);
534 if (error) {
535 error_propagate(errp, error);
536 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200537 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200538
539 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
Peter Maydellc8057f92012-08-02 13:45:54 +0100540 if (is_help_option(buf)) {
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200541 qemu_printf("Supported formats:");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300542 bdrv_iterate_format(bdrv_format_print, NULL, false);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200543 qemu_printf("\nSupported formats (read-only):");
Andrey Shinkevich9ac404c2019-03-07 16:33:58 +0300544 bdrv_iterate_format(bdrv_format_print, NULL, true);
Markus Armbrustercdcd4362019-04-17 21:06:38 +0200545 qemu_printf("\n");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100546 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200547 }
Kevin Wolf74fe54f2013-07-09 11:09:02 +0200548
Max Reitze4342ce2015-02-05 13:58:14 -0500549 if (qdict_haskey(bs_opts, "driver")) {
550 error_setg(errp, "Cannot specify both 'driver' and 'format'");
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100551 goto early_err;
Mike Qiu6db5f5d2013-08-08 10:45:16 -0400552 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500553 qdict_put_str(bs_opts, "driver", buf);
Markus Armbruster666daa62010-06-02 18:48:27 +0200554 }
555
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200556 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
Markus Armbruster666daa62010-06-02 18:48:27 +0200557 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200558 on_write_error = parse_block_error_action(buf, 0, &error);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100559 if (error) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200560 error_propagate(errp, error);
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100561 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200562 }
563 }
564
Paolo Bonzini92aa5c62012-09-28 17:22:55 +0200565 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
Markus Armbruster666daa62010-06-02 18:48:27 +0200566 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200567 on_read_error = parse_block_error_action(buf, 1, &error);
Markus Armbruster84d18f02014-01-30 15:07:28 +0100568 if (error) {
Kevin Wolfb6810722013-09-20 11:33:11 +0200569 error_propagate(errp, error);
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100570 goto early_err;
Markus Armbruster666daa62010-06-02 18:48:27 +0200571 }
572 }
573
Max Reitz5ec18f82015-10-19 17:53:30 +0200574 if (snapshot) {
Kevin Wolf91a097e2015-05-08 17:49:53 +0200575 bdrv_flags |= BDRV_O_SNAPSHOT;
Max Reitz5ec18f82015-10-19 17:53:30 +0200576 }
577
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300578 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
579
Kevin Wolf326642b2013-07-11 12:52:34 +0200580 /* init */
Kevin Wolf39c4ae92015-11-13 14:45:42 +0100581 if ((!file || !*file) && !qdict_size(bs_opts)) {
Max Reitz5ec18f82015-10-19 17:53:30 +0200582 BlockBackendRootState *blk_rs;
583
Kevin Wolfd861ab32019-04-25 14:25:10 +0200584 blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
Max Reitz5ec18f82015-10-19 17:53:30 +0200585 blk_rs = blk_get_root_state(blk);
586 blk_rs->open_flags = bdrv_flags;
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300587 blk_rs->read_only = read_only;
Max Reitz5ec18f82015-10-19 17:53:30 +0200588 blk_rs->detect_zeroes = detect_zeroes;
589
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200590 qobject_unref(bs_opts);
Max Reitze4342ce2015-02-05 13:58:14 -0500591 } else {
592 if (file && !*file) {
593 file = NULL;
594 }
595
Kevin Wolf91a097e2015-05-08 17:49:53 +0200596 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
597 * with other callers) rather than what we want as the real defaults.
598 * Apply the defaults here instead. */
Kevin Wolf91a097e2015-05-08 17:49:53 +0200599 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
600 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300601 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
602 read_only ? "on" : "off");
Kevin Wolf9384a442018-10-17 18:24:30 +0200603 qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
Kevin Wolf72e775c2016-03-15 14:34:37 +0100604 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
Kevin Wolf91a097e2015-05-08 17:49:53 +0200605
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100606 if (runstate_check(RUN_STATE_INMIGRATE)) {
607 bdrv_flags |= BDRV_O_INACTIVE;
608 }
609
Max Reitzefaa7c42016-03-16 19:54:38 +0100610 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
Max Reitze4342ce2015-02-05 13:58:14 -0500611 if (!blk) {
612 goto err_no_bs_opts;
613 }
614 bs = blk_bs(blk);
Max Reitze4342ce2015-02-05 13:58:14 -0500615
Max Reitz5ec18f82015-10-19 17:53:30 +0200616 bs->detect_zeroes = detect_zeroes;
617
Paolo Bonzini9caa6f32017-06-05 14:39:07 +0200618 block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
Alberto Garcia2be55062015-10-28 17:33:07 +0200619
Alberto Garcia40119ef2015-11-16 11:28:38 +0200620 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
621 blk_unref(blk);
622 blk = NULL;
623 goto err_no_bs_opts;
Alberto Garcia2be55062015-10-28 17:33:07 +0200624 }
Max Reitz5ec18f82015-10-19 17:53:30 +0200625 }
Markus Armbruster666daa62010-06-02 18:48:27 +0200626
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100627 /* disk I/O throttling */
628 if (throttle_enabled(&cfg)) {
629 if (!throttling_group) {
Alberto Garciaff356ee2016-07-08 17:03:00 +0300630 throttling_group = id;
Kevin Wolf7ca7f0f2016-03-22 13:00:08 +0100631 }
632 blk_io_limits_enable(blk, throttling_group);
633 blk_set_io_limits(blk, &cfg);
634 }
635
Kevin Wolfe4b24b42016-03-15 15:39:42 +0100636 blk_set_enable_write_cache(blk, !writethrough);
Max Reitz373340b2015-10-19 17:53:22 +0200637 blk_set_on_error(blk, on_read_error, on_write_error);
Markus Armbrusterabd7f682010-06-02 18:55:17 +0200638
Alberto Garciaff356ee2016-07-08 17:03:00 +0300639 if (!monitor_add_blk(blk, id, errp)) {
Max Reitzefaa7c42016-03-16 19:54:38 +0100640 blk_unref(blk);
641 blk = NULL;
642 goto err_no_bs_opts;
643 }
644
Max Reitze4342ce2015-02-05 13:58:14 -0500645err_no_bs_opts:
Kevin Wolf00063832013-03-15 10:35:07 +0100646 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200647 qobject_unref(interval_dict);
648 qobject_unref(interval_list);
Markus Armbruster18e46a02014-10-07 13:59:06 +0200649 return blk;
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100650
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100651early_err:
Stefan Hajnocziec9c10d2013-10-30 14:54:30 +0100652 qemu_opts_del(opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200653 qobject_unref(interval_dict);
654 qobject_unref(interval_list);
Markus Armbruster6376f952014-05-28 11:17:01 +0200655err_no_opts:
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200656 qobject_unref(bs_opts);
Markus Armbrustera9ae2bf2011-02-08 15:12:39 +0100657 return NULL;
Markus Armbruster666daa62010-06-02 18:48:27 +0200658}
659
Max Reitzbd745e22015-10-19 17:53:32 +0200660/* Takes the ownership of bs_opts */
Maxim Levitsky89802d52020-03-08 11:24:40 +0200661BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
Max Reitzbd745e22015-10-19 17:53:32 +0200662{
Max Reitzbd745e22015-10-19 17:53:32 +0200663 int bdrv_flags = 0;
664
Kevin Wolfa81d6162016-03-07 14:23:04 +0100665 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
666 * with other callers) rather than what we want as the real defaults.
667 * Apply the defaults here instead. */
Kevin Wolfa81d6162016-03-07 14:23:04 +0100668 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
669 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
Alberto Garciaf87a0e22016-09-15 17:53:02 +0300670 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
Kevin Wolfa81d6162016-03-07 14:23:04 +0100671
Kevin Wolf12d5ee32016-02-19 16:48:10 +0100672 if (runstate_check(RUN_STATE_INMIGRATE)) {
673 bdrv_flags |= BDRV_O_INACTIVE;
674 }
675
Kevin Wolf74e1ae72016-09-20 20:48:52 +0200676 return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
Max Reitzbd745e22015-10-19 17:53:32 +0200677}
678
Max Reitz9c4218e2016-01-29 16:36:12 +0100679void blockdev_close_all_bdrv_states(void)
680{
681 BlockDriverState *bs, *next_bs;
682
683 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
684 AioContext *ctx = bdrv_get_aio_context(bs);
685
686 aio_context_acquire(ctx);
687 bdrv_unref(bs);
688 aio_context_release(ctx);
689 }
690}
691
Max Reitz262b4e82016-03-16 19:54:41 +0100692/* Iterates over the list of monitor-owned BlockDriverStates */
693BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
694{
695 return bs ? QTAILQ_NEXT(bs, monitor_list)
696 : QTAILQ_FIRST(&monitor_bdrv_states);
697}
698
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200699static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200700 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200701{
702 const char *value;
703
704 value = qemu_opt_get(opts, from);
705 if (value) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200706 if (qemu_opt_find(opts, to)) {
707 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
708 "same time", to, from);
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200709 return false;
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200710 }
Jun Li20d6cd42014-09-24 13:45:27 +0800711 }
712
713 /* rename all items in opts */
714 while ((value = qemu_opt_get(opts, from))) {
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100715 qemu_opt_set(opts, to, value, &error_abort);
Kevin Wolf57975222013-07-17 14:41:54 +0200716 qemu_opt_unset(opts, from);
717 }
Markus Armbrusterc75d7f72020-07-07 18:05:41 +0200718 return true;
Kevin Wolf57975222013-07-17 14:41:54 +0200719}
720
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200721QemuOptsList qemu_legacy_drive_opts = {
722 .name = "drive",
723 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
724 .desc = {
725 {
Kevin Wolf87a899c2013-09-10 15:48:13 +0200726 .name = "bus",
727 .type = QEMU_OPT_NUMBER,
728 .help = "bus number",
729 },{
730 .name = "unit",
731 .type = QEMU_OPT_NUMBER,
732 .help = "unit number (i.e. lun for scsi)",
733 },{
734 .name = "index",
735 .type = QEMU_OPT_NUMBER,
736 .help = "index number",
737 },{
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200738 .name = "media",
739 .type = QEMU_OPT_STRING,
740 .help = "media type (disk, cdrom)",
Kevin Wolf593d4642013-08-28 17:24:51 +0200741 },{
742 .name = "if",
743 .type = QEMU_OPT_STRING,
744 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
Kevin Wolfb41a7332013-09-09 16:49:49 +0200745 },{
Max Reitzd095b462013-12-20 19:28:14 +0100746 .name = "file",
747 .type = QEMU_OPT_STRING,
748 .help = "file name",
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200749 },
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200750
751 /* Options that are passed on, but have special semantics with -drive */
752 {
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300753 .name = BDRV_OPT_READ_ONLY,
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200754 .type = QEMU_OPT_BOOL,
755 .help = "open drive file as read-only",
756 },{
Kevin Wolfee13ed12014-02-09 09:52:32 +0100757 .name = "rerror",
758 .type = QEMU_OPT_STRING,
759 .help = "read error action",
760 },{
761 .name = "werror",
762 .type = QEMU_OPT_STRING,
763 .help = "write error action",
764 },{
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200765 .name = "copy-on-read",
766 .type = QEMU_OPT_BOOL,
767 .help = "copy read data from backing file into image file",
768 },
769
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200770 { /* end of list */ }
771 },
772};
773
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200774DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
775 Error **errp)
Kevin Wolf57975222013-07-17 14:41:54 +0200776{
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200777 const char *value;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200778 BlockBackend *blk;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200779 DriveInfo *dinfo = NULL;
Kevin Wolff298d072013-09-10 12:01:20 +0200780 QDict *bs_opts;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200781 QemuOpts *legacy_opts;
782 DriveMediaType media = MEDIA_DISK;
Kevin Wolf593d4642013-08-28 17:24:51 +0200783 BlockInterfaceType type;
Kevin Wolf87a899c2013-09-10 15:48:13 +0200784 int max_devs, bus_id, unit_id, index;
Kevin Wolfee13ed12014-02-09 09:52:32 +0100785 const char *werror, *rerror;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800786 bool read_only = false;
787 bool copy_on_read;
Max Reitzd095b462013-12-20 19:28:14 +0100788 const char *filename;
Kevin Wolf247147f2014-09-24 16:37:14 +0200789 int i;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200790
Kevin Wolf57975222013-07-17 14:41:54 +0200791 /* Change legacy command line options into QMP ones */
Kevin Wolf247147f2014-09-24 16:37:14 +0200792 static const struct {
793 const char *from;
794 const char *to;
795 } opt_renames[] = {
796 { "iops", "throttling.iops-total" },
797 { "iops_rd", "throttling.iops-read" },
798 { "iops_wr", "throttling.iops-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200799
Kevin Wolf247147f2014-09-24 16:37:14 +0200800 { "bps", "throttling.bps-total" },
801 { "bps_rd", "throttling.bps-read" },
802 { "bps_wr", "throttling.bps-write" },
Kevin Wolf57975222013-07-17 14:41:54 +0200803
Kevin Wolf247147f2014-09-24 16:37:14 +0200804 { "iops_max", "throttling.iops-total-max" },
805 { "iops_rd_max", "throttling.iops-read-max" },
806 { "iops_wr_max", "throttling.iops-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200807
Kevin Wolf247147f2014-09-24 16:37:14 +0200808 { "bps_max", "throttling.bps-total-max" },
809 { "bps_rd_max", "throttling.bps-read-max" },
810 { "bps_wr_max", "throttling.bps-write-max" },
Benoît Canet3e9fab62013-09-02 14:14:40 +0200811
Kevin Wolf247147f2014-09-24 16:37:14 +0200812 { "iops_size", "throttling.iops-size" },
Benoît Canet2024c1d2013-09-02 14:14:41 +0200813
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200814 { "group", "throttling.group" },
815
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300816 { "readonly", BDRV_OPT_READ_ONLY },
Kevin Wolf247147f2014-09-24 16:37:14 +0200817 };
818
819 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
Markus Armbruster235e59c2020-07-07 18:05:42 +0200820 if (!qemu_opt_rename(all_opts, opt_renames[i].from,
Markus Armbruster668f62e2020-07-07 18:06:02 +0200821 opt_renames[i].to, errp)) {
Kevin Wolf5abbf0e2014-09-18 11:48:34 +0200822 return NULL;
823 }
Kevin Wolf247147f2014-09-24 16:37:14 +0200824 }
Kevin Wolf0f227a92013-07-19 20:07:29 +0200825
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200826 value = qemu_opt_get(all_opts, "cache");
827 if (value) {
828 int flags = 0;
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100829 bool writethrough;
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200830
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100831 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200832 error_setg(errp, "invalid cache option");
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200833 return NULL;
834 }
835
836 /* Specific options take precedence */
Kevin Wolf54861b92015-04-07 16:55:00 +0200837 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
838 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
Kevin Wolf04feb4a2016-03-18 15:35:51 +0100839 !writethrough, &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200840 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200841 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
842 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100843 !!(flags & BDRV_O_NOCACHE), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200844 }
Kevin Wolf54861b92015-04-07 16:55:00 +0200845 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
846 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
Markus Armbrustercccb7962015-02-12 16:37:44 +0100847 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
Kevin Wolf29c4e2b2013-07-18 16:31:25 +0200848 }
849 qemu_opt_unset(all_opts, "cache");
850 }
851
Kevin Wolff298d072013-09-10 12:01:20 +0200852 /* Get a QDict for processing the options */
853 bs_opts = qdict_new();
854 qemu_opts_to_qdict(all_opts, bs_opts);
855
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800856 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
857 &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200858 if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200859 goto fail;
860 }
861
862 /* Media type */
863 value = qemu_opt_get(legacy_opts, "media");
864 if (value) {
865 if (!strcmp(value, "disk")) {
866 media = MEDIA_DISK;
867 } else if (!strcmp(value, "cdrom")) {
868 media = MEDIA_CDROM;
Fam Zhenga7fdbcf2013-10-15 17:45:50 +0800869 read_only = true;
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200870 } else {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200871 error_setg(errp, "'%s' invalid media", value);
Kevin Wolf33cb7dc2013-08-28 17:00:13 +0200872 goto fail;
873 }
874 }
875
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200876 /* copy-on-read is disabled with a warning for read-only devices */
Alberto Garcia4e200cf2016-09-15 17:53:05 +0300877 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200878 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
879
880 if (read_only && copy_on_read) {
Alistair Francis3dc6f862017-07-12 06:57:41 -0700881 warn_report("disabling copy-on-read on read-only drive");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200882 copy_on_read = false;
883 }
884
Eric Blake46f5ac22017-04-27 16:58:17 -0500885 qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
886 qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
Kevin Wolf0ebd24e2013-09-19 15:12:18 +0200887
Kevin Wolf593d4642013-08-28 17:24:51 +0200888 /* Controller type */
889 value = qemu_opt_get(legacy_opts, "if");
890 if (value) {
891 for (type = 0;
892 type < IF_COUNT && strcmp(value, if_name[type]);
893 type++) {
894 }
895 if (type == IF_COUNT) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200896 error_setg(errp, "unsupported bus type '%s'", value);
Kevin Wolf593d4642013-08-28 17:24:51 +0200897 goto fail;
898 }
899 } else {
900 type = block_default_type;
901 }
902
Kevin Wolf87a899c2013-09-10 15:48:13 +0200903 /* Device address specified by bus/unit or index.
904 * If none was specified, try to find the first free one. */
905 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
906 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
907 index = qemu_opt_get_number(legacy_opts, "index", -1);
908
909 max_devs = if_max_devs[type];
910
911 if (index != -1) {
912 if (bus_id != 0 || unit_id != -1) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200913 error_setg(errp, "index cannot be used with bus and unit");
Kevin Wolf87a899c2013-09-10 15:48:13 +0200914 goto fail;
915 }
916 bus_id = drive_index_to_bus_id(type, index);
917 unit_id = drive_index_to_unit_id(type, index);
918 }
919
920 if (unit_id == -1) {
921 unit_id = 0;
922 while (drive_get(type, bus_id, unit_id) != NULL) {
923 unit_id++;
924 if (max_devs && unit_id >= max_devs) {
925 unit_id -= max_devs;
926 bus_id++;
927 }
928 }
929 }
930
931 if (max_devs && unit_id >= max_devs) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200932 error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200933 goto fail;
934 }
935
936 if (drive_get(type, bus_id, unit_id) != NULL) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200937 error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
938 bus_id, unit_id, index);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200939 goto fail;
940 }
941
942 /* no id supplied -> create one */
943 if (qemu_opts_id(all_opts) == NULL) {
944 char *new_id;
945 const char *mediastr = "";
946 if (type == IF_IDE || type == IF_SCSI) {
947 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
948 }
949 if (max_devs) {
950 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
951 mediastr, unit_id);
952 } else {
953 new_id = g_strdup_printf("%s%s%i", if_name[type],
954 mediastr, unit_id);
955 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500956 qdict_put_str(bs_opts, "id", new_id);
Kevin Wolf87a899c2013-09-10 15:48:13 +0200957 g_free(new_id);
958 }
959
Kevin Wolf394c7d42013-09-13 14:09:17 +0200960 /* Add virtio block device */
Kevin Wolf394c7d42013-09-13 14:09:17 +0200961 if (type == IF_VIRTIO) {
962 QemuOpts *devopts;
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800963 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
964 &error_abort);
Laurent Vivier9db1d3a2021-03-23 16:53:04 +0000965 qemu_opt_set(devopts, "driver", "virtio-blk", &error_abort);
Markus Armbrusterf43e47d2015-02-12 17:52:20 +0100966 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
967 &error_abort);
Kevin Wolf394c7d42013-09-13 14:09:17 +0200968 }
969
Max Reitzd095b462013-12-20 19:28:14 +0100970 filename = qemu_opt_get(legacy_opts, "file");
971
Kevin Wolfee13ed12014-02-09 09:52:32 +0100972 /* Check werror/rerror compatibility with if=... */
973 werror = qemu_opt_get(legacy_opts, "werror");
974 if (werror != NULL) {
975 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
976 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200977 error_setg(errp, "werror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +0100978 goto fail;
979 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500980 qdict_put_str(bs_opts, "werror", werror);
Kevin Wolfee13ed12014-02-09 09:52:32 +0100981 }
982
983 rerror = qemu_opt_get(legacy_opts, "rerror");
984 if (rerror != NULL) {
985 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
986 type != IF_NONE) {
Markus Armbrusterc4f26c92018-10-17 10:26:57 +0200987 error_setg(errp, "rerror is not supported by this bus type");
Kevin Wolfee13ed12014-02-09 09:52:32 +0100988 goto fail;
989 }
Eric Blake46f5ac22017-04-27 16:58:17 -0500990 qdict_put_str(bs_opts, "rerror", rerror);
Kevin Wolfee13ed12014-02-09 09:52:32 +0100991 }
992
Kevin Wolf2d246f02013-09-18 15:14:47 +0200993 /* Actual block device init: Functionality shared with blockdev-add */
Markus Armbruster992861f2020-07-07 18:06:04 +0200994 blk = blockdev_init(filename, bs_opts, errp);
Markus Armbruster3cb0e252014-05-28 11:17:02 +0200995 bs_opts = NULL;
Markus Armbruster18e46a02014-10-07 13:59:06 +0200996 if (!blk) {
Kevin Wolf2d246f02013-09-18 15:14:47 +0200997 goto fail;
998 }
999
Markus Armbruster26f8b3a2014-10-07 13:59:22 +02001000 /* Create legacy DriveInfo */
1001 dinfo = g_malloc0(sizeof(*dinfo));
Kevin Wolff298d072013-09-10 12:01:20 +02001002 dinfo->opts = all_opts;
Kevin Wolf2d246f02013-09-18 15:14:47 +02001003
Kevin Wolfee13ed12014-02-09 09:52:32 +01001004 dinfo->type = type;
Kevin Wolf87a899c2013-09-10 15:48:13 +02001005 dinfo->bus = bus_id;
1006 dinfo->unit = unit_id;
Kevin Wolfbcf83152014-06-06 15:21:48 +02001007
Markus Armbruster26f8b3a2014-10-07 13:59:22 +02001008 blk_set_legacy_dinfo(blk, dinfo);
1009
Kevin Wolfe34ef042013-09-19 14:24:10 +02001010 switch(type) {
1011 case IF_IDE:
1012 case IF_SCSI:
1013 case IF_XEN:
1014 case IF_NONE:
1015 dinfo->media_cd = media == MEDIA_CDROM;
1016 break;
1017 default:
1018 break;
1019 }
1020
Kevin Wolf2d246f02013-09-18 15:14:47 +02001021fail:
Kevin Wolf33cb7dc2013-08-28 17:00:13 +02001022 qemu_opts_del(legacy_opts);
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +02001023 qobject_unref(bs_opts);
Kevin Wolf2d246f02013-09-18 15:14:47 +02001024 return dinfo;
Kevin Wolf57975222013-07-17 14:41:54 +02001025}
1026
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02001027static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1028{
1029 BlockDriverState *bs;
1030
1031 bs = bdrv_lookup_bs(name, name, errp);
1032 if (bs == NULL) {
1033 return NULL;
1034 }
1035
1036 if (!bdrv_is_root_node(bs)) {
1037 error_setg(errp, "Need a root block node");
1038 return NULL;
1039 }
1040
1041 if (!bdrv_is_inserted(bs)) {
1042 error_setg(errp, "Device has no medium");
1043 return NULL;
1044 }
1045
1046 return bs;
1047}
1048
Eric Blake10f75902016-03-03 09:16:50 -07001049static void blockdev_do_action(TransactionAction *action, Error **errp)
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001050{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001051 TransactionActionList list;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001052
Eric Blake10f75902016-03-03 09:16:50 -07001053 list.value = action;
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001054 list.next = NULL;
John Snow94d16a62015-11-05 18:13:18 -05001055 qmp_transaction(&list, false, NULL, errp);
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001056}
1057
Benoît Canet0901f672014-01-23 21:31:38 +01001058void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1059 bool has_node_name, const char *node_name,
1060 const char *snapshot_file,
1061 bool has_snapshot_node_name,
1062 const char *snapshot_node_name,
Luiz Capitulino6106e242011-11-25 16:15:19 -02001063 bool has_format, const char *format,
Benoît Canet0901f672014-01-23 21:31:38 +01001064 bool has_mode, NewImageMode mode, Error **errp)
Jes Sorensenf8882562010-12-16 13:52:16 +01001065{
Alberto Garciaa911e6a2015-10-26 14:27:14 +02001066 BlockdevSnapshotSync snapshot = {
Benoît Canet0901f672014-01-23 21:31:38 +01001067 .has_device = has_device,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001068 .device = (char *) device,
Benoît Canet0901f672014-01-23 21:31:38 +01001069 .has_node_name = has_node_name,
1070 .node_name = (char *) node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001071 .snapshot_file = (char *) snapshot_file,
Benoît Canet0901f672014-01-23 21:31:38 +01001072 .has_snapshot_node_name = has_snapshot_node_name,
1073 .snapshot_node_name = (char *) snapshot_node_name,
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001074 .has_format = has_format,
1075 .format = (char *) format,
1076 .has_mode = has_mode,
1077 .mode = mode,
1078 };
Eric Blake10f75902016-03-03 09:16:50 -07001079 TransactionAction action = {
1080 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001081 .u.blockdev_snapshot_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001082 };
1083 blockdev_do_action(&action, errp);
Jes Sorensenf8882562010-12-16 13:52:16 +01001084}
1085
Alberto Garcia43de7e22015-10-26 14:27:16 +02001086void qmp_blockdev_snapshot(const char *node, const char *overlay,
1087 Error **errp)
1088{
1089 BlockdevSnapshot snapshot_data = {
1090 .node = (char *) node,
1091 .overlay = (char *) overlay
1092 };
Eric Blake10f75902016-03-03 09:16:50 -07001093 TransactionAction action = {
1094 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
Eric Blake32bafa82016-03-17 16:48:37 -06001095 .u.blockdev_snapshot.data = &snapshot_data,
Eric Blake10f75902016-03-03 09:16:50 -07001096 };
1097 blockdev_do_action(&action, errp);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001098}
1099
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001100void qmp_blockdev_snapshot_internal_sync(const char *device,
1101 const char *name,
1102 Error **errp)
1103{
1104 BlockdevSnapshotInternal snapshot = {
1105 .device = (char *) device,
1106 .name = (char *) name
1107 };
Eric Blake10f75902016-03-03 09:16:50 -07001108 TransactionAction action = {
1109 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
Eric Blake32bafa82016-03-17 16:48:37 -06001110 .u.blockdev_snapshot_internal_sync.data = &snapshot,
Eric Blake10f75902016-03-03 09:16:50 -07001111 };
1112 blockdev_do_action(&action, errp);
Wenchao Xiaf323bc92013-09-11 14:04:35 +08001113}
1114
Wenchao Xia44e3e052013-09-11 14:04:36 +08001115SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1116 bool has_id,
1117 const char *id,
1118 bool has_name,
1119 const char *name,
1120 Error **errp)
1121{
Fam Zhenga0e85442015-03-02 19:36:48 +08001122 BlockDriverState *bs;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001123 AioContext *aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001124 QEMUSnapshotInfo sn;
1125 Error *local_err = NULL;
1126 SnapshotInfo *info = NULL;
1127 int ret;
1128
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001129 bs = qmp_get_root_bs(device, errp);
1130 if (!bs) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001131 return NULL;
1132 }
Kevin Wolf2dfb4c02016-06-23 14:20:24 +02001133 aio_context = bdrv_get_aio_context(bs);
Max Reitz5433c242015-10-19 17:53:29 +02001134 aio_context_acquire(aio_context);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001135
1136 if (!has_id) {
1137 id = NULL;
1138 }
1139
1140 if (!has_name) {
1141 name = NULL;
1142 }
1143
1144 if (!id && !name) {
1145 error_setg(errp, "Name or id must be provided");
Max Reitz5433c242015-10-19 17:53:29 +02001146 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001147 }
1148
Stefan Hajnoczi0b928852014-11-19 14:19:43 +00001149 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1150 goto out_aio_context;
1151 }
1152
Wenchao Xia44e3e052013-09-11 14:04:36 +08001153 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001154 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001155 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001156 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001157 }
1158 if (!ret) {
1159 error_setg(errp,
1160 "Snapshot with id '%s' and name '%s' does not exist on "
1161 "device '%s'",
1162 STR_OR_NULL(id), STR_OR_NULL(name), device);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001163 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001164 }
1165
1166 bdrv_snapshot_delete(bs, id, name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01001167 if (local_err) {
Wenchao Xia44e3e052013-09-11 14:04:36 +08001168 error_propagate(errp, local_err);
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001169 goto out_aio_context;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001170 }
1171
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001172 aio_context_release(aio_context);
1173
Markus Armbruster5839e532014-08-19 10:31:08 +02001174 info = g_new0(SnapshotInfo, 1);
Wenchao Xia44e3e052013-09-11 14:04:36 +08001175 info->id = g_strdup(sn.id_str);
1176 info->name = g_strdup(sn.name);
1177 info->date_nsec = sn.date_nsec;
1178 info->date_sec = sn.date_sec;
1179 info->vm_state_size = sn.vm_state_size;
1180 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1181 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001182 if (sn.icount != -1ULL) {
1183 info->icount = sn.icount;
1184 info->has_icount = true;
1185 }
Wenchao Xia44e3e052013-09-11 14:04:36 +08001186
1187 return info;
Stefan Hajnoczi4ef39822014-11-19 14:19:42 +00001188
1189out_aio_context:
1190 aio_context_release(aio_context);
1191 return NULL;
Wenchao Xia44e3e052013-09-11 14:04:36 +08001192}
Jeff Cody8802d1f2012-02-28 15:54:06 -05001193
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00001194/* New and old BlockDriverState structs for atomic group operations */
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001195
John Snow50f43f02015-11-05 18:13:09 -05001196typedef struct BlkActionState BlkActionState;
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001197
John Snow50f43f02015-11-05 18:13:09 -05001198/**
1199 * BlkActionOps:
1200 * Table of operations that define an Action.
1201 *
1202 * @instance_size: Size of state struct, in bytes.
1203 * @prepare: Prepare the work, must NOT be NULL.
1204 * @commit: Commit the changes, can be NULL.
1205 * @abort: Abort the changes on fail, can be NULL.
1206 * @clean: Clean up resources after all transaction actions have called
1207 * commit() or abort(). Can be NULL.
1208 *
1209 * Only prepare() may fail. In a single transaction, only one of commit() or
1210 * abort() will be called. clean() will always be called if it is present.
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001211 */
John Snow50f43f02015-11-05 18:13:09 -05001212typedef struct BlkActionOps {
1213 size_t instance_size;
1214 void (*prepare)(BlkActionState *common, Error **errp);
1215 void (*commit)(BlkActionState *common);
1216 void (*abort)(BlkActionState *common);
1217 void (*clean)(BlkActionState *common);
1218} BlkActionOps;
1219
1220/**
1221 * BlkActionState:
1222 * Describes one Action's state within a Transaction.
1223 *
1224 * @action: QAPI-defined enum identifying which Action to perform.
1225 * @ops: Table of ActionOps this Action can perform.
John Snow94d16a62015-11-05 18:13:18 -05001226 * @block_job_txn: Transaction which this action belongs to.
John Snow50f43f02015-11-05 18:13:09 -05001227 * @entry: List membership for all Actions in this Transaction.
1228 *
1229 * This structure must be arranged as first member in a subclassed type,
1230 * assuming that the compiler will also arrange it to the same offsets as the
1231 * base class.
1232 */
1233struct BlkActionState {
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001234 TransactionAction *action;
John Snow50f43f02015-11-05 18:13:09 -05001235 const BlkActionOps *ops;
Kevin Wolf62c9e412018-04-19 16:09:52 +02001236 JobTxn *block_job_txn;
John Snow94d16a62015-11-05 18:13:18 -05001237 TransactionProperties *txn_props;
John Snowf4de0f82019-01-11 11:59:16 -06001238 QTAILQ_ENTRY(BlkActionState) entry;
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001239};
1240
Wenchao Xiabbe86012013-09-11 14:04:34 +08001241/* internal snapshot private data */
1242typedef struct InternalSnapshotState {
John Snow50f43f02015-11-05 18:13:09 -05001243 BlkActionState common;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001244 BlockDriverState *bs;
1245 QEMUSnapshotInfo sn;
Fam Zheng507306c2015-10-23 11:08:13 +08001246 bool created;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001247} InternalSnapshotState;
1248
John Snow94d16a62015-11-05 18:13:18 -05001249
1250static int action_check_completion_mode(BlkActionState *s, Error **errp)
1251{
1252 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1253 error_setg(errp,
1254 "Action '%s' does not support Transaction property "
1255 "completion-mode = %s",
Markus Armbruster977c7362017-08-24 10:46:08 +02001256 TransactionActionKind_str(s->action->type),
1257 ActionCompletionMode_str(s->txn_props->completion_mode));
John Snow94d16a62015-11-05 18:13:18 -05001258 return -1;
1259 }
1260 return 0;
1261}
1262
John Snow50f43f02015-11-05 18:13:09 -05001263static void internal_snapshot_prepare(BlkActionState *common,
Wenchao Xiabbe86012013-09-11 14:04:34 +08001264 Error **errp)
1265{
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001266 Error *local_err = NULL;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001267 const char *device;
1268 const char *name;
1269 BlockDriverState *bs;
1270 QEMUSnapshotInfo old_sn, *sn;
1271 bool ret;
1272 qemu_timeval tv;
1273 BlockdevSnapshotInternal *internal;
1274 InternalSnapshotState *state;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001275 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001276 int ret1;
1277
Eric Blake6a8f9662015-10-26 16:34:54 -06001278 g_assert(common->action->type ==
Wenchao Xiabbe86012013-09-11 14:04:34 +08001279 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
Eric Blake32bafa82016-03-17 16:48:37 -06001280 internal = common->action->u.blockdev_snapshot_internal_sync.data;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001281 state = DO_UPCAST(InternalSnapshotState, common, common);
1282
1283 /* 1. parse input */
1284 device = internal->device;
1285 name = internal->name;
1286
1287 /* 2. check for validation */
John Snow94d16a62015-11-05 18:13:18 -05001288 if (action_check_completion_mode(common, errp) < 0) {
1289 return;
1290 }
1291
Kevin Wolf75dfd402016-06-23 14:20:24 +02001292 bs = qmp_get_root_bs(device, errp);
1293 if (!bs) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001294 return;
1295 }
1296
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001297 aio_context = bdrv_get_aio_context(bs);
1298 aio_context_acquire(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001299
Fam Zheng507306c2015-10-23 11:08:13 +08001300 state->bs = bs;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001301
1302 /* Paired with .clean() */
Fam Zheng507306c2015-10-23 11:08:13 +08001303 bdrv_drained_begin(bs);
1304
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001305 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001306 goto out;
Stefan Hajnoczi3dc7ca32014-11-21 10:49:00 +00001307 }
1308
Wenchao Xiabbe86012013-09-11 14:04:34 +08001309 if (bdrv_is_read_only(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001310 error_setg(errp, "Device '%s' is read only", device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001311 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001312 }
1313
1314 if (!bdrv_can_snapshot(bs)) {
Alberto Garcia81e5f782015-04-08 12:29:19 +03001315 error_setg(errp, "Block format '%s' used by device '%s' "
1316 "does not support internal snapshots",
1317 bs->drv->format_name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001318 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001319 }
1320
1321 if (!strlen(name)) {
1322 error_setg(errp, "Name is empty");
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001323 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001324 }
1325
1326 /* check whether a snapshot with name exist */
Markus Armbrusterf70edf92014-04-25 16:50:34 +02001327 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1328 &local_err);
1329 if (local_err) {
1330 error_propagate(errp, local_err);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001331 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001332 } else if (ret) {
1333 error_setg(errp,
1334 "Snapshot with name '%s' already exists on device '%s'",
1335 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001336 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001337 }
1338
1339 /* 3. take the snapshot */
1340 sn = &state->sn;
1341 pstrcpy(sn->name, sizeof(sn->name), name);
1342 qemu_gettimeofday(&tv);
1343 sn->date_sec = tv.tv_sec;
1344 sn->date_nsec = tv.tv_usec * 1000;
1345 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
Pavel Dovgalyukb39847a2020-10-03 20:13:08 +03001346 if (replay_mode != REPLAY_MODE_NONE) {
1347 sn->icount = replay_get_current_icount();
1348 } else {
1349 sn->icount = -1ULL;
1350 }
Wenchao Xiabbe86012013-09-11 14:04:34 +08001351
1352 ret1 = bdrv_snapshot_create(bs, sn);
1353 if (ret1 < 0) {
1354 error_setg_errno(errp, -ret1,
1355 "Failed to create snapshot '%s' on device '%s'",
1356 name, device);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001357 goto out;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001358 }
1359
1360 /* 4. succeed, mark a snapshot is created */
Fam Zheng507306c2015-10-23 11:08:13 +08001361 state->created = true;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001362
1363out:
1364 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001365}
1366
John Snow50f43f02015-11-05 18:13:09 -05001367static void internal_snapshot_abort(BlkActionState *common)
Wenchao Xiabbe86012013-09-11 14:04:34 +08001368{
1369 InternalSnapshotState *state =
1370 DO_UPCAST(InternalSnapshotState, common, common);
1371 BlockDriverState *bs = state->bs;
1372 QEMUSnapshotInfo *sn = &state->sn;
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001373 AioContext *aio_context;
Wenchao Xiabbe86012013-09-11 14:04:34 +08001374 Error *local_error = NULL;
1375
Fam Zheng507306c2015-10-23 11:08:13 +08001376 if (!state->created) {
Wenchao Xiabbe86012013-09-11 14:04:34 +08001377 return;
1378 }
1379
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001380 aio_context = bdrv_get_aio_context(state->bs);
1381 aio_context_acquire(aio_context);
1382
Wenchao Xiabbe86012013-09-11 14:04:34 +08001383 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
Markus Armbrusterc29b77f2015-12-18 16:35:14 +01001384 error_reportf_err(local_error,
1385 "Failed to delete snapshot with id '%s' and "
1386 "name '%s' on device '%s' in abort: ",
1387 sn->id_str, sn->name,
1388 bdrv_get_device_name(bs));
Wenchao Xiabbe86012013-09-11 14:04:34 +08001389 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001390
1391 aio_context_release(aio_context);
Wenchao Xiabbe86012013-09-11 14:04:34 +08001392}
1393
John Snow50f43f02015-11-05 18:13:09 -05001394static void internal_snapshot_clean(BlkActionState *common)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001395{
1396 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1397 common, common);
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001398 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001399
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001400 if (!state->bs) {
1401 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001402 }
Stefan Hajnoczia36e4582017-12-06 14:45:46 +00001403
1404 aio_context = bdrv_get_aio_context(state->bs);
1405 aio_context_acquire(aio_context);
1406
1407 bdrv_drained_end(state->bs);
1408
1409 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001410}
1411
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001412/* external snapshot private data */
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001413typedef struct ExternalSnapshotState {
John Snow50f43f02015-11-05 18:13:09 -05001414 BlkActionState common;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001415 BlockDriverState *old_bs;
1416 BlockDriverState *new_bs;
Kevin Wolf067acf22017-03-02 15:26:18 +01001417 bool overlay_appended;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001418} ExternalSnapshotState;
Jeff Cody8802d1f2012-02-28 15:54:06 -05001419
John Snow50f43f02015-11-05 18:13:09 -05001420static void external_snapshot_prepare(BlkActionState *common,
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001421 Error **errp)
1422{
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001423 int ret;
Max Reitz5b363932016-05-17 16:41:31 +02001424 int flags = 0;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001425 QDict *options = NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001426 Error *local_err = NULL;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001427 /* Device and node name of the image to generate the snapshot from */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001428 const char *device;
Benoît Canet0901f672014-01-23 21:31:38 +01001429 const char *node_name;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001430 /* Reference to the new image (for 'blockdev-snapshot') */
1431 const char *snapshot_ref;
1432 /* File name of the new image (for 'blockdev-snapshot-sync') */
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001433 const char *new_image_file;
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001434 ExternalSnapshotState *state =
1435 DO_UPCAST(ExternalSnapshotState, common, common);
Kevin Wolfc8a83e82013-05-13 10:43:43 +02001436 TransactionAction *action = common->action;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001437 AioContext *aio_context;
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001438 uint64_t perm, shared;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001439
Alberto Garcia43de7e22015-10-26 14:27:16 +02001440 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1441 * purpose but a different set of parameters */
1442 switch (action->type) {
1443 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1444 {
Eric Blake32bafa82016-03-17 16:48:37 -06001445 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001446 device = s->node;
1447 node_name = s->node;
1448 new_image_file = NULL;
1449 snapshot_ref = s->overlay;
1450 }
1451 break;
1452 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1453 {
Eric Blake32bafa82016-03-17 16:48:37 -06001454 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001455 device = s->has_device ? s->device : NULL;
1456 node_name = s->has_node_name ? s->node_name : NULL;
1457 new_image_file = s->snapshot_file;
1458 snapshot_ref = NULL;
1459 }
1460 break;
1461 default:
1462 g_assert_not_reached();
Wenchao Xiae2a31e82013-05-08 18:25:13 +08001463 }
1464
1465 /* start processing */
John Snow94d16a62015-11-05 18:13:18 -05001466 if (action_check_completion_mode(common, errp) < 0) {
1467 return;
1468 }
1469
Alberto Garcia43de7e22015-10-26 14:27:16 +02001470 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1471 if (!state->old_bs) {
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001472 return;
1473 }
1474
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001475 aio_context = bdrv_get_aio_context(state->old_bs);
1476 aio_context_acquire(aio_context);
1477
1478 /* Paired with .clean() */
Fam Zhengda763e82015-10-23 11:08:10 +08001479 bdrv_drained_begin(state->old_bs);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001480
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001481 if (!bdrv_is_inserted(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001482 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001483 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001484 }
1485
Fam Zheng3718d8a2014-05-23 21:29:43 +08001486 if (bdrv_op_is_blocked(state->old_bs,
1487 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001488 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001489 }
1490
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001491 if (!bdrv_is_read_only(state->old_bs)) {
1492 if (bdrv_flush(state->old_bs)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01001493 error_setg(errp, QERR_IO_ERROR);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001494 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001495 }
1496 }
1497
Alberto Garcia43de7e22015-10-26 14:27:16 +02001498 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
Eric Blake32bafa82016-03-17 16:48:37 -06001499 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001500 const char *format = s->has_format ? s->format : "qcow2";
1501 enum NewImageMode mode;
1502 const char *snapshot_node_name =
1503 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001504
Alberto Garcia43de7e22015-10-26 14:27:16 +02001505 if (node_name && !snapshot_node_name) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001506 error_setg(errp, "New overlay node-name missing");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001507 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001508 }
Alberto Garcia43de7e22015-10-26 14:27:16 +02001509
1510 if (snapshot_node_name &&
1511 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06001512 error_setg(errp, "New overlay node-name already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001513 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001514 }
1515
1516 flags = state->old_bs->open_flags;
John Snow2a32c6e2017-07-17 20:34:21 -04001517 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1518 flags |= BDRV_O_NO_BACKING;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001519
1520 /* create new image w/backing file */
1521 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1522 if (mode != NEW_IMAGE_MODE_EXISTING) {
Kevin Wolff86b8b52016-03-02 12:16:44 +01001523 int64_t size = bdrv_getlength(state->old_bs);
1524 if (size < 0) {
1525 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001526 goto out;
Kevin Wolff86b8b52016-03-02 12:16:44 +01001527 }
Max Reitzf30c66b2019-02-01 20:29:05 +01001528 bdrv_refresh_filename(state->old_bs);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001529 bdrv_img_create(new_image_file, format,
1530 state->old_bs->filename,
1531 state->old_bs->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08001532 NULL, size, flags, false, &local_err);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001533 if (local_err) {
1534 error_propagate(errp, local_err);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001535 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001536 }
1537 }
1538
1539 options = qdict_new();
Peter Maydelld52e1a02018-11-01 16:30:37 +00001540 if (snapshot_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05001541 qdict_put_str(options, "node-name", snapshot_node_name);
Alberto Garcia43de7e22015-10-26 14:27:16 +02001542 }
Eric Blake46f5ac22017-04-27 16:58:17 -05001543 qdict_put_str(options, "driver", format);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001544 }
1545
Max Reitz5b363932016-05-17 16:41:31 +02001546 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1547 errp);
Max Reitzf67503e2014-02-18 18:33:05 +01001548 /* We will manually add the backing_hd field to the bs later */
Max Reitz5b363932016-05-17 16:41:31 +02001549 if (!state->new_bs) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001550 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001551 }
1552
Kevin Wolfd29d3d12020-03-10 12:38:26 +01001553 /*
1554 * Allow attaching a backing file to an overlay that's already in use only
1555 * if the parents don't assume that they are already seeing a valid image.
1556 * (Specifically, allow it as a mirror target, which is write-only access.)
1557 */
1558 bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1559 if (perm & BLK_PERM_CONSISTENT_READ) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001560 error_setg(errp, "The overlay is already in use");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001561 goto out;
Alberto Garcia43de7e22015-10-26 14:27:16 +02001562 }
1563
Max Reitz7cc734a2019-06-12 18:34:46 +02001564 if (state->new_bs->drv->is_filter) {
1565 error_setg(errp, "Filters cannot be used as overlays");
1566 goto out;
1567 }
1568
1569 if (bdrv_cow_child(state->new_bs)) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001570 error_setg(errp, "The overlay already has a backing image");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001571 goto out;
Alberto Garcia08b24cf2015-11-03 12:32:35 +02001572 }
1573
1574 if (!state->new_bs->drv->supports_backing) {
Max Reitza2bb6f82019-06-03 22:22:36 +02001575 error_setg(errp, "The overlay does not support backing images");
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001576 goto out;
Kevin Wolfb2c28322017-02-20 12:46:42 +01001577 }
1578
Vladimir Sementsov-Ogievskiy934aee12021-02-02 15:49:44 +03001579 ret = bdrv_append(state->new_bs, state->old_bs, errp);
1580 if (ret < 0) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001581 goto out;
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001582 }
Kevin Wolf067acf22017-03-02 15:26:18 +01001583 state->overlay_appended = true;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001584
1585out:
1586 aio_context_release(aio_context);
Wenchao Xia9b9877e2013-05-08 18:25:12 +08001587}
1588
John Snow50f43f02015-11-05 18:13:09 -05001589static void external_snapshot_commit(BlkActionState *common)
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001590{
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001591 ExternalSnapshotState *state =
1592 DO_UPCAST(ExternalSnapshotState, common, common);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001593 AioContext *aio_context;
1594
1595 aio_context = bdrv_get_aio_context(state->old_bs);
1596 aio_context_acquire(aio_context);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08001597
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001598 /* We don't need (or want) to use the transactional
1599 * bdrv_reopen_multiple() across all the entries at once, because we
1600 * don't want to abort all of them if one of them fails the reopen */
Stefan Hajnoczid73415a2020-09-23 11:56:46 +01001601 if (!qatomic_read(&state->old_bs->copy_on_read)) {
Alberto Garcia1b577742018-11-12 16:00:39 +02001602 bdrv_reopen_set_read_only(state->old_bs, true, NULL);
Kevin Wolf4c844982016-02-29 13:12:26 +01001603 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001604
1605 aio_context_release(aio_context);
Wenchao Xia3b0047e2013-05-08 18:25:14 +08001606}
1607
John Snow50f43f02015-11-05 18:13:09 -05001608static void external_snapshot_abort(BlkActionState *common)
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001609{
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02001610 ExternalSnapshotState *state =
1611 DO_UPCAST(ExternalSnapshotState, common, common);
1612 if (state->new_bs) {
Kevin Wolf067acf22017-03-02 15:26:18 +01001613 if (state->overlay_appended) {
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001614 AioContext *aio_context;
Sergio Lopez377410f2020-01-08 15:31:37 +01001615 AioContext *tmp_context;
1616 int ret;
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001617
1618 aio_context = bdrv_get_aio_context(state->old_bs);
1619 aio_context_acquire(aio_context);
1620
Jeff Cody719fc282017-06-07 09:55:22 -04001621 bdrv_ref(state->old_bs); /* we can't let bdrv_set_backind_hd()
1622 close state->old_bs; we need it */
1623 bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
Sergio Lopez377410f2020-01-08 15:31:37 +01001624
1625 /*
1626 * The call to bdrv_set_backing_hd() above returns state->old_bs to
1627 * the main AioContext. As we're still going to be using it, return
1628 * it to the AioContext it was before.
1629 */
1630 tmp_context = bdrv_get_aio_context(state->old_bs);
1631 if (aio_context != tmp_context) {
1632 aio_context_release(aio_context);
1633 aio_context_acquire(tmp_context);
1634
1635 ret = bdrv_try_set_aio_context(state->old_bs,
1636 aio_context, NULL);
1637 assert(ret == 0);
1638
1639 aio_context_release(tmp_context);
1640 aio_context_acquire(aio_context);
1641 }
1642
Kevin Wolf5fe31c22017-03-06 16:20:51 +01001643 bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
Jeff Cody719fc282017-06-07 09:55:22 -04001644 bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001645
1646 aio_context_release(aio_context);
Kevin Wolfb2c28322017-02-20 12:46:42 +01001647 }
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001648 }
Fam Zhengda763e82015-10-23 11:08:10 +08001649}
1650
John Snow50f43f02015-11-05 18:13:09 -05001651static void external_snapshot_clean(BlkActionState *common)
Fam Zhengda763e82015-10-23 11:08:10 +08001652{
1653 ExternalSnapshotState *state =
1654 DO_UPCAST(ExternalSnapshotState, common, common);
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001655 AioContext *aio_context;
1656
1657 if (!state->old_bs) {
1658 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001659 }
Stefan Hajnoczi2d24b602017-12-06 14:45:43 +00001660
1661 aio_context = bdrv_get_aio_context(state->old_bs);
1662 aio_context_acquire(aio_context);
1663
1664 bdrv_drained_end(state->old_bs);
1665 bdrv_unref(state->new_bs);
1666
1667 aio_context_release(aio_context);
Wenchao Xia96b86bf2013-05-08 18:25:15 +08001668}
1669
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001670typedef struct DriveBackupState {
John Snow50f43f02015-11-05 18:13:09 -05001671 BlkActionState common;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001672 BlockDriverState *bs;
1673 BlockJob *job;
1674} DriveBackupState;
1675
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001676static BlockJob *do_backup_common(BackupCommon *backup,
1677 BlockDriverState *bs,
1678 BlockDriverState *target_bs,
1679 AioContext *aio_context,
1680 JobTxn *txn, Error **errp);
John Snow78f51fd2015-11-05 18:13:17 -05001681
John Snow50f43f02015-11-05 18:13:09 -05001682static void drive_backup_prepare(BlkActionState *common, Error **errp)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001683{
1684 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1685 DriveBackup *backup;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001686 BlockDriverState *bs;
1687 BlockDriverState *target_bs;
1688 BlockDriverState *source = NULL;
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001689 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001690 AioContext *old_context;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001691 QDict *options;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001692 Error *local_err = NULL;
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001693 int flags;
1694 int64_t size;
1695 bool set_backing_hd = false;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001696 int ret;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001697
Eric Blake6a8f9662015-10-26 16:34:54 -06001698 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
Eric Blake32bafa82016-03-17 16:48:37 -06001699 backup = common->action->u.drive_backup.data;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001700
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001701 if (!backup->has_mode) {
1702 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1703 }
1704
Vladimir Sementsov-Ogievskiy85c9d132019-06-18 17:08:04 +03001705 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001706 if (!bs) {
Fam Zheng1fdd4b72015-10-23 11:08:11 +08001707 return;
1708 }
1709
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001710 if (!bs->drv) {
1711 error_setg(errp, "Device has no medium");
1712 return;
1713 }
1714
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001715 aio_context = bdrv_get_aio_context(bs);
1716 aio_context_acquire(aio_context);
1717
1718 /* Paired with .clean() */
Kevin Wolfb7e4fa22016-06-23 14:20:24 +02001719 bdrv_drained_begin(bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001720
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001721 if (!backup->has_format) {
1722 backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
1723 NULL : (char *) bs->drv->format_name;
1724 }
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001725
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001726 /* Early check to avoid creating target */
1727 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
1728 goto out;
1729 }
1730
1731 flags = bs->open_flags | BDRV_O_RDWR;
1732
1733 /*
1734 * See if we have a backing HD we can use to create our new image
1735 * on top of.
1736 */
1737 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
Max Reitz2b088c62019-06-12 17:46:45 +02001738 /*
1739 * Backup will not replace the source by the target, so none
1740 * of the filters skipped here will be removed (in contrast to
1741 * mirror). Therefore, we can skip all of them when looking
1742 * for the first COW relationship.
1743 */
1744 source = bdrv_cow_bs(bdrv_skip_filters(bs));
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001745 if (!source) {
1746 backup->sync = MIRROR_SYNC_MODE_FULL;
1747 }
1748 }
1749 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1750 source = bs;
1751 flags |= BDRV_O_NO_BACKING;
1752 set_backing_hd = true;
1753 }
1754
1755 size = bdrv_getlength(bs);
1756 if (size < 0) {
1757 error_setg_errno(errp, -size, "bdrv_getlength failed");
1758 goto out;
1759 }
1760
1761 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
1762 assert(backup->format);
1763 if (source) {
Max Reitz2b088c62019-06-12 17:46:45 +02001764 /* Implicit filters should not appear in the filename */
1765 BlockDriverState *explicit_backing =
1766 bdrv_skip_implicit_filters(source);
1767
1768 bdrv_refresh_filename(explicit_backing);
1769 bdrv_img_create(backup->target, backup->format,
1770 explicit_backing->filename,
1771 explicit_backing->drv->format_name, NULL,
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001772 size, flags, false, &local_err);
1773 } else {
1774 bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
1775 size, flags, false, &local_err);
1776 }
1777 }
1778
Markus Armbruster84d18f02014-01-30 15:07:28 +01001779 if (local_err) {
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001780 error_propagate(errp, local_err);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001781 goto out;
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001782 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001783
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001784 options = qdict_new();
1785 qdict_put_str(options, "discard", "unmap");
1786 qdict_put_str(options, "detect-zeroes", "unmap");
1787 if (backup->format) {
1788 qdict_put_str(options, "driver", backup->format);
1789 }
1790
1791 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
1792 if (!target_bs) {
1793 goto out;
1794 }
1795
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001796 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
1797 old_context = bdrv_get_aio_context(target_bs);
1798 aio_context_release(aio_context);
1799 aio_context_acquire(old_context);
1800
1801 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1802 if (ret < 0) {
1803 bdrv_unref(target_bs);
1804 aio_context_release(old_context);
1805 return;
1806 }
1807
1808 aio_context_release(old_context);
1809 aio_context_acquire(aio_context);
1810
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001811 if (set_backing_hd) {
Vladimir Sementsov-Ogievskiy5a11a1c2021-02-02 15:49:46 +03001812 if (bdrv_set_backing_hd(target_bs, source, errp) < 0) {
Sergio Lopez2288ccf2020-01-08 15:31:32 +01001813 goto unref;
1814 }
1815 }
1816
1817 state->bs = bs;
1818
1819 state->job = do_backup_common(qapi_DriveBackup_base(backup),
1820 bs, target_bs, aio_context,
1821 common->block_job_txn, errp);
1822
1823unref:
1824 bdrv_unref(target_bs);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001825out:
1826 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001827}
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001828
John Snow111049a2016-11-08 01:50:38 -05001829static void drive_backup_commit(BlkActionState *common)
1830{
1831 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001832 AioContext *aio_context;
1833
1834 aio_context = bdrv_get_aio_context(state->bs);
1835 aio_context_acquire(aio_context);
1836
John Snow111049a2016-11-08 01:50:38 -05001837 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001838 job_start(&state->job->job);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001839
1840 aio_context_release(aio_context);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001841}
1842
John Snow50f43f02015-11-05 18:13:09 -05001843static void drive_backup_abort(BlkActionState *common)
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001844{
1845 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001846
John Snow111049a2016-11-08 01:50:38 -05001847 if (state->job) {
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001848 AioContext *aio_context;
1849
1850 aio_context = bdrv_get_aio_context(state->bs);
1851 aio_context_acquire(aio_context);
1852
Kevin Wolf3d70ff52018-04-24 16:13:52 +02001853 job_cancel_sync(&state->job->job);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001854
1855 aio_context_release(aio_context);
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02001856 }
1857}
1858
John Snow50f43f02015-11-05 18:13:09 -05001859static void drive_backup_clean(BlkActionState *common)
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001860{
1861 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001862 AioContext *aio_context;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001863
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001864 if (!state->bs) {
1865 return;
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001866 }
Stefan Hajnoczi66d56052017-12-06 14:45:44 +00001867
1868 aio_context = bdrv_get_aio_context(state->bs);
1869 aio_context_acquire(aio_context);
1870
1871 bdrv_drained_end(state->bs);
1872
1873 aio_context_release(aio_context);
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00001874}
1875
Fam Zhengbd8baec2014-12-18 18:37:06 +08001876typedef struct BlockdevBackupState {
John Snow50f43f02015-11-05 18:13:09 -05001877 BlkActionState common;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001878 BlockDriverState *bs;
1879 BlockJob *job;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001880} BlockdevBackupState;
1881
John Snow50f43f02015-11-05 18:13:09 -05001882static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001883{
1884 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1885 BlockdevBackup *backup;
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001886 BlockDriverState *bs;
1887 BlockDriverState *target_bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001888 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001889 AioContext *old_context;
1890 int ret;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001891
Eric Blake6a8f9662015-10-26 16:34:54 -06001892 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
Eric Blake32bafa82016-03-17 16:48:37 -06001893 backup = common->action->u.blockdev_backup.data;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001894
Vladimir Sementsov-Ogievskiy930fe172018-07-02 15:46:29 -04001895 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001896 if (!bs) {
Fam Zhengff52bf32015-10-23 11:08:12 +08001897 return;
1898 }
1899
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001900 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1901 if (!target_bs) {
Fam Zhengbd8baec2014-12-18 18:37:06 +08001902 return;
1903 }
1904
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001905 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001906 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01001907 old_context = bdrv_get_aio_context(target_bs);
1908 aio_context_acquire(old_context);
1909
1910 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1911 if (ret < 0) {
1912 aio_context_release(old_context);
1913 return;
1914 }
1915
1916 aio_context_release(old_context);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001917 aio_context_acquire(aio_context);
Kevin Wolfcef34ee2016-06-23 14:20:24 +02001918 state->bs = bs;
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001919
1920 /* Paired with .clean() */
Fam Zhengff52bf32015-10-23 11:08:12 +08001921 bdrv_drained_begin(state->bs);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001922
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01001923 state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1924 bs, target_bs, aio_context,
1925 common->block_job_txn, errp);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001926
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001927 aio_context_release(aio_context);
John Snow111049a2016-11-08 01:50:38 -05001928}
Fam Zhengbd8baec2014-12-18 18:37:06 +08001929
John Snow111049a2016-11-08 01:50:38 -05001930static void blockdev_backup_commit(BlkActionState *common)
1931{
1932 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001933 AioContext *aio_context;
1934
1935 aio_context = bdrv_get_aio_context(state->bs);
1936 aio_context_acquire(aio_context);
1937
John Snow111049a2016-11-08 01:50:38 -05001938 assert(state->job);
Kevin Wolfda01ff72018-04-13 17:31:02 +02001939 job_start(&state->job->job);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001940
1941 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001942}
1943
John Snow50f43f02015-11-05 18:13:09 -05001944static void blockdev_backup_abort(BlkActionState *common)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001945{
1946 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001947
John Snow111049a2016-11-08 01:50:38 -05001948 if (state->job) {
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001949 AioContext *aio_context;
1950
1951 aio_context = bdrv_get_aio_context(state->bs);
1952 aio_context_acquire(aio_context);
1953
Kevin Wolf3d70ff52018-04-24 16:13:52 +02001954 job_cancel_sync(&state->job->job);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001955
1956 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001957 }
1958}
1959
John Snow50f43f02015-11-05 18:13:09 -05001960static void blockdev_backup_clean(BlkActionState *common)
Fam Zhengbd8baec2014-12-18 18:37:06 +08001961{
1962 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001963 AioContext *aio_context;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001964
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001965 if (!state->bs) {
1966 return;
Fam Zhengbd8baec2014-12-18 18:37:06 +08001967 }
Stefan Hajnocziedd5ade2017-12-06 14:45:45 +00001968
1969 aio_context = bdrv_get_aio_context(state->bs);
1970 aio_context_acquire(aio_context);
1971
1972 bdrv_drained_end(state->bs);
1973
1974 aio_context_release(aio_context);
Fam Zhengbd8baec2014-12-18 18:37:06 +08001975}
1976
Fam Zhengdf9a6812015-11-09 18:16:54 +08001977typedef struct BlockDirtyBitmapState {
John Snow50f43f02015-11-05 18:13:09 -05001978 BlkActionState common;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001979 BdrvDirtyBitmap *bitmap;
1980 BlockDriverState *bs;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001981 HBitmap *backup;
1982 bool prepared;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04001983 bool was_enabled;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001984} BlockDirtyBitmapState;
1985
John Snow50f43f02015-11-05 18:13:09 -05001986static void block_dirty_bitmap_add_prepare(BlkActionState *common,
Fam Zhengdf9a6812015-11-09 18:16:54 +08001987 Error **errp)
1988{
1989 Error *local_err = NULL;
1990 BlockDirtyBitmapAdd *action;
1991 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1992 common, common);
1993
John Snow94d16a62015-11-05 18:13:18 -05001994 if (action_check_completion_mode(common, errp) < 0) {
1995 return;
1996 }
1997
Eric Blake32bafa82016-03-17 16:48:37 -06001998 action = common->action->u.block_dirty_bitmap_add.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08001999 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2000 qmp_block_dirty_bitmap_add(action->node, action->name,
2001 action->has_granularity, action->granularity,
Vladimir Sementsov-Ogievskiyfd5ae4c2017-06-28 15:05:23 +03002002 action->has_persistent, action->persistent,
John Snow0e2b7f02018-12-21 04:35:22 -05002003 action->has_disabled, action->disabled,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002004 &local_err);
2005
2006 if (!local_err) {
2007 state->prepared = true;
2008 } else {
2009 error_propagate(errp, local_err);
2010 }
2011}
2012
John Snow50f43f02015-11-05 18:13:09 -05002013static void block_dirty_bitmap_add_abort(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002014{
2015 BlockDirtyBitmapAdd *action;
2016 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2017 common, common);
2018
Eric Blake32bafa82016-03-17 16:48:37 -06002019 action = common->action->u.block_dirty_bitmap_add.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002020 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2021 * then the node reference and bitmap name must have been valid.
2022 */
2023 if (state->prepared) {
2024 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2025 }
2026}
2027
John Snow50f43f02015-11-05 18:13:09 -05002028static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002029 Error **errp)
2030{
2031 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2032 common, common);
2033 BlockDirtyBitmap *action;
2034
John Snow94d16a62015-11-05 18:13:18 -05002035 if (action_check_completion_mode(common, errp) < 0) {
2036 return;
2037 }
2038
Eric Blake32bafa82016-03-17 16:48:37 -06002039 action = common->action->u.block_dirty_bitmap_clear.data;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002040 state->bitmap = block_dirty_bitmap_lookup(action->node,
2041 action->name,
2042 &state->bs,
Fam Zhengdf9a6812015-11-09 18:16:54 +08002043 errp);
2044 if (!state->bitmap) {
2045 return;
2046 }
2047
John Snow3ae96d62019-03-12 12:05:49 -04002048 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
Vladimir Sementsov-Ogievskiyd6883bc2017-06-28 15:05:10 +03002049 return;
Fam Zhengdf9a6812015-11-09 18:16:54 +08002050 }
2051
2052 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
Fam Zhengdf9a6812015-11-09 18:16:54 +08002053}
2054
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002055static void block_dirty_bitmap_restore(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002056{
2057 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2058 common, common);
2059
John Snow184dd9c2017-03-15 17:28:11 -04002060 if (state->backup) {
Vladimir Sementsov-Ogievskiy56bd6622018-10-29 16:23:14 -04002061 bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
John Snow184dd9c2017-03-15 17:28:11 -04002062 }
Fam Zhengdf9a6812015-11-09 18:16:54 +08002063}
2064
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002065static void block_dirty_bitmap_free_backup(BlkActionState *common)
Fam Zhengdf9a6812015-11-09 18:16:54 +08002066{
2067 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2068 common, common);
2069
2070 hbitmap_free(state->backup);
2071}
2072
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002073static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2074 Error **errp)
2075{
2076 BlockDirtyBitmap *action;
2077 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2078 common, common);
2079
2080 if (action_check_completion_mode(common, errp) < 0) {
2081 return;
2082 }
2083
John Snow0e2b7f02018-12-21 04:35:22 -05002084 action = common->action->u.block_dirty_bitmap_enable.data;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002085 state->bitmap = block_dirty_bitmap_lookup(action->node,
2086 action->name,
2087 NULL,
2088 errp);
2089 if (!state->bitmap) {
2090 return;
2091 }
2092
John Snow3ae96d62019-03-12 12:05:49 -04002093 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04002094 return;
2095 }
2096
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002097 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2098 bdrv_enable_dirty_bitmap(state->bitmap);
2099}
2100
2101static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2102{
2103 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2104 common, common);
2105
2106 if (!state->was_enabled) {
2107 bdrv_disable_dirty_bitmap(state->bitmap);
2108 }
2109}
2110
2111static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2112 Error **errp)
2113{
2114 BlockDirtyBitmap *action;
2115 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2116 common, common);
2117
2118 if (action_check_completion_mode(common, errp) < 0) {
2119 return;
2120 }
2121
John Snow0e2b7f02018-12-21 04:35:22 -05002122 action = common->action->u.block_dirty_bitmap_disable.data;
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002123 state->bitmap = block_dirty_bitmap_lookup(action->node,
2124 action->name,
2125 NULL,
2126 errp);
2127 if (!state->bitmap) {
2128 return;
2129 }
2130
John Snow3ae96d62019-03-12 12:05:49 -04002131 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snowb053bb52018-10-29 16:23:16 -04002132 return;
2133 }
2134
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002135 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2136 bdrv_disable_dirty_bitmap(state->bitmap);
2137}
2138
2139static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2140{
2141 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2142 common, common);
2143
2144 if (state->was_enabled) {
2145 bdrv_enable_dirty_bitmap(state->bitmap);
2146 }
2147}
2148
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002149static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2150 Error **errp)
2151{
2152 BlockDirtyBitmapMerge *action;
2153 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2154 common, common);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002155
2156 if (action_check_completion_mode(common, errp) < 0) {
2157 return;
2158 }
2159
John Snow0e2b7f02018-12-21 04:35:22 -05002160 action = common->action->u.block_dirty_bitmap_merge.data;
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002161
Eric Blakec6996cf2020-05-12 20:16:43 -05002162 state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2163 action->bitmaps, &state->backup,
2164 errp);
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002165}
2166
John Snowc4e4b0f2019-07-29 16:35:54 -04002167static void block_dirty_bitmap_remove_prepare(BlkActionState *common,
2168 Error **errp)
2169{
2170 BlockDirtyBitmap *action;
2171 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2172 common, common);
2173
2174 if (action_check_completion_mode(common, errp) < 0) {
2175 return;
2176 }
2177
2178 action = common->action->u.block_dirty_bitmap_remove.data;
2179
Eric Blakec6996cf2020-05-12 20:16:43 -05002180 state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2181 false, &state->bs, errp);
John Snowc4e4b0f2019-07-29 16:35:54 -04002182 if (state->bitmap) {
2183 bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2184 bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2185 }
2186}
2187
2188static void block_dirty_bitmap_remove_abort(BlkActionState *common)
2189{
2190 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2191 common, common);
2192
2193 if (state->bitmap) {
2194 bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2195 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2196 }
2197}
2198
2199static void block_dirty_bitmap_remove_commit(BlkActionState *common)
2200{
2201 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2202 common, common);
2203
2204 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
Vladimir Sementsov-Ogievskiy5deb6cb2019-09-16 17:19:09 +03002205 bdrv_release_dirty_bitmap(state->bitmap);
John Snowc4e4b0f2019-07-29 16:35:54 -04002206}
2207
John Snow50f43f02015-11-05 18:13:09 -05002208static void abort_prepare(BlkActionState *common, Error **errp)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002209{
2210 error_setg(errp, "Transaction aborted using Abort action");
2211}
2212
John Snow50f43f02015-11-05 18:13:09 -05002213static void abort_commit(BlkActionState *common)
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002214{
Stefan Weildfc6f862013-07-25 18:21:28 +02002215 g_assert_not_reached(); /* this action never succeeds */
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002216}
2217
John Snow50f43f02015-11-05 18:13:09 -05002218static const BlkActionOps actions[] = {
Alberto Garcia43de7e22015-10-26 14:27:16 +02002219 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2220 .instance_size = sizeof(ExternalSnapshotState),
2221 .prepare = external_snapshot_prepare,
2222 .commit = external_snapshot_commit,
2223 .abort = external_snapshot_abort,
Alberto Garcia4ad6f3d2015-11-13 15:00:24 +02002224 .clean = external_snapshot_clean,
Alberto Garcia43de7e22015-10-26 14:27:16 +02002225 },
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002226 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002227 .instance_size = sizeof(ExternalSnapshotState),
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002228 .prepare = external_snapshot_prepare,
2229 .commit = external_snapshot_commit,
2230 .abort = external_snapshot_abort,
Fam Zhengda763e82015-10-23 11:08:10 +08002231 .clean = external_snapshot_clean,
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002232 },
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002233 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2234 .instance_size = sizeof(DriveBackupState),
2235 .prepare = drive_backup_prepare,
John Snow111049a2016-11-08 01:50:38 -05002236 .commit = drive_backup_commit,
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002237 .abort = drive_backup_abort,
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00002238 .clean = drive_backup_clean,
Stefan Hajnoczi3037f362013-06-24 17:13:17 +02002239 },
Fam Zhengbd8baec2014-12-18 18:37:06 +08002240 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2241 .instance_size = sizeof(BlockdevBackupState),
2242 .prepare = blockdev_backup_prepare,
John Snow111049a2016-11-08 01:50:38 -05002243 .commit = blockdev_backup_commit,
Fam Zhengbd8baec2014-12-18 18:37:06 +08002244 .abort = blockdev_backup_abort,
2245 .clean = blockdev_backup_clean,
2246 },
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002247 [TRANSACTION_ACTION_KIND_ABORT] = {
John Snow50f43f02015-11-05 18:13:09 -05002248 .instance_size = sizeof(BlkActionState),
Stefan Hajnoczi78b18b72013-06-24 17:13:18 +02002249 .prepare = abort_prepare,
2250 .commit = abort_commit,
2251 },
Wenchao Xiabbe86012013-09-11 14:04:34 +08002252 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2253 .instance_size = sizeof(InternalSnapshotState),
2254 .prepare = internal_snapshot_prepare,
2255 .abort = internal_snapshot_abort,
Stefan Hajnoczi5d6e96e2014-11-21 10:48:59 +00002256 .clean = internal_snapshot_clean,
Wenchao Xiabbe86012013-09-11 14:04:34 +08002257 },
Fam Zhengdf9a6812015-11-09 18:16:54 +08002258 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2259 .instance_size = sizeof(BlockDirtyBitmapState),
2260 .prepare = block_dirty_bitmap_add_prepare,
2261 .abort = block_dirty_bitmap_add_abort,
2262 },
2263 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2264 .instance_size = sizeof(BlockDirtyBitmapState),
2265 .prepare = block_dirty_bitmap_clear_prepare,
Vladimir Sementsov-Ogievskiy5c4cf8b2018-10-29 16:23:15 -04002266 .commit = block_dirty_bitmap_free_backup,
2267 .abort = block_dirty_bitmap_restore,
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002268 },
John Snow0e2b7f02018-12-21 04:35:22 -05002269 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002270 .instance_size = sizeof(BlockDirtyBitmapState),
2271 .prepare = block_dirty_bitmap_enable_prepare,
2272 .abort = block_dirty_bitmap_enable_abort,
2273 },
John Snow0e2b7f02018-12-21 04:35:22 -05002274 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
Vladimir Sementsov-Ogievskiyc6490442018-06-11 14:53:32 -04002275 .instance_size = sizeof(BlockDirtyBitmapState),
2276 .prepare = block_dirty_bitmap_disable_prepare,
2277 .abort = block_dirty_bitmap_disable_abort,
John Snow66da04d2018-09-06 09:02:25 -04002278 },
John Snow0e2b7f02018-12-21 04:35:22 -05002279 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
Vladimir Sementsov-Ogievskiy6fd2e402018-10-29 16:23:15 -04002280 .instance_size = sizeof(BlockDirtyBitmapState),
2281 .prepare = block_dirty_bitmap_merge_prepare,
2282 .commit = block_dirty_bitmap_free_backup,
2283 .abort = block_dirty_bitmap_restore,
2284 },
John Snowc4e4b0f2019-07-29 16:35:54 -04002285 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE] = {
2286 .instance_size = sizeof(BlockDirtyBitmapState),
2287 .prepare = block_dirty_bitmap_remove_prepare,
2288 .commit = block_dirty_bitmap_remove_commit,
2289 .abort = block_dirty_bitmap_remove_abort,
2290 },
John Snow66da04d2018-09-06 09:02:25 -04002291 /* Where are transactions for MIRROR, COMMIT and STREAM?
2292 * Although these blockjobs use transaction callbacks like the backup job,
2293 * these jobs do not necessarily adhere to transaction semantics.
2294 * These jobs may not fully undo all of their actions on abort, nor do they
2295 * necessarily work in transactions with more than one job in them.
2296 */
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002297};
2298
John Snow94d16a62015-11-05 18:13:18 -05002299/**
2300 * Allocate a TransactionProperties structure if necessary, and fill
2301 * that structure with desired defaults if they are unset.
2302 */
2303static TransactionProperties *get_transaction_properties(
2304 TransactionProperties *props)
2305{
2306 if (!props) {
2307 props = g_new0(TransactionProperties, 1);
2308 }
2309
2310 if (!props->has_completion_mode) {
2311 props->has_completion_mode = true;
2312 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2313 }
2314
2315 return props;
2316}
2317
Jeff Cody8802d1f2012-02-28 15:54:06 -05002318/*
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002319 * 'Atomic' group operations. The operations are performed as a set, and if
2320 * any fail then we roll back all operations in the group.
Jeff Cody8802d1f2012-02-28 15:54:06 -05002321 */
John Snow94d16a62015-11-05 18:13:18 -05002322void qmp_transaction(TransactionActionList *dev_list,
2323 bool has_props,
2324 struct TransactionProperties *props,
2325 Error **errp)
Jeff Cody8802d1f2012-02-28 15:54:06 -05002326{
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002327 TransactionActionList *dev_entry = dev_list;
Kevin Wolf62c9e412018-04-19 16:09:52 +02002328 JobTxn *block_job_txn = NULL;
John Snow50f43f02015-11-05 18:13:09 -05002329 BlkActionState *state, *next;
Luiz Capitulino43e17042012-11-30 10:52:07 -02002330 Error *local_err = NULL;
Jeff Cody8802d1f2012-02-28 15:54:06 -05002331
John Snowf4de0f82019-01-11 11:59:16 -06002332 QTAILQ_HEAD(, BlkActionState) snap_bdrv_states;
2333 QTAILQ_INIT(&snap_bdrv_states);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002334
John Snow94d16a62015-11-05 18:13:18 -05002335 /* Does this transaction get canceled as a group on failure?
Kevin Wolf62c9e412018-04-19 16:09:52 +02002336 * If not, we don't really need to make a JobTxn.
John Snow94d16a62015-11-05 18:13:18 -05002337 */
2338 props = get_transaction_properties(props);
2339 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002340 block_job_txn = job_txn_new();
John Snow94d16a62015-11-05 18:13:18 -05002341 }
2342
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002343 /* drain all i/o before any operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002344 bdrv_drain_all();
2345
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002346 /* We don't do anything in this loop that commits us to the operations */
Jeff Cody8802d1f2012-02-28 15:54:06 -05002347 while (NULL != dev_entry) {
Kevin Wolfc8a83e82013-05-13 10:43:43 +02002348 TransactionAction *dev_info = NULL;
John Snow50f43f02015-11-05 18:13:09 -05002349 const BlkActionOps *ops;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002350
Jeff Cody8802d1f2012-02-28 15:54:06 -05002351 dev_info = dev_entry->value;
2352 dev_entry = dev_entry->next;
2353
Eric Blake6a8f9662015-10-26 16:34:54 -06002354 assert(dev_info->type < ARRAY_SIZE(actions));
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002355
Eric Blake6a8f9662015-10-26 16:34:54 -06002356 ops = &actions[dev_info->type];
Max Reitzaa3fe712013-09-12 14:57:27 +02002357 assert(ops->instance_size > 0);
2358
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002359 state = g_malloc0(ops->instance_size);
2360 state->ops = ops;
2361 state->action = dev_info;
John Snow94d16a62015-11-05 18:13:18 -05002362 state->block_job_txn = block_job_txn;
2363 state->txn_props = props;
John Snowf4de0f82019-01-11 11:59:16 -06002364 QTAILQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002365
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002366 state->ops->prepare(state, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002367 if (local_err) {
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002368 error_propagate(errp, local_err);
2369 goto delete_and_fail;
Paolo Bonzini52e7c242012-03-06 18:55:57 +01002370 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002371 }
2372
John Snowf4de0f82019-01-11 11:59:16 -06002373 QTAILQ_FOREACH(state, &snap_bdrv_states, entry) {
Stefan Hajnoczif9ea81e2013-06-24 17:13:16 +02002374 if (state->ops->commit) {
2375 state->ops->commit(state);
2376 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002377 }
2378
2379 /* success */
2380 goto exit;
2381
2382delete_and_fail:
Stefan Hajnoczib756b9c2014-11-21 10:48:57 +00002383 /* failure, and it is all-or-none; roll back all operations */
John Snowf4de0f82019-01-11 11:59:16 -06002384 QTAILQ_FOREACH_REVERSE(state, &snap_bdrv_states, entry) {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002385 if (state->ops->abort) {
2386 state->ops->abort(state);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002387 }
Jeff Cody8802d1f2012-02-28 15:54:06 -05002388 }
2389exit:
John Snowf4de0f82019-01-11 11:59:16 -06002390 QTAILQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002391 if (state->ops->clean) {
2392 state->ops->clean(state);
Wenchao Xiaba0c86a2013-05-08 18:25:16 +08002393 }
Stefan Hajnocziba5d6ab2013-06-24 17:13:15 +02002394 g_free(state);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002395 }
John Snow94d16a62015-11-05 18:13:18 -05002396 if (!has_props) {
2397 qapi_free_TransactionProperties(props);
2398 }
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02002399 job_txn_unref(block_job_txn);
Jeff Cody8802d1f2012-02-28 15:54:06 -05002400}
2401
Vladimir Sementsov-Ogievskiya3b52532017-06-28 15:05:25 +03002402BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2403 const char *name,
2404 Error **errp)
2405{
2406 BdrvDirtyBitmap *bitmap;
2407 BlockDriverState *bs;
2408 BlockDirtyBitmapSha256 *ret = NULL;
2409 char *sha256;
2410
2411 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2412 if (!bitmap || !bs) {
2413 return NULL;
2414 }
2415
2416 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2417 if (sha256 == NULL) {
2418 return NULL;
2419 }
2420
2421 ret = g_new(BlockDirtyBitmapSha256, 1);
2422 ret->sha256 = sha256;
2423
2424 return ret;
2425}
2426
Kevin Wolfeb94b812020-10-05 17:58:55 +02002427void coroutine_fn qmp_block_resize(bool has_device, const char *device,
2428 bool has_node_name, const char *node_name,
2429 int64_t size, Error **errp)
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002430{
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002431 Error *local_err = NULL;
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002432 BlockBackend *blk;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002433 BlockDriverState *bs;
Kevin Wolfeb94b812020-10-05 17:58:55 +02002434 AioContext *old_ctx;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002435
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002436 bs = bdrv_lookup_bs(has_device ? device : NULL,
2437 has_node_name ? node_name : NULL,
2438 &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002439 if (local_err) {
Benoît Canet3b1dbd12014-01-23 21:31:37 +01002440 error_propagate(errp, local_err);
2441 return;
2442 }
2443
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002444 if (size < 0) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002445 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002446 return;
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002447 }
2448
Jeff Cody9c75e162014-06-25 16:55:30 -04002449 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01002450 error_setg(errp, QERR_DEVICE_IN_USE, device);
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002451 return;
Jeff Cody9c75e162014-06-25 16:55:30 -04002452 }
2453
Eric Blakea3aeeab2020-04-28 14:26:46 -05002454 blk = blk_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
2455 if (!blk) {
Kevin Wolfd9dbf252020-12-03 18:23:09 +01002456 return;
Kevin Wolfd7086422017-01-13 19:02:32 +01002457 }
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002458
Kevin Wolf8089eab2020-12-03 18:23:10 +01002459 bdrv_co_lock(bs);
John Snow698bdfa2017-05-10 13:39:45 -04002460 bdrv_drained_begin(bs);
Kevin Wolf8089eab2020-12-03 18:23:10 +01002461 bdrv_co_unlock(bs);
2462
Kevin Wolfeb94b812020-10-05 17:58:55 +02002463 old_ctx = bdrv_co_enter(bs);
Eric Blakea3aeeab2020-04-28 14:26:46 -05002464 blk_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002465 bdrv_co_leave(bs, old_ctx);
Stefan Hajnoczi927e0e72014-08-18 14:52:28 +01002466
Kevin Wolfeb94b812020-10-05 17:58:55 +02002467 bdrv_co_lock(bs);
Kevin Wolf8089eab2020-12-03 18:23:10 +01002468 bdrv_drained_end(bs);
Kevin Wolf7dad9ee2017-02-17 11:23:33 +01002469 blk_unref(blk);
Kevin Wolfeb94b812020-10-05 17:58:55 +02002470 bdrv_co_unlock(bs);
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +01002471}
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002472
Alberto Garcia23233222016-07-05 17:28:59 +03002473void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002474 bool has_base, const char *base,
Alberto Garcia312fe092016-10-28 10:08:19 +03002475 bool has_base_node, const char *base_node,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002476 bool has_backing_file, const char *backing_file,
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002477 bool has_bottom, const char *bottom,
Jeff Cody13d8cc52014-06-25 15:40:11 -04002478 bool has_speed, int64_t speed,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002479 bool has_on_error, BlockdevOnError on_error,
Andrey Shinkevich880747a2020-12-16 09:16:54 +03002480 bool has_filter_node_name, const char *filter_node_name,
John Snow241ca1a2018-09-06 09:02:23 -04002481 bool has_auto_finalize, bool auto_finalize,
2482 bool has_auto_dismiss, bool auto_dismiss,
Paolo Bonzini1d809092012-09-28 17:22:59 +02002483 Error **errp)
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002484{
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002485 BlockDriverState *bs, *iter, *iter_end;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002486 BlockDriverState *base_bs = NULL;
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002487 BlockDriverState *bottom_bs = NULL;
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002488 AioContext *aio_context;
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002489 Error *local_err = NULL;
John Snowcf6320d2018-09-06 09:02:12 -04002490 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002491
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002492 if (has_base && has_base_node) {
2493 error_setg(errp, "'base' and 'base-node' cannot be specified "
2494 "at the same time");
2495 return;
2496 }
2497
2498 if (has_base && has_bottom) {
2499 error_setg(errp, "'base' and 'bottom' cannot be specified "
2500 "at the same time");
2501 return;
2502 }
2503
2504 if (has_bottom && has_base_node) {
2505 error_setg(errp, "'bottom' and 'base-node' cannot be specified "
2506 "at the same time");
2507 return;
2508 }
2509
Paolo Bonzini1d809092012-09-28 17:22:59 +02002510 if (!has_on_error) {
2511 on_error = BLOCKDEV_ON_ERROR_REPORT;
2512 }
2513
Alberto Garcia554b6142016-10-28 10:08:11 +03002514 bs = bdrv_lookup_bs(device, device, errp);
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002515 if (!bs) {
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002516 return;
2517 }
2518
Kevin Wolfb6c1bae2016-06-23 14:20:24 +02002519 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002520 aio_context_acquire(aio_context);
2521
Jeff Cody13d8cc52014-06-25 15:40:11 -04002522 if (has_base) {
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002523 base_bs = bdrv_find_backing_image(bs, base);
2524 if (base_bs == NULL) {
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002525 error_setg(errp, "Can't find '%s' in the backing chain", base);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002526 goto out;
Marcelo Tosattic8c30802012-01-18 14:40:53 +00002527 }
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002528 assert(bdrv_get_aio_context(base_bs) == aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002529 }
2530
Alberto Garcia312fe092016-10-28 10:08:19 +03002531 if (has_base_node) {
2532 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2533 if (!base_bs) {
2534 goto out;
2535 }
2536 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2537 error_setg(errp, "Node '%s' is not a backing image of '%s'",
2538 base_node, device);
2539 goto out;
2540 }
2541 assert(bdrv_get_aio_context(base_bs) == aio_context);
Max Reitzf30c66b2019-02-01 20:29:05 +01002542 bdrv_refresh_filename(base_bs);
Alberto Garcia312fe092016-10-28 10:08:19 +03002543 }
2544
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002545 if (has_bottom) {
2546 bottom_bs = bdrv_lookup_bs(NULL, bottom, errp);
2547 if (!bottom_bs) {
2548 goto out;
2549 }
2550 if (!bottom_bs->drv) {
2551 error_setg(errp, "Node '%s' is not open", bottom);
2552 goto out;
2553 }
2554 if (bottom_bs->drv->is_filter) {
2555 error_setg(errp, "Node '%s' is a filter, use a non-filter node "
2556 "as 'bottom'", bottom);
2557 goto out;
2558 }
2559 if (!bdrv_chain_contains(bs, bottom_bs)) {
2560 error_setg(errp, "Node '%s' is not in a chain starting from '%s'",
2561 bottom, device);
2562 goto out;
2563 }
2564 assert(bdrv_get_aio_context(bottom_bs) == aio_context);
2565 }
2566
2567 /*
2568 * Check for op blockers in the whole chain between bs and base (or bottom)
2569 */
2570 iter_end = has_bottom ? bdrv_filter_or_cow_bs(bottom_bs) : base_bs;
2571 for (iter = bs; iter && iter != iter_end;
Max Reitz67acfd22019-06-12 17:48:11 +02002572 iter = bdrv_filter_or_cow_bs(iter))
2573 {
Alberto Garcia554b6142016-10-28 10:08:11 +03002574 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
2575 goto out;
2576 }
2577 }
2578
Jeff Cody13d8cc52014-06-25 15:40:11 -04002579 /* if we are streaming the entire chain, the result will have no backing
2580 * file, and specifying one is therefore an error */
2581 if (base_bs == NULL && has_backing_file) {
2582 error_setg(errp, "backing file specified, but streaming the "
2583 "entire chain");
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002584 goto out;
Jeff Cody13d8cc52014-06-25 15:40:11 -04002585 }
2586
John Snow241ca1a2018-09-06 09:02:23 -04002587 if (has_auto_finalize && !auto_finalize) {
2588 job_flags |= JOB_MANUAL_FINALIZE;
2589 }
2590 if (has_auto_dismiss && !auto_dismiss) {
2591 job_flags |= JOB_MANUAL_DISMISS;
2592 }
2593
Andrey Shinkevich000e5a12020-12-16 09:16:59 +03002594 stream_start(has_job_id ? job_id : NULL, bs, base_bs, backing_file,
Vladimir Sementsov-Ogievskiy7f4a3962020-12-16 09:17:00 +03002595 bottom_bs, job_flags, has_speed ? speed : 0, on_error,
Andrey Shinkevich880747a2020-12-16 09:16:54 +03002596 filter_node_name, &local_err);
Markus Armbruster84d18f02014-01-30 15:07:28 +01002597 if (local_err) {
Stefan Hajnoczifd7f8c62012-04-25 16:51:00 +01002598 error_propagate(errp, local_err);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002599 goto out;
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002600 }
2601
Vladimir Sementsov-Ogievskiyb23c5802019-06-06 18:41:32 +03002602 trace_qmp_block_stream(bs);
Stefan Hajnoczif3e69be2014-10-21 12:03:57 +01002603
2604out:
2605 aio_context_release(aio_context);
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +00002606}
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00002607
Alberto Garciafd62c602016-07-05 17:29:00 +03002608void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
Kevin Wolf3c605f42017-06-27 17:18:20 +02002609 bool has_base_node, const char *base_node,
Jeff Cody7676e2c2014-06-30 15:14:15 +02002610 bool has_base, const char *base,
Kevin Wolf3c605f42017-06-27 17:18:20 +02002611 bool has_top_node, const char *top_node,
Jeff Cody7676e2c2014-06-30 15:14:15 +02002612 bool has_top, const char *top,
Jeff Cody54e26902014-06-25 15:40:10 -04002613 bool has_backing_file, const char *backing_file,
Jeff Codyed61fc12012-09-27 13:29:16 -04002614 bool has_speed, int64_t speed,
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002615 bool has_on_error, BlockdevOnError on_error,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002616 bool has_filter_node_name, const char *filter_node_name,
John Snow96fbf532018-09-06 09:02:21 -04002617 bool has_auto_finalize, bool auto_finalize,
2618 bool has_auto_dismiss, bool auto_dismiss,
Jeff Codyed61fc12012-09-27 13:29:16 -04002619 Error **errp)
2620{
2621 BlockDriverState *bs;
Alberto Garcia058223a2016-10-28 10:08:07 +03002622 BlockDriverState *iter;
Jeff Codyed61fc12012-09-27 13:29:16 -04002623 BlockDriverState *base_bs, *top_bs;
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002624 AioContext *aio_context;
Jeff Codyed61fc12012-09-27 13:29:16 -04002625 Error *local_err = NULL;
John Snow53607822018-09-06 09:02:10 -04002626 int job_flags = JOB_DEFAULT;
Max Reitz05ea3852019-06-11 21:19:26 +02002627 uint64_t top_perm, top_shared;
Jeff Codyed61fc12012-09-27 13:29:16 -04002628
Max Reitz54504662014-04-10 19:36:25 +02002629 if (!has_speed) {
2630 speed = 0;
2631 }
Kevin Wolf8faad1c2020-02-14 21:08:11 +01002632 if (!has_on_error) {
2633 on_error = BLOCKDEV_ON_ERROR_REPORT;
2634 }
Kevin Wolf0db832f2017-02-20 18:10:05 +01002635 if (!has_filter_node_name) {
2636 filter_node_name = NULL;
2637 }
John Snow96fbf532018-09-06 09:02:21 -04002638 if (has_auto_finalize && !auto_finalize) {
2639 job_flags |= JOB_MANUAL_FINALIZE;
2640 }
2641 if (has_auto_dismiss && !auto_dismiss) {
2642 job_flags |= JOB_MANUAL_DISMISS;
2643 }
Max Reitz54504662014-04-10 19:36:25 +02002644
Jeff Cody7676e2c2014-06-30 15:14:15 +02002645 /* Important Note:
2646 * libvirt relies on the DeviceNotFound error class in order to probe for
2647 * live commit feature versions; for this to work, we must make sure to
2648 * perform the device lookup before any generic errors that may occur in a
2649 * scenario in which all optional arguments are omitted. */
Kevin Wolf1d13b162016-06-23 14:20:24 +02002650 bs = qmp_get_root_bs(device, &local_err);
2651 if (!bs) {
2652 bs = bdrv_lookup_bs(device, device, NULL);
2653 if (!bs) {
2654 error_free(local_err);
2655 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2656 "Device '%s' not found", device);
2657 } else {
2658 error_propagate(errp, local_err);
2659 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002660 return;
2661 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002662
Kevin Wolf1d13b162016-06-23 14:20:24 +02002663 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002664 aio_context_acquire(aio_context);
2665
Fam Zhengbb000212014-09-11 13:14:00 +08002666 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002667 goto out;
Fam Zheng628ff682014-05-23 21:29:44 +08002668 }
2669
Jeff Codyed61fc12012-09-27 13:29:16 -04002670 /* default top_bs is the active layer */
2671 top_bs = bs;
2672
Kevin Wolf3c605f42017-06-27 17:18:20 +02002673 if (has_top_node && has_top) {
2674 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
2675 goto out;
2676 } else if (has_top_node) {
2677 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2678 if (top_bs == NULL) {
2679 goto out;
2680 }
2681 if (!bdrv_chain_contains(bs, top_bs)) {
2682 error_setg(errp, "'%s' is not in this backing file chain",
2683 top_node);
2684 goto out;
2685 }
2686 } else if (has_top && top) {
Max Reitzf30c66b2019-02-01 20:29:05 +01002687 /* This strcmp() is just a shortcut, there is no need to
2688 * refresh @bs's filename. If it mismatches,
2689 * bdrv_find_backing_image() will do the refresh and may still
2690 * return @bs. */
Jeff Codyed61fc12012-09-27 13:29:16 -04002691 if (strcmp(bs->filename, top) != 0) {
2692 top_bs = bdrv_find_backing_image(bs, top);
2693 }
2694 }
2695
2696 if (top_bs == NULL) {
2697 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002698 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002699 }
2700
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002701 assert(bdrv_get_aio_context(top_bs) == aio_context);
2702
Kevin Wolf3c605f42017-06-27 17:18:20 +02002703 if (has_base_node && has_base) {
2704 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
2705 goto out;
2706 } else if (has_base_node) {
2707 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2708 if (base_bs == NULL) {
2709 goto out;
2710 }
2711 if (!bdrv_chain_contains(top_bs, base_bs)) {
2712 error_setg(errp, "'%s' is not in this backing file chain",
2713 base_node);
2714 goto out;
2715 }
2716 } else if (has_base && base) {
Jeff Codyd5208c42012-10-16 15:49:10 -04002717 base_bs = bdrv_find_backing_image(top_bs, base);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002718 if (base_bs == NULL) {
2719 error_setg(errp, "Can't find '%s' in the backing chain", base);
2720 goto out;
2721 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002722 } else {
2723 base_bs = bdrv_find_base(top_bs);
Markus Armbrusterb0d7be22020-11-13 09:26:19 +01002724 if (base_bs == NULL) {
2725 error_setg(errp, "There is no backimg image");
2726 goto out;
2727 }
Jeff Codyd5208c42012-10-16 15:49:10 -04002728 }
2729
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002730 assert(bdrv_get_aio_context(base_bs) == aio_context);
2731
Max Reitz9a71b9d2019-06-12 17:47:37 +02002732 for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2733 iter = bdrv_filter_or_cow_bs(iter))
2734 {
Alberto Garcia058223a2016-10-28 10:08:07 +03002735 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2736 goto out;
2737 }
Fam Zhengbb000212014-09-11 13:14:00 +08002738 }
2739
Jeff Cody7676e2c2014-06-30 15:14:15 +02002740 /* Do not allow attempts to commit an image into itself */
2741 if (top_bs == base_bs) {
2742 error_setg(errp, "cannot commit an image into itself");
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002743 goto out;
Jeff Cody7676e2c2014-06-30 15:14:15 +02002744 }
2745
Max Reitz05ea3852019-06-11 21:19:26 +02002746 /*
2747 * Active commit is required if and only if someone has taken a
2748 * WRITE permission on the top node. Historically, we have always
2749 * used active commit for top nodes, so continue that practice
2750 * lest we possibly break clients that rely on this behavior, e.g.
2751 * to later attach this node to a writing parent.
2752 * (Active commit is never really wrong.)
2753 */
2754 bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2755 if (top_perm & BLK_PERM_WRITE ||
2756 bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2757 {
Jeff Cody54e26902014-06-25 15:40:10 -04002758 if (has_backing_file) {
Max Reitz05ea3852019-06-11 21:19:26 +02002759 if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2760 error_setg(errp, "'backing-file' specified,"
2761 " but 'top' is the active layer");
2762 } else {
2763 error_setg(errp, "'backing-file' specified, but 'top' has a "
2764 "writer on it");
2765 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002766 goto out;
Jeff Cody54e26902014-06-25 15:40:10 -04002767 }
Max Reitz05ea3852019-06-11 21:19:26 +02002768 if (!has_job_id) {
2769 /*
2770 * Emulate here what block_job_create() does, because it
2771 * is possible that @bs != @top_bs (the block job should
2772 * be named after @bs, even if @top_bs is the actual
2773 * source)
2774 */
2775 job_id = bdrv_get_device_name(bs);
2776 }
2777 commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
Fam Zheng78bbd912017-04-21 20:27:04 +08002778 filter_node_name, NULL, NULL, false, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002779 } else {
Alberto Garcia058223a2016-10-28 10:08:07 +03002780 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2781 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2782 goto out;
2783 }
John Snow53607822018-09-06 09:02:10 -04002784 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
2785 speed, on_error, has_backing_file ? backing_file : NULL,
Kevin Wolf0db832f2017-02-20 18:10:05 +01002786 filter_node_name, &local_err);
Fam Zheng20a63d22013-12-16 14:45:31 +08002787 }
Jeff Codyed61fc12012-09-27 13:29:16 -04002788 if (local_err != NULL) {
2789 error_propagate(errp, local_err);
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002790 goto out;
Jeff Codyed61fc12012-09-27 13:29:16 -04002791 }
Stefan Hajnoczi9e85cd52014-10-21 12:03:59 +01002792
2793out:
2794 aio_context_release(aio_context);
Jeff Codyed61fc12012-09-27 13:29:16 -04002795}
2796
John Snow7b0b8702019-07-29 16:35:52 -04002797/* Common QMP interface for drive-backup and blockdev-backup */
2798static BlockJob *do_backup_common(BackupCommon *backup,
2799 BlockDriverState *bs,
2800 BlockDriverState *target_bs,
2801 AioContext *aio_context,
2802 JobTxn *txn, Error **errp)
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002803{
John Snow111049a2016-11-08 01:50:38 -05002804 BlockJob *job = NULL;
John Snowd58d8452015-04-17 19:49:58 -04002805 BdrvDirtyBitmap *bmap = NULL;
Vladimir Sementsov-Ogievskiy6a30f662021-01-17 00:47:00 +03002806 BackupPerf perf = { .max_workers = 64 };
John Snow7b0b8702019-07-29 16:35:52 -04002807 int job_flags = JOB_DEFAULT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002808
Pavel Butsykin81206a82016-07-22 11:17:50 +03002809 if (!backup->has_speed) {
2810 backup->speed = 0;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002811 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002812 if (!backup->has_on_source_error) {
2813 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002814 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002815 if (!backup->has_on_target_error) {
2816 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002817 }
Pavel Butsykin81206a82016-07-22 11:17:50 +03002818 if (!backup->has_job_id) {
2819 backup->job_id = NULL;
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002820 }
John Snowb40dacd2018-03-10 03:27:44 -05002821 if (!backup->has_auto_finalize) {
2822 backup->auto_finalize = true;
2823 }
2824 if (!backup->has_auto_dismiss) {
2825 backup->auto_dismiss = true;
2826 }
Pavel Butsykin13b94142016-07-22 11:17:52 +03002827 if (!backup->has_compress) {
2828 backup->compress = false;
2829 }
Stefan Hajnoczi99a9add2013-06-24 17:13:14 +02002830
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002831 if (backup->x_perf) {
2832 if (backup->x_perf->has_use_copy_range) {
2833 perf.use_copy_range = backup->x_perf->use_copy_range;
2834 }
Vladimir Sementsov-Ogievskiy2c59fd82021-01-17 00:46:52 +03002835 if (backup->x_perf->has_max_workers) {
2836 perf.max_workers = backup->x_perf->max_workers;
2837 }
2838 if (backup->x_perf->has_max_chunk) {
2839 perf.max_chunk = backup->x_perf->max_chunk;
2840 }
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002841 }
2842
John Snowa6c93652019-07-29 16:35:55 -04002843 if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2844 (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2845 /* done before desugaring 'incremental' to print the right message */
2846 if (!backup->has_bitmap) {
2847 error_setg(errp, "must provide a valid bitmap name for "
2848 "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2849 return NULL;
2850 }
2851 }
2852
John Snowc8b56502019-07-29 16:35:52 -04002853 if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2854 if (backup->has_bitmap_mode &&
2855 backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2856 error_setg(errp, "Bitmap sync mode must be '%s' "
2857 "when using sync mode '%s'",
2858 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2859 MirrorSyncMode_str(backup->sync));
2860 return NULL;
2861 }
2862 backup->has_bitmap_mode = true;
2863 backup->sync = MIRROR_SYNC_MODE_BITMAP;
2864 backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2865 }
2866
John Snow7b0b8702019-07-29 16:35:52 -04002867 if (backup->has_bitmap) {
2868 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2869 if (!bmap) {
2870 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2871 return NULL;
2872 }
John Snowc8b56502019-07-29 16:35:52 -04002873 if (!backup->has_bitmap_mode) {
2874 error_setg(errp, "Bitmap sync mode must be given "
2875 "when providing a bitmap");
2876 return NULL;
2877 }
John Snowb30ffbe2019-07-29 16:35:54 -04002878 if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
John Snow7b0b8702019-07-29 16:35:52 -04002879 return NULL;
2880 }
John Snow1a2b8b42019-07-29 16:35:55 -04002881
2882 /* This does not produce a useful bitmap artifact: */
2883 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2884 error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2885 " outputs", MirrorSyncMode_str(backup->sync));
2886 return NULL;
2887 }
2888
2889 /* If the bitmap isn't used for input or output, this is useless: */
2890 if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2891 backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2892 error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2893 " when combined with sync mode '%s'",
2894 BitmapSyncMode_str(backup->bitmap_mode),
2895 MirrorSyncMode_str(backup->sync));
2896 return NULL;
2897 }
2898 }
2899
2900 if (!backup->has_bitmap && backup->has_bitmap_mode) {
2901 error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2902 return NULL;
John Snow7b0b8702019-07-29 16:35:52 -04002903 }
2904
2905 if (!backup->auto_finalize) {
2906 job_flags |= JOB_MANUAL_FINALIZE;
2907 }
2908 if (!backup->auto_dismiss) {
2909 job_flags |= JOB_MANUAL_DISMISS;
2910 }
2911
2912 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
John Snowc8b56502019-07-29 16:35:52 -04002913 backup->sync, bmap, backup->bitmap_mode,
2914 backup->compress,
Vladimir Sementsov-Ogievskiy00e30f02019-10-01 16:14:09 +03002915 backup->filter_node_name,
Vladimir Sementsov-Ogievskiy86c6a3b2021-01-17 00:46:43 +03002916 &perf,
John Snowc8b56502019-07-29 16:35:52 -04002917 backup->on_source_error,
2918 backup->on_target_error,
John Snow7b0b8702019-07-29 16:35:52 -04002919 job_flags, NULL, NULL, txn, errp);
2920 return job;
2921}
2922
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002923void qmp_drive_backup(DriveBackup *backup, Error **errp)
John Snow7b0b8702019-07-29 16:35:52 -04002924{
Sergio Lopez2288ccf2020-01-08 15:31:32 +01002925 TransactionAction action = {
2926 .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2927 .u.drive_backup.data = backup,
2928 };
2929 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002930}
2931
Peter Krempafacda542020-01-20 09:50:49 +01002932BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2933 bool flat,
2934 Error **errp)
Benoît Canetc13163f2014-01-23 21:31:34 +01002935{
Peter Krempafacda542020-01-20 09:50:49 +01002936 bool return_flat = has_flat && flat;
2937
2938 return bdrv_named_nodes_list(return_flat, errp);
Benoît Canetc13163f2014-01-23 21:31:34 +01002939}
2940
Vladimir Sementsov-Ogievskiy5d3b4e92018-12-21 20:09:07 +03002941XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2942{
2943 return bdrv_get_xdbg_block_graph(errp);
2944}
2945
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002946void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
Fam Zhengc29c1dd2014-12-18 18:37:05 +08002947{
Sergio Lopez5b7bfe52020-01-08 15:31:33 +01002948 TransactionAction action = {
2949 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2950 .u.blockdev_backup.data = backup,
2951 };
2952 blockdev_do_action(&action, errp);
John Snow78f51fd2015-11-05 18:13:17 -05002953}
2954
Fam Zheng4193cdd2015-12-24 12:45:03 +08002955/* Parameter check and block job starting for drive mirroring.
2956 * Caller should hold @device and @target's aio context (must be the same).
2957 **/
Alberto Garcia71aa9862016-07-05 17:28:57 +03002958static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002959 BlockDriverState *target,
2960 bool has_replaces, const char *replaces,
2961 enum MirrorSyncMode sync,
Max Reitz274fcce2016-06-10 20:57:47 +02002962 BlockMirrorBackingMode backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02002963 bool zero_target,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002964 bool has_speed, int64_t speed,
2965 bool has_granularity, uint32_t granularity,
2966 bool has_buf_size, int64_t buf_size,
2967 bool has_on_source_error,
2968 BlockdevOnError on_source_error,
2969 bool has_on_target_error,
2970 BlockdevOnError on_target_error,
2971 bool has_unmap, bool unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01002972 bool has_filter_node_name,
2973 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02002974 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04002975 bool has_auto_finalize, bool auto_finalize,
2976 bool has_auto_dismiss, bool auto_dismiss,
Fam Zheng4193cdd2015-12-24 12:45:03 +08002977 Error **errp)
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002978{
Max Reitz3f072a72019-06-12 16:27:32 +02002979 BlockDriverState *unfiltered_bs;
John Snowa1999b32018-09-06 09:02:11 -04002980 int job_flags = JOB_DEFAULT;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02002981
2982 if (!has_speed) {
2983 speed = 0;
2984 }
Paolo Bonzinib952b552012-10-18 16:49:28 +02002985 if (!has_on_source_error) {
2986 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2987 }
2988 if (!has_on_target_error) {
2989 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2990 }
Paolo Bonzinieee13df2013-01-21 17:09:46 +01002991 if (!has_granularity) {
2992 granularity = 0;
2993 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002994 if (!has_buf_size) {
Wen Congyang48ac0a42015-05-15 15:51:36 +08002995 buf_size = 0;
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01002996 }
Fam Zheng0fc9f8e2015-06-08 13:56:08 +08002997 if (!has_unmap) {
2998 unmap = true;
2999 }
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003000 if (!has_filter_node_name) {
3001 filter_node_name = NULL;
3002 }
Max Reitz481deba2018-06-13 20:18:22 +02003003 if (!has_copy_mode) {
3004 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
3005 }
John Snowa6b58ad2018-09-06 09:02:22 -04003006 if (has_auto_finalize && !auto_finalize) {
3007 job_flags |= JOB_MANUAL_FINALIZE;
3008 }
3009 if (has_auto_dismiss && !auto_dismiss) {
3010 job_flags |= JOB_MANUAL_DISMISS;
3011 }
Paolo Bonzini08e4ed62013-01-22 09:03:13 +01003012
Paolo Bonzinieee13df2013-01-21 17:09:46 +01003013 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01003014 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3015 "a value in range [512B, 64MB]");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01003016 return;
3017 }
3018 if (granularity & (granularity - 1)) {
Markus Armbrusterc6bd8c72015-03-17 11:54:50 +01003019 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
Markus Armbruster6cc06672020-11-13 09:26:26 +01003020 "a power of 2");
Paolo Bonzinieee13df2013-01-21 17:09:46 +01003021 return;
3022 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003023
Fam Zheng4193cdd2015-12-24 12:45:03 +08003024 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3025 return;
3026 }
Fam Zhenge40e5022015-12-24 12:45:04 +08003027 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3028 return;
3029 }
Fam Zheng4193cdd2015-12-24 12:45:03 +08003030
Max Reitz3f072a72019-06-12 16:27:32 +02003031 if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
Fam Zheng4193cdd2015-12-24 12:45:03 +08003032 sync = MIRROR_SYNC_MODE_FULL;
3033 }
3034
Max Reitz3f072a72019-06-12 16:27:32 +02003035 if (!has_replaces) {
3036 /* We want to mirror from @bs, but keep implicit filters on top */
3037 unfiltered_bs = bdrv_skip_implicit_filters(bs);
3038 if (unfiltered_bs != bs) {
3039 replaces = unfiltered_bs->node_name;
3040 has_replaces = true;
3041 }
3042 }
3043
Max Reitz74ce9e42019-02-13 23:53:01 +01003044 if (has_replaces) {
3045 BlockDriverState *to_replace_bs;
3046 AioContext *replace_aio_context;
3047 int64_t bs_size, replace_size;
3048
3049 bs_size = bdrv_getlength(bs);
3050 if (bs_size < 0) {
3051 error_setg_errno(errp, -bs_size, "Failed to query device's size");
3052 return;
3053 }
3054
3055 to_replace_bs = check_to_replace_node(bs, replaces, errp);
3056 if (!to_replace_bs) {
3057 return;
3058 }
3059
3060 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3061 aio_context_acquire(replace_aio_context);
3062 replace_size = bdrv_getlength(to_replace_bs);
3063 aio_context_release(replace_aio_context);
3064
3065 if (replace_size < 0) {
3066 error_setg_errno(errp, -replace_size,
3067 "Failed to query the replacement node's size");
3068 return;
3069 }
3070 if (bs_size != replace_size) {
3071 error_setg(errp, "cannot replace image with a mirror image of "
3072 "different size");
3073 return;
3074 }
3075 }
3076
Fam Zheng4193cdd2015-12-24 12:45:03 +08003077 /* pass the node name to replace to mirror start since it's loose coupling
3078 * and will allow to check whether the node still exist at mirror completion
3079 */
Alberto Garcia71aa9862016-07-05 17:28:57 +03003080 mirror_start(job_id, bs, target,
John Snowa1999b32018-09-06 09:02:11 -04003081 has_replaces ? replaces : NULL, job_flags,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003082 speed, granularity, buf_size, sync, backing_mode, zero_target,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003083 on_source_error, on_target_error, unmap, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003084 copy_mode, errp);
Fam Zheng4193cdd2015-12-24 12:45:03 +08003085}
3086
Eric Blakefaecd402016-07-14 16:37:58 -06003087void qmp_drive_mirror(DriveMirror *arg, Error **errp)
Fam Zheng4193cdd2015-12-24 12:45:03 +08003088{
3089 BlockDriverState *bs;
Max Reitz3f072a72019-06-12 16:27:32 +02003090 BlockDriverState *target_backing_bs, *target_bs;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003091 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003092 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003093 BlockMirrorBackingMode backing_mode;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003094 Error *local_err = NULL;
3095 QDict *options = NULL;
3096 int flags;
3097 int64_t size;
Eric Blakefaecd402016-07-14 16:37:58 -06003098 const char *format = arg->format;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003099 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003100 int ret;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003101
Kevin Wolf0524e932016-06-23 14:20:24 +02003102 bs = qmp_get_root_bs(arg->device, errp);
3103 if (!bs) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003104 return;
3105 }
3106
Paolo Bonzinicb2af912018-02-07 17:29:20 +01003107 /* Early check to avoid creating target */
3108 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3109 return;
3110 }
3111
Kevin Wolf0524e932016-06-23 14:20:24 +02003112 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003113 aio_context_acquire(aio_context);
3114
Eric Blakefaecd402016-07-14 16:37:58 -06003115 if (!arg->has_mode) {
3116 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
Fam Zheng4193cdd2015-12-24 12:45:03 +08003117 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003118
Eric Blakefaecd402016-07-14 16:37:58 -06003119 if (!arg->has_format) {
3120 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3121 ? NULL : bs->drv->format_name);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003122 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003123
Kevin Wolf61de4c62016-03-18 17:46:45 +01003124 flags = bs->open_flags | BDRV_O_RDWR;
Max Reitz3f072a72019-06-12 16:27:32 +02003125 target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
3126 if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
Eric Blakefaecd402016-07-14 16:37:58 -06003127 arg->sync = MIRROR_SYNC_MODE_FULL;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003128 }
Eric Blakefaecd402016-07-14 16:37:58 -06003129 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
Max Reitz3f072a72019-06-12 16:27:32 +02003130 target_backing_bs = bs;
Max Reitz117e0c82013-11-25 20:28:55 +01003131 }
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003132
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003133 size = bdrv_getlength(bs);
3134 if (size < 0) {
3135 error_setg_errno(errp, -size, "bdrv_getlength failed");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003136 goto out;
Stefan Hajnocziac3c5d82013-06-24 17:13:13 +02003137 }
3138
Eric Blakefaecd402016-07-14 16:37:58 -06003139 if (arg->has_replaces) {
Eric Blakefaecd402016-07-14 16:37:58 -06003140 if (!arg->has_node_name) {
Benoît Canet09158f02014-06-27 18:25:25 +02003141 error_setg(errp, "a node-name must be provided when replacing a"
3142 " named node of the graph");
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003143 goto out;
Benoît Canet09158f02014-06-27 18:25:25 +02003144 }
Benoît Canet09158f02014-06-27 18:25:25 +02003145 }
3146
Eric Blakefaecd402016-07-14 16:37:58 -06003147 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
Max Reitz274fcce2016-06-10 20:57:47 +02003148 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3149 } else {
3150 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3151 }
3152
John Snow2a32c6e2017-07-17 20:34:21 -04003153 /* Don't open backing image in create() */
3154 flags |= BDRV_O_NO_BACKING;
3155
Max Reitz3f072a72019-06-12 16:27:32 +02003156 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
Eric Blakefaecd402016-07-14 16:37:58 -06003157 && arg->mode != NEW_IMAGE_MODE_EXISTING)
Max Reitz14526862013-11-06 19:50:44 +01003158 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003159 /* create new image w/o backing file */
Max Reitze6641712015-08-26 19:47:48 +02003160 assert(format);
Eric Blakefaecd402016-07-14 16:37:58 -06003161 bdrv_img_create(arg->target, format,
Fam Zheng92172832017-04-21 20:27:01 +08003162 NULL, NULL, NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003163 } else {
Max Reitz3f072a72019-06-12 16:27:32 +02003164 /* Implicit filters should not appear in the filename */
3165 BlockDriverState *explicit_backing =
3166 bdrv_skip_implicit_filters(target_backing_bs);
3167
Eric Blakefaecd402016-07-14 16:37:58 -06003168 switch (arg->mode) {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003169 case NEW_IMAGE_MODE_EXISTING:
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003170 break;
3171 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3172 /* create new image with backing file */
Max Reitz3f072a72019-06-12 16:27:32 +02003173 bdrv_refresh_filename(explicit_backing);
Eric Blakefaecd402016-07-14 16:37:58 -06003174 bdrv_img_create(arg->target, format,
Max Reitz3f072a72019-06-12 16:27:32 +02003175 explicit_backing->filename,
3176 explicit_backing->drv->format_name,
Fam Zheng92172832017-04-21 20:27:01 +08003177 NULL, size, flags, false, &local_err);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003178 break;
3179 default:
3180 abort();
3181 }
3182 }
3183
Markus Armbruster84d18f02014-01-30 15:07:28 +01003184 if (local_err) {
Luiz Capitulinocf8f2422012-11-30 10:52:08 -02003185 error_propagate(errp, local_err);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003186 goto out;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003187 }
3188
Max Reitze6641712015-08-26 19:47:48 +02003189 options = qdict_new();
Eric Blakefaecd402016-07-14 16:37:58 -06003190 if (arg->has_node_name) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003191 qdict_put_str(options, "node-name", arg->node_name);
Benoît Canet4c828dc2014-06-16 12:00:55 +02003192 }
Max Reitze6641712015-08-26 19:47:48 +02003193 if (format) {
Eric Blake46f5ac22017-04-27 16:58:17 -05003194 qdict_put_str(options, "driver", format);
Max Reitze6641712015-08-26 19:47:48 +02003195 }
Benoît Canet4c828dc2014-06-16 12:00:55 +02003196
Paolo Bonzinib812f672013-01-21 17:09:43 +01003197 /* Mirroring takes care of copy-on-write using the source's backing
3198 * file.
3199 */
John Snow2a32c6e2017-07-17 20:34:21 -04003200 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
Max Reitz5b363932016-05-17 16:41:31 +02003201 if (!target_bs) {
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003202 goto out;
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003203 }
3204
Max Reitzcdf3bc92019-07-24 19:12:30 +02003205 zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3206 (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3207 !bdrv_has_zero_init(target_bs)));
3208
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003209
3210 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3211 old_context = bdrv_get_aio_context(target_bs);
3212 aio_context_release(aio_context);
3213 aio_context_acquire(old_context);
3214
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003215 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3216 if (ret < 0) {
3217 bdrv_unref(target_bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003218 aio_context_release(old_context);
3219 return;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003220 }
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003221
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003222 aio_context_release(old_context);
3223 aio_context_acquire(aio_context);
3224
Eric Blakefaecd402016-07-14 16:37:58 -06003225 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3226 arg->has_replaces, arg->replaces, arg->sync,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003227 backing_mode, zero_target,
3228 arg->has_speed, arg->speed,
Eric Blakefaecd402016-07-14 16:37:58 -06003229 arg->has_granularity, arg->granularity,
3230 arg->has_buf_size, arg->buf_size,
3231 arg->has_on_source_error, arg->on_source_error,
3232 arg->has_on_target_error, arg->on_target_error,
3233 arg->has_unmap, arg->unmap,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003234 false, NULL,
Max Reitz481deba2018-06-13 20:18:22 +02003235 arg->has_copy_mode, arg->copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003236 arg->has_auto_finalize, arg->auto_finalize,
3237 arg->has_auto_dismiss, arg->auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003238 errp);
Kevin Wolfe253f4b2016-04-12 16:17:41 +02003239 bdrv_unref(target_bs);
Stefan Hajnoczi5a7e7a02014-10-21 12:03:58 +01003240out:
3241 aio_context_release(aio_context);
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02003242}
3243
Alberto Garcia71aa9862016-07-05 17:28:57 +03003244void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3245 const char *device, const char *target,
Fam Zhengdf925622015-12-24 12:45:05 +08003246 bool has_replaces, const char *replaces,
3247 MirrorSyncMode sync,
3248 bool has_speed, int64_t speed,
3249 bool has_granularity, uint32_t granularity,
3250 bool has_buf_size, int64_t buf_size,
3251 bool has_on_source_error,
3252 BlockdevOnError on_source_error,
3253 bool has_on_target_error,
3254 BlockdevOnError on_target_error,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003255 bool has_filter_node_name,
3256 const char *filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003257 bool has_copy_mode, MirrorCopyMode copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003258 bool has_auto_finalize, bool auto_finalize,
3259 bool has_auto_dismiss, bool auto_dismiss,
Fam Zhengdf925622015-12-24 12:45:05 +08003260 Error **errp)
3261{
3262 BlockDriverState *bs;
Fam Zhengdf925622015-12-24 12:45:05 +08003263 BlockDriverState *target_bs;
3264 AioContext *aio_context;
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003265 AioContext *old_context;
Max Reitz274fcce2016-06-10 20:57:47 +02003266 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
Max Reitzcdf3bc92019-07-24 19:12:30 +02003267 bool zero_target;
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003268 int ret;
Fam Zhengdf925622015-12-24 12:45:05 +08003269
Kevin Wolf07eec652016-06-23 14:20:24 +02003270 bs = qmp_get_root_bs(device, errp);
Fam Zhengdf925622015-12-24 12:45:05 +08003271 if (!bs) {
Fam Zhengdf925622015-12-24 12:45:05 +08003272 return;
3273 }
3274
3275 target_bs = bdrv_lookup_bs(target, target, errp);
3276 if (!target_bs) {
3277 return;
3278 }
3279
Max Reitzcdf3bc92019-07-24 19:12:30 +02003280 zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3281
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003282 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3283 old_context = bdrv_get_aio_context(target_bs);
Fam Zhengdf925622015-12-24 12:45:05 +08003284 aio_context = bdrv_get_aio_context(bs);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003285 aio_context_acquire(old_context);
Fam Zhengdf925622015-12-24 12:45:05 +08003286
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003287 ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
Sergio Lopez3ea67e02020-01-08 15:31:34 +01003288
3289 aio_context_release(old_context);
3290 aio_context_acquire(aio_context);
3291
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003292 if (ret < 0) {
3293 goto out;
3294 }
Fam Zhengdf925622015-12-24 12:45:05 +08003295
Alberto Garcia71aa9862016-07-05 17:28:57 +03003296 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
Max Reitz274fcce2016-06-10 20:57:47 +02003297 has_replaces, replaces, sync, backing_mode,
Max Reitzcdf3bc92019-07-24 19:12:30 +02003298 zero_target, has_speed, speed,
Fam Zhengdf925622015-12-24 12:45:05 +08003299 has_granularity, granularity,
3300 has_buf_size, buf_size,
3301 has_on_source_error, on_source_error,
3302 has_on_target_error, on_target_error,
3303 true, true,
Kevin Wolf6cdbceb2017-02-20 18:10:05 +01003304 has_filter_node_name, filter_node_name,
Max Reitz481deba2018-06-13 20:18:22 +02003305 has_copy_mode, copy_mode,
John Snowa6b58ad2018-09-06 09:02:22 -04003306 has_auto_finalize, auto_finalize,
3307 has_auto_dismiss, auto_dismiss,
Markus Armbruster992861f2020-07-07 18:06:04 +02003308 errp);
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003309out:
Fam Zhengdf925622015-12-24 12:45:05 +08003310 aio_context_release(aio_context);
3311}
3312
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003313/* Get a block job using its ID and acquire its AioContext */
3314static BlockJob *find_block_job(const char *id, AioContext **aio_context,
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003315 Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003316{
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003317 BlockJob *job;
3318
3319 assert(id != NULL);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003320
Max Reitz5433c242015-10-19 17:53:29 +02003321 *aio_context = NULL;
3322
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003323 job = block_job_get(id);
3324
3325 if (!job) {
3326 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3327 "Block job '%s' not found", id);
3328 return NULL;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003329 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003330
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003331 *aio_context = blk_get_aio_context(job->blk);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003332 aio_context_acquire(*aio_context);
3333
Alberto Garcia3ddf3ef2016-07-05 17:28:55 +03003334 return job;
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003335}
3336
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003337void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003338{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003339 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003340 BlockJob *job = find_block_job(device, &aio_context, errp);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003341
3342 if (!job) {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003343 return;
3344 }
3345
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +01003346 block_job_set_speed(job, speed, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003347 aio_context_release(aio_context);
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +00003348}
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003349
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003350void qmp_block_job_cancel(const char *device,
3351 bool has_force, bool force, Error **errp)
3352{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003353 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003354 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003355
3356 if (!job) {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003357 return;
3358 }
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003359
3360 if (!has_force) {
3361 force = false;
3362 }
3363
Kevin Wolfb15de822018-04-18 17:10:26 +02003364 if (job_user_paused(&job->job) && !force) {
Cole Robinsonf231b882014-03-21 19:42:26 -04003365 error_setg(errp, "The block job for device '%s' is currently paused",
3366 device);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003367 goto out;
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003368 }
3369
3370 trace_qmp_block_job_cancel(job);
Kevin Wolf3d70ff52018-04-24 16:13:52 +02003371 job_user_cancel(&job->job, force, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003372out:
3373 aio_context_release(aio_context);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003374}
3375
3376void qmp_block_job_pause(const char *device, Error **errp)
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003377{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003378 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003379 BlockJob *job = find_block_job(device, &aio_context, errp);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003380
John Snow0ec4dfb2018-03-10 03:27:32 -05003381 if (!job) {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003382 return;
3383 }
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003384
3385 trace_qmp_block_job_pause(job);
Kevin Wolfb15de822018-04-18 17:10:26 +02003386 job_user_pause(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003387 aio_context_release(aio_context);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003388}
3389
3390void qmp_block_job_resume(const char *device, Error **errp)
3391{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003392 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003393 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003394
John Snow0ec4dfb2018-03-10 03:27:32 -05003395 if (!job) {
Paolo Bonzini8acc72a2012-09-28 17:22:50 +02003396 return;
3397 }
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003398
Paolo Bonzini6e37fb82012-09-28 17:22:51 +02003399 trace_qmp_block_job_resume(job);
Kevin Wolfb15de822018-04-18 17:10:26 +02003400 job_user_resume(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003401 aio_context_release(aio_context);
Stefan Hajnoczi370521a2012-01-18 14:40:48 +00003402}
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003403
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003404void qmp_block_job_complete(const char *device, Error **errp)
3405{
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003406 AioContext *aio_context;
Markus Armbruster24d6bff2015-01-29 10:36:58 +01003407 BlockJob *job = find_block_job(device, &aio_context, errp);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003408
3409 if (!job) {
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003410 return;
3411 }
3412
3413 trace_qmp_block_job_complete(job);
Kevin Wolf3453d972018-04-23 12:24:16 +02003414 job_complete(&job->job, errp);
Stefan Hajnoczi3d948cd2014-10-21 12:03:50 +01003415 aio_context_release(aio_context);
Paolo Bonziniaeae8832012-10-18 16:49:21 +02003416}
3417
John Snow11b61fb2018-03-10 03:27:43 -05003418void qmp_block_job_finalize(const char *id, Error **errp)
3419{
3420 AioContext *aio_context;
3421 BlockJob *job = find_block_job(id, &aio_context, errp);
3422
3423 if (!job) {
3424 return;
3425 }
3426
3427 trace_qmp_block_job_finalize(job);
Stefan Reiterb660a842020-04-07 13:56:49 +02003428 job_ref(&job->job);
Kevin Wolf7eaa8fb2018-04-23 16:06:26 +02003429 job_finalize(&job->job, errp);
Stefan Reiterb660a842020-04-07 13:56:49 +02003430
3431 /*
3432 * Job's context might have changed via job_finalize (and job_txn_apply
3433 * automatically acquires the new one), so make sure we release the correct
3434 * one.
3435 */
3436 aio_context = blk_get_aio_context(job->blk);
3437 job_unref(&job->job);
John Snow11b61fb2018-03-10 03:27:43 -05003438 aio_context_release(aio_context);
3439}
3440
John Snow75f71052018-03-10 03:27:36 -05003441void qmp_block_job_dismiss(const char *id, Error **errp)
3442{
3443 AioContext *aio_context;
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003444 BlockJob *bjob = find_block_job(id, &aio_context, errp);
3445 Job *job;
John Snow75f71052018-03-10 03:27:36 -05003446
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003447 if (!bjob) {
John Snow75f71052018-03-10 03:27:36 -05003448 return;
3449 }
3450
Kevin Wolf5f9a6a02018-04-24 17:10:12 +02003451 trace_qmp_block_job_dismiss(bjob);
3452 job = &bjob->job;
3453 job_dismiss(&job, errp);
John Snow75f71052018-03-10 03:27:36 -05003454 aio_context_release(aio_context);
3455}
3456
Jeff Codyfa40e652014-07-01 09:52:16 +02003457void qmp_change_backing_file(const char *device,
3458 const char *image_node_name,
3459 const char *backing_file,
3460 Error **errp)
3461{
3462 BlockDriverState *bs = NULL;
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003463 AioContext *aio_context;
Jeff Codyfa40e652014-07-01 09:52:16 +02003464 BlockDriverState *image_bs = NULL;
3465 Error *local_err = NULL;
3466 bool ro;
Jeff Codyfa40e652014-07-01 09:52:16 +02003467 int ret;
3468
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003469 bs = qmp_get_root_bs(device, errp);
3470 if (!bs) {
Jeff Codyfa40e652014-07-01 09:52:16 +02003471 return;
3472 }
3473
Kevin Wolf7b5dca32016-06-23 14:20:24 +02003474 aio_context = bdrv_get_aio_context(bs);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003475 aio_context_acquire(aio_context);
3476
Jeff Codyfa40e652014-07-01 09:52:16 +02003477 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3478 if (local_err) {
3479 error_propagate(errp, local_err);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003480 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003481 }
3482
3483 if (!image_bs) {
3484 error_setg(errp, "image file not found");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003485 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003486 }
3487
3488 if (bdrv_find_base(image_bs) == image_bs) {
3489 error_setg(errp, "not allowing backing file change on an image "
3490 "without a backing file");
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003491 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003492 }
3493
3494 /* even though we are not necessarily operating on bs, we need it to
3495 * determine if block ops are currently prohibited on the chain */
3496 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003497 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003498 }
3499
3500 /* final sanity check */
3501 if (!bdrv_chain_contains(bs, image_bs)) {
3502 error_setg(errp, "'%s' and image file are not in the same chain",
3503 device);
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003504 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003505 }
3506
3507 /* if not r/w, reopen to make r/w */
Jeff Codyfa40e652014-07-01 09:52:16 +02003508 ro = bdrv_is_read_only(image_bs);
3509
3510 if (ro) {
Alberto Garcia051a60f2018-11-12 16:00:38 +02003511 if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003512 goto out;
Jeff Codyfa40e652014-07-01 09:52:16 +02003513 }
3514 }
3515
3516 ret = bdrv_change_backing_file(image_bs, backing_file,
Eric Blakee54ee1b2020-07-06 15:39:53 -05003517 image_bs->drv ? image_bs->drv->format_name : "",
3518 false);
Jeff Codyfa40e652014-07-01 09:52:16 +02003519
3520 if (ret < 0) {
3521 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3522 backing_file);
3523 /* don't exit here, so we can try to restore open flags if
3524 * appropriate */
3525 }
3526
3527 if (ro) {
Markus Armbruster992861f2020-07-07 18:06:04 +02003528 bdrv_reopen_set_read_only(image_bs, true, errp);
Jeff Codyfa40e652014-07-01 09:52:16 +02003529 }
Stefan Hajnoczi729962f2014-11-19 14:19:45 +00003530
3531out:
3532 aio_context_release(aio_context);
Jeff Codyfa40e652014-07-01 09:52:16 +02003533}
3534
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003535void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3536{
Max Reitzbe4b67b2015-10-19 17:53:09 +02003537 BlockDriverState *bs;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003538 QObject *obj;
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +01003539 Visitor *v = qobject_output_visitor_new(&obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003540 QDict *qdict;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003541
Markus Armbruster1f584242020-04-24 10:43:35 +02003542 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
Eric Blake3b098d52016-06-09 10:48:43 -06003543 visit_complete(v, &obj);
Max Reitz7dc847e2018-02-24 16:40:29 +01003544 qdict = qobject_to(QDict, obj);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003545
3546 qdict_flatten(qdict);
3547
Kevin Wolf9ec88732016-09-21 14:56:11 +02003548 if (!qdict_get_try_str(qdict, "node-name")) {
3549 error_setg(errp, "'node-name' must be specified for the root node");
3550 goto fail;
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003551 }
3552
Kevin Wolf9ec88732016-09-21 14:56:11 +02003553 bs = bds_tree_init(qdict, errp);
3554 if (!bs) {
3555 goto fail;
3556 }
3557
Maxim Levitsky89802d52020-03-08 11:24:40 +02003558 bdrv_set_monitor_owned(bs);
Kevin Wolf9ec88732016-09-21 14:56:11 +02003559
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003560fail:
Eric Blake3b098d52016-06-09 10:48:43 -06003561 visit_free(v);
Kevin Wolfd26c9a12013-09-23 15:26:03 +02003562}
3563
Alberto Garcia1479c732019-03-12 18:48:51 +02003564void qmp_x_blockdev_reopen(BlockdevOptions *options, Error **errp)
3565{
3566 BlockDriverState *bs;
3567 AioContext *ctx;
3568 QObject *obj;
3569 Visitor *v = qobject_output_visitor_new(&obj);
Alberto Garcia1479c732019-03-12 18:48:51 +02003570 BlockReopenQueue *queue;
3571 QDict *qdict;
3572
3573 /* Check for the selected node name */
3574 if (!options->has_node_name) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003575 error_setg(errp, "node-name not specified");
Alberto Garcia1479c732019-03-12 18:48:51 +02003576 goto fail;
3577 }
3578
3579 bs = bdrv_find_node(options->node_name);
3580 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003581 error_setg(errp, "Failed to find node with node-name='%s'",
3582 options->node_name);
Alberto Garcia1479c732019-03-12 18:48:51 +02003583 goto fail;
3584 }
3585
3586 /* Put all options in a QDict and flatten it */
Markus Armbruster1f584242020-04-24 10:43:35 +02003587 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
Alberto Garcia1479c732019-03-12 18:48:51 +02003588 visit_complete(v, &obj);
3589 qdict = qobject_to(QDict, obj);
3590
3591 qdict_flatten(qdict);
3592
3593 /* Perform the reopen operation */
3594 ctx = bdrv_get_aio_context(bs);
3595 aio_context_acquire(ctx);
3596 bdrv_subtree_drained_begin(bs);
3597 queue = bdrv_reopen_queue(NULL, bs, qdict, false);
3598 bdrv_reopen_multiple(queue, errp);
3599 bdrv_subtree_drained_end(bs);
3600 aio_context_release(ctx);
3601
3602fail:
3603 visit_free(v);
3604}
3605
Markus Armbruster79b7a772017-03-21 17:53:28 +01003606void qmp_blockdev_del(const char *node_name, Error **errp)
Alberto Garcia81b936a2015-11-02 16:51:55 +02003607{
3608 AioContext *aio_context;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003609 BlockDriverState *bs;
3610
Kevin Wolf9ec88732016-09-21 14:56:11 +02003611 bs = bdrv_find_node(node_name);
3612 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003613 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003614 return;
3615 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003616 if (bdrv_has_blk(bs)) {
3617 error_setg(errp, "Node %s is in use", node_name);
3618 return;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003619 }
Kevin Wolf9ec88732016-09-21 14:56:11 +02003620 aio_context = bdrv_get_aio_context(bs);
Alberto Garcia81b936a2015-11-02 16:51:55 +02003621 aio_context_acquire(aio_context);
3622
Kevin Wolf9ec88732016-09-21 14:56:11 +02003623 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3624 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003625 }
3626
Paolo Bonzini70537ed2018-12-06 23:00:09 +01003627 if (!QTAILQ_IN_USE(bs, monitor_list)) {
Kevin Wolf9ec88732016-09-21 14:56:11 +02003628 error_setg(errp, "Node %s is not owned by the monitor",
3629 bs->node_name);
3630 goto out;
Alberto Garcia81b936a2015-11-02 16:51:55 +02003631 }
3632
Kevin Wolf9ec88732016-09-21 14:56:11 +02003633 if (bs->refcnt > 1) {
3634 error_setg(errp, "Block device %s is in use",
3635 bdrv_get_device_or_node_name(bs));
3636 goto out;
3637 }
3638
3639 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3640 bdrv_unref(bs);
3641
Alberto Garcia81b936a2015-11-02 16:51:55 +02003642out:
3643 aio_context_release(aio_context);
3644}
3645
Wen Congyang7f821592016-05-10 15:36:39 +08003646static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3647 const char *child_name)
3648{
3649 BdrvChild *child;
3650
3651 QLIST_FOREACH(child, &parent_bs->children, next) {
3652 if (strcmp(child->name, child_name) == 0) {
3653 return child;
3654 }
3655 }
3656
3657 return NULL;
3658}
3659
3660void qmp_x_blockdev_change(const char *parent, bool has_child,
3661 const char *child, bool has_node,
3662 const char *node, Error **errp)
3663{
3664 BlockDriverState *parent_bs, *new_bs = NULL;
3665 BdrvChild *p_child;
3666
3667 parent_bs = bdrv_lookup_bs(parent, parent, errp);
3668 if (!parent_bs) {
3669 return;
3670 }
3671
3672 if (has_child == has_node) {
3673 if (has_child) {
3674 error_setg(errp, "The parameters child and node are in conflict");
3675 } else {
3676 error_setg(errp, "Either child or node must be specified");
3677 }
3678 return;
3679 }
3680
3681 if (has_child) {
3682 p_child = bdrv_find_child(parent_bs, child);
3683 if (!p_child) {
3684 error_setg(errp, "Node '%s' does not have child '%s'",
3685 parent, child);
3686 return;
3687 }
3688 bdrv_del_child(parent_bs, p_child, errp);
3689 }
3690
3691 if (has_node) {
3692 new_bs = bdrv_find_node(node);
3693 if (!new_bs) {
3694 error_setg(errp, "Node '%s' not found", node);
3695 return;
3696 }
3697 bdrv_add_child(parent_bs, new_bs, errp);
3698 }
3699}
3700
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003701BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3702{
Eric Blakec3033fd2021-01-13 16:10:12 -06003703 BlockJobInfoList *head = NULL, **tail = &head;
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003704 BlockJob *job;
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003705
Alberto Garciaf0f55de2016-05-27 12:53:37 +02003706 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
Eric Blakec3033fd2021-01-13 16:10:12 -06003707 BlockJobInfo *value;
John Snow559b9352016-10-27 12:06:55 -04003708 AioContext *aio_context;
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003709
John Snow559b9352016-10-27 12:06:55 -04003710 if (block_job_is_internal(job)) {
3711 continue;
3712 }
John Snow559b9352016-10-27 12:06:55 -04003713 aio_context = blk_get_aio_context(job->blk);
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003714 aio_context_acquire(aio_context);
Eric Blakec3033fd2021-01-13 16:10:12 -06003715 value = block_job_query(job, errp);
Stefan Hajnoczi69691e72014-10-21 12:03:51 +01003716 aio_context_release(aio_context);
Eric Blakec3033fd2021-01-13 16:10:12 -06003717 if (!value) {
John Snow559b9352016-10-27 12:06:55 -04003718 qapi_free_BlockJobInfoList(head);
3719 return NULL;
3720 }
Eric Blakec3033fd2021-01-13 16:10:12 -06003721 QAPI_LIST_APPEND(tail, value);
Markus Armbrusterfea68bb2014-10-07 13:59:10 +02003722 }
3723
3724 return head;
Stefan Hajnoczifb5458c2012-01-18 14:40:49 +00003725}
Paolo Bonzini4d454572012-11-26 16:03:42 +01003726
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003727void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003728 bool has_force, bool force, Error **errp)
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003729{
3730 AioContext *old_context;
3731 AioContext *new_context;
3732 BlockDriverState *bs;
3733
3734 bs = bdrv_find_node(node_name);
3735 if (!bs) {
Connor Kuehlef2e38a2021-03-05 09:19:29 -06003736 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003737 return;
3738 }
3739
Stefan Hajnoczi882e9b82017-12-07 20:13:17 +00003740 /* Protects against accidents. */
3741 if (!(has_force && force) && bdrv_has_blk(bs)) {
3742 error_setg(errp, "Node %s is associated with a BlockBackend and could "
3743 "be in use (use force=true to override this check)",
3744 node_name);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003745 return;
3746 }
3747
3748 if (iothread->type == QTYPE_QSTRING) {
3749 IOThread *obj = iothread_by_id(iothread->u.s);
3750 if (!obj) {
3751 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3752 return;
3753 }
3754
3755 new_context = iothread_get_aio_context(obj);
3756 } else {
3757 new_context = qemu_get_aio_context();
3758 }
3759
3760 old_context = bdrv_get_aio_context(bs);
3761 aio_context_acquire(old_context);
3762
Kevin Wolf8ed7d422019-04-26 16:12:27 +02003763 bdrv_try_set_aio_context(bs, new_context, errp);
Stefan Hajnoczica00bbb2017-12-06 14:45:49 +00003764
3765 aio_context_release(old_context);
3766}
3767
Kevin Wolf00063832013-03-15 10:35:07 +01003768QemuOptsList qemu_common_drive_opts = {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003769 .name = "drive",
Kevin Wolf00063832013-03-15 10:35:07 +01003770 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
Paolo Bonzini4d454572012-11-26 16:03:42 +01003771 .desc = {
3772 {
Paolo Bonzini4d454572012-11-26 16:03:42 +01003773 .name = "snapshot",
3774 .type = QEMU_OPT_BOOL,
3775 .help = "enable/disable snapshot mode",
3776 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003777 .name = "aio",
3778 .type = QEMU_OPT_STRING,
Aarushi Mehtaf80f2672020-01-20 14:18:50 +00003779 .help = "host AIO implementation (threads, native, io_uring)",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003780 },{
Kevin Wolfe4b24b42016-03-15 15:39:42 +01003781 .name = BDRV_OPT_CACHE_WB,
3782 .type = QEMU_OPT_BOOL,
3783 .help = "Enable writeback mode",
3784 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003785 .name = "format",
3786 .type = QEMU_OPT_STRING,
3787 .help = "disk format (raw, qcow2, ...)",
3788 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003789 .name = "rerror",
3790 .type = QEMU_OPT_STRING,
3791 .help = "read error action",
3792 },{
3793 .name = "werror",
3794 .type = QEMU_OPT_STRING,
3795 .help = "write error action",
3796 },{
Alberto Garcia4e200cf2016-09-15 17:53:05 +03003797 .name = BDRV_OPT_READ_ONLY,
Paolo Bonzini4d454572012-11-26 16:03:42 +01003798 .type = QEMU_OPT_BOOL,
3799 .help = "open drive file as read-only",
Pradeep Jagadeesha2a78622017-02-28 10:31:46 +01003800 },
3801
3802 THROTTLE_OPTS,
3803
3804 {
Alberto Garcia76f4afb2015-06-08 18:17:44 +02003805 .name = "throttling.group",
3806 .type = QEMU_OPT_STRING,
3807 .help = "name of the block throttling group",
3808 },{
Paolo Bonzini4d454572012-11-26 16:03:42 +01003809 .name = "copy-on-read",
3810 .type = QEMU_OPT_BOOL,
3811 .help = "copy read data from backing file into image file",
Peter Lieven465bee12014-05-18 00:58:19 +02003812 },{
3813 .name = "detect-zeroes",
3814 .type = QEMU_OPT_STRING,
3815 .help = "try to optimize zero writes (off, on, unmap)",
Alberto Garcia362e9292015-10-28 17:33:04 +02003816 },{
3817 .name = "stats-account-invalid",
3818 .type = QEMU_OPT_BOOL,
3819 .help = "whether to account for invalid I/O operations "
3820 "in the statistics",
3821 },{
3822 .name = "stats-account-failed",
3823 .type = QEMU_OPT_BOOL,
3824 .help = "whether to account for failed I/O operations "
3825 "in the statistics",
Paolo Bonzini4d454572012-11-26 16:03:42 +01003826 },
3827 { /* end of list */ }
3828 },
3829};
Kevin Wolf00063832013-03-15 10:35:07 +01003830
3831QemuOptsList qemu_drive_opts = {
3832 .name = "drive",
3833 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3834 .desc = {
Kevin Wolf492fdc62013-06-19 13:44:17 +02003835 /*
3836 * no elements => accept any params
3837 * validation will happen later
3838 */
Kevin Wolf00063832013-03-15 10:35:07 +01003839 { /* end of list */ }
3840 },
3841};