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/block-backend.h"
34 #include "sysemu/blockdev.h"
35 #include "hw/block/block.h"
36 #include "block/blockjob.h"
37 #include "block/throttle-groups.h"
38 #include "monitor/monitor.h"
39 #include "qemu/option.h"
40 #include "qemu/config-file.h"
41 #include "qapi/qmp/types.h"
42 #include "qapi-visit.h"
43 #include "qapi/qmp-output-visitor.h"
44 #include "qapi/util.h"
45 #include "sysemu/sysemu.h"
46 #include "block/block_int.h"
47 #include "qmp-commands.h"
49 #include "sysemu/arch_init.h"
51 static const char *const if_name
[IF_COUNT
] = {
55 [IF_FLOPPY
] = "floppy",
56 [IF_PFLASH
] = "pflash",
59 [IF_VIRTIO
] = "virtio",
63 static int if_max_devs
[IF_COUNT
] = {
65 * Do not change these numbers! They govern how drive option
66 * index maps to unit and bus. That mapping is ABI.
68 * All controllers used to imlement if=T drives need to support
69 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
70 * Otherwise, some index values map to "impossible" bus, unit
73 * For instance, if you change [IF_SCSI] to 255, -drive
74 * if=scsi,index=12 no longer means bus=1,unit=5, but
75 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
76 * the drive can't be set up. Regression.
83 * Boards may call this to offer board-by-board overrides
84 * of the default, global values.
86 void override_max_devs(BlockInterfaceType type
, int max_devs
)
95 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
96 dinfo
= blk_legacy_dinfo(blk
);
97 if (dinfo
->type
== type
) {
98 fprintf(stderr
, "Cannot override units-per-bus property of"
99 " the %s interface, because a drive of that type has"
100 " already been added.\n", if_name
[type
]);
101 g_assert_not_reached();
105 if_max_devs
[type
] = max_devs
;
109 * We automatically delete the drive when a device using it gets
110 * unplugged. Questionable feature, but we can't just drop it.
111 * Device models call blockdev_mark_auto_del() to schedule the
112 * automatic deletion, and generic qdev code calls blockdev_auto_del()
113 * when deletion is actually safe.
115 void blockdev_mark_auto_del(BlockBackend
*blk
)
117 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
118 BlockDriverState
*bs
= blk_bs(blk
);
119 AioContext
*aio_context
;
125 aio_context
= bdrv_get_aio_context(bs
);
126 aio_context_acquire(aio_context
);
129 block_job_cancel(bs
->job
);
132 aio_context_release(aio_context
);
137 void blockdev_auto_del(BlockBackend
*blk
)
139 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
141 if (dinfo
&& dinfo
->auto_del
) {
147 * Returns the current mapping of how many units per bus
148 * a particular interface can support.
150 * A positive integer indicates n units per bus.
151 * 0 implies the mapping has not been established.
152 * -1 indicates an invalid BlockInterfaceType was given.
154 int drive_get_max_devs(BlockInterfaceType type
)
156 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
157 return if_max_devs
[type
];
163 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
165 int max_devs
= if_max_devs
[type
];
166 return max_devs
? index
/ max_devs
: 0;
169 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
171 int max_devs
= if_max_devs
[type
];
172 return max_devs
? index
% max_devs
: index
;
175 QemuOpts
*drive_def(const char *optstr
)
177 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
180 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
185 opts
= drive_def(optstr
);
189 if (type
!= IF_DEFAULT
) {
190 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
193 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
196 qemu_opt_set(opts
, "file", file
, &error_abort
);
200 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
205 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
206 dinfo
= blk_legacy_dinfo(blk
);
207 if (dinfo
&& dinfo
->type
== type
208 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
216 bool drive_check_orphaned(void)
222 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
223 dinfo
= blk_legacy_dinfo(blk
);
224 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
225 /* Unless this is a default drive, this may be an oversight. */
226 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
227 dinfo
->type
!= IF_NONE
) {
228 fprintf(stderr
, "Warning: Orphaned drive without device: "
229 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
230 blk_name(blk
), blk_bs(blk
)->filename
, if_name
[dinfo
->type
],
231 dinfo
->bus
, dinfo
->unit
);
239 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
241 return drive_get(type
,
242 drive_index_to_bus_id(type
, index
),
243 drive_index_to_unit_id(type
, index
));
246 int drive_get_max_bus(BlockInterfaceType type
)
253 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
254 dinfo
= blk_legacy_dinfo(blk
);
255 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
256 max_bus
= dinfo
->bus
;
262 /* Get a block device. This should only be used for single-drive devices
263 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
265 DriveInfo
*drive_get_next(BlockInterfaceType type
)
267 static int next_block_unit
[IF_COUNT
];
269 return drive_get(type
, 0, next_block_unit
[type
]++);
272 static void bdrv_format_print(void *opaque
, const char *name
)
274 error_printf(" %s", name
);
279 BlockDriverState
*bs
;
282 static void bdrv_put_ref_bh(void *opaque
)
284 BDRVPutRefBH
*s
= opaque
;
287 qemu_bh_delete(s
->bh
);
292 * Release a BDS reference in a BH
294 * It is not safe to use bdrv_unref() from a callback function when the callers
295 * still need the BlockDriverState. In such cases we schedule a BH to release
298 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
302 s
= g_new(BDRVPutRefBH
, 1);
303 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
305 qemu_bh_schedule(s
->bh
);
308 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
310 if (!strcmp(buf
, "ignore")) {
311 return BLOCKDEV_ON_ERROR_IGNORE
;
312 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
313 return BLOCKDEV_ON_ERROR_ENOSPC
;
314 } else if (!strcmp(buf
, "stop")) {
315 return BLOCKDEV_ON_ERROR_STOP
;
316 } else if (!strcmp(buf
, "report")) {
317 return BLOCKDEV_ON_ERROR_REPORT
;
319 error_setg(errp
, "'%s' invalid %s error action",
320 buf
, is_read
? "read" : "write");
325 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
327 if (throttle_conflicting(cfg
)) {
328 error_setg(errp
, "bps/iops/max total values and read/write values"
329 " cannot be used at the same time");
333 if (!throttle_is_valid(cfg
)) {
334 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
341 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
343 /* Takes the ownership of bs_opts */
344 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
350 int on_read_error
, on_write_error
;
352 BlockDriverState
*bs
;
359 bool has_driver_specific_opts
;
360 BlockdevDetectZeroesOptions detect_zeroes
;
361 const char *throttling_group
;
363 /* Check common options by copying from bs_opts to opts, all other options
364 * stay in bs_opts for processing by bdrv_open(). */
365 id
= qdict_get_try_str(bs_opts
, "id");
366 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
368 error_propagate(errp
, error
);
372 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
374 error_propagate(errp
, error
);
379 qdict_del(bs_opts
, "id");
382 has_driver_specific_opts
= !!qdict_size(bs_opts
);
384 /* extract parameters */
385 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
386 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
387 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
389 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
390 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
391 error_setg(errp
, "invalid discard option");
396 if (qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true)) {
397 bdrv_flags
|= BDRV_O_CACHE_WB
;
399 if (qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_DIRECT
, false)) {
400 bdrv_flags
|= BDRV_O_NOCACHE
;
402 if (qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_NO_FLUSH
, false)) {
403 bdrv_flags
|= BDRV_O_NO_FLUSH
;
406 #ifdef CONFIG_LINUX_AIO
407 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
408 if (!strcmp(buf
, "native")) {
409 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
410 } else if (!strcmp(buf
, "threads")) {
411 /* this is the default */
413 error_setg(errp
, "invalid aio option");
419 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
420 if (is_help_option(buf
)) {
421 error_printf("Supported formats:");
422 bdrv_iterate_format(bdrv_format_print
, NULL
);
427 if (qdict_haskey(bs_opts
, "driver")) {
428 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
431 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
434 /* disk I/O throttling */
435 memset(&cfg
, 0, sizeof(cfg
));
436 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
437 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
438 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
439 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
440 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
441 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
442 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
443 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
444 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
445 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
446 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
447 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
449 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
450 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
451 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
452 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
453 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
454 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
455 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
456 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
457 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
458 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
459 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
460 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
462 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
464 throttling_group
= qemu_opt_get(opts
, "throttling.group");
466 if (!check_throttle_config(&cfg
, &error
)) {
467 error_propagate(errp
, error
);
471 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
472 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
473 on_write_error
= parse_block_error_action(buf
, 0, &error
);
475 error_propagate(errp
, error
);
480 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
481 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
482 on_read_error
= parse_block_error_action(buf
, 1, &error
);
484 error_propagate(errp
, error
);
490 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
491 qemu_opt_get(opts
, "detect-zeroes"),
492 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX
,
493 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
496 error_propagate(errp
, error
);
500 if (detect_zeroes
== BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP
&&
501 !(bdrv_flags
& BDRV_O_UNMAP
)) {
502 error_setg(errp
, "setting detect-zeroes to unmap is not allowed "
503 "without setting discard operation to unmap");
508 if ((!file
|| !*file
) && !has_driver_specific_opts
) {
509 blk
= blk_new_with_bs(qemu_opts_id(opts
), errp
);
515 bs
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
520 if (file
&& !*file
) {
525 /* always use cache=unsafe with snapshot */
526 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
527 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
531 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
534 if (runstate_check(RUN_STATE_INMIGRATE
)) {
535 bdrv_flags
|= BDRV_O_INCOMING
;
538 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
540 blk
= blk_new_open(qemu_opts_id(opts
), file
, NULL
, bs_opts
, bdrv_flags
,
548 bs
->detect_zeroes
= detect_zeroes
;
550 bdrv_set_on_error(bs
, on_read_error
, on_write_error
);
552 /* disk I/O throttling */
553 if (throttle_enabled(&cfg
)) {
554 if (!throttling_group
) {
555 throttling_group
= blk_name(blk
);
557 bdrv_io_limits_enable(bs
, throttling_group
);
558 bdrv_set_io_limits(bs
, &cfg
);
561 if (bdrv_key_required(bs
)) {
576 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
581 value
= qemu_opt_get(opts
, from
);
583 if (qemu_opt_find(opts
, to
)) {
584 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
585 "same time", to
, from
);
590 /* rename all items in opts */
591 while ((value
= qemu_opt_get(opts
, from
))) {
592 qemu_opt_set(opts
, to
, value
, &error_abort
);
593 qemu_opt_unset(opts
, from
);
597 QemuOptsList qemu_legacy_drive_opts
= {
599 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
603 .type
= QEMU_OPT_NUMBER
,
604 .help
= "bus number",
607 .type
= QEMU_OPT_NUMBER
,
608 .help
= "unit number (i.e. lun for scsi)",
611 .type
= QEMU_OPT_NUMBER
,
612 .help
= "index number",
615 .type
= QEMU_OPT_STRING
,
616 .help
= "media type (disk, cdrom)",
619 .type
= QEMU_OPT_STRING
,
620 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
623 .type
= QEMU_OPT_NUMBER
,
624 .help
= "number of cylinders (ide disk geometry)",
627 .type
= QEMU_OPT_NUMBER
,
628 .help
= "number of heads (ide disk geometry)",
631 .type
= QEMU_OPT_NUMBER
,
632 .help
= "number of sectors (ide disk geometry)",
635 .type
= QEMU_OPT_STRING
,
636 .help
= "chs translation (auto, lba, none)",
639 .type
= QEMU_OPT_BOOL
,
640 .help
= "(deprecated, ignored)",
643 .type
= QEMU_OPT_STRING
,
644 .help
= "pci address (virtio only)",
647 .type
= QEMU_OPT_STRING
,
648 .help
= "disk serial number",
651 .type
= QEMU_OPT_STRING
,
655 /* Options that are passed on, but have special semantics with -drive */
658 .type
= QEMU_OPT_BOOL
,
659 .help
= "open drive file as read-only",
662 .type
= QEMU_OPT_STRING
,
663 .help
= "read error action",
666 .type
= QEMU_OPT_STRING
,
667 .help
= "write error action",
669 .name
= "copy-on-read",
670 .type
= QEMU_OPT_BOOL
,
671 .help
= "copy read data from backing file into image file",
674 { /* end of list */ }
678 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
682 DriveInfo
*dinfo
= NULL
;
684 QemuOpts
*legacy_opts
;
685 DriveMediaType media
= MEDIA_DISK
;
686 BlockInterfaceType type
;
687 int cyls
, heads
, secs
, translation
;
688 int max_devs
, bus_id
, unit_id
, index
;
690 const char *werror
, *rerror
;
691 bool read_only
= false;
694 const char *filename
;
695 Error
*local_err
= NULL
;
698 /* Change legacy command line options into QMP ones */
699 static const struct {
703 { "iops", "throttling.iops-total" },
704 { "iops_rd", "throttling.iops-read" },
705 { "iops_wr", "throttling.iops-write" },
707 { "bps", "throttling.bps-total" },
708 { "bps_rd", "throttling.bps-read" },
709 { "bps_wr", "throttling.bps-write" },
711 { "iops_max", "throttling.iops-total-max" },
712 { "iops_rd_max", "throttling.iops-read-max" },
713 { "iops_wr_max", "throttling.iops-write-max" },
715 { "bps_max", "throttling.bps-total-max" },
716 { "bps_rd_max", "throttling.bps-read-max" },
717 { "bps_wr_max", "throttling.bps-write-max" },
719 { "iops_size", "throttling.iops-size" },
721 { "group", "throttling.group" },
723 { "readonly", "read-only" },
726 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
727 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
730 error_report_err(local_err
);
735 value
= qemu_opt_get(all_opts
, "cache");
739 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
740 error_report("invalid cache option");
744 /* Specific options take precedence */
745 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
746 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
747 !!(flags
& BDRV_O_CACHE_WB
), &error_abort
);
749 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
750 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
751 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
753 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
754 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
755 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
757 qemu_opt_unset(all_opts
, "cache");
760 /* Get a QDict for processing the options */
761 bs_opts
= qdict_new();
762 qemu_opts_to_qdict(all_opts
, bs_opts
);
764 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
766 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
768 error_report_err(local_err
);
772 /* Deprecated option boot=[on|off] */
773 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
774 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
775 "ignored. Future versions will reject this parameter. Please "
776 "update your scripts.\n");
780 value
= qemu_opt_get(legacy_opts
, "media");
782 if (!strcmp(value
, "disk")) {
784 } else if (!strcmp(value
, "cdrom")) {
788 error_report("'%s' invalid media", value
);
793 /* copy-on-read is disabled with a warning for read-only devices */
794 read_only
|= qemu_opt_get_bool(legacy_opts
, "read-only", false);
795 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
797 if (read_only
&& copy_on_read
) {
798 error_report("warning: disabling copy-on-read on read-only drive");
799 copy_on_read
= false;
802 qdict_put(bs_opts
, "read-only",
803 qstring_from_str(read_only
? "on" : "off"));
804 qdict_put(bs_opts
, "copy-on-read",
805 qstring_from_str(copy_on_read
? "on" :"off"));
807 /* Controller type */
808 value
= qemu_opt_get(legacy_opts
, "if");
811 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
814 if (type
== IF_COUNT
) {
815 error_report("unsupported bus type '%s'", value
);
819 type
= block_default_type
;
823 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
824 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
825 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
827 if (cyls
|| heads
|| secs
) {
829 error_report("invalid physical cyls number");
833 error_report("invalid physical heads number");
837 error_report("invalid physical secs number");
842 translation
= BIOS_ATA_TRANSLATION_AUTO
;
843 value
= qemu_opt_get(legacy_opts
, "trans");
846 error_report("'%s' trans must be used with cyls, heads and secs",
850 if (!strcmp(value
, "none")) {
851 translation
= BIOS_ATA_TRANSLATION_NONE
;
852 } else if (!strcmp(value
, "lba")) {
853 translation
= BIOS_ATA_TRANSLATION_LBA
;
854 } else if (!strcmp(value
, "large")) {
855 translation
= BIOS_ATA_TRANSLATION_LARGE
;
856 } else if (!strcmp(value
, "rechs")) {
857 translation
= BIOS_ATA_TRANSLATION_RECHS
;
858 } else if (!strcmp(value
, "auto")) {
859 translation
= BIOS_ATA_TRANSLATION_AUTO
;
861 error_report("'%s' invalid translation type", value
);
866 if (media
== MEDIA_CDROM
) {
867 if (cyls
|| secs
|| heads
) {
868 error_report("CHS can't be set with media=cdrom");
873 /* Device address specified by bus/unit or index.
874 * If none was specified, try to find the first free one. */
875 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
876 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
877 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
879 max_devs
= if_max_devs
[type
];
882 if (bus_id
!= 0 || unit_id
!= -1) {
883 error_report("index cannot be used with bus and unit");
886 bus_id
= drive_index_to_bus_id(type
, index
);
887 unit_id
= drive_index_to_unit_id(type
, index
);
892 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
894 if (max_devs
&& unit_id
>= max_devs
) {
901 if (max_devs
&& unit_id
>= max_devs
) {
902 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
906 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
907 error_report("drive with bus=%d, unit=%d (index=%d) exists",
908 bus_id
, unit_id
, index
);
913 serial
= qemu_opt_get(legacy_opts
, "serial");
915 /* no id supplied -> create one */
916 if (qemu_opts_id(all_opts
) == NULL
) {
918 const char *mediastr
= "";
919 if (type
== IF_IDE
|| type
== IF_SCSI
) {
920 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
923 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
926 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
929 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
933 /* Add virtio block device */
934 devaddr
= qemu_opt_get(legacy_opts
, "addr");
935 if (devaddr
&& type
!= IF_VIRTIO
) {
936 error_report("addr is not supported by this bus type");
940 if (type
== IF_VIRTIO
) {
942 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
944 if (arch_type
== QEMU_ARCH_S390X
) {
945 qemu_opt_set(devopts
, "driver", "virtio-blk-s390", &error_abort
);
947 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
949 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
952 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
956 filename
= qemu_opt_get(legacy_opts
, "file");
958 /* Check werror/rerror compatibility with if=... */
959 werror
= qemu_opt_get(legacy_opts
, "werror");
960 if (werror
!= NULL
) {
961 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
963 error_report("werror is not supported by this bus type");
966 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
969 rerror
= qemu_opt_get(legacy_opts
, "rerror");
970 if (rerror
!= NULL
) {
971 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
973 error_report("rerror is not supported by this bus type");
976 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
979 /* Actual block device init: Functionality shared with blockdev-add */
980 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
984 error_report_err(local_err
);
991 /* Create legacy DriveInfo */
992 dinfo
= g_malloc0(sizeof(*dinfo
));
993 dinfo
->opts
= all_opts
;
996 dinfo
->heads
= heads
;
998 dinfo
->trans
= translation
;
1001 dinfo
->bus
= bus_id
;
1002 dinfo
->unit
= unit_id
;
1003 dinfo
->devaddr
= devaddr
;
1004 dinfo
->serial
= g_strdup(serial
);
1006 blk_set_legacy_dinfo(blk
, dinfo
);
1013 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1020 qemu_opts_del(legacy_opts
);
1025 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1027 const char *device
= qdict_get_str(qdict
, "device");
1031 if (!strcmp(device
, "all")) {
1032 ret
= bdrv_commit_all();
1034 blk
= blk_by_name(device
);
1036 monitor_printf(mon
, "Device '%s' not found\n", device
);
1039 ret
= bdrv_commit(blk_bs(blk
));
1042 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1047 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
1049 TransactionAction action
;
1050 TransactionActionList list
;
1054 list
.value
= &action
;
1056 qmp_transaction(&list
, errp
);
1059 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1060 bool has_node_name
, const char *node_name
,
1061 const char *snapshot_file
,
1062 bool has_snapshot_node_name
,
1063 const char *snapshot_node_name
,
1064 bool has_format
, const char *format
,
1065 bool has_mode
, NewImageMode mode
, Error
**errp
)
1067 BlockdevSnapshot snapshot
= {
1068 .has_device
= has_device
,
1069 .device
= (char *) device
,
1070 .has_node_name
= has_node_name
,
1071 .node_name
= (char *) node_name
,
1072 .snapshot_file
= (char *) snapshot_file
,
1073 .has_snapshot_node_name
= has_snapshot_node_name
,
1074 .snapshot_node_name
= (char *) snapshot_node_name
,
1075 .has_format
= has_format
,
1076 .format
= (char *) format
,
1077 .has_mode
= has_mode
,
1080 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1084 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1088 BlockdevSnapshotInternal snapshot
= {
1089 .device
= (char *) device
,
1090 .name
= (char *) name
1093 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1097 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1104 BlockDriverState
*bs
;
1106 AioContext
*aio_context
;
1107 QEMUSnapshotInfo sn
;
1108 Error
*local_err
= NULL
;
1109 SnapshotInfo
*info
= NULL
;
1112 blk
= blk_by_name(device
);
1114 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1128 error_setg(errp
, "Name or id must be provided");
1132 aio_context
= bdrv_get_aio_context(bs
);
1133 aio_context_acquire(aio_context
);
1135 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1136 goto out_aio_context
;
1139 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1141 error_propagate(errp
, local_err
);
1142 goto out_aio_context
;
1146 "Snapshot with id '%s' and name '%s' does not exist on "
1148 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1149 goto out_aio_context
;
1152 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1154 error_propagate(errp
, local_err
);
1155 goto out_aio_context
;
1158 aio_context_release(aio_context
);
1160 info
= g_new0(SnapshotInfo
, 1);
1161 info
->id
= g_strdup(sn
.id_str
);
1162 info
->name
= g_strdup(sn
.name
);
1163 info
->date_nsec
= sn
.date_nsec
;
1164 info
->date_sec
= sn
.date_sec
;
1165 info
->vm_state_size
= sn
.vm_state_size
;
1166 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1167 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1172 aio_context_release(aio_context
);
1177 * block_dirty_bitmap_lookup:
1178 * Return a dirty bitmap (if present), after validating
1179 * the node reference and bitmap names.
1181 * @node: The name of the BDS node to search for bitmaps
1182 * @name: The name of the bitmap to search for
1183 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1184 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1185 * @errp: Output pointer for error information. Can be NULL.
1187 * @return: A bitmap object on success, or NULL on failure.
1189 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1191 BlockDriverState
**pbs
,
1195 BlockDriverState
*bs
;
1196 BdrvDirtyBitmap
*bitmap
;
1197 AioContext
*aio_context
;
1200 error_setg(errp
, "Node cannot be NULL");
1204 error_setg(errp
, "Bitmap name cannot be NULL");
1207 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1209 error_setg(errp
, "Node '%s' not found", node
);
1213 aio_context
= bdrv_get_aio_context(bs
);
1214 aio_context_acquire(aio_context
);
1216 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1218 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1226 *paio
= aio_context
;
1228 aio_context_release(aio_context
);
1234 aio_context_release(aio_context
);
1238 /* New and old BlockDriverState structs for atomic group operations */
1240 typedef struct BlkTransactionState BlkTransactionState
;
1242 /* Only prepare() may fail. In a single transaction, only one of commit() or
1243 abort() will be called, clean() will always be called if it present. */
1244 typedef struct BdrvActionOps
{
1245 /* Size of state struct, in bytes. */
1246 size_t instance_size
;
1247 /* Prepare the work, must NOT be NULL. */
1248 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
1249 /* Commit the changes, can be NULL. */
1250 void (*commit
)(BlkTransactionState
*common
);
1251 /* Abort the changes on fail, can be NULL. */
1252 void (*abort
)(BlkTransactionState
*common
);
1253 /* Clean up resource in the end, can be NULL. */
1254 void (*clean
)(BlkTransactionState
*common
);
1258 * This structure must be arranged as first member in child type, assuming
1259 * that compiler will also arrange it to the same address with parent instance.
1260 * Later it will be used in free().
1262 struct BlkTransactionState
{
1263 TransactionAction
*action
;
1264 const BdrvActionOps
*ops
;
1265 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
1268 /* internal snapshot private data */
1269 typedef struct InternalSnapshotState
{
1270 BlkTransactionState common
;
1271 BlockDriverState
*bs
;
1272 AioContext
*aio_context
;
1273 QEMUSnapshotInfo sn
;
1274 } InternalSnapshotState
;
1276 static void internal_snapshot_prepare(BlkTransactionState
*common
,
1279 Error
*local_err
= NULL
;
1283 BlockDriverState
*bs
;
1284 QEMUSnapshotInfo old_sn
, *sn
;
1287 BlockdevSnapshotInternal
*internal
;
1288 InternalSnapshotState
*state
;
1291 g_assert(common
->action
->kind
==
1292 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1293 internal
= common
->action
->blockdev_snapshot_internal_sync
;
1294 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1296 /* 1. parse input */
1297 device
= internal
->device
;
1298 name
= internal
->name
;
1300 /* 2. check for validation */
1301 blk
= blk_by_name(device
);
1303 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1308 /* AioContext is released in .clean() */
1309 state
->aio_context
= bdrv_get_aio_context(bs
);
1310 aio_context_acquire(state
->aio_context
);
1312 if (!bdrv_is_inserted(bs
)) {
1313 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1317 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1321 if (bdrv_is_read_only(bs
)) {
1322 error_setg(errp
, "Device '%s' is read only", device
);
1326 if (!bdrv_can_snapshot(bs
)) {
1327 error_setg(errp
, "Block format '%s' used by device '%s' "
1328 "does not support internal snapshots",
1329 bs
->drv
->format_name
, device
);
1333 if (!strlen(name
)) {
1334 error_setg(errp
, "Name is empty");
1338 /* check whether a snapshot with name exist */
1339 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1342 error_propagate(errp
, local_err
);
1346 "Snapshot with name '%s' already exists on device '%s'",
1351 /* 3. take the snapshot */
1353 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1354 qemu_gettimeofday(&tv
);
1355 sn
->date_sec
= tv
.tv_sec
;
1356 sn
->date_nsec
= tv
.tv_usec
* 1000;
1357 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1359 ret1
= bdrv_snapshot_create(bs
, sn
);
1361 error_setg_errno(errp
, -ret1
,
1362 "Failed to create snapshot '%s' on device '%s'",
1367 /* 4. succeed, mark a snapshot is created */
1371 static void internal_snapshot_abort(BlkTransactionState
*common
)
1373 InternalSnapshotState
*state
=
1374 DO_UPCAST(InternalSnapshotState
, common
, common
);
1375 BlockDriverState
*bs
= state
->bs
;
1376 QEMUSnapshotInfo
*sn
= &state
->sn
;
1377 Error
*local_error
= NULL
;
1383 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1384 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1385 "device '%s' in abort: %s",
1388 bdrv_get_device_name(bs
),
1389 error_get_pretty(local_error
));
1390 error_free(local_error
);
1394 static void internal_snapshot_clean(BlkTransactionState
*common
)
1396 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1399 if (state
->aio_context
) {
1400 aio_context_release(state
->aio_context
);
1404 /* external snapshot private data */
1405 typedef struct ExternalSnapshotState
{
1406 BlkTransactionState common
;
1407 BlockDriverState
*old_bs
;
1408 BlockDriverState
*new_bs
;
1409 AioContext
*aio_context
;
1410 } ExternalSnapshotState
;
1412 static void external_snapshot_prepare(BlkTransactionState
*common
,
1417 QDict
*options
= NULL
;
1418 Error
*local_err
= NULL
;
1419 bool has_device
= false;
1421 bool has_node_name
= false;
1422 const char *node_name
;
1423 bool has_snapshot_node_name
= false;
1424 const char *snapshot_node_name
;
1425 const char *new_image_file
;
1426 const char *format
= "qcow2";
1427 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1428 ExternalSnapshotState
*state
=
1429 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1430 TransactionAction
*action
= common
->action
;
1432 /* get parameters */
1433 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1435 has_device
= action
->blockdev_snapshot_sync
->has_device
;
1436 device
= action
->blockdev_snapshot_sync
->device
;
1437 has_node_name
= action
->blockdev_snapshot_sync
->has_node_name
;
1438 node_name
= action
->blockdev_snapshot_sync
->node_name
;
1439 has_snapshot_node_name
=
1440 action
->blockdev_snapshot_sync
->has_snapshot_node_name
;
1441 snapshot_node_name
= action
->blockdev_snapshot_sync
->snapshot_node_name
;
1443 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1444 if (action
->blockdev_snapshot_sync
->has_format
) {
1445 format
= action
->blockdev_snapshot_sync
->format
;
1447 if (action
->blockdev_snapshot_sync
->has_mode
) {
1448 mode
= action
->blockdev_snapshot_sync
->mode
;
1451 /* start processing */
1452 drv
= bdrv_find_format(format
);
1454 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1458 state
->old_bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
1459 has_node_name
? node_name
: NULL
,
1462 error_propagate(errp
, local_err
);
1466 if (has_node_name
&& !has_snapshot_node_name
) {
1467 error_setg(errp
, "New snapshot node name missing");
1471 if (has_snapshot_node_name
&& bdrv_find_node(snapshot_node_name
)) {
1472 error_setg(errp
, "New snapshot node name already existing");
1476 /* Acquire AioContext now so any threads operating on old_bs stop */
1477 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1478 aio_context_acquire(state
->aio_context
);
1480 if (!bdrv_is_inserted(state
->old_bs
)) {
1481 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1485 if (bdrv_op_is_blocked(state
->old_bs
,
1486 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1490 if (!bdrv_is_read_only(state
->old_bs
)) {
1491 if (bdrv_flush(state
->old_bs
)) {
1492 error_set(errp
, QERR_IO_ERROR
);
1497 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1498 error_set(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1502 flags
= state
->old_bs
->open_flags
;
1504 /* create new image w/backing file */
1505 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1506 bdrv_img_create(new_image_file
, format
,
1507 state
->old_bs
->filename
,
1508 state
->old_bs
->drv
->format_name
,
1509 NULL
, -1, flags
, &local_err
, false);
1511 error_propagate(errp
, local_err
);
1516 if (has_snapshot_node_name
) {
1517 options
= qdict_new();
1518 qdict_put(options
, "node-name",
1519 qstring_from_str(snapshot_node_name
));
1522 /* TODO Inherit bs->options or only take explicit options with an
1523 * extended QMP command? */
1524 assert(state
->new_bs
== NULL
);
1525 ret
= bdrv_open(&state
->new_bs
, new_image_file
, NULL
, options
,
1526 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
1527 /* We will manually add the backing_hd field to the bs later */
1529 error_propagate(errp
, local_err
);
1533 static void external_snapshot_commit(BlkTransactionState
*common
)
1535 ExternalSnapshotState
*state
=
1536 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1538 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1540 /* This removes our old bs and adds the new bs */
1541 bdrv_append(state
->new_bs
, state
->old_bs
);
1542 /* We don't need (or want) to use the transactional
1543 * bdrv_reopen_multiple() across all the entries at once, because we
1544 * don't want to abort all of them if one of them fails the reopen */
1545 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
1548 aio_context_release(state
->aio_context
);
1551 static void external_snapshot_abort(BlkTransactionState
*common
)
1553 ExternalSnapshotState
*state
=
1554 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1555 if (state
->new_bs
) {
1556 bdrv_unref(state
->new_bs
);
1558 if (state
->aio_context
) {
1559 aio_context_release(state
->aio_context
);
1563 typedef struct DriveBackupState
{
1564 BlkTransactionState common
;
1565 BlockDriverState
*bs
;
1566 AioContext
*aio_context
;
1570 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1572 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1573 BlockDriverState
*bs
;
1575 DriveBackup
*backup
;
1576 Error
*local_err
= NULL
;
1578 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1579 backup
= common
->action
->drive_backup
;
1581 blk
= blk_by_name(backup
->device
);
1583 error_set(errp
, QERR_DEVICE_NOT_FOUND
, backup
->device
);
1588 /* AioContext is released in .clean() */
1589 state
->aio_context
= bdrv_get_aio_context(bs
);
1590 aio_context_acquire(state
->aio_context
);
1592 qmp_drive_backup(backup
->device
, backup
->target
,
1593 backup
->has_format
, backup
->format
,
1595 backup
->has_mode
, backup
->mode
,
1596 backup
->has_speed
, backup
->speed
,
1597 backup
->has_bitmap
, backup
->bitmap
,
1598 backup
->has_on_source_error
, backup
->on_source_error
,
1599 backup
->has_on_target_error
, backup
->on_target_error
,
1602 error_propagate(errp
, local_err
);
1607 state
->job
= state
->bs
->job
;
1610 static void drive_backup_abort(BlkTransactionState
*common
)
1612 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1613 BlockDriverState
*bs
= state
->bs
;
1615 /* Only cancel if it's the job we started */
1616 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1617 block_job_cancel_sync(bs
->job
);
1621 static void drive_backup_clean(BlkTransactionState
*common
)
1623 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1625 if (state
->aio_context
) {
1626 aio_context_release(state
->aio_context
);
1630 typedef struct BlockdevBackupState
{
1631 BlkTransactionState common
;
1632 BlockDriverState
*bs
;
1634 AioContext
*aio_context
;
1635 } BlockdevBackupState
;
1637 static void blockdev_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1639 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1640 BlockdevBackup
*backup
;
1641 BlockDriverState
*bs
, *target
;
1643 Error
*local_err
= NULL
;
1645 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1646 backup
= common
->action
->blockdev_backup
;
1648 blk
= blk_by_name(backup
->device
);
1650 error_setg(errp
, "Device '%s' not found", backup
->device
);
1655 blk
= blk_by_name(backup
->target
);
1657 error_setg(errp
, "Device '%s' not found", backup
->target
);
1660 target
= blk_bs(blk
);
1662 /* AioContext is released in .clean() */
1663 state
->aio_context
= bdrv_get_aio_context(bs
);
1664 if (state
->aio_context
!= bdrv_get_aio_context(target
)) {
1665 state
->aio_context
= NULL
;
1666 error_setg(errp
, "Backup between two IO threads is not implemented");
1669 aio_context_acquire(state
->aio_context
);
1671 qmp_blockdev_backup(backup
->device
, backup
->target
,
1673 backup
->has_speed
, backup
->speed
,
1674 backup
->has_on_source_error
, backup
->on_source_error
,
1675 backup
->has_on_target_error
, backup
->on_target_error
,
1678 error_propagate(errp
, local_err
);
1683 state
->job
= state
->bs
->job
;
1686 static void blockdev_backup_abort(BlkTransactionState
*common
)
1688 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1689 BlockDriverState
*bs
= state
->bs
;
1691 /* Only cancel if it's the job we started */
1692 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1693 block_job_cancel_sync(bs
->job
);
1697 static void blockdev_backup_clean(BlkTransactionState
*common
)
1699 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1701 if (state
->aio_context
) {
1702 aio_context_release(state
->aio_context
);
1706 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1708 error_setg(errp
, "Transaction aborted using Abort action");
1711 static void abort_commit(BlkTransactionState
*common
)
1713 g_assert_not_reached(); /* this action never succeeds */
1716 static const BdrvActionOps actions
[] = {
1717 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1718 .instance_size
= sizeof(ExternalSnapshotState
),
1719 .prepare
= external_snapshot_prepare
,
1720 .commit
= external_snapshot_commit
,
1721 .abort
= external_snapshot_abort
,
1723 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1724 .instance_size
= sizeof(DriveBackupState
),
1725 .prepare
= drive_backup_prepare
,
1726 .abort
= drive_backup_abort
,
1727 .clean
= drive_backup_clean
,
1729 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
1730 .instance_size
= sizeof(BlockdevBackupState
),
1731 .prepare
= blockdev_backup_prepare
,
1732 .abort
= blockdev_backup_abort
,
1733 .clean
= blockdev_backup_clean
,
1735 [TRANSACTION_ACTION_KIND_ABORT
] = {
1736 .instance_size
= sizeof(BlkTransactionState
),
1737 .prepare
= abort_prepare
,
1738 .commit
= abort_commit
,
1740 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1741 .instance_size
= sizeof(InternalSnapshotState
),
1742 .prepare
= internal_snapshot_prepare
,
1743 .abort
= internal_snapshot_abort
,
1744 .clean
= internal_snapshot_clean
,
1749 * 'Atomic' group operations. The operations are performed as a set, and if
1750 * any fail then we roll back all operations in the group.
1752 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1754 TransactionActionList
*dev_entry
= dev_list
;
1755 BlkTransactionState
*state
, *next
;
1756 Error
*local_err
= NULL
;
1758 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1759 QSIMPLEQ_INIT(&snap_bdrv_states
);
1761 /* drain all i/o before any operations */
1764 /* We don't do anything in this loop that commits us to the operations */
1765 while (NULL
!= dev_entry
) {
1766 TransactionAction
*dev_info
= NULL
;
1767 const BdrvActionOps
*ops
;
1769 dev_info
= dev_entry
->value
;
1770 dev_entry
= dev_entry
->next
;
1772 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1774 ops
= &actions
[dev_info
->kind
];
1775 assert(ops
->instance_size
> 0);
1777 state
= g_malloc0(ops
->instance_size
);
1779 state
->action
= dev_info
;
1780 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1782 state
->ops
->prepare(state
, &local_err
);
1784 error_propagate(errp
, local_err
);
1785 goto delete_and_fail
;
1789 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1790 if (state
->ops
->commit
) {
1791 state
->ops
->commit(state
);
1799 /* failure, and it is all-or-none; roll back all operations */
1800 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1801 if (state
->ops
->abort
) {
1802 state
->ops
->abort(state
);
1806 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1807 if (state
->ops
->clean
) {
1808 state
->ops
->clean(state
);
1815 static void eject_device(BlockBackend
*blk
, int force
, Error
**errp
)
1817 BlockDriverState
*bs
= blk_bs(blk
);
1818 AioContext
*aio_context
;
1820 aio_context
= bdrv_get_aio_context(bs
);
1821 aio_context_acquire(aio_context
);
1823 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
1826 if (!blk_dev_has_removable_media(blk
)) {
1827 error_setg(errp
, "Device '%s' is not removable",
1828 bdrv_get_device_name(bs
));
1832 if (blk_dev_is_medium_locked(blk
) && !blk_dev_is_tray_open(blk
)) {
1833 blk_dev_eject_request(blk
, force
);
1835 error_setg(errp
, "Device '%s' is locked",
1836 bdrv_get_device_name(bs
));
1844 aio_context_release(aio_context
);
1847 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1851 blk
= blk_by_name(device
);
1853 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1857 eject_device(blk
, force
, errp
);
1860 void qmp_block_passwd(bool has_device
, const char *device
,
1861 bool has_node_name
, const char *node_name
,
1862 const char *password
, Error
**errp
)
1864 Error
*local_err
= NULL
;
1865 BlockDriverState
*bs
;
1866 AioContext
*aio_context
;
1868 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
1869 has_node_name
? node_name
: NULL
,
1872 error_propagate(errp
, local_err
);
1876 aio_context
= bdrv_get_aio_context(bs
);
1877 aio_context_acquire(aio_context
);
1879 bdrv_add_key(bs
, password
, errp
);
1881 aio_context_release(aio_context
);
1884 /* Assumes AioContext is held */
1885 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1886 int bdrv_flags
, BlockDriver
*drv
,
1887 const char *password
, Error
**errp
)
1889 Error
*local_err
= NULL
;
1892 ret
= bdrv_open(&bs
, filename
, NULL
, NULL
, bdrv_flags
, drv
, &local_err
);
1894 error_propagate(errp
, local_err
);
1898 bdrv_add_key(bs
, password
, errp
);
1901 void qmp_change_blockdev(const char *device
, const char *filename
,
1902 const char *format
, Error
**errp
)
1905 BlockDriverState
*bs
;
1906 AioContext
*aio_context
;
1907 BlockDriver
*drv
= NULL
;
1911 blk
= blk_by_name(device
);
1913 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1918 aio_context
= bdrv_get_aio_context(bs
);
1919 aio_context_acquire(aio_context
);
1922 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1924 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1929 eject_device(blk
, 0, &err
);
1931 error_propagate(errp
, err
);
1935 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1936 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1938 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1941 aio_context_release(aio_context
);
1944 /* throttling disk I/O limits */
1945 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1952 bool has_bps_rd_max
,
1954 bool has_bps_wr_max
,
1958 bool has_iops_rd_max
,
1959 int64_t iops_rd_max
,
1960 bool has_iops_wr_max
,
1961 int64_t iops_wr_max
,
1965 const char *group
, Error
**errp
)
1968 BlockDriverState
*bs
;
1970 AioContext
*aio_context
;
1972 blk
= blk_by_name(device
);
1974 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1979 memset(&cfg
, 0, sizeof(cfg
));
1980 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
1981 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
1982 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
1984 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
1985 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
1986 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
1989 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
1991 if (has_bps_rd_max
) {
1992 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
1994 if (has_bps_wr_max
) {
1995 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
1998 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
2000 if (has_iops_rd_max
) {
2001 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
2003 if (has_iops_wr_max
) {
2004 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
2007 if (has_iops_size
) {
2008 cfg
.op_size
= iops_size
;
2011 if (!check_throttle_config(&cfg
, errp
)) {
2015 aio_context
= bdrv_get_aio_context(bs
);
2016 aio_context_acquire(aio_context
);
2018 if (throttle_enabled(&cfg
)) {
2019 /* Enable I/O limits if they're not enabled yet, otherwise
2020 * just update the throttling group. */
2021 if (!bs
->io_limits_enabled
) {
2022 bdrv_io_limits_enable(bs
, has_group
? group
: device
);
2023 } else if (has_group
) {
2024 bdrv_io_limits_update_group(bs
, group
);
2026 /* Set the new throttling configuration */
2027 bdrv_set_io_limits(bs
, &cfg
);
2028 } else if (bs
->io_limits_enabled
) {
2029 /* If all throttling settings are set to 0, disable I/O limits */
2030 bdrv_io_limits_disable(bs
);
2033 aio_context_release(aio_context
);
2036 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2037 bool has_granularity
, uint32_t granularity
,
2040 AioContext
*aio_context
;
2041 BlockDriverState
*bs
;
2043 if (!name
|| name
[0] == '\0') {
2044 error_setg(errp
, "Bitmap name cannot be empty");
2048 bs
= bdrv_lookup_bs(node
, node
, errp
);
2053 aio_context
= bdrv_get_aio_context(bs
);
2054 aio_context_acquire(aio_context
);
2056 if (has_granularity
) {
2057 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2058 error_setg(errp
, "Granularity must be power of 2 "
2059 "and at least 512");
2063 /* Default to cluster size, if available: */
2064 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2067 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2070 aio_context_release(aio_context
);
2073 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2076 AioContext
*aio_context
;
2077 BlockDriverState
*bs
;
2078 BdrvDirtyBitmap
*bitmap
;
2080 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2081 if (!bitmap
|| !bs
) {
2085 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2087 "Bitmap '%s' is currently frozen and cannot be removed",
2091 bdrv_dirty_bitmap_make_anon(bitmap
);
2092 bdrv_release_dirty_bitmap(bs
, bitmap
);
2095 aio_context_release(aio_context
);
2099 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2100 * immediately after a full backup operation.
2102 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2105 AioContext
*aio_context
;
2106 BdrvDirtyBitmap
*bitmap
;
2107 BlockDriverState
*bs
;
2109 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2110 if (!bitmap
|| !bs
) {
2114 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2116 "Bitmap '%s' is currently frozen and cannot be modified",
2119 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2121 "Bitmap '%s' is currently disabled and cannot be cleared",
2126 bdrv_clear_dirty_bitmap(bitmap
);
2129 aio_context_release(aio_context
);
2132 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2134 const char *id
= qdict_get_str(qdict
, "id");
2136 BlockDriverState
*bs
;
2137 AioContext
*aio_context
;
2138 Error
*local_err
= NULL
;
2140 blk
= blk_by_name(id
);
2142 error_report("Device '%s' not found", id
);
2147 if (!blk_legacy_dinfo(blk
)) {
2148 error_report("Deleting device added with blockdev-add"
2149 " is not supported");
2153 aio_context
= bdrv_get_aio_context(bs
);
2154 aio_context_acquire(aio_context
);
2156 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2157 error_report_err(local_err
);
2158 aio_context_release(aio_context
);
2162 /* quiesce block driver; prevent further io */
2167 /* if we have a device attached to this BlockDriverState
2168 * then we need to make the drive anonymous until the device
2169 * can be removed. If this is a drive with no device backing
2170 * then we can just get rid of the block driver state right here.
2172 if (blk_get_attached_dev(blk
)) {
2173 blk_hide_on_behalf_of_hmp_drive_del(blk
);
2174 /* Further I/O must not pause the guest */
2175 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
2176 BLOCKDEV_ON_ERROR_REPORT
);
2181 aio_context_release(aio_context
);
2184 void qmp_block_resize(bool has_device
, const char *device
,
2185 bool has_node_name
, const char *node_name
,
2186 int64_t size
, Error
**errp
)
2188 Error
*local_err
= NULL
;
2189 BlockDriverState
*bs
;
2190 AioContext
*aio_context
;
2193 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2194 has_node_name
? node_name
: NULL
,
2197 error_propagate(errp
, local_err
);
2201 aio_context
= bdrv_get_aio_context(bs
);
2202 aio_context_acquire(aio_context
);
2204 if (!bdrv_is_first_non_filter(bs
)) {
2205 error_set(errp
, QERR_FEATURE_DISABLED
, "resize");
2210 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2214 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2215 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
2219 /* complete all in-flight operations before resizing the device */
2222 ret
= bdrv_truncate(bs
, size
);
2227 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2230 error_set(errp
, QERR_UNSUPPORTED
);
2233 error_setg(errp
, "Device '%s' is read only", device
);
2236 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
2239 error_setg_errno(errp
, -ret
, "Could not resize");
2244 aio_context_release(aio_context
);
2247 static void block_job_cb(void *opaque
, int ret
)
2249 /* Note that this function may be executed from another AioContext besides
2250 * the QEMU main loop. If you need to access anything that assumes the
2251 * QEMU global mutex, use a BH or introduce a mutex.
2254 BlockDriverState
*bs
= opaque
;
2255 const char *msg
= NULL
;
2257 trace_block_job_cb(bs
, bs
->job
, ret
);
2262 msg
= strerror(-ret
);
2265 if (block_job_is_cancelled(bs
->job
)) {
2266 block_job_event_cancelled(bs
->job
);
2268 block_job_event_completed(bs
->job
, msg
);
2271 bdrv_put_ref_bh_schedule(bs
);
2274 void qmp_block_stream(const char *device
,
2275 bool has_base
, const char *base
,
2276 bool has_backing_file
, const char *backing_file
,
2277 bool has_speed
, int64_t speed
,
2278 bool has_on_error
, BlockdevOnError on_error
,
2282 BlockDriverState
*bs
;
2283 BlockDriverState
*base_bs
= NULL
;
2284 AioContext
*aio_context
;
2285 Error
*local_err
= NULL
;
2286 const char *base_name
= NULL
;
2288 if (!has_on_error
) {
2289 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2292 blk
= blk_by_name(device
);
2294 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2299 aio_context
= bdrv_get_aio_context(bs
);
2300 aio_context_acquire(aio_context
);
2302 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_STREAM
, errp
)) {
2307 base_bs
= bdrv_find_backing_image(bs
, base
);
2308 if (base_bs
== NULL
) {
2309 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
2312 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2316 /* if we are streaming the entire chain, the result will have no backing
2317 * file, and specifying one is therefore an error */
2318 if (base_bs
== NULL
&& has_backing_file
) {
2319 error_setg(errp
, "backing file specified, but streaming the "
2324 /* backing_file string overrides base bs filename */
2325 base_name
= has_backing_file
? backing_file
: base_name
;
2327 stream_start(bs
, base_bs
, base_name
, has_speed
? speed
: 0,
2328 on_error
, block_job_cb
, bs
, &local_err
);
2330 error_propagate(errp
, local_err
);
2334 trace_qmp_block_stream(bs
, bs
->job
);
2337 aio_context_release(aio_context
);
2340 void qmp_block_commit(const char *device
,
2341 bool has_base
, const char *base
,
2342 bool has_top
, const char *top
,
2343 bool has_backing_file
, const char *backing_file
,
2344 bool has_speed
, int64_t speed
,
2348 BlockDriverState
*bs
;
2349 BlockDriverState
*base_bs
, *top_bs
;
2350 AioContext
*aio_context
;
2351 Error
*local_err
= NULL
;
2352 /* This will be part of the QMP command, if/when the
2353 * BlockdevOnError change for blkmirror makes it in
2355 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2362 * libvirt relies on the DeviceNotFound error class in order to probe for
2363 * live commit feature versions; for this to work, we must make sure to
2364 * perform the device lookup before any generic errors that may occur in a
2365 * scenario in which all optional arguments are omitted. */
2366 blk
= blk_by_name(device
);
2368 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2373 aio_context
= bdrv_get_aio_context(bs
);
2374 aio_context_acquire(aio_context
);
2376 /* drain all i/o before commits */
2379 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
2383 /* default top_bs is the active layer */
2386 if (has_top
&& top
) {
2387 if (strcmp(bs
->filename
, top
) != 0) {
2388 top_bs
= bdrv_find_backing_image(bs
, top
);
2392 if (top_bs
== NULL
) {
2393 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
2397 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
2399 if (has_base
&& base
) {
2400 base_bs
= bdrv_find_backing_image(top_bs
, base
);
2402 base_bs
= bdrv_find_base(top_bs
);
2405 if (base_bs
== NULL
) {
2406 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
2410 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2412 if (bdrv_op_is_blocked(base_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
2416 /* Do not allow attempts to commit an image into itself */
2417 if (top_bs
== base_bs
) {
2418 error_setg(errp
, "cannot commit an image into itself");
2423 if (has_backing_file
) {
2424 error_setg(errp
, "'backing-file' specified,"
2425 " but 'top' is the active layer");
2428 commit_active_start(bs
, base_bs
, speed
, on_error
, block_job_cb
,
2431 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
2432 has_backing_file
? backing_file
: NULL
, &local_err
);
2434 if (local_err
!= NULL
) {
2435 error_propagate(errp
, local_err
);
2440 aio_context_release(aio_context
);
2443 void qmp_drive_backup(const char *device
, const char *target
,
2444 bool has_format
, const char *format
,
2445 enum MirrorSyncMode sync
,
2446 bool has_mode
, enum NewImageMode mode
,
2447 bool has_speed
, int64_t speed
,
2448 bool has_bitmap
, const char *bitmap
,
2449 bool has_on_source_error
, BlockdevOnError on_source_error
,
2450 bool has_on_target_error
, BlockdevOnError on_target_error
,
2454 BlockDriverState
*bs
;
2455 BlockDriverState
*target_bs
;
2456 BlockDriverState
*source
= NULL
;
2457 BdrvDirtyBitmap
*bmap
= NULL
;
2458 AioContext
*aio_context
;
2459 BlockDriver
*drv
= NULL
;
2460 Error
*local_err
= NULL
;
2468 if (!has_on_source_error
) {
2469 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2471 if (!has_on_target_error
) {
2472 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2475 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
2478 blk
= blk_by_name(device
);
2480 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2485 aio_context
= bdrv_get_aio_context(bs
);
2486 aio_context_acquire(aio_context
);
2488 /* Although backup_run has this check too, we need to use bs->drv below, so
2489 * do an early check redundantly. */
2490 if (!bdrv_is_inserted(bs
)) {
2491 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2496 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
2499 drv
= bdrv_find_format(format
);
2501 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
2506 /* Early check to avoid creating target */
2507 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
2511 flags
= bs
->open_flags
| BDRV_O_RDWR
;
2513 /* See if we have a backing HD we can use to create our new image
2515 if (sync
== MIRROR_SYNC_MODE_TOP
) {
2516 source
= bs
->backing_hd
;
2518 sync
= MIRROR_SYNC_MODE_FULL
;
2521 if (sync
== MIRROR_SYNC_MODE_NONE
) {
2525 size
= bdrv_getlength(bs
);
2527 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
2531 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
2532 assert(format
&& drv
);
2534 bdrv_img_create(target
, format
, source
->filename
,
2535 source
->drv
->format_name
, NULL
,
2536 size
, flags
, &local_err
, false);
2538 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
2539 size
, flags
, &local_err
, false);
2544 error_propagate(errp
, local_err
);
2549 ret
= bdrv_open(&target_bs
, target
, NULL
, NULL
, flags
, drv
, &local_err
);
2551 error_propagate(errp
, local_err
);
2555 bdrv_set_aio_context(target_bs
, aio_context
);
2558 bmap
= bdrv_find_dirty_bitmap(bs
, bitmap
);
2560 error_setg(errp
, "Bitmap '%s' could not be found", bitmap
);
2565 backup_start(bs
, target_bs
, speed
, sync
, bmap
,
2566 on_source_error
, on_target_error
,
2567 block_job_cb
, bs
, &local_err
);
2568 if (local_err
!= NULL
) {
2569 bdrv_unref(target_bs
);
2570 error_propagate(errp
, local_err
);
2575 aio_context_release(aio_context
);
2578 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
2580 return bdrv_named_nodes_list(errp
);
2583 void qmp_blockdev_backup(const char *device
, const char *target
,
2584 enum MirrorSyncMode sync
,
2585 bool has_speed
, int64_t speed
,
2586 bool has_on_source_error
,
2587 BlockdevOnError on_source_error
,
2588 bool has_on_target_error
,
2589 BlockdevOnError on_target_error
,
2593 BlockDriverState
*bs
;
2594 BlockDriverState
*target_bs
;
2595 Error
*local_err
= NULL
;
2596 AioContext
*aio_context
;
2601 if (!has_on_source_error
) {
2602 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2604 if (!has_on_target_error
) {
2605 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2608 blk
= blk_by_name(device
);
2610 error_setg(errp
, "Device '%s' not found", device
);
2615 aio_context
= bdrv_get_aio_context(bs
);
2616 aio_context_acquire(aio_context
);
2618 blk
= blk_by_name(target
);
2620 error_setg(errp
, "Device '%s' not found", target
);
2623 target_bs
= blk_bs(blk
);
2625 bdrv_ref(target_bs
);
2626 bdrv_set_aio_context(target_bs
, aio_context
);
2627 backup_start(bs
, target_bs
, speed
, sync
, NULL
, on_source_error
,
2628 on_target_error
, block_job_cb
, bs
, &local_err
);
2629 if (local_err
!= NULL
) {
2630 bdrv_unref(target_bs
);
2631 error_propagate(errp
, local_err
);
2634 aio_context_release(aio_context
);
2637 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
2639 void qmp_drive_mirror(const char *device
, const char *target
,
2640 bool has_format
, const char *format
,
2641 bool has_node_name
, const char *node_name
,
2642 bool has_replaces
, const char *replaces
,
2643 enum MirrorSyncMode sync
,
2644 bool has_mode
, enum NewImageMode mode
,
2645 bool has_speed
, int64_t speed
,
2646 bool has_granularity
, uint32_t granularity
,
2647 bool has_buf_size
, int64_t buf_size
,
2648 bool has_on_source_error
, BlockdevOnError on_source_error
,
2649 bool has_on_target_error
, BlockdevOnError on_target_error
,
2653 BlockDriverState
*bs
;
2654 BlockDriverState
*source
, *target_bs
;
2655 AioContext
*aio_context
;
2656 BlockDriver
*drv
= NULL
;
2657 Error
*local_err
= NULL
;
2658 QDict
*options
= NULL
;
2666 if (!has_on_source_error
) {
2667 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2669 if (!has_on_target_error
) {
2670 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2673 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
2675 if (!has_granularity
) {
2678 if (!has_buf_size
) {
2679 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
2682 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
2683 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
2684 "a value in range [512B, 64MB]");
2687 if (granularity
& (granularity
- 1)) {
2688 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity", "power of 2");
2692 blk
= blk_by_name(device
);
2694 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2699 aio_context
= bdrv_get_aio_context(bs
);
2700 aio_context_acquire(aio_context
);
2702 if (!bdrv_is_inserted(bs
)) {
2703 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2708 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
2711 drv
= bdrv_find_format(format
);
2713 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
2718 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR
, errp
)) {
2722 flags
= bs
->open_flags
| BDRV_O_RDWR
;
2723 source
= bs
->backing_hd
;
2724 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
2725 sync
= MIRROR_SYNC_MODE_FULL
;
2727 if (sync
== MIRROR_SYNC_MODE_NONE
) {
2731 size
= bdrv_getlength(bs
);
2733 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
2738 BlockDriverState
*to_replace_bs
;
2739 AioContext
*replace_aio_context
;
2740 int64_t replace_size
;
2742 if (!has_node_name
) {
2743 error_setg(errp
, "a node-name must be provided when replacing a"
2744 " named node of the graph");
2748 to_replace_bs
= check_to_replace_node(replaces
, &local_err
);
2750 if (!to_replace_bs
) {
2751 error_propagate(errp
, local_err
);
2755 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
2756 aio_context_acquire(replace_aio_context
);
2757 replace_size
= bdrv_getlength(to_replace_bs
);
2758 aio_context_release(replace_aio_context
);
2760 if (size
!= replace_size
) {
2761 error_setg(errp
, "cannot replace image with a mirror image of "
2767 if ((sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
2768 && mode
!= NEW_IMAGE_MODE_EXISTING
)
2770 /* create new image w/o backing file */
2771 assert(format
&& drv
);
2772 bdrv_img_create(target
, format
,
2773 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
2776 case NEW_IMAGE_MODE_EXISTING
:
2778 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
2779 /* create new image with backing file */
2780 bdrv_img_create(target
, format
,
2782 source
->drv
->format_name
,
2783 NULL
, size
, flags
, &local_err
, false);
2791 error_propagate(errp
, local_err
);
2795 if (has_node_name
) {
2796 options
= qdict_new();
2797 qdict_put(options
, "node-name", qstring_from_str(node_name
));
2800 /* Mirroring takes care of copy-on-write using the source's backing
2804 ret
= bdrv_open(&target_bs
, target
, NULL
, options
,
2805 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
2807 error_propagate(errp
, local_err
);
2811 bdrv_set_aio_context(target_bs
, aio_context
);
2813 /* pass the node name to replace to mirror start since it's loose coupling
2814 * and will allow to check whether the node still exist at mirror completion
2816 mirror_start(bs
, target_bs
,
2817 has_replaces
? replaces
: NULL
,
2818 speed
, granularity
, buf_size
, sync
,
2819 on_source_error
, on_target_error
,
2820 block_job_cb
, bs
, &local_err
);
2821 if (local_err
!= NULL
) {
2822 bdrv_unref(target_bs
);
2823 error_propagate(errp
, local_err
);
2828 aio_context_release(aio_context
);
2831 /* Get the block job for a given device name and acquire its AioContext */
2832 static BlockJob
*find_block_job(const char *device
, AioContext
**aio_context
,
2836 BlockDriverState
*bs
;
2838 blk
= blk_by_name(device
);
2844 *aio_context
= bdrv_get_aio_context(bs
);
2845 aio_context_acquire(*aio_context
);
2848 aio_context_release(*aio_context
);
2855 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
2856 "No active block job on device '%s'", device
);
2857 *aio_context
= NULL
;
2861 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
2863 AioContext
*aio_context
;
2864 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2870 block_job_set_speed(job
, speed
, errp
);
2871 aio_context_release(aio_context
);
2874 void qmp_block_job_cancel(const char *device
,
2875 bool has_force
, bool force
, Error
**errp
)
2877 AioContext
*aio_context
;
2878 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2888 if (job
->user_paused
&& !force
) {
2889 error_setg(errp
, "The block job for device '%s' is currently paused",
2894 trace_qmp_block_job_cancel(job
);
2895 block_job_cancel(job
);
2897 aio_context_release(aio_context
);
2900 void qmp_block_job_pause(const char *device
, Error
**errp
)
2902 AioContext
*aio_context
;
2903 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2905 if (!job
|| job
->user_paused
) {
2909 job
->user_paused
= true;
2910 trace_qmp_block_job_pause(job
);
2911 block_job_pause(job
);
2912 aio_context_release(aio_context
);
2915 void qmp_block_job_resume(const char *device
, Error
**errp
)
2917 AioContext
*aio_context
;
2918 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2920 if (!job
|| !job
->user_paused
) {
2924 job
->user_paused
= false;
2925 trace_qmp_block_job_resume(job
);
2926 block_job_resume(job
);
2927 aio_context_release(aio_context
);
2930 void qmp_block_job_complete(const char *device
, Error
**errp
)
2932 AioContext
*aio_context
;
2933 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2939 trace_qmp_block_job_complete(job
);
2940 block_job_complete(job
, errp
);
2941 aio_context_release(aio_context
);
2944 void qmp_change_backing_file(const char *device
,
2945 const char *image_node_name
,
2946 const char *backing_file
,
2950 BlockDriverState
*bs
= NULL
;
2951 AioContext
*aio_context
;
2952 BlockDriverState
*image_bs
= NULL
;
2953 Error
*local_err
= NULL
;
2958 blk
= blk_by_name(device
);
2960 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2965 aio_context
= bdrv_get_aio_context(bs
);
2966 aio_context_acquire(aio_context
);
2968 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
2970 error_propagate(errp
, local_err
);
2975 error_setg(errp
, "image file not found");
2979 if (bdrv_find_base(image_bs
) == image_bs
) {
2980 error_setg(errp
, "not allowing backing file change on an image "
2981 "without a backing file");
2985 /* even though we are not necessarily operating on bs, we need it to
2986 * determine if block ops are currently prohibited on the chain */
2987 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
2991 /* final sanity check */
2992 if (!bdrv_chain_contains(bs
, image_bs
)) {
2993 error_setg(errp
, "'%s' and image file are not in the same chain",
2998 /* if not r/w, reopen to make r/w */
2999 open_flags
= image_bs
->open_flags
;
3000 ro
= bdrv_is_read_only(image_bs
);
3003 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3005 error_propagate(errp
, local_err
);
3010 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3011 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3014 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3016 /* don't exit here, so we can try to restore open flags if
3021 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3023 error_propagate(errp
, local_err
); /* will preserve prior errp */
3028 aio_context_release(aio_context
);
3031 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3033 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
3037 Error
*local_err
= NULL
;
3039 /* Require an ID in the top level */
3040 if (!options
->has_id
) {
3041 error_setg(errp
, "Block device needs an ID");
3045 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3046 * cache.direct=false instead of silently switching to aio=threads, except
3047 * when called from drive_new().
3049 * For now, simply forbidding the combination for all drivers will do. */
3050 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
3051 bool direct
= options
->has_cache
&&
3052 options
->cache
->has_direct
&&
3053 options
->cache
->direct
;
3055 error_setg(errp
, "aio=native requires cache.direct=true");
3060 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
),
3061 &options
, NULL
, &local_err
);
3063 error_propagate(errp
, local_err
);
3067 obj
= qmp_output_get_qobject(ov
);
3068 qdict
= qobject_to_qdict(obj
);
3070 qdict_flatten(qdict
);
3072 blk
= blockdev_init(NULL
, qdict
, &local_err
);
3074 error_propagate(errp
, local_err
);
3078 if (bdrv_key_required(blk_bs(blk
))) {
3080 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3085 qmp_output_visitor_cleanup(ov
);
3088 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3090 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3091 BlockDriverState
*bs
;
3093 for (bs
= bdrv_next(NULL
); bs
; bs
= bdrv_next(bs
)) {
3094 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
3096 aio_context_acquire(aio_context
);
3099 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
3100 elem
->value
= block_job_query(bs
->job
);
3102 p_next
= &elem
->next
;
3105 aio_context_release(aio_context
);
3111 QemuOptsList qemu_common_drive_opts
= {
3113 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
3117 .type
= QEMU_OPT_BOOL
,
3118 .help
= "enable/disable snapshot mode",
3121 .type
= QEMU_OPT_STRING
,
3122 .help
= "discard operation (ignore/off, unmap/on)",
3124 .name
= BDRV_OPT_CACHE_WB
,
3125 .type
= QEMU_OPT_BOOL
,
3126 .help
= "enables writeback mode for any caches",
3128 .name
= BDRV_OPT_CACHE_DIRECT
,
3129 .type
= QEMU_OPT_BOOL
,
3130 .help
= "enables use of O_DIRECT (bypass the host page cache)",
3132 .name
= BDRV_OPT_CACHE_NO_FLUSH
,
3133 .type
= QEMU_OPT_BOOL
,
3134 .help
= "ignore any flush requests for the device",
3137 .type
= QEMU_OPT_STRING
,
3138 .help
= "host AIO implementation (threads, native)",
3141 .type
= QEMU_OPT_STRING
,
3142 .help
= "disk format (raw, qcow2, ...)",
3145 .type
= QEMU_OPT_STRING
,
3146 .help
= "read error action",
3149 .type
= QEMU_OPT_STRING
,
3150 .help
= "write error action",
3152 .name
= "read-only",
3153 .type
= QEMU_OPT_BOOL
,
3154 .help
= "open drive file as read-only",
3156 .name
= "throttling.iops-total",
3157 .type
= QEMU_OPT_NUMBER
,
3158 .help
= "limit total I/O operations per second",
3160 .name
= "throttling.iops-read",
3161 .type
= QEMU_OPT_NUMBER
,
3162 .help
= "limit read operations per second",
3164 .name
= "throttling.iops-write",
3165 .type
= QEMU_OPT_NUMBER
,
3166 .help
= "limit write operations per second",
3168 .name
= "throttling.bps-total",
3169 .type
= QEMU_OPT_NUMBER
,
3170 .help
= "limit total bytes per second",
3172 .name
= "throttling.bps-read",
3173 .type
= QEMU_OPT_NUMBER
,
3174 .help
= "limit read bytes per second",
3176 .name
= "throttling.bps-write",
3177 .type
= QEMU_OPT_NUMBER
,
3178 .help
= "limit write bytes per second",
3180 .name
= "throttling.iops-total-max",
3181 .type
= QEMU_OPT_NUMBER
,
3182 .help
= "I/O operations burst",
3184 .name
= "throttling.iops-read-max",
3185 .type
= QEMU_OPT_NUMBER
,
3186 .help
= "I/O operations read burst",
3188 .name
= "throttling.iops-write-max",
3189 .type
= QEMU_OPT_NUMBER
,
3190 .help
= "I/O operations write burst",
3192 .name
= "throttling.bps-total-max",
3193 .type
= QEMU_OPT_NUMBER
,
3194 .help
= "total bytes burst",
3196 .name
= "throttling.bps-read-max",
3197 .type
= QEMU_OPT_NUMBER
,
3198 .help
= "total bytes read burst",
3200 .name
= "throttling.bps-write-max",
3201 .type
= QEMU_OPT_NUMBER
,
3202 .help
= "total bytes write burst",
3204 .name
= "throttling.iops-size",
3205 .type
= QEMU_OPT_NUMBER
,
3206 .help
= "when limiting by iops max size of an I/O in bytes",
3208 .name
= "throttling.group",
3209 .type
= QEMU_OPT_STRING
,
3210 .help
= "name of the block throttling group",
3212 .name
= "copy-on-read",
3213 .type
= QEMU_OPT_BOOL
,
3214 .help
= "copy read data from backing file into image file",
3216 .name
= "detect-zeroes",
3217 .type
= QEMU_OPT_STRING
,
3218 .help
= "try to optimize zero writes (off, on, unmap)",
3220 { /* end of list */ }
3224 QemuOptsList qemu_drive_opts
= {
3226 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
3229 * no elements => accept any params
3230 * validation will happen later
3232 { /* end of list */ }