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/qdict.h"
39 #include "block/throttle-groups.h"
40 #include "monitor/monitor.h"
41 #include "qemu/error-report.h"
42 #include "qemu/option.h"
43 #include "qemu/qemu-print.h"
44 #include "qemu/config-file.h"
45 #include "qapi/qapi-commands-block.h"
46 #include "qapi/qapi-commands-transaction.h"
47 #include "qapi/qapi-visit-block-core.h"
48 #include "qapi/qmp/qdict.h"
49 #include "qapi/qmp/qnum.h"
50 #include "qapi/qmp/qstring.h"
51 #include "qapi/error.h"
52 #include "qapi/qmp/qerror.h"
53 #include "qapi/qmp/qlist.h"
54 #include "qapi/qobject-output-visitor.h"
55 #include "sysemu/sysemu.h"
56 #include "sysemu/iothread.h"
57 #include "block/block_int.h"
58 #include "block/trace.h"
59 #include "sysemu/arch_init.h"
60 #include "sysemu/qtest.h"
61 #include "sysemu/runstate.h"
62 #include "qemu/cutils.h"
63 #include "qemu/help_option.h"
64 #include "qemu/main-loop.h"
65 #include "qemu/throttle-options.h"
67 static QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
68 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
70 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
71 bool force
, Error
**errp
);
72 static void blockdev_remove_medium(bool has_device
, const char *device
,
73 bool has_id
, const char *id
, Error
**errp
);
74 static void blockdev_insert_medium(bool has_device
, const char *device
,
75 bool has_id
, const char *id
,
76 const char *node_name
, Error
**errp
);
78 static const char *const if_name
[IF_COUNT
] = {
82 [IF_FLOPPY
] = "floppy",
83 [IF_PFLASH
] = "pflash",
86 [IF_VIRTIO
] = "virtio",
90 static int if_max_devs
[IF_COUNT
] = {
92 * Do not change these numbers! They govern how drive option
93 * index maps to unit and bus. That mapping is ABI.
95 * All controllers used to implement if=T drives need to support
96 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
97 * Otherwise, some index values map to "impossible" bus, unit
100 * For instance, if you change [IF_SCSI] to 255, -drive
101 * if=scsi,index=12 no longer means bus=1,unit=5, but
102 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
103 * the drive can't be set up. Regression.
110 * Boards may call this to offer board-by-board overrides
111 * of the default, global values.
113 void override_max_devs(BlockInterfaceType type
, int max_devs
)
122 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
123 dinfo
= blk_legacy_dinfo(blk
);
124 if (dinfo
->type
== type
) {
125 fprintf(stderr
, "Cannot override units-per-bus property of"
126 " the %s interface, because a drive of that type has"
127 " already been added.\n", if_name
[type
]);
128 g_assert_not_reached();
132 if_max_devs
[type
] = max_devs
;
136 * We automatically delete the drive when a device using it gets
137 * unplugged. Questionable feature, but we can't just drop it.
138 * Device models call blockdev_mark_auto_del() to schedule the
139 * automatic deletion, and generic qdev code calls blockdev_auto_del()
140 * when deletion is actually safe.
142 void blockdev_mark_auto_del(BlockBackend
*blk
)
144 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
151 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
152 if (block_job_has_bdrv(job
, blk_bs(blk
))) {
153 AioContext
*aio_context
= job
->job
.aio_context
;
154 aio_context_acquire(aio_context
);
156 job_cancel(&job
->job
, false);
158 aio_context_release(aio_context
);
165 void blockdev_auto_del(BlockBackend
*blk
)
167 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
169 if (dinfo
&& dinfo
->auto_del
) {
170 monitor_remove_blk(blk
);
176 * Returns the current mapping of how many units per bus
177 * a particular interface can support.
179 * A positive integer indicates n units per bus.
180 * 0 implies the mapping has not been established.
181 * -1 indicates an invalid BlockInterfaceType was given.
183 int drive_get_max_devs(BlockInterfaceType type
)
185 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
186 return if_max_devs
[type
];
192 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
194 int max_devs
= if_max_devs
[type
];
195 return max_devs
? index
/ max_devs
: 0;
198 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
200 int max_devs
= if_max_devs
[type
];
201 return max_devs
? index
% max_devs
: index
;
204 QemuOpts
*drive_def(const char *optstr
)
206 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
209 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
214 opts
= drive_def(optstr
);
218 if (type
!= IF_DEFAULT
) {
219 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
222 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
225 qemu_opt_set(opts
, "file", file
, &error_abort
);
229 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
234 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
235 dinfo
= blk_legacy_dinfo(blk
);
236 if (dinfo
&& dinfo
->type
== type
237 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
245 void drive_check_orphaned(void)
250 bool orphans
= false;
252 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
253 dinfo
= blk_legacy_dinfo(blk
);
254 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
255 dinfo
->type
!= IF_NONE
) {
257 qemu_opts_loc_restore(dinfo
->opts
);
258 error_report("machine type does not support"
259 " if=%s,bus=%d,unit=%d",
260 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
271 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
273 return drive_get(type
,
274 drive_index_to_bus_id(type
, index
),
275 drive_index_to_unit_id(type
, index
));
278 int drive_get_max_bus(BlockInterfaceType type
)
285 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
286 dinfo
= blk_legacy_dinfo(blk
);
287 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
288 max_bus
= dinfo
->bus
;
294 /* Get a block device. This should only be used for single-drive devices
295 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
297 DriveInfo
*drive_get_next(BlockInterfaceType type
)
299 static int next_block_unit
[IF_COUNT
];
301 return drive_get(type
, 0, next_block_unit
[type
]++);
304 static void bdrv_format_print(void *opaque
, const char *name
)
306 qemu_printf(" %s", name
);
311 BlockDriverState
*bs
;
314 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
316 if (!strcmp(buf
, "ignore")) {
317 return BLOCKDEV_ON_ERROR_IGNORE
;
318 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
319 return BLOCKDEV_ON_ERROR_ENOSPC
;
320 } else if (!strcmp(buf
, "stop")) {
321 return BLOCKDEV_ON_ERROR_STOP
;
322 } else if (!strcmp(buf
, "report")) {
323 return BLOCKDEV_ON_ERROR_REPORT
;
325 error_setg(errp
, "'%s' invalid %s error action",
326 buf
, is_read
? "read" : "write");
331 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
334 const QListEntry
*entry
;
335 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
336 switch (qobject_type(entry
->value
)) {
338 case QTYPE_QSTRING
: {
339 unsigned long long length
;
340 const char *str
= qstring_get_str(qobject_to(QString
,
342 if (parse_uint_full(str
, &length
, 10) == 0 &&
343 length
> 0 && length
<= UINT_MAX
) {
344 block_acct_add_interval(stats
, (unsigned) length
);
346 error_setg(errp
, "Invalid interval length: %s", str
);
353 int64_t length
= qnum_get_int(qobject_to(QNum
, entry
->value
));
355 if (length
> 0 && length
<= UINT_MAX
) {
356 block_acct_add_interval(stats
, (unsigned) length
);
358 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
365 error_setg(errp
, "The specification of stats-intervals is invalid");
372 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
374 /* All parameters but @opts are optional and may be set to NULL. */
375 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
376 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
377 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
379 Error
*local_error
= NULL
;
383 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
384 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
387 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
388 if (!strcmp(aio
, "native")) {
389 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
390 } else if (!strcmp(aio
, "threads")) {
391 /* this is the default */
393 error_setg(errp
, "invalid aio option");
399 /* disk I/O throttling */
400 if (throttling_group
) {
401 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
405 throttle_config_init(throttle_cfg
);
406 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
407 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
408 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
409 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
410 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
411 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
412 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
413 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
414 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
415 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
416 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
417 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
419 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
420 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
421 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
422 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
423 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
424 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
425 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
426 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
427 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
428 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
429 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
430 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
432 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].burst_length
=
433 qemu_opt_get_number(opts
, "throttling.bps-total-max-length", 1);
434 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].burst_length
=
435 qemu_opt_get_number(opts
, "throttling.bps-read-max-length", 1);
436 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].burst_length
=
437 qemu_opt_get_number(opts
, "throttling.bps-write-max-length", 1);
438 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].burst_length
=
439 qemu_opt_get_number(opts
, "throttling.iops-total-max-length", 1);
440 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].burst_length
=
441 qemu_opt_get_number(opts
, "throttling.iops-read-max-length", 1);
442 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].burst_length
=
443 qemu_opt_get_number(opts
, "throttling.iops-write-max-length", 1);
445 throttle_cfg
->op_size
=
446 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
448 if (!throttle_is_valid(throttle_cfg
, errp
)) {
455 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup
,
456 qemu_opt_get(opts
, "detect-zeroes"),
457 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
460 error_propagate(errp
, local_error
);
466 /* Takes the ownership of bs_opts */
467 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
472 int on_read_error
, on_write_error
;
473 bool account_invalid
, account_failed
;
474 bool writethrough
, read_only
;
476 BlockDriverState
*bs
;
481 QDict
*interval_dict
= NULL
;
482 QList
*interval_list
= NULL
;
484 BlockdevDetectZeroesOptions detect_zeroes
=
485 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
486 const char *throttling_group
= NULL
;
488 /* Check common options by copying from bs_opts to opts, all other options
489 * stay in bs_opts for processing by bdrv_open(). */
490 id
= qdict_get_try_str(bs_opts
, "id");
491 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
493 error_propagate(errp
, error
);
497 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
499 error_propagate(errp
, error
);
504 qdict_del(bs_opts
, "id");
507 /* extract parameters */
508 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
510 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
511 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
513 writethrough
= !qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true);
515 id
= qemu_opts_id(opts
);
517 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
518 qdict_array_split(interval_dict
, &interval_list
);
520 if (qdict_size(interval_dict
) != 0) {
521 error_setg(errp
, "Invalid option stats-intervals.%s",
522 qdict_first(interval_dict
)->key
);
526 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
527 &detect_zeroes
, &error
);
529 error_propagate(errp
, error
);
533 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
534 if (is_help_option(buf
)) {
535 qemu_printf("Supported formats:");
536 bdrv_iterate_format(bdrv_format_print
, NULL
, false);
537 qemu_printf("\nSupported formats (read-only):");
538 bdrv_iterate_format(bdrv_format_print
, NULL
, true);
543 if (qdict_haskey(bs_opts
, "driver")) {
544 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
547 qdict_put_str(bs_opts
, "driver", buf
);
550 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
551 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
552 on_write_error
= parse_block_error_action(buf
, 0, &error
);
554 error_propagate(errp
, error
);
559 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
560 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
561 on_read_error
= parse_block_error_action(buf
, 1, &error
);
563 error_propagate(errp
, error
);
569 bdrv_flags
|= BDRV_O_SNAPSHOT
;
572 read_only
= qemu_opt_get_bool(opts
, BDRV_OPT_READ_ONLY
, false);
575 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
576 BlockBackendRootState
*blk_rs
;
578 blk
= blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL
);
579 blk_rs
= blk_get_root_state(blk
);
580 blk_rs
->open_flags
= bdrv_flags
;
581 blk_rs
->read_only
= read_only
;
582 blk_rs
->detect_zeroes
= detect_zeroes
;
584 qobject_unref(bs_opts
);
586 if (file
&& !*file
) {
590 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
591 * with other callers) rather than what we want as the real defaults.
592 * Apply the defaults here instead. */
593 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
594 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
595 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
,
596 read_only
? "on" : "off");
597 qdict_set_default_str(bs_opts
, BDRV_OPT_AUTO_READ_ONLY
, "on");
598 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
600 if (runstate_check(RUN_STATE_INMIGRATE
)) {
601 bdrv_flags
|= BDRV_O_INACTIVE
;
604 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
610 bs
->detect_zeroes
= detect_zeroes
;
612 block_acct_setup(blk_get_stats(blk
), account_invalid
, account_failed
);
614 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
621 /* disk I/O throttling */
622 if (throttle_enabled(&cfg
)) {
623 if (!throttling_group
) {
624 throttling_group
= id
;
626 blk_io_limits_enable(blk
, throttling_group
);
627 blk_set_io_limits(blk
, &cfg
);
630 blk_set_enable_write_cache(blk
, !writethrough
);
631 blk_set_on_error(blk
, on_read_error
, on_write_error
);
633 if (!monitor_add_blk(blk
, id
, errp
)) {
641 qobject_unref(interval_dict
);
642 qobject_unref(interval_list
);
647 qobject_unref(interval_dict
);
648 qobject_unref(interval_list
);
650 qobject_unref(bs_opts
);
654 /* Takes the ownership of bs_opts */
655 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
659 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
660 * with other callers) rather than what we want as the real defaults.
661 * Apply the defaults here instead. */
662 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
663 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
664 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
666 if (runstate_check(RUN_STATE_INMIGRATE
)) {
667 bdrv_flags
|= BDRV_O_INACTIVE
;
670 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
673 void blockdev_close_all_bdrv_states(void)
675 BlockDriverState
*bs
, *next_bs
;
677 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
678 AioContext
*ctx
= bdrv_get_aio_context(bs
);
680 aio_context_acquire(ctx
);
682 aio_context_release(ctx
);
686 /* Iterates over the list of monitor-owned BlockDriverStates */
687 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
689 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
690 : QTAILQ_FIRST(&monitor_bdrv_states
);
693 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
698 value
= qemu_opt_get(opts
, from
);
700 if (qemu_opt_find(opts
, to
)) {
701 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
702 "same time", to
, from
);
707 /* rename all items in opts */
708 while ((value
= qemu_opt_get(opts
, from
))) {
709 qemu_opt_set(opts
, to
, value
, &error_abort
);
710 qemu_opt_unset(opts
, from
);
714 QemuOptsList qemu_legacy_drive_opts
= {
716 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
720 .type
= QEMU_OPT_NUMBER
,
721 .help
= "bus number",
724 .type
= QEMU_OPT_NUMBER
,
725 .help
= "unit number (i.e. lun for scsi)",
728 .type
= QEMU_OPT_NUMBER
,
729 .help
= "index number",
732 .type
= QEMU_OPT_STRING
,
733 .help
= "media type (disk, cdrom)",
736 .type
= QEMU_OPT_STRING
,
737 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
740 .type
= QEMU_OPT_STRING
,
744 /* Options that are passed on, but have special semantics with -drive */
746 .name
= BDRV_OPT_READ_ONLY
,
747 .type
= QEMU_OPT_BOOL
,
748 .help
= "open drive file as read-only",
751 .type
= QEMU_OPT_STRING
,
752 .help
= "read error action",
755 .type
= QEMU_OPT_STRING
,
756 .help
= "write error action",
758 .name
= "copy-on-read",
759 .type
= QEMU_OPT_BOOL
,
760 .help
= "copy read data from backing file into image file",
763 { /* end of list */ }
767 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
,
772 DriveInfo
*dinfo
= NULL
;
774 QemuOpts
*legacy_opts
;
775 DriveMediaType media
= MEDIA_DISK
;
776 BlockInterfaceType type
;
777 int max_devs
, bus_id
, unit_id
, index
;
778 const char *werror
, *rerror
;
779 bool read_only
= false;
781 const char *filename
;
782 Error
*local_err
= NULL
;
785 /* Change legacy command line options into QMP ones */
786 static const struct {
790 { "iops", "throttling.iops-total" },
791 { "iops_rd", "throttling.iops-read" },
792 { "iops_wr", "throttling.iops-write" },
794 { "bps", "throttling.bps-total" },
795 { "bps_rd", "throttling.bps-read" },
796 { "bps_wr", "throttling.bps-write" },
798 { "iops_max", "throttling.iops-total-max" },
799 { "iops_rd_max", "throttling.iops-read-max" },
800 { "iops_wr_max", "throttling.iops-write-max" },
802 { "bps_max", "throttling.bps-total-max" },
803 { "bps_rd_max", "throttling.bps-read-max" },
804 { "bps_wr_max", "throttling.bps-write-max" },
806 { "iops_size", "throttling.iops-size" },
808 { "group", "throttling.group" },
810 { "readonly", BDRV_OPT_READ_ONLY
},
813 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
814 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
817 error_propagate(errp
, local_err
);
822 value
= qemu_opt_get(all_opts
, "cache");
827 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
828 error_setg(errp
, "invalid cache option");
832 /* Specific options take precedence */
833 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
834 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
835 !writethrough
, &error_abort
);
837 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
838 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
839 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
841 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
842 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
843 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
845 qemu_opt_unset(all_opts
, "cache");
848 /* Get a QDict for processing the options */
849 bs_opts
= qdict_new();
850 qemu_opts_to_qdict(all_opts
, bs_opts
);
852 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
854 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
856 error_propagate(errp
, local_err
);
861 value
= qemu_opt_get(legacy_opts
, "media");
863 if (!strcmp(value
, "disk")) {
865 } else if (!strcmp(value
, "cdrom")) {
869 error_setg(errp
, "'%s' invalid media", value
);
874 /* copy-on-read is disabled with a warning for read-only devices */
875 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
876 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
878 if (read_only
&& copy_on_read
) {
879 warn_report("disabling copy-on-read on read-only drive");
880 copy_on_read
= false;
883 qdict_put_str(bs_opts
, BDRV_OPT_READ_ONLY
, read_only
? "on" : "off");
884 qdict_put_str(bs_opts
, "copy-on-read", copy_on_read
? "on" : "off");
886 /* Controller type */
887 value
= qemu_opt_get(legacy_opts
, "if");
890 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
893 if (type
== IF_COUNT
) {
894 error_setg(errp
, "unsupported bus type '%s'", value
);
898 type
= block_default_type
;
901 /* Device address specified by bus/unit or index.
902 * If none was specified, try to find the first free one. */
903 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
904 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
905 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
907 max_devs
= if_max_devs
[type
];
910 if (bus_id
!= 0 || unit_id
!= -1) {
911 error_setg(errp
, "index cannot be used with bus and unit");
914 bus_id
= drive_index_to_bus_id(type
, index
);
915 unit_id
= drive_index_to_unit_id(type
, index
);
920 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
922 if (max_devs
&& unit_id
>= max_devs
) {
929 if (max_devs
&& unit_id
>= max_devs
) {
930 error_setg(errp
, "unit %d too big (max is %d)", unit_id
, max_devs
- 1);
934 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
935 error_setg(errp
, "drive with bus=%d, unit=%d (index=%d) exists",
936 bus_id
, unit_id
, index
);
940 /* no id supplied -> create one */
941 if (qemu_opts_id(all_opts
) == NULL
) {
943 const char *mediastr
= "";
944 if (type
== IF_IDE
|| type
== IF_SCSI
) {
945 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
948 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
951 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
954 qdict_put_str(bs_opts
, "id", new_id
);
958 /* Add virtio block device */
959 if (type
== IF_VIRTIO
) {
961 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
963 if (arch_type
== QEMU_ARCH_S390X
) {
964 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
966 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
968 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
972 filename
= qemu_opt_get(legacy_opts
, "file");
974 /* Check werror/rerror compatibility with if=... */
975 werror
= qemu_opt_get(legacy_opts
, "werror");
976 if (werror
!= NULL
) {
977 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
979 error_setg(errp
, "werror is not supported by this bus type");
982 qdict_put_str(bs_opts
, "werror", werror
);
985 rerror
= qemu_opt_get(legacy_opts
, "rerror");
986 if (rerror
!= NULL
) {
987 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
989 error_setg(errp
, "rerror is not supported by this bus type");
992 qdict_put_str(bs_opts
, "rerror", rerror
);
995 /* Actual block device init: Functionality shared with blockdev-add */
996 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
999 error_propagate(errp
, local_err
);
1005 /* Create legacy DriveInfo */
1006 dinfo
= g_malloc0(sizeof(*dinfo
));
1007 dinfo
->opts
= all_opts
;
1010 dinfo
->bus
= bus_id
;
1011 dinfo
->unit
= unit_id
;
1013 blk_set_legacy_dinfo(blk
, dinfo
);
1020 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1027 qemu_opts_del(legacy_opts
);
1028 qobject_unref(bs_opts
);
1032 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1034 BlockDriverState
*bs
;
1036 bs
= bdrv_lookup_bs(name
, name
, errp
);
1041 if (!bdrv_is_root_node(bs
)) {
1042 error_setg(errp
, "Need a root block node");
1046 if (!bdrv_is_inserted(bs
)) {
1047 error_setg(errp
, "Device has no medium");
1054 static BlockBackend
*qmp_get_blk(const char *blk_name
, const char *qdev_id
,
1059 if (!blk_name
== !qdev_id
) {
1060 error_setg(errp
, "Need exactly one of 'device' and 'id'");
1065 blk
= blk_by_qdev_id(qdev_id
, errp
);
1067 blk
= blk_by_name(blk_name
);
1069 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1070 "Device '%s' not found", blk_name
);
1077 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1079 const char *device
= qdict_get_str(qdict
, "device");
1083 if (!strcmp(device
, "all")) {
1084 ret
= blk_commit_all();
1086 BlockDriverState
*bs
;
1087 AioContext
*aio_context
;
1089 blk
= blk_by_name(device
);
1091 error_report("Device '%s' not found", device
);
1094 if (!blk_is_available(blk
)) {
1095 error_report("Device '%s' has no medium", device
);
1100 aio_context
= bdrv_get_aio_context(bs
);
1101 aio_context_acquire(aio_context
);
1103 ret
= bdrv_commit(bs
);
1105 aio_context_release(aio_context
);
1108 error_report("'commit' error for '%s': %s", device
, strerror(-ret
));
1112 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1114 TransactionActionList list
;
1116 list
.value
= action
;
1118 qmp_transaction(&list
, false, NULL
, errp
);
1121 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1122 bool has_node_name
, const char *node_name
,
1123 const char *snapshot_file
,
1124 bool has_snapshot_node_name
,
1125 const char *snapshot_node_name
,
1126 bool has_format
, const char *format
,
1127 bool has_mode
, NewImageMode mode
, Error
**errp
)
1129 BlockdevSnapshotSync snapshot
= {
1130 .has_device
= has_device
,
1131 .device
= (char *) device
,
1132 .has_node_name
= has_node_name
,
1133 .node_name
= (char *) node_name
,
1134 .snapshot_file
= (char *) snapshot_file
,
1135 .has_snapshot_node_name
= has_snapshot_node_name
,
1136 .snapshot_node_name
= (char *) snapshot_node_name
,
1137 .has_format
= has_format
,
1138 .format
= (char *) format
,
1139 .has_mode
= has_mode
,
1142 TransactionAction action
= {
1143 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1144 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1146 blockdev_do_action(&action
, errp
);
1149 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1152 BlockdevSnapshot snapshot_data
= {
1153 .node
= (char *) node
,
1154 .overlay
= (char *) overlay
1156 TransactionAction action
= {
1157 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1158 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1160 blockdev_do_action(&action
, errp
);
1163 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1167 BlockdevSnapshotInternal snapshot
= {
1168 .device
= (char *) device
,
1169 .name
= (char *) name
1171 TransactionAction action
= {
1172 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1173 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1175 blockdev_do_action(&action
, errp
);
1178 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1185 BlockDriverState
*bs
;
1186 AioContext
*aio_context
;
1187 QEMUSnapshotInfo sn
;
1188 Error
*local_err
= NULL
;
1189 SnapshotInfo
*info
= NULL
;
1192 bs
= qmp_get_root_bs(device
, errp
);
1196 aio_context
= bdrv_get_aio_context(bs
);
1197 aio_context_acquire(aio_context
);
1208 error_setg(errp
, "Name or id must be provided");
1209 goto out_aio_context
;
1212 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1213 goto out_aio_context
;
1216 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1218 error_propagate(errp
, local_err
);
1219 goto out_aio_context
;
1223 "Snapshot with id '%s' and name '%s' does not exist on "
1225 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1226 goto out_aio_context
;
1229 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1231 error_propagate(errp
, local_err
);
1232 goto out_aio_context
;
1235 aio_context_release(aio_context
);
1237 info
= g_new0(SnapshotInfo
, 1);
1238 info
->id
= g_strdup(sn
.id_str
);
1239 info
->name
= g_strdup(sn
.name
);
1240 info
->date_nsec
= sn
.date_nsec
;
1241 info
->date_sec
= sn
.date_sec
;
1242 info
->vm_state_size
= sn
.vm_state_size
;
1243 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1244 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1249 aio_context_release(aio_context
);
1254 * block_dirty_bitmap_lookup:
1255 * Return a dirty bitmap (if present), after validating
1256 * the node reference and bitmap names.
1258 * @node: The name of the BDS node to search for bitmaps
1259 * @name: The name of the bitmap to search for
1260 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1261 * @errp: Output pointer for error information. Can be NULL.
1263 * @return: A bitmap object on success, or NULL on failure.
1265 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1267 BlockDriverState
**pbs
,
1270 BlockDriverState
*bs
;
1271 BdrvDirtyBitmap
*bitmap
;
1274 error_setg(errp
, "Node cannot be NULL");
1278 error_setg(errp
, "Bitmap name cannot be NULL");
1281 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1283 error_setg(errp
, "Node '%s' not found", node
);
1287 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1289 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1300 /* New and old BlockDriverState structs for atomic group operations */
1302 typedef struct BlkActionState BlkActionState
;
1306 * Table of operations that define an Action.
1308 * @instance_size: Size of state struct, in bytes.
1309 * @prepare: Prepare the work, must NOT be NULL.
1310 * @commit: Commit the changes, can be NULL.
1311 * @abort: Abort the changes on fail, can be NULL.
1312 * @clean: Clean up resources after all transaction actions have called
1313 * commit() or abort(). Can be NULL.
1315 * Only prepare() may fail. In a single transaction, only one of commit() or
1316 * abort() will be called. clean() will always be called if it is present.
1318 typedef struct BlkActionOps
{
1319 size_t instance_size
;
1320 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1321 void (*commit
)(BlkActionState
*common
);
1322 void (*abort
)(BlkActionState
*common
);
1323 void (*clean
)(BlkActionState
*common
);
1328 * Describes one Action's state within a Transaction.
1330 * @action: QAPI-defined enum identifying which Action to perform.
1331 * @ops: Table of ActionOps this Action can perform.
1332 * @block_job_txn: Transaction which this action belongs to.
1333 * @entry: List membership for all Actions in this Transaction.
1335 * This structure must be arranged as first member in a subclassed type,
1336 * assuming that the compiler will also arrange it to the same offsets as the
1339 struct BlkActionState
{
1340 TransactionAction
*action
;
1341 const BlkActionOps
*ops
;
1342 JobTxn
*block_job_txn
;
1343 TransactionProperties
*txn_props
;
1344 QTAILQ_ENTRY(BlkActionState
) entry
;
1347 /* internal snapshot private data */
1348 typedef struct InternalSnapshotState
{
1349 BlkActionState common
;
1350 BlockDriverState
*bs
;
1351 QEMUSnapshotInfo sn
;
1353 } InternalSnapshotState
;
1356 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1358 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1360 "Action '%s' does not support Transaction property "
1361 "completion-mode = %s",
1362 TransactionActionKind_str(s
->action
->type
),
1363 ActionCompletionMode_str(s
->txn_props
->completion_mode
));
1369 static void internal_snapshot_prepare(BlkActionState
*common
,
1372 Error
*local_err
= NULL
;
1375 BlockDriverState
*bs
;
1376 QEMUSnapshotInfo old_sn
, *sn
;
1379 BlockdevSnapshotInternal
*internal
;
1380 InternalSnapshotState
*state
;
1381 AioContext
*aio_context
;
1384 g_assert(common
->action
->type
==
1385 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1386 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1387 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1389 /* 1. parse input */
1390 device
= internal
->device
;
1391 name
= internal
->name
;
1393 /* 2. check for validation */
1394 if (action_check_completion_mode(common
, errp
) < 0) {
1398 bs
= qmp_get_root_bs(device
, errp
);
1403 aio_context
= bdrv_get_aio_context(bs
);
1404 aio_context_acquire(aio_context
);
1408 /* Paired with .clean() */
1409 bdrv_drained_begin(bs
);
1411 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1415 if (bdrv_is_read_only(bs
)) {
1416 error_setg(errp
, "Device '%s' is read only", device
);
1420 if (!bdrv_can_snapshot(bs
)) {
1421 error_setg(errp
, "Block format '%s' used by device '%s' "
1422 "does not support internal snapshots",
1423 bs
->drv
->format_name
, device
);
1427 if (!strlen(name
)) {
1428 error_setg(errp
, "Name is empty");
1432 /* check whether a snapshot with name exist */
1433 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1436 error_propagate(errp
, local_err
);
1440 "Snapshot with name '%s' already exists on device '%s'",
1445 /* 3. take the snapshot */
1447 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1448 qemu_gettimeofday(&tv
);
1449 sn
->date_sec
= tv
.tv_sec
;
1450 sn
->date_nsec
= tv
.tv_usec
* 1000;
1451 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1453 ret1
= bdrv_snapshot_create(bs
, sn
);
1455 error_setg_errno(errp
, -ret1
,
1456 "Failed to create snapshot '%s' on device '%s'",
1461 /* 4. succeed, mark a snapshot is created */
1462 state
->created
= true;
1465 aio_context_release(aio_context
);
1468 static void internal_snapshot_abort(BlkActionState
*common
)
1470 InternalSnapshotState
*state
=
1471 DO_UPCAST(InternalSnapshotState
, common
, common
);
1472 BlockDriverState
*bs
= state
->bs
;
1473 QEMUSnapshotInfo
*sn
= &state
->sn
;
1474 AioContext
*aio_context
;
1475 Error
*local_error
= NULL
;
1477 if (!state
->created
) {
1481 aio_context
= bdrv_get_aio_context(state
->bs
);
1482 aio_context_acquire(aio_context
);
1484 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1485 error_reportf_err(local_error
,
1486 "Failed to delete snapshot with id '%s' and "
1487 "name '%s' on device '%s' in abort: ",
1488 sn
->id_str
, sn
->name
,
1489 bdrv_get_device_name(bs
));
1492 aio_context_release(aio_context
);
1495 static void internal_snapshot_clean(BlkActionState
*common
)
1497 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1499 AioContext
*aio_context
;
1505 aio_context
= bdrv_get_aio_context(state
->bs
);
1506 aio_context_acquire(aio_context
);
1508 bdrv_drained_end(state
->bs
);
1510 aio_context_release(aio_context
);
1513 /* external snapshot private data */
1514 typedef struct ExternalSnapshotState
{
1515 BlkActionState common
;
1516 BlockDriverState
*old_bs
;
1517 BlockDriverState
*new_bs
;
1518 bool overlay_appended
;
1519 } ExternalSnapshotState
;
1521 static void external_snapshot_prepare(BlkActionState
*common
,
1525 QDict
*options
= NULL
;
1526 Error
*local_err
= NULL
;
1527 /* Device and node name of the image to generate the snapshot from */
1529 const char *node_name
;
1530 /* Reference to the new image (for 'blockdev-snapshot') */
1531 const char *snapshot_ref
;
1532 /* File name of the new image (for 'blockdev-snapshot-sync') */
1533 const char *new_image_file
;
1534 ExternalSnapshotState
*state
=
1535 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1536 TransactionAction
*action
= common
->action
;
1537 AioContext
*aio_context
;
1540 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1541 * purpose but a different set of parameters */
1542 switch (action
->type
) {
1543 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1545 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1547 node_name
= s
->node
;
1548 new_image_file
= NULL
;
1549 snapshot_ref
= s
->overlay
;
1552 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1554 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1555 device
= s
->has_device
? s
->device
: NULL
;
1556 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1557 new_image_file
= s
->snapshot_file
;
1558 snapshot_ref
= NULL
;
1562 g_assert_not_reached();
1565 /* start processing */
1566 if (action_check_completion_mode(common
, errp
) < 0) {
1570 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1571 if (!state
->old_bs
) {
1575 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1576 aio_context_acquire(aio_context
);
1578 /* Paired with .clean() */
1579 bdrv_drained_begin(state
->old_bs
);
1581 if (!bdrv_is_inserted(state
->old_bs
)) {
1582 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1586 if (bdrv_op_is_blocked(state
->old_bs
,
1587 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1591 if (!bdrv_is_read_only(state
->old_bs
)) {
1592 if (bdrv_flush(state
->old_bs
)) {
1593 error_setg(errp
, QERR_IO_ERROR
);
1598 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1599 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1603 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1604 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1605 const char *format
= s
->has_format
? s
->format
: "qcow2";
1606 enum NewImageMode mode
;
1607 const char *snapshot_node_name
=
1608 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1610 if (node_name
&& !snapshot_node_name
) {
1611 error_setg(errp
, "New overlay node name missing");
1615 if (snapshot_node_name
&&
1616 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1617 error_setg(errp
, "New overlay node name already in use");
1621 flags
= state
->old_bs
->open_flags
;
1622 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_COPY_ON_READ
);
1623 flags
|= BDRV_O_NO_BACKING
;
1625 /* create new image w/backing file */
1626 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1627 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1628 int64_t size
= bdrv_getlength(state
->old_bs
);
1630 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1633 bdrv_refresh_filename(state
->old_bs
);
1634 bdrv_img_create(new_image_file
, format
,
1635 state
->old_bs
->filename
,
1636 state
->old_bs
->drv
->format_name
,
1637 NULL
, size
, flags
, false, &local_err
);
1639 error_propagate(errp
, local_err
);
1644 options
= qdict_new();
1645 if (snapshot_node_name
) {
1646 qdict_put_str(options
, "node-name", snapshot_node_name
);
1648 qdict_put_str(options
, "driver", format
);
1651 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1653 /* We will manually add the backing_hd field to the bs later */
1654 if (!state
->new_bs
) {
1658 if (bdrv_has_blk(state
->new_bs
)) {
1659 error_setg(errp
, "The overlay is already in use");
1663 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1668 if (state
->new_bs
->backing
!= NULL
) {
1669 error_setg(errp
, "The overlay already has a backing image");
1673 if (!state
->new_bs
->drv
->supports_backing
) {
1674 error_setg(errp
, "The overlay does not support backing images");
1678 ret
= bdrv_try_set_aio_context(state
->new_bs
, aio_context
, errp
);
1683 /* This removes our old bs and adds the new bs. This is an operation that
1684 * can fail, so we need to do it in .prepare; undoing it for abort is
1685 * always possible. */
1686 bdrv_ref(state
->new_bs
);
1687 bdrv_append(state
->new_bs
, state
->old_bs
, &local_err
);
1689 error_propagate(errp
, local_err
);
1692 state
->overlay_appended
= true;
1695 aio_context_release(aio_context
);
1698 static void external_snapshot_commit(BlkActionState
*common
)
1700 ExternalSnapshotState
*state
=
1701 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1702 AioContext
*aio_context
;
1704 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1705 aio_context_acquire(aio_context
);
1707 /* We don't need (or want) to use the transactional
1708 * bdrv_reopen_multiple() across all the entries at once, because we
1709 * don't want to abort all of them if one of them fails the reopen */
1710 if (!atomic_read(&state
->old_bs
->copy_on_read
)) {
1711 bdrv_reopen_set_read_only(state
->old_bs
, true, NULL
);
1714 aio_context_release(aio_context
);
1717 static void external_snapshot_abort(BlkActionState
*common
)
1719 ExternalSnapshotState
*state
=
1720 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1721 if (state
->new_bs
) {
1722 if (state
->overlay_appended
) {
1723 AioContext
*aio_context
;
1725 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1726 aio_context_acquire(aio_context
);
1728 bdrv_ref(state
->old_bs
); /* we can't let bdrv_set_backind_hd()
1729 close state->old_bs; we need it */
1730 bdrv_set_backing_hd(state
->new_bs
, NULL
, &error_abort
);
1731 bdrv_replace_node(state
->new_bs
, state
->old_bs
, &error_abort
);
1732 bdrv_unref(state
->old_bs
); /* bdrv_replace_node() ref'ed old_bs */
1734 aio_context_release(aio_context
);
1739 static void external_snapshot_clean(BlkActionState
*common
)
1741 ExternalSnapshotState
*state
=
1742 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1743 AioContext
*aio_context
;
1745 if (!state
->old_bs
) {
1749 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1750 aio_context_acquire(aio_context
);
1752 bdrv_drained_end(state
->old_bs
);
1753 bdrv_unref(state
->new_bs
);
1755 aio_context_release(aio_context
);
1758 typedef struct DriveBackupState
{
1759 BlkActionState common
;
1760 BlockDriverState
*bs
;
1764 static BlockJob
*do_backup_common(BackupCommon
*backup
,
1765 BlockDriverState
*bs
,
1766 BlockDriverState
*target_bs
,
1767 AioContext
*aio_context
,
1768 JobTxn
*txn
, Error
**errp
);
1770 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1772 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1773 DriveBackup
*backup
;
1774 BlockDriverState
*bs
;
1775 BlockDriverState
*target_bs
;
1776 BlockDriverState
*source
= NULL
;
1777 AioContext
*aio_context
;
1779 Error
*local_err
= NULL
;
1782 bool set_backing_hd
= false;
1784 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1785 backup
= common
->action
->u
.drive_backup
.data
;
1787 if (!backup
->has_mode
) {
1788 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1791 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1797 error_setg(errp
, "Device has no medium");
1801 aio_context
= bdrv_get_aio_context(bs
);
1802 aio_context_acquire(aio_context
);
1804 /* Paired with .clean() */
1805 bdrv_drained_begin(bs
);
1807 if (!backup
->has_format
) {
1808 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
1809 NULL
: (char *) bs
->drv
->format_name
;
1812 /* Early check to avoid creating target */
1813 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
1817 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1820 * See if we have a backing HD we can use to create our new image
1823 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
1824 source
= backing_bs(bs
);
1826 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
1829 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
1831 flags
|= BDRV_O_NO_BACKING
;
1832 set_backing_hd
= true;
1835 size
= bdrv_getlength(bs
);
1837 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1841 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
1842 assert(backup
->format
);
1844 bdrv_refresh_filename(source
);
1845 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
1846 source
->drv
->format_name
, NULL
,
1847 size
, flags
, false, &local_err
);
1849 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
1850 size
, flags
, false, &local_err
);
1855 error_propagate(errp
, local_err
);
1859 options
= qdict_new();
1860 qdict_put_str(options
, "discard", "unmap");
1861 qdict_put_str(options
, "detect-zeroes", "unmap");
1862 if (backup
->format
) {
1863 qdict_put_str(options
, "driver", backup
->format
);
1866 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
1871 if (set_backing_hd
) {
1872 bdrv_set_backing_hd(target_bs
, source
, &local_err
);
1880 state
->job
= do_backup_common(qapi_DriveBackup_base(backup
),
1881 bs
, target_bs
, aio_context
,
1882 common
->block_job_txn
, errp
);
1885 bdrv_unref(target_bs
);
1887 aio_context_release(aio_context
);
1890 static void drive_backup_commit(BlkActionState
*common
)
1892 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1893 AioContext
*aio_context
;
1895 aio_context
= bdrv_get_aio_context(state
->bs
);
1896 aio_context_acquire(aio_context
);
1899 job_start(&state
->job
->job
);
1901 aio_context_release(aio_context
);
1904 static void drive_backup_abort(BlkActionState
*common
)
1906 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1909 AioContext
*aio_context
;
1911 aio_context
= bdrv_get_aio_context(state
->bs
);
1912 aio_context_acquire(aio_context
);
1914 job_cancel_sync(&state
->job
->job
);
1916 aio_context_release(aio_context
);
1920 static void drive_backup_clean(BlkActionState
*common
)
1922 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1923 AioContext
*aio_context
;
1929 aio_context
= bdrv_get_aio_context(state
->bs
);
1930 aio_context_acquire(aio_context
);
1932 bdrv_drained_end(state
->bs
);
1934 aio_context_release(aio_context
);
1937 typedef struct BlockdevBackupState
{
1938 BlkActionState common
;
1939 BlockDriverState
*bs
;
1941 } BlockdevBackupState
;
1943 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1945 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1946 BlockdevBackup
*backup
;
1947 BlockDriverState
*bs
;
1948 BlockDriverState
*target_bs
;
1949 AioContext
*aio_context
;
1951 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1952 backup
= common
->action
->u
.blockdev_backup
.data
;
1954 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1959 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1964 aio_context
= bdrv_get_aio_context(bs
);
1965 aio_context_acquire(aio_context
);
1968 /* Paired with .clean() */
1969 bdrv_drained_begin(state
->bs
);
1971 state
->job
= do_backup_common(qapi_BlockdevBackup_base(backup
),
1972 bs
, target_bs
, aio_context
,
1973 common
->block_job_txn
, errp
);
1975 aio_context_release(aio_context
);
1978 static void blockdev_backup_commit(BlkActionState
*common
)
1980 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1981 AioContext
*aio_context
;
1983 aio_context
= bdrv_get_aio_context(state
->bs
);
1984 aio_context_acquire(aio_context
);
1987 job_start(&state
->job
->job
);
1989 aio_context_release(aio_context
);
1992 static void blockdev_backup_abort(BlkActionState
*common
)
1994 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1997 AioContext
*aio_context
;
1999 aio_context
= bdrv_get_aio_context(state
->bs
);
2000 aio_context_acquire(aio_context
);
2002 job_cancel_sync(&state
->job
->job
);
2004 aio_context_release(aio_context
);
2008 static void blockdev_backup_clean(BlkActionState
*common
)
2010 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
2011 AioContext
*aio_context
;
2017 aio_context
= bdrv_get_aio_context(state
->bs
);
2018 aio_context_acquire(aio_context
);
2020 bdrv_drained_end(state
->bs
);
2022 aio_context_release(aio_context
);
2025 typedef struct BlockDirtyBitmapState
{
2026 BlkActionState common
;
2027 BdrvDirtyBitmap
*bitmap
;
2028 BlockDriverState
*bs
;
2032 } BlockDirtyBitmapState
;
2034 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
2037 Error
*local_err
= NULL
;
2038 BlockDirtyBitmapAdd
*action
;
2039 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2042 if (action_check_completion_mode(common
, errp
) < 0) {
2046 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
2047 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2048 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
2049 action
->has_granularity
, action
->granularity
,
2050 action
->has_persistent
, action
->persistent
,
2051 action
->has_disabled
, action
->disabled
,
2055 state
->prepared
= true;
2057 error_propagate(errp
, local_err
);
2061 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
2063 BlockDirtyBitmapAdd
*action
;
2064 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2067 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
2068 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2069 * then the node reference and bitmap name must have been valid.
2071 if (state
->prepared
) {
2072 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
2076 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
2079 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2081 BlockDirtyBitmap
*action
;
2083 if (action_check_completion_mode(common
, errp
) < 0) {
2087 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2088 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2092 if (!state
->bitmap
) {
2096 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_DEFAULT
, errp
)) {
2100 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2103 static void block_dirty_bitmap_restore(BlkActionState
*common
)
2105 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2108 if (state
->backup
) {
2109 bdrv_restore_dirty_bitmap(state
->bitmap
, state
->backup
);
2113 static void block_dirty_bitmap_free_backup(BlkActionState
*common
)
2115 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2118 hbitmap_free(state
->backup
);
2121 static void block_dirty_bitmap_enable_prepare(BlkActionState
*common
,
2124 BlockDirtyBitmap
*action
;
2125 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2128 if (action_check_completion_mode(common
, errp
) < 0) {
2132 action
= common
->action
->u
.block_dirty_bitmap_enable
.data
;
2133 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2137 if (!state
->bitmap
) {
2141 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2145 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2146 bdrv_enable_dirty_bitmap(state
->bitmap
);
2149 static void block_dirty_bitmap_enable_abort(BlkActionState
*common
)
2151 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2154 if (!state
->was_enabled
) {
2155 bdrv_disable_dirty_bitmap(state
->bitmap
);
2159 static void block_dirty_bitmap_disable_prepare(BlkActionState
*common
,
2162 BlockDirtyBitmap
*action
;
2163 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2166 if (action_check_completion_mode(common
, errp
) < 0) {
2170 action
= common
->action
->u
.block_dirty_bitmap_disable
.data
;
2171 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2175 if (!state
->bitmap
) {
2179 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2183 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2184 bdrv_disable_dirty_bitmap(state
->bitmap
);
2187 static void block_dirty_bitmap_disable_abort(BlkActionState
*common
)
2189 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2192 if (state
->was_enabled
) {
2193 bdrv_enable_dirty_bitmap(state
->bitmap
);
2197 static BdrvDirtyBitmap
*do_block_dirty_bitmap_merge(
2198 const char *node
, const char *target
,
2199 BlockDirtyBitmapMergeSourceList
*bitmaps
,
2200 HBitmap
**backup
, Error
**errp
);
2202 static void block_dirty_bitmap_merge_prepare(BlkActionState
*common
,
2205 BlockDirtyBitmapMerge
*action
;
2206 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2209 if (action_check_completion_mode(common
, errp
) < 0) {
2213 action
= common
->action
->u
.block_dirty_bitmap_merge
.data
;
2215 state
->bitmap
= do_block_dirty_bitmap_merge(action
->node
, action
->target
,
2216 action
->bitmaps
, &state
->backup
,
2220 static BdrvDirtyBitmap
*do_block_dirty_bitmap_remove(
2221 const char *node
, const char *name
, bool release
,
2222 BlockDriverState
**bitmap_bs
, Error
**errp
);
2224 static void block_dirty_bitmap_remove_prepare(BlkActionState
*common
,
2227 BlockDirtyBitmap
*action
;
2228 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2231 if (action_check_completion_mode(common
, errp
) < 0) {
2235 action
= common
->action
->u
.block_dirty_bitmap_remove
.data
;
2237 state
->bitmap
= do_block_dirty_bitmap_remove(action
->node
, action
->name
,
2238 false, &state
->bs
, errp
);
2239 if (state
->bitmap
) {
2240 bdrv_dirty_bitmap_skip_store(state
->bitmap
, true);
2241 bdrv_dirty_bitmap_set_busy(state
->bitmap
, true);
2245 static void block_dirty_bitmap_remove_abort(BlkActionState
*common
)
2247 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2250 if (state
->bitmap
) {
2251 bdrv_dirty_bitmap_skip_store(state
->bitmap
, false);
2252 bdrv_dirty_bitmap_set_busy(state
->bitmap
, false);
2256 static void block_dirty_bitmap_remove_commit(BlkActionState
*common
)
2258 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2261 bdrv_dirty_bitmap_set_busy(state
->bitmap
, false);
2262 bdrv_release_dirty_bitmap(state
->bitmap
);
2265 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2267 error_setg(errp
, "Transaction aborted using Abort action");
2270 static void abort_commit(BlkActionState
*common
)
2272 g_assert_not_reached(); /* this action never succeeds */
2275 static const BlkActionOps actions
[] = {
2276 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2277 .instance_size
= sizeof(ExternalSnapshotState
),
2278 .prepare
= external_snapshot_prepare
,
2279 .commit
= external_snapshot_commit
,
2280 .abort
= external_snapshot_abort
,
2281 .clean
= external_snapshot_clean
,
2283 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2284 .instance_size
= sizeof(ExternalSnapshotState
),
2285 .prepare
= external_snapshot_prepare
,
2286 .commit
= external_snapshot_commit
,
2287 .abort
= external_snapshot_abort
,
2288 .clean
= external_snapshot_clean
,
2290 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2291 .instance_size
= sizeof(DriveBackupState
),
2292 .prepare
= drive_backup_prepare
,
2293 .commit
= drive_backup_commit
,
2294 .abort
= drive_backup_abort
,
2295 .clean
= drive_backup_clean
,
2297 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2298 .instance_size
= sizeof(BlockdevBackupState
),
2299 .prepare
= blockdev_backup_prepare
,
2300 .commit
= blockdev_backup_commit
,
2301 .abort
= blockdev_backup_abort
,
2302 .clean
= blockdev_backup_clean
,
2304 [TRANSACTION_ACTION_KIND_ABORT
] = {
2305 .instance_size
= sizeof(BlkActionState
),
2306 .prepare
= abort_prepare
,
2307 .commit
= abort_commit
,
2309 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2310 .instance_size
= sizeof(InternalSnapshotState
),
2311 .prepare
= internal_snapshot_prepare
,
2312 .abort
= internal_snapshot_abort
,
2313 .clean
= internal_snapshot_clean
,
2315 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2316 .instance_size
= sizeof(BlockDirtyBitmapState
),
2317 .prepare
= block_dirty_bitmap_add_prepare
,
2318 .abort
= block_dirty_bitmap_add_abort
,
2320 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2321 .instance_size
= sizeof(BlockDirtyBitmapState
),
2322 .prepare
= block_dirty_bitmap_clear_prepare
,
2323 .commit
= block_dirty_bitmap_free_backup
,
2324 .abort
= block_dirty_bitmap_restore
,
2326 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE
] = {
2327 .instance_size
= sizeof(BlockDirtyBitmapState
),
2328 .prepare
= block_dirty_bitmap_enable_prepare
,
2329 .abort
= block_dirty_bitmap_enable_abort
,
2331 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE
] = {
2332 .instance_size
= sizeof(BlockDirtyBitmapState
),
2333 .prepare
= block_dirty_bitmap_disable_prepare
,
2334 .abort
= block_dirty_bitmap_disable_abort
,
2336 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE
] = {
2337 .instance_size
= sizeof(BlockDirtyBitmapState
),
2338 .prepare
= block_dirty_bitmap_merge_prepare
,
2339 .commit
= block_dirty_bitmap_free_backup
,
2340 .abort
= block_dirty_bitmap_restore
,
2342 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE
] = {
2343 .instance_size
= sizeof(BlockDirtyBitmapState
),
2344 .prepare
= block_dirty_bitmap_remove_prepare
,
2345 .commit
= block_dirty_bitmap_remove_commit
,
2346 .abort
= block_dirty_bitmap_remove_abort
,
2348 /* Where are transactions for MIRROR, COMMIT and STREAM?
2349 * Although these blockjobs use transaction callbacks like the backup job,
2350 * these jobs do not necessarily adhere to transaction semantics.
2351 * These jobs may not fully undo all of their actions on abort, nor do they
2352 * necessarily work in transactions with more than one job in them.
2357 * Allocate a TransactionProperties structure if necessary, and fill
2358 * that structure with desired defaults if they are unset.
2360 static TransactionProperties
*get_transaction_properties(
2361 TransactionProperties
*props
)
2364 props
= g_new0(TransactionProperties
, 1);
2367 if (!props
->has_completion_mode
) {
2368 props
->has_completion_mode
= true;
2369 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2376 * 'Atomic' group operations. The operations are performed as a set, and if
2377 * any fail then we roll back all operations in the group.
2379 void qmp_transaction(TransactionActionList
*dev_list
,
2381 struct TransactionProperties
*props
,
2384 TransactionActionList
*dev_entry
= dev_list
;
2385 JobTxn
*block_job_txn
= NULL
;
2386 BlkActionState
*state
, *next
;
2387 Error
*local_err
= NULL
;
2389 QTAILQ_HEAD(, BlkActionState
) snap_bdrv_states
;
2390 QTAILQ_INIT(&snap_bdrv_states
);
2392 /* Does this transaction get canceled as a group on failure?
2393 * If not, we don't really need to make a JobTxn.
2395 props
= get_transaction_properties(props
);
2396 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2397 block_job_txn
= job_txn_new();
2400 /* drain all i/o before any operations */
2403 /* We don't do anything in this loop that commits us to the operations */
2404 while (NULL
!= dev_entry
) {
2405 TransactionAction
*dev_info
= NULL
;
2406 const BlkActionOps
*ops
;
2408 dev_info
= dev_entry
->value
;
2409 dev_entry
= dev_entry
->next
;
2411 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2413 ops
= &actions
[dev_info
->type
];
2414 assert(ops
->instance_size
> 0);
2416 state
= g_malloc0(ops
->instance_size
);
2418 state
->action
= dev_info
;
2419 state
->block_job_txn
= block_job_txn
;
2420 state
->txn_props
= props
;
2421 QTAILQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2423 state
->ops
->prepare(state
, &local_err
);
2425 error_propagate(errp
, local_err
);
2426 goto delete_and_fail
;
2430 QTAILQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2431 if (state
->ops
->commit
) {
2432 state
->ops
->commit(state
);
2440 /* failure, and it is all-or-none; roll back all operations */
2441 QTAILQ_FOREACH_REVERSE(state
, &snap_bdrv_states
, entry
) {
2442 if (state
->ops
->abort
) {
2443 state
->ops
->abort(state
);
2447 QTAILQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2448 if (state
->ops
->clean
) {
2449 state
->ops
->clean(state
);
2454 qapi_free_TransactionProperties(props
);
2456 job_txn_unref(block_job_txn
);
2459 void qmp_eject(bool has_device
, const char *device
,
2460 bool has_id
, const char *id
,
2461 bool has_force
, bool force
, Error
**errp
)
2463 Error
*local_err
= NULL
;
2470 rc
= do_open_tray(has_device
? device
: NULL
,
2473 if (rc
&& rc
!= -ENOSYS
) {
2474 error_propagate(errp
, local_err
);
2477 error_free(local_err
);
2479 blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2482 void qmp_block_passwd(bool has_device
, const char *device
,
2483 bool has_node_name
, const char *node_name
,
2484 const char *password
, Error
**errp
)
2487 "Setting block passwords directly is no longer supported");
2491 * Attempt to open the tray of @device.
2492 * If @force, ignore its tray lock.
2493 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2494 * On error, store an error through @errp and return -errno.
2495 * If @device does not exist, return -ENODEV.
2496 * If it has no removable media, return -ENOTSUP.
2497 * If it has no tray, return -ENOSYS.
2498 * If the guest was asked to open the tray, return -EINPROGRESS.
2501 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2502 bool force
, Error
**errp
)
2505 const char *device
= qdev_id
?: blk_name
;
2508 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2513 if (!blk_dev_has_removable_media(blk
)) {
2514 error_setg(errp
, "Device '%s' is not removable", device
);
2518 if (!blk_dev_has_tray(blk
)) {
2519 error_setg(errp
, "Device '%s' does not have a tray", device
);
2523 if (blk_dev_is_tray_open(blk
)) {
2527 locked
= blk_dev_is_medium_locked(blk
);
2529 blk_dev_eject_request(blk
, force
);
2532 if (!locked
|| force
) {
2533 blk_dev_change_media_cb(blk
, false, &error_abort
);
2536 if (locked
&& !force
) {
2537 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2538 "wait for tray to open and try again", device
);
2539 return -EINPROGRESS
;
2545 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2546 bool has_id
, const char *id
,
2547 bool has_force
, bool force
,
2550 Error
*local_err
= NULL
;
2556 rc
= do_open_tray(has_device
? device
: NULL
,
2559 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2560 error_propagate(errp
, local_err
);
2563 error_free(local_err
);
2566 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2567 bool has_id
, const char *id
,
2571 Error
*local_err
= NULL
;
2573 device
= has_device
? device
: NULL
;
2574 id
= has_id
? id
: NULL
;
2576 blk
= qmp_get_blk(device
, id
, errp
);
2581 if (!blk_dev_has_removable_media(blk
)) {
2582 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2586 if (!blk_dev_has_tray(blk
)) {
2587 /* Ignore this command on tray-less devices */
2591 if (!blk_dev_is_tray_open(blk
)) {
2595 blk_dev_change_media_cb(blk
, true, &local_err
);
2597 error_propagate(errp
, local_err
);
2602 static void blockdev_remove_medium(bool has_device
, const char *device
,
2603 bool has_id
, const char *id
, Error
**errp
)
2606 BlockDriverState
*bs
;
2607 AioContext
*aio_context
;
2608 bool has_attached_device
;
2610 device
= has_device
? device
: NULL
;
2611 id
= has_id
? id
: NULL
;
2613 blk
= qmp_get_blk(device
, id
, errp
);
2618 /* For BBs without a device, we can exchange the BDS tree at will */
2619 has_attached_device
= blk_get_attached_dev(blk
);
2621 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2622 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2626 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2627 !blk_dev_is_tray_open(blk
))
2629 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2638 aio_context
= bdrv_get_aio_context(bs
);
2639 aio_context_acquire(aio_context
);
2641 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2647 if (!blk_dev_has_tray(blk
)) {
2648 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2649 * called at all); therefore, the medium needs to be ejected here.
2650 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2651 * value passed here (i.e. false). */
2652 blk_dev_change_media_cb(blk
, false, &error_abort
);
2656 aio_context_release(aio_context
);
2659 void qmp_blockdev_remove_medium(const char *id
, Error
**errp
)
2661 blockdev_remove_medium(false, NULL
, true, id
, errp
);
2664 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2665 BlockDriverState
*bs
, Error
**errp
)
2667 Error
*local_err
= NULL
;
2671 /* For BBs without a device, we can exchange the BDS tree at will */
2672 has_device
= blk_get_attached_dev(blk
);
2674 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2675 error_setg(errp
, "Device is not removable");
2679 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2680 error_setg(errp
, "Tray of the device is not open");
2685 error_setg(errp
, "There already is a medium in the device");
2689 ret
= blk_insert_bs(blk
, bs
, errp
);
2694 if (!blk_dev_has_tray(blk
)) {
2695 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2696 * called at all); therefore, the medium needs to be pushed into the
2698 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2699 * value passed here (i.e. true). */
2700 blk_dev_change_media_cb(blk
, true, &local_err
);
2702 error_propagate(errp
, local_err
);
2709 static void blockdev_insert_medium(bool has_device
, const char *device
,
2710 bool has_id
, const char *id
,
2711 const char *node_name
, Error
**errp
)
2714 BlockDriverState
*bs
;
2716 blk
= qmp_get_blk(has_device
? device
: NULL
,
2723 bs
= bdrv_find_node(node_name
);
2725 error_setg(errp
, "Node '%s' not found", node_name
);
2729 if (bdrv_has_blk(bs
)) {
2730 error_setg(errp
, "Node '%s' is already in use", node_name
);
2734 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2737 void qmp_blockdev_insert_medium(const char *id
, const char *node_name
,
2740 blockdev_insert_medium(false, NULL
, true, id
, node_name
, errp
);
2743 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2744 bool has_id
, const char *id
,
2745 const char *filename
,
2746 bool has_format
, const char *format
,
2748 BlockdevChangeReadOnlyMode read_only
,
2752 BlockDriverState
*medium_bs
= NULL
;
2756 QDict
*options
= NULL
;
2759 blk
= qmp_get_blk(has_device
? device
: NULL
,
2767 blk_update_root_state(blk
);
2770 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2771 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2772 BDRV_O_PROTOCOL
| BDRV_O_AUTO_RDONLY
);
2774 if (!has_read_only
) {
2775 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2778 switch (read_only
) {
2779 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2782 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2783 bdrv_flags
&= ~BDRV_O_RDWR
;
2786 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2787 bdrv_flags
|= BDRV_O_RDWR
;
2794 options
= qdict_new();
2795 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2796 qdict_put_str(options
, "detect-zeroes", detect_zeroes
? "on" : "off");
2799 qdict_put_str(options
, "driver", format
);
2802 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2807 rc
= do_open_tray(has_device
? device
: NULL
,
2810 if (rc
&& rc
!= -ENOSYS
) {
2811 error_propagate(errp
, err
);
2817 blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2819 error_propagate(errp
, err
);
2823 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2825 error_propagate(errp
, err
);
2829 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2832 /* If the medium has been inserted, the device has its own reference, so
2833 * ours must be relinquished; and if it has not been inserted successfully,
2834 * the reference must be relinquished anyway */
2835 bdrv_unref(medium_bs
);
2838 /* throttling disk I/O limits */
2839 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2842 BlockDriverState
*bs
;
2844 AioContext
*aio_context
;
2846 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2847 arg
->has_id
? arg
->id
: NULL
,
2853 aio_context
= blk_get_aio_context(blk
);
2854 aio_context_acquire(aio_context
);
2858 error_setg(errp
, "Device has no medium");
2862 throttle_config_init(&cfg
);
2863 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2864 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2865 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2867 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2868 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2869 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2871 if (arg
->has_bps_max
) {
2872 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2874 if (arg
->has_bps_rd_max
) {
2875 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2877 if (arg
->has_bps_wr_max
) {
2878 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2880 if (arg
->has_iops_max
) {
2881 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2883 if (arg
->has_iops_rd_max
) {
2884 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2886 if (arg
->has_iops_wr_max
) {
2887 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2890 if (arg
->has_bps_max_length
) {
2891 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2893 if (arg
->has_bps_rd_max_length
) {
2894 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2896 if (arg
->has_bps_wr_max_length
) {
2897 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2899 if (arg
->has_iops_max_length
) {
2900 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2902 if (arg
->has_iops_rd_max_length
) {
2903 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2905 if (arg
->has_iops_wr_max_length
) {
2906 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2909 if (arg
->has_iops_size
) {
2910 cfg
.op_size
= arg
->iops_size
;
2913 if (!throttle_is_valid(&cfg
, errp
)) {
2917 if (throttle_enabled(&cfg
)) {
2918 /* Enable I/O limits if they're not enabled yet, otherwise
2919 * just update the throttling group. */
2920 if (!blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2921 blk_io_limits_enable(blk
,
2922 arg
->has_group
? arg
->group
:
2923 arg
->has_device
? arg
->device
:
2925 } else if (arg
->has_group
) {
2926 blk_io_limits_update_group(blk
, arg
->group
);
2928 /* Set the new throttling configuration */
2929 blk_set_io_limits(blk
, &cfg
);
2930 } else if (blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2931 /* If all throttling settings are set to 0, disable I/O limits */
2932 blk_io_limits_disable(blk
);
2936 aio_context_release(aio_context
);
2939 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2940 bool has_granularity
, uint32_t granularity
,
2941 bool has_persistent
, bool persistent
,
2942 bool has_disabled
, bool disabled
,
2945 BlockDriverState
*bs
;
2946 BdrvDirtyBitmap
*bitmap
;
2948 if (!name
|| name
[0] == '\0') {
2949 error_setg(errp
, "Bitmap name cannot be empty");
2953 bs
= bdrv_lookup_bs(node
, node
, errp
);
2958 if (has_granularity
) {
2959 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2960 error_setg(errp
, "Granularity must be power of 2 "
2961 "and at least 512");
2965 /* Default to cluster size, if available: */
2966 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2969 if (!has_persistent
) {
2973 if (!has_disabled
) {
2978 !bdrv_can_store_new_dirty_bitmap(bs
, name
, granularity
, errp
))
2983 bitmap
= bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2984 if (bitmap
== NULL
) {
2989 bdrv_disable_dirty_bitmap(bitmap
);
2992 bdrv_dirty_bitmap_set_persistence(bitmap
, persistent
);
2995 static BdrvDirtyBitmap
*do_block_dirty_bitmap_remove(
2996 const char *node
, const char *name
, bool release
,
2997 BlockDriverState
**bitmap_bs
, Error
**errp
)
2999 BlockDriverState
*bs
;
3000 BdrvDirtyBitmap
*bitmap
;
3002 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3003 if (!bitmap
|| !bs
) {
3007 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_BUSY
| BDRV_BITMAP_RO
,
3012 if (bdrv_dirty_bitmap_get_persistence(bitmap
) &&
3013 bdrv_remove_persistent_dirty_bitmap(bs
, name
, errp
) < 0)
3019 bdrv_release_dirty_bitmap(bitmap
);
3026 return release
? NULL
: bitmap
;
3029 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
3032 do_block_dirty_bitmap_remove(node
, name
, true, NULL
, errp
);
3036 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
3037 * immediately after a full backup operation.
3039 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
3042 BdrvDirtyBitmap
*bitmap
;
3043 BlockDriverState
*bs
;
3045 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3046 if (!bitmap
|| !bs
) {
3050 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_DEFAULT
, errp
)) {
3054 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
3057 void qmp_block_dirty_bitmap_enable(const char *node
, const char *name
,
3060 BlockDriverState
*bs
;
3061 BdrvDirtyBitmap
*bitmap
;
3063 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3068 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
3072 bdrv_enable_dirty_bitmap(bitmap
);
3075 void qmp_block_dirty_bitmap_disable(const char *node
, const char *name
,
3078 BlockDriverState
*bs
;
3079 BdrvDirtyBitmap
*bitmap
;
3081 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3086 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
3090 bdrv_disable_dirty_bitmap(bitmap
);
3093 static BdrvDirtyBitmap
*do_block_dirty_bitmap_merge(
3094 const char *node
, const char *target
,
3095 BlockDirtyBitmapMergeSourceList
*bitmaps
,
3096 HBitmap
**backup
, Error
**errp
)
3098 BlockDriverState
*bs
;
3099 BdrvDirtyBitmap
*dst
, *src
, *anon
;
3100 BlockDirtyBitmapMergeSourceList
*lst
;
3101 Error
*local_err
= NULL
;
3103 dst
= block_dirty_bitmap_lookup(node
, target
, &bs
, errp
);
3108 anon
= bdrv_create_dirty_bitmap(bs
, bdrv_dirty_bitmap_granularity(dst
),
3114 for (lst
= bitmaps
; lst
; lst
= lst
->next
) {
3115 switch (lst
->value
->type
) {
3116 const char *name
, *node
;
3118 name
= lst
->value
->u
.local
;
3119 src
= bdrv_find_dirty_bitmap(bs
, name
);
3121 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
3127 node
= lst
->value
->u
.external
.node
;
3128 name
= lst
->value
->u
.external
.name
;
3129 src
= block_dirty_bitmap_lookup(node
, name
, NULL
, errp
);
3139 bdrv_merge_dirty_bitmap(anon
, src
, NULL
, &local_err
);
3141 error_propagate(errp
, local_err
);
3147 /* Merge into dst; dst is unchanged on failure. */
3148 bdrv_merge_dirty_bitmap(dst
, anon
, backup
, errp
);
3151 bdrv_release_dirty_bitmap(anon
);
3155 void qmp_block_dirty_bitmap_merge(const char *node
, const char *target
,
3156 BlockDirtyBitmapMergeSourceList
*bitmaps
,
3159 do_block_dirty_bitmap_merge(node
, target
, bitmaps
, NULL
, errp
);
3162 BlockDirtyBitmapSha256
*qmp_x_debug_block_dirty_bitmap_sha256(const char *node
,
3166 BdrvDirtyBitmap
*bitmap
;
3167 BlockDriverState
*bs
;
3168 BlockDirtyBitmapSha256
*ret
= NULL
;
3171 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3172 if (!bitmap
|| !bs
) {
3176 sha256
= bdrv_dirty_bitmap_sha256(bitmap
, errp
);
3177 if (sha256
== NULL
) {
3181 ret
= g_new(BlockDirtyBitmapSha256
, 1);
3182 ret
->sha256
= sha256
;
3187 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
3189 const char *id
= qdict_get_str(qdict
, "id");
3191 BlockDriverState
*bs
;
3192 AioContext
*aio_context
;
3193 Error
*local_err
= NULL
;
3195 bs
= bdrv_find_node(id
);
3197 qmp_blockdev_del(id
, &local_err
);
3199 error_report_err(local_err
);
3204 blk
= blk_by_name(id
);
3206 error_report("Device '%s' not found", id
);
3210 if (!blk_legacy_dinfo(blk
)) {
3211 error_report("Deleting device added with blockdev-add"
3212 " is not supported");
3216 aio_context
= blk_get_aio_context(blk
);
3217 aio_context_acquire(aio_context
);
3221 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
3222 error_report_err(local_err
);
3223 aio_context_release(aio_context
);
3230 /* Make the BlockBackend and the attached BlockDriverState anonymous */
3231 monitor_remove_blk(blk
);
3233 /* If this BlockBackend has a device attached to it, its refcount will be
3234 * decremented when the device is removed; otherwise we have to do so here.
3236 if (blk_get_attached_dev(blk
)) {
3237 /* Further I/O must not pause the guest */
3238 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
3239 BLOCKDEV_ON_ERROR_REPORT
);
3244 aio_context_release(aio_context
);
3247 void qmp_block_resize(bool has_device
, const char *device
,
3248 bool has_node_name
, const char *node_name
,
3249 int64_t size
, Error
**errp
)
3251 Error
*local_err
= NULL
;
3252 BlockBackend
*blk
= NULL
;
3253 BlockDriverState
*bs
;
3254 AioContext
*aio_context
;
3257 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
3258 has_node_name
? node_name
: NULL
,
3261 error_propagate(errp
, local_err
);
3265 aio_context
= bdrv_get_aio_context(bs
);
3266 aio_context_acquire(aio_context
);
3268 if (!bdrv_is_first_non_filter(bs
)) {
3269 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
3274 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
3278 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
3279 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
3283 blk
= blk_new(bdrv_get_aio_context(bs
), BLK_PERM_RESIZE
, BLK_PERM_ALL
);
3284 ret
= blk_insert_bs(blk
, bs
, errp
);
3289 bdrv_drained_begin(bs
);
3290 ret
= blk_truncate(blk
, size
, false, PREALLOC_MODE_OFF
, errp
);
3291 bdrv_drained_end(bs
);
3295 aio_context_release(aio_context
);
3298 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
3299 bool has_base
, const char *base
,
3300 bool has_base_node
, const char *base_node
,
3301 bool has_backing_file
, const char *backing_file
,
3302 bool has_speed
, int64_t speed
,
3303 bool has_on_error
, BlockdevOnError on_error
,
3304 bool has_auto_finalize
, bool auto_finalize
,
3305 bool has_auto_dismiss
, bool auto_dismiss
,
3308 BlockDriverState
*bs
, *iter
;
3309 BlockDriverState
*base_bs
= NULL
;
3310 AioContext
*aio_context
;
3311 Error
*local_err
= NULL
;
3312 const char *base_name
= NULL
;
3313 int job_flags
= JOB_DEFAULT
;
3315 if (!has_on_error
) {
3316 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3319 bs
= bdrv_lookup_bs(device
, device
, errp
);
3324 aio_context
= bdrv_get_aio_context(bs
);
3325 aio_context_acquire(aio_context
);
3327 if (has_base
&& has_base_node
) {
3328 error_setg(errp
, "'base' and 'base-node' cannot be specified "
3329 "at the same time");
3334 base_bs
= bdrv_find_backing_image(bs
, base
);
3335 if (base_bs
== NULL
) {
3336 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
3339 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3343 if (has_base_node
) {
3344 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3348 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
3349 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
3353 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3354 bdrv_refresh_filename(base_bs
);
3355 base_name
= base_bs
->filename
;
3358 /* Check for op blockers in the whole chain between bs and base */
3359 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
3360 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3365 /* if we are streaming the entire chain, the result will have no backing
3366 * file, and specifying one is therefore an error */
3367 if (base_bs
== NULL
&& has_backing_file
) {
3368 error_setg(errp
, "backing file specified, but streaming the "
3373 /* backing_file string overrides base bs filename */
3374 base_name
= has_backing_file
? backing_file
: base_name
;
3376 if (has_auto_finalize
&& !auto_finalize
) {
3377 job_flags
|= JOB_MANUAL_FINALIZE
;
3379 if (has_auto_dismiss
&& !auto_dismiss
) {
3380 job_flags
|= JOB_MANUAL_DISMISS
;
3383 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
3384 job_flags
, has_speed
? speed
: 0, on_error
, &local_err
);
3386 error_propagate(errp
, local_err
);
3390 trace_qmp_block_stream(bs
);
3393 aio_context_release(aio_context
);
3396 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
3397 bool has_base_node
, const char *base_node
,
3398 bool has_base
, const char *base
,
3399 bool has_top_node
, const char *top_node
,
3400 bool has_top
, const char *top
,
3401 bool has_backing_file
, const char *backing_file
,
3402 bool has_speed
, int64_t speed
,
3403 bool has_filter_node_name
, const char *filter_node_name
,
3404 bool has_auto_finalize
, bool auto_finalize
,
3405 bool has_auto_dismiss
, bool auto_dismiss
,
3408 BlockDriverState
*bs
;
3409 BlockDriverState
*iter
;
3410 BlockDriverState
*base_bs
, *top_bs
;
3411 AioContext
*aio_context
;
3412 Error
*local_err
= NULL
;
3413 /* This will be part of the QMP command, if/when the
3414 * BlockdevOnError change for blkmirror makes it in
3416 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3417 int job_flags
= JOB_DEFAULT
;
3422 if (!has_filter_node_name
) {
3423 filter_node_name
= NULL
;
3425 if (has_auto_finalize
&& !auto_finalize
) {
3426 job_flags
|= JOB_MANUAL_FINALIZE
;
3428 if (has_auto_dismiss
&& !auto_dismiss
) {
3429 job_flags
|= JOB_MANUAL_DISMISS
;
3433 * libvirt relies on the DeviceNotFound error class in order to probe for
3434 * live commit feature versions; for this to work, we must make sure to
3435 * perform the device lookup before any generic errors that may occur in a
3436 * scenario in which all optional arguments are omitted. */
3437 bs
= qmp_get_root_bs(device
, &local_err
);
3439 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3441 error_free(local_err
);
3442 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3443 "Device '%s' not found", device
);
3445 error_propagate(errp
, local_err
);
3450 aio_context
= bdrv_get_aio_context(bs
);
3451 aio_context_acquire(aio_context
);
3453 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3457 /* default top_bs is the active layer */
3460 if (has_top_node
&& has_top
) {
3461 error_setg(errp
, "'top-node' and 'top' are mutually exclusive");
3463 } else if (has_top_node
) {
3464 top_bs
= bdrv_lookup_bs(NULL
, top_node
, errp
);
3465 if (top_bs
== NULL
) {
3468 if (!bdrv_chain_contains(bs
, top_bs
)) {
3469 error_setg(errp
, "'%s' is not in this backing file chain",
3473 } else if (has_top
&& top
) {
3474 /* This strcmp() is just a shortcut, there is no need to
3475 * refresh @bs's filename. If it mismatches,
3476 * bdrv_find_backing_image() will do the refresh and may still
3478 if (strcmp(bs
->filename
, top
) != 0) {
3479 top_bs
= bdrv_find_backing_image(bs
, top
);
3483 if (top_bs
== NULL
) {
3484 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3488 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3490 if (has_base_node
&& has_base
) {
3491 error_setg(errp
, "'base-node' and 'base' are mutually exclusive");
3493 } else if (has_base_node
) {
3494 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3495 if (base_bs
== NULL
) {
3498 if (!bdrv_chain_contains(top_bs
, base_bs
)) {
3499 error_setg(errp
, "'%s' is not in this backing file chain",
3503 } else if (has_base
&& base
) {
3504 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3506 base_bs
= bdrv_find_base(top_bs
);
3509 if (base_bs
== NULL
) {
3510 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3514 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3516 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
3517 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3522 /* Do not allow attempts to commit an image into itself */
3523 if (top_bs
== base_bs
) {
3524 error_setg(errp
, "cannot commit an image into itself");
3529 if (has_backing_file
) {
3530 error_setg(errp
, "'backing-file' specified,"
3531 " but 'top' is the active layer");
3534 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
3535 job_flags
, speed
, on_error
,
3536 filter_node_name
, NULL
, NULL
, false, &local_err
);
3538 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
3539 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3542 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, job_flags
,
3543 speed
, on_error
, has_backing_file
? backing_file
: NULL
,
3544 filter_node_name
, &local_err
);
3546 if (local_err
!= NULL
) {
3547 error_propagate(errp
, local_err
);
3552 aio_context_release(aio_context
);
3555 /* Common QMP interface for drive-backup and blockdev-backup */
3556 static BlockJob
*do_backup_common(BackupCommon
*backup
,
3557 BlockDriverState
*bs
,
3558 BlockDriverState
*target_bs
,
3559 AioContext
*aio_context
,
3560 JobTxn
*txn
, Error
**errp
)
3562 BlockJob
*job
= NULL
;
3563 BdrvDirtyBitmap
*bmap
= NULL
;
3564 int job_flags
= JOB_DEFAULT
;
3567 if (!backup
->has_speed
) {
3570 if (!backup
->has_on_source_error
) {
3571 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3573 if (!backup
->has_on_target_error
) {
3574 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3576 if (!backup
->has_job_id
) {
3577 backup
->job_id
= NULL
;
3579 if (!backup
->has_auto_finalize
) {
3580 backup
->auto_finalize
= true;
3582 if (!backup
->has_auto_dismiss
) {
3583 backup
->auto_dismiss
= true;
3585 if (!backup
->has_compress
) {
3586 backup
->compress
= false;
3589 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
3594 if ((backup
->sync
== MIRROR_SYNC_MODE_BITMAP
) ||
3595 (backup
->sync
== MIRROR_SYNC_MODE_INCREMENTAL
)) {
3596 /* done before desugaring 'incremental' to print the right message */
3597 if (!backup
->has_bitmap
) {
3598 error_setg(errp
, "must provide a valid bitmap name for "
3599 "'%s' sync mode", MirrorSyncMode_str(backup
->sync
));
3604 if (backup
->sync
== MIRROR_SYNC_MODE_INCREMENTAL
) {
3605 if (backup
->has_bitmap_mode
&&
3606 backup
->bitmap_mode
!= BITMAP_SYNC_MODE_ON_SUCCESS
) {
3607 error_setg(errp
, "Bitmap sync mode must be '%s' "
3608 "when using sync mode '%s'",
3609 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS
),
3610 MirrorSyncMode_str(backup
->sync
));
3613 backup
->has_bitmap_mode
= true;
3614 backup
->sync
= MIRROR_SYNC_MODE_BITMAP
;
3615 backup
->bitmap_mode
= BITMAP_SYNC_MODE_ON_SUCCESS
;
3618 if (backup
->has_bitmap
) {
3619 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3621 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3624 if (!backup
->has_bitmap_mode
) {
3625 error_setg(errp
, "Bitmap sync mode must be given "
3626 "when providing a bitmap");
3629 if (bdrv_dirty_bitmap_check(bmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
3633 /* This does not produce a useful bitmap artifact: */
3634 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3635 error_setg(errp
, "sync mode '%s' does not produce meaningful bitmap"
3636 " outputs", MirrorSyncMode_str(backup
->sync
));
3640 /* If the bitmap isn't used for input or output, this is useless: */
3641 if (backup
->bitmap_mode
== BITMAP_SYNC_MODE_NEVER
&&
3642 backup
->sync
!= MIRROR_SYNC_MODE_BITMAP
) {
3643 error_setg(errp
, "Bitmap sync mode '%s' has no meaningful effect"
3644 " when combined with sync mode '%s'",
3645 BitmapSyncMode_str(backup
->bitmap_mode
),
3646 MirrorSyncMode_str(backup
->sync
));
3651 if (!backup
->has_bitmap
&& backup
->has_bitmap_mode
) {
3652 error_setg(errp
, "Cannot specify bitmap sync mode without a bitmap");
3656 if (!backup
->auto_finalize
) {
3657 job_flags
|= JOB_MANUAL_FINALIZE
;
3659 if (!backup
->auto_dismiss
) {
3660 job_flags
|= JOB_MANUAL_DISMISS
;
3663 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3664 backup
->sync
, bmap
, backup
->bitmap_mode
,
3666 backup
->filter_node_name
,
3667 backup
->on_source_error
,
3668 backup
->on_target_error
,
3669 job_flags
, NULL
, NULL
, txn
, errp
);
3673 void qmp_drive_backup(DriveBackup
*backup
, Error
**errp
)
3675 TransactionAction action
= {
3676 .type
= TRANSACTION_ACTION_KIND_DRIVE_BACKUP
,
3677 .u
.drive_backup
.data
= backup
,
3679 blockdev_do_action(&action
, errp
);
3682 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3684 return bdrv_named_nodes_list(errp
);
3687 XDbgBlockGraph
*qmp_x_debug_query_block_graph(Error
**errp
)
3689 return bdrv_get_xdbg_block_graph(errp
);
3692 void qmp_blockdev_backup(BlockdevBackup
*backup
, Error
**errp
)
3694 TransactionAction action
= {
3695 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
,
3696 .u
.blockdev_backup
.data
= backup
,
3698 blockdev_do_action(&action
, errp
);
3701 /* Parameter check and block job starting for drive mirroring.
3702 * Caller should hold @device and @target's aio context (must be the same).
3704 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3705 BlockDriverState
*target
,
3706 bool has_replaces
, const char *replaces
,
3707 enum MirrorSyncMode sync
,
3708 BlockMirrorBackingMode backing_mode
,
3710 bool has_speed
, int64_t speed
,
3711 bool has_granularity
, uint32_t granularity
,
3712 bool has_buf_size
, int64_t buf_size
,
3713 bool has_on_source_error
,
3714 BlockdevOnError on_source_error
,
3715 bool has_on_target_error
,
3716 BlockdevOnError on_target_error
,
3717 bool has_unmap
, bool unmap
,
3718 bool has_filter_node_name
,
3719 const char *filter_node_name
,
3720 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3721 bool has_auto_finalize
, bool auto_finalize
,
3722 bool has_auto_dismiss
, bool auto_dismiss
,
3725 int job_flags
= JOB_DEFAULT
;
3730 if (!has_on_source_error
) {
3731 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3733 if (!has_on_target_error
) {
3734 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3736 if (!has_granularity
) {
3739 if (!has_buf_size
) {
3745 if (!has_filter_node_name
) {
3746 filter_node_name
= NULL
;
3748 if (!has_copy_mode
) {
3749 copy_mode
= MIRROR_COPY_MODE_BACKGROUND
;
3751 if (has_auto_finalize
&& !auto_finalize
) {
3752 job_flags
|= JOB_MANUAL_FINALIZE
;
3754 if (has_auto_dismiss
&& !auto_dismiss
) {
3755 job_flags
|= JOB_MANUAL_DISMISS
;
3758 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3759 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3760 "a value in range [512B, 64MB]");
3763 if (granularity
& (granularity
- 1)) {
3764 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3769 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3772 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3776 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3777 sync
= MIRROR_SYNC_MODE_FULL
;
3781 BlockDriverState
*to_replace_bs
;
3782 AioContext
*replace_aio_context
;
3783 int64_t bs_size
, replace_size
;
3785 bs_size
= bdrv_getlength(bs
);
3787 error_setg_errno(errp
, -bs_size
, "Failed to query device's size");
3791 to_replace_bs
= check_to_replace_node(bs
, replaces
, errp
);
3792 if (!to_replace_bs
) {
3796 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3797 aio_context_acquire(replace_aio_context
);
3798 replace_size
= bdrv_getlength(to_replace_bs
);
3799 aio_context_release(replace_aio_context
);
3801 if (replace_size
< 0) {
3802 error_setg_errno(errp
, -replace_size
,
3803 "Failed to query the replacement node's size");
3806 if (bs_size
!= replace_size
) {
3807 error_setg(errp
, "cannot replace image with a mirror image of "
3813 /* pass the node name to replace to mirror start since it's loose coupling
3814 * and will allow to check whether the node still exist at mirror completion
3816 mirror_start(job_id
, bs
, target
,
3817 has_replaces
? replaces
: NULL
, job_flags
,
3818 speed
, granularity
, buf_size
, sync
, backing_mode
, zero_target
,
3819 on_source_error
, on_target_error
, unmap
, filter_node_name
,
3823 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3825 BlockDriverState
*bs
;
3826 BlockDriverState
*source
, *target_bs
;
3827 AioContext
*aio_context
;
3828 BlockMirrorBackingMode backing_mode
;
3829 Error
*local_err
= NULL
;
3830 QDict
*options
= NULL
;
3833 const char *format
= arg
->format
;
3837 bs
= qmp_get_root_bs(arg
->device
, errp
);
3842 /* Early check to avoid creating target */
3843 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3847 aio_context
= bdrv_get_aio_context(bs
);
3848 aio_context_acquire(aio_context
);
3850 if (!arg
->has_mode
) {
3851 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3854 if (!arg
->has_format
) {
3855 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3856 ? NULL
: bs
->drv
->format_name
);
3859 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3860 source
= backing_bs(bs
);
3861 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3862 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3864 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3868 size
= bdrv_getlength(bs
);
3870 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3874 if (arg
->has_replaces
) {
3875 if (!arg
->has_node_name
) {
3876 error_setg(errp
, "a node-name must be provided when replacing a"
3877 " named node of the graph");
3882 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3883 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3885 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3888 /* Don't open backing image in create() */
3889 flags
|= BDRV_O_NO_BACKING
;
3891 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3892 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3894 /* create new image w/o backing file */
3896 bdrv_img_create(arg
->target
, format
,
3897 NULL
, NULL
, NULL
, size
, flags
, false, &local_err
);
3899 switch (arg
->mode
) {
3900 case NEW_IMAGE_MODE_EXISTING
:
3902 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3903 /* create new image with backing file */
3904 bdrv_refresh_filename(source
);
3905 bdrv_img_create(arg
->target
, format
,
3907 source
->drv
->format_name
,
3908 NULL
, size
, flags
, false, &local_err
);
3916 error_propagate(errp
, local_err
);
3920 options
= qdict_new();
3921 if (arg
->has_node_name
) {
3922 qdict_put_str(options
, "node-name", arg
->node_name
);
3925 qdict_put_str(options
, "driver", format
);
3928 /* Mirroring takes care of copy-on-write using the source's backing
3931 target_bs
= bdrv_open(arg
->target
, NULL
, options
, flags
, errp
);
3936 zero_target
= (arg
->sync
== MIRROR_SYNC_MODE_FULL
&&
3937 (arg
->mode
== NEW_IMAGE_MODE_EXISTING
||
3938 !bdrv_has_zero_init(target_bs
)));
3940 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
3942 bdrv_unref(target_bs
);
3946 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3947 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3948 backing_mode
, zero_target
,
3949 arg
->has_speed
, arg
->speed
,
3950 arg
->has_granularity
, arg
->granularity
,
3951 arg
->has_buf_size
, arg
->buf_size
,
3952 arg
->has_on_source_error
, arg
->on_source_error
,
3953 arg
->has_on_target_error
, arg
->on_target_error
,
3954 arg
->has_unmap
, arg
->unmap
,
3956 arg
->has_copy_mode
, arg
->copy_mode
,
3957 arg
->has_auto_finalize
, arg
->auto_finalize
,
3958 arg
->has_auto_dismiss
, arg
->auto_dismiss
,
3960 bdrv_unref(target_bs
);
3961 error_propagate(errp
, local_err
);
3963 aio_context_release(aio_context
);
3966 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3967 const char *device
, const char *target
,
3968 bool has_replaces
, const char *replaces
,
3969 MirrorSyncMode sync
,
3970 bool has_speed
, int64_t speed
,
3971 bool has_granularity
, uint32_t granularity
,
3972 bool has_buf_size
, int64_t buf_size
,
3973 bool has_on_source_error
,
3974 BlockdevOnError on_source_error
,
3975 bool has_on_target_error
,
3976 BlockdevOnError on_target_error
,
3977 bool has_filter_node_name
,
3978 const char *filter_node_name
,
3979 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3980 bool has_auto_finalize
, bool auto_finalize
,
3981 bool has_auto_dismiss
, bool auto_dismiss
,
3984 BlockDriverState
*bs
;
3985 BlockDriverState
*target_bs
;
3986 AioContext
*aio_context
;
3987 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3988 Error
*local_err
= NULL
;
3992 bs
= qmp_get_root_bs(device
, errp
);
3997 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
4002 zero_target
= (sync
== MIRROR_SYNC_MODE_FULL
);
4004 aio_context
= bdrv_get_aio_context(bs
);
4005 aio_context_acquire(aio_context
);
4007 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
4012 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
4013 has_replaces
, replaces
, sync
, backing_mode
,
4014 zero_target
, has_speed
, speed
,
4015 has_granularity
, granularity
,
4016 has_buf_size
, buf_size
,
4017 has_on_source_error
, on_source_error
,
4018 has_on_target_error
, on_target_error
,
4020 has_filter_node_name
, filter_node_name
,
4021 has_copy_mode
, copy_mode
,
4022 has_auto_finalize
, auto_finalize
,
4023 has_auto_dismiss
, auto_dismiss
,
4025 error_propagate(errp
, local_err
);
4027 aio_context_release(aio_context
);
4030 /* Get a block job using its ID and acquire its AioContext */
4031 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
4038 *aio_context
= NULL
;
4040 job
= block_job_get(id
);
4043 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
4044 "Block job '%s' not found", id
);
4048 *aio_context
= blk_get_aio_context(job
->blk
);
4049 aio_context_acquire(*aio_context
);
4054 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
4056 AioContext
*aio_context
;
4057 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4063 block_job_set_speed(job
, speed
, errp
);
4064 aio_context_release(aio_context
);
4067 void qmp_block_job_cancel(const char *device
,
4068 bool has_force
, bool force
, Error
**errp
)
4070 AioContext
*aio_context
;
4071 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4081 if (job_user_paused(&job
->job
) && !force
) {
4082 error_setg(errp
, "The block job for device '%s' is currently paused",
4087 trace_qmp_block_job_cancel(job
);
4088 job_user_cancel(&job
->job
, force
, errp
);
4090 aio_context_release(aio_context
);
4093 void qmp_block_job_pause(const char *device
, Error
**errp
)
4095 AioContext
*aio_context
;
4096 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4102 trace_qmp_block_job_pause(job
);
4103 job_user_pause(&job
->job
, errp
);
4104 aio_context_release(aio_context
);
4107 void qmp_block_job_resume(const char *device
, Error
**errp
)
4109 AioContext
*aio_context
;
4110 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4116 trace_qmp_block_job_resume(job
);
4117 job_user_resume(&job
->job
, errp
);
4118 aio_context_release(aio_context
);
4121 void qmp_block_job_complete(const char *device
, Error
**errp
)
4123 AioContext
*aio_context
;
4124 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4130 trace_qmp_block_job_complete(job
);
4131 job_complete(&job
->job
, errp
);
4132 aio_context_release(aio_context
);
4135 void qmp_block_job_finalize(const char *id
, Error
**errp
)
4137 AioContext
*aio_context
;
4138 BlockJob
*job
= find_block_job(id
, &aio_context
, errp
);
4144 trace_qmp_block_job_finalize(job
);
4145 job_finalize(&job
->job
, errp
);
4146 aio_context_release(aio_context
);
4149 void qmp_block_job_dismiss(const char *id
, Error
**errp
)
4151 AioContext
*aio_context
;
4152 BlockJob
*bjob
= find_block_job(id
, &aio_context
, errp
);
4159 trace_qmp_block_job_dismiss(bjob
);
4161 job_dismiss(&job
, errp
);
4162 aio_context_release(aio_context
);
4165 void qmp_change_backing_file(const char *device
,
4166 const char *image_node_name
,
4167 const char *backing_file
,
4170 BlockDriverState
*bs
= NULL
;
4171 AioContext
*aio_context
;
4172 BlockDriverState
*image_bs
= NULL
;
4173 Error
*local_err
= NULL
;
4177 bs
= qmp_get_root_bs(device
, errp
);
4182 aio_context
= bdrv_get_aio_context(bs
);
4183 aio_context_acquire(aio_context
);
4185 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
4187 error_propagate(errp
, local_err
);
4192 error_setg(errp
, "image file not found");
4196 if (bdrv_find_base(image_bs
) == image_bs
) {
4197 error_setg(errp
, "not allowing backing file change on an image "
4198 "without a backing file");
4202 /* even though we are not necessarily operating on bs, we need it to
4203 * determine if block ops are currently prohibited on the chain */
4204 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
4208 /* final sanity check */
4209 if (!bdrv_chain_contains(bs
, image_bs
)) {
4210 error_setg(errp
, "'%s' and image file are not in the same chain",
4215 /* if not r/w, reopen to make r/w */
4216 ro
= bdrv_is_read_only(image_bs
);
4219 if (bdrv_reopen_set_read_only(image_bs
, false, errp
) != 0) {
4224 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
4225 image_bs
->drv
? image_bs
->drv
->format_name
: "");
4228 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
4230 /* don't exit here, so we can try to restore open flags if
4235 bdrv_reopen_set_read_only(image_bs
, true, &local_err
);
4236 error_propagate(errp
, local_err
);
4240 aio_context_release(aio_context
);
4243 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
4247 Error
*local_err
= NULL
;
4249 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
4254 qdict
= qemu_opts_to_qdict(opts
, NULL
);
4256 if (!qdict_get_try_str(qdict
, "node-name")) {
4257 qobject_unref(qdict
);
4258 error_report("'node-name' needs to be specified");
4262 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
4264 error_report_err(local_err
);
4268 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4271 qemu_opts_del(opts
);
4274 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
4276 BlockDriverState
*bs
;
4278 Visitor
*v
= qobject_output_visitor_new(&obj
);
4280 Error
*local_err
= NULL
;
4282 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
4284 error_propagate(errp
, local_err
);
4288 visit_complete(v
, &obj
);
4289 qdict
= qobject_to(QDict
, obj
);
4291 qdict_flatten(qdict
);
4293 if (!qdict_get_try_str(qdict
, "node-name")) {
4294 error_setg(errp
, "'node-name' must be specified for the root node");
4298 bs
= bds_tree_init(qdict
, errp
);
4303 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4309 void qmp_x_blockdev_reopen(BlockdevOptions
*options
, Error
**errp
)
4311 BlockDriverState
*bs
;
4314 Visitor
*v
= qobject_output_visitor_new(&obj
);
4315 Error
*local_err
= NULL
;
4316 BlockReopenQueue
*queue
;
4319 /* Check for the selected node name */
4320 if (!options
->has_node_name
) {
4321 error_setg(errp
, "Node name not specified");
4325 bs
= bdrv_find_node(options
->node_name
);
4327 error_setg(errp
, "Cannot find node named '%s'", options
->node_name
);
4331 /* Put all options in a QDict and flatten it */
4332 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
4334 error_propagate(errp
, local_err
);
4338 visit_complete(v
, &obj
);
4339 qdict
= qobject_to(QDict
, obj
);
4341 qdict_flatten(qdict
);
4343 /* Perform the reopen operation */
4344 ctx
= bdrv_get_aio_context(bs
);
4345 aio_context_acquire(ctx
);
4346 bdrv_subtree_drained_begin(bs
);
4347 queue
= bdrv_reopen_queue(NULL
, bs
, qdict
, false);
4348 bdrv_reopen_multiple(queue
, errp
);
4349 bdrv_subtree_drained_end(bs
);
4350 aio_context_release(ctx
);
4356 void qmp_blockdev_del(const char *node_name
, Error
**errp
)
4358 AioContext
*aio_context
;
4359 BlockDriverState
*bs
;
4361 bs
= bdrv_find_node(node_name
);
4363 error_setg(errp
, "Cannot find node %s", node_name
);
4366 if (bdrv_has_blk(bs
)) {
4367 error_setg(errp
, "Node %s is in use", node_name
);
4370 aio_context
= bdrv_get_aio_context(bs
);
4371 aio_context_acquire(aio_context
);
4373 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
4377 if (!QTAILQ_IN_USE(bs
, monitor_list
)) {
4378 error_setg(errp
, "Node %s is not owned by the monitor",
4383 if (bs
->refcnt
> 1) {
4384 error_setg(errp
, "Block device %s is in use",
4385 bdrv_get_device_or_node_name(bs
));
4389 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
4393 aio_context_release(aio_context
);
4396 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
4397 const char *child_name
)
4401 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
4402 if (strcmp(child
->name
, child_name
) == 0) {
4410 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
4411 const char *child
, bool has_node
,
4412 const char *node
, Error
**errp
)
4414 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
4417 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
4422 if (has_child
== has_node
) {
4424 error_setg(errp
, "The parameters child and node are in conflict");
4426 error_setg(errp
, "Either child or node must be specified");
4432 p_child
= bdrv_find_child(parent_bs
, child
);
4434 error_setg(errp
, "Node '%s' does not have child '%s'",
4438 bdrv_del_child(parent_bs
, p_child
, errp
);
4442 new_bs
= bdrv_find_node(node
);
4444 error_setg(errp
, "Node '%s' not found", node
);
4447 bdrv_add_child(parent_bs
, new_bs
, errp
);
4451 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
4453 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
4456 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
4457 BlockJobInfoList
*elem
;
4458 AioContext
*aio_context
;
4460 if (block_job_is_internal(job
)) {
4463 elem
= g_new0(BlockJobInfoList
, 1);
4464 aio_context
= blk_get_aio_context(job
->blk
);
4465 aio_context_acquire(aio_context
);
4466 elem
->value
= block_job_query(job
, errp
);
4467 aio_context_release(aio_context
);
4470 qapi_free_BlockJobInfoList(head
);
4474 p_next
= &elem
->next
;
4480 void qmp_x_blockdev_set_iothread(const char *node_name
, StrOrNull
*iothread
,
4481 bool has_force
, bool force
, Error
**errp
)
4483 AioContext
*old_context
;
4484 AioContext
*new_context
;
4485 BlockDriverState
*bs
;
4487 bs
= bdrv_find_node(node_name
);
4489 error_setg(errp
, "Cannot find node %s", node_name
);
4493 /* Protects against accidents. */
4494 if (!(has_force
&& force
) && bdrv_has_blk(bs
)) {
4495 error_setg(errp
, "Node %s is associated with a BlockBackend and could "
4496 "be in use (use force=true to override this check)",
4501 if (iothread
->type
== QTYPE_QSTRING
) {
4502 IOThread
*obj
= iothread_by_id(iothread
->u
.s
);
4504 error_setg(errp
, "Cannot find iothread %s", iothread
->u
.s
);
4508 new_context
= iothread_get_aio_context(obj
);
4510 new_context
= qemu_get_aio_context();
4513 old_context
= bdrv_get_aio_context(bs
);
4514 aio_context_acquire(old_context
);
4516 bdrv_try_set_aio_context(bs
, new_context
, errp
);
4518 aio_context_release(old_context
);
4521 void qmp_block_latency_histogram_set(
4523 bool has_boundaries
, uint64List
*boundaries
,
4524 bool has_boundaries_read
, uint64List
*boundaries_read
,
4525 bool has_boundaries_write
, uint64List
*boundaries_write
,
4526 bool has_boundaries_flush
, uint64List
*boundaries_flush
,
4529 BlockBackend
*blk
= qmp_get_blk(NULL
, id
, errp
);
4530 BlockAcctStats
*stats
;
4537 stats
= blk_get_stats(blk
);
4539 if (!has_boundaries
&& !has_boundaries_read
&& !has_boundaries_write
&&
4540 !has_boundaries_flush
)
4542 block_latency_histograms_clear(stats
);
4546 if (has_boundaries
|| has_boundaries_read
) {
4547 ret
= block_latency_histogram_set(
4548 stats
, BLOCK_ACCT_READ
,
4549 has_boundaries_read
? boundaries_read
: boundaries
);
4551 error_setg(errp
, "Device '%s' set read boundaries fail", id
);
4556 if (has_boundaries
|| has_boundaries_write
) {
4557 ret
= block_latency_histogram_set(
4558 stats
, BLOCK_ACCT_WRITE
,
4559 has_boundaries_write
? boundaries_write
: boundaries
);
4561 error_setg(errp
, "Device '%s' set write boundaries fail", id
);
4566 if (has_boundaries
|| has_boundaries_flush
) {
4567 ret
= block_latency_histogram_set(
4568 stats
, BLOCK_ACCT_FLUSH
,
4569 has_boundaries_flush
? boundaries_flush
: boundaries
);
4571 error_setg(errp
, "Device '%s' set flush boundaries fail", id
);
4577 QemuOptsList qemu_common_drive_opts
= {
4579 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4583 .type
= QEMU_OPT_BOOL
,
4584 .help
= "enable/disable snapshot mode",
4587 .type
= QEMU_OPT_STRING
,
4588 .help
= "host AIO implementation (threads, native)",
4590 .name
= BDRV_OPT_CACHE_WB
,
4591 .type
= QEMU_OPT_BOOL
,
4592 .help
= "Enable writeback mode",
4595 .type
= QEMU_OPT_STRING
,
4596 .help
= "disk format (raw, qcow2, ...)",
4599 .type
= QEMU_OPT_STRING
,
4600 .help
= "read error action",
4603 .type
= QEMU_OPT_STRING
,
4604 .help
= "write error action",
4606 .name
= BDRV_OPT_READ_ONLY
,
4607 .type
= QEMU_OPT_BOOL
,
4608 .help
= "open drive file as read-only",
4614 .name
= "throttling.group",
4615 .type
= QEMU_OPT_STRING
,
4616 .help
= "name of the block throttling group",
4618 .name
= "copy-on-read",
4619 .type
= QEMU_OPT_BOOL
,
4620 .help
= "copy read data from backing file into image file",
4622 .name
= "detect-zeroes",
4623 .type
= QEMU_OPT_STRING
,
4624 .help
= "try to optimize zero writes (off, on, unmap)",
4626 .name
= "stats-account-invalid",
4627 .type
= QEMU_OPT_BOOL
,
4628 .help
= "whether to account for invalid I/O operations "
4629 "in the statistics",
4631 .name
= "stats-account-failed",
4632 .type
= QEMU_OPT_BOOL
,
4633 .help
= "whether to account for failed I/O operations "
4634 "in the statistics",
4636 { /* end of list */ }
4640 QemuOptsList qemu_drive_opts
= {
4642 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4645 * no elements => accept any params
4646 * validation will happen later
4648 { /* end of list */ }