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;
49 extern QemuOptsList qemu_old_drive_opts;
51 static const char *const if_name[IF_COUNT] = {
55 [IF_FLOPPY] = "floppy",
56 [IF_PFLASH] = "pflash",
59 [IF_VIRTIO] = "virtio",
63 static const int if_max_devs[IF_COUNT] = {
65 * Do not change these numbers! They govern how drive option
66 * index maps to unit and bus. That mapping is ABI.
68 * All controllers used to imlement if=T drives need to support
69 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
70 * Otherwise, some index values map to "impossible" bus, unit
73 * For instance, if you change [IF_SCSI] to 255, -drive
74 * if=scsi,index=12 no longer means bus=1,unit=5, but
75 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
76 * the drive can't be set up. Regression.
83 * We automatically delete the drive when a device using it gets
84 * unplugged. Questionable feature, but we can't just drop it.
85 * Device models call blockdev_mark_auto_del() to schedule the
86 * automatic deletion, and generic qdev code calls blockdev_auto_del()
87 * when deletion is actually safe.
89 void blockdev_mark_auto_del(BlockDriverState *bs)
91 DriveInfo *dinfo = drive_get_by_blockdev(bs);
94 block_job_cancel(bs->job);
101 void blockdev_auto_del(BlockDriverState *bs)
103 DriveInfo *dinfo = drive_get_by_blockdev(bs);
105 if (dinfo && dinfo->auto_del) {
106 drive_put_ref(dinfo);
110 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
112 int max_devs = if_max_devs[type];
113 return max_devs ? index / max_devs : 0;
116 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
118 int max_devs = if_max_devs[type];
119 return max_devs ? index % max_devs : index;
122 QemuOpts *drive_def(const char *optstr)
124 return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
127 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
133 opts = drive_def(optstr);
137 if (type != IF_DEFAULT) {
138 qemu_opt_set(opts, "if", if_name[type]);
141 snprintf(buf, sizeof(buf), "%d", index);
142 qemu_opt_set(opts, "index", buf);
145 qemu_opt_set(opts, "file", file);
149 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
153 /* seek interface, bus and unit */
155 QTAILQ_FOREACH(dinfo, &drives, next) {
156 if (dinfo->type == type &&
165 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
167 return drive_get(type,
168 drive_index_to_bus_id(type, index),
169 drive_index_to_unit_id(type, index));
172 int drive_get_max_bus(BlockInterfaceType type)
178 QTAILQ_FOREACH(dinfo, &drives, next) {
179 if(dinfo->type == type &&
180 dinfo->bus > max_bus)
181 max_bus = dinfo->bus;
186 /* Get a block device. This should only be used for single-drive devices
187 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
189 DriveInfo *drive_get_next(BlockInterfaceType type)
191 static int next_block_unit[IF_COUNT];
193 return drive_get(type, 0, next_block_unit[type]++);
196 DriveInfo *drive_get_by_blockdev(BlockDriverState *bs)
200 QTAILQ_FOREACH(dinfo, &drives, next) {
201 if (dinfo->bdrv == bs) {
208 static void bdrv_format_print(void *opaque, const char *name)
210 error_printf(" %s", name);
213 static void drive_uninit(DriveInfo *dinfo)
215 qemu_opts_del(dinfo->opts);
216 bdrv_delete(dinfo->bdrv);
218 QTAILQ_REMOVE(&drives, dinfo, next);
219 g_free(dinfo->serial);
223 void drive_put_ref(DriveInfo *dinfo)
225 assert(dinfo->refcount);
226 if (--dinfo->refcount == 0) {
231 void drive_get_ref(DriveInfo *dinfo)
241 static void drive_put_ref_bh(void *opaque)
243 DrivePutRefBH *s = opaque;
245 drive_put_ref(s->dinfo);
246 qemu_bh_delete(s->bh);
251 * Release a drive reference in a BH
253 * It is not possible to use drive_put_ref() from a callback function when the
254 * callers still need the drive. In such cases we schedule a BH to release the
257 static void drive_put_ref_bh_schedule(DriveInfo *dinfo)
261 s = g_new(DrivePutRefBH, 1);
262 s->bh = qemu_bh_new(drive_put_ref_bh, s);
264 qemu_bh_schedule(s->bh);
267 static int parse_block_error_action(const char *buf, bool is_read)
269 if (!strcmp(buf, "ignore")) {
270 return BLOCKDEV_ON_ERROR_IGNORE;
271 } else if (!is_read && !strcmp(buf, "enospc")) {
272 return BLOCKDEV_ON_ERROR_ENOSPC;
273 } else if (!strcmp(buf, "stop")) {
274 return BLOCKDEV_ON_ERROR_STOP;
275 } else if (!strcmp(buf, "report")) {
276 return BLOCKDEV_ON_ERROR_REPORT;
278 error_report("'%s' invalid %s error action",
279 buf, is_read ? "read" : "write");
285 extern int start_simple_client(char* msg);
286 extern char* maru_convert_path(char* msg, const char *path);
289 static bool do_check_io_limits(BlockIOLimit *io_limits, Error **errp)
296 bps_flag = (io_limits->bps[BLOCK_IO_LIMIT_TOTAL] != 0)
297 && ((io_limits->bps[BLOCK_IO_LIMIT_READ] != 0)
298 || (io_limits->bps[BLOCK_IO_LIMIT_WRITE] != 0));
299 iops_flag = (io_limits->iops[BLOCK_IO_LIMIT_TOTAL] != 0)
300 && ((io_limits->iops[BLOCK_IO_LIMIT_READ] != 0)
301 || (io_limits->iops[BLOCK_IO_LIMIT_WRITE] != 0));
302 if (bps_flag || iops_flag) {
303 error_setg(errp, "bps(iops) and bps_rd/bps_wr(iops_rd/iops_wr) "
304 "cannot be used at the same time");
308 if (io_limits->bps[BLOCK_IO_LIMIT_TOTAL] < 0 ||
309 io_limits->bps[BLOCK_IO_LIMIT_WRITE] < 0 ||
310 io_limits->bps[BLOCK_IO_LIMIT_READ] < 0 ||
311 io_limits->iops[BLOCK_IO_LIMIT_TOTAL] < 0 ||
312 io_limits->iops[BLOCK_IO_LIMIT_WRITE] < 0 ||
313 io_limits->iops[BLOCK_IO_LIMIT_READ] < 0) {
314 error_setg(errp, "bps and iops values must be 0 or greater");
321 static DriveInfo *blockdev_init(QemuOpts *all_opts,
322 BlockInterfaceType block_default_type)
325 const char *file = NULL;
327 const char *mediastr = "";
328 BlockInterfaceType type;
329 enum { MEDIA_DISK, MEDIA_CDROM } media;
331 int cyls, heads, secs, translation;
336 int on_read_error, on_write_error;
339 BlockIOLimit io_limits;
347 bool has_driver_specific_opts;
348 BlockDriver *drv = NULL;
350 translation = BIOS_ATA_TRANSLATION_AUTO;
353 /* Check common options by copying from all_opts to opts, all other options
354 * are stored in bs_opts. */
355 id = qemu_opts_id(all_opts);
356 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
357 if (error_is_set(&error)) {
358 qerror_report_err(error);
363 bs_opts = qdict_new();
364 qemu_opts_to_qdict(all_opts, bs_opts);
365 qemu_opts_absorb_qdict(opts, bs_opts, &error);
366 if (error_is_set(&error)) {
367 qerror_report_err(error);
373 qdict_del(bs_opts, "id");
376 has_driver_specific_opts = !!qdict_size(bs_opts);
378 /* extract parameters */
379 bus_id = qemu_opt_get_number(opts, "bus", 0);
380 unit_id = qemu_opt_get_number(opts, "unit", -1);
381 index = qemu_opt_get_number(opts, "index", -1);
383 cyls = qemu_opt_get_number(opts, "cyls", 0);
384 heads = qemu_opt_get_number(opts, "heads", 0);
385 secs = qemu_opt_get_number(opts, "secs", 0);
387 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
388 ro = qemu_opt_get_bool(opts, "read-only", 0);
389 copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
391 file = qemu_opt_get(opts, "file");
392 serial = qemu_opt_get(opts, "serial");
394 if ((buf = qemu_opt_get(opts, "if")) != NULL) {
395 for (type = 0; type < IF_COUNT && strcmp(buf, if_name[type]); type++)
397 if (type == IF_COUNT) {
398 error_report("unsupported bus type '%s'", buf);
402 type = block_default_type;
405 max_devs = if_max_devs[type];
407 if (cyls || heads || secs) {
409 error_report("invalid physical cyls number");
413 error_report("invalid physical heads number");
417 error_report("invalid physical secs number");
422 if ((buf = qemu_opt_get(opts, "trans")) != NULL) {
424 error_report("'%s' trans must be used with cyls, heads and secs",
428 if (!strcmp(buf, "none"))
429 translation = BIOS_ATA_TRANSLATION_NONE;
430 else if (!strcmp(buf, "lba"))
431 translation = BIOS_ATA_TRANSLATION_LBA;
432 else if (!strcmp(buf, "auto"))
433 translation = BIOS_ATA_TRANSLATION_AUTO;
435 error_report("'%s' invalid translation type", buf);
440 if ((buf = qemu_opt_get(opts, "media")) != NULL) {
441 if (!strcmp(buf, "disk")) {
443 } else if (!strcmp(buf, "cdrom")) {
444 if (cyls || secs || heads) {
445 error_report("CHS can't be set with media=%s", buf);
450 error_report("'%s' invalid media", buf);
455 if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
456 if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
457 error_report("invalid discard option");
462 if (qemu_opt_get_bool(opts, "cache.writeback", true)) {
463 bdrv_flags |= BDRV_O_CACHE_WB;
465 if (qemu_opt_get_bool(opts, "cache.direct", false)) {
466 bdrv_flags |= BDRV_O_NOCACHE;
468 if (qemu_opt_get_bool(opts, "cache.no-flush", false)) {
469 bdrv_flags |= BDRV_O_NO_FLUSH;
472 #ifdef CONFIG_LINUX_AIO
473 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
474 if (!strcmp(buf, "native")) {
475 bdrv_flags |= BDRV_O_NATIVE_AIO;
476 } else if (!strcmp(buf, "threads")) {
477 /* this is the default */
479 error_report("invalid aio option");
485 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
486 if (is_help_option(buf)) {
487 error_printf("Supported formats:");
488 bdrv_iterate_format(bdrv_format_print, NULL);
493 drv = bdrv_find_whitelisted_format(buf, ro);
495 error_report("'%s' invalid format", buf);
500 /* disk I/O throttling */
501 io_limits.bps[BLOCK_IO_LIMIT_TOTAL] =
502 qemu_opt_get_number(opts, "throttling.bps-total", 0);
503 io_limits.bps[BLOCK_IO_LIMIT_READ] =
504 qemu_opt_get_number(opts, "throttling.bps-read", 0);
505 io_limits.bps[BLOCK_IO_LIMIT_WRITE] =
506 qemu_opt_get_number(opts, "throttling.bps-write", 0);
507 io_limits.iops[BLOCK_IO_LIMIT_TOTAL] =
508 qemu_opt_get_number(opts, "throttling.iops-total", 0);
509 io_limits.iops[BLOCK_IO_LIMIT_READ] =
510 qemu_opt_get_number(opts, "throttling.iops-read", 0);
511 io_limits.iops[BLOCK_IO_LIMIT_WRITE] =
512 qemu_opt_get_number(opts, "throttling.iops-write", 0);
514 if (!do_check_io_limits(&io_limits, &error)) {
515 error_report("%s", error_get_pretty(error));
520 if (qemu_opt_get(opts, "boot") != NULL) {
521 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
522 "ignored. Future versions will reject this parameter. Please "
523 "update your scripts.\n");
526 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
527 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
528 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO && type != IF_NONE) {
529 error_report("werror is not supported by this bus type");
533 on_write_error = parse_block_error_action(buf, 0);
534 if (on_write_error < 0) {
539 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
540 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
541 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI && type != IF_NONE) {
542 error_report("rerror is not supported by this bus type");
546 on_read_error = parse_block_error_action(buf, 1);
547 if (on_read_error < 0) {
552 if ((devaddr = qemu_opt_get(opts, "addr")) != NULL) {
553 if (type != IF_VIRTIO) {
554 error_report("addr is not supported by this bus type");
559 /* compute bus and unit according index */
562 if (bus_id != 0 || unit_id != -1) {
563 error_report("index cannot be used with bus and unit");
566 bus_id = drive_index_to_bus_id(type, index);
567 unit_id = drive_index_to_unit_id(type, index);
570 /* if user doesn't specify a unit_id,
571 * try to find the first free
576 while (drive_get(type, bus_id, unit_id) != NULL) {
578 if (max_devs && unit_id >= max_devs) {
587 if (max_devs && unit_id >= max_devs) {
588 error_report("unit %d too big (max is %d)",
589 unit_id, max_devs - 1);
594 * catch multiple definitions
597 if (drive_get(type, bus_id, unit_id) != NULL) {
598 error_report("drive with bus=%d, unit=%d (index=%d) exists",
599 bus_id, unit_id, index);
605 dinfo = g_malloc0(sizeof(*dinfo));
606 if ((buf = qemu_opts_id(opts)) != NULL) {
607 dinfo->id = g_strdup(buf);
609 /* no id supplied -> create one */
610 dinfo->id = g_malloc0(32);
611 if (type == IF_IDE || type == IF_SCSI)
612 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
614 snprintf(dinfo->id, 32, "%s%i%s%i",
615 if_name[type], bus_id, mediastr, unit_id);
617 snprintf(dinfo->id, 32, "%s%s%i",
618 if_name[type], mediastr, unit_id);
620 dinfo->bdrv = bdrv_new(dinfo->id);
621 dinfo->bdrv->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
622 dinfo->bdrv->read_only = ro;
623 dinfo->devaddr = devaddr;
626 dinfo->unit = unit_id;
628 dinfo->heads = heads;
630 dinfo->trans = translation;
631 dinfo->opts = all_opts;
633 if (serial != NULL) {
634 dinfo->serial = g_strdup(serial);
636 QTAILQ_INSERT_TAIL(&drives, dinfo, next);
638 bdrv_set_on_error(dinfo->bdrv, on_read_error, on_write_error);
640 /* disk I/O throttling */
641 bdrv_set_io_limits(dinfo->bdrv, &io_limits);
648 dinfo->media_cd = media == MEDIA_CDROM;
657 /* add virtio block device */
659 devopts = qemu_opts_create_nofail(qemu_find_opts("device"));
660 if (arch_type == QEMU_ARCH_S390X) {
661 qemu_opt_set(devopts, "driver", "virtio-blk-s390");
663 qemu_opt_set(devopts, "driver", "virtio-blk-pci");
665 qemu_opt_set(devopts, "drive", dinfo->id);
667 qemu_opt_set(devopts, "addr", devaddr);
673 if (!file || !*file) {
674 if (has_driver_specific_opts) {
681 /* always use cache=unsafe with snapshot */
682 bdrv_flags &= ~BDRV_O_CACHE_MASK;
683 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
687 bdrv_flags |= BDRV_O_COPY_ON_READ;
690 if (runstate_check(RUN_STATE_INMIGRATE)) {
691 bdrv_flags |= BDRV_O_INCOMING;
694 if (media == MEDIA_CDROM) {
695 /* CDROM is fine for any interface, don't check. */
697 } else if (ro == 1) {
698 if (type != IF_SCSI && type != IF_VIRTIO && type != IF_FLOPPY &&
699 type != IF_NONE && type != IF_PFLASH) {
700 error_report("read-only not supported by this bus type");
705 bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
707 if (ro && copy_on_read) {
708 error_report("warning: disabling copy_on_read on read-only drive");
712 ret = bdrv_open(dinfo->bdrv, file, bs_opts, bdrv_flags, drv);
716 const char _msg[] = "Failed to load disk file from the following path. Check if the file is corrupted or missing.\n\n";
717 char* err_msg = NULL;
718 err_msg = maru_convert_path((char*)_msg, file);
719 start_simple_client(err_msg);
725 if (ret == -EMEDIUMTYPE) {
726 error_report("could not open disk image %s: not in %s format",
727 file ?: dinfo->id, drv ? drv->format_name :
728 qdict_get_str(bs_opts, "driver"));
730 error_report("could not open disk image %s: %s",
731 file ?: dinfo->id, strerror(-ret));
736 if (bdrv_key_required(dinfo->bdrv))
747 bdrv_delete(dinfo->bdrv);
749 QTAILQ_REMOVE(&drives, dinfo, next);
754 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to)
758 value = qemu_opt_get(opts, from);
760 qemu_opt_set(opts, to, value);
761 qemu_opt_unset(opts, from);
765 DriveInfo *drive_init(QemuOpts *all_opts, BlockInterfaceType block_default_type)
770 * Check that only old options are used by copying into a QemuOpts with
771 * stricter checks. Going through a QDict seems to be the easiest way to
774 QemuOpts* check_opts;
776 Error *local_err = NULL;
778 qdict = qemu_opts_to_qdict(all_opts, NULL);
779 check_opts = qemu_opts_from_qdict(&qemu_old_drive_opts, qdict, &local_err);
782 if (error_is_set(&local_err)) {
783 qerror_report_err(local_err);
784 error_free(local_err);
787 qemu_opts_del(check_opts);
789 /* Change legacy command line options into QMP ones */
790 qemu_opt_rename(all_opts, "iops", "throttling.iops-total");
791 qemu_opt_rename(all_opts, "iops_rd", "throttling.iops-read");
792 qemu_opt_rename(all_opts, "iops_wr", "throttling.iops-write");
794 qemu_opt_rename(all_opts, "bps", "throttling.bps-total");
795 qemu_opt_rename(all_opts, "bps_rd", "throttling.bps-read");
796 qemu_opt_rename(all_opts, "bps_wr", "throttling.bps-write");
798 qemu_opt_rename(all_opts, "readonly", "read-only");
800 value = qemu_opt_get(all_opts, "cache");
804 if (bdrv_parse_cache_flags(value, &flags) != 0) {
805 error_report("invalid cache option");
809 /* Specific options take precedence */
810 if (!qemu_opt_get(all_opts, "cache.writeback")) {
811 qemu_opt_set_bool(all_opts, "cache.writeback",
812 !!(flags & BDRV_O_CACHE_WB));
814 if (!qemu_opt_get(all_opts, "cache.direct")) {
815 qemu_opt_set_bool(all_opts, "cache.direct",
816 !!(flags & BDRV_O_NOCACHE));
818 if (!qemu_opt_get(all_opts, "cache.no-flush")) {
819 qemu_opt_set_bool(all_opts, "cache.no-flush",
820 !!(flags & BDRV_O_NO_FLUSH));
822 qemu_opt_unset(all_opts, "cache");
825 return blockdev_init(all_opts, block_default_type);
828 void do_commit(Monitor *mon, const QDict *qdict)
830 const char *device = qdict_get_str(qdict, "device");
831 BlockDriverState *bs;
834 if (!strcmp(device, "all")) {
835 ret = bdrv_commit_all();
837 bs = bdrv_find(device);
839 monitor_printf(mon, "Device '%s' not found\n", device);
842 ret = bdrv_commit(bs);
845 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
850 static void blockdev_do_action(int kind, void *data, Error **errp)
852 TransactionAction action;
853 TransactionActionList list;
857 list.value = &action;
859 qmp_transaction(&list, errp);
862 void qmp_blockdev_snapshot_sync(const char *device, const char *snapshot_file,
863 bool has_format, const char *format,
864 bool has_mode, enum NewImageMode mode,
867 BlockdevSnapshot snapshot = {
868 .device = (char *) device,
869 .snapshot_file = (char *) snapshot_file,
870 .has_format = has_format,
871 .format = (char *) format,
872 .has_mode = has_mode,
875 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
880 /* New and old BlockDriverState structs for group snapshots */
882 typedef struct BlkTransactionState BlkTransactionState;
884 /* Only prepare() may fail. In a single transaction, only one of commit() or
885 abort() will be called, clean() will always be called if it present. */
886 typedef struct BdrvActionOps {
887 /* Size of state struct, in bytes. */
888 size_t instance_size;
889 /* Prepare the work, must NOT be NULL. */
890 void (*prepare)(BlkTransactionState *common, Error **errp);
891 /* Commit the changes, can be NULL. */
892 void (*commit)(BlkTransactionState *common);
893 /* Abort the changes on fail, can be NULL. */
894 void (*abort)(BlkTransactionState *common);
895 /* Clean up resource in the end, can be NULL. */
896 void (*clean)(BlkTransactionState *common);
900 * This structure must be arranged as first member in child type, assuming
901 * that compiler will also arrange it to the same address with parent instance.
902 * Later it will be used in free().
904 struct BlkTransactionState {
905 TransactionAction *action;
906 const BdrvActionOps *ops;
907 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
910 /* external snapshot private data */
911 typedef struct ExternalSnapshotState {
912 BlkTransactionState common;
913 BlockDriverState *old_bs;
914 BlockDriverState *new_bs;
915 } ExternalSnapshotState;
917 static void external_snapshot_prepare(BlkTransactionState *common,
922 Error *local_err = NULL;
924 const char *new_image_file;
925 const char *format = "qcow2";
926 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
927 ExternalSnapshotState *state =
928 DO_UPCAST(ExternalSnapshotState, common, common);
929 TransactionAction *action = common->action;
932 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
934 device = action->blockdev_snapshot_sync->device;
935 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
936 if (action->blockdev_snapshot_sync->has_format) {
937 format = action->blockdev_snapshot_sync->format;
939 if (action->blockdev_snapshot_sync->has_mode) {
940 mode = action->blockdev_snapshot_sync->mode;
943 /* start processing */
944 drv = bdrv_find_format(format);
946 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
950 state->old_bs = bdrv_find(device);
951 if (!state->old_bs) {
952 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
956 if (!bdrv_is_inserted(state->old_bs)) {
957 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
961 if (bdrv_in_use(state->old_bs)) {
962 error_set(errp, QERR_DEVICE_IN_USE, device);
966 if (!bdrv_is_read_only(state->old_bs)) {
967 if (bdrv_flush(state->old_bs)) {
968 error_set(errp, QERR_IO_ERROR);
973 flags = state->old_bs->open_flags;
975 /* create new image w/backing file */
976 if (mode != NEW_IMAGE_MODE_EXISTING) {
977 bdrv_img_create(new_image_file, format,
978 state->old_bs->filename,
979 state->old_bs->drv->format_name,
980 NULL, -1, flags, &local_err, false);
981 if (error_is_set(&local_err)) {
982 error_propagate(errp, local_err);
987 /* We will manually add the backing_hd field to the bs later */
988 state->new_bs = bdrv_new("");
989 /* TODO Inherit bs->options or only take explicit options with an
990 * extended QMP command? */
991 ret = bdrv_open(state->new_bs, new_image_file, NULL,
992 flags | BDRV_O_NO_BACKING, drv);
994 error_setg_file_open(errp, -ret, new_image_file);
998 static void external_snapshot_commit(BlkTransactionState *common)
1000 ExternalSnapshotState *state =
1001 DO_UPCAST(ExternalSnapshotState, common, common);
1003 /* This removes our old bs and adds the new bs */
1004 bdrv_append(state->new_bs, state->old_bs);
1005 /* We don't need (or want) to use the transactional
1006 * bdrv_reopen_multiple() across all the entries at once, because we
1007 * don't want to abort all of them if one of them fails the reopen */
1008 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1012 static void external_snapshot_abort(BlkTransactionState *common)
1014 ExternalSnapshotState *state =
1015 DO_UPCAST(ExternalSnapshotState, common, common);
1016 if (state->new_bs) {
1017 bdrv_delete(state->new_bs);
1021 typedef struct DriveBackupState {
1022 BlkTransactionState common;
1023 BlockDriverState *bs;
1027 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1029 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1030 DriveBackup *backup;
1031 Error *local_err = NULL;
1033 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1034 backup = common->action->drive_backup;
1036 qmp_drive_backup(backup->device, backup->target,
1037 backup->has_format, backup->format,
1039 backup->has_mode, backup->mode,
1040 backup->has_speed, backup->speed,
1041 backup->has_on_source_error, backup->on_source_error,
1042 backup->has_on_target_error, backup->on_target_error,
1044 if (error_is_set(&local_err)) {
1045 error_propagate(errp, local_err);
1051 state->bs = bdrv_find(backup->device);
1052 state->job = state->bs->job;
1055 static void drive_backup_abort(BlkTransactionState *common)
1057 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1058 BlockDriverState *bs = state->bs;
1060 /* Only cancel if it's the job we started */
1061 if (bs && bs->job && bs->job == state->job) {
1062 block_job_cancel_sync(bs->job);
1066 static void abort_prepare(BlkTransactionState *common, Error **errp)
1068 error_setg(errp, "Transaction aborted using Abort action");
1071 static void abort_commit(BlkTransactionState *common)
1073 g_assert_not_reached(); /* this action never succeeds */
1076 static const BdrvActionOps actions[] = {
1077 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1078 .instance_size = sizeof(ExternalSnapshotState),
1079 .prepare = external_snapshot_prepare,
1080 .commit = external_snapshot_commit,
1081 .abort = external_snapshot_abort,
1083 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1084 .instance_size = sizeof(DriveBackupState),
1085 .prepare = drive_backup_prepare,
1086 .abort = drive_backup_abort,
1088 [TRANSACTION_ACTION_KIND_ABORT] = {
1089 .instance_size = sizeof(BlkTransactionState),
1090 .prepare = abort_prepare,
1091 .commit = abort_commit,
1096 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1097 * then we do not pivot any of the devices in the group, and abandon the
1100 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1102 TransactionActionList *dev_entry = dev_list;
1103 BlkTransactionState *state, *next;
1104 Error *local_err = NULL;
1106 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1107 QSIMPLEQ_INIT(&snap_bdrv_states);
1109 /* drain all i/o before any snapshots */
1112 /* We don't do anything in this loop that commits us to the snapshot */
1113 while (NULL != dev_entry) {
1114 TransactionAction *dev_info = NULL;
1115 const BdrvActionOps *ops;
1117 dev_info = dev_entry->value;
1118 dev_entry = dev_entry->next;
1120 assert(dev_info->kind < ARRAY_SIZE(actions));
1122 ops = &actions[dev_info->kind];
1123 state = g_malloc0(ops->instance_size);
1125 state->action = dev_info;
1126 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1128 state->ops->prepare(state, &local_err);
1129 if (error_is_set(&local_err)) {
1130 error_propagate(errp, local_err);
1131 goto delete_and_fail;
1135 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1136 if (state->ops->commit) {
1137 state->ops->commit(state);
1146 * failure, and it is all-or-none; abandon each new bs, and keep using
1147 * the original bs for all images
1149 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1150 if (state->ops->abort) {
1151 state->ops->abort(state);
1155 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1156 if (state->ops->clean) {
1157 state->ops->clean(state);
1164 static void eject_device(BlockDriverState *bs, int force, Error **errp)
1166 if (bdrv_in_use(bs)) {
1167 error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
1170 if (!bdrv_dev_has_removable_media(bs)) {
1171 error_set(errp, QERR_DEVICE_NOT_REMOVABLE, bdrv_get_device_name(bs));
1175 if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
1176 bdrv_dev_eject_request(bs, force);
1178 error_set(errp, QERR_DEVICE_LOCKED, bdrv_get_device_name(bs));
1186 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1188 BlockDriverState *bs;
1190 bs = bdrv_find(device);
1192 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1196 eject_device(bs, force, errp);
1199 void qmp_block_passwd(const char *device, const char *password, Error **errp)
1201 BlockDriverState *bs;
1204 bs = bdrv_find(device);
1206 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1210 err = bdrv_set_key(bs, password);
1211 if (err == -EINVAL) {
1212 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1214 } else if (err < 0) {
1215 error_set(errp, QERR_INVALID_PASSWORD);
1220 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1221 int bdrv_flags, BlockDriver *drv,
1222 const char *password, Error **errp)
1226 ret = bdrv_open(bs, filename, NULL, bdrv_flags, drv);
1228 error_setg_file_open(errp, -ret, filename);
1232 if (bdrv_key_required(bs)) {
1234 if (bdrv_set_key(bs, password) < 0) {
1235 error_set(errp, QERR_INVALID_PASSWORD);
1238 error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
1239 bdrv_get_encrypted_filename(bs));
1241 } else if (password) {
1242 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1246 void qmp_change_blockdev(const char *device, const char *filename,
1247 bool has_format, const char *format, Error **errp)
1249 BlockDriverState *bs;
1250 BlockDriver *drv = NULL;
1254 bs = bdrv_find(device);
1256 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1261 drv = bdrv_find_whitelisted_format(format, bs->read_only);
1263 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1268 eject_device(bs, 0, &err);
1269 if (error_is_set(&err)) {
1270 error_propagate(errp, err);
1274 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1275 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1277 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1280 /* throttling disk I/O limits */
1281 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1282 int64_t bps_wr, int64_t iops, int64_t iops_rd,
1283 int64_t iops_wr, Error **errp)
1285 BlockIOLimit io_limits;
1286 BlockDriverState *bs;
1288 bs = bdrv_find(device);
1290 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1294 io_limits.bps[BLOCK_IO_LIMIT_TOTAL] = bps;
1295 io_limits.bps[BLOCK_IO_LIMIT_READ] = bps_rd;
1296 io_limits.bps[BLOCK_IO_LIMIT_WRITE] = bps_wr;
1297 io_limits.iops[BLOCK_IO_LIMIT_TOTAL]= iops;
1298 io_limits.iops[BLOCK_IO_LIMIT_READ] = iops_rd;
1299 io_limits.iops[BLOCK_IO_LIMIT_WRITE]= iops_wr;
1301 if (!do_check_io_limits(&io_limits, errp)) {
1305 bs->io_limits = io_limits;
1307 if (!bs->io_limits_enabled && bdrv_io_limits_enabled(bs)) {
1308 bdrv_io_limits_enable(bs);
1309 } else if (bs->io_limits_enabled && !bdrv_io_limits_enabled(bs)) {
1310 bdrv_io_limits_disable(bs);
1312 if (bs->block_timer) {
1313 qemu_mod_timer(bs->block_timer, qemu_get_clock_ns(vm_clock));
1318 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1320 const char *id = qdict_get_str(qdict, "id");
1321 BlockDriverState *bs;
1325 qerror_report(QERR_DEVICE_NOT_FOUND, id);
1328 if (bdrv_in_use(bs)) {
1329 qerror_report(QERR_DEVICE_IN_USE, id);
1333 /* quiesce block driver; prevent further io */
1338 /* if we have a device attached to this BlockDriverState
1339 * then we need to make the drive anonymous until the device
1340 * can be removed. If this is a drive with no device backing
1341 * then we can just get rid of the block driver state right here.
1343 if (bdrv_get_attached_dev(bs)) {
1346 /* Further I/O must not pause the guest */
1347 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
1348 BLOCKDEV_ON_ERROR_REPORT);
1350 drive_uninit(drive_get_by_blockdev(bs));
1356 void qmp_block_resize(const char *device, int64_t size, Error **errp)
1358 BlockDriverState *bs;
1361 bs = bdrv_find(device);
1363 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1368 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
1372 /* complete all in-flight operations before resizing the device */
1375 ret = bdrv_truncate(bs, size);
1380 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1383 error_set(errp, QERR_UNSUPPORTED);
1386 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1389 error_set(errp, QERR_DEVICE_IN_USE, device);
1392 error_setg_errno(errp, -ret, "Could not resize");
1397 static void block_job_cb(void *opaque, int ret)
1399 BlockDriverState *bs = opaque;
1402 trace_block_job_cb(bs, bs->job, ret);
1405 obj = qobject_from_block_job(bs->job);
1407 QDict *dict = qobject_to_qdict(obj);
1408 qdict_put(dict, "error", qstring_from_str(strerror(-ret)));
1411 if (block_job_is_cancelled(bs->job)) {
1412 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED, obj);
1414 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED, obj);
1416 qobject_decref(obj);
1418 drive_put_ref_bh_schedule(drive_get_by_blockdev(bs));
1421 void qmp_block_stream(const char *device, bool has_base,
1422 const char *base, bool has_speed, int64_t speed,
1423 bool has_on_error, BlockdevOnError on_error,
1426 BlockDriverState *bs;
1427 BlockDriverState *base_bs = NULL;
1428 Error *local_err = NULL;
1430 if (!has_on_error) {
1431 on_error = BLOCKDEV_ON_ERROR_REPORT;
1434 bs = bdrv_find(device);
1436 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1441 base_bs = bdrv_find_backing_image(bs, base);
1442 if (base_bs == NULL) {
1443 error_set(errp, QERR_BASE_NOT_FOUND, base);
1448 stream_start(bs, base_bs, base, has_speed ? speed : 0,
1449 on_error, block_job_cb, bs, &local_err);
1450 if (error_is_set(&local_err)) {
1451 error_propagate(errp, local_err);
1455 /* Grab a reference so hotplug does not delete the BlockDriverState from
1458 drive_get_ref(drive_get_by_blockdev(bs));
1460 trace_qmp_block_stream(bs, bs->job);
1463 void qmp_block_commit(const char *device,
1464 bool has_base, const char *base, const char *top,
1465 bool has_speed, int64_t speed,
1468 BlockDriverState *bs;
1469 BlockDriverState *base_bs, *top_bs;
1470 Error *local_err = NULL;
1471 /* This will be part of the QMP command, if/when the
1472 * BlockdevOnError change for blkmirror makes it in
1474 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
1476 /* drain all i/o before commits */
1479 bs = bdrv_find(device);
1481 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1485 /* default top_bs is the active layer */
1489 if (strcmp(bs->filename, top) != 0) {
1490 top_bs = bdrv_find_backing_image(bs, top);
1494 if (top_bs == NULL) {
1495 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
1499 if (has_base && base) {
1500 base_bs = bdrv_find_backing_image(top_bs, base);
1502 base_bs = bdrv_find_base(top_bs);
1505 if (base_bs == NULL) {
1506 error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
1510 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
1512 if (local_err != NULL) {
1513 error_propagate(errp, local_err);
1516 /* Grab a reference so hotplug does not delete the BlockDriverState from
1519 drive_get_ref(drive_get_by_blockdev(bs));
1522 void qmp_drive_backup(const char *device, const char *target,
1523 bool has_format, const char *format,
1524 enum MirrorSyncMode sync,
1525 bool has_mode, enum NewImageMode mode,
1526 bool has_speed, int64_t speed,
1527 bool has_on_source_error, BlockdevOnError on_source_error,
1528 bool has_on_target_error, BlockdevOnError on_target_error,
1531 BlockDriverState *bs;
1532 BlockDriverState *target_bs;
1533 BlockDriverState *source = NULL;
1534 BlockDriver *drv = NULL;
1535 Error *local_err = NULL;
1543 if (!has_on_source_error) {
1544 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1546 if (!has_on_target_error) {
1547 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1550 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1553 bs = bdrv_find(device);
1555 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1559 if (!bdrv_is_inserted(bs)) {
1560 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1565 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1568 drv = bdrv_find_format(format);
1570 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1575 if (bdrv_in_use(bs)) {
1576 error_set(errp, QERR_DEVICE_IN_USE, device);
1580 flags = bs->open_flags | BDRV_O_RDWR;
1582 /* See if we have a backing HD we can use to create our new image
1584 if (sync == MIRROR_SYNC_MODE_TOP) {
1585 source = bs->backing_hd;
1587 sync = MIRROR_SYNC_MODE_FULL;
1590 if (sync == MIRROR_SYNC_MODE_NONE) {
1594 size = bdrv_getlength(bs);
1596 error_setg_errno(errp, -size, "bdrv_getlength failed");
1600 if (mode != NEW_IMAGE_MODE_EXISTING) {
1601 assert(format && drv);
1603 bdrv_img_create(target, format, source->filename,
1604 source->drv->format_name, NULL,
1605 size, flags, &local_err, false);
1607 bdrv_img_create(target, format, NULL, NULL, NULL,
1608 size, flags, &local_err, false);
1612 if (error_is_set(&local_err)) {
1613 error_propagate(errp, local_err);
1617 target_bs = bdrv_new("");
1618 ret = bdrv_open(target_bs, target, NULL, flags, drv);
1620 bdrv_delete(target_bs);
1621 error_setg_file_open(errp, -ret, target);
1625 backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
1626 block_job_cb, bs, &local_err);
1627 if (local_err != NULL) {
1628 bdrv_delete(target_bs);
1629 error_propagate(errp, local_err);
1633 /* Grab a reference so hotplug does not delete the BlockDriverState from
1636 drive_get_ref(drive_get_by_blockdev(bs));
1639 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1641 void qmp_drive_mirror(const char *device, const char *target,
1642 bool has_format, const char *format,
1643 enum MirrorSyncMode sync,
1644 bool has_mode, enum NewImageMode mode,
1645 bool has_speed, int64_t speed,
1646 bool has_granularity, uint32_t granularity,
1647 bool has_buf_size, int64_t buf_size,
1648 bool has_on_source_error, BlockdevOnError on_source_error,
1649 bool has_on_target_error, BlockdevOnError on_target_error,
1652 BlockDriverState *bs;
1653 BlockDriverState *source, *target_bs;
1654 BlockDriver *drv = NULL;
1655 Error *local_err = NULL;
1663 if (!has_on_source_error) {
1664 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1666 if (!has_on_target_error) {
1667 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1670 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1672 if (!has_granularity) {
1675 if (!has_buf_size) {
1676 buf_size = DEFAULT_MIRROR_BUF_SIZE;
1679 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
1680 error_set(errp, QERR_INVALID_PARAMETER, device);
1683 if (granularity & (granularity - 1)) {
1684 error_set(errp, QERR_INVALID_PARAMETER, device);
1688 bs = bdrv_find(device);
1690 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1694 if (!bdrv_is_inserted(bs)) {
1695 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1700 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1703 drv = bdrv_find_format(format);
1705 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1710 if (bdrv_in_use(bs)) {
1711 error_set(errp, QERR_DEVICE_IN_USE, device);
1715 flags = bs->open_flags | BDRV_O_RDWR;
1716 source = bs->backing_hd;
1717 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
1718 sync = MIRROR_SYNC_MODE_FULL;
1721 size = bdrv_getlength(bs);
1723 error_setg_errno(errp, -size, "bdrv_getlength failed");
1727 if (sync == MIRROR_SYNC_MODE_FULL && mode != NEW_IMAGE_MODE_EXISTING) {
1728 /* create new image w/o backing file */
1729 assert(format && drv);
1730 bdrv_img_create(target, format,
1731 NULL, NULL, NULL, size, flags, &local_err, false);
1734 case NEW_IMAGE_MODE_EXISTING:
1737 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
1738 /* create new image with backing file */
1739 bdrv_img_create(target, format,
1741 source->drv->format_name,
1742 NULL, size, flags, &local_err, false);
1749 if (error_is_set(&local_err)) {
1750 error_propagate(errp, local_err);
1754 /* Mirroring takes care of copy-on-write using the source's backing
1757 target_bs = bdrv_new("");
1758 ret = bdrv_open(target_bs, target, NULL, flags | BDRV_O_NO_BACKING, drv);
1760 bdrv_delete(target_bs);
1761 error_setg_file_open(errp, -ret, target);
1765 mirror_start(bs, target_bs, speed, granularity, buf_size, sync,
1766 on_source_error, on_target_error,
1767 block_job_cb, bs, &local_err);
1768 if (local_err != NULL) {
1769 bdrv_delete(target_bs);
1770 error_propagate(errp, local_err);
1774 /* Grab a reference so hotplug does not delete the BlockDriverState from
1777 drive_get_ref(drive_get_by_blockdev(bs));
1780 static BlockJob *find_block_job(const char *device)
1782 BlockDriverState *bs;
1784 bs = bdrv_find(device);
1785 if (!bs || !bs->job) {
1791 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
1793 BlockJob *job = find_block_job(device);
1796 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
1800 block_job_set_speed(job, speed, errp);
1803 void qmp_block_job_cancel(const char *device,
1804 bool has_force, bool force, Error **errp)
1806 BlockJob *job = find_block_job(device);
1813 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
1816 if (job->paused && !force) {
1817 error_set(errp, QERR_BLOCK_JOB_PAUSED, device);
1821 trace_qmp_block_job_cancel(job);
1822 block_job_cancel(job);
1825 void qmp_block_job_pause(const char *device, Error **errp)
1827 BlockJob *job = find_block_job(device);
1830 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
1834 trace_qmp_block_job_pause(job);
1835 block_job_pause(job);
1838 void qmp_block_job_resume(const char *device, Error **errp)
1840 BlockJob *job = find_block_job(device);
1843 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
1847 trace_qmp_block_job_resume(job);
1848 block_job_resume(job);
1851 void qmp_block_job_complete(const char *device, Error **errp)
1853 BlockJob *job = find_block_job(device);
1856 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
1860 trace_qmp_block_job_complete(job);
1861 block_job_complete(job, errp);
1864 static void do_qmp_query_block_jobs_one(void *opaque, BlockDriverState *bs)
1866 BlockJobInfoList **prev = opaque;
1867 BlockJob *job = bs->job;
1870 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
1871 elem->value = block_job_query(bs->job);
1872 (*prev)->next = elem;
1877 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
1879 /* Dummy is a fake list element for holding the head pointer */
1880 BlockJobInfoList dummy = {};
1881 BlockJobInfoList *prev = &dummy;
1882 bdrv_iterate(do_qmp_query_block_jobs_one, &prev);
1886 QemuOptsList qemu_common_drive_opts = {
1888 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
1892 .type = QEMU_OPT_NUMBER,
1893 .help = "bus number",
1896 .type = QEMU_OPT_NUMBER,
1897 .help = "unit number (i.e. lun for scsi)",
1900 .type = QEMU_OPT_STRING,
1901 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
1904 .type = QEMU_OPT_NUMBER,
1905 .help = "index number",
1908 .type = QEMU_OPT_NUMBER,
1909 .help = "number of cylinders (ide disk geometry)",
1912 .type = QEMU_OPT_NUMBER,
1913 .help = "number of heads (ide disk geometry)",
1916 .type = QEMU_OPT_NUMBER,
1917 .help = "number of sectors (ide disk geometry)",
1920 .type = QEMU_OPT_STRING,
1921 .help = "chs translation (auto, lba. none)",
1924 .type = QEMU_OPT_STRING,
1925 .help = "media type (disk, cdrom)",
1928 .type = QEMU_OPT_BOOL,
1929 .help = "enable/disable snapshot mode",
1932 .type = QEMU_OPT_STRING,
1933 .help = "disk image",
1936 .type = QEMU_OPT_STRING,
1937 .help = "discard operation (ignore/off, unmap/on)",
1939 .name = "cache.writeback",
1940 .type = QEMU_OPT_BOOL,
1941 .help = "enables writeback mode for any caches",
1943 .name = "cache.direct",
1944 .type = QEMU_OPT_BOOL,
1945 .help = "enables use of O_DIRECT (bypass the host page cache)",
1947 .name = "cache.no-flush",
1948 .type = QEMU_OPT_BOOL,
1949 .help = "ignore any flush requests for the device",
1952 .type = QEMU_OPT_STRING,
1953 .help = "host AIO implementation (threads, native)",
1956 .type = QEMU_OPT_STRING,
1957 .help = "disk format (raw, qcow2, ...)",
1960 .type = QEMU_OPT_STRING,
1961 .help = "disk serial number",
1964 .type = QEMU_OPT_STRING,
1965 .help = "read error action",
1968 .type = QEMU_OPT_STRING,
1969 .help = "write error action",
1972 .type = QEMU_OPT_STRING,
1973 .help = "pci address (virtio only)",
1975 .name = "read-only",
1976 .type = QEMU_OPT_BOOL,
1977 .help = "open drive file as read-only",
1979 .name = "throttling.iops-total",
1980 .type = QEMU_OPT_NUMBER,
1981 .help = "limit total I/O operations per second",
1983 .name = "throttling.iops-read",
1984 .type = QEMU_OPT_NUMBER,
1985 .help = "limit read operations per second",
1987 .name = "throttling.iops-write",
1988 .type = QEMU_OPT_NUMBER,
1989 .help = "limit write operations per second",
1991 .name = "throttling.bps-total",
1992 .type = QEMU_OPT_NUMBER,
1993 .help = "limit total bytes per second",
1995 .name = "throttling.bps-read",
1996 .type = QEMU_OPT_NUMBER,
1997 .help = "limit read bytes per second",
1999 .name = "throttling.bps-write",
2000 .type = QEMU_OPT_NUMBER,
2001 .help = "limit write bytes per second",
2003 .name = "copy-on-read",
2004 .type = QEMU_OPT_BOOL,
2005 .help = "copy read data from backing file into image file",
2008 .type = QEMU_OPT_BOOL,
2009 .help = "(deprecated, ignored)",
2011 { /* end of list */ }
2015 QemuOptsList qemu_old_drive_opts = {
2017 .head = QTAILQ_HEAD_INITIALIZER(qemu_old_drive_opts.head),
2021 .type = QEMU_OPT_NUMBER,
2022 .help = "bus number",
2025 .type = QEMU_OPT_NUMBER,
2026 .help = "unit number (i.e. lun for scsi)",
2029 .type = QEMU_OPT_STRING,
2030 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2033 .type = QEMU_OPT_NUMBER,
2034 .help = "index number",
2037 .type = QEMU_OPT_NUMBER,
2038 .help = "number of cylinders (ide disk geometry)",
2041 .type = QEMU_OPT_NUMBER,
2042 .help = "number of heads (ide disk geometry)",
2045 .type = QEMU_OPT_NUMBER,
2046 .help = "number of sectors (ide disk geometry)",
2049 .type = QEMU_OPT_STRING,
2050 .help = "chs translation (auto, lba. none)",
2053 .type = QEMU_OPT_STRING,
2054 .help = "media type (disk, cdrom)",
2057 .type = QEMU_OPT_BOOL,
2058 .help = "enable/disable snapshot mode",
2061 .type = QEMU_OPT_STRING,
2062 .help = "disk image",
2065 .type = QEMU_OPT_STRING,
2066 .help = "discard operation (ignore/off, unmap/on)",
2069 .type = QEMU_OPT_STRING,
2070 .help = "host cache usage (none, writeback, writethrough, "
2071 "directsync, unsafe)",
2074 .type = QEMU_OPT_STRING,
2075 .help = "host AIO implementation (threads, native)",
2078 .type = QEMU_OPT_STRING,
2079 .help = "disk format (raw, qcow2, ...)",
2082 .type = QEMU_OPT_STRING,
2083 .help = "disk serial number",
2086 .type = QEMU_OPT_STRING,
2087 .help = "read error action",
2090 .type = QEMU_OPT_STRING,
2091 .help = "write error action",
2094 .type = QEMU_OPT_STRING,
2095 .help = "pci address (virtio only)",
2098 .type = QEMU_OPT_BOOL,
2099 .help = "open drive file as read-only",
2102 .type = QEMU_OPT_NUMBER,
2103 .help = "limit total I/O operations per second",
2106 .type = QEMU_OPT_NUMBER,
2107 .help = "limit read operations per second",
2110 .type = QEMU_OPT_NUMBER,
2111 .help = "limit write operations per second",
2114 .type = QEMU_OPT_NUMBER,
2115 .help = "limit total bytes per second",
2118 .type = QEMU_OPT_NUMBER,
2119 .help = "limit read bytes per second",
2122 .type = QEMU_OPT_NUMBER,
2123 .help = "limit write bytes per second",
2125 .name = "copy-on-read",
2126 .type = QEMU_OPT_BOOL,
2127 .help = "copy read data from backing file into image file",
2130 .type = QEMU_OPT_BOOL,
2131 .help = "(deprecated, ignored)",
2133 { /* end of list */ }
2137 QemuOptsList qemu_drive_opts = {
2139 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
2142 * no elements => accept any params
2143 * validation will happen later
2145 { /* end of list */ }