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);
716 if (ret == -EMEDIUMTYPE) {
717 error_report("could not open disk image %s: not in %s format",
718 file ?: dinfo->id, drv ? drv->format_name :
719 qdict_get_str(bs_opts, "driver"));
721 error_report("could not open disk image %s: %s",
722 file ?: dinfo->id, strerror(-ret));
727 if (bdrv_key_required(dinfo->bdrv))
738 bdrv_unref(dinfo->bdrv);
740 QTAILQ_REMOVE(&drives, dinfo, next);
745 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to)
749 value = qemu_opt_get(opts, from);
751 qemu_opt_set(opts, to, value);
752 qemu_opt_unset(opts, from);
756 DriveInfo *drive_init(QemuOpts *all_opts, BlockInterfaceType block_default_type)
760 /* Change legacy command line options into QMP ones */
761 qemu_opt_rename(all_opts, "iops", "throttling.iops-total");
762 qemu_opt_rename(all_opts, "iops_rd", "throttling.iops-read");
763 qemu_opt_rename(all_opts, "iops_wr", "throttling.iops-write");
765 qemu_opt_rename(all_opts, "bps", "throttling.bps-total");
766 qemu_opt_rename(all_opts, "bps_rd", "throttling.bps-read");
767 qemu_opt_rename(all_opts, "bps_wr", "throttling.bps-write");
769 qemu_opt_rename(all_opts, "iops_max", "throttling.iops-total-max");
770 qemu_opt_rename(all_opts, "iops_rd_max", "throttling.iops-read-max");
771 qemu_opt_rename(all_opts, "iops_wr_max", "throttling.iops-write-max");
773 qemu_opt_rename(all_opts, "bps_max", "throttling.bps-total-max");
774 qemu_opt_rename(all_opts, "bps_rd_max", "throttling.bps-read-max");
775 qemu_opt_rename(all_opts, "bps_wr_max", "throttling.bps-write-max");
777 qemu_opt_rename(all_opts,
778 "iops_size", "throttling.iops-size");
780 qemu_opt_rename(all_opts, "readonly", "read-only");
782 value = qemu_opt_get(all_opts, "cache");
786 if (bdrv_parse_cache_flags(value, &flags) != 0) {
787 error_report("invalid cache option");
791 /* Specific options take precedence */
792 if (!qemu_opt_get(all_opts, "cache.writeback")) {
793 qemu_opt_set_bool(all_opts, "cache.writeback",
794 !!(flags & BDRV_O_CACHE_WB));
796 if (!qemu_opt_get(all_opts, "cache.direct")) {
797 qemu_opt_set_bool(all_opts, "cache.direct",
798 !!(flags & BDRV_O_NOCACHE));
800 if (!qemu_opt_get(all_opts, "cache.no-flush")) {
801 qemu_opt_set_bool(all_opts, "cache.no-flush",
802 !!(flags & BDRV_O_NO_FLUSH));
804 qemu_opt_unset(all_opts, "cache");
807 return blockdev_init(all_opts, block_default_type);
810 void do_commit(Monitor *mon, const QDict *qdict)
812 const char *device = qdict_get_str(qdict, "device");
813 BlockDriverState *bs;
816 if (!strcmp(device, "all")) {
817 ret = bdrv_commit_all();
819 bs = bdrv_find(device);
821 monitor_printf(mon, "Device '%s' not found\n", device);
824 ret = bdrv_commit(bs);
827 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
832 static void blockdev_do_action(int kind, void *data, Error **errp)
834 TransactionAction action;
835 TransactionActionList list;
839 list.value = &action;
841 qmp_transaction(&list, errp);
844 void qmp_blockdev_snapshot_sync(const char *device, const char *snapshot_file,
845 bool has_format, const char *format,
846 bool has_mode, enum NewImageMode mode,
849 BlockdevSnapshot snapshot = {
850 .device = (char *) device,
851 .snapshot_file = (char *) snapshot_file,
852 .has_format = has_format,
853 .format = (char *) format,
854 .has_mode = has_mode,
857 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
861 void qmp_blockdev_snapshot_internal_sync(const char *device,
865 BlockdevSnapshotInternal snapshot = {
866 .device = (char *) device,
867 .name = (char *) name
870 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
874 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
881 BlockDriverState *bs = bdrv_find(device);
883 Error *local_err = NULL;
884 SnapshotInfo *info = NULL;
888 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
901 error_setg(errp, "Name or id must be provided");
905 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
906 if (error_is_set(&local_err)) {
907 error_propagate(errp, local_err);
912 "Snapshot with id '%s' and name '%s' does not exist on "
914 STR_OR_NULL(id), STR_OR_NULL(name), device);
918 bdrv_snapshot_delete(bs, id, name, &local_err);
919 if (error_is_set(&local_err)) {
920 error_propagate(errp, local_err);
924 info = g_malloc0(sizeof(SnapshotInfo));
925 info->id = g_strdup(sn.id_str);
926 info->name = g_strdup(sn.name);
927 info->date_nsec = sn.date_nsec;
928 info->date_sec = sn.date_sec;
929 info->vm_state_size = sn.vm_state_size;
930 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
931 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
936 /* New and old BlockDriverState structs for group snapshots */
938 typedef struct BlkTransactionState BlkTransactionState;
940 /* Only prepare() may fail. In a single transaction, only one of commit() or
941 abort() will be called, clean() will always be called if it present. */
942 typedef struct BdrvActionOps {
943 /* Size of state struct, in bytes. */
944 size_t instance_size;
945 /* Prepare the work, must NOT be NULL. */
946 void (*prepare)(BlkTransactionState *common, Error **errp);
947 /* Commit the changes, can be NULL. */
948 void (*commit)(BlkTransactionState *common);
949 /* Abort the changes on fail, can be NULL. */
950 void (*abort)(BlkTransactionState *common);
951 /* Clean up resource in the end, can be NULL. */
952 void (*clean)(BlkTransactionState *common);
956 * This structure must be arranged as first member in child type, assuming
957 * that compiler will also arrange it to the same address with parent instance.
958 * Later it will be used in free().
960 struct BlkTransactionState {
961 TransactionAction *action;
962 const BdrvActionOps *ops;
963 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
966 /* internal snapshot private data */
967 typedef struct InternalSnapshotState {
968 BlkTransactionState common;
969 BlockDriverState *bs;
971 } InternalSnapshotState;
973 static void internal_snapshot_prepare(BlkTransactionState *common,
978 BlockDriverState *bs;
979 QEMUSnapshotInfo old_sn, *sn;
982 BlockdevSnapshotInternal *internal;
983 InternalSnapshotState *state;
986 g_assert(common->action->kind ==
987 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
988 internal = common->action->blockdev_snapshot_internal_sync;
989 state = DO_UPCAST(InternalSnapshotState, common, common);
992 device = internal->device;
993 name = internal->name;
995 /* 2. check for validation */
996 bs = bdrv_find(device);
998 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1002 if (!bdrv_is_inserted(bs)) {
1003 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1007 if (bdrv_is_read_only(bs)) {
1008 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1012 if (!bdrv_can_snapshot(bs)) {
1013 error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1014 bs->drv->format_name, device, "internal snapshot");
1018 if (!strlen(name)) {
1019 error_setg(errp, "Name is empty");
1023 /* check whether a snapshot with name exist */
1024 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn, errp);
1025 if (error_is_set(errp)) {
1029 "Snapshot with name '%s' already exists on device '%s'",
1034 /* 3. take the snapshot */
1036 pstrcpy(sn->name, sizeof(sn->name), name);
1037 qemu_gettimeofday(&tv);
1038 sn->date_sec = tv.tv_sec;
1039 sn->date_nsec = tv.tv_usec * 1000;
1040 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1042 ret1 = bdrv_snapshot_create(bs, sn);
1044 error_setg_errno(errp, -ret1,
1045 "Failed to create snapshot '%s' on device '%s'",
1050 /* 4. succeed, mark a snapshot is created */
1054 static void internal_snapshot_abort(BlkTransactionState *common)
1056 InternalSnapshotState *state =
1057 DO_UPCAST(InternalSnapshotState, common, common);
1058 BlockDriverState *bs = state->bs;
1059 QEMUSnapshotInfo *sn = &state->sn;
1060 Error *local_error = NULL;
1066 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1067 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1068 "device '%s' in abort: %s",
1071 bdrv_get_device_name(bs),
1072 error_get_pretty(local_error));
1073 error_free(local_error);
1077 /* external snapshot private data */
1078 typedef struct ExternalSnapshotState {
1079 BlkTransactionState common;
1080 BlockDriverState *old_bs;
1081 BlockDriverState *new_bs;
1082 } ExternalSnapshotState;
1084 static void external_snapshot_prepare(BlkTransactionState *common,
1089 Error *local_err = NULL;
1091 const char *new_image_file;
1092 const char *format = "qcow2";
1093 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1094 ExternalSnapshotState *state =
1095 DO_UPCAST(ExternalSnapshotState, common, common);
1096 TransactionAction *action = common->action;
1098 /* get parameters */
1099 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1101 device = action->blockdev_snapshot_sync->device;
1102 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1103 if (action->blockdev_snapshot_sync->has_format) {
1104 format = action->blockdev_snapshot_sync->format;
1106 if (action->blockdev_snapshot_sync->has_mode) {
1107 mode = action->blockdev_snapshot_sync->mode;
1110 /* start processing */
1111 drv = bdrv_find_format(format);
1113 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1117 state->old_bs = bdrv_find(device);
1118 if (!state->old_bs) {
1119 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1123 if (!bdrv_is_inserted(state->old_bs)) {
1124 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1128 if (bdrv_in_use(state->old_bs)) {
1129 error_set(errp, QERR_DEVICE_IN_USE, device);
1133 if (!bdrv_is_read_only(state->old_bs)) {
1134 if (bdrv_flush(state->old_bs)) {
1135 error_set(errp, QERR_IO_ERROR);
1140 flags = state->old_bs->open_flags;
1142 /* create new image w/backing file */
1143 if (mode != NEW_IMAGE_MODE_EXISTING) {
1144 bdrv_img_create(new_image_file, format,
1145 state->old_bs->filename,
1146 state->old_bs->drv->format_name,
1147 NULL, -1, flags, &local_err, false);
1148 if (error_is_set(&local_err)) {
1149 error_propagate(errp, local_err);
1154 /* We will manually add the backing_hd field to the bs later */
1155 state->new_bs = bdrv_new("");
1156 /* TODO Inherit bs->options or only take explicit options with an
1157 * extended QMP command? */
1158 ret = bdrv_open(state->new_bs, new_image_file, NULL,
1159 flags | BDRV_O_NO_BACKING, drv);
1161 error_setg_file_open(errp, -ret, new_image_file);
1165 static void external_snapshot_commit(BlkTransactionState *common)
1167 ExternalSnapshotState *state =
1168 DO_UPCAST(ExternalSnapshotState, common, common);
1170 /* This removes our old bs and adds the new bs */
1171 bdrv_append(state->new_bs, state->old_bs);
1172 /* We don't need (or want) to use the transactional
1173 * bdrv_reopen_multiple() across all the entries at once, because we
1174 * don't want to abort all of them if one of them fails the reopen */
1175 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1179 static void external_snapshot_abort(BlkTransactionState *common)
1181 ExternalSnapshotState *state =
1182 DO_UPCAST(ExternalSnapshotState, common, common);
1183 if (state->new_bs) {
1184 bdrv_unref(state->new_bs);
1188 typedef struct DriveBackupState {
1189 BlkTransactionState common;
1190 BlockDriverState *bs;
1194 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1196 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1197 DriveBackup *backup;
1198 Error *local_err = NULL;
1200 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1201 backup = common->action->drive_backup;
1203 qmp_drive_backup(backup->device, backup->target,
1204 backup->has_format, backup->format,
1206 backup->has_mode, backup->mode,
1207 backup->has_speed, backup->speed,
1208 backup->has_on_source_error, backup->on_source_error,
1209 backup->has_on_target_error, backup->on_target_error,
1211 if (error_is_set(&local_err)) {
1212 error_propagate(errp, local_err);
1218 state->bs = bdrv_find(backup->device);
1219 state->job = state->bs->job;
1222 static void drive_backup_abort(BlkTransactionState *common)
1224 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1225 BlockDriverState *bs = state->bs;
1227 /* Only cancel if it's the job we started */
1228 if (bs && bs->job && bs->job == state->job) {
1229 block_job_cancel_sync(bs->job);
1233 static void abort_prepare(BlkTransactionState *common, Error **errp)
1235 error_setg(errp, "Transaction aborted using Abort action");
1238 static void abort_commit(BlkTransactionState *common)
1240 g_assert_not_reached(); /* this action never succeeds */
1243 static const BdrvActionOps actions[] = {
1244 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1245 .instance_size = sizeof(ExternalSnapshotState),
1246 .prepare = external_snapshot_prepare,
1247 .commit = external_snapshot_commit,
1248 .abort = external_snapshot_abort,
1250 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1251 .instance_size = sizeof(DriveBackupState),
1252 .prepare = drive_backup_prepare,
1253 .abort = drive_backup_abort,
1255 [TRANSACTION_ACTION_KIND_ABORT] = {
1256 .instance_size = sizeof(BlkTransactionState),
1257 .prepare = abort_prepare,
1258 .commit = abort_commit,
1260 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1261 .instance_size = sizeof(InternalSnapshotState),
1262 .prepare = internal_snapshot_prepare,
1263 .abort = internal_snapshot_abort,
1268 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1269 * then we do not pivot any of the devices in the group, and abandon the
1272 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1274 TransactionActionList *dev_entry = dev_list;
1275 BlkTransactionState *state, *next;
1276 Error *local_err = NULL;
1278 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1279 QSIMPLEQ_INIT(&snap_bdrv_states);
1281 /* drain all i/o before any snapshots */
1284 /* We don't do anything in this loop that commits us to the snapshot */
1285 while (NULL != dev_entry) {
1286 TransactionAction *dev_info = NULL;
1287 const BdrvActionOps *ops;
1289 dev_info = dev_entry->value;
1290 dev_entry = dev_entry->next;
1292 assert(dev_info->kind < ARRAY_SIZE(actions));
1294 ops = &actions[dev_info->kind];
1295 state = g_malloc0(ops->instance_size);
1297 state->action = dev_info;
1298 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1300 state->ops->prepare(state, &local_err);
1301 if (error_is_set(&local_err)) {
1302 error_propagate(errp, local_err);
1303 goto delete_and_fail;
1307 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1308 if (state->ops->commit) {
1309 state->ops->commit(state);
1318 * failure, and it is all-or-none; abandon each new bs, and keep using
1319 * the original bs for all images
1321 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1322 if (state->ops->abort) {
1323 state->ops->abort(state);
1327 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1328 if (state->ops->clean) {
1329 state->ops->clean(state);
1336 static void eject_device(BlockDriverState *bs, int force, Error **errp)
1338 if (bdrv_in_use(bs)) {
1339 error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
1342 if (!bdrv_dev_has_removable_media(bs)) {
1343 error_set(errp, QERR_DEVICE_NOT_REMOVABLE, bdrv_get_device_name(bs));
1347 if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
1348 bdrv_dev_eject_request(bs, force);
1350 error_set(errp, QERR_DEVICE_LOCKED, bdrv_get_device_name(bs));
1358 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1360 BlockDriverState *bs;
1362 bs = bdrv_find(device);
1364 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1368 eject_device(bs, force, errp);
1371 void qmp_block_passwd(const char *device, const char *password, Error **errp)
1373 BlockDriverState *bs;
1376 bs = bdrv_find(device);
1378 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1382 err = bdrv_set_key(bs, password);
1383 if (err == -EINVAL) {
1384 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1386 } else if (err < 0) {
1387 error_set(errp, QERR_INVALID_PASSWORD);
1392 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1393 int bdrv_flags, BlockDriver *drv,
1394 const char *password, Error **errp)
1398 ret = bdrv_open(bs, filename, NULL, bdrv_flags, drv);
1400 error_setg_file_open(errp, -ret, filename);
1404 if (bdrv_key_required(bs)) {
1406 if (bdrv_set_key(bs, password) < 0) {
1407 error_set(errp, QERR_INVALID_PASSWORD);
1410 error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
1411 bdrv_get_encrypted_filename(bs));
1413 } else if (password) {
1414 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1418 void qmp_change_blockdev(const char *device, const char *filename,
1419 bool has_format, const char *format, Error **errp)
1421 BlockDriverState *bs;
1422 BlockDriver *drv = NULL;
1426 bs = bdrv_find(device);
1428 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1433 drv = bdrv_find_whitelisted_format(format, bs->read_only);
1435 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1440 eject_device(bs, 0, &err);
1441 if (error_is_set(&err)) {
1442 error_propagate(errp, err);
1446 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1447 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1449 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1452 /* throttling disk I/O limits */
1453 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1460 bool has_bps_rd_max,
1462 bool has_bps_wr_max,
1466 bool has_iops_rd_max,
1467 int64_t iops_rd_max,
1468 bool has_iops_wr_max,
1469 int64_t iops_wr_max,
1471 int64_t iops_size, Error **errp)
1474 BlockDriverState *bs;
1476 bs = bdrv_find(device);
1478 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1482 memset(&cfg, 0, sizeof(cfg));
1483 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1484 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
1485 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1487 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1488 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
1489 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1492 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1494 if (has_bps_rd_max) {
1495 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
1497 if (has_bps_wr_max) {
1498 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
1501 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
1503 if (has_iops_rd_max) {
1504 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
1506 if (has_iops_wr_max) {
1507 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
1510 if (has_iops_size) {
1511 cfg.op_size = iops_size;
1514 if (!check_throttle_config(&cfg, errp)) {
1518 if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
1519 bdrv_io_limits_enable(bs);
1520 } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
1521 bdrv_io_limits_disable(bs);
1524 if (bs->io_limits_enabled) {
1525 bdrv_set_io_limits(bs, &cfg);
1529 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1531 const char *id = qdict_get_str(qdict, "id");
1532 BlockDriverState *bs;
1536 qerror_report(QERR_DEVICE_NOT_FOUND, id);
1539 if (bdrv_in_use(bs)) {
1540 qerror_report(QERR_DEVICE_IN_USE, id);
1544 /* quiesce block driver; prevent further io */
1549 /* if we have a device attached to this BlockDriverState
1550 * then we need to make the drive anonymous until the device
1551 * can be removed. If this is a drive with no device backing
1552 * then we can just get rid of the block driver state right here.
1554 if (bdrv_get_attached_dev(bs)) {
1557 /* Further I/O must not pause the guest */
1558 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
1559 BLOCKDEV_ON_ERROR_REPORT);
1561 drive_uninit(drive_get_by_blockdev(bs));
1567 void qmp_block_resize(const char *device, int64_t size, Error **errp)
1569 BlockDriverState *bs;
1572 bs = bdrv_find(device);
1574 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1579 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
1583 /* complete all in-flight operations before resizing the device */
1586 ret = bdrv_truncate(bs, size);
1591 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1594 error_set(errp, QERR_UNSUPPORTED);
1597 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1600 error_set(errp, QERR_DEVICE_IN_USE, device);
1603 error_setg_errno(errp, -ret, "Could not resize");
1608 static void block_job_cb(void *opaque, int ret)
1610 BlockDriverState *bs = opaque;
1613 trace_block_job_cb(bs, bs->job, ret);
1616 obj = qobject_from_block_job(bs->job);
1618 QDict *dict = qobject_to_qdict(obj);
1619 qdict_put(dict, "error", qstring_from_str(strerror(-ret)));
1622 if (block_job_is_cancelled(bs->job)) {
1623 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED, obj);
1625 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED, obj);
1627 qobject_decref(obj);
1629 bdrv_put_ref_bh_schedule(bs);
1632 void qmp_block_stream(const char *device, bool has_base,
1633 const char *base, bool has_speed, int64_t speed,
1634 bool has_on_error, BlockdevOnError on_error,
1637 BlockDriverState *bs;
1638 BlockDriverState *base_bs = NULL;
1639 Error *local_err = NULL;
1641 if (!has_on_error) {
1642 on_error = BLOCKDEV_ON_ERROR_REPORT;
1645 bs = bdrv_find(device);
1647 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1652 base_bs = bdrv_find_backing_image(bs, base);
1653 if (base_bs == NULL) {
1654 error_set(errp, QERR_BASE_NOT_FOUND, base);
1659 stream_start(bs, base_bs, base, has_speed ? speed : 0,
1660 on_error, block_job_cb, bs, &local_err);
1661 if (error_is_set(&local_err)) {
1662 error_propagate(errp, local_err);
1666 trace_qmp_block_stream(bs, bs->job);
1669 void qmp_block_commit(const char *device,
1670 bool has_base, const char *base, const char *top,
1671 bool has_speed, int64_t speed,
1674 BlockDriverState *bs;
1675 BlockDriverState *base_bs, *top_bs;
1676 Error *local_err = NULL;
1677 /* This will be part of the QMP command, if/when the
1678 * BlockdevOnError change for blkmirror makes it in
1680 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
1682 /* drain all i/o before commits */
1685 bs = bdrv_find(device);
1687 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1691 /* default top_bs is the active layer */
1695 if (strcmp(bs->filename, top) != 0) {
1696 top_bs = bdrv_find_backing_image(bs, top);
1700 if (top_bs == NULL) {
1701 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
1705 if (has_base && base) {
1706 base_bs = bdrv_find_backing_image(top_bs, base);
1708 base_bs = bdrv_find_base(top_bs);
1711 if (base_bs == NULL) {
1712 error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
1716 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
1718 if (local_err != NULL) {
1719 error_propagate(errp, local_err);
1724 void qmp_drive_backup(const char *device, const char *target,
1725 bool has_format, const char *format,
1726 enum MirrorSyncMode sync,
1727 bool has_mode, enum NewImageMode mode,
1728 bool has_speed, int64_t speed,
1729 bool has_on_source_error, BlockdevOnError on_source_error,
1730 bool has_on_target_error, BlockdevOnError on_target_error,
1733 BlockDriverState *bs;
1734 BlockDriverState *target_bs;
1735 BlockDriverState *source = NULL;
1736 BlockDriver *drv = NULL;
1737 Error *local_err = NULL;
1745 if (!has_on_source_error) {
1746 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1748 if (!has_on_target_error) {
1749 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1752 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1755 bs = bdrv_find(device);
1757 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1761 if (!bdrv_is_inserted(bs)) {
1762 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1767 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1770 drv = bdrv_find_format(format);
1772 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1777 if (bdrv_in_use(bs)) {
1778 error_set(errp, QERR_DEVICE_IN_USE, device);
1782 flags = bs->open_flags | BDRV_O_RDWR;
1784 /* See if we have a backing HD we can use to create our new image
1786 if (sync == MIRROR_SYNC_MODE_TOP) {
1787 source = bs->backing_hd;
1789 sync = MIRROR_SYNC_MODE_FULL;
1792 if (sync == MIRROR_SYNC_MODE_NONE) {
1796 size = bdrv_getlength(bs);
1798 error_setg_errno(errp, -size, "bdrv_getlength failed");
1802 if (mode != NEW_IMAGE_MODE_EXISTING) {
1803 assert(format && drv);
1805 bdrv_img_create(target, format, source->filename,
1806 source->drv->format_name, NULL,
1807 size, flags, &local_err, false);
1809 bdrv_img_create(target, format, NULL, NULL, NULL,
1810 size, flags, &local_err, false);
1814 if (error_is_set(&local_err)) {
1815 error_propagate(errp, local_err);
1819 target_bs = bdrv_new("");
1820 ret = bdrv_open(target_bs, target, NULL, flags, drv);
1822 bdrv_unref(target_bs);
1823 error_setg_file_open(errp, -ret, target);
1827 backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
1828 block_job_cb, bs, &local_err);
1829 if (local_err != NULL) {
1830 bdrv_unref(target_bs);
1831 error_propagate(errp, local_err);
1836 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1838 void qmp_drive_mirror(const char *device, const char *target,
1839 bool has_format, const char *format,
1840 enum MirrorSyncMode sync,
1841 bool has_mode, enum NewImageMode mode,
1842 bool has_speed, int64_t speed,
1843 bool has_granularity, uint32_t granularity,
1844 bool has_buf_size, int64_t buf_size,
1845 bool has_on_source_error, BlockdevOnError on_source_error,
1846 bool has_on_target_error, BlockdevOnError on_target_error,
1849 BlockDriverState *bs;
1850 BlockDriverState *source, *target_bs;
1851 BlockDriver *drv = NULL;
1852 Error *local_err = NULL;
1860 if (!has_on_source_error) {
1861 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1863 if (!has_on_target_error) {
1864 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1867 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1869 if (!has_granularity) {
1872 if (!has_buf_size) {
1873 buf_size = DEFAULT_MIRROR_BUF_SIZE;
1876 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
1877 error_set(errp, QERR_INVALID_PARAMETER, device);
1880 if (granularity & (granularity - 1)) {
1881 error_set(errp, QERR_INVALID_PARAMETER, device);
1885 bs = bdrv_find(device);
1887 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1891 if (!bdrv_is_inserted(bs)) {
1892 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1897 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1900 drv = bdrv_find_format(format);
1902 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1907 if (bdrv_in_use(bs)) {
1908 error_set(errp, QERR_DEVICE_IN_USE, device);
1912 flags = bs->open_flags | BDRV_O_RDWR;
1913 source = bs->backing_hd;
1914 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
1915 sync = MIRROR_SYNC_MODE_FULL;
1918 size = bdrv_getlength(bs);
1920 error_setg_errno(errp, -size, "bdrv_getlength failed");
1924 if (sync == MIRROR_SYNC_MODE_FULL && mode != NEW_IMAGE_MODE_EXISTING) {
1925 /* create new image w/o backing file */
1926 assert(format && drv);
1927 bdrv_img_create(target, format,
1928 NULL, NULL, NULL, size, flags, &local_err, false);
1931 case NEW_IMAGE_MODE_EXISTING:
1934 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
1935 /* create new image with backing file */
1936 bdrv_img_create(target, format,
1938 source->drv->format_name,
1939 NULL, size, flags, &local_err, false);
1946 if (error_is_set(&local_err)) {
1947 error_propagate(errp, local_err);
1951 /* Mirroring takes care of copy-on-write using the source's backing
1954 target_bs = bdrv_new("");
1955 ret = bdrv_open(target_bs, target, NULL, flags | BDRV_O_NO_BACKING, drv);
1957 bdrv_unref(target_bs);
1958 error_setg_file_open(errp, -ret, target);
1962 mirror_start(bs, target_bs, speed, granularity, buf_size, sync,
1963 on_source_error, on_target_error,
1964 block_job_cb, bs, &local_err);
1965 if (local_err != NULL) {
1966 bdrv_unref(target_bs);
1967 error_propagate(errp, local_err);
1972 static BlockJob *find_block_job(const char *device)
1974 BlockDriverState *bs;
1976 bs = bdrv_find(device);
1977 if (!bs || !bs->job) {
1983 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
1985 BlockJob *job = find_block_job(device);
1988 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
1992 block_job_set_speed(job, speed, errp);
1995 void qmp_block_job_cancel(const char *device,
1996 bool has_force, bool force, Error **errp)
1998 BlockJob *job = find_block_job(device);
2005 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2008 if (job->paused && !force) {
2009 error_set(errp, QERR_BLOCK_JOB_PAUSED, device);
2013 trace_qmp_block_job_cancel(job);
2014 block_job_cancel(job);
2017 void qmp_block_job_pause(const char *device, Error **errp)
2019 BlockJob *job = find_block_job(device);
2022 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2026 trace_qmp_block_job_pause(job);
2027 block_job_pause(job);
2030 void qmp_block_job_resume(const char *device, Error **errp)
2032 BlockJob *job = find_block_job(device);
2035 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2039 trace_qmp_block_job_resume(job);
2040 block_job_resume(job);
2043 void qmp_block_job_complete(const char *device, Error **errp)
2045 BlockJob *job = find_block_job(device);
2048 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2052 trace_qmp_block_job_complete(job);
2053 block_job_complete(job, errp);
2056 static void do_qmp_query_block_jobs_one(void *opaque, BlockDriverState *bs)
2058 BlockJobInfoList **prev = opaque;
2059 BlockJob *job = bs->job;
2062 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
2063 elem->value = block_job_query(bs->job);
2064 (*prev)->next = elem;
2069 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
2071 /* Dummy is a fake list element for holding the head pointer */
2072 BlockJobInfoList dummy = {};
2073 BlockJobInfoList *prev = &dummy;
2074 bdrv_iterate(do_qmp_query_block_jobs_one, &prev);
2078 QemuOptsList qemu_common_drive_opts = {
2080 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
2084 .type = QEMU_OPT_NUMBER,
2085 .help = "bus number",
2088 .type = QEMU_OPT_NUMBER,
2089 .help = "unit number (i.e. lun for scsi)",
2092 .type = QEMU_OPT_STRING,
2093 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2096 .type = QEMU_OPT_NUMBER,
2097 .help = "index number",
2100 .type = QEMU_OPT_NUMBER,
2101 .help = "number of cylinders (ide disk geometry)",
2104 .type = QEMU_OPT_NUMBER,
2105 .help = "number of heads (ide disk geometry)",
2108 .type = QEMU_OPT_NUMBER,
2109 .help = "number of sectors (ide disk geometry)",
2112 .type = QEMU_OPT_STRING,
2113 .help = "chs translation (auto, lba. none)",
2116 .type = QEMU_OPT_STRING,
2117 .help = "media type (disk, cdrom)",
2120 .type = QEMU_OPT_BOOL,
2121 .help = "enable/disable snapshot mode",
2124 .type = QEMU_OPT_STRING,
2125 .help = "disk image",
2128 .type = QEMU_OPT_STRING,
2129 .help = "discard operation (ignore/off, unmap/on)",
2131 .name = "cache.writeback",
2132 .type = QEMU_OPT_BOOL,
2133 .help = "enables writeback mode for any caches",
2135 .name = "cache.direct",
2136 .type = QEMU_OPT_BOOL,
2137 .help = "enables use of O_DIRECT (bypass the host page cache)",
2139 .name = "cache.no-flush",
2140 .type = QEMU_OPT_BOOL,
2141 .help = "ignore any flush requests for the device",
2144 .type = QEMU_OPT_STRING,
2145 .help = "host AIO implementation (threads, native)",
2148 .type = QEMU_OPT_STRING,
2149 .help = "disk format (raw, qcow2, ...)",
2152 .type = QEMU_OPT_STRING,
2153 .help = "disk serial number",
2156 .type = QEMU_OPT_STRING,
2157 .help = "read error action",
2160 .type = QEMU_OPT_STRING,
2161 .help = "write error action",
2164 .type = QEMU_OPT_STRING,
2165 .help = "pci address (virtio only)",
2167 .name = "read-only",
2168 .type = QEMU_OPT_BOOL,
2169 .help = "open drive file as read-only",
2171 .name = "throttling.iops-total",
2172 .type = QEMU_OPT_NUMBER,
2173 .help = "limit total I/O operations per second",
2175 .name = "throttling.iops-read",
2176 .type = QEMU_OPT_NUMBER,
2177 .help = "limit read operations per second",
2179 .name = "throttling.iops-write",
2180 .type = QEMU_OPT_NUMBER,
2181 .help = "limit write operations per second",
2183 .name = "throttling.bps-total",
2184 .type = QEMU_OPT_NUMBER,
2185 .help = "limit total bytes per second",
2187 .name = "throttling.bps-read",
2188 .type = QEMU_OPT_NUMBER,
2189 .help = "limit read bytes per second",
2191 .name = "throttling.bps-write",
2192 .type = QEMU_OPT_NUMBER,
2193 .help = "limit write bytes per second",
2195 .name = "throttling.iops-total-max",
2196 .type = QEMU_OPT_NUMBER,
2197 .help = "I/O operations burst",
2199 .name = "throttling.iops-read-max",
2200 .type = QEMU_OPT_NUMBER,
2201 .help = "I/O operations read burst",
2203 .name = "throttling.iops-write-max",
2204 .type = QEMU_OPT_NUMBER,
2205 .help = "I/O operations write burst",
2207 .name = "throttling.bps-total-max",
2208 .type = QEMU_OPT_NUMBER,
2209 .help = "total bytes burst",
2211 .name = "throttling.bps-read-max",
2212 .type = QEMU_OPT_NUMBER,
2213 .help = "total bytes read burst",
2215 .name = "throttling.bps-write-max",
2216 .type = QEMU_OPT_NUMBER,
2217 .help = "total bytes write burst",
2219 .name = "throttling.iops-size",
2220 .type = QEMU_OPT_NUMBER,
2221 .help = "when limiting by iops max size of an I/O in bytes",
2223 .name = "copy-on-read",
2224 .type = QEMU_OPT_BOOL,
2225 .help = "copy read data from backing file into image file",
2228 .type = QEMU_OPT_BOOL,
2229 .help = "(deprecated, ignored)",
2231 { /* end of list */ }
2235 QemuOptsList qemu_drive_opts = {
2237 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
2240 * no elements => accept any params
2241 * validation will happen later
2243 { /* end of list */ }