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"
53 #include "qemu/cutils.h"
54 #include "qemu/help_option.h"
56 static QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
57 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
59 static const char *const if_name
[IF_COUNT
] = {
63 [IF_FLOPPY
] = "floppy",
64 [IF_PFLASH
] = "pflash",
67 [IF_VIRTIO
] = "virtio",
71 static int if_max_devs
[IF_COUNT
] = {
73 * Do not change these numbers! They govern how drive option
74 * index maps to unit and bus. That mapping is ABI.
76 * All controllers used to implement if=T drives need to support
77 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
78 * Otherwise, some index values map to "impossible" bus, unit
81 * For instance, if you change [IF_SCSI] to 255, -drive
82 * if=scsi,index=12 no longer means bus=1,unit=5, but
83 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
84 * the drive can't be set up. Regression.
91 * Boards may call this to offer board-by-board overrides
92 * of the default, global values.
94 void override_max_devs(BlockInterfaceType type
, int max_devs
)
103 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
104 dinfo
= blk_legacy_dinfo(blk
);
105 if (dinfo
->type
== type
) {
106 fprintf(stderr
, "Cannot override units-per-bus property of"
107 " the %s interface, because a drive of that type has"
108 " already been added.\n", if_name
[type
]);
109 g_assert_not_reached();
113 if_max_devs
[type
] = max_devs
;
117 * We automatically delete the drive when a device using it gets
118 * unplugged. Questionable feature, but we can't just drop it.
119 * Device models call blockdev_mark_auto_del() to schedule the
120 * automatic deletion, and generic qdev code calls blockdev_auto_del()
121 * when deletion is actually safe.
123 void blockdev_mark_auto_del(BlockBackend
*blk
)
125 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
126 BlockDriverState
*bs
= blk_bs(blk
);
127 AioContext
*aio_context
;
134 aio_context
= bdrv_get_aio_context(bs
);
135 aio_context_acquire(aio_context
);
138 block_job_cancel(bs
->job
);
141 aio_context_release(aio_context
);
147 void blockdev_auto_del(BlockBackend
*blk
)
149 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
151 if (dinfo
&& dinfo
->auto_del
) {
152 monitor_remove_blk(blk
);
158 * Returns the current mapping of how many units per bus
159 * a particular interface can support.
161 * A positive integer indicates n units per bus.
162 * 0 implies the mapping has not been established.
163 * -1 indicates an invalid BlockInterfaceType was given.
165 int drive_get_max_devs(BlockInterfaceType type
)
167 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
168 return if_max_devs
[type
];
174 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
176 int max_devs
= if_max_devs
[type
];
177 return max_devs
? index
/ max_devs
: 0;
180 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
182 int max_devs
= if_max_devs
[type
];
183 return max_devs
? index
% max_devs
: index
;
186 QemuOpts
*drive_def(const char *optstr
)
188 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
191 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
196 opts
= drive_def(optstr
);
200 if (type
!= IF_DEFAULT
) {
201 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
204 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
207 qemu_opt_set(opts
, "file", file
, &error_abort
);
211 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
216 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
217 dinfo
= blk_legacy_dinfo(blk
);
218 if (dinfo
&& dinfo
->type
== type
219 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
227 bool drive_check_orphaned(void)
233 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
234 dinfo
= blk_legacy_dinfo(blk
);
235 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
236 /* Unless this is a default drive, this may be an oversight. */
237 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
238 dinfo
->type
!= IF_NONE
) {
239 fprintf(stderr
, "Warning: Orphaned drive without device: "
240 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
241 blk_name(blk
), blk_bs(blk
) ? blk_bs(blk
)->filename
: "",
242 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
250 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
252 return drive_get(type
,
253 drive_index_to_bus_id(type
, index
),
254 drive_index_to_unit_id(type
, index
));
257 int drive_get_max_bus(BlockInterfaceType type
)
264 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
265 dinfo
= blk_legacy_dinfo(blk
);
266 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
267 max_bus
= dinfo
->bus
;
273 /* Get a block device. This should only be used for single-drive devices
274 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
276 DriveInfo
*drive_get_next(BlockInterfaceType type
)
278 static int next_block_unit
[IF_COUNT
];
280 return drive_get(type
, 0, next_block_unit
[type
]++);
283 static void bdrv_format_print(void *opaque
, const char *name
)
285 error_printf(" %s", name
);
290 BlockDriverState
*bs
;
293 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
295 if (!strcmp(buf
, "ignore")) {
296 return BLOCKDEV_ON_ERROR_IGNORE
;
297 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
298 return BLOCKDEV_ON_ERROR_ENOSPC
;
299 } else if (!strcmp(buf
, "stop")) {
300 return BLOCKDEV_ON_ERROR_STOP
;
301 } else if (!strcmp(buf
, "report")) {
302 return BLOCKDEV_ON_ERROR_REPORT
;
304 error_setg(errp
, "'%s' invalid %s error action",
305 buf
, is_read
? "read" : "write");
310 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
313 const QListEntry
*entry
;
314 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
315 switch (qobject_type(entry
->value
)) {
317 case QTYPE_QSTRING
: {
318 unsigned long long length
;
319 const char *str
= qstring_get_str(qobject_to_qstring(entry
->value
));
320 if (parse_uint_full(str
, &length
, 10) == 0 &&
321 length
> 0 && length
<= UINT_MAX
) {
322 block_acct_add_interval(stats
, (unsigned) length
);
324 error_setg(errp
, "Invalid interval length: %s", str
);
331 int64_t length
= qint_get_int(qobject_to_qint(entry
->value
));
332 if (length
> 0 && length
<= UINT_MAX
) {
333 block_acct_add_interval(stats
, (unsigned) length
);
335 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
342 error_setg(errp
, "The specification of stats-intervals is invalid");
349 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
351 /* All parameters but @opts are optional and may be set to NULL. */
352 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
353 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
354 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
357 Error
*local_error
= NULL
;
361 if (!qemu_opt_get_bool(opts
, "read-only", false)) {
362 *bdrv_flags
|= BDRV_O_RDWR
;
364 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
365 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
368 if ((discard
= qemu_opt_get(opts
, "discard")) != NULL
) {
369 if (bdrv_parse_discard_flags(discard
, bdrv_flags
) != 0) {
370 error_setg(errp
, "Invalid discard option");
375 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
376 if (!strcmp(aio
, "native")) {
377 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
378 } else if (!strcmp(aio
, "threads")) {
379 /* this is the default */
381 error_setg(errp
, "invalid aio option");
387 /* disk I/O throttling */
388 if (throttling_group
) {
389 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
393 throttle_config_init(throttle_cfg
);
394 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
395 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
396 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
397 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
398 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
399 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
400 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
401 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
402 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
403 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
404 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
405 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
407 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
408 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
409 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
410 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
411 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
412 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
413 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
414 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
415 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
416 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
417 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
418 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
420 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].burst_length
=
421 qemu_opt_get_number(opts
, "throttling.bps-total-max-length", 1);
422 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].burst_length
=
423 qemu_opt_get_number(opts
, "throttling.bps-read-max-length", 1);
424 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].burst_length
=
425 qemu_opt_get_number(opts
, "throttling.bps-write-max-length", 1);
426 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].burst_length
=
427 qemu_opt_get_number(opts
, "throttling.iops-total-max-length", 1);
428 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].burst_length
=
429 qemu_opt_get_number(opts
, "throttling.iops-read-max-length", 1);
430 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].burst_length
=
431 qemu_opt_get_number(opts
, "throttling.iops-write-max-length", 1);
433 throttle_cfg
->op_size
=
434 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
436 if (!throttle_is_valid(throttle_cfg
, errp
)) {
443 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
444 qemu_opt_get(opts
, "detect-zeroes"),
445 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX
,
446 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
449 error_propagate(errp
, local_error
);
454 *detect_zeroes
== BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP
&&
455 !(*bdrv_flags
& BDRV_O_UNMAP
))
457 error_setg(errp
, "setting detect-zeroes to unmap is not allowed "
458 "without setting discard operation to unmap");
464 /* Takes the ownership of bs_opts */
465 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
470 int on_read_error
, on_write_error
;
471 bool account_invalid
, account_failed
;
474 BlockDriverState
*bs
;
479 QDict
*interval_dict
= NULL
;
480 QList
*interval_list
= NULL
;
482 BlockdevDetectZeroesOptions detect_zeroes
=
483 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
484 const char *throttling_group
= NULL
;
486 /* Check common options by copying from bs_opts to opts, all other options
487 * stay in bs_opts for processing by bdrv_open(). */
488 id
= qdict_get_try_str(bs_opts
, "id");
489 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
491 error_propagate(errp
, error
);
495 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
497 error_propagate(errp
, error
);
502 qdict_del(bs_opts
, "id");
505 /* extract parameters */
506 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
508 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
509 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
511 writethrough
= !qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true);
513 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
514 qdict_array_split(interval_dict
, &interval_list
);
516 if (qdict_size(interval_dict
) != 0) {
517 error_setg(errp
, "Invalid option stats-intervals.%s",
518 qdict_first(interval_dict
)->key
);
522 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
523 &detect_zeroes
, &error
);
525 error_propagate(errp
, error
);
529 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
530 if (is_help_option(buf
)) {
531 error_printf("Supported formats:");
532 bdrv_iterate_format(bdrv_format_print
, NULL
);
537 if (qdict_haskey(bs_opts
, "driver")) {
538 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
541 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
544 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
545 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
546 on_write_error
= parse_block_error_action(buf
, 0, &error
);
548 error_propagate(errp
, error
);
553 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
554 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
555 on_read_error
= parse_block_error_action(buf
, 1, &error
);
557 error_propagate(errp
, error
);
563 bdrv_flags
|= BDRV_O_SNAPSHOT
;
567 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
568 BlockBackendRootState
*blk_rs
;
575 blk_rs
= blk_get_root_state(blk
);
576 blk_rs
->open_flags
= bdrv_flags
;
577 blk_rs
->read_only
= !(bdrv_flags
& BDRV_O_RDWR
);
578 blk_rs
->detect_zeroes
= detect_zeroes
;
582 if (file
&& !*file
) {
586 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
587 * with other callers) rather than what we want as the real defaults.
588 * Apply the defaults here instead. */
589 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
590 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
591 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
593 if (runstate_check(RUN_STATE_INMIGRATE
)) {
594 bdrv_flags
|= BDRV_O_INACTIVE
;
597 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
603 bs
->detect_zeroes
= detect_zeroes
;
605 if (bdrv_key_required(bs
)) {
609 block_acct_init(blk_get_stats(blk
), account_invalid
, account_failed
);
611 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
618 /* disk I/O throttling */
619 if (throttle_enabled(&cfg
)) {
620 if (!throttling_group
) {
621 throttling_group
= blk_name(blk
);
623 blk_io_limits_enable(blk
, throttling_group
);
624 blk_set_io_limits(blk
, &cfg
);
627 blk_set_enable_write_cache(blk
, !writethrough
);
628 blk_set_on_error(blk
, on_read_error
, on_write_error
);
630 if (!monitor_add_blk(blk
, qemu_opts_id(opts
), errp
)) {
638 QDECREF(interval_dict
);
639 QDECREF(interval_list
);
644 QDECREF(interval_dict
);
645 QDECREF(interval_list
);
651 static QemuOptsList qemu_root_bds_opts
;
653 /* Takes the ownership of bs_opts */
654 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
656 BlockDriverState
*bs
;
658 Error
*local_error
= NULL
;
659 BlockdevDetectZeroesOptions detect_zeroes
;
663 opts
= qemu_opts_create(&qemu_root_bds_opts
, NULL
, 1, errp
);
668 qemu_opts_absorb_qdict(opts
, bs_opts
, &local_error
);
670 error_propagate(errp
, local_error
);
674 extract_common_blockdev_options(opts
, &bdrv_flags
, NULL
, NULL
,
675 &detect_zeroes
, &local_error
);
677 error_propagate(errp
, local_error
);
681 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
682 * with other callers) rather than what we want as the real defaults.
683 * Apply the defaults here instead. */
684 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
685 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
687 if (runstate_check(RUN_STATE_INMIGRATE
)) {
688 bdrv_flags
|= BDRV_O_INACTIVE
;
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 /* Iterates over the list of monitor-owned BlockDriverStates */
723 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
725 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
726 : QTAILQ_FIRST(&monitor_bdrv_states
);
729 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
734 value
= qemu_opt_get(opts
, from
);
736 if (qemu_opt_find(opts
, to
)) {
737 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
738 "same time", to
, from
);
743 /* rename all items in opts */
744 while ((value
= qemu_opt_get(opts
, from
))) {
745 qemu_opt_set(opts
, to
, value
, &error_abort
);
746 qemu_opt_unset(opts
, from
);
750 QemuOptsList qemu_legacy_drive_opts
= {
752 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
756 .type
= QEMU_OPT_NUMBER
,
757 .help
= "bus number",
760 .type
= QEMU_OPT_NUMBER
,
761 .help
= "unit number (i.e. lun for scsi)",
764 .type
= QEMU_OPT_NUMBER
,
765 .help
= "index number",
768 .type
= QEMU_OPT_STRING
,
769 .help
= "media type (disk, cdrom)",
772 .type
= QEMU_OPT_STRING
,
773 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
776 .type
= QEMU_OPT_NUMBER
,
777 .help
= "number of cylinders (ide disk geometry)",
780 .type
= QEMU_OPT_NUMBER
,
781 .help
= "number of heads (ide disk geometry)",
784 .type
= QEMU_OPT_NUMBER
,
785 .help
= "number of sectors (ide disk geometry)",
788 .type
= QEMU_OPT_STRING
,
789 .help
= "chs translation (auto, lba, none)",
792 .type
= QEMU_OPT_BOOL
,
793 .help
= "(deprecated, ignored)",
796 .type
= QEMU_OPT_STRING
,
797 .help
= "pci address (virtio only)",
800 .type
= QEMU_OPT_STRING
,
801 .help
= "disk serial number",
804 .type
= QEMU_OPT_STRING
,
808 /* Options that are passed on, but have special semantics with -drive */
811 .type
= QEMU_OPT_BOOL
,
812 .help
= "open drive file as read-only",
815 .type
= QEMU_OPT_STRING
,
816 .help
= "read error action",
819 .type
= QEMU_OPT_STRING
,
820 .help
= "write error action",
822 .name
= "copy-on-read",
823 .type
= QEMU_OPT_BOOL
,
824 .help
= "copy read data from backing file into image file",
827 { /* end of list */ }
831 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
835 DriveInfo
*dinfo
= NULL
;
837 QemuOpts
*legacy_opts
;
838 DriveMediaType media
= MEDIA_DISK
;
839 BlockInterfaceType type
;
840 int cyls
, heads
, secs
, translation
;
841 int max_devs
, bus_id
, unit_id
, index
;
843 const char *werror
, *rerror
;
844 bool read_only
= false;
847 const char *filename
;
848 Error
*local_err
= NULL
;
851 /* Change legacy command line options into QMP ones */
852 static const struct {
856 { "iops", "throttling.iops-total" },
857 { "iops_rd", "throttling.iops-read" },
858 { "iops_wr", "throttling.iops-write" },
860 { "bps", "throttling.bps-total" },
861 { "bps_rd", "throttling.bps-read" },
862 { "bps_wr", "throttling.bps-write" },
864 { "iops_max", "throttling.iops-total-max" },
865 { "iops_rd_max", "throttling.iops-read-max" },
866 { "iops_wr_max", "throttling.iops-write-max" },
868 { "bps_max", "throttling.bps-total-max" },
869 { "bps_rd_max", "throttling.bps-read-max" },
870 { "bps_wr_max", "throttling.bps-write-max" },
872 { "iops_size", "throttling.iops-size" },
874 { "group", "throttling.group" },
876 { "readonly", "read-only" },
879 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
880 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
883 error_report_err(local_err
);
888 value
= qemu_opt_get(all_opts
, "cache");
893 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
894 error_report("invalid cache option");
898 /* Specific options take precedence */
899 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
900 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
901 !writethrough
, &error_abort
);
903 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
904 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
905 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
907 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
908 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
909 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
911 qemu_opt_unset(all_opts
, "cache");
914 /* Get a QDict for processing the options */
915 bs_opts
= qdict_new();
916 qemu_opts_to_qdict(all_opts
, bs_opts
);
918 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
920 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
922 error_report_err(local_err
);
926 /* Deprecated option boot=[on|off] */
927 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
928 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
929 "ignored. Future versions will reject this parameter. Please "
930 "update your scripts.\n");
934 value
= qemu_opt_get(legacy_opts
, "media");
936 if (!strcmp(value
, "disk")) {
938 } else if (!strcmp(value
, "cdrom")) {
942 error_report("'%s' invalid media", value
);
947 /* copy-on-read is disabled with a warning for read-only devices */
948 read_only
|= qemu_opt_get_bool(legacy_opts
, "read-only", false);
949 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
951 if (read_only
&& copy_on_read
) {
952 error_report("warning: disabling copy-on-read on read-only drive");
953 copy_on_read
= false;
956 qdict_put(bs_opts
, "read-only",
957 qstring_from_str(read_only
? "on" : "off"));
958 qdict_put(bs_opts
, "copy-on-read",
959 qstring_from_str(copy_on_read
? "on" :"off"));
961 /* Controller type */
962 value
= qemu_opt_get(legacy_opts
, "if");
965 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
968 if (type
== IF_COUNT
) {
969 error_report("unsupported bus type '%s'", value
);
973 type
= block_default_type
;
977 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
978 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
979 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
981 if (cyls
|| heads
|| secs
) {
983 error_report("invalid physical cyls number");
987 error_report("invalid physical heads number");
991 error_report("invalid physical secs number");
996 translation
= BIOS_ATA_TRANSLATION_AUTO
;
997 value
= qemu_opt_get(legacy_opts
, "trans");
1000 error_report("'%s' trans must be used with cyls, heads and secs",
1004 if (!strcmp(value
, "none")) {
1005 translation
= BIOS_ATA_TRANSLATION_NONE
;
1006 } else if (!strcmp(value
, "lba")) {
1007 translation
= BIOS_ATA_TRANSLATION_LBA
;
1008 } else if (!strcmp(value
, "large")) {
1009 translation
= BIOS_ATA_TRANSLATION_LARGE
;
1010 } else if (!strcmp(value
, "rechs")) {
1011 translation
= BIOS_ATA_TRANSLATION_RECHS
;
1012 } else if (!strcmp(value
, "auto")) {
1013 translation
= BIOS_ATA_TRANSLATION_AUTO
;
1015 error_report("'%s' invalid translation type", value
);
1020 if (media
== MEDIA_CDROM
) {
1021 if (cyls
|| secs
|| heads
) {
1022 error_report("CHS can't be set with media=cdrom");
1027 /* Device address specified by bus/unit or index.
1028 * If none was specified, try to find the first free one. */
1029 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
1030 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
1031 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
1033 max_devs
= if_max_devs
[type
];
1036 if (bus_id
!= 0 || unit_id
!= -1) {
1037 error_report("index cannot be used with bus and unit");
1040 bus_id
= drive_index_to_bus_id(type
, index
);
1041 unit_id
= drive_index_to_unit_id(type
, index
);
1044 if (unit_id
== -1) {
1046 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1048 if (max_devs
&& unit_id
>= max_devs
) {
1049 unit_id
-= max_devs
;
1055 if (max_devs
&& unit_id
>= max_devs
) {
1056 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
1060 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1061 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1062 bus_id
, unit_id
, index
);
1067 serial
= qemu_opt_get(legacy_opts
, "serial");
1069 /* no id supplied -> create one */
1070 if (qemu_opts_id(all_opts
) == NULL
) {
1072 const char *mediastr
= "";
1073 if (type
== IF_IDE
|| type
== IF_SCSI
) {
1074 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
1077 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
1080 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
1083 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
1087 /* Add virtio block device */
1088 devaddr
= qemu_opt_get(legacy_opts
, "addr");
1089 if (devaddr
&& type
!= IF_VIRTIO
) {
1090 error_report("addr is not supported by this bus type");
1094 if (type
== IF_VIRTIO
) {
1096 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
1098 if (arch_type
== QEMU_ARCH_S390X
) {
1099 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
1101 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
1103 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
1106 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
1110 filename
= qemu_opt_get(legacy_opts
, "file");
1112 /* Check werror/rerror compatibility with if=... */
1113 werror
= qemu_opt_get(legacy_opts
, "werror");
1114 if (werror
!= NULL
) {
1115 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
1117 error_report("werror is not supported by this bus type");
1120 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
1123 rerror
= qemu_opt_get(legacy_opts
, "rerror");
1124 if (rerror
!= NULL
) {
1125 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
1127 error_report("rerror is not supported by this bus type");
1130 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
1133 /* Actual block device init: Functionality shared with blockdev-add */
1134 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
1138 error_report_err(local_err
);
1145 /* Create legacy DriveInfo */
1146 dinfo
= g_malloc0(sizeof(*dinfo
));
1147 dinfo
->opts
= all_opts
;
1150 dinfo
->heads
= heads
;
1152 dinfo
->trans
= translation
;
1155 dinfo
->bus
= bus_id
;
1156 dinfo
->unit
= unit_id
;
1157 dinfo
->devaddr
= devaddr
;
1158 dinfo
->serial
= g_strdup(serial
);
1160 blk_set_legacy_dinfo(blk
, dinfo
);
1167 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1174 qemu_opts_del(legacy_opts
);
1179 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1181 const char *device
= qdict_get_str(qdict
, "device");
1185 if (!strcmp(device
, "all")) {
1186 ret
= blk_commit_all();
1188 BlockDriverState
*bs
;
1189 AioContext
*aio_context
;
1191 blk
= blk_by_name(device
);
1193 monitor_printf(mon
, "Device '%s' not found\n", device
);
1196 if (!blk_is_available(blk
)) {
1197 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1202 aio_context
= bdrv_get_aio_context(bs
);
1203 aio_context_acquire(aio_context
);
1205 ret
= bdrv_commit(bs
);
1207 aio_context_release(aio_context
);
1210 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1215 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1217 TransactionActionList list
;
1219 list
.value
= action
;
1221 qmp_transaction(&list
, false, NULL
, errp
);
1224 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1225 bool has_node_name
, const char *node_name
,
1226 const char *snapshot_file
,
1227 bool has_snapshot_node_name
,
1228 const char *snapshot_node_name
,
1229 bool has_format
, const char *format
,
1230 bool has_mode
, NewImageMode mode
, Error
**errp
)
1232 BlockdevSnapshotSync snapshot
= {
1233 .has_device
= has_device
,
1234 .device
= (char *) device
,
1235 .has_node_name
= has_node_name
,
1236 .node_name
= (char *) node_name
,
1237 .snapshot_file
= (char *) snapshot_file
,
1238 .has_snapshot_node_name
= has_snapshot_node_name
,
1239 .snapshot_node_name
= (char *) snapshot_node_name
,
1240 .has_format
= has_format
,
1241 .format
= (char *) format
,
1242 .has_mode
= has_mode
,
1245 TransactionAction action
= {
1246 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1247 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1249 blockdev_do_action(&action
, errp
);
1252 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1255 BlockdevSnapshot snapshot_data
= {
1256 .node
= (char *) node
,
1257 .overlay
= (char *) overlay
1259 TransactionAction action
= {
1260 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1261 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1263 blockdev_do_action(&action
, errp
);
1266 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1270 BlockdevSnapshotInternal snapshot
= {
1271 .device
= (char *) device
,
1272 .name
= (char *) name
1274 TransactionAction action
= {
1275 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1276 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1278 blockdev_do_action(&action
, errp
);
1281 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1288 BlockDriverState
*bs
;
1290 AioContext
*aio_context
;
1291 QEMUSnapshotInfo sn
;
1292 Error
*local_err
= NULL
;
1293 SnapshotInfo
*info
= NULL
;
1296 blk
= blk_by_name(device
);
1298 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1299 "Device '%s' not found", device
);
1303 aio_context
= blk_get_aio_context(blk
);
1304 aio_context_acquire(aio_context
);
1315 error_setg(errp
, "Name or id must be provided");
1316 goto out_aio_context
;
1319 if (!blk_is_available(blk
)) {
1320 error_setg(errp
, "Device '%s' has no medium", device
);
1321 goto out_aio_context
;
1325 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1326 goto out_aio_context
;
1329 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1331 error_propagate(errp
, local_err
);
1332 goto out_aio_context
;
1336 "Snapshot with id '%s' and name '%s' does not exist on "
1338 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1339 goto out_aio_context
;
1342 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1344 error_propagate(errp
, local_err
);
1345 goto out_aio_context
;
1348 aio_context_release(aio_context
);
1350 info
= g_new0(SnapshotInfo
, 1);
1351 info
->id
= g_strdup(sn
.id_str
);
1352 info
->name
= g_strdup(sn
.name
);
1353 info
->date_nsec
= sn
.date_nsec
;
1354 info
->date_sec
= sn
.date_sec
;
1355 info
->vm_state_size
= sn
.vm_state_size
;
1356 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1357 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1362 aio_context_release(aio_context
);
1367 * block_dirty_bitmap_lookup:
1368 * Return a dirty bitmap (if present), after validating
1369 * the node reference and bitmap names.
1371 * @node: The name of the BDS node to search for bitmaps
1372 * @name: The name of the bitmap to search for
1373 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1374 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1375 * @errp: Output pointer for error information. Can be NULL.
1377 * @return: A bitmap object on success, or NULL on failure.
1379 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1381 BlockDriverState
**pbs
,
1385 BlockDriverState
*bs
;
1386 BdrvDirtyBitmap
*bitmap
;
1387 AioContext
*aio_context
;
1390 error_setg(errp
, "Node cannot be NULL");
1394 error_setg(errp
, "Bitmap name cannot be NULL");
1397 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1399 error_setg(errp
, "Node '%s' not found", node
);
1403 aio_context
= bdrv_get_aio_context(bs
);
1404 aio_context_acquire(aio_context
);
1406 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1408 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1416 *paio
= aio_context
;
1418 aio_context_release(aio_context
);
1424 aio_context_release(aio_context
);
1428 /* New and old BlockDriverState structs for atomic group operations */
1430 typedef struct BlkActionState BlkActionState
;
1434 * Table of operations that define an Action.
1436 * @instance_size: Size of state struct, in bytes.
1437 * @prepare: Prepare the work, must NOT be NULL.
1438 * @commit: Commit the changes, can be NULL.
1439 * @abort: Abort the changes on fail, can be NULL.
1440 * @clean: Clean up resources after all transaction actions have called
1441 * commit() or abort(). Can be NULL.
1443 * Only prepare() may fail. In a single transaction, only one of commit() or
1444 * abort() will be called. clean() will always be called if it is present.
1446 typedef struct BlkActionOps
{
1447 size_t instance_size
;
1448 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1449 void (*commit
)(BlkActionState
*common
);
1450 void (*abort
)(BlkActionState
*common
);
1451 void (*clean
)(BlkActionState
*common
);
1456 * Describes one Action's state within a Transaction.
1458 * @action: QAPI-defined enum identifying which Action to perform.
1459 * @ops: Table of ActionOps this Action can perform.
1460 * @block_job_txn: Transaction which this action belongs to.
1461 * @entry: List membership for all Actions in this Transaction.
1463 * This structure must be arranged as first member in a subclassed type,
1464 * assuming that the compiler will also arrange it to the same offsets as the
1467 struct BlkActionState
{
1468 TransactionAction
*action
;
1469 const BlkActionOps
*ops
;
1470 BlockJobTxn
*block_job_txn
;
1471 TransactionProperties
*txn_props
;
1472 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1475 /* internal snapshot private data */
1476 typedef struct InternalSnapshotState
{
1477 BlkActionState common
;
1478 BlockDriverState
*bs
;
1479 AioContext
*aio_context
;
1480 QEMUSnapshotInfo sn
;
1482 } InternalSnapshotState
;
1485 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1487 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1489 "Action '%s' does not support Transaction property "
1490 "completion-mode = %s",
1491 TransactionActionKind_lookup
[s
->action
->type
],
1492 ActionCompletionMode_lookup
[s
->txn_props
->completion_mode
]);
1498 static void internal_snapshot_prepare(BlkActionState
*common
,
1501 Error
*local_err
= NULL
;
1505 BlockDriverState
*bs
;
1506 QEMUSnapshotInfo old_sn
, *sn
;
1509 BlockdevSnapshotInternal
*internal
;
1510 InternalSnapshotState
*state
;
1513 g_assert(common
->action
->type
==
1514 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1515 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1516 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1518 /* 1. parse input */
1519 device
= internal
->device
;
1520 name
= internal
->name
;
1522 /* 2. check for validation */
1523 if (action_check_completion_mode(common
, errp
) < 0) {
1527 blk
= blk_by_name(device
);
1529 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1530 "Device '%s' not found", device
);
1534 /* AioContext is released in .clean() */
1535 state
->aio_context
= blk_get_aio_context(blk
);
1536 aio_context_acquire(state
->aio_context
);
1538 if (!blk_is_available(blk
)) {
1539 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1545 bdrv_drained_begin(bs
);
1547 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1551 if (bdrv_is_read_only(bs
)) {
1552 error_setg(errp
, "Device '%s' is read only", device
);
1556 if (!bdrv_can_snapshot(bs
)) {
1557 error_setg(errp
, "Block format '%s' used by device '%s' "
1558 "does not support internal snapshots",
1559 bs
->drv
->format_name
, device
);
1563 if (!strlen(name
)) {
1564 error_setg(errp
, "Name is empty");
1568 /* check whether a snapshot with name exist */
1569 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1572 error_propagate(errp
, local_err
);
1576 "Snapshot with name '%s' already exists on device '%s'",
1581 /* 3. take the snapshot */
1583 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1584 qemu_gettimeofday(&tv
);
1585 sn
->date_sec
= tv
.tv_sec
;
1586 sn
->date_nsec
= tv
.tv_usec
* 1000;
1587 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1589 ret1
= bdrv_snapshot_create(bs
, sn
);
1591 error_setg_errno(errp
, -ret1
,
1592 "Failed to create snapshot '%s' on device '%s'",
1597 /* 4. succeed, mark a snapshot is created */
1598 state
->created
= true;
1601 static void internal_snapshot_abort(BlkActionState
*common
)
1603 InternalSnapshotState
*state
=
1604 DO_UPCAST(InternalSnapshotState
, common
, common
);
1605 BlockDriverState
*bs
= state
->bs
;
1606 QEMUSnapshotInfo
*sn
= &state
->sn
;
1607 Error
*local_error
= NULL
;
1609 if (!state
->created
) {
1613 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1614 error_reportf_err(local_error
,
1615 "Failed to delete snapshot with id '%s' and "
1616 "name '%s' on device '%s' in abort: ",
1617 sn
->id_str
, sn
->name
,
1618 bdrv_get_device_name(bs
));
1622 static void internal_snapshot_clean(BlkActionState
*common
)
1624 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1627 if (state
->aio_context
) {
1629 bdrv_drained_end(state
->bs
);
1631 aio_context_release(state
->aio_context
);
1635 /* external snapshot private data */
1636 typedef struct ExternalSnapshotState
{
1637 BlkActionState common
;
1638 BlockDriverState
*old_bs
;
1639 BlockDriverState
*new_bs
;
1640 AioContext
*aio_context
;
1641 } ExternalSnapshotState
;
1643 static void external_snapshot_prepare(BlkActionState
*common
,
1647 QDict
*options
= NULL
;
1648 Error
*local_err
= NULL
;
1649 /* Device and node name of the image to generate the snapshot from */
1651 const char *node_name
;
1652 /* Reference to the new image (for 'blockdev-snapshot') */
1653 const char *snapshot_ref
;
1654 /* File name of the new image (for 'blockdev-snapshot-sync') */
1655 const char *new_image_file
;
1656 ExternalSnapshotState
*state
=
1657 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1658 TransactionAction
*action
= common
->action
;
1660 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1661 * purpose but a different set of parameters */
1662 switch (action
->type
) {
1663 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1665 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1667 node_name
= s
->node
;
1668 new_image_file
= NULL
;
1669 snapshot_ref
= s
->overlay
;
1672 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1674 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1675 device
= s
->has_device
? s
->device
: NULL
;
1676 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1677 new_image_file
= s
->snapshot_file
;
1678 snapshot_ref
= NULL
;
1682 g_assert_not_reached();
1685 /* start processing */
1686 if (action_check_completion_mode(common
, errp
) < 0) {
1690 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1691 if (!state
->old_bs
) {
1695 /* Acquire AioContext now so any threads operating on old_bs stop */
1696 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1697 aio_context_acquire(state
->aio_context
);
1698 bdrv_drained_begin(state
->old_bs
);
1700 if (!bdrv_is_inserted(state
->old_bs
)) {
1701 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1705 if (bdrv_op_is_blocked(state
->old_bs
,
1706 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1710 if (!bdrv_is_read_only(state
->old_bs
)) {
1711 if (bdrv_flush(state
->old_bs
)) {
1712 error_setg(errp
, QERR_IO_ERROR
);
1717 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1718 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1722 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1723 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1724 const char *format
= s
->has_format
? s
->format
: "qcow2";
1725 enum NewImageMode mode
;
1726 const char *snapshot_node_name
=
1727 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1729 if (node_name
&& !snapshot_node_name
) {
1730 error_setg(errp
, "New snapshot node name missing");
1734 if (snapshot_node_name
&&
1735 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1736 error_setg(errp
, "New snapshot node name already in use");
1740 flags
= state
->old_bs
->open_flags
;
1741 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
| BDRV_O_COPY_ON_READ
);
1743 /* create new image w/backing file */
1744 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1745 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1746 int64_t size
= bdrv_getlength(state
->old_bs
);
1748 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1751 bdrv_img_create(new_image_file
, format
,
1752 state
->old_bs
->filename
,
1753 state
->old_bs
->drv
->format_name
,
1754 NULL
, size
, flags
, &local_err
, false);
1756 error_propagate(errp
, local_err
);
1761 options
= qdict_new();
1762 if (s
->has_snapshot_node_name
) {
1763 qdict_put(options
, "node-name",
1764 qstring_from_str(snapshot_node_name
));
1766 qdict_put(options
, "driver", qstring_from_str(format
));
1768 flags
|= BDRV_O_NO_BACKING
;
1771 assert(state
->new_bs
== NULL
);
1772 ret
= bdrv_open(&state
->new_bs
, new_image_file
, snapshot_ref
, options
,
1774 /* We will manually add the backing_hd field to the bs later */
1779 if (bdrv_has_blk(state
->new_bs
)) {
1780 error_setg(errp
, "The snapshot is already in use by %s",
1781 bdrv_get_parent_name(state
->new_bs
));
1785 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1790 if (state
->new_bs
->backing
!= NULL
) {
1791 error_setg(errp
, "The snapshot already has a backing image");
1795 if (!state
->new_bs
->drv
->supports_backing
) {
1796 error_setg(errp
, "The snapshot does not support backing images");
1800 static void external_snapshot_commit(BlkActionState
*common
)
1802 ExternalSnapshotState
*state
=
1803 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1805 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1807 /* This removes our old bs and adds the new bs */
1808 bdrv_append(state
->new_bs
, state
->old_bs
);
1809 /* We don't need (or want) to use the transactional
1810 * bdrv_reopen_multiple() across all the entries at once, because we
1811 * don't want to abort all of them if one of them fails the reopen */
1812 if (!state
->old_bs
->copy_on_read
) {
1813 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1818 static void external_snapshot_abort(BlkActionState
*common
)
1820 ExternalSnapshotState
*state
=
1821 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1822 if (state
->new_bs
) {
1823 bdrv_unref(state
->new_bs
);
1827 static void external_snapshot_clean(BlkActionState
*common
)
1829 ExternalSnapshotState
*state
=
1830 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1831 if (state
->aio_context
) {
1832 bdrv_drained_end(state
->old_bs
);
1833 aio_context_release(state
->aio_context
);
1837 typedef struct DriveBackupState
{
1838 BlkActionState common
;
1839 BlockDriverState
*bs
;
1840 AioContext
*aio_context
;
1844 static void do_drive_backup(const char *device
, const char *target
,
1845 bool has_format
, const char *format
,
1846 enum MirrorSyncMode sync
,
1847 bool has_mode
, enum NewImageMode mode
,
1848 bool has_speed
, int64_t speed
,
1849 bool has_bitmap
, const char *bitmap
,
1850 bool has_on_source_error
,
1851 BlockdevOnError on_source_error
,
1852 bool has_on_target_error
,
1853 BlockdevOnError on_target_error
,
1854 BlockJobTxn
*txn
, Error
**errp
);
1856 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1858 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1860 DriveBackup
*backup
;
1861 Error
*local_err
= NULL
;
1863 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1864 backup
= common
->action
->u
.drive_backup
.data
;
1866 blk
= blk_by_name(backup
->device
);
1868 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1869 "Device '%s' not found", backup
->device
);
1873 if (!blk_is_available(blk
)) {
1874 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, backup
->device
);
1878 /* AioContext is released in .clean() */
1879 state
->aio_context
= blk_get_aio_context(blk
);
1880 aio_context_acquire(state
->aio_context
);
1881 bdrv_drained_begin(blk_bs(blk
));
1882 state
->bs
= blk_bs(blk
);
1884 do_drive_backup(backup
->device
, backup
->target
,
1885 backup
->has_format
, backup
->format
,
1887 backup
->has_mode
, backup
->mode
,
1888 backup
->has_speed
, backup
->speed
,
1889 backup
->has_bitmap
, backup
->bitmap
,
1890 backup
->has_on_source_error
, backup
->on_source_error
,
1891 backup
->has_on_target_error
, backup
->on_target_error
,
1892 common
->block_job_txn
, &local_err
);
1894 error_propagate(errp
, local_err
);
1898 state
->job
= state
->bs
->job
;
1901 static void drive_backup_abort(BlkActionState
*common
)
1903 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1904 BlockDriverState
*bs
= state
->bs
;
1906 /* Only cancel if it's the job we started */
1907 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1908 block_job_cancel_sync(bs
->job
);
1912 static void drive_backup_clean(BlkActionState
*common
)
1914 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1916 if (state
->aio_context
) {
1917 bdrv_drained_end(state
->bs
);
1918 aio_context_release(state
->aio_context
);
1922 typedef struct BlockdevBackupState
{
1923 BlkActionState common
;
1924 BlockDriverState
*bs
;
1926 AioContext
*aio_context
;
1927 } BlockdevBackupState
;
1929 static void do_blockdev_backup(const char *device
, const char *target
,
1930 enum MirrorSyncMode sync
,
1931 bool has_speed
, int64_t speed
,
1932 bool has_on_source_error
,
1933 BlockdevOnError on_source_error
,
1934 bool has_on_target_error
,
1935 BlockdevOnError on_target_error
,
1936 BlockJobTxn
*txn
, Error
**errp
);
1938 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1940 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1941 BlockdevBackup
*backup
;
1942 BlockBackend
*blk
, *target
;
1943 Error
*local_err
= NULL
;
1945 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1946 backup
= common
->action
->u
.blockdev_backup
.data
;
1948 blk
= blk_by_name(backup
->device
);
1950 error_setg(errp
, "Device '%s' not found", backup
->device
);
1954 if (!blk_is_available(blk
)) {
1955 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, backup
->device
);
1959 target
= blk_by_name(backup
->target
);
1961 error_setg(errp
, "Device '%s' not found", backup
->target
);
1965 /* AioContext is released in .clean() */
1966 state
->aio_context
= blk_get_aio_context(blk
);
1967 if (state
->aio_context
!= blk_get_aio_context(target
)) {
1968 state
->aio_context
= NULL
;
1969 error_setg(errp
, "Backup between two IO threads is not implemented");
1972 aio_context_acquire(state
->aio_context
);
1973 state
->bs
= blk_bs(blk
);
1974 bdrv_drained_begin(state
->bs
);
1976 do_blockdev_backup(backup
->device
, backup
->target
,
1978 backup
->has_speed
, backup
->speed
,
1979 backup
->has_on_source_error
, backup
->on_source_error
,
1980 backup
->has_on_target_error
, backup
->on_target_error
,
1981 common
->block_job_txn
, &local_err
);
1983 error_propagate(errp
, local_err
);
1987 state
->job
= state
->bs
->job
;
1990 static void blockdev_backup_abort(BlkActionState
*common
)
1992 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1993 BlockDriverState
*bs
= state
->bs
;
1995 /* Only cancel if it's the job we started */
1996 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1997 block_job_cancel_sync(bs
->job
);
2001 static void blockdev_backup_clean(BlkActionState
*common
)
2003 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
2005 if (state
->aio_context
) {
2006 bdrv_drained_end(state
->bs
);
2007 aio_context_release(state
->aio_context
);
2011 typedef struct BlockDirtyBitmapState
{
2012 BlkActionState common
;
2013 BdrvDirtyBitmap
*bitmap
;
2014 BlockDriverState
*bs
;
2015 AioContext
*aio_context
;
2018 } BlockDirtyBitmapState
;
2020 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
2023 Error
*local_err
= NULL
;
2024 BlockDirtyBitmapAdd
*action
;
2025 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2028 if (action_check_completion_mode(common
, errp
) < 0) {
2032 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
2033 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2034 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
2035 action
->has_granularity
, action
->granularity
,
2039 state
->prepared
= true;
2041 error_propagate(errp
, local_err
);
2045 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
2047 BlockDirtyBitmapAdd
*action
;
2048 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2051 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
2052 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2053 * then the node reference and bitmap name must have been valid.
2055 if (state
->prepared
) {
2056 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
2060 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
2063 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2065 BlockDirtyBitmap
*action
;
2067 if (action_check_completion_mode(common
, errp
) < 0) {
2071 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2072 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2075 &state
->aio_context
,
2077 if (!state
->bitmap
) {
2081 if (bdrv_dirty_bitmap_frozen(state
->bitmap
)) {
2082 error_setg(errp
, "Cannot modify a frozen bitmap");
2084 } else if (!bdrv_dirty_bitmap_enabled(state
->bitmap
)) {
2085 error_setg(errp
, "Cannot clear a disabled bitmap");
2089 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2090 /* AioContext is released in .clean() */
2093 static void block_dirty_bitmap_clear_abort(BlkActionState
*common
)
2095 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2098 bdrv_undo_clear_dirty_bitmap(state
->bitmap
, state
->backup
);
2101 static void block_dirty_bitmap_clear_commit(BlkActionState
*common
)
2103 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2106 hbitmap_free(state
->backup
);
2109 static void block_dirty_bitmap_clear_clean(BlkActionState
*common
)
2111 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2114 if (state
->aio_context
) {
2115 aio_context_release(state
->aio_context
);
2119 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2121 error_setg(errp
, "Transaction aborted using Abort action");
2124 static void abort_commit(BlkActionState
*common
)
2126 g_assert_not_reached(); /* this action never succeeds */
2129 static const BlkActionOps actions
[] = {
2130 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2131 .instance_size
= sizeof(ExternalSnapshotState
),
2132 .prepare
= external_snapshot_prepare
,
2133 .commit
= external_snapshot_commit
,
2134 .abort
= external_snapshot_abort
,
2135 .clean
= external_snapshot_clean
,
2137 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2138 .instance_size
= sizeof(ExternalSnapshotState
),
2139 .prepare
= external_snapshot_prepare
,
2140 .commit
= external_snapshot_commit
,
2141 .abort
= external_snapshot_abort
,
2142 .clean
= external_snapshot_clean
,
2144 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2145 .instance_size
= sizeof(DriveBackupState
),
2146 .prepare
= drive_backup_prepare
,
2147 .abort
= drive_backup_abort
,
2148 .clean
= drive_backup_clean
,
2150 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2151 .instance_size
= sizeof(BlockdevBackupState
),
2152 .prepare
= blockdev_backup_prepare
,
2153 .abort
= blockdev_backup_abort
,
2154 .clean
= blockdev_backup_clean
,
2156 [TRANSACTION_ACTION_KIND_ABORT
] = {
2157 .instance_size
= sizeof(BlkActionState
),
2158 .prepare
= abort_prepare
,
2159 .commit
= abort_commit
,
2161 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2162 .instance_size
= sizeof(InternalSnapshotState
),
2163 .prepare
= internal_snapshot_prepare
,
2164 .abort
= internal_snapshot_abort
,
2165 .clean
= internal_snapshot_clean
,
2167 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2168 .instance_size
= sizeof(BlockDirtyBitmapState
),
2169 .prepare
= block_dirty_bitmap_add_prepare
,
2170 .abort
= block_dirty_bitmap_add_abort
,
2172 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2173 .instance_size
= sizeof(BlockDirtyBitmapState
),
2174 .prepare
= block_dirty_bitmap_clear_prepare
,
2175 .commit
= block_dirty_bitmap_clear_commit
,
2176 .abort
= block_dirty_bitmap_clear_abort
,
2177 .clean
= block_dirty_bitmap_clear_clean
,
2182 * Allocate a TransactionProperties structure if necessary, and fill
2183 * that structure with desired defaults if they are unset.
2185 static TransactionProperties
*get_transaction_properties(
2186 TransactionProperties
*props
)
2189 props
= g_new0(TransactionProperties
, 1);
2192 if (!props
->has_completion_mode
) {
2193 props
->has_completion_mode
= true;
2194 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2201 * 'Atomic' group operations. The operations are performed as a set, and if
2202 * any fail then we roll back all operations in the group.
2204 void qmp_transaction(TransactionActionList
*dev_list
,
2206 struct TransactionProperties
*props
,
2209 TransactionActionList
*dev_entry
= dev_list
;
2210 BlockJobTxn
*block_job_txn
= NULL
;
2211 BlkActionState
*state
, *next
;
2212 Error
*local_err
= NULL
;
2214 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkActionState
) snap_bdrv_states
;
2215 QSIMPLEQ_INIT(&snap_bdrv_states
);
2217 /* Does this transaction get canceled as a group on failure?
2218 * If not, we don't really need to make a BlockJobTxn.
2220 props
= get_transaction_properties(props
);
2221 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2222 block_job_txn
= block_job_txn_new();
2225 /* drain all i/o before any operations */
2228 /* We don't do anything in this loop that commits us to the operations */
2229 while (NULL
!= dev_entry
) {
2230 TransactionAction
*dev_info
= NULL
;
2231 const BlkActionOps
*ops
;
2233 dev_info
= dev_entry
->value
;
2234 dev_entry
= dev_entry
->next
;
2236 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2238 ops
= &actions
[dev_info
->type
];
2239 assert(ops
->instance_size
> 0);
2241 state
= g_malloc0(ops
->instance_size
);
2243 state
->action
= dev_info
;
2244 state
->block_job_txn
= block_job_txn
;
2245 state
->txn_props
= props
;
2246 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2248 state
->ops
->prepare(state
, &local_err
);
2250 error_propagate(errp
, local_err
);
2251 goto delete_and_fail
;
2255 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2256 if (state
->ops
->commit
) {
2257 state
->ops
->commit(state
);
2265 /* failure, and it is all-or-none; roll back all operations */
2266 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2267 if (state
->ops
->abort
) {
2268 state
->ops
->abort(state
);
2272 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2273 if (state
->ops
->clean
) {
2274 state
->ops
->clean(state
);
2279 qapi_free_TransactionProperties(props
);
2281 block_job_txn_unref(block_job_txn
);
2284 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
2286 Error
*local_err
= NULL
;
2288 qmp_blockdev_open_tray(device
, has_force
, force
, &local_err
);
2290 error_propagate(errp
, local_err
);
2294 qmp_x_blockdev_remove_medium(device
, errp
);
2297 void qmp_block_passwd(bool has_device
, const char *device
,
2298 bool has_node_name
, const char *node_name
,
2299 const char *password
, Error
**errp
)
2301 Error
*local_err
= NULL
;
2302 BlockDriverState
*bs
;
2303 AioContext
*aio_context
;
2305 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2306 has_node_name
? node_name
: NULL
,
2309 error_propagate(errp
, local_err
);
2313 aio_context
= bdrv_get_aio_context(bs
);
2314 aio_context_acquire(aio_context
);
2316 bdrv_add_key(bs
, password
, errp
);
2318 aio_context_release(aio_context
);
2321 void qmp_blockdev_open_tray(const char *device
, bool has_force
, bool force
,
2331 blk
= blk_by_name(device
);
2333 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2334 "Device '%s' not found", device
);
2338 if (!blk_dev_has_removable_media(blk
)) {
2339 error_setg(errp
, "Device '%s' is not removable", device
);
2343 if (!blk_dev_has_tray(blk
)) {
2344 /* Ignore this command on tray-less devices */
2348 if (blk_dev_is_tray_open(blk
)) {
2352 locked
= blk_dev_is_medium_locked(blk
);
2354 blk_dev_eject_request(blk
, force
);
2357 if (!locked
|| force
) {
2358 blk_dev_change_media_cb(blk
, false);
2362 void qmp_blockdev_close_tray(const char *device
, Error
**errp
)
2366 blk
= blk_by_name(device
);
2368 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2369 "Device '%s' not found", device
);
2373 if (!blk_dev_has_removable_media(blk
)) {
2374 error_setg(errp
, "Device '%s' is not removable", device
);
2378 if (!blk_dev_has_tray(blk
)) {
2379 /* Ignore this command on tray-less devices */
2383 if (!blk_dev_is_tray_open(blk
)) {
2387 blk_dev_change_media_cb(blk
, true);
2390 void qmp_x_blockdev_remove_medium(const char *device
, Error
**errp
)
2393 BlockDriverState
*bs
;
2394 AioContext
*aio_context
;
2397 blk
= blk_by_name(device
);
2399 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2400 "Device '%s' not found", device
);
2404 /* For BBs without a device, we can exchange the BDS tree at will */
2405 has_device
= blk_get_attached_dev(blk
);
2407 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2408 error_setg(errp
, "Device '%s' is not removable", device
);
2412 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2413 error_setg(errp
, "Tray of device '%s' is not open", device
);
2422 aio_context
= bdrv_get_aio_context(bs
);
2423 aio_context_acquire(aio_context
);
2425 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2431 if (!blk_dev_has_tray(blk
)) {
2432 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2433 * called at all); therefore, the medium needs to be ejected here.
2434 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2435 * value passed here (i.e. false). */
2436 blk_dev_change_media_cb(blk
, false);
2440 aio_context_release(aio_context
);
2443 static void qmp_blockdev_insert_anon_medium(const char *device
,
2444 BlockDriverState
*bs
, Error
**errp
)
2449 blk
= blk_by_name(device
);
2451 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2452 "Device '%s' not found", device
);
2456 /* For BBs without a device, we can exchange the BDS tree at will */
2457 has_device
= blk_get_attached_dev(blk
);
2459 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2460 error_setg(errp
, "Device '%s' is not removable", device
);
2464 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2465 error_setg(errp
, "Tray of device '%s' is not open", device
);
2470 error_setg(errp
, "There already is a medium in device '%s'", device
);
2474 blk_insert_bs(blk
, bs
);
2476 if (!blk_dev_has_tray(blk
)) {
2477 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2478 * called at all); therefore, the medium needs to be pushed into the
2480 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2481 * value passed here (i.e. true). */
2482 blk_dev_change_media_cb(blk
, true);
2486 void qmp_x_blockdev_insert_medium(const char *device
, const char *node_name
,
2489 BlockDriverState
*bs
;
2491 bs
= bdrv_find_node(node_name
);
2493 error_setg(errp
, "Node '%s' not found", node_name
);
2497 if (bdrv_has_blk(bs
)) {
2498 error_setg(errp
, "Node '%s' is already in use by '%s'", node_name
,
2499 bdrv_get_parent_name(bs
));
2503 qmp_blockdev_insert_anon_medium(device
, bs
, errp
);
2506 void qmp_blockdev_change_medium(const char *device
, const char *filename
,
2507 bool has_format
, const char *format
,
2509 BlockdevChangeReadOnlyMode read_only
,
2513 BlockDriverState
*medium_bs
= NULL
;
2514 int bdrv_flags
, ret
;
2515 QDict
*options
= NULL
;
2518 blk
= blk_by_name(device
);
2520 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2521 "Device '%s' not found", device
);
2526 blk_update_root_state(blk
);
2529 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2530 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2533 if (!has_read_only
) {
2534 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2537 switch (read_only
) {
2538 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2541 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2542 bdrv_flags
&= ~BDRV_O_RDWR
;
2545 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2546 bdrv_flags
|= BDRV_O_RDWR
;
2554 options
= qdict_new();
2555 qdict_put(options
, "driver", qstring_from_str(format
));
2559 ret
= bdrv_open(&medium_bs
, filename
, NULL
, options
, bdrv_flags
, errp
);
2564 bdrv_add_key(medium_bs
, NULL
, &err
);
2566 error_propagate(errp
, err
);
2570 qmp_blockdev_open_tray(device
, false, false, &err
);
2572 error_propagate(errp
, err
);
2576 qmp_x_blockdev_remove_medium(device
, &err
);
2578 error_propagate(errp
, err
);
2582 qmp_blockdev_insert_anon_medium(device
, medium_bs
, &err
);
2584 error_propagate(errp
, err
);
2588 blk_apply_root_state(blk
, medium_bs
);
2590 qmp_blockdev_close_tray(device
, errp
);
2593 /* If the medium has been inserted, the device has its own reference, so
2594 * ours must be relinquished; and if it has not been inserted successfully,
2595 * the reference must be relinquished anyway */
2596 bdrv_unref(medium_bs
);
2599 /* throttling disk I/O limits */
2600 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
2607 bool has_bps_rd_max
,
2609 bool has_bps_wr_max
,
2613 bool has_iops_rd_max
,
2614 int64_t iops_rd_max
,
2615 bool has_iops_wr_max
,
2616 int64_t iops_wr_max
,
2617 bool has_bps_max_length
,
2618 int64_t bps_max_length
,
2619 bool has_bps_rd_max_length
,
2620 int64_t bps_rd_max_length
,
2621 bool has_bps_wr_max_length
,
2622 int64_t bps_wr_max_length
,
2623 bool has_iops_max_length
,
2624 int64_t iops_max_length
,
2625 bool has_iops_rd_max_length
,
2626 int64_t iops_rd_max_length
,
2627 bool has_iops_wr_max_length
,
2628 int64_t iops_wr_max_length
,
2632 const char *group
, Error
**errp
)
2635 BlockDriverState
*bs
;
2637 AioContext
*aio_context
;
2639 blk
= blk_by_name(device
);
2641 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2642 "Device '%s' not found", device
);
2646 aio_context
= blk_get_aio_context(blk
);
2647 aio_context_acquire(aio_context
);
2651 error_setg(errp
, "Device '%s' has no medium", device
);
2655 throttle_config_init(&cfg
);
2656 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
2657 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
2658 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
2660 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
2661 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
2662 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
2665 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
2667 if (has_bps_rd_max
) {
2668 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
2670 if (has_bps_wr_max
) {
2671 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
2674 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
2676 if (has_iops_rd_max
) {
2677 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
2679 if (has_iops_wr_max
) {
2680 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
2683 if (has_bps_max_length
) {
2684 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= bps_max_length
;
2686 if (has_bps_rd_max_length
) {
2687 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= bps_rd_max_length
;
2689 if (has_bps_wr_max_length
) {
2690 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= bps_wr_max_length
;
2692 if (has_iops_max_length
) {
2693 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= iops_max_length
;
2695 if (has_iops_rd_max_length
) {
2696 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= iops_rd_max_length
;
2698 if (has_iops_wr_max_length
) {
2699 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= iops_wr_max_length
;
2702 if (has_iops_size
) {
2703 cfg
.op_size
= iops_size
;
2706 if (!throttle_is_valid(&cfg
, errp
)) {
2710 if (throttle_enabled(&cfg
)) {
2711 /* Enable I/O limits if they're not enabled yet, otherwise
2712 * just update the throttling group. */
2713 if (!blk_get_public(blk
)->throttle_state
) {
2714 blk_io_limits_enable(blk
, has_group
? group
: device
);
2715 } else if (has_group
) {
2716 blk_io_limits_update_group(blk
, group
);
2718 /* Set the new throttling configuration */
2719 blk_set_io_limits(blk
, &cfg
);
2720 } else if (blk_get_public(blk
)->throttle_state
) {
2721 /* If all throttling settings are set to 0, disable I/O limits */
2722 blk_io_limits_disable(blk
);
2726 aio_context_release(aio_context
);
2729 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2730 bool has_granularity
, uint32_t granularity
,
2733 AioContext
*aio_context
;
2734 BlockDriverState
*bs
;
2736 if (!name
|| name
[0] == '\0') {
2737 error_setg(errp
, "Bitmap name cannot be empty");
2741 bs
= bdrv_lookup_bs(node
, node
, errp
);
2746 aio_context
= bdrv_get_aio_context(bs
);
2747 aio_context_acquire(aio_context
);
2749 if (has_granularity
) {
2750 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2751 error_setg(errp
, "Granularity must be power of 2 "
2752 "and at least 512");
2756 /* Default to cluster size, if available: */
2757 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2760 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2763 aio_context_release(aio_context
);
2766 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2769 AioContext
*aio_context
;
2770 BlockDriverState
*bs
;
2771 BdrvDirtyBitmap
*bitmap
;
2773 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2774 if (!bitmap
|| !bs
) {
2778 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2780 "Bitmap '%s' is currently frozen and cannot be removed",
2784 bdrv_dirty_bitmap_make_anon(bitmap
);
2785 bdrv_release_dirty_bitmap(bs
, bitmap
);
2788 aio_context_release(aio_context
);
2792 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2793 * immediately after a full backup operation.
2795 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2798 AioContext
*aio_context
;
2799 BdrvDirtyBitmap
*bitmap
;
2800 BlockDriverState
*bs
;
2802 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2803 if (!bitmap
|| !bs
) {
2807 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2809 "Bitmap '%s' is currently frozen and cannot be modified",
2812 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2814 "Bitmap '%s' is currently disabled and cannot be cleared",
2819 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2822 aio_context_release(aio_context
);
2825 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2827 const char *id
= qdict_get_str(qdict
, "id");
2829 BlockDriverState
*bs
;
2830 AioContext
*aio_context
;
2831 Error
*local_err
= NULL
;
2833 bs
= bdrv_find_node(id
);
2835 qmp_x_blockdev_del(false, NULL
, true, id
, &local_err
);
2837 error_report_err(local_err
);
2842 blk
= blk_by_name(id
);
2844 error_report("Device '%s' not found", id
);
2848 if (!blk_legacy_dinfo(blk
)) {
2849 error_report("Deleting device added with blockdev-add"
2850 " is not supported");
2854 aio_context
= blk_get_aio_context(blk
);
2855 aio_context_acquire(aio_context
);
2859 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2860 error_report_err(local_err
);
2861 aio_context_release(aio_context
);
2868 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2869 monitor_remove_blk(blk
);
2871 /* If this BlockBackend has a device attached to it, its refcount will be
2872 * decremented when the device is removed; otherwise we have to do so here.
2874 if (blk_get_attached_dev(blk
)) {
2875 /* Further I/O must not pause the guest */
2876 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
2877 BLOCKDEV_ON_ERROR_REPORT
);
2882 aio_context_release(aio_context
);
2885 void qmp_block_resize(bool has_device
, const char *device
,
2886 bool has_node_name
, const char *node_name
,
2887 int64_t size
, Error
**errp
)
2889 Error
*local_err
= NULL
;
2890 BlockDriverState
*bs
;
2891 AioContext
*aio_context
;
2894 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2895 has_node_name
? node_name
: NULL
,
2898 error_propagate(errp
, local_err
);
2902 aio_context
= bdrv_get_aio_context(bs
);
2903 aio_context_acquire(aio_context
);
2905 if (!bdrv_is_first_non_filter(bs
)) {
2906 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
2911 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2915 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2916 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2920 /* complete all in-flight operations before resizing the device */
2923 ret
= bdrv_truncate(bs
, size
);
2928 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2931 error_setg(errp
, QERR_UNSUPPORTED
);
2934 error_setg(errp
, "Device '%s' is read only", device
);
2937 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2940 error_setg_errno(errp
, -ret
, "Could not resize");
2945 aio_context_release(aio_context
);
2948 static void block_job_cb(void *opaque
, int ret
)
2950 /* Note that this function may be executed from another AioContext besides
2951 * the QEMU main loop. If you need to access anything that assumes the
2952 * QEMU global mutex, use a BH or introduce a mutex.
2955 BlockDriverState
*bs
= opaque
;
2956 const char *msg
= NULL
;
2958 trace_block_job_cb(bs
, bs
->job
, ret
);
2963 msg
= strerror(-ret
);
2966 if (block_job_is_cancelled(bs
->job
)) {
2967 block_job_event_cancelled(bs
->job
);
2969 block_job_event_completed(bs
->job
, msg
);
2973 void qmp_block_stream(const char *device
,
2974 bool has_base
, const char *base
,
2975 bool has_backing_file
, const char *backing_file
,
2976 bool has_speed
, int64_t speed
,
2977 bool has_on_error
, BlockdevOnError on_error
,
2981 BlockDriverState
*bs
;
2982 BlockDriverState
*base_bs
= NULL
;
2983 AioContext
*aio_context
;
2984 Error
*local_err
= NULL
;
2985 const char *base_name
= NULL
;
2987 if (!has_on_error
) {
2988 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2991 blk
= blk_by_name(device
);
2993 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2994 "Device '%s' not found", device
);
2998 aio_context
= blk_get_aio_context(blk
);
2999 aio_context_acquire(aio_context
);
3001 if (!blk_is_available(blk
)) {
3002 error_setg(errp
, "Device '%s' has no medium", device
);
3007 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3012 base_bs
= bdrv_find_backing_image(bs
, base
);
3013 if (base_bs
== NULL
) {
3014 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
3017 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3021 /* if we are streaming the entire chain, the result will have no backing
3022 * file, and specifying one is therefore an error */
3023 if (base_bs
== NULL
&& has_backing_file
) {
3024 error_setg(errp
, "backing file specified, but streaming the "
3029 /* backing_file string overrides base bs filename */
3030 base_name
= has_backing_file
? backing_file
: base_name
;
3032 stream_start(bs
, base_bs
, base_name
, has_speed
? speed
: 0,
3033 on_error
, block_job_cb
, bs
, &local_err
);
3035 error_propagate(errp
, local_err
);
3039 trace_qmp_block_stream(bs
, bs
->job
);
3042 aio_context_release(aio_context
);
3045 void qmp_block_commit(const char *device
,
3046 bool has_base
, const char *base
,
3047 bool has_top
, const char *top
,
3048 bool has_backing_file
, const char *backing_file
,
3049 bool has_speed
, int64_t speed
,
3053 BlockDriverState
*bs
;
3054 BlockDriverState
*base_bs
, *top_bs
;
3055 AioContext
*aio_context
;
3056 Error
*local_err
= NULL
;
3057 /* This will be part of the QMP command, if/when the
3058 * BlockdevOnError change for blkmirror makes it in
3060 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3067 * libvirt relies on the DeviceNotFound error class in order to probe for
3068 * live commit feature versions; for this to work, we must make sure to
3069 * perform the device lookup before any generic errors that may occur in a
3070 * scenario in which all optional arguments are omitted. */
3071 blk
= blk_by_name(device
);
3073 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3074 "Device '%s' not found", device
);
3078 aio_context
= blk_get_aio_context(blk
);
3079 aio_context_acquire(aio_context
);
3081 if (!blk_is_available(blk
)) {
3082 error_setg(errp
, "Device '%s' has no medium", device
);
3087 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3091 /* default top_bs is the active layer */
3094 if (has_top
&& top
) {
3095 if (strcmp(bs
->filename
, top
) != 0) {
3096 top_bs
= bdrv_find_backing_image(bs
, top
);
3100 if (top_bs
== NULL
) {
3101 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3105 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3107 if (has_base
&& base
) {
3108 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3110 base_bs
= bdrv_find_base(top_bs
);
3113 if (base_bs
== NULL
) {
3114 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3118 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3120 if (bdrv_op_is_blocked(base_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3124 /* Do not allow attempts to commit an image into itself */
3125 if (top_bs
== base_bs
) {
3126 error_setg(errp
, "cannot commit an image into itself");
3131 if (has_backing_file
) {
3132 error_setg(errp
, "'backing-file' specified,"
3133 " but 'top' is the active layer");
3136 commit_active_start(bs
, base_bs
, speed
, on_error
, block_job_cb
,
3139 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
3140 has_backing_file
? backing_file
: NULL
, &local_err
);
3142 if (local_err
!= NULL
) {
3143 error_propagate(errp
, local_err
);
3148 aio_context_release(aio_context
);
3151 static void do_drive_backup(const char *device
, const char *target
,
3152 bool has_format
, const char *format
,
3153 enum MirrorSyncMode sync
,
3154 bool has_mode
, enum NewImageMode mode
,
3155 bool has_speed
, int64_t speed
,
3156 bool has_bitmap
, const char *bitmap
,
3157 bool has_on_source_error
,
3158 BlockdevOnError on_source_error
,
3159 bool has_on_target_error
,
3160 BlockdevOnError on_target_error
,
3161 BlockJobTxn
*txn
, Error
**errp
)
3164 BlockDriverState
*bs
;
3165 BlockDriverState
*target_bs
;
3166 BlockDriverState
*source
= NULL
;
3167 BdrvDirtyBitmap
*bmap
= NULL
;
3168 AioContext
*aio_context
;
3169 QDict
*options
= NULL
;
3170 Error
*local_err
= NULL
;
3178 if (!has_on_source_error
) {
3179 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3181 if (!has_on_target_error
) {
3182 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3185 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3188 blk
= blk_by_name(device
);
3190 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3191 "Device '%s' not found", device
);
3195 aio_context
= blk_get_aio_context(blk
);
3196 aio_context_acquire(aio_context
);
3198 /* Although backup_run has this check too, we need to use bs->drv below, so
3199 * do an early check redundantly. */
3200 if (!blk_is_available(blk
)) {
3201 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
3207 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
3210 /* Early check to avoid creating target */
3211 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3215 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3217 /* See if we have a backing HD we can use to create our new image
3219 if (sync
== MIRROR_SYNC_MODE_TOP
) {
3220 source
= backing_bs(bs
);
3222 sync
= MIRROR_SYNC_MODE_FULL
;
3225 if (sync
== MIRROR_SYNC_MODE_NONE
) {
3229 size
= bdrv_getlength(bs
);
3231 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3235 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
3238 bdrv_img_create(target
, format
, source
->filename
,
3239 source
->drv
->format_name
, NULL
,
3240 size
, flags
, &local_err
, false);
3242 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
3243 size
, flags
, &local_err
, false);
3248 error_propagate(errp
, local_err
);
3253 options
= qdict_new();
3254 qdict_put(options
, "driver", qstring_from_str(format
));
3258 ret
= bdrv_open(&target_bs
, target
, NULL
, options
, flags
, &local_err
);
3260 error_propagate(errp
, local_err
);
3264 bdrv_set_aio_context(target_bs
, aio_context
);
3267 bmap
= bdrv_find_dirty_bitmap(bs
, bitmap
);
3269 error_setg(errp
, "Bitmap '%s' could not be found", bitmap
);
3270 bdrv_unref(target_bs
);
3275 backup_start(bs
, target_bs
, speed
, sync
, bmap
,
3276 on_source_error
, on_target_error
,
3277 block_job_cb
, bs
, txn
, &local_err
);
3278 if (local_err
!= NULL
) {
3279 bdrv_unref(target_bs
);
3280 error_propagate(errp
, local_err
);
3285 aio_context_release(aio_context
);
3288 void qmp_drive_backup(const char *device
, const char *target
,
3289 bool has_format
, const char *format
,
3290 enum MirrorSyncMode sync
,
3291 bool has_mode
, enum NewImageMode mode
,
3292 bool has_speed
, int64_t speed
,
3293 bool has_bitmap
, const char *bitmap
,
3294 bool has_on_source_error
, BlockdevOnError on_source_error
,
3295 bool has_on_target_error
, BlockdevOnError on_target_error
,
3298 return do_drive_backup(device
, target
, has_format
, format
, sync
,
3299 has_mode
, mode
, has_speed
, speed
,
3301 has_on_source_error
, on_source_error
,
3302 has_on_target_error
, on_target_error
,
3306 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3308 return bdrv_named_nodes_list(errp
);
3311 void do_blockdev_backup(const char *device
, const char *target
,
3312 enum MirrorSyncMode sync
,
3313 bool has_speed
, int64_t speed
,
3314 bool has_on_source_error
,
3315 BlockdevOnError on_source_error
,
3316 bool has_on_target_error
,
3317 BlockdevOnError on_target_error
,
3318 BlockJobTxn
*txn
, Error
**errp
)
3320 BlockBackend
*blk
, *target_blk
;
3321 BlockDriverState
*bs
;
3322 BlockDriverState
*target_bs
;
3323 Error
*local_err
= NULL
;
3324 AioContext
*aio_context
;
3329 if (!has_on_source_error
) {
3330 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3332 if (!has_on_target_error
) {
3333 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3336 blk
= blk_by_name(device
);
3338 error_setg(errp
, "Device '%s' not found", device
);
3342 aio_context
= blk_get_aio_context(blk
);
3343 aio_context_acquire(aio_context
);
3345 if (!blk_is_available(blk
)) {
3346 error_setg(errp
, "Device '%s' has no medium", device
);
3351 target_blk
= blk_by_name(target
);
3353 error_setg(errp
, "Device '%s' not found", target
);
3357 if (!blk_is_available(target_blk
)) {
3358 error_setg(errp
, "Device '%s' has no medium", target
);
3361 target_bs
= blk_bs(target_blk
);
3363 bdrv_ref(target_bs
);
3364 bdrv_set_aio_context(target_bs
, aio_context
);
3365 backup_start(bs
, target_bs
, speed
, sync
, NULL
, on_source_error
,
3366 on_target_error
, block_job_cb
, bs
, txn
, &local_err
);
3367 if (local_err
!= NULL
) {
3368 bdrv_unref(target_bs
);
3369 error_propagate(errp
, local_err
);
3372 aio_context_release(aio_context
);
3375 void qmp_blockdev_backup(const char *device
, const char *target
,
3376 enum MirrorSyncMode sync
,
3377 bool has_speed
, int64_t speed
,
3378 bool has_on_source_error
,
3379 BlockdevOnError on_source_error
,
3380 bool has_on_target_error
,
3381 BlockdevOnError on_target_error
,
3384 do_blockdev_backup(device
, target
, sync
, has_speed
, speed
,
3385 has_on_source_error
, on_source_error
,
3386 has_on_target_error
, on_target_error
,
3390 /* Parameter check and block job starting for drive mirroring.
3391 * Caller should hold @device and @target's aio context (must be the same).
3393 static void blockdev_mirror_common(BlockDriverState
*bs
,
3394 BlockDriverState
*target
,
3395 bool has_replaces
, const char *replaces
,
3396 enum MirrorSyncMode sync
,
3397 bool has_speed
, int64_t speed
,
3398 bool has_granularity
, uint32_t granularity
,
3399 bool has_buf_size
, int64_t buf_size
,
3400 bool has_on_source_error
,
3401 BlockdevOnError on_source_error
,
3402 bool has_on_target_error
,
3403 BlockdevOnError on_target_error
,
3404 bool has_unmap
, bool unmap
,
3411 if (!has_on_source_error
) {
3412 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3414 if (!has_on_target_error
) {
3415 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3417 if (!has_granularity
) {
3420 if (!has_buf_size
) {
3427 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3428 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3429 "a value in range [512B, 64MB]");
3432 if (granularity
& (granularity
- 1)) {
3433 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3438 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3441 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3444 if (bdrv_has_blk(target
)) {
3445 error_setg(errp
, "Cannot mirror to an attached block device");
3449 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3450 sync
= MIRROR_SYNC_MODE_FULL
;
3453 /* pass the node name to replace to mirror start since it's loose coupling
3454 * and will allow to check whether the node still exist at mirror completion
3456 mirror_start(bs
, target
,
3457 has_replaces
? replaces
: NULL
,
3458 speed
, granularity
, buf_size
, sync
,
3459 on_source_error
, on_target_error
, unmap
,
3460 block_job_cb
, bs
, errp
);
3463 void qmp_drive_mirror(const char *device
, const char *target
,
3464 bool has_format
, const char *format
,
3465 bool has_node_name
, const char *node_name
,
3466 bool has_replaces
, const char *replaces
,
3467 enum MirrorSyncMode sync
,
3468 bool has_mode
, enum NewImageMode mode
,
3469 bool has_speed
, int64_t speed
,
3470 bool has_granularity
, uint32_t granularity
,
3471 bool has_buf_size
, int64_t buf_size
,
3472 bool has_on_source_error
, BlockdevOnError on_source_error
,
3473 bool has_on_target_error
, BlockdevOnError on_target_error
,
3474 bool has_unmap
, bool unmap
,
3477 BlockDriverState
*bs
;
3479 BlockDriverState
*source
, *target_bs
;
3480 AioContext
*aio_context
;
3481 Error
*local_err
= NULL
;
3482 QDict
*options
= NULL
;
3487 blk
= blk_by_name(device
);
3489 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3490 "Device '%s' not found", device
);
3494 aio_context
= blk_get_aio_context(blk
);
3495 aio_context_acquire(aio_context
);
3497 if (!blk_is_available(blk
)) {
3498 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
3503 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3507 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
3510 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3511 source
= backing_bs(bs
);
3512 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3513 sync
= MIRROR_SYNC_MODE_FULL
;
3515 if (sync
== MIRROR_SYNC_MODE_NONE
) {
3519 size
= bdrv_getlength(bs
);
3521 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3526 BlockDriverState
*to_replace_bs
;
3527 AioContext
*replace_aio_context
;
3528 int64_t replace_size
;
3530 if (!has_node_name
) {
3531 error_setg(errp
, "a node-name must be provided when replacing a"
3532 " named node of the graph");
3536 to_replace_bs
= check_to_replace_node(bs
, replaces
, &local_err
);
3538 if (!to_replace_bs
) {
3539 error_propagate(errp
, local_err
);
3543 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3544 aio_context_acquire(replace_aio_context
);
3545 replace_size
= bdrv_getlength(to_replace_bs
);
3546 aio_context_release(replace_aio_context
);
3548 if (size
!= replace_size
) {
3549 error_setg(errp
, "cannot replace image with a mirror image of "
3555 if ((sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3556 && mode
!= NEW_IMAGE_MODE_EXISTING
)
3558 /* create new image w/o backing file */
3560 bdrv_img_create(target
, format
,
3561 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
3564 case NEW_IMAGE_MODE_EXISTING
:
3566 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3567 /* create new image with backing file */
3568 bdrv_img_create(target
, format
,
3570 source
->drv
->format_name
,
3571 NULL
, size
, flags
, &local_err
, false);
3579 error_propagate(errp
, local_err
);
3583 options
= qdict_new();
3584 if (has_node_name
) {
3585 qdict_put(options
, "node-name", qstring_from_str(node_name
));
3588 qdict_put(options
, "driver", qstring_from_str(format
));
3591 /* Mirroring takes care of copy-on-write using the source's backing
3595 ret
= bdrv_open(&target_bs
, target
, NULL
, options
,
3596 flags
| BDRV_O_NO_BACKING
, &local_err
);
3598 error_propagate(errp
, local_err
);
3602 bdrv_set_aio_context(target_bs
, aio_context
);
3604 blockdev_mirror_common(bs
, target_bs
,
3605 has_replaces
, replaces
, sync
,
3607 has_granularity
, granularity
,
3608 has_buf_size
, buf_size
,
3609 has_on_source_error
, on_source_error
,
3610 has_on_target_error
, on_target_error
,
3614 error_propagate(errp
, local_err
);
3615 bdrv_unref(target_bs
);
3618 aio_context_release(aio_context
);
3621 void qmp_blockdev_mirror(const char *device
, const char *target
,
3622 bool has_replaces
, const char *replaces
,
3623 MirrorSyncMode sync
,
3624 bool has_speed
, int64_t speed
,
3625 bool has_granularity
, uint32_t granularity
,
3626 bool has_buf_size
, int64_t buf_size
,
3627 bool has_on_source_error
,
3628 BlockdevOnError on_source_error
,
3629 bool has_on_target_error
,
3630 BlockdevOnError on_target_error
,
3633 BlockDriverState
*bs
;
3635 BlockDriverState
*target_bs
;
3636 AioContext
*aio_context
;
3637 Error
*local_err
= NULL
;
3639 blk
= blk_by_name(device
);
3641 error_setg(errp
, "Device '%s' not found", device
);
3647 error_setg(errp
, "Device '%s' has no media", device
);
3651 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3656 aio_context
= bdrv_get_aio_context(bs
);
3657 aio_context_acquire(aio_context
);
3659 bdrv_ref(target_bs
);
3660 bdrv_set_aio_context(target_bs
, aio_context
);
3662 blockdev_mirror_common(bs
, target_bs
,
3663 has_replaces
, replaces
, sync
,
3665 has_granularity
, granularity
,
3666 has_buf_size
, buf_size
,
3667 has_on_source_error
, on_source_error
,
3668 has_on_target_error
, on_target_error
,
3672 error_propagate(errp
, local_err
);
3673 bdrv_unref(target_bs
);
3676 aio_context_release(aio_context
);
3679 /* Get the block job for a given device name and acquire its AioContext */
3680 static BlockJob
*find_block_job(const char *device
, AioContext
**aio_context
,
3684 BlockDriverState
*bs
;
3686 *aio_context
= NULL
;
3688 blk
= blk_by_name(device
);
3693 *aio_context
= blk_get_aio_context(blk
);
3694 aio_context_acquire(*aio_context
);
3696 if (!blk_is_available(blk
)) {
3708 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3709 "No active block job on device '%s'", device
);
3711 aio_context_release(*aio_context
);
3712 *aio_context
= NULL
;
3717 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3719 AioContext
*aio_context
;
3720 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3726 block_job_set_speed(job
, speed
, errp
);
3727 aio_context_release(aio_context
);
3730 void qmp_block_job_cancel(const char *device
,
3731 bool has_force
, bool force
, Error
**errp
)
3733 AioContext
*aio_context
;
3734 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3744 if (job
->user_paused
&& !force
) {
3745 error_setg(errp
, "The block job for device '%s' is currently paused",
3750 trace_qmp_block_job_cancel(job
);
3751 block_job_cancel(job
);
3753 aio_context_release(aio_context
);
3756 void qmp_block_job_pause(const char *device
, Error
**errp
)
3758 AioContext
*aio_context
;
3759 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3761 if (!job
|| job
->user_paused
) {
3765 job
->user_paused
= true;
3766 trace_qmp_block_job_pause(job
);
3767 block_job_pause(job
);
3768 aio_context_release(aio_context
);
3771 void qmp_block_job_resume(const char *device
, Error
**errp
)
3773 AioContext
*aio_context
;
3774 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3776 if (!job
|| !job
->user_paused
) {
3780 job
->user_paused
= false;
3781 trace_qmp_block_job_resume(job
);
3782 block_job_resume(job
);
3783 aio_context_release(aio_context
);
3786 void qmp_block_job_complete(const char *device
, Error
**errp
)
3788 AioContext
*aio_context
;
3789 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3795 trace_qmp_block_job_complete(job
);
3796 block_job_complete(job
, errp
);
3797 aio_context_release(aio_context
);
3800 void qmp_change_backing_file(const char *device
,
3801 const char *image_node_name
,
3802 const char *backing_file
,
3806 BlockDriverState
*bs
= NULL
;
3807 AioContext
*aio_context
;
3808 BlockDriverState
*image_bs
= NULL
;
3809 Error
*local_err
= NULL
;
3814 blk
= blk_by_name(device
);
3816 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3817 "Device '%s' not found", device
);
3821 aio_context
= blk_get_aio_context(blk
);
3822 aio_context_acquire(aio_context
);
3824 if (!blk_is_available(blk
)) {
3825 error_setg(errp
, "Device '%s' has no medium", device
);
3830 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3832 error_propagate(errp
, local_err
);
3837 error_setg(errp
, "image file not found");
3841 if (bdrv_find_base(image_bs
) == image_bs
) {
3842 error_setg(errp
, "not allowing backing file change on an image "
3843 "without a backing file");
3847 /* even though we are not necessarily operating on bs, we need it to
3848 * determine if block ops are currently prohibited on the chain */
3849 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3853 /* final sanity check */
3854 if (!bdrv_chain_contains(bs
, image_bs
)) {
3855 error_setg(errp
, "'%s' and image file are not in the same chain",
3860 /* if not r/w, reopen to make r/w */
3861 open_flags
= image_bs
->open_flags
;
3862 ro
= bdrv_is_read_only(image_bs
);
3865 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3867 error_propagate(errp
, local_err
);
3872 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3873 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3876 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3878 /* don't exit here, so we can try to restore open flags if
3883 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3885 error_propagate(errp
, local_err
); /* will preserve prior errp */
3890 aio_context_release(aio_context
);
3893 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
3897 Error
*local_err
= NULL
;
3899 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
3904 qdict
= qemu_opts_to_qdict(opts
, NULL
);
3906 if (!qdict_get_try_str(qdict
, "node-name")) {
3908 error_report("'node-name' needs to be specified");
3912 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
3914 error_report_err(local_err
);
3918 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3921 qemu_opts_del(opts
);
3924 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3926 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
3927 BlockDriverState
*bs
;
3928 BlockBackend
*blk
= NULL
;
3931 Error
*local_err
= NULL
;
3933 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3934 * cache.direct=false instead of silently switching to aio=threads, except
3935 * when called from drive_new().
3937 * For now, simply forbidding the combination for all drivers will do. */
3938 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
3939 bool direct
= options
->has_cache
&&
3940 options
->cache
->has_direct
&&
3941 options
->cache
->direct
;
3943 error_setg(errp
, "aio=native requires cache.direct=true");
3948 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
), NULL
, &options
,
3951 error_propagate(errp
, local_err
);
3955 obj
= qmp_output_get_qobject(ov
);
3956 qdict
= qobject_to_qdict(obj
);
3958 qdict_flatten(qdict
);
3960 if (options
->has_id
) {
3961 blk
= blockdev_init(NULL
, qdict
, &local_err
);
3963 error_propagate(errp
, local_err
);
3969 if (!qdict_get_try_str(qdict
, "node-name")) {
3970 error_setg(errp
, "'id' and/or 'node-name' need to be specified for "
3975 bs
= bds_tree_init(qdict
, errp
);
3980 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3983 if (bs
&& bdrv_key_required(bs
)) {
3985 monitor_remove_blk(blk
);
3988 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3991 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3996 qmp_output_visitor_cleanup(ov
);
3999 void qmp_x_blockdev_del(bool has_id
, const char *id
,
4000 bool has_node_name
, const char *node_name
, Error
**errp
)
4002 AioContext
*aio_context
;
4004 BlockDriverState
*bs
;
4006 if (has_id
&& has_node_name
) {
4007 error_setg(errp
, "Only one of id and node-name must be specified");
4009 } else if (!has_id
&& !has_node_name
) {
4010 error_setg(errp
, "No block device specified");
4015 /* blk_by_name() never returns a BB that is not owned by the monitor */
4016 blk
= blk_by_name(id
);
4018 error_setg(errp
, "Cannot find block backend %s", id
);
4021 if (blk_legacy_dinfo(blk
)) {
4022 error_setg(errp
, "Deleting block backend added with drive-add"
4023 " is not supported");
4026 if (blk_get_refcnt(blk
) > 1) {
4027 error_setg(errp
, "Block backend %s is in use", id
);
4031 aio_context
= blk_get_aio_context(blk
);
4034 bs
= bdrv_find_node(node_name
);
4036 error_setg(errp
, "Cannot find node %s", node_name
);
4039 if (bdrv_has_blk(bs
)) {
4040 error_setg(errp
, "Node %s is in use by %s",
4041 node_name
, bdrv_get_parent_name(bs
));
4044 aio_context
= bdrv_get_aio_context(bs
);
4047 aio_context_acquire(aio_context
);
4050 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
4054 if (!blk
&& !bs
->monitor_list
.tqe_prev
) {
4055 error_setg(errp
, "Node %s is not owned by the monitor",
4060 if (bs
->refcnt
> 1) {
4061 error_setg(errp
, "Block device %s is in use",
4062 bdrv_get_device_or_node_name(bs
));
4068 monitor_remove_blk(blk
);
4071 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
4076 aio_context_release(aio_context
);
4079 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
4080 const char *child_name
)
4084 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
4085 if (strcmp(child
->name
, child_name
) == 0) {
4093 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
4094 const char *child
, bool has_node
,
4095 const char *node
, Error
**errp
)
4097 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
4100 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
4105 if (has_child
== has_node
) {
4107 error_setg(errp
, "The parameters child and node are in conflict");
4109 error_setg(errp
, "Either child or node must be specified");
4115 p_child
= bdrv_find_child(parent_bs
, child
);
4117 error_setg(errp
, "Node '%s' does not have child '%s'",
4121 bdrv_del_child(parent_bs
, p_child
, errp
);
4125 new_bs
= bdrv_find_node(node
);
4127 error_setg(errp
, "Node '%s' not found", node
);
4130 bdrv_add_child(parent_bs
, new_bs
, errp
);
4134 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
4136 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
4137 BlockDriverState
*bs
;
4138 BdrvNextIterator
*it
= NULL
;
4140 while ((it
= bdrv_next(it
, &bs
))) {
4141 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
4143 aio_context_acquire(aio_context
);
4146 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
4147 elem
->value
= block_job_query(bs
->job
);
4149 p_next
= &elem
->next
;
4152 aio_context_release(aio_context
);
4158 QemuOptsList qemu_common_drive_opts
= {
4160 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4164 .type
= QEMU_OPT_BOOL
,
4165 .help
= "enable/disable snapshot mode",
4168 .type
= QEMU_OPT_STRING
,
4169 .help
= "discard operation (ignore/off, unmap/on)",
4172 .type
= QEMU_OPT_STRING
,
4173 .help
= "host AIO implementation (threads, native)",
4175 .name
= BDRV_OPT_CACHE_WB
,
4176 .type
= QEMU_OPT_BOOL
,
4177 .help
= "Enable writeback mode",
4180 .type
= QEMU_OPT_STRING
,
4181 .help
= "disk format (raw, qcow2, ...)",
4184 .type
= QEMU_OPT_STRING
,
4185 .help
= "read error action",
4188 .type
= QEMU_OPT_STRING
,
4189 .help
= "write error action",
4191 .name
= "read-only",
4192 .type
= QEMU_OPT_BOOL
,
4193 .help
= "open drive file as read-only",
4195 .name
= "throttling.iops-total",
4196 .type
= QEMU_OPT_NUMBER
,
4197 .help
= "limit total I/O operations per second",
4199 .name
= "throttling.iops-read",
4200 .type
= QEMU_OPT_NUMBER
,
4201 .help
= "limit read operations per second",
4203 .name
= "throttling.iops-write",
4204 .type
= QEMU_OPT_NUMBER
,
4205 .help
= "limit write operations per second",
4207 .name
= "throttling.bps-total",
4208 .type
= QEMU_OPT_NUMBER
,
4209 .help
= "limit total bytes per second",
4211 .name
= "throttling.bps-read",
4212 .type
= QEMU_OPT_NUMBER
,
4213 .help
= "limit read bytes per second",
4215 .name
= "throttling.bps-write",
4216 .type
= QEMU_OPT_NUMBER
,
4217 .help
= "limit write bytes per second",
4219 .name
= "throttling.iops-total-max",
4220 .type
= QEMU_OPT_NUMBER
,
4221 .help
= "I/O operations burst",
4223 .name
= "throttling.iops-read-max",
4224 .type
= QEMU_OPT_NUMBER
,
4225 .help
= "I/O operations read burst",
4227 .name
= "throttling.iops-write-max",
4228 .type
= QEMU_OPT_NUMBER
,
4229 .help
= "I/O operations write burst",
4231 .name
= "throttling.bps-total-max",
4232 .type
= QEMU_OPT_NUMBER
,
4233 .help
= "total bytes burst",
4235 .name
= "throttling.bps-read-max",
4236 .type
= QEMU_OPT_NUMBER
,
4237 .help
= "total bytes read burst",
4239 .name
= "throttling.bps-write-max",
4240 .type
= QEMU_OPT_NUMBER
,
4241 .help
= "total bytes write burst",
4243 .name
= "throttling.iops-total-max-length",
4244 .type
= QEMU_OPT_NUMBER
,
4245 .help
= "length of the iops-total-max burst period, in seconds",
4247 .name
= "throttling.iops-read-max-length",
4248 .type
= QEMU_OPT_NUMBER
,
4249 .help
= "length of the iops-read-max burst period, in seconds",
4251 .name
= "throttling.iops-write-max-length",
4252 .type
= QEMU_OPT_NUMBER
,
4253 .help
= "length of the iops-write-max burst period, in seconds",
4255 .name
= "throttling.bps-total-max-length",
4256 .type
= QEMU_OPT_NUMBER
,
4257 .help
= "length of the bps-total-max burst period, in seconds",
4259 .name
= "throttling.bps-read-max-length",
4260 .type
= QEMU_OPT_NUMBER
,
4261 .help
= "length of the bps-read-max burst period, in seconds",
4263 .name
= "throttling.bps-write-max-length",
4264 .type
= QEMU_OPT_NUMBER
,
4265 .help
= "length of the bps-write-max burst period, in seconds",
4267 .name
= "throttling.iops-size",
4268 .type
= QEMU_OPT_NUMBER
,
4269 .help
= "when limiting by iops max size of an I/O in bytes",
4271 .name
= "throttling.group",
4272 .type
= QEMU_OPT_STRING
,
4273 .help
= "name of the block throttling group",
4275 .name
= "copy-on-read",
4276 .type
= QEMU_OPT_BOOL
,
4277 .help
= "copy read data from backing file into image file",
4279 .name
= "detect-zeroes",
4280 .type
= QEMU_OPT_STRING
,
4281 .help
= "try to optimize zero writes (off, on, unmap)",
4283 .name
= "stats-account-invalid",
4284 .type
= QEMU_OPT_BOOL
,
4285 .help
= "whether to account for invalid I/O operations "
4286 "in the statistics",
4288 .name
= "stats-account-failed",
4289 .type
= QEMU_OPT_BOOL
,
4290 .help
= "whether to account for failed I/O operations "
4291 "in the statistics",
4293 { /* end of list */ }
4297 static QemuOptsList qemu_root_bds_opts
= {
4299 .head
= QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts
.head
),
4303 .type
= QEMU_OPT_STRING
,
4304 .help
= "discard operation (ignore/off, unmap/on)",
4307 .type
= QEMU_OPT_STRING
,
4308 .help
= "host AIO implementation (threads, native)",
4310 .name
= "read-only",
4311 .type
= QEMU_OPT_BOOL
,
4312 .help
= "open drive file as read-only",
4314 .name
= "copy-on-read",
4315 .type
= QEMU_OPT_BOOL
,
4316 .help
= "copy read data from backing file into image file",
4318 .name
= "detect-zeroes",
4319 .type
= QEMU_OPT_STRING
,
4320 .help
= "try to optimize zero writes (off, on, unmap)",
4322 { /* end of list */ }
4326 QemuOptsList qemu_drive_opts
= {
4328 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4331 * no elements => accept any params
4332 * validation will happen later
4334 { /* end of list */ }