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
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
33 #include "sysemu/block-backend.h"
34 #include "sysemu/blockdev.h"
35 #include "hw/block/block.h"
36 #include "block/blockjob.h"
37 #include "block/throttle-groups.h"
38 #include "monitor/monitor.h"
39 #include "qemu/error-report.h"
40 #include "qemu/option.h"
41 #include "qemu/config-file.h"
42 #include "qapi/qmp/types.h"
43 #include "qapi-visit.h"
44 #include "qapi/qmp/qerror.h"
45 #include "qapi/qmp-output-visitor.h"
46 #include "qapi/util.h"
47 #include "sysemu/sysemu.h"
48 #include "block/block_int.h"
49 #include "qmp-commands.h"
51 #include "sysemu/arch_init.h"
53 static const char *const if_name[IF_COUNT] = {
57 [IF_FLOPPY] = "floppy",
58 [IF_PFLASH] = "pflash",
61 [IF_VIRTIO] = "virtio",
65 static int if_max_devs[IF_COUNT] = {
67 * Do not change these numbers! They govern how drive option
68 * index maps to unit and bus. That mapping is ABI.
70 * All controllers used to imlement if=T drives need to support
71 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
72 * Otherwise, some index values map to "impossible" bus, unit
75 * For instance, if you change [IF_SCSI] to 255, -drive
76 * if=scsi,index=12 no longer means bus=1,unit=5, but
77 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
78 * the drive can't be set up. Regression.
85 * Boards may call this to offer board-by-board overrides
86 * of the default, global values.
88 void override_max_devs(BlockInterfaceType type, int max_devs)
97 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
98 dinfo = blk_legacy_dinfo(blk);
99 if (dinfo->type == type) {
100 fprintf(stderr, "Cannot override units-per-bus property of"
101 " the %s interface, because a drive of that type has"
102 " already been added.\n", if_name[type]);
103 g_assert_not_reached();
107 if_max_devs[type] = max_devs;
111 * We automatically delete the drive when a device using it gets
112 * unplugged. Questionable feature, but we can't just drop it.
113 * Device models call blockdev_mark_auto_del() to schedule the
114 * automatic deletion, and generic qdev code calls blockdev_auto_del()
115 * when deletion is actually safe.
117 void blockdev_mark_auto_del(BlockBackend *blk)
119 DriveInfo *dinfo = blk_legacy_dinfo(blk);
120 BlockDriverState *bs = blk_bs(blk);
121 AioContext *aio_context;
127 aio_context = bdrv_get_aio_context(bs);
128 aio_context_acquire(aio_context);
131 block_job_cancel(bs->job);
134 aio_context_release(aio_context);
139 void blockdev_auto_del(BlockBackend *blk)
141 DriveInfo *dinfo = blk_legacy_dinfo(blk);
143 if (dinfo && dinfo->auto_del) {
149 * Returns the current mapping of how many units per bus
150 * a particular interface can support.
152 * A positive integer indicates n units per bus.
153 * 0 implies the mapping has not been established.
154 * -1 indicates an invalid BlockInterfaceType was given.
156 int drive_get_max_devs(BlockInterfaceType type)
158 if (type >= IF_IDE && type < IF_COUNT) {
159 return if_max_devs[type];
165 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
167 int max_devs = if_max_devs[type];
168 return max_devs ? index / max_devs : 0;
171 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
173 int max_devs = if_max_devs[type];
174 return max_devs ? index % max_devs : index;
177 QemuOpts *drive_def(const char *optstr)
179 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
182 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
187 opts = drive_def(optstr);
191 if (type != IF_DEFAULT) {
192 qemu_opt_set(opts, "if", if_name[type], &error_abort);
195 qemu_opt_set_number(opts, "index", index, &error_abort);
198 qemu_opt_set(opts, "file", file, &error_abort);
202 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
207 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
208 dinfo = blk_legacy_dinfo(blk);
209 if (dinfo && dinfo->type == type
210 && dinfo->bus == bus && dinfo->unit == unit) {
218 bool drive_check_orphaned(void)
224 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
225 dinfo = blk_legacy_dinfo(blk);
226 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
227 /* Unless this is a default drive, this may be an oversight. */
228 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
229 dinfo->type != IF_NONE) {
230 fprintf(stderr, "Warning: Orphaned drive without device: "
231 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
232 blk_name(blk), blk_bs(blk)->filename, if_name[dinfo->type],
233 dinfo->bus, dinfo->unit);
241 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
243 return drive_get(type,
244 drive_index_to_bus_id(type, index),
245 drive_index_to_unit_id(type, index));
248 int drive_get_max_bus(BlockInterfaceType type)
255 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
256 dinfo = blk_legacy_dinfo(blk);
257 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
258 max_bus = dinfo->bus;
264 /* Get a block device. This should only be used for single-drive devices
265 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
267 DriveInfo *drive_get_next(BlockInterfaceType type)
269 static int next_block_unit[IF_COUNT];
271 return drive_get(type, 0, next_block_unit[type]++);
274 static void bdrv_format_print(void *opaque, const char *name)
276 error_printf(" %s", name);
281 BlockDriverState *bs;
284 static void bdrv_put_ref_bh(void *opaque)
286 BDRVPutRefBH *s = opaque;
289 qemu_bh_delete(s->bh);
294 * Release a BDS reference in a BH
296 * It is not safe to use bdrv_unref() from a callback function when the callers
297 * still need the BlockDriverState. In such cases we schedule a BH to release
300 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
304 s = g_new(BDRVPutRefBH, 1);
305 s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
307 qemu_bh_schedule(s->bh);
310 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
312 if (!strcmp(buf, "ignore")) {
313 return BLOCKDEV_ON_ERROR_IGNORE;
314 } else if (!is_read && !strcmp(buf, "enospc")) {
315 return BLOCKDEV_ON_ERROR_ENOSPC;
316 } else if (!strcmp(buf, "stop")) {
317 return BLOCKDEV_ON_ERROR_STOP;
318 } else if (!strcmp(buf, "report")) {
319 return BLOCKDEV_ON_ERROR_REPORT;
321 error_setg(errp, "'%s' invalid %s error action",
322 buf, is_read ? "read" : "write");
327 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
329 if (throttle_conflicting(cfg)) {
330 error_setg(errp, "bps/iops/max total values and read/write values"
331 " cannot be used at the same time");
335 if (!throttle_is_valid(cfg)) {
336 error_setg(errp, "bps/iops/maxs values must be 0 or greater");
340 if (throttle_max_is_missing_limit(cfg)) {
341 error_setg(errp, "bps_max/iops_max require corresponding"
349 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
351 /* Takes the ownership of bs_opts */
352 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
358 int on_read_error, on_write_error;
360 BlockDriverState *bs;
367 bool has_driver_specific_opts;
368 BlockdevDetectZeroesOptions detect_zeroes;
369 const char *throttling_group;
371 /* Check common options by copying from bs_opts to opts, all other options
372 * stay in bs_opts for processing by bdrv_open(). */
373 id = qdict_get_try_str(bs_opts, "id");
374 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
376 error_propagate(errp, error);
380 qemu_opts_absorb_qdict(opts, bs_opts, &error);
382 error_propagate(errp, error);
387 qdict_del(bs_opts, "id");
390 has_driver_specific_opts = !!qdict_size(bs_opts);
392 /* extract parameters */
393 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
394 ro = qemu_opt_get_bool(opts, "read-only", 0);
395 copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
397 if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
398 if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
399 error_setg(errp, "invalid discard option");
404 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true)) {
405 bdrv_flags |= BDRV_O_CACHE_WB;
407 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) {
408 bdrv_flags |= BDRV_O_NOCACHE;
410 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) {
411 bdrv_flags |= BDRV_O_NO_FLUSH;
414 #ifdef CONFIG_LINUX_AIO
415 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
416 if (!strcmp(buf, "native")) {
417 bdrv_flags |= BDRV_O_NATIVE_AIO;
418 } else if (!strcmp(buf, "threads")) {
419 /* this is the default */
421 error_setg(errp, "invalid aio option");
427 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
428 if (is_help_option(buf)) {
429 error_printf("Supported formats:");
430 bdrv_iterate_format(bdrv_format_print, NULL);
435 if (qdict_haskey(bs_opts, "driver")) {
436 error_setg(errp, "Cannot specify both 'driver' and 'format'");
439 qdict_put(bs_opts, "driver", qstring_from_str(buf));
442 /* disk I/O throttling */
443 memset(&cfg, 0, sizeof(cfg));
444 cfg.buckets[THROTTLE_BPS_TOTAL].avg =
445 qemu_opt_get_number(opts, "throttling.bps-total", 0);
446 cfg.buckets[THROTTLE_BPS_READ].avg =
447 qemu_opt_get_number(opts, "throttling.bps-read", 0);
448 cfg.buckets[THROTTLE_BPS_WRITE].avg =
449 qemu_opt_get_number(opts, "throttling.bps-write", 0);
450 cfg.buckets[THROTTLE_OPS_TOTAL].avg =
451 qemu_opt_get_number(opts, "throttling.iops-total", 0);
452 cfg.buckets[THROTTLE_OPS_READ].avg =
453 qemu_opt_get_number(opts, "throttling.iops-read", 0);
454 cfg.buckets[THROTTLE_OPS_WRITE].avg =
455 qemu_opt_get_number(opts, "throttling.iops-write", 0);
457 cfg.buckets[THROTTLE_BPS_TOTAL].max =
458 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
459 cfg.buckets[THROTTLE_BPS_READ].max =
460 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
461 cfg.buckets[THROTTLE_BPS_WRITE].max =
462 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
463 cfg.buckets[THROTTLE_OPS_TOTAL].max =
464 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
465 cfg.buckets[THROTTLE_OPS_READ].max =
466 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
467 cfg.buckets[THROTTLE_OPS_WRITE].max =
468 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
470 cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
472 throttling_group = qemu_opt_get(opts, "throttling.group");
474 if (!check_throttle_config(&cfg, &error)) {
475 error_propagate(errp, error);
479 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
480 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
481 on_write_error = parse_block_error_action(buf, 0, &error);
483 error_propagate(errp, error);
488 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
489 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
490 on_read_error = parse_block_error_action(buf, 1, &error);
492 error_propagate(errp, error);
498 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
499 qemu_opt_get(opts, "detect-zeroes"),
500 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
501 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
504 error_propagate(errp, error);
508 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
509 !(bdrv_flags & BDRV_O_UNMAP)) {
510 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
511 "without setting discard operation to unmap");
516 if ((!file || !*file) && !has_driver_specific_opts) {
517 blk = blk_new_with_bs(qemu_opts_id(opts), errp);
523 bs->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
528 if (file && !*file) {
533 /* always use cache=unsafe with snapshot */
534 bdrv_flags &= ~BDRV_O_CACHE_MASK;
535 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
539 bdrv_flags |= BDRV_O_COPY_ON_READ;
542 if (runstate_check(RUN_STATE_INMIGRATE)) {
543 bdrv_flags |= BDRV_O_INCOMING;
546 bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
548 blk = blk_new_open(qemu_opts_id(opts), file, NULL, bs_opts, bdrv_flags,
556 bs->detect_zeroes = detect_zeroes;
558 bdrv_set_on_error(bs, on_read_error, on_write_error);
560 /* disk I/O throttling */
561 if (throttle_enabled(&cfg)) {
562 if (!throttling_group) {
563 throttling_group = blk_name(blk);
565 bdrv_io_limits_enable(bs, throttling_group);
566 bdrv_set_io_limits(bs, &cfg);
569 if (bdrv_key_required(bs)) {
584 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
589 value = qemu_opt_get(opts, from);
591 if (qemu_opt_find(opts, to)) {
592 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
593 "same time", to, from);
598 /* rename all items in opts */
599 while ((value = qemu_opt_get(opts, from))) {
600 qemu_opt_set(opts, to, value, &error_abort);
601 qemu_opt_unset(opts, from);
605 QemuOptsList qemu_legacy_drive_opts = {
607 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
611 .type = QEMU_OPT_NUMBER,
612 .help = "bus number",
615 .type = QEMU_OPT_NUMBER,
616 .help = "unit number (i.e. lun for scsi)",
619 .type = QEMU_OPT_NUMBER,
620 .help = "index number",
623 .type = QEMU_OPT_STRING,
624 .help = "media type (disk, cdrom)",
627 .type = QEMU_OPT_STRING,
628 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
631 .type = QEMU_OPT_NUMBER,
632 .help = "number of cylinders (ide disk geometry)",
635 .type = QEMU_OPT_NUMBER,
636 .help = "number of heads (ide disk geometry)",
639 .type = QEMU_OPT_NUMBER,
640 .help = "number of sectors (ide disk geometry)",
643 .type = QEMU_OPT_STRING,
644 .help = "chs translation (auto, lba, none)",
647 .type = QEMU_OPT_BOOL,
648 .help = "(deprecated, ignored)",
651 .type = QEMU_OPT_STRING,
652 .help = "pci address (virtio only)",
655 .type = QEMU_OPT_STRING,
656 .help = "disk serial number",
659 .type = QEMU_OPT_STRING,
663 /* Options that are passed on, but have special semantics with -drive */
666 .type = QEMU_OPT_BOOL,
667 .help = "open drive file as read-only",
670 .type = QEMU_OPT_STRING,
671 .help = "read error action",
674 .type = QEMU_OPT_STRING,
675 .help = "write error action",
677 .name = "copy-on-read",
678 .type = QEMU_OPT_BOOL,
679 .help = "copy read data from backing file into image file",
682 { /* end of list */ }
686 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
690 DriveInfo *dinfo = NULL;
692 QemuOpts *legacy_opts;
693 DriveMediaType media = MEDIA_DISK;
694 BlockInterfaceType type;
695 int cyls, heads, secs, translation;
696 int max_devs, bus_id, unit_id, index;
698 const char *werror, *rerror;
699 bool read_only = false;
702 const char *filename;
703 Error *local_err = NULL;
706 /* Change legacy command line options into QMP ones */
707 static const struct {
711 { "iops", "throttling.iops-total" },
712 { "iops_rd", "throttling.iops-read" },
713 { "iops_wr", "throttling.iops-write" },
715 { "bps", "throttling.bps-total" },
716 { "bps_rd", "throttling.bps-read" },
717 { "bps_wr", "throttling.bps-write" },
719 { "iops_max", "throttling.iops-total-max" },
720 { "iops_rd_max", "throttling.iops-read-max" },
721 { "iops_wr_max", "throttling.iops-write-max" },
723 { "bps_max", "throttling.bps-total-max" },
724 { "bps_rd_max", "throttling.bps-read-max" },
725 { "bps_wr_max", "throttling.bps-write-max" },
727 { "iops_size", "throttling.iops-size" },
729 { "group", "throttling.group" },
731 { "readonly", "read-only" },
734 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
735 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
738 error_report_err(local_err);
743 value = qemu_opt_get(all_opts, "cache");
747 if (bdrv_parse_cache_flags(value, &flags) != 0) {
748 error_report("invalid cache option");
752 /* Specific options take precedence */
753 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
754 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
755 !!(flags & BDRV_O_CACHE_WB), &error_abort);
757 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
758 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
759 !!(flags & BDRV_O_NOCACHE), &error_abort);
761 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
762 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
763 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
765 qemu_opt_unset(all_opts, "cache");
768 /* Get a QDict for processing the options */
769 bs_opts = qdict_new();
770 qemu_opts_to_qdict(all_opts, bs_opts);
772 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
774 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
776 error_report_err(local_err);
780 /* Deprecated option boot=[on|off] */
781 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
782 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
783 "ignored. Future versions will reject this parameter. Please "
784 "update your scripts.\n");
788 value = qemu_opt_get(legacy_opts, "media");
790 if (!strcmp(value, "disk")) {
792 } else if (!strcmp(value, "cdrom")) {
796 error_report("'%s' invalid media", value);
801 /* copy-on-read is disabled with a warning for read-only devices */
802 read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
803 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
805 if (read_only && copy_on_read) {
806 error_report("warning: disabling copy-on-read on read-only drive");
807 copy_on_read = false;
810 qdict_put(bs_opts, "read-only",
811 qstring_from_str(read_only ? "on" : "off"));
812 qdict_put(bs_opts, "copy-on-read",
813 qstring_from_str(copy_on_read ? "on" :"off"));
815 /* Controller type */
816 value = qemu_opt_get(legacy_opts, "if");
819 type < IF_COUNT && strcmp(value, if_name[type]);
822 if (type == IF_COUNT) {
823 error_report("unsupported bus type '%s'", value);
827 type = block_default_type;
831 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
832 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
833 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
835 if (cyls || heads || secs) {
837 error_report("invalid physical cyls number");
841 error_report("invalid physical heads number");
845 error_report("invalid physical secs number");
850 translation = BIOS_ATA_TRANSLATION_AUTO;
851 value = qemu_opt_get(legacy_opts, "trans");
854 error_report("'%s' trans must be used with cyls, heads and secs",
858 if (!strcmp(value, "none")) {
859 translation = BIOS_ATA_TRANSLATION_NONE;
860 } else if (!strcmp(value, "lba")) {
861 translation = BIOS_ATA_TRANSLATION_LBA;
862 } else if (!strcmp(value, "large")) {
863 translation = BIOS_ATA_TRANSLATION_LARGE;
864 } else if (!strcmp(value, "rechs")) {
865 translation = BIOS_ATA_TRANSLATION_RECHS;
866 } else if (!strcmp(value, "auto")) {
867 translation = BIOS_ATA_TRANSLATION_AUTO;
869 error_report("'%s' invalid translation type", value);
874 if (media == MEDIA_CDROM) {
875 if (cyls || secs || heads) {
876 error_report("CHS can't be set with media=cdrom");
881 /* Device address specified by bus/unit or index.
882 * If none was specified, try to find the first free one. */
883 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
884 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
885 index = qemu_opt_get_number(legacy_opts, "index", -1);
887 max_devs = if_max_devs[type];
890 if (bus_id != 0 || unit_id != -1) {
891 error_report("index cannot be used with bus and unit");
894 bus_id = drive_index_to_bus_id(type, index);
895 unit_id = drive_index_to_unit_id(type, index);
900 while (drive_get(type, bus_id, unit_id) != NULL) {
902 if (max_devs && unit_id >= max_devs) {
909 if (max_devs && unit_id >= max_devs) {
910 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
914 if (drive_get(type, bus_id, unit_id) != NULL) {
915 error_report("drive with bus=%d, unit=%d (index=%d) exists",
916 bus_id, unit_id, index);
921 serial = qemu_opt_get(legacy_opts, "serial");
923 /* no id supplied -> create one */
924 if (qemu_opts_id(all_opts) == NULL) {
926 const char *mediastr = "";
927 if (type == IF_IDE || type == IF_SCSI) {
928 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
931 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
934 new_id = g_strdup_printf("%s%s%i", if_name[type],
937 qdict_put(bs_opts, "id", qstring_from_str(new_id));
941 /* Add virtio block device */
942 devaddr = qemu_opt_get(legacy_opts, "addr");
943 if (devaddr && type != IF_VIRTIO) {
944 error_report("addr is not supported by this bus type");
948 if (type == IF_VIRTIO) {
950 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
952 if (arch_type == QEMU_ARCH_S390X) {
953 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
955 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
957 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
960 qemu_opt_set(devopts, "addr", devaddr, &error_abort);
964 filename = qemu_opt_get(legacy_opts, "file");
966 /* Check werror/rerror compatibility with if=... */
967 werror = qemu_opt_get(legacy_opts, "werror");
968 if (werror != NULL) {
969 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
971 error_report("werror is not supported by this bus type");
974 qdict_put(bs_opts, "werror", qstring_from_str(werror));
977 rerror = qemu_opt_get(legacy_opts, "rerror");
978 if (rerror != NULL) {
979 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
981 error_report("rerror is not supported by this bus type");
984 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
987 /* Actual block device init: Functionality shared with blockdev-add */
988 blk = blockdev_init(filename, bs_opts, &local_err);
992 error_report_err(local_err);
999 /* Create legacy DriveInfo */
1000 dinfo = g_malloc0(sizeof(*dinfo));
1001 dinfo->opts = all_opts;
1004 dinfo->heads = heads;
1006 dinfo->trans = translation;
1009 dinfo->bus = bus_id;
1010 dinfo->unit = unit_id;
1011 dinfo->devaddr = devaddr;
1012 dinfo->serial = g_strdup(serial);
1014 blk_set_legacy_dinfo(blk, dinfo);
1021 dinfo->media_cd = media == MEDIA_CDROM;
1028 qemu_opts_del(legacy_opts);
1033 void hmp_commit(Monitor *mon, const QDict *qdict)
1035 const char *device = qdict_get_str(qdict, "device");
1039 if (!strcmp(device, "all")) {
1040 ret = bdrv_commit_all();
1042 blk = blk_by_name(device);
1044 monitor_printf(mon, "Device '%s' not found\n", device);
1047 ret = bdrv_commit(blk_bs(blk));
1050 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1055 static void blockdev_do_action(int kind, void *data, Error **errp)
1057 TransactionAction action;
1058 TransactionActionList list;
1062 list.value = &action;
1064 qmp_transaction(&list, errp);
1067 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1068 bool has_node_name, const char *node_name,
1069 const char *snapshot_file,
1070 bool has_snapshot_node_name,
1071 const char *snapshot_node_name,
1072 bool has_format, const char *format,
1073 bool has_mode, NewImageMode mode, Error **errp)
1075 BlockdevSnapshot snapshot = {
1076 .has_device = has_device,
1077 .device = (char *) device,
1078 .has_node_name = has_node_name,
1079 .node_name = (char *) node_name,
1080 .snapshot_file = (char *) snapshot_file,
1081 .has_snapshot_node_name = has_snapshot_node_name,
1082 .snapshot_node_name = (char *) snapshot_node_name,
1083 .has_format = has_format,
1084 .format = (char *) format,
1085 .has_mode = has_mode,
1088 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1092 void qmp_blockdev_snapshot_internal_sync(const char *device,
1096 BlockdevSnapshotInternal snapshot = {
1097 .device = (char *) device,
1098 .name = (char *) name
1101 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1105 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1112 BlockDriverState *bs;
1114 AioContext *aio_context;
1115 QEMUSnapshotInfo sn;
1116 Error *local_err = NULL;
1117 SnapshotInfo *info = NULL;
1120 blk = blk_by_name(device);
1122 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1123 "Device '%s' not found", device);
1137 error_setg(errp, "Name or id must be provided");
1141 aio_context = bdrv_get_aio_context(bs);
1142 aio_context_acquire(aio_context);
1144 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1145 goto out_aio_context;
1148 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1150 error_propagate(errp, local_err);
1151 goto out_aio_context;
1155 "Snapshot with id '%s' and name '%s' does not exist on "
1157 STR_OR_NULL(id), STR_OR_NULL(name), device);
1158 goto out_aio_context;
1161 bdrv_snapshot_delete(bs, id, name, &local_err);
1163 error_propagate(errp, local_err);
1164 goto out_aio_context;
1167 aio_context_release(aio_context);
1169 info = g_new0(SnapshotInfo, 1);
1170 info->id = g_strdup(sn.id_str);
1171 info->name = g_strdup(sn.name);
1172 info->date_nsec = sn.date_nsec;
1173 info->date_sec = sn.date_sec;
1174 info->vm_state_size = sn.vm_state_size;
1175 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1176 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1181 aio_context_release(aio_context);
1186 * block_dirty_bitmap_lookup:
1187 * Return a dirty bitmap (if present), after validating
1188 * the node reference and bitmap names.
1190 * @node: The name of the BDS node to search for bitmaps
1191 * @name: The name of the bitmap to search for
1192 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1193 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1194 * @errp: Output pointer for error information. Can be NULL.
1196 * @return: A bitmap object on success, or NULL on failure.
1198 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1200 BlockDriverState **pbs,
1204 BlockDriverState *bs;
1205 BdrvDirtyBitmap *bitmap;
1206 AioContext *aio_context;
1209 error_setg(errp, "Node cannot be NULL");
1213 error_setg(errp, "Bitmap name cannot be NULL");
1216 bs = bdrv_lookup_bs(node, node, NULL);
1218 error_setg(errp, "Node '%s' not found", node);
1222 aio_context = bdrv_get_aio_context(bs);
1223 aio_context_acquire(aio_context);
1225 bitmap = bdrv_find_dirty_bitmap(bs, name);
1227 error_setg(errp, "Dirty bitmap '%s' not found", name);
1235 *paio = aio_context;
1237 aio_context_release(aio_context);
1243 aio_context_release(aio_context);
1247 /* New and old BlockDriverState structs for atomic group operations */
1249 typedef struct BlkTransactionState BlkTransactionState;
1251 /* Only prepare() may fail. In a single transaction, only one of commit() or
1252 abort() will be called, clean() will always be called if it present. */
1253 typedef struct BdrvActionOps {
1254 /* Size of state struct, in bytes. */
1255 size_t instance_size;
1256 /* Prepare the work, must NOT be NULL. */
1257 void (*prepare)(BlkTransactionState *common, Error **errp);
1258 /* Commit the changes, can be NULL. */
1259 void (*commit)(BlkTransactionState *common);
1260 /* Abort the changes on fail, can be NULL. */
1261 void (*abort)(BlkTransactionState *common);
1262 /* Clean up resource in the end, can be NULL. */
1263 void (*clean)(BlkTransactionState *common);
1267 * This structure must be arranged as first member in child type, assuming
1268 * that compiler will also arrange it to the same address with parent instance.
1269 * Later it will be used in free().
1271 struct BlkTransactionState {
1272 TransactionAction *action;
1273 const BdrvActionOps *ops;
1274 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1277 /* internal snapshot private data */
1278 typedef struct InternalSnapshotState {
1279 BlkTransactionState common;
1280 BlockDriverState *bs;
1281 AioContext *aio_context;
1282 QEMUSnapshotInfo sn;
1283 } InternalSnapshotState;
1285 static void internal_snapshot_prepare(BlkTransactionState *common,
1288 Error *local_err = NULL;
1292 BlockDriverState *bs;
1293 QEMUSnapshotInfo old_sn, *sn;
1296 BlockdevSnapshotInternal *internal;
1297 InternalSnapshotState *state;
1300 g_assert(common->action->kind ==
1301 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1302 internal = common->action->blockdev_snapshot_internal_sync;
1303 state = DO_UPCAST(InternalSnapshotState, common, common);
1305 /* 1. parse input */
1306 device = internal->device;
1307 name = internal->name;
1309 /* 2. check for validation */
1310 blk = blk_by_name(device);
1312 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1313 "Device '%s' not found", device);
1318 /* AioContext is released in .clean() */
1319 state->aio_context = bdrv_get_aio_context(bs);
1320 aio_context_acquire(state->aio_context);
1322 if (!bdrv_is_inserted(bs)) {
1323 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1327 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1331 if (bdrv_is_read_only(bs)) {
1332 error_setg(errp, "Device '%s' is read only", device);
1336 if (!bdrv_can_snapshot(bs)) {
1337 error_setg(errp, "Block format '%s' used by device '%s' "
1338 "does not support internal snapshots",
1339 bs->drv->format_name, device);
1343 if (!strlen(name)) {
1344 error_setg(errp, "Name is empty");
1348 /* check whether a snapshot with name exist */
1349 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1352 error_propagate(errp, local_err);
1356 "Snapshot with name '%s' already exists on device '%s'",
1361 /* 3. take the snapshot */
1363 pstrcpy(sn->name, sizeof(sn->name), name);
1364 qemu_gettimeofday(&tv);
1365 sn->date_sec = tv.tv_sec;
1366 sn->date_nsec = tv.tv_usec * 1000;
1367 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1369 ret1 = bdrv_snapshot_create(bs, sn);
1371 error_setg_errno(errp, -ret1,
1372 "Failed to create snapshot '%s' on device '%s'",
1377 /* 4. succeed, mark a snapshot is created */
1381 static void internal_snapshot_abort(BlkTransactionState *common)
1383 InternalSnapshotState *state =
1384 DO_UPCAST(InternalSnapshotState, common, common);
1385 BlockDriverState *bs = state->bs;
1386 QEMUSnapshotInfo *sn = &state->sn;
1387 Error *local_error = NULL;
1393 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1394 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1395 "device '%s' in abort: %s",
1398 bdrv_get_device_name(bs),
1399 error_get_pretty(local_error));
1400 error_free(local_error);
1404 static void internal_snapshot_clean(BlkTransactionState *common)
1406 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1409 if (state->aio_context) {
1410 aio_context_release(state->aio_context);
1414 /* external snapshot private data */
1415 typedef struct ExternalSnapshotState {
1416 BlkTransactionState common;
1417 BlockDriverState *old_bs;
1418 BlockDriverState *new_bs;
1419 AioContext *aio_context;
1420 } ExternalSnapshotState;
1422 static void external_snapshot_prepare(BlkTransactionState *common,
1427 Error *local_err = NULL;
1428 bool has_device = false;
1430 bool has_node_name = false;
1431 const char *node_name;
1432 bool has_snapshot_node_name = false;
1433 const char *snapshot_node_name;
1434 const char *new_image_file;
1435 const char *format = "qcow2";
1436 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1437 ExternalSnapshotState *state =
1438 DO_UPCAST(ExternalSnapshotState, common, common);
1439 TransactionAction *action = common->action;
1441 /* get parameters */
1442 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1444 has_device = action->blockdev_snapshot_sync->has_device;
1445 device = action->blockdev_snapshot_sync->device;
1446 has_node_name = action->blockdev_snapshot_sync->has_node_name;
1447 node_name = action->blockdev_snapshot_sync->node_name;
1448 has_snapshot_node_name =
1449 action->blockdev_snapshot_sync->has_snapshot_node_name;
1450 snapshot_node_name = action->blockdev_snapshot_sync->snapshot_node_name;
1452 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1453 if (action->blockdev_snapshot_sync->has_format) {
1454 format = action->blockdev_snapshot_sync->format;
1456 if (action->blockdev_snapshot_sync->has_mode) {
1457 mode = action->blockdev_snapshot_sync->mode;
1460 /* start processing */
1461 state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
1462 has_node_name ? node_name : NULL,
1465 error_propagate(errp, local_err);
1469 if (has_node_name && !has_snapshot_node_name) {
1470 error_setg(errp, "New snapshot node name missing");
1474 if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
1475 error_setg(errp, "New snapshot node name already existing");
1479 /* Acquire AioContext now so any threads operating on old_bs stop */
1480 state->aio_context = bdrv_get_aio_context(state->old_bs);
1481 aio_context_acquire(state->aio_context);
1483 if (!bdrv_is_inserted(state->old_bs)) {
1484 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1488 if (bdrv_op_is_blocked(state->old_bs,
1489 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1493 if (!bdrv_is_read_only(state->old_bs)) {
1494 if (bdrv_flush(state->old_bs)) {
1495 error_setg(errp, QERR_IO_ERROR);
1500 if (!bdrv_is_first_non_filter(state->old_bs)) {
1501 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1505 flags = state->old_bs->open_flags;
1507 /* create new image w/backing file */
1508 if (mode != NEW_IMAGE_MODE_EXISTING) {
1509 bdrv_img_create(new_image_file, format,
1510 state->old_bs->filename,
1511 state->old_bs->drv->format_name,
1512 NULL, -1, flags, &local_err, false);
1514 error_propagate(errp, local_err);
1519 options = qdict_new();
1520 if (has_snapshot_node_name) {
1521 qdict_put(options, "node-name",
1522 qstring_from_str(snapshot_node_name));
1524 qdict_put(options, "driver", qstring_from_str(format));
1526 /* TODO Inherit bs->options or only take explicit options with an
1527 * extended QMP command? */
1528 assert(state->new_bs == NULL);
1529 ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
1530 flags | BDRV_O_NO_BACKING, &local_err);
1531 /* We will manually add the backing_hd field to the bs later */
1533 error_propagate(errp, local_err);
1537 static void external_snapshot_commit(BlkTransactionState *common)
1539 ExternalSnapshotState *state =
1540 DO_UPCAST(ExternalSnapshotState, common, common);
1542 bdrv_set_aio_context(state->new_bs, state->aio_context);
1544 /* This removes our old bs and adds the new bs */
1545 bdrv_append(state->new_bs, state->old_bs);
1546 /* We don't need (or want) to use the transactional
1547 * bdrv_reopen_multiple() across all the entries at once, because we
1548 * don't want to abort all of them if one of them fails the reopen */
1549 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1552 aio_context_release(state->aio_context);
1555 static void external_snapshot_abort(BlkTransactionState *common)
1557 ExternalSnapshotState *state =
1558 DO_UPCAST(ExternalSnapshotState, common, common);
1559 if (state->new_bs) {
1560 bdrv_unref(state->new_bs);
1562 if (state->aio_context) {
1563 aio_context_release(state->aio_context);
1567 typedef struct DriveBackupState {
1568 BlkTransactionState common;
1569 BlockDriverState *bs;
1570 AioContext *aio_context;
1574 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1576 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1577 BlockDriverState *bs;
1579 DriveBackup *backup;
1580 Error *local_err = NULL;
1582 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1583 backup = common->action->drive_backup;
1585 blk = blk_by_name(backup->device);
1587 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1588 "Device '%s' not found", backup->device);
1593 /* AioContext is released in .clean() */
1594 state->aio_context = bdrv_get_aio_context(bs);
1595 aio_context_acquire(state->aio_context);
1597 qmp_drive_backup(backup->device, backup->target,
1598 backup->has_format, backup->format,
1600 backup->has_mode, backup->mode,
1601 backup->has_speed, backup->speed,
1602 backup->has_bitmap, backup->bitmap,
1603 backup->has_on_source_error, backup->on_source_error,
1604 backup->has_on_target_error, backup->on_target_error,
1607 error_propagate(errp, local_err);
1612 state->job = state->bs->job;
1615 static void drive_backup_abort(BlkTransactionState *common)
1617 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1618 BlockDriverState *bs = state->bs;
1620 /* Only cancel if it's the job we started */
1621 if (bs && bs->job && bs->job == state->job) {
1622 block_job_cancel_sync(bs->job);
1626 static void drive_backup_clean(BlkTransactionState *common)
1628 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1630 if (state->aio_context) {
1631 aio_context_release(state->aio_context);
1635 typedef struct BlockdevBackupState {
1636 BlkTransactionState common;
1637 BlockDriverState *bs;
1639 AioContext *aio_context;
1640 } BlockdevBackupState;
1642 static void blockdev_backup_prepare(BlkTransactionState *common, Error **errp)
1644 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1645 BlockdevBackup *backup;
1646 BlockDriverState *bs, *target;
1648 Error *local_err = NULL;
1650 assert(common->action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1651 backup = common->action->blockdev_backup;
1653 blk = blk_by_name(backup->device);
1655 error_setg(errp, "Device '%s' not found", backup->device);
1660 blk = blk_by_name(backup->target);
1662 error_setg(errp, "Device '%s' not found", backup->target);
1665 target = blk_bs(blk);
1667 /* AioContext is released in .clean() */
1668 state->aio_context = bdrv_get_aio_context(bs);
1669 if (state->aio_context != bdrv_get_aio_context(target)) {
1670 state->aio_context = NULL;
1671 error_setg(errp, "Backup between two IO threads is not implemented");
1674 aio_context_acquire(state->aio_context);
1676 qmp_blockdev_backup(backup->device, backup->target,
1678 backup->has_speed, backup->speed,
1679 backup->has_on_source_error, backup->on_source_error,
1680 backup->has_on_target_error, backup->on_target_error,
1683 error_propagate(errp, local_err);
1688 state->job = state->bs->job;
1691 static void blockdev_backup_abort(BlkTransactionState *common)
1693 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1694 BlockDriverState *bs = state->bs;
1696 /* Only cancel if it's the job we started */
1697 if (bs && bs->job && bs->job == state->job) {
1698 block_job_cancel_sync(bs->job);
1702 static void blockdev_backup_clean(BlkTransactionState *common)
1704 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1706 if (state->aio_context) {
1707 aio_context_release(state->aio_context);
1711 static void abort_prepare(BlkTransactionState *common, Error **errp)
1713 error_setg(errp, "Transaction aborted using Abort action");
1716 static void abort_commit(BlkTransactionState *common)
1718 g_assert_not_reached(); /* this action never succeeds */
1721 static const BdrvActionOps actions[] = {
1722 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1723 .instance_size = sizeof(ExternalSnapshotState),
1724 .prepare = external_snapshot_prepare,
1725 .commit = external_snapshot_commit,
1726 .abort = external_snapshot_abort,
1728 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1729 .instance_size = sizeof(DriveBackupState),
1730 .prepare = drive_backup_prepare,
1731 .abort = drive_backup_abort,
1732 .clean = drive_backup_clean,
1734 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
1735 .instance_size = sizeof(BlockdevBackupState),
1736 .prepare = blockdev_backup_prepare,
1737 .abort = blockdev_backup_abort,
1738 .clean = blockdev_backup_clean,
1740 [TRANSACTION_ACTION_KIND_ABORT] = {
1741 .instance_size = sizeof(BlkTransactionState),
1742 .prepare = abort_prepare,
1743 .commit = abort_commit,
1745 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1746 .instance_size = sizeof(InternalSnapshotState),
1747 .prepare = internal_snapshot_prepare,
1748 .abort = internal_snapshot_abort,
1749 .clean = internal_snapshot_clean,
1754 * 'Atomic' group operations. The operations are performed as a set, and if
1755 * any fail then we roll back all operations in the group.
1757 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1759 TransactionActionList *dev_entry = dev_list;
1760 BlkTransactionState *state, *next;
1761 Error *local_err = NULL;
1763 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1764 QSIMPLEQ_INIT(&snap_bdrv_states);
1766 /* drain all i/o before any operations */
1769 /* We don't do anything in this loop that commits us to the operations */
1770 while (NULL != dev_entry) {
1771 TransactionAction *dev_info = NULL;
1772 const BdrvActionOps *ops;
1774 dev_info = dev_entry->value;
1775 dev_entry = dev_entry->next;
1777 assert(dev_info->kind < ARRAY_SIZE(actions));
1779 ops = &actions[dev_info->kind];
1780 assert(ops->instance_size > 0);
1782 state = g_malloc0(ops->instance_size);
1784 state->action = dev_info;
1785 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1787 state->ops->prepare(state, &local_err);
1789 error_propagate(errp, local_err);
1790 goto delete_and_fail;
1794 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1795 if (state->ops->commit) {
1796 state->ops->commit(state);
1804 /* failure, and it is all-or-none; roll back all operations */
1805 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1806 if (state->ops->abort) {
1807 state->ops->abort(state);
1811 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1812 if (state->ops->clean) {
1813 state->ops->clean(state);
1820 static void eject_device(BlockBackend *blk, int force, Error **errp)
1822 BlockDriverState *bs = blk_bs(blk);
1823 AioContext *aio_context;
1825 aio_context = bdrv_get_aio_context(bs);
1826 aio_context_acquire(aio_context);
1828 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1831 if (!blk_dev_has_removable_media(blk)) {
1832 error_setg(errp, "Device '%s' is not removable",
1833 bdrv_get_device_name(bs));
1837 if (blk_dev_is_medium_locked(blk) && !blk_dev_is_tray_open(blk)) {
1838 blk_dev_eject_request(blk, force);
1840 error_setg(errp, "Device '%s' is locked",
1841 bdrv_get_device_name(bs));
1849 aio_context_release(aio_context);
1852 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1856 blk = blk_by_name(device);
1858 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1859 "Device '%s' not found", device);
1863 eject_device(blk, force, errp);
1866 void qmp_block_passwd(bool has_device, const char *device,
1867 bool has_node_name, const char *node_name,
1868 const char *password, Error **errp)
1870 Error *local_err = NULL;
1871 BlockDriverState *bs;
1872 AioContext *aio_context;
1874 bs = bdrv_lookup_bs(has_device ? device : NULL,
1875 has_node_name ? node_name : NULL,
1878 error_propagate(errp, local_err);
1882 aio_context = bdrv_get_aio_context(bs);
1883 aio_context_acquire(aio_context);
1885 bdrv_add_key(bs, password, errp);
1887 aio_context_release(aio_context);
1890 /* Assumes AioContext is held */
1891 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1892 int bdrv_flags, const char *format,
1893 const char *password, Error **errp)
1895 Error *local_err = NULL;
1896 QDict *options = NULL;
1900 options = qdict_new();
1901 qdict_put(options, "driver", qstring_from_str(format));
1904 ret = bdrv_open(&bs, filename, NULL, options, bdrv_flags, &local_err);
1906 error_propagate(errp, local_err);
1910 bdrv_add_key(bs, password, errp);
1913 void qmp_change_blockdev(const char *device, const char *filename,
1914 const char *format, Error **errp)
1917 BlockDriverState *bs;
1918 AioContext *aio_context;
1922 blk = blk_by_name(device);
1924 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1925 "Device '%s' not found", device);
1930 aio_context = bdrv_get_aio_context(bs);
1931 aio_context_acquire(aio_context);
1933 eject_device(blk, 0, &err);
1935 error_propagate(errp, err);
1939 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1940 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1942 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, format, NULL, errp);
1945 aio_context_release(aio_context);
1948 /* throttling disk I/O limits */
1949 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1956 bool has_bps_rd_max,
1958 bool has_bps_wr_max,
1962 bool has_iops_rd_max,
1963 int64_t iops_rd_max,
1964 bool has_iops_wr_max,
1965 int64_t iops_wr_max,
1969 const char *group, Error **errp)
1972 BlockDriverState *bs;
1974 AioContext *aio_context;
1976 blk = blk_by_name(device);
1978 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1979 "Device '%s' not found", device);
1984 memset(&cfg, 0, sizeof(cfg));
1985 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1986 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
1987 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1989 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1990 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
1991 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1994 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1996 if (has_bps_rd_max) {
1997 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
1999 if (has_bps_wr_max) {
2000 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
2003 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
2005 if (has_iops_rd_max) {
2006 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
2008 if (has_iops_wr_max) {
2009 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
2012 if (has_iops_size) {
2013 cfg.op_size = iops_size;
2016 if (!check_throttle_config(&cfg, errp)) {
2020 aio_context = bdrv_get_aio_context(bs);
2021 aio_context_acquire(aio_context);
2023 if (throttle_enabled(&cfg)) {
2024 /* Enable I/O limits if they're not enabled yet, otherwise
2025 * just update the throttling group. */
2026 if (!bs->io_limits_enabled) {
2027 bdrv_io_limits_enable(bs, has_group ? group : device);
2028 } else if (has_group) {
2029 bdrv_io_limits_update_group(bs, group);
2031 /* Set the new throttling configuration */
2032 bdrv_set_io_limits(bs, &cfg);
2033 } else if (bs->io_limits_enabled) {
2034 /* If all throttling settings are set to 0, disable I/O limits */
2035 bdrv_io_limits_disable(bs);
2038 aio_context_release(aio_context);
2041 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2042 bool has_granularity, uint32_t granularity,
2045 AioContext *aio_context;
2046 BlockDriverState *bs;
2048 if (!name || name[0] == '\0') {
2049 error_setg(errp, "Bitmap name cannot be empty");
2053 bs = bdrv_lookup_bs(node, node, errp);
2058 aio_context = bdrv_get_aio_context(bs);
2059 aio_context_acquire(aio_context);
2061 if (has_granularity) {
2062 if (granularity < 512 || !is_power_of_2(granularity)) {
2063 error_setg(errp, "Granularity must be power of 2 "
2064 "and at least 512");
2068 /* Default to cluster size, if available: */
2069 granularity = bdrv_get_default_bitmap_granularity(bs);
2072 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2075 aio_context_release(aio_context);
2078 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2081 AioContext *aio_context;
2082 BlockDriverState *bs;
2083 BdrvDirtyBitmap *bitmap;
2085 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2086 if (!bitmap || !bs) {
2090 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2092 "Bitmap '%s' is currently frozen and cannot be removed",
2096 bdrv_dirty_bitmap_make_anon(bitmap);
2097 bdrv_release_dirty_bitmap(bs, bitmap);
2100 aio_context_release(aio_context);
2104 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2105 * immediately after a full backup operation.
2107 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2110 AioContext *aio_context;
2111 BdrvDirtyBitmap *bitmap;
2112 BlockDriverState *bs;
2114 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2115 if (!bitmap || !bs) {
2119 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2121 "Bitmap '%s' is currently frozen and cannot be modified",
2124 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2126 "Bitmap '%s' is currently disabled and cannot be cleared",
2131 bdrv_clear_dirty_bitmap(bitmap);
2134 aio_context_release(aio_context);
2137 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2139 const char *id = qdict_get_str(qdict, "id");
2141 BlockDriverState *bs;
2142 AioContext *aio_context;
2143 Error *local_err = NULL;
2145 blk = blk_by_name(id);
2147 error_report("Device '%s' not found", id);
2152 if (!blk_legacy_dinfo(blk)) {
2153 error_report("Deleting device added with blockdev-add"
2154 " is not supported");
2158 aio_context = bdrv_get_aio_context(bs);
2159 aio_context_acquire(aio_context);
2161 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2162 error_report_err(local_err);
2163 aio_context_release(aio_context);
2169 /* if we have a device attached to this BlockDriverState
2170 * then we need to make the drive anonymous until the device
2171 * can be removed. If this is a drive with no device backing
2172 * then we can just get rid of the block driver state right here.
2174 if (blk_get_attached_dev(blk)) {
2175 blk_hide_on_behalf_of_hmp_drive_del(blk);
2176 /* Further I/O must not pause the guest */
2177 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
2178 BLOCKDEV_ON_ERROR_REPORT);
2183 aio_context_release(aio_context);
2186 void qmp_block_resize(bool has_device, const char *device,
2187 bool has_node_name, const char *node_name,
2188 int64_t size, Error **errp)
2190 Error *local_err = NULL;
2191 BlockDriverState *bs;
2192 AioContext *aio_context;
2195 bs = bdrv_lookup_bs(has_device ? device : NULL,
2196 has_node_name ? node_name : NULL,
2199 error_propagate(errp, local_err);
2203 aio_context = bdrv_get_aio_context(bs);
2204 aio_context_acquire(aio_context);
2206 if (!bdrv_is_first_non_filter(bs)) {
2207 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2212 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2216 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2217 error_setg(errp, QERR_DEVICE_IN_USE, device);
2221 /* complete all in-flight operations before resizing the device */
2224 ret = bdrv_truncate(bs, size);
2229 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2232 error_setg(errp, QERR_UNSUPPORTED);
2235 error_setg(errp, "Device '%s' is read only", device);
2238 error_setg(errp, QERR_DEVICE_IN_USE, device);
2241 error_setg_errno(errp, -ret, "Could not resize");
2246 aio_context_release(aio_context);
2249 static void block_job_cb(void *opaque, int ret)
2251 /* Note that this function may be executed from another AioContext besides
2252 * the QEMU main loop. If you need to access anything that assumes the
2253 * QEMU global mutex, use a BH or introduce a mutex.
2256 BlockDriverState *bs = opaque;
2257 const char *msg = NULL;
2259 trace_block_job_cb(bs, bs->job, ret);
2264 msg = strerror(-ret);
2267 if (block_job_is_cancelled(bs->job)) {
2268 block_job_event_cancelled(bs->job);
2270 block_job_event_completed(bs->job, msg);
2273 bdrv_put_ref_bh_schedule(bs);
2276 void qmp_block_stream(const char *device,
2277 bool has_base, const char *base,
2278 bool has_backing_file, const char *backing_file,
2279 bool has_speed, int64_t speed,
2280 bool has_on_error, BlockdevOnError on_error,
2284 BlockDriverState *bs;
2285 BlockDriverState *base_bs = NULL;
2286 AioContext *aio_context;
2287 Error *local_err = NULL;
2288 const char *base_name = NULL;
2290 if (!has_on_error) {
2291 on_error = BLOCKDEV_ON_ERROR_REPORT;
2294 blk = blk_by_name(device);
2296 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2297 "Device '%s' not found", device);
2302 aio_context = bdrv_get_aio_context(bs);
2303 aio_context_acquire(aio_context);
2305 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2310 base_bs = bdrv_find_backing_image(bs, base);
2311 if (base_bs == NULL) {
2312 error_setg(errp, QERR_BASE_NOT_FOUND, base);
2315 assert(bdrv_get_aio_context(base_bs) == aio_context);
2319 /* if we are streaming the entire chain, the result will have no backing
2320 * file, and specifying one is therefore an error */
2321 if (base_bs == NULL && has_backing_file) {
2322 error_setg(errp, "backing file specified, but streaming the "
2327 /* backing_file string overrides base bs filename */
2328 base_name = has_backing_file ? backing_file : base_name;
2330 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
2331 on_error, block_job_cb, bs, &local_err);
2333 error_propagate(errp, local_err);
2337 trace_qmp_block_stream(bs, bs->job);
2340 aio_context_release(aio_context);
2343 void qmp_block_commit(const char *device,
2344 bool has_base, const char *base,
2345 bool has_top, const char *top,
2346 bool has_backing_file, const char *backing_file,
2347 bool has_speed, int64_t speed,
2351 BlockDriverState *bs;
2352 BlockDriverState *base_bs, *top_bs;
2353 AioContext *aio_context;
2354 Error *local_err = NULL;
2355 /* This will be part of the QMP command, if/when the
2356 * BlockdevOnError change for blkmirror makes it in
2358 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
2365 * libvirt relies on the DeviceNotFound error class in order to probe for
2366 * live commit feature versions; for this to work, we must make sure to
2367 * perform the device lookup before any generic errors that may occur in a
2368 * scenario in which all optional arguments are omitted. */
2369 blk = blk_by_name(device);
2371 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2372 "Device '%s' not found", device);
2377 aio_context = bdrv_get_aio_context(bs);
2378 aio_context_acquire(aio_context);
2380 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2384 /* default top_bs is the active layer */
2387 if (has_top && top) {
2388 if (strcmp(bs->filename, top) != 0) {
2389 top_bs = bdrv_find_backing_image(bs, top);
2393 if (top_bs == NULL) {
2394 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2398 assert(bdrv_get_aio_context(top_bs) == aio_context);
2400 if (has_base && base) {
2401 base_bs = bdrv_find_backing_image(top_bs, base);
2403 base_bs = bdrv_find_base(top_bs);
2406 if (base_bs == NULL) {
2407 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
2411 assert(bdrv_get_aio_context(base_bs) == aio_context);
2413 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2417 /* Do not allow attempts to commit an image into itself */
2418 if (top_bs == base_bs) {
2419 error_setg(errp, "cannot commit an image into itself");
2424 if (has_backing_file) {
2425 error_setg(errp, "'backing-file' specified,"
2426 " but 'top' is the active layer");
2429 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2432 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
2433 has_backing_file ? backing_file : NULL, &local_err);
2435 if (local_err != NULL) {
2436 error_propagate(errp, local_err);
2441 aio_context_release(aio_context);
2444 void qmp_drive_backup(const char *device, const char *target,
2445 bool has_format, const char *format,
2446 enum MirrorSyncMode sync,
2447 bool has_mode, enum NewImageMode mode,
2448 bool has_speed, int64_t speed,
2449 bool has_bitmap, const char *bitmap,
2450 bool has_on_source_error, BlockdevOnError on_source_error,
2451 bool has_on_target_error, BlockdevOnError on_target_error,
2455 BlockDriverState *bs;
2456 BlockDriverState *target_bs;
2457 BlockDriverState *source = NULL;
2458 BdrvDirtyBitmap *bmap = NULL;
2459 AioContext *aio_context;
2460 QDict *options = NULL;
2461 Error *local_err = NULL;
2469 if (!has_on_source_error) {
2470 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2472 if (!has_on_target_error) {
2473 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2476 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2479 blk = blk_by_name(device);
2481 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2482 "Device '%s' not found", device);
2487 aio_context = bdrv_get_aio_context(bs);
2488 aio_context_acquire(aio_context);
2490 /* Although backup_run has this check too, we need to use bs->drv below, so
2491 * do an early check redundantly. */
2492 if (!bdrv_is_inserted(bs)) {
2493 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2498 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2501 /* Early check to avoid creating target */
2502 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2506 flags = bs->open_flags | BDRV_O_RDWR;
2508 /* See if we have a backing HD we can use to create our new image
2510 if (sync == MIRROR_SYNC_MODE_TOP) {
2511 source = bs->backing_hd;
2513 sync = MIRROR_SYNC_MODE_FULL;
2516 if (sync == MIRROR_SYNC_MODE_NONE) {
2520 size = bdrv_getlength(bs);
2522 error_setg_errno(errp, -size, "bdrv_getlength failed");
2526 if (mode != NEW_IMAGE_MODE_EXISTING) {
2529 bdrv_img_create(target, format, source->filename,
2530 source->drv->format_name, NULL,
2531 size, flags, &local_err, false);
2533 bdrv_img_create(target, format, NULL, NULL, NULL,
2534 size, flags, &local_err, false);
2539 error_propagate(errp, local_err);
2544 options = qdict_new();
2545 qdict_put(options, "driver", qstring_from_str(format));
2549 ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
2551 error_propagate(errp, local_err);
2555 bdrv_set_aio_context(target_bs, aio_context);
2558 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
2560 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
2565 backup_start(bs, target_bs, speed, sync, bmap,
2566 on_source_error, on_target_error,
2567 block_job_cb, bs, &local_err);
2568 if (local_err != NULL) {
2569 bdrv_unref(target_bs);
2570 error_propagate(errp, local_err);
2575 aio_context_release(aio_context);
2578 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2580 return bdrv_named_nodes_list(errp);
2583 void qmp_blockdev_backup(const char *device, const char *target,
2584 enum MirrorSyncMode sync,
2585 bool has_speed, int64_t speed,
2586 bool has_on_source_error,
2587 BlockdevOnError on_source_error,
2588 bool has_on_target_error,
2589 BlockdevOnError on_target_error,
2593 BlockDriverState *bs;
2594 BlockDriverState *target_bs;
2595 Error *local_err = NULL;
2596 AioContext *aio_context;
2601 if (!has_on_source_error) {
2602 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2604 if (!has_on_target_error) {
2605 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2608 blk = blk_by_name(device);
2610 error_setg(errp, "Device '%s' not found", device);
2615 aio_context = bdrv_get_aio_context(bs);
2616 aio_context_acquire(aio_context);
2618 blk = blk_by_name(target);
2620 error_setg(errp, "Device '%s' not found", target);
2623 target_bs = blk_bs(blk);
2625 bdrv_ref(target_bs);
2626 bdrv_set_aio_context(target_bs, aio_context);
2627 backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
2628 on_target_error, block_job_cb, bs, &local_err);
2629 if (local_err != NULL) {
2630 bdrv_unref(target_bs);
2631 error_propagate(errp, local_err);
2634 aio_context_release(aio_context);
2637 void qmp_drive_mirror(const char *device, const char *target,
2638 bool has_format, const char *format,
2639 bool has_node_name, const char *node_name,
2640 bool has_replaces, const char *replaces,
2641 enum MirrorSyncMode sync,
2642 bool has_mode, enum NewImageMode mode,
2643 bool has_speed, int64_t speed,
2644 bool has_granularity, uint32_t granularity,
2645 bool has_buf_size, int64_t buf_size,
2646 bool has_on_source_error, BlockdevOnError on_source_error,
2647 bool has_on_target_error, BlockdevOnError on_target_error,
2648 bool has_unmap, bool unmap,
2652 BlockDriverState *bs;
2653 BlockDriverState *source, *target_bs;
2654 AioContext *aio_context;
2655 Error *local_err = NULL;
2664 if (!has_on_source_error) {
2665 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2667 if (!has_on_target_error) {
2668 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2671 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2673 if (!has_granularity) {
2676 if (!has_buf_size) {
2683 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
2684 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2685 "a value in range [512B, 64MB]");
2688 if (granularity & (granularity - 1)) {
2689 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2694 blk = blk_by_name(device);
2696 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2697 "Device '%s' not found", device);
2702 aio_context = bdrv_get_aio_context(bs);
2703 aio_context_acquire(aio_context);
2705 if (!bdrv_is_inserted(bs)) {
2706 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2711 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2714 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
2718 flags = bs->open_flags | BDRV_O_RDWR;
2719 source = bs->backing_hd;
2720 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
2721 sync = MIRROR_SYNC_MODE_FULL;
2723 if (sync == MIRROR_SYNC_MODE_NONE) {
2727 size = bdrv_getlength(bs);
2729 error_setg_errno(errp, -size, "bdrv_getlength failed");
2734 BlockDriverState *to_replace_bs;
2735 AioContext *replace_aio_context;
2736 int64_t replace_size;
2738 if (!has_node_name) {
2739 error_setg(errp, "a node-name must be provided when replacing a"
2740 " named node of the graph");
2744 to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
2746 if (!to_replace_bs) {
2747 error_propagate(errp, local_err);
2751 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
2752 aio_context_acquire(replace_aio_context);
2753 replace_size = bdrv_getlength(to_replace_bs);
2754 aio_context_release(replace_aio_context);
2756 if (size != replace_size) {
2757 error_setg(errp, "cannot replace image with a mirror image of "
2763 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
2764 && mode != NEW_IMAGE_MODE_EXISTING)
2766 /* create new image w/o backing file */
2768 bdrv_img_create(target, format,
2769 NULL, NULL, NULL, size, flags, &local_err, false);
2772 case NEW_IMAGE_MODE_EXISTING:
2774 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
2775 /* create new image with backing file */
2776 bdrv_img_create(target, format,
2778 source->drv->format_name,
2779 NULL, size, flags, &local_err, false);
2787 error_propagate(errp, local_err);
2791 options = qdict_new();
2792 if (has_node_name) {
2793 qdict_put(options, "node-name", qstring_from_str(node_name));
2796 qdict_put(options, "driver", qstring_from_str(format));
2799 /* Mirroring takes care of copy-on-write using the source's backing
2803 ret = bdrv_open(&target_bs, target, NULL, options,
2804 flags | BDRV_O_NO_BACKING, &local_err);
2806 error_propagate(errp, local_err);
2810 bdrv_set_aio_context(target_bs, aio_context);
2812 /* pass the node name to replace to mirror start since it's loose coupling
2813 * and will allow to check whether the node still exist at mirror completion
2815 mirror_start(bs, target_bs,
2816 has_replaces ? replaces : NULL,
2817 speed, granularity, buf_size, sync,
2818 on_source_error, on_target_error,
2820 block_job_cb, bs, &local_err);
2821 if (local_err != NULL) {
2822 bdrv_unref(target_bs);
2823 error_propagate(errp, local_err);
2828 aio_context_release(aio_context);
2831 /* Get the block job for a given device name and acquire its AioContext */
2832 static BlockJob *find_block_job(const char *device, AioContext **aio_context,
2836 BlockDriverState *bs;
2838 blk = blk_by_name(device);
2844 *aio_context = bdrv_get_aio_context(bs);
2845 aio_context_acquire(*aio_context);
2848 aio_context_release(*aio_context);
2855 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
2856 "No active block job on device '%s'", device);
2857 *aio_context = NULL;
2861 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
2863 AioContext *aio_context;
2864 BlockJob *job = find_block_job(device, &aio_context, errp);
2870 block_job_set_speed(job, speed, errp);
2871 aio_context_release(aio_context);
2874 void qmp_block_job_cancel(const char *device,
2875 bool has_force, bool force, Error **errp)
2877 AioContext *aio_context;
2878 BlockJob *job = find_block_job(device, &aio_context, errp);
2888 if (job->user_paused && !force) {
2889 error_setg(errp, "The block job for device '%s' is currently paused",
2894 trace_qmp_block_job_cancel(job);
2895 block_job_cancel(job);
2897 aio_context_release(aio_context);
2900 void qmp_block_job_pause(const char *device, Error **errp)
2902 AioContext *aio_context;
2903 BlockJob *job = find_block_job(device, &aio_context, errp);
2905 if (!job || job->user_paused) {
2909 job->user_paused = true;
2910 trace_qmp_block_job_pause(job);
2911 block_job_pause(job);
2912 aio_context_release(aio_context);
2915 void qmp_block_job_resume(const char *device, Error **errp)
2917 AioContext *aio_context;
2918 BlockJob *job = find_block_job(device, &aio_context, errp);
2920 if (!job || !job->user_paused) {
2924 job->user_paused = false;
2925 trace_qmp_block_job_resume(job);
2926 block_job_resume(job);
2927 aio_context_release(aio_context);
2930 void qmp_block_job_complete(const char *device, Error **errp)
2932 AioContext *aio_context;
2933 BlockJob *job = find_block_job(device, &aio_context, errp);
2939 trace_qmp_block_job_complete(job);
2940 block_job_complete(job, errp);
2941 aio_context_release(aio_context);
2944 void qmp_change_backing_file(const char *device,
2945 const char *image_node_name,
2946 const char *backing_file,
2950 BlockDriverState *bs = NULL;
2951 AioContext *aio_context;
2952 BlockDriverState *image_bs = NULL;
2953 Error *local_err = NULL;
2958 blk = blk_by_name(device);
2960 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2961 "Device '%s' not found", device);
2966 aio_context = bdrv_get_aio_context(bs);
2967 aio_context_acquire(aio_context);
2969 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
2971 error_propagate(errp, local_err);
2976 error_setg(errp, "image file not found");
2980 if (bdrv_find_base(image_bs) == image_bs) {
2981 error_setg(errp, "not allowing backing file change on an image "
2982 "without a backing file");
2986 /* even though we are not necessarily operating on bs, we need it to
2987 * determine if block ops are currently prohibited on the chain */
2988 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
2992 /* final sanity check */
2993 if (!bdrv_chain_contains(bs, image_bs)) {
2994 error_setg(errp, "'%s' and image file are not in the same chain",
2999 /* if not r/w, reopen to make r/w */
3000 open_flags = image_bs->open_flags;
3001 ro = bdrv_is_read_only(image_bs);
3004 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3006 error_propagate(errp, local_err);
3011 ret = bdrv_change_backing_file(image_bs, backing_file,
3012 image_bs->drv ? image_bs->drv->format_name : "");
3015 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3017 /* don't exit here, so we can try to restore open flags if
3022 bdrv_reopen(image_bs, open_flags, &local_err);
3024 error_propagate(errp, local_err); /* will preserve prior errp */
3029 aio_context_release(aio_context);
3032 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3034 QmpOutputVisitor *ov = qmp_output_visitor_new();
3038 Error *local_err = NULL;
3040 /* Require an ID in the top level */
3041 if (!options->has_id) {
3042 error_setg(errp, "Block device needs an ID");
3046 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3047 * cache.direct=false instead of silently switching to aio=threads, except
3048 * when called from drive_new().
3050 * For now, simply forbidding the combination for all drivers will do. */
3051 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3052 bool direct = options->has_cache &&
3053 options->cache->has_direct &&
3054 options->cache->direct;
3056 error_setg(errp, "aio=native requires cache.direct=true");
3061 visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
3062 &options, NULL, &local_err);
3064 error_propagate(errp, local_err);
3068 obj = qmp_output_get_qobject(ov);
3069 qdict = qobject_to_qdict(obj);
3071 qdict_flatten(qdict);
3073 blk = blockdev_init(NULL, qdict, &local_err);
3075 error_propagate(errp, local_err);
3079 if (bdrv_key_required(blk_bs(blk))) {
3081 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3086 qmp_output_visitor_cleanup(ov);
3089 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3091 BlockJobInfoList *head = NULL, **p_next = &head;
3092 BlockDriverState *bs;
3094 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
3095 AioContext *aio_context = bdrv_get_aio_context(bs);
3097 aio_context_acquire(aio_context);
3100 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
3101 elem->value = block_job_query(bs->job);
3103 p_next = &elem->next;
3106 aio_context_release(aio_context);
3112 QemuOptsList qemu_common_drive_opts = {
3114 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3118 .type = QEMU_OPT_BOOL,
3119 .help = "enable/disable snapshot mode",
3122 .type = QEMU_OPT_STRING,
3123 .help = "discard operation (ignore/off, unmap/on)",
3125 .name = BDRV_OPT_CACHE_WB,
3126 .type = QEMU_OPT_BOOL,
3127 .help = "enables writeback mode for any caches",
3129 .name = BDRV_OPT_CACHE_DIRECT,
3130 .type = QEMU_OPT_BOOL,
3131 .help = "enables use of O_DIRECT (bypass the host page cache)",
3133 .name = BDRV_OPT_CACHE_NO_FLUSH,
3134 .type = QEMU_OPT_BOOL,
3135 .help = "ignore any flush requests for the device",
3138 .type = QEMU_OPT_STRING,
3139 .help = "host AIO implementation (threads, native)",
3142 .type = QEMU_OPT_STRING,
3143 .help = "disk format (raw, qcow2, ...)",
3146 .type = QEMU_OPT_STRING,
3147 .help = "read error action",
3150 .type = QEMU_OPT_STRING,
3151 .help = "write error action",
3153 .name = "read-only",
3154 .type = QEMU_OPT_BOOL,
3155 .help = "open drive file as read-only",
3157 .name = "throttling.iops-total",
3158 .type = QEMU_OPT_NUMBER,
3159 .help = "limit total I/O operations per second",
3161 .name = "throttling.iops-read",
3162 .type = QEMU_OPT_NUMBER,
3163 .help = "limit read operations per second",
3165 .name = "throttling.iops-write",
3166 .type = QEMU_OPT_NUMBER,
3167 .help = "limit write operations per second",
3169 .name = "throttling.bps-total",
3170 .type = QEMU_OPT_NUMBER,
3171 .help = "limit total bytes per second",
3173 .name = "throttling.bps-read",
3174 .type = QEMU_OPT_NUMBER,
3175 .help = "limit read bytes per second",
3177 .name = "throttling.bps-write",
3178 .type = QEMU_OPT_NUMBER,
3179 .help = "limit write bytes per second",
3181 .name = "throttling.iops-total-max",
3182 .type = QEMU_OPT_NUMBER,
3183 .help = "I/O operations burst",
3185 .name = "throttling.iops-read-max",
3186 .type = QEMU_OPT_NUMBER,
3187 .help = "I/O operations read burst",
3189 .name = "throttling.iops-write-max",
3190 .type = QEMU_OPT_NUMBER,
3191 .help = "I/O operations write burst",
3193 .name = "throttling.bps-total-max",
3194 .type = QEMU_OPT_NUMBER,
3195 .help = "total bytes burst",
3197 .name = "throttling.bps-read-max",
3198 .type = QEMU_OPT_NUMBER,
3199 .help = "total bytes read burst",
3201 .name = "throttling.bps-write-max",
3202 .type = QEMU_OPT_NUMBER,
3203 .help = "total bytes write burst",
3205 .name = "throttling.iops-size",
3206 .type = QEMU_OPT_NUMBER,
3207 .help = "when limiting by iops max size of an I/O in bytes",
3209 .name = "throttling.group",
3210 .type = QEMU_OPT_STRING,
3211 .help = "name of the block throttling group",
3213 .name = "copy-on-read",
3214 .type = QEMU_OPT_BOOL,
3215 .help = "copy read data from backing file into image file",
3217 .name = "detect-zeroes",
3218 .type = QEMU_OPT_STRING,
3219 .help = "try to optimize zero writes (off, on, unmap)",
3221 { /* end of list */ }
3225 QemuOptsList qemu_drive_opts = {
3227 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3230 * no elements => accept any params
3231 * validation will happen later
3233 { /* end of list */ }