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 "qemu/osdep.h"
34 #include "sysemu/block-backend.h"
35 #include "sysemu/blockdev.h"
36 #include "hw/block/block.h"
37 #include "block/blockjob.h"
38 #include "block/throttle-groups.h"
39 #include "monitor/monitor.h"
40 #include "qemu/error-report.h"
41 #include "qemu/option.h"
42 #include "qemu/config-file.h"
43 #include "qapi/qmp/types.h"
44 #include "qapi-visit.h"
45 #include "qapi/qmp/qerror.h"
46 #include "qapi/qmp-output-visitor.h"
47 #include "qapi/util.h"
48 #include "sysemu/sysemu.h"
49 #include "block/block_int.h"
50 #include "qmp-commands.h"
52 #include "sysemu/arch_init.h"
54 static QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
55 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
57 static const char *const if_name
[IF_COUNT
] = {
61 [IF_FLOPPY
] = "floppy",
62 [IF_PFLASH
] = "pflash",
65 [IF_VIRTIO
] = "virtio",
69 static int if_max_devs
[IF_COUNT
] = {
71 * Do not change these numbers! They govern how drive option
72 * index maps to unit and bus. That mapping is ABI.
74 * All controllers used to imlement if=T drives need to support
75 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
76 * Otherwise, some index values map to "impossible" bus, unit
79 * For instance, if you change [IF_SCSI] to 255, -drive
80 * if=scsi,index=12 no longer means bus=1,unit=5, but
81 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
82 * the drive can't be set up. Regression.
89 * Boards may call this to offer board-by-board overrides
90 * of the default, global values.
92 void override_max_devs(BlockInterfaceType type
, int max_devs
)
101 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
102 dinfo
= blk_legacy_dinfo(blk
);
103 if (dinfo
->type
== type
) {
104 fprintf(stderr
, "Cannot override units-per-bus property of"
105 " the %s interface, because a drive of that type has"
106 " already been added.\n", if_name
[type
]);
107 g_assert_not_reached();
111 if_max_devs
[type
] = max_devs
;
115 * We automatically delete the drive when a device using it gets
116 * unplugged. Questionable feature, but we can't just drop it.
117 * Device models call blockdev_mark_auto_del() to schedule the
118 * automatic deletion, and generic qdev code calls blockdev_auto_del()
119 * when deletion is actually safe.
121 void blockdev_mark_auto_del(BlockBackend
*blk
)
123 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
124 BlockDriverState
*bs
= blk_bs(blk
);
125 AioContext
*aio_context
;
132 aio_context
= bdrv_get_aio_context(bs
);
133 aio_context_acquire(aio_context
);
136 block_job_cancel(bs
->job
);
139 aio_context_release(aio_context
);
145 void blockdev_auto_del(BlockBackend
*blk
)
147 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
149 if (dinfo
&& dinfo
->auto_del
) {
155 * Returns the current mapping of how many units per bus
156 * a particular interface can support.
158 * A positive integer indicates n units per bus.
159 * 0 implies the mapping has not been established.
160 * -1 indicates an invalid BlockInterfaceType was given.
162 int drive_get_max_devs(BlockInterfaceType type
)
164 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
165 return if_max_devs
[type
];
171 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
173 int max_devs
= if_max_devs
[type
];
174 return max_devs
? index
/ max_devs
: 0;
177 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
179 int max_devs
= if_max_devs
[type
];
180 return max_devs
? index
% max_devs
: index
;
183 QemuOpts
*drive_def(const char *optstr
)
185 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
188 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
193 opts
= drive_def(optstr
);
197 if (type
!= IF_DEFAULT
) {
198 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
201 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
204 qemu_opt_set(opts
, "file", file
, &error_abort
);
208 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
213 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
214 dinfo
= blk_legacy_dinfo(blk
);
215 if (dinfo
&& dinfo
->type
== type
216 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
224 bool drive_check_orphaned(void)
230 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
231 dinfo
= blk_legacy_dinfo(blk
);
232 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
233 /* Unless this is a default drive, this may be an oversight. */
234 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
235 dinfo
->type
!= IF_NONE
) {
236 fprintf(stderr
, "Warning: Orphaned drive without device: "
237 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
238 blk_name(blk
), blk_bs(blk
) ? blk_bs(blk
)->filename
: "",
239 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
247 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
249 return drive_get(type
,
250 drive_index_to_bus_id(type
, index
),
251 drive_index_to_unit_id(type
, index
));
254 int drive_get_max_bus(BlockInterfaceType type
)
261 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
262 dinfo
= blk_legacy_dinfo(blk
);
263 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
264 max_bus
= dinfo
->bus
;
270 /* Get a block device. This should only be used for single-drive devices
271 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
273 DriveInfo
*drive_get_next(BlockInterfaceType type
)
275 static int next_block_unit
[IF_COUNT
];
277 return drive_get(type
, 0, next_block_unit
[type
]++);
280 static void bdrv_format_print(void *opaque
, const char *name
)
282 error_printf(" %s", name
);
287 BlockDriverState
*bs
;
290 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
292 if (!strcmp(buf
, "ignore")) {
293 return BLOCKDEV_ON_ERROR_IGNORE
;
294 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
295 return BLOCKDEV_ON_ERROR_ENOSPC
;
296 } else if (!strcmp(buf
, "stop")) {
297 return BLOCKDEV_ON_ERROR_STOP
;
298 } else if (!strcmp(buf
, "report")) {
299 return BLOCKDEV_ON_ERROR_REPORT
;
301 error_setg(errp
, "'%s' invalid %s error action",
302 buf
, is_read
? "read" : "write");
307 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
310 const QListEntry
*entry
;
311 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
312 switch (qobject_type(entry
->value
)) {
314 case QTYPE_QSTRING
: {
315 unsigned long long length
;
316 const char *str
= qstring_get_str(qobject_to_qstring(entry
->value
));
317 if (parse_uint_full(str
, &length
, 10) == 0 &&
318 length
> 0 && length
<= UINT_MAX
) {
319 block_acct_add_interval(stats
, (unsigned) length
);
321 error_setg(errp
, "Invalid interval length: %s", str
);
328 int64_t length
= qint_get_int(qobject_to_qint(entry
->value
));
329 if (length
> 0 && length
<= UINT_MAX
) {
330 block_acct_add_interval(stats
, (unsigned) length
);
332 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
339 error_setg(errp
, "The specification of stats-intervals is invalid");
346 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
348 /* All parameters but @opts are optional and may be set to NULL. */
349 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
350 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
351 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
354 Error
*local_error
= NULL
;
358 if (!qemu_opt_get_bool(opts
, "read-only", false)) {
359 *bdrv_flags
|= BDRV_O_RDWR
;
361 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
362 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
365 if ((discard
= qemu_opt_get(opts
, "discard")) != NULL
) {
366 if (bdrv_parse_discard_flags(discard
, bdrv_flags
) != 0) {
367 error_setg(errp
, "Invalid discard option");
372 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
373 if (!strcmp(aio
, "native")) {
374 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
375 } else if (!strcmp(aio
, "threads")) {
376 /* this is the default */
378 error_setg(errp
, "invalid aio option");
384 /* disk I/O throttling */
385 if (throttling_group
) {
386 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
390 memset(throttle_cfg
, 0, sizeof(*throttle_cfg
));
391 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
392 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
393 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
394 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
395 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
396 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
397 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
398 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
399 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
400 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
401 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
402 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
404 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
405 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
406 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
407 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
408 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
409 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
410 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
411 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
412 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
413 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
414 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
415 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
417 throttle_cfg
->op_size
=
418 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
420 if (!throttle_is_valid(throttle_cfg
, errp
)) {
427 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
428 qemu_opt_get(opts
, "detect-zeroes"),
429 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX
,
430 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
433 error_propagate(errp
, local_error
);
438 *detect_zeroes
== BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP
&&
439 !(*bdrv_flags
& BDRV_O_UNMAP
))
441 error_setg(errp
, "setting detect-zeroes to unmap is not allowed "
442 "without setting discard operation to unmap");
448 /* Takes the ownership of bs_opts */
449 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
454 int on_read_error
, on_write_error
;
455 bool account_invalid
, account_failed
;
457 BlockDriverState
*bs
;
462 QDict
*interval_dict
= NULL
;
463 QList
*interval_list
= NULL
;
465 BlockdevDetectZeroesOptions detect_zeroes
=
466 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
467 const char *throttling_group
= NULL
;
469 /* Check common options by copying from bs_opts to opts, all other options
470 * stay in bs_opts for processing by bdrv_open(). */
471 id
= qdict_get_try_str(bs_opts
, "id");
472 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
474 error_propagate(errp
, error
);
478 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
480 error_propagate(errp
, error
);
485 qdict_del(bs_opts
, "id");
488 /* extract parameters */
489 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
491 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
492 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
494 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
495 qdict_array_split(interval_dict
, &interval_list
);
497 if (qdict_size(interval_dict
) != 0) {
498 error_setg(errp
, "Invalid option stats-intervals.%s",
499 qdict_first(interval_dict
)->key
);
503 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
504 &detect_zeroes
, &error
);
506 error_propagate(errp
, error
);
510 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
511 if (is_help_option(buf
)) {
512 error_printf("Supported formats:");
513 bdrv_iterate_format(bdrv_format_print
, NULL
);
518 if (qdict_haskey(bs_opts
, "driver")) {
519 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
522 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
525 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
526 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
527 on_write_error
= parse_block_error_action(buf
, 0, &error
);
529 error_propagate(errp
, error
);
534 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
535 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
536 on_read_error
= parse_block_error_action(buf
, 1, &error
);
538 error_propagate(errp
, error
);
544 bdrv_flags
|= BDRV_O_SNAPSHOT
;
548 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
549 BlockBackendRootState
*blk_rs
;
551 blk
= blk_new(qemu_opts_id(opts
), errp
);
556 blk_rs
= blk_get_root_state(blk
);
557 blk_rs
->open_flags
= bdrv_flags
;
558 blk_rs
->read_only
= !(bdrv_flags
& BDRV_O_RDWR
);
559 blk_rs
->detect_zeroes
= detect_zeroes
;
561 if (throttle_enabled(&cfg
)) {
562 if (!throttling_group
) {
563 throttling_group
= blk_name(blk
);
565 blk_rs
->throttle_group
= g_strdup(throttling_group
);
566 blk_rs
->throttle_state
= throttle_group_incref(throttling_group
);
567 blk_rs
->throttle_state
->cfg
= cfg
;
572 if (file
&& !*file
) {
576 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
577 * with other callers) rather than what we want as the real defaults.
578 * Apply the defaults here instead. */
579 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_WB
, "on");
580 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
581 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
584 /* always use cache=unsafe with snapshot */
585 qdict_put(bs_opts
, BDRV_OPT_CACHE_WB
, qstring_from_str("on"));
586 qdict_put(bs_opts
, BDRV_OPT_CACHE_DIRECT
, qstring_from_str("off"));
587 qdict_put(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, qstring_from_str("on"));
590 if (runstate_check(RUN_STATE_INMIGRATE
)) {
591 bdrv_flags
|= BDRV_O_INACTIVE
;
594 blk
= blk_new_open(qemu_opts_id(opts
), file
, NULL
, bs_opts
, bdrv_flags
,
601 bs
->detect_zeroes
= detect_zeroes
;
603 /* disk I/O throttling */
604 if (throttle_enabled(&cfg
)) {
605 if (!throttling_group
) {
606 throttling_group
= blk_name(blk
);
608 bdrv_io_limits_enable(bs
, throttling_group
);
609 bdrv_set_io_limits(bs
, &cfg
);
612 if (bdrv_key_required(bs
)) {
616 block_acct_init(blk_get_stats(blk
), account_invalid
, account_failed
);
618 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
625 blk_set_on_error(blk
, on_read_error
, on_write_error
);
629 QDECREF(interval_dict
);
630 QDECREF(interval_list
);
635 QDECREF(interval_dict
);
636 QDECREF(interval_list
);
642 static QemuOptsList qemu_root_bds_opts
;
644 /* Takes the ownership of bs_opts */
645 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
647 BlockDriverState
*bs
;
649 Error
*local_error
= NULL
;
650 BlockdevDetectZeroesOptions detect_zeroes
;
654 opts
= qemu_opts_create(&qemu_root_bds_opts
, NULL
, 1, errp
);
659 qemu_opts_absorb_qdict(opts
, bs_opts
, &local_error
);
661 error_propagate(errp
, local_error
);
665 extract_common_blockdev_options(opts
, &bdrv_flags
, NULL
, NULL
,
666 &detect_zeroes
, &local_error
);
668 error_propagate(errp
, local_error
);
672 if (runstate_check(RUN_STATE_INMIGRATE
)) {
673 bdrv_flags
|= BDRV_O_INACTIVE
;
677 ret
= bdrv_open(&bs
, NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
679 goto fail_no_bs_opts
;
682 bs
->detect_zeroes
= detect_zeroes
;
694 void blockdev_close_all_bdrv_states(void)
696 BlockDriverState
*bs
, *next_bs
;
698 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
699 AioContext
*ctx
= bdrv_get_aio_context(bs
);
701 aio_context_acquire(ctx
);
703 aio_context_release(ctx
);
707 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
712 value
= qemu_opt_get(opts
, from
);
714 if (qemu_opt_find(opts
, to
)) {
715 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
716 "same time", to
, from
);
721 /* rename all items in opts */
722 while ((value
= qemu_opt_get(opts
, from
))) {
723 qemu_opt_set(opts
, to
, value
, &error_abort
);
724 qemu_opt_unset(opts
, from
);
728 QemuOptsList qemu_legacy_drive_opts
= {
730 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
734 .type
= QEMU_OPT_NUMBER
,
735 .help
= "bus number",
738 .type
= QEMU_OPT_NUMBER
,
739 .help
= "unit number (i.e. lun for scsi)",
742 .type
= QEMU_OPT_NUMBER
,
743 .help
= "index number",
746 .type
= QEMU_OPT_STRING
,
747 .help
= "media type (disk, cdrom)",
750 .type
= QEMU_OPT_STRING
,
751 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
754 .type
= QEMU_OPT_NUMBER
,
755 .help
= "number of cylinders (ide disk geometry)",
758 .type
= QEMU_OPT_NUMBER
,
759 .help
= "number of heads (ide disk geometry)",
762 .type
= QEMU_OPT_NUMBER
,
763 .help
= "number of sectors (ide disk geometry)",
766 .type
= QEMU_OPT_STRING
,
767 .help
= "chs translation (auto, lba, none)",
770 .type
= QEMU_OPT_BOOL
,
771 .help
= "(deprecated, ignored)",
774 .type
= QEMU_OPT_STRING
,
775 .help
= "pci address (virtio only)",
778 .type
= QEMU_OPT_STRING
,
779 .help
= "disk serial number",
782 .type
= QEMU_OPT_STRING
,
786 /* Options that are passed on, but have special semantics with -drive */
789 .type
= QEMU_OPT_BOOL
,
790 .help
= "open drive file as read-only",
793 .type
= QEMU_OPT_STRING
,
794 .help
= "read error action",
797 .type
= QEMU_OPT_STRING
,
798 .help
= "write error action",
800 .name
= "copy-on-read",
801 .type
= QEMU_OPT_BOOL
,
802 .help
= "copy read data from backing file into image file",
805 { /* end of list */ }
809 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
813 DriveInfo
*dinfo
= NULL
;
815 QemuOpts
*legacy_opts
;
816 DriveMediaType media
= MEDIA_DISK
;
817 BlockInterfaceType type
;
818 int cyls
, heads
, secs
, translation
;
819 int max_devs
, bus_id
, unit_id
, index
;
821 const char *werror
, *rerror
;
822 bool read_only
= false;
825 const char *filename
;
826 Error
*local_err
= NULL
;
829 /* Change legacy command line options into QMP ones */
830 static const struct {
834 { "iops", "throttling.iops-total" },
835 { "iops_rd", "throttling.iops-read" },
836 { "iops_wr", "throttling.iops-write" },
838 { "bps", "throttling.bps-total" },
839 { "bps_rd", "throttling.bps-read" },
840 { "bps_wr", "throttling.bps-write" },
842 { "iops_max", "throttling.iops-total-max" },
843 { "iops_rd_max", "throttling.iops-read-max" },
844 { "iops_wr_max", "throttling.iops-write-max" },
846 { "bps_max", "throttling.bps-total-max" },
847 { "bps_rd_max", "throttling.bps-read-max" },
848 { "bps_wr_max", "throttling.bps-write-max" },
850 { "iops_size", "throttling.iops-size" },
852 { "group", "throttling.group" },
854 { "readonly", "read-only" },
857 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
858 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
861 error_report_err(local_err
);
866 value
= qemu_opt_get(all_opts
, "cache");
870 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
871 error_report("invalid cache option");
875 /* Specific options take precedence */
876 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
877 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
878 !!(flags
& BDRV_O_CACHE_WB
), &error_abort
);
880 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
881 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
882 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
884 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
885 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
886 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
888 qemu_opt_unset(all_opts
, "cache");
891 /* Get a QDict for processing the options */
892 bs_opts
= qdict_new();
893 qemu_opts_to_qdict(all_opts
, bs_opts
);
895 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
897 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
899 error_report_err(local_err
);
903 /* Deprecated option boot=[on|off] */
904 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
905 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
906 "ignored. Future versions will reject this parameter. Please "
907 "update your scripts.\n");
911 value
= qemu_opt_get(legacy_opts
, "media");
913 if (!strcmp(value
, "disk")) {
915 } else if (!strcmp(value
, "cdrom")) {
919 error_report("'%s' invalid media", value
);
924 /* copy-on-read is disabled with a warning for read-only devices */
925 read_only
|= qemu_opt_get_bool(legacy_opts
, "read-only", false);
926 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
928 if (read_only
&& copy_on_read
) {
929 error_report("warning: disabling copy-on-read on read-only drive");
930 copy_on_read
= false;
933 qdict_put(bs_opts
, "read-only",
934 qstring_from_str(read_only
? "on" : "off"));
935 qdict_put(bs_opts
, "copy-on-read",
936 qstring_from_str(copy_on_read
? "on" :"off"));
938 /* Controller type */
939 value
= qemu_opt_get(legacy_opts
, "if");
942 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
945 if (type
== IF_COUNT
) {
946 error_report("unsupported bus type '%s'", value
);
950 type
= block_default_type
;
954 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
955 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
956 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
958 if (cyls
|| heads
|| secs
) {
960 error_report("invalid physical cyls number");
964 error_report("invalid physical heads number");
968 error_report("invalid physical secs number");
973 translation
= BIOS_ATA_TRANSLATION_AUTO
;
974 value
= qemu_opt_get(legacy_opts
, "trans");
977 error_report("'%s' trans must be used with cyls, heads and secs",
981 if (!strcmp(value
, "none")) {
982 translation
= BIOS_ATA_TRANSLATION_NONE
;
983 } else if (!strcmp(value
, "lba")) {
984 translation
= BIOS_ATA_TRANSLATION_LBA
;
985 } else if (!strcmp(value
, "large")) {
986 translation
= BIOS_ATA_TRANSLATION_LARGE
;
987 } else if (!strcmp(value
, "rechs")) {
988 translation
= BIOS_ATA_TRANSLATION_RECHS
;
989 } else if (!strcmp(value
, "auto")) {
990 translation
= BIOS_ATA_TRANSLATION_AUTO
;
992 error_report("'%s' invalid translation type", value
);
997 if (media
== MEDIA_CDROM
) {
998 if (cyls
|| secs
|| heads
) {
999 error_report("CHS can't be set with media=cdrom");
1004 /* Device address specified by bus/unit or index.
1005 * If none was specified, try to find the first free one. */
1006 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
1007 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
1008 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
1010 max_devs
= if_max_devs
[type
];
1013 if (bus_id
!= 0 || unit_id
!= -1) {
1014 error_report("index cannot be used with bus and unit");
1017 bus_id
= drive_index_to_bus_id(type
, index
);
1018 unit_id
= drive_index_to_unit_id(type
, index
);
1021 if (unit_id
== -1) {
1023 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1025 if (max_devs
&& unit_id
>= max_devs
) {
1026 unit_id
-= max_devs
;
1032 if (max_devs
&& unit_id
>= max_devs
) {
1033 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
1037 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1038 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1039 bus_id
, unit_id
, index
);
1044 serial
= qemu_opt_get(legacy_opts
, "serial");
1046 /* no id supplied -> create one */
1047 if (qemu_opts_id(all_opts
) == NULL
) {
1049 const char *mediastr
= "";
1050 if (type
== IF_IDE
|| type
== IF_SCSI
) {
1051 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
1054 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
1057 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
1060 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
1064 /* Add virtio block device */
1065 devaddr
= qemu_opt_get(legacy_opts
, "addr");
1066 if (devaddr
&& type
!= IF_VIRTIO
) {
1067 error_report("addr is not supported by this bus type");
1071 if (type
== IF_VIRTIO
) {
1073 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
1075 if (arch_type
== QEMU_ARCH_S390X
) {
1076 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
1078 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
1080 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
1083 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
1087 filename
= qemu_opt_get(legacy_opts
, "file");
1089 /* Check werror/rerror compatibility with if=... */
1090 werror
= qemu_opt_get(legacy_opts
, "werror");
1091 if (werror
!= NULL
) {
1092 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
1094 error_report("werror is not supported by this bus type");
1097 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
1100 rerror
= qemu_opt_get(legacy_opts
, "rerror");
1101 if (rerror
!= NULL
) {
1102 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
1104 error_report("rerror is not supported by this bus type");
1107 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
1110 /* Actual block device init: Functionality shared with blockdev-add */
1111 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
1115 error_report_err(local_err
);
1122 /* Create legacy DriveInfo */
1123 dinfo
= g_malloc0(sizeof(*dinfo
));
1124 dinfo
->opts
= all_opts
;
1127 dinfo
->heads
= heads
;
1129 dinfo
->trans
= translation
;
1132 dinfo
->bus
= bus_id
;
1133 dinfo
->unit
= unit_id
;
1134 dinfo
->devaddr
= devaddr
;
1135 dinfo
->serial
= g_strdup(serial
);
1137 blk_set_legacy_dinfo(blk
, dinfo
);
1144 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1151 qemu_opts_del(legacy_opts
);
1156 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1158 const char *device
= qdict_get_str(qdict
, "device");
1162 if (!strcmp(device
, "all")) {
1163 ret
= bdrv_commit_all();
1165 BlockDriverState
*bs
;
1166 AioContext
*aio_context
;
1168 blk
= blk_by_name(device
);
1170 monitor_printf(mon
, "Device '%s' not found\n", device
);
1173 if (!blk_is_available(blk
)) {
1174 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1179 aio_context
= bdrv_get_aio_context(bs
);
1180 aio_context_acquire(aio_context
);
1182 ret
= bdrv_commit(bs
);
1184 aio_context_release(aio_context
);
1187 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1192 static void blockdev_do_action(TransactionActionKind type
, void *data
,
1195 TransactionAction action
;
1196 TransactionActionList list
;
1199 action
.u
.data
= data
;
1200 list
.value
= &action
;
1202 qmp_transaction(&list
, false, NULL
, errp
);
1205 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1206 bool has_node_name
, const char *node_name
,
1207 const char *snapshot_file
,
1208 bool has_snapshot_node_name
,
1209 const char *snapshot_node_name
,
1210 bool has_format
, const char *format
,
1211 bool has_mode
, NewImageMode mode
, Error
**errp
)
1213 BlockdevSnapshotSync snapshot
= {
1214 .has_device
= has_device
,
1215 .device
= (char *) device
,
1216 .has_node_name
= has_node_name
,
1217 .node_name
= (char *) node_name
,
1218 .snapshot_file
= (char *) snapshot_file
,
1219 .has_snapshot_node_name
= has_snapshot_node_name
,
1220 .snapshot_node_name
= (char *) snapshot_node_name
,
1221 .has_format
= has_format
,
1222 .format
= (char *) format
,
1223 .has_mode
= has_mode
,
1226 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1230 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1233 BlockdevSnapshot snapshot_data
= {
1234 .node
= (char *) node
,
1235 .overlay
= (char *) overlay
1238 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1239 &snapshot_data
, errp
);
1242 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1246 BlockdevSnapshotInternal snapshot
= {
1247 .device
= (char *) device
,
1248 .name
= (char *) name
1251 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1255 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1262 BlockDriverState
*bs
;
1264 AioContext
*aio_context
;
1265 QEMUSnapshotInfo sn
;
1266 Error
*local_err
= NULL
;
1267 SnapshotInfo
*info
= NULL
;
1270 blk
= blk_by_name(device
);
1272 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1273 "Device '%s' not found", device
);
1277 aio_context
= blk_get_aio_context(blk
);
1278 aio_context_acquire(aio_context
);
1289 error_setg(errp
, "Name or id must be provided");
1290 goto out_aio_context
;
1293 if (!blk_is_available(blk
)) {
1294 error_setg(errp
, "Device '%s' has no medium", device
);
1295 goto out_aio_context
;
1299 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1300 goto out_aio_context
;
1303 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1305 error_propagate(errp
, local_err
);
1306 goto out_aio_context
;
1310 "Snapshot with id '%s' and name '%s' does not exist on "
1312 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1313 goto out_aio_context
;
1316 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1318 error_propagate(errp
, local_err
);
1319 goto out_aio_context
;
1322 aio_context_release(aio_context
);
1324 info
= g_new0(SnapshotInfo
, 1);
1325 info
->id
= g_strdup(sn
.id_str
);
1326 info
->name
= g_strdup(sn
.name
);
1327 info
->date_nsec
= sn
.date_nsec
;
1328 info
->date_sec
= sn
.date_sec
;
1329 info
->vm_state_size
= sn
.vm_state_size
;
1330 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1331 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1336 aio_context_release(aio_context
);
1341 * block_dirty_bitmap_lookup:
1342 * Return a dirty bitmap (if present), after validating
1343 * the node reference and bitmap names.
1345 * @node: The name of the BDS node to search for bitmaps
1346 * @name: The name of the bitmap to search for
1347 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1348 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1349 * @errp: Output pointer for error information. Can be NULL.
1351 * @return: A bitmap object on success, or NULL on failure.
1353 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1355 BlockDriverState
**pbs
,
1359 BlockDriverState
*bs
;
1360 BdrvDirtyBitmap
*bitmap
;
1361 AioContext
*aio_context
;
1364 error_setg(errp
, "Node cannot be NULL");
1368 error_setg(errp
, "Bitmap name cannot be NULL");
1371 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1373 error_setg(errp
, "Node '%s' not found", node
);
1377 aio_context
= bdrv_get_aio_context(bs
);
1378 aio_context_acquire(aio_context
);
1380 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1382 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1390 *paio
= aio_context
;
1392 aio_context_release(aio_context
);
1398 aio_context_release(aio_context
);
1402 /* New and old BlockDriverState structs for atomic group operations */
1404 typedef struct BlkActionState BlkActionState
;
1408 * Table of operations that define an Action.
1410 * @instance_size: Size of state struct, in bytes.
1411 * @prepare: Prepare the work, must NOT be NULL.
1412 * @commit: Commit the changes, can be NULL.
1413 * @abort: Abort the changes on fail, can be NULL.
1414 * @clean: Clean up resources after all transaction actions have called
1415 * commit() or abort(). Can be NULL.
1417 * Only prepare() may fail. In a single transaction, only one of commit() or
1418 * abort() will be called. clean() will always be called if it is present.
1420 typedef struct BlkActionOps
{
1421 size_t instance_size
;
1422 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1423 void (*commit
)(BlkActionState
*common
);
1424 void (*abort
)(BlkActionState
*common
);
1425 void (*clean
)(BlkActionState
*common
);
1430 * Describes one Action's state within a Transaction.
1432 * @action: QAPI-defined enum identifying which Action to perform.
1433 * @ops: Table of ActionOps this Action can perform.
1434 * @block_job_txn: Transaction which this action belongs to.
1435 * @entry: List membership for all Actions in this Transaction.
1437 * This structure must be arranged as first member in a subclassed type,
1438 * assuming that the compiler will also arrange it to the same offsets as the
1441 struct BlkActionState
{
1442 TransactionAction
*action
;
1443 const BlkActionOps
*ops
;
1444 BlockJobTxn
*block_job_txn
;
1445 TransactionProperties
*txn_props
;
1446 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1449 /* internal snapshot private data */
1450 typedef struct InternalSnapshotState
{
1451 BlkActionState common
;
1452 BlockDriverState
*bs
;
1453 AioContext
*aio_context
;
1454 QEMUSnapshotInfo sn
;
1456 } InternalSnapshotState
;
1459 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1461 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1463 "Action '%s' does not support Transaction property "
1464 "completion-mode = %s",
1465 TransactionActionKind_lookup
[s
->action
->type
],
1466 ActionCompletionMode_lookup
[s
->txn_props
->completion_mode
]);
1472 static void internal_snapshot_prepare(BlkActionState
*common
,
1475 Error
*local_err
= NULL
;
1479 BlockDriverState
*bs
;
1480 QEMUSnapshotInfo old_sn
, *sn
;
1483 BlockdevSnapshotInternal
*internal
;
1484 InternalSnapshotState
*state
;
1487 g_assert(common
->action
->type
==
1488 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1489 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
;
1490 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1492 /* 1. parse input */
1493 device
= internal
->device
;
1494 name
= internal
->name
;
1496 /* 2. check for validation */
1497 if (action_check_completion_mode(common
, errp
) < 0) {
1501 blk
= blk_by_name(device
);
1503 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1504 "Device '%s' not found", device
);
1508 /* AioContext is released in .clean() */
1509 state
->aio_context
= blk_get_aio_context(blk
);
1510 aio_context_acquire(state
->aio_context
);
1512 if (!blk_is_available(blk
)) {
1513 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1519 bdrv_drained_begin(bs
);
1521 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1525 if (bdrv_is_read_only(bs
)) {
1526 error_setg(errp
, "Device '%s' is read only", device
);
1530 if (!bdrv_can_snapshot(bs
)) {
1531 error_setg(errp
, "Block format '%s' used by device '%s' "
1532 "does not support internal snapshots",
1533 bs
->drv
->format_name
, device
);
1537 if (!strlen(name
)) {
1538 error_setg(errp
, "Name is empty");
1542 /* check whether a snapshot with name exist */
1543 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1546 error_propagate(errp
, local_err
);
1550 "Snapshot with name '%s' already exists on device '%s'",
1555 /* 3. take the snapshot */
1557 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1558 qemu_gettimeofday(&tv
);
1559 sn
->date_sec
= tv
.tv_sec
;
1560 sn
->date_nsec
= tv
.tv_usec
* 1000;
1561 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1563 ret1
= bdrv_snapshot_create(bs
, sn
);
1565 error_setg_errno(errp
, -ret1
,
1566 "Failed to create snapshot '%s' on device '%s'",
1571 /* 4. succeed, mark a snapshot is created */
1572 state
->created
= true;
1575 static void internal_snapshot_abort(BlkActionState
*common
)
1577 InternalSnapshotState
*state
=
1578 DO_UPCAST(InternalSnapshotState
, common
, common
);
1579 BlockDriverState
*bs
= state
->bs
;
1580 QEMUSnapshotInfo
*sn
= &state
->sn
;
1581 Error
*local_error
= NULL
;
1583 if (!state
->created
) {
1587 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1588 error_reportf_err(local_error
,
1589 "Failed to delete snapshot with id '%s' and "
1590 "name '%s' on device '%s' in abort: ",
1591 sn
->id_str
, sn
->name
,
1592 bdrv_get_device_name(bs
));
1596 static void internal_snapshot_clean(BlkActionState
*common
)
1598 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1601 if (state
->aio_context
) {
1603 bdrv_drained_end(state
->bs
);
1605 aio_context_release(state
->aio_context
);
1609 /* external snapshot private data */
1610 typedef struct ExternalSnapshotState
{
1611 BlkActionState common
;
1612 BlockDriverState
*old_bs
;
1613 BlockDriverState
*new_bs
;
1614 AioContext
*aio_context
;
1615 } ExternalSnapshotState
;
1617 static void external_snapshot_prepare(BlkActionState
*common
,
1621 QDict
*options
= NULL
;
1622 Error
*local_err
= NULL
;
1623 /* Device and node name of the image to generate the snapshot from */
1625 const char *node_name
;
1626 /* Reference to the new image (for 'blockdev-snapshot') */
1627 const char *snapshot_ref
;
1628 /* File name of the new image (for 'blockdev-snapshot-sync') */
1629 const char *new_image_file
;
1630 ExternalSnapshotState
*state
=
1631 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1632 TransactionAction
*action
= common
->action
;
1634 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1635 * purpose but a different set of parameters */
1636 switch (action
->type
) {
1637 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1639 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
;
1641 node_name
= s
->node
;
1642 new_image_file
= NULL
;
1643 snapshot_ref
= s
->overlay
;
1646 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1648 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
;
1649 device
= s
->has_device
? s
->device
: NULL
;
1650 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1651 new_image_file
= s
->snapshot_file
;
1652 snapshot_ref
= NULL
;
1656 g_assert_not_reached();
1659 /* start processing */
1660 if (action_check_completion_mode(common
, errp
) < 0) {
1664 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1665 if (!state
->old_bs
) {
1669 /* Acquire AioContext now so any threads operating on old_bs stop */
1670 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1671 aio_context_acquire(state
->aio_context
);
1672 bdrv_drained_begin(state
->old_bs
);
1674 if (!bdrv_is_inserted(state
->old_bs
)) {
1675 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1679 if (bdrv_op_is_blocked(state
->old_bs
,
1680 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1684 if (!bdrv_is_read_only(state
->old_bs
)) {
1685 if (bdrv_flush(state
->old_bs
)) {
1686 error_setg(errp
, QERR_IO_ERROR
);
1691 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1692 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1696 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1697 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
;
1698 const char *format
= s
->has_format
? s
->format
: "qcow2";
1699 enum NewImageMode mode
;
1700 const char *snapshot_node_name
=
1701 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1703 if (node_name
&& !snapshot_node_name
) {
1704 error_setg(errp
, "New snapshot node name missing");
1708 if (snapshot_node_name
&&
1709 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1710 error_setg(errp
, "New snapshot node name already in use");
1714 flags
= state
->old_bs
->open_flags
;
1716 /* create new image w/backing file */
1717 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1718 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1719 bdrv_img_create(new_image_file
, format
,
1720 state
->old_bs
->filename
,
1721 state
->old_bs
->drv
->format_name
,
1722 NULL
, -1, flags
, &local_err
, false);
1724 error_propagate(errp
, local_err
);
1729 options
= qdict_new();
1730 if (s
->has_snapshot_node_name
) {
1731 qdict_put(options
, "node-name",
1732 qstring_from_str(snapshot_node_name
));
1734 qdict_put(options
, "driver", qstring_from_str(format
));
1736 flags
|= BDRV_O_NO_BACKING
;
1739 assert(state
->new_bs
== NULL
);
1740 ret
= bdrv_open(&state
->new_bs
, new_image_file
, snapshot_ref
, options
,
1742 /* We will manually add the backing_hd field to the bs later */
1747 if (state
->new_bs
->blk
!= NULL
) {
1748 error_setg(errp
, "The snapshot is already in use by %s",
1749 blk_name(state
->new_bs
->blk
));
1753 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1758 if (state
->new_bs
->backing
!= NULL
) {
1759 error_setg(errp
, "The snapshot already has a backing image");
1763 if (!state
->new_bs
->drv
->supports_backing
) {
1764 error_setg(errp
, "The snapshot does not support backing images");
1768 static void external_snapshot_commit(BlkActionState
*common
)
1770 ExternalSnapshotState
*state
=
1771 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1773 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1775 /* This removes our old bs and adds the new bs */
1776 bdrv_append(state
->new_bs
, state
->old_bs
);
1777 /* We don't need (or want) to use the transactional
1778 * bdrv_reopen_multiple() across all the entries at once, because we
1779 * don't want to abort all of them if one of them fails the reopen */
1780 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1784 static void external_snapshot_abort(BlkActionState
*common
)
1786 ExternalSnapshotState
*state
=
1787 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1788 if (state
->new_bs
) {
1789 bdrv_unref(state
->new_bs
);
1793 static void external_snapshot_clean(BlkActionState
*common
)
1795 ExternalSnapshotState
*state
=
1796 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1797 if (state
->aio_context
) {
1798 bdrv_drained_end(state
->old_bs
);
1799 aio_context_release(state
->aio_context
);
1803 typedef struct DriveBackupState
{
1804 BlkActionState common
;
1805 BlockDriverState
*bs
;
1806 AioContext
*aio_context
;
1810 static void do_drive_backup(const char *device
, const char *target
,
1811 bool has_format
, const char *format
,
1812 enum MirrorSyncMode sync
,
1813 bool has_mode
, enum NewImageMode mode
,
1814 bool has_speed
, int64_t speed
,
1815 bool has_bitmap
, const char *bitmap
,
1816 bool has_on_source_error
,
1817 BlockdevOnError on_source_error
,
1818 bool has_on_target_error
,
1819 BlockdevOnError on_target_error
,
1820 BlockJobTxn
*txn
, Error
**errp
);
1822 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1824 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1826 DriveBackup
*backup
;
1827 Error
*local_err
= NULL
;
1829 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1830 backup
= common
->action
->u
.drive_backup
;
1832 blk
= blk_by_name(backup
->device
);
1834 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1835 "Device '%s' not found", backup
->device
);
1839 if (!blk_is_available(blk
)) {
1840 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, backup
->device
);
1844 /* AioContext is released in .clean() */
1845 state
->aio_context
= blk_get_aio_context(blk
);
1846 aio_context_acquire(state
->aio_context
);
1847 bdrv_drained_begin(blk_bs(blk
));
1848 state
->bs
= blk_bs(blk
);
1850 do_drive_backup(backup
->device
, backup
->target
,
1851 backup
->has_format
, backup
->format
,
1853 backup
->has_mode
, backup
->mode
,
1854 backup
->has_speed
, backup
->speed
,
1855 backup
->has_bitmap
, backup
->bitmap
,
1856 backup
->has_on_source_error
, backup
->on_source_error
,
1857 backup
->has_on_target_error
, backup
->on_target_error
,
1858 common
->block_job_txn
, &local_err
);
1860 error_propagate(errp
, local_err
);
1864 state
->job
= state
->bs
->job
;
1867 static void drive_backup_abort(BlkActionState
*common
)
1869 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1870 BlockDriverState
*bs
= state
->bs
;
1872 /* Only cancel if it's the job we started */
1873 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1874 block_job_cancel_sync(bs
->job
);
1878 static void drive_backup_clean(BlkActionState
*common
)
1880 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1882 if (state
->aio_context
) {
1883 bdrv_drained_end(state
->bs
);
1884 aio_context_release(state
->aio_context
);
1888 typedef struct BlockdevBackupState
{
1889 BlkActionState common
;
1890 BlockDriverState
*bs
;
1892 AioContext
*aio_context
;
1893 } BlockdevBackupState
;
1895 static void do_blockdev_backup(const char *device
, const char *target
,
1896 enum MirrorSyncMode sync
,
1897 bool has_speed
, int64_t speed
,
1898 bool has_on_source_error
,
1899 BlockdevOnError on_source_error
,
1900 bool has_on_target_error
,
1901 BlockdevOnError on_target_error
,
1902 BlockJobTxn
*txn
, Error
**errp
);
1904 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1906 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1907 BlockdevBackup
*backup
;
1908 BlockBackend
*blk
, *target
;
1909 Error
*local_err
= NULL
;
1911 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1912 backup
= common
->action
->u
.blockdev_backup
;
1914 blk
= blk_by_name(backup
->device
);
1916 error_setg(errp
, "Device '%s' not found", backup
->device
);
1920 if (!blk_is_available(blk
)) {
1921 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, backup
->device
);
1925 target
= blk_by_name(backup
->target
);
1927 error_setg(errp
, "Device '%s' not found", backup
->target
);
1931 /* AioContext is released in .clean() */
1932 state
->aio_context
= blk_get_aio_context(blk
);
1933 if (state
->aio_context
!= blk_get_aio_context(target
)) {
1934 state
->aio_context
= NULL
;
1935 error_setg(errp
, "Backup between two IO threads is not implemented");
1938 aio_context_acquire(state
->aio_context
);
1939 state
->bs
= blk_bs(blk
);
1940 bdrv_drained_begin(state
->bs
);
1942 do_blockdev_backup(backup
->device
, backup
->target
,
1944 backup
->has_speed
, backup
->speed
,
1945 backup
->has_on_source_error
, backup
->on_source_error
,
1946 backup
->has_on_target_error
, backup
->on_target_error
,
1947 common
->block_job_txn
, &local_err
);
1949 error_propagate(errp
, local_err
);
1953 state
->job
= state
->bs
->job
;
1956 static void blockdev_backup_abort(BlkActionState
*common
)
1958 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1959 BlockDriverState
*bs
= state
->bs
;
1961 /* Only cancel if it's the job we started */
1962 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1963 block_job_cancel_sync(bs
->job
);
1967 static void blockdev_backup_clean(BlkActionState
*common
)
1969 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1971 if (state
->aio_context
) {
1972 bdrv_drained_end(state
->bs
);
1973 aio_context_release(state
->aio_context
);
1977 typedef struct BlockDirtyBitmapState
{
1978 BlkActionState common
;
1979 BdrvDirtyBitmap
*bitmap
;
1980 BlockDriverState
*bs
;
1981 AioContext
*aio_context
;
1984 } BlockDirtyBitmapState
;
1986 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1989 Error
*local_err
= NULL
;
1990 BlockDirtyBitmapAdd
*action
;
1991 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1994 if (action_check_completion_mode(common
, errp
) < 0) {
1998 action
= common
->action
->u
.block_dirty_bitmap_add
;
1999 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2000 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
2001 action
->has_granularity
, action
->granularity
,
2005 state
->prepared
= true;
2007 error_propagate(errp
, local_err
);
2011 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
2013 BlockDirtyBitmapAdd
*action
;
2014 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2017 action
= common
->action
->u
.block_dirty_bitmap_add
;
2018 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2019 * then the node reference and bitmap name must have been valid.
2021 if (state
->prepared
) {
2022 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
2026 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
2029 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2031 BlockDirtyBitmap
*action
;
2033 if (action_check_completion_mode(common
, errp
) < 0) {
2037 action
= common
->action
->u
.block_dirty_bitmap_clear
;
2038 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2041 &state
->aio_context
,
2043 if (!state
->bitmap
) {
2047 if (bdrv_dirty_bitmap_frozen(state
->bitmap
)) {
2048 error_setg(errp
, "Cannot modify a frozen bitmap");
2050 } else if (!bdrv_dirty_bitmap_enabled(state
->bitmap
)) {
2051 error_setg(errp
, "Cannot clear a disabled bitmap");
2055 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2056 /* AioContext is released in .clean() */
2059 static void block_dirty_bitmap_clear_abort(BlkActionState
*common
)
2061 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2064 bdrv_undo_clear_dirty_bitmap(state
->bitmap
, state
->backup
);
2067 static void block_dirty_bitmap_clear_commit(BlkActionState
*common
)
2069 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2072 hbitmap_free(state
->backup
);
2075 static void block_dirty_bitmap_clear_clean(BlkActionState
*common
)
2077 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2080 if (state
->aio_context
) {
2081 aio_context_release(state
->aio_context
);
2085 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2087 error_setg(errp
, "Transaction aborted using Abort action");
2090 static void abort_commit(BlkActionState
*common
)
2092 g_assert_not_reached(); /* this action never succeeds */
2095 static const BlkActionOps actions
[] = {
2096 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2097 .instance_size
= sizeof(ExternalSnapshotState
),
2098 .prepare
= external_snapshot_prepare
,
2099 .commit
= external_snapshot_commit
,
2100 .abort
= external_snapshot_abort
,
2101 .clean
= external_snapshot_clean
,
2103 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2104 .instance_size
= sizeof(ExternalSnapshotState
),
2105 .prepare
= external_snapshot_prepare
,
2106 .commit
= external_snapshot_commit
,
2107 .abort
= external_snapshot_abort
,
2108 .clean
= external_snapshot_clean
,
2110 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2111 .instance_size
= sizeof(DriveBackupState
),
2112 .prepare
= drive_backup_prepare
,
2113 .abort
= drive_backup_abort
,
2114 .clean
= drive_backup_clean
,
2116 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2117 .instance_size
= sizeof(BlockdevBackupState
),
2118 .prepare
= blockdev_backup_prepare
,
2119 .abort
= blockdev_backup_abort
,
2120 .clean
= blockdev_backup_clean
,
2122 [TRANSACTION_ACTION_KIND_ABORT
] = {
2123 .instance_size
= sizeof(BlkActionState
),
2124 .prepare
= abort_prepare
,
2125 .commit
= abort_commit
,
2127 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2128 .instance_size
= sizeof(InternalSnapshotState
),
2129 .prepare
= internal_snapshot_prepare
,
2130 .abort
= internal_snapshot_abort
,
2131 .clean
= internal_snapshot_clean
,
2133 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2134 .instance_size
= sizeof(BlockDirtyBitmapState
),
2135 .prepare
= block_dirty_bitmap_add_prepare
,
2136 .abort
= block_dirty_bitmap_add_abort
,
2138 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2139 .instance_size
= sizeof(BlockDirtyBitmapState
),
2140 .prepare
= block_dirty_bitmap_clear_prepare
,
2141 .commit
= block_dirty_bitmap_clear_commit
,
2142 .abort
= block_dirty_bitmap_clear_abort
,
2143 .clean
= block_dirty_bitmap_clear_clean
,
2148 * Allocate a TransactionProperties structure if necessary, and fill
2149 * that structure with desired defaults if they are unset.
2151 static TransactionProperties
*get_transaction_properties(
2152 TransactionProperties
*props
)
2155 props
= g_new0(TransactionProperties
, 1);
2158 if (!props
->has_completion_mode
) {
2159 props
->has_completion_mode
= true;
2160 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2167 * 'Atomic' group operations. The operations are performed as a set, and if
2168 * any fail then we roll back all operations in the group.
2170 void qmp_transaction(TransactionActionList
*dev_list
,
2172 struct TransactionProperties
*props
,
2175 TransactionActionList
*dev_entry
= dev_list
;
2176 BlockJobTxn
*block_job_txn
= NULL
;
2177 BlkActionState
*state
, *next
;
2178 Error
*local_err
= NULL
;
2180 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkActionState
) snap_bdrv_states
;
2181 QSIMPLEQ_INIT(&snap_bdrv_states
);
2183 /* Does this transaction get canceled as a group on failure?
2184 * If not, we don't really need to make a BlockJobTxn.
2186 props
= get_transaction_properties(props
);
2187 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2188 block_job_txn
= block_job_txn_new();
2191 /* drain all i/o before any operations */
2194 /* We don't do anything in this loop that commits us to the operations */
2195 while (NULL
!= dev_entry
) {
2196 TransactionAction
*dev_info
= NULL
;
2197 const BlkActionOps
*ops
;
2199 dev_info
= dev_entry
->value
;
2200 dev_entry
= dev_entry
->next
;
2202 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2204 ops
= &actions
[dev_info
->type
];
2205 assert(ops
->instance_size
> 0);
2207 state
= g_malloc0(ops
->instance_size
);
2209 state
->action
= dev_info
;
2210 state
->block_job_txn
= block_job_txn
;
2211 state
->txn_props
= props
;
2212 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2214 state
->ops
->prepare(state
, &local_err
);
2216 error_propagate(errp
, local_err
);
2217 goto delete_and_fail
;
2221 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2222 if (state
->ops
->commit
) {
2223 state
->ops
->commit(state
);
2231 /* failure, and it is all-or-none; roll back all operations */
2232 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2233 if (state
->ops
->abort
) {
2234 state
->ops
->abort(state
);
2238 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2239 if (state
->ops
->clean
) {
2240 state
->ops
->clean(state
);
2245 qapi_free_TransactionProperties(props
);
2247 block_job_txn_unref(block_job_txn
);
2250 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
2252 Error
*local_err
= NULL
;
2254 qmp_blockdev_open_tray(device
, has_force
, force
, &local_err
);
2256 error_propagate(errp
, local_err
);
2260 qmp_x_blockdev_remove_medium(device
, errp
);
2263 void qmp_block_passwd(bool has_device
, const char *device
,
2264 bool has_node_name
, const char *node_name
,
2265 const char *password
, Error
**errp
)
2267 Error
*local_err
= NULL
;
2268 BlockDriverState
*bs
;
2269 AioContext
*aio_context
;
2271 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2272 has_node_name
? node_name
: NULL
,
2275 error_propagate(errp
, local_err
);
2279 aio_context
= bdrv_get_aio_context(bs
);
2280 aio_context_acquire(aio_context
);
2282 bdrv_add_key(bs
, password
, errp
);
2284 aio_context_release(aio_context
);
2287 void qmp_blockdev_open_tray(const char *device
, bool has_force
, bool force
,
2297 blk
= blk_by_name(device
);
2299 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2300 "Device '%s' not found", device
);
2304 if (!blk_dev_has_removable_media(blk
)) {
2305 error_setg(errp
, "Device '%s' is not removable", device
);
2309 if (!blk_dev_has_tray(blk
)) {
2310 /* Ignore this command on tray-less devices */
2314 if (blk_dev_is_tray_open(blk
)) {
2318 locked
= blk_dev_is_medium_locked(blk
);
2320 blk_dev_eject_request(blk
, force
);
2323 if (!locked
|| force
) {
2324 blk_dev_change_media_cb(blk
, false);
2328 void qmp_blockdev_close_tray(const char *device
, Error
**errp
)
2332 blk
= blk_by_name(device
);
2334 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2335 "Device '%s' not found", device
);
2339 if (!blk_dev_has_removable_media(blk
)) {
2340 error_setg(errp
, "Device '%s' is not removable", device
);
2344 if (!blk_dev_has_tray(blk
)) {
2345 /* Ignore this command on tray-less devices */
2349 if (!blk_dev_is_tray_open(blk
)) {
2353 blk_dev_change_media_cb(blk
, true);
2356 void qmp_x_blockdev_remove_medium(const char *device
, Error
**errp
)
2359 BlockDriverState
*bs
;
2360 AioContext
*aio_context
;
2363 blk
= blk_by_name(device
);
2365 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2366 "Device '%s' not found", device
);
2370 /* For BBs without a device, we can exchange the BDS tree at will */
2371 has_device
= blk_get_attached_dev(blk
);
2373 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2374 error_setg(errp
, "Device '%s' is not removable", device
);
2378 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2379 error_setg(errp
, "Tray of device '%s' is not open", device
);
2388 aio_context
= bdrv_get_aio_context(bs
);
2389 aio_context_acquire(aio_context
);
2391 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2395 /* This follows the convention established by bdrv_make_anon() */
2396 if (bs
->device_list
.tqe_prev
) {
2397 bdrv_device_remove(bs
);
2402 if (!blk_dev_has_tray(blk
)) {
2403 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2404 * called at all); therefore, the medium needs to be ejected here.
2405 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2406 * value passed here (i.e. false). */
2407 blk_dev_change_media_cb(blk
, false);
2411 aio_context_release(aio_context
);
2414 static void qmp_blockdev_insert_anon_medium(const char *device
,
2415 BlockDriverState
*bs
, Error
**errp
)
2420 blk
= blk_by_name(device
);
2422 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2423 "Device '%s' not found", device
);
2427 /* For BBs without a device, we can exchange the BDS tree at will */
2428 has_device
= blk_get_attached_dev(blk
);
2430 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2431 error_setg(errp
, "Device '%s' is not removable", device
);
2435 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2436 error_setg(errp
, "Tray of device '%s' is not open", device
);
2441 error_setg(errp
, "There already is a medium in device '%s'", device
);
2445 blk_insert_bs(blk
, bs
);
2447 QTAILQ_INSERT_TAIL(&bdrv_states
, bs
, device_list
);
2449 if (!blk_dev_has_tray(blk
)) {
2450 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2451 * called at all); therefore, the medium needs to be pushed into the
2453 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2454 * value passed here (i.e. true). */
2455 blk_dev_change_media_cb(blk
, true);
2459 void qmp_x_blockdev_insert_medium(const char *device
, const char *node_name
,
2462 BlockDriverState
*bs
;
2464 bs
= bdrv_find_node(node_name
);
2466 error_setg(errp
, "Node '%s' not found", node_name
);
2471 error_setg(errp
, "Node '%s' is already in use by '%s'", node_name
,
2476 qmp_blockdev_insert_anon_medium(device
, bs
, errp
);
2479 void qmp_blockdev_change_medium(const char *device
, const char *filename
,
2480 bool has_format
, const char *format
,
2482 BlockdevChangeReadOnlyMode read_only
,
2486 BlockDriverState
*medium_bs
= NULL
;
2487 int bdrv_flags
, ret
;
2488 QDict
*options
= NULL
;
2491 blk
= blk_by_name(device
);
2493 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2494 "Device '%s' not found", device
);
2499 blk_update_root_state(blk
);
2502 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2504 if (!has_read_only
) {
2505 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2508 switch (read_only
) {
2509 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2512 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2513 bdrv_flags
&= ~BDRV_O_RDWR
;
2516 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2517 bdrv_flags
|= BDRV_O_RDWR
;
2525 options
= qdict_new();
2526 qdict_put(options
, "driver", qstring_from_str(format
));
2530 ret
= bdrv_open(&medium_bs
, filename
, NULL
, options
, bdrv_flags
, errp
);
2535 blk_apply_root_state(blk
, medium_bs
);
2537 bdrv_add_key(medium_bs
, NULL
, &err
);
2539 error_propagate(errp
, err
);
2543 qmp_blockdev_open_tray(device
, false, false, &err
);
2545 error_propagate(errp
, err
);
2549 qmp_x_blockdev_remove_medium(device
, &err
);
2551 error_propagate(errp
, err
);
2555 qmp_blockdev_insert_anon_medium(device
, medium_bs
, &err
);
2557 error_propagate(errp
, err
);
2561 qmp_blockdev_close_tray(device
, errp
);
2564 /* If the medium has been inserted, the device has its own reference, so
2565 * ours must be relinquished; and if it has not been inserted successfully,
2566 * the reference must be relinquished anyway */
2567 bdrv_unref(medium_bs
);
2570 /* throttling disk I/O limits */
2571 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
2578 bool has_bps_rd_max
,
2580 bool has_bps_wr_max
,
2584 bool has_iops_rd_max
,
2585 int64_t iops_rd_max
,
2586 bool has_iops_wr_max
,
2587 int64_t iops_wr_max
,
2591 const char *group
, Error
**errp
)
2594 BlockDriverState
*bs
;
2596 AioContext
*aio_context
;
2598 blk
= blk_by_name(device
);
2600 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2601 "Device '%s' not found", device
);
2605 aio_context
= blk_get_aio_context(blk
);
2606 aio_context_acquire(aio_context
);
2610 error_setg(errp
, "Device '%s' has no medium", device
);
2614 memset(&cfg
, 0, sizeof(cfg
));
2615 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
2616 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
2617 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
2619 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
2620 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
2621 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
2624 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
2626 if (has_bps_rd_max
) {
2627 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
2629 if (has_bps_wr_max
) {
2630 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
2633 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
2635 if (has_iops_rd_max
) {
2636 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
2638 if (has_iops_wr_max
) {
2639 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
2642 if (has_iops_size
) {
2643 cfg
.op_size
= iops_size
;
2646 if (!throttle_is_valid(&cfg
, errp
)) {
2650 if (throttle_enabled(&cfg
)) {
2651 /* Enable I/O limits if they're not enabled yet, otherwise
2652 * just update the throttling group. */
2653 if (!bs
->throttle_state
) {
2654 bdrv_io_limits_enable(bs
, has_group
? group
: device
);
2655 } else if (has_group
) {
2656 bdrv_io_limits_update_group(bs
, group
);
2658 /* Set the new throttling configuration */
2659 bdrv_set_io_limits(bs
, &cfg
);
2660 } else if (bs
->throttle_state
) {
2661 /* If all throttling settings are set to 0, disable I/O limits */
2662 bdrv_io_limits_disable(bs
);
2666 aio_context_release(aio_context
);
2669 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2670 bool has_granularity
, uint32_t granularity
,
2673 AioContext
*aio_context
;
2674 BlockDriverState
*bs
;
2676 if (!name
|| name
[0] == '\0') {
2677 error_setg(errp
, "Bitmap name cannot be empty");
2681 bs
= bdrv_lookup_bs(node
, node
, errp
);
2686 aio_context
= bdrv_get_aio_context(bs
);
2687 aio_context_acquire(aio_context
);
2689 if (has_granularity
) {
2690 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2691 error_setg(errp
, "Granularity must be power of 2 "
2692 "and at least 512");
2696 /* Default to cluster size, if available: */
2697 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2700 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2703 aio_context_release(aio_context
);
2706 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2709 AioContext
*aio_context
;
2710 BlockDriverState
*bs
;
2711 BdrvDirtyBitmap
*bitmap
;
2713 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2714 if (!bitmap
|| !bs
) {
2718 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2720 "Bitmap '%s' is currently frozen and cannot be removed",
2724 bdrv_dirty_bitmap_make_anon(bitmap
);
2725 bdrv_release_dirty_bitmap(bs
, bitmap
);
2728 aio_context_release(aio_context
);
2732 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2733 * immediately after a full backup operation.
2735 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2738 AioContext
*aio_context
;
2739 BdrvDirtyBitmap
*bitmap
;
2740 BlockDriverState
*bs
;
2742 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2743 if (!bitmap
|| !bs
) {
2747 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2749 "Bitmap '%s' is currently frozen and cannot be modified",
2752 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2754 "Bitmap '%s' is currently disabled and cannot be cleared",
2759 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2762 aio_context_release(aio_context
);
2765 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2767 const char *id
= qdict_get_str(qdict
, "id");
2769 BlockDriverState
*bs
;
2770 AioContext
*aio_context
;
2771 Error
*local_err
= NULL
;
2773 blk
= blk_by_name(id
);
2775 error_report("Device '%s' not found", id
);
2779 if (!blk_legacy_dinfo(blk
)) {
2780 error_report("Deleting device added with blockdev-add"
2781 " is not supported");
2785 aio_context
= blk_get_aio_context(blk
);
2786 aio_context_acquire(aio_context
);
2790 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2791 error_report_err(local_err
);
2792 aio_context_release(aio_context
);
2799 /* if we have a device attached to this BlockDriverState
2800 * then we need to make the drive anonymous until the device
2801 * can be removed. If this is a drive with no device backing
2802 * then we can just get rid of the block driver state right here.
2804 if (blk_get_attached_dev(blk
)) {
2805 blk_hide_on_behalf_of_hmp_drive_del(blk
);
2806 /* Further I/O must not pause the guest */
2807 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
2808 BLOCKDEV_ON_ERROR_REPORT
);
2813 aio_context_release(aio_context
);
2816 void qmp_block_resize(bool has_device
, const char *device
,
2817 bool has_node_name
, const char *node_name
,
2818 int64_t size
, Error
**errp
)
2820 Error
*local_err
= NULL
;
2821 BlockDriverState
*bs
;
2822 AioContext
*aio_context
;
2825 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2826 has_node_name
? node_name
: NULL
,
2829 error_propagate(errp
, local_err
);
2833 aio_context
= bdrv_get_aio_context(bs
);
2834 aio_context_acquire(aio_context
);
2836 if (!bdrv_is_first_non_filter(bs
)) {
2837 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
2842 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2846 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2847 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2851 /* complete all in-flight operations before resizing the device */
2854 ret
= bdrv_truncate(bs
, size
);
2859 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2862 error_setg(errp
, QERR_UNSUPPORTED
);
2865 error_setg(errp
, "Device '%s' is read only", device
);
2868 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2871 error_setg_errno(errp
, -ret
, "Could not resize");
2876 aio_context_release(aio_context
);
2879 static void block_job_cb(void *opaque
, int ret
)
2881 /* Note that this function may be executed from another AioContext besides
2882 * the QEMU main loop. If you need to access anything that assumes the
2883 * QEMU global mutex, use a BH or introduce a mutex.
2886 BlockDriverState
*bs
= opaque
;
2887 const char *msg
= NULL
;
2889 trace_block_job_cb(bs
, bs
->job
, ret
);
2894 msg
= strerror(-ret
);
2897 if (block_job_is_cancelled(bs
->job
)) {
2898 block_job_event_cancelled(bs
->job
);
2900 block_job_event_completed(bs
->job
, msg
);
2904 void qmp_block_stream(const char *device
,
2905 bool has_base
, const char *base
,
2906 bool has_backing_file
, const char *backing_file
,
2907 bool has_speed
, int64_t speed
,
2908 bool has_on_error
, BlockdevOnError on_error
,
2912 BlockDriverState
*bs
;
2913 BlockDriverState
*base_bs
= NULL
;
2914 AioContext
*aio_context
;
2915 Error
*local_err
= NULL
;
2916 const char *base_name
= NULL
;
2918 if (!has_on_error
) {
2919 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2922 blk
= blk_by_name(device
);
2924 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2925 "Device '%s' not found", device
);
2929 aio_context
= blk_get_aio_context(blk
);
2930 aio_context_acquire(aio_context
);
2932 if (!blk_is_available(blk
)) {
2933 error_setg(errp
, "Device '%s' has no medium", device
);
2938 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_STREAM
, errp
)) {
2943 base_bs
= bdrv_find_backing_image(bs
, base
);
2944 if (base_bs
== NULL
) {
2945 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
2948 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2952 /* if we are streaming the entire chain, the result will have no backing
2953 * file, and specifying one is therefore an error */
2954 if (base_bs
== NULL
&& has_backing_file
) {
2955 error_setg(errp
, "backing file specified, but streaming the "
2960 /* backing_file string overrides base bs filename */
2961 base_name
= has_backing_file
? backing_file
: base_name
;
2963 stream_start(bs
, base_bs
, base_name
, has_speed
? speed
: 0,
2964 on_error
, block_job_cb
, bs
, &local_err
);
2966 error_propagate(errp
, local_err
);
2970 trace_qmp_block_stream(bs
, bs
->job
);
2973 aio_context_release(aio_context
);
2976 void qmp_block_commit(const char *device
,
2977 bool has_base
, const char *base
,
2978 bool has_top
, const char *top
,
2979 bool has_backing_file
, const char *backing_file
,
2980 bool has_speed
, int64_t speed
,
2984 BlockDriverState
*bs
;
2985 BlockDriverState
*base_bs
, *top_bs
;
2986 AioContext
*aio_context
;
2987 Error
*local_err
= NULL
;
2988 /* This will be part of the QMP command, if/when the
2989 * BlockdevOnError change for blkmirror makes it in
2991 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2998 * libvirt relies on the DeviceNotFound error class in order to probe for
2999 * live commit feature versions; for this to work, we must make sure to
3000 * perform the device lookup before any generic errors that may occur in a
3001 * scenario in which all optional arguments are omitted. */
3002 blk
= blk_by_name(device
);
3004 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3005 "Device '%s' not found", device
);
3009 aio_context
= blk_get_aio_context(blk
);
3010 aio_context_acquire(aio_context
);
3012 if (!blk_is_available(blk
)) {
3013 error_setg(errp
, "Device '%s' has no medium", device
);
3018 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3022 /* default top_bs is the active layer */
3025 if (has_top
&& top
) {
3026 if (strcmp(bs
->filename
, top
) != 0) {
3027 top_bs
= bdrv_find_backing_image(bs
, top
);
3031 if (top_bs
== NULL
) {
3032 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3036 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3038 if (has_base
&& base
) {
3039 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3041 base_bs
= bdrv_find_base(top_bs
);
3044 if (base_bs
== NULL
) {
3045 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3049 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3051 if (bdrv_op_is_blocked(base_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3055 /* Do not allow attempts to commit an image into itself */
3056 if (top_bs
== base_bs
) {
3057 error_setg(errp
, "cannot commit an image into itself");
3062 if (has_backing_file
) {
3063 error_setg(errp
, "'backing-file' specified,"
3064 " but 'top' is the active layer");
3067 commit_active_start(bs
, base_bs
, speed
, on_error
, block_job_cb
,
3070 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
3071 has_backing_file
? backing_file
: NULL
, &local_err
);
3073 if (local_err
!= NULL
) {
3074 error_propagate(errp
, local_err
);
3079 aio_context_release(aio_context
);
3082 static void do_drive_backup(const char *device
, const char *target
,
3083 bool has_format
, const char *format
,
3084 enum MirrorSyncMode sync
,
3085 bool has_mode
, enum NewImageMode mode
,
3086 bool has_speed
, int64_t speed
,
3087 bool has_bitmap
, const char *bitmap
,
3088 bool has_on_source_error
,
3089 BlockdevOnError on_source_error
,
3090 bool has_on_target_error
,
3091 BlockdevOnError on_target_error
,
3092 BlockJobTxn
*txn
, Error
**errp
)
3095 BlockDriverState
*bs
;
3096 BlockDriverState
*target_bs
;
3097 BlockDriverState
*source
= NULL
;
3098 BdrvDirtyBitmap
*bmap
= NULL
;
3099 AioContext
*aio_context
;
3100 QDict
*options
= NULL
;
3101 Error
*local_err
= NULL
;
3109 if (!has_on_source_error
) {
3110 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3112 if (!has_on_target_error
) {
3113 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3116 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3119 blk
= blk_by_name(device
);
3121 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3122 "Device '%s' not found", device
);
3126 aio_context
= blk_get_aio_context(blk
);
3127 aio_context_acquire(aio_context
);
3129 /* Although backup_run has this check too, we need to use bs->drv below, so
3130 * do an early check redundantly. */
3131 if (!blk_is_available(blk
)) {
3132 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
3138 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
3141 /* Early check to avoid creating target */
3142 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3146 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3148 /* See if we have a backing HD we can use to create our new image
3150 if (sync
== MIRROR_SYNC_MODE_TOP
) {
3151 source
= backing_bs(bs
);
3153 sync
= MIRROR_SYNC_MODE_FULL
;
3156 if (sync
== MIRROR_SYNC_MODE_NONE
) {
3160 size
= bdrv_getlength(bs
);
3162 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3166 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
3169 bdrv_img_create(target
, format
, source
->filename
,
3170 source
->drv
->format_name
, NULL
,
3171 size
, flags
, &local_err
, false);
3173 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
3174 size
, flags
, &local_err
, false);
3179 error_propagate(errp
, local_err
);
3184 options
= qdict_new();
3185 qdict_put(options
, "driver", qstring_from_str(format
));
3189 ret
= bdrv_open(&target_bs
, target
, NULL
, options
, flags
, &local_err
);
3191 error_propagate(errp
, local_err
);
3195 bdrv_set_aio_context(target_bs
, aio_context
);
3198 bmap
= bdrv_find_dirty_bitmap(bs
, bitmap
);
3200 error_setg(errp
, "Bitmap '%s' could not be found", bitmap
);
3201 bdrv_unref(target_bs
);
3206 backup_start(bs
, target_bs
, speed
, sync
, bmap
,
3207 on_source_error
, on_target_error
,
3208 block_job_cb
, bs
, txn
, &local_err
);
3209 if (local_err
!= NULL
) {
3210 bdrv_unref(target_bs
);
3211 error_propagate(errp
, local_err
);
3216 aio_context_release(aio_context
);
3219 void qmp_drive_backup(const char *device
, const char *target
,
3220 bool has_format
, const char *format
,
3221 enum MirrorSyncMode sync
,
3222 bool has_mode
, enum NewImageMode mode
,
3223 bool has_speed
, int64_t speed
,
3224 bool has_bitmap
, const char *bitmap
,
3225 bool has_on_source_error
, BlockdevOnError on_source_error
,
3226 bool has_on_target_error
, BlockdevOnError on_target_error
,
3229 return do_drive_backup(device
, target
, has_format
, format
, sync
,
3230 has_mode
, mode
, has_speed
, speed
,
3232 has_on_source_error
, on_source_error
,
3233 has_on_target_error
, on_target_error
,
3237 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3239 return bdrv_named_nodes_list(errp
);
3242 void do_blockdev_backup(const char *device
, const char *target
,
3243 enum MirrorSyncMode sync
,
3244 bool has_speed
, int64_t speed
,
3245 bool has_on_source_error
,
3246 BlockdevOnError on_source_error
,
3247 bool has_on_target_error
,
3248 BlockdevOnError on_target_error
,
3249 BlockJobTxn
*txn
, Error
**errp
)
3251 BlockBackend
*blk
, *target_blk
;
3252 BlockDriverState
*bs
;
3253 BlockDriverState
*target_bs
;
3254 Error
*local_err
= NULL
;
3255 AioContext
*aio_context
;
3260 if (!has_on_source_error
) {
3261 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3263 if (!has_on_target_error
) {
3264 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3267 blk
= blk_by_name(device
);
3269 error_setg(errp
, "Device '%s' not found", device
);
3273 aio_context
= blk_get_aio_context(blk
);
3274 aio_context_acquire(aio_context
);
3276 if (!blk_is_available(blk
)) {
3277 error_setg(errp
, "Device '%s' has no medium", device
);
3282 target_blk
= blk_by_name(target
);
3284 error_setg(errp
, "Device '%s' not found", target
);
3288 if (!blk_is_available(target_blk
)) {
3289 error_setg(errp
, "Device '%s' has no medium", target
);
3292 target_bs
= blk_bs(target_blk
);
3294 bdrv_ref(target_bs
);
3295 bdrv_set_aio_context(target_bs
, aio_context
);
3296 backup_start(bs
, target_bs
, speed
, sync
, NULL
, on_source_error
,
3297 on_target_error
, block_job_cb
, bs
, txn
, &local_err
);
3298 if (local_err
!= NULL
) {
3299 bdrv_unref(target_bs
);
3300 error_propagate(errp
, local_err
);
3303 aio_context_release(aio_context
);
3306 void qmp_blockdev_backup(const char *device
, const char *target
,
3307 enum MirrorSyncMode sync
,
3308 bool has_speed
, int64_t speed
,
3309 bool has_on_source_error
,
3310 BlockdevOnError on_source_error
,
3311 bool has_on_target_error
,
3312 BlockdevOnError on_target_error
,
3315 do_blockdev_backup(device
, target
, sync
, has_speed
, speed
,
3316 has_on_source_error
, on_source_error
,
3317 has_on_target_error
, on_target_error
,
3321 /* Parameter check and block job starting for drive mirroring.
3322 * Caller should hold @device and @target's aio context (must be the same).
3324 static void blockdev_mirror_common(BlockDriverState
*bs
,
3325 BlockDriverState
*target
,
3326 bool has_replaces
, const char *replaces
,
3327 enum MirrorSyncMode sync
,
3328 bool has_speed
, int64_t speed
,
3329 bool has_granularity
, uint32_t granularity
,
3330 bool has_buf_size
, int64_t buf_size
,
3331 bool has_on_source_error
,
3332 BlockdevOnError on_source_error
,
3333 bool has_on_target_error
,
3334 BlockdevOnError on_target_error
,
3335 bool has_unmap
, bool unmap
,
3342 if (!has_on_source_error
) {
3343 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3345 if (!has_on_target_error
) {
3346 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3348 if (!has_granularity
) {
3351 if (!has_buf_size
) {
3358 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3359 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3360 "a value in range [512B, 64MB]");
3363 if (granularity
& (granularity
- 1)) {
3364 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3369 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3372 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3376 error_setg(errp
, "Cannot mirror to an attached block device");
3380 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3381 sync
= MIRROR_SYNC_MODE_FULL
;
3384 /* pass the node name to replace to mirror start since it's loose coupling
3385 * and will allow to check whether the node still exist at mirror completion
3387 mirror_start(bs
, target
,
3388 has_replaces
? replaces
: NULL
,
3389 speed
, granularity
, buf_size
, sync
,
3390 on_source_error
, on_target_error
, unmap
,
3391 block_job_cb
, bs
, errp
);
3394 void qmp_drive_mirror(const char *device
, const char *target
,
3395 bool has_format
, const char *format
,
3396 bool has_node_name
, const char *node_name
,
3397 bool has_replaces
, const char *replaces
,
3398 enum MirrorSyncMode sync
,
3399 bool has_mode
, enum NewImageMode mode
,
3400 bool has_speed
, int64_t speed
,
3401 bool has_granularity
, uint32_t granularity
,
3402 bool has_buf_size
, int64_t buf_size
,
3403 bool has_on_source_error
, BlockdevOnError on_source_error
,
3404 bool has_on_target_error
, BlockdevOnError on_target_error
,
3405 bool has_unmap
, bool unmap
,
3408 BlockDriverState
*bs
;
3410 BlockDriverState
*source
, *target_bs
;
3411 AioContext
*aio_context
;
3412 Error
*local_err
= NULL
;
3413 QDict
*options
= NULL
;
3418 blk
= blk_by_name(device
);
3420 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3421 "Device '%s' not found", device
);
3425 aio_context
= blk_get_aio_context(blk
);
3426 aio_context_acquire(aio_context
);
3428 if (!blk_is_available(blk
)) {
3429 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
3434 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3438 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
3441 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3442 source
= backing_bs(bs
);
3443 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3444 sync
= MIRROR_SYNC_MODE_FULL
;
3446 if (sync
== MIRROR_SYNC_MODE_NONE
) {
3450 size
= bdrv_getlength(bs
);
3452 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3457 BlockDriverState
*to_replace_bs
;
3458 AioContext
*replace_aio_context
;
3459 int64_t replace_size
;
3461 if (!has_node_name
) {
3462 error_setg(errp
, "a node-name must be provided when replacing a"
3463 " named node of the graph");
3467 to_replace_bs
= check_to_replace_node(bs
, replaces
, &local_err
);
3469 if (!to_replace_bs
) {
3470 error_propagate(errp
, local_err
);
3474 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3475 aio_context_acquire(replace_aio_context
);
3476 replace_size
= bdrv_getlength(to_replace_bs
);
3477 aio_context_release(replace_aio_context
);
3479 if (size
!= replace_size
) {
3480 error_setg(errp
, "cannot replace image with a mirror image of "
3486 if ((sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3487 && mode
!= NEW_IMAGE_MODE_EXISTING
)
3489 /* create new image w/o backing file */
3491 bdrv_img_create(target
, format
,
3492 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
3495 case NEW_IMAGE_MODE_EXISTING
:
3497 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3498 /* create new image with backing file */
3499 bdrv_img_create(target
, format
,
3501 source
->drv
->format_name
,
3502 NULL
, size
, flags
, &local_err
, false);
3510 error_propagate(errp
, local_err
);
3514 options
= qdict_new();
3515 if (has_node_name
) {
3516 qdict_put(options
, "node-name", qstring_from_str(node_name
));
3519 qdict_put(options
, "driver", qstring_from_str(format
));
3522 /* Mirroring takes care of copy-on-write using the source's backing
3526 ret
= bdrv_open(&target_bs
, target
, NULL
, options
,
3527 flags
| BDRV_O_NO_BACKING
, &local_err
);
3529 error_propagate(errp
, local_err
);
3533 bdrv_set_aio_context(target_bs
, aio_context
);
3535 blockdev_mirror_common(bs
, target_bs
,
3536 has_replaces
, replaces
, sync
,
3538 has_granularity
, granularity
,
3539 has_buf_size
, buf_size
,
3540 has_on_source_error
, on_source_error
,
3541 has_on_target_error
, on_target_error
,
3545 error_propagate(errp
, local_err
);
3546 bdrv_unref(target_bs
);
3549 aio_context_release(aio_context
);
3552 void qmp_blockdev_mirror(const char *device
, const char *target
,
3553 bool has_replaces
, const char *replaces
,
3554 MirrorSyncMode sync
,
3555 bool has_speed
, int64_t speed
,
3556 bool has_granularity
, uint32_t granularity
,
3557 bool has_buf_size
, int64_t buf_size
,
3558 bool has_on_source_error
,
3559 BlockdevOnError on_source_error
,
3560 bool has_on_target_error
,
3561 BlockdevOnError on_target_error
,
3564 BlockDriverState
*bs
;
3566 BlockDriverState
*target_bs
;
3567 AioContext
*aio_context
;
3568 Error
*local_err
= NULL
;
3570 blk
= blk_by_name(device
);
3572 error_setg(errp
, "Device '%s' not found", device
);
3578 error_setg(errp
, "Device '%s' has no media", device
);
3582 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3587 aio_context
= bdrv_get_aio_context(bs
);
3588 aio_context_acquire(aio_context
);
3590 bdrv_ref(target_bs
);
3591 bdrv_set_aio_context(target_bs
, aio_context
);
3593 blockdev_mirror_common(bs
, target_bs
,
3594 has_replaces
, replaces
, sync
,
3596 has_granularity
, granularity
,
3597 has_buf_size
, buf_size
,
3598 has_on_source_error
, on_source_error
,
3599 has_on_target_error
, on_target_error
,
3603 error_propagate(errp
, local_err
);
3604 bdrv_unref(target_bs
);
3607 aio_context_release(aio_context
);
3610 /* Get the block job for a given device name and acquire its AioContext */
3611 static BlockJob
*find_block_job(const char *device
, AioContext
**aio_context
,
3615 BlockDriverState
*bs
;
3617 *aio_context
= NULL
;
3619 blk
= blk_by_name(device
);
3624 *aio_context
= blk_get_aio_context(blk
);
3625 aio_context_acquire(*aio_context
);
3627 if (!blk_is_available(blk
)) {
3639 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3640 "No active block job on device '%s'", device
);
3642 aio_context_release(*aio_context
);
3643 *aio_context
= NULL
;
3648 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3650 AioContext
*aio_context
;
3651 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3657 block_job_set_speed(job
, speed
, errp
);
3658 aio_context_release(aio_context
);
3661 void qmp_block_job_cancel(const char *device
,
3662 bool has_force
, bool force
, Error
**errp
)
3664 AioContext
*aio_context
;
3665 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3675 if (job
->user_paused
&& !force
) {
3676 error_setg(errp
, "The block job for device '%s' is currently paused",
3681 trace_qmp_block_job_cancel(job
);
3682 block_job_cancel(job
);
3684 aio_context_release(aio_context
);
3687 void qmp_block_job_pause(const char *device
, Error
**errp
)
3689 AioContext
*aio_context
;
3690 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3692 if (!job
|| job
->user_paused
) {
3696 job
->user_paused
= true;
3697 trace_qmp_block_job_pause(job
);
3698 block_job_pause(job
);
3699 aio_context_release(aio_context
);
3702 void qmp_block_job_resume(const char *device
, Error
**errp
)
3704 AioContext
*aio_context
;
3705 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3707 if (!job
|| !job
->user_paused
) {
3711 job
->user_paused
= false;
3712 trace_qmp_block_job_resume(job
);
3713 block_job_resume(job
);
3714 aio_context_release(aio_context
);
3717 void qmp_block_job_complete(const char *device
, Error
**errp
)
3719 AioContext
*aio_context
;
3720 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3726 trace_qmp_block_job_complete(job
);
3727 block_job_complete(job
, errp
);
3728 aio_context_release(aio_context
);
3731 void qmp_change_backing_file(const char *device
,
3732 const char *image_node_name
,
3733 const char *backing_file
,
3737 BlockDriverState
*bs
= NULL
;
3738 AioContext
*aio_context
;
3739 BlockDriverState
*image_bs
= NULL
;
3740 Error
*local_err
= NULL
;
3745 blk
= blk_by_name(device
);
3747 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3748 "Device '%s' not found", device
);
3752 aio_context
= blk_get_aio_context(blk
);
3753 aio_context_acquire(aio_context
);
3755 if (!blk_is_available(blk
)) {
3756 error_setg(errp
, "Device '%s' has no medium", device
);
3761 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3763 error_propagate(errp
, local_err
);
3768 error_setg(errp
, "image file not found");
3772 if (bdrv_find_base(image_bs
) == image_bs
) {
3773 error_setg(errp
, "not allowing backing file change on an image "
3774 "without a backing file");
3778 /* even though we are not necessarily operating on bs, we need it to
3779 * determine if block ops are currently prohibited on the chain */
3780 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3784 /* final sanity check */
3785 if (!bdrv_chain_contains(bs
, image_bs
)) {
3786 error_setg(errp
, "'%s' and image file are not in the same chain",
3791 /* if not r/w, reopen to make r/w */
3792 open_flags
= image_bs
->open_flags
;
3793 ro
= bdrv_is_read_only(image_bs
);
3796 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3798 error_propagate(errp
, local_err
);
3803 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3804 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3807 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3809 /* don't exit here, so we can try to restore open flags if
3814 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3816 error_propagate(errp
, local_err
); /* will preserve prior errp */
3821 aio_context_release(aio_context
);
3824 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3826 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
3827 BlockDriverState
*bs
;
3828 BlockBackend
*blk
= NULL
;
3831 Error
*local_err
= NULL
;
3833 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3834 * cache.direct=false instead of silently switching to aio=threads, except
3835 * when called from drive_new().
3837 * For now, simply forbidding the combination for all drivers will do. */
3838 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
3839 bool direct
= options
->has_cache
&&
3840 options
->cache
->has_direct
&&
3841 options
->cache
->direct
;
3843 error_setg(errp
, "aio=native requires cache.direct=true");
3848 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
), NULL
, &options
,
3851 error_propagate(errp
, local_err
);
3855 obj
= qmp_output_get_qobject(ov
);
3856 qdict
= qobject_to_qdict(obj
);
3858 qdict_flatten(qdict
);
3860 if (options
->has_id
) {
3861 blk
= blockdev_init(NULL
, qdict
, &local_err
);
3863 error_propagate(errp
, local_err
);
3869 if (!qdict_get_try_str(qdict
, "node-name")) {
3870 error_setg(errp
, "'id' and/or 'node-name' need to be specified for "
3875 bs
= bds_tree_init(qdict
, errp
);
3880 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3883 if (bs
&& bdrv_key_required(bs
)) {
3887 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3890 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3895 qmp_output_visitor_cleanup(ov
);
3898 void qmp_x_blockdev_del(bool has_id
, const char *id
,
3899 bool has_node_name
, const char *node_name
, Error
**errp
)
3901 AioContext
*aio_context
;
3903 BlockDriverState
*bs
;
3905 if (has_id
&& has_node_name
) {
3906 error_setg(errp
, "Only one of id and node-name must be specified");
3908 } else if (!has_id
&& !has_node_name
) {
3909 error_setg(errp
, "No block device specified");
3914 blk
= blk_by_name(id
);
3916 error_setg(errp
, "Cannot find block backend %s", id
);
3919 if (blk_get_refcnt(blk
) > 1) {
3920 error_setg(errp
, "Block backend %s is in use", id
);
3924 aio_context
= blk_get_aio_context(blk
);
3926 bs
= bdrv_find_node(node_name
);
3928 error_setg(errp
, "Cannot find node %s", node_name
);
3933 error_setg(errp
, "Node %s is in use by %s",
3934 node_name
, blk_name(blk
));
3937 aio_context
= bdrv_get_aio_context(bs
);
3940 aio_context_acquire(aio_context
);
3943 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
3947 if (!blk
&& !bs
->monitor_list
.tqe_prev
) {
3948 error_setg(errp
, "Node %s is not owned by the monitor",
3953 if (bs
->refcnt
> 1) {
3954 error_setg(errp
, "Block device %s is in use",
3955 bdrv_get_device_or_node_name(bs
));
3963 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3968 aio_context_release(aio_context
);
3971 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3973 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3974 BlockDriverState
*bs
;
3976 for (bs
= bdrv_next(NULL
); bs
; bs
= bdrv_next(bs
)) {
3977 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
3979 aio_context_acquire(aio_context
);
3982 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
3983 elem
->value
= block_job_query(bs
->job
);
3985 p_next
= &elem
->next
;
3988 aio_context_release(aio_context
);
3994 QemuOptsList qemu_common_drive_opts
= {
3996 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4000 .type
= QEMU_OPT_BOOL
,
4001 .help
= "enable/disable snapshot mode",
4004 .type
= QEMU_OPT_STRING
,
4005 .help
= "discard operation (ignore/off, unmap/on)",
4008 .type
= QEMU_OPT_STRING
,
4009 .help
= "host AIO implementation (threads, native)",
4012 .type
= QEMU_OPT_STRING
,
4013 .help
= "disk format (raw, qcow2, ...)",
4016 .type
= QEMU_OPT_STRING
,
4017 .help
= "read error action",
4020 .type
= QEMU_OPT_STRING
,
4021 .help
= "write error action",
4023 .name
= "read-only",
4024 .type
= QEMU_OPT_BOOL
,
4025 .help
= "open drive file as read-only",
4027 .name
= "throttling.iops-total",
4028 .type
= QEMU_OPT_NUMBER
,
4029 .help
= "limit total I/O operations per second",
4031 .name
= "throttling.iops-read",
4032 .type
= QEMU_OPT_NUMBER
,
4033 .help
= "limit read operations per second",
4035 .name
= "throttling.iops-write",
4036 .type
= QEMU_OPT_NUMBER
,
4037 .help
= "limit write operations per second",
4039 .name
= "throttling.bps-total",
4040 .type
= QEMU_OPT_NUMBER
,
4041 .help
= "limit total bytes per second",
4043 .name
= "throttling.bps-read",
4044 .type
= QEMU_OPT_NUMBER
,
4045 .help
= "limit read bytes per second",
4047 .name
= "throttling.bps-write",
4048 .type
= QEMU_OPT_NUMBER
,
4049 .help
= "limit write bytes per second",
4051 .name
= "throttling.iops-total-max",
4052 .type
= QEMU_OPT_NUMBER
,
4053 .help
= "I/O operations burst",
4055 .name
= "throttling.iops-read-max",
4056 .type
= QEMU_OPT_NUMBER
,
4057 .help
= "I/O operations read burst",
4059 .name
= "throttling.iops-write-max",
4060 .type
= QEMU_OPT_NUMBER
,
4061 .help
= "I/O operations write burst",
4063 .name
= "throttling.bps-total-max",
4064 .type
= QEMU_OPT_NUMBER
,
4065 .help
= "total bytes burst",
4067 .name
= "throttling.bps-read-max",
4068 .type
= QEMU_OPT_NUMBER
,
4069 .help
= "total bytes read burst",
4071 .name
= "throttling.bps-write-max",
4072 .type
= QEMU_OPT_NUMBER
,
4073 .help
= "total bytes write burst",
4075 .name
= "throttling.iops-size",
4076 .type
= QEMU_OPT_NUMBER
,
4077 .help
= "when limiting by iops max size of an I/O in bytes",
4079 .name
= "throttling.group",
4080 .type
= QEMU_OPT_STRING
,
4081 .help
= "name of the block throttling group",
4083 .name
= "copy-on-read",
4084 .type
= QEMU_OPT_BOOL
,
4085 .help
= "copy read data from backing file into image file",
4087 .name
= "detect-zeroes",
4088 .type
= QEMU_OPT_STRING
,
4089 .help
= "try to optimize zero writes (off, on, unmap)",
4091 .name
= "stats-account-invalid",
4092 .type
= QEMU_OPT_BOOL
,
4093 .help
= "whether to account for invalid I/O operations "
4094 "in the statistics",
4096 .name
= "stats-account-failed",
4097 .type
= QEMU_OPT_BOOL
,
4098 .help
= "whether to account for failed I/O operations "
4099 "in the statistics",
4101 { /* end of list */ }
4105 static QemuOptsList qemu_root_bds_opts
= {
4107 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4111 .type
= QEMU_OPT_STRING
,
4112 .help
= "discard operation (ignore/off, unmap/on)",
4115 .type
= QEMU_OPT_STRING
,
4116 .help
= "host AIO implementation (threads, native)",
4118 .name
= "read-only",
4119 .type
= QEMU_OPT_BOOL
,
4120 .help
= "open drive file as read-only",
4122 .name
= "copy-on-read",
4123 .type
= QEMU_OPT_BOOL
,
4124 .help
= "copy read data from backing file into image file",
4126 .name
= "detect-zeroes",
4127 .type
= QEMU_OPT_STRING
,
4128 .help
= "try to optimize zero writes (off, on, unmap)",
4130 { /* end of list */ }
4134 QemuOptsList qemu_drive_opts
= {
4136 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4139 * no elements => accept any params
4140 * validation will happen later
4142 { /* end of list */ }