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 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
348 if (throttle_conflicting(cfg
)) {
349 error_setg(errp
, "bps/iops/max total values and read/write values"
350 " cannot be used at the same time");
354 if (!throttle_is_valid(cfg
)) {
355 error_setg(errp
, "bps/iops/max values must be within [0, %lld]",
360 if (throttle_max_is_missing_limit(cfg
)) {
361 error_setg(errp
, "bps_max/iops_max require corresponding"
369 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
371 /* All parameters but @opts are optional and may be set to NULL. */
372 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
373 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
374 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
377 Error
*local_error
= NULL
;
381 if (!qemu_opt_get_bool(opts
, "read-only", false)) {
382 *bdrv_flags
|= BDRV_O_RDWR
;
384 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
385 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
388 if ((discard
= qemu_opt_get(opts
, "discard")) != NULL
) {
389 if (bdrv_parse_discard_flags(discard
, bdrv_flags
) != 0) {
390 error_setg(errp
, "Invalid discard option");
395 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
396 if (!strcmp(aio
, "native")) {
397 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
398 } else if (!strcmp(aio
, "threads")) {
399 /* this is the default */
401 error_setg(errp
, "invalid aio option");
407 /* disk I/O throttling */
408 if (throttling_group
) {
409 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
413 memset(throttle_cfg
, 0, sizeof(*throttle_cfg
));
414 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
415 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
416 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
417 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
418 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
419 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
420 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
421 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
422 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
423 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
424 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
425 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
427 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
428 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
429 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
430 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
431 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
432 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
433 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
434 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
435 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
436 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
437 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
438 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
440 throttle_cfg
->op_size
=
441 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
443 if (!check_throttle_config(throttle_cfg
, errp
)) {
450 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
451 qemu_opt_get(opts
, "detect-zeroes"),
452 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX
,
453 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
456 error_propagate(errp
, local_error
);
461 *detect_zeroes
== BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP
&&
462 !(*bdrv_flags
& BDRV_O_UNMAP
))
464 error_setg(errp
, "setting detect-zeroes to unmap is not allowed "
465 "without setting discard operation to unmap");
471 /* Takes the ownership of bs_opts */
472 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
477 int on_read_error
, on_write_error
;
478 bool account_invalid
, account_failed
;
480 BlockDriverState
*bs
;
485 QDict
*interval_dict
= NULL
;
486 QList
*interval_list
= NULL
;
488 BlockdevDetectZeroesOptions detect_zeroes
=
489 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
490 const char *throttling_group
= NULL
;
492 /* Check common options by copying from bs_opts to opts, all other options
493 * stay in bs_opts for processing by bdrv_open(). */
494 id
= qdict_get_try_str(bs_opts
, "id");
495 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
497 error_propagate(errp
, error
);
501 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
503 error_propagate(errp
, error
);
508 qdict_del(bs_opts
, "id");
511 /* extract parameters */
512 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
514 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
515 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
517 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
518 qdict_array_split(interval_dict
, &interval_list
);
520 if (qdict_size(interval_dict
) != 0) {
521 error_setg(errp
, "Invalid option stats-intervals.%s",
522 qdict_first(interval_dict
)->key
);
526 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
527 &detect_zeroes
, &error
);
529 error_propagate(errp
, error
);
533 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
534 if (is_help_option(buf
)) {
535 error_printf("Supported formats:");
536 bdrv_iterate_format(bdrv_format_print
, NULL
);
541 if (qdict_haskey(bs_opts
, "driver")) {
542 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
545 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
548 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
549 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
550 on_write_error
= parse_block_error_action(buf
, 0, &error
);
552 error_propagate(errp
, error
);
557 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
558 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
559 on_read_error
= parse_block_error_action(buf
, 1, &error
);
561 error_propagate(errp
, error
);
567 bdrv_flags
|= BDRV_O_SNAPSHOT
;
571 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
572 BlockBackendRootState
*blk_rs
;
574 blk
= blk_new(qemu_opts_id(opts
), errp
);
579 blk_rs
= blk_get_root_state(blk
);
580 blk_rs
->open_flags
= bdrv_flags
;
581 blk_rs
->read_only
= !(bdrv_flags
& BDRV_O_RDWR
);
582 blk_rs
->detect_zeroes
= detect_zeroes
;
584 if (throttle_enabled(&cfg
)) {
585 if (!throttling_group
) {
586 throttling_group
= blk_name(blk
);
588 blk_rs
->throttle_group
= g_strdup(throttling_group
);
589 blk_rs
->throttle_state
= throttle_group_incref(throttling_group
);
590 blk_rs
->throttle_state
->cfg
= cfg
;
595 if (file
&& !*file
) {
599 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
600 * with other callers) rather than what we want as the real defaults.
601 * Apply the defaults here instead. */
602 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_WB
, "on");
603 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
604 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
607 /* always use cache=unsafe with snapshot */
608 qdict_put(bs_opts
, BDRV_OPT_CACHE_WB
, qstring_from_str("on"));
609 qdict_put(bs_opts
, BDRV_OPT_CACHE_DIRECT
, qstring_from_str("off"));
610 qdict_put(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, qstring_from_str("on"));
613 blk
= blk_new_open(qemu_opts_id(opts
), file
, NULL
, bs_opts
, bdrv_flags
,
620 bs
->detect_zeroes
= detect_zeroes
;
622 /* disk I/O throttling */
623 if (throttle_enabled(&cfg
)) {
624 if (!throttling_group
) {
625 throttling_group
= blk_name(blk
);
627 bdrv_io_limits_enable(bs
, throttling_group
);
628 bdrv_set_io_limits(bs
, &cfg
);
631 if (bdrv_key_required(bs
)) {
635 block_acct_init(blk_get_stats(blk
), account_invalid
, account_failed
);
637 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
644 blk_set_on_error(blk
, on_read_error
, on_write_error
);
648 QDECREF(interval_dict
);
649 QDECREF(interval_list
);
654 QDECREF(interval_dict
);
655 QDECREF(interval_list
);
661 static QemuOptsList qemu_root_bds_opts
;
663 /* Takes the ownership of bs_opts */
664 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
666 BlockDriverState
*bs
;
668 Error
*local_error
= NULL
;
669 BlockdevDetectZeroesOptions detect_zeroes
;
673 opts
= qemu_opts_create(&qemu_root_bds_opts
, NULL
, 1, errp
);
678 qemu_opts_absorb_qdict(opts
, bs_opts
, &local_error
);
680 error_propagate(errp
, local_error
);
684 extract_common_blockdev_options(opts
, &bdrv_flags
, NULL
, NULL
,
685 &detect_zeroes
, &local_error
);
687 error_propagate(errp
, local_error
);
692 ret
= bdrv_open(&bs
, NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
694 goto fail_no_bs_opts
;
697 bs
->detect_zeroes
= detect_zeroes
;
709 void blockdev_close_all_bdrv_states(void)
711 BlockDriverState
*bs
, *next_bs
;
713 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
714 AioContext
*ctx
= bdrv_get_aio_context(bs
);
716 aio_context_acquire(ctx
);
718 aio_context_release(ctx
);
722 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
727 value
= qemu_opt_get(opts
, from
);
729 if (qemu_opt_find(opts
, to
)) {
730 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
731 "same time", to
, from
);
736 /* rename all items in opts */
737 while ((value
= qemu_opt_get(opts
, from
))) {
738 qemu_opt_set(opts
, to
, value
, &error_abort
);
739 qemu_opt_unset(opts
, from
);
743 QemuOptsList qemu_legacy_drive_opts
= {
745 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
749 .type
= QEMU_OPT_NUMBER
,
750 .help
= "bus number",
753 .type
= QEMU_OPT_NUMBER
,
754 .help
= "unit number (i.e. lun for scsi)",
757 .type
= QEMU_OPT_NUMBER
,
758 .help
= "index number",
761 .type
= QEMU_OPT_STRING
,
762 .help
= "media type (disk, cdrom)",
765 .type
= QEMU_OPT_STRING
,
766 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
769 .type
= QEMU_OPT_NUMBER
,
770 .help
= "number of cylinders (ide disk geometry)",
773 .type
= QEMU_OPT_NUMBER
,
774 .help
= "number of heads (ide disk geometry)",
777 .type
= QEMU_OPT_NUMBER
,
778 .help
= "number of sectors (ide disk geometry)",
781 .type
= QEMU_OPT_STRING
,
782 .help
= "chs translation (auto, lba, none)",
785 .type
= QEMU_OPT_BOOL
,
786 .help
= "(deprecated, ignored)",
789 .type
= QEMU_OPT_STRING
,
790 .help
= "pci address (virtio only)",
793 .type
= QEMU_OPT_STRING
,
794 .help
= "disk serial number",
797 .type
= QEMU_OPT_STRING
,
801 /* Options that are passed on, but have special semantics with -drive */
804 .type
= QEMU_OPT_BOOL
,
805 .help
= "open drive file as read-only",
808 .type
= QEMU_OPT_STRING
,
809 .help
= "read error action",
812 .type
= QEMU_OPT_STRING
,
813 .help
= "write error action",
815 .name
= "copy-on-read",
816 .type
= QEMU_OPT_BOOL
,
817 .help
= "copy read data from backing file into image file",
820 { /* end of list */ }
824 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
828 DriveInfo
*dinfo
= NULL
;
830 QemuOpts
*legacy_opts
;
831 DriveMediaType media
= MEDIA_DISK
;
832 BlockInterfaceType type
;
833 int cyls
, heads
, secs
, translation
;
834 int max_devs
, bus_id
, unit_id
, index
;
836 const char *werror
, *rerror
;
837 bool read_only
= false;
840 const char *filename
;
841 Error
*local_err
= NULL
;
844 /* Change legacy command line options into QMP ones */
845 static const struct {
849 { "iops", "throttling.iops-total" },
850 { "iops_rd", "throttling.iops-read" },
851 { "iops_wr", "throttling.iops-write" },
853 { "bps", "throttling.bps-total" },
854 { "bps_rd", "throttling.bps-read" },
855 { "bps_wr", "throttling.bps-write" },
857 { "iops_max", "throttling.iops-total-max" },
858 { "iops_rd_max", "throttling.iops-read-max" },
859 { "iops_wr_max", "throttling.iops-write-max" },
861 { "bps_max", "throttling.bps-total-max" },
862 { "bps_rd_max", "throttling.bps-read-max" },
863 { "bps_wr_max", "throttling.bps-write-max" },
865 { "iops_size", "throttling.iops-size" },
867 { "group", "throttling.group" },
869 { "readonly", "read-only" },
872 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
873 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
876 error_report_err(local_err
);
881 value
= qemu_opt_get(all_opts
, "cache");
885 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
886 error_report("invalid cache option");
890 /* Specific options take precedence */
891 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
892 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
893 !!(flags
& BDRV_O_CACHE_WB
), &error_abort
);
895 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
896 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
897 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
899 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
900 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
901 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
903 qemu_opt_unset(all_opts
, "cache");
906 /* Get a QDict for processing the options */
907 bs_opts
= qdict_new();
908 qemu_opts_to_qdict(all_opts
, bs_opts
);
910 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
912 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
914 error_report_err(local_err
);
918 /* Deprecated option boot=[on|off] */
919 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
920 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
921 "ignored. Future versions will reject this parameter. Please "
922 "update your scripts.\n");
926 value
= qemu_opt_get(legacy_opts
, "media");
928 if (!strcmp(value
, "disk")) {
930 } else if (!strcmp(value
, "cdrom")) {
934 error_report("'%s' invalid media", value
);
939 /* copy-on-read is disabled with a warning for read-only devices */
940 read_only
|= qemu_opt_get_bool(legacy_opts
, "read-only", false);
941 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
943 if (read_only
&& copy_on_read
) {
944 error_report("warning: disabling copy-on-read on read-only drive");
945 copy_on_read
= false;
948 qdict_put(bs_opts
, "read-only",
949 qstring_from_str(read_only
? "on" : "off"));
950 qdict_put(bs_opts
, "copy-on-read",
951 qstring_from_str(copy_on_read
? "on" :"off"));
953 /* Controller type */
954 value
= qemu_opt_get(legacy_opts
, "if");
957 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
960 if (type
== IF_COUNT
) {
961 error_report("unsupported bus type '%s'", value
);
965 type
= block_default_type
;
969 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
970 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
971 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
973 if (cyls
|| heads
|| secs
) {
975 error_report("invalid physical cyls number");
979 error_report("invalid physical heads number");
983 error_report("invalid physical secs number");
988 translation
= BIOS_ATA_TRANSLATION_AUTO
;
989 value
= qemu_opt_get(legacy_opts
, "trans");
992 error_report("'%s' trans must be used with cyls, heads and secs",
996 if (!strcmp(value
, "none")) {
997 translation
= BIOS_ATA_TRANSLATION_NONE
;
998 } else if (!strcmp(value
, "lba")) {
999 translation
= BIOS_ATA_TRANSLATION_LBA
;
1000 } else if (!strcmp(value
, "large")) {
1001 translation
= BIOS_ATA_TRANSLATION_LARGE
;
1002 } else if (!strcmp(value
, "rechs")) {
1003 translation
= BIOS_ATA_TRANSLATION_RECHS
;
1004 } else if (!strcmp(value
, "auto")) {
1005 translation
= BIOS_ATA_TRANSLATION_AUTO
;
1007 error_report("'%s' invalid translation type", value
);
1012 if (media
== MEDIA_CDROM
) {
1013 if (cyls
|| secs
|| heads
) {
1014 error_report("CHS can't be set with media=cdrom");
1019 /* Device address specified by bus/unit or index.
1020 * If none was specified, try to find the first free one. */
1021 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
1022 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
1023 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
1025 max_devs
= if_max_devs
[type
];
1028 if (bus_id
!= 0 || unit_id
!= -1) {
1029 error_report("index cannot be used with bus and unit");
1032 bus_id
= drive_index_to_bus_id(type
, index
);
1033 unit_id
= drive_index_to_unit_id(type
, index
);
1036 if (unit_id
== -1) {
1038 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1040 if (max_devs
&& unit_id
>= max_devs
) {
1041 unit_id
-= max_devs
;
1047 if (max_devs
&& unit_id
>= max_devs
) {
1048 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
1052 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1053 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1054 bus_id
, unit_id
, index
);
1059 serial
= qemu_opt_get(legacy_opts
, "serial");
1061 /* no id supplied -> create one */
1062 if (qemu_opts_id(all_opts
) == NULL
) {
1064 const char *mediastr
= "";
1065 if (type
== IF_IDE
|| type
== IF_SCSI
) {
1066 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
1069 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
1072 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
1075 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
1079 /* Add virtio block device */
1080 devaddr
= qemu_opt_get(legacy_opts
, "addr");
1081 if (devaddr
&& type
!= IF_VIRTIO
) {
1082 error_report("addr is not supported by this bus type");
1086 if (type
== IF_VIRTIO
) {
1088 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
1090 if (arch_type
== QEMU_ARCH_S390X
) {
1091 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
1093 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
1095 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
1098 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
1102 filename
= qemu_opt_get(legacy_opts
, "file");
1104 /* Check werror/rerror compatibility with if=... */
1105 werror
= qemu_opt_get(legacy_opts
, "werror");
1106 if (werror
!= NULL
) {
1107 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
1109 error_report("werror is not supported by this bus type");
1112 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
1115 rerror
= qemu_opt_get(legacy_opts
, "rerror");
1116 if (rerror
!= NULL
) {
1117 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
1119 error_report("rerror is not supported by this bus type");
1122 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
1125 /* Actual block device init: Functionality shared with blockdev-add */
1126 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
1130 error_report_err(local_err
);
1137 /* Create legacy DriveInfo */
1138 dinfo
= g_malloc0(sizeof(*dinfo
));
1139 dinfo
->opts
= all_opts
;
1142 dinfo
->heads
= heads
;
1144 dinfo
->trans
= translation
;
1147 dinfo
->bus
= bus_id
;
1148 dinfo
->unit
= unit_id
;
1149 dinfo
->devaddr
= devaddr
;
1150 dinfo
->serial
= g_strdup(serial
);
1152 blk_set_legacy_dinfo(blk
, dinfo
);
1159 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1166 qemu_opts_del(legacy_opts
);
1171 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1173 const char *device
= qdict_get_str(qdict
, "device");
1177 if (!strcmp(device
, "all")) {
1178 ret
= bdrv_commit_all();
1180 BlockDriverState
*bs
;
1181 AioContext
*aio_context
;
1183 blk
= blk_by_name(device
);
1185 monitor_printf(mon
, "Device '%s' not found\n", device
);
1188 if (!blk_is_available(blk
)) {
1189 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1194 aio_context
= bdrv_get_aio_context(bs
);
1195 aio_context_acquire(aio_context
);
1197 ret
= bdrv_commit(bs
);
1199 aio_context_release(aio_context
);
1202 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1207 static void blockdev_do_action(TransactionActionKind type
, void *data
,
1210 TransactionAction action
;
1211 TransactionActionList list
;
1214 action
.u
.data
= data
;
1215 list
.value
= &action
;
1217 qmp_transaction(&list
, false, NULL
, errp
);
1220 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1221 bool has_node_name
, const char *node_name
,
1222 const char *snapshot_file
,
1223 bool has_snapshot_node_name
,
1224 const char *snapshot_node_name
,
1225 bool has_format
, const char *format
,
1226 bool has_mode
, NewImageMode mode
, Error
**errp
)
1228 BlockdevSnapshotSync snapshot
= {
1229 .has_device
= has_device
,
1230 .device
= (char *) device
,
1231 .has_node_name
= has_node_name
,
1232 .node_name
= (char *) node_name
,
1233 .snapshot_file
= (char *) snapshot_file
,
1234 .has_snapshot_node_name
= has_snapshot_node_name
,
1235 .snapshot_node_name
= (char *) snapshot_node_name
,
1236 .has_format
= has_format
,
1237 .format
= (char *) format
,
1238 .has_mode
= has_mode
,
1241 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1245 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1248 BlockdevSnapshot snapshot_data
= {
1249 .node
= (char *) node
,
1250 .overlay
= (char *) overlay
1253 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1254 &snapshot_data
, errp
);
1257 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1261 BlockdevSnapshotInternal snapshot
= {
1262 .device
= (char *) device
,
1263 .name
= (char *) name
1266 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1270 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1277 BlockDriverState
*bs
;
1279 AioContext
*aio_context
;
1280 QEMUSnapshotInfo sn
;
1281 Error
*local_err
= NULL
;
1282 SnapshotInfo
*info
= NULL
;
1285 blk
= blk_by_name(device
);
1287 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1288 "Device '%s' not found", device
);
1292 aio_context
= blk_get_aio_context(blk
);
1293 aio_context_acquire(aio_context
);
1304 error_setg(errp
, "Name or id must be provided");
1305 goto out_aio_context
;
1308 if (!blk_is_available(blk
)) {
1309 error_setg(errp
, "Device '%s' has no medium", device
);
1310 goto out_aio_context
;
1314 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1315 goto out_aio_context
;
1318 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1320 error_propagate(errp
, local_err
);
1321 goto out_aio_context
;
1325 "Snapshot with id '%s' and name '%s' does not exist on "
1327 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1328 goto out_aio_context
;
1331 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1333 error_propagate(errp
, local_err
);
1334 goto out_aio_context
;
1337 aio_context_release(aio_context
);
1339 info
= g_new0(SnapshotInfo
, 1);
1340 info
->id
= g_strdup(sn
.id_str
);
1341 info
->name
= g_strdup(sn
.name
);
1342 info
->date_nsec
= sn
.date_nsec
;
1343 info
->date_sec
= sn
.date_sec
;
1344 info
->vm_state_size
= sn
.vm_state_size
;
1345 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1346 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1351 aio_context_release(aio_context
);
1356 * block_dirty_bitmap_lookup:
1357 * Return a dirty bitmap (if present), after validating
1358 * the node reference and bitmap names.
1360 * @node: The name of the BDS node to search for bitmaps
1361 * @name: The name of the bitmap to search for
1362 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1363 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1364 * @errp: Output pointer for error information. Can be NULL.
1366 * @return: A bitmap object on success, or NULL on failure.
1368 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1370 BlockDriverState
**pbs
,
1374 BlockDriverState
*bs
;
1375 BdrvDirtyBitmap
*bitmap
;
1376 AioContext
*aio_context
;
1379 error_setg(errp
, "Node cannot be NULL");
1383 error_setg(errp
, "Bitmap name cannot be NULL");
1386 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1388 error_setg(errp
, "Node '%s' not found", node
);
1392 aio_context
= bdrv_get_aio_context(bs
);
1393 aio_context_acquire(aio_context
);
1395 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1397 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1405 *paio
= aio_context
;
1407 aio_context_release(aio_context
);
1413 aio_context_release(aio_context
);
1417 /* New and old BlockDriverState structs for atomic group operations */
1419 typedef struct BlkActionState BlkActionState
;
1423 * Table of operations that define an Action.
1425 * @instance_size: Size of state struct, in bytes.
1426 * @prepare: Prepare the work, must NOT be NULL.
1427 * @commit: Commit the changes, can be NULL.
1428 * @abort: Abort the changes on fail, can be NULL.
1429 * @clean: Clean up resources after all transaction actions have called
1430 * commit() or abort(). Can be NULL.
1432 * Only prepare() may fail. In a single transaction, only one of commit() or
1433 * abort() will be called. clean() will always be called if it is present.
1435 typedef struct BlkActionOps
{
1436 size_t instance_size
;
1437 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1438 void (*commit
)(BlkActionState
*common
);
1439 void (*abort
)(BlkActionState
*common
);
1440 void (*clean
)(BlkActionState
*common
);
1445 * Describes one Action's state within a Transaction.
1447 * @action: QAPI-defined enum identifying which Action to perform.
1448 * @ops: Table of ActionOps this Action can perform.
1449 * @block_job_txn: Transaction which this action belongs to.
1450 * @entry: List membership for all Actions in this Transaction.
1452 * This structure must be arranged as first member in a subclassed type,
1453 * assuming that the compiler will also arrange it to the same offsets as the
1456 struct BlkActionState
{
1457 TransactionAction
*action
;
1458 const BlkActionOps
*ops
;
1459 BlockJobTxn
*block_job_txn
;
1460 TransactionProperties
*txn_props
;
1461 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1464 /* internal snapshot private data */
1465 typedef struct InternalSnapshotState
{
1466 BlkActionState common
;
1467 BlockDriverState
*bs
;
1468 AioContext
*aio_context
;
1469 QEMUSnapshotInfo sn
;
1471 } InternalSnapshotState
;
1474 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1476 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1478 "Action '%s' does not support Transaction property "
1479 "completion-mode = %s",
1480 TransactionActionKind_lookup
[s
->action
->type
],
1481 ActionCompletionMode_lookup
[s
->txn_props
->completion_mode
]);
1487 static void internal_snapshot_prepare(BlkActionState
*common
,
1490 Error
*local_err
= NULL
;
1494 BlockDriverState
*bs
;
1495 QEMUSnapshotInfo old_sn
, *sn
;
1498 BlockdevSnapshotInternal
*internal
;
1499 InternalSnapshotState
*state
;
1502 g_assert(common
->action
->type
==
1503 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1504 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
;
1505 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1507 /* 1. parse input */
1508 device
= internal
->device
;
1509 name
= internal
->name
;
1511 /* 2. check for validation */
1512 if (action_check_completion_mode(common
, errp
) < 0) {
1516 blk
= blk_by_name(device
);
1518 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1519 "Device '%s' not found", device
);
1523 /* AioContext is released in .clean() */
1524 state
->aio_context
= blk_get_aio_context(blk
);
1525 aio_context_acquire(state
->aio_context
);
1527 if (!blk_is_available(blk
)) {
1528 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1534 bdrv_drained_begin(bs
);
1536 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1540 if (bdrv_is_read_only(bs
)) {
1541 error_setg(errp
, "Device '%s' is read only", device
);
1545 if (!bdrv_can_snapshot(bs
)) {
1546 error_setg(errp
, "Block format '%s' used by device '%s' "
1547 "does not support internal snapshots",
1548 bs
->drv
->format_name
, device
);
1552 if (!strlen(name
)) {
1553 error_setg(errp
, "Name is empty");
1557 /* check whether a snapshot with name exist */
1558 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1561 error_propagate(errp
, local_err
);
1565 "Snapshot with name '%s' already exists on device '%s'",
1570 /* 3. take the snapshot */
1572 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1573 qemu_gettimeofday(&tv
);
1574 sn
->date_sec
= tv
.tv_sec
;
1575 sn
->date_nsec
= tv
.tv_usec
* 1000;
1576 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1578 ret1
= bdrv_snapshot_create(bs
, sn
);
1580 error_setg_errno(errp
, -ret1
,
1581 "Failed to create snapshot '%s' on device '%s'",
1586 /* 4. succeed, mark a snapshot is created */
1587 state
->created
= true;
1590 static void internal_snapshot_abort(BlkActionState
*common
)
1592 InternalSnapshotState
*state
=
1593 DO_UPCAST(InternalSnapshotState
, common
, common
);
1594 BlockDriverState
*bs
= state
->bs
;
1595 QEMUSnapshotInfo
*sn
= &state
->sn
;
1596 Error
*local_error
= NULL
;
1598 if (!state
->created
) {
1602 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1603 error_reportf_err(local_error
,
1604 "Failed to delete snapshot with id '%s' and "
1605 "name '%s' on device '%s' in abort: ",
1606 sn
->id_str
, sn
->name
,
1607 bdrv_get_device_name(bs
));
1611 static void internal_snapshot_clean(BlkActionState
*common
)
1613 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1616 if (state
->aio_context
) {
1618 bdrv_drained_end(state
->bs
);
1620 aio_context_release(state
->aio_context
);
1624 /* external snapshot private data */
1625 typedef struct ExternalSnapshotState
{
1626 BlkActionState common
;
1627 BlockDriverState
*old_bs
;
1628 BlockDriverState
*new_bs
;
1629 AioContext
*aio_context
;
1630 } ExternalSnapshotState
;
1632 static void external_snapshot_prepare(BlkActionState
*common
,
1636 QDict
*options
= NULL
;
1637 Error
*local_err
= NULL
;
1638 /* Device and node name of the image to generate the snapshot from */
1640 const char *node_name
;
1641 /* Reference to the new image (for 'blockdev-snapshot') */
1642 const char *snapshot_ref
;
1643 /* File name of the new image (for 'blockdev-snapshot-sync') */
1644 const char *new_image_file
;
1645 ExternalSnapshotState
*state
=
1646 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1647 TransactionAction
*action
= common
->action
;
1649 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1650 * purpose but a different set of parameters */
1651 switch (action
->type
) {
1652 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1654 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
;
1656 node_name
= s
->node
;
1657 new_image_file
= NULL
;
1658 snapshot_ref
= s
->overlay
;
1661 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1663 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
;
1664 device
= s
->has_device
? s
->device
: NULL
;
1665 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1666 new_image_file
= s
->snapshot_file
;
1667 snapshot_ref
= NULL
;
1671 g_assert_not_reached();
1674 /* start processing */
1675 if (action_check_completion_mode(common
, errp
) < 0) {
1679 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1680 if (!state
->old_bs
) {
1684 /* Acquire AioContext now so any threads operating on old_bs stop */
1685 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1686 aio_context_acquire(state
->aio_context
);
1687 bdrv_drained_begin(state
->old_bs
);
1689 if (!bdrv_is_inserted(state
->old_bs
)) {
1690 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1694 if (bdrv_op_is_blocked(state
->old_bs
,
1695 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1699 if (!bdrv_is_read_only(state
->old_bs
)) {
1700 if (bdrv_flush(state
->old_bs
)) {
1701 error_setg(errp
, QERR_IO_ERROR
);
1706 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1707 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1711 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1712 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
;
1713 const char *format
= s
->has_format
? s
->format
: "qcow2";
1714 enum NewImageMode mode
;
1715 const char *snapshot_node_name
=
1716 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1718 if (node_name
&& !snapshot_node_name
) {
1719 error_setg(errp
, "New snapshot node name missing");
1723 if (snapshot_node_name
&&
1724 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1725 error_setg(errp
, "New snapshot node name already in use");
1729 flags
= state
->old_bs
->open_flags
;
1731 /* create new image w/backing file */
1732 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1733 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1734 bdrv_img_create(new_image_file
, format
,
1735 state
->old_bs
->filename
,
1736 state
->old_bs
->drv
->format_name
,
1737 NULL
, -1, flags
, &local_err
, false);
1739 error_propagate(errp
, local_err
);
1744 options
= qdict_new();
1745 if (s
->has_snapshot_node_name
) {
1746 qdict_put(options
, "node-name",
1747 qstring_from_str(snapshot_node_name
));
1749 qdict_put(options
, "driver", qstring_from_str(format
));
1751 flags
|= BDRV_O_NO_BACKING
;
1754 assert(state
->new_bs
== NULL
);
1755 ret
= bdrv_open(&state
->new_bs
, new_image_file
, snapshot_ref
, options
,
1757 /* We will manually add the backing_hd field to the bs later */
1762 if (state
->new_bs
->blk
!= NULL
) {
1763 error_setg(errp
, "The snapshot is already in use by %s",
1764 blk_name(state
->new_bs
->blk
));
1768 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1773 if (state
->new_bs
->backing
!= NULL
) {
1774 error_setg(errp
, "The snapshot already has a backing image");
1778 if (!state
->new_bs
->drv
->supports_backing
) {
1779 error_setg(errp
, "The snapshot does not support backing images");
1783 static void external_snapshot_commit(BlkActionState
*common
)
1785 ExternalSnapshotState
*state
=
1786 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1788 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1790 /* This removes our old bs and adds the new bs */
1791 bdrv_append(state
->new_bs
, state
->old_bs
);
1792 /* We don't need (or want) to use the transactional
1793 * bdrv_reopen_multiple() across all the entries at once, because we
1794 * don't want to abort all of them if one of them fails the reopen */
1795 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1799 static void external_snapshot_abort(BlkActionState
*common
)
1801 ExternalSnapshotState
*state
=
1802 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1803 if (state
->new_bs
) {
1804 bdrv_unref(state
->new_bs
);
1808 static void external_snapshot_clean(BlkActionState
*common
)
1810 ExternalSnapshotState
*state
=
1811 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1812 if (state
->aio_context
) {
1813 bdrv_drained_end(state
->old_bs
);
1814 aio_context_release(state
->aio_context
);
1818 typedef struct DriveBackupState
{
1819 BlkActionState common
;
1820 BlockDriverState
*bs
;
1821 AioContext
*aio_context
;
1825 static void do_drive_backup(const char *device
, const char *target
,
1826 bool has_format
, const char *format
,
1827 enum MirrorSyncMode sync
,
1828 bool has_mode
, enum NewImageMode mode
,
1829 bool has_speed
, int64_t speed
,
1830 bool has_bitmap
, const char *bitmap
,
1831 bool has_on_source_error
,
1832 BlockdevOnError on_source_error
,
1833 bool has_on_target_error
,
1834 BlockdevOnError on_target_error
,
1835 BlockJobTxn
*txn
, Error
**errp
);
1837 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1839 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1841 DriveBackup
*backup
;
1842 Error
*local_err
= NULL
;
1844 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1845 backup
= common
->action
->u
.drive_backup
;
1847 blk
= blk_by_name(backup
->device
);
1849 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1850 "Device '%s' not found", backup
->device
);
1854 if (!blk_is_available(blk
)) {
1855 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, backup
->device
);
1859 /* AioContext is released in .clean() */
1860 state
->aio_context
= blk_get_aio_context(blk
);
1861 aio_context_acquire(state
->aio_context
);
1862 bdrv_drained_begin(blk_bs(blk
));
1863 state
->bs
= blk_bs(blk
);
1865 do_drive_backup(backup
->device
, backup
->target
,
1866 backup
->has_format
, backup
->format
,
1868 backup
->has_mode
, backup
->mode
,
1869 backup
->has_speed
, backup
->speed
,
1870 backup
->has_bitmap
, backup
->bitmap
,
1871 backup
->has_on_source_error
, backup
->on_source_error
,
1872 backup
->has_on_target_error
, backup
->on_target_error
,
1873 common
->block_job_txn
, &local_err
);
1875 error_propagate(errp
, local_err
);
1879 state
->job
= state
->bs
->job
;
1882 static void drive_backup_abort(BlkActionState
*common
)
1884 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1885 BlockDriverState
*bs
= state
->bs
;
1887 /* Only cancel if it's the job we started */
1888 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1889 block_job_cancel_sync(bs
->job
);
1893 static void drive_backup_clean(BlkActionState
*common
)
1895 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1897 if (state
->aio_context
) {
1898 bdrv_drained_end(state
->bs
);
1899 aio_context_release(state
->aio_context
);
1903 typedef struct BlockdevBackupState
{
1904 BlkActionState common
;
1905 BlockDriverState
*bs
;
1907 AioContext
*aio_context
;
1908 } BlockdevBackupState
;
1910 static void do_blockdev_backup(const char *device
, const char *target
,
1911 enum MirrorSyncMode sync
,
1912 bool has_speed
, int64_t speed
,
1913 bool has_on_source_error
,
1914 BlockdevOnError on_source_error
,
1915 bool has_on_target_error
,
1916 BlockdevOnError on_target_error
,
1917 BlockJobTxn
*txn
, Error
**errp
);
1919 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1921 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1922 BlockdevBackup
*backup
;
1923 BlockBackend
*blk
, *target
;
1924 Error
*local_err
= NULL
;
1926 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1927 backup
= common
->action
->u
.blockdev_backup
;
1929 blk
= blk_by_name(backup
->device
);
1931 error_setg(errp
, "Device '%s' not found", backup
->device
);
1935 if (!blk_is_available(blk
)) {
1936 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, backup
->device
);
1940 target
= blk_by_name(backup
->target
);
1942 error_setg(errp
, "Device '%s' not found", backup
->target
);
1946 /* AioContext is released in .clean() */
1947 state
->aio_context
= blk_get_aio_context(blk
);
1948 if (state
->aio_context
!= blk_get_aio_context(target
)) {
1949 state
->aio_context
= NULL
;
1950 error_setg(errp
, "Backup between two IO threads is not implemented");
1953 aio_context_acquire(state
->aio_context
);
1954 state
->bs
= blk_bs(blk
);
1955 bdrv_drained_begin(state
->bs
);
1957 do_blockdev_backup(backup
->device
, backup
->target
,
1959 backup
->has_speed
, backup
->speed
,
1960 backup
->has_on_source_error
, backup
->on_source_error
,
1961 backup
->has_on_target_error
, backup
->on_target_error
,
1962 common
->block_job_txn
, &local_err
);
1964 error_propagate(errp
, local_err
);
1968 state
->job
= state
->bs
->job
;
1971 static void blockdev_backup_abort(BlkActionState
*common
)
1973 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1974 BlockDriverState
*bs
= state
->bs
;
1976 /* Only cancel if it's the job we started */
1977 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1978 block_job_cancel_sync(bs
->job
);
1982 static void blockdev_backup_clean(BlkActionState
*common
)
1984 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1986 if (state
->aio_context
) {
1987 bdrv_drained_end(state
->bs
);
1988 aio_context_release(state
->aio_context
);
1992 typedef struct BlockDirtyBitmapState
{
1993 BlkActionState common
;
1994 BdrvDirtyBitmap
*bitmap
;
1995 BlockDriverState
*bs
;
1996 AioContext
*aio_context
;
1999 } BlockDirtyBitmapState
;
2001 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
2004 Error
*local_err
= NULL
;
2005 BlockDirtyBitmapAdd
*action
;
2006 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2009 if (action_check_completion_mode(common
, errp
) < 0) {
2013 action
= common
->action
->u
.block_dirty_bitmap_add
;
2014 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2015 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
2016 action
->has_granularity
, action
->granularity
,
2020 state
->prepared
= true;
2022 error_propagate(errp
, local_err
);
2026 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
2028 BlockDirtyBitmapAdd
*action
;
2029 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2032 action
= common
->action
->u
.block_dirty_bitmap_add
;
2033 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2034 * then the node reference and bitmap name must have been valid.
2036 if (state
->prepared
) {
2037 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
2041 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
2044 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2046 BlockDirtyBitmap
*action
;
2048 if (action_check_completion_mode(common
, errp
) < 0) {
2052 action
= common
->action
->u
.block_dirty_bitmap_clear
;
2053 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2056 &state
->aio_context
,
2058 if (!state
->bitmap
) {
2062 if (bdrv_dirty_bitmap_frozen(state
->bitmap
)) {
2063 error_setg(errp
, "Cannot modify a frozen bitmap");
2065 } else if (!bdrv_dirty_bitmap_enabled(state
->bitmap
)) {
2066 error_setg(errp
, "Cannot clear a disabled bitmap");
2070 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2071 /* AioContext is released in .clean() */
2074 static void block_dirty_bitmap_clear_abort(BlkActionState
*common
)
2076 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2079 bdrv_undo_clear_dirty_bitmap(state
->bitmap
, state
->backup
);
2082 static void block_dirty_bitmap_clear_commit(BlkActionState
*common
)
2084 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2087 hbitmap_free(state
->backup
);
2090 static void block_dirty_bitmap_clear_clean(BlkActionState
*common
)
2092 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2095 if (state
->aio_context
) {
2096 aio_context_release(state
->aio_context
);
2100 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2102 error_setg(errp
, "Transaction aborted using Abort action");
2105 static void abort_commit(BlkActionState
*common
)
2107 g_assert_not_reached(); /* this action never succeeds */
2110 static const BlkActionOps actions
[] = {
2111 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2112 .instance_size
= sizeof(ExternalSnapshotState
),
2113 .prepare
= external_snapshot_prepare
,
2114 .commit
= external_snapshot_commit
,
2115 .abort
= external_snapshot_abort
,
2116 .clean
= external_snapshot_clean
,
2118 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2119 .instance_size
= sizeof(ExternalSnapshotState
),
2120 .prepare
= external_snapshot_prepare
,
2121 .commit
= external_snapshot_commit
,
2122 .abort
= external_snapshot_abort
,
2123 .clean
= external_snapshot_clean
,
2125 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2126 .instance_size
= sizeof(DriveBackupState
),
2127 .prepare
= drive_backup_prepare
,
2128 .abort
= drive_backup_abort
,
2129 .clean
= drive_backup_clean
,
2131 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2132 .instance_size
= sizeof(BlockdevBackupState
),
2133 .prepare
= blockdev_backup_prepare
,
2134 .abort
= blockdev_backup_abort
,
2135 .clean
= blockdev_backup_clean
,
2137 [TRANSACTION_ACTION_KIND_ABORT
] = {
2138 .instance_size
= sizeof(BlkActionState
),
2139 .prepare
= abort_prepare
,
2140 .commit
= abort_commit
,
2142 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2143 .instance_size
= sizeof(InternalSnapshotState
),
2144 .prepare
= internal_snapshot_prepare
,
2145 .abort
= internal_snapshot_abort
,
2146 .clean
= internal_snapshot_clean
,
2148 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2149 .instance_size
= sizeof(BlockDirtyBitmapState
),
2150 .prepare
= block_dirty_bitmap_add_prepare
,
2151 .abort
= block_dirty_bitmap_add_abort
,
2153 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2154 .instance_size
= sizeof(BlockDirtyBitmapState
),
2155 .prepare
= block_dirty_bitmap_clear_prepare
,
2156 .commit
= block_dirty_bitmap_clear_commit
,
2157 .abort
= block_dirty_bitmap_clear_abort
,
2158 .clean
= block_dirty_bitmap_clear_clean
,
2163 * Allocate a TransactionProperties structure if necessary, and fill
2164 * that structure with desired defaults if they are unset.
2166 static TransactionProperties
*get_transaction_properties(
2167 TransactionProperties
*props
)
2170 props
= g_new0(TransactionProperties
, 1);
2173 if (!props
->has_completion_mode
) {
2174 props
->has_completion_mode
= true;
2175 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2182 * 'Atomic' group operations. The operations are performed as a set, and if
2183 * any fail then we roll back all operations in the group.
2185 void qmp_transaction(TransactionActionList
*dev_list
,
2187 struct TransactionProperties
*props
,
2190 TransactionActionList
*dev_entry
= dev_list
;
2191 BlockJobTxn
*block_job_txn
= NULL
;
2192 BlkActionState
*state
, *next
;
2193 Error
*local_err
= NULL
;
2195 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkActionState
) snap_bdrv_states
;
2196 QSIMPLEQ_INIT(&snap_bdrv_states
);
2198 /* Does this transaction get canceled as a group on failure?
2199 * If not, we don't really need to make a BlockJobTxn.
2201 props
= get_transaction_properties(props
);
2202 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2203 block_job_txn
= block_job_txn_new();
2206 /* drain all i/o before any operations */
2209 /* We don't do anything in this loop that commits us to the operations */
2210 while (NULL
!= dev_entry
) {
2211 TransactionAction
*dev_info
= NULL
;
2212 const BlkActionOps
*ops
;
2214 dev_info
= dev_entry
->value
;
2215 dev_entry
= dev_entry
->next
;
2217 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2219 ops
= &actions
[dev_info
->type
];
2220 assert(ops
->instance_size
> 0);
2222 state
= g_malloc0(ops
->instance_size
);
2224 state
->action
= dev_info
;
2225 state
->block_job_txn
= block_job_txn
;
2226 state
->txn_props
= props
;
2227 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2229 state
->ops
->prepare(state
, &local_err
);
2231 error_propagate(errp
, local_err
);
2232 goto delete_and_fail
;
2236 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2237 if (state
->ops
->commit
) {
2238 state
->ops
->commit(state
);
2246 /* failure, and it is all-or-none; roll back all operations */
2247 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2248 if (state
->ops
->abort
) {
2249 state
->ops
->abort(state
);
2253 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2254 if (state
->ops
->clean
) {
2255 state
->ops
->clean(state
);
2260 qapi_free_TransactionProperties(props
);
2262 block_job_txn_unref(block_job_txn
);
2265 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
2267 Error
*local_err
= NULL
;
2269 qmp_blockdev_open_tray(device
, has_force
, force
, &local_err
);
2271 error_propagate(errp
, local_err
);
2275 qmp_x_blockdev_remove_medium(device
, errp
);
2278 void qmp_block_passwd(bool has_device
, const char *device
,
2279 bool has_node_name
, const char *node_name
,
2280 const char *password
, Error
**errp
)
2282 Error
*local_err
= NULL
;
2283 BlockDriverState
*bs
;
2284 AioContext
*aio_context
;
2286 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2287 has_node_name
? node_name
: NULL
,
2290 error_propagate(errp
, local_err
);
2294 aio_context
= bdrv_get_aio_context(bs
);
2295 aio_context_acquire(aio_context
);
2297 bdrv_add_key(bs
, password
, errp
);
2299 aio_context_release(aio_context
);
2302 void qmp_blockdev_open_tray(const char *device
, bool has_force
, bool force
,
2312 blk
= blk_by_name(device
);
2314 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2315 "Device '%s' not found", device
);
2319 if (!blk_dev_has_removable_media(blk
)) {
2320 error_setg(errp
, "Device '%s' is not removable", device
);
2324 if (!blk_dev_has_tray(blk
)) {
2325 /* Ignore this command on tray-less devices */
2329 if (blk_dev_is_tray_open(blk
)) {
2333 locked
= blk_dev_is_medium_locked(blk
);
2335 blk_dev_eject_request(blk
, force
);
2338 if (!locked
|| force
) {
2339 blk_dev_change_media_cb(blk
, false);
2343 void qmp_blockdev_close_tray(const char *device
, Error
**errp
)
2347 blk
= blk_by_name(device
);
2349 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2350 "Device '%s' not found", device
);
2354 if (!blk_dev_has_removable_media(blk
)) {
2355 error_setg(errp
, "Device '%s' is not removable", device
);
2359 if (!blk_dev_has_tray(blk
)) {
2360 /* Ignore this command on tray-less devices */
2364 if (!blk_dev_is_tray_open(blk
)) {
2368 blk_dev_change_media_cb(blk
, true);
2371 void qmp_x_blockdev_remove_medium(const char *device
, Error
**errp
)
2374 BlockDriverState
*bs
;
2375 AioContext
*aio_context
;
2378 blk
= blk_by_name(device
);
2380 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2381 "Device '%s' not found", device
);
2385 /* For BBs without a device, we can exchange the BDS tree at will */
2386 has_device
= blk_get_attached_dev(blk
);
2388 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2389 error_setg(errp
, "Device '%s' is not removable", device
);
2393 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2394 error_setg(errp
, "Tray of device '%s' is not open", device
);
2403 aio_context
= bdrv_get_aio_context(bs
);
2404 aio_context_acquire(aio_context
);
2406 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2410 /* This follows the convention established by bdrv_make_anon() */
2411 if (bs
->device_list
.tqe_prev
) {
2412 bdrv_device_remove(bs
);
2417 if (!blk_dev_has_tray(blk
)) {
2418 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2419 * called at all); therefore, the medium needs to be ejected here.
2420 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2421 * value passed here (i.e. false). */
2422 blk_dev_change_media_cb(blk
, false);
2426 aio_context_release(aio_context
);
2429 static void qmp_blockdev_insert_anon_medium(const char *device
,
2430 BlockDriverState
*bs
, Error
**errp
)
2435 blk
= blk_by_name(device
);
2437 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2438 "Device '%s' not found", device
);
2442 /* For BBs without a device, we can exchange the BDS tree at will */
2443 has_device
= blk_get_attached_dev(blk
);
2445 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2446 error_setg(errp
, "Device '%s' is not removable", device
);
2450 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2451 error_setg(errp
, "Tray of device '%s' is not open", device
);
2456 error_setg(errp
, "There already is a medium in device '%s'", device
);
2460 blk_insert_bs(blk
, bs
);
2462 QTAILQ_INSERT_TAIL(&bdrv_states
, bs
, device_list
);
2464 if (!blk_dev_has_tray(blk
)) {
2465 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2466 * called at all); therefore, the medium needs to be pushed into the
2468 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2469 * value passed here (i.e. true). */
2470 blk_dev_change_media_cb(blk
, true);
2474 void qmp_x_blockdev_insert_medium(const char *device
, const char *node_name
,
2477 BlockDriverState
*bs
;
2479 bs
= bdrv_find_node(node_name
);
2481 error_setg(errp
, "Node '%s' not found", node_name
);
2486 error_setg(errp
, "Node '%s' is already in use by '%s'", node_name
,
2491 qmp_blockdev_insert_anon_medium(device
, bs
, errp
);
2494 void qmp_blockdev_change_medium(const char *device
, const char *filename
,
2495 bool has_format
, const char *format
,
2497 BlockdevChangeReadOnlyMode read_only
,
2501 BlockDriverState
*medium_bs
= NULL
;
2502 int bdrv_flags
, ret
;
2503 QDict
*options
= NULL
;
2506 blk
= blk_by_name(device
);
2508 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2509 "Device '%s' not found", device
);
2514 blk_update_root_state(blk
);
2517 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2519 if (!has_read_only
) {
2520 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2523 switch (read_only
) {
2524 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2527 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2528 bdrv_flags
&= ~BDRV_O_RDWR
;
2531 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2532 bdrv_flags
|= BDRV_O_RDWR
;
2540 options
= qdict_new();
2541 qdict_put(options
, "driver", qstring_from_str(format
));
2545 ret
= bdrv_open(&medium_bs
, filename
, NULL
, options
, bdrv_flags
, errp
);
2550 blk_apply_root_state(blk
, medium_bs
);
2552 bdrv_add_key(medium_bs
, NULL
, &err
);
2554 error_propagate(errp
, err
);
2558 qmp_blockdev_open_tray(device
, false, false, &err
);
2560 error_propagate(errp
, err
);
2564 qmp_x_blockdev_remove_medium(device
, &err
);
2566 error_propagate(errp
, err
);
2570 qmp_blockdev_insert_anon_medium(device
, medium_bs
, &err
);
2572 error_propagate(errp
, err
);
2576 qmp_blockdev_close_tray(device
, errp
);
2579 /* If the medium has been inserted, the device has its own reference, so
2580 * ours must be relinquished; and if it has not been inserted successfully,
2581 * the reference must be relinquished anyway */
2582 bdrv_unref(medium_bs
);
2585 /* throttling disk I/O limits */
2586 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
2593 bool has_bps_rd_max
,
2595 bool has_bps_wr_max
,
2599 bool has_iops_rd_max
,
2600 int64_t iops_rd_max
,
2601 bool has_iops_wr_max
,
2602 int64_t iops_wr_max
,
2606 const char *group
, Error
**errp
)
2609 BlockDriverState
*bs
;
2611 AioContext
*aio_context
;
2613 blk
= blk_by_name(device
);
2615 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2616 "Device '%s' not found", device
);
2620 aio_context
= blk_get_aio_context(blk
);
2621 aio_context_acquire(aio_context
);
2625 error_setg(errp
, "Device '%s' has no medium", device
);
2629 memset(&cfg
, 0, sizeof(cfg
));
2630 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
2631 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
2632 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
2634 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
2635 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
2636 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
2639 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
2641 if (has_bps_rd_max
) {
2642 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
2644 if (has_bps_wr_max
) {
2645 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
2648 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
2650 if (has_iops_rd_max
) {
2651 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
2653 if (has_iops_wr_max
) {
2654 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
2657 if (has_iops_size
) {
2658 cfg
.op_size
= iops_size
;
2661 if (!check_throttle_config(&cfg
, errp
)) {
2665 if (throttle_enabled(&cfg
)) {
2666 /* Enable I/O limits if they're not enabled yet, otherwise
2667 * just update the throttling group. */
2668 if (!bs
->throttle_state
) {
2669 bdrv_io_limits_enable(bs
, has_group
? group
: device
);
2670 } else if (has_group
) {
2671 bdrv_io_limits_update_group(bs
, group
);
2673 /* Set the new throttling configuration */
2674 bdrv_set_io_limits(bs
, &cfg
);
2675 } else if (bs
->throttle_state
) {
2676 /* If all throttling settings are set to 0, disable I/O limits */
2677 bdrv_io_limits_disable(bs
);
2681 aio_context_release(aio_context
);
2684 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2685 bool has_granularity
, uint32_t granularity
,
2688 AioContext
*aio_context
;
2689 BlockDriverState
*bs
;
2691 if (!name
|| name
[0] == '\0') {
2692 error_setg(errp
, "Bitmap name cannot be empty");
2696 bs
= bdrv_lookup_bs(node
, node
, errp
);
2701 aio_context
= bdrv_get_aio_context(bs
);
2702 aio_context_acquire(aio_context
);
2704 if (has_granularity
) {
2705 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2706 error_setg(errp
, "Granularity must be power of 2 "
2707 "and at least 512");
2711 /* Default to cluster size, if available: */
2712 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2715 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2718 aio_context_release(aio_context
);
2721 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2724 AioContext
*aio_context
;
2725 BlockDriverState
*bs
;
2726 BdrvDirtyBitmap
*bitmap
;
2728 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2729 if (!bitmap
|| !bs
) {
2733 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2735 "Bitmap '%s' is currently frozen and cannot be removed",
2739 bdrv_dirty_bitmap_make_anon(bitmap
);
2740 bdrv_release_dirty_bitmap(bs
, bitmap
);
2743 aio_context_release(aio_context
);
2747 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2748 * immediately after a full backup operation.
2750 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2753 AioContext
*aio_context
;
2754 BdrvDirtyBitmap
*bitmap
;
2755 BlockDriverState
*bs
;
2757 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2758 if (!bitmap
|| !bs
) {
2762 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2764 "Bitmap '%s' is currently frozen and cannot be modified",
2767 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2769 "Bitmap '%s' is currently disabled and cannot be cleared",
2774 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2777 aio_context_release(aio_context
);
2780 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2782 const char *id
= qdict_get_str(qdict
, "id");
2784 BlockDriverState
*bs
;
2785 AioContext
*aio_context
;
2786 Error
*local_err
= NULL
;
2788 blk
= blk_by_name(id
);
2790 error_report("Device '%s' not found", id
);
2794 if (!blk_legacy_dinfo(blk
)) {
2795 error_report("Deleting device added with blockdev-add"
2796 " is not supported");
2800 aio_context
= blk_get_aio_context(blk
);
2801 aio_context_acquire(aio_context
);
2805 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2806 error_report_err(local_err
);
2807 aio_context_release(aio_context
);
2814 /* if we have a device attached to this BlockDriverState
2815 * then we need to make the drive anonymous until the device
2816 * can be removed. If this is a drive with no device backing
2817 * then we can just get rid of the block driver state right here.
2819 if (blk_get_attached_dev(blk
)) {
2820 blk_hide_on_behalf_of_hmp_drive_del(blk
);
2821 /* Further I/O must not pause the guest */
2822 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
2823 BLOCKDEV_ON_ERROR_REPORT
);
2828 aio_context_release(aio_context
);
2831 void qmp_block_resize(bool has_device
, const char *device
,
2832 bool has_node_name
, const char *node_name
,
2833 int64_t size
, Error
**errp
)
2835 Error
*local_err
= NULL
;
2836 BlockDriverState
*bs
;
2837 AioContext
*aio_context
;
2840 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2841 has_node_name
? node_name
: NULL
,
2844 error_propagate(errp
, local_err
);
2848 aio_context
= bdrv_get_aio_context(bs
);
2849 aio_context_acquire(aio_context
);
2851 if (!bdrv_is_first_non_filter(bs
)) {
2852 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
2857 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2861 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2862 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2866 /* complete all in-flight operations before resizing the device */
2869 ret
= bdrv_truncate(bs
, size
);
2874 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2877 error_setg(errp
, QERR_UNSUPPORTED
);
2880 error_setg(errp
, "Device '%s' is read only", device
);
2883 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2886 error_setg_errno(errp
, -ret
, "Could not resize");
2891 aio_context_release(aio_context
);
2894 static void block_job_cb(void *opaque
, int ret
)
2896 /* Note that this function may be executed from another AioContext besides
2897 * the QEMU main loop. If you need to access anything that assumes the
2898 * QEMU global mutex, use a BH or introduce a mutex.
2901 BlockDriverState
*bs
= opaque
;
2902 const char *msg
= NULL
;
2904 trace_block_job_cb(bs
, bs
->job
, ret
);
2909 msg
= strerror(-ret
);
2912 if (block_job_is_cancelled(bs
->job
)) {
2913 block_job_event_cancelled(bs
->job
);
2915 block_job_event_completed(bs
->job
, msg
);
2919 void qmp_block_stream(const char *device
,
2920 bool has_base
, const char *base
,
2921 bool has_backing_file
, const char *backing_file
,
2922 bool has_speed
, int64_t speed
,
2923 bool has_on_error
, BlockdevOnError on_error
,
2927 BlockDriverState
*bs
;
2928 BlockDriverState
*base_bs
= NULL
;
2929 AioContext
*aio_context
;
2930 Error
*local_err
= NULL
;
2931 const char *base_name
= NULL
;
2933 if (!has_on_error
) {
2934 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2937 blk
= blk_by_name(device
);
2939 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2940 "Device '%s' not found", device
);
2944 aio_context
= blk_get_aio_context(blk
);
2945 aio_context_acquire(aio_context
);
2947 if (!blk_is_available(blk
)) {
2948 error_setg(errp
, "Device '%s' has no medium", device
);
2953 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_STREAM
, errp
)) {
2958 base_bs
= bdrv_find_backing_image(bs
, base
);
2959 if (base_bs
== NULL
) {
2960 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
2963 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2967 /* if we are streaming the entire chain, the result will have no backing
2968 * file, and specifying one is therefore an error */
2969 if (base_bs
== NULL
&& has_backing_file
) {
2970 error_setg(errp
, "backing file specified, but streaming the "
2975 /* backing_file string overrides base bs filename */
2976 base_name
= has_backing_file
? backing_file
: base_name
;
2978 stream_start(bs
, base_bs
, base_name
, has_speed
? speed
: 0,
2979 on_error
, block_job_cb
, bs
, &local_err
);
2981 error_propagate(errp
, local_err
);
2985 trace_qmp_block_stream(bs
, bs
->job
);
2988 aio_context_release(aio_context
);
2991 void qmp_block_commit(const char *device
,
2992 bool has_base
, const char *base
,
2993 bool has_top
, const char *top
,
2994 bool has_backing_file
, const char *backing_file
,
2995 bool has_speed
, int64_t speed
,
2999 BlockDriverState
*bs
;
3000 BlockDriverState
*base_bs
, *top_bs
;
3001 AioContext
*aio_context
;
3002 Error
*local_err
= NULL
;
3003 /* This will be part of the QMP command, if/when the
3004 * BlockdevOnError change for blkmirror makes it in
3006 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3013 * libvirt relies on the DeviceNotFound error class in order to probe for
3014 * live commit feature versions; for this to work, we must make sure to
3015 * perform the device lookup before any generic errors that may occur in a
3016 * scenario in which all optional arguments are omitted. */
3017 blk
= blk_by_name(device
);
3019 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3020 "Device '%s' not found", device
);
3024 aio_context
= blk_get_aio_context(blk
);
3025 aio_context_acquire(aio_context
);
3027 if (!blk_is_available(blk
)) {
3028 error_setg(errp
, "Device '%s' has no medium", device
);
3033 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3037 /* default top_bs is the active layer */
3040 if (has_top
&& top
) {
3041 if (strcmp(bs
->filename
, top
) != 0) {
3042 top_bs
= bdrv_find_backing_image(bs
, top
);
3046 if (top_bs
== NULL
) {
3047 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3051 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3053 if (has_base
&& base
) {
3054 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3056 base_bs
= bdrv_find_base(top_bs
);
3059 if (base_bs
== NULL
) {
3060 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3064 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3066 if (bdrv_op_is_blocked(base_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3070 /* Do not allow attempts to commit an image into itself */
3071 if (top_bs
== base_bs
) {
3072 error_setg(errp
, "cannot commit an image into itself");
3077 if (has_backing_file
) {
3078 error_setg(errp
, "'backing-file' specified,"
3079 " but 'top' is the active layer");
3082 commit_active_start(bs
, base_bs
, speed
, on_error
, block_job_cb
,
3085 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
3086 has_backing_file
? backing_file
: NULL
, &local_err
);
3088 if (local_err
!= NULL
) {
3089 error_propagate(errp
, local_err
);
3094 aio_context_release(aio_context
);
3097 static void do_drive_backup(const char *device
, const char *target
,
3098 bool has_format
, const char *format
,
3099 enum MirrorSyncMode sync
,
3100 bool has_mode
, enum NewImageMode mode
,
3101 bool has_speed
, int64_t speed
,
3102 bool has_bitmap
, const char *bitmap
,
3103 bool has_on_source_error
,
3104 BlockdevOnError on_source_error
,
3105 bool has_on_target_error
,
3106 BlockdevOnError on_target_error
,
3107 BlockJobTxn
*txn
, Error
**errp
)
3110 BlockDriverState
*bs
;
3111 BlockDriverState
*target_bs
;
3112 BlockDriverState
*source
= NULL
;
3113 BdrvDirtyBitmap
*bmap
= NULL
;
3114 AioContext
*aio_context
;
3115 QDict
*options
= NULL
;
3116 Error
*local_err
= NULL
;
3124 if (!has_on_source_error
) {
3125 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3127 if (!has_on_target_error
) {
3128 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3131 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3134 blk
= blk_by_name(device
);
3136 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3137 "Device '%s' not found", device
);
3141 aio_context
= blk_get_aio_context(blk
);
3142 aio_context_acquire(aio_context
);
3144 /* Although backup_run has this check too, we need to use bs->drv below, so
3145 * do an early check redundantly. */
3146 if (!blk_is_available(blk
)) {
3147 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
3153 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
3156 /* Early check to avoid creating target */
3157 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3161 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3163 /* See if we have a backing HD we can use to create our new image
3165 if (sync
== MIRROR_SYNC_MODE_TOP
) {
3166 source
= backing_bs(bs
);
3168 sync
= MIRROR_SYNC_MODE_FULL
;
3171 if (sync
== MIRROR_SYNC_MODE_NONE
) {
3175 size
= bdrv_getlength(bs
);
3177 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3181 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
3184 bdrv_img_create(target
, format
, source
->filename
,
3185 source
->drv
->format_name
, NULL
,
3186 size
, flags
, &local_err
, false);
3188 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
3189 size
, flags
, &local_err
, false);
3194 error_propagate(errp
, local_err
);
3199 options
= qdict_new();
3200 qdict_put(options
, "driver", qstring_from_str(format
));
3204 ret
= bdrv_open(&target_bs
, target
, NULL
, options
, flags
, &local_err
);
3206 error_propagate(errp
, local_err
);
3210 bdrv_set_aio_context(target_bs
, aio_context
);
3213 bmap
= bdrv_find_dirty_bitmap(bs
, bitmap
);
3215 error_setg(errp
, "Bitmap '%s' could not be found", bitmap
);
3216 bdrv_unref(target_bs
);
3221 backup_start(bs
, target_bs
, speed
, sync
, bmap
,
3222 on_source_error
, on_target_error
,
3223 block_job_cb
, bs
, txn
, &local_err
);
3224 if (local_err
!= NULL
) {
3225 bdrv_unref(target_bs
);
3226 error_propagate(errp
, local_err
);
3231 aio_context_release(aio_context
);
3234 void qmp_drive_backup(const char *device
, const char *target
,
3235 bool has_format
, const char *format
,
3236 enum MirrorSyncMode sync
,
3237 bool has_mode
, enum NewImageMode mode
,
3238 bool has_speed
, int64_t speed
,
3239 bool has_bitmap
, const char *bitmap
,
3240 bool has_on_source_error
, BlockdevOnError on_source_error
,
3241 bool has_on_target_error
, BlockdevOnError on_target_error
,
3244 return do_drive_backup(device
, target
, has_format
, format
, sync
,
3245 has_mode
, mode
, has_speed
, speed
,
3247 has_on_source_error
, on_source_error
,
3248 has_on_target_error
, on_target_error
,
3252 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3254 return bdrv_named_nodes_list(errp
);
3257 void do_blockdev_backup(const char *device
, const char *target
,
3258 enum MirrorSyncMode sync
,
3259 bool has_speed
, int64_t speed
,
3260 bool has_on_source_error
,
3261 BlockdevOnError on_source_error
,
3262 bool has_on_target_error
,
3263 BlockdevOnError on_target_error
,
3264 BlockJobTxn
*txn
, Error
**errp
)
3266 BlockBackend
*blk
, *target_blk
;
3267 BlockDriverState
*bs
;
3268 BlockDriverState
*target_bs
;
3269 Error
*local_err
= NULL
;
3270 AioContext
*aio_context
;
3275 if (!has_on_source_error
) {
3276 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3278 if (!has_on_target_error
) {
3279 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3282 blk
= blk_by_name(device
);
3284 error_setg(errp
, "Device '%s' not found", device
);
3288 aio_context
= blk_get_aio_context(blk
);
3289 aio_context_acquire(aio_context
);
3291 if (!blk_is_available(blk
)) {
3292 error_setg(errp
, "Device '%s' has no medium", device
);
3297 target_blk
= blk_by_name(target
);
3299 error_setg(errp
, "Device '%s' not found", target
);
3303 if (!blk_is_available(target_blk
)) {
3304 error_setg(errp
, "Device '%s' has no medium", target
);
3307 target_bs
= blk_bs(target_blk
);
3309 bdrv_ref(target_bs
);
3310 bdrv_set_aio_context(target_bs
, aio_context
);
3311 backup_start(bs
, target_bs
, speed
, sync
, NULL
, on_source_error
,
3312 on_target_error
, block_job_cb
, bs
, txn
, &local_err
);
3313 if (local_err
!= NULL
) {
3314 bdrv_unref(target_bs
);
3315 error_propagate(errp
, local_err
);
3318 aio_context_release(aio_context
);
3321 void qmp_blockdev_backup(const char *device
, const char *target
,
3322 enum MirrorSyncMode sync
,
3323 bool has_speed
, int64_t speed
,
3324 bool has_on_source_error
,
3325 BlockdevOnError on_source_error
,
3326 bool has_on_target_error
,
3327 BlockdevOnError on_target_error
,
3330 do_blockdev_backup(device
, target
, sync
, has_speed
, speed
,
3331 has_on_source_error
, on_source_error
,
3332 has_on_target_error
, on_target_error
,
3336 /* Parameter check and block job starting for drive mirroring.
3337 * Caller should hold @device and @target's aio context (must be the same).
3339 static void blockdev_mirror_common(BlockDriverState
*bs
,
3340 BlockDriverState
*target
,
3341 bool has_replaces
, const char *replaces
,
3342 enum MirrorSyncMode sync
,
3343 bool has_speed
, int64_t speed
,
3344 bool has_granularity
, uint32_t granularity
,
3345 bool has_buf_size
, int64_t buf_size
,
3346 bool has_on_source_error
,
3347 BlockdevOnError on_source_error
,
3348 bool has_on_target_error
,
3349 BlockdevOnError on_target_error
,
3350 bool has_unmap
, bool unmap
,
3357 if (!has_on_source_error
) {
3358 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3360 if (!has_on_target_error
) {
3361 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3363 if (!has_granularity
) {
3366 if (!has_buf_size
) {
3373 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3374 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3375 "a value in range [512B, 64MB]");
3378 if (granularity
& (granularity
- 1)) {
3379 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3384 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3387 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3391 error_setg(errp
, "Cannot mirror to an attached block device");
3395 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3396 sync
= MIRROR_SYNC_MODE_FULL
;
3399 /* pass the node name to replace to mirror start since it's loose coupling
3400 * and will allow to check whether the node still exist at mirror completion
3402 mirror_start(bs
, target
,
3403 has_replaces
? replaces
: NULL
,
3404 speed
, granularity
, buf_size
, sync
,
3405 on_source_error
, on_target_error
, unmap
,
3406 block_job_cb
, bs
, errp
);
3409 void qmp_drive_mirror(const char *device
, const char *target
,
3410 bool has_format
, const char *format
,
3411 bool has_node_name
, const char *node_name
,
3412 bool has_replaces
, const char *replaces
,
3413 enum MirrorSyncMode sync
,
3414 bool has_mode
, enum NewImageMode mode
,
3415 bool has_speed
, int64_t speed
,
3416 bool has_granularity
, uint32_t granularity
,
3417 bool has_buf_size
, int64_t buf_size
,
3418 bool has_on_source_error
, BlockdevOnError on_source_error
,
3419 bool has_on_target_error
, BlockdevOnError on_target_error
,
3420 bool has_unmap
, bool unmap
,
3423 BlockDriverState
*bs
;
3425 BlockDriverState
*source
, *target_bs
;
3426 AioContext
*aio_context
;
3427 Error
*local_err
= NULL
;
3428 QDict
*options
= NULL
;
3433 blk
= blk_by_name(device
);
3435 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3436 "Device '%s' not found", device
);
3440 aio_context
= blk_get_aio_context(blk
);
3441 aio_context_acquire(aio_context
);
3443 if (!blk_is_available(blk
)) {
3444 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
3449 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3453 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
3456 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3457 source
= backing_bs(bs
);
3458 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3459 sync
= MIRROR_SYNC_MODE_FULL
;
3461 if (sync
== MIRROR_SYNC_MODE_NONE
) {
3465 size
= bdrv_getlength(bs
);
3467 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3472 BlockDriverState
*to_replace_bs
;
3473 AioContext
*replace_aio_context
;
3474 int64_t replace_size
;
3476 if (!has_node_name
) {
3477 error_setg(errp
, "a node-name must be provided when replacing a"
3478 " named node of the graph");
3482 to_replace_bs
= check_to_replace_node(bs
, replaces
, &local_err
);
3484 if (!to_replace_bs
) {
3485 error_propagate(errp
, local_err
);
3489 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3490 aio_context_acquire(replace_aio_context
);
3491 replace_size
= bdrv_getlength(to_replace_bs
);
3492 aio_context_release(replace_aio_context
);
3494 if (size
!= replace_size
) {
3495 error_setg(errp
, "cannot replace image with a mirror image of "
3501 if ((sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3502 && mode
!= NEW_IMAGE_MODE_EXISTING
)
3504 /* create new image w/o backing file */
3506 bdrv_img_create(target
, format
,
3507 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
3510 case NEW_IMAGE_MODE_EXISTING
:
3512 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3513 /* create new image with backing file */
3514 bdrv_img_create(target
, format
,
3516 source
->drv
->format_name
,
3517 NULL
, size
, flags
, &local_err
, false);
3525 error_propagate(errp
, local_err
);
3529 options
= qdict_new();
3530 if (has_node_name
) {
3531 qdict_put(options
, "node-name", qstring_from_str(node_name
));
3534 qdict_put(options
, "driver", qstring_from_str(format
));
3537 /* Mirroring takes care of copy-on-write using the source's backing
3541 ret
= bdrv_open(&target_bs
, target
, NULL
, options
,
3542 flags
| BDRV_O_NO_BACKING
, &local_err
);
3544 error_propagate(errp
, local_err
);
3548 bdrv_set_aio_context(target_bs
, aio_context
);
3550 blockdev_mirror_common(bs
, target_bs
,
3551 has_replaces
, replaces
, sync
,
3553 has_granularity
, granularity
,
3554 has_buf_size
, buf_size
,
3555 has_on_source_error
, on_source_error
,
3556 has_on_target_error
, on_target_error
,
3560 error_propagate(errp
, local_err
);
3561 bdrv_unref(target_bs
);
3564 aio_context_release(aio_context
);
3567 void qmp_blockdev_mirror(const char *device
, const char *target
,
3568 bool has_replaces
, const char *replaces
,
3569 MirrorSyncMode sync
,
3570 bool has_speed
, int64_t speed
,
3571 bool has_granularity
, uint32_t granularity
,
3572 bool has_buf_size
, int64_t buf_size
,
3573 bool has_on_source_error
,
3574 BlockdevOnError on_source_error
,
3575 bool has_on_target_error
,
3576 BlockdevOnError on_target_error
,
3579 BlockDriverState
*bs
;
3581 BlockDriverState
*target_bs
;
3582 AioContext
*aio_context
;
3583 Error
*local_err
= NULL
;
3585 blk
= blk_by_name(device
);
3587 error_setg(errp
, "Device '%s' not found", device
);
3593 error_setg(errp
, "Device '%s' has no media", device
);
3597 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3602 aio_context
= bdrv_get_aio_context(bs
);
3603 aio_context_acquire(aio_context
);
3605 bdrv_ref(target_bs
);
3606 bdrv_set_aio_context(target_bs
, aio_context
);
3608 blockdev_mirror_common(bs
, target_bs
,
3609 has_replaces
, replaces
, sync
,
3611 has_granularity
, granularity
,
3612 has_buf_size
, buf_size
,
3613 has_on_source_error
, on_source_error
,
3614 has_on_target_error
, on_target_error
,
3618 error_propagate(errp
, local_err
);
3619 bdrv_unref(target_bs
);
3622 aio_context_release(aio_context
);
3625 /* Get the block job for a given device name and acquire its AioContext */
3626 static BlockJob
*find_block_job(const char *device
, AioContext
**aio_context
,
3630 BlockDriverState
*bs
;
3632 *aio_context
= NULL
;
3634 blk
= blk_by_name(device
);
3639 *aio_context
= blk_get_aio_context(blk
);
3640 aio_context_acquire(*aio_context
);
3642 if (!blk_is_available(blk
)) {
3654 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3655 "No active block job on device '%s'", device
);
3657 aio_context_release(*aio_context
);
3658 *aio_context
= NULL
;
3663 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3665 AioContext
*aio_context
;
3666 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3672 block_job_set_speed(job
, speed
, errp
);
3673 aio_context_release(aio_context
);
3676 void qmp_block_job_cancel(const char *device
,
3677 bool has_force
, bool force
, Error
**errp
)
3679 AioContext
*aio_context
;
3680 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3690 if (job
->user_paused
&& !force
) {
3691 error_setg(errp
, "The block job for device '%s' is currently paused",
3696 trace_qmp_block_job_cancel(job
);
3697 block_job_cancel(job
);
3699 aio_context_release(aio_context
);
3702 void qmp_block_job_pause(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
= true;
3712 trace_qmp_block_job_pause(job
);
3713 block_job_pause(job
);
3714 aio_context_release(aio_context
);
3717 void qmp_block_job_resume(const char *device
, Error
**errp
)
3719 AioContext
*aio_context
;
3720 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3722 if (!job
|| !job
->user_paused
) {
3726 job
->user_paused
= false;
3727 trace_qmp_block_job_resume(job
);
3728 block_job_resume(job
);
3729 aio_context_release(aio_context
);
3732 void qmp_block_job_complete(const char *device
, Error
**errp
)
3734 AioContext
*aio_context
;
3735 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3741 trace_qmp_block_job_complete(job
);
3742 block_job_complete(job
, errp
);
3743 aio_context_release(aio_context
);
3746 void qmp_change_backing_file(const char *device
,
3747 const char *image_node_name
,
3748 const char *backing_file
,
3752 BlockDriverState
*bs
= NULL
;
3753 AioContext
*aio_context
;
3754 BlockDriverState
*image_bs
= NULL
;
3755 Error
*local_err
= NULL
;
3760 blk
= blk_by_name(device
);
3762 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3763 "Device '%s' not found", device
);
3767 aio_context
= blk_get_aio_context(blk
);
3768 aio_context_acquire(aio_context
);
3770 if (!blk_is_available(blk
)) {
3771 error_setg(errp
, "Device '%s' has no medium", device
);
3776 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3778 error_propagate(errp
, local_err
);
3783 error_setg(errp
, "image file not found");
3787 if (bdrv_find_base(image_bs
) == image_bs
) {
3788 error_setg(errp
, "not allowing backing file change on an image "
3789 "without a backing file");
3793 /* even though we are not necessarily operating on bs, we need it to
3794 * determine if block ops are currently prohibited on the chain */
3795 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3799 /* final sanity check */
3800 if (!bdrv_chain_contains(bs
, image_bs
)) {
3801 error_setg(errp
, "'%s' and image file are not in the same chain",
3806 /* if not r/w, reopen to make r/w */
3807 open_flags
= image_bs
->open_flags
;
3808 ro
= bdrv_is_read_only(image_bs
);
3811 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3813 error_propagate(errp
, local_err
);
3818 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3819 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3822 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3824 /* don't exit here, so we can try to restore open flags if
3829 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3831 error_propagate(errp
, local_err
); /* will preserve prior errp */
3836 aio_context_release(aio_context
);
3839 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3841 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
3842 BlockDriverState
*bs
;
3843 BlockBackend
*blk
= NULL
;
3846 Error
*local_err
= NULL
;
3848 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3849 * cache.direct=false instead of silently switching to aio=threads, except
3850 * when called from drive_new().
3852 * For now, simply forbidding the combination for all drivers will do. */
3853 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
3854 bool direct
= options
->has_cache
&&
3855 options
->cache
->has_direct
&&
3856 options
->cache
->direct
;
3858 error_setg(errp
, "aio=native requires cache.direct=true");
3863 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
), NULL
, &options
,
3866 error_propagate(errp
, local_err
);
3870 obj
= qmp_output_get_qobject(ov
);
3871 qdict
= qobject_to_qdict(obj
);
3873 qdict_flatten(qdict
);
3875 if (options
->has_id
) {
3876 blk
= blockdev_init(NULL
, qdict
, &local_err
);
3878 error_propagate(errp
, local_err
);
3884 if (!qdict_get_try_str(qdict
, "node-name")) {
3885 error_setg(errp
, "'id' and/or 'node-name' need to be specified for "
3890 bs
= bds_tree_init(qdict
, errp
);
3895 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3898 if (bs
&& bdrv_key_required(bs
)) {
3902 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3905 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3910 qmp_output_visitor_cleanup(ov
);
3913 void qmp_x_blockdev_del(bool has_id
, const char *id
,
3914 bool has_node_name
, const char *node_name
, Error
**errp
)
3916 AioContext
*aio_context
;
3918 BlockDriverState
*bs
;
3920 if (has_id
&& has_node_name
) {
3921 error_setg(errp
, "Only one of id and node-name must be specified");
3923 } else if (!has_id
&& !has_node_name
) {
3924 error_setg(errp
, "No block device specified");
3929 blk
= blk_by_name(id
);
3931 error_setg(errp
, "Cannot find block backend %s", id
);
3934 if (blk_get_refcnt(blk
) > 1) {
3935 error_setg(errp
, "Block backend %s is in use", id
);
3939 aio_context
= blk_get_aio_context(blk
);
3941 bs
= bdrv_find_node(node_name
);
3943 error_setg(errp
, "Cannot find node %s", node_name
);
3948 error_setg(errp
, "Node %s is in use by %s",
3949 node_name
, blk_name(blk
));
3952 aio_context
= bdrv_get_aio_context(bs
);
3955 aio_context_acquire(aio_context
);
3958 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
3962 if (!blk
&& !bs
->monitor_list
.tqe_prev
) {
3963 error_setg(errp
, "Node %s is not owned by the monitor",
3968 if (bs
->refcnt
> 1) {
3969 error_setg(errp
, "Block device %s is in use",
3970 bdrv_get_device_or_node_name(bs
));
3978 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3983 aio_context_release(aio_context
);
3986 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3988 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3989 BlockDriverState
*bs
;
3991 for (bs
= bdrv_next(NULL
); bs
; bs
= bdrv_next(bs
)) {
3992 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
3994 aio_context_acquire(aio_context
);
3997 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
3998 elem
->value
= block_job_query(bs
->job
);
4000 p_next
= &elem
->next
;
4003 aio_context_release(aio_context
);
4009 QemuOptsList qemu_common_drive_opts
= {
4011 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4015 .type
= QEMU_OPT_BOOL
,
4016 .help
= "enable/disable snapshot mode",
4019 .type
= QEMU_OPT_STRING
,
4020 .help
= "discard operation (ignore/off, unmap/on)",
4023 .type
= QEMU_OPT_STRING
,
4024 .help
= "host AIO implementation (threads, native)",
4027 .type
= QEMU_OPT_STRING
,
4028 .help
= "disk format (raw, qcow2, ...)",
4031 .type
= QEMU_OPT_STRING
,
4032 .help
= "read error action",
4035 .type
= QEMU_OPT_STRING
,
4036 .help
= "write error action",
4038 .name
= "read-only",
4039 .type
= QEMU_OPT_BOOL
,
4040 .help
= "open drive file as read-only",
4042 .name
= "throttling.iops-total",
4043 .type
= QEMU_OPT_NUMBER
,
4044 .help
= "limit total I/O operations per second",
4046 .name
= "throttling.iops-read",
4047 .type
= QEMU_OPT_NUMBER
,
4048 .help
= "limit read operations per second",
4050 .name
= "throttling.iops-write",
4051 .type
= QEMU_OPT_NUMBER
,
4052 .help
= "limit write operations per second",
4054 .name
= "throttling.bps-total",
4055 .type
= QEMU_OPT_NUMBER
,
4056 .help
= "limit total bytes per second",
4058 .name
= "throttling.bps-read",
4059 .type
= QEMU_OPT_NUMBER
,
4060 .help
= "limit read bytes per second",
4062 .name
= "throttling.bps-write",
4063 .type
= QEMU_OPT_NUMBER
,
4064 .help
= "limit write bytes per second",
4066 .name
= "throttling.iops-total-max",
4067 .type
= QEMU_OPT_NUMBER
,
4068 .help
= "I/O operations burst",
4070 .name
= "throttling.iops-read-max",
4071 .type
= QEMU_OPT_NUMBER
,
4072 .help
= "I/O operations read burst",
4074 .name
= "throttling.iops-write-max",
4075 .type
= QEMU_OPT_NUMBER
,
4076 .help
= "I/O operations write burst",
4078 .name
= "throttling.bps-total-max",
4079 .type
= QEMU_OPT_NUMBER
,
4080 .help
= "total bytes burst",
4082 .name
= "throttling.bps-read-max",
4083 .type
= QEMU_OPT_NUMBER
,
4084 .help
= "total bytes read burst",
4086 .name
= "throttling.bps-write-max",
4087 .type
= QEMU_OPT_NUMBER
,
4088 .help
= "total bytes write burst",
4090 .name
= "throttling.iops-size",
4091 .type
= QEMU_OPT_NUMBER
,
4092 .help
= "when limiting by iops max size of an I/O in bytes",
4094 .name
= "throttling.group",
4095 .type
= QEMU_OPT_STRING
,
4096 .help
= "name of the block throttling group",
4098 .name
= "copy-on-read",
4099 .type
= QEMU_OPT_BOOL
,
4100 .help
= "copy read data from backing file into image file",
4102 .name
= "detect-zeroes",
4103 .type
= QEMU_OPT_STRING
,
4104 .help
= "try to optimize zero writes (off, on, unmap)",
4106 .name
= "stats-account-invalid",
4107 .type
= QEMU_OPT_BOOL
,
4108 .help
= "whether to account for invalid I/O operations "
4109 "in the statistics",
4111 .name
= "stats-account-failed",
4112 .type
= QEMU_OPT_BOOL
,
4113 .help
= "whether to account for failed I/O operations "
4114 "in the statistics",
4116 { /* end of list */ }
4120 static QemuOptsList qemu_root_bds_opts
= {
4122 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4126 .type
= QEMU_OPT_STRING
,
4127 .help
= "discard operation (ignore/off, unmap/on)",
4130 .type
= QEMU_OPT_STRING
,
4131 .help
= "host AIO implementation (threads, native)",
4133 .name
= "read-only",
4134 .type
= QEMU_OPT_BOOL
,
4135 .help
= "open drive file as read-only",
4137 .name
= "copy-on-read",
4138 .type
= QEMU_OPT_BOOL
,
4139 .help
= "copy read data from backing file into image file",
4141 .name
= "detect-zeroes",
4142 .type
= QEMU_OPT_STRING
,
4143 .help
= "try to optimize zero writes (off, on, unmap)",
4145 { /* end of list */ }
4149 QemuOptsList qemu_drive_opts
= {
4151 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4154 * no elements => accept any params
4155 * validation will happen later
4157 { /* end of list */ }