tests/test-bdrv-drain: use QEMU_IOVEC_INIT_BUF
[qemu/ar7.git] / blockdev.c
blob8714ad2702f9eb0b08cbf61fd167021d9ec2a1bc
1 /*
2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
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.
9 * This file incorporates work covered by the following copyright and
10 * permission notice:
12 * Copyright (c) 2003-2008 Fabrice Bellard
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:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
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.
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"
64 static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
65 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
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);
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",
87 static int if_max_devs[IF_COUNT] = {
89 * Do not change these numbers! They govern how drive option
90 * index maps to unit and bus. That mapping is ABI.
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.
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.
102 [IF_IDE] = 2,
103 [IF_SCSI] = 7,
107 * Boards may call this to offer board-by-board overrides
108 * of the default, global values.
110 void override_max_devs(BlockInterfaceType type, int max_devs)
112 BlockBackend *blk;
113 DriveInfo *dinfo;
115 if (max_devs <= 0) {
116 return;
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();
129 if_max_devs[type] = max_devs;
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.
139 void blockdev_mark_auto_del(BlockBackend *blk)
141 DriveInfo *dinfo = blk_legacy_dinfo(blk);
142 BlockDriverState *bs = blk_bs(blk);
143 AioContext *aio_context;
145 if (!dinfo) {
146 return;
149 if (bs) {
150 aio_context = bdrv_get_aio_context(bs);
151 aio_context_acquire(aio_context);
153 if (bs->job) {
154 job_cancel(&bs->job->job, false);
157 aio_context_release(aio_context);
160 dinfo->auto_del = 1;
163 void blockdev_auto_del(BlockBackend *blk)
165 DriveInfo *dinfo = blk_legacy_dinfo(blk);
167 if (dinfo && dinfo->auto_del) {
168 monitor_remove_blk(blk);
169 blk_unref(blk);
174 * Returns the current mapping of how many units per bus
175 * a particular interface can support.
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.
181 int drive_get_max_devs(BlockInterfaceType type)
183 if (type >= IF_IDE && type < IF_COUNT) {
184 return if_max_devs[type];
187 return -1;
190 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
192 int max_devs = if_max_devs[type];
193 return max_devs ? index / max_devs : 0;
196 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
198 int max_devs = if_max_devs[type];
199 return max_devs ? index % max_devs : index;
202 QemuOpts *drive_def(const char *optstr)
204 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
207 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
208 const char *optstr)
210 QemuOpts *opts;
212 opts = drive_def(optstr);
213 if (!opts) {
214 return NULL;
216 if (type != IF_DEFAULT) {
217 qemu_opt_set(opts, "if", if_name[type], &error_abort);
219 if (index >= 0) {
220 qemu_opt_set_number(opts, "index", index, &error_abort);
222 if (file)
223 qemu_opt_set(opts, "file", file, &error_abort);
224 return opts;
227 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
229 BlockBackend *blk;
230 DriveInfo *dinfo;
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;
240 return NULL;
243 void drive_check_orphaned(void)
245 BlockBackend *blk;
246 DriveInfo *dinfo;
247 Location loc;
248 bool orphans = false;
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;
264 if (orphans) {
265 exit(1);
269 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
271 return drive_get(type,
272 drive_index_to_bus_id(type, index),
273 drive_index_to_unit_id(type, index));
276 int drive_get_max_bus(BlockInterfaceType type)
278 int max_bus;
279 BlockBackend *blk;
280 DriveInfo *dinfo;
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;
289 return max_bus;
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)
297 static int next_block_unit[IF_COUNT];
299 return drive_get(type, 0, next_block_unit[type]++);
302 static void bdrv_format_print(void *opaque, const char *name)
304 error_printf(" %s", name);
307 typedef struct {
308 QEMUBH *bh;
309 BlockDriverState *bs;
310 } BDRVPutRefBH;
312 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
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;
329 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
330 Error **errp)
332 const QListEntry *entry;
333 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
334 switch (qobject_type(entry->value)) {
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;
347 break;
350 case QTYPE_QNUM: {
351 int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
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;
359 break;
362 default:
363 error_setg(errp, "The specification of stats-intervals is invalid");
364 return false;
367 return true;
370 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
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)
377 Error *local_error = NULL;
378 const char *aio;
380 if (bdrv_flags) {
381 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
382 *bdrv_flags |= BDRV_O_COPY_ON_READ;
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;
397 /* disk I/O throttling */
398 if (throttling_group) {
399 *throttling_group = qemu_opt_get(opts, "throttling.group");
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);
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);
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);
443 throttle_cfg->op_size =
444 qemu_opt_get_number(opts, "throttling.iops-size", 0);
446 if (!throttle_is_valid(throttle_cfg, errp)) {
447 return;
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;
464 /* Takes the ownership of bs_opts */
465 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
466 Error **errp)
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;
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;
495 qemu_opts_absorb_qdict(opts, bs_opts, &error);
496 if (error) {
497 error_propagate(errp, error);
498 goto early_err;
501 if (id) {
502 qdict_del(bs_opts, "id");
505 /* extract parameters */
506 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
508 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
509 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
511 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
513 id = qemu_opts_id(opts);
515 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
516 qdict_array_split(interval_dict, &interval_list);
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;
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;
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;
539 if (qdict_haskey(bs_opts, "driver")) {
540 error_setg(errp, "Cannot specify both 'driver' and 'format'");
541 goto early_err;
543 qdict_put_str(bs_opts, "driver", buf);
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;
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;
564 if (snapshot) {
565 bdrv_flags |= BDRV_O_SNAPSHOT;
568 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
570 /* init */
571 if ((!file || !*file) && !qdict_size(bs_opts)) {
572 BlockBackendRootState *blk_rs;
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;
580 qobject_unref(bs_opts);
581 } else {
582 if (file && !*file) {
583 file = NULL;
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);
596 if (runstate_check(RUN_STATE_INMIGRATE)) {
597 bdrv_flags |= BDRV_O_INACTIVE;
600 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
601 if (!blk) {
602 goto err_no_bs_opts;
604 bs = blk_bs(blk);
606 bs->detect_zeroes = detect_zeroes;
608 block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
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;
617 /* disk I/O throttling */
618 if (throttle_enabled(&cfg)) {
619 if (!throttling_group) {
620 throttling_group = id;
622 blk_io_limits_enable(blk, throttling_group);
623 blk_set_io_limits(blk, &cfg);
626 blk_set_enable_write_cache(blk, !writethrough);
627 blk_set_on_error(blk, on_read_error, on_write_error);
629 if (!monitor_add_blk(blk, id, errp)) {
630 blk_unref(blk);
631 blk = NULL;
632 goto err_no_bs_opts;
635 err_no_bs_opts:
636 qemu_opts_del(opts);
637 qobject_unref(interval_dict);
638 qobject_unref(interval_list);
639 return blk;
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;
650 /* Takes the ownership of bs_opts */
651 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
653 int bdrv_flags = 0;
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");
662 if (runstate_check(RUN_STATE_INMIGRATE)) {
663 bdrv_flags |= BDRV_O_INACTIVE;
666 return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
669 void blockdev_close_all_bdrv_states(void)
671 BlockDriverState *bs, *next_bs;
673 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
674 AioContext *ctx = bdrv_get_aio_context(bs);
676 aio_context_acquire(ctx);
677 bdrv_unref(bs);
678 aio_context_release(ctx);
682 /* Iterates over the list of monitor-owned BlockDriverStates */
683 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
685 return bs ? QTAILQ_NEXT(bs, monitor_list)
686 : QTAILQ_FIRST(&monitor_bdrv_states);
689 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
690 Error **errp)
692 const char *value;
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;
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);
710 QemuOptsList qemu_legacy_drive_opts = {
711 .name = "drive",
712 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
713 .desc = {
715 .name = "bus",
716 .type = QEMU_OPT_NUMBER,
717 .help = "bus number",
719 .name = "unit",
720 .type = QEMU_OPT_NUMBER,
721 .help = "unit number (i.e. lun for scsi)",
723 .name = "index",
724 .type = QEMU_OPT_NUMBER,
725 .help = "index number",
727 .name = "media",
728 .type = QEMU_OPT_STRING,
729 .help = "media type (disk, cdrom)",
731 .name = "if",
732 .type = QEMU_OPT_STRING,
733 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
735 .name = "file",
736 .type = QEMU_OPT_STRING,
737 .help = "file name",
740 /* Options that are passed on, but have special semantics with -drive */
742 .name = BDRV_OPT_READ_ONLY,
743 .type = QEMU_OPT_BOOL,
744 .help = "open drive file as read-only",
746 .name = "rerror",
747 .type = QEMU_OPT_STRING,
748 .help = "read error action",
750 .name = "werror",
751 .type = QEMU_OPT_STRING,
752 .help = "write error action",
754 .name = "copy-on-read",
755 .type = QEMU_OPT_BOOL,
756 .help = "copy read data from backing file into image file",
759 { /* end of list */ }
763 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
764 Error **errp)
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;
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" },
790 { "bps", "throttling.bps-total" },
791 { "bps_rd", "throttling.bps-read" },
792 { "bps_wr", "throttling.bps-write" },
794 { "iops_max", "throttling.iops-total-max" },
795 { "iops_rd_max", "throttling.iops-read-max" },
796 { "iops_wr_max", "throttling.iops-write-max" },
798 { "bps_max", "throttling.bps-total-max" },
799 { "bps_rd_max", "throttling.bps-read-max" },
800 { "bps_wr_max", "throttling.bps-write-max" },
802 { "iops_size", "throttling.iops-size" },
804 { "group", "throttling.group" },
806 { "readonly", BDRV_OPT_READ_ONLY },
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;
818 value = qemu_opt_get(all_opts, "cache");
819 if (value) {
820 int flags = 0;
821 bool writethrough;
823 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
824 error_setg(errp, "invalid cache option");
825 return NULL;
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);
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);
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);
841 qemu_opt_unset(all_opts, "cache");
844 /* Get a QDict for processing the options */
845 bs_opts = qdict_new();
846 qemu_opts_to_qdict(all_opts, bs_opts);
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;
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;
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);
874 if (read_only && copy_on_read) {
875 warn_report("disabling copy-on-read on read-only drive");
876 copy_on_read = false;
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");
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++) {
889 if (type == IF_COUNT) {
890 error_setg(errp, "unsupported bus type '%s'", value);
891 goto fail;
893 } else {
894 type = block_default_type;
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);
903 max_devs = if_max_devs[type];
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;
910 bus_id = drive_index_to_bus_id(type, index);
911 unit_id = drive_index_to_unit_id(type, index);
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++;
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;
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;
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";
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);
950 qdict_put_str(bs_opts, "id", new_id);
951 g_free(new_id);
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);
964 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
965 &error_abort);
968 filename = qemu_opt_get(legacy_opts, "file");
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;
978 qdict_put_str(bs_opts, "werror", werror);
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;
988 qdict_put_str(bs_opts, "rerror", rerror);
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);
1001 /* Create legacy DriveInfo */
1002 dinfo = g_malloc0(sizeof(*dinfo));
1003 dinfo->opts = all_opts;
1005 dinfo->type = type;
1006 dinfo->bus = bus_id;
1007 dinfo->unit = unit_id;
1009 blk_set_legacy_dinfo(blk, dinfo);
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;
1022 fail:
1023 qemu_opts_del(legacy_opts);
1024 qobject_unref(bs_opts);
1025 return dinfo;
1028 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1030 BlockDriverState *bs;
1032 bs = bdrv_lookup_bs(name, name, errp);
1033 if (bs == NULL) {
1034 return NULL;
1037 if (!bdrv_is_root_node(bs)) {
1038 error_setg(errp, "Need a root block node");
1039 return NULL;
1042 if (!bdrv_is_inserted(bs)) {
1043 error_setg(errp, "Device has no medium");
1044 return NULL;
1047 return bs;
1050 static BlockBackend *qmp_get_blk(const char *blk_name, const char *qdev_id,
1051 Error **errp)
1053 BlockBackend *blk;
1055 if (!blk_name == !qdev_id) {
1056 error_setg(errp, "Need exactly one of 'device' and 'id'");
1057 return NULL;
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);
1070 return blk;
1073 void hmp_commit(Monitor *mon, const QDict *qdict)
1075 const char *device = qdict_get_str(qdict, "device");
1076 BlockBackend *blk;
1077 int ret;
1079 if (!strcmp(device, "all")) {
1080 ret = blk_commit_all();
1081 } else {
1082 BlockDriverState *bs;
1083 AioContext *aio_context;
1085 blk = blk_by_name(device);
1086 if (!blk) {
1087 monitor_printf(mon, "Device '%s' not found\n", device);
1088 return;
1090 if (!blk_is_available(blk)) {
1091 monitor_printf(mon, "Device '%s' has no medium\n", device);
1092 return;
1095 bs = blk_bs(blk);
1096 aio_context = bdrv_get_aio_context(bs);
1097 aio_context_acquire(aio_context);
1099 ret = bdrv_commit(bs);
1101 aio_context_release(aio_context);
1103 if (ret < 0) {
1104 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1105 strerror(-ret));
1109 static void blockdev_do_action(TransactionAction *action, Error **errp)
1111 TransactionActionList list;
1113 list.value = action;
1114 list.next = NULL;
1115 qmp_transaction(&list, false, NULL, errp);
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)
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,
1139 TransactionAction action = {
1140 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1141 .u.blockdev_snapshot_sync.data = &snapshot,
1143 blockdev_do_action(&action, errp);
1146 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1147 Error **errp)
1149 BlockdevSnapshot snapshot_data = {
1150 .node = (char *) node,
1151 .overlay = (char *) overlay
1153 TransactionAction action = {
1154 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1155 .u.blockdev_snapshot.data = &snapshot_data,
1157 blockdev_do_action(&action, errp);
1160 void qmp_blockdev_snapshot_internal_sync(const char *device,
1161 const char *name,
1162 Error **errp)
1164 BlockdevSnapshotInternal snapshot = {
1165 .device = (char *) device,
1166 .name = (char *) name
1168 TransactionAction action = {
1169 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1170 .u.blockdev_snapshot_internal_sync.data = &snapshot,
1172 blockdev_do_action(&action, errp);
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)
1182 BlockDriverState *bs;
1183 AioContext *aio_context;
1184 QEMUSnapshotInfo sn;
1185 Error *local_err = NULL;
1186 SnapshotInfo *info = NULL;
1187 int ret;
1189 bs = qmp_get_root_bs(device, errp);
1190 if (!bs) {
1191 return NULL;
1193 aio_context = bdrv_get_aio_context(bs);
1194 aio_context_acquire(aio_context);
1196 if (!has_id) {
1197 id = NULL;
1200 if (!has_name) {
1201 name = NULL;
1204 if (!id && !name) {
1205 error_setg(errp, "Name or id must be provided");
1206 goto out_aio_context;
1209 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1210 goto out_aio_context;
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;
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;
1226 bdrv_snapshot_delete(bs, id, name, &local_err);
1227 if (local_err) {
1228 error_propagate(errp, local_err);
1229 goto out_aio_context;
1232 aio_context_release(aio_context);
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;
1243 return info;
1245 out_aio_context:
1246 aio_context_release(aio_context);
1247 return NULL;
1251 * block_dirty_bitmap_lookup:
1252 * Return a dirty bitmap (if present), after validating
1253 * the node reference and bitmap names.
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.
1261 * @return: A bitmap object on success, or NULL on failure.
1263 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1264 const char *name,
1265 BlockDriverState **pbs,
1266 Error **errp)
1268 BlockDriverState *bs;
1269 BdrvDirtyBitmap *bitmap;
1271 if (!node) {
1272 error_setg(errp, "Node cannot be NULL");
1273 return NULL;
1275 if (!name) {
1276 error_setg(errp, "Bitmap name cannot be NULL");
1277 return NULL;
1279 bs = bdrv_lookup_bs(node, node, NULL);
1280 if (!bs) {
1281 error_setg(errp, "Node '%s' not found", node);
1282 return NULL;
1285 bitmap = bdrv_find_dirty_bitmap(bs, name);
1286 if (!bitmap) {
1287 error_setg(errp, "Dirty bitmap '%s' not found", name);
1288 return NULL;
1291 if (pbs) {
1292 *pbs = bs;
1295 return bitmap;
1298 /* New and old BlockDriverState structs for atomic group operations */
1300 typedef struct BlkActionState BlkActionState;
1303 * BlkActionOps:
1304 * Table of operations that define an Action.
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.
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.
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;
1325 * BlkActionState:
1326 * Describes one Action's state within a Transaction.
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.
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.
1337 struct BlkActionState {
1338 TransactionAction *action;
1339 const BlkActionOps *ops;
1340 JobTxn *block_job_txn;
1341 TransactionProperties *txn_props;
1342 QTAILQ_ENTRY(BlkActionState) entry;
1345 /* internal snapshot private data */
1346 typedef struct InternalSnapshotState {
1347 BlkActionState common;
1348 BlockDriverState *bs;
1349 QEMUSnapshotInfo sn;
1350 bool created;
1351 } InternalSnapshotState;
1354 static int action_check_completion_mode(BlkActionState *s, Error **errp)
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;
1364 return 0;
1367 static void internal_snapshot_prepare(BlkActionState *common,
1368 Error **errp)
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;
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);
1387 /* 1. parse input */
1388 device = internal->device;
1389 name = internal->name;
1391 /* 2. check for validation */
1392 if (action_check_completion_mode(common, errp) < 0) {
1393 return;
1396 bs = qmp_get_root_bs(device, errp);
1397 if (!bs) {
1398 return;
1401 aio_context = bdrv_get_aio_context(bs);
1402 aio_context_acquire(aio_context);
1404 state->bs = bs;
1406 /* Paired with .clean() */
1407 bdrv_drained_begin(bs);
1409 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1410 goto out;
1413 if (bdrv_is_read_only(bs)) {
1414 error_setg(errp, "Device '%s' is read only", device);
1415 goto out;
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;
1425 if (!strlen(name)) {
1426 error_setg(errp, "Name is empty");
1427 goto out;
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;
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);
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;
1459 /* 4. succeed, mark a snapshot is created */
1460 state->created = true;
1462 out:
1463 aio_context_release(aio_context);
1466 static void internal_snapshot_abort(BlkActionState *common)
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;
1475 if (!state->created) {
1476 return;
1479 aio_context = bdrv_get_aio_context(state->bs);
1480 aio_context_acquire(aio_context);
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));
1490 aio_context_release(aio_context);
1493 static void internal_snapshot_clean(BlkActionState *common)
1495 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1496 common, common);
1497 AioContext *aio_context;
1499 if (!state->bs) {
1500 return;
1503 aio_context = bdrv_get_aio_context(state->bs);
1504 aio_context_acquire(aio_context);
1506 bdrv_drained_end(state->bs);
1508 aio_context_release(aio_context);
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;
1519 static void external_snapshot_prepare(BlkActionState *common,
1520 Error **errp)
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;
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:
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;
1548 break;
1549 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
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;
1557 break;
1558 default:
1559 g_assert_not_reached();
1562 /* start processing */
1563 if (action_check_completion_mode(common, errp) < 0) {
1564 return;
1567 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1568 if (!state->old_bs) {
1569 return;
1572 aio_context = bdrv_get_aio_context(state->old_bs);
1573 aio_context_acquire(aio_context);
1575 /* Paired with .clean() */
1576 bdrv_drained_begin(state->old_bs);
1578 if (!bdrv_is_inserted(state->old_bs)) {
1579 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1580 goto out;
1583 if (bdrv_op_is_blocked(state->old_bs,
1584 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1585 goto out;
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;
1595 if (!bdrv_is_first_non_filter(state->old_bs)) {
1596 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1597 goto out;
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;
1607 if (node_name && !snapshot_node_name) {
1608 error_setg(errp, "New snapshot node name missing");
1609 goto out;
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;
1618 flags = state->old_bs->open_flags;
1619 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1620 flags |= BDRV_O_NO_BACKING;
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;
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;
1640 options = qdict_new();
1641 if (snapshot_node_name) {
1642 qdict_put_str(options, "node-name", snapshot_node_name);
1644 qdict_put_str(options, "driver", format);
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;
1654 if (bdrv_has_blk(state->new_bs)) {
1655 error_setg(errp, "The snapshot is already in use");
1656 goto out;
1659 if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
1660 errp)) {
1661 goto out;
1664 if (state->new_bs->backing != NULL) {
1665 error_setg(errp, "The snapshot already has a backing image");
1666 goto out;
1669 if (!state->new_bs->drv->supports_backing) {
1670 error_setg(errp, "The snapshot does not support backing images");
1671 goto out;
1674 bdrv_set_aio_context(state->new_bs, aio_context);
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;
1685 state->overlay_appended = true;
1687 out:
1688 aio_context_release(aio_context);
1691 static void external_snapshot_commit(BlkActionState *common)
1693 ExternalSnapshotState *state =
1694 DO_UPCAST(ExternalSnapshotState, common, common);
1695 AioContext *aio_context;
1697 aio_context = bdrv_get_aio_context(state->old_bs);
1698 aio_context_acquire(aio_context);
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);
1707 aio_context_release(aio_context);
1710 static void external_snapshot_abort(BlkActionState *common)
1712 ExternalSnapshotState *state =
1713 DO_UPCAST(ExternalSnapshotState, common, common);
1714 if (state->new_bs) {
1715 if (state->overlay_appended) {
1716 AioContext *aio_context;
1718 aio_context = bdrv_get_aio_context(state->old_bs);
1719 aio_context_acquire(aio_context);
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 */
1727 aio_context_release(aio_context);
1732 static void external_snapshot_clean(BlkActionState *common)
1734 ExternalSnapshotState *state =
1735 DO_UPCAST(ExternalSnapshotState, common, common);
1736 AioContext *aio_context;
1738 if (!state->old_bs) {
1739 return;
1742 aio_context = bdrv_get_aio_context(state->old_bs);
1743 aio_context_acquire(aio_context);
1745 bdrv_drained_end(state->old_bs);
1746 bdrv_unref(state->new_bs);
1748 aio_context_release(aio_context);
1751 typedef struct DriveBackupState {
1752 BlkActionState common;
1753 BlockDriverState *bs;
1754 BlockJob *job;
1755 } DriveBackupState;
1757 static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
1758 Error **errp);
1760 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1762 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1763 BlockDriverState *bs;
1764 DriveBackup *backup;
1765 AioContext *aio_context;
1766 Error *local_err = NULL;
1768 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1769 backup = common->action->u.drive_backup.data;
1771 bs = qmp_get_root_bs(backup->device, errp);
1772 if (!bs) {
1773 return;
1776 aio_context = bdrv_get_aio_context(bs);
1777 aio_context_acquire(aio_context);
1779 /* Paired with .clean() */
1780 bdrv_drained_begin(bs);
1782 state->bs = bs;
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;
1790 out:
1791 aio_context_release(aio_context);
1794 static void drive_backup_commit(BlkActionState *common)
1796 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1797 AioContext *aio_context;
1799 aio_context = bdrv_get_aio_context(state->bs);
1800 aio_context_acquire(aio_context);
1802 assert(state->job);
1803 job_start(&state->job->job);
1805 aio_context_release(aio_context);
1808 static void drive_backup_abort(BlkActionState *common)
1810 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1812 if (state->job) {
1813 AioContext *aio_context;
1815 aio_context = bdrv_get_aio_context(state->bs);
1816 aio_context_acquire(aio_context);
1818 job_cancel_sync(&state->job->job);
1820 aio_context_release(aio_context);
1824 static void drive_backup_clean(BlkActionState *common)
1826 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1827 AioContext *aio_context;
1829 if (!state->bs) {
1830 return;
1833 aio_context = bdrv_get_aio_context(state->bs);
1834 aio_context_acquire(aio_context);
1836 bdrv_drained_end(state->bs);
1838 aio_context_release(aio_context);
1841 typedef struct BlockdevBackupState {
1842 BlkActionState common;
1843 BlockDriverState *bs;
1844 BlockJob *job;
1845 } BlockdevBackupState;
1847 static BlockJob *do_blockdev_backup(BlockdevBackup *backup, JobTxn *txn,
1848 Error **errp);
1850 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1852 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1853 BlockdevBackup *backup;
1854 BlockDriverState *bs, *target;
1855 AioContext *aio_context;
1856 Error *local_err = NULL;
1858 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1859 backup = common->action->u.blockdev_backup.data;
1861 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1862 if (!bs) {
1863 return;
1866 target = bdrv_lookup_bs(backup->target, backup->target, errp);
1867 if (!target) {
1868 return;
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;
1876 aio_context_acquire(aio_context);
1877 state->bs = bs;
1879 /* Paired with .clean() */
1880 bdrv_drained_begin(state->bs);
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;
1888 out:
1889 aio_context_release(aio_context);
1892 static void blockdev_backup_commit(BlkActionState *common)
1894 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1895 AioContext *aio_context;
1897 aio_context = bdrv_get_aio_context(state->bs);
1898 aio_context_acquire(aio_context);
1900 assert(state->job);
1901 job_start(&state->job->job);
1903 aio_context_release(aio_context);
1906 static void blockdev_backup_abort(BlkActionState *common)
1908 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1910 if (state->job) {
1911 AioContext *aio_context;
1913 aio_context = bdrv_get_aio_context(state->bs);
1914 aio_context_acquire(aio_context);
1916 job_cancel_sync(&state->job->job);
1918 aio_context_release(aio_context);
1922 static void blockdev_backup_clean(BlkActionState *common)
1924 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1925 AioContext *aio_context;
1927 if (!state->bs) {
1928 return;
1931 aio_context = bdrv_get_aio_context(state->bs);
1932 aio_context_acquire(aio_context);
1934 bdrv_drained_end(state->bs);
1936 aio_context_release(aio_context);
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;
1948 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
1949 Error **errp)
1951 Error *local_err = NULL;
1952 BlockDirtyBitmapAdd *action;
1953 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1954 common, common);
1956 if (action_check_completion_mode(common, errp) < 0) {
1957 return;
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_disabled, action->disabled,
1967 &local_err);
1969 if (!local_err) {
1970 state->prepared = true;
1971 } else {
1972 error_propagate(errp, local_err);
1976 static void block_dirty_bitmap_add_abort(BlkActionState *common)
1978 BlockDirtyBitmapAdd *action;
1979 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1980 common, common);
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.
1986 if (state->prepared) {
1987 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
1991 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
1992 Error **errp)
1994 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1995 common, common);
1996 BlockDirtyBitmap *action;
1998 if (action_check_completion_mode(common, errp) < 0) {
1999 return;
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;
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;
2019 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2022 static void block_dirty_bitmap_restore(BlkActionState *common)
2024 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2025 common, common);
2027 if (state->backup) {
2028 bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
2032 static void block_dirty_bitmap_free_backup(BlkActionState *common)
2034 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2035 common, common);
2037 hbitmap_free(state->backup);
2040 static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2041 Error **errp)
2043 BlockDirtyBitmap *action;
2044 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2045 common, common);
2047 if (action_check_completion_mode(common, errp) < 0) {
2048 return;
2051 action = common->action->u.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;
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;
2067 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2068 bdrv_enable_dirty_bitmap(state->bitmap);
2071 static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2073 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2074 common, common);
2076 if (!state->was_enabled) {
2077 bdrv_disable_dirty_bitmap(state->bitmap);
2081 static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2082 Error **errp)
2084 BlockDirtyBitmap *action;
2085 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2086 common, common);
2088 if (action_check_completion_mode(common, errp) < 0) {
2089 return;
2092 action = common->action->u.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;
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;
2108 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2109 bdrv_disable_dirty_bitmap(state->bitmap);
2112 static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2114 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2115 common, common);
2117 if (state->was_enabled) {
2118 bdrv_enable_dirty_bitmap(state->bitmap);
2122 static BdrvDirtyBitmap *do_block_dirty_bitmap_merge(const char *node,
2123 const char *target,
2124 strList *bitmaps,
2125 HBitmap **backup,
2126 Error **errp);
2128 static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2129 Error **errp)
2131 BlockDirtyBitmapMerge *action;
2132 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2133 common, common);
2135 if (action_check_completion_mode(common, errp) < 0) {
2136 return;
2139 action = common->action->u.block_dirty_bitmap_merge.data;
2141 state->bitmap = do_block_dirty_bitmap_merge(action->node, action->target,
2142 action->bitmaps, &state->backup,
2143 errp);
2146 static void abort_prepare(BlkActionState *common, Error **errp)
2148 error_setg(errp, "Transaction aborted using Abort action");
2151 static void abort_commit(BlkActionState *common)
2153 g_assert_not_reached(); /* this action never succeeds */
2156 static const BlkActionOps actions[] = {
2157 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2158 .instance_size = sizeof(ExternalSnapshotState),
2159 .prepare = external_snapshot_prepare,
2160 .commit = external_snapshot_commit,
2161 .abort = external_snapshot_abort,
2162 .clean = external_snapshot_clean,
2164 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2165 .instance_size = sizeof(ExternalSnapshotState),
2166 .prepare = external_snapshot_prepare,
2167 .commit = external_snapshot_commit,
2168 .abort = external_snapshot_abort,
2169 .clean = external_snapshot_clean,
2171 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2172 .instance_size = sizeof(DriveBackupState),
2173 .prepare = drive_backup_prepare,
2174 .commit = drive_backup_commit,
2175 .abort = drive_backup_abort,
2176 .clean = drive_backup_clean,
2178 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2179 .instance_size = sizeof(BlockdevBackupState),
2180 .prepare = blockdev_backup_prepare,
2181 .commit = blockdev_backup_commit,
2182 .abort = blockdev_backup_abort,
2183 .clean = blockdev_backup_clean,
2185 [TRANSACTION_ACTION_KIND_ABORT] = {
2186 .instance_size = sizeof(BlkActionState),
2187 .prepare = abort_prepare,
2188 .commit = abort_commit,
2190 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2191 .instance_size = sizeof(InternalSnapshotState),
2192 .prepare = internal_snapshot_prepare,
2193 .abort = internal_snapshot_abort,
2194 .clean = internal_snapshot_clean,
2196 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2197 .instance_size = sizeof(BlockDirtyBitmapState),
2198 .prepare = block_dirty_bitmap_add_prepare,
2199 .abort = block_dirty_bitmap_add_abort,
2201 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2202 .instance_size = sizeof(BlockDirtyBitmapState),
2203 .prepare = block_dirty_bitmap_clear_prepare,
2204 .commit = block_dirty_bitmap_free_backup,
2205 .abort = block_dirty_bitmap_restore,
2207 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
2208 .instance_size = sizeof(BlockDirtyBitmapState),
2209 .prepare = block_dirty_bitmap_enable_prepare,
2210 .abort = block_dirty_bitmap_enable_abort,
2212 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
2213 .instance_size = sizeof(BlockDirtyBitmapState),
2214 .prepare = block_dirty_bitmap_disable_prepare,
2215 .abort = block_dirty_bitmap_disable_abort,
2217 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
2218 .instance_size = sizeof(BlockDirtyBitmapState),
2219 .prepare = block_dirty_bitmap_merge_prepare,
2220 .commit = block_dirty_bitmap_free_backup,
2221 .abort = block_dirty_bitmap_restore,
2223 /* Where are transactions for MIRROR, COMMIT and STREAM?
2224 * Although these blockjobs use transaction callbacks like the backup job,
2225 * these jobs do not necessarily adhere to transaction semantics.
2226 * These jobs may not fully undo all of their actions on abort, nor do they
2227 * necessarily work in transactions with more than one job in them.
2232 * Allocate a TransactionProperties structure if necessary, and fill
2233 * that structure with desired defaults if they are unset.
2235 static TransactionProperties *get_transaction_properties(
2236 TransactionProperties *props)
2238 if (!props) {
2239 props = g_new0(TransactionProperties, 1);
2242 if (!props->has_completion_mode) {
2243 props->has_completion_mode = true;
2244 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2247 return props;
2251 * 'Atomic' group operations. The operations are performed as a set, and if
2252 * any fail then we roll back all operations in the group.
2254 void qmp_transaction(TransactionActionList *dev_list,
2255 bool has_props,
2256 struct TransactionProperties *props,
2257 Error **errp)
2259 TransactionActionList *dev_entry = dev_list;
2260 JobTxn *block_job_txn = NULL;
2261 BlkActionState *state, *next;
2262 Error *local_err = NULL;
2264 QTAILQ_HEAD(, BlkActionState) snap_bdrv_states;
2265 QTAILQ_INIT(&snap_bdrv_states);
2267 /* Does this transaction get canceled as a group on failure?
2268 * If not, we don't really need to make a JobTxn.
2270 props = get_transaction_properties(props);
2271 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2272 block_job_txn = job_txn_new();
2275 /* drain all i/o before any operations */
2276 bdrv_drain_all();
2278 /* We don't do anything in this loop that commits us to the operations */
2279 while (NULL != dev_entry) {
2280 TransactionAction *dev_info = NULL;
2281 const BlkActionOps *ops;
2283 dev_info = dev_entry->value;
2284 dev_entry = dev_entry->next;
2286 assert(dev_info->type < ARRAY_SIZE(actions));
2288 ops = &actions[dev_info->type];
2289 assert(ops->instance_size > 0);
2291 state = g_malloc0(ops->instance_size);
2292 state->ops = ops;
2293 state->action = dev_info;
2294 state->block_job_txn = block_job_txn;
2295 state->txn_props = props;
2296 QTAILQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2298 state->ops->prepare(state, &local_err);
2299 if (local_err) {
2300 error_propagate(errp, local_err);
2301 goto delete_and_fail;
2305 QTAILQ_FOREACH(state, &snap_bdrv_states, entry) {
2306 if (state->ops->commit) {
2307 state->ops->commit(state);
2311 /* success */
2312 goto exit;
2314 delete_and_fail:
2315 /* failure, and it is all-or-none; roll back all operations */
2316 QTAILQ_FOREACH_REVERSE(state, &snap_bdrv_states, entry) {
2317 if (state->ops->abort) {
2318 state->ops->abort(state);
2321 exit:
2322 QTAILQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2323 if (state->ops->clean) {
2324 state->ops->clean(state);
2326 g_free(state);
2328 if (!has_props) {
2329 qapi_free_TransactionProperties(props);
2331 job_txn_unref(block_job_txn);
2334 void qmp_eject(bool has_device, const char *device,
2335 bool has_id, const char *id,
2336 bool has_force, bool force, Error **errp)
2338 Error *local_err = NULL;
2339 int rc;
2341 if (!has_force) {
2342 force = false;
2345 rc = do_open_tray(has_device ? device : NULL,
2346 has_id ? id : NULL,
2347 force, &local_err);
2348 if (rc && rc != -ENOSYS) {
2349 error_propagate(errp, local_err);
2350 return;
2352 error_free(local_err);
2354 blockdev_remove_medium(has_device, device, has_id, id, errp);
2357 void qmp_block_passwd(bool has_device, const char *device,
2358 bool has_node_name, const char *node_name,
2359 const char *password, Error **errp)
2361 error_setg(errp,
2362 "Setting block passwords directly is no longer supported");
2366 * Attempt to open the tray of @device.
2367 * If @force, ignore its tray lock.
2368 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2369 * On error, store an error through @errp and return -errno.
2370 * If @device does not exist, return -ENODEV.
2371 * If it has no removable media, return -ENOTSUP.
2372 * If it has no tray, return -ENOSYS.
2373 * If the guest was asked to open the tray, return -EINPROGRESS.
2374 * Else, return 0.
2376 static int do_open_tray(const char *blk_name, const char *qdev_id,
2377 bool force, Error **errp)
2379 BlockBackend *blk;
2380 const char *device = qdev_id ?: blk_name;
2381 bool locked;
2383 blk = qmp_get_blk(blk_name, qdev_id, errp);
2384 if (!blk) {
2385 return -ENODEV;
2388 if (!blk_dev_has_removable_media(blk)) {
2389 error_setg(errp, "Device '%s' is not removable", device);
2390 return -ENOTSUP;
2393 if (!blk_dev_has_tray(blk)) {
2394 error_setg(errp, "Device '%s' does not have a tray", device);
2395 return -ENOSYS;
2398 if (blk_dev_is_tray_open(blk)) {
2399 return 0;
2402 locked = blk_dev_is_medium_locked(blk);
2403 if (locked) {
2404 blk_dev_eject_request(blk, force);
2407 if (!locked || force) {
2408 blk_dev_change_media_cb(blk, false, &error_abort);
2411 if (locked && !force) {
2412 error_setg(errp, "Device '%s' is locked and force was not specified, "
2413 "wait for tray to open and try again", device);
2414 return -EINPROGRESS;
2417 return 0;
2420 void qmp_blockdev_open_tray(bool has_device, const char *device,
2421 bool has_id, const char *id,
2422 bool has_force, bool force,
2423 Error **errp)
2425 Error *local_err = NULL;
2426 int rc;
2428 if (!has_force) {
2429 force = false;
2431 rc = do_open_tray(has_device ? device : NULL,
2432 has_id ? id : NULL,
2433 force, &local_err);
2434 if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2435 error_propagate(errp, local_err);
2436 return;
2438 error_free(local_err);
2441 void qmp_blockdev_close_tray(bool has_device, const char *device,
2442 bool has_id, const char *id,
2443 Error **errp)
2445 BlockBackend *blk;
2446 Error *local_err = NULL;
2448 device = has_device ? device : NULL;
2449 id = has_id ? id : NULL;
2451 blk = qmp_get_blk(device, id, errp);
2452 if (!blk) {
2453 return;
2456 if (!blk_dev_has_removable_media(blk)) {
2457 error_setg(errp, "Device '%s' is not removable", device ?: id);
2458 return;
2461 if (!blk_dev_has_tray(blk)) {
2462 /* Ignore this command on tray-less devices */
2463 return;
2466 if (!blk_dev_is_tray_open(blk)) {
2467 return;
2470 blk_dev_change_media_cb(blk, true, &local_err);
2471 if (local_err) {
2472 error_propagate(errp, local_err);
2473 return;
2477 static void blockdev_remove_medium(bool has_device, const char *device,
2478 bool has_id, const char *id, Error **errp)
2480 BlockBackend *blk;
2481 BlockDriverState *bs;
2482 AioContext *aio_context;
2483 bool has_attached_device;
2485 device = has_device ? device : NULL;
2486 id = has_id ? id : NULL;
2488 blk = qmp_get_blk(device, id, errp);
2489 if (!blk) {
2490 return;
2493 /* For BBs without a device, we can exchange the BDS tree at will */
2494 has_attached_device = blk_get_attached_dev(blk);
2496 if (has_attached_device && !blk_dev_has_removable_media(blk)) {
2497 error_setg(errp, "Device '%s' is not removable", device ?: id);
2498 return;
2501 if (has_attached_device && blk_dev_has_tray(blk) &&
2502 !blk_dev_is_tray_open(blk))
2504 error_setg(errp, "Tray of device '%s' is not open", device ?: id);
2505 return;
2508 bs = blk_bs(blk);
2509 if (!bs) {
2510 return;
2513 aio_context = bdrv_get_aio_context(bs);
2514 aio_context_acquire(aio_context);
2516 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2517 goto out;
2520 blk_remove_bs(blk);
2522 if (!blk_dev_has_tray(blk)) {
2523 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2524 * called at all); therefore, the medium needs to be ejected here.
2525 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2526 * value passed here (i.e. false). */
2527 blk_dev_change_media_cb(blk, false, &error_abort);
2530 out:
2531 aio_context_release(aio_context);
2534 void qmp_blockdev_remove_medium(const char *id, Error **errp)
2536 blockdev_remove_medium(false, NULL, true, id, errp);
2539 static void qmp_blockdev_insert_anon_medium(BlockBackend *blk,
2540 BlockDriverState *bs, Error **errp)
2542 Error *local_err = NULL;
2543 bool has_device;
2544 int ret;
2546 /* For BBs without a device, we can exchange the BDS tree at will */
2547 has_device = blk_get_attached_dev(blk);
2549 if (has_device && !blk_dev_has_removable_media(blk)) {
2550 error_setg(errp, "Device is not removable");
2551 return;
2554 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2555 error_setg(errp, "Tray of the device is not open");
2556 return;
2559 if (blk_bs(blk)) {
2560 error_setg(errp, "There already is a medium in the device");
2561 return;
2564 ret = blk_insert_bs(blk, bs, errp);
2565 if (ret < 0) {
2566 return;
2569 if (!blk_dev_has_tray(blk)) {
2570 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2571 * called at all); therefore, the medium needs to be pushed into the
2572 * slot here.
2573 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2574 * value passed here (i.e. true). */
2575 blk_dev_change_media_cb(blk, true, &local_err);
2576 if (local_err) {
2577 error_propagate(errp, local_err);
2578 blk_remove_bs(blk);
2579 return;
2584 static void blockdev_insert_medium(bool has_device, const char *device,
2585 bool has_id, const char *id,
2586 const char *node_name, Error **errp)
2588 BlockBackend *blk;
2589 BlockDriverState *bs;
2591 blk = qmp_get_blk(has_device ? device : NULL,
2592 has_id ? id : NULL,
2593 errp);
2594 if (!blk) {
2595 return;
2598 bs = bdrv_find_node(node_name);
2599 if (!bs) {
2600 error_setg(errp, "Node '%s' not found", node_name);
2601 return;
2604 if (bdrv_has_blk(bs)) {
2605 error_setg(errp, "Node '%s' is already in use", node_name);
2606 return;
2609 qmp_blockdev_insert_anon_medium(blk, bs, errp);
2612 void qmp_blockdev_insert_medium(const char *id, const char *node_name,
2613 Error **errp)
2615 blockdev_insert_medium(false, NULL, true, id, node_name, errp);
2618 void qmp_blockdev_change_medium(bool has_device, const char *device,
2619 bool has_id, const char *id,
2620 const char *filename,
2621 bool has_format, const char *format,
2622 bool has_read_only,
2623 BlockdevChangeReadOnlyMode read_only,
2624 Error **errp)
2626 BlockBackend *blk;
2627 BlockDriverState *medium_bs = NULL;
2628 int bdrv_flags;
2629 bool detect_zeroes;
2630 int rc;
2631 QDict *options = NULL;
2632 Error *err = NULL;
2634 blk = qmp_get_blk(has_device ? device : NULL,
2635 has_id ? id : NULL,
2636 errp);
2637 if (!blk) {
2638 goto fail;
2641 if (blk_bs(blk)) {
2642 blk_update_root_state(blk);
2645 bdrv_flags = blk_get_open_flags_from_root_state(blk);
2646 bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2647 BDRV_O_PROTOCOL | BDRV_O_AUTO_RDONLY);
2649 if (!has_read_only) {
2650 read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2653 switch (read_only) {
2654 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2655 break;
2657 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2658 bdrv_flags &= ~BDRV_O_RDWR;
2659 break;
2661 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2662 bdrv_flags |= BDRV_O_RDWR;
2663 break;
2665 default:
2666 abort();
2669 options = qdict_new();
2670 detect_zeroes = blk_get_detect_zeroes_from_root_state(blk);
2671 qdict_put_str(options, "detect-zeroes", detect_zeroes ? "on" : "off");
2673 if (has_format) {
2674 qdict_put_str(options, "driver", format);
2677 medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2678 if (!medium_bs) {
2679 goto fail;
2682 rc = do_open_tray(has_device ? device : NULL,
2683 has_id ? id : NULL,
2684 false, &err);
2685 if (rc && rc != -ENOSYS) {
2686 error_propagate(errp, err);
2687 goto fail;
2689 error_free(err);
2690 err = NULL;
2692 blockdev_remove_medium(has_device, device, has_id, id, &err);
2693 if (err) {
2694 error_propagate(errp, err);
2695 goto fail;
2698 qmp_blockdev_insert_anon_medium(blk, medium_bs, &err);
2699 if (err) {
2700 error_propagate(errp, err);
2701 goto fail;
2704 qmp_blockdev_close_tray(has_device, device, has_id, id, errp);
2706 fail:
2707 /* If the medium has been inserted, the device has its own reference, so
2708 * ours must be relinquished; and if it has not been inserted successfully,
2709 * the reference must be relinquished anyway */
2710 bdrv_unref(medium_bs);
2713 /* throttling disk I/O limits */
2714 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2716 ThrottleConfig cfg;
2717 BlockDriverState *bs;
2718 BlockBackend *blk;
2719 AioContext *aio_context;
2721 blk = qmp_get_blk(arg->has_device ? arg->device : NULL,
2722 arg->has_id ? arg->id : NULL,
2723 errp);
2724 if (!blk) {
2725 return;
2728 aio_context = blk_get_aio_context(blk);
2729 aio_context_acquire(aio_context);
2731 bs = blk_bs(blk);
2732 if (!bs) {
2733 error_setg(errp, "Device has no medium");
2734 goto out;
2737 throttle_config_init(&cfg);
2738 cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2739 cfg.buckets[THROTTLE_BPS_READ].avg = arg->bps_rd;
2740 cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2742 cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2743 cfg.buckets[THROTTLE_OPS_READ].avg = arg->iops_rd;
2744 cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2746 if (arg->has_bps_max) {
2747 cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2749 if (arg->has_bps_rd_max) {
2750 cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2752 if (arg->has_bps_wr_max) {
2753 cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2755 if (arg->has_iops_max) {
2756 cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2758 if (arg->has_iops_rd_max) {
2759 cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2761 if (arg->has_iops_wr_max) {
2762 cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2765 if (arg->has_bps_max_length) {
2766 cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2768 if (arg->has_bps_rd_max_length) {
2769 cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2771 if (arg->has_bps_wr_max_length) {
2772 cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2774 if (arg->has_iops_max_length) {
2775 cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2777 if (arg->has_iops_rd_max_length) {
2778 cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2780 if (arg->has_iops_wr_max_length) {
2781 cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2784 if (arg->has_iops_size) {
2785 cfg.op_size = arg->iops_size;
2788 if (!throttle_is_valid(&cfg, errp)) {
2789 goto out;
2792 if (throttle_enabled(&cfg)) {
2793 /* Enable I/O limits if they're not enabled yet, otherwise
2794 * just update the throttling group. */
2795 if (!blk_get_public(blk)->throttle_group_member.throttle_state) {
2796 blk_io_limits_enable(blk,
2797 arg->has_group ? arg->group :
2798 arg->has_device ? arg->device :
2799 arg->id);
2800 } else if (arg->has_group) {
2801 blk_io_limits_update_group(blk, arg->group);
2803 /* Set the new throttling configuration */
2804 blk_set_io_limits(blk, &cfg);
2805 } else if (blk_get_public(blk)->throttle_group_member.throttle_state) {
2806 /* If all throttling settings are set to 0, disable I/O limits */
2807 blk_io_limits_disable(blk);
2810 out:
2811 aio_context_release(aio_context);
2814 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2815 bool has_granularity, uint32_t granularity,
2816 bool has_persistent, bool persistent,
2817 bool has_autoload, bool autoload,
2818 bool has_disabled, bool disabled,
2819 Error **errp)
2821 BlockDriverState *bs;
2822 BdrvDirtyBitmap *bitmap;
2823 AioContext *aio_context = NULL;
2825 if (!name || name[0] == '\0') {
2826 error_setg(errp, "Bitmap name cannot be empty");
2827 return;
2830 bs = bdrv_lookup_bs(node, node, errp);
2831 if (!bs) {
2832 return;
2835 if (has_granularity) {
2836 if (granularity < 512 || !is_power_of_2(granularity)) {
2837 error_setg(errp, "Granularity must be power of 2 "
2838 "and at least 512");
2839 return;
2841 } else {
2842 /* Default to cluster size, if available: */
2843 granularity = bdrv_get_default_bitmap_granularity(bs);
2846 if (!has_persistent) {
2847 persistent = false;
2850 if (has_autoload) {
2851 warn_report("Autoload option is deprecated and its value is ignored");
2854 if (!has_disabled) {
2855 disabled = false;
2858 if (persistent) {
2859 aio_context = bdrv_get_aio_context(bs);
2860 aio_context_acquire(aio_context);
2861 if (!bdrv_can_store_new_dirty_bitmap(bs, name, granularity, errp)) {
2862 goto out;
2866 bitmap = bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2867 if (bitmap == NULL) {
2868 goto out;
2871 if (disabled) {
2872 bdrv_disable_dirty_bitmap(bitmap);
2875 bdrv_dirty_bitmap_set_persistance(bitmap, persistent);
2876 out:
2877 if (aio_context) {
2878 aio_context_release(aio_context);
2882 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2883 Error **errp)
2885 BlockDriverState *bs;
2886 BdrvDirtyBitmap *bitmap;
2887 Error *local_err = NULL;
2888 AioContext *aio_context = NULL;
2890 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2891 if (!bitmap || !bs) {
2892 return;
2895 if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2896 error_setg(errp,
2897 "Bitmap '%s' is currently in use by another operation and"
2898 " cannot be removed", name);
2899 return;
2902 if (bdrv_dirty_bitmap_get_persistance(bitmap)) {
2903 aio_context = bdrv_get_aio_context(bs);
2904 aio_context_acquire(aio_context);
2905 bdrv_remove_persistent_dirty_bitmap(bs, name, &local_err);
2906 if (local_err != NULL) {
2907 error_propagate(errp, local_err);
2908 goto out;
2912 bdrv_release_dirty_bitmap(bs, bitmap);
2913 out:
2914 if (aio_context) {
2915 aio_context_release(aio_context);
2920 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2921 * immediately after a full backup operation.
2923 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2924 Error **errp)
2926 BdrvDirtyBitmap *bitmap;
2927 BlockDriverState *bs;
2929 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2930 if (!bitmap || !bs) {
2931 return;
2934 if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2935 error_setg(errp,
2936 "Bitmap '%s' is currently in use by another operation"
2937 " and cannot be cleared", name);
2938 return;
2939 } else if (bdrv_dirty_bitmap_readonly(bitmap)) {
2940 error_setg(errp, "Bitmap '%s' is readonly and cannot be cleared", name);
2941 return;
2944 bdrv_clear_dirty_bitmap(bitmap, NULL);
2947 void qmp_block_dirty_bitmap_enable(const char *node, const char *name,
2948 Error **errp)
2950 BlockDriverState *bs;
2951 BdrvDirtyBitmap *bitmap;
2953 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2954 if (!bitmap) {
2955 return;
2958 if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2959 error_setg(errp,
2960 "Bitmap '%s' is currently in use by another operation"
2961 " and cannot be enabled", name);
2962 return;
2965 bdrv_enable_dirty_bitmap(bitmap);
2968 void qmp_block_dirty_bitmap_disable(const char *node, const char *name,
2969 Error **errp)
2971 BlockDriverState *bs;
2972 BdrvDirtyBitmap *bitmap;
2974 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2975 if (!bitmap) {
2976 return;
2979 if (bdrv_dirty_bitmap_user_locked(bitmap)) {
2980 error_setg(errp,
2981 "Bitmap '%s' is currently in use by another operation"
2982 " and cannot be disabled", name);
2983 return;
2986 bdrv_disable_dirty_bitmap(bitmap);
2989 static BdrvDirtyBitmap *do_block_dirty_bitmap_merge(const char *node,
2990 const char *target,
2991 strList *bitmaps,
2992 HBitmap **backup,
2993 Error **errp)
2995 BlockDriverState *bs;
2996 BdrvDirtyBitmap *dst, *src, *anon;
2997 strList *lst;
2998 Error *local_err = NULL;
3000 dst = block_dirty_bitmap_lookup(node, target, &bs, errp);
3001 if (!dst) {
3002 return NULL;
3005 anon = bdrv_create_dirty_bitmap(bs, bdrv_dirty_bitmap_granularity(dst),
3006 NULL, errp);
3007 if (!anon) {
3008 return NULL;
3011 for (lst = bitmaps; lst; lst = lst->next) {
3012 src = bdrv_find_dirty_bitmap(bs, lst->value);
3013 if (!src) {
3014 error_setg(errp, "Dirty bitmap '%s' not found", lst->value);
3015 dst = NULL;
3016 goto out;
3019 bdrv_merge_dirty_bitmap(anon, src, NULL, &local_err);
3020 if (local_err) {
3021 error_propagate(errp, local_err);
3022 dst = NULL;
3023 goto out;
3027 /* Merge into dst; dst is unchanged on failure. */
3028 bdrv_merge_dirty_bitmap(dst, anon, backup, errp);
3030 out:
3031 bdrv_release_dirty_bitmap(bs, anon);
3032 return dst;
3035 void qmp_block_dirty_bitmap_merge(const char *node, const char *target,
3036 strList *bitmaps, Error **errp)
3038 do_block_dirty_bitmap_merge(node, target, bitmaps, NULL, errp);
3041 BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
3042 const char *name,
3043 Error **errp)
3045 BdrvDirtyBitmap *bitmap;
3046 BlockDriverState *bs;
3047 BlockDirtyBitmapSha256 *ret = NULL;
3048 char *sha256;
3050 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
3051 if (!bitmap || !bs) {
3052 return NULL;
3055 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
3056 if (sha256 == NULL) {
3057 return NULL;
3060 ret = g_new(BlockDirtyBitmapSha256, 1);
3061 ret->sha256 = sha256;
3063 return ret;
3066 void hmp_drive_del(Monitor *mon, const QDict *qdict)
3068 const char *id = qdict_get_str(qdict, "id");
3069 BlockBackend *blk;
3070 BlockDriverState *bs;
3071 AioContext *aio_context;
3072 Error *local_err = NULL;
3074 bs = bdrv_find_node(id);
3075 if (bs) {
3076 qmp_blockdev_del(id, &local_err);
3077 if (local_err) {
3078 error_report_err(local_err);
3080 return;
3083 blk = blk_by_name(id);
3084 if (!blk) {
3085 error_report("Device '%s' not found", id);
3086 return;
3089 if (!blk_legacy_dinfo(blk)) {
3090 error_report("Deleting device added with blockdev-add"
3091 " is not supported");
3092 return;
3095 aio_context = blk_get_aio_context(blk);
3096 aio_context_acquire(aio_context);
3098 bs = blk_bs(blk);
3099 if (bs) {
3100 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
3101 error_report_err(local_err);
3102 aio_context_release(aio_context);
3103 return;
3106 blk_remove_bs(blk);
3109 /* Make the BlockBackend and the attached BlockDriverState anonymous */
3110 monitor_remove_blk(blk);
3112 /* If this BlockBackend has a device attached to it, its refcount will be
3113 * decremented when the device is removed; otherwise we have to do so here.
3115 if (blk_get_attached_dev(blk)) {
3116 /* Further I/O must not pause the guest */
3117 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
3118 BLOCKDEV_ON_ERROR_REPORT);
3119 } else {
3120 blk_unref(blk);
3123 aio_context_release(aio_context);
3126 void qmp_block_resize(bool has_device, const char *device,
3127 bool has_node_name, const char *node_name,
3128 int64_t size, Error **errp)
3130 Error *local_err = NULL;
3131 BlockBackend *blk = NULL;
3132 BlockDriverState *bs;
3133 AioContext *aio_context;
3134 int ret;
3136 bs = bdrv_lookup_bs(has_device ? device : NULL,
3137 has_node_name ? node_name : NULL,
3138 &local_err);
3139 if (local_err) {
3140 error_propagate(errp, local_err);
3141 return;
3144 aio_context = bdrv_get_aio_context(bs);
3145 aio_context_acquire(aio_context);
3147 if (!bdrv_is_first_non_filter(bs)) {
3148 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
3149 goto out;
3152 if (size < 0) {
3153 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
3154 goto out;
3157 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
3158 error_setg(errp, QERR_DEVICE_IN_USE, device);
3159 goto out;
3162 blk = blk_new(BLK_PERM_RESIZE, BLK_PERM_ALL);
3163 ret = blk_insert_bs(blk, bs, errp);
3164 if (ret < 0) {
3165 goto out;
3168 bdrv_drained_begin(bs);
3169 ret = blk_truncate(blk, size, PREALLOC_MODE_OFF, errp);
3170 bdrv_drained_end(bs);
3172 out:
3173 blk_unref(blk);
3174 aio_context_release(aio_context);
3177 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
3178 bool has_base, const char *base,
3179 bool has_base_node, const char *base_node,
3180 bool has_backing_file, const char *backing_file,
3181 bool has_speed, int64_t speed,
3182 bool has_on_error, BlockdevOnError on_error,
3183 bool has_auto_finalize, bool auto_finalize,
3184 bool has_auto_dismiss, bool auto_dismiss,
3185 Error **errp)
3187 BlockDriverState *bs, *iter;
3188 BlockDriverState *base_bs = NULL;
3189 AioContext *aio_context;
3190 Error *local_err = NULL;
3191 const char *base_name = NULL;
3192 int job_flags = JOB_DEFAULT;
3194 if (!has_on_error) {
3195 on_error = BLOCKDEV_ON_ERROR_REPORT;
3198 bs = bdrv_lookup_bs(device, device, errp);
3199 if (!bs) {
3200 return;
3203 aio_context = bdrv_get_aio_context(bs);
3204 aio_context_acquire(aio_context);
3206 if (has_base && has_base_node) {
3207 error_setg(errp, "'base' and 'base-node' cannot be specified "
3208 "at the same time");
3209 goto out;
3212 if (has_base) {
3213 base_bs = bdrv_find_backing_image(bs, base);
3214 if (base_bs == NULL) {
3215 error_setg(errp, QERR_BASE_NOT_FOUND, base);
3216 goto out;
3218 assert(bdrv_get_aio_context(base_bs) == aio_context);
3219 base_name = base;
3222 if (has_base_node) {
3223 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3224 if (!base_bs) {
3225 goto out;
3227 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
3228 error_setg(errp, "Node '%s' is not a backing image of '%s'",
3229 base_node, device);
3230 goto out;
3232 assert(bdrv_get_aio_context(base_bs) == aio_context);
3233 base_name = base_bs->filename;
3236 /* Check for op blockers in the whole chain between bs and base */
3237 for (iter = bs; iter && iter != base_bs; iter = backing_bs(iter)) {
3238 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
3239 goto out;
3243 /* if we are streaming the entire chain, the result will have no backing
3244 * file, and specifying one is therefore an error */
3245 if (base_bs == NULL && has_backing_file) {
3246 error_setg(errp, "backing file specified, but streaming the "
3247 "entire chain");
3248 goto out;
3251 /* backing_file string overrides base bs filename */
3252 base_name = has_backing_file ? backing_file : base_name;
3254 if (has_auto_finalize && !auto_finalize) {
3255 job_flags |= JOB_MANUAL_FINALIZE;
3257 if (has_auto_dismiss && !auto_dismiss) {
3258 job_flags |= JOB_MANUAL_DISMISS;
3261 stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
3262 job_flags, has_speed ? speed : 0, on_error, &local_err);
3263 if (local_err) {
3264 error_propagate(errp, local_err);
3265 goto out;
3268 trace_qmp_block_stream(bs, bs->job);
3270 out:
3271 aio_context_release(aio_context);
3274 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3275 bool has_base_node, const char *base_node,
3276 bool has_base, const char *base,
3277 bool has_top_node, const char *top_node,
3278 bool has_top, const char *top,
3279 bool has_backing_file, const char *backing_file,
3280 bool has_speed, int64_t speed,
3281 bool has_filter_node_name, const char *filter_node_name,
3282 bool has_auto_finalize, bool auto_finalize,
3283 bool has_auto_dismiss, bool auto_dismiss,
3284 Error **errp)
3286 BlockDriverState *bs;
3287 BlockDriverState *iter;
3288 BlockDriverState *base_bs, *top_bs;
3289 AioContext *aio_context;
3290 Error *local_err = NULL;
3291 /* This will be part of the QMP command, if/when the
3292 * BlockdevOnError change for blkmirror makes it in
3294 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3295 int job_flags = JOB_DEFAULT;
3297 if (!has_speed) {
3298 speed = 0;
3300 if (!has_filter_node_name) {
3301 filter_node_name = NULL;
3303 if (has_auto_finalize && !auto_finalize) {
3304 job_flags |= JOB_MANUAL_FINALIZE;
3306 if (has_auto_dismiss && !auto_dismiss) {
3307 job_flags |= JOB_MANUAL_DISMISS;
3310 /* Important Note:
3311 * libvirt relies on the DeviceNotFound error class in order to probe for
3312 * live commit feature versions; for this to work, we must make sure to
3313 * perform the device lookup before any generic errors that may occur in a
3314 * scenario in which all optional arguments are omitted. */
3315 bs = qmp_get_root_bs(device, &local_err);
3316 if (!bs) {
3317 bs = bdrv_lookup_bs(device, device, NULL);
3318 if (!bs) {
3319 error_free(local_err);
3320 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3321 "Device '%s' not found", device);
3322 } else {
3323 error_propagate(errp, local_err);
3325 return;
3328 aio_context = bdrv_get_aio_context(bs);
3329 aio_context_acquire(aio_context);
3331 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3332 goto out;
3335 /* default top_bs is the active layer */
3336 top_bs = bs;
3338 if (has_top_node && has_top) {
3339 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
3340 goto out;
3341 } else if (has_top_node) {
3342 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
3343 if (top_bs == NULL) {
3344 goto out;
3346 if (!bdrv_chain_contains(bs, top_bs)) {
3347 error_setg(errp, "'%s' is not in this backing file chain",
3348 top_node);
3349 goto out;
3351 } else if (has_top && top) {
3352 if (strcmp(bs->filename, top) != 0) {
3353 top_bs = bdrv_find_backing_image(bs, top);
3357 if (top_bs == NULL) {
3358 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3359 goto out;
3362 assert(bdrv_get_aio_context(top_bs) == aio_context);
3364 if (has_base_node && has_base) {
3365 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
3366 goto out;
3367 } else if (has_base_node) {
3368 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3369 if (base_bs == NULL) {
3370 goto out;
3372 if (!bdrv_chain_contains(top_bs, base_bs)) {
3373 error_setg(errp, "'%s' is not in this backing file chain",
3374 base_node);
3375 goto out;
3377 } else if (has_base && base) {
3378 base_bs = bdrv_find_backing_image(top_bs, base);
3379 } else {
3380 base_bs = bdrv_find_base(top_bs);
3383 if (base_bs == NULL) {
3384 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3385 goto out;
3388 assert(bdrv_get_aio_context(base_bs) == aio_context);
3390 for (iter = top_bs; iter != backing_bs(base_bs); iter = backing_bs(iter)) {
3391 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3392 goto out;
3396 /* Do not allow attempts to commit an image into itself */
3397 if (top_bs == base_bs) {
3398 error_setg(errp, "cannot commit an image into itself");
3399 goto out;
3402 if (top_bs == bs) {
3403 if (has_backing_file) {
3404 error_setg(errp, "'backing-file' specified,"
3405 " but 'top' is the active layer");
3406 goto out;
3408 commit_active_start(has_job_id ? job_id : NULL, bs, base_bs,
3409 job_flags, speed, on_error,
3410 filter_node_name, NULL, NULL, false, &local_err);
3411 } else {
3412 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
3413 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3414 goto out;
3416 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
3417 speed, on_error, has_backing_file ? backing_file : NULL,
3418 filter_node_name, &local_err);
3420 if (local_err != NULL) {
3421 error_propagate(errp, local_err);
3422 goto out;
3425 out:
3426 aio_context_release(aio_context);
3429 static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
3430 Error **errp)
3432 BlockDriverState *bs;
3433 BlockDriverState *target_bs;
3434 BlockDriverState *source = NULL;
3435 BlockJob *job = NULL;
3436 BdrvDirtyBitmap *bmap = NULL;
3437 AioContext *aio_context;
3438 QDict *options = NULL;
3439 Error *local_err = NULL;
3440 int flags, job_flags = JOB_DEFAULT;
3441 int64_t size;
3442 bool set_backing_hd = false;
3444 if (!backup->has_speed) {
3445 backup->speed = 0;
3447 if (!backup->has_on_source_error) {
3448 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3450 if (!backup->has_on_target_error) {
3451 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3453 if (!backup->has_mode) {
3454 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3456 if (!backup->has_job_id) {
3457 backup->job_id = NULL;
3459 if (!backup->has_auto_finalize) {
3460 backup->auto_finalize = true;
3462 if (!backup->has_auto_dismiss) {
3463 backup->auto_dismiss = true;
3465 if (!backup->has_compress) {
3466 backup->compress = false;
3469 bs = qmp_get_root_bs(backup->device, errp);
3470 if (!bs) {
3471 return NULL;
3474 aio_context = bdrv_get_aio_context(bs);
3475 aio_context_acquire(aio_context);
3477 if (!backup->has_format) {
3478 backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
3479 NULL : (char*) bs->drv->format_name;
3482 /* Early check to avoid creating target */
3483 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3484 goto out;
3487 flags = bs->open_flags | BDRV_O_RDWR;
3489 /* See if we have a backing HD we can use to create our new image
3490 * on top of. */
3491 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3492 source = backing_bs(bs);
3493 if (!source) {
3494 backup->sync = MIRROR_SYNC_MODE_FULL;
3497 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3498 source = bs;
3499 flags |= BDRV_O_NO_BACKING;
3500 set_backing_hd = true;
3503 size = bdrv_getlength(bs);
3504 if (size < 0) {
3505 error_setg_errno(errp, -size, "bdrv_getlength failed");
3506 goto out;
3509 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
3510 assert(backup->format);
3511 if (source) {
3512 bdrv_img_create(backup->target, backup->format, source->filename,
3513 source->drv->format_name, NULL,
3514 size, flags, false, &local_err);
3515 } else {
3516 bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3517 size, flags, false, &local_err);
3521 if (local_err) {
3522 error_propagate(errp, local_err);
3523 goto out;
3526 if (backup->format) {
3527 if (!options) {
3528 options = qdict_new();
3530 qdict_put_str(options, "driver", backup->format);
3533 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
3534 if (!target_bs) {
3535 goto out;
3538 bdrv_set_aio_context(target_bs, aio_context);
3540 if (set_backing_hd) {
3541 bdrv_set_backing_hd(target_bs, source, &local_err);
3542 if (local_err) {
3543 bdrv_unref(target_bs);
3544 goto out;
3548 if (backup->has_bitmap) {
3549 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3550 if (!bmap) {
3551 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3552 bdrv_unref(target_bs);
3553 goto out;
3555 if (bdrv_dirty_bitmap_user_locked(bmap)) {
3556 error_setg(errp,
3557 "Bitmap '%s' is currently in use by another operation"
3558 " and cannot be used for backup", backup->bitmap);
3559 goto out;
3562 if (!backup->auto_finalize) {
3563 job_flags |= JOB_MANUAL_FINALIZE;
3565 if (!backup->auto_dismiss) {
3566 job_flags |= JOB_MANUAL_DISMISS;
3569 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3570 backup->sync, bmap, backup->compress,
3571 backup->on_source_error, backup->on_target_error,
3572 job_flags, NULL, NULL, txn, &local_err);
3573 bdrv_unref(target_bs);
3574 if (local_err != NULL) {
3575 error_propagate(errp, local_err);
3576 goto out;
3579 out:
3580 aio_context_release(aio_context);
3581 return job;
3584 void qmp_drive_backup(DriveBackup *arg, Error **errp)
3587 BlockJob *job;
3588 job = do_drive_backup(arg, NULL, errp);
3589 if (job) {
3590 job_start(&job->job);
3594 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3596 return bdrv_named_nodes_list(errp);
3599 XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
3601 return bdrv_get_xdbg_block_graph(errp);
3604 BlockJob *do_blockdev_backup(BlockdevBackup *backup, JobTxn *txn,
3605 Error **errp)
3607 BlockDriverState *bs;
3608 BlockDriverState *target_bs;
3609 Error *local_err = NULL;
3610 BdrvDirtyBitmap *bmap = NULL;
3611 AioContext *aio_context;
3612 BlockJob *job = NULL;
3613 int job_flags = JOB_DEFAULT;
3615 if (!backup->has_speed) {
3616 backup->speed = 0;
3618 if (!backup->has_on_source_error) {
3619 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3621 if (!backup->has_on_target_error) {
3622 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3624 if (!backup->has_job_id) {
3625 backup->job_id = NULL;
3627 if (!backup->has_auto_finalize) {
3628 backup->auto_finalize = true;
3630 if (!backup->has_auto_dismiss) {
3631 backup->auto_dismiss = true;
3633 if (!backup->has_compress) {
3634 backup->compress = false;
3637 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
3638 if (!bs) {
3639 return NULL;
3642 aio_context = bdrv_get_aio_context(bs);
3643 aio_context_acquire(aio_context);
3645 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
3646 if (!target_bs) {
3647 goto out;
3650 if (bdrv_get_aio_context(target_bs) != aio_context) {
3651 if (!bdrv_has_blk(target_bs)) {
3652 /* The target BDS is not attached, we can safely move it to another
3653 * AioContext. */
3654 bdrv_set_aio_context(target_bs, aio_context);
3655 } else {
3656 error_setg(errp, "Target is attached to a different thread from "
3657 "source.");
3658 goto out;
3662 if (backup->has_bitmap) {
3663 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3664 if (!bmap) {
3665 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3666 goto out;
3668 if (bdrv_dirty_bitmap_user_locked(bmap)) {
3669 error_setg(errp,
3670 "Bitmap '%s' is currently in use by another operation"
3671 " and cannot be used for backup", backup->bitmap);
3672 goto out;
3676 if (!backup->auto_finalize) {
3677 job_flags |= JOB_MANUAL_FINALIZE;
3679 if (!backup->auto_dismiss) {
3680 job_flags |= JOB_MANUAL_DISMISS;
3682 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3683 backup->sync, bmap, backup->compress,
3684 backup->on_source_error, backup->on_target_error,
3685 job_flags, NULL, NULL, txn, &local_err);
3686 if (local_err != NULL) {
3687 error_propagate(errp, local_err);
3689 out:
3690 aio_context_release(aio_context);
3691 return job;
3694 void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
3696 BlockJob *job;
3697 job = do_blockdev_backup(arg, NULL, errp);
3698 if (job) {
3699 job_start(&job->job);
3703 /* Parameter check and block job starting for drive mirroring.
3704 * Caller should hold @device and @target's aio context (must be the same).
3706 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3707 BlockDriverState *target,
3708 bool has_replaces, const char *replaces,
3709 enum MirrorSyncMode sync,
3710 BlockMirrorBackingMode backing_mode,
3711 bool has_speed, int64_t speed,
3712 bool has_granularity, uint32_t granularity,
3713 bool has_buf_size, int64_t buf_size,
3714 bool has_on_source_error,
3715 BlockdevOnError on_source_error,
3716 bool has_on_target_error,
3717 BlockdevOnError on_target_error,
3718 bool has_unmap, bool unmap,
3719 bool has_filter_node_name,
3720 const char *filter_node_name,
3721 bool has_copy_mode, MirrorCopyMode copy_mode,
3722 bool has_auto_finalize, bool auto_finalize,
3723 bool has_auto_dismiss, bool auto_dismiss,
3724 Error **errp)
3726 int job_flags = JOB_DEFAULT;
3728 if (!has_speed) {
3729 speed = 0;
3731 if (!has_on_source_error) {
3732 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3734 if (!has_on_target_error) {
3735 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3737 if (!has_granularity) {
3738 granularity = 0;
3740 if (!has_buf_size) {
3741 buf_size = 0;
3743 if (!has_unmap) {
3744 unmap = true;
3746 if (!has_filter_node_name) {
3747 filter_node_name = NULL;
3749 if (!has_copy_mode) {
3750 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
3752 if (has_auto_finalize && !auto_finalize) {
3753 job_flags |= JOB_MANUAL_FINALIZE;
3755 if (has_auto_dismiss && !auto_dismiss) {
3756 job_flags |= JOB_MANUAL_DISMISS;
3759 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3760 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3761 "a value in range [512B, 64MB]");
3762 return;
3764 if (granularity & (granularity - 1)) {
3765 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3766 "power of 2");
3767 return;
3770 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3771 return;
3773 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3774 return;
3777 if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3778 sync = MIRROR_SYNC_MODE_FULL;
3781 /* pass the node name to replace to mirror start since it's loose coupling
3782 * and will allow to check whether the node still exist at mirror completion
3784 mirror_start(job_id, bs, target,
3785 has_replaces ? replaces : NULL, job_flags,
3786 speed, granularity, buf_size, sync, backing_mode,
3787 on_source_error, on_target_error, unmap, filter_node_name,
3788 copy_mode, errp);
3791 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3793 BlockDriverState *bs;
3794 BlockDriverState *source, *target_bs;
3795 AioContext *aio_context;
3796 BlockMirrorBackingMode backing_mode;
3797 Error *local_err = NULL;
3798 QDict *options = NULL;
3799 int flags;
3800 int64_t size;
3801 const char *format = arg->format;
3803 bs = qmp_get_root_bs(arg->device, errp);
3804 if (!bs) {
3805 return;
3808 /* Early check to avoid creating target */
3809 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3810 return;
3813 aio_context = bdrv_get_aio_context(bs);
3814 aio_context_acquire(aio_context);
3816 if (!arg->has_mode) {
3817 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3820 if (!arg->has_format) {
3821 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3822 ? NULL : bs->drv->format_name);
3825 flags = bs->open_flags | BDRV_O_RDWR;
3826 source = backing_bs(bs);
3827 if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3828 arg->sync = MIRROR_SYNC_MODE_FULL;
3830 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3831 source = bs;
3834 size = bdrv_getlength(bs);
3835 if (size < 0) {
3836 error_setg_errno(errp, -size, "bdrv_getlength failed");
3837 goto out;
3840 if (arg->has_replaces) {
3841 BlockDriverState *to_replace_bs;
3842 AioContext *replace_aio_context;
3843 int64_t replace_size;
3845 if (!arg->has_node_name) {
3846 error_setg(errp, "a node-name must be provided when replacing a"
3847 " named node of the graph");
3848 goto out;
3851 to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3853 if (!to_replace_bs) {
3854 error_propagate(errp, local_err);
3855 goto out;
3858 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3859 aio_context_acquire(replace_aio_context);
3860 replace_size = bdrv_getlength(to_replace_bs);
3861 aio_context_release(replace_aio_context);
3863 if (size != replace_size) {
3864 error_setg(errp, "cannot replace image with a mirror image of "
3865 "different size");
3866 goto out;
3870 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3871 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3872 } else {
3873 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3876 /* Don't open backing image in create() */
3877 flags |= BDRV_O_NO_BACKING;
3879 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3880 && arg->mode != NEW_IMAGE_MODE_EXISTING)
3882 /* create new image w/o backing file */
3883 assert(format);
3884 bdrv_img_create(arg->target, format,
3885 NULL, NULL, NULL, size, flags, false, &local_err);
3886 } else {
3887 switch (arg->mode) {
3888 case NEW_IMAGE_MODE_EXISTING:
3889 break;
3890 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3891 /* create new image with backing file */
3892 bdrv_img_create(arg->target, format,
3893 source->filename,
3894 source->drv->format_name,
3895 NULL, size, flags, false, &local_err);
3896 break;
3897 default:
3898 abort();
3902 if (local_err) {
3903 error_propagate(errp, local_err);
3904 goto out;
3907 options = qdict_new();
3908 if (arg->has_node_name) {
3909 qdict_put_str(options, "node-name", arg->node_name);
3911 if (format) {
3912 qdict_put_str(options, "driver", format);
3915 /* Mirroring takes care of copy-on-write using the source's backing
3916 * file.
3918 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
3919 if (!target_bs) {
3920 goto out;
3923 bdrv_set_aio_context(target_bs, aio_context);
3925 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3926 arg->has_replaces, arg->replaces, arg->sync,
3927 backing_mode, arg->has_speed, arg->speed,
3928 arg->has_granularity, arg->granularity,
3929 arg->has_buf_size, arg->buf_size,
3930 arg->has_on_source_error, arg->on_source_error,
3931 arg->has_on_target_error, arg->on_target_error,
3932 arg->has_unmap, arg->unmap,
3933 false, NULL,
3934 arg->has_copy_mode, arg->copy_mode,
3935 arg->has_auto_finalize, arg->auto_finalize,
3936 arg->has_auto_dismiss, arg->auto_dismiss,
3937 &local_err);
3938 bdrv_unref(target_bs);
3939 error_propagate(errp, local_err);
3940 out:
3941 aio_context_release(aio_context);
3944 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3945 const char *device, const char *target,
3946 bool has_replaces, const char *replaces,
3947 MirrorSyncMode sync,
3948 bool has_speed, int64_t speed,
3949 bool has_granularity, uint32_t granularity,
3950 bool has_buf_size, int64_t buf_size,
3951 bool has_on_source_error,
3952 BlockdevOnError on_source_error,
3953 bool has_on_target_error,
3954 BlockdevOnError on_target_error,
3955 bool has_filter_node_name,
3956 const char *filter_node_name,
3957 bool has_copy_mode, MirrorCopyMode copy_mode,
3958 bool has_auto_finalize, bool auto_finalize,
3959 bool has_auto_dismiss, bool auto_dismiss,
3960 Error **errp)
3962 BlockDriverState *bs;
3963 BlockDriverState *target_bs;
3964 AioContext *aio_context;
3965 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3966 Error *local_err = NULL;
3968 bs = qmp_get_root_bs(device, errp);
3969 if (!bs) {
3970 return;
3973 target_bs = bdrv_lookup_bs(target, target, errp);
3974 if (!target_bs) {
3975 return;
3978 aio_context = bdrv_get_aio_context(bs);
3979 aio_context_acquire(aio_context);
3981 bdrv_set_aio_context(target_bs, aio_context);
3983 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3984 has_replaces, replaces, sync, backing_mode,
3985 has_speed, speed,
3986 has_granularity, granularity,
3987 has_buf_size, buf_size,
3988 has_on_source_error, on_source_error,
3989 has_on_target_error, on_target_error,
3990 true, true,
3991 has_filter_node_name, filter_node_name,
3992 has_copy_mode, copy_mode,
3993 has_auto_finalize, auto_finalize,
3994 has_auto_dismiss, auto_dismiss,
3995 &local_err);
3996 error_propagate(errp, local_err);
3998 aio_context_release(aio_context);
4001 /* Get a block job using its ID and acquire its AioContext */
4002 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
4003 Error **errp)
4005 BlockJob *job;
4007 assert(id != NULL);
4009 *aio_context = NULL;
4011 job = block_job_get(id);
4013 if (!job) {
4014 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
4015 "Block job '%s' not found", id);
4016 return NULL;
4019 *aio_context = blk_get_aio_context(job->blk);
4020 aio_context_acquire(*aio_context);
4022 return job;
4025 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
4027 AioContext *aio_context;
4028 BlockJob *job = find_block_job(device, &aio_context, errp);
4030 if (!job) {
4031 return;
4034 block_job_set_speed(job, speed, errp);
4035 aio_context_release(aio_context);
4038 void qmp_block_job_cancel(const char *device,
4039 bool has_force, bool force, Error **errp)
4041 AioContext *aio_context;
4042 BlockJob *job = find_block_job(device, &aio_context, errp);
4044 if (!job) {
4045 return;
4048 if (!has_force) {
4049 force = false;
4052 if (job_user_paused(&job->job) && !force) {
4053 error_setg(errp, "The block job for device '%s' is currently paused",
4054 device);
4055 goto out;
4058 trace_qmp_block_job_cancel(job);
4059 job_user_cancel(&job->job, force, errp);
4060 out:
4061 aio_context_release(aio_context);
4064 void qmp_block_job_pause(const char *device, Error **errp)
4066 AioContext *aio_context;
4067 BlockJob *job = find_block_job(device, &aio_context, errp);
4069 if (!job) {
4070 return;
4073 trace_qmp_block_job_pause(job);
4074 job_user_pause(&job->job, errp);
4075 aio_context_release(aio_context);
4078 void qmp_block_job_resume(const char *device, Error **errp)
4080 AioContext *aio_context;
4081 BlockJob *job = find_block_job(device, &aio_context, errp);
4083 if (!job) {
4084 return;
4087 trace_qmp_block_job_resume(job);
4088 job_user_resume(&job->job, errp);
4089 aio_context_release(aio_context);
4092 void qmp_block_job_complete(const char *device, Error **errp)
4094 AioContext *aio_context;
4095 BlockJob *job = find_block_job(device, &aio_context, errp);
4097 if (!job) {
4098 return;
4101 trace_qmp_block_job_complete(job);
4102 job_complete(&job->job, errp);
4103 aio_context_release(aio_context);
4106 void qmp_block_job_finalize(const char *id, Error **errp)
4108 AioContext *aio_context;
4109 BlockJob *job = find_block_job(id, &aio_context, errp);
4111 if (!job) {
4112 return;
4115 trace_qmp_block_job_finalize(job);
4116 job_finalize(&job->job, errp);
4117 aio_context_release(aio_context);
4120 void qmp_block_job_dismiss(const char *id, Error **errp)
4122 AioContext *aio_context;
4123 BlockJob *bjob = find_block_job(id, &aio_context, errp);
4124 Job *job;
4126 if (!bjob) {
4127 return;
4130 trace_qmp_block_job_dismiss(bjob);
4131 job = &bjob->job;
4132 job_dismiss(&job, errp);
4133 aio_context_release(aio_context);
4136 void qmp_change_backing_file(const char *device,
4137 const char *image_node_name,
4138 const char *backing_file,
4139 Error **errp)
4141 BlockDriverState *bs = NULL;
4142 AioContext *aio_context;
4143 BlockDriverState *image_bs = NULL;
4144 Error *local_err = NULL;
4145 bool ro;
4146 int ret;
4148 bs = qmp_get_root_bs(device, errp);
4149 if (!bs) {
4150 return;
4153 aio_context = bdrv_get_aio_context(bs);
4154 aio_context_acquire(aio_context);
4156 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
4157 if (local_err) {
4158 error_propagate(errp, local_err);
4159 goto out;
4162 if (!image_bs) {
4163 error_setg(errp, "image file not found");
4164 goto out;
4167 if (bdrv_find_base(image_bs) == image_bs) {
4168 error_setg(errp, "not allowing backing file change on an image "
4169 "without a backing file");
4170 goto out;
4173 /* even though we are not necessarily operating on bs, we need it to
4174 * determine if block ops are currently prohibited on the chain */
4175 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
4176 goto out;
4179 /* final sanity check */
4180 if (!bdrv_chain_contains(bs, image_bs)) {
4181 error_setg(errp, "'%s' and image file are not in the same chain",
4182 device);
4183 goto out;
4186 /* if not r/w, reopen to make r/w */
4187 ro = bdrv_is_read_only(image_bs);
4189 if (ro) {
4190 if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
4191 goto out;
4195 ret = bdrv_change_backing_file(image_bs, backing_file,
4196 image_bs->drv ? image_bs->drv->format_name : "");
4198 if (ret < 0) {
4199 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
4200 backing_file);
4201 /* don't exit here, so we can try to restore open flags if
4202 * appropriate */
4205 if (ro) {
4206 bdrv_reopen_set_read_only(image_bs, true, &local_err);
4207 error_propagate(errp, local_err);
4210 out:
4211 aio_context_release(aio_context);
4214 void hmp_drive_add_node(Monitor *mon, const char *optstr)
4216 QemuOpts *opts;
4217 QDict *qdict;
4218 Error *local_err = NULL;
4220 opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
4221 if (!opts) {
4222 return;
4225 qdict = qemu_opts_to_qdict(opts, NULL);
4227 if (!qdict_get_try_str(qdict, "node-name")) {
4228 qobject_unref(qdict);
4229 error_report("'node-name' needs to be specified");
4230 goto out;
4233 BlockDriverState *bs = bds_tree_init(qdict, &local_err);
4234 if (!bs) {
4235 error_report_err(local_err);
4236 goto out;
4239 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4241 out:
4242 qemu_opts_del(opts);
4245 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
4247 BlockDriverState *bs;
4248 QObject *obj;
4249 Visitor *v = qobject_output_visitor_new(&obj);
4250 QDict *qdict;
4251 Error *local_err = NULL;
4253 visit_type_BlockdevOptions(v, NULL, &options, &local_err);
4254 if (local_err) {
4255 error_propagate(errp, local_err);
4256 goto fail;
4259 visit_complete(v, &obj);
4260 qdict = qobject_to(QDict, obj);
4262 qdict_flatten(qdict);
4264 if (!qdict_get_try_str(qdict, "node-name")) {
4265 error_setg(errp, "'node-name' must be specified for the root node");
4266 goto fail;
4269 bs = bds_tree_init(qdict, errp);
4270 if (!bs) {
4271 goto fail;
4274 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4276 fail:
4277 visit_free(v);
4280 void qmp_blockdev_del(const char *node_name, Error **errp)
4282 AioContext *aio_context;
4283 BlockDriverState *bs;
4285 bs = bdrv_find_node(node_name);
4286 if (!bs) {
4287 error_setg(errp, "Cannot find node %s", node_name);
4288 return;
4290 if (bdrv_has_blk(bs)) {
4291 error_setg(errp, "Node %s is in use", node_name);
4292 return;
4294 aio_context = bdrv_get_aio_context(bs);
4295 aio_context_acquire(aio_context);
4297 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
4298 goto out;
4301 if (!QTAILQ_IN_USE(bs, monitor_list)) {
4302 error_setg(errp, "Node %s is not owned by the monitor",
4303 bs->node_name);
4304 goto out;
4307 if (bs->refcnt > 1) {
4308 error_setg(errp, "Block device %s is in use",
4309 bdrv_get_device_or_node_name(bs));
4310 goto out;
4313 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4314 bdrv_unref(bs);
4316 out:
4317 aio_context_release(aio_context);
4320 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
4321 const char *child_name)
4323 BdrvChild *child;
4325 QLIST_FOREACH(child, &parent_bs->children, next) {
4326 if (strcmp(child->name, child_name) == 0) {
4327 return child;
4331 return NULL;
4334 void qmp_x_blockdev_change(const char *parent, bool has_child,
4335 const char *child, bool has_node,
4336 const char *node, Error **errp)
4338 BlockDriverState *parent_bs, *new_bs = NULL;
4339 BdrvChild *p_child;
4341 parent_bs = bdrv_lookup_bs(parent, parent, errp);
4342 if (!parent_bs) {
4343 return;
4346 if (has_child == has_node) {
4347 if (has_child) {
4348 error_setg(errp, "The parameters child and node are in conflict");
4349 } else {
4350 error_setg(errp, "Either child or node must be specified");
4352 return;
4355 if (has_child) {
4356 p_child = bdrv_find_child(parent_bs, child);
4357 if (!p_child) {
4358 error_setg(errp, "Node '%s' does not have child '%s'",
4359 parent, child);
4360 return;
4362 bdrv_del_child(parent_bs, p_child, errp);
4365 if (has_node) {
4366 new_bs = bdrv_find_node(node);
4367 if (!new_bs) {
4368 error_setg(errp, "Node '%s' not found", node);
4369 return;
4371 bdrv_add_child(parent_bs, new_bs, errp);
4375 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4377 BlockJobInfoList *head = NULL, **p_next = &head;
4378 BlockJob *job;
4380 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
4381 BlockJobInfoList *elem;
4382 AioContext *aio_context;
4384 if (block_job_is_internal(job)) {
4385 continue;
4387 elem = g_new0(BlockJobInfoList, 1);
4388 aio_context = blk_get_aio_context(job->blk);
4389 aio_context_acquire(aio_context);
4390 elem->value = block_job_query(job, errp);
4391 aio_context_release(aio_context);
4392 if (!elem->value) {
4393 g_free(elem);
4394 qapi_free_BlockJobInfoList(head);
4395 return NULL;
4397 *p_next = elem;
4398 p_next = &elem->next;
4401 return head;
4404 void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
4405 bool has_force, bool force, Error **errp)
4407 AioContext *old_context;
4408 AioContext *new_context;
4409 BlockDriverState *bs;
4411 bs = bdrv_find_node(node_name);
4412 if (!bs) {
4413 error_setg(errp, "Cannot find node %s", node_name);
4414 return;
4417 /* Protects against accidents. */
4418 if (!(has_force && force) && bdrv_has_blk(bs)) {
4419 error_setg(errp, "Node %s is associated with a BlockBackend and could "
4420 "be in use (use force=true to override this check)",
4421 node_name);
4422 return;
4425 if (iothread->type == QTYPE_QSTRING) {
4426 IOThread *obj = iothread_by_id(iothread->u.s);
4427 if (!obj) {
4428 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
4429 return;
4432 new_context = iothread_get_aio_context(obj);
4433 } else {
4434 new_context = qemu_get_aio_context();
4437 old_context = bdrv_get_aio_context(bs);
4438 aio_context_acquire(old_context);
4440 bdrv_set_aio_context(bs, new_context);
4442 aio_context_release(old_context);
4445 void qmp_x_block_latency_histogram_set(
4446 const char *device,
4447 bool has_boundaries, uint64List *boundaries,
4448 bool has_boundaries_read, uint64List *boundaries_read,
4449 bool has_boundaries_write, uint64List *boundaries_write,
4450 bool has_boundaries_flush, uint64List *boundaries_flush,
4451 Error **errp)
4453 BlockBackend *blk = blk_by_name(device);
4454 BlockAcctStats *stats;
4455 int ret;
4457 if (!blk) {
4458 error_setg(errp, "Device '%s' not found", device);
4459 return;
4461 stats = blk_get_stats(blk);
4463 if (!has_boundaries && !has_boundaries_read && !has_boundaries_write &&
4464 !has_boundaries_flush)
4466 block_latency_histograms_clear(stats);
4467 return;
4470 if (has_boundaries || has_boundaries_read) {
4471 ret = block_latency_histogram_set(
4472 stats, BLOCK_ACCT_READ,
4473 has_boundaries_read ? boundaries_read : boundaries);
4474 if (ret) {
4475 error_setg(errp, "Device '%s' set read boundaries fail", device);
4476 return;
4480 if (has_boundaries || has_boundaries_write) {
4481 ret = block_latency_histogram_set(
4482 stats, BLOCK_ACCT_WRITE,
4483 has_boundaries_write ? boundaries_write : boundaries);
4484 if (ret) {
4485 error_setg(errp, "Device '%s' set write boundaries fail", device);
4486 return;
4490 if (has_boundaries || has_boundaries_flush) {
4491 ret = block_latency_histogram_set(
4492 stats, BLOCK_ACCT_FLUSH,
4493 has_boundaries_flush ? boundaries_flush : boundaries);
4494 if (ret) {
4495 error_setg(errp, "Device '%s' set flush boundaries fail", device);
4496 return;
4501 QemuOptsList qemu_common_drive_opts = {
4502 .name = "drive",
4503 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4504 .desc = {
4506 .name = "snapshot",
4507 .type = QEMU_OPT_BOOL,
4508 .help = "enable/disable snapshot mode",
4510 .name = "aio",
4511 .type = QEMU_OPT_STRING,
4512 .help = "host AIO implementation (threads, native)",
4514 .name = BDRV_OPT_CACHE_WB,
4515 .type = QEMU_OPT_BOOL,
4516 .help = "Enable writeback mode",
4518 .name = "format",
4519 .type = QEMU_OPT_STRING,
4520 .help = "disk format (raw, qcow2, ...)",
4522 .name = "rerror",
4523 .type = QEMU_OPT_STRING,
4524 .help = "read error action",
4526 .name = "werror",
4527 .type = QEMU_OPT_STRING,
4528 .help = "write error action",
4530 .name = BDRV_OPT_READ_ONLY,
4531 .type = QEMU_OPT_BOOL,
4532 .help = "open drive file as read-only",
4535 THROTTLE_OPTS,
4538 .name = "throttling.group",
4539 .type = QEMU_OPT_STRING,
4540 .help = "name of the block throttling group",
4542 .name = "copy-on-read",
4543 .type = QEMU_OPT_BOOL,
4544 .help = "copy read data from backing file into image file",
4546 .name = "detect-zeroes",
4547 .type = QEMU_OPT_STRING,
4548 .help = "try to optimize zero writes (off, on, unmap)",
4550 .name = "stats-account-invalid",
4551 .type = QEMU_OPT_BOOL,
4552 .help = "whether to account for invalid I/O operations "
4553 "in the statistics",
4555 .name = "stats-account-failed",
4556 .type = QEMU_OPT_BOOL,
4557 .help = "whether to account for failed I/O operations "
4558 "in the statistics",
4560 { /* end of list */ }
4564 QemuOptsList qemu_drive_opts = {
4565 .name = "drive",
4566 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4567 .desc = {
4569 * no elements => accept any params
4570 * validation will happen later
4572 { /* end of list */ }