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/blockdev.h"
34 #include "hw/block/block.h"
35 #include "block/blockjob.h"
36 #include "monitor/monitor.h"
37 #include "qapi/qmp/qerror.h"
38 #include "qemu/option.h"
39 #include "qemu/config-file.h"
40 #include "qapi/qmp/types.h"
41 #include "sysemu/sysemu.h"
42 #include "block/block_int.h"
43 #include "qmp-commands.h"
45 #include "sysemu/arch_init.h"
47 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
48 extern QemuOptsList qemu_common_drive_opts;
50 static const char *const if_name[IF_COUNT] = {
54 [IF_FLOPPY] = "floppy",
55 [IF_PFLASH] = "pflash",
58 [IF_VIRTIO] = "virtio",
62 static const int if_max_devs[IF_COUNT] = {
64 * Do not change these numbers! They govern how drive option
65 * index maps to unit and bus. That mapping is ABI.
67 * All controllers used to imlement if=T drives need to support
68 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
69 * Otherwise, some index values map to "impossible" bus, unit
72 * For instance, if you change [IF_SCSI] to 255, -drive
73 * if=scsi,index=12 no longer means bus=1,unit=5, but
74 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
75 * the drive can't be set up. Regression.
82 * We automatically delete the drive when a device using it gets
83 * unplugged. Questionable feature, but we can't just drop it.
84 * Device models call blockdev_mark_auto_del() to schedule the
85 * automatic deletion, and generic qdev code calls blockdev_auto_del()
86 * when deletion is actually safe.
88 void blockdev_mark_auto_del(BlockDriverState *bs)
90 DriveInfo *dinfo = drive_get_by_blockdev(bs);
93 block_job_cancel(bs->job);
100 void blockdev_auto_del(BlockDriverState *bs)
102 DriveInfo *dinfo = drive_get_by_blockdev(bs);
104 if (dinfo && dinfo->auto_del) {
105 drive_put_ref(dinfo);
109 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
111 int max_devs = if_max_devs[type];
112 return max_devs ? index / max_devs : 0;
115 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
117 int max_devs = if_max_devs[type];
118 return max_devs ? index % max_devs : index;
121 QemuOpts *drive_def(const char *optstr)
123 return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
126 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
132 opts = drive_def(optstr);
136 if (type != IF_DEFAULT) {
137 qemu_opt_set(opts, "if", if_name[type]);
140 snprintf(buf, sizeof(buf), "%d", index);
141 qemu_opt_set(opts, "index", buf);
144 qemu_opt_set(opts, "file", file);
148 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
152 /* seek interface, bus and unit */
154 QTAILQ_FOREACH(dinfo, &drives, next) {
155 if (dinfo->type == type &&
164 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
166 return drive_get(type,
167 drive_index_to_bus_id(type, index),
168 drive_index_to_unit_id(type, index));
171 int drive_get_max_bus(BlockInterfaceType type)
177 QTAILQ_FOREACH(dinfo, &drives, next) {
178 if(dinfo->type == type &&
179 dinfo->bus > max_bus)
180 max_bus = dinfo->bus;
185 /* Get a block device. This should only be used for single-drive devices
186 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
188 DriveInfo *drive_get_next(BlockInterfaceType type)
190 static int next_block_unit[IF_COUNT];
192 return drive_get(type, 0, next_block_unit[type]++);
195 DriveInfo *drive_get_by_blockdev(BlockDriverState *bs)
199 QTAILQ_FOREACH(dinfo, &drives, next) {
200 if (dinfo->bdrv == bs) {
207 static void bdrv_format_print(void *opaque, const char *name)
209 error_printf(" %s", name);
212 static void drive_uninit(DriveInfo *dinfo)
214 qemu_opts_del(dinfo->opts);
215 bdrv_unref(dinfo->bdrv);
217 QTAILQ_REMOVE(&drives, dinfo, next);
218 g_free(dinfo->serial);
222 void drive_put_ref(DriveInfo *dinfo)
224 assert(dinfo->refcount);
225 if (--dinfo->refcount == 0) {
230 void drive_get_ref(DriveInfo *dinfo)
237 BlockDriverState *bs;
240 static void bdrv_put_ref_bh(void *opaque)
242 BDRVPutRefBH *s = opaque;
245 qemu_bh_delete(s->bh);
250 * Release a BDS reference in a BH
252 * It is not safe to use bdrv_unref() from a callback function when the callers
253 * still need the BlockDriverState. In such cases we schedule a BH to release
256 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
260 s = g_new(BDRVPutRefBH, 1);
261 s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
263 qemu_bh_schedule(s->bh);
266 static int parse_block_error_action(const char *buf, bool is_read)
268 if (!strcmp(buf, "ignore")) {
269 return BLOCKDEV_ON_ERROR_IGNORE;
270 } else if (!is_read && !strcmp(buf, "enospc")) {
271 return BLOCKDEV_ON_ERROR_ENOSPC;
272 } else if (!strcmp(buf, "stop")) {
273 return BLOCKDEV_ON_ERROR_STOP;
274 } else if (!strcmp(buf, "report")) {
275 return BLOCKDEV_ON_ERROR_REPORT;
277 error_report("'%s' invalid %s error action",
278 buf, is_read ? "read" : "write");
283 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
285 if (throttle_conflicting(cfg)) {
286 error_setg(errp, "bps/iops/max total values and read/write values"
287 " cannot be used at the same time");
291 if (!throttle_is_valid(cfg)) {
292 error_setg(errp, "bps/iops/maxs values must be 0 or greater");
299 static DriveInfo *blockdev_init(QemuOpts *all_opts,
300 BlockInterfaceType block_default_type)
303 const char *file = NULL;
305 const char *mediastr = "";
306 BlockInterfaceType type;
307 enum { MEDIA_DISK, MEDIA_CDROM } media;
309 int cyls, heads, secs, translation;
314 int on_read_error, on_write_error;
325 bool has_driver_specific_opts;
326 BlockDriver *drv = NULL;
328 translation = BIOS_ATA_TRANSLATION_AUTO;
331 /* Check common options by copying from all_opts to opts, all other options
332 * are stored in bs_opts. */
333 id = qemu_opts_id(all_opts);
334 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
335 if (error_is_set(&error)) {
336 qerror_report_err(error);
341 bs_opts = qdict_new();
342 qemu_opts_to_qdict(all_opts, bs_opts);
343 qemu_opts_absorb_qdict(opts, bs_opts, &error);
344 if (error_is_set(&error)) {
345 qerror_report_err(error);
351 qdict_del(bs_opts, "id");
354 has_driver_specific_opts = !!qdict_size(bs_opts);
356 /* extract parameters */
357 bus_id = qemu_opt_get_number(opts, "bus", 0);
358 unit_id = qemu_opt_get_number(opts, "unit", -1);
359 index = qemu_opt_get_number(opts, "index", -1);
361 cyls = qemu_opt_get_number(opts, "cyls", 0);
362 heads = qemu_opt_get_number(opts, "heads", 0);
363 secs = qemu_opt_get_number(opts, "secs", 0);
365 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
366 ro = qemu_opt_get_bool(opts, "read-only", 0);
367 copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
369 file = qemu_opt_get(opts, "file");
370 serial = qemu_opt_get(opts, "serial");
372 if ((buf = qemu_opt_get(opts, "if")) != NULL) {
373 for (type = 0; type < IF_COUNT && strcmp(buf, if_name[type]); type++)
375 if (type == IF_COUNT) {
376 error_report("unsupported bus type '%s'", buf);
380 type = block_default_type;
383 max_devs = if_max_devs[type];
385 if (cyls || heads || secs) {
387 error_report("invalid physical cyls number");
391 error_report("invalid physical heads number");
395 error_report("invalid physical secs number");
400 if ((buf = qemu_opt_get(opts, "trans")) != NULL) {
402 error_report("'%s' trans must be used with cyls, heads and secs",
406 if (!strcmp(buf, "none"))
407 translation = BIOS_ATA_TRANSLATION_NONE;
408 else if (!strcmp(buf, "lba"))
409 translation = BIOS_ATA_TRANSLATION_LBA;
410 else if (!strcmp(buf, "auto"))
411 translation = BIOS_ATA_TRANSLATION_AUTO;
413 error_report("'%s' invalid translation type", buf);
418 if ((buf = qemu_opt_get(opts, "media")) != NULL) {
419 if (!strcmp(buf, "disk")) {
421 } else if (!strcmp(buf, "cdrom")) {
422 if (cyls || secs || heads) {
423 error_report("CHS can't be set with media=%s", buf);
428 error_report("'%s' invalid media", buf);
433 if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
434 if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
435 error_report("invalid discard option");
440 if (qemu_opt_get_bool(opts, "cache.writeback", true)) {
441 bdrv_flags |= BDRV_O_CACHE_WB;
443 if (qemu_opt_get_bool(opts, "cache.direct", false)) {
444 bdrv_flags |= BDRV_O_NOCACHE;
446 if (qemu_opt_get_bool(opts, "cache.no-flush", true)) {
447 bdrv_flags |= BDRV_O_NO_FLUSH;
450 #ifdef CONFIG_LINUX_AIO
451 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
452 if (!strcmp(buf, "native")) {
453 bdrv_flags |= BDRV_O_NATIVE_AIO;
454 } else if (!strcmp(buf, "threads")) {
455 /* this is the default */
457 error_report("invalid aio option");
463 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
464 if (is_help_option(buf)) {
465 error_printf("Supported formats:");
466 bdrv_iterate_format(bdrv_format_print, NULL);
471 drv = bdrv_find_whitelisted_format(buf, ro);
473 if (!ro && bdrv_find_whitelisted_format(buf, !ro)) {
474 error_report("'%s' can be only used as read-only device.", buf);
476 error_report("'%s' invalid format", buf);
482 /* disk I/O throttling */
483 memset(&cfg, 0, sizeof(cfg));
484 cfg.buckets[THROTTLE_BPS_TOTAL].avg =
485 qemu_opt_get_number(opts, "throttling.bps-total", 0);
486 cfg.buckets[THROTTLE_BPS_READ].avg =
487 qemu_opt_get_number(opts, "throttling.bps-read", 0);
488 cfg.buckets[THROTTLE_BPS_WRITE].avg =
489 qemu_opt_get_number(opts, "throttling.bps-write", 0);
490 cfg.buckets[THROTTLE_OPS_TOTAL].avg =
491 qemu_opt_get_number(opts, "throttling.iops-total", 0);
492 cfg.buckets[THROTTLE_OPS_READ].avg =
493 qemu_opt_get_number(opts, "throttling.iops-read", 0);
494 cfg.buckets[THROTTLE_OPS_WRITE].avg =
495 qemu_opt_get_number(opts, "throttling.iops-write", 0);
497 cfg.buckets[THROTTLE_BPS_TOTAL].max =
498 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
499 cfg.buckets[THROTTLE_BPS_READ].max =
500 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
501 cfg.buckets[THROTTLE_BPS_WRITE].max =
502 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
503 cfg.buckets[THROTTLE_OPS_TOTAL].max =
504 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
505 cfg.buckets[THROTTLE_OPS_READ].max =
506 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
507 cfg.buckets[THROTTLE_OPS_WRITE].max =
508 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
510 cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
512 if (!check_throttle_config(&cfg, &error)) {
513 error_report("%s", error_get_pretty(error));
518 if (qemu_opt_get(opts, "boot") != NULL) {
519 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
520 "ignored. Future versions will reject this parameter. Please "
521 "update your scripts.\n");
524 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
525 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
526 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO && type != IF_NONE) {
527 error_report("werror is not supported by this bus type");
531 on_write_error = parse_block_error_action(buf, 0);
532 if (on_write_error < 0) {
537 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
538 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
539 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI && type != IF_NONE) {
540 error_report("rerror is not supported by this bus type");
544 on_read_error = parse_block_error_action(buf, 1);
545 if (on_read_error < 0) {
550 if ((devaddr = qemu_opt_get(opts, "addr")) != NULL) {
551 if (type != IF_VIRTIO) {
552 error_report("addr is not supported by this bus type");
557 /* compute bus and unit according index */
560 if (bus_id != 0 || unit_id != -1) {
561 error_report("index cannot be used with bus and unit");
564 bus_id = drive_index_to_bus_id(type, index);
565 unit_id = drive_index_to_unit_id(type, index);
568 /* if user doesn't specify a unit_id,
569 * try to find the first free
574 while (drive_get(type, bus_id, unit_id) != NULL) {
576 if (max_devs && unit_id >= max_devs) {
585 if (max_devs && unit_id >= max_devs) {
586 error_report("unit %d too big (max is %d)",
587 unit_id, max_devs - 1);
592 * catch multiple definitions
595 if (drive_get(type, bus_id, unit_id) != NULL) {
596 error_report("drive with bus=%d, unit=%d (index=%d) exists",
597 bus_id, unit_id, index);
603 dinfo = g_malloc0(sizeof(*dinfo));
604 if ((buf = qemu_opts_id(opts)) != NULL) {
605 dinfo->id = g_strdup(buf);
607 /* no id supplied -> create one */
608 dinfo->id = g_malloc0(32);
609 if (type == IF_IDE || type == IF_SCSI)
610 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
612 snprintf(dinfo->id, 32, "%s%i%s%i",
613 if_name[type], bus_id, mediastr, unit_id);
615 snprintf(dinfo->id, 32, "%s%s%i",
616 if_name[type], mediastr, unit_id);
618 dinfo->bdrv = bdrv_new(dinfo->id);
619 dinfo->bdrv->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
620 dinfo->bdrv->read_only = ro;
621 dinfo->devaddr = devaddr;
624 dinfo->unit = unit_id;
626 dinfo->heads = heads;
628 dinfo->trans = translation;
629 dinfo->opts = all_opts;
631 if (serial != NULL) {
632 dinfo->serial = g_strdup(serial);
634 QTAILQ_INSERT_TAIL(&drives, dinfo, next);
636 bdrv_set_on_error(dinfo->bdrv, on_read_error, on_write_error);
638 /* disk I/O throttling */
639 if (throttle_enabled(&cfg)) {
640 bdrv_io_limits_enable(dinfo->bdrv);
641 bdrv_set_io_limits(dinfo->bdrv, &cfg);
649 dinfo->media_cd = media == MEDIA_CDROM;
658 /* add virtio block device */
660 devopts = qemu_opts_create_nofail(qemu_find_opts("device"));
661 if (arch_type == QEMU_ARCH_S390X) {
662 qemu_opt_set(devopts, "driver", "virtio-blk-s390");
664 qemu_opt_set(devopts, "driver", "virtio-blk-pci");
666 qemu_opt_set(devopts, "drive", dinfo->id);
668 qemu_opt_set(devopts, "addr", devaddr);
674 if (!file || !*file) {
675 if (has_driver_specific_opts) {
682 /* always use cache=unsafe with snapshot */
683 bdrv_flags &= ~BDRV_O_CACHE_MASK;
684 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
688 bdrv_flags |= BDRV_O_COPY_ON_READ;
691 if (runstate_check(RUN_STATE_INMIGRATE)) {
692 bdrv_flags |= BDRV_O_INCOMING;
695 if (media == MEDIA_CDROM) {
696 /* CDROM is fine for any interface, don't check. */
698 } else if (ro == 1) {
699 if (type != IF_SCSI && type != IF_VIRTIO && type != IF_FLOPPY &&
700 type != IF_NONE && type != IF_PFLASH) {
701 error_report("read-only not supported by this bus type");
706 bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
708 if (ro && copy_on_read) {
709 error_report("warning: disabling copy_on_read on read-only drive");
713 ret = bdrv_open(dinfo->bdrv, file, bs_opts, bdrv_flags, drv, &error);
716 error_report("could not open disk image %s: %s",
717 file ?: dinfo->id, error_get_pretty(error));
721 if (bdrv_key_required(dinfo->bdrv))
732 bdrv_unref(dinfo->bdrv);
734 QTAILQ_REMOVE(&drives, dinfo, next);
739 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to)
743 value = qemu_opt_get(opts, from);
745 qemu_opt_set(opts, to, value);
746 qemu_opt_unset(opts, from);
750 DriveInfo *drive_init(QemuOpts *all_opts, BlockInterfaceType block_default_type)
754 /* Change legacy command line options into QMP ones */
755 qemu_opt_rename(all_opts, "iops", "throttling.iops-total");
756 qemu_opt_rename(all_opts, "iops_rd", "throttling.iops-read");
757 qemu_opt_rename(all_opts, "iops_wr", "throttling.iops-write");
759 qemu_opt_rename(all_opts, "bps", "throttling.bps-total");
760 qemu_opt_rename(all_opts, "bps_rd", "throttling.bps-read");
761 qemu_opt_rename(all_opts, "bps_wr", "throttling.bps-write");
763 qemu_opt_rename(all_opts, "iops_max", "throttling.iops-total-max");
764 qemu_opt_rename(all_opts, "iops_rd_max", "throttling.iops-read-max");
765 qemu_opt_rename(all_opts, "iops_wr_max", "throttling.iops-write-max");
767 qemu_opt_rename(all_opts, "bps_max", "throttling.bps-total-max");
768 qemu_opt_rename(all_opts, "bps_rd_max", "throttling.bps-read-max");
769 qemu_opt_rename(all_opts, "bps_wr_max", "throttling.bps-write-max");
771 qemu_opt_rename(all_opts,
772 "iops_size", "throttling.iops-size");
774 qemu_opt_rename(all_opts, "readonly", "read-only");
776 value = qemu_opt_get(all_opts, "cache");
780 if (bdrv_parse_cache_flags(value, &flags) != 0) {
781 error_report("invalid cache option");
785 /* Specific options take precedence */
786 if (!qemu_opt_get(all_opts, "cache.writeback")) {
787 qemu_opt_set_bool(all_opts, "cache.writeback",
788 !!(flags & BDRV_O_CACHE_WB));
790 if (!qemu_opt_get(all_opts, "cache.direct")) {
791 qemu_opt_set_bool(all_opts, "cache.direct",
792 !!(flags & BDRV_O_NOCACHE));
794 if (!qemu_opt_get(all_opts, "cache.no-flush")) {
795 qemu_opt_set_bool(all_opts, "cache.no-flush",
796 !!(flags & BDRV_O_NO_FLUSH));
798 qemu_opt_unset(all_opts, "cache");
801 return blockdev_init(all_opts, block_default_type);
804 void do_commit(Monitor *mon, const QDict *qdict)
806 const char *device = qdict_get_str(qdict, "device");
807 BlockDriverState *bs;
810 if (!strcmp(device, "all")) {
811 ret = bdrv_commit_all();
813 bs = bdrv_find(device);
815 monitor_printf(mon, "Device '%s' not found\n", device);
818 ret = bdrv_commit(bs);
821 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
826 static void blockdev_do_action(int kind, void *data, Error **errp)
828 TransactionAction action;
829 TransactionActionList list;
833 list.value = &action;
835 qmp_transaction(&list, errp);
838 void qmp_blockdev_snapshot_sync(const char *device, const char *snapshot_file,
839 bool has_format, const char *format,
840 bool has_mode, enum NewImageMode mode,
843 BlockdevSnapshot snapshot = {
844 .device = (char *) device,
845 .snapshot_file = (char *) snapshot_file,
846 .has_format = has_format,
847 .format = (char *) format,
848 .has_mode = has_mode,
851 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
855 void qmp_blockdev_snapshot_internal_sync(const char *device,
859 BlockdevSnapshotInternal snapshot = {
860 .device = (char *) device,
861 .name = (char *) name
864 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
868 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
875 BlockDriverState *bs = bdrv_find(device);
877 Error *local_err = NULL;
878 SnapshotInfo *info = NULL;
882 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
895 error_setg(errp, "Name or id must be provided");
899 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
900 if (error_is_set(&local_err)) {
901 error_propagate(errp, local_err);
906 "Snapshot with id '%s' and name '%s' does not exist on "
908 STR_OR_NULL(id), STR_OR_NULL(name), device);
912 bdrv_snapshot_delete(bs, id, name, &local_err);
913 if (error_is_set(&local_err)) {
914 error_propagate(errp, local_err);
918 info = g_malloc0(sizeof(SnapshotInfo));
919 info->id = g_strdup(sn.id_str);
920 info->name = g_strdup(sn.name);
921 info->date_nsec = sn.date_nsec;
922 info->date_sec = sn.date_sec;
923 info->vm_state_size = sn.vm_state_size;
924 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
925 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
930 /* New and old BlockDriverState structs for group snapshots */
932 typedef struct BlkTransactionState BlkTransactionState;
934 /* Only prepare() may fail. In a single transaction, only one of commit() or
935 abort() will be called, clean() will always be called if it present. */
936 typedef struct BdrvActionOps {
937 /* Size of state struct, in bytes. */
938 size_t instance_size;
939 /* Prepare the work, must NOT be NULL. */
940 void (*prepare)(BlkTransactionState *common, Error **errp);
941 /* Commit the changes, can be NULL. */
942 void (*commit)(BlkTransactionState *common);
943 /* Abort the changes on fail, can be NULL. */
944 void (*abort)(BlkTransactionState *common);
945 /* Clean up resource in the end, can be NULL. */
946 void (*clean)(BlkTransactionState *common);
950 * This structure must be arranged as first member in child type, assuming
951 * that compiler will also arrange it to the same address with parent instance.
952 * Later it will be used in free().
954 struct BlkTransactionState {
955 TransactionAction *action;
956 const BdrvActionOps *ops;
957 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
960 /* internal snapshot private data */
961 typedef struct InternalSnapshotState {
962 BlkTransactionState common;
963 BlockDriverState *bs;
965 } InternalSnapshotState;
967 static void internal_snapshot_prepare(BlkTransactionState *common,
972 BlockDriverState *bs;
973 QEMUSnapshotInfo old_sn, *sn;
976 BlockdevSnapshotInternal *internal;
977 InternalSnapshotState *state;
980 g_assert(common->action->kind ==
981 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
982 internal = common->action->blockdev_snapshot_internal_sync;
983 state = DO_UPCAST(InternalSnapshotState, common, common);
986 device = internal->device;
987 name = internal->name;
989 /* 2. check for validation */
990 bs = bdrv_find(device);
992 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
996 if (!bdrv_is_inserted(bs)) {
997 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1001 if (bdrv_is_read_only(bs)) {
1002 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1006 if (!bdrv_can_snapshot(bs)) {
1007 error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1008 bs->drv->format_name, device, "internal snapshot");
1012 if (!strlen(name)) {
1013 error_setg(errp, "Name is empty");
1017 /* check whether a snapshot with name exist */
1018 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn, errp);
1019 if (error_is_set(errp)) {
1023 "Snapshot with name '%s' already exists on device '%s'",
1028 /* 3. take the snapshot */
1030 pstrcpy(sn->name, sizeof(sn->name), name);
1031 qemu_gettimeofday(&tv);
1032 sn->date_sec = tv.tv_sec;
1033 sn->date_nsec = tv.tv_usec * 1000;
1034 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1036 ret1 = bdrv_snapshot_create(bs, sn);
1038 error_setg_errno(errp, -ret1,
1039 "Failed to create snapshot '%s' on device '%s'",
1044 /* 4. succeed, mark a snapshot is created */
1048 static void internal_snapshot_abort(BlkTransactionState *common)
1050 InternalSnapshotState *state =
1051 DO_UPCAST(InternalSnapshotState, common, common);
1052 BlockDriverState *bs = state->bs;
1053 QEMUSnapshotInfo *sn = &state->sn;
1054 Error *local_error = NULL;
1060 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1061 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1062 "device '%s' in abort: %s",
1065 bdrv_get_device_name(bs),
1066 error_get_pretty(local_error));
1067 error_free(local_error);
1071 /* external snapshot private data */
1072 typedef struct ExternalSnapshotState {
1073 BlkTransactionState common;
1074 BlockDriverState *old_bs;
1075 BlockDriverState *new_bs;
1076 } ExternalSnapshotState;
1078 static void external_snapshot_prepare(BlkTransactionState *common,
1083 Error *local_err = NULL;
1085 const char *new_image_file;
1086 const char *format = "qcow2";
1087 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1088 ExternalSnapshotState *state =
1089 DO_UPCAST(ExternalSnapshotState, common, common);
1090 TransactionAction *action = common->action;
1092 /* get parameters */
1093 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1095 device = action->blockdev_snapshot_sync->device;
1096 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1097 if (action->blockdev_snapshot_sync->has_format) {
1098 format = action->blockdev_snapshot_sync->format;
1100 if (action->blockdev_snapshot_sync->has_mode) {
1101 mode = action->blockdev_snapshot_sync->mode;
1104 /* start processing */
1105 drv = bdrv_find_format(format);
1107 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1111 state->old_bs = bdrv_find(device);
1112 if (!state->old_bs) {
1113 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1117 if (!bdrv_is_inserted(state->old_bs)) {
1118 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1122 if (bdrv_in_use(state->old_bs)) {
1123 error_set(errp, QERR_DEVICE_IN_USE, device);
1127 if (!bdrv_is_read_only(state->old_bs)) {
1128 if (bdrv_flush(state->old_bs)) {
1129 error_set(errp, QERR_IO_ERROR);
1134 flags = state->old_bs->open_flags;
1136 /* create new image w/backing file */
1137 if (mode != NEW_IMAGE_MODE_EXISTING) {
1138 bdrv_img_create(new_image_file, format,
1139 state->old_bs->filename,
1140 state->old_bs->drv->format_name,
1141 NULL, -1, flags, &local_err, false);
1142 if (error_is_set(&local_err)) {
1143 error_propagate(errp, local_err);
1148 /* We will manually add the backing_hd field to the bs later */
1149 state->new_bs = bdrv_new("");
1150 /* TODO Inherit bs->options or only take explicit options with an
1151 * extended QMP command? */
1152 ret = bdrv_open(state->new_bs, new_image_file, NULL,
1153 flags | BDRV_O_NO_BACKING, drv, &local_err);
1155 error_propagate(errp, local_err);
1159 static void external_snapshot_commit(BlkTransactionState *common)
1161 ExternalSnapshotState *state =
1162 DO_UPCAST(ExternalSnapshotState, common, common);
1164 /* This removes our old bs and adds the new bs */
1165 bdrv_append(state->new_bs, state->old_bs);
1166 /* We don't need (or want) to use the transactional
1167 * bdrv_reopen_multiple() across all the entries at once, because we
1168 * don't want to abort all of them if one of them fails the reopen */
1169 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1173 static void external_snapshot_abort(BlkTransactionState *common)
1175 ExternalSnapshotState *state =
1176 DO_UPCAST(ExternalSnapshotState, common, common);
1177 if (state->new_bs) {
1178 bdrv_unref(state->new_bs);
1182 typedef struct DriveBackupState {
1183 BlkTransactionState common;
1184 BlockDriverState *bs;
1188 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1190 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1191 DriveBackup *backup;
1192 Error *local_err = NULL;
1194 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1195 backup = common->action->drive_backup;
1197 qmp_drive_backup(backup->device, backup->target,
1198 backup->has_format, backup->format,
1200 backup->has_mode, backup->mode,
1201 backup->has_speed, backup->speed,
1202 backup->has_on_source_error, backup->on_source_error,
1203 backup->has_on_target_error, backup->on_target_error,
1205 if (error_is_set(&local_err)) {
1206 error_propagate(errp, local_err);
1212 state->bs = bdrv_find(backup->device);
1213 state->job = state->bs->job;
1216 static void drive_backup_abort(BlkTransactionState *common)
1218 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1219 BlockDriverState *bs = state->bs;
1221 /* Only cancel if it's the job we started */
1222 if (bs && bs->job && bs->job == state->job) {
1223 block_job_cancel_sync(bs->job);
1227 static void abort_prepare(BlkTransactionState *common, Error **errp)
1229 error_setg(errp, "Transaction aborted using Abort action");
1232 static void abort_commit(BlkTransactionState *common)
1234 g_assert_not_reached(); /* this action never succeeds */
1237 static const BdrvActionOps actions[] = {
1238 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1239 .instance_size = sizeof(ExternalSnapshotState),
1240 .prepare = external_snapshot_prepare,
1241 .commit = external_snapshot_commit,
1242 .abort = external_snapshot_abort,
1244 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1245 .instance_size = sizeof(DriveBackupState),
1246 .prepare = drive_backup_prepare,
1247 .abort = drive_backup_abort,
1249 [TRANSACTION_ACTION_KIND_ABORT] = {
1250 .instance_size = sizeof(BlkTransactionState),
1251 .prepare = abort_prepare,
1252 .commit = abort_commit,
1254 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1255 .instance_size = sizeof(InternalSnapshotState),
1256 .prepare = internal_snapshot_prepare,
1257 .abort = internal_snapshot_abort,
1262 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1263 * then we do not pivot any of the devices in the group, and abandon the
1266 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1268 TransactionActionList *dev_entry = dev_list;
1269 BlkTransactionState *state, *next;
1270 Error *local_err = NULL;
1272 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1273 QSIMPLEQ_INIT(&snap_bdrv_states);
1275 /* drain all i/o before any snapshots */
1278 /* We don't do anything in this loop that commits us to the snapshot */
1279 while (NULL != dev_entry) {
1280 TransactionAction *dev_info = NULL;
1281 const BdrvActionOps *ops;
1283 dev_info = dev_entry->value;
1284 dev_entry = dev_entry->next;
1286 assert(dev_info->kind < ARRAY_SIZE(actions));
1288 ops = &actions[dev_info->kind];
1289 state = g_malloc0(ops->instance_size);
1291 state->action = dev_info;
1292 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1294 state->ops->prepare(state, &local_err);
1295 if (error_is_set(&local_err)) {
1296 error_propagate(errp, local_err);
1297 goto delete_and_fail;
1301 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1302 if (state->ops->commit) {
1303 state->ops->commit(state);
1312 * failure, and it is all-or-none; abandon each new bs, and keep using
1313 * the original bs for all images
1315 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1316 if (state->ops->abort) {
1317 state->ops->abort(state);
1321 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1322 if (state->ops->clean) {
1323 state->ops->clean(state);
1330 static void eject_device(BlockDriverState *bs, int force, Error **errp)
1332 if (bdrv_in_use(bs)) {
1333 error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
1336 if (!bdrv_dev_has_removable_media(bs)) {
1337 error_set(errp, QERR_DEVICE_NOT_REMOVABLE, bdrv_get_device_name(bs));
1341 if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
1342 bdrv_dev_eject_request(bs, force);
1344 error_set(errp, QERR_DEVICE_LOCKED, bdrv_get_device_name(bs));
1352 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1354 BlockDriverState *bs;
1356 bs = bdrv_find(device);
1358 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1362 eject_device(bs, force, errp);
1365 void qmp_block_passwd(const char *device, const char *password, Error **errp)
1367 BlockDriverState *bs;
1370 bs = bdrv_find(device);
1372 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1376 err = bdrv_set_key(bs, password);
1377 if (err == -EINVAL) {
1378 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1380 } else if (err < 0) {
1381 error_set(errp, QERR_INVALID_PASSWORD);
1386 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1387 int bdrv_flags, BlockDriver *drv,
1388 const char *password, Error **errp)
1390 Error *local_err = NULL;
1393 ret = bdrv_open(bs, filename, NULL, bdrv_flags, drv, &local_err);
1395 error_propagate(errp, local_err);
1399 if (bdrv_key_required(bs)) {
1401 if (bdrv_set_key(bs, password) < 0) {
1402 error_set(errp, QERR_INVALID_PASSWORD);
1405 error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
1406 bdrv_get_encrypted_filename(bs));
1408 } else if (password) {
1409 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1413 void qmp_change_blockdev(const char *device, const char *filename,
1414 bool has_format, const char *format, Error **errp)
1416 BlockDriverState *bs;
1417 BlockDriver *drv = NULL;
1421 bs = bdrv_find(device);
1423 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1428 drv = bdrv_find_whitelisted_format(format, bs->read_only);
1430 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1435 eject_device(bs, 0, &err);
1436 if (error_is_set(&err)) {
1437 error_propagate(errp, err);
1441 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1442 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1444 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1447 /* throttling disk I/O limits */
1448 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1455 bool has_bps_rd_max,
1457 bool has_bps_wr_max,
1461 bool has_iops_rd_max,
1462 int64_t iops_rd_max,
1463 bool has_iops_wr_max,
1464 int64_t iops_wr_max,
1466 int64_t iops_size, Error **errp)
1469 BlockDriverState *bs;
1471 bs = bdrv_find(device);
1473 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1477 memset(&cfg, 0, sizeof(cfg));
1478 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1479 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
1480 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1482 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1483 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
1484 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1487 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1489 if (has_bps_rd_max) {
1490 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
1492 if (has_bps_wr_max) {
1493 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
1496 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
1498 if (has_iops_rd_max) {
1499 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
1501 if (has_iops_wr_max) {
1502 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
1505 if (has_iops_size) {
1506 cfg.op_size = iops_size;
1509 if (!check_throttle_config(&cfg, errp)) {
1513 if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
1514 bdrv_io_limits_enable(bs);
1515 } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
1516 bdrv_io_limits_disable(bs);
1519 if (bs->io_limits_enabled) {
1520 bdrv_set_io_limits(bs, &cfg);
1524 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1526 const char *id = qdict_get_str(qdict, "id");
1527 BlockDriverState *bs;
1531 qerror_report(QERR_DEVICE_NOT_FOUND, id);
1534 if (bdrv_in_use(bs)) {
1535 qerror_report(QERR_DEVICE_IN_USE, id);
1539 /* quiesce block driver; prevent further io */
1544 /* if we have a device attached to this BlockDriverState
1545 * then we need to make the drive anonymous until the device
1546 * can be removed. If this is a drive with no device backing
1547 * then we can just get rid of the block driver state right here.
1549 if (bdrv_get_attached_dev(bs)) {
1552 /* Further I/O must not pause the guest */
1553 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
1554 BLOCKDEV_ON_ERROR_REPORT);
1556 drive_uninit(drive_get_by_blockdev(bs));
1562 void qmp_block_resize(const char *device, int64_t size, Error **errp)
1564 BlockDriverState *bs;
1567 bs = bdrv_find(device);
1569 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1574 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
1578 /* complete all in-flight operations before resizing the device */
1581 ret = bdrv_truncate(bs, size);
1586 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1589 error_set(errp, QERR_UNSUPPORTED);
1592 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1595 error_set(errp, QERR_DEVICE_IN_USE, device);
1598 error_setg_errno(errp, -ret, "Could not resize");
1603 static void block_job_cb(void *opaque, int ret)
1605 BlockDriverState *bs = opaque;
1608 trace_block_job_cb(bs, bs->job, ret);
1611 obj = qobject_from_block_job(bs->job);
1613 QDict *dict = qobject_to_qdict(obj);
1614 qdict_put(dict, "error", qstring_from_str(strerror(-ret)));
1617 if (block_job_is_cancelled(bs->job)) {
1618 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED, obj);
1620 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED, obj);
1622 qobject_decref(obj);
1624 bdrv_put_ref_bh_schedule(bs);
1627 void qmp_block_stream(const char *device, bool has_base,
1628 const char *base, bool has_speed, int64_t speed,
1629 bool has_on_error, BlockdevOnError on_error,
1632 BlockDriverState *bs;
1633 BlockDriverState *base_bs = NULL;
1634 Error *local_err = NULL;
1636 if (!has_on_error) {
1637 on_error = BLOCKDEV_ON_ERROR_REPORT;
1640 bs = bdrv_find(device);
1642 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1647 base_bs = bdrv_find_backing_image(bs, base);
1648 if (base_bs == NULL) {
1649 error_set(errp, QERR_BASE_NOT_FOUND, base);
1654 stream_start(bs, base_bs, base, has_speed ? speed : 0,
1655 on_error, block_job_cb, bs, &local_err);
1656 if (error_is_set(&local_err)) {
1657 error_propagate(errp, local_err);
1661 trace_qmp_block_stream(bs, bs->job);
1664 void qmp_block_commit(const char *device,
1665 bool has_base, const char *base, const char *top,
1666 bool has_speed, int64_t speed,
1669 BlockDriverState *bs;
1670 BlockDriverState *base_bs, *top_bs;
1671 Error *local_err = NULL;
1672 /* This will be part of the QMP command, if/when the
1673 * BlockdevOnError change for blkmirror makes it in
1675 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
1677 /* drain all i/o before commits */
1680 bs = bdrv_find(device);
1682 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1686 /* default top_bs is the active layer */
1690 if (strcmp(bs->filename, top) != 0) {
1691 top_bs = bdrv_find_backing_image(bs, top);
1695 if (top_bs == NULL) {
1696 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
1700 if (has_base && base) {
1701 base_bs = bdrv_find_backing_image(top_bs, base);
1703 base_bs = bdrv_find_base(top_bs);
1706 if (base_bs == NULL) {
1707 error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
1711 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
1713 if (local_err != NULL) {
1714 error_propagate(errp, local_err);
1719 void qmp_drive_backup(const char *device, const char *target,
1720 bool has_format, const char *format,
1721 enum MirrorSyncMode sync,
1722 bool has_mode, enum NewImageMode mode,
1723 bool has_speed, int64_t speed,
1724 bool has_on_source_error, BlockdevOnError on_source_error,
1725 bool has_on_target_error, BlockdevOnError on_target_error,
1728 BlockDriverState *bs;
1729 BlockDriverState *target_bs;
1730 BlockDriverState *source = NULL;
1731 BlockDriver *drv = NULL;
1732 Error *local_err = NULL;
1740 if (!has_on_source_error) {
1741 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1743 if (!has_on_target_error) {
1744 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1747 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1750 bs = bdrv_find(device);
1752 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1756 if (!bdrv_is_inserted(bs)) {
1757 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1762 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1765 drv = bdrv_find_format(format);
1767 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1772 if (bdrv_in_use(bs)) {
1773 error_set(errp, QERR_DEVICE_IN_USE, device);
1777 flags = bs->open_flags | BDRV_O_RDWR;
1779 /* See if we have a backing HD we can use to create our new image
1781 if (sync == MIRROR_SYNC_MODE_TOP) {
1782 source = bs->backing_hd;
1784 sync = MIRROR_SYNC_MODE_FULL;
1787 if (sync == MIRROR_SYNC_MODE_NONE) {
1791 size = bdrv_getlength(bs);
1793 error_setg_errno(errp, -size, "bdrv_getlength failed");
1797 if (mode != NEW_IMAGE_MODE_EXISTING) {
1798 assert(format && drv);
1800 bdrv_img_create(target, format, source->filename,
1801 source->drv->format_name, NULL,
1802 size, flags, &local_err, false);
1804 bdrv_img_create(target, format, NULL, NULL, NULL,
1805 size, flags, &local_err, false);
1809 if (error_is_set(&local_err)) {
1810 error_propagate(errp, local_err);
1814 target_bs = bdrv_new("");
1815 ret = bdrv_open(target_bs, target, NULL, flags, drv, &local_err);
1817 bdrv_unref(target_bs);
1818 error_propagate(errp, local_err);
1822 backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
1823 block_job_cb, bs, &local_err);
1824 if (local_err != NULL) {
1825 bdrv_unref(target_bs);
1826 error_propagate(errp, local_err);
1831 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1833 void qmp_drive_mirror(const char *device, const char *target,
1834 bool has_format, const char *format,
1835 enum MirrorSyncMode sync,
1836 bool has_mode, enum NewImageMode mode,
1837 bool has_speed, int64_t speed,
1838 bool has_granularity, uint32_t granularity,
1839 bool has_buf_size, int64_t buf_size,
1840 bool has_on_source_error, BlockdevOnError on_source_error,
1841 bool has_on_target_error, BlockdevOnError on_target_error,
1844 BlockDriverState *bs;
1845 BlockDriverState *source, *target_bs;
1846 BlockDriver *drv = NULL;
1847 Error *local_err = NULL;
1855 if (!has_on_source_error) {
1856 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1858 if (!has_on_target_error) {
1859 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1862 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1864 if (!has_granularity) {
1867 if (!has_buf_size) {
1868 buf_size = DEFAULT_MIRROR_BUF_SIZE;
1871 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
1872 error_set(errp, QERR_INVALID_PARAMETER, device);
1875 if (granularity & (granularity - 1)) {
1876 error_set(errp, QERR_INVALID_PARAMETER, device);
1880 bs = bdrv_find(device);
1882 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1886 if (!bdrv_is_inserted(bs)) {
1887 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1892 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1895 drv = bdrv_find_format(format);
1897 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1902 if (bdrv_in_use(bs)) {
1903 error_set(errp, QERR_DEVICE_IN_USE, device);
1907 flags = bs->open_flags | BDRV_O_RDWR;
1908 source = bs->backing_hd;
1909 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
1910 sync = MIRROR_SYNC_MODE_FULL;
1913 size = bdrv_getlength(bs);
1915 error_setg_errno(errp, -size, "bdrv_getlength failed");
1919 if (sync == MIRROR_SYNC_MODE_FULL && mode != NEW_IMAGE_MODE_EXISTING) {
1920 /* create new image w/o backing file */
1921 assert(format && drv);
1922 bdrv_img_create(target, format,
1923 NULL, NULL, NULL, size, flags, &local_err, false);
1926 case NEW_IMAGE_MODE_EXISTING:
1929 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
1930 /* create new image with backing file */
1931 bdrv_img_create(target, format,
1933 source->drv->format_name,
1934 NULL, size, flags, &local_err, false);
1941 if (error_is_set(&local_err)) {
1942 error_propagate(errp, local_err);
1946 /* Mirroring takes care of copy-on-write using the source's backing
1949 target_bs = bdrv_new("");
1950 ret = bdrv_open(target_bs, target, NULL, flags | BDRV_O_NO_BACKING, drv,
1953 bdrv_unref(target_bs);
1954 error_propagate(errp, local_err);
1958 mirror_start(bs, target_bs, speed, granularity, buf_size, sync,
1959 on_source_error, on_target_error,
1960 block_job_cb, bs, &local_err);
1961 if (local_err != NULL) {
1962 bdrv_unref(target_bs);
1963 error_propagate(errp, local_err);
1968 static BlockJob *find_block_job(const char *device)
1970 BlockDriverState *bs;
1972 bs = bdrv_find(device);
1973 if (!bs || !bs->job) {
1979 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
1981 BlockJob *job = find_block_job(device);
1984 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
1988 block_job_set_speed(job, speed, errp);
1991 void qmp_block_job_cancel(const char *device,
1992 bool has_force, bool force, Error **errp)
1994 BlockJob *job = find_block_job(device);
2001 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2004 if (job->paused && !force) {
2005 error_set(errp, QERR_BLOCK_JOB_PAUSED, device);
2009 trace_qmp_block_job_cancel(job);
2010 block_job_cancel(job);
2013 void qmp_block_job_pause(const char *device, Error **errp)
2015 BlockJob *job = find_block_job(device);
2018 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2022 trace_qmp_block_job_pause(job);
2023 block_job_pause(job);
2026 void qmp_block_job_resume(const char *device, Error **errp)
2028 BlockJob *job = find_block_job(device);
2031 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2035 trace_qmp_block_job_resume(job);
2036 block_job_resume(job);
2039 void qmp_block_job_complete(const char *device, Error **errp)
2041 BlockJob *job = find_block_job(device);
2044 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2048 trace_qmp_block_job_complete(job);
2049 block_job_complete(job, errp);
2052 static void do_qmp_query_block_jobs_one(void *opaque, BlockDriverState *bs)
2054 BlockJobInfoList **prev = opaque;
2055 BlockJob *job = bs->job;
2058 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
2059 elem->value = block_job_query(bs->job);
2060 (*prev)->next = elem;
2065 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
2067 /* Dummy is a fake list element for holding the head pointer */
2068 BlockJobInfoList dummy = {};
2069 BlockJobInfoList *prev = &dummy;
2070 bdrv_iterate(do_qmp_query_block_jobs_one, &prev);
2074 QemuOptsList qemu_common_drive_opts = {
2076 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
2080 .type = QEMU_OPT_NUMBER,
2081 .help = "bus number",
2084 .type = QEMU_OPT_NUMBER,
2085 .help = "unit number (i.e. lun for scsi)",
2088 .type = QEMU_OPT_STRING,
2089 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2092 .type = QEMU_OPT_NUMBER,
2093 .help = "index number",
2096 .type = QEMU_OPT_NUMBER,
2097 .help = "number of cylinders (ide disk geometry)",
2100 .type = QEMU_OPT_NUMBER,
2101 .help = "number of heads (ide disk geometry)",
2104 .type = QEMU_OPT_NUMBER,
2105 .help = "number of sectors (ide disk geometry)",
2108 .type = QEMU_OPT_STRING,
2109 .help = "chs translation (auto, lba. none)",
2112 .type = QEMU_OPT_STRING,
2113 .help = "media type (disk, cdrom)",
2116 .type = QEMU_OPT_BOOL,
2117 .help = "enable/disable snapshot mode",
2120 .type = QEMU_OPT_STRING,
2121 .help = "disk image",
2124 .type = QEMU_OPT_STRING,
2125 .help = "discard operation (ignore/off, unmap/on)",
2127 .name = "cache.writeback",
2128 .type = QEMU_OPT_BOOL,
2129 .help = "enables writeback mode for any caches",
2131 .name = "cache.direct",
2132 .type = QEMU_OPT_BOOL,
2133 .help = "enables use of O_DIRECT (bypass the host page cache)",
2135 .name = "cache.no-flush",
2136 .type = QEMU_OPT_BOOL,
2137 .help = "ignore any flush requests for the device",
2140 .type = QEMU_OPT_STRING,
2141 .help = "host AIO implementation (threads, native)",
2144 .type = QEMU_OPT_STRING,
2145 .help = "disk format (raw, qcow2, ...)",
2148 .type = QEMU_OPT_STRING,
2149 .help = "disk serial number",
2152 .type = QEMU_OPT_STRING,
2153 .help = "read error action",
2156 .type = QEMU_OPT_STRING,
2157 .help = "write error action",
2160 .type = QEMU_OPT_STRING,
2161 .help = "pci address (virtio only)",
2163 .name = "read-only",
2164 .type = QEMU_OPT_BOOL,
2165 .help = "open drive file as read-only",
2167 .name = "throttling.iops-total",
2168 .type = QEMU_OPT_NUMBER,
2169 .help = "limit total I/O operations per second",
2171 .name = "throttling.iops-read",
2172 .type = QEMU_OPT_NUMBER,
2173 .help = "limit read operations per second",
2175 .name = "throttling.iops-write",
2176 .type = QEMU_OPT_NUMBER,
2177 .help = "limit write operations per second",
2179 .name = "throttling.bps-total",
2180 .type = QEMU_OPT_NUMBER,
2181 .help = "limit total bytes per second",
2183 .name = "throttling.bps-read",
2184 .type = QEMU_OPT_NUMBER,
2185 .help = "limit read bytes per second",
2187 .name = "throttling.bps-write",
2188 .type = QEMU_OPT_NUMBER,
2189 .help = "limit write bytes per second",
2191 .name = "throttling.iops-total-max",
2192 .type = QEMU_OPT_NUMBER,
2193 .help = "I/O operations burst",
2195 .name = "throttling.iops-read-max",
2196 .type = QEMU_OPT_NUMBER,
2197 .help = "I/O operations read burst",
2199 .name = "throttling.iops-write-max",
2200 .type = QEMU_OPT_NUMBER,
2201 .help = "I/O operations write burst",
2203 .name = "throttling.bps-total-max",
2204 .type = QEMU_OPT_NUMBER,
2205 .help = "total bytes burst",
2207 .name = "throttling.bps-read-max",
2208 .type = QEMU_OPT_NUMBER,
2209 .help = "total bytes read burst",
2211 .name = "throttling.bps-write-max",
2212 .type = QEMU_OPT_NUMBER,
2213 .help = "total bytes write burst",
2215 .name = "throttling.iops-size",
2216 .type = QEMU_OPT_NUMBER,
2217 .help = "when limiting by iops max size of an I/O in bytes",
2219 .name = "copy-on-read",
2220 .type = QEMU_OPT_BOOL,
2221 .help = "copy read data from backing file into image file",
2224 .type = QEMU_OPT_BOOL,
2225 .help = "(deprecated, ignored)",
2227 { /* end of list */ }
2231 QemuOptsList qemu_drive_opts = {
2233 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
2236 * no elements => accept any params
2237 * validation will happen later
2239 { /* end of list */ }