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 "qapi-visit.h"
42 #include "qapi/qmp-output-visitor.h"
43 #include "sysemu/sysemu.h"
44 #include "block/block_int.h"
45 #include "qmp-commands.h"
47 #include "sysemu/arch_init.h"
49 static QTAILQ_HEAD(drivelist
, DriveInfo
) drives
= QTAILQ_HEAD_INITIALIZER(drives
);
50 extern QemuOptsList qemu_common_drive_opts
;
52 static const char *const if_name
[IF_COUNT
] = {
56 [IF_FLOPPY
] = "floppy",
57 [IF_PFLASH
] = "pflash",
60 [IF_VIRTIO
] = "virtio",
64 static const int if_max_devs
[IF_COUNT
] = {
66 * Do not change these numbers! They govern how drive option
67 * index maps to unit and bus. That mapping is ABI.
69 * All controllers used to imlement if=T drives need to support
70 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
71 * Otherwise, some index values map to "impossible" bus, unit
74 * For instance, if you change [IF_SCSI] to 255, -drive
75 * if=scsi,index=12 no longer means bus=1,unit=5, but
76 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
77 * the drive can't be set up. Regression.
84 * We automatically delete the drive when a device using it gets
85 * unplugged. Questionable feature, but we can't just drop it.
86 * Device models call blockdev_mark_auto_del() to schedule the
87 * automatic deletion, and generic qdev code calls blockdev_auto_del()
88 * when deletion is actually safe.
90 void blockdev_mark_auto_del(BlockDriverState
*bs
)
92 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
94 if (dinfo
&& !dinfo
->enable_auto_del
) {
99 block_job_cancel(bs
->job
);
106 void blockdev_auto_del(BlockDriverState
*bs
)
108 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
110 if (dinfo
&& dinfo
->auto_del
) {
111 drive_put_ref(dinfo
);
115 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
117 int max_devs
= if_max_devs
[type
];
118 return max_devs
? index
/ max_devs
: 0;
121 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
123 int max_devs
= if_max_devs
[type
];
124 return max_devs
? index
% max_devs
: index
;
127 QemuOpts
*drive_def(const char *optstr
)
129 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
132 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
138 opts
= drive_def(optstr
);
142 if (type
!= IF_DEFAULT
) {
143 qemu_opt_set(opts
, "if", if_name
[type
]);
146 snprintf(buf
, sizeof(buf
), "%d", index
);
147 qemu_opt_set(opts
, "index", buf
);
150 qemu_opt_set(opts
, "file", file
);
154 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
158 /* seek interface, bus and unit */
160 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
161 if (dinfo
->type
== type
&&
170 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
172 return drive_get(type
,
173 drive_index_to_bus_id(type
, index
),
174 drive_index_to_unit_id(type
, index
));
177 int drive_get_max_bus(BlockInterfaceType type
)
183 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
184 if(dinfo
->type
== type
&&
185 dinfo
->bus
> max_bus
)
186 max_bus
= dinfo
->bus
;
191 /* Get a block device. This should only be used for single-drive devices
192 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
194 DriveInfo
*drive_get_next(BlockInterfaceType type
)
196 static int next_block_unit
[IF_COUNT
];
198 return drive_get(type
, 0, next_block_unit
[type
]++);
201 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
205 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
206 if (dinfo
->bdrv
== bs
) {
213 static void bdrv_format_print(void *opaque
, const char *name
)
215 error_printf(" %s", name
);
218 static void drive_uninit(DriveInfo
*dinfo
)
220 qemu_opts_del(dinfo
->opts
);
221 bdrv_unref(dinfo
->bdrv
);
223 QTAILQ_REMOVE(&drives
, dinfo
, next
);
224 g_free(dinfo
->serial
);
228 void drive_put_ref(DriveInfo
*dinfo
)
230 assert(dinfo
->refcount
);
231 if (--dinfo
->refcount
== 0) {
236 void drive_get_ref(DriveInfo
*dinfo
)
243 BlockDriverState
*bs
;
246 static void bdrv_put_ref_bh(void *opaque
)
248 BDRVPutRefBH
*s
= opaque
;
251 qemu_bh_delete(s
->bh
);
256 * Release a BDS reference in a BH
258 * It is not safe to use bdrv_unref() from a callback function when the callers
259 * still need the BlockDriverState. In such cases we schedule a BH to release
262 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
266 s
= g_new(BDRVPutRefBH
, 1);
267 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
269 qemu_bh_schedule(s
->bh
);
272 static int parse_block_error_action(const char *buf
, bool is_read
)
274 if (!strcmp(buf
, "ignore")) {
275 return BLOCKDEV_ON_ERROR_IGNORE
;
276 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
277 return BLOCKDEV_ON_ERROR_ENOSPC
;
278 } else if (!strcmp(buf
, "stop")) {
279 return BLOCKDEV_ON_ERROR_STOP
;
280 } else if (!strcmp(buf
, "report")) {
281 return BLOCKDEV_ON_ERROR_REPORT
;
283 error_report("'%s' invalid %s error action",
284 buf
, is_read
? "read" : "write");
289 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
291 if (throttle_conflicting(cfg
)) {
292 error_setg(errp
, "bps/iops/max total values and read/write values"
293 " cannot be used at the same time");
297 if (!throttle_is_valid(cfg
)) {
298 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
305 static DriveInfo
*blockdev_init(QemuOpts
*all_opts
,
306 BlockInterfaceType block_default_type
)
309 const char *file
= NULL
;
311 const char *mediastr
= "";
312 BlockInterfaceType type
;
313 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
315 int cyls
, heads
, secs
, translation
;
320 int on_read_error
, on_write_error
;
331 bool has_driver_specific_opts
;
332 BlockDriver
*drv
= NULL
;
334 translation
= BIOS_ATA_TRANSLATION_AUTO
;
337 /* Check common options by copying from all_opts to opts, all other options
338 * are stored in bs_opts. */
339 id
= qemu_opts_id(all_opts
);
340 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
341 if (error_is_set(&error
)) {
342 qerror_report_err(error
);
347 bs_opts
= qdict_new();
348 qemu_opts_to_qdict(all_opts
, bs_opts
);
349 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
350 if (error_is_set(&error
)) {
351 qerror_report_err(error
);
357 qdict_del(bs_opts
, "id");
360 has_driver_specific_opts
= !!qdict_size(bs_opts
);
362 /* extract parameters */
363 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
364 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
365 index
= qemu_opt_get_number(opts
, "index", -1);
367 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
368 heads
= qemu_opt_get_number(opts
, "heads", 0);
369 secs
= qemu_opt_get_number(opts
, "secs", 0);
371 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
372 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
373 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
375 file
= qemu_opt_get(opts
, "file");
376 serial
= qemu_opt_get(opts
, "serial");
378 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
379 for (type
= 0; type
< IF_COUNT
&& strcmp(buf
, if_name
[type
]); type
++)
381 if (type
== IF_COUNT
) {
382 error_report("unsupported bus type '%s'", buf
);
386 type
= block_default_type
;
389 max_devs
= if_max_devs
[type
];
391 if (cyls
|| heads
|| secs
) {
393 error_report("invalid physical cyls number");
397 error_report("invalid physical heads number");
401 error_report("invalid physical secs number");
406 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
408 error_report("'%s' trans must be used with cyls, heads and secs",
412 if (!strcmp(buf
, "none"))
413 translation
= BIOS_ATA_TRANSLATION_NONE
;
414 else if (!strcmp(buf
, "lba"))
415 translation
= BIOS_ATA_TRANSLATION_LBA
;
416 else if (!strcmp(buf
, "auto"))
417 translation
= BIOS_ATA_TRANSLATION_AUTO
;
419 error_report("'%s' invalid translation type", buf
);
424 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
425 if (!strcmp(buf
, "disk")) {
427 } else if (!strcmp(buf
, "cdrom")) {
428 if (cyls
|| secs
|| heads
) {
429 error_report("CHS can't be set with media=%s", buf
);
434 error_report("'%s' invalid media", buf
);
439 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
440 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
441 error_report("invalid discard option");
446 if (qemu_opt_get_bool(opts
, "cache.writeback", true)) {
447 bdrv_flags
|= BDRV_O_CACHE_WB
;
449 if (qemu_opt_get_bool(opts
, "cache.direct", false)) {
450 bdrv_flags
|= BDRV_O_NOCACHE
;
452 if (qemu_opt_get_bool(opts
, "cache.no-flush", false)) {
453 bdrv_flags
|= BDRV_O_NO_FLUSH
;
456 #ifdef CONFIG_LINUX_AIO
457 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
458 if (!strcmp(buf
, "native")) {
459 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
460 } else if (!strcmp(buf
, "threads")) {
461 /* this is the default */
463 error_report("invalid aio option");
469 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
470 if (is_help_option(buf
)) {
471 error_printf("Supported formats:");
472 bdrv_iterate_format(bdrv_format_print
, NULL
);
477 drv
= bdrv_find_format(buf
);
479 error_report("'%s' invalid format", buf
);
484 /* disk I/O throttling */
485 memset(&cfg
, 0, sizeof(cfg
));
486 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
487 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
488 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
489 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
490 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
491 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
492 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
493 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
494 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
495 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
496 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
497 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
499 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
500 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
501 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
502 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
503 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
504 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
505 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
506 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
507 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
508 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
509 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
510 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
512 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
514 if (!check_throttle_config(&cfg
, &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
);
603 /* no id supplied -> create one */
604 if (qemu_opts_id(opts
) == NULL
) {
606 if (type
== IF_IDE
|| type
== IF_SCSI
) {
607 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
610 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
613 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
616 qemu_opts_set_id(opts
, new_id
);
620 dinfo
= g_malloc0(sizeof(*dinfo
));
621 dinfo
->id
= g_strdup(qemu_opts_id(opts
));
622 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
623 dinfo
->bdrv
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
624 dinfo
->bdrv
->read_only
= ro
;
625 dinfo
->devaddr
= devaddr
;
628 dinfo
->unit
= unit_id
;
630 dinfo
->heads
= heads
;
632 dinfo
->trans
= translation
;
633 dinfo
->opts
= all_opts
;
635 if (serial
!= NULL
) {
636 dinfo
->serial
= g_strdup(serial
);
638 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
640 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
642 /* disk I/O throttling */
643 if (throttle_enabled(&cfg
)) {
644 bdrv_io_limits_enable(dinfo
->bdrv
);
645 bdrv_set_io_limits(dinfo
->bdrv
, &cfg
);
653 dinfo
->media_cd
= media
== MEDIA_CDROM
;
662 /* add virtio block device */
664 devopts
= qemu_opts_create_nofail(qemu_find_opts("device"));
665 if (arch_type
== QEMU_ARCH_S390X
) {
666 qemu_opt_set(devopts
, "driver", "virtio-blk-s390");
668 qemu_opt_set(devopts
, "driver", "virtio-blk-pci");
670 qemu_opt_set(devopts
, "drive", dinfo
->id
);
672 qemu_opt_set(devopts
, "addr", devaddr
);
678 if (!file
|| !*file
) {
679 if (has_driver_specific_opts
) {
686 /* always use cache=unsafe with snapshot */
687 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
688 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
692 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
695 if (runstate_check(RUN_STATE_INMIGRATE
)) {
696 bdrv_flags
|= BDRV_O_INCOMING
;
699 if (media
== MEDIA_CDROM
) {
700 /* CDROM is fine for any interface, don't check. */
702 } else if (ro
== 1) {
703 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&&
704 type
!= IF_NONE
&& type
!= IF_PFLASH
) {
705 error_report("read-only not supported by this bus type");
710 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
712 if (ro
&& copy_on_read
) {
713 error_report("warning: disabling copy_on_read on read-only drive");
717 ret
= bdrv_open(dinfo
->bdrv
, file
, bs_opts
, bdrv_flags
, drv
, &error
);
720 error_report("could not open disk image %s: %s",
721 file
?: dinfo
->id
, error_get_pretty(error
));
725 if (bdrv_key_required(dinfo
->bdrv
))
736 bdrv_unref(dinfo
->bdrv
);
738 QTAILQ_REMOVE(&drives
, dinfo
, next
);
743 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
)
747 value
= qemu_opt_get(opts
, from
);
749 qemu_opt_set(opts
, to
, value
);
750 qemu_opt_unset(opts
, from
);
754 DriveInfo
*drive_init(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
759 /* Change legacy command line options into QMP ones */
760 qemu_opt_rename(all_opts
, "iops", "throttling.iops-total");
761 qemu_opt_rename(all_opts
, "iops_rd", "throttling.iops-read");
762 qemu_opt_rename(all_opts
, "iops_wr", "throttling.iops-write");
764 qemu_opt_rename(all_opts
, "bps", "throttling.bps-total");
765 qemu_opt_rename(all_opts
, "bps_rd", "throttling.bps-read");
766 qemu_opt_rename(all_opts
, "bps_wr", "throttling.bps-write");
768 qemu_opt_rename(all_opts
, "iops_max", "throttling.iops-total-max");
769 qemu_opt_rename(all_opts
, "iops_rd_max", "throttling.iops-read-max");
770 qemu_opt_rename(all_opts
, "iops_wr_max", "throttling.iops-write-max");
772 qemu_opt_rename(all_opts
, "bps_max", "throttling.bps-total-max");
773 qemu_opt_rename(all_opts
, "bps_rd_max", "throttling.bps-read-max");
774 qemu_opt_rename(all_opts
, "bps_wr_max", "throttling.bps-write-max");
776 qemu_opt_rename(all_opts
,
777 "iops_size", "throttling.iops-size");
779 qemu_opt_rename(all_opts
, "readonly", "read-only");
781 value
= qemu_opt_get(all_opts
, "cache");
785 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
786 error_report("invalid cache option");
790 /* Specific options take precedence */
791 if (!qemu_opt_get(all_opts
, "cache.writeback")) {
792 qemu_opt_set_bool(all_opts
, "cache.writeback",
793 !!(flags
& BDRV_O_CACHE_WB
));
795 if (!qemu_opt_get(all_opts
, "cache.direct")) {
796 qemu_opt_set_bool(all_opts
, "cache.direct",
797 !!(flags
& BDRV_O_NOCACHE
));
799 if (!qemu_opt_get(all_opts
, "cache.no-flush")) {
800 qemu_opt_set_bool(all_opts
, "cache.no-flush",
801 !!(flags
& BDRV_O_NO_FLUSH
));
803 qemu_opt_unset(all_opts
, "cache");
806 /* Actual block device init: Functionality shared with blockdev-add */
807 dinfo
= blockdev_init(all_opts
, block_default_type
);
812 /* Set legacy DriveInfo fields */
813 dinfo
->enable_auto_del
= true;
819 void do_commit(Monitor
*mon
, const QDict
*qdict
)
821 const char *device
= qdict_get_str(qdict
, "device");
822 BlockDriverState
*bs
;
825 if (!strcmp(device
, "all")) {
826 ret
= bdrv_commit_all();
828 bs
= bdrv_find(device
);
830 monitor_printf(mon
, "Device '%s' not found\n", device
);
833 ret
= bdrv_commit(bs
);
836 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
841 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
843 TransactionAction action
;
844 TransactionActionList list
;
848 list
.value
= &action
;
850 qmp_transaction(&list
, errp
);
853 void qmp_blockdev_snapshot_sync(const char *device
, const char *snapshot_file
,
854 bool has_format
, const char *format
,
855 bool has_mode
, enum NewImageMode mode
,
858 BlockdevSnapshot snapshot
= {
859 .device
= (char *) device
,
860 .snapshot_file
= (char *) snapshot_file
,
861 .has_format
= has_format
,
862 .format
= (char *) format
,
863 .has_mode
= has_mode
,
866 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
870 void qmp_blockdev_snapshot_internal_sync(const char *device
,
874 BlockdevSnapshotInternal snapshot
= {
875 .device
= (char *) device
,
876 .name
= (char *) name
879 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
883 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
890 BlockDriverState
*bs
= bdrv_find(device
);
892 Error
*local_err
= NULL
;
893 SnapshotInfo
*info
= NULL
;
897 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
910 error_setg(errp
, "Name or id must be provided");
914 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
915 if (error_is_set(&local_err
)) {
916 error_propagate(errp
, local_err
);
921 "Snapshot with id '%s' and name '%s' does not exist on "
923 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
927 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
928 if (error_is_set(&local_err
)) {
929 error_propagate(errp
, local_err
);
933 info
= g_malloc0(sizeof(SnapshotInfo
));
934 info
->id
= g_strdup(sn
.id_str
);
935 info
->name
= g_strdup(sn
.name
);
936 info
->date_nsec
= sn
.date_nsec
;
937 info
->date_sec
= sn
.date_sec
;
938 info
->vm_state_size
= sn
.vm_state_size
;
939 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
940 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
945 /* New and old BlockDriverState structs for group snapshots */
947 typedef struct BlkTransactionState BlkTransactionState
;
949 /* Only prepare() may fail. In a single transaction, only one of commit() or
950 abort() will be called, clean() will always be called if it present. */
951 typedef struct BdrvActionOps
{
952 /* Size of state struct, in bytes. */
953 size_t instance_size
;
954 /* Prepare the work, must NOT be NULL. */
955 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
956 /* Commit the changes, can be NULL. */
957 void (*commit
)(BlkTransactionState
*common
);
958 /* Abort the changes on fail, can be NULL. */
959 void (*abort
)(BlkTransactionState
*common
);
960 /* Clean up resource in the end, can be NULL. */
961 void (*clean
)(BlkTransactionState
*common
);
965 * This structure must be arranged as first member in child type, assuming
966 * that compiler will also arrange it to the same address with parent instance.
967 * Later it will be used in free().
969 struct BlkTransactionState
{
970 TransactionAction
*action
;
971 const BdrvActionOps
*ops
;
972 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
975 /* internal snapshot private data */
976 typedef struct InternalSnapshotState
{
977 BlkTransactionState common
;
978 BlockDriverState
*bs
;
980 } InternalSnapshotState
;
982 static void internal_snapshot_prepare(BlkTransactionState
*common
,
987 BlockDriverState
*bs
;
988 QEMUSnapshotInfo old_sn
, *sn
;
991 BlockdevSnapshotInternal
*internal
;
992 InternalSnapshotState
*state
;
995 g_assert(common
->action
->kind
==
996 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
997 internal
= common
->action
->blockdev_snapshot_internal_sync
;
998 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1000 /* 1. parse input */
1001 device
= internal
->device
;
1002 name
= internal
->name
;
1004 /* 2. check for validation */
1005 bs
= bdrv_find(device
);
1007 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1011 if (!bdrv_is_inserted(bs
)) {
1012 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1016 if (bdrv_is_read_only(bs
)) {
1017 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1021 if (!bdrv_can_snapshot(bs
)) {
1022 error_set(errp
, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
1023 bs
->drv
->format_name
, device
, "internal snapshot");
1027 if (!strlen(name
)) {
1028 error_setg(errp
, "Name is empty");
1032 /* check whether a snapshot with name exist */
1033 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
, errp
);
1034 if (error_is_set(errp
)) {
1038 "Snapshot with name '%s' already exists on device '%s'",
1043 /* 3. take the snapshot */
1045 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1046 qemu_gettimeofday(&tv
);
1047 sn
->date_sec
= tv
.tv_sec
;
1048 sn
->date_nsec
= tv
.tv_usec
* 1000;
1049 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1051 ret1
= bdrv_snapshot_create(bs
, sn
);
1053 error_setg_errno(errp
, -ret1
,
1054 "Failed to create snapshot '%s' on device '%s'",
1059 /* 4. succeed, mark a snapshot is created */
1063 static void internal_snapshot_abort(BlkTransactionState
*common
)
1065 InternalSnapshotState
*state
=
1066 DO_UPCAST(InternalSnapshotState
, common
, common
);
1067 BlockDriverState
*bs
= state
->bs
;
1068 QEMUSnapshotInfo
*sn
= &state
->sn
;
1069 Error
*local_error
= NULL
;
1075 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1076 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1077 "device '%s' in abort: %s",
1080 bdrv_get_device_name(bs
),
1081 error_get_pretty(local_error
));
1082 error_free(local_error
);
1086 /* external snapshot private data */
1087 typedef struct ExternalSnapshotState
{
1088 BlkTransactionState common
;
1089 BlockDriverState
*old_bs
;
1090 BlockDriverState
*new_bs
;
1091 } ExternalSnapshotState
;
1093 static void external_snapshot_prepare(BlkTransactionState
*common
,
1098 Error
*local_err
= NULL
;
1100 const char *new_image_file
;
1101 const char *format
= "qcow2";
1102 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1103 ExternalSnapshotState
*state
=
1104 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1105 TransactionAction
*action
= common
->action
;
1107 /* get parameters */
1108 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1110 device
= action
->blockdev_snapshot_sync
->device
;
1111 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1112 if (action
->blockdev_snapshot_sync
->has_format
) {
1113 format
= action
->blockdev_snapshot_sync
->format
;
1115 if (action
->blockdev_snapshot_sync
->has_mode
) {
1116 mode
= action
->blockdev_snapshot_sync
->mode
;
1119 /* start processing */
1120 drv
= bdrv_find_format(format
);
1122 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1126 state
->old_bs
= bdrv_find(device
);
1127 if (!state
->old_bs
) {
1128 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1132 if (!bdrv_is_inserted(state
->old_bs
)) {
1133 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1137 if (bdrv_in_use(state
->old_bs
)) {
1138 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1142 if (!bdrv_is_read_only(state
->old_bs
)) {
1143 if (bdrv_flush(state
->old_bs
)) {
1144 error_set(errp
, QERR_IO_ERROR
);
1149 if (bdrv_check_ext_snapshot(state
->old_bs
) != EXT_SNAPSHOT_ALLOWED
) {
1150 error_set(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1154 flags
= state
->old_bs
->open_flags
;
1156 /* create new image w/backing file */
1157 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1158 bdrv_img_create(new_image_file
, format
,
1159 state
->old_bs
->filename
,
1160 state
->old_bs
->drv
->format_name
,
1161 NULL
, -1, flags
, &local_err
, false);
1162 if (error_is_set(&local_err
)) {
1163 error_propagate(errp
, local_err
);
1168 /* We will manually add the backing_hd field to the bs later */
1169 state
->new_bs
= bdrv_new("");
1170 /* TODO Inherit bs->options or only take explicit options with an
1171 * extended QMP command? */
1172 ret
= bdrv_open(state
->new_bs
, new_image_file
, NULL
,
1173 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
1175 error_propagate(errp
, local_err
);
1179 static void external_snapshot_commit(BlkTransactionState
*common
)
1181 ExternalSnapshotState
*state
=
1182 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1184 /* This removes our old bs and adds the new bs */
1185 bdrv_append(state
->new_bs
, state
->old_bs
);
1186 /* We don't need (or want) to use the transactional
1187 * bdrv_reopen_multiple() across all the entries at once, because we
1188 * don't want to abort all of them if one of them fails the reopen */
1189 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
1193 static void external_snapshot_abort(BlkTransactionState
*common
)
1195 ExternalSnapshotState
*state
=
1196 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1197 if (state
->new_bs
) {
1198 bdrv_unref(state
->new_bs
);
1202 typedef struct DriveBackupState
{
1203 BlkTransactionState common
;
1204 BlockDriverState
*bs
;
1208 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1210 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1211 DriveBackup
*backup
;
1212 Error
*local_err
= NULL
;
1214 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1215 backup
= common
->action
->drive_backup
;
1217 qmp_drive_backup(backup
->device
, backup
->target
,
1218 backup
->has_format
, backup
->format
,
1220 backup
->has_mode
, backup
->mode
,
1221 backup
->has_speed
, backup
->speed
,
1222 backup
->has_on_source_error
, backup
->on_source_error
,
1223 backup
->has_on_target_error
, backup
->on_target_error
,
1225 if (error_is_set(&local_err
)) {
1226 error_propagate(errp
, local_err
);
1232 state
->bs
= bdrv_find(backup
->device
);
1233 state
->job
= state
->bs
->job
;
1236 static void drive_backup_abort(BlkTransactionState
*common
)
1238 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1239 BlockDriverState
*bs
= state
->bs
;
1241 /* Only cancel if it's the job we started */
1242 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1243 block_job_cancel_sync(bs
->job
);
1247 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1249 error_setg(errp
, "Transaction aborted using Abort action");
1252 static void abort_commit(BlkTransactionState
*common
)
1254 g_assert_not_reached(); /* this action never succeeds */
1257 static const BdrvActionOps actions
[] = {
1258 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1259 .instance_size
= sizeof(ExternalSnapshotState
),
1260 .prepare
= external_snapshot_prepare
,
1261 .commit
= external_snapshot_commit
,
1262 .abort
= external_snapshot_abort
,
1264 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1265 .instance_size
= sizeof(DriveBackupState
),
1266 .prepare
= drive_backup_prepare
,
1267 .abort
= drive_backup_abort
,
1269 [TRANSACTION_ACTION_KIND_ABORT
] = {
1270 .instance_size
= sizeof(BlkTransactionState
),
1271 .prepare
= abort_prepare
,
1272 .commit
= abort_commit
,
1274 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1275 .instance_size
= sizeof(InternalSnapshotState
),
1276 .prepare
= internal_snapshot_prepare
,
1277 .abort
= internal_snapshot_abort
,
1282 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1283 * then we do not pivot any of the devices in the group, and abandon the
1286 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1288 TransactionActionList
*dev_entry
= dev_list
;
1289 BlkTransactionState
*state
, *next
;
1290 Error
*local_err
= NULL
;
1292 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1293 QSIMPLEQ_INIT(&snap_bdrv_states
);
1295 /* drain all i/o before any snapshots */
1298 /* We don't do anything in this loop that commits us to the snapshot */
1299 while (NULL
!= dev_entry
) {
1300 TransactionAction
*dev_info
= NULL
;
1301 const BdrvActionOps
*ops
;
1303 dev_info
= dev_entry
->value
;
1304 dev_entry
= dev_entry
->next
;
1306 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1308 ops
= &actions
[dev_info
->kind
];
1309 assert(ops
->instance_size
> 0);
1311 state
= g_malloc0(ops
->instance_size
);
1313 state
->action
= dev_info
;
1314 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1316 state
->ops
->prepare(state
, &local_err
);
1317 if (error_is_set(&local_err
)) {
1318 error_propagate(errp
, local_err
);
1319 goto delete_and_fail
;
1323 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1324 if (state
->ops
->commit
) {
1325 state
->ops
->commit(state
);
1334 * failure, and it is all-or-none; abandon each new bs, and keep using
1335 * the original bs for all images
1337 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1338 if (state
->ops
->abort
) {
1339 state
->ops
->abort(state
);
1343 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1344 if (state
->ops
->clean
) {
1345 state
->ops
->clean(state
);
1352 static void eject_device(BlockDriverState
*bs
, int force
, Error
**errp
)
1354 if (bdrv_in_use(bs
)) {
1355 error_set(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
1358 if (!bdrv_dev_has_removable_media(bs
)) {
1359 error_set(errp
, QERR_DEVICE_NOT_REMOVABLE
, bdrv_get_device_name(bs
));
1363 if (bdrv_dev_is_medium_locked(bs
) && !bdrv_dev_is_tray_open(bs
)) {
1364 bdrv_dev_eject_request(bs
, force
);
1366 error_set(errp
, QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
1374 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1376 BlockDriverState
*bs
;
1378 bs
= bdrv_find(device
);
1380 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1384 eject_device(bs
, force
, errp
);
1387 void qmp_block_passwd(const char *device
, const char *password
, Error
**errp
)
1389 BlockDriverState
*bs
;
1392 bs
= bdrv_find(device
);
1394 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1398 err
= bdrv_set_key(bs
, password
);
1399 if (err
== -EINVAL
) {
1400 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1402 } else if (err
< 0) {
1403 error_set(errp
, QERR_INVALID_PASSWORD
);
1408 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1409 int bdrv_flags
, BlockDriver
*drv
,
1410 const char *password
, Error
**errp
)
1412 Error
*local_err
= NULL
;
1415 ret
= bdrv_open(bs
, filename
, NULL
, bdrv_flags
, drv
, &local_err
);
1417 error_propagate(errp
, local_err
);
1421 if (bdrv_key_required(bs
)) {
1423 if (bdrv_set_key(bs
, password
) < 0) {
1424 error_set(errp
, QERR_INVALID_PASSWORD
);
1427 error_set(errp
, QERR_DEVICE_ENCRYPTED
, bdrv_get_device_name(bs
),
1428 bdrv_get_encrypted_filename(bs
));
1430 } else if (password
) {
1431 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1435 void qmp_change_blockdev(const char *device
, const char *filename
,
1436 bool has_format
, const char *format
, Error
**errp
)
1438 BlockDriverState
*bs
;
1439 BlockDriver
*drv
= NULL
;
1443 bs
= bdrv_find(device
);
1445 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1450 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1452 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1457 eject_device(bs
, 0, &err
);
1458 if (error_is_set(&err
)) {
1459 error_propagate(errp
, err
);
1463 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1464 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1466 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1469 /* throttling disk I/O limits */
1470 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1477 bool has_bps_rd_max
,
1479 bool has_bps_wr_max
,
1483 bool has_iops_rd_max
,
1484 int64_t iops_rd_max
,
1485 bool has_iops_wr_max
,
1486 int64_t iops_wr_max
,
1488 int64_t iops_size
, Error
**errp
)
1491 BlockDriverState
*bs
;
1493 bs
= bdrv_find(device
);
1495 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1499 memset(&cfg
, 0, sizeof(cfg
));
1500 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
1501 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
1502 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
1504 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
1505 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
1506 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
1509 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
1511 if (has_bps_rd_max
) {
1512 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
1514 if (has_bps_wr_max
) {
1515 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
1518 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
1520 if (has_iops_rd_max
) {
1521 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
1523 if (has_iops_wr_max
) {
1524 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
1527 if (has_iops_size
) {
1528 cfg
.op_size
= iops_size
;
1531 if (!check_throttle_config(&cfg
, errp
)) {
1535 if (!bs
->io_limits_enabled
&& throttle_enabled(&cfg
)) {
1536 bdrv_io_limits_enable(bs
);
1537 } else if (bs
->io_limits_enabled
&& !throttle_enabled(&cfg
)) {
1538 bdrv_io_limits_disable(bs
);
1541 if (bs
->io_limits_enabled
) {
1542 bdrv_set_io_limits(bs
, &cfg
);
1546 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
1548 const char *id
= qdict_get_str(qdict
, "id");
1549 BlockDriverState
*bs
;
1553 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
1556 if (bdrv_in_use(bs
)) {
1557 qerror_report(QERR_DEVICE_IN_USE
, id
);
1561 /* quiesce block driver; prevent further io */
1566 /* if we have a device attached to this BlockDriverState
1567 * then we need to make the drive anonymous until the device
1568 * can be removed. If this is a drive with no device backing
1569 * then we can just get rid of the block driver state right here.
1571 if (bdrv_get_attached_dev(bs
)) {
1574 /* Further I/O must not pause the guest */
1575 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
1576 BLOCKDEV_ON_ERROR_REPORT
);
1578 drive_uninit(drive_get_by_blockdev(bs
));
1584 void qmp_block_resize(const char *device
, int64_t size
, Error
**errp
)
1586 BlockDriverState
*bs
;
1589 bs
= bdrv_find(device
);
1591 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1596 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
1600 /* complete all in-flight operations before resizing the device */
1603 ret
= bdrv_truncate(bs
, size
);
1608 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1611 error_set(errp
, QERR_UNSUPPORTED
);
1614 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1617 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1620 error_setg_errno(errp
, -ret
, "Could not resize");
1625 static void block_job_cb(void *opaque
, int ret
)
1627 BlockDriverState
*bs
= opaque
;
1630 trace_block_job_cb(bs
, bs
->job
, ret
);
1633 obj
= qobject_from_block_job(bs
->job
);
1635 QDict
*dict
= qobject_to_qdict(obj
);
1636 qdict_put(dict
, "error", qstring_from_str(strerror(-ret
)));
1639 if (block_job_is_cancelled(bs
->job
)) {
1640 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED
, obj
);
1642 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED
, obj
);
1644 qobject_decref(obj
);
1646 bdrv_put_ref_bh_schedule(bs
);
1649 void qmp_block_stream(const char *device
, bool has_base
,
1650 const char *base
, bool has_speed
, int64_t speed
,
1651 bool has_on_error
, BlockdevOnError on_error
,
1654 BlockDriverState
*bs
;
1655 BlockDriverState
*base_bs
= NULL
;
1656 Error
*local_err
= NULL
;
1658 if (!has_on_error
) {
1659 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1662 bs
= bdrv_find(device
);
1664 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1669 base_bs
= bdrv_find_backing_image(bs
, base
);
1670 if (base_bs
== NULL
) {
1671 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
1676 stream_start(bs
, base_bs
, base
, has_speed
? speed
: 0,
1677 on_error
, block_job_cb
, bs
, &local_err
);
1678 if (error_is_set(&local_err
)) {
1679 error_propagate(errp
, local_err
);
1683 trace_qmp_block_stream(bs
, bs
->job
);
1686 void qmp_block_commit(const char *device
,
1687 bool has_base
, const char *base
, const char *top
,
1688 bool has_speed
, int64_t speed
,
1691 BlockDriverState
*bs
;
1692 BlockDriverState
*base_bs
, *top_bs
;
1693 Error
*local_err
= NULL
;
1694 /* This will be part of the QMP command, if/when the
1695 * BlockdevOnError change for blkmirror makes it in
1697 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1699 /* drain all i/o before commits */
1702 bs
= bdrv_find(device
);
1704 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1708 /* default top_bs is the active layer */
1712 if (strcmp(bs
->filename
, top
) != 0) {
1713 top_bs
= bdrv_find_backing_image(bs
, top
);
1717 if (top_bs
== NULL
) {
1718 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
1722 if (has_base
&& base
) {
1723 base_bs
= bdrv_find_backing_image(top_bs
, base
);
1725 base_bs
= bdrv_find_base(top_bs
);
1728 if (base_bs
== NULL
) {
1729 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
1733 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
1735 if (local_err
!= NULL
) {
1736 error_propagate(errp
, local_err
);
1741 void qmp_drive_backup(const char *device
, const char *target
,
1742 bool has_format
, const char *format
,
1743 enum MirrorSyncMode sync
,
1744 bool has_mode
, enum NewImageMode mode
,
1745 bool has_speed
, int64_t speed
,
1746 bool has_on_source_error
, BlockdevOnError on_source_error
,
1747 bool has_on_target_error
, BlockdevOnError on_target_error
,
1750 BlockDriverState
*bs
;
1751 BlockDriverState
*target_bs
;
1752 BlockDriverState
*source
= NULL
;
1753 BlockDriver
*drv
= NULL
;
1754 Error
*local_err
= NULL
;
1762 if (!has_on_source_error
) {
1763 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1765 if (!has_on_target_error
) {
1766 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1769 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1772 bs
= bdrv_find(device
);
1774 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1778 if (!bdrv_is_inserted(bs
)) {
1779 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1784 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1787 drv
= bdrv_find_format(format
);
1789 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1794 if (bdrv_in_use(bs
)) {
1795 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1799 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1801 /* See if we have a backing HD we can use to create our new image
1803 if (sync
== MIRROR_SYNC_MODE_TOP
) {
1804 source
= bs
->backing_hd
;
1806 sync
= MIRROR_SYNC_MODE_FULL
;
1809 if (sync
== MIRROR_SYNC_MODE_NONE
) {
1813 size
= bdrv_getlength(bs
);
1815 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1819 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1820 assert(format
&& drv
);
1822 bdrv_img_create(target
, format
, source
->filename
,
1823 source
->drv
->format_name
, NULL
,
1824 size
, flags
, &local_err
, false);
1826 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
1827 size
, flags
, &local_err
, false);
1831 if (error_is_set(&local_err
)) {
1832 error_propagate(errp
, local_err
);
1836 target_bs
= bdrv_new("");
1837 ret
= bdrv_open(target_bs
, target
, NULL
, flags
, drv
, &local_err
);
1839 bdrv_unref(target_bs
);
1840 error_propagate(errp
, local_err
);
1844 backup_start(bs
, target_bs
, speed
, sync
, on_source_error
, on_target_error
,
1845 block_job_cb
, bs
, &local_err
);
1846 if (local_err
!= NULL
) {
1847 bdrv_unref(target_bs
);
1848 error_propagate(errp
, local_err
);
1853 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1855 void qmp_drive_mirror(const char *device
, const char *target
,
1856 bool has_format
, const char *format
,
1857 enum MirrorSyncMode sync
,
1858 bool has_mode
, enum NewImageMode mode
,
1859 bool has_speed
, int64_t speed
,
1860 bool has_granularity
, uint32_t granularity
,
1861 bool has_buf_size
, int64_t buf_size
,
1862 bool has_on_source_error
, BlockdevOnError on_source_error
,
1863 bool has_on_target_error
, BlockdevOnError on_target_error
,
1866 BlockDriverState
*bs
;
1867 BlockDriverState
*source
, *target_bs
;
1868 BlockDriver
*drv
= NULL
;
1869 Error
*local_err
= NULL
;
1877 if (!has_on_source_error
) {
1878 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1880 if (!has_on_target_error
) {
1881 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1884 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1886 if (!has_granularity
) {
1889 if (!has_buf_size
) {
1890 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1893 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
1894 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1897 if (granularity
& (granularity
- 1)) {
1898 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1902 bs
= bdrv_find(device
);
1904 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1908 if (!bdrv_is_inserted(bs
)) {
1909 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1914 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1917 drv
= bdrv_find_format(format
);
1919 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1924 if (bdrv_in_use(bs
)) {
1925 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1929 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1930 source
= bs
->backing_hd
;
1931 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
1932 sync
= MIRROR_SYNC_MODE_FULL
;
1935 size
= bdrv_getlength(bs
);
1937 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1941 if (sync
== MIRROR_SYNC_MODE_FULL
&& mode
!= NEW_IMAGE_MODE_EXISTING
) {
1942 /* create new image w/o backing file */
1943 assert(format
&& drv
);
1944 bdrv_img_create(target
, format
,
1945 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
1948 case NEW_IMAGE_MODE_EXISTING
:
1950 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
1951 /* create new image with backing file */
1952 bdrv_img_create(target
, format
,
1954 source
->drv
->format_name
,
1955 NULL
, size
, flags
, &local_err
, false);
1962 if (error_is_set(&local_err
)) {
1963 error_propagate(errp
, local_err
);
1967 /* Mirroring takes care of copy-on-write using the source's backing
1970 target_bs
= bdrv_new("");
1971 ret
= bdrv_open(target_bs
, target
, NULL
, flags
| BDRV_O_NO_BACKING
, drv
,
1974 bdrv_unref(target_bs
);
1975 error_propagate(errp
, local_err
);
1979 mirror_start(bs
, target_bs
, speed
, granularity
, buf_size
, sync
,
1980 on_source_error
, on_target_error
,
1981 block_job_cb
, bs
, &local_err
);
1982 if (local_err
!= NULL
) {
1983 bdrv_unref(target_bs
);
1984 error_propagate(errp
, local_err
);
1989 static BlockJob
*find_block_job(const char *device
)
1991 BlockDriverState
*bs
;
1993 bs
= bdrv_find(device
);
1994 if (!bs
|| !bs
->job
) {
2000 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
2002 BlockJob
*job
= find_block_job(device
);
2005 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2009 block_job_set_speed(job
, speed
, errp
);
2012 void qmp_block_job_cancel(const char *device
,
2013 bool has_force
, bool force
, Error
**errp
)
2015 BlockJob
*job
= find_block_job(device
);
2022 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2025 if (job
->paused
&& !force
) {
2026 error_set(errp
, QERR_BLOCK_JOB_PAUSED
, device
);
2030 trace_qmp_block_job_cancel(job
);
2031 block_job_cancel(job
);
2034 void qmp_block_job_pause(const char *device
, Error
**errp
)
2036 BlockJob
*job
= find_block_job(device
);
2039 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2043 trace_qmp_block_job_pause(job
);
2044 block_job_pause(job
);
2047 void qmp_block_job_resume(const char *device
, Error
**errp
)
2049 BlockJob
*job
= find_block_job(device
);
2052 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2056 trace_qmp_block_job_resume(job
);
2057 block_job_resume(job
);
2060 void qmp_block_job_complete(const char *device
, Error
**errp
)
2062 BlockJob
*job
= find_block_job(device
);
2065 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2069 trace_qmp_block_job_complete(job
);
2070 block_job_complete(job
, errp
);
2073 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
2075 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2079 Error
*local_err
= NULL
;
2081 /* Require an ID in the top level */
2082 if (!options
->has_id
) {
2083 error_setg(errp
, "Block device needs an ID");
2087 /* TODO Sort it out in raw-posix and drive_init: Reject aio=native with
2088 * cache.direct=false instead of silently switching to aio=threads, except
2089 * if called from drive_init.
2091 * For now, simply forbidding the combination for all drivers will do. */
2092 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
2093 bool direct
= options
->cache
->has_direct
&& options
->cache
->direct
;
2094 if (!options
->has_cache
&& !direct
) {
2095 error_setg(errp
, "aio=native requires cache.direct=true");
2100 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
),
2101 &options
, NULL
, &local_err
);
2102 if (error_is_set(&local_err
)) {
2103 error_propagate(errp
, local_err
);
2107 obj
= qmp_output_get_qobject(ov
);
2108 qdict
= qobject_to_qdict(obj
);
2110 qdict_flatten(qdict
);
2112 QemuOpts
*opts
= qemu_opts_from_qdict(&qemu_drive_opts
, qdict
, &local_err
);
2113 if (error_is_set(&local_err
)) {
2114 error_propagate(errp
, local_err
);
2118 dinfo
= blockdev_init(opts
, IF_NONE
);
2120 error_setg(errp
, "Could not open image");
2125 qmp_output_visitor_cleanup(ov
);
2128 static void do_qmp_query_block_jobs_one(void *opaque
, BlockDriverState
*bs
)
2130 BlockJobInfoList
**prev
= opaque
;
2131 BlockJob
*job
= bs
->job
;
2134 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
2135 elem
->value
= block_job_query(bs
->job
);
2136 (*prev
)->next
= elem
;
2141 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
2143 /* Dummy is a fake list element for holding the head pointer */
2144 BlockJobInfoList dummy
= {};
2145 BlockJobInfoList
*prev
= &dummy
;
2146 bdrv_iterate(do_qmp_query_block_jobs_one
, &prev
);
2150 QemuOptsList qemu_common_drive_opts
= {
2152 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
2156 .type
= QEMU_OPT_NUMBER
,
2157 .help
= "bus number",
2160 .type
= QEMU_OPT_NUMBER
,
2161 .help
= "unit number (i.e. lun for scsi)",
2164 .type
= QEMU_OPT_STRING
,
2165 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2168 .type
= QEMU_OPT_NUMBER
,
2169 .help
= "index number",
2172 .type
= QEMU_OPT_NUMBER
,
2173 .help
= "number of cylinders (ide disk geometry)",
2176 .type
= QEMU_OPT_NUMBER
,
2177 .help
= "number of heads (ide disk geometry)",
2180 .type
= QEMU_OPT_NUMBER
,
2181 .help
= "number of sectors (ide disk geometry)",
2184 .type
= QEMU_OPT_STRING
,
2185 .help
= "chs translation (auto, lba. none)",
2188 .type
= QEMU_OPT_STRING
,
2189 .help
= "media type (disk, cdrom)",
2192 .type
= QEMU_OPT_BOOL
,
2193 .help
= "enable/disable snapshot mode",
2196 .type
= QEMU_OPT_STRING
,
2197 .help
= "disk image",
2200 .type
= QEMU_OPT_STRING
,
2201 .help
= "discard operation (ignore/off, unmap/on)",
2203 .name
= "cache.writeback",
2204 .type
= QEMU_OPT_BOOL
,
2205 .help
= "enables writeback mode for any caches",
2207 .name
= "cache.direct",
2208 .type
= QEMU_OPT_BOOL
,
2209 .help
= "enables use of O_DIRECT (bypass the host page cache)",
2211 .name
= "cache.no-flush",
2212 .type
= QEMU_OPT_BOOL
,
2213 .help
= "ignore any flush requests for the device",
2216 .type
= QEMU_OPT_STRING
,
2217 .help
= "host AIO implementation (threads, native)",
2220 .type
= QEMU_OPT_STRING
,
2221 .help
= "disk format (raw, qcow2, ...)",
2224 .type
= QEMU_OPT_STRING
,
2225 .help
= "disk serial number",
2228 .type
= QEMU_OPT_STRING
,
2229 .help
= "read error action",
2232 .type
= QEMU_OPT_STRING
,
2233 .help
= "write error action",
2236 .type
= QEMU_OPT_STRING
,
2237 .help
= "pci address (virtio only)",
2239 .name
= "read-only",
2240 .type
= QEMU_OPT_BOOL
,
2241 .help
= "open drive file as read-only",
2243 .name
= "throttling.iops-total",
2244 .type
= QEMU_OPT_NUMBER
,
2245 .help
= "limit total I/O operations per second",
2247 .name
= "throttling.iops-read",
2248 .type
= QEMU_OPT_NUMBER
,
2249 .help
= "limit read operations per second",
2251 .name
= "throttling.iops-write",
2252 .type
= QEMU_OPT_NUMBER
,
2253 .help
= "limit write operations per second",
2255 .name
= "throttling.bps-total",
2256 .type
= QEMU_OPT_NUMBER
,
2257 .help
= "limit total bytes per second",
2259 .name
= "throttling.bps-read",
2260 .type
= QEMU_OPT_NUMBER
,
2261 .help
= "limit read bytes per second",
2263 .name
= "throttling.bps-write",
2264 .type
= QEMU_OPT_NUMBER
,
2265 .help
= "limit write bytes per second",
2267 .name
= "throttling.iops-total-max",
2268 .type
= QEMU_OPT_NUMBER
,
2269 .help
= "I/O operations burst",
2271 .name
= "throttling.iops-read-max",
2272 .type
= QEMU_OPT_NUMBER
,
2273 .help
= "I/O operations read burst",
2275 .name
= "throttling.iops-write-max",
2276 .type
= QEMU_OPT_NUMBER
,
2277 .help
= "I/O operations write burst",
2279 .name
= "throttling.bps-total-max",
2280 .type
= QEMU_OPT_NUMBER
,
2281 .help
= "total bytes burst",
2283 .name
= "throttling.bps-read-max",
2284 .type
= QEMU_OPT_NUMBER
,
2285 .help
= "total bytes read burst",
2287 .name
= "throttling.bps-write-max",
2288 .type
= QEMU_OPT_NUMBER
,
2289 .help
= "total bytes write burst",
2291 .name
= "throttling.iops-size",
2292 .type
= QEMU_OPT_NUMBER
,
2293 .help
= "when limiting by iops max size of an I/O in bytes",
2295 .name
= "copy-on-read",
2296 .type
= QEMU_OPT_BOOL
,
2297 .help
= "copy read data from backing file into image file",
2300 .type
= QEMU_OPT_BOOL
,
2301 .help
= "(deprecated, ignored)",
2303 { /* end of list */ }
2307 QemuOptsList qemu_drive_opts
= {
2309 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
2312 * no elements => accept any params
2313 * validation will happen later
2315 { /* end of list */ }