2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
9 * This file incorporates work covered by the following copyright and
12 * Copyright (c) 2003-2008 Fabrice Bellard
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
33 #include "sysemu/blockdev.h"
34 #include "hw/block/block.h"
35 #include "block/blockjob.h"
36 #include "monitor/monitor.h"
37 #include "qapi/qmp/qerror.h"
38 #include "qemu/option.h"
39 #include "qemu/config-file.h"
40 #include "qapi/qmp/types.h"
41 #include "sysemu/sysemu.h"
42 #include "block/block_int.h"
43 #include "qmp-commands.h"
45 #include "sysemu/arch_init.h"
47 static QTAILQ_HEAD(drivelist
, DriveInfo
) drives
= QTAILQ_HEAD_INITIALIZER(drives
);
48 extern QemuOptsList qemu_common_drive_opts
;
50 static const char *const if_name
[IF_COUNT
] = {
54 [IF_FLOPPY
] = "floppy",
55 [IF_PFLASH
] = "pflash",
58 [IF_VIRTIO
] = "virtio",
62 static const int if_max_devs
[IF_COUNT
] = {
64 * Do not change these numbers! They govern how drive option
65 * index maps to unit and bus. That mapping is ABI.
67 * All controllers used to imlement if=T drives need to support
68 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
69 * Otherwise, some index values map to "impossible" bus, unit
72 * For instance, if you change [IF_SCSI] to 255, -drive
73 * if=scsi,index=12 no longer means bus=1,unit=5, but
74 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
75 * the drive can't be set up. Regression.
82 * We automatically delete the drive when a device using it gets
83 * unplugged. Questionable feature, but we can't just drop it.
84 * Device models call blockdev_mark_auto_del() to schedule the
85 * automatic deletion, and generic qdev code calls blockdev_auto_del()
86 * when deletion is actually safe.
88 void blockdev_mark_auto_del(BlockDriverState
*bs
)
90 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
93 block_job_cancel(bs
->job
);
100 void blockdev_auto_del(BlockDriverState
*bs
)
102 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
104 if (dinfo
&& dinfo
->auto_del
) {
105 drive_put_ref(dinfo
);
109 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
111 int max_devs
= if_max_devs
[type
];
112 return max_devs
? index
/ max_devs
: 0;
115 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
117 int max_devs
= if_max_devs
[type
];
118 return max_devs
? index
% max_devs
: index
;
121 QemuOpts
*drive_def(const char *optstr
)
123 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
126 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
132 opts
= drive_def(optstr
);
136 if (type
!= IF_DEFAULT
) {
137 qemu_opt_set(opts
, "if", if_name
[type
]);
140 snprintf(buf
, sizeof(buf
), "%d", index
);
141 qemu_opt_set(opts
, "index", buf
);
144 qemu_opt_set(opts
, "file", file
);
148 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
152 /* seek interface, bus and unit */
154 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
155 if (dinfo
->type
== type
&&
164 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
166 return drive_get(type
,
167 drive_index_to_bus_id(type
, index
),
168 drive_index_to_unit_id(type
, index
));
171 int drive_get_max_bus(BlockInterfaceType type
)
177 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
178 if(dinfo
->type
== type
&&
179 dinfo
->bus
> max_bus
)
180 max_bus
= dinfo
->bus
;
185 /* Get a block device. This should only be used for single-drive devices
186 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
188 DriveInfo
*drive_get_next(BlockInterfaceType type
)
190 static int next_block_unit
[IF_COUNT
];
192 return drive_get(type
, 0, next_block_unit
[type
]++);
195 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
199 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
200 if (dinfo
->bdrv
== bs
) {
207 static void bdrv_format_print(void *opaque
, const char *name
)
209 error_printf(" %s", name
);
212 static void drive_uninit(DriveInfo
*dinfo
)
214 qemu_opts_del(dinfo
->opts
);
215 bdrv_unref(dinfo
->bdrv
);
217 QTAILQ_REMOVE(&drives
, dinfo
, next
);
218 g_free(dinfo
->serial
);
222 void drive_put_ref(DriveInfo
*dinfo
)
224 assert(dinfo
->refcount
);
225 if (--dinfo
->refcount
== 0) {
230 void drive_get_ref(DriveInfo
*dinfo
)
237 BlockDriverState
*bs
;
240 static void bdrv_put_ref_bh(void *opaque
)
242 BDRVPutRefBH
*s
= opaque
;
245 qemu_bh_delete(s
->bh
);
250 * Release a BDS reference in a BH
252 * It is not safe to use bdrv_unref() from a callback function when the callers
253 * still need the BlockDriverState. In such cases we schedule a BH to release
256 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
260 s
= g_new(BDRVPutRefBH
, 1);
261 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
263 qemu_bh_schedule(s
->bh
);
266 static int parse_block_error_action(const char *buf
, bool is_read
)
268 if (!strcmp(buf
, "ignore")) {
269 return BLOCKDEV_ON_ERROR_IGNORE
;
270 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
271 return BLOCKDEV_ON_ERROR_ENOSPC
;
272 } else if (!strcmp(buf
, "stop")) {
273 return BLOCKDEV_ON_ERROR_STOP
;
274 } else if (!strcmp(buf
, "report")) {
275 return BLOCKDEV_ON_ERROR_REPORT
;
277 error_report("'%s' invalid %s error action",
278 buf
, is_read
? "read" : "write");
283 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
285 if (throttle_conflicting(cfg
)) {
286 error_setg(errp
, "bps/iops/max total values and read/write values"
287 " cannot be used at the same time");
291 if (!throttle_is_valid(cfg
)) {
292 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
299 static DriveInfo
*blockdev_init(QemuOpts
*all_opts
,
300 BlockInterfaceType block_default_type
)
303 const char *file
= NULL
;
305 const char *mediastr
= "";
306 BlockInterfaceType type
;
307 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
309 int cyls
, heads
, secs
, translation
;
314 int on_read_error
, on_write_error
;
325 bool has_driver_specific_opts
;
326 BlockDriver
*drv
= NULL
;
328 translation
= BIOS_ATA_TRANSLATION_AUTO
;
331 /* Check common options by copying from all_opts to opts, all other options
332 * are stored in bs_opts. */
333 id
= qemu_opts_id(all_opts
);
334 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
335 if (error_is_set(&error
)) {
336 qerror_report_err(error
);
341 bs_opts
= qdict_new();
342 qemu_opts_to_qdict(all_opts
, bs_opts
);
343 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
344 if (error_is_set(&error
)) {
345 qerror_report_err(error
);
351 qdict_del(bs_opts
, "id");
354 has_driver_specific_opts
= !!qdict_size(bs_opts
);
356 /* extract parameters */
357 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
358 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
359 index
= qemu_opt_get_number(opts
, "index", -1);
361 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
362 heads
= qemu_opt_get_number(opts
, "heads", 0);
363 secs
= qemu_opt_get_number(opts
, "secs", 0);
365 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
366 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
367 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
369 file
= qemu_opt_get(opts
, "file");
370 serial
= qemu_opt_get(opts
, "serial");
372 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
373 for (type
= 0; type
< IF_COUNT
&& strcmp(buf
, if_name
[type
]); type
++)
375 if (type
== IF_COUNT
) {
376 error_report("unsupported bus type '%s'", buf
);
380 type
= block_default_type
;
383 max_devs
= if_max_devs
[type
];
385 if (cyls
|| heads
|| secs
) {
387 error_report("invalid physical cyls number");
391 error_report("invalid physical heads number");
395 error_report("invalid physical secs number");
400 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
402 error_report("'%s' trans must be used with cyls, heads and secs",
406 if (!strcmp(buf
, "none"))
407 translation
= BIOS_ATA_TRANSLATION_NONE
;
408 else if (!strcmp(buf
, "lba"))
409 translation
= BIOS_ATA_TRANSLATION_LBA
;
410 else if (!strcmp(buf
, "auto"))
411 translation
= BIOS_ATA_TRANSLATION_AUTO
;
413 error_report("'%s' invalid translation type", buf
);
418 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
419 if (!strcmp(buf
, "disk")) {
421 } else if (!strcmp(buf
, "cdrom")) {
422 if (cyls
|| secs
|| heads
) {
423 error_report("CHS can't be set with media=%s", buf
);
428 error_report("'%s' invalid media", buf
);
433 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
434 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
435 error_report("invalid discard option");
440 if (qemu_opt_get_bool(opts
, "cache.writeback", true)) {
441 bdrv_flags
|= BDRV_O_CACHE_WB
;
443 if (qemu_opt_get_bool(opts
, "cache.direct", false)) {
444 bdrv_flags
|= BDRV_O_NOCACHE
;
446 if (qemu_opt_get_bool(opts
, "cache.no-flush", false)) {
447 bdrv_flags
|= BDRV_O_NO_FLUSH
;
450 #ifdef CONFIG_LINUX_AIO
451 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
452 if (!strcmp(buf
, "native")) {
453 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
454 } else if (!strcmp(buf
, "threads")) {
455 /* this is the default */
457 error_report("invalid aio option");
463 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
464 if (is_help_option(buf
)) {
465 error_printf("Supported formats:");
466 bdrv_iterate_format(bdrv_format_print
, NULL
);
471 drv
= bdrv_find_format(buf
);
473 error_report("'%s' invalid format", buf
);
478 /* disk I/O throttling */
479 memset(&cfg
, 0, sizeof(cfg
));
480 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
481 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
482 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
483 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
484 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
485 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
486 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
487 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
488 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
489 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
490 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
491 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
493 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
494 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
495 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
496 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
497 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
498 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
499 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
500 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
501 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
502 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
503 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
504 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
506 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
508 if (!check_throttle_config(&cfg
, &error
)) {
509 error_report("%s", error_get_pretty(error
));
514 if (qemu_opt_get(opts
, "boot") != NULL
) {
515 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
516 "ignored. Future versions will reject this parameter. Please "
517 "update your scripts.\n");
520 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
521 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
522 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
523 error_report("werror is not supported by this bus type");
527 on_write_error
= parse_block_error_action(buf
, 0);
528 if (on_write_error
< 0) {
533 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
534 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
535 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
536 error_report("rerror is not supported by this bus type");
540 on_read_error
= parse_block_error_action(buf
, 1);
541 if (on_read_error
< 0) {
546 if ((devaddr
= qemu_opt_get(opts
, "addr")) != NULL
) {
547 if (type
!= IF_VIRTIO
) {
548 error_report("addr is not supported by this bus type");
553 /* compute bus and unit according index */
556 if (bus_id
!= 0 || unit_id
!= -1) {
557 error_report("index cannot be used with bus and unit");
560 bus_id
= drive_index_to_bus_id(type
, index
);
561 unit_id
= drive_index_to_unit_id(type
, index
);
564 /* if user doesn't specify a unit_id,
565 * try to find the first free
570 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
572 if (max_devs
&& unit_id
>= max_devs
) {
581 if (max_devs
&& unit_id
>= max_devs
) {
582 error_report("unit %d too big (max is %d)",
583 unit_id
, max_devs
- 1);
588 * catch multiple definitions
591 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
592 error_report("drive with bus=%d, unit=%d (index=%d) exists",
593 bus_id
, unit_id
, index
);
599 dinfo
= g_malloc0(sizeof(*dinfo
));
600 if ((buf
= qemu_opts_id(opts
)) != NULL
) {
601 dinfo
->id
= g_strdup(buf
);
603 /* no id supplied -> create one */
604 dinfo
->id
= g_malloc0(32);
605 if (type
== IF_IDE
|| type
== IF_SCSI
)
606 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
608 snprintf(dinfo
->id
, 32, "%s%i%s%i",
609 if_name
[type
], bus_id
, mediastr
, unit_id
);
611 snprintf(dinfo
->id
, 32, "%s%s%i",
612 if_name
[type
], mediastr
, unit_id
);
614 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
615 dinfo
->bdrv
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
616 dinfo
->bdrv
->read_only
= ro
;
617 dinfo
->devaddr
= devaddr
;
620 dinfo
->unit
= unit_id
;
622 dinfo
->heads
= heads
;
624 dinfo
->trans
= translation
;
625 dinfo
->opts
= all_opts
;
627 if (serial
!= NULL
) {
628 dinfo
->serial
= g_strdup(serial
);
630 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
632 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
634 /* disk I/O throttling */
635 if (throttle_enabled(&cfg
)) {
636 bdrv_io_limits_enable(dinfo
->bdrv
);
637 bdrv_set_io_limits(dinfo
->bdrv
, &cfg
);
645 dinfo
->media_cd
= media
== MEDIA_CDROM
;
654 /* add virtio block device */
656 devopts
= qemu_opts_create_nofail(qemu_find_opts("device"));
657 if (arch_type
== QEMU_ARCH_S390X
) {
658 qemu_opt_set(devopts
, "driver", "virtio-blk-s390");
660 qemu_opt_set(devopts
, "driver", "virtio-blk-pci");
662 qemu_opt_set(devopts
, "drive", dinfo
->id
);
664 qemu_opt_set(devopts
, "addr", devaddr
);
670 if (!file
|| !*file
) {
671 if (has_driver_specific_opts
) {
678 /* always use cache=unsafe with snapshot */
679 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
680 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
684 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
687 if (runstate_check(RUN_STATE_INMIGRATE
)) {
688 bdrv_flags
|= BDRV_O_INCOMING
;
691 if (media
== MEDIA_CDROM
) {
692 /* CDROM is fine for any interface, don't check. */
694 } else if (ro
== 1) {
695 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&&
696 type
!= IF_NONE
&& type
!= IF_PFLASH
) {
697 error_report("read-only not supported by this bus type");
702 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
704 if (ro
&& copy_on_read
) {
705 error_report("warning: disabling copy_on_read on read-only drive");
709 ret
= bdrv_open(dinfo
->bdrv
, file
, bs_opts
, bdrv_flags
, drv
, &error
);
712 error_report("could not open disk image %s: %s",
713 file
?: dinfo
->id
, error_get_pretty(error
));
717 if (bdrv_key_required(dinfo
->bdrv
))
728 bdrv_unref(dinfo
->bdrv
);
730 QTAILQ_REMOVE(&drives
, dinfo
, next
);
735 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
)
739 value
= qemu_opt_get(opts
, from
);
741 qemu_opt_set(opts
, to
, value
);
742 qemu_opt_unset(opts
, from
);
746 DriveInfo
*drive_init(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
750 /* Change legacy command line options into QMP ones */
751 qemu_opt_rename(all_opts
, "iops", "throttling.iops-total");
752 qemu_opt_rename(all_opts
, "iops_rd", "throttling.iops-read");
753 qemu_opt_rename(all_opts
, "iops_wr", "throttling.iops-write");
755 qemu_opt_rename(all_opts
, "bps", "throttling.bps-total");
756 qemu_opt_rename(all_opts
, "bps_rd", "throttling.bps-read");
757 qemu_opt_rename(all_opts
, "bps_wr", "throttling.bps-write");
759 qemu_opt_rename(all_opts
, "iops_max", "throttling.iops-total-max");
760 qemu_opt_rename(all_opts
, "iops_rd_max", "throttling.iops-read-max");
761 qemu_opt_rename(all_opts
, "iops_wr_max", "throttling.iops-write-max");
763 qemu_opt_rename(all_opts
, "bps_max", "throttling.bps-total-max");
764 qemu_opt_rename(all_opts
, "bps_rd_max", "throttling.bps-read-max");
765 qemu_opt_rename(all_opts
, "bps_wr_max", "throttling.bps-write-max");
767 qemu_opt_rename(all_opts
,
768 "iops_size", "throttling.iops-size");
770 qemu_opt_rename(all_opts
, "readonly", "read-only");
772 value
= qemu_opt_get(all_opts
, "cache");
776 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
777 error_report("invalid cache option");
781 /* Specific options take precedence */
782 if (!qemu_opt_get(all_opts
, "cache.writeback")) {
783 qemu_opt_set_bool(all_opts
, "cache.writeback",
784 !!(flags
& BDRV_O_CACHE_WB
));
786 if (!qemu_opt_get(all_opts
, "cache.direct")) {
787 qemu_opt_set_bool(all_opts
, "cache.direct",
788 !!(flags
& BDRV_O_NOCACHE
));
790 if (!qemu_opt_get(all_opts
, "cache.no-flush")) {
791 qemu_opt_set_bool(all_opts
, "cache.no-flush",
792 !!(flags
& BDRV_O_NO_FLUSH
));
794 qemu_opt_unset(all_opts
, "cache");
797 return blockdev_init(all_opts
, block_default_type
);
800 void do_commit(Monitor
*mon
, const QDict
*qdict
)
802 const char *device
= qdict_get_str(qdict
, "device");
803 BlockDriverState
*bs
;
806 if (!strcmp(device
, "all")) {
807 ret
= bdrv_commit_all();
809 bs
= bdrv_find(device
);
811 monitor_printf(mon
, "Device '%s' not found\n", device
);
814 ret
= bdrv_commit(bs
);
817 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
822 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
824 TransactionAction action
;
825 TransactionActionList list
;
829 list
.value
= &action
;
831 qmp_transaction(&list
, errp
);
834 void qmp_blockdev_snapshot_sync(const char *device
, const char *snapshot_file
,
835 bool has_format
, const char *format
,
836 bool has_mode
, enum NewImageMode mode
,
839 BlockdevSnapshot snapshot
= {
840 .device
= (char *) device
,
841 .snapshot_file
= (char *) snapshot_file
,
842 .has_format
= has_format
,
843 .format
= (char *) format
,
844 .has_mode
= has_mode
,
847 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
851 void qmp_blockdev_snapshot_internal_sync(const char *device
,
855 BlockdevSnapshotInternal snapshot
= {
856 .device
= (char *) device
,
857 .name
= (char *) name
860 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
864 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
871 BlockDriverState
*bs
= bdrv_find(device
);
873 Error
*local_err
= NULL
;
874 SnapshotInfo
*info
= NULL
;
878 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
891 error_setg(errp
, "Name or id must be provided");
895 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
896 if (error_is_set(&local_err
)) {
897 error_propagate(errp
, local_err
);
902 "Snapshot with id '%s' and name '%s' does not exist on "
904 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
908 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
909 if (error_is_set(&local_err
)) {
910 error_propagate(errp
, local_err
);
914 info
= g_malloc0(sizeof(SnapshotInfo
));
915 info
->id
= g_strdup(sn
.id_str
);
916 info
->name
= g_strdup(sn
.name
);
917 info
->date_nsec
= sn
.date_nsec
;
918 info
->date_sec
= sn
.date_sec
;
919 info
->vm_state_size
= sn
.vm_state_size
;
920 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
921 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
926 /* New and old BlockDriverState structs for group snapshots */
928 typedef struct BlkTransactionState BlkTransactionState
;
930 /* Only prepare() may fail. In a single transaction, only one of commit() or
931 abort() will be called, clean() will always be called if it present. */
932 typedef struct BdrvActionOps
{
933 /* Size of state struct, in bytes. */
934 size_t instance_size
;
935 /* Prepare the work, must NOT be NULL. */
936 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
937 /* Commit the changes, can be NULL. */
938 void (*commit
)(BlkTransactionState
*common
);
939 /* Abort the changes on fail, can be NULL. */
940 void (*abort
)(BlkTransactionState
*common
);
941 /* Clean up resource in the end, can be NULL. */
942 void (*clean
)(BlkTransactionState
*common
);
946 * This structure must be arranged as first member in child type, assuming
947 * that compiler will also arrange it to the same address with parent instance.
948 * Later it will be used in free().
950 struct BlkTransactionState
{
951 TransactionAction
*action
;
952 const BdrvActionOps
*ops
;
953 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
956 /* internal snapshot private data */
957 typedef struct InternalSnapshotState
{
958 BlkTransactionState common
;
959 BlockDriverState
*bs
;
961 } InternalSnapshotState
;
963 static void internal_snapshot_prepare(BlkTransactionState
*common
,
968 BlockDriverState
*bs
;
969 QEMUSnapshotInfo old_sn
, *sn
;
972 BlockdevSnapshotInternal
*internal
;
973 InternalSnapshotState
*state
;
976 g_assert(common
->action
->kind
==
977 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
978 internal
= common
->action
->blockdev_snapshot_internal_sync
;
979 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
982 device
= internal
->device
;
983 name
= internal
->name
;
985 /* 2. check for validation */
986 bs
= bdrv_find(device
);
988 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
992 if (!bdrv_is_inserted(bs
)) {
993 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
997 if (bdrv_is_read_only(bs
)) {
998 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1002 if (!bdrv_can_snapshot(bs
)) {
1003 error_set(errp
, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
1004 bs
->drv
->format_name
, device
, "internal snapshot");
1008 if (!strlen(name
)) {
1009 error_setg(errp
, "Name is empty");
1013 /* check whether a snapshot with name exist */
1014 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
, errp
);
1015 if (error_is_set(errp
)) {
1019 "Snapshot with name '%s' already exists on device '%s'",
1024 /* 3. take the snapshot */
1026 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1027 qemu_gettimeofday(&tv
);
1028 sn
->date_sec
= tv
.tv_sec
;
1029 sn
->date_nsec
= tv
.tv_usec
* 1000;
1030 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1032 ret1
= bdrv_snapshot_create(bs
, sn
);
1034 error_setg_errno(errp
, -ret1
,
1035 "Failed to create snapshot '%s' on device '%s'",
1040 /* 4. succeed, mark a snapshot is created */
1044 static void internal_snapshot_abort(BlkTransactionState
*common
)
1046 InternalSnapshotState
*state
=
1047 DO_UPCAST(InternalSnapshotState
, common
, common
);
1048 BlockDriverState
*bs
= state
->bs
;
1049 QEMUSnapshotInfo
*sn
= &state
->sn
;
1050 Error
*local_error
= NULL
;
1056 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1057 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1058 "device '%s' in abort: %s",
1061 bdrv_get_device_name(bs
),
1062 error_get_pretty(local_error
));
1063 error_free(local_error
);
1067 /* external snapshot private data */
1068 typedef struct ExternalSnapshotState
{
1069 BlkTransactionState common
;
1070 BlockDriverState
*old_bs
;
1071 BlockDriverState
*new_bs
;
1072 } ExternalSnapshotState
;
1074 static void external_snapshot_prepare(BlkTransactionState
*common
,
1079 Error
*local_err
= NULL
;
1081 const char *new_image_file
;
1082 const char *format
= "qcow2";
1083 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1084 ExternalSnapshotState
*state
=
1085 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1086 TransactionAction
*action
= common
->action
;
1088 /* get parameters */
1089 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1091 device
= action
->blockdev_snapshot_sync
->device
;
1092 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1093 if (action
->blockdev_snapshot_sync
->has_format
) {
1094 format
= action
->blockdev_snapshot_sync
->format
;
1096 if (action
->blockdev_snapshot_sync
->has_mode
) {
1097 mode
= action
->blockdev_snapshot_sync
->mode
;
1100 /* start processing */
1101 drv
= bdrv_find_format(format
);
1103 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1107 state
->old_bs
= bdrv_find(device
);
1108 if (!state
->old_bs
) {
1109 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1113 if (!bdrv_is_inserted(state
->old_bs
)) {
1114 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1118 if (bdrv_in_use(state
->old_bs
)) {
1119 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1123 if (!bdrv_is_read_only(state
->old_bs
)) {
1124 if (bdrv_flush(state
->old_bs
)) {
1125 error_set(errp
, QERR_IO_ERROR
);
1130 if (bdrv_check_ext_snapshot(state
->old_bs
) != EXT_SNAPSHOT_ALLOWED
) {
1131 error_set(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1135 flags
= state
->old_bs
->open_flags
;
1137 /* create new image w/backing file */
1138 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1139 bdrv_img_create(new_image_file
, format
,
1140 state
->old_bs
->filename
,
1141 state
->old_bs
->drv
->format_name
,
1142 NULL
, -1, flags
, &local_err
, false);
1143 if (error_is_set(&local_err
)) {
1144 error_propagate(errp
, local_err
);
1149 /* We will manually add the backing_hd field to the bs later */
1150 state
->new_bs
= bdrv_new("");
1151 /* TODO Inherit bs->options or only take explicit options with an
1152 * extended QMP command? */
1153 ret
= bdrv_open(state
->new_bs
, new_image_file
, NULL
,
1154 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
1156 error_propagate(errp
, local_err
);
1160 static void external_snapshot_commit(BlkTransactionState
*common
)
1162 ExternalSnapshotState
*state
=
1163 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1165 /* This removes our old bs and adds the new bs */
1166 bdrv_append(state
->new_bs
, state
->old_bs
);
1167 /* We don't need (or want) to use the transactional
1168 * bdrv_reopen_multiple() across all the entries at once, because we
1169 * don't want to abort all of them if one of them fails the reopen */
1170 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
1174 static void external_snapshot_abort(BlkTransactionState
*common
)
1176 ExternalSnapshotState
*state
=
1177 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1178 if (state
->new_bs
) {
1179 bdrv_unref(state
->new_bs
);
1183 typedef struct DriveBackupState
{
1184 BlkTransactionState common
;
1185 BlockDriverState
*bs
;
1189 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1191 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1192 DriveBackup
*backup
;
1193 Error
*local_err
= NULL
;
1195 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1196 backup
= common
->action
->drive_backup
;
1198 qmp_drive_backup(backup
->device
, backup
->target
,
1199 backup
->has_format
, backup
->format
,
1201 backup
->has_mode
, backup
->mode
,
1202 backup
->has_speed
, backup
->speed
,
1203 backup
->has_on_source_error
, backup
->on_source_error
,
1204 backup
->has_on_target_error
, backup
->on_target_error
,
1206 if (error_is_set(&local_err
)) {
1207 error_propagate(errp
, local_err
);
1213 state
->bs
= bdrv_find(backup
->device
);
1214 state
->job
= state
->bs
->job
;
1217 static void drive_backup_abort(BlkTransactionState
*common
)
1219 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1220 BlockDriverState
*bs
= state
->bs
;
1222 /* Only cancel if it's the job we started */
1223 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1224 block_job_cancel_sync(bs
->job
);
1228 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1230 error_setg(errp
, "Transaction aborted using Abort action");
1233 static void abort_commit(BlkTransactionState
*common
)
1235 g_assert_not_reached(); /* this action never succeeds */
1238 static const BdrvActionOps actions
[] = {
1239 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1240 .instance_size
= sizeof(ExternalSnapshotState
),
1241 .prepare
= external_snapshot_prepare
,
1242 .commit
= external_snapshot_commit
,
1243 .abort
= external_snapshot_abort
,
1245 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1246 .instance_size
= sizeof(DriveBackupState
),
1247 .prepare
= drive_backup_prepare
,
1248 .abort
= drive_backup_abort
,
1250 [TRANSACTION_ACTION_KIND_ABORT
] = {
1251 .instance_size
= sizeof(BlkTransactionState
),
1252 .prepare
= abort_prepare
,
1253 .commit
= abort_commit
,
1255 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1256 .instance_size
= sizeof(InternalSnapshotState
),
1257 .prepare
= internal_snapshot_prepare
,
1258 .abort
= internal_snapshot_abort
,
1263 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1264 * then we do not pivot any of the devices in the group, and abandon the
1267 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1269 TransactionActionList
*dev_entry
= dev_list
;
1270 BlkTransactionState
*state
, *next
;
1271 Error
*local_err
= NULL
;
1273 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1274 QSIMPLEQ_INIT(&snap_bdrv_states
);
1276 /* drain all i/o before any snapshots */
1279 /* We don't do anything in this loop that commits us to the snapshot */
1280 while (NULL
!= dev_entry
) {
1281 TransactionAction
*dev_info
= NULL
;
1282 const BdrvActionOps
*ops
;
1284 dev_info
= dev_entry
->value
;
1285 dev_entry
= dev_entry
->next
;
1287 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1289 ops
= &actions
[dev_info
->kind
];
1290 assert(ops
->instance_size
> 0);
1292 state
= g_malloc0(ops
->instance_size
);
1294 state
->action
= dev_info
;
1295 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1297 state
->ops
->prepare(state
, &local_err
);
1298 if (error_is_set(&local_err
)) {
1299 error_propagate(errp
, local_err
);
1300 goto delete_and_fail
;
1304 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1305 if (state
->ops
->commit
) {
1306 state
->ops
->commit(state
);
1315 * failure, and it is all-or-none; abandon each new bs, and keep using
1316 * the original bs for all images
1318 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1319 if (state
->ops
->abort
) {
1320 state
->ops
->abort(state
);
1324 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1325 if (state
->ops
->clean
) {
1326 state
->ops
->clean(state
);
1333 static void eject_device(BlockDriverState
*bs
, int force
, Error
**errp
)
1335 if (bdrv_in_use(bs
)) {
1336 error_set(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
1339 if (!bdrv_dev_has_removable_media(bs
)) {
1340 error_set(errp
, QERR_DEVICE_NOT_REMOVABLE
, bdrv_get_device_name(bs
));
1344 if (bdrv_dev_is_medium_locked(bs
) && !bdrv_dev_is_tray_open(bs
)) {
1345 bdrv_dev_eject_request(bs
, force
);
1347 error_set(errp
, QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
1355 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1357 BlockDriverState
*bs
;
1359 bs
= bdrv_find(device
);
1361 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1365 eject_device(bs
, force
, errp
);
1368 void qmp_block_passwd(const char *device
, const char *password
, Error
**errp
)
1370 BlockDriverState
*bs
;
1373 bs
= bdrv_find(device
);
1375 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1379 err
= bdrv_set_key(bs
, password
);
1380 if (err
== -EINVAL
) {
1381 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1383 } else if (err
< 0) {
1384 error_set(errp
, QERR_INVALID_PASSWORD
);
1389 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1390 int bdrv_flags
, BlockDriver
*drv
,
1391 const char *password
, Error
**errp
)
1393 Error
*local_err
= NULL
;
1396 ret
= bdrv_open(bs
, filename
, NULL
, bdrv_flags
, drv
, &local_err
);
1398 error_propagate(errp
, local_err
);
1402 if (bdrv_key_required(bs
)) {
1404 if (bdrv_set_key(bs
, password
) < 0) {
1405 error_set(errp
, QERR_INVALID_PASSWORD
);
1408 error_set(errp
, QERR_DEVICE_ENCRYPTED
, bdrv_get_device_name(bs
),
1409 bdrv_get_encrypted_filename(bs
));
1411 } else if (password
) {
1412 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1416 void qmp_change_blockdev(const char *device
, const char *filename
,
1417 bool has_format
, const char *format
, Error
**errp
)
1419 BlockDriverState
*bs
;
1420 BlockDriver
*drv
= NULL
;
1424 bs
= bdrv_find(device
);
1426 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1431 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1433 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1438 eject_device(bs
, 0, &err
);
1439 if (error_is_set(&err
)) {
1440 error_propagate(errp
, err
);
1444 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1445 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1447 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1450 /* throttling disk I/O limits */
1451 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1458 bool has_bps_rd_max
,
1460 bool has_bps_wr_max
,
1464 bool has_iops_rd_max
,
1465 int64_t iops_rd_max
,
1466 bool has_iops_wr_max
,
1467 int64_t iops_wr_max
,
1469 int64_t iops_size
, Error
**errp
)
1472 BlockDriverState
*bs
;
1474 bs
= bdrv_find(device
);
1476 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1480 memset(&cfg
, 0, sizeof(cfg
));
1481 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
1482 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
1483 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
1485 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
1486 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
1487 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
1490 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
1492 if (has_bps_rd_max
) {
1493 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
1495 if (has_bps_wr_max
) {
1496 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
1499 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
1501 if (has_iops_rd_max
) {
1502 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
1504 if (has_iops_wr_max
) {
1505 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
1508 if (has_iops_size
) {
1509 cfg
.op_size
= iops_size
;
1512 if (!check_throttle_config(&cfg
, errp
)) {
1516 if (!bs
->io_limits_enabled
&& throttle_enabled(&cfg
)) {
1517 bdrv_io_limits_enable(bs
);
1518 } else if (bs
->io_limits_enabled
&& !throttle_enabled(&cfg
)) {
1519 bdrv_io_limits_disable(bs
);
1522 if (bs
->io_limits_enabled
) {
1523 bdrv_set_io_limits(bs
, &cfg
);
1527 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
1529 const char *id
= qdict_get_str(qdict
, "id");
1530 BlockDriverState
*bs
;
1534 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
1537 if (bdrv_in_use(bs
)) {
1538 qerror_report(QERR_DEVICE_IN_USE
, id
);
1542 /* quiesce block driver; prevent further io */
1547 /* if we have a device attached to this BlockDriverState
1548 * then we need to make the drive anonymous until the device
1549 * can be removed. If this is a drive with no device backing
1550 * then we can just get rid of the block driver state right here.
1552 if (bdrv_get_attached_dev(bs
)) {
1555 /* Further I/O must not pause the guest */
1556 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
1557 BLOCKDEV_ON_ERROR_REPORT
);
1559 drive_uninit(drive_get_by_blockdev(bs
));
1565 void qmp_block_resize(const char *device
, int64_t size
, Error
**errp
)
1567 BlockDriverState
*bs
;
1570 bs
= bdrv_find(device
);
1572 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1577 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
1581 /* complete all in-flight operations before resizing the device */
1584 ret
= bdrv_truncate(bs
, size
);
1589 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1592 error_set(errp
, QERR_UNSUPPORTED
);
1595 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1598 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1601 error_setg_errno(errp
, -ret
, "Could not resize");
1606 static void block_job_cb(void *opaque
, int ret
)
1608 BlockDriverState
*bs
= opaque
;
1611 trace_block_job_cb(bs
, bs
->job
, ret
);
1614 obj
= qobject_from_block_job(bs
->job
);
1616 QDict
*dict
= qobject_to_qdict(obj
);
1617 qdict_put(dict
, "error", qstring_from_str(strerror(-ret
)));
1620 if (block_job_is_cancelled(bs
->job
)) {
1621 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED
, obj
);
1623 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED
, obj
);
1625 qobject_decref(obj
);
1627 bdrv_put_ref_bh_schedule(bs
);
1630 void qmp_block_stream(const char *device
, bool has_base
,
1631 const char *base
, bool has_speed
, int64_t speed
,
1632 bool has_on_error
, BlockdevOnError on_error
,
1635 BlockDriverState
*bs
;
1636 BlockDriverState
*base_bs
= NULL
;
1637 Error
*local_err
= NULL
;
1639 if (!has_on_error
) {
1640 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1643 bs
= bdrv_find(device
);
1645 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1650 base_bs
= bdrv_find_backing_image(bs
, base
);
1651 if (base_bs
== NULL
) {
1652 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
1657 stream_start(bs
, base_bs
, base
, has_speed
? speed
: 0,
1658 on_error
, block_job_cb
, bs
, &local_err
);
1659 if (error_is_set(&local_err
)) {
1660 error_propagate(errp
, local_err
);
1664 trace_qmp_block_stream(bs
, bs
->job
);
1667 void qmp_block_commit(const char *device
,
1668 bool has_base
, const char *base
, const char *top
,
1669 bool has_speed
, int64_t speed
,
1672 BlockDriverState
*bs
;
1673 BlockDriverState
*base_bs
, *top_bs
;
1674 Error
*local_err
= NULL
;
1675 /* This will be part of the QMP command, if/when the
1676 * BlockdevOnError change for blkmirror makes it in
1678 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1680 /* drain all i/o before commits */
1683 bs
= bdrv_find(device
);
1685 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1689 /* default top_bs is the active layer */
1693 if (strcmp(bs
->filename
, top
) != 0) {
1694 top_bs
= bdrv_find_backing_image(bs
, top
);
1698 if (top_bs
== NULL
) {
1699 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
1703 if (has_base
&& base
) {
1704 base_bs
= bdrv_find_backing_image(top_bs
, base
);
1706 base_bs
= bdrv_find_base(top_bs
);
1709 if (base_bs
== NULL
) {
1710 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
1714 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
1716 if (local_err
!= NULL
) {
1717 error_propagate(errp
, local_err
);
1722 void qmp_drive_backup(const char *device
, const char *target
,
1723 bool has_format
, const char *format
,
1724 enum MirrorSyncMode sync
,
1725 bool has_mode
, enum NewImageMode mode
,
1726 bool has_speed
, int64_t speed
,
1727 bool has_on_source_error
, BlockdevOnError on_source_error
,
1728 bool has_on_target_error
, BlockdevOnError on_target_error
,
1731 BlockDriverState
*bs
;
1732 BlockDriverState
*target_bs
;
1733 BlockDriverState
*source
= NULL
;
1734 BlockDriver
*drv
= NULL
;
1735 Error
*local_err
= NULL
;
1743 if (!has_on_source_error
) {
1744 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1746 if (!has_on_target_error
) {
1747 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1750 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1753 bs
= bdrv_find(device
);
1755 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1759 if (!bdrv_is_inserted(bs
)) {
1760 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1765 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1768 drv
= bdrv_find_format(format
);
1770 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1775 if (bdrv_in_use(bs
)) {
1776 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1780 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1782 /* See if we have a backing HD we can use to create our new image
1784 if (sync
== MIRROR_SYNC_MODE_TOP
) {
1785 source
= bs
->backing_hd
;
1787 sync
= MIRROR_SYNC_MODE_FULL
;
1790 if (sync
== MIRROR_SYNC_MODE_NONE
) {
1794 size
= bdrv_getlength(bs
);
1796 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1800 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1801 assert(format
&& drv
);
1803 bdrv_img_create(target
, format
, source
->filename
,
1804 source
->drv
->format_name
, NULL
,
1805 size
, flags
, &local_err
, false);
1807 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
1808 size
, flags
, &local_err
, false);
1812 if (error_is_set(&local_err
)) {
1813 error_propagate(errp
, local_err
);
1817 target_bs
= bdrv_new("");
1818 ret
= bdrv_open(target_bs
, target
, NULL
, flags
, drv
, &local_err
);
1820 bdrv_unref(target_bs
);
1821 error_propagate(errp
, local_err
);
1825 backup_start(bs
, target_bs
, speed
, sync
, on_source_error
, on_target_error
,
1826 block_job_cb
, bs
, &local_err
);
1827 if (local_err
!= NULL
) {
1828 bdrv_unref(target_bs
);
1829 error_propagate(errp
, local_err
);
1834 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1836 void qmp_drive_mirror(const char *device
, const char *target
,
1837 bool has_format
, const char *format
,
1838 enum MirrorSyncMode sync
,
1839 bool has_mode
, enum NewImageMode mode
,
1840 bool has_speed
, int64_t speed
,
1841 bool has_granularity
, uint32_t granularity
,
1842 bool has_buf_size
, int64_t buf_size
,
1843 bool has_on_source_error
, BlockdevOnError on_source_error
,
1844 bool has_on_target_error
, BlockdevOnError on_target_error
,
1847 BlockDriverState
*bs
;
1848 BlockDriverState
*source
, *target_bs
;
1849 BlockDriver
*drv
= NULL
;
1850 Error
*local_err
= NULL
;
1858 if (!has_on_source_error
) {
1859 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1861 if (!has_on_target_error
) {
1862 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1865 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1867 if (!has_granularity
) {
1870 if (!has_buf_size
) {
1871 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1874 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
1875 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1878 if (granularity
& (granularity
- 1)) {
1879 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1883 bs
= bdrv_find(device
);
1885 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1889 if (!bdrv_is_inserted(bs
)) {
1890 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1895 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1898 drv
= bdrv_find_format(format
);
1900 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1905 if (bdrv_in_use(bs
)) {
1906 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1910 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1911 source
= bs
->backing_hd
;
1912 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
1913 sync
= MIRROR_SYNC_MODE_FULL
;
1916 size
= bdrv_getlength(bs
);
1918 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1922 if (sync
== MIRROR_SYNC_MODE_FULL
&& mode
!= NEW_IMAGE_MODE_EXISTING
) {
1923 /* create new image w/o backing file */
1924 assert(format
&& drv
);
1925 bdrv_img_create(target
, format
,
1926 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
1929 case NEW_IMAGE_MODE_EXISTING
:
1931 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
1932 /* create new image with backing file */
1933 bdrv_img_create(target
, format
,
1935 source
->drv
->format_name
,
1936 NULL
, size
, flags
, &local_err
, false);
1943 if (error_is_set(&local_err
)) {
1944 error_propagate(errp
, local_err
);
1948 /* Mirroring takes care of copy-on-write using the source's backing
1951 target_bs
= bdrv_new("");
1952 ret
= bdrv_open(target_bs
, target
, NULL
, flags
| BDRV_O_NO_BACKING
, drv
,
1955 bdrv_unref(target_bs
);
1956 error_propagate(errp
, local_err
);
1960 mirror_start(bs
, target_bs
, speed
, granularity
, buf_size
, sync
,
1961 on_source_error
, on_target_error
,
1962 block_job_cb
, bs
, &local_err
);
1963 if (local_err
!= NULL
) {
1964 bdrv_unref(target_bs
);
1965 error_propagate(errp
, local_err
);
1970 static BlockJob
*find_block_job(const char *device
)
1972 BlockDriverState
*bs
;
1974 bs
= bdrv_find(device
);
1975 if (!bs
|| !bs
->job
) {
1981 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
1983 BlockJob
*job
= find_block_job(device
);
1986 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1990 block_job_set_speed(job
, speed
, errp
);
1993 void qmp_block_job_cancel(const char *device
,
1994 bool has_force
, bool force
, Error
**errp
)
1996 BlockJob
*job
= find_block_job(device
);
2003 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2006 if (job
->paused
&& !force
) {
2007 error_set(errp
, QERR_BLOCK_JOB_PAUSED
, device
);
2011 trace_qmp_block_job_cancel(job
);
2012 block_job_cancel(job
);
2015 void qmp_block_job_pause(const char *device
, Error
**errp
)
2017 BlockJob
*job
= find_block_job(device
);
2020 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2024 trace_qmp_block_job_pause(job
);
2025 block_job_pause(job
);
2028 void qmp_block_job_resume(const char *device
, Error
**errp
)
2030 BlockJob
*job
= find_block_job(device
);
2033 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2037 trace_qmp_block_job_resume(job
);
2038 block_job_resume(job
);
2041 void qmp_block_job_complete(const char *device
, Error
**errp
)
2043 BlockJob
*job
= find_block_job(device
);
2046 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2050 trace_qmp_block_job_complete(job
);
2051 block_job_complete(job
, errp
);
2054 static void do_qmp_query_block_jobs_one(void *opaque
, BlockDriverState
*bs
)
2056 BlockJobInfoList
**prev
= opaque
;
2057 BlockJob
*job
= bs
->job
;
2060 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
2061 elem
->value
= block_job_query(bs
->job
);
2062 (*prev
)->next
= elem
;
2067 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
2069 /* Dummy is a fake list element for holding the head pointer */
2070 BlockJobInfoList dummy
= {};
2071 BlockJobInfoList
*prev
= &dummy
;
2072 bdrv_iterate(do_qmp_query_block_jobs_one
, &prev
);
2076 QemuOptsList qemu_common_drive_opts
= {
2078 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
2082 .type
= QEMU_OPT_NUMBER
,
2083 .help
= "bus number",
2086 .type
= QEMU_OPT_NUMBER
,
2087 .help
= "unit number (i.e. lun for scsi)",
2090 .type
= QEMU_OPT_STRING
,
2091 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2094 .type
= QEMU_OPT_NUMBER
,
2095 .help
= "index number",
2098 .type
= QEMU_OPT_NUMBER
,
2099 .help
= "number of cylinders (ide disk geometry)",
2102 .type
= QEMU_OPT_NUMBER
,
2103 .help
= "number of heads (ide disk geometry)",
2106 .type
= QEMU_OPT_NUMBER
,
2107 .help
= "number of sectors (ide disk geometry)",
2110 .type
= QEMU_OPT_STRING
,
2111 .help
= "chs translation (auto, lba. none)",
2114 .type
= QEMU_OPT_STRING
,
2115 .help
= "media type (disk, cdrom)",
2118 .type
= QEMU_OPT_BOOL
,
2119 .help
= "enable/disable snapshot mode",
2122 .type
= QEMU_OPT_STRING
,
2123 .help
= "disk image",
2126 .type
= QEMU_OPT_STRING
,
2127 .help
= "discard operation (ignore/off, unmap/on)",
2129 .name
= "cache.writeback",
2130 .type
= QEMU_OPT_BOOL
,
2131 .help
= "enables writeback mode for any caches",
2133 .name
= "cache.direct",
2134 .type
= QEMU_OPT_BOOL
,
2135 .help
= "enables use of O_DIRECT (bypass the host page cache)",
2137 .name
= "cache.no-flush",
2138 .type
= QEMU_OPT_BOOL
,
2139 .help
= "ignore any flush requests for the device",
2142 .type
= QEMU_OPT_STRING
,
2143 .help
= "host AIO implementation (threads, native)",
2146 .type
= QEMU_OPT_STRING
,
2147 .help
= "disk format (raw, qcow2, ...)",
2150 .type
= QEMU_OPT_STRING
,
2151 .help
= "disk serial number",
2154 .type
= QEMU_OPT_STRING
,
2155 .help
= "read error action",
2158 .type
= QEMU_OPT_STRING
,
2159 .help
= "write error action",
2162 .type
= QEMU_OPT_STRING
,
2163 .help
= "pci address (virtio only)",
2165 .name
= "read-only",
2166 .type
= QEMU_OPT_BOOL
,
2167 .help
= "open drive file as read-only",
2169 .name
= "throttling.iops-total",
2170 .type
= QEMU_OPT_NUMBER
,
2171 .help
= "limit total I/O operations per second",
2173 .name
= "throttling.iops-read",
2174 .type
= QEMU_OPT_NUMBER
,
2175 .help
= "limit read operations per second",
2177 .name
= "throttling.iops-write",
2178 .type
= QEMU_OPT_NUMBER
,
2179 .help
= "limit write operations per second",
2181 .name
= "throttling.bps-total",
2182 .type
= QEMU_OPT_NUMBER
,
2183 .help
= "limit total bytes per second",
2185 .name
= "throttling.bps-read",
2186 .type
= QEMU_OPT_NUMBER
,
2187 .help
= "limit read bytes per second",
2189 .name
= "throttling.bps-write",
2190 .type
= QEMU_OPT_NUMBER
,
2191 .help
= "limit write bytes per second",
2193 .name
= "throttling.iops-total-max",
2194 .type
= QEMU_OPT_NUMBER
,
2195 .help
= "I/O operations burst",
2197 .name
= "throttling.iops-read-max",
2198 .type
= QEMU_OPT_NUMBER
,
2199 .help
= "I/O operations read burst",
2201 .name
= "throttling.iops-write-max",
2202 .type
= QEMU_OPT_NUMBER
,
2203 .help
= "I/O operations write burst",
2205 .name
= "throttling.bps-total-max",
2206 .type
= QEMU_OPT_NUMBER
,
2207 .help
= "total bytes burst",
2209 .name
= "throttling.bps-read-max",
2210 .type
= QEMU_OPT_NUMBER
,
2211 .help
= "total bytes read burst",
2213 .name
= "throttling.bps-write-max",
2214 .type
= QEMU_OPT_NUMBER
,
2215 .help
= "total bytes write burst",
2217 .name
= "throttling.iops-size",
2218 .type
= QEMU_OPT_NUMBER
,
2219 .help
= "when limiting by iops max size of an I/O in bytes",
2221 .name
= "copy-on-read",
2222 .type
= QEMU_OPT_BOOL
,
2223 .help
= "copy read data from backing file into image file",
2226 .type
= QEMU_OPT_BOOL
,
2227 .help
= "(deprecated, ignored)",
2229 { /* end of list */ }
2233 QemuOptsList qemu_drive_opts
= {
2235 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
2238 * no elements => accept any params
2239 * validation will happen later
2241 { /* end of list */ }