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
);
92 if (dinfo
&& !dinfo
->enable_auto_del
) {
97 block_job_cancel(bs
->job
);
104 void blockdev_auto_del(BlockDriverState
*bs
)
106 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
108 if (dinfo
&& dinfo
->auto_del
) {
109 drive_put_ref(dinfo
);
113 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
115 int max_devs
= if_max_devs
[type
];
116 return max_devs
? index
/ max_devs
: 0;
119 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
121 int max_devs
= if_max_devs
[type
];
122 return max_devs
? index
% max_devs
: index
;
125 QemuOpts
*drive_def(const char *optstr
)
127 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
130 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
136 opts
= drive_def(optstr
);
140 if (type
!= IF_DEFAULT
) {
141 qemu_opt_set(opts
, "if", if_name
[type
]);
144 snprintf(buf
, sizeof(buf
), "%d", index
);
145 qemu_opt_set(opts
, "index", buf
);
148 qemu_opt_set(opts
, "file", file
);
152 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
156 /* seek interface, bus and unit */
158 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
159 if (dinfo
->type
== type
&&
168 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
170 return drive_get(type
,
171 drive_index_to_bus_id(type
, index
),
172 drive_index_to_unit_id(type
, index
));
175 int drive_get_max_bus(BlockInterfaceType type
)
181 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
182 if(dinfo
->type
== type
&&
183 dinfo
->bus
> max_bus
)
184 max_bus
= dinfo
->bus
;
189 /* Get a block device. This should only be used for single-drive devices
190 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
192 DriveInfo
*drive_get_next(BlockInterfaceType type
)
194 static int next_block_unit
[IF_COUNT
];
196 return drive_get(type
, 0, next_block_unit
[type
]++);
199 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
203 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
204 if (dinfo
->bdrv
== bs
) {
211 static void bdrv_format_print(void *opaque
, const char *name
)
213 error_printf(" %s", name
);
216 static void drive_uninit(DriveInfo
*dinfo
)
218 qemu_opts_del(dinfo
->opts
);
219 bdrv_unref(dinfo
->bdrv
);
221 QTAILQ_REMOVE(&drives
, dinfo
, next
);
222 g_free(dinfo
->serial
);
226 void drive_put_ref(DriveInfo
*dinfo
)
228 assert(dinfo
->refcount
);
229 if (--dinfo
->refcount
== 0) {
234 void drive_get_ref(DriveInfo
*dinfo
)
241 BlockDriverState
*bs
;
244 static void bdrv_put_ref_bh(void *opaque
)
246 BDRVPutRefBH
*s
= opaque
;
249 qemu_bh_delete(s
->bh
);
254 * Release a BDS reference in a BH
256 * It is not safe to use bdrv_unref() from a callback function when the callers
257 * still need the BlockDriverState. In such cases we schedule a BH to release
260 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
264 s
= g_new(BDRVPutRefBH
, 1);
265 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
267 qemu_bh_schedule(s
->bh
);
270 static int parse_block_error_action(const char *buf
, bool is_read
)
272 if (!strcmp(buf
, "ignore")) {
273 return BLOCKDEV_ON_ERROR_IGNORE
;
274 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
275 return BLOCKDEV_ON_ERROR_ENOSPC
;
276 } else if (!strcmp(buf
, "stop")) {
277 return BLOCKDEV_ON_ERROR_STOP
;
278 } else if (!strcmp(buf
, "report")) {
279 return BLOCKDEV_ON_ERROR_REPORT
;
281 error_report("'%s' invalid %s error action",
282 buf
, is_read
? "read" : "write");
287 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
289 if (throttle_conflicting(cfg
)) {
290 error_setg(errp
, "bps/iops/max total values and read/write values"
291 " cannot be used at the same time");
295 if (!throttle_is_valid(cfg
)) {
296 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
303 static DriveInfo
*blockdev_init(QemuOpts
*all_opts
,
304 BlockInterfaceType block_default_type
)
307 const char *file
= NULL
;
309 const char *mediastr
= "";
310 BlockInterfaceType type
;
311 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
313 int cyls
, heads
, secs
, translation
;
318 int on_read_error
, on_write_error
;
329 bool has_driver_specific_opts
;
330 BlockDriver
*drv
= NULL
;
332 translation
= BIOS_ATA_TRANSLATION_AUTO
;
335 /* Check common options by copying from all_opts to opts, all other options
336 * are stored in bs_opts. */
337 id
= qemu_opts_id(all_opts
);
338 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
339 if (error_is_set(&error
)) {
340 qerror_report_err(error
);
345 bs_opts
= qdict_new();
346 qemu_opts_to_qdict(all_opts
, bs_opts
);
347 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
348 if (error_is_set(&error
)) {
349 qerror_report_err(error
);
355 qdict_del(bs_opts
, "id");
358 has_driver_specific_opts
= !!qdict_size(bs_opts
);
360 /* extract parameters */
361 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
362 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
363 index
= qemu_opt_get_number(opts
, "index", -1);
365 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
366 heads
= qemu_opt_get_number(opts
, "heads", 0);
367 secs
= qemu_opt_get_number(opts
, "secs", 0);
369 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
370 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
371 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
373 file
= qemu_opt_get(opts
, "file");
374 serial
= qemu_opt_get(opts
, "serial");
376 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
377 for (type
= 0; type
< IF_COUNT
&& strcmp(buf
, if_name
[type
]); type
++)
379 if (type
== IF_COUNT
) {
380 error_report("unsupported bus type '%s'", buf
);
384 type
= block_default_type
;
387 max_devs
= if_max_devs
[type
];
389 if (cyls
|| heads
|| secs
) {
391 error_report("invalid physical cyls number");
395 error_report("invalid physical heads number");
399 error_report("invalid physical secs number");
404 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
406 error_report("'%s' trans must be used with cyls, heads and secs",
410 if (!strcmp(buf
, "none"))
411 translation
= BIOS_ATA_TRANSLATION_NONE
;
412 else if (!strcmp(buf
, "lba"))
413 translation
= BIOS_ATA_TRANSLATION_LBA
;
414 else if (!strcmp(buf
, "auto"))
415 translation
= BIOS_ATA_TRANSLATION_AUTO
;
417 error_report("'%s' invalid translation type", buf
);
422 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
423 if (!strcmp(buf
, "disk")) {
425 } else if (!strcmp(buf
, "cdrom")) {
426 if (cyls
|| secs
|| heads
) {
427 error_report("CHS can't be set with media=%s", buf
);
432 error_report("'%s' invalid media", buf
);
437 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
438 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
439 error_report("invalid discard option");
444 if (qemu_opt_get_bool(opts
, "cache.writeback", true)) {
445 bdrv_flags
|= BDRV_O_CACHE_WB
;
447 if (qemu_opt_get_bool(opts
, "cache.direct", false)) {
448 bdrv_flags
|= BDRV_O_NOCACHE
;
450 if (qemu_opt_get_bool(opts
, "cache.no-flush", false)) {
451 bdrv_flags
|= BDRV_O_NO_FLUSH
;
454 #ifdef CONFIG_LINUX_AIO
455 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
456 if (!strcmp(buf
, "native")) {
457 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
458 } else if (!strcmp(buf
, "threads")) {
459 /* this is the default */
461 error_report("invalid aio option");
467 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
468 if (is_help_option(buf
)) {
469 error_printf("Supported formats:");
470 bdrv_iterate_format(bdrv_format_print
, NULL
);
475 drv
= bdrv_find_format(buf
);
477 error_report("'%s' invalid format", buf
);
482 /* disk I/O throttling */
483 memset(&cfg
, 0, sizeof(cfg
));
484 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
485 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
486 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
487 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
488 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
489 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
490 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
491 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
492 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
493 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
494 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
495 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
497 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
498 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
499 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
500 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
501 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
502 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
503 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
504 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
505 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
506 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
507 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
508 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
510 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
512 if (!check_throttle_config(&cfg
, &error
)) {
513 error_report("%s", error_get_pretty(error
));
518 if (qemu_opt_get(opts
, "boot") != NULL
) {
519 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
520 "ignored. Future versions will reject this parameter. Please "
521 "update your scripts.\n");
524 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
525 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
526 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
527 error_report("werror is not supported by this bus type");
531 on_write_error
= parse_block_error_action(buf
, 0);
532 if (on_write_error
< 0) {
537 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
538 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
539 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
540 error_report("rerror is not supported by this bus type");
544 on_read_error
= parse_block_error_action(buf
, 1);
545 if (on_read_error
< 0) {
550 if ((devaddr
= qemu_opt_get(opts
, "addr")) != NULL
) {
551 if (type
!= IF_VIRTIO
) {
552 error_report("addr is not supported by this bus type");
557 /* compute bus and unit according index */
560 if (bus_id
!= 0 || unit_id
!= -1) {
561 error_report("index cannot be used with bus and unit");
564 bus_id
= drive_index_to_bus_id(type
, index
);
565 unit_id
= drive_index_to_unit_id(type
, index
);
568 /* if user doesn't specify a unit_id,
569 * try to find the first free
574 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
576 if (max_devs
&& unit_id
>= max_devs
) {
585 if (max_devs
&& unit_id
>= max_devs
) {
586 error_report("unit %d too big (max is %d)",
587 unit_id
, max_devs
- 1);
592 * catch multiple definitions
595 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
596 error_report("drive with bus=%d, unit=%d (index=%d) exists",
597 bus_id
, unit_id
, index
);
603 dinfo
= g_malloc0(sizeof(*dinfo
));
604 if ((buf
= qemu_opts_id(opts
)) != NULL
) {
605 dinfo
->id
= g_strdup(buf
);
607 /* no id supplied -> create one */
608 dinfo
->id
= g_malloc0(32);
609 if (type
== IF_IDE
|| type
== IF_SCSI
)
610 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
612 snprintf(dinfo
->id
, 32, "%s%i%s%i",
613 if_name
[type
], bus_id
, mediastr
, unit_id
);
615 snprintf(dinfo
->id
, 32, "%s%s%i",
616 if_name
[type
], mediastr
, unit_id
);
618 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
619 dinfo
->bdrv
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
620 dinfo
->bdrv
->read_only
= ro
;
621 dinfo
->devaddr
= devaddr
;
624 dinfo
->unit
= unit_id
;
626 dinfo
->heads
= heads
;
628 dinfo
->trans
= translation
;
629 dinfo
->opts
= all_opts
;
631 if (serial
!= NULL
) {
632 dinfo
->serial
= g_strdup(serial
);
634 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
636 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
638 /* disk I/O throttling */
639 if (throttle_enabled(&cfg
)) {
640 bdrv_io_limits_enable(dinfo
->bdrv
);
641 bdrv_set_io_limits(dinfo
->bdrv
, &cfg
);
649 dinfo
->media_cd
= media
== MEDIA_CDROM
;
658 /* add virtio block device */
660 devopts
= qemu_opts_create_nofail(qemu_find_opts("device"));
661 if (arch_type
== QEMU_ARCH_S390X
) {
662 qemu_opt_set(devopts
, "driver", "virtio-blk-s390");
664 qemu_opt_set(devopts
, "driver", "virtio-blk-pci");
666 qemu_opt_set(devopts
, "drive", dinfo
->id
);
668 qemu_opt_set(devopts
, "addr", devaddr
);
674 if (!file
|| !*file
) {
675 if (has_driver_specific_opts
) {
682 /* always use cache=unsafe with snapshot */
683 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
684 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
688 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
691 if (runstate_check(RUN_STATE_INMIGRATE
)) {
692 bdrv_flags
|= BDRV_O_INCOMING
;
695 if (media
== MEDIA_CDROM
) {
696 /* CDROM is fine for any interface, don't check. */
698 } else if (ro
== 1) {
699 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&&
700 type
!= IF_NONE
&& type
!= IF_PFLASH
) {
701 error_report("read-only not supported by this bus type");
706 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
708 if (ro
&& copy_on_read
) {
709 error_report("warning: disabling copy_on_read on read-only drive");
713 ret
= bdrv_open(dinfo
->bdrv
, file
, bs_opts
, bdrv_flags
, drv
, &error
);
716 error_report("could not open disk image %s: %s",
717 file
?: dinfo
->id
, error_get_pretty(error
));
721 if (bdrv_key_required(dinfo
->bdrv
))
732 bdrv_unref(dinfo
->bdrv
);
734 QTAILQ_REMOVE(&drives
, dinfo
, next
);
739 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
)
743 value
= qemu_opt_get(opts
, from
);
745 qemu_opt_set(opts
, to
, value
);
746 qemu_opt_unset(opts
, from
);
750 DriveInfo
*drive_init(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
755 /* Change legacy command line options into QMP ones */
756 qemu_opt_rename(all_opts
, "iops", "throttling.iops-total");
757 qemu_opt_rename(all_opts
, "iops_rd", "throttling.iops-read");
758 qemu_opt_rename(all_opts
, "iops_wr", "throttling.iops-write");
760 qemu_opt_rename(all_opts
, "bps", "throttling.bps-total");
761 qemu_opt_rename(all_opts
, "bps_rd", "throttling.bps-read");
762 qemu_opt_rename(all_opts
, "bps_wr", "throttling.bps-write");
764 qemu_opt_rename(all_opts
, "iops_max", "throttling.iops-total-max");
765 qemu_opt_rename(all_opts
, "iops_rd_max", "throttling.iops-read-max");
766 qemu_opt_rename(all_opts
, "iops_wr_max", "throttling.iops-write-max");
768 qemu_opt_rename(all_opts
, "bps_max", "throttling.bps-total-max");
769 qemu_opt_rename(all_opts
, "bps_rd_max", "throttling.bps-read-max");
770 qemu_opt_rename(all_opts
, "bps_wr_max", "throttling.bps-write-max");
772 qemu_opt_rename(all_opts
,
773 "iops_size", "throttling.iops-size");
775 qemu_opt_rename(all_opts
, "readonly", "read-only");
777 value
= qemu_opt_get(all_opts
, "cache");
781 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
782 error_report("invalid cache option");
786 /* Specific options take precedence */
787 if (!qemu_opt_get(all_opts
, "cache.writeback")) {
788 qemu_opt_set_bool(all_opts
, "cache.writeback",
789 !!(flags
& BDRV_O_CACHE_WB
));
791 if (!qemu_opt_get(all_opts
, "cache.direct")) {
792 qemu_opt_set_bool(all_opts
, "cache.direct",
793 !!(flags
& BDRV_O_NOCACHE
));
795 if (!qemu_opt_get(all_opts
, "cache.no-flush")) {
796 qemu_opt_set_bool(all_opts
, "cache.no-flush",
797 !!(flags
& BDRV_O_NO_FLUSH
));
799 qemu_opt_unset(all_opts
, "cache");
802 /* Actual block device init: Functionality shared with blockdev-add */
803 dinfo
= blockdev_init(all_opts
, block_default_type
);
808 /* Set legacy DriveInfo fields */
809 dinfo
->enable_auto_del
= true;
815 void do_commit(Monitor
*mon
, const QDict
*qdict
)
817 const char *device
= qdict_get_str(qdict
, "device");
818 BlockDriverState
*bs
;
821 if (!strcmp(device
, "all")) {
822 ret
= bdrv_commit_all();
824 bs
= bdrv_find(device
);
826 monitor_printf(mon
, "Device '%s' not found\n", device
);
829 ret
= bdrv_commit(bs
);
832 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
837 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
839 TransactionAction action
;
840 TransactionActionList list
;
844 list
.value
= &action
;
846 qmp_transaction(&list
, errp
);
849 void qmp_blockdev_snapshot_sync(const char *device
, const char *snapshot_file
,
850 bool has_format
, const char *format
,
851 bool has_mode
, enum NewImageMode mode
,
854 BlockdevSnapshot snapshot
= {
855 .device
= (char *) device
,
856 .snapshot_file
= (char *) snapshot_file
,
857 .has_format
= has_format
,
858 .format
= (char *) format
,
859 .has_mode
= has_mode
,
862 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
866 void qmp_blockdev_snapshot_internal_sync(const char *device
,
870 BlockdevSnapshotInternal snapshot
= {
871 .device
= (char *) device
,
872 .name
= (char *) name
875 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
879 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
886 BlockDriverState
*bs
= bdrv_find(device
);
888 Error
*local_err
= NULL
;
889 SnapshotInfo
*info
= NULL
;
893 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
906 error_setg(errp
, "Name or id must be provided");
910 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
911 if (error_is_set(&local_err
)) {
912 error_propagate(errp
, local_err
);
917 "Snapshot with id '%s' and name '%s' does not exist on "
919 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
923 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
924 if (error_is_set(&local_err
)) {
925 error_propagate(errp
, local_err
);
929 info
= g_malloc0(sizeof(SnapshotInfo
));
930 info
->id
= g_strdup(sn
.id_str
);
931 info
->name
= g_strdup(sn
.name
);
932 info
->date_nsec
= sn
.date_nsec
;
933 info
->date_sec
= sn
.date_sec
;
934 info
->vm_state_size
= sn
.vm_state_size
;
935 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
936 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
941 /* New and old BlockDriverState structs for group snapshots */
943 typedef struct BlkTransactionState BlkTransactionState
;
945 /* Only prepare() may fail. In a single transaction, only one of commit() or
946 abort() will be called, clean() will always be called if it present. */
947 typedef struct BdrvActionOps
{
948 /* Size of state struct, in bytes. */
949 size_t instance_size
;
950 /* Prepare the work, must NOT be NULL. */
951 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
952 /* Commit the changes, can be NULL. */
953 void (*commit
)(BlkTransactionState
*common
);
954 /* Abort the changes on fail, can be NULL. */
955 void (*abort
)(BlkTransactionState
*common
);
956 /* Clean up resource in the end, can be NULL. */
957 void (*clean
)(BlkTransactionState
*common
);
961 * This structure must be arranged as first member in child type, assuming
962 * that compiler will also arrange it to the same address with parent instance.
963 * Later it will be used in free().
965 struct BlkTransactionState
{
966 TransactionAction
*action
;
967 const BdrvActionOps
*ops
;
968 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
971 /* internal snapshot private data */
972 typedef struct InternalSnapshotState
{
973 BlkTransactionState common
;
974 BlockDriverState
*bs
;
976 } InternalSnapshotState
;
978 static void internal_snapshot_prepare(BlkTransactionState
*common
,
983 BlockDriverState
*bs
;
984 QEMUSnapshotInfo old_sn
, *sn
;
987 BlockdevSnapshotInternal
*internal
;
988 InternalSnapshotState
*state
;
991 g_assert(common
->action
->kind
==
992 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
993 internal
= common
->action
->blockdev_snapshot_internal_sync
;
994 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
997 device
= internal
->device
;
998 name
= internal
->name
;
1000 /* 2. check for validation */
1001 bs
= bdrv_find(device
);
1003 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1007 if (!bdrv_is_inserted(bs
)) {
1008 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1012 if (bdrv_is_read_only(bs
)) {
1013 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1017 if (!bdrv_can_snapshot(bs
)) {
1018 error_set(errp
, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
1019 bs
->drv
->format_name
, device
, "internal snapshot");
1023 if (!strlen(name
)) {
1024 error_setg(errp
, "Name is empty");
1028 /* check whether a snapshot with name exist */
1029 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
, errp
);
1030 if (error_is_set(errp
)) {
1034 "Snapshot with name '%s' already exists on device '%s'",
1039 /* 3. take the snapshot */
1041 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1042 qemu_gettimeofday(&tv
);
1043 sn
->date_sec
= tv
.tv_sec
;
1044 sn
->date_nsec
= tv
.tv_usec
* 1000;
1045 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1047 ret1
= bdrv_snapshot_create(bs
, sn
);
1049 error_setg_errno(errp
, -ret1
,
1050 "Failed to create snapshot '%s' on device '%s'",
1055 /* 4. succeed, mark a snapshot is created */
1059 static void internal_snapshot_abort(BlkTransactionState
*common
)
1061 InternalSnapshotState
*state
=
1062 DO_UPCAST(InternalSnapshotState
, common
, common
);
1063 BlockDriverState
*bs
= state
->bs
;
1064 QEMUSnapshotInfo
*sn
= &state
->sn
;
1065 Error
*local_error
= NULL
;
1071 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1072 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1073 "device '%s' in abort: %s",
1076 bdrv_get_device_name(bs
),
1077 error_get_pretty(local_error
));
1078 error_free(local_error
);
1082 /* external snapshot private data */
1083 typedef struct ExternalSnapshotState
{
1084 BlkTransactionState common
;
1085 BlockDriverState
*old_bs
;
1086 BlockDriverState
*new_bs
;
1087 } ExternalSnapshotState
;
1089 static void external_snapshot_prepare(BlkTransactionState
*common
,
1094 Error
*local_err
= NULL
;
1096 const char *new_image_file
;
1097 const char *format
= "qcow2";
1098 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1099 ExternalSnapshotState
*state
=
1100 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1101 TransactionAction
*action
= common
->action
;
1103 /* get parameters */
1104 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1106 device
= action
->blockdev_snapshot_sync
->device
;
1107 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1108 if (action
->blockdev_snapshot_sync
->has_format
) {
1109 format
= action
->blockdev_snapshot_sync
->format
;
1111 if (action
->blockdev_snapshot_sync
->has_mode
) {
1112 mode
= action
->blockdev_snapshot_sync
->mode
;
1115 /* start processing */
1116 drv
= bdrv_find_format(format
);
1118 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1122 state
->old_bs
= bdrv_find(device
);
1123 if (!state
->old_bs
) {
1124 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1128 if (!bdrv_is_inserted(state
->old_bs
)) {
1129 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1133 if (bdrv_in_use(state
->old_bs
)) {
1134 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1138 if (!bdrv_is_read_only(state
->old_bs
)) {
1139 if (bdrv_flush(state
->old_bs
)) {
1140 error_set(errp
, QERR_IO_ERROR
);
1145 if (bdrv_check_ext_snapshot(state
->old_bs
) != EXT_SNAPSHOT_ALLOWED
) {
1146 error_set(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1150 flags
= state
->old_bs
->open_flags
;
1152 /* create new image w/backing file */
1153 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1154 bdrv_img_create(new_image_file
, format
,
1155 state
->old_bs
->filename
,
1156 state
->old_bs
->drv
->format_name
,
1157 NULL
, -1, flags
, &local_err
, false);
1158 if (error_is_set(&local_err
)) {
1159 error_propagate(errp
, local_err
);
1164 /* We will manually add the backing_hd field to the bs later */
1165 state
->new_bs
= bdrv_new("");
1166 /* TODO Inherit bs->options or only take explicit options with an
1167 * extended QMP command? */
1168 ret
= bdrv_open(state
->new_bs
, new_image_file
, NULL
,
1169 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
1171 error_propagate(errp
, local_err
);
1175 static void external_snapshot_commit(BlkTransactionState
*common
)
1177 ExternalSnapshotState
*state
=
1178 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1180 /* This removes our old bs and adds the new bs */
1181 bdrv_append(state
->new_bs
, state
->old_bs
);
1182 /* We don't need (or want) to use the transactional
1183 * bdrv_reopen_multiple() across all the entries at once, because we
1184 * don't want to abort all of them if one of them fails the reopen */
1185 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
1189 static void external_snapshot_abort(BlkTransactionState
*common
)
1191 ExternalSnapshotState
*state
=
1192 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1193 if (state
->new_bs
) {
1194 bdrv_unref(state
->new_bs
);
1198 typedef struct DriveBackupState
{
1199 BlkTransactionState common
;
1200 BlockDriverState
*bs
;
1204 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1206 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1207 DriveBackup
*backup
;
1208 Error
*local_err
= NULL
;
1210 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1211 backup
= common
->action
->drive_backup
;
1213 qmp_drive_backup(backup
->device
, backup
->target
,
1214 backup
->has_format
, backup
->format
,
1216 backup
->has_mode
, backup
->mode
,
1217 backup
->has_speed
, backup
->speed
,
1218 backup
->has_on_source_error
, backup
->on_source_error
,
1219 backup
->has_on_target_error
, backup
->on_target_error
,
1221 if (error_is_set(&local_err
)) {
1222 error_propagate(errp
, local_err
);
1228 state
->bs
= bdrv_find(backup
->device
);
1229 state
->job
= state
->bs
->job
;
1232 static void drive_backup_abort(BlkTransactionState
*common
)
1234 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1235 BlockDriverState
*bs
= state
->bs
;
1237 /* Only cancel if it's the job we started */
1238 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1239 block_job_cancel_sync(bs
->job
);
1243 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1245 error_setg(errp
, "Transaction aborted using Abort action");
1248 static void abort_commit(BlkTransactionState
*common
)
1250 g_assert_not_reached(); /* this action never succeeds */
1253 static const BdrvActionOps actions
[] = {
1254 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1255 .instance_size
= sizeof(ExternalSnapshotState
),
1256 .prepare
= external_snapshot_prepare
,
1257 .commit
= external_snapshot_commit
,
1258 .abort
= external_snapshot_abort
,
1260 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1261 .instance_size
= sizeof(DriveBackupState
),
1262 .prepare
= drive_backup_prepare
,
1263 .abort
= drive_backup_abort
,
1265 [TRANSACTION_ACTION_KIND_ABORT
] = {
1266 .instance_size
= sizeof(BlkTransactionState
),
1267 .prepare
= abort_prepare
,
1268 .commit
= abort_commit
,
1270 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1271 .instance_size
= sizeof(InternalSnapshotState
),
1272 .prepare
= internal_snapshot_prepare
,
1273 .abort
= internal_snapshot_abort
,
1278 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1279 * then we do not pivot any of the devices in the group, and abandon the
1282 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1284 TransactionActionList
*dev_entry
= dev_list
;
1285 BlkTransactionState
*state
, *next
;
1286 Error
*local_err
= NULL
;
1288 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1289 QSIMPLEQ_INIT(&snap_bdrv_states
);
1291 /* drain all i/o before any snapshots */
1294 /* We don't do anything in this loop that commits us to the snapshot */
1295 while (NULL
!= dev_entry
) {
1296 TransactionAction
*dev_info
= NULL
;
1297 const BdrvActionOps
*ops
;
1299 dev_info
= dev_entry
->value
;
1300 dev_entry
= dev_entry
->next
;
1302 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1304 ops
= &actions
[dev_info
->kind
];
1305 assert(ops
->instance_size
> 0);
1307 state
= g_malloc0(ops
->instance_size
);
1309 state
->action
= dev_info
;
1310 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1312 state
->ops
->prepare(state
, &local_err
);
1313 if (error_is_set(&local_err
)) {
1314 error_propagate(errp
, local_err
);
1315 goto delete_and_fail
;
1319 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1320 if (state
->ops
->commit
) {
1321 state
->ops
->commit(state
);
1330 * failure, and it is all-or-none; abandon each new bs, and keep using
1331 * the original bs for all images
1333 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1334 if (state
->ops
->abort
) {
1335 state
->ops
->abort(state
);
1339 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1340 if (state
->ops
->clean
) {
1341 state
->ops
->clean(state
);
1348 static void eject_device(BlockDriverState
*bs
, int force
, Error
**errp
)
1350 if (bdrv_in_use(bs
)) {
1351 error_set(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
1354 if (!bdrv_dev_has_removable_media(bs
)) {
1355 error_set(errp
, QERR_DEVICE_NOT_REMOVABLE
, bdrv_get_device_name(bs
));
1359 if (bdrv_dev_is_medium_locked(bs
) && !bdrv_dev_is_tray_open(bs
)) {
1360 bdrv_dev_eject_request(bs
, force
);
1362 error_set(errp
, QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
1370 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1372 BlockDriverState
*bs
;
1374 bs
= bdrv_find(device
);
1376 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1380 eject_device(bs
, force
, errp
);
1383 void qmp_block_passwd(const char *device
, const char *password
, Error
**errp
)
1385 BlockDriverState
*bs
;
1388 bs
= bdrv_find(device
);
1390 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1394 err
= bdrv_set_key(bs
, password
);
1395 if (err
== -EINVAL
) {
1396 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1398 } else if (err
< 0) {
1399 error_set(errp
, QERR_INVALID_PASSWORD
);
1404 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1405 int bdrv_flags
, BlockDriver
*drv
,
1406 const char *password
, Error
**errp
)
1408 Error
*local_err
= NULL
;
1411 ret
= bdrv_open(bs
, filename
, NULL
, bdrv_flags
, drv
, &local_err
);
1413 error_propagate(errp
, local_err
);
1417 if (bdrv_key_required(bs
)) {
1419 if (bdrv_set_key(bs
, password
) < 0) {
1420 error_set(errp
, QERR_INVALID_PASSWORD
);
1423 error_set(errp
, QERR_DEVICE_ENCRYPTED
, bdrv_get_device_name(bs
),
1424 bdrv_get_encrypted_filename(bs
));
1426 } else if (password
) {
1427 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1431 void qmp_change_blockdev(const char *device
, const char *filename
,
1432 bool has_format
, const char *format
, Error
**errp
)
1434 BlockDriverState
*bs
;
1435 BlockDriver
*drv
= NULL
;
1439 bs
= bdrv_find(device
);
1441 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1446 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1448 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1453 eject_device(bs
, 0, &err
);
1454 if (error_is_set(&err
)) {
1455 error_propagate(errp
, err
);
1459 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1460 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1462 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1465 /* throttling disk I/O limits */
1466 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1473 bool has_bps_rd_max
,
1475 bool has_bps_wr_max
,
1479 bool has_iops_rd_max
,
1480 int64_t iops_rd_max
,
1481 bool has_iops_wr_max
,
1482 int64_t iops_wr_max
,
1484 int64_t iops_size
, Error
**errp
)
1487 BlockDriverState
*bs
;
1489 bs
= bdrv_find(device
);
1491 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1495 memset(&cfg
, 0, sizeof(cfg
));
1496 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
1497 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
1498 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
1500 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
1501 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
1502 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
1505 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
1507 if (has_bps_rd_max
) {
1508 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
1510 if (has_bps_wr_max
) {
1511 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
1514 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
1516 if (has_iops_rd_max
) {
1517 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
1519 if (has_iops_wr_max
) {
1520 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
1523 if (has_iops_size
) {
1524 cfg
.op_size
= iops_size
;
1527 if (!check_throttle_config(&cfg
, errp
)) {
1531 if (!bs
->io_limits_enabled
&& throttle_enabled(&cfg
)) {
1532 bdrv_io_limits_enable(bs
);
1533 } else if (bs
->io_limits_enabled
&& !throttle_enabled(&cfg
)) {
1534 bdrv_io_limits_disable(bs
);
1537 if (bs
->io_limits_enabled
) {
1538 bdrv_set_io_limits(bs
, &cfg
);
1542 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
1544 const char *id
= qdict_get_str(qdict
, "id");
1545 BlockDriverState
*bs
;
1549 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
1552 if (bdrv_in_use(bs
)) {
1553 qerror_report(QERR_DEVICE_IN_USE
, id
);
1557 /* quiesce block driver; prevent further io */
1562 /* if we have a device attached to this BlockDriverState
1563 * then we need to make the drive anonymous until the device
1564 * can be removed. If this is a drive with no device backing
1565 * then we can just get rid of the block driver state right here.
1567 if (bdrv_get_attached_dev(bs
)) {
1570 /* Further I/O must not pause the guest */
1571 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
1572 BLOCKDEV_ON_ERROR_REPORT
);
1574 drive_uninit(drive_get_by_blockdev(bs
));
1580 void qmp_block_resize(const char *device
, int64_t size
, Error
**errp
)
1582 BlockDriverState
*bs
;
1585 bs
= bdrv_find(device
);
1587 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1592 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
1596 /* complete all in-flight operations before resizing the device */
1599 ret
= bdrv_truncate(bs
, size
);
1604 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1607 error_set(errp
, QERR_UNSUPPORTED
);
1610 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1613 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1616 error_setg_errno(errp
, -ret
, "Could not resize");
1621 static void block_job_cb(void *opaque
, int ret
)
1623 BlockDriverState
*bs
= opaque
;
1626 trace_block_job_cb(bs
, bs
->job
, ret
);
1629 obj
= qobject_from_block_job(bs
->job
);
1631 QDict
*dict
= qobject_to_qdict(obj
);
1632 qdict_put(dict
, "error", qstring_from_str(strerror(-ret
)));
1635 if (block_job_is_cancelled(bs
->job
)) {
1636 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED
, obj
);
1638 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED
, obj
);
1640 qobject_decref(obj
);
1642 bdrv_put_ref_bh_schedule(bs
);
1645 void qmp_block_stream(const char *device
, bool has_base
,
1646 const char *base
, bool has_speed
, int64_t speed
,
1647 bool has_on_error
, BlockdevOnError on_error
,
1650 BlockDriverState
*bs
;
1651 BlockDriverState
*base_bs
= NULL
;
1652 Error
*local_err
= NULL
;
1654 if (!has_on_error
) {
1655 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1658 bs
= bdrv_find(device
);
1660 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1665 base_bs
= bdrv_find_backing_image(bs
, base
);
1666 if (base_bs
== NULL
) {
1667 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
1672 stream_start(bs
, base_bs
, base
, has_speed
? speed
: 0,
1673 on_error
, block_job_cb
, bs
, &local_err
);
1674 if (error_is_set(&local_err
)) {
1675 error_propagate(errp
, local_err
);
1679 trace_qmp_block_stream(bs
, bs
->job
);
1682 void qmp_block_commit(const char *device
,
1683 bool has_base
, const char *base
, const char *top
,
1684 bool has_speed
, int64_t speed
,
1687 BlockDriverState
*bs
;
1688 BlockDriverState
*base_bs
, *top_bs
;
1689 Error
*local_err
= NULL
;
1690 /* This will be part of the QMP command, if/when the
1691 * BlockdevOnError change for blkmirror makes it in
1693 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1695 /* drain all i/o before commits */
1698 bs
= bdrv_find(device
);
1700 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1704 /* default top_bs is the active layer */
1708 if (strcmp(bs
->filename
, top
) != 0) {
1709 top_bs
= bdrv_find_backing_image(bs
, top
);
1713 if (top_bs
== NULL
) {
1714 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
1718 if (has_base
&& base
) {
1719 base_bs
= bdrv_find_backing_image(top_bs
, base
);
1721 base_bs
= bdrv_find_base(top_bs
);
1724 if (base_bs
== NULL
) {
1725 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
1729 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
1731 if (local_err
!= NULL
) {
1732 error_propagate(errp
, local_err
);
1737 void qmp_drive_backup(const char *device
, const char *target
,
1738 bool has_format
, const char *format
,
1739 enum MirrorSyncMode sync
,
1740 bool has_mode
, enum NewImageMode mode
,
1741 bool has_speed
, int64_t speed
,
1742 bool has_on_source_error
, BlockdevOnError on_source_error
,
1743 bool has_on_target_error
, BlockdevOnError on_target_error
,
1746 BlockDriverState
*bs
;
1747 BlockDriverState
*target_bs
;
1748 BlockDriverState
*source
= NULL
;
1749 BlockDriver
*drv
= NULL
;
1750 Error
*local_err
= NULL
;
1758 if (!has_on_source_error
) {
1759 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1761 if (!has_on_target_error
) {
1762 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1765 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1768 bs
= bdrv_find(device
);
1770 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1774 if (!bdrv_is_inserted(bs
)) {
1775 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1780 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1783 drv
= bdrv_find_format(format
);
1785 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1790 if (bdrv_in_use(bs
)) {
1791 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1795 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1797 /* See if we have a backing HD we can use to create our new image
1799 if (sync
== MIRROR_SYNC_MODE_TOP
) {
1800 source
= bs
->backing_hd
;
1802 sync
= MIRROR_SYNC_MODE_FULL
;
1805 if (sync
== MIRROR_SYNC_MODE_NONE
) {
1809 size
= bdrv_getlength(bs
);
1811 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1815 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1816 assert(format
&& drv
);
1818 bdrv_img_create(target
, format
, source
->filename
,
1819 source
->drv
->format_name
, NULL
,
1820 size
, flags
, &local_err
, false);
1822 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
1823 size
, flags
, &local_err
, false);
1827 if (error_is_set(&local_err
)) {
1828 error_propagate(errp
, local_err
);
1832 target_bs
= bdrv_new("");
1833 ret
= bdrv_open(target_bs
, target
, NULL
, flags
, drv
, &local_err
);
1835 bdrv_unref(target_bs
);
1836 error_propagate(errp
, local_err
);
1840 backup_start(bs
, target_bs
, speed
, sync
, on_source_error
, on_target_error
,
1841 block_job_cb
, bs
, &local_err
);
1842 if (local_err
!= NULL
) {
1843 bdrv_unref(target_bs
);
1844 error_propagate(errp
, local_err
);
1849 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1851 void qmp_drive_mirror(const char *device
, const char *target
,
1852 bool has_format
, const char *format
,
1853 enum MirrorSyncMode sync
,
1854 bool has_mode
, enum NewImageMode mode
,
1855 bool has_speed
, int64_t speed
,
1856 bool has_granularity
, uint32_t granularity
,
1857 bool has_buf_size
, int64_t buf_size
,
1858 bool has_on_source_error
, BlockdevOnError on_source_error
,
1859 bool has_on_target_error
, BlockdevOnError on_target_error
,
1862 BlockDriverState
*bs
;
1863 BlockDriverState
*source
, *target_bs
;
1864 BlockDriver
*drv
= NULL
;
1865 Error
*local_err
= NULL
;
1873 if (!has_on_source_error
) {
1874 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1876 if (!has_on_target_error
) {
1877 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1880 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1882 if (!has_granularity
) {
1885 if (!has_buf_size
) {
1886 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1889 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
1890 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1893 if (granularity
& (granularity
- 1)) {
1894 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1898 bs
= bdrv_find(device
);
1900 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1904 if (!bdrv_is_inserted(bs
)) {
1905 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1910 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1913 drv
= bdrv_find_format(format
);
1915 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1920 if (bdrv_in_use(bs
)) {
1921 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1925 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1926 source
= bs
->backing_hd
;
1927 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
1928 sync
= MIRROR_SYNC_MODE_FULL
;
1931 size
= bdrv_getlength(bs
);
1933 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1937 if (sync
== MIRROR_SYNC_MODE_FULL
&& mode
!= NEW_IMAGE_MODE_EXISTING
) {
1938 /* create new image w/o backing file */
1939 assert(format
&& drv
);
1940 bdrv_img_create(target
, format
,
1941 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
1944 case NEW_IMAGE_MODE_EXISTING
:
1946 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
1947 /* create new image with backing file */
1948 bdrv_img_create(target
, format
,
1950 source
->drv
->format_name
,
1951 NULL
, size
, flags
, &local_err
, false);
1958 if (error_is_set(&local_err
)) {
1959 error_propagate(errp
, local_err
);
1963 /* Mirroring takes care of copy-on-write using the source's backing
1966 target_bs
= bdrv_new("");
1967 ret
= bdrv_open(target_bs
, target
, NULL
, flags
| BDRV_O_NO_BACKING
, drv
,
1970 bdrv_unref(target_bs
);
1971 error_propagate(errp
, local_err
);
1975 mirror_start(bs
, target_bs
, speed
, granularity
, buf_size
, sync
,
1976 on_source_error
, on_target_error
,
1977 block_job_cb
, bs
, &local_err
);
1978 if (local_err
!= NULL
) {
1979 bdrv_unref(target_bs
);
1980 error_propagate(errp
, local_err
);
1985 static BlockJob
*find_block_job(const char *device
)
1987 BlockDriverState
*bs
;
1989 bs
= bdrv_find(device
);
1990 if (!bs
|| !bs
->job
) {
1996 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
1998 BlockJob
*job
= find_block_job(device
);
2001 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2005 block_job_set_speed(job
, speed
, errp
);
2008 void qmp_block_job_cancel(const char *device
,
2009 bool has_force
, bool force
, Error
**errp
)
2011 BlockJob
*job
= find_block_job(device
);
2018 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2021 if (job
->paused
&& !force
) {
2022 error_set(errp
, QERR_BLOCK_JOB_PAUSED
, device
);
2026 trace_qmp_block_job_cancel(job
);
2027 block_job_cancel(job
);
2030 void qmp_block_job_pause(const char *device
, Error
**errp
)
2032 BlockJob
*job
= find_block_job(device
);
2035 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2039 trace_qmp_block_job_pause(job
);
2040 block_job_pause(job
);
2043 void qmp_block_job_resume(const char *device
, Error
**errp
)
2045 BlockJob
*job
= find_block_job(device
);
2048 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2052 trace_qmp_block_job_resume(job
);
2053 block_job_resume(job
);
2056 void qmp_block_job_complete(const char *device
, Error
**errp
)
2058 BlockJob
*job
= find_block_job(device
);
2061 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2065 trace_qmp_block_job_complete(job
);
2066 block_job_complete(job
, errp
);
2069 static void do_qmp_query_block_jobs_one(void *opaque
, BlockDriverState
*bs
)
2071 BlockJobInfoList
**prev
= opaque
;
2072 BlockJob
*job
= bs
->job
;
2075 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
2076 elem
->value
= block_job_query(bs
->job
);
2077 (*prev
)->next
= elem
;
2082 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
2084 /* Dummy is a fake list element for holding the head pointer */
2085 BlockJobInfoList dummy
= {};
2086 BlockJobInfoList
*prev
= &dummy
;
2087 bdrv_iterate(do_qmp_query_block_jobs_one
, &prev
);
2091 QemuOptsList qemu_common_drive_opts
= {
2093 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
2097 .type
= QEMU_OPT_NUMBER
,
2098 .help
= "bus number",
2101 .type
= QEMU_OPT_NUMBER
,
2102 .help
= "unit number (i.e. lun for scsi)",
2105 .type
= QEMU_OPT_STRING
,
2106 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2109 .type
= QEMU_OPT_NUMBER
,
2110 .help
= "index number",
2113 .type
= QEMU_OPT_NUMBER
,
2114 .help
= "number of cylinders (ide disk geometry)",
2117 .type
= QEMU_OPT_NUMBER
,
2118 .help
= "number of heads (ide disk geometry)",
2121 .type
= QEMU_OPT_NUMBER
,
2122 .help
= "number of sectors (ide disk geometry)",
2125 .type
= QEMU_OPT_STRING
,
2126 .help
= "chs translation (auto, lba. none)",
2129 .type
= QEMU_OPT_STRING
,
2130 .help
= "media type (disk, cdrom)",
2133 .type
= QEMU_OPT_BOOL
,
2134 .help
= "enable/disable snapshot mode",
2137 .type
= QEMU_OPT_STRING
,
2138 .help
= "disk image",
2141 .type
= QEMU_OPT_STRING
,
2142 .help
= "discard operation (ignore/off, unmap/on)",
2144 .name
= "cache.writeback",
2145 .type
= QEMU_OPT_BOOL
,
2146 .help
= "enables writeback mode for any caches",
2148 .name
= "cache.direct",
2149 .type
= QEMU_OPT_BOOL
,
2150 .help
= "enables use of O_DIRECT (bypass the host page cache)",
2152 .name
= "cache.no-flush",
2153 .type
= QEMU_OPT_BOOL
,
2154 .help
= "ignore any flush requests for the device",
2157 .type
= QEMU_OPT_STRING
,
2158 .help
= "host AIO implementation (threads, native)",
2161 .type
= QEMU_OPT_STRING
,
2162 .help
= "disk format (raw, qcow2, ...)",
2165 .type
= QEMU_OPT_STRING
,
2166 .help
= "disk serial number",
2169 .type
= QEMU_OPT_STRING
,
2170 .help
= "read error action",
2173 .type
= QEMU_OPT_STRING
,
2174 .help
= "write error action",
2177 .type
= QEMU_OPT_STRING
,
2178 .help
= "pci address (virtio only)",
2180 .name
= "read-only",
2181 .type
= QEMU_OPT_BOOL
,
2182 .help
= "open drive file as read-only",
2184 .name
= "throttling.iops-total",
2185 .type
= QEMU_OPT_NUMBER
,
2186 .help
= "limit total I/O operations per second",
2188 .name
= "throttling.iops-read",
2189 .type
= QEMU_OPT_NUMBER
,
2190 .help
= "limit read operations per second",
2192 .name
= "throttling.iops-write",
2193 .type
= QEMU_OPT_NUMBER
,
2194 .help
= "limit write operations per second",
2196 .name
= "throttling.bps-total",
2197 .type
= QEMU_OPT_NUMBER
,
2198 .help
= "limit total bytes per second",
2200 .name
= "throttling.bps-read",
2201 .type
= QEMU_OPT_NUMBER
,
2202 .help
= "limit read bytes per second",
2204 .name
= "throttling.bps-write",
2205 .type
= QEMU_OPT_NUMBER
,
2206 .help
= "limit write bytes per second",
2208 .name
= "throttling.iops-total-max",
2209 .type
= QEMU_OPT_NUMBER
,
2210 .help
= "I/O operations burst",
2212 .name
= "throttling.iops-read-max",
2213 .type
= QEMU_OPT_NUMBER
,
2214 .help
= "I/O operations read burst",
2216 .name
= "throttling.iops-write-max",
2217 .type
= QEMU_OPT_NUMBER
,
2218 .help
= "I/O operations write burst",
2220 .name
= "throttling.bps-total-max",
2221 .type
= QEMU_OPT_NUMBER
,
2222 .help
= "total bytes burst",
2224 .name
= "throttling.bps-read-max",
2225 .type
= QEMU_OPT_NUMBER
,
2226 .help
= "total bytes read burst",
2228 .name
= "throttling.bps-write-max",
2229 .type
= QEMU_OPT_NUMBER
,
2230 .help
= "total bytes write burst",
2232 .name
= "throttling.iops-size",
2233 .type
= QEMU_OPT_NUMBER
,
2234 .help
= "when limiting by iops max size of an I/O in bytes",
2236 .name
= "copy-on-read",
2237 .type
= QEMU_OPT_BOOL
,
2238 .help
= "copy read data from backing file into image file",
2241 .type
= QEMU_OPT_BOOL
,
2242 .help
= "(deprecated, ignored)",
2244 { /* end of list */ }
2248 QemuOptsList qemu_drive_opts
= {
2250 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
2253 * no elements => accept any params
2254 * validation will happen later
2256 { /* end of list */ }