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/error-report.h"
40 #include "qemu/option.h"
41 #include "qemu/config-file.h"
42 #include "qapi/qmp/types.h"
43 #include "qapi-visit.h"
44 #include "qapi/qmp/qerror.h"
45 #include "qapi/qmp-output-visitor.h"
46 #include "qapi/util.h"
47 #include "sysemu/sysemu.h"
48 #include "block/block_int.h"
49 #include "qmp-commands.h"
51 #include "sysemu/arch_init.h"
53 static const char *const if_name
[IF_COUNT
] = {
57 [IF_FLOPPY
] = "floppy",
58 [IF_PFLASH
] = "pflash",
61 [IF_VIRTIO
] = "virtio",
65 static int if_max_devs
[IF_COUNT
] = {
67 * Do not change these numbers! They govern how drive option
68 * index maps to unit and bus. That mapping is ABI.
70 * All controllers used to imlement if=T drives need to support
71 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
72 * Otherwise, some index values map to "impossible" bus, unit
75 * For instance, if you change [IF_SCSI] to 255, -drive
76 * if=scsi,index=12 no longer means bus=1,unit=5, but
77 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
78 * the drive can't be set up. Regression.
85 * Boards may call this to offer board-by-board overrides
86 * of the default, global values.
88 void override_max_devs(BlockInterfaceType type
, int max_devs
)
97 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
98 dinfo
= blk_legacy_dinfo(blk
);
99 if (dinfo
->type
== type
) {
100 fprintf(stderr
, "Cannot override units-per-bus property of"
101 " the %s interface, because a drive of that type has"
102 " already been added.\n", if_name
[type
]);
103 g_assert_not_reached();
107 if_max_devs
[type
] = max_devs
;
111 * We automatically delete the drive when a device using it gets
112 * unplugged. Questionable feature, but we can't just drop it.
113 * Device models call blockdev_mark_auto_del() to schedule the
114 * automatic deletion, and generic qdev code calls blockdev_auto_del()
115 * when deletion is actually safe.
117 void blockdev_mark_auto_del(BlockBackend
*blk
)
119 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
120 BlockDriverState
*bs
= blk_bs(blk
);
121 AioContext
*aio_context
;
128 aio_context
= bdrv_get_aio_context(bs
);
129 aio_context_acquire(aio_context
);
132 block_job_cancel(bs
->job
);
135 aio_context_release(aio_context
);
141 void blockdev_auto_del(BlockBackend
*blk
)
143 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
145 if (dinfo
&& dinfo
->auto_del
) {
151 * Returns the current mapping of how many units per bus
152 * a particular interface can support.
154 * A positive integer indicates n units per bus.
155 * 0 implies the mapping has not been established.
156 * -1 indicates an invalid BlockInterfaceType was given.
158 int drive_get_max_devs(BlockInterfaceType type
)
160 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
161 return if_max_devs
[type
];
167 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
169 int max_devs
= if_max_devs
[type
];
170 return max_devs
? index
/ max_devs
: 0;
173 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
175 int max_devs
= if_max_devs
[type
];
176 return max_devs
? index
% max_devs
: index
;
179 QemuOpts
*drive_def(const char *optstr
)
181 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
184 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
189 opts
= drive_def(optstr
);
193 if (type
!= IF_DEFAULT
) {
194 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
197 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
200 qemu_opt_set(opts
, "file", file
, &error_abort
);
204 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
209 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
210 dinfo
= blk_legacy_dinfo(blk
);
211 if (dinfo
&& dinfo
->type
== type
212 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
220 bool drive_check_orphaned(void)
226 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
227 dinfo
= blk_legacy_dinfo(blk
);
228 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
229 /* Unless this is a default drive, this may be an oversight. */
230 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
231 dinfo
->type
!= IF_NONE
) {
232 fprintf(stderr
, "Warning: Orphaned drive without device: "
233 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
234 blk_name(blk
), blk_bs(blk
) ? blk_bs(blk
)->filename
: "",
235 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
243 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
245 return drive_get(type
,
246 drive_index_to_bus_id(type
, index
),
247 drive_index_to_unit_id(type
, index
));
250 int drive_get_max_bus(BlockInterfaceType type
)
257 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
258 dinfo
= blk_legacy_dinfo(blk
);
259 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
260 max_bus
= dinfo
->bus
;
266 /* Get a block device. This should only be used for single-drive devices
267 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
269 DriveInfo
*drive_get_next(BlockInterfaceType type
)
271 static int next_block_unit
[IF_COUNT
];
273 return drive_get(type
, 0, next_block_unit
[type
]++);
276 static void bdrv_format_print(void *opaque
, const char *name
)
278 error_printf(" %s", name
);
283 BlockDriverState
*bs
;
286 static void bdrv_put_ref_bh(void *opaque
)
288 BDRVPutRefBH
*s
= opaque
;
291 qemu_bh_delete(s
->bh
);
296 * Release a BDS reference in a BH
298 * It is not safe to use bdrv_unref() from a callback function when the callers
299 * still need the BlockDriverState. In such cases we schedule a BH to release
302 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
306 s
= g_new(BDRVPutRefBH
, 1);
307 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
309 qemu_bh_schedule(s
->bh
);
312 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
314 if (!strcmp(buf
, "ignore")) {
315 return BLOCKDEV_ON_ERROR_IGNORE
;
316 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
317 return BLOCKDEV_ON_ERROR_ENOSPC
;
318 } else if (!strcmp(buf
, "stop")) {
319 return BLOCKDEV_ON_ERROR_STOP
;
320 } else if (!strcmp(buf
, "report")) {
321 return BLOCKDEV_ON_ERROR_REPORT
;
323 error_setg(errp
, "'%s' invalid %s error action",
324 buf
, is_read
? "read" : "write");
329 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
331 if (throttle_conflicting(cfg
)) {
332 error_setg(errp
, "bps/iops/max total values and read/write values"
333 " cannot be used at the same time");
337 if (!throttle_is_valid(cfg
)) {
338 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
342 if (throttle_max_is_missing_limit(cfg
)) {
343 error_setg(errp
, "bps_max/iops_max require corresponding"
351 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
353 /* Takes the ownership of bs_opts */
354 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
360 int on_read_error
, on_write_error
;
362 BlockDriverState
*bs
;
369 bool has_driver_specific_opts
;
370 BlockdevDetectZeroesOptions detect_zeroes
;
371 const char *throttling_group
;
373 /* Check common options by copying from bs_opts to opts, all other options
374 * stay in bs_opts for processing by bdrv_open(). */
375 id
= qdict_get_try_str(bs_opts
, "id");
376 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
378 error_propagate(errp
, error
);
382 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
384 error_propagate(errp
, error
);
389 qdict_del(bs_opts
, "id");
392 has_driver_specific_opts
= !!qdict_size(bs_opts
);
394 /* extract parameters */
395 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
396 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
397 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
399 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
400 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
401 error_setg(errp
, "invalid discard option");
406 if (qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true)) {
407 bdrv_flags
|= BDRV_O_CACHE_WB
;
409 if (qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_DIRECT
, false)) {
410 bdrv_flags
|= BDRV_O_NOCACHE
;
412 if (qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_NO_FLUSH
, false)) {
413 bdrv_flags
|= BDRV_O_NO_FLUSH
;
416 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
417 if (!strcmp(buf
, "native")) {
418 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
419 } else if (!strcmp(buf
, "threads")) {
420 /* this is the default */
422 error_setg(errp
, "invalid aio option");
427 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
428 if (is_help_option(buf
)) {
429 error_printf("Supported formats:");
430 bdrv_iterate_format(bdrv_format_print
, NULL
);
435 if (qdict_haskey(bs_opts
, "driver")) {
436 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
439 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
442 /* disk I/O throttling */
443 memset(&cfg
, 0, sizeof(cfg
));
444 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
445 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
446 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
447 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
448 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
449 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
450 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
451 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
452 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
453 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
454 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
455 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
457 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
458 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
459 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
460 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
461 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
462 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
463 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
464 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
465 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
466 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
467 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
468 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
470 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
472 throttling_group
= qemu_opt_get(opts
, "throttling.group");
474 if (!check_throttle_config(&cfg
, &error
)) {
475 error_propagate(errp
, error
);
479 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
480 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
481 on_write_error
= parse_block_error_action(buf
, 0, &error
);
483 error_propagate(errp
, error
);
488 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
489 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
490 on_read_error
= parse_block_error_action(buf
, 1, &error
);
492 error_propagate(errp
, error
);
498 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
499 qemu_opt_get(opts
, "detect-zeroes"),
500 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX
,
501 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
504 error_propagate(errp
, error
);
508 if (detect_zeroes
== BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP
&&
509 !(bdrv_flags
& BDRV_O_UNMAP
)) {
510 error_setg(errp
, "setting detect-zeroes to unmap is not allowed "
511 "without setting discard operation to unmap");
516 if ((!file
|| !*file
) && !has_driver_specific_opts
) {
517 blk
= blk_new_with_bs(qemu_opts_id(opts
), errp
);
523 bs
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
528 if (file
&& !*file
) {
533 /* always use cache=unsafe with snapshot */
534 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
535 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
539 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
542 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
544 blk
= blk_new_open(qemu_opts_id(opts
), file
, NULL
, bs_opts
, bdrv_flags
,
552 bs
->detect_zeroes
= detect_zeroes
;
554 blk_set_on_error(blk
, on_read_error
, on_write_error
);
556 /* disk I/O throttling */
557 if (throttle_enabled(&cfg
)) {
558 if (!throttling_group
) {
559 throttling_group
= blk_name(blk
);
561 bdrv_io_limits_enable(bs
, throttling_group
);
562 bdrv_set_io_limits(bs
, &cfg
);
565 if (bdrv_key_required(bs
)) {
580 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
585 value
= qemu_opt_get(opts
, from
);
587 if (qemu_opt_find(opts
, to
)) {
588 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
589 "same time", to
, from
);
594 /* rename all items in opts */
595 while ((value
= qemu_opt_get(opts
, from
))) {
596 qemu_opt_set(opts
, to
, value
, &error_abort
);
597 qemu_opt_unset(opts
, from
);
601 QemuOptsList qemu_legacy_drive_opts
= {
603 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
607 .type
= QEMU_OPT_NUMBER
,
608 .help
= "bus number",
611 .type
= QEMU_OPT_NUMBER
,
612 .help
= "unit number (i.e. lun for scsi)",
615 .type
= QEMU_OPT_NUMBER
,
616 .help
= "index number",
619 .type
= QEMU_OPT_STRING
,
620 .help
= "media type (disk, cdrom)",
623 .type
= QEMU_OPT_STRING
,
624 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
627 .type
= QEMU_OPT_NUMBER
,
628 .help
= "number of cylinders (ide disk geometry)",
631 .type
= QEMU_OPT_NUMBER
,
632 .help
= "number of heads (ide disk geometry)",
635 .type
= QEMU_OPT_NUMBER
,
636 .help
= "number of sectors (ide disk geometry)",
639 .type
= QEMU_OPT_STRING
,
640 .help
= "chs translation (auto, lba, none)",
643 .type
= QEMU_OPT_BOOL
,
644 .help
= "(deprecated, ignored)",
647 .type
= QEMU_OPT_STRING
,
648 .help
= "pci address (virtio only)",
651 .type
= QEMU_OPT_STRING
,
652 .help
= "disk serial number",
655 .type
= QEMU_OPT_STRING
,
659 /* Options that are passed on, but have special semantics with -drive */
662 .type
= QEMU_OPT_BOOL
,
663 .help
= "open drive file as read-only",
666 .type
= QEMU_OPT_STRING
,
667 .help
= "read error action",
670 .type
= QEMU_OPT_STRING
,
671 .help
= "write error action",
673 .name
= "copy-on-read",
674 .type
= QEMU_OPT_BOOL
,
675 .help
= "copy read data from backing file into image file",
678 { /* end of list */ }
682 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
686 DriveInfo
*dinfo
= NULL
;
688 QemuOpts
*legacy_opts
;
689 DriveMediaType media
= MEDIA_DISK
;
690 BlockInterfaceType type
;
691 int cyls
, heads
, secs
, translation
;
692 int max_devs
, bus_id
, unit_id
, index
;
694 const char *werror
, *rerror
;
695 bool read_only
= false;
698 const char *filename
;
699 Error
*local_err
= NULL
;
702 /* Change legacy command line options into QMP ones */
703 static const struct {
707 { "iops", "throttling.iops-total" },
708 { "iops_rd", "throttling.iops-read" },
709 { "iops_wr", "throttling.iops-write" },
711 { "bps", "throttling.bps-total" },
712 { "bps_rd", "throttling.bps-read" },
713 { "bps_wr", "throttling.bps-write" },
715 { "iops_max", "throttling.iops-total-max" },
716 { "iops_rd_max", "throttling.iops-read-max" },
717 { "iops_wr_max", "throttling.iops-write-max" },
719 { "bps_max", "throttling.bps-total-max" },
720 { "bps_rd_max", "throttling.bps-read-max" },
721 { "bps_wr_max", "throttling.bps-write-max" },
723 { "iops_size", "throttling.iops-size" },
725 { "group", "throttling.group" },
727 { "readonly", "read-only" },
730 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
731 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
734 error_report_err(local_err
);
739 value
= qemu_opt_get(all_opts
, "cache");
743 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
744 error_report("invalid cache option");
748 /* Specific options take precedence */
749 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
750 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
751 !!(flags
& BDRV_O_CACHE_WB
), &error_abort
);
753 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
754 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
755 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
757 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
758 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
759 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
761 qemu_opt_unset(all_opts
, "cache");
764 /* Get a QDict for processing the options */
765 bs_opts
= qdict_new();
766 qemu_opts_to_qdict(all_opts
, bs_opts
);
768 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
770 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
772 error_report_err(local_err
);
776 /* Deprecated option boot=[on|off] */
777 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
778 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
779 "ignored. Future versions will reject this parameter. Please "
780 "update your scripts.\n");
784 value
= qemu_opt_get(legacy_opts
, "media");
786 if (!strcmp(value
, "disk")) {
788 } else if (!strcmp(value
, "cdrom")) {
792 error_report("'%s' invalid media", value
);
797 /* copy-on-read is disabled with a warning for read-only devices */
798 read_only
|= qemu_opt_get_bool(legacy_opts
, "read-only", false);
799 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
801 if (read_only
&& copy_on_read
) {
802 error_report("warning: disabling copy-on-read on read-only drive");
803 copy_on_read
= false;
806 qdict_put(bs_opts
, "read-only",
807 qstring_from_str(read_only
? "on" : "off"));
808 qdict_put(bs_opts
, "copy-on-read",
809 qstring_from_str(copy_on_read
? "on" :"off"));
811 /* Controller type */
812 value
= qemu_opt_get(legacy_opts
, "if");
815 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
818 if (type
== IF_COUNT
) {
819 error_report("unsupported bus type '%s'", value
);
823 type
= block_default_type
;
827 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
828 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
829 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
831 if (cyls
|| heads
|| secs
) {
833 error_report("invalid physical cyls number");
837 error_report("invalid physical heads number");
841 error_report("invalid physical secs number");
846 translation
= BIOS_ATA_TRANSLATION_AUTO
;
847 value
= qemu_opt_get(legacy_opts
, "trans");
850 error_report("'%s' trans must be used with cyls, heads and secs",
854 if (!strcmp(value
, "none")) {
855 translation
= BIOS_ATA_TRANSLATION_NONE
;
856 } else if (!strcmp(value
, "lba")) {
857 translation
= BIOS_ATA_TRANSLATION_LBA
;
858 } else if (!strcmp(value
, "large")) {
859 translation
= BIOS_ATA_TRANSLATION_LARGE
;
860 } else if (!strcmp(value
, "rechs")) {
861 translation
= BIOS_ATA_TRANSLATION_RECHS
;
862 } else if (!strcmp(value
, "auto")) {
863 translation
= BIOS_ATA_TRANSLATION_AUTO
;
865 error_report("'%s' invalid translation type", value
);
870 if (media
== MEDIA_CDROM
) {
871 if (cyls
|| secs
|| heads
) {
872 error_report("CHS can't be set with media=cdrom");
877 /* Device address specified by bus/unit or index.
878 * If none was specified, try to find the first free one. */
879 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
880 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
881 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
883 max_devs
= if_max_devs
[type
];
886 if (bus_id
!= 0 || unit_id
!= -1) {
887 error_report("index cannot be used with bus and unit");
890 bus_id
= drive_index_to_bus_id(type
, index
);
891 unit_id
= drive_index_to_unit_id(type
, index
);
896 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
898 if (max_devs
&& unit_id
>= max_devs
) {
905 if (max_devs
&& unit_id
>= max_devs
) {
906 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
910 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
911 error_report("drive with bus=%d, unit=%d (index=%d) exists",
912 bus_id
, unit_id
, index
);
917 serial
= qemu_opt_get(legacy_opts
, "serial");
919 /* no id supplied -> create one */
920 if (qemu_opts_id(all_opts
) == NULL
) {
922 const char *mediastr
= "";
923 if (type
== IF_IDE
|| type
== IF_SCSI
) {
924 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
927 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
930 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
933 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
937 /* Add virtio block device */
938 devaddr
= qemu_opt_get(legacy_opts
, "addr");
939 if (devaddr
&& type
!= IF_VIRTIO
) {
940 error_report("addr is not supported by this bus type");
944 if (type
== IF_VIRTIO
) {
946 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
948 if (arch_type
== QEMU_ARCH_S390X
) {
949 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
951 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
953 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
956 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
960 filename
= qemu_opt_get(legacy_opts
, "file");
962 /* Check werror/rerror compatibility with if=... */
963 werror
= qemu_opt_get(legacy_opts
, "werror");
964 if (werror
!= NULL
) {
965 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
967 error_report("werror is not supported by this bus type");
970 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
973 rerror
= qemu_opt_get(legacy_opts
, "rerror");
974 if (rerror
!= NULL
) {
975 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
977 error_report("rerror is not supported by this bus type");
980 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
983 /* Actual block device init: Functionality shared with blockdev-add */
984 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
988 error_report_err(local_err
);
995 /* Create legacy DriveInfo */
996 dinfo
= g_malloc0(sizeof(*dinfo
));
997 dinfo
->opts
= all_opts
;
1000 dinfo
->heads
= heads
;
1002 dinfo
->trans
= translation
;
1005 dinfo
->bus
= bus_id
;
1006 dinfo
->unit
= unit_id
;
1007 dinfo
->devaddr
= devaddr
;
1008 dinfo
->serial
= g_strdup(serial
);
1010 blk_set_legacy_dinfo(blk
, dinfo
);
1017 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1024 qemu_opts_del(legacy_opts
);
1029 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1031 const char *device
= qdict_get_str(qdict
, "device");
1035 if (!strcmp(device
, "all")) {
1036 ret
= bdrv_commit_all();
1038 blk
= blk_by_name(device
);
1040 monitor_printf(mon
, "Device '%s' not found\n", device
);
1043 if (!blk_is_available(blk
)) {
1044 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1047 ret
= bdrv_commit(blk_bs(blk
));
1050 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1055 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
1057 TransactionAction action
;
1058 TransactionActionList list
;
1062 list
.value
= &action
;
1064 qmp_transaction(&list
, errp
);
1067 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1068 bool has_node_name
, const char *node_name
,
1069 const char *snapshot_file
,
1070 bool has_snapshot_node_name
,
1071 const char *snapshot_node_name
,
1072 bool has_format
, const char *format
,
1073 bool has_mode
, NewImageMode mode
, Error
**errp
)
1075 BlockdevSnapshot snapshot
= {
1076 .has_device
= has_device
,
1077 .device
= (char *) device
,
1078 .has_node_name
= has_node_name
,
1079 .node_name
= (char *) node_name
,
1080 .snapshot_file
= (char *) snapshot_file
,
1081 .has_snapshot_node_name
= has_snapshot_node_name
,
1082 .snapshot_node_name
= (char *) snapshot_node_name
,
1083 .has_format
= has_format
,
1084 .format
= (char *) format
,
1085 .has_mode
= has_mode
,
1088 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1092 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1096 BlockdevSnapshotInternal snapshot
= {
1097 .device
= (char *) device
,
1098 .name
= (char *) name
1101 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1105 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1112 BlockDriverState
*bs
;
1114 AioContext
*aio_context
;
1115 QEMUSnapshotInfo sn
;
1116 Error
*local_err
= NULL
;
1117 SnapshotInfo
*info
= NULL
;
1120 blk
= blk_by_name(device
);
1122 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1123 "Device '%s' not found", device
);
1127 aio_context
= blk_get_aio_context(blk
);
1128 aio_context_acquire(aio_context
);
1139 error_setg(errp
, "Name or id must be provided");
1140 goto out_aio_context
;
1143 if (!blk_is_available(blk
)) {
1144 error_setg(errp
, "Device '%s' has no medium", device
);
1145 goto out_aio_context
;
1149 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1150 goto out_aio_context
;
1153 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1155 error_propagate(errp
, local_err
);
1156 goto out_aio_context
;
1160 "Snapshot with id '%s' and name '%s' does not exist on "
1162 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1163 goto out_aio_context
;
1166 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1168 error_propagate(errp
, local_err
);
1169 goto out_aio_context
;
1172 aio_context_release(aio_context
);
1174 info
= g_new0(SnapshotInfo
, 1);
1175 info
->id
= g_strdup(sn
.id_str
);
1176 info
->name
= g_strdup(sn
.name
);
1177 info
->date_nsec
= sn
.date_nsec
;
1178 info
->date_sec
= sn
.date_sec
;
1179 info
->vm_state_size
= sn
.vm_state_size
;
1180 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1181 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1186 aio_context_release(aio_context
);
1191 * block_dirty_bitmap_lookup:
1192 * Return a dirty bitmap (if present), after validating
1193 * the node reference and bitmap names.
1195 * @node: The name of the BDS node to search for bitmaps
1196 * @name: The name of the bitmap to search for
1197 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1198 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1199 * @errp: Output pointer for error information. Can be NULL.
1201 * @return: A bitmap object on success, or NULL on failure.
1203 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1205 BlockDriverState
**pbs
,
1209 BlockDriverState
*bs
;
1210 BdrvDirtyBitmap
*bitmap
;
1211 AioContext
*aio_context
;
1214 error_setg(errp
, "Node cannot be NULL");
1218 error_setg(errp
, "Bitmap name cannot be NULL");
1221 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1223 error_setg(errp
, "Node '%s' not found", node
);
1227 aio_context
= bdrv_get_aio_context(bs
);
1228 aio_context_acquire(aio_context
);
1230 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1232 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1240 *paio
= aio_context
;
1242 aio_context_release(aio_context
);
1248 aio_context_release(aio_context
);
1252 /* New and old BlockDriverState structs for atomic group operations */
1254 typedef struct BlkTransactionState BlkTransactionState
;
1256 /* Only prepare() may fail. In a single transaction, only one of commit() or
1257 abort() will be called, clean() will always be called if it present. */
1258 typedef struct BdrvActionOps
{
1259 /* Size of state struct, in bytes. */
1260 size_t instance_size
;
1261 /* Prepare the work, must NOT be NULL. */
1262 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
1263 /* Commit the changes, can be NULL. */
1264 void (*commit
)(BlkTransactionState
*common
);
1265 /* Abort the changes on fail, can be NULL. */
1266 void (*abort
)(BlkTransactionState
*common
);
1267 /* Clean up resource in the end, can be NULL. */
1268 void (*clean
)(BlkTransactionState
*common
);
1272 * This structure must be arranged as first member in child type, assuming
1273 * that compiler will also arrange it to the same address with parent instance.
1274 * Later it will be used in free().
1276 struct BlkTransactionState
{
1277 TransactionAction
*action
;
1278 const BdrvActionOps
*ops
;
1279 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
1282 /* internal snapshot private data */
1283 typedef struct InternalSnapshotState
{
1284 BlkTransactionState common
;
1285 BlockDriverState
*bs
;
1286 AioContext
*aio_context
;
1287 QEMUSnapshotInfo sn
;
1288 } InternalSnapshotState
;
1290 static void internal_snapshot_prepare(BlkTransactionState
*common
,
1293 Error
*local_err
= NULL
;
1297 BlockDriverState
*bs
;
1298 QEMUSnapshotInfo old_sn
, *sn
;
1301 BlockdevSnapshotInternal
*internal
;
1302 InternalSnapshotState
*state
;
1305 g_assert(common
->action
->kind
==
1306 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1307 internal
= common
->action
->blockdev_snapshot_internal_sync
;
1308 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1310 /* 1. parse input */
1311 device
= internal
->device
;
1312 name
= internal
->name
;
1314 /* 2. check for validation */
1315 blk
= blk_by_name(device
);
1317 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1318 "Device '%s' not found", device
);
1322 /* AioContext is released in .clean() */
1323 state
->aio_context
= blk_get_aio_context(blk
);
1324 aio_context_acquire(state
->aio_context
);
1326 if (!blk_is_available(blk
)) {
1327 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1332 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1336 if (bdrv_is_read_only(bs
)) {
1337 error_setg(errp
, "Device '%s' is read only", device
);
1341 if (!bdrv_can_snapshot(bs
)) {
1342 error_setg(errp
, "Block format '%s' used by device '%s' "
1343 "does not support internal snapshots",
1344 bs
->drv
->format_name
, device
);
1348 if (!strlen(name
)) {
1349 error_setg(errp
, "Name is empty");
1353 /* check whether a snapshot with name exist */
1354 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1357 error_propagate(errp
, local_err
);
1361 "Snapshot with name '%s' already exists on device '%s'",
1366 /* 3. take the snapshot */
1368 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1369 qemu_gettimeofday(&tv
);
1370 sn
->date_sec
= tv
.tv_sec
;
1371 sn
->date_nsec
= tv
.tv_usec
* 1000;
1372 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1374 ret1
= bdrv_snapshot_create(bs
, sn
);
1376 error_setg_errno(errp
, -ret1
,
1377 "Failed to create snapshot '%s' on device '%s'",
1382 /* 4. succeed, mark a snapshot is created */
1386 static void internal_snapshot_abort(BlkTransactionState
*common
)
1388 InternalSnapshotState
*state
=
1389 DO_UPCAST(InternalSnapshotState
, common
, common
);
1390 BlockDriverState
*bs
= state
->bs
;
1391 QEMUSnapshotInfo
*sn
= &state
->sn
;
1392 Error
*local_error
= NULL
;
1398 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1399 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1400 "device '%s' in abort: %s",
1403 bdrv_get_device_name(bs
),
1404 error_get_pretty(local_error
));
1405 error_free(local_error
);
1409 static void internal_snapshot_clean(BlkTransactionState
*common
)
1411 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1414 if (state
->aio_context
) {
1415 aio_context_release(state
->aio_context
);
1419 /* external snapshot private data */
1420 typedef struct ExternalSnapshotState
{
1421 BlkTransactionState common
;
1422 BlockDriverState
*old_bs
;
1423 BlockDriverState
*new_bs
;
1424 AioContext
*aio_context
;
1425 } ExternalSnapshotState
;
1427 static void external_snapshot_prepare(BlkTransactionState
*common
,
1432 Error
*local_err
= NULL
;
1433 bool has_device
= false;
1435 bool has_node_name
= false;
1436 const char *node_name
;
1437 bool has_snapshot_node_name
= false;
1438 const char *snapshot_node_name
;
1439 const char *new_image_file
;
1440 const char *format
= "qcow2";
1441 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1442 ExternalSnapshotState
*state
=
1443 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1444 TransactionAction
*action
= common
->action
;
1446 /* get parameters */
1447 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1449 has_device
= action
->blockdev_snapshot_sync
->has_device
;
1450 device
= action
->blockdev_snapshot_sync
->device
;
1451 has_node_name
= action
->blockdev_snapshot_sync
->has_node_name
;
1452 node_name
= action
->blockdev_snapshot_sync
->node_name
;
1453 has_snapshot_node_name
=
1454 action
->blockdev_snapshot_sync
->has_snapshot_node_name
;
1455 snapshot_node_name
= action
->blockdev_snapshot_sync
->snapshot_node_name
;
1457 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1458 if (action
->blockdev_snapshot_sync
->has_format
) {
1459 format
= action
->blockdev_snapshot_sync
->format
;
1461 if (action
->blockdev_snapshot_sync
->has_mode
) {
1462 mode
= action
->blockdev_snapshot_sync
->mode
;
1465 /* start processing */
1466 state
->old_bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
1467 has_node_name
? node_name
: NULL
,
1470 error_propagate(errp
, local_err
);
1474 if (has_node_name
&& !has_snapshot_node_name
) {
1475 error_setg(errp
, "New snapshot node name missing");
1479 if (has_snapshot_node_name
&& bdrv_find_node(snapshot_node_name
)) {
1480 error_setg(errp
, "New snapshot node name already existing");
1484 /* Acquire AioContext now so any threads operating on old_bs stop */
1485 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1486 aio_context_acquire(state
->aio_context
);
1488 if (!bdrv_is_inserted(state
->old_bs
)) {
1489 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1493 if (bdrv_op_is_blocked(state
->old_bs
,
1494 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1498 if (!bdrv_is_read_only(state
->old_bs
)) {
1499 if (bdrv_flush(state
->old_bs
)) {
1500 error_setg(errp
, QERR_IO_ERROR
);
1505 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1506 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1510 flags
= state
->old_bs
->open_flags
;
1512 /* create new image w/backing file */
1513 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1514 bdrv_img_create(new_image_file
, format
,
1515 state
->old_bs
->filename
,
1516 state
->old_bs
->drv
->format_name
,
1517 NULL
, -1, flags
, &local_err
, false);
1519 error_propagate(errp
, local_err
);
1524 options
= qdict_new();
1525 if (has_snapshot_node_name
) {
1526 qdict_put(options
, "node-name",
1527 qstring_from_str(snapshot_node_name
));
1529 qdict_put(options
, "driver", qstring_from_str(format
));
1531 /* TODO Inherit bs->options or only take explicit options with an
1532 * extended QMP command? */
1533 assert(state
->new_bs
== NULL
);
1534 ret
= bdrv_open(&state
->new_bs
, new_image_file
, NULL
, options
,
1535 flags
| BDRV_O_NO_BACKING
, &local_err
);
1536 /* We will manually add the backing_hd field to the bs later */
1538 error_propagate(errp
, local_err
);
1542 static void external_snapshot_commit(BlkTransactionState
*common
)
1544 ExternalSnapshotState
*state
=
1545 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1547 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1549 /* This removes our old bs and adds the new bs */
1550 bdrv_append(state
->new_bs
, state
->old_bs
);
1551 /* We don't need (or want) to use the transactional
1552 * bdrv_reopen_multiple() across all the entries at once, because we
1553 * don't want to abort all of them if one of them fails the reopen */
1554 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1557 aio_context_release(state
->aio_context
);
1560 static void external_snapshot_abort(BlkTransactionState
*common
)
1562 ExternalSnapshotState
*state
=
1563 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1564 if (state
->new_bs
) {
1565 bdrv_unref(state
->new_bs
);
1567 if (state
->aio_context
) {
1568 aio_context_release(state
->aio_context
);
1572 typedef struct DriveBackupState
{
1573 BlkTransactionState common
;
1574 BlockDriverState
*bs
;
1575 AioContext
*aio_context
;
1579 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1581 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1583 DriveBackup
*backup
;
1584 Error
*local_err
= NULL
;
1586 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1587 backup
= common
->action
->drive_backup
;
1589 blk
= blk_by_name(backup
->device
);
1591 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1592 "Device '%s' not found", backup
->device
);
1596 /* AioContext is released in .clean() */
1597 state
->aio_context
= blk_get_aio_context(blk
);
1598 aio_context_acquire(state
->aio_context
);
1600 qmp_drive_backup(backup
->device
, backup
->target
,
1601 backup
->has_format
, backup
->format
,
1603 backup
->has_mode
, backup
->mode
,
1604 backup
->has_speed
, backup
->speed
,
1605 backup
->has_bitmap
, backup
->bitmap
,
1606 backup
->has_on_source_error
, backup
->on_source_error
,
1607 backup
->has_on_target_error
, backup
->on_target_error
,
1610 error_propagate(errp
, local_err
);
1614 state
->bs
= blk_bs(blk
);
1615 state
->job
= state
->bs
->job
;
1618 static void drive_backup_abort(BlkTransactionState
*common
)
1620 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1621 BlockDriverState
*bs
= state
->bs
;
1623 /* Only cancel if it's the job we started */
1624 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1625 block_job_cancel_sync(bs
->job
);
1629 static void drive_backup_clean(BlkTransactionState
*common
)
1631 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1633 if (state
->aio_context
) {
1634 aio_context_release(state
->aio_context
);
1638 typedef struct BlockdevBackupState
{
1639 BlkTransactionState common
;
1640 BlockDriverState
*bs
;
1642 AioContext
*aio_context
;
1643 } BlockdevBackupState
;
1645 static void blockdev_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1647 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1648 BlockdevBackup
*backup
;
1649 BlockBackend
*blk
, *target
;
1650 Error
*local_err
= NULL
;
1652 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1653 backup
= common
->action
->blockdev_backup
;
1655 blk
= blk_by_name(backup
->device
);
1657 error_setg(errp
, "Device '%s' not found", backup
->device
);
1661 target
= blk_by_name(backup
->target
);
1663 error_setg(errp
, "Device '%s' not found", backup
->target
);
1667 /* AioContext is released in .clean() */
1668 state
->aio_context
= blk_get_aio_context(blk
);
1669 if (state
->aio_context
!= blk_get_aio_context(target
)) {
1670 state
->aio_context
= NULL
;
1671 error_setg(errp
, "Backup between two IO threads is not implemented");
1674 aio_context_acquire(state
->aio_context
);
1676 qmp_blockdev_backup(backup
->device
, backup
->target
,
1678 backup
->has_speed
, backup
->speed
,
1679 backup
->has_on_source_error
, backup
->on_source_error
,
1680 backup
->has_on_target_error
, backup
->on_target_error
,
1683 error_propagate(errp
, local_err
);
1687 state
->bs
= blk_bs(blk
);
1688 state
->job
= state
->bs
->job
;
1691 static void blockdev_backup_abort(BlkTransactionState
*common
)
1693 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1694 BlockDriverState
*bs
= state
->bs
;
1696 /* Only cancel if it's the job we started */
1697 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1698 block_job_cancel_sync(bs
->job
);
1702 static void blockdev_backup_clean(BlkTransactionState
*common
)
1704 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1706 if (state
->aio_context
) {
1707 aio_context_release(state
->aio_context
);
1711 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1713 error_setg(errp
, "Transaction aborted using Abort action");
1716 static void abort_commit(BlkTransactionState
*common
)
1718 g_assert_not_reached(); /* this action never succeeds */
1721 static const BdrvActionOps actions
[] = {
1722 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1723 .instance_size
= sizeof(ExternalSnapshotState
),
1724 .prepare
= external_snapshot_prepare
,
1725 .commit
= external_snapshot_commit
,
1726 .abort
= external_snapshot_abort
,
1728 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1729 .instance_size
= sizeof(DriveBackupState
),
1730 .prepare
= drive_backup_prepare
,
1731 .abort
= drive_backup_abort
,
1732 .clean
= drive_backup_clean
,
1734 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
1735 .instance_size
= sizeof(BlockdevBackupState
),
1736 .prepare
= blockdev_backup_prepare
,
1737 .abort
= blockdev_backup_abort
,
1738 .clean
= blockdev_backup_clean
,
1740 [TRANSACTION_ACTION_KIND_ABORT
] = {
1741 .instance_size
= sizeof(BlkTransactionState
),
1742 .prepare
= abort_prepare
,
1743 .commit
= abort_commit
,
1745 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1746 .instance_size
= sizeof(InternalSnapshotState
),
1747 .prepare
= internal_snapshot_prepare
,
1748 .abort
= internal_snapshot_abort
,
1749 .clean
= internal_snapshot_clean
,
1754 * 'Atomic' group operations. The operations are performed as a set, and if
1755 * any fail then we roll back all operations in the group.
1757 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1759 TransactionActionList
*dev_entry
= dev_list
;
1760 BlkTransactionState
*state
, *next
;
1761 Error
*local_err
= NULL
;
1763 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1764 QSIMPLEQ_INIT(&snap_bdrv_states
);
1766 /* drain all i/o before any operations */
1769 /* We don't do anything in this loop that commits us to the operations */
1770 while (NULL
!= dev_entry
) {
1771 TransactionAction
*dev_info
= NULL
;
1772 const BdrvActionOps
*ops
;
1774 dev_info
= dev_entry
->value
;
1775 dev_entry
= dev_entry
->next
;
1777 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1779 ops
= &actions
[dev_info
->kind
];
1780 assert(ops
->instance_size
> 0);
1782 state
= g_malloc0(ops
->instance_size
);
1784 state
->action
= dev_info
;
1785 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1787 state
->ops
->prepare(state
, &local_err
);
1789 error_propagate(errp
, local_err
);
1790 goto delete_and_fail
;
1794 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1795 if (state
->ops
->commit
) {
1796 state
->ops
->commit(state
);
1804 /* failure, and it is all-or-none; roll back all operations */
1805 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1806 if (state
->ops
->abort
) {
1807 state
->ops
->abort(state
);
1811 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1812 if (state
->ops
->clean
) {
1813 state
->ops
->clean(state
);
1820 static void eject_device(BlockBackend
*blk
, int force
, Error
**errp
)
1822 BlockDriverState
*bs
= blk_bs(blk
);
1823 AioContext
*aio_context
;
1826 /* No medium inserted, so there is nothing to do */
1830 aio_context
= bdrv_get_aio_context(bs
);
1831 aio_context_acquire(aio_context
);
1833 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
1836 if (!blk_dev_has_removable_media(blk
)) {
1837 error_setg(errp
, "Device '%s' is not removable",
1838 bdrv_get_device_name(bs
));
1842 if (blk_dev_is_medium_locked(blk
) && !blk_dev_is_tray_open(blk
)) {
1843 blk_dev_eject_request(blk
, force
);
1845 error_setg(errp
, "Device '%s' is locked",
1846 bdrv_get_device_name(bs
));
1854 aio_context_release(aio_context
);
1857 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1861 blk
= blk_by_name(device
);
1863 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1864 "Device '%s' not found", device
);
1868 eject_device(blk
, force
, errp
);
1871 void qmp_block_passwd(bool has_device
, const char *device
,
1872 bool has_node_name
, const char *node_name
,
1873 const char *password
, Error
**errp
)
1875 Error
*local_err
= NULL
;
1876 BlockDriverState
*bs
;
1877 AioContext
*aio_context
;
1879 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
1880 has_node_name
? node_name
: NULL
,
1883 error_propagate(errp
, local_err
);
1887 aio_context
= bdrv_get_aio_context(bs
);
1888 aio_context_acquire(aio_context
);
1890 bdrv_add_key(bs
, password
, errp
);
1892 aio_context_release(aio_context
);
1895 /* Assumes AioContext is held */
1896 static void qmp_bdrv_open_encrypted(BlockDriverState
**pbs
,
1897 const char *filename
,
1898 int bdrv_flags
, const char *format
,
1899 const char *password
, Error
**errp
)
1901 Error
*local_err
= NULL
;
1902 QDict
*options
= NULL
;
1906 options
= qdict_new();
1907 qdict_put(options
, "driver", qstring_from_str(format
));
1910 ret
= bdrv_open(pbs
, filename
, NULL
, options
, bdrv_flags
, &local_err
);
1912 error_propagate(errp
, local_err
);
1916 bdrv_add_key(*pbs
, password
, errp
);
1919 void qmp_change_blockdev(const char *device
, const char *filename
,
1920 const char *format
, Error
**errp
)
1923 BlockDriverState
*bs
;
1924 AioContext
*aio_context
;
1929 blk
= blk_by_name(device
);
1931 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1932 "Device '%s' not found", device
);
1938 aio_context
= blk_get_aio_context(blk
);
1939 aio_context_acquire(aio_context
);
1941 eject_device(blk
, 0, &err
);
1943 error_propagate(errp
, err
);
1947 bdrv_flags
= blk_is_read_only(blk
) ? 0 : BDRV_O_RDWR
;
1948 bdrv_flags
|= blk_get_root_state(blk
)->open_flags
& ~BDRV_O_RDWR
;
1950 qmp_bdrv_open_encrypted(&bs
, filename
, bdrv_flags
, format
, NULL
, &err
);
1952 error_propagate(errp
, err
);
1957 blk_insert_bs(blk
, bs
);
1958 /* Has been sent automatically by bdrv_open() if blk_bs(blk) was not
1960 blk_dev_change_media_cb(blk
, true);
1964 aio_context_release(aio_context
);
1967 /* throttling disk I/O limits */
1968 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1975 bool has_bps_rd_max
,
1977 bool has_bps_wr_max
,
1981 bool has_iops_rd_max
,
1982 int64_t iops_rd_max
,
1983 bool has_iops_wr_max
,
1984 int64_t iops_wr_max
,
1988 const char *group
, Error
**errp
)
1991 BlockDriverState
*bs
;
1993 AioContext
*aio_context
;
1995 blk
= blk_by_name(device
);
1997 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1998 "Device '%s' not found", device
);
2002 aio_context
= blk_get_aio_context(blk
);
2003 aio_context_acquire(aio_context
);
2007 error_setg(errp
, "Device '%s' has no medium", device
);
2011 memset(&cfg
, 0, sizeof(cfg
));
2012 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
2013 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
2014 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
2016 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
2017 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
2018 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
2021 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
2023 if (has_bps_rd_max
) {
2024 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
2026 if (has_bps_wr_max
) {
2027 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
2030 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
2032 if (has_iops_rd_max
) {
2033 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
2035 if (has_iops_wr_max
) {
2036 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
2039 if (has_iops_size
) {
2040 cfg
.op_size
= iops_size
;
2043 if (!check_throttle_config(&cfg
, errp
)) {
2047 if (throttle_enabled(&cfg
)) {
2048 /* Enable I/O limits if they're not enabled yet, otherwise
2049 * just update the throttling group. */
2050 if (!bs
->io_limits_enabled
) {
2051 bdrv_io_limits_enable(bs
, has_group
? group
: device
);
2052 } else if (has_group
) {
2053 bdrv_io_limits_update_group(bs
, group
);
2055 /* Set the new throttling configuration */
2056 bdrv_set_io_limits(bs
, &cfg
);
2057 } else if (bs
->io_limits_enabled
) {
2058 /* If all throttling settings are set to 0, disable I/O limits */
2059 bdrv_io_limits_disable(bs
);
2063 aio_context_release(aio_context
);
2066 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2067 bool has_granularity
, uint32_t granularity
,
2070 AioContext
*aio_context
;
2071 BlockDriverState
*bs
;
2073 if (!name
|| name
[0] == '\0') {
2074 error_setg(errp
, "Bitmap name cannot be empty");
2078 bs
= bdrv_lookup_bs(node
, node
, errp
);
2083 aio_context
= bdrv_get_aio_context(bs
);
2084 aio_context_acquire(aio_context
);
2086 if (has_granularity
) {
2087 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2088 error_setg(errp
, "Granularity must be power of 2 "
2089 "and at least 512");
2093 /* Default to cluster size, if available: */
2094 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2097 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2100 aio_context_release(aio_context
);
2103 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2106 AioContext
*aio_context
;
2107 BlockDriverState
*bs
;
2108 BdrvDirtyBitmap
*bitmap
;
2110 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2111 if (!bitmap
|| !bs
) {
2115 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2117 "Bitmap '%s' is currently frozen and cannot be removed",
2121 bdrv_dirty_bitmap_make_anon(bitmap
);
2122 bdrv_release_dirty_bitmap(bs
, bitmap
);
2125 aio_context_release(aio_context
);
2129 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2130 * immediately after a full backup operation.
2132 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2135 AioContext
*aio_context
;
2136 BdrvDirtyBitmap
*bitmap
;
2137 BlockDriverState
*bs
;
2139 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2140 if (!bitmap
|| !bs
) {
2144 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2146 "Bitmap '%s' is currently frozen and cannot be modified",
2149 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2151 "Bitmap '%s' is currently disabled and cannot be cleared",
2156 bdrv_clear_dirty_bitmap(bitmap
);
2159 aio_context_release(aio_context
);
2162 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2164 const char *id
= qdict_get_str(qdict
, "id");
2166 BlockDriverState
*bs
;
2167 AioContext
*aio_context
;
2168 Error
*local_err
= NULL
;
2170 blk
= blk_by_name(id
);
2172 error_report("Device '%s' not found", id
);
2176 if (!blk_legacy_dinfo(blk
)) {
2177 error_report("Deleting device added with blockdev-add"
2178 " is not supported");
2182 aio_context
= blk_get_aio_context(blk
);
2183 aio_context_acquire(aio_context
);
2187 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2188 error_report_err(local_err
);
2189 aio_context_release(aio_context
);
2196 /* if we have a device attached to this BlockDriverState
2197 * then we need to make the drive anonymous until the device
2198 * can be removed. If this is a drive with no device backing
2199 * then we can just get rid of the block driver state right here.
2201 if (blk_get_attached_dev(blk
)) {
2202 blk_hide_on_behalf_of_hmp_drive_del(blk
);
2203 /* Further I/O must not pause the guest */
2204 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
2205 BLOCKDEV_ON_ERROR_REPORT
);
2210 aio_context_release(aio_context
);
2213 void qmp_block_resize(bool has_device
, const char *device
,
2214 bool has_node_name
, const char *node_name
,
2215 int64_t size
, Error
**errp
)
2217 Error
*local_err
= NULL
;
2218 BlockDriverState
*bs
;
2219 AioContext
*aio_context
;
2222 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2223 has_node_name
? node_name
: NULL
,
2226 error_propagate(errp
, local_err
);
2230 aio_context
= bdrv_get_aio_context(bs
);
2231 aio_context_acquire(aio_context
);
2233 if (!bdrv_is_first_non_filter(bs
)) {
2234 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
2239 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2243 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2244 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2248 /* complete all in-flight operations before resizing the device */
2251 ret
= bdrv_truncate(bs
, size
);
2256 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2259 error_setg(errp
, QERR_UNSUPPORTED
);
2262 error_setg(errp
, "Device '%s' is read only", device
);
2265 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2268 error_setg_errno(errp
, -ret
, "Could not resize");
2273 aio_context_release(aio_context
);
2276 static void block_job_cb(void *opaque
, int ret
)
2278 /* Note that this function may be executed from another AioContext besides
2279 * the QEMU main loop. If you need to access anything that assumes the
2280 * QEMU global mutex, use a BH or introduce a mutex.
2283 BlockDriverState
*bs
= opaque
;
2284 const char *msg
= NULL
;
2286 trace_block_job_cb(bs
, bs
->job
, ret
);
2291 msg
= strerror(-ret
);
2294 if (block_job_is_cancelled(bs
->job
)) {
2295 block_job_event_cancelled(bs
->job
);
2297 block_job_event_completed(bs
->job
, msg
);
2300 bdrv_put_ref_bh_schedule(bs
);
2303 void qmp_block_stream(const char *device
,
2304 bool has_base
, const char *base
,
2305 bool has_backing_file
, const char *backing_file
,
2306 bool has_speed
, int64_t speed
,
2307 bool has_on_error
, BlockdevOnError on_error
,
2311 BlockDriverState
*bs
;
2312 BlockDriverState
*base_bs
= NULL
;
2313 AioContext
*aio_context
;
2314 Error
*local_err
= NULL
;
2315 const char *base_name
= NULL
;
2317 if (!has_on_error
) {
2318 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2321 blk
= blk_by_name(device
);
2323 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2324 "Device '%s' not found", device
);
2328 aio_context
= blk_get_aio_context(blk
);
2329 aio_context_acquire(aio_context
);
2331 if (!blk_is_available(blk
)) {
2332 error_setg(errp
, "Device '%s' has no medium", device
);
2337 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_STREAM
, errp
)) {
2342 base_bs
= bdrv_find_backing_image(bs
, base
);
2343 if (base_bs
== NULL
) {
2344 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
2347 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2351 /* if we are streaming the entire chain, the result will have no backing
2352 * file, and specifying one is therefore an error */
2353 if (base_bs
== NULL
&& has_backing_file
) {
2354 error_setg(errp
, "backing file specified, but streaming the "
2359 /* backing_file string overrides base bs filename */
2360 base_name
= has_backing_file
? backing_file
: base_name
;
2362 stream_start(bs
, base_bs
, base_name
, has_speed
? speed
: 0,
2363 on_error
, block_job_cb
, bs
, &local_err
);
2365 error_propagate(errp
, local_err
);
2369 trace_qmp_block_stream(bs
, bs
->job
);
2372 aio_context_release(aio_context
);
2375 void qmp_block_commit(const char *device
,
2376 bool has_base
, const char *base
,
2377 bool has_top
, const char *top
,
2378 bool has_backing_file
, const char *backing_file
,
2379 bool has_speed
, int64_t speed
,
2383 BlockDriverState
*bs
;
2384 BlockDriverState
*base_bs
, *top_bs
;
2385 AioContext
*aio_context
;
2386 Error
*local_err
= NULL
;
2387 /* This will be part of the QMP command, if/when the
2388 * BlockdevOnError change for blkmirror makes it in
2390 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2397 * libvirt relies on the DeviceNotFound error class in order to probe for
2398 * live commit feature versions; for this to work, we must make sure to
2399 * perform the device lookup before any generic errors that may occur in a
2400 * scenario in which all optional arguments are omitted. */
2401 blk
= blk_by_name(device
);
2403 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2404 "Device '%s' not found", device
);
2408 aio_context
= blk_get_aio_context(blk
);
2409 aio_context_acquire(aio_context
);
2411 if (!blk_is_available(blk
)) {
2412 error_setg(errp
, "Device '%s' has no medium", device
);
2417 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
2421 /* default top_bs is the active layer */
2424 if (has_top
&& top
) {
2425 if (strcmp(bs
->filename
, top
) != 0) {
2426 top_bs
= bdrv_find_backing_image(bs
, top
);
2430 if (top_bs
== NULL
) {
2431 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
2435 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
2437 if (has_base
&& base
) {
2438 base_bs
= bdrv_find_backing_image(top_bs
, base
);
2440 base_bs
= bdrv_find_base(top_bs
);
2443 if (base_bs
== NULL
) {
2444 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
2448 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2450 if (bdrv_op_is_blocked(base_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
2454 /* Do not allow attempts to commit an image into itself */
2455 if (top_bs
== base_bs
) {
2456 error_setg(errp
, "cannot commit an image into itself");
2461 if (has_backing_file
) {
2462 error_setg(errp
, "'backing-file' specified,"
2463 " but 'top' is the active layer");
2466 commit_active_start(bs
, base_bs
, speed
, on_error
, block_job_cb
,
2469 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
2470 has_backing_file
? backing_file
: NULL
, &local_err
);
2472 if (local_err
!= NULL
) {
2473 error_propagate(errp
, local_err
);
2478 aio_context_release(aio_context
);
2481 void qmp_drive_backup(const char *device
, const char *target
,
2482 bool has_format
, const char *format
,
2483 enum MirrorSyncMode sync
,
2484 bool has_mode
, enum NewImageMode mode
,
2485 bool has_speed
, int64_t speed
,
2486 bool has_bitmap
, const char *bitmap
,
2487 bool has_on_source_error
, BlockdevOnError on_source_error
,
2488 bool has_on_target_error
, BlockdevOnError on_target_error
,
2492 BlockDriverState
*bs
;
2493 BlockDriverState
*target_bs
;
2494 BlockDriverState
*source
= NULL
;
2495 BdrvDirtyBitmap
*bmap
= NULL
;
2496 AioContext
*aio_context
;
2497 QDict
*options
= NULL
;
2498 Error
*local_err
= NULL
;
2506 if (!has_on_source_error
) {
2507 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2509 if (!has_on_target_error
) {
2510 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2513 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
2516 blk
= blk_by_name(device
);
2518 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2519 "Device '%s' not found", device
);
2523 aio_context
= blk_get_aio_context(blk
);
2524 aio_context_acquire(aio_context
);
2526 /* Although backup_run has this check too, we need to use bs->drv below, so
2527 * do an early check redundantly. */
2528 if (!blk_is_available(blk
)) {
2529 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2535 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
2538 /* Early check to avoid creating target */
2539 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
2543 flags
= bs
->open_flags
| BDRV_O_RDWR
;
2545 /* See if we have a backing HD we can use to create our new image
2547 if (sync
== MIRROR_SYNC_MODE_TOP
) {
2548 source
= backing_bs(bs
);
2550 sync
= MIRROR_SYNC_MODE_FULL
;
2553 if (sync
== MIRROR_SYNC_MODE_NONE
) {
2557 size
= bdrv_getlength(bs
);
2559 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
2563 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
2566 bdrv_img_create(target
, format
, source
->filename
,
2567 source
->drv
->format_name
, NULL
,
2568 size
, flags
, &local_err
, false);
2570 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
2571 size
, flags
, &local_err
, false);
2576 error_propagate(errp
, local_err
);
2581 options
= qdict_new();
2582 qdict_put(options
, "driver", qstring_from_str(format
));
2586 ret
= bdrv_open(&target_bs
, target
, NULL
, options
, flags
, &local_err
);
2588 error_propagate(errp
, local_err
);
2592 bdrv_set_aio_context(target_bs
, aio_context
);
2595 bmap
= bdrv_find_dirty_bitmap(bs
, bitmap
);
2597 error_setg(errp
, "Bitmap '%s' could not be found", bitmap
);
2602 backup_start(bs
, target_bs
, speed
, sync
, bmap
,
2603 on_source_error
, on_target_error
,
2604 block_job_cb
, bs
, &local_err
);
2605 if (local_err
!= NULL
) {
2606 bdrv_unref(target_bs
);
2607 error_propagate(errp
, local_err
);
2612 aio_context_release(aio_context
);
2615 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
2617 return bdrv_named_nodes_list(errp
);
2620 void qmp_blockdev_backup(const char *device
, const char *target
,
2621 enum MirrorSyncMode sync
,
2622 bool has_speed
, int64_t speed
,
2623 bool has_on_source_error
,
2624 BlockdevOnError on_source_error
,
2625 bool has_on_target_error
,
2626 BlockdevOnError on_target_error
,
2629 BlockBackend
*blk
, *target_blk
;
2630 BlockDriverState
*bs
;
2631 BlockDriverState
*target_bs
;
2632 Error
*local_err
= NULL
;
2633 AioContext
*aio_context
;
2638 if (!has_on_source_error
) {
2639 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2641 if (!has_on_target_error
) {
2642 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2645 blk
= blk_by_name(device
);
2647 error_setg(errp
, "Device '%s' not found", device
);
2651 aio_context
= blk_get_aio_context(blk
);
2652 aio_context_acquire(aio_context
);
2654 if (!blk_is_available(blk
)) {
2655 error_setg(errp
, "Device '%s' has no medium", device
);
2660 target_blk
= blk_by_name(target
);
2662 error_setg(errp
, "Device '%s' not found", target
);
2666 if (!blk_is_available(target_blk
)) {
2667 error_setg(errp
, "Device '%s' has no medium", target
);
2670 target_bs
= blk_bs(target_blk
);
2672 bdrv_ref(target_bs
);
2673 bdrv_set_aio_context(target_bs
, aio_context
);
2674 backup_start(bs
, target_bs
, speed
, sync
, NULL
, on_source_error
,
2675 on_target_error
, block_job_cb
, bs
, &local_err
);
2676 if (local_err
!= NULL
) {
2677 bdrv_unref(target_bs
);
2678 error_propagate(errp
, local_err
);
2681 aio_context_release(aio_context
);
2684 void qmp_drive_mirror(const char *device
, const char *target
,
2685 bool has_format
, const char *format
,
2686 bool has_node_name
, const char *node_name
,
2687 bool has_replaces
, const char *replaces
,
2688 enum MirrorSyncMode sync
,
2689 bool has_mode
, enum NewImageMode mode
,
2690 bool has_speed
, int64_t speed
,
2691 bool has_granularity
, uint32_t granularity
,
2692 bool has_buf_size
, int64_t buf_size
,
2693 bool has_on_source_error
, BlockdevOnError on_source_error
,
2694 bool has_on_target_error
, BlockdevOnError on_target_error
,
2695 bool has_unmap
, bool unmap
,
2699 BlockDriverState
*bs
;
2700 BlockDriverState
*source
, *target_bs
;
2701 AioContext
*aio_context
;
2702 Error
*local_err
= NULL
;
2711 if (!has_on_source_error
) {
2712 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2714 if (!has_on_target_error
) {
2715 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2718 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
2720 if (!has_granularity
) {
2723 if (!has_buf_size
) {
2730 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
2731 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
2732 "a value in range [512B, 64MB]");
2735 if (granularity
& (granularity
- 1)) {
2736 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
2741 blk
= blk_by_name(device
);
2743 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2744 "Device '%s' not found", device
);
2748 aio_context
= blk_get_aio_context(blk
);
2749 aio_context_acquire(aio_context
);
2751 if (!blk_is_available(blk
)) {
2752 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2758 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
2761 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR
, errp
)) {
2765 flags
= bs
->open_flags
| BDRV_O_RDWR
;
2766 source
= backing_bs(bs
);
2767 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
2768 sync
= MIRROR_SYNC_MODE_FULL
;
2770 if (sync
== MIRROR_SYNC_MODE_NONE
) {
2774 size
= bdrv_getlength(bs
);
2776 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
2781 BlockDriverState
*to_replace_bs
;
2782 AioContext
*replace_aio_context
;
2783 int64_t replace_size
;
2785 if (!has_node_name
) {
2786 error_setg(errp
, "a node-name must be provided when replacing a"
2787 " named node of the graph");
2791 to_replace_bs
= check_to_replace_node(bs
, replaces
, &local_err
);
2793 if (!to_replace_bs
) {
2794 error_propagate(errp
, local_err
);
2798 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
2799 aio_context_acquire(replace_aio_context
);
2800 replace_size
= bdrv_getlength(to_replace_bs
);
2801 aio_context_release(replace_aio_context
);
2803 if (size
!= replace_size
) {
2804 error_setg(errp
, "cannot replace image with a mirror image of "
2810 if ((sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
2811 && mode
!= NEW_IMAGE_MODE_EXISTING
)
2813 /* create new image w/o backing file */
2815 bdrv_img_create(target
, format
,
2816 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
2819 case NEW_IMAGE_MODE_EXISTING
:
2821 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
2822 /* create new image with backing file */
2823 bdrv_img_create(target
, format
,
2825 source
->drv
->format_name
,
2826 NULL
, size
, flags
, &local_err
, false);
2834 error_propagate(errp
, local_err
);
2838 options
= qdict_new();
2839 if (has_node_name
) {
2840 qdict_put(options
, "node-name", qstring_from_str(node_name
));
2843 qdict_put(options
, "driver", qstring_from_str(format
));
2846 /* Mirroring takes care of copy-on-write using the source's backing
2850 ret
= bdrv_open(&target_bs
, target
, NULL
, options
,
2851 flags
| BDRV_O_NO_BACKING
, &local_err
);
2853 error_propagate(errp
, local_err
);
2857 bdrv_set_aio_context(target_bs
, aio_context
);
2859 /* pass the node name to replace to mirror start since it's loose coupling
2860 * and will allow to check whether the node still exist at mirror completion
2862 mirror_start(bs
, target_bs
,
2863 has_replaces
? replaces
: NULL
,
2864 speed
, granularity
, buf_size
, sync
,
2865 on_source_error
, on_target_error
,
2867 block_job_cb
, bs
, &local_err
);
2868 if (local_err
!= NULL
) {
2869 bdrv_unref(target_bs
);
2870 error_propagate(errp
, local_err
);
2875 aio_context_release(aio_context
);
2878 /* Get the block job for a given device name and acquire its AioContext */
2879 static BlockJob
*find_block_job(const char *device
, AioContext
**aio_context
,
2883 BlockDriverState
*bs
;
2885 *aio_context
= NULL
;
2887 blk
= blk_by_name(device
);
2892 *aio_context
= blk_get_aio_context(blk
);
2893 aio_context_acquire(*aio_context
);
2895 if (!blk_is_available(blk
)) {
2907 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
2908 "No active block job on device '%s'", device
);
2910 aio_context_release(*aio_context
);
2911 *aio_context
= NULL
;
2916 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
2918 AioContext
*aio_context
;
2919 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2925 block_job_set_speed(job
, speed
, errp
);
2926 aio_context_release(aio_context
);
2929 void qmp_block_job_cancel(const char *device
,
2930 bool has_force
, bool force
, Error
**errp
)
2932 AioContext
*aio_context
;
2933 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2943 if (job
->user_paused
&& !force
) {
2944 error_setg(errp
, "The block job for device '%s' is currently paused",
2949 trace_qmp_block_job_cancel(job
);
2950 block_job_cancel(job
);
2952 aio_context_release(aio_context
);
2955 void qmp_block_job_pause(const char *device
, Error
**errp
)
2957 AioContext
*aio_context
;
2958 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2960 if (!job
|| job
->user_paused
) {
2964 job
->user_paused
= true;
2965 trace_qmp_block_job_pause(job
);
2966 block_job_pause(job
);
2967 aio_context_release(aio_context
);
2970 void qmp_block_job_resume(const char *device
, Error
**errp
)
2972 AioContext
*aio_context
;
2973 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2975 if (!job
|| !job
->user_paused
) {
2979 job
->user_paused
= false;
2980 trace_qmp_block_job_resume(job
);
2981 block_job_resume(job
);
2982 aio_context_release(aio_context
);
2985 void qmp_block_job_complete(const char *device
, Error
**errp
)
2987 AioContext
*aio_context
;
2988 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2994 trace_qmp_block_job_complete(job
);
2995 block_job_complete(job
, errp
);
2996 aio_context_release(aio_context
);
2999 void qmp_change_backing_file(const char *device
,
3000 const char *image_node_name
,
3001 const char *backing_file
,
3005 BlockDriverState
*bs
= NULL
;
3006 AioContext
*aio_context
;
3007 BlockDriverState
*image_bs
= NULL
;
3008 Error
*local_err
= NULL
;
3013 blk
= blk_by_name(device
);
3015 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3016 "Device '%s' not found", device
);
3020 aio_context
= blk_get_aio_context(blk
);
3021 aio_context_acquire(aio_context
);
3023 if (!blk_is_available(blk
)) {
3024 error_setg(errp
, "Device '%s' has no medium", device
);
3029 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3031 error_propagate(errp
, local_err
);
3036 error_setg(errp
, "image file not found");
3040 if (bdrv_find_base(image_bs
) == image_bs
) {
3041 error_setg(errp
, "not allowing backing file change on an image "
3042 "without a backing file");
3046 /* even though we are not necessarily operating on bs, we need it to
3047 * determine if block ops are currently prohibited on the chain */
3048 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3052 /* final sanity check */
3053 if (!bdrv_chain_contains(bs
, image_bs
)) {
3054 error_setg(errp
, "'%s' and image file are not in the same chain",
3059 /* if not r/w, reopen to make r/w */
3060 open_flags
= image_bs
->open_flags
;
3061 ro
= bdrv_is_read_only(image_bs
);
3064 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3066 error_propagate(errp
, local_err
);
3071 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3072 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3075 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3077 /* don't exit here, so we can try to restore open flags if
3082 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3084 error_propagate(errp
, local_err
); /* will preserve prior errp */
3089 aio_context_release(aio_context
);
3092 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3094 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
3095 BlockDriverState
*bs
;
3096 BlockBackend
*blk
= NULL
;
3099 Error
*local_err
= NULL
;
3101 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3102 * cache.direct=false instead of silently switching to aio=threads, except
3103 * when called from drive_new().
3105 * For now, simply forbidding the combination for all drivers will do. */
3106 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
3107 bool direct
= options
->has_cache
&&
3108 options
->cache
->has_direct
&&
3109 options
->cache
->direct
;
3111 error_setg(errp
, "aio=native requires cache.direct=true");
3116 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
),
3117 &options
, NULL
, &local_err
);
3119 error_propagate(errp
, local_err
);
3123 obj
= qmp_output_get_qobject(ov
);
3124 qdict
= qobject_to_qdict(obj
);
3126 qdict_flatten(qdict
);
3128 if (options
->has_id
) {
3129 blk
= blockdev_init(NULL
, qdict
, &local_err
);
3131 error_propagate(errp
, local_err
);
3139 if (!qdict_get_try_str(qdict
, "node-name")) {
3140 error_setg(errp
, "'id' and/or 'node-name' need to be specified for "
3146 ret
= bdrv_open(&bs
, NULL
, NULL
, qdict
, BDRV_O_RDWR
| BDRV_O_CACHE_WB
,
3153 if (bs
&& bdrv_key_required(bs
)) {
3159 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3164 qmp_output_visitor_cleanup(ov
);
3167 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3169 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3170 BlockDriverState
*bs
;
3172 for (bs
= bdrv_next(NULL
); bs
; bs
= bdrv_next(bs
)) {
3173 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
3175 aio_context_acquire(aio_context
);
3178 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
3179 elem
->value
= block_job_query(bs
->job
);
3181 p_next
= &elem
->next
;
3184 aio_context_release(aio_context
);
3190 QemuOptsList qemu_common_drive_opts
= {
3192 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
3196 .type
= QEMU_OPT_BOOL
,
3197 .help
= "enable/disable snapshot mode",
3200 .type
= QEMU_OPT_STRING
,
3201 .help
= "discard operation (ignore/off, unmap/on)",
3203 .name
= BDRV_OPT_CACHE_WB
,
3204 .type
= QEMU_OPT_BOOL
,
3205 .help
= "enables writeback mode for any caches",
3207 .name
= BDRV_OPT_CACHE_DIRECT
,
3208 .type
= QEMU_OPT_BOOL
,
3209 .help
= "enables use of O_DIRECT (bypass the host page cache)",
3211 .name
= BDRV_OPT_CACHE_NO_FLUSH
,
3212 .type
= QEMU_OPT_BOOL
,
3213 .help
= "ignore any flush requests for the device",
3216 .type
= QEMU_OPT_STRING
,
3217 .help
= "host AIO implementation (threads, native)",
3220 .type
= QEMU_OPT_STRING
,
3221 .help
= "disk format (raw, qcow2, ...)",
3224 .type
= QEMU_OPT_STRING
,
3225 .help
= "read error action",
3228 .type
= QEMU_OPT_STRING
,
3229 .help
= "write error action",
3231 .name
= "read-only",
3232 .type
= QEMU_OPT_BOOL
,
3233 .help
= "open drive file as read-only",
3235 .name
= "throttling.iops-total",
3236 .type
= QEMU_OPT_NUMBER
,
3237 .help
= "limit total I/O operations per second",
3239 .name
= "throttling.iops-read",
3240 .type
= QEMU_OPT_NUMBER
,
3241 .help
= "limit read operations per second",
3243 .name
= "throttling.iops-write",
3244 .type
= QEMU_OPT_NUMBER
,
3245 .help
= "limit write operations per second",
3247 .name
= "throttling.bps-total",
3248 .type
= QEMU_OPT_NUMBER
,
3249 .help
= "limit total bytes per second",
3251 .name
= "throttling.bps-read",
3252 .type
= QEMU_OPT_NUMBER
,
3253 .help
= "limit read bytes per second",
3255 .name
= "throttling.bps-write",
3256 .type
= QEMU_OPT_NUMBER
,
3257 .help
= "limit write bytes per second",
3259 .name
= "throttling.iops-total-max",
3260 .type
= QEMU_OPT_NUMBER
,
3261 .help
= "I/O operations burst",
3263 .name
= "throttling.iops-read-max",
3264 .type
= QEMU_OPT_NUMBER
,
3265 .help
= "I/O operations read burst",
3267 .name
= "throttling.iops-write-max",
3268 .type
= QEMU_OPT_NUMBER
,
3269 .help
= "I/O operations write burst",
3271 .name
= "throttling.bps-total-max",
3272 .type
= QEMU_OPT_NUMBER
,
3273 .help
= "total bytes burst",
3275 .name
= "throttling.bps-read-max",
3276 .type
= QEMU_OPT_NUMBER
,
3277 .help
= "total bytes read burst",
3279 .name
= "throttling.bps-write-max",
3280 .type
= QEMU_OPT_NUMBER
,
3281 .help
= "total bytes write burst",
3283 .name
= "throttling.iops-size",
3284 .type
= QEMU_OPT_NUMBER
,
3285 .help
= "when limiting by iops max size of an I/O in bytes",
3287 .name
= "throttling.group",
3288 .type
= QEMU_OPT_STRING
,
3289 .help
= "name of the block throttling group",
3291 .name
= "copy-on-read",
3292 .type
= QEMU_OPT_BOOL
,
3293 .help
= "copy read data from backing file into image file",
3295 .name
= "detect-zeroes",
3296 .type
= QEMU_OPT_STRING
,
3297 .help
= "try to optimize zero writes (off, on, unmap)",
3299 { /* end of list */ }
3303 QemuOptsList qemu_drive_opts
= {
3305 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
3308 * no elements => accept any params
3309 * validation will happen later
3311 { /* end of list */ }