xref: /openbmc/qemu/blockdev.c (revision ac6dd31e)
1 /*
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.
8  *
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.
31  */
32 
33 #include "qemu/osdep.h"
34 #include "sysemu/block-backend.h"
35 #include "sysemu/blockdev.h"
36 #include "hw/block/block.h"
37 #include "block/blockjob.h"
38 #include "block/qdict.h"
39 #include "block/throttle-groups.h"
40 #include "monitor/monitor.h"
41 #include "qemu/error-report.h"
42 #include "qemu/option.h"
43 #include "qemu/config-file.h"
44 #include "qapi/qapi-commands-block.h"
45 #include "qapi/qapi-commands-transaction.h"
46 #include "qapi/qapi-visit-block-core.h"
47 #include "qapi/qmp/qdict.h"
48 #include "qapi/qmp/qnum.h"
49 #include "qapi/qmp/qstring.h"
50 #include "qapi/error.h"
51 #include "qapi/qmp/qerror.h"
52 #include "qapi/qmp/qlist.h"
53 #include "qapi/qobject-output-visitor.h"
54 #include "sysemu/sysemu.h"
55 #include "sysemu/iothread.h"
56 #include "block/block_int.h"
57 #include "block/trace.h"
58 #include "sysemu/arch_init.h"
59 #include "sysemu/qtest.h"
60 #include "qemu/cutils.h"
61 #include "qemu/help_option.h"
62 #include "qemu/throttle-options.h"
63 
64 static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
65     QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
66 
67 static int do_open_tray(const char *blk_name, const char *qdev_id,
68                         bool force, Error **errp);
69 static void blockdev_remove_medium(bool has_device, const char *device,
70                                    bool has_id, const char *id, Error **errp);
71 static void blockdev_insert_medium(bool has_device, const char *device,
72                                    bool has_id, const char *id,
73                                    const char *node_name, Error **errp);
74 
75 static 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 
87 static int if_max_devs[IF_COUNT] = {
88     /*
89      * Do not change these numbers!  They govern how drive option
90      * index maps to unit and bus.  That mapping is ABI.
91      *
92      * All controllers used to implement if=T drives need to support
93      * 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,
104 };
105 
106 /**
107  * Boards may call this to offer board-by-board overrides
108  * of the default, global values.
109  */
110 void override_max_devs(BlockInterfaceType type, int max_devs)
111 {
112     BlockBackend *blk;
113     DriveInfo *dinfo;
114 
115     if (max_devs <= 0) {
116         return;
117     }
118 
119     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
120         dinfo = blk_legacy_dinfo(blk);
121         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 
132 /*
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  */
139 void blockdev_mark_auto_del(BlockBackend *blk)
140 {
141     DriveInfo *dinfo = blk_legacy_dinfo(blk);
142     BlockDriverState *bs = blk_bs(blk);
143     AioContext *aio_context;
144 
145     if (!dinfo) {
146         return;
147     }
148 
149     if (bs) {
150         aio_context = bdrv_get_aio_context(bs);
151         aio_context_acquire(aio_context);
152 
153         if (bs->job) {
154             job_cancel(&bs->job->job, false);
155         }
156 
157         aio_context_release(aio_context);
158     }
159 
160     dinfo->auto_del = 1;
161 }
162 
163 void blockdev_auto_del(BlockBackend *blk)
164 {
165     DriveInfo *dinfo = blk_legacy_dinfo(blk);
166 
167     if (dinfo && dinfo->auto_del) {
168         monitor_remove_blk(blk);
169         blk_unref(blk);
170     }
171 }
172 
173 /**
174  * Returns the current mapping of how many units per bus
175  * a particular interface can support.
176  *
177  *  A positive integer indicates n units per bus.
178  *  0 implies the mapping has not been established.
179  * -1 indicates an invalid BlockInterfaceType was given.
180  */
181 int drive_get_max_devs(BlockInterfaceType type)
182 {
183     if (type >= IF_IDE && type < IF_COUNT) {
184         return if_max_devs[type];
185     }
186 
187     return -1;
188 }
189 
190 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
191 {
192     int max_devs = if_max_devs[type];
193     return max_devs ? index / max_devs : 0;
194 }
195 
196 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
197 {
198     int max_devs = if_max_devs[type];
199     return max_devs ? index % max_devs : index;
200 }
201 
202 QemuOpts *drive_def(const char *optstr)
203 {
204     return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
205 }
206 
207 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
208                     const char *optstr)
209 {
210     QemuOpts *opts;
211 
212     opts = drive_def(optstr);
213     if (!opts) {
214         return NULL;
215     }
216     if (type != IF_DEFAULT) {
217         qemu_opt_set(opts, "if", if_name[type], &error_abort);
218     }
219     if (index >= 0) {
220         qemu_opt_set_number(opts, "index", index, &error_abort);
221     }
222     if (file)
223         qemu_opt_set(opts, "file", file, &error_abort);
224     return opts;
225 }
226 
227 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
228 {
229     BlockBackend *blk;
230     DriveInfo *dinfo;
231 
232     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
233         dinfo = blk_legacy_dinfo(blk);
234         if (dinfo && dinfo->type == type
235             && dinfo->bus == bus && dinfo->unit == unit) {
236             return dinfo;
237         }
238     }
239 
240     return NULL;
241 }
242 
243 void drive_check_orphaned(void)
244 {
245     BlockBackend *blk;
246     DriveInfo *dinfo;
247     Location loc;
248     bool orphans = false;
249 
250     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
251         dinfo = blk_legacy_dinfo(blk);
252         if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
253             dinfo->type != IF_NONE) {
254             loc_push_none(&loc);
255             qemu_opts_loc_restore(dinfo->opts);
256             error_report("machine type does not support"
257                          " if=%s,bus=%d,unit=%d",
258                          if_name[dinfo->type], dinfo->bus, dinfo->unit);
259             loc_pop(&loc);
260             orphans = true;
261         }
262     }
263 
264     if (orphans) {
265         exit(1);
266     }
267 }
268 
269 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
270 {
271     return drive_get(type,
272                      drive_index_to_bus_id(type, index),
273                      drive_index_to_unit_id(type, index));
274 }
275 
276 int drive_get_max_bus(BlockInterfaceType type)
277 {
278     int max_bus;
279     BlockBackend *blk;
280     DriveInfo *dinfo;
281 
282     max_bus = -1;
283     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
284         dinfo = blk_legacy_dinfo(blk);
285         if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
286             max_bus = dinfo->bus;
287         }
288     }
289     return max_bus;
290 }
291 
292 /* Get a block device.  This should only be used for single-drive devices
293    (e.g. SD/Floppy/MTD).  Multi-disk devices (scsi/ide) should use the
294    appropriate bus.  */
295 DriveInfo *drive_get_next(BlockInterfaceType type)
296 {
297     static int next_block_unit[IF_COUNT];
298 
299     return drive_get(type, 0, next_block_unit[type]++);
300 }
301 
302 static void bdrv_format_print(void *opaque, const char *name)
303 {
304     error_printf(" %s", name);
305 }
306 
307 typedef struct {
308     QEMUBH *bh;
309     BlockDriverState *bs;
310 } BDRVPutRefBH;
311 
312 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
313 {
314     if (!strcmp(buf, "ignore")) {
315         return BLOCKDEV_ON_ERROR_IGNORE;
316     } else if (!is_read && !strcmp(buf, "enospc")) {
317         return BLOCKDEV_ON_ERROR_ENOSPC;
318     } else if (!strcmp(buf, "stop")) {
319         return BLOCKDEV_ON_ERROR_STOP;
320     } else if (!strcmp(buf, "report")) {
321         return BLOCKDEV_ON_ERROR_REPORT;
322     } else {
323         error_setg(errp, "'%s' invalid %s error action",
324                    buf, is_read ? "read" : "write");
325         return -1;
326     }
327 }
328 
329 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
330                                   Error **errp)
331 {
332     const QListEntry *entry;
333     for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
334         switch (qobject_type(entry->value)) {
335 
336         case QTYPE_QSTRING: {
337             unsigned long long length;
338             const char *str = qstring_get_str(qobject_to(QString,
339                                                          entry->value));
340             if (parse_uint_full(str, &length, 10) == 0 &&
341                 length > 0 && length <= UINT_MAX) {
342                 block_acct_add_interval(stats, (unsigned) length);
343             } else {
344                 error_setg(errp, "Invalid interval length: %s", str);
345                 return false;
346             }
347             break;
348         }
349 
350         case QTYPE_QNUM: {
351             int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
352 
353             if (length > 0 && length <= UINT_MAX) {
354                 block_acct_add_interval(stats, (unsigned) length);
355             } else {
356                 error_setg(errp, "Invalid interval length: %" PRId64, length);
357                 return false;
358             }
359             break;
360         }
361 
362         default:
363             error_setg(errp, "The specification of stats-intervals is invalid");
364             return false;
365         }
366     }
367     return true;
368 }
369 
370 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
371 
372 /* All parameters but @opts are optional and may be set to NULL. */
373 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
374     const char **throttling_group, ThrottleConfig *throttle_cfg,
375     BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
376 {
377     Error *local_error = NULL;
378     const char *aio;
379 
380     if (bdrv_flags) {
381         if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
382             *bdrv_flags |= BDRV_O_COPY_ON_READ;
383         }
384 
385         if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
386             if (!strcmp(aio, "native")) {
387                 *bdrv_flags |= BDRV_O_NATIVE_AIO;
388             } else if (!strcmp(aio, "threads")) {
389                 /* this is the default */
390             } else {
391                error_setg(errp, "invalid aio option");
392                return;
393             }
394         }
395     }
396 
397     /* disk I/O throttling */
398     if (throttling_group) {
399         *throttling_group = qemu_opt_get(opts, "throttling.group");
400     }
401 
402     if (throttle_cfg) {
403         throttle_config_init(throttle_cfg);
404         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
405             qemu_opt_get_number(opts, "throttling.bps-total", 0);
406         throttle_cfg->buckets[THROTTLE_BPS_READ].avg  =
407             qemu_opt_get_number(opts, "throttling.bps-read", 0);
408         throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
409             qemu_opt_get_number(opts, "throttling.bps-write", 0);
410         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
411             qemu_opt_get_number(opts, "throttling.iops-total", 0);
412         throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
413             qemu_opt_get_number(opts, "throttling.iops-read", 0);
414         throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
415             qemu_opt_get_number(opts, "throttling.iops-write", 0);
416 
417         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
418             qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
419         throttle_cfg->buckets[THROTTLE_BPS_READ].max  =
420             qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
421         throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
422             qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
423         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
424             qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
425         throttle_cfg->buckets[THROTTLE_OPS_READ].max =
426             qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
427         throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
428             qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
429 
430         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
431             qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
432         throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length  =
433             qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
434         throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
435             qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
436         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
437             qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
438         throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
439             qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
440         throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
441             qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
442 
443         throttle_cfg->op_size =
444             qemu_opt_get_number(opts, "throttling.iops-size", 0);
445 
446         if (!throttle_is_valid(throttle_cfg, errp)) {
447             return;
448         }
449     }
450 
451     if (detect_zeroes) {
452         *detect_zeroes =
453             qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
454                             qemu_opt_get(opts, "detect-zeroes"),
455                             BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
456                             &local_error);
457         if (local_error) {
458             error_propagate(errp, local_error);
459             return;
460         }
461     }
462 }
463 
464 /* Takes the ownership of bs_opts */
465 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
466                                    Error **errp)
467 {
468     const char *buf;
469     int bdrv_flags = 0;
470     int on_read_error, on_write_error;
471     bool account_invalid, account_failed;
472     bool writethrough, read_only;
473     BlockBackend *blk;
474     BlockDriverState *bs;
475     ThrottleConfig cfg;
476     int snapshot = 0;
477     Error *error = NULL;
478     QemuOpts *opts;
479     QDict *interval_dict = NULL;
480     QList *interval_list = NULL;
481     const char *id;
482     BlockdevDetectZeroesOptions detect_zeroes =
483         BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
484     const char *throttling_group = NULL;
485 
486     /* Check common options by copying from bs_opts to opts, all other options
487      * stay in bs_opts for processing by bdrv_open(). */
488     id = qdict_get_try_str(bs_opts, "id");
489     opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
490     if (error) {
491         error_propagate(errp, error);
492         goto err_no_opts;
493     }
494 
495     qemu_opts_absorb_qdict(opts, bs_opts, &error);
496     if (error) {
497         error_propagate(errp, error);
498         goto early_err;
499     }
500 
501     if (id) {
502         qdict_del(bs_opts, "id");
503     }
504 
505     /* extract parameters */
506     snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
507 
508     account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
509     account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
510 
511     writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
512 
513     id = qemu_opts_id(opts);
514 
515     qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
516     qdict_array_split(interval_dict, &interval_list);
517 
518     if (qdict_size(interval_dict) != 0) {
519         error_setg(errp, "Invalid option stats-intervals.%s",
520                    qdict_first(interval_dict)->key);
521         goto early_err;
522     }
523 
524     extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
525                                     &detect_zeroes, &error);
526     if (error) {
527         error_propagate(errp, error);
528         goto early_err;
529     }
530 
531     if ((buf = qemu_opt_get(opts, "format")) != NULL) {
532         if (is_help_option(buf)) {
533             error_printf("Supported formats:");
534             bdrv_iterate_format(bdrv_format_print, NULL);
535             error_printf("\n");
536             goto early_err;
537         }
538 
539         if (qdict_haskey(bs_opts, "driver")) {
540             error_setg(errp, "Cannot specify both 'driver' and 'format'");
541             goto early_err;
542         }
543         qdict_put_str(bs_opts, "driver", buf);
544     }
545 
546     on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
547     if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
548         on_write_error = parse_block_error_action(buf, 0, &error);
549         if (error) {
550             error_propagate(errp, error);
551             goto early_err;
552         }
553     }
554 
555     on_read_error = BLOCKDEV_ON_ERROR_REPORT;
556     if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
557         on_read_error = parse_block_error_action(buf, 1, &error);
558         if (error) {
559             error_propagate(errp, error);
560             goto early_err;
561         }
562     }
563 
564     if (snapshot) {
565         bdrv_flags |= BDRV_O_SNAPSHOT;
566     }
567 
568     read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
569 
570     /* init */
571     if ((!file || !*file) && !qdict_size(bs_opts)) {
572         BlockBackendRootState *blk_rs;
573 
574         blk = blk_new(0, BLK_PERM_ALL);
575         blk_rs = blk_get_root_state(blk);
576         blk_rs->open_flags    = bdrv_flags;
577         blk_rs->read_only     = read_only;
578         blk_rs->detect_zeroes = detect_zeroes;
579 
580         qobject_unref(bs_opts);
581     } else {
582         if (file && !*file) {
583             file = NULL;
584         }
585 
586         /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
587          * with other callers) rather than what we want as the real defaults.
588          * Apply the defaults here instead. */
589         qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
590         qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
591         qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
592                               read_only ? "on" : "off");
593         qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
594         assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
595 
596         if (runstate_check(RUN_STATE_INMIGRATE)) {
597             bdrv_flags |= BDRV_O_INACTIVE;
598         }
599 
600         blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
601         if (!blk) {
602             goto err_no_bs_opts;
603         }
604         bs = blk_bs(blk);
605 
606         bs->detect_zeroes = detect_zeroes;
607 
608         block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
609 
610         if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
611             blk_unref(blk);
612             blk = NULL;
613             goto err_no_bs_opts;
614         }
615     }
616 
617     /* disk I/O throttling */
618     if (throttle_enabled(&cfg)) {
619         if (!throttling_group) {
620             throttling_group = id;
621         }
622         blk_io_limits_enable(blk, throttling_group);
623         blk_set_io_limits(blk, &cfg);
624     }
625 
626     blk_set_enable_write_cache(blk, !writethrough);
627     blk_set_on_error(blk, on_read_error, on_write_error);
628 
629     if (!monitor_add_blk(blk, id, errp)) {
630         blk_unref(blk);
631         blk = NULL;
632         goto err_no_bs_opts;
633     }
634 
635 err_no_bs_opts:
636     qemu_opts_del(opts);
637     qobject_unref(interval_dict);
638     qobject_unref(interval_list);
639     return blk;
640 
641 early_err:
642     qemu_opts_del(opts);
643     qobject_unref(interval_dict);
644     qobject_unref(interval_list);
645 err_no_opts:
646     qobject_unref(bs_opts);
647     return NULL;
648 }
649 
650 /* Takes the ownership of bs_opts */
651 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
652 {
653     int bdrv_flags = 0;
654 
655     /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
656      * with other callers) rather than what we want as the real defaults.
657      * Apply the defaults here instead. */
658     qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
659     qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
660     qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
661 
662     if (runstate_check(RUN_STATE_INMIGRATE)) {
663         bdrv_flags |= BDRV_O_INACTIVE;
664     }
665 
666     return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
667 }
668 
669 void blockdev_close_all_bdrv_states(void)
670 {
671     BlockDriverState *bs, *next_bs;
672 
673     QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
674         AioContext *ctx = bdrv_get_aio_context(bs);
675 
676         aio_context_acquire(ctx);
677         bdrv_unref(bs);
678         aio_context_release(ctx);
679     }
680 }
681 
682 /* Iterates over the list of monitor-owned BlockDriverStates */
683 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
684 {
685     return bs ? QTAILQ_NEXT(bs, monitor_list)
686               : QTAILQ_FIRST(&monitor_bdrv_states);
687 }
688 
689 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
690                             Error **errp)
691 {
692     const char *value;
693 
694     value = qemu_opt_get(opts, from);
695     if (value) {
696         if (qemu_opt_find(opts, to)) {
697             error_setg(errp, "'%s' and its alias '%s' can't be used at the "
698                        "same time", to, from);
699             return;
700         }
701     }
702 
703     /* rename all items in opts */
704     while ((value = qemu_opt_get(opts, from))) {
705         qemu_opt_set(opts, to, value, &error_abort);
706         qemu_opt_unset(opts, from);
707     }
708 }
709 
710 QemuOptsList qemu_legacy_drive_opts = {
711     .name = "drive",
712     .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
713     .desc = {
714         {
715             .name = "bus",
716             .type = QEMU_OPT_NUMBER,
717             .help = "bus number",
718         },{
719             .name = "unit",
720             .type = QEMU_OPT_NUMBER,
721             .help = "unit number (i.e. lun for scsi)",
722         },{
723             .name = "index",
724             .type = QEMU_OPT_NUMBER,
725             .help = "index number",
726         },{
727             .name = "media",
728             .type = QEMU_OPT_STRING,
729             .help = "media type (disk, cdrom)",
730         },{
731             .name = "if",
732             .type = QEMU_OPT_STRING,
733             .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
734         },{
735             .name = "file",
736             .type = QEMU_OPT_STRING,
737             .help = "file name",
738         },
739 
740         /* Options that are passed on, but have special semantics with -drive */
741         {
742             .name = BDRV_OPT_READ_ONLY,
743             .type = QEMU_OPT_BOOL,
744             .help = "open drive file as read-only",
745         },{
746             .name = "rerror",
747             .type = QEMU_OPT_STRING,
748             .help = "read error action",
749         },{
750             .name = "werror",
751             .type = QEMU_OPT_STRING,
752             .help = "write error action",
753         },{
754             .name = "copy-on-read",
755             .type = QEMU_OPT_BOOL,
756             .help = "copy read data from backing file into image file",
757         },
758 
759         { /* end of list */ }
760     },
761 };
762 
763 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
764                      Error **errp)
765 {
766     const char *value;
767     BlockBackend *blk;
768     DriveInfo *dinfo = NULL;
769     QDict *bs_opts;
770     QemuOpts *legacy_opts;
771     DriveMediaType media = MEDIA_DISK;
772     BlockInterfaceType type;
773     int max_devs, bus_id, unit_id, index;
774     const char *werror, *rerror;
775     bool read_only = false;
776     bool copy_on_read;
777     const char *filename;
778     Error *local_err = NULL;
779     int i;
780 
781     /* Change legacy command line options into QMP ones */
782     static const struct {
783         const char *from;
784         const char *to;
785     } opt_renames[] = {
786         { "iops",           "throttling.iops-total" },
787         { "iops_rd",        "throttling.iops-read" },
788         { "iops_wr",        "throttling.iops-write" },
789 
790         { "bps",            "throttling.bps-total" },
791         { "bps_rd",         "throttling.bps-read" },
792         { "bps_wr",         "throttling.bps-write" },
793 
794         { "iops_max",       "throttling.iops-total-max" },
795         { "iops_rd_max",    "throttling.iops-read-max" },
796         { "iops_wr_max",    "throttling.iops-write-max" },
797 
798         { "bps_max",        "throttling.bps-total-max" },
799         { "bps_rd_max",     "throttling.bps-read-max" },
800         { "bps_wr_max",     "throttling.bps-write-max" },
801 
802         { "iops_size",      "throttling.iops-size" },
803 
804         { "group",          "throttling.group" },
805 
806         { "readonly",       BDRV_OPT_READ_ONLY },
807     };
808 
809     for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
810         qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
811                         &local_err);
812         if (local_err) {
813             error_propagate(errp, local_err);
814             return NULL;
815         }
816     }
817 
818     value = qemu_opt_get(all_opts, "cache");
819     if (value) {
820         int flags = 0;
821         bool writethrough;
822 
823         if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
824             error_setg(errp, "invalid cache option");
825             return NULL;
826         }
827 
828         /* Specific options take precedence */
829         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
830             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
831                               !writethrough, &error_abort);
832         }
833         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
834             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
835                               !!(flags & BDRV_O_NOCACHE), &error_abort);
836         }
837         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
838             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
839                               !!(flags & BDRV_O_NO_FLUSH), &error_abort);
840         }
841         qemu_opt_unset(all_opts, "cache");
842     }
843 
844     /* Get a QDict for processing the options */
845     bs_opts = qdict_new();
846     qemu_opts_to_qdict(all_opts, bs_opts);
847 
848     legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
849                                    &error_abort);
850     qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
851     if (local_err) {
852         error_propagate(errp, local_err);
853         goto fail;
854     }
855 
856     /* Media type */
857     value = qemu_opt_get(legacy_opts, "media");
858     if (value) {
859         if (!strcmp(value, "disk")) {
860             media = MEDIA_DISK;
861         } else if (!strcmp(value, "cdrom")) {
862             media = MEDIA_CDROM;
863             read_only = true;
864         } else {
865             error_setg(errp, "'%s' invalid media", value);
866             goto fail;
867         }
868     }
869 
870     /* copy-on-read is disabled with a warning for read-only devices */
871     read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
872     copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
873 
874     if (read_only && copy_on_read) {
875         warn_report("disabling copy-on-read on read-only drive");
876         copy_on_read = false;
877     }
878 
879     qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
880     qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
881 
882     /* Controller type */
883     value = qemu_opt_get(legacy_opts, "if");
884     if (value) {
885         for (type = 0;
886              type < IF_COUNT && strcmp(value, if_name[type]);
887              type++) {
888         }
889         if (type == IF_COUNT) {
890             error_setg(errp, "unsupported bus type '%s'", value);
891             goto fail;
892         }
893     } else {
894         type = block_default_type;
895     }
896 
897     /* Device address specified by bus/unit or index.
898      * If none was specified, try to find the first free one. */
899     bus_id  = qemu_opt_get_number(legacy_opts, "bus", 0);
900     unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
901     index   = qemu_opt_get_number(legacy_opts, "index", -1);
902 
903     max_devs = if_max_devs[type];
904 
905     if (index != -1) {
906         if (bus_id != 0 || unit_id != -1) {
907             error_setg(errp, "index cannot be used with bus and unit");
908             goto fail;
909         }
910         bus_id = drive_index_to_bus_id(type, index);
911         unit_id = drive_index_to_unit_id(type, index);
912     }
913 
914     if (unit_id == -1) {
915        unit_id = 0;
916        while (drive_get(type, bus_id, unit_id) != NULL) {
917            unit_id++;
918            if (max_devs && unit_id >= max_devs) {
919                unit_id -= max_devs;
920                bus_id++;
921            }
922        }
923     }
924 
925     if (max_devs && unit_id >= max_devs) {
926         error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
927         goto fail;
928     }
929 
930     if (drive_get(type, bus_id, unit_id) != NULL) {
931         error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
932                    bus_id, unit_id, index);
933         goto fail;
934     }
935 
936     /* no id supplied -> create one */
937     if (qemu_opts_id(all_opts) == NULL) {
938         char *new_id;
939         const char *mediastr = "";
940         if (type == IF_IDE || type == IF_SCSI) {
941             mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
942         }
943         if (max_devs) {
944             new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
945                                      mediastr, unit_id);
946         } else {
947             new_id = g_strdup_printf("%s%s%i", if_name[type],
948                                      mediastr, unit_id);
949         }
950         qdict_put_str(bs_opts, "id", new_id);
951         g_free(new_id);
952     }
953 
954     /* Add virtio block device */
955     if (type == IF_VIRTIO) {
956         QemuOpts *devopts;
957         devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
958                                    &error_abort);
959         if (arch_type == QEMU_ARCH_S390X) {
960             qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
961         } else {
962             qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
963         }
964         qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
965                      &error_abort);
966     }
967 
968     filename = qemu_opt_get(legacy_opts, "file");
969 
970     /* Check werror/rerror compatibility with if=... */
971     werror = qemu_opt_get(legacy_opts, "werror");
972     if (werror != NULL) {
973         if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
974             type != IF_NONE) {
975             error_setg(errp, "werror is not supported by this bus type");
976             goto fail;
977         }
978         qdict_put_str(bs_opts, "werror", werror);
979     }
980 
981     rerror = qemu_opt_get(legacy_opts, "rerror");
982     if (rerror != NULL) {
983         if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
984             type != IF_NONE) {
985             error_setg(errp, "rerror is not supported by this bus type");
986             goto fail;
987         }
988         qdict_put_str(bs_opts, "rerror", rerror);
989     }
990 
991     /* Actual block device init: Functionality shared with blockdev-add */
992     blk = blockdev_init(filename, bs_opts, &local_err);
993     bs_opts = NULL;
994     if (!blk) {
995         error_propagate(errp, local_err);
996         goto fail;
997     } else {
998         assert(!local_err);
999     }
1000 
1001     /* Create legacy DriveInfo */
1002     dinfo = g_malloc0(sizeof(*dinfo));
1003     dinfo->opts = all_opts;
1004 
1005     dinfo->type = type;
1006     dinfo->bus = bus_id;
1007     dinfo->unit = unit_id;
1008 
1009     blk_set_legacy_dinfo(blk, dinfo);
1010 
1011     switch(type) {
1012     case IF_IDE:
1013     case IF_SCSI:
1014     case IF_XEN:
1015     case IF_NONE:
1016         dinfo->media_cd = media == MEDIA_CDROM;
1017         break;
1018     default:
1019         break;
1020     }
1021 
1022 fail:
1023     qemu_opts_del(legacy_opts);
1024     qobject_unref(bs_opts);
1025     return dinfo;
1026 }
1027 
1028 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1029 {
1030     BlockDriverState *bs;
1031 
1032     bs = bdrv_lookup_bs(name, name, errp);
1033     if (bs == NULL) {
1034         return NULL;
1035     }
1036 
1037     if (!bdrv_is_root_node(bs)) {
1038         error_setg(errp, "Need a root block node");
1039         return NULL;
1040     }
1041 
1042     if (!bdrv_is_inserted(bs)) {
1043         error_setg(errp, "Device has no medium");
1044         return NULL;
1045     }
1046 
1047     return bs;
1048 }
1049 
1050 static BlockBackend *qmp_get_blk(const char *blk_name, const char *qdev_id,
1051                                  Error **errp)
1052 {
1053     BlockBackend *blk;
1054 
1055     if (!blk_name == !qdev_id) {
1056         error_setg(errp, "Need exactly one of 'device' and 'id'");
1057         return NULL;
1058     }
1059 
1060     if (qdev_id) {
1061         blk = blk_by_qdev_id(qdev_id, errp);
1062     } else {
1063         blk = blk_by_name(blk_name);
1064         if (blk == NULL) {
1065             error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1066                       "Device '%s' not found", blk_name);
1067         }
1068     }
1069 
1070     return blk;
1071 }
1072 
1073 void hmp_commit(Monitor *mon, const QDict *qdict)
1074 {
1075     const char *device = qdict_get_str(qdict, "device");
1076     BlockBackend *blk;
1077     int ret;
1078 
1079     if (!strcmp(device, "all")) {
1080         ret = blk_commit_all();
1081     } else {
1082         BlockDriverState *bs;
1083         AioContext *aio_context;
1084 
1085         blk = blk_by_name(device);
1086         if (!blk) {
1087             monitor_printf(mon, "Device '%s' not found\n", device);
1088             return;
1089         }
1090         if (!blk_is_available(blk)) {
1091             monitor_printf(mon, "Device '%s' has no medium\n", device);
1092             return;
1093         }
1094 
1095         bs = blk_bs(blk);
1096         aio_context = bdrv_get_aio_context(bs);
1097         aio_context_acquire(aio_context);
1098 
1099         ret = bdrv_commit(bs);
1100 
1101         aio_context_release(aio_context);
1102     }
1103     if (ret < 0) {
1104         monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1105                        strerror(-ret));
1106     }
1107 }
1108 
1109 static void blockdev_do_action(TransactionAction *action, Error **errp)
1110 {
1111     TransactionActionList list;
1112 
1113     list.value = action;
1114     list.next = NULL;
1115     qmp_transaction(&list, false, NULL, errp);
1116 }
1117 
1118 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1119                                 bool has_node_name, const char *node_name,
1120                                 const char *snapshot_file,
1121                                 bool has_snapshot_node_name,
1122                                 const char *snapshot_node_name,
1123                                 bool has_format, const char *format,
1124                                 bool has_mode, NewImageMode mode, Error **errp)
1125 {
1126     BlockdevSnapshotSync snapshot = {
1127         .has_device = has_device,
1128         .device = (char *) device,
1129         .has_node_name = has_node_name,
1130         .node_name = (char *) node_name,
1131         .snapshot_file = (char *) snapshot_file,
1132         .has_snapshot_node_name = has_snapshot_node_name,
1133         .snapshot_node_name = (char *) snapshot_node_name,
1134         .has_format = has_format,
1135         .format = (char *) format,
1136         .has_mode = has_mode,
1137         .mode = mode,
1138     };
1139     TransactionAction action = {
1140         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1141         .u.blockdev_snapshot_sync.data = &snapshot,
1142     };
1143     blockdev_do_action(&action, errp);
1144 }
1145 
1146 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1147                            Error **errp)
1148 {
1149     BlockdevSnapshot snapshot_data = {
1150         .node = (char *) node,
1151         .overlay = (char *) overlay
1152     };
1153     TransactionAction action = {
1154         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1155         .u.blockdev_snapshot.data = &snapshot_data,
1156     };
1157     blockdev_do_action(&action, errp);
1158 }
1159 
1160 void qmp_blockdev_snapshot_internal_sync(const char *device,
1161                                          const char *name,
1162                                          Error **errp)
1163 {
1164     BlockdevSnapshotInternal snapshot = {
1165         .device = (char *) device,
1166         .name = (char *) name
1167     };
1168     TransactionAction action = {
1169         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1170         .u.blockdev_snapshot_internal_sync.data = &snapshot,
1171     };
1172     blockdev_do_action(&action, errp);
1173 }
1174 
1175 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1176                                                          bool has_id,
1177                                                          const char *id,
1178                                                          bool has_name,
1179                                                          const char *name,
1180                                                          Error **errp)
1181 {
1182     BlockDriverState *bs;
1183     AioContext *aio_context;
1184     QEMUSnapshotInfo sn;
1185     Error *local_err = NULL;
1186     SnapshotInfo *info = NULL;
1187     int ret;
1188 
1189     bs = qmp_get_root_bs(device, errp);
1190     if (!bs) {
1191         return NULL;
1192     }
1193     aio_context = bdrv_get_aio_context(bs);
1194     aio_context_acquire(aio_context);
1195 
1196     if (!has_id) {
1197         id = NULL;
1198     }
1199 
1200     if (!has_name) {
1201         name = NULL;
1202     }
1203 
1204     if (!id && !name) {
1205         error_setg(errp, "Name or id must be provided");
1206         goto out_aio_context;
1207     }
1208 
1209     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1210         goto out_aio_context;
1211     }
1212 
1213     ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1214     if (local_err) {
1215         error_propagate(errp, local_err);
1216         goto out_aio_context;
1217     }
1218     if (!ret) {
1219         error_setg(errp,
1220                    "Snapshot with id '%s' and name '%s' does not exist on "
1221                    "device '%s'",
1222                    STR_OR_NULL(id), STR_OR_NULL(name), device);
1223         goto out_aio_context;
1224     }
1225 
1226     bdrv_snapshot_delete(bs, id, name, &local_err);
1227     if (local_err) {
1228         error_propagate(errp, local_err);
1229         goto out_aio_context;
1230     }
1231 
1232     aio_context_release(aio_context);
1233 
1234     info = g_new0(SnapshotInfo, 1);
1235     info->id = g_strdup(sn.id_str);
1236     info->name = g_strdup(sn.name);
1237     info->date_nsec = sn.date_nsec;
1238     info->date_sec = sn.date_sec;
1239     info->vm_state_size = sn.vm_state_size;
1240     info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1241     info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1242 
1243     return info;
1244 
1245 out_aio_context:
1246     aio_context_release(aio_context);
1247     return NULL;
1248 }
1249 
1250 /**
1251  * block_dirty_bitmap_lookup:
1252  * Return a dirty bitmap (if present), after validating
1253  * the node reference and bitmap names.
1254  *
1255  * @node: The name of the BDS node to search for bitmaps
1256  * @name: The name of the bitmap to search for
1257  * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1258  * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1259  * @errp: Output pointer for error information. Can be NULL.
1260  *
1261  * @return: A bitmap object on success, or NULL on failure.
1262  */
1263 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1264                                                   const char *name,
1265                                                   BlockDriverState **pbs,
1266                                                   Error **errp)
1267 {
1268     BlockDriverState *bs;
1269     BdrvDirtyBitmap *bitmap;
1270 
1271     if (!node) {
1272         error_setg(errp, "Node cannot be NULL");
1273         return NULL;
1274     }
1275     if (!name) {
1276         error_setg(errp, "Bitmap name cannot be NULL");
1277         return NULL;
1278     }
1279     bs = bdrv_lookup_bs(node, node, NULL);
1280     if (!bs) {
1281         error_setg(errp, "Node '%s' not found", node);
1282         return NULL;
1283     }
1284 
1285     bitmap = bdrv_find_dirty_bitmap(bs, name);
1286     if (!bitmap) {
1287         error_setg(errp, "Dirty bitmap '%s' not found", name);
1288         return NULL;
1289     }
1290 
1291     if (pbs) {
1292         *pbs = bs;
1293     }
1294 
1295     return bitmap;
1296 }
1297 
1298 /* New and old BlockDriverState structs for atomic group operations */
1299 
1300 typedef struct BlkActionState BlkActionState;
1301 
1302 /**
1303  * BlkActionOps:
1304  * Table of operations that define an Action.
1305  *
1306  * @instance_size: Size of state struct, in bytes.
1307  * @prepare: Prepare the work, must NOT be NULL.
1308  * @commit: Commit the changes, can be NULL.
1309  * @abort: Abort the changes on fail, can be NULL.
1310  * @clean: Clean up resources after all transaction actions have called
1311  *         commit() or abort(). Can be NULL.
1312  *
1313  * Only prepare() may fail. In a single transaction, only one of commit() or
1314  * abort() will be called. clean() will always be called if it is present.
1315  */
1316 typedef struct BlkActionOps {
1317     size_t instance_size;
1318     void (*prepare)(BlkActionState *common, Error **errp);
1319     void (*commit)(BlkActionState *common);
1320     void (*abort)(BlkActionState *common);
1321     void (*clean)(BlkActionState *common);
1322 } BlkActionOps;
1323 
1324 /**
1325  * BlkActionState:
1326  * Describes one Action's state within a Transaction.
1327  *
1328  * @action: QAPI-defined enum identifying which Action to perform.
1329  * @ops: Table of ActionOps this Action can perform.
1330  * @block_job_txn: Transaction which this action belongs to.
1331  * @entry: List membership for all Actions in this Transaction.
1332  *
1333  * This structure must be arranged as first member in a subclassed type,
1334  * assuming that the compiler will also arrange it to the same offsets as the
1335  * base class.
1336  */
1337 struct BlkActionState {
1338     TransactionAction *action;
1339     const BlkActionOps *ops;
1340     JobTxn *block_job_txn;
1341     TransactionProperties *txn_props;
1342     QSIMPLEQ_ENTRY(BlkActionState) entry;
1343 };
1344 
1345 /* internal snapshot private data */
1346 typedef struct InternalSnapshotState {
1347     BlkActionState common;
1348     BlockDriverState *bs;
1349     QEMUSnapshotInfo sn;
1350     bool created;
1351 } InternalSnapshotState;
1352 
1353 
1354 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1355 {
1356     if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1357         error_setg(errp,
1358                    "Action '%s' does not support Transaction property "
1359                    "completion-mode = %s",
1360                    TransactionActionKind_str(s->action->type),
1361                    ActionCompletionMode_str(s->txn_props->completion_mode));
1362         return -1;
1363     }
1364     return 0;
1365 }
1366 
1367 static void internal_snapshot_prepare(BlkActionState *common,
1368                                       Error **errp)
1369 {
1370     Error *local_err = NULL;
1371     const char *device;
1372     const char *name;
1373     BlockDriverState *bs;
1374     QEMUSnapshotInfo old_sn, *sn;
1375     bool ret;
1376     qemu_timeval tv;
1377     BlockdevSnapshotInternal *internal;
1378     InternalSnapshotState *state;
1379     AioContext *aio_context;
1380     int ret1;
1381 
1382     g_assert(common->action->type ==
1383              TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1384     internal = common->action->u.blockdev_snapshot_internal_sync.data;
1385     state = DO_UPCAST(InternalSnapshotState, common, common);
1386 
1387     /* 1. parse input */
1388     device = internal->device;
1389     name = internal->name;
1390 
1391     /* 2. check for validation */
1392     if (action_check_completion_mode(common, errp) < 0) {
1393         return;
1394     }
1395 
1396     bs = qmp_get_root_bs(device, errp);
1397     if (!bs) {
1398         return;
1399     }
1400 
1401     aio_context = bdrv_get_aio_context(bs);
1402     aio_context_acquire(aio_context);
1403 
1404     state->bs = bs;
1405 
1406     /* Paired with .clean() */
1407     bdrv_drained_begin(bs);
1408 
1409     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1410         goto out;
1411     }
1412 
1413     if (bdrv_is_read_only(bs)) {
1414         error_setg(errp, "Device '%s' is read only", device);
1415         goto out;
1416     }
1417 
1418     if (!bdrv_can_snapshot(bs)) {
1419         error_setg(errp, "Block format '%s' used by device '%s' "
1420                    "does not support internal snapshots",
1421                    bs->drv->format_name, device);
1422         goto out;
1423     }
1424 
1425     if (!strlen(name)) {
1426         error_setg(errp, "Name is empty");
1427         goto out;
1428     }
1429 
1430     /* check whether a snapshot with name exist */
1431     ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1432                                             &local_err);
1433     if (local_err) {
1434         error_propagate(errp, local_err);
1435         goto out;
1436     } else if (ret) {
1437         error_setg(errp,
1438                    "Snapshot with name '%s' already exists on device '%s'",
1439                    name, device);
1440         goto out;
1441     }
1442 
1443     /* 3. take the snapshot */
1444     sn = &state->sn;
1445     pstrcpy(sn->name, sizeof(sn->name), name);
1446     qemu_gettimeofday(&tv);
1447     sn->date_sec = tv.tv_sec;
1448     sn->date_nsec = tv.tv_usec * 1000;
1449     sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1450 
1451     ret1 = bdrv_snapshot_create(bs, sn);
1452     if (ret1 < 0) {
1453         error_setg_errno(errp, -ret1,
1454                          "Failed to create snapshot '%s' on device '%s'",
1455                          name, device);
1456         goto out;
1457     }
1458 
1459     /* 4. succeed, mark a snapshot is created */
1460     state->created = true;
1461 
1462 out:
1463     aio_context_release(aio_context);
1464 }
1465 
1466 static void internal_snapshot_abort(BlkActionState *common)
1467 {
1468     InternalSnapshotState *state =
1469                              DO_UPCAST(InternalSnapshotState, common, common);
1470     BlockDriverState *bs = state->bs;
1471     QEMUSnapshotInfo *sn = &state->sn;
1472     AioContext *aio_context;
1473     Error *local_error = NULL;
1474 
1475     if (!state->created) {
1476         return;
1477     }
1478 
1479     aio_context = bdrv_get_aio_context(state->bs);
1480     aio_context_acquire(aio_context);
1481 
1482     if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1483         error_reportf_err(local_error,
1484                           "Failed to delete snapshot with id '%s' and "
1485                           "name '%s' on device '%s' in abort: ",
1486                           sn->id_str, sn->name,
1487                           bdrv_get_device_name(bs));
1488     }
1489 
1490     aio_context_release(aio_context);
1491 }
1492 
1493 static void internal_snapshot_clean(BlkActionState *common)
1494 {
1495     InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1496                                              common, common);
1497     AioContext *aio_context;
1498 
1499     if (!state->bs) {
1500         return;
1501     }
1502 
1503     aio_context = bdrv_get_aio_context(state->bs);
1504     aio_context_acquire(aio_context);
1505 
1506     bdrv_drained_end(state->bs);
1507 
1508     aio_context_release(aio_context);
1509 }
1510 
1511 /* external snapshot private data */
1512 typedef struct ExternalSnapshotState {
1513     BlkActionState common;
1514     BlockDriverState *old_bs;
1515     BlockDriverState *new_bs;
1516     bool overlay_appended;
1517 } ExternalSnapshotState;
1518 
1519 static void external_snapshot_prepare(BlkActionState *common,
1520                                       Error **errp)
1521 {
1522     int flags = 0;
1523     QDict *options = NULL;
1524     Error *local_err = NULL;
1525     /* Device and node name of the image to generate the snapshot from */
1526     const char *device;
1527     const char *node_name;
1528     /* Reference to the new image (for 'blockdev-snapshot') */
1529     const char *snapshot_ref;
1530     /* File name of the new image (for 'blockdev-snapshot-sync') */
1531     const char *new_image_file;
1532     ExternalSnapshotState *state =
1533                              DO_UPCAST(ExternalSnapshotState, common, common);
1534     TransactionAction *action = common->action;
1535     AioContext *aio_context;
1536 
1537     /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1538      * purpose but a different set of parameters */
1539     switch (action->type) {
1540     case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1541         {
1542             BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1543             device = s->node;
1544             node_name = s->node;
1545             new_image_file = NULL;
1546             snapshot_ref = s->overlay;
1547         }
1548         break;
1549     case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1550         {
1551             BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1552             device = s->has_device ? s->device : NULL;
1553             node_name = s->has_node_name ? s->node_name : NULL;
1554             new_image_file = s->snapshot_file;
1555             snapshot_ref = NULL;
1556         }
1557         break;
1558     default:
1559         g_assert_not_reached();
1560     }
1561 
1562     /* start processing */
1563     if (action_check_completion_mode(common, errp) < 0) {
1564         return;
1565     }
1566 
1567     state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1568     if (!state->old_bs) {
1569         return;
1570     }
1571 
1572     aio_context = bdrv_get_aio_context(state->old_bs);
1573     aio_context_acquire(aio_context);
1574 
1575     /* Paired with .clean() */
1576     bdrv_drained_begin(state->old_bs);
1577 
1578     if (!bdrv_is_inserted(state->old_bs)) {
1579         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1580         goto out;
1581     }
1582 
1583     if (bdrv_op_is_blocked(state->old_bs,
1584                            BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1585         goto out;
1586     }
1587 
1588     if (!bdrv_is_read_only(state->old_bs)) {
1589         if (bdrv_flush(state->old_bs)) {
1590             error_setg(errp, QERR_IO_ERROR);
1591             goto out;
1592         }
1593     }
1594 
1595     if (!bdrv_is_first_non_filter(state->old_bs)) {
1596         error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1597         goto out;
1598     }
1599 
1600     if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1601         BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1602         const char *format = s->has_format ? s->format : "qcow2";
1603         enum NewImageMode mode;
1604         const char *snapshot_node_name =
1605             s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1606 
1607         if (node_name && !snapshot_node_name) {
1608             error_setg(errp, "New snapshot node name missing");
1609             goto out;
1610         }
1611 
1612         if (snapshot_node_name &&
1613             bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1614             error_setg(errp, "New snapshot node name already in use");
1615             goto out;
1616         }
1617 
1618         flags = state->old_bs->open_flags;
1619         flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1620         flags |= BDRV_O_NO_BACKING;
1621 
1622         /* create new image w/backing file */
1623         mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1624         if (mode != NEW_IMAGE_MODE_EXISTING) {
1625             int64_t size = bdrv_getlength(state->old_bs);
1626             if (size < 0) {
1627                 error_setg_errno(errp, -size, "bdrv_getlength failed");
1628                 goto out;
1629             }
1630             bdrv_img_create(new_image_file, format,
1631                             state->old_bs->filename,
1632                             state->old_bs->drv->format_name,
1633                             NULL, size, flags, false, &local_err);
1634             if (local_err) {
1635                 error_propagate(errp, local_err);
1636                 goto out;
1637             }
1638         }
1639 
1640         options = qdict_new();
1641         if (snapshot_node_name) {
1642             qdict_put_str(options, "node-name", snapshot_node_name);
1643         }
1644         qdict_put_str(options, "driver", format);
1645     }
1646 
1647     state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1648                               errp);
1649     /* We will manually add the backing_hd field to the bs later */
1650     if (!state->new_bs) {
1651         goto out;
1652     }
1653 
1654     if (bdrv_has_blk(state->new_bs)) {
1655         error_setg(errp, "The snapshot is already in use");
1656         goto out;
1657     }
1658 
1659     if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
1660                            errp)) {
1661         goto out;
1662     }
1663 
1664     if (state->new_bs->backing != NULL) {
1665         error_setg(errp, "The snapshot already has a backing image");
1666         goto out;
1667     }
1668 
1669     if (!state->new_bs->drv->supports_backing) {
1670         error_setg(errp, "The snapshot does not support backing images");
1671         goto out;
1672     }
1673 
1674     bdrv_set_aio_context(state->new_bs, aio_context);
1675 
1676     /* This removes our old bs and adds the new bs. This is an operation that
1677      * can fail, so we need to do it in .prepare; undoing it for abort is
1678      * always possible. */
1679     bdrv_ref(state->new_bs);
1680     bdrv_append(state->new_bs, state->old_bs, &local_err);
1681     if (local_err) {
1682         error_propagate(errp, local_err);
1683         goto out;
1684     }
1685     state->overlay_appended = true;
1686 
1687 out:
1688     aio_context_release(aio_context);
1689 }
1690 
1691 static void external_snapshot_commit(BlkActionState *common)
1692 {
1693     ExternalSnapshotState *state =
1694                              DO_UPCAST(ExternalSnapshotState, common, common);
1695     AioContext *aio_context;
1696 
1697     aio_context = bdrv_get_aio_context(state->old_bs);
1698     aio_context_acquire(aio_context);
1699 
1700     /* We don't need (or want) to use the transactional
1701      * bdrv_reopen_multiple() across all the entries at once, because we
1702      * don't want to abort all of them if one of them fails the reopen */
1703     if (!atomic_read(&state->old_bs->copy_on_read)) {
1704         bdrv_reopen_set_read_only(state->old_bs, true, NULL);
1705     }
1706 
1707     aio_context_release(aio_context);
1708 }
1709 
1710 static void external_snapshot_abort(BlkActionState *common)
1711 {
1712     ExternalSnapshotState *state =
1713                              DO_UPCAST(ExternalSnapshotState, common, common);
1714     if (state->new_bs) {
1715         if (state->overlay_appended) {
1716             AioContext *aio_context;
1717 
1718             aio_context = bdrv_get_aio_context(state->old_bs);
1719             aio_context_acquire(aio_context);
1720 
1721             bdrv_ref(state->old_bs);   /* we can't let bdrv_set_backind_hd()
1722                                           close state->old_bs; we need it */
1723             bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
1724             bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
1725             bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
1726 
1727             aio_context_release(aio_context);
1728         }
1729     }
1730 }
1731 
1732 static void external_snapshot_clean(BlkActionState *common)
1733 {
1734     ExternalSnapshotState *state =
1735                              DO_UPCAST(ExternalSnapshotState, common, common);
1736     AioContext *aio_context;
1737 
1738     if (!state->old_bs) {
1739         return;
1740     }
1741 
1742     aio_context = bdrv_get_aio_context(state->old_bs);
1743     aio_context_acquire(aio_context);
1744 
1745     bdrv_drained_end(state->old_bs);
1746     bdrv_unref(state->new_bs);
1747 
1748     aio_context_release(aio_context);
1749 }
1750 
1751 typedef struct DriveBackupState {
1752     BlkActionState common;
1753     BlockDriverState *bs;
1754     BlockJob *job;
1755 } DriveBackupState;
1756 
1757 static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
1758                             Error **errp);
1759 
1760 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1761 {
1762     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1763     BlockDriverState *bs;
1764     DriveBackup *backup;
1765     AioContext *aio_context;
1766     Error *local_err = NULL;
1767 
1768     assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1769     backup = common->action->u.drive_backup.data;
1770 
1771     bs = qmp_get_root_bs(backup->device, errp);
1772     if (!bs) {
1773         return;
1774     }
1775 
1776     aio_context = bdrv_get_aio_context(bs);
1777     aio_context_acquire(aio_context);
1778 
1779     /* Paired with .clean() */
1780     bdrv_drained_begin(bs);
1781 
1782     state->bs = bs;
1783 
1784     state->job = do_drive_backup(backup, common->block_job_txn, &local_err);
1785     if (local_err) {
1786         error_propagate(errp, local_err);
1787         goto out;
1788     }
1789 
1790 out:
1791     aio_context_release(aio_context);
1792 }
1793 
1794 static void drive_backup_commit(BlkActionState *common)
1795 {
1796     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1797     AioContext *aio_context;
1798 
1799     aio_context = bdrv_get_aio_context(state->bs);
1800     aio_context_acquire(aio_context);
1801 
1802     assert(state->job);
1803     job_start(&state->job->job);
1804 
1805     aio_context_release(aio_context);
1806 }
1807 
1808 static void drive_backup_abort(BlkActionState *common)
1809 {
1810     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1811 
1812     if (state->job) {
1813         AioContext *aio_context;
1814 
1815         aio_context = bdrv_get_aio_context(state->bs);
1816         aio_context_acquire(aio_context);
1817 
1818         job_cancel_sync(&state->job->job);
1819 
1820         aio_context_release(aio_context);
1821     }
1822 }
1823 
1824 static void drive_backup_clean(BlkActionState *common)
1825 {
1826     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1827     AioContext *aio_context;
1828 
1829     if (!state->bs) {
1830         return;
1831     }
1832 
1833     aio_context = bdrv_get_aio_context(state->bs);
1834     aio_context_acquire(aio_context);
1835 
1836     bdrv_drained_end(state->bs);
1837 
1838     aio_context_release(aio_context);
1839 }
1840 
1841 typedef struct BlockdevBackupState {
1842     BlkActionState common;
1843     BlockDriverState *bs;
1844     BlockJob *job;
1845 } BlockdevBackupState;
1846 
1847 static BlockJob *do_blockdev_backup(BlockdevBackup *backup, JobTxn *txn,
1848                                     Error **errp);
1849 
1850 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1851 {
1852     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1853     BlockdevBackup *backup;
1854     BlockDriverState *bs, *target;
1855     AioContext *aio_context;
1856     Error *local_err = NULL;
1857 
1858     assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1859     backup = common->action->u.blockdev_backup.data;
1860 
1861     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1862     if (!bs) {
1863         return;
1864     }
1865 
1866     target = bdrv_lookup_bs(backup->target, backup->target, errp);
1867     if (!target) {
1868         return;
1869     }
1870 
1871     aio_context = bdrv_get_aio_context(bs);
1872     if (aio_context != bdrv_get_aio_context(target)) {
1873         error_setg(errp, "Backup between two IO threads is not implemented");
1874         return;
1875     }
1876     aio_context_acquire(aio_context);
1877     state->bs = bs;
1878 
1879     /* Paired with .clean() */
1880     bdrv_drained_begin(state->bs);
1881 
1882     state->job = do_blockdev_backup(backup, common->block_job_txn, &local_err);
1883     if (local_err) {
1884         error_propagate(errp, local_err);
1885         goto out;
1886     }
1887 
1888 out:
1889     aio_context_release(aio_context);
1890 }
1891 
1892 static void blockdev_backup_commit(BlkActionState *common)
1893 {
1894     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1895     AioContext *aio_context;
1896 
1897     aio_context = bdrv_get_aio_context(state->bs);
1898     aio_context_acquire(aio_context);
1899 
1900     assert(state->job);
1901     job_start(&state->job->job);
1902 
1903     aio_context_release(aio_context);
1904 }
1905 
1906 static void blockdev_backup_abort(BlkActionState *common)
1907 {
1908     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1909 
1910     if (state->job) {
1911         AioContext *aio_context;
1912 
1913         aio_context = bdrv_get_aio_context(state->bs);
1914         aio_context_acquire(aio_context);
1915 
1916         job_cancel_sync(&state->job->job);
1917 
1918         aio_context_release(aio_context);
1919     }
1920 }
1921 
1922 static void blockdev_backup_clean(BlkActionState *common)
1923 {
1924     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1925     AioContext *aio_context;
1926 
1927     if (!state->bs) {
1928         return;
1929     }
1930 
1931     aio_context = bdrv_get_aio_context(state->bs);
1932     aio_context_acquire(aio_context);
1933 
1934     bdrv_drained_end(state->bs);
1935 
1936     aio_context_release(aio_context);
1937 }
1938 
1939 typedef struct BlockDirtyBitmapState {
1940     BlkActionState common;
1941     BdrvDirtyBitmap *bitmap;
1942     BlockDriverState *bs;
1943     HBitmap *backup;
1944     bool prepared;
1945     bool was_enabled;
1946 } BlockDirtyBitmapState;
1947 
1948 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
1949                                            Error **errp)
1950 {
1951     Error *local_err = NULL;
1952     BlockDirtyBitmapAdd *action;
1953     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1954                                              common, common);
1955 
1956     if (action_check_completion_mode(common, errp) < 0) {
1957         return;
1958     }
1959 
1960     action = common->action->u.block_dirty_bitmap_add.data;
1961     /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1962     qmp_block_dirty_bitmap_add(action->node, action->name,
1963                                action->has_granularity, action->granularity,
1964                                action->has_persistent, action->persistent,
1965                                action->has_autoload, action->autoload,
1966                                action->has_x_disabled, action->x_disabled,
1967                                &local_err);
1968 
1969     if (!local_err) {
1970         state->prepared = true;
1971     } else {
1972         error_propagate(errp, local_err);
1973     }
1974 }
1975 
1976 static void block_dirty_bitmap_add_abort(BlkActionState *common)
1977 {
1978     BlockDirtyBitmapAdd *action;
1979     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1980                                              common, common);
1981 
1982     action = common->action->u.block_dirty_bitmap_add.data;
1983     /* Should not be able to fail: IF the bitmap was added via .prepare(),
1984      * then the node reference and bitmap name must have been valid.
1985      */
1986     if (state->prepared) {
1987         qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
1988     }
1989 }
1990 
1991 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
1992                                              Error **errp)
1993 {
1994     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1995                                              common, common);
1996     BlockDirtyBitmap *action;
1997 
1998     if (action_check_completion_mode(common, errp) < 0) {
1999         return;
2000     }
2001 
2002     action = common->action->u.block_dirty_bitmap_clear.data;
2003     state->bitmap = block_dirty_bitmap_lookup(action->node,
2004                                               action->name,
2005                                               &state->bs,
2006                                               errp);
2007     if (!state->bitmap) {
2008         return;
2009     }
2010 
2011     if (bdrv_dirty_bitmap_user_locked(state->bitmap)) {
2012         error_setg(errp, "Cannot modify a bitmap in use by another operation");
2013         return;
2014     } else if (bdrv_dirty_bitmap_readonly(state->bitmap)) {
2015         error_setg(errp, "Cannot clear a readonly bitmap");
2016         return;
2017     }
2018 
2019     bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2020 }
2021 
2022 static void block_dirty_bitmap_restore(BlkActionState *common)
2023 {
2024     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2025                                              common, common);
2026 
2027     if (state->backup) {
2028         bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
2029     }
2030 }
2031 
2032 static void block_dirty_bitmap_free_backup(BlkActionState *common)
2033 {
2034     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2035                                              common, common);
2036 
2037     hbitmap_free(state->backup);
2038 }
2039 
2040 static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2041                                               Error **errp)
2042 {
2043     BlockDirtyBitmap *action;
2044     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2045                                              common, common);
2046 
2047     if (action_check_completion_mode(common, errp) < 0) {
2048         return;
2049     }
2050 
2051     action = common->action->u.x_block_dirty_bitmap_enable.data;
2052     state->bitmap = block_dirty_bitmap_lookup(action->node,
2053                                               action->name,
2054                                               NULL,
2055                                               errp);
2056     if (!state->bitmap) {
2057         return;
2058     }
2059 
2060     if (bdrv_dirty_bitmap_user_locked(state->bitmap)) {
2061         error_setg(errp,
2062                    "Bitmap '%s' is currently in use by another operation"
2063                    " and cannot be enabled", action->name);
2064         return;
2065     }
2066 
2067     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2068     bdrv_enable_dirty_bitmap(state->bitmap);
2069 }
2070 
2071 static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2072 {
2073     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2074                                              common, common);
2075 
2076     if (!state->was_enabled) {
2077         bdrv_disable_dirty_bitmap(state->bitmap);
2078     }
2079 }
2080 
2081 static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2082                                                Error **errp)
2083 {
2084     BlockDirtyBitmap *action;
2085     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2086                                              common, common);
2087 
2088     if (action_check_completion_mode(common, errp) < 0) {
2089         return;
2090     }
2091 
2092     action = common->action->u.x_block_dirty_bitmap_disable.data;
2093     state->bitmap = block_dirty_bitmap_lookup(action->node,
2094                                               action->name,
2095                                               NULL,
2096                                               errp);
2097     if (!state->bitmap) {
2098         return;
2099     }
2100 
2101     if (bdrv_dirty_bitmap_user_locked(state->bitmap)) {
2102         error_setg(errp,
2103                    "Bitmap '%s' is currently in use by another operation"
2104                    " and cannot be disabled", action->name);
2105         return;
2106     }
2107 
2108     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2109     bdrv_disable_dirty_bitmap(state->bitmap);
2110 }
2111 
2112 static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2113 {
2114     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2115                                              common, common);
2116 
2117     if (state->was_enabled) {
2118         bdrv_enable_dirty_bitmap(state->bitmap);
2119     }
2120 }
2121 
2122 static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2123                                              Error **errp)
2124 {
2125     BlockDirtyBitmapMerge *action;
2126     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2127                                              common, common);
2128     BdrvDirtyBitmap *merge_source;
2129 
2130     if (action_check_completion_mode(common, errp) < 0) {
2131         return;
2132     }
2133 
2134     action = common->action->u.x_block_dirty_bitmap_merge.data;
2135     state->bitmap = block_dirty_bitmap_lookup(action->node,
2136                                               action->dst_name,
2137                                               &state->bs,
2138                                               errp);
2139     if (!state->bitmap) {
2140         return;
2141     }
2142 
2143     merge_source = bdrv_find_dirty_bitmap(state->bs, action->src_name);
2144     if (!merge_source) {
2145         return;
2146     }
2147 
2148     bdrv_merge_dirty_bitmap(state->bitmap, merge_source, &state->backup, errp);
2149 }
2150 
2151 static void abort_prepare(BlkActionState *common, Error **errp)
2152 {
2153     error_setg(errp, "Transaction aborted using Abort action");
2154 }
2155 
2156 static void abort_commit(BlkActionState *common)
2157 {
2158     g_assert_not_reached(); /* this action never succeeds */
2159 }
2160 
2161 static const BlkActionOps actions[] = {
2162     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2163         .instance_size = sizeof(ExternalSnapshotState),
2164         .prepare  = external_snapshot_prepare,
2165         .commit   = external_snapshot_commit,
2166         .abort = external_snapshot_abort,
2167         .clean = external_snapshot_clean,
2168     },
2169     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2170         .instance_size = sizeof(ExternalSnapshotState),
2171         .prepare  = external_snapshot_prepare,
2172         .commit   = external_snapshot_commit,
2173         .abort = external_snapshot_abort,
2174         .clean = external_snapshot_clean,
2175     },
2176     [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2177         .instance_size = sizeof(DriveBackupState),
2178         .prepare = drive_backup_prepare,
2179         .commit = drive_backup_commit,
2180         .abort = drive_backup_abort,
2181         .clean = drive_backup_clean,
2182     },
2183     [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2184         .instance_size = sizeof(BlockdevBackupState),
2185         .prepare = blockdev_backup_prepare,
2186         .commit = blockdev_backup_commit,
2187         .abort = blockdev_backup_abort,
2188         .clean = blockdev_backup_clean,
2189     },
2190     [TRANSACTION_ACTION_KIND_ABORT] = {
2191         .instance_size = sizeof(BlkActionState),
2192         .prepare = abort_prepare,
2193         .commit = abort_commit,
2194     },
2195     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2196         .instance_size = sizeof(InternalSnapshotState),
2197         .prepare  = internal_snapshot_prepare,
2198         .abort = internal_snapshot_abort,
2199         .clean = internal_snapshot_clean,
2200     },
2201     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2202         .instance_size = sizeof(BlockDirtyBitmapState),
2203         .prepare = block_dirty_bitmap_add_prepare,
2204         .abort = block_dirty_bitmap_add_abort,
2205     },
2206     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2207         .instance_size = sizeof(BlockDirtyBitmapState),
2208         .prepare = block_dirty_bitmap_clear_prepare,
2209         .commit = block_dirty_bitmap_free_backup,
2210         .abort = block_dirty_bitmap_restore,
2211     },
2212     [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_ENABLE] = {
2213         .instance_size = sizeof(BlockDirtyBitmapState),
2214         .prepare = block_dirty_bitmap_enable_prepare,
2215         .abort = block_dirty_bitmap_enable_abort,
2216     },
2217     [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_DISABLE] = {
2218         .instance_size = sizeof(BlockDirtyBitmapState),
2219         .prepare = block_dirty_bitmap_disable_prepare,
2220         .abort = block_dirty_bitmap_disable_abort,
2221     },
2222     [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_MERGE] = {
2223         .instance_size = sizeof(BlockDirtyBitmapState),
2224         .prepare = block_dirty_bitmap_merge_prepare,
2225         .commit = block_dirty_bitmap_free_backup,
2226         .abort = block_dirty_bitmap_restore,
2227     },
2228     /* Where are transactions for MIRROR, COMMIT and STREAM?
2229      * Although these blockjobs use transaction callbacks like the backup job,
2230      * these jobs do not necessarily adhere to transaction semantics.
2231      * These jobs may not fully undo all of their actions on abort, nor do they
2232      * necessarily work in transactions with more than one job in them.
2233      */
2234 };
2235 
2236 /**
2237  * Allocate a TransactionProperties structure if necessary, and fill
2238  * that structure with desired defaults if they are unset.
2239  */
2240 static TransactionProperties *get_transaction_properties(
2241     TransactionProperties *props)
2242 {
2243     if (!props) {
2244         props = g_new0(TransactionProperties, 1);
2245     }
2246 
2247     if (!props->has_completion_mode) {
2248         props->has_completion_mode = true;
2249         props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2250     }
2251 
2252     return props;
2253 }
2254 
2255 /*
2256  * 'Atomic' group operations.  The operations are performed as a set, and if
2257  * any fail then we roll back all operations in the group.
2258  */
2259 void qmp_transaction(TransactionActionList *dev_list,
2260                      bool has_props,
2261                      struct TransactionProperties *props,
2262                      Error **errp)
2263 {
2264     TransactionActionList *dev_entry = dev_list;
2265     JobTxn *block_job_txn = NULL;
2266     BlkActionState *state, *next;
2267     Error *local_err = NULL;
2268 
2269     QSIMPLEQ_HEAD(, BlkActionState) snap_bdrv_states;
2270     QSIMPLEQ_INIT(&snap_bdrv_states);
2271 
2272     /* Does this transaction get canceled as a group on failure?
2273      * If not, we don't really need to make a JobTxn.
2274      */
2275     props = get_transaction_properties(props);
2276     if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2277         block_job_txn = job_txn_new();
2278     }
2279 
2280     /* drain all i/o before any operations */
2281     bdrv_drain_all();
2282 
2283     /* We don't do anything in this loop that commits us to the operations */
2284     while (NULL != dev_entry) {
2285         TransactionAction *dev_info = NULL;
2286         const BlkActionOps *ops;
2287 
2288         dev_info = dev_entry->value;
2289         dev_entry = dev_entry->next;
2290 
2291         assert(dev_info->type < ARRAY_SIZE(actions));
2292 
2293         ops = &actions[dev_info->type];
2294         assert(ops->instance_size > 0);
2295 
2296         state = g_malloc0(ops->instance_size);
2297         state->ops = ops;
2298         state->action = dev_info;
2299         state->block_job_txn = block_job_txn;
2300         state->txn_props = props;
2301         QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2302 
2303         state->ops->prepare(state, &local_err);
2304         if (local_err) {
2305             error_propagate(errp, local_err);
2306             goto delete_and_fail;
2307         }
2308     }
2309 
2310     QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2311         if (state->ops->commit) {
2312             state->ops->commit(state);
2313         }
2314     }
2315 
2316     /* success */
2317     goto exit;
2318 
2319 delete_and_fail:
2320     /* failure, and it is all-or-none; roll back all operations */
2321     QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2322         if (state->ops->abort) {
2323             state->ops->abort(state);
2324         }
2325     }
2326 exit:
2327     QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2328         if (state->ops->clean) {
2329             state->ops->clean(state);
2330         }
2331         g_free(state);
2332     }
2333     if (!has_props) {
2334         qapi_free_TransactionProperties(props);
2335     }
2336     job_txn_unref(block_job_txn);
2337 }
2338 
2339 void qmp_eject(bool has_device, const char *device,
2340                bool has_id, const char *id,
2341                bool has_force, bool force, Error **errp)
2342 {
2343     Error *local_err = NULL;
2344     int rc;
2345 
2346     if (!has_force) {
2347         force = false;
2348     }
2349 
2350     rc = do_open_tray(has_device ? device : NULL,
2351                       has_id ? id : NULL,
2352                       force, &local_err);
2353     if (rc && rc != -ENOSYS) {
2354         error_propagate(errp, local_err);
2355         return;
2356     }
2357     error_free(local_err);
2358 
2359     blockdev_remove_medium(has_device, device, has_id, id, errp);
2360 }
2361 
2362 void qmp_block_passwd(bool has_device, const char *device,
2363                       bool has_node_name, const char *node_name,
2364                       const char *password, Error **errp)
2365 {
2366     error_setg(errp,
2367                "Setting block passwords directly is no longer supported");
2368 }
2369 
2370 /*
2371  * Attempt to open the tray of @device.
2372  * If @force, ignore its tray lock.
2373  * Else, if the tray is locked, don't open it, but ask the guest to open it.
2374  * On error, store an error through @errp and return -errno.
2375  * If @device does not exist, return -ENODEV.
2376  * If it has no removable media, return -ENOTSUP.
2377  * If it has no tray, return -ENOSYS.
2378  * If the guest was asked to open the tray, return -EINPROGRESS.
2379  * Else, return 0.
2380  */
2381 static int do_open_tray(const char *blk_name, const char *qdev_id,
2382                         bool force, Error **errp)
2383 {
2384     BlockBackend *blk;
2385     const char *device = qdev_id ?: blk_name;
2386     bool locked;
2387 
2388     blk = qmp_get_blk(blk_name, qdev_id, errp);
2389     if (!blk) {
2390         return -ENODEV;
2391     }
2392 
2393     if (!blk_dev_has_removable_media(blk)) {
2394         error_setg(errp, "Device '%s' is not removable", device);
2395         return -ENOTSUP;
2396     }
2397 
2398     if (!blk_dev_has_tray(blk)) {
2399         error_setg(errp, "Device '%s' does not have a tray", device);
2400         return -ENOSYS;
2401     }
2402 
2403     if (blk_dev_is_tray_open(blk)) {
2404         return 0;
2405     }
2406 
2407     locked = blk_dev_is_medium_locked(blk);
2408     if (locked) {
2409         blk_dev_eject_request(blk, force);
2410     }
2411 
2412     if (!locked || force) {
2413         blk_dev_change_media_cb(blk, false, &error_abort);
2414     }
2415 
2416     if (locked && !force) {
2417         error_setg(errp, "Device '%s' is locked and force was not specified, "
2418                    "wait for tray to open and try again", device);
2419         return -EINPROGRESS;
2420     }
2421 
2422     return 0;
2423 }
2424 
2425 void qmp_blockdev_open_tray(bool has_device, const char *device,
2426                             bool has_id, const char *id,
2427                             bool has_force, bool force,
2428                             Error **errp)
2429 {
2430     Error *local_err = NULL;
2431     int rc;
2432 
2433     if (!has_force) {
2434         force = false;
2435     }
2436     rc = do_open_tray(has_device ? device : NULL,
2437                       has_id ? id : NULL,
2438                       force, &local_err);
2439     if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2440         error_propagate(errp, local_err);
2441         return;
2442     }
2443     error_free(local_err);
2444 }
2445 
2446 void qmp_blockdev_close_tray(bool has_device, const char *device,
2447                              bool has_id, const char *id,
2448                              Error **errp)
2449 {
2450     BlockBackend *blk;
2451     Error *local_err = NULL;
2452 
2453     device = has_device ? device : NULL;
2454     id = has_id ? id : NULL;
2455 
2456     blk = qmp_get_blk(device, id, errp);
2457     if (!blk) {
2458         return;
2459     }
2460 
2461     if (!blk_dev_has_removable_media(blk)) {
2462         error_setg(errp, "Device '%s' is not removable", device ?: id);
2463         return;
2464     }
2465 
2466     if (!blk_dev_has_tray(blk)) {
2467         /* Ignore this command on tray-less devices */
2468         return;
2469     }
2470 
2471     if (!blk_dev_is_tray_open(blk)) {
2472         return;
2473     }
2474 
2475     blk_dev_change_media_cb(blk, true, &local_err);
2476     if (local_err) {
2477         error_propagate(errp, local_err);
2478         return;
2479     }
2480 }
2481 
2482 static void blockdev_remove_medium(bool has_device, const char *device,
2483                                    bool has_id, const char *id, Error **errp)
2484 {
2485     BlockBackend *blk;
2486     BlockDriverState *bs;
2487     AioContext *aio_context;
2488     bool has_attached_device;
2489 
2490     device = has_device ? device : NULL;
2491     id = has_id ? id : NULL;
2492 
2493     blk = qmp_get_blk(device, id, errp);
2494     if (!blk) {
2495         return;
2496     }
2497 
2498     /* For BBs without a device, we can exchange the BDS tree at will */
2499     has_attached_device = blk_get_attached_dev(blk);
2500 
2501     if (has_attached_device && !blk_dev_has_removable_media(blk)) {
2502         error_setg(errp, "Device '%s' is not removable", device ?: id);
2503         return;
2504     }
2505 
2506     if (has_attached_device && blk_dev_has_tray(blk) &&
2507         !blk_dev_is_tray_open(blk))
2508     {
2509         error_setg(errp, "Tray of device '%s' is not open", device ?: id);
2510         return;
2511     }
2512 
2513     bs = blk_bs(blk);
2514     if (!bs) {
2515         return;
2516     }
2517 
2518     aio_context = bdrv_get_aio_context(bs);
2519     aio_context_acquire(aio_context);
2520 
2521     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2522         goto out;
2523     }
2524 
2525     blk_remove_bs(blk);
2526 
2527     if (!blk_dev_has_tray(blk)) {
2528         /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2529          * called at all); therefore, the medium needs to be ejected here.
2530          * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2531          * value passed here (i.e. false). */
2532         blk_dev_change_media_cb(blk, false, &error_abort);
2533     }
2534 
2535 out:
2536     aio_context_release(aio_context);
2537 }
2538 
2539 void qmp_blockdev_remove_medium(const char *id, Error **errp)
2540 {
2541     blockdev_remove_medium(false, NULL, true, id, errp);
2542 }
2543 
2544 static void qmp_blockdev_insert_anon_medium(BlockBackend *blk,
2545                                             BlockDriverState *bs, Error **errp)
2546 {
2547     Error *local_err = NULL;
2548     bool has_device;
2549     int ret;
2550 
2551     /* For BBs without a device, we can exchange the BDS tree at will */
2552     has_device = blk_get_attached_dev(blk);
2553 
2554     if (has_device && !blk_dev_has_removable_media(blk)) {
2555         error_setg(errp, "Device is not removable");
2556         return;
2557     }
2558 
2559     if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2560         error_setg(errp, "Tray of the device is not open");
2561         return;
2562     }
2563 
2564     if (blk_bs(blk)) {
2565         error_setg(errp, "There already is a medium in the device");
2566         return;
2567     }
2568 
2569     ret = blk_insert_bs(blk, bs, errp);
2570     if (ret < 0) {
2571         return;
2572     }
2573 
2574     if (!blk_dev_has_tray(blk)) {
2575         /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2576          * called at all); therefore, the medium needs to be pushed into the
2577          * slot here.
2578          * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2579          * value passed here (i.e. true). */
2580         blk_dev_change_media_cb(blk, true, &local_err);
2581         if (local_err) {
2582             error_propagate(errp, local_err);
2583             blk_remove_bs(blk);
2584             return;
2585         }
2586     }
2587 }
2588 
2589 static void blockdev_insert_medium(bool has_device, const char *device,
2590                                    bool has_id, const char *id,
2591                                    const char *node_name, Error **errp)
2592 {
2593     BlockBackend *blk;
2594     BlockDriverState *bs;
2595 
2596     blk = qmp_get_blk(has_device ? device : NULL,
2597                       has_id ? id : NULL,
2598                       errp);
2599     if (!blk) {
2600         return;
2601     }
2602 
2603     bs = bdrv_find_node(node_name);
2604     if (!bs) {
2605         error_setg(errp, "Node '%s' not found", node_name);
2606         return;
2607     }
2608 
2609     if (bdrv_has_blk(bs)) {
2610         error_setg(errp, "Node '%s' is already in use", node_name);
2611         return;
2612     }
2613 
2614     qmp_blockdev_insert_anon_medium(blk, bs, errp);
2615 }
2616 
2617 void qmp_blockdev_insert_medium(const char *id, const char *node_name,
2618                                 Error **errp)
2619 {
2620     blockdev_insert_medium(false, NULL, true, id, node_name, errp);
2621 }
2622 
2623 void qmp_blockdev_change_medium(bool has_device, const char *device,
2624                                 bool has_id, const char *id,
2625                                 const char *filename,
2626                                 bool has_format, const char *format,
2627                                 bool has_read_only,
2628                                 BlockdevChangeReadOnlyMode read_only,
2629                                 Error **errp)
2630 {
2631     BlockBackend *blk;
2632     BlockDriverState *medium_bs = NULL;
2633     int bdrv_flags;
2634     bool detect_zeroes;
2635     int rc;
2636     QDict *options = NULL;
2637     Error *err = NULL;
2638 
2639     blk = qmp_get_blk(has_device ? device : NULL,
2640                       has_id ? id : NULL,
2641                       errp);
2642     if (!blk) {
2643         goto fail;
2644     }
2645 
2646     if (blk_bs(blk)) {
2647         blk_update_root_state(blk);
2648     }
2649 
2650     bdrv_flags = blk_get_open_flags_from_root_state(blk);
2651     bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2652         BDRV_O_PROTOCOL | BDRV_O_AUTO_RDONLY);
2653 
2654     if (!has_read_only) {
2655         read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2656     }
2657 
2658     switch (read_only) {
2659     case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2660         break;
2661 
2662     case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2663         bdrv_flags &= ~BDRV_O_RDWR;
2664         break;
2665 
2666     case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2667         bdrv_flags |= BDRV_O_RDWR;
2668         break;
2669 
2670     default:
2671         abort();
2672     }
2673 
2674     options = qdict_new();
2675     detect_zeroes = blk_get_detect_zeroes_from_root_state(blk);
2676     qdict_put_str(options, "detect-zeroes", detect_zeroes ? "on" : "off");
2677 
2678     if (has_format) {
2679         qdict_put_str(options, "driver", format);
2680     }
2681 
2682     medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2683     if (!medium_bs) {
2684         goto fail;
2685     }
2686 
2687     rc = do_open_tray(has_device ? device : NULL,
2688                       has_id ? id : NULL,
2689                       false, &err);
2690     if (rc && rc != -ENOSYS) {
2691         error_propagate(errp, err);
2692         goto fail;
2693     }
2694     error_free(err);
2695     err = NULL;
2696 
2697     blockdev_remove_medium(has_device, device, has_id, id, &err);
2698     if (err) {
2699         error_propagate(errp, err);
2700         goto fail;
2701     }
2702 
2703     qmp_blockdev_insert_anon_medium(blk, medium_bs, &err);
2704     if (err) {
2705         error_propagate(errp, err);
2706         goto fail;
2707     }
2708 
2709     qmp_blockdev_close_tray(has_device, device, has_id, id, errp);
2710 
2711 fail:
2712     /* If the medium has been inserted, the device has its own reference, so
2713      * ours must be relinquished; and if it has not been inserted successfully,
2714      * the reference must be relinquished anyway */
2715     bdrv_unref(medium_bs);
2716 }
2717 
2718 /* throttling disk I/O limits */
2719 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2720 {
2721     ThrottleConfig cfg;
2722     BlockDriverState *bs;
2723     BlockBackend *blk;
2724     AioContext *aio_context;
2725 
2726     blk = qmp_get_blk(arg->has_device ? arg->device : NULL,
2727                       arg->has_id ? arg->id : NULL,
2728                       errp);
2729     if (!blk) {
2730         return;
2731     }
2732 
2733     aio_context = blk_get_aio_context(blk);
2734     aio_context_acquire(aio_context);
2735 
2736     bs = blk_bs(blk);
2737     if (!bs) {
2738         error_setg(errp, "Device has no medium");
2739         goto out;
2740     }
2741 
2742     throttle_config_init(&cfg);
2743     cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2744     cfg.buckets[THROTTLE_BPS_READ].avg  = arg->bps_rd;
2745     cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2746 
2747     cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2748     cfg.buckets[THROTTLE_OPS_READ].avg  = arg->iops_rd;
2749     cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2750 
2751     if (arg->has_bps_max) {
2752         cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2753     }
2754     if (arg->has_bps_rd_max) {
2755         cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2756     }
2757     if (arg->has_bps_wr_max) {
2758         cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2759     }
2760     if (arg->has_iops_max) {
2761         cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2762     }
2763     if (arg->has_iops_rd_max) {
2764         cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2765     }
2766     if (arg->has_iops_wr_max) {
2767         cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2768     }
2769 
2770     if (arg->has_bps_max_length) {
2771         cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2772     }
2773     if (arg->has_bps_rd_max_length) {
2774         cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2775     }
2776     if (arg->has_bps_wr_max_length) {
2777         cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2778     }
2779     if (arg->has_iops_max_length) {
2780         cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2781     }
2782     if (arg->has_iops_rd_max_length) {
2783         cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2784     }
2785     if (arg->has_iops_wr_max_length) {
2786         cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2787     }
2788 
2789     if (arg->has_iops_size) {
2790         cfg.op_size = arg->iops_size;
2791     }
2792 
2793     if (!throttle_is_valid(&cfg, errp)) {
2794         goto out;
2795     }
2796 
2797     if (throttle_enabled(&cfg)) {
2798         /* Enable I/O limits if they're not enabled yet, otherwise
2799          * just update the throttling group. */
2800         if (!blk_get_public(blk)->throttle_group_member.throttle_state) {
2801             blk_io_limits_enable(blk,
2802                                  arg->has_group ? arg->group :
2803                                  arg->has_device ? arg->device :
2804                                  arg->id);
2805         } else if (arg->has_group) {
2806             blk_io_limits_update_group(blk, arg->group);
2807         }
2808         /* Set the new throttling configuration */
2809         blk_set_io_limits(blk, &cfg);
2810     } else if (blk_get_public(blk)->throttle_group_member.throttle_state) {
2811         /* If all throttling settings are set to 0, disable I/O limits */
2812         blk_io_limits_disable(blk);
2813     }
2814 
2815 out:
2816     aio_context_release(aio_context);
2817 }
2818 
2819 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2820                                 bool has_granularity, uint32_t granularity,
2821                                 bool has_persistent, bool persistent,
2822                                 bool has_autoload, bool autoload,
2823                                 bool has_disabled, bool disabled,
2824                                 Error **errp)
2825 {
2826     BlockDriverState *bs;
2827     BdrvDirtyBitmap *bitmap;
2828 
2829     if (!name || name[0] == '\0') {
2830         error_setg(errp, "Bitmap name cannot be empty");
2831         return;
2832     }
2833 
2834     bs = bdrv_lookup_bs(node, node, errp);
2835     if (!bs) {
2836         return;
2837     }
2838 
2839     if (has_granularity) {
2840         if (granularity < 512 || !is_power_of_2(granularity)) {
2841             error_setg(errp, "Granularity must be power of 2 "
2842                              "and at least 512");
2843             return;
2844         }
2845     } else {
2846         /* Default to cluster size, if available: */
2847         granularity = bdrv_get_default_bitmap_granularity(bs);
2848     }
2849 
2850     if (!has_persistent) {
2851         persistent = false;
2852     }
2853 
2854     if (has_autoload) {
2855         warn_report("Autoload option is deprecated and its value is ignored");
2856     }
2857 
2858     if (!has_disabled) {
2859         disabled = false;
2860     }
2861 
2862     if (persistent &&
2863         !bdrv_can_store_new_dirty_bitmap(bs, name, granularity, errp))
2864     {
2865         return;
2866     }
2867 
2868     bitmap = bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2869     if (bitmap == NULL) {
2870         return;
2871     }
2872 
2873     if (disabled) {
2874         bdrv_disable_dirty_bitmap(bitmap);
2875     }
2876 
2877     bdrv_dirty_bitmap_set_persistance(bitmap, persistent);
2878 }
2879 
2880 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2881                                    Error **errp)
2882 {
2883     BlockDriverState *bs;
2884     BdrvDirtyBitmap *bitmap;
2885     Error *local_err = NULL;
2886 
2887     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2888     if (!bitmap || !bs) {
2889         return;
2890     }
2891 
2892     if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2893         error_setg(errp,
2894                    "Bitmap '%s' is currently in use by another operation and"
2895                    " cannot be removed", name);
2896         return;
2897     }
2898 
2899     if (bdrv_dirty_bitmap_get_persistance(bitmap)) {
2900         bdrv_remove_persistent_dirty_bitmap(bs, name, &local_err);
2901         if (local_err != NULL) {
2902             error_propagate(errp, local_err);
2903             return;
2904         }
2905     }
2906 
2907     bdrv_release_dirty_bitmap(bs, bitmap);
2908 }
2909 
2910 /**
2911  * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2912  * immediately after a full backup operation.
2913  */
2914 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2915                                   Error **errp)
2916 {
2917     BdrvDirtyBitmap *bitmap;
2918     BlockDriverState *bs;
2919 
2920     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2921     if (!bitmap || !bs) {
2922         return;
2923     }
2924 
2925     if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2926         error_setg(errp,
2927                    "Bitmap '%s' is currently in use by another operation"
2928                    " and cannot be cleared", name);
2929         return;
2930     } else if (bdrv_dirty_bitmap_readonly(bitmap)) {
2931         error_setg(errp, "Bitmap '%s' is readonly and cannot be cleared", name);
2932         return;
2933     }
2934 
2935     bdrv_clear_dirty_bitmap(bitmap, NULL);
2936 }
2937 
2938 void qmp_x_block_dirty_bitmap_enable(const char *node, const char *name,
2939                                    Error **errp)
2940 {
2941     BlockDriverState *bs;
2942     BdrvDirtyBitmap *bitmap;
2943 
2944     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2945     if (!bitmap) {
2946         return;
2947     }
2948 
2949     if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2950         error_setg(errp,
2951                    "Bitmap '%s' is currently in use by another operation"
2952                    " and cannot be enabled", name);
2953         return;
2954     }
2955 
2956     bdrv_enable_dirty_bitmap(bitmap);
2957 }
2958 
2959 void qmp_x_block_dirty_bitmap_disable(const char *node, const char *name,
2960                                     Error **errp)
2961 {
2962     BlockDriverState *bs;
2963     BdrvDirtyBitmap *bitmap;
2964 
2965     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2966     if (!bitmap) {
2967         return;
2968     }
2969 
2970     if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2971         error_setg(errp,
2972                    "Bitmap '%s' is currently in use by another operation"
2973                    " and cannot be disabled", name);
2974         return;
2975     }
2976 
2977     bdrv_disable_dirty_bitmap(bitmap);
2978 }
2979 
2980 void qmp_x_block_dirty_bitmap_merge(const char *node, const char *dst_name,
2981                                     const char *src_name, Error **errp)
2982 {
2983     BlockDriverState *bs;
2984     BdrvDirtyBitmap *dst, *src;
2985 
2986     dst = block_dirty_bitmap_lookup(node, dst_name, &bs, errp);
2987     if (!dst) {
2988         return;
2989     }
2990 
2991     src = bdrv_find_dirty_bitmap(bs, src_name);
2992     if (!src) {
2993         error_setg(errp, "Dirty bitmap '%s' not found", src_name);
2994         return;
2995     }
2996 
2997     bdrv_merge_dirty_bitmap(dst, src, NULL, errp);
2998 }
2999 
3000 BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
3001                                                               const char *name,
3002                                                               Error **errp)
3003 {
3004     BdrvDirtyBitmap *bitmap;
3005     BlockDriverState *bs;
3006     BlockDirtyBitmapSha256 *ret = NULL;
3007     char *sha256;
3008 
3009     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
3010     if (!bitmap || !bs) {
3011         return NULL;
3012     }
3013 
3014     sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
3015     if (sha256 == NULL) {
3016         return NULL;
3017     }
3018 
3019     ret = g_new(BlockDirtyBitmapSha256, 1);
3020     ret->sha256 = sha256;
3021 
3022     return ret;
3023 }
3024 
3025 void hmp_drive_del(Monitor *mon, const QDict *qdict)
3026 {
3027     const char *id = qdict_get_str(qdict, "id");
3028     BlockBackend *blk;
3029     BlockDriverState *bs;
3030     AioContext *aio_context;
3031     Error *local_err = NULL;
3032 
3033     bs = bdrv_find_node(id);
3034     if (bs) {
3035         qmp_blockdev_del(id, &local_err);
3036         if (local_err) {
3037             error_report_err(local_err);
3038         }
3039         return;
3040     }
3041 
3042     blk = blk_by_name(id);
3043     if (!blk) {
3044         error_report("Device '%s' not found", id);
3045         return;
3046     }
3047 
3048     if (!blk_legacy_dinfo(blk)) {
3049         error_report("Deleting device added with blockdev-add"
3050                      " is not supported");
3051         return;
3052     }
3053 
3054     aio_context = blk_get_aio_context(blk);
3055     aio_context_acquire(aio_context);
3056 
3057     bs = blk_bs(blk);
3058     if (bs) {
3059         if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
3060             error_report_err(local_err);
3061             aio_context_release(aio_context);
3062             return;
3063         }
3064 
3065         blk_remove_bs(blk);
3066     }
3067 
3068     /* Make the BlockBackend and the attached BlockDriverState anonymous */
3069     monitor_remove_blk(blk);
3070 
3071     /* If this BlockBackend has a device attached to it, its refcount will be
3072      * decremented when the device is removed; otherwise we have to do so here.
3073      */
3074     if (blk_get_attached_dev(blk)) {
3075         /* Further I/O must not pause the guest */
3076         blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
3077                          BLOCKDEV_ON_ERROR_REPORT);
3078     } else {
3079         blk_unref(blk);
3080     }
3081 
3082     aio_context_release(aio_context);
3083 }
3084 
3085 void qmp_block_resize(bool has_device, const char *device,
3086                       bool has_node_name, const char *node_name,
3087                       int64_t size, Error **errp)
3088 {
3089     Error *local_err = NULL;
3090     BlockBackend *blk = NULL;
3091     BlockDriverState *bs;
3092     AioContext *aio_context;
3093     int ret;
3094 
3095     bs = bdrv_lookup_bs(has_device ? device : NULL,
3096                         has_node_name ? node_name : NULL,
3097                         &local_err);
3098     if (local_err) {
3099         error_propagate(errp, local_err);
3100         return;
3101     }
3102 
3103     aio_context = bdrv_get_aio_context(bs);
3104     aio_context_acquire(aio_context);
3105 
3106     if (!bdrv_is_first_non_filter(bs)) {
3107         error_setg(errp, QERR_FEATURE_DISABLED, "resize");
3108         goto out;
3109     }
3110 
3111     if (size < 0) {
3112         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
3113         goto out;
3114     }
3115 
3116     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
3117         error_setg(errp, QERR_DEVICE_IN_USE, device);
3118         goto out;
3119     }
3120 
3121     blk = blk_new(BLK_PERM_RESIZE, BLK_PERM_ALL);
3122     ret = blk_insert_bs(blk, bs, errp);
3123     if (ret < 0) {
3124         goto out;
3125     }
3126 
3127     bdrv_drained_begin(bs);
3128     ret = blk_truncate(blk, size, PREALLOC_MODE_OFF, errp);
3129     bdrv_drained_end(bs);
3130 
3131 out:
3132     blk_unref(blk);
3133     aio_context_release(aio_context);
3134 }
3135 
3136 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
3137                       bool has_base, const char *base,
3138                       bool has_base_node, const char *base_node,
3139                       bool has_backing_file, const char *backing_file,
3140                       bool has_speed, int64_t speed,
3141                       bool has_on_error, BlockdevOnError on_error,
3142                       bool has_auto_finalize, bool auto_finalize,
3143                       bool has_auto_dismiss, bool auto_dismiss,
3144                       Error **errp)
3145 {
3146     BlockDriverState *bs, *iter;
3147     BlockDriverState *base_bs = NULL;
3148     AioContext *aio_context;
3149     Error *local_err = NULL;
3150     const char *base_name = NULL;
3151     int job_flags = JOB_DEFAULT;
3152 
3153     if (!has_on_error) {
3154         on_error = BLOCKDEV_ON_ERROR_REPORT;
3155     }
3156 
3157     bs = bdrv_lookup_bs(device, device, errp);
3158     if (!bs) {
3159         return;
3160     }
3161 
3162     aio_context = bdrv_get_aio_context(bs);
3163     aio_context_acquire(aio_context);
3164 
3165     if (has_base && has_base_node) {
3166         error_setg(errp, "'base' and 'base-node' cannot be specified "
3167                    "at the same time");
3168         goto out;
3169     }
3170 
3171     if (has_base) {
3172         base_bs = bdrv_find_backing_image(bs, base);
3173         if (base_bs == NULL) {
3174             error_setg(errp, QERR_BASE_NOT_FOUND, base);
3175             goto out;
3176         }
3177         assert(bdrv_get_aio_context(base_bs) == aio_context);
3178         base_name = base;
3179     }
3180 
3181     if (has_base_node) {
3182         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3183         if (!base_bs) {
3184             goto out;
3185         }
3186         if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
3187             error_setg(errp, "Node '%s' is not a backing image of '%s'",
3188                        base_node, device);
3189             goto out;
3190         }
3191         assert(bdrv_get_aio_context(base_bs) == aio_context);
3192         base_name = base_bs->filename;
3193     }
3194 
3195     /* Check for op blockers in the whole chain between bs and base */
3196     for (iter = bs; iter && iter != base_bs; iter = backing_bs(iter)) {
3197         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
3198             goto out;
3199         }
3200     }
3201 
3202     /* if we are streaming the entire chain, the result will have no backing
3203      * file, and specifying one is therefore an error */
3204     if (base_bs == NULL && has_backing_file) {
3205         error_setg(errp, "backing file specified, but streaming the "
3206                          "entire chain");
3207         goto out;
3208     }
3209 
3210     /* backing_file string overrides base bs filename */
3211     base_name = has_backing_file ? backing_file : base_name;
3212 
3213     if (has_auto_finalize && !auto_finalize) {
3214         job_flags |= JOB_MANUAL_FINALIZE;
3215     }
3216     if (has_auto_dismiss && !auto_dismiss) {
3217         job_flags |= JOB_MANUAL_DISMISS;
3218     }
3219 
3220     stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
3221                  job_flags, has_speed ? speed : 0, on_error, &local_err);
3222     if (local_err) {
3223         error_propagate(errp, local_err);
3224         goto out;
3225     }
3226 
3227     trace_qmp_block_stream(bs, bs->job);
3228 
3229 out:
3230     aio_context_release(aio_context);
3231 }
3232 
3233 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3234                       bool has_base_node, const char *base_node,
3235                       bool has_base, const char *base,
3236                       bool has_top_node, const char *top_node,
3237                       bool has_top, const char *top,
3238                       bool has_backing_file, const char *backing_file,
3239                       bool has_speed, int64_t speed,
3240                       bool has_filter_node_name, const char *filter_node_name,
3241                       bool has_auto_finalize, bool auto_finalize,
3242                       bool has_auto_dismiss, bool auto_dismiss,
3243                       Error **errp)
3244 {
3245     BlockDriverState *bs;
3246     BlockDriverState *iter;
3247     BlockDriverState *base_bs, *top_bs;
3248     AioContext *aio_context;
3249     Error *local_err = NULL;
3250     /* This will be part of the QMP command, if/when the
3251      * BlockdevOnError change for blkmirror makes it in
3252      */
3253     BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3254     int job_flags = JOB_DEFAULT;
3255 
3256     if (!has_speed) {
3257         speed = 0;
3258     }
3259     if (!has_filter_node_name) {
3260         filter_node_name = NULL;
3261     }
3262     if (has_auto_finalize && !auto_finalize) {
3263         job_flags |= JOB_MANUAL_FINALIZE;
3264     }
3265     if (has_auto_dismiss && !auto_dismiss) {
3266         job_flags |= JOB_MANUAL_DISMISS;
3267     }
3268 
3269     /* Important Note:
3270      *  libvirt relies on the DeviceNotFound error class in order to probe for
3271      *  live commit feature versions; for this to work, we must make sure to
3272      *  perform the device lookup before any generic errors that may occur in a
3273      *  scenario in which all optional arguments are omitted. */
3274     bs = qmp_get_root_bs(device, &local_err);
3275     if (!bs) {
3276         bs = bdrv_lookup_bs(device, device, NULL);
3277         if (!bs) {
3278             error_free(local_err);
3279             error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3280                       "Device '%s' not found", device);
3281         } else {
3282             error_propagate(errp, local_err);
3283         }
3284         return;
3285     }
3286 
3287     aio_context = bdrv_get_aio_context(bs);
3288     aio_context_acquire(aio_context);
3289 
3290     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3291         goto out;
3292     }
3293 
3294     /* default top_bs is the active layer */
3295     top_bs = bs;
3296 
3297     if (has_top_node && has_top) {
3298         error_setg(errp, "'top-node' and 'top' are mutually exclusive");
3299         goto out;
3300     } else if (has_top_node) {
3301         top_bs = bdrv_lookup_bs(NULL, top_node, errp);
3302         if (top_bs == NULL) {
3303             goto out;
3304         }
3305         if (!bdrv_chain_contains(bs, top_bs)) {
3306             error_setg(errp, "'%s' is not in this backing file chain",
3307                        top_node);
3308             goto out;
3309         }
3310     } else if (has_top && top) {
3311         if (strcmp(bs->filename, top) != 0) {
3312             top_bs = bdrv_find_backing_image(bs, top);
3313         }
3314     }
3315 
3316     if (top_bs == NULL) {
3317         error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3318         goto out;
3319     }
3320 
3321     assert(bdrv_get_aio_context(top_bs) == aio_context);
3322 
3323     if (has_base_node && has_base) {
3324         error_setg(errp, "'base-node' and 'base' are mutually exclusive");
3325         goto out;
3326     } else if (has_base_node) {
3327         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3328         if (base_bs == NULL) {
3329             goto out;
3330         }
3331         if (!bdrv_chain_contains(top_bs, base_bs)) {
3332             error_setg(errp, "'%s' is not in this backing file chain",
3333                        base_node);
3334             goto out;
3335         }
3336     } else if (has_base && base) {
3337         base_bs = bdrv_find_backing_image(top_bs, base);
3338     } else {
3339         base_bs = bdrv_find_base(top_bs);
3340     }
3341 
3342     if (base_bs == NULL) {
3343         error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3344         goto out;
3345     }
3346 
3347     assert(bdrv_get_aio_context(base_bs) == aio_context);
3348 
3349     for (iter = top_bs; iter != backing_bs(base_bs); iter = backing_bs(iter)) {
3350         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3351             goto out;
3352         }
3353     }
3354 
3355     /* Do not allow attempts to commit an image into itself */
3356     if (top_bs == base_bs) {
3357         error_setg(errp, "cannot commit an image into itself");
3358         goto out;
3359     }
3360 
3361     if (top_bs == bs) {
3362         if (has_backing_file) {
3363             error_setg(errp, "'backing-file' specified,"
3364                              " but 'top' is the active layer");
3365             goto out;
3366         }
3367         commit_active_start(has_job_id ? job_id : NULL, bs, base_bs,
3368                             job_flags, speed, on_error,
3369                             filter_node_name, NULL, NULL, false, &local_err);
3370     } else {
3371         BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
3372         if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3373             goto out;
3374         }
3375         commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
3376                      speed, on_error, has_backing_file ? backing_file : NULL,
3377                      filter_node_name, &local_err);
3378     }
3379     if (local_err != NULL) {
3380         error_propagate(errp, local_err);
3381         goto out;
3382     }
3383 
3384 out:
3385     aio_context_release(aio_context);
3386 }
3387 
3388 static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
3389                                  Error **errp)
3390 {
3391     BlockDriverState *bs;
3392     BlockDriverState *target_bs;
3393     BlockDriverState *source = NULL;
3394     BlockJob *job = NULL;
3395     BdrvDirtyBitmap *bmap = NULL;
3396     AioContext *aio_context;
3397     QDict *options = NULL;
3398     Error *local_err = NULL;
3399     int flags, job_flags = JOB_DEFAULT;
3400     int64_t size;
3401     bool set_backing_hd = false;
3402 
3403     if (!backup->has_speed) {
3404         backup->speed = 0;
3405     }
3406     if (!backup->has_on_source_error) {
3407         backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3408     }
3409     if (!backup->has_on_target_error) {
3410         backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3411     }
3412     if (!backup->has_mode) {
3413         backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3414     }
3415     if (!backup->has_job_id) {
3416         backup->job_id = NULL;
3417     }
3418     if (!backup->has_auto_finalize) {
3419         backup->auto_finalize = true;
3420     }
3421     if (!backup->has_auto_dismiss) {
3422         backup->auto_dismiss = true;
3423     }
3424     if (!backup->has_compress) {
3425         backup->compress = false;
3426     }
3427 
3428     bs = qmp_get_root_bs(backup->device, errp);
3429     if (!bs) {
3430         return NULL;
3431     }
3432 
3433     aio_context = bdrv_get_aio_context(bs);
3434     aio_context_acquire(aio_context);
3435 
3436     if (!backup->has_format) {
3437         backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
3438                          NULL : (char*) bs->drv->format_name;
3439     }
3440 
3441     /* Early check to avoid creating target */
3442     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3443         goto out;
3444     }
3445 
3446     flags = bs->open_flags | BDRV_O_RDWR;
3447 
3448     /* See if we have a backing HD we can use to create our new image
3449      * on top of. */
3450     if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3451         source = backing_bs(bs);
3452         if (!source) {
3453             backup->sync = MIRROR_SYNC_MODE_FULL;
3454         }
3455     }
3456     if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3457         source = bs;
3458         flags |= BDRV_O_NO_BACKING;
3459         set_backing_hd = true;
3460     }
3461 
3462     size = bdrv_getlength(bs);
3463     if (size < 0) {
3464         error_setg_errno(errp, -size, "bdrv_getlength failed");
3465         goto out;
3466     }
3467 
3468     if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
3469         assert(backup->format);
3470         if (source) {
3471             bdrv_img_create(backup->target, backup->format, source->filename,
3472                             source->drv->format_name, NULL,
3473                             size, flags, false, &local_err);
3474         } else {
3475             bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3476                             size, flags, false, &local_err);
3477         }
3478     }
3479 
3480     if (local_err) {
3481         error_propagate(errp, local_err);
3482         goto out;
3483     }
3484 
3485     if (backup->format) {
3486         if (!options) {
3487             options = qdict_new();
3488         }
3489         qdict_put_str(options, "driver", backup->format);
3490     }
3491 
3492     target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
3493     if (!target_bs) {
3494         goto out;
3495     }
3496 
3497     bdrv_set_aio_context(target_bs, aio_context);
3498 
3499     if (set_backing_hd) {
3500         bdrv_set_backing_hd(target_bs, source, &local_err);
3501         if (local_err) {
3502             bdrv_unref(target_bs);
3503             goto out;
3504         }
3505     }
3506 
3507     if (backup->has_bitmap) {
3508         bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3509         if (!bmap) {
3510             error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3511             bdrv_unref(target_bs);
3512             goto out;
3513         }
3514         if (bdrv_dirty_bitmap_user_locked(bmap)) {
3515             error_setg(errp,
3516                        "Bitmap '%s' is currently in use by another operation"
3517                        " and cannot be used for backup", backup->bitmap);
3518             goto out;
3519         }
3520     }
3521     if (!backup->auto_finalize) {
3522         job_flags |= JOB_MANUAL_FINALIZE;
3523     }
3524     if (!backup->auto_dismiss) {
3525         job_flags |= JOB_MANUAL_DISMISS;
3526     }
3527 
3528     job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3529                             backup->sync, bmap, backup->compress,
3530                             backup->on_source_error, backup->on_target_error,
3531                             job_flags, NULL, NULL, txn, &local_err);
3532     bdrv_unref(target_bs);
3533     if (local_err != NULL) {
3534         error_propagate(errp, local_err);
3535         goto out;
3536     }
3537 
3538 out:
3539     aio_context_release(aio_context);
3540     return job;
3541 }
3542 
3543 void qmp_drive_backup(DriveBackup *arg, Error **errp)
3544 {
3545 
3546     BlockJob *job;
3547     job = do_drive_backup(arg, NULL, errp);
3548     if (job) {
3549         job_start(&job->job);
3550     }
3551 }
3552 
3553 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3554 {
3555     return bdrv_named_nodes_list(errp);
3556 }
3557 
3558 BlockJob *do_blockdev_backup(BlockdevBackup *backup, JobTxn *txn,
3559                              Error **errp)
3560 {
3561     BlockDriverState *bs;
3562     BlockDriverState *target_bs;
3563     Error *local_err = NULL;
3564     BdrvDirtyBitmap *bmap = NULL;
3565     AioContext *aio_context;
3566     BlockJob *job = NULL;
3567     int job_flags = JOB_DEFAULT;
3568 
3569     if (!backup->has_speed) {
3570         backup->speed = 0;
3571     }
3572     if (!backup->has_on_source_error) {
3573         backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3574     }
3575     if (!backup->has_on_target_error) {
3576         backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3577     }
3578     if (!backup->has_job_id) {
3579         backup->job_id = NULL;
3580     }
3581     if (!backup->has_auto_finalize) {
3582         backup->auto_finalize = true;
3583     }
3584     if (!backup->has_auto_dismiss) {
3585         backup->auto_dismiss = true;
3586     }
3587     if (!backup->has_compress) {
3588         backup->compress = false;
3589     }
3590 
3591     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
3592     if (!bs) {
3593         return NULL;
3594     }
3595 
3596     aio_context = bdrv_get_aio_context(bs);
3597     aio_context_acquire(aio_context);
3598 
3599     target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
3600     if (!target_bs) {
3601         goto out;
3602     }
3603 
3604     if (bdrv_get_aio_context(target_bs) != aio_context) {
3605         if (!bdrv_has_blk(target_bs)) {
3606             /* The target BDS is not attached, we can safely move it to another
3607              * AioContext. */
3608             bdrv_set_aio_context(target_bs, aio_context);
3609         } else {
3610             error_setg(errp, "Target is attached to a different thread from "
3611                              "source.");
3612             goto out;
3613         }
3614     }
3615 
3616     if (backup->has_bitmap) {
3617         bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3618         if (!bmap) {
3619             error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3620             goto out;
3621         }
3622         if (bdrv_dirty_bitmap_user_locked(bmap)) {
3623             error_setg(errp,
3624                        "Bitmap '%s' is currently in use by another operation"
3625                        " and cannot be used for backup", backup->bitmap);
3626             goto out;
3627         }
3628     }
3629 
3630     if (!backup->auto_finalize) {
3631         job_flags |= JOB_MANUAL_FINALIZE;
3632     }
3633     if (!backup->auto_dismiss) {
3634         job_flags |= JOB_MANUAL_DISMISS;
3635     }
3636     job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3637                             backup->sync, bmap, backup->compress,
3638                             backup->on_source_error, backup->on_target_error,
3639                             job_flags, NULL, NULL, txn, &local_err);
3640     if (local_err != NULL) {
3641         error_propagate(errp, local_err);
3642     }
3643 out:
3644     aio_context_release(aio_context);
3645     return job;
3646 }
3647 
3648 void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
3649 {
3650     BlockJob *job;
3651     job = do_blockdev_backup(arg, NULL, errp);
3652     if (job) {
3653         job_start(&job->job);
3654     }
3655 }
3656 
3657 /* Parameter check and block job starting for drive mirroring.
3658  * Caller should hold @device and @target's aio context (must be the same).
3659  **/
3660 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3661                                    BlockDriverState *target,
3662                                    bool has_replaces, const char *replaces,
3663                                    enum MirrorSyncMode sync,
3664                                    BlockMirrorBackingMode backing_mode,
3665                                    bool has_speed, int64_t speed,
3666                                    bool has_granularity, uint32_t granularity,
3667                                    bool has_buf_size, int64_t buf_size,
3668                                    bool has_on_source_error,
3669                                    BlockdevOnError on_source_error,
3670                                    bool has_on_target_error,
3671                                    BlockdevOnError on_target_error,
3672                                    bool has_unmap, bool unmap,
3673                                    bool has_filter_node_name,
3674                                    const char *filter_node_name,
3675                                    bool has_copy_mode, MirrorCopyMode copy_mode,
3676                                    bool has_auto_finalize, bool auto_finalize,
3677                                    bool has_auto_dismiss, bool auto_dismiss,
3678                                    Error **errp)
3679 {
3680     int job_flags = JOB_DEFAULT;
3681 
3682     if (!has_speed) {
3683         speed = 0;
3684     }
3685     if (!has_on_source_error) {
3686         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3687     }
3688     if (!has_on_target_error) {
3689         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3690     }
3691     if (!has_granularity) {
3692         granularity = 0;
3693     }
3694     if (!has_buf_size) {
3695         buf_size = 0;
3696     }
3697     if (!has_unmap) {
3698         unmap = true;
3699     }
3700     if (!has_filter_node_name) {
3701         filter_node_name = NULL;
3702     }
3703     if (!has_copy_mode) {
3704         copy_mode = MIRROR_COPY_MODE_BACKGROUND;
3705     }
3706     if (has_auto_finalize && !auto_finalize) {
3707         job_flags |= JOB_MANUAL_FINALIZE;
3708     }
3709     if (has_auto_dismiss && !auto_dismiss) {
3710         job_flags |= JOB_MANUAL_DISMISS;
3711     }
3712 
3713     if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3714         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3715                    "a value in range [512B, 64MB]");
3716         return;
3717     }
3718     if (granularity & (granularity - 1)) {
3719         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3720                    "power of 2");
3721         return;
3722     }
3723 
3724     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3725         return;
3726     }
3727     if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3728         return;
3729     }
3730 
3731     if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3732         sync = MIRROR_SYNC_MODE_FULL;
3733     }
3734 
3735     /* pass the node name to replace to mirror start since it's loose coupling
3736      * and will allow to check whether the node still exist at mirror completion
3737      */
3738     mirror_start(job_id, bs, target,
3739                  has_replaces ? replaces : NULL, job_flags,
3740                  speed, granularity, buf_size, sync, backing_mode,
3741                  on_source_error, on_target_error, unmap, filter_node_name,
3742                  copy_mode, errp);
3743 }
3744 
3745 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3746 {
3747     BlockDriverState *bs;
3748     BlockDriverState *source, *target_bs;
3749     AioContext *aio_context;
3750     BlockMirrorBackingMode backing_mode;
3751     Error *local_err = NULL;
3752     QDict *options = NULL;
3753     int flags;
3754     int64_t size;
3755     const char *format = arg->format;
3756 
3757     bs = qmp_get_root_bs(arg->device, errp);
3758     if (!bs) {
3759         return;
3760     }
3761 
3762     /* Early check to avoid creating target */
3763     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3764         return;
3765     }
3766 
3767     aio_context = bdrv_get_aio_context(bs);
3768     aio_context_acquire(aio_context);
3769 
3770     if (!arg->has_mode) {
3771         arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3772     }
3773 
3774     if (!arg->has_format) {
3775         format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3776                   ? NULL : bs->drv->format_name);
3777     }
3778 
3779     flags = bs->open_flags | BDRV_O_RDWR;
3780     source = backing_bs(bs);
3781     if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3782         arg->sync = MIRROR_SYNC_MODE_FULL;
3783     }
3784     if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3785         source = bs;
3786     }
3787 
3788     size = bdrv_getlength(bs);
3789     if (size < 0) {
3790         error_setg_errno(errp, -size, "bdrv_getlength failed");
3791         goto out;
3792     }
3793 
3794     if (arg->has_replaces) {
3795         BlockDriverState *to_replace_bs;
3796         AioContext *replace_aio_context;
3797         int64_t replace_size;
3798 
3799         if (!arg->has_node_name) {
3800             error_setg(errp, "a node-name must be provided when replacing a"
3801                              " named node of the graph");
3802             goto out;
3803         }
3804 
3805         to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3806 
3807         if (!to_replace_bs) {
3808             error_propagate(errp, local_err);
3809             goto out;
3810         }
3811 
3812         replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3813         aio_context_acquire(replace_aio_context);
3814         replace_size = bdrv_getlength(to_replace_bs);
3815         aio_context_release(replace_aio_context);
3816 
3817         if (size != replace_size) {
3818             error_setg(errp, "cannot replace image with a mirror image of "
3819                              "different size");
3820             goto out;
3821         }
3822     }
3823 
3824     if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3825         backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3826     } else {
3827         backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3828     }
3829 
3830     /* Don't open backing image in create() */
3831     flags |= BDRV_O_NO_BACKING;
3832 
3833     if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3834         && arg->mode != NEW_IMAGE_MODE_EXISTING)
3835     {
3836         /* create new image w/o backing file */
3837         assert(format);
3838         bdrv_img_create(arg->target, format,
3839                         NULL, NULL, NULL, size, flags, false, &local_err);
3840     } else {
3841         switch (arg->mode) {
3842         case NEW_IMAGE_MODE_EXISTING:
3843             break;
3844         case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3845             /* create new image with backing file */
3846             bdrv_img_create(arg->target, format,
3847                             source->filename,
3848                             source->drv->format_name,
3849                             NULL, size, flags, false, &local_err);
3850             break;
3851         default:
3852             abort();
3853         }
3854     }
3855 
3856     if (local_err) {
3857         error_propagate(errp, local_err);
3858         goto out;
3859     }
3860 
3861     options = qdict_new();
3862     if (arg->has_node_name) {
3863         qdict_put_str(options, "node-name", arg->node_name);
3864     }
3865     if (format) {
3866         qdict_put_str(options, "driver", format);
3867     }
3868 
3869     /* Mirroring takes care of copy-on-write using the source's backing
3870      * file.
3871      */
3872     target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
3873     if (!target_bs) {
3874         goto out;
3875     }
3876 
3877     bdrv_set_aio_context(target_bs, aio_context);
3878 
3879     blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3880                            arg->has_replaces, arg->replaces, arg->sync,
3881                            backing_mode, arg->has_speed, arg->speed,
3882                            arg->has_granularity, arg->granularity,
3883                            arg->has_buf_size, arg->buf_size,
3884                            arg->has_on_source_error, arg->on_source_error,
3885                            arg->has_on_target_error, arg->on_target_error,
3886                            arg->has_unmap, arg->unmap,
3887                            false, NULL,
3888                            arg->has_copy_mode, arg->copy_mode,
3889                            arg->has_auto_finalize, arg->auto_finalize,
3890                            arg->has_auto_dismiss, arg->auto_dismiss,
3891                            &local_err);
3892     bdrv_unref(target_bs);
3893     error_propagate(errp, local_err);
3894 out:
3895     aio_context_release(aio_context);
3896 }
3897 
3898 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3899                          const char *device, const char *target,
3900                          bool has_replaces, const char *replaces,
3901                          MirrorSyncMode sync,
3902                          bool has_speed, int64_t speed,
3903                          bool has_granularity, uint32_t granularity,
3904                          bool has_buf_size, int64_t buf_size,
3905                          bool has_on_source_error,
3906                          BlockdevOnError on_source_error,
3907                          bool has_on_target_error,
3908                          BlockdevOnError on_target_error,
3909                          bool has_filter_node_name,
3910                          const char *filter_node_name,
3911                          bool has_copy_mode, MirrorCopyMode copy_mode,
3912                          bool has_auto_finalize, bool auto_finalize,
3913                          bool has_auto_dismiss, bool auto_dismiss,
3914                          Error **errp)
3915 {
3916     BlockDriverState *bs;
3917     BlockDriverState *target_bs;
3918     AioContext *aio_context;
3919     BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3920     Error *local_err = NULL;
3921 
3922     bs = qmp_get_root_bs(device, errp);
3923     if (!bs) {
3924         return;
3925     }
3926 
3927     target_bs = bdrv_lookup_bs(target, target, errp);
3928     if (!target_bs) {
3929         return;
3930     }
3931 
3932     aio_context = bdrv_get_aio_context(bs);
3933     aio_context_acquire(aio_context);
3934 
3935     bdrv_set_aio_context(target_bs, aio_context);
3936 
3937     blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3938                            has_replaces, replaces, sync, backing_mode,
3939                            has_speed, speed,
3940                            has_granularity, granularity,
3941                            has_buf_size, buf_size,
3942                            has_on_source_error, on_source_error,
3943                            has_on_target_error, on_target_error,
3944                            true, true,
3945                            has_filter_node_name, filter_node_name,
3946                            has_copy_mode, copy_mode,
3947                            has_auto_finalize, auto_finalize,
3948                            has_auto_dismiss, auto_dismiss,
3949                            &local_err);
3950     error_propagate(errp, local_err);
3951 
3952     aio_context_release(aio_context);
3953 }
3954 
3955 /* Get a block job using its ID and acquire its AioContext */
3956 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3957                                 Error **errp)
3958 {
3959     BlockJob *job;
3960 
3961     assert(id != NULL);
3962 
3963     *aio_context = NULL;
3964 
3965     job = block_job_get(id);
3966 
3967     if (!job) {
3968         error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3969                   "Block job '%s' not found", id);
3970         return NULL;
3971     }
3972 
3973     *aio_context = blk_get_aio_context(job->blk);
3974     aio_context_acquire(*aio_context);
3975 
3976     return job;
3977 }
3978 
3979 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3980 {
3981     AioContext *aio_context;
3982     BlockJob *job = find_block_job(device, &aio_context, errp);
3983 
3984     if (!job) {
3985         return;
3986     }
3987 
3988     block_job_set_speed(job, speed, errp);
3989     aio_context_release(aio_context);
3990 }
3991 
3992 void qmp_block_job_cancel(const char *device,
3993                           bool has_force, bool force, Error **errp)
3994 {
3995     AioContext *aio_context;
3996     BlockJob *job = find_block_job(device, &aio_context, errp);
3997 
3998     if (!job) {
3999         return;
4000     }
4001 
4002     if (!has_force) {
4003         force = false;
4004     }
4005 
4006     if (job_user_paused(&job->job) && !force) {
4007         error_setg(errp, "The block job for device '%s' is currently paused",
4008                    device);
4009         goto out;
4010     }
4011 
4012     trace_qmp_block_job_cancel(job);
4013     job_user_cancel(&job->job, force, errp);
4014 out:
4015     aio_context_release(aio_context);
4016 }
4017 
4018 void qmp_block_job_pause(const char *device, Error **errp)
4019 {
4020     AioContext *aio_context;
4021     BlockJob *job = find_block_job(device, &aio_context, errp);
4022 
4023     if (!job) {
4024         return;
4025     }
4026 
4027     trace_qmp_block_job_pause(job);
4028     job_user_pause(&job->job, errp);
4029     aio_context_release(aio_context);
4030 }
4031 
4032 void qmp_block_job_resume(const char *device, Error **errp)
4033 {
4034     AioContext *aio_context;
4035     BlockJob *job = find_block_job(device, &aio_context, errp);
4036 
4037     if (!job) {
4038         return;
4039     }
4040 
4041     trace_qmp_block_job_resume(job);
4042     job_user_resume(&job->job, errp);
4043     aio_context_release(aio_context);
4044 }
4045 
4046 void qmp_block_job_complete(const char *device, Error **errp)
4047 {
4048     AioContext *aio_context;
4049     BlockJob *job = find_block_job(device, &aio_context, errp);
4050 
4051     if (!job) {
4052         return;
4053     }
4054 
4055     trace_qmp_block_job_complete(job);
4056     job_complete(&job->job, errp);
4057     aio_context_release(aio_context);
4058 }
4059 
4060 void qmp_block_job_finalize(const char *id, Error **errp)
4061 {
4062     AioContext *aio_context;
4063     BlockJob *job = find_block_job(id, &aio_context, errp);
4064 
4065     if (!job) {
4066         return;
4067     }
4068 
4069     trace_qmp_block_job_finalize(job);
4070     job_finalize(&job->job, errp);
4071     aio_context_release(aio_context);
4072 }
4073 
4074 void qmp_block_job_dismiss(const char *id, Error **errp)
4075 {
4076     AioContext *aio_context;
4077     BlockJob *bjob = find_block_job(id, &aio_context, errp);
4078     Job *job;
4079 
4080     if (!bjob) {
4081         return;
4082     }
4083 
4084     trace_qmp_block_job_dismiss(bjob);
4085     job = &bjob->job;
4086     job_dismiss(&job, errp);
4087     aio_context_release(aio_context);
4088 }
4089 
4090 void qmp_change_backing_file(const char *device,
4091                              const char *image_node_name,
4092                              const char *backing_file,
4093                              Error **errp)
4094 {
4095     BlockDriverState *bs = NULL;
4096     AioContext *aio_context;
4097     BlockDriverState *image_bs = NULL;
4098     Error *local_err = NULL;
4099     bool ro;
4100     int ret;
4101 
4102     bs = qmp_get_root_bs(device, errp);
4103     if (!bs) {
4104         return;
4105     }
4106 
4107     aio_context = bdrv_get_aio_context(bs);
4108     aio_context_acquire(aio_context);
4109 
4110     image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
4111     if (local_err) {
4112         error_propagate(errp, local_err);
4113         goto out;
4114     }
4115 
4116     if (!image_bs) {
4117         error_setg(errp, "image file not found");
4118         goto out;
4119     }
4120 
4121     if (bdrv_find_base(image_bs) == image_bs) {
4122         error_setg(errp, "not allowing backing file change on an image "
4123                          "without a backing file");
4124         goto out;
4125     }
4126 
4127     /* even though we are not necessarily operating on bs, we need it to
4128      * determine if block ops are currently prohibited on the chain */
4129     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
4130         goto out;
4131     }
4132 
4133     /* final sanity check */
4134     if (!bdrv_chain_contains(bs, image_bs)) {
4135         error_setg(errp, "'%s' and image file are not in the same chain",
4136                    device);
4137         goto out;
4138     }
4139 
4140     /* if not r/w, reopen to make r/w */
4141     ro = bdrv_is_read_only(image_bs);
4142 
4143     if (ro) {
4144         if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
4145             goto out;
4146         }
4147     }
4148 
4149     ret = bdrv_change_backing_file(image_bs, backing_file,
4150                                image_bs->drv ? image_bs->drv->format_name : "");
4151 
4152     if (ret < 0) {
4153         error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
4154                          backing_file);
4155         /* don't exit here, so we can try to restore open flags if
4156          * appropriate */
4157     }
4158 
4159     if (ro) {
4160         bdrv_reopen_set_read_only(image_bs, true, &local_err);
4161         error_propagate(errp, local_err);
4162     }
4163 
4164 out:
4165     aio_context_release(aio_context);
4166 }
4167 
4168 void hmp_drive_add_node(Monitor *mon, const char *optstr)
4169 {
4170     QemuOpts *opts;
4171     QDict *qdict;
4172     Error *local_err = NULL;
4173 
4174     opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
4175     if (!opts) {
4176         return;
4177     }
4178 
4179     qdict = qemu_opts_to_qdict(opts, NULL);
4180 
4181     if (!qdict_get_try_str(qdict, "node-name")) {
4182         qobject_unref(qdict);
4183         error_report("'node-name' needs to be specified");
4184         goto out;
4185     }
4186 
4187     BlockDriverState *bs = bds_tree_init(qdict, &local_err);
4188     if (!bs) {
4189         error_report_err(local_err);
4190         goto out;
4191     }
4192 
4193     QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4194 
4195 out:
4196     qemu_opts_del(opts);
4197 }
4198 
4199 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
4200 {
4201     BlockDriverState *bs;
4202     QObject *obj;
4203     Visitor *v = qobject_output_visitor_new(&obj);
4204     QDict *qdict;
4205     Error *local_err = NULL;
4206 
4207     visit_type_BlockdevOptions(v, NULL, &options, &local_err);
4208     if (local_err) {
4209         error_propagate(errp, local_err);
4210         goto fail;
4211     }
4212 
4213     visit_complete(v, &obj);
4214     qdict = qobject_to(QDict, obj);
4215 
4216     qdict_flatten(qdict);
4217 
4218     if (!qdict_get_try_str(qdict, "node-name")) {
4219         error_setg(errp, "'node-name' must be specified for the root node");
4220         goto fail;
4221     }
4222 
4223     bs = bds_tree_init(qdict, errp);
4224     if (!bs) {
4225         goto fail;
4226     }
4227 
4228     QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4229 
4230 fail:
4231     visit_free(v);
4232 }
4233 
4234 void qmp_blockdev_del(const char *node_name, Error **errp)
4235 {
4236     AioContext *aio_context;
4237     BlockDriverState *bs;
4238 
4239     bs = bdrv_find_node(node_name);
4240     if (!bs) {
4241         error_setg(errp, "Cannot find node %s", node_name);
4242         return;
4243     }
4244     if (bdrv_has_blk(bs)) {
4245         error_setg(errp, "Node %s is in use", node_name);
4246         return;
4247     }
4248     aio_context = bdrv_get_aio_context(bs);
4249     aio_context_acquire(aio_context);
4250 
4251     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
4252         goto out;
4253     }
4254 
4255     if (!QTAILQ_IN_USE(bs, monitor_list)) {
4256         error_setg(errp, "Node %s is not owned by the monitor",
4257                    bs->node_name);
4258         goto out;
4259     }
4260 
4261     if (bs->refcnt > 1) {
4262         error_setg(errp, "Block device %s is in use",
4263                    bdrv_get_device_or_node_name(bs));
4264         goto out;
4265     }
4266 
4267     QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4268     bdrv_unref(bs);
4269 
4270 out:
4271     aio_context_release(aio_context);
4272 }
4273 
4274 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
4275                                   const char *child_name)
4276 {
4277     BdrvChild *child;
4278 
4279     QLIST_FOREACH(child, &parent_bs->children, next) {
4280         if (strcmp(child->name, child_name) == 0) {
4281             return child;
4282         }
4283     }
4284 
4285     return NULL;
4286 }
4287 
4288 void qmp_x_blockdev_change(const char *parent, bool has_child,
4289                            const char *child, bool has_node,
4290                            const char *node, Error **errp)
4291 {
4292     BlockDriverState *parent_bs, *new_bs = NULL;
4293     BdrvChild *p_child;
4294 
4295     parent_bs = bdrv_lookup_bs(parent, parent, errp);
4296     if (!parent_bs) {
4297         return;
4298     }
4299 
4300     if (has_child == has_node) {
4301         if (has_child) {
4302             error_setg(errp, "The parameters child and node are in conflict");
4303         } else {
4304             error_setg(errp, "Either child or node must be specified");
4305         }
4306         return;
4307     }
4308 
4309     if (has_child) {
4310         p_child = bdrv_find_child(parent_bs, child);
4311         if (!p_child) {
4312             error_setg(errp, "Node '%s' does not have child '%s'",
4313                        parent, child);
4314             return;
4315         }
4316         bdrv_del_child(parent_bs, p_child, errp);
4317     }
4318 
4319     if (has_node) {
4320         new_bs = bdrv_find_node(node);
4321         if (!new_bs) {
4322             error_setg(errp, "Node '%s' not found", node);
4323             return;
4324         }
4325         bdrv_add_child(parent_bs, new_bs, errp);
4326     }
4327 }
4328 
4329 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4330 {
4331     BlockJobInfoList *head = NULL, **p_next = &head;
4332     BlockJob *job;
4333 
4334     for (job = block_job_next(NULL); job; job = block_job_next(job)) {
4335         BlockJobInfoList *elem;
4336         AioContext *aio_context;
4337 
4338         if (block_job_is_internal(job)) {
4339             continue;
4340         }
4341         elem = g_new0(BlockJobInfoList, 1);
4342         aio_context = blk_get_aio_context(job->blk);
4343         aio_context_acquire(aio_context);
4344         elem->value = block_job_query(job, errp);
4345         aio_context_release(aio_context);
4346         if (!elem->value) {
4347             g_free(elem);
4348             qapi_free_BlockJobInfoList(head);
4349             return NULL;
4350         }
4351         *p_next = elem;
4352         p_next = &elem->next;
4353     }
4354 
4355     return head;
4356 }
4357 
4358 void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
4359                                  bool has_force, bool force, Error **errp)
4360 {
4361     AioContext *old_context;
4362     AioContext *new_context;
4363     BlockDriverState *bs;
4364 
4365     bs = bdrv_find_node(node_name);
4366     if (!bs) {
4367         error_setg(errp, "Cannot find node %s", node_name);
4368         return;
4369     }
4370 
4371     /* Protects against accidents. */
4372     if (!(has_force && force) && bdrv_has_blk(bs)) {
4373         error_setg(errp, "Node %s is associated with a BlockBackend and could "
4374                          "be in use (use force=true to override this check)",
4375                          node_name);
4376         return;
4377     }
4378 
4379     if (iothread->type == QTYPE_QSTRING) {
4380         IOThread *obj = iothread_by_id(iothread->u.s);
4381         if (!obj) {
4382             error_setg(errp, "Cannot find iothread %s", iothread->u.s);
4383             return;
4384         }
4385 
4386         new_context = iothread_get_aio_context(obj);
4387     } else {
4388         new_context = qemu_get_aio_context();
4389     }
4390 
4391     old_context = bdrv_get_aio_context(bs);
4392     aio_context_acquire(old_context);
4393 
4394     bdrv_set_aio_context(bs, new_context);
4395 
4396     aio_context_release(old_context);
4397 }
4398 
4399 void qmp_x_block_latency_histogram_set(
4400     const char *device,
4401     bool has_boundaries, uint64List *boundaries,
4402     bool has_boundaries_read, uint64List *boundaries_read,
4403     bool has_boundaries_write, uint64List *boundaries_write,
4404     bool has_boundaries_flush, uint64List *boundaries_flush,
4405     Error **errp)
4406 {
4407     BlockBackend *blk = blk_by_name(device);
4408     BlockAcctStats *stats;
4409     int ret;
4410 
4411     if (!blk) {
4412         error_setg(errp, "Device '%s' not found", device);
4413         return;
4414     }
4415     stats = blk_get_stats(blk);
4416 
4417     if (!has_boundaries && !has_boundaries_read && !has_boundaries_write &&
4418         !has_boundaries_flush)
4419     {
4420         block_latency_histograms_clear(stats);
4421         return;
4422     }
4423 
4424     if (has_boundaries || has_boundaries_read) {
4425         ret = block_latency_histogram_set(
4426             stats, BLOCK_ACCT_READ,
4427             has_boundaries_read ? boundaries_read : boundaries);
4428         if (ret) {
4429             error_setg(errp, "Device '%s' set read boundaries fail", device);
4430             return;
4431         }
4432     }
4433 
4434     if (has_boundaries || has_boundaries_write) {
4435         ret = block_latency_histogram_set(
4436             stats, BLOCK_ACCT_WRITE,
4437             has_boundaries_write ? boundaries_write : boundaries);
4438         if (ret) {
4439             error_setg(errp, "Device '%s' set write boundaries fail", device);
4440             return;
4441         }
4442     }
4443 
4444     if (has_boundaries || has_boundaries_flush) {
4445         ret = block_latency_histogram_set(
4446             stats, BLOCK_ACCT_FLUSH,
4447             has_boundaries_flush ? boundaries_flush : boundaries);
4448         if (ret) {
4449             error_setg(errp, "Device '%s' set flush boundaries fail", device);
4450             return;
4451         }
4452     }
4453 }
4454 
4455 QemuOptsList qemu_common_drive_opts = {
4456     .name = "drive",
4457     .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4458     .desc = {
4459         {
4460             .name = "snapshot",
4461             .type = QEMU_OPT_BOOL,
4462             .help = "enable/disable snapshot mode",
4463         },{
4464             .name = "aio",
4465             .type = QEMU_OPT_STRING,
4466             .help = "host AIO implementation (threads, native)",
4467         },{
4468             .name = BDRV_OPT_CACHE_WB,
4469             .type = QEMU_OPT_BOOL,
4470             .help = "Enable writeback mode",
4471         },{
4472             .name = "format",
4473             .type = QEMU_OPT_STRING,
4474             .help = "disk format (raw, qcow2, ...)",
4475         },{
4476             .name = "rerror",
4477             .type = QEMU_OPT_STRING,
4478             .help = "read error action",
4479         },{
4480             .name = "werror",
4481             .type = QEMU_OPT_STRING,
4482             .help = "write error action",
4483         },{
4484             .name = BDRV_OPT_READ_ONLY,
4485             .type = QEMU_OPT_BOOL,
4486             .help = "open drive file as read-only",
4487         },
4488 
4489         THROTTLE_OPTS,
4490 
4491         {
4492             .name = "throttling.group",
4493             .type = QEMU_OPT_STRING,
4494             .help = "name of the block throttling group",
4495         },{
4496             .name = "copy-on-read",
4497             .type = QEMU_OPT_BOOL,
4498             .help = "copy read data from backing file into image file",
4499         },{
4500             .name = "detect-zeroes",
4501             .type = QEMU_OPT_STRING,
4502             .help = "try to optimize zero writes (off, on, unmap)",
4503         },{
4504             .name = "stats-account-invalid",
4505             .type = QEMU_OPT_BOOL,
4506             .help = "whether to account for invalid I/O operations "
4507                     "in the statistics",
4508         },{
4509             .name = "stats-account-failed",
4510             .type = QEMU_OPT_BOOL,
4511             .help = "whether to account for failed I/O operations "
4512                     "in the statistics",
4513         },
4514         { /* end of list */ }
4515     },
4516 };
4517 
4518 QemuOptsList qemu_drive_opts = {
4519     .name = "drive",
4520     .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4521     .desc = {
4522         /*
4523          * no elements => accept any params
4524          * validation will happen later
4525          */
4526         { /* end of list */ }
4527     },
4528 };
4529