2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
9 * This file incorporates work covered by the following copyright and
12 * Copyright (c) 2003-2008 Fabrice Bellard
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
33 #include "sysemu/blockdev.h"
34 #include "hw/block/block.h"
35 #include "block/blockjob.h"
36 #include "monitor/monitor.h"
37 #include "qapi/qmp/qerror.h"
38 #include "qemu/option.h"
39 #include "qemu/config-file.h"
40 #include "qapi/qmp/types.h"
41 #include "sysemu/sysemu.h"
42 #include "block/block_int.h"
43 #include "qmp-commands.h"
45 #include "sysemu/arch_init.h"
47 static QTAILQ_HEAD(drivelist
, DriveInfo
) drives
= QTAILQ_HEAD_INITIALIZER(drives
);
48 extern QemuOptsList qemu_common_drive_opts
;
50 static const char *const if_name
[IF_COUNT
] = {
54 [IF_FLOPPY
] = "floppy",
55 [IF_PFLASH
] = "pflash",
58 [IF_VIRTIO
] = "virtio",
62 static const int if_max_devs
[IF_COUNT
] = {
64 * Do not change these numbers! They govern how drive option
65 * index maps to unit and bus. That mapping is ABI.
67 * All controllers used to imlement if=T drives need to support
68 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
69 * Otherwise, some index values map to "impossible" bus, unit
72 * For instance, if you change [IF_SCSI] to 255, -drive
73 * if=scsi,index=12 no longer means bus=1,unit=5, but
74 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
75 * the drive can't be set up. Regression.
82 * We automatically delete the drive when a device using it gets
83 * unplugged. Questionable feature, but we can't just drop it.
84 * Device models call blockdev_mark_auto_del() to schedule the
85 * automatic deletion, and generic qdev code calls blockdev_auto_del()
86 * when deletion is actually safe.
88 void blockdev_mark_auto_del(BlockDriverState
*bs
)
90 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
93 block_job_cancel(bs
->job
);
100 void blockdev_auto_del(BlockDriverState
*bs
)
102 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
104 if (dinfo
&& dinfo
->auto_del
) {
105 drive_put_ref(dinfo
);
109 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
111 int max_devs
= if_max_devs
[type
];
112 return max_devs
? index
/ max_devs
: 0;
115 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
117 int max_devs
= if_max_devs
[type
];
118 return max_devs
? index
% max_devs
: index
;
121 QemuOpts
*drive_def(const char *optstr
)
123 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
126 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
132 opts
= drive_def(optstr
);
136 if (type
!= IF_DEFAULT
) {
137 qemu_opt_set(opts
, "if", if_name
[type
]);
140 snprintf(buf
, sizeof(buf
), "%d", index
);
141 qemu_opt_set(opts
, "index", buf
);
144 qemu_opt_set(opts
, "file", file
);
148 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
152 /* seek interface, bus and unit */
154 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
155 if (dinfo
->type
== type
&&
164 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
166 return drive_get(type
,
167 drive_index_to_bus_id(type
, index
),
168 drive_index_to_unit_id(type
, index
));
171 int drive_get_max_bus(BlockInterfaceType type
)
177 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
178 if(dinfo
->type
== type
&&
179 dinfo
->bus
> max_bus
)
180 max_bus
= dinfo
->bus
;
185 /* Get a block device. This should only be used for single-drive devices
186 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
188 DriveInfo
*drive_get_next(BlockInterfaceType type
)
190 static int next_block_unit
[IF_COUNT
];
192 return drive_get(type
, 0, next_block_unit
[type
]++);
195 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
199 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
200 if (dinfo
->bdrv
== bs
) {
207 static void bdrv_format_print(void *opaque
, const char *name
)
209 error_printf(" %s", name
);
212 static void drive_uninit(DriveInfo
*dinfo
)
214 qemu_opts_del(dinfo
->opts
);
215 bdrv_unref(dinfo
->bdrv
);
217 QTAILQ_REMOVE(&drives
, dinfo
, next
);
218 g_free(dinfo
->serial
);
222 void drive_put_ref(DriveInfo
*dinfo
)
224 assert(dinfo
->refcount
);
225 if (--dinfo
->refcount
== 0) {
230 void drive_get_ref(DriveInfo
*dinfo
)
237 BlockDriverState
*bs
;
240 static void bdrv_put_ref_bh(void *opaque
)
242 BDRVPutRefBH
*s
= opaque
;
245 qemu_bh_delete(s
->bh
);
250 * Release a BDS reference in a BH
252 * It is not safe to use bdrv_unref() from a callback function when the callers
253 * still need the BlockDriverState. In such cases we schedule a BH to release
256 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
260 s
= g_new(BDRVPutRefBH
, 1);
261 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
263 qemu_bh_schedule(s
->bh
);
266 static int parse_block_error_action(const char *buf
, bool is_read
)
268 if (!strcmp(buf
, "ignore")) {
269 return BLOCKDEV_ON_ERROR_IGNORE
;
270 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
271 return BLOCKDEV_ON_ERROR_ENOSPC
;
272 } else if (!strcmp(buf
, "stop")) {
273 return BLOCKDEV_ON_ERROR_STOP
;
274 } else if (!strcmp(buf
, "report")) {
275 return BLOCKDEV_ON_ERROR_REPORT
;
277 error_report("'%s' invalid %s error action",
278 buf
, is_read
? "read" : "write");
283 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
285 if (throttle_conflicting(cfg
)) {
286 error_setg(errp
, "bps/iops/max total values and read/write values"
287 " cannot be used at the same time");
291 if (!throttle_is_valid(cfg
)) {
292 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
299 static DriveInfo
*blockdev_init(QemuOpts
*all_opts
,
300 BlockInterfaceType block_default_type
)
303 const char *file
= NULL
;
305 const char *mediastr
= "";
306 BlockInterfaceType type
;
307 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
309 int cyls
, heads
, secs
, translation
;
314 int on_read_error
, on_write_error
;
325 bool has_driver_specific_opts
;
326 BlockDriver
*drv
= NULL
;
328 translation
= BIOS_ATA_TRANSLATION_AUTO
;
331 /* Check common options by copying from all_opts to opts, all other options
332 * are stored in bs_opts. */
333 id
= qemu_opts_id(all_opts
);
334 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
335 if (error_is_set(&error
)) {
336 qerror_report_err(error
);
341 bs_opts
= qdict_new();
342 qemu_opts_to_qdict(all_opts
, bs_opts
);
343 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
344 if (error_is_set(&error
)) {
345 qerror_report_err(error
);
351 qdict_del(bs_opts
, "id");
354 has_driver_specific_opts
= !!qdict_size(bs_opts
);
356 /* extract parameters */
357 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
358 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
359 index
= qemu_opt_get_number(opts
, "index", -1);
361 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
362 heads
= qemu_opt_get_number(opts
, "heads", 0);
363 secs
= qemu_opt_get_number(opts
, "secs", 0);
365 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
366 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
367 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
369 file
= qemu_opt_get(opts
, "file");
370 serial
= qemu_opt_get(opts
, "serial");
372 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
373 for (type
= 0; type
< IF_COUNT
&& strcmp(buf
, if_name
[type
]); type
++)
375 if (type
== IF_COUNT
) {
376 error_report("unsupported bus type '%s'", buf
);
380 type
= block_default_type
;
383 max_devs
= if_max_devs
[type
];
385 if (cyls
|| heads
|| secs
) {
387 error_report("invalid physical cyls number");
391 error_report("invalid physical heads number");
395 error_report("invalid physical secs number");
400 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
402 error_report("'%s' trans must be used with cyls, heads and secs",
406 if (!strcmp(buf
, "none"))
407 translation
= BIOS_ATA_TRANSLATION_NONE
;
408 else if (!strcmp(buf
, "lba"))
409 translation
= BIOS_ATA_TRANSLATION_LBA
;
410 else if (!strcmp(buf
, "auto"))
411 translation
= BIOS_ATA_TRANSLATION_AUTO
;
413 error_report("'%s' invalid translation type", buf
);
418 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
419 if (!strcmp(buf
, "disk")) {
421 } else if (!strcmp(buf
, "cdrom")) {
422 if (cyls
|| secs
|| heads
) {
423 error_report("CHS can't be set with media=%s", buf
);
428 error_report("'%s' invalid media", buf
);
433 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
434 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
435 error_report("invalid discard option");
440 if (qemu_opt_get_bool(opts
, "cache.writeback", true)) {
441 bdrv_flags
|= BDRV_O_CACHE_WB
;
443 if (qemu_opt_get_bool(opts
, "cache.direct", false)) {
444 bdrv_flags
|= BDRV_O_NOCACHE
;
446 if (qemu_opt_get_bool(opts
, "cache.no-flush", true)) {
447 bdrv_flags
|= BDRV_O_NO_FLUSH
;
450 #ifdef CONFIG_LINUX_AIO
451 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
452 if (!strcmp(buf
, "native")) {
453 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
454 } else if (!strcmp(buf
, "threads")) {
455 /* this is the default */
457 error_report("invalid aio option");
463 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
464 if (is_help_option(buf
)) {
465 error_printf("Supported formats:");
466 bdrv_iterate_format(bdrv_format_print
, NULL
);
471 drv
= bdrv_find_whitelisted_format(buf
, ro
);
473 if (!ro
&& bdrv_find_whitelisted_format(buf
, !ro
)) {
474 error_report("'%s' can be only used as read-only device.", buf
);
476 error_report("'%s' invalid format", buf
);
482 /* disk I/O throttling */
483 memset(&cfg
, 0, sizeof(cfg
));
484 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
485 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
486 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
487 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
488 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
489 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
490 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
491 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
492 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
493 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
494 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
495 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
497 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
498 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
499 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
500 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
501 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
502 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
503 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
504 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
505 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
506 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
507 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
508 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
510 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
512 if (!check_throttle_config(&cfg
, &error
)) {
513 error_report("%s", error_get_pretty(error
));
518 if (qemu_opt_get(opts
, "boot") != NULL
) {
519 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
520 "ignored. Future versions will reject this parameter. Please "
521 "update your scripts.\n");
524 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
525 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
526 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
527 error_report("werror is not supported by this bus type");
531 on_write_error
= parse_block_error_action(buf
, 0);
532 if (on_write_error
< 0) {
537 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
538 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
539 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
540 error_report("rerror is not supported by this bus type");
544 on_read_error
= parse_block_error_action(buf
, 1);
545 if (on_read_error
< 0) {
550 if ((devaddr
= qemu_opt_get(opts
, "addr")) != NULL
) {
551 if (type
!= IF_VIRTIO
) {
552 error_report("addr is not supported by this bus type");
557 /* compute bus and unit according index */
560 if (bus_id
!= 0 || unit_id
!= -1) {
561 error_report("index cannot be used with bus and unit");
564 bus_id
= drive_index_to_bus_id(type
, index
);
565 unit_id
= drive_index_to_unit_id(type
, index
);
568 /* if user doesn't specify a unit_id,
569 * try to find the first free
574 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
576 if (max_devs
&& unit_id
>= max_devs
) {
585 if (max_devs
&& unit_id
>= max_devs
) {
586 error_report("unit %d too big (max is %d)",
587 unit_id
, max_devs
- 1);
592 * catch multiple definitions
595 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
596 error_report("drive with bus=%d, unit=%d (index=%d) exists",
597 bus_id
, unit_id
, index
);
603 dinfo
= g_malloc0(sizeof(*dinfo
));
604 if ((buf
= qemu_opts_id(opts
)) != NULL
) {
605 dinfo
->id
= g_strdup(buf
);
607 /* no id supplied -> create one */
608 dinfo
->id
= g_malloc0(32);
609 if (type
== IF_IDE
|| type
== IF_SCSI
)
610 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
612 snprintf(dinfo
->id
, 32, "%s%i%s%i",
613 if_name
[type
], bus_id
, mediastr
, unit_id
);
615 snprintf(dinfo
->id
, 32, "%s%s%i",
616 if_name
[type
], mediastr
, unit_id
);
618 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
619 dinfo
->bdrv
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
620 dinfo
->bdrv
->read_only
= ro
;
621 dinfo
->devaddr
= devaddr
;
624 dinfo
->unit
= unit_id
;
626 dinfo
->heads
= heads
;
628 dinfo
->trans
= translation
;
629 dinfo
->opts
= all_opts
;
631 if (serial
!= NULL
) {
632 dinfo
->serial
= g_strdup(serial
);
634 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
636 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
638 /* disk I/O throttling */
639 if (throttle_enabled(&cfg
)) {
640 bdrv_io_limits_enable(dinfo
->bdrv
);
641 bdrv_set_io_limits(dinfo
->bdrv
, &cfg
);
649 dinfo
->media_cd
= media
== MEDIA_CDROM
;
658 /* add virtio block device */
660 devopts
= qemu_opts_create_nofail(qemu_find_opts("device"));
661 if (arch_type
== QEMU_ARCH_S390X
) {
662 qemu_opt_set(devopts
, "driver", "virtio-blk-s390");
664 qemu_opt_set(devopts
, "driver", "virtio-blk-pci");
666 qemu_opt_set(devopts
, "drive", dinfo
->id
);
668 qemu_opt_set(devopts
, "addr", devaddr
);
674 if (!file
|| !*file
) {
675 if (has_driver_specific_opts
) {
682 /* always use cache=unsafe with snapshot */
683 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
684 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
688 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
691 if (runstate_check(RUN_STATE_INMIGRATE
)) {
692 bdrv_flags
|= BDRV_O_INCOMING
;
695 if (media
== MEDIA_CDROM
) {
696 /* CDROM is fine for any interface, don't check. */
698 } else if (ro
== 1) {
699 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&&
700 type
!= IF_NONE
&& type
!= IF_PFLASH
) {
701 error_report("read-only not supported by this bus type");
706 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
708 if (ro
&& copy_on_read
) {
709 error_report("warning: disabling copy_on_read on read-only drive");
713 ret
= bdrv_open(dinfo
->bdrv
, file
, bs_opts
, bdrv_flags
, drv
);
716 if (ret
== -EMEDIUMTYPE
) {
717 error_report("could not open disk image %s: not in %s format",
718 file
?: dinfo
->id
, drv
? drv
->format_name
:
719 qdict_get_str(bs_opts
, "driver"));
721 error_report("could not open disk image %s: %s",
722 file
?: dinfo
->id
, strerror(-ret
));
727 if (bdrv_key_required(dinfo
->bdrv
))
738 bdrv_unref(dinfo
->bdrv
);
740 QTAILQ_REMOVE(&drives
, dinfo
, next
);
745 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
)
749 value
= qemu_opt_get(opts
, from
);
751 qemu_opt_set(opts
, to
, value
);
752 qemu_opt_unset(opts
, from
);
756 DriveInfo
*drive_init(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
760 /* Change legacy command line options into QMP ones */
761 qemu_opt_rename(all_opts
, "iops", "throttling.iops-total");
762 qemu_opt_rename(all_opts
, "iops_rd", "throttling.iops-read");
763 qemu_opt_rename(all_opts
, "iops_wr", "throttling.iops-write");
765 qemu_opt_rename(all_opts
, "bps", "throttling.bps-total");
766 qemu_opt_rename(all_opts
, "bps_rd", "throttling.bps-read");
767 qemu_opt_rename(all_opts
, "bps_wr", "throttling.bps-write");
769 qemu_opt_rename(all_opts
, "iops_max", "throttling.iops-total-max");
770 qemu_opt_rename(all_opts
, "iops_rd_max", "throttling.iops-read-max");
771 qemu_opt_rename(all_opts
, "iops_wr_max", "throttling.iops-write-max");
773 qemu_opt_rename(all_opts
, "bps_max", "throttling.bps-total-max");
774 qemu_opt_rename(all_opts
, "bps_rd_max", "throttling.bps-read-max");
775 qemu_opt_rename(all_opts
, "bps_wr_max", "throttling.bps-write-max");
777 qemu_opt_rename(all_opts
,
778 "iops_size", "throttling.iops-size");
780 qemu_opt_rename(all_opts
, "readonly", "read-only");
782 value
= qemu_opt_get(all_opts
, "cache");
786 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
787 error_report("invalid cache option");
791 /* Specific options take precedence */
792 if (!qemu_opt_get(all_opts
, "cache.writeback")) {
793 qemu_opt_set_bool(all_opts
, "cache.writeback",
794 !!(flags
& BDRV_O_CACHE_WB
));
796 if (!qemu_opt_get(all_opts
, "cache.direct")) {
797 qemu_opt_set_bool(all_opts
, "cache.direct",
798 !!(flags
& BDRV_O_NOCACHE
));
800 if (!qemu_opt_get(all_opts
, "cache.no-flush")) {
801 qemu_opt_set_bool(all_opts
, "cache.no-flush",
802 !!(flags
& BDRV_O_NO_FLUSH
));
804 qemu_opt_unset(all_opts
, "cache");
807 return blockdev_init(all_opts
, block_default_type
);
810 void do_commit(Monitor
*mon
, const QDict
*qdict
)
812 const char *device
= qdict_get_str(qdict
, "device");
813 BlockDriverState
*bs
;
816 if (!strcmp(device
, "all")) {
817 ret
= bdrv_commit_all();
819 bs
= bdrv_find(device
);
821 monitor_printf(mon
, "Device '%s' not found\n", device
);
824 ret
= bdrv_commit(bs
);
827 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
832 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
834 TransactionAction action
;
835 TransactionActionList list
;
839 list
.value
= &action
;
841 qmp_transaction(&list
, errp
);
844 void qmp_blockdev_snapshot_sync(const char *device
, const char *snapshot_file
,
845 bool has_format
, const char *format
,
846 bool has_mode
, enum NewImageMode mode
,
849 BlockdevSnapshot snapshot
= {
850 .device
= (char *) device
,
851 .snapshot_file
= (char *) snapshot_file
,
852 .has_format
= has_format
,
853 .format
= (char *) format
,
854 .has_mode
= has_mode
,
857 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
861 void qmp_blockdev_snapshot_internal_sync(const char *device
,
865 BlockdevSnapshotInternal snapshot
= {
866 .device
= (char *) device
,
867 .name
= (char *) name
870 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
875 /* New and old BlockDriverState structs for group snapshots */
877 typedef struct BlkTransactionState BlkTransactionState
;
879 /* Only prepare() may fail. In a single transaction, only one of commit() or
880 abort() will be called, clean() will always be called if it present. */
881 typedef struct BdrvActionOps
{
882 /* Size of state struct, in bytes. */
883 size_t instance_size
;
884 /* Prepare the work, must NOT be NULL. */
885 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
886 /* Commit the changes, can be NULL. */
887 void (*commit
)(BlkTransactionState
*common
);
888 /* Abort the changes on fail, can be NULL. */
889 void (*abort
)(BlkTransactionState
*common
);
890 /* Clean up resource in the end, can be NULL. */
891 void (*clean
)(BlkTransactionState
*common
);
895 * This structure must be arranged as first member in child type, assuming
896 * that compiler will also arrange it to the same address with parent instance.
897 * Later it will be used in free().
899 struct BlkTransactionState
{
900 TransactionAction
*action
;
901 const BdrvActionOps
*ops
;
902 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
905 /* internal snapshot private data */
906 typedef struct InternalSnapshotState
{
907 BlkTransactionState common
;
908 BlockDriverState
*bs
;
910 } InternalSnapshotState
;
912 static void internal_snapshot_prepare(BlkTransactionState
*common
,
917 BlockDriverState
*bs
;
918 QEMUSnapshotInfo old_sn
, *sn
;
921 BlockdevSnapshotInternal
*internal
;
922 InternalSnapshotState
*state
;
925 g_assert(common
->action
->kind
==
926 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
927 internal
= common
->action
->blockdev_snapshot_internal_sync
;
928 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
931 device
= internal
->device
;
932 name
= internal
->name
;
934 /* 2. check for validation */
935 bs
= bdrv_find(device
);
937 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
941 if (!bdrv_is_inserted(bs
)) {
942 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
946 if (bdrv_is_read_only(bs
)) {
947 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
951 if (!bdrv_can_snapshot(bs
)) {
952 error_set(errp
, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
953 bs
->drv
->format_name
, device
, "internal snapshot");
958 error_setg(errp
, "Name is empty");
962 /* check whether a snapshot with name exist */
963 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
, errp
);
964 if (error_is_set(errp
)) {
968 "Snapshot with name '%s' already exists on device '%s'",
973 /* 3. take the snapshot */
975 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
976 qemu_gettimeofday(&tv
);
977 sn
->date_sec
= tv
.tv_sec
;
978 sn
->date_nsec
= tv
.tv_usec
* 1000;
979 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
981 ret1
= bdrv_snapshot_create(bs
, sn
);
983 error_setg_errno(errp
, -ret1
,
984 "Failed to create snapshot '%s' on device '%s'",
989 /* 4. succeed, mark a snapshot is created */
993 static void internal_snapshot_abort(BlkTransactionState
*common
)
995 InternalSnapshotState
*state
=
996 DO_UPCAST(InternalSnapshotState
, common
, common
);
997 BlockDriverState
*bs
= state
->bs
;
998 QEMUSnapshotInfo
*sn
= &state
->sn
;
999 Error
*local_error
= NULL
;
1005 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1006 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1007 "device '%s' in abort: %s",
1010 bdrv_get_device_name(bs
),
1011 error_get_pretty(local_error
));
1012 error_free(local_error
);
1016 /* external snapshot private data */
1017 typedef struct ExternalSnapshotState
{
1018 BlkTransactionState common
;
1019 BlockDriverState
*old_bs
;
1020 BlockDriverState
*new_bs
;
1021 } ExternalSnapshotState
;
1023 static void external_snapshot_prepare(BlkTransactionState
*common
,
1028 Error
*local_err
= NULL
;
1030 const char *new_image_file
;
1031 const char *format
= "qcow2";
1032 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1033 ExternalSnapshotState
*state
=
1034 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1035 TransactionAction
*action
= common
->action
;
1037 /* get parameters */
1038 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1040 device
= action
->blockdev_snapshot_sync
->device
;
1041 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1042 if (action
->blockdev_snapshot_sync
->has_format
) {
1043 format
= action
->blockdev_snapshot_sync
->format
;
1045 if (action
->blockdev_snapshot_sync
->has_mode
) {
1046 mode
= action
->blockdev_snapshot_sync
->mode
;
1049 /* start processing */
1050 drv
= bdrv_find_format(format
);
1052 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1056 state
->old_bs
= bdrv_find(device
);
1057 if (!state
->old_bs
) {
1058 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1062 if (!bdrv_is_inserted(state
->old_bs
)) {
1063 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1067 if (bdrv_in_use(state
->old_bs
)) {
1068 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1072 if (!bdrv_is_read_only(state
->old_bs
)) {
1073 if (bdrv_flush(state
->old_bs
)) {
1074 error_set(errp
, QERR_IO_ERROR
);
1079 flags
= state
->old_bs
->open_flags
;
1081 /* create new image w/backing file */
1082 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1083 bdrv_img_create(new_image_file
, format
,
1084 state
->old_bs
->filename
,
1085 state
->old_bs
->drv
->format_name
,
1086 NULL
, -1, flags
, &local_err
, false);
1087 if (error_is_set(&local_err
)) {
1088 error_propagate(errp
, local_err
);
1093 /* We will manually add the backing_hd field to the bs later */
1094 state
->new_bs
= bdrv_new("");
1095 /* TODO Inherit bs->options or only take explicit options with an
1096 * extended QMP command? */
1097 ret
= bdrv_open(state
->new_bs
, new_image_file
, NULL
,
1098 flags
| BDRV_O_NO_BACKING
, drv
);
1100 error_setg_file_open(errp
, -ret
, new_image_file
);
1104 static void external_snapshot_commit(BlkTransactionState
*common
)
1106 ExternalSnapshotState
*state
=
1107 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1109 /* This removes our old bs and adds the new bs */
1110 bdrv_append(state
->new_bs
, state
->old_bs
);
1111 /* We don't need (or want) to use the transactional
1112 * bdrv_reopen_multiple() across all the entries at once, because we
1113 * don't want to abort all of them if one of them fails the reopen */
1114 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
1118 static void external_snapshot_abort(BlkTransactionState
*common
)
1120 ExternalSnapshotState
*state
=
1121 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1122 if (state
->new_bs
) {
1123 bdrv_unref(state
->new_bs
);
1127 typedef struct DriveBackupState
{
1128 BlkTransactionState common
;
1129 BlockDriverState
*bs
;
1133 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1135 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1136 DriveBackup
*backup
;
1137 Error
*local_err
= NULL
;
1139 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1140 backup
= common
->action
->drive_backup
;
1142 qmp_drive_backup(backup
->device
, backup
->target
,
1143 backup
->has_format
, backup
->format
,
1145 backup
->has_mode
, backup
->mode
,
1146 backup
->has_speed
, backup
->speed
,
1147 backup
->has_on_source_error
, backup
->on_source_error
,
1148 backup
->has_on_target_error
, backup
->on_target_error
,
1150 if (error_is_set(&local_err
)) {
1151 error_propagate(errp
, local_err
);
1157 state
->bs
= bdrv_find(backup
->device
);
1158 state
->job
= state
->bs
->job
;
1161 static void drive_backup_abort(BlkTransactionState
*common
)
1163 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1164 BlockDriverState
*bs
= state
->bs
;
1166 /* Only cancel if it's the job we started */
1167 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1168 block_job_cancel_sync(bs
->job
);
1172 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1174 error_setg(errp
, "Transaction aborted using Abort action");
1177 static void abort_commit(BlkTransactionState
*common
)
1179 g_assert_not_reached(); /* this action never succeeds */
1182 static const BdrvActionOps actions
[] = {
1183 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1184 .instance_size
= sizeof(ExternalSnapshotState
),
1185 .prepare
= external_snapshot_prepare
,
1186 .commit
= external_snapshot_commit
,
1187 .abort
= external_snapshot_abort
,
1189 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1190 .instance_size
= sizeof(DriveBackupState
),
1191 .prepare
= drive_backup_prepare
,
1192 .abort
= drive_backup_abort
,
1194 [TRANSACTION_ACTION_KIND_ABORT
] = {
1195 .instance_size
= sizeof(BlkTransactionState
),
1196 .prepare
= abort_prepare
,
1197 .commit
= abort_commit
,
1199 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1200 .instance_size
= sizeof(InternalSnapshotState
),
1201 .prepare
= internal_snapshot_prepare
,
1202 .abort
= internal_snapshot_abort
,
1207 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1208 * then we do not pivot any of the devices in the group, and abandon the
1211 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1213 TransactionActionList
*dev_entry
= dev_list
;
1214 BlkTransactionState
*state
, *next
;
1215 Error
*local_err
= NULL
;
1217 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1218 QSIMPLEQ_INIT(&snap_bdrv_states
);
1220 /* drain all i/o before any snapshots */
1223 /* We don't do anything in this loop that commits us to the snapshot */
1224 while (NULL
!= dev_entry
) {
1225 TransactionAction
*dev_info
= NULL
;
1226 const BdrvActionOps
*ops
;
1228 dev_info
= dev_entry
->value
;
1229 dev_entry
= dev_entry
->next
;
1231 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1233 ops
= &actions
[dev_info
->kind
];
1234 state
= g_malloc0(ops
->instance_size
);
1236 state
->action
= dev_info
;
1237 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1239 state
->ops
->prepare(state
, &local_err
);
1240 if (error_is_set(&local_err
)) {
1241 error_propagate(errp
, local_err
);
1242 goto delete_and_fail
;
1246 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1247 if (state
->ops
->commit
) {
1248 state
->ops
->commit(state
);
1257 * failure, and it is all-or-none; abandon each new bs, and keep using
1258 * the original bs for all images
1260 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1261 if (state
->ops
->abort
) {
1262 state
->ops
->abort(state
);
1266 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1267 if (state
->ops
->clean
) {
1268 state
->ops
->clean(state
);
1275 static void eject_device(BlockDriverState
*bs
, int force
, Error
**errp
)
1277 if (bdrv_in_use(bs
)) {
1278 error_set(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
1281 if (!bdrv_dev_has_removable_media(bs
)) {
1282 error_set(errp
, QERR_DEVICE_NOT_REMOVABLE
, bdrv_get_device_name(bs
));
1286 if (bdrv_dev_is_medium_locked(bs
) && !bdrv_dev_is_tray_open(bs
)) {
1287 bdrv_dev_eject_request(bs
, force
);
1289 error_set(errp
, QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
1297 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1299 BlockDriverState
*bs
;
1301 bs
= bdrv_find(device
);
1303 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1307 eject_device(bs
, force
, errp
);
1310 void qmp_block_passwd(const char *device
, const char *password
, Error
**errp
)
1312 BlockDriverState
*bs
;
1315 bs
= bdrv_find(device
);
1317 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1321 err
= bdrv_set_key(bs
, password
);
1322 if (err
== -EINVAL
) {
1323 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1325 } else if (err
< 0) {
1326 error_set(errp
, QERR_INVALID_PASSWORD
);
1331 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1332 int bdrv_flags
, BlockDriver
*drv
,
1333 const char *password
, Error
**errp
)
1337 ret
= bdrv_open(bs
, filename
, NULL
, bdrv_flags
, drv
);
1339 error_setg_file_open(errp
, -ret
, filename
);
1343 if (bdrv_key_required(bs
)) {
1345 if (bdrv_set_key(bs
, password
) < 0) {
1346 error_set(errp
, QERR_INVALID_PASSWORD
);
1349 error_set(errp
, QERR_DEVICE_ENCRYPTED
, bdrv_get_device_name(bs
),
1350 bdrv_get_encrypted_filename(bs
));
1352 } else if (password
) {
1353 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1357 void qmp_change_blockdev(const char *device
, const char *filename
,
1358 bool has_format
, const char *format
, Error
**errp
)
1360 BlockDriverState
*bs
;
1361 BlockDriver
*drv
= NULL
;
1365 bs
= bdrv_find(device
);
1367 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1372 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1374 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1379 eject_device(bs
, 0, &err
);
1380 if (error_is_set(&err
)) {
1381 error_propagate(errp
, err
);
1385 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1386 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1388 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1391 /* throttling disk I/O limits */
1392 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1399 bool has_bps_rd_max
,
1401 bool has_bps_wr_max
,
1405 bool has_iops_rd_max
,
1406 int64_t iops_rd_max
,
1407 bool has_iops_wr_max
,
1408 int64_t iops_wr_max
,
1410 int64_t iops_size
, Error
**errp
)
1413 BlockDriverState
*bs
;
1415 bs
= bdrv_find(device
);
1417 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1421 memset(&cfg
, 0, sizeof(cfg
));
1422 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
1423 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
1424 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
1426 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
1427 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
1428 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
1431 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
1433 if (has_bps_rd_max
) {
1434 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
1436 if (has_bps_wr_max
) {
1437 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
1440 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
1442 if (has_iops_rd_max
) {
1443 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
1445 if (has_iops_wr_max
) {
1446 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
1449 if (has_iops_size
) {
1450 cfg
.op_size
= iops_size
;
1453 if (!check_throttle_config(&cfg
, errp
)) {
1457 if (!bs
->io_limits_enabled
&& throttle_enabled(&cfg
)) {
1458 bdrv_io_limits_enable(bs
);
1459 } else if (bs
->io_limits_enabled
&& !throttle_enabled(&cfg
)) {
1460 bdrv_io_limits_disable(bs
);
1463 if (bs
->io_limits_enabled
) {
1464 bdrv_set_io_limits(bs
, &cfg
);
1468 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
1470 const char *id
= qdict_get_str(qdict
, "id");
1471 BlockDriverState
*bs
;
1475 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
1478 if (bdrv_in_use(bs
)) {
1479 qerror_report(QERR_DEVICE_IN_USE
, id
);
1483 /* quiesce block driver; prevent further io */
1488 /* if we have a device attached to this BlockDriverState
1489 * then we need to make the drive anonymous until the device
1490 * can be removed. If this is a drive with no device backing
1491 * then we can just get rid of the block driver state right here.
1493 if (bdrv_get_attached_dev(bs
)) {
1496 /* Further I/O must not pause the guest */
1497 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
1498 BLOCKDEV_ON_ERROR_REPORT
);
1500 drive_uninit(drive_get_by_blockdev(bs
));
1506 void qmp_block_resize(const char *device
, int64_t size
, Error
**errp
)
1508 BlockDriverState
*bs
;
1511 bs
= bdrv_find(device
);
1513 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1518 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
1522 /* complete all in-flight operations before resizing the device */
1525 ret
= bdrv_truncate(bs
, size
);
1530 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1533 error_set(errp
, QERR_UNSUPPORTED
);
1536 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1539 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1542 error_setg_errno(errp
, -ret
, "Could not resize");
1547 static void block_job_cb(void *opaque
, int ret
)
1549 BlockDriverState
*bs
= opaque
;
1552 trace_block_job_cb(bs
, bs
->job
, ret
);
1555 obj
= qobject_from_block_job(bs
->job
);
1557 QDict
*dict
= qobject_to_qdict(obj
);
1558 qdict_put(dict
, "error", qstring_from_str(strerror(-ret
)));
1561 if (block_job_is_cancelled(bs
->job
)) {
1562 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED
, obj
);
1564 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED
, obj
);
1566 qobject_decref(obj
);
1568 bdrv_put_ref_bh_schedule(bs
);
1571 void qmp_block_stream(const char *device
, bool has_base
,
1572 const char *base
, bool has_speed
, int64_t speed
,
1573 bool has_on_error
, BlockdevOnError on_error
,
1576 BlockDriverState
*bs
;
1577 BlockDriverState
*base_bs
= NULL
;
1578 Error
*local_err
= NULL
;
1580 if (!has_on_error
) {
1581 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1584 bs
= bdrv_find(device
);
1586 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1591 base_bs
= bdrv_find_backing_image(bs
, base
);
1592 if (base_bs
== NULL
) {
1593 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
1598 stream_start(bs
, base_bs
, base
, has_speed
? speed
: 0,
1599 on_error
, block_job_cb
, bs
, &local_err
);
1600 if (error_is_set(&local_err
)) {
1601 error_propagate(errp
, local_err
);
1605 trace_qmp_block_stream(bs
, bs
->job
);
1608 void qmp_block_commit(const char *device
,
1609 bool has_base
, const char *base
, const char *top
,
1610 bool has_speed
, int64_t speed
,
1613 BlockDriverState
*bs
;
1614 BlockDriverState
*base_bs
, *top_bs
;
1615 Error
*local_err
= NULL
;
1616 /* This will be part of the QMP command, if/when the
1617 * BlockdevOnError change for blkmirror makes it in
1619 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1621 /* drain all i/o before commits */
1624 bs
= bdrv_find(device
);
1626 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1630 /* default top_bs is the active layer */
1634 if (strcmp(bs
->filename
, top
) != 0) {
1635 top_bs
= bdrv_find_backing_image(bs
, top
);
1639 if (top_bs
== NULL
) {
1640 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
1644 if (has_base
&& base
) {
1645 base_bs
= bdrv_find_backing_image(top_bs
, base
);
1647 base_bs
= bdrv_find_base(top_bs
);
1650 if (base_bs
== NULL
) {
1651 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
1655 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
1657 if (local_err
!= NULL
) {
1658 error_propagate(errp
, local_err
);
1663 void qmp_drive_backup(const char *device
, const char *target
,
1664 bool has_format
, const char *format
,
1665 enum MirrorSyncMode sync
,
1666 bool has_mode
, enum NewImageMode mode
,
1667 bool has_speed
, int64_t speed
,
1668 bool has_on_source_error
, BlockdevOnError on_source_error
,
1669 bool has_on_target_error
, BlockdevOnError on_target_error
,
1672 BlockDriverState
*bs
;
1673 BlockDriverState
*target_bs
;
1674 BlockDriverState
*source
= NULL
;
1675 BlockDriver
*drv
= NULL
;
1676 Error
*local_err
= NULL
;
1684 if (!has_on_source_error
) {
1685 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1687 if (!has_on_target_error
) {
1688 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1691 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1694 bs
= bdrv_find(device
);
1696 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1700 if (!bdrv_is_inserted(bs
)) {
1701 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1706 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1709 drv
= bdrv_find_format(format
);
1711 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1716 if (bdrv_in_use(bs
)) {
1717 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1721 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1723 /* See if we have a backing HD we can use to create our new image
1725 if (sync
== MIRROR_SYNC_MODE_TOP
) {
1726 source
= bs
->backing_hd
;
1728 sync
= MIRROR_SYNC_MODE_FULL
;
1731 if (sync
== MIRROR_SYNC_MODE_NONE
) {
1735 size
= bdrv_getlength(bs
);
1737 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1741 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1742 assert(format
&& drv
);
1744 bdrv_img_create(target
, format
, source
->filename
,
1745 source
->drv
->format_name
, NULL
,
1746 size
, flags
, &local_err
, false);
1748 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
1749 size
, flags
, &local_err
, false);
1753 if (error_is_set(&local_err
)) {
1754 error_propagate(errp
, local_err
);
1758 target_bs
= bdrv_new("");
1759 ret
= bdrv_open(target_bs
, target
, NULL
, flags
, drv
);
1761 bdrv_unref(target_bs
);
1762 error_setg_file_open(errp
, -ret
, target
);
1766 backup_start(bs
, target_bs
, speed
, sync
, on_source_error
, on_target_error
,
1767 block_job_cb
, bs
, &local_err
);
1768 if (local_err
!= NULL
) {
1769 bdrv_unref(target_bs
);
1770 error_propagate(errp
, local_err
);
1775 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1777 void qmp_drive_mirror(const char *device
, const char *target
,
1778 bool has_format
, const char *format
,
1779 enum MirrorSyncMode sync
,
1780 bool has_mode
, enum NewImageMode mode
,
1781 bool has_speed
, int64_t speed
,
1782 bool has_granularity
, uint32_t granularity
,
1783 bool has_buf_size
, int64_t buf_size
,
1784 bool has_on_source_error
, BlockdevOnError on_source_error
,
1785 bool has_on_target_error
, BlockdevOnError on_target_error
,
1788 BlockDriverState
*bs
;
1789 BlockDriverState
*source
, *target_bs
;
1790 BlockDriver
*drv
= NULL
;
1791 Error
*local_err
= NULL
;
1799 if (!has_on_source_error
) {
1800 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1802 if (!has_on_target_error
) {
1803 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1806 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1808 if (!has_granularity
) {
1811 if (!has_buf_size
) {
1812 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1815 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
1816 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1819 if (granularity
& (granularity
- 1)) {
1820 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1824 bs
= bdrv_find(device
);
1826 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1830 if (!bdrv_is_inserted(bs
)) {
1831 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1836 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1839 drv
= bdrv_find_format(format
);
1841 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1846 if (bdrv_in_use(bs
)) {
1847 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1851 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1852 source
= bs
->backing_hd
;
1853 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
1854 sync
= MIRROR_SYNC_MODE_FULL
;
1857 size
= bdrv_getlength(bs
);
1859 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1863 if (sync
== MIRROR_SYNC_MODE_FULL
&& mode
!= NEW_IMAGE_MODE_EXISTING
) {
1864 /* create new image w/o backing file */
1865 assert(format
&& drv
);
1866 bdrv_img_create(target
, format
,
1867 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
1870 case NEW_IMAGE_MODE_EXISTING
:
1873 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
1874 /* create new image with backing file */
1875 bdrv_img_create(target
, format
,
1877 source
->drv
->format_name
,
1878 NULL
, size
, flags
, &local_err
, false);
1885 if (error_is_set(&local_err
)) {
1886 error_propagate(errp
, local_err
);
1890 /* Mirroring takes care of copy-on-write using the source's backing
1893 target_bs
= bdrv_new("");
1894 ret
= bdrv_open(target_bs
, target
, NULL
, flags
| BDRV_O_NO_BACKING
, drv
);
1896 bdrv_unref(target_bs
);
1897 error_setg_file_open(errp
, -ret
, target
);
1901 mirror_start(bs
, target_bs
, speed
, granularity
, buf_size
, sync
,
1902 on_source_error
, on_target_error
,
1903 block_job_cb
, bs
, &local_err
);
1904 if (local_err
!= NULL
) {
1905 bdrv_unref(target_bs
);
1906 error_propagate(errp
, local_err
);
1911 static BlockJob
*find_block_job(const char *device
)
1913 BlockDriverState
*bs
;
1915 bs
= bdrv_find(device
);
1916 if (!bs
|| !bs
->job
) {
1922 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
1924 BlockJob
*job
= find_block_job(device
);
1927 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1931 block_job_set_speed(job
, speed
, errp
);
1934 void qmp_block_job_cancel(const char *device
,
1935 bool has_force
, bool force
, Error
**errp
)
1937 BlockJob
*job
= find_block_job(device
);
1944 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1947 if (job
->paused
&& !force
) {
1948 error_set(errp
, QERR_BLOCK_JOB_PAUSED
, device
);
1952 trace_qmp_block_job_cancel(job
);
1953 block_job_cancel(job
);
1956 void qmp_block_job_pause(const char *device
, Error
**errp
)
1958 BlockJob
*job
= find_block_job(device
);
1961 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1965 trace_qmp_block_job_pause(job
);
1966 block_job_pause(job
);
1969 void qmp_block_job_resume(const char *device
, Error
**errp
)
1971 BlockJob
*job
= find_block_job(device
);
1974 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1978 trace_qmp_block_job_resume(job
);
1979 block_job_resume(job
);
1982 void qmp_block_job_complete(const char *device
, Error
**errp
)
1984 BlockJob
*job
= find_block_job(device
);
1987 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1991 trace_qmp_block_job_complete(job
);
1992 block_job_complete(job
, errp
);
1995 static void do_qmp_query_block_jobs_one(void *opaque
, BlockDriverState
*bs
)
1997 BlockJobInfoList
**prev
= opaque
;
1998 BlockJob
*job
= bs
->job
;
2001 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
2002 elem
->value
= block_job_query(bs
->job
);
2003 (*prev
)->next
= elem
;
2008 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
2010 /* Dummy is a fake list element for holding the head pointer */
2011 BlockJobInfoList dummy
= {};
2012 BlockJobInfoList
*prev
= &dummy
;
2013 bdrv_iterate(do_qmp_query_block_jobs_one
, &prev
);
2017 QemuOptsList qemu_common_drive_opts
= {
2019 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
2023 .type
= QEMU_OPT_NUMBER
,
2024 .help
= "bus number",
2027 .type
= QEMU_OPT_NUMBER
,
2028 .help
= "unit number (i.e. lun for scsi)",
2031 .type
= QEMU_OPT_STRING
,
2032 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2035 .type
= QEMU_OPT_NUMBER
,
2036 .help
= "index number",
2039 .type
= QEMU_OPT_NUMBER
,
2040 .help
= "number of cylinders (ide disk geometry)",
2043 .type
= QEMU_OPT_NUMBER
,
2044 .help
= "number of heads (ide disk geometry)",
2047 .type
= QEMU_OPT_NUMBER
,
2048 .help
= "number of sectors (ide disk geometry)",
2051 .type
= QEMU_OPT_STRING
,
2052 .help
= "chs translation (auto, lba. none)",
2055 .type
= QEMU_OPT_STRING
,
2056 .help
= "media type (disk, cdrom)",
2059 .type
= QEMU_OPT_BOOL
,
2060 .help
= "enable/disable snapshot mode",
2063 .type
= QEMU_OPT_STRING
,
2064 .help
= "disk image",
2067 .type
= QEMU_OPT_STRING
,
2068 .help
= "discard operation (ignore/off, unmap/on)",
2070 .name
= "cache.writeback",
2071 .type
= QEMU_OPT_BOOL
,
2072 .help
= "enables writeback mode for any caches",
2074 .name
= "cache.direct",
2075 .type
= QEMU_OPT_BOOL
,
2076 .help
= "enables use of O_DIRECT (bypass the host page cache)",
2078 .name
= "cache.no-flush",
2079 .type
= QEMU_OPT_BOOL
,
2080 .help
= "ignore any flush requests for the device",
2083 .type
= QEMU_OPT_STRING
,
2084 .help
= "host AIO implementation (threads, native)",
2087 .type
= QEMU_OPT_STRING
,
2088 .help
= "disk format (raw, qcow2, ...)",
2091 .type
= QEMU_OPT_STRING
,
2092 .help
= "disk serial number",
2095 .type
= QEMU_OPT_STRING
,
2096 .help
= "read error action",
2099 .type
= QEMU_OPT_STRING
,
2100 .help
= "write error action",
2103 .type
= QEMU_OPT_STRING
,
2104 .help
= "pci address (virtio only)",
2106 .name
= "read-only",
2107 .type
= QEMU_OPT_BOOL
,
2108 .help
= "open drive file as read-only",
2110 .name
= "throttling.iops-total",
2111 .type
= QEMU_OPT_NUMBER
,
2112 .help
= "limit total I/O operations per second",
2114 .name
= "throttling.iops-read",
2115 .type
= QEMU_OPT_NUMBER
,
2116 .help
= "limit read operations per second",
2118 .name
= "throttling.iops-write",
2119 .type
= QEMU_OPT_NUMBER
,
2120 .help
= "limit write operations per second",
2122 .name
= "throttling.bps-total",
2123 .type
= QEMU_OPT_NUMBER
,
2124 .help
= "limit total bytes per second",
2126 .name
= "throttling.bps-read",
2127 .type
= QEMU_OPT_NUMBER
,
2128 .help
= "limit read bytes per second",
2130 .name
= "throttling.bps-write",
2131 .type
= QEMU_OPT_NUMBER
,
2132 .help
= "limit write bytes per second",
2134 .name
= "throttling.iops-total-max",
2135 .type
= QEMU_OPT_NUMBER
,
2136 .help
= "I/O operations burst",
2138 .name
= "throttling.iops-read-max",
2139 .type
= QEMU_OPT_NUMBER
,
2140 .help
= "I/O operations read burst",
2142 .name
= "throttling.iops-write-max",
2143 .type
= QEMU_OPT_NUMBER
,
2144 .help
= "I/O operations write burst",
2146 .name
= "throttling.bps-total-max",
2147 .type
= QEMU_OPT_NUMBER
,
2148 .help
= "total bytes burst",
2150 .name
= "throttling.bps-read-max",
2151 .type
= QEMU_OPT_NUMBER
,
2152 .help
= "total bytes read burst",
2154 .name
= "throttling.bps-write-max",
2155 .type
= QEMU_OPT_NUMBER
,
2156 .help
= "total bytes write burst",
2158 .name
= "throttling.iops-size",
2159 .type
= QEMU_OPT_NUMBER
,
2160 .help
= "when limiting by iops max size of an I/O in bytes",
2162 .name
= "copy-on-read",
2163 .type
= QEMU_OPT_BOOL
,
2164 .help
= "copy read data from backing file into image file",
2167 .type
= QEMU_OPT_BOOL
,
2168 .help
= "(deprecated, ignored)",
2170 { /* end of list */ }
2174 QemuOptsList qemu_drive_opts
= {
2176 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
2179 * no elements => accept any params
2180 * validation will happen later
2182 { /* end of list */ }