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 monitor_printf(mon
, "Device '%s' not found\n", device
);
1094 if (!blk_is_available(blk
)) {
1095 monitor_printf(mon
, "Device '%s' has no medium\n", 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 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1113 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1115 TransactionActionList list
;
1117 list
.value
= action
;
1119 qmp_transaction(&list
, false, NULL
, errp
);
1122 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1123 bool has_node_name
, const char *node_name
,
1124 const char *snapshot_file
,
1125 bool has_snapshot_node_name
,
1126 const char *snapshot_node_name
,
1127 bool has_format
, const char *format
,
1128 bool has_mode
, NewImageMode mode
, Error
**errp
)
1130 BlockdevSnapshotSync snapshot
= {
1131 .has_device
= has_device
,
1132 .device
= (char *) device
,
1133 .has_node_name
= has_node_name
,
1134 .node_name
= (char *) node_name
,
1135 .snapshot_file
= (char *) snapshot_file
,
1136 .has_snapshot_node_name
= has_snapshot_node_name
,
1137 .snapshot_node_name
= (char *) snapshot_node_name
,
1138 .has_format
= has_format
,
1139 .format
= (char *) format
,
1140 .has_mode
= has_mode
,
1143 TransactionAction action
= {
1144 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1145 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1147 blockdev_do_action(&action
, errp
);
1150 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1153 BlockdevSnapshot snapshot_data
= {
1154 .node
= (char *) node
,
1155 .overlay
= (char *) overlay
1157 TransactionAction action
= {
1158 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1159 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1161 blockdev_do_action(&action
, errp
);
1164 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1168 BlockdevSnapshotInternal snapshot
= {
1169 .device
= (char *) device
,
1170 .name
= (char *) name
1172 TransactionAction action
= {
1173 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1174 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1176 blockdev_do_action(&action
, errp
);
1179 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1186 BlockDriverState
*bs
;
1187 AioContext
*aio_context
;
1188 QEMUSnapshotInfo sn
;
1189 Error
*local_err
= NULL
;
1190 SnapshotInfo
*info
= NULL
;
1193 bs
= qmp_get_root_bs(device
, errp
);
1197 aio_context
= bdrv_get_aio_context(bs
);
1198 aio_context_acquire(aio_context
);
1209 error_setg(errp
, "Name or id must be provided");
1210 goto out_aio_context
;
1213 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1214 goto out_aio_context
;
1217 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1219 error_propagate(errp
, local_err
);
1220 goto out_aio_context
;
1224 "Snapshot with id '%s' and name '%s' does not exist on "
1226 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1227 goto out_aio_context
;
1230 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1232 error_propagate(errp
, local_err
);
1233 goto out_aio_context
;
1236 aio_context_release(aio_context
);
1238 info
= g_new0(SnapshotInfo
, 1);
1239 info
->id
= g_strdup(sn
.id_str
);
1240 info
->name
= g_strdup(sn
.name
);
1241 info
->date_nsec
= sn
.date_nsec
;
1242 info
->date_sec
= sn
.date_sec
;
1243 info
->vm_state_size
= sn
.vm_state_size
;
1244 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1245 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1250 aio_context_release(aio_context
);
1255 * block_dirty_bitmap_lookup:
1256 * Return a dirty bitmap (if present), after validating
1257 * the node reference and bitmap names.
1259 * @node: The name of the BDS node to search for bitmaps
1260 * @name: The name of the bitmap to search for
1261 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1262 * @errp: Output pointer for error information. Can be NULL.
1264 * @return: A bitmap object on success, or NULL on failure.
1266 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1268 BlockDriverState
**pbs
,
1271 BlockDriverState
*bs
;
1272 BdrvDirtyBitmap
*bitmap
;
1275 error_setg(errp
, "Node cannot be NULL");
1279 error_setg(errp
, "Bitmap name cannot be NULL");
1282 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1284 error_setg(errp
, "Node '%s' not found", node
);
1288 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1290 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1301 /* New and old BlockDriverState structs for atomic group operations */
1303 typedef struct BlkActionState BlkActionState
;
1307 * Table of operations that define an Action.
1309 * @instance_size: Size of state struct, in bytes.
1310 * @prepare: Prepare the work, must NOT be NULL.
1311 * @commit: Commit the changes, can be NULL.
1312 * @abort: Abort the changes on fail, can be NULL.
1313 * @clean: Clean up resources after all transaction actions have called
1314 * commit() or abort(). Can be NULL.
1316 * Only prepare() may fail. In a single transaction, only one of commit() or
1317 * abort() will be called. clean() will always be called if it is present.
1319 typedef struct BlkActionOps
{
1320 size_t instance_size
;
1321 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1322 void (*commit
)(BlkActionState
*common
);
1323 void (*abort
)(BlkActionState
*common
);
1324 void (*clean
)(BlkActionState
*common
);
1329 * Describes one Action's state within a Transaction.
1331 * @action: QAPI-defined enum identifying which Action to perform.
1332 * @ops: Table of ActionOps this Action can perform.
1333 * @block_job_txn: Transaction which this action belongs to.
1334 * @entry: List membership for all Actions in this Transaction.
1336 * This structure must be arranged as first member in a subclassed type,
1337 * assuming that the compiler will also arrange it to the same offsets as the
1340 struct BlkActionState
{
1341 TransactionAction
*action
;
1342 const BlkActionOps
*ops
;
1343 JobTxn
*block_job_txn
;
1344 TransactionProperties
*txn_props
;
1345 QTAILQ_ENTRY(BlkActionState
) entry
;
1348 /* internal snapshot private data */
1349 typedef struct InternalSnapshotState
{
1350 BlkActionState common
;
1351 BlockDriverState
*bs
;
1352 QEMUSnapshotInfo sn
;
1354 } InternalSnapshotState
;
1357 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1359 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1361 "Action '%s' does not support Transaction property "
1362 "completion-mode = %s",
1363 TransactionActionKind_str(s
->action
->type
),
1364 ActionCompletionMode_str(s
->txn_props
->completion_mode
));
1370 static void internal_snapshot_prepare(BlkActionState
*common
,
1373 Error
*local_err
= NULL
;
1376 BlockDriverState
*bs
;
1377 QEMUSnapshotInfo old_sn
, *sn
;
1380 BlockdevSnapshotInternal
*internal
;
1381 InternalSnapshotState
*state
;
1382 AioContext
*aio_context
;
1385 g_assert(common
->action
->type
==
1386 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1387 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1388 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1390 /* 1. parse input */
1391 device
= internal
->device
;
1392 name
= internal
->name
;
1394 /* 2. check for validation */
1395 if (action_check_completion_mode(common
, errp
) < 0) {
1399 bs
= qmp_get_root_bs(device
, errp
);
1404 aio_context
= bdrv_get_aio_context(bs
);
1405 aio_context_acquire(aio_context
);
1409 /* Paired with .clean() */
1410 bdrv_drained_begin(bs
);
1412 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1416 if (bdrv_is_read_only(bs
)) {
1417 error_setg(errp
, "Device '%s' is read only", device
);
1421 if (!bdrv_can_snapshot(bs
)) {
1422 error_setg(errp
, "Block format '%s' used by device '%s' "
1423 "does not support internal snapshots",
1424 bs
->drv
->format_name
, device
);
1428 if (!strlen(name
)) {
1429 error_setg(errp
, "Name is empty");
1433 /* check whether a snapshot with name exist */
1434 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1437 error_propagate(errp
, local_err
);
1441 "Snapshot with name '%s' already exists on device '%s'",
1446 /* 3. take the snapshot */
1448 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1449 qemu_gettimeofday(&tv
);
1450 sn
->date_sec
= tv
.tv_sec
;
1451 sn
->date_nsec
= tv
.tv_usec
* 1000;
1452 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1454 ret1
= bdrv_snapshot_create(bs
, sn
);
1456 error_setg_errno(errp
, -ret1
,
1457 "Failed to create snapshot '%s' on device '%s'",
1462 /* 4. succeed, mark a snapshot is created */
1463 state
->created
= true;
1466 aio_context_release(aio_context
);
1469 static void internal_snapshot_abort(BlkActionState
*common
)
1471 InternalSnapshotState
*state
=
1472 DO_UPCAST(InternalSnapshotState
, common
, common
);
1473 BlockDriverState
*bs
= state
->bs
;
1474 QEMUSnapshotInfo
*sn
= &state
->sn
;
1475 AioContext
*aio_context
;
1476 Error
*local_error
= NULL
;
1478 if (!state
->created
) {
1482 aio_context
= bdrv_get_aio_context(state
->bs
);
1483 aio_context_acquire(aio_context
);
1485 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1486 error_reportf_err(local_error
,
1487 "Failed to delete snapshot with id '%s' and "
1488 "name '%s' on device '%s' in abort: ",
1489 sn
->id_str
, sn
->name
,
1490 bdrv_get_device_name(bs
));
1493 aio_context_release(aio_context
);
1496 static void internal_snapshot_clean(BlkActionState
*common
)
1498 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1500 AioContext
*aio_context
;
1506 aio_context
= bdrv_get_aio_context(state
->bs
);
1507 aio_context_acquire(aio_context
);
1509 bdrv_drained_end(state
->bs
);
1511 aio_context_release(aio_context
);
1514 /* external snapshot private data */
1515 typedef struct ExternalSnapshotState
{
1516 BlkActionState common
;
1517 BlockDriverState
*old_bs
;
1518 BlockDriverState
*new_bs
;
1519 bool overlay_appended
;
1520 } ExternalSnapshotState
;
1522 static void external_snapshot_prepare(BlkActionState
*common
,
1526 QDict
*options
= NULL
;
1527 Error
*local_err
= NULL
;
1528 /* Device and node name of the image to generate the snapshot from */
1530 const char *node_name
;
1531 /* Reference to the new image (for 'blockdev-snapshot') */
1532 const char *snapshot_ref
;
1533 /* File name of the new image (for 'blockdev-snapshot-sync') */
1534 const char *new_image_file
;
1535 ExternalSnapshotState
*state
=
1536 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1537 TransactionAction
*action
= common
->action
;
1538 AioContext
*aio_context
;
1541 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1542 * purpose but a different set of parameters */
1543 switch (action
->type
) {
1544 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1546 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1548 node_name
= s
->node
;
1549 new_image_file
= NULL
;
1550 snapshot_ref
= s
->overlay
;
1553 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1555 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1556 device
= s
->has_device
? s
->device
: NULL
;
1557 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1558 new_image_file
= s
->snapshot_file
;
1559 snapshot_ref
= NULL
;
1563 g_assert_not_reached();
1566 /* start processing */
1567 if (action_check_completion_mode(common
, errp
) < 0) {
1571 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1572 if (!state
->old_bs
) {
1576 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1577 aio_context_acquire(aio_context
);
1579 /* Paired with .clean() */
1580 bdrv_drained_begin(state
->old_bs
);
1582 if (!bdrv_is_inserted(state
->old_bs
)) {
1583 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1587 if (bdrv_op_is_blocked(state
->old_bs
,
1588 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1592 if (!bdrv_is_read_only(state
->old_bs
)) {
1593 if (bdrv_flush(state
->old_bs
)) {
1594 error_setg(errp
, QERR_IO_ERROR
);
1599 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1600 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1604 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1605 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1606 const char *format
= s
->has_format
? s
->format
: "qcow2";
1607 enum NewImageMode mode
;
1608 const char *snapshot_node_name
=
1609 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1611 if (node_name
&& !snapshot_node_name
) {
1612 error_setg(errp
, "New overlay node name missing");
1616 if (snapshot_node_name
&&
1617 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1618 error_setg(errp
, "New overlay node name already in use");
1622 flags
= state
->old_bs
->open_flags
;
1623 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_COPY_ON_READ
);
1624 flags
|= BDRV_O_NO_BACKING
;
1626 /* create new image w/backing file */
1627 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1628 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1629 int64_t size
= bdrv_getlength(state
->old_bs
);
1631 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1634 bdrv_refresh_filename(state
->old_bs
);
1635 bdrv_img_create(new_image_file
, format
,
1636 state
->old_bs
->filename
,
1637 state
->old_bs
->drv
->format_name
,
1638 NULL
, size
, flags
, false, &local_err
);
1640 error_propagate(errp
, local_err
);
1645 options
= qdict_new();
1646 if (snapshot_node_name
) {
1647 qdict_put_str(options
, "node-name", snapshot_node_name
);
1649 qdict_put_str(options
, "driver", format
);
1652 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1654 /* We will manually add the backing_hd field to the bs later */
1655 if (!state
->new_bs
) {
1659 if (bdrv_has_blk(state
->new_bs
)) {
1660 error_setg(errp
, "The overlay is already in use");
1664 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1669 if (state
->new_bs
->backing
!= NULL
) {
1670 error_setg(errp
, "The overlay already has a backing image");
1674 if (!state
->new_bs
->drv
->supports_backing
) {
1675 error_setg(errp
, "The overlay does not support backing images");
1679 ret
= bdrv_try_set_aio_context(state
->new_bs
, aio_context
, errp
);
1684 /* This removes our old bs and adds the new bs. This is an operation that
1685 * can fail, so we need to do it in .prepare; undoing it for abort is
1686 * always possible. */
1687 bdrv_ref(state
->new_bs
);
1688 bdrv_append(state
->new_bs
, state
->old_bs
, &local_err
);
1690 error_propagate(errp
, local_err
);
1693 state
->overlay_appended
= true;
1696 aio_context_release(aio_context
);
1699 static void external_snapshot_commit(BlkActionState
*common
)
1701 ExternalSnapshotState
*state
=
1702 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1703 AioContext
*aio_context
;
1705 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1706 aio_context_acquire(aio_context
);
1708 /* We don't need (or want) to use the transactional
1709 * bdrv_reopen_multiple() across all the entries at once, because we
1710 * don't want to abort all of them if one of them fails the reopen */
1711 if (!atomic_read(&state
->old_bs
->copy_on_read
)) {
1712 bdrv_reopen_set_read_only(state
->old_bs
, true, NULL
);
1715 aio_context_release(aio_context
);
1718 static void external_snapshot_abort(BlkActionState
*common
)
1720 ExternalSnapshotState
*state
=
1721 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1722 if (state
->new_bs
) {
1723 if (state
->overlay_appended
) {
1724 AioContext
*aio_context
;
1726 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1727 aio_context_acquire(aio_context
);
1729 bdrv_ref(state
->old_bs
); /* we can't let bdrv_set_backind_hd()
1730 close state->old_bs; we need it */
1731 bdrv_set_backing_hd(state
->new_bs
, NULL
, &error_abort
);
1732 bdrv_replace_node(state
->new_bs
, state
->old_bs
, &error_abort
);
1733 bdrv_unref(state
->old_bs
); /* bdrv_replace_node() ref'ed old_bs */
1735 aio_context_release(aio_context
);
1740 static void external_snapshot_clean(BlkActionState
*common
)
1742 ExternalSnapshotState
*state
=
1743 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1744 AioContext
*aio_context
;
1746 if (!state
->old_bs
) {
1750 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1751 aio_context_acquire(aio_context
);
1753 bdrv_drained_end(state
->old_bs
);
1754 bdrv_unref(state
->new_bs
);
1756 aio_context_release(aio_context
);
1759 typedef struct DriveBackupState
{
1760 BlkActionState common
;
1761 BlockDriverState
*bs
;
1765 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
1768 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1770 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1771 BlockDriverState
*bs
;
1772 DriveBackup
*backup
;
1773 AioContext
*aio_context
;
1774 Error
*local_err
= NULL
;
1776 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1777 backup
= common
->action
->u
.drive_backup
.data
;
1779 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1784 aio_context
= bdrv_get_aio_context(bs
);
1785 aio_context_acquire(aio_context
);
1787 /* Paired with .clean() */
1788 bdrv_drained_begin(bs
);
1792 state
->job
= do_drive_backup(backup
, common
->block_job_txn
, &local_err
);
1794 error_propagate(errp
, local_err
);
1799 aio_context_release(aio_context
);
1802 static void drive_backup_commit(BlkActionState
*common
)
1804 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1805 AioContext
*aio_context
;
1807 aio_context
= bdrv_get_aio_context(state
->bs
);
1808 aio_context_acquire(aio_context
);
1811 job_start(&state
->job
->job
);
1813 aio_context_release(aio_context
);
1816 static void drive_backup_abort(BlkActionState
*common
)
1818 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1821 AioContext
*aio_context
;
1823 aio_context
= bdrv_get_aio_context(state
->bs
);
1824 aio_context_acquire(aio_context
);
1826 job_cancel_sync(&state
->job
->job
);
1828 aio_context_release(aio_context
);
1832 static void drive_backup_clean(BlkActionState
*common
)
1834 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1835 AioContext
*aio_context
;
1841 aio_context
= bdrv_get_aio_context(state
->bs
);
1842 aio_context_acquire(aio_context
);
1844 bdrv_drained_end(state
->bs
);
1846 aio_context_release(aio_context
);
1849 typedef struct BlockdevBackupState
{
1850 BlkActionState common
;
1851 BlockDriverState
*bs
;
1853 } BlockdevBackupState
;
1855 static BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
1858 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1860 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1861 BlockdevBackup
*backup
;
1862 BlockDriverState
*bs
, *target
;
1863 AioContext
*aio_context
;
1864 Error
*local_err
= NULL
;
1866 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1867 backup
= common
->action
->u
.blockdev_backup
.data
;
1869 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1874 target
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1879 aio_context
= bdrv_get_aio_context(bs
);
1880 aio_context_acquire(aio_context
);
1883 /* Paired with .clean() */
1884 bdrv_drained_begin(state
->bs
);
1886 state
->job
= do_blockdev_backup(backup
, common
->block_job_txn
, &local_err
);
1888 error_propagate(errp
, local_err
);
1893 aio_context_release(aio_context
);
1896 static void blockdev_backup_commit(BlkActionState
*common
)
1898 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1899 AioContext
*aio_context
;
1901 aio_context
= bdrv_get_aio_context(state
->bs
);
1902 aio_context_acquire(aio_context
);
1905 job_start(&state
->job
->job
);
1907 aio_context_release(aio_context
);
1910 static void blockdev_backup_abort(BlkActionState
*common
)
1912 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1915 AioContext
*aio_context
;
1917 aio_context
= bdrv_get_aio_context(state
->bs
);
1918 aio_context_acquire(aio_context
);
1920 job_cancel_sync(&state
->job
->job
);
1922 aio_context_release(aio_context
);
1926 static void blockdev_backup_clean(BlkActionState
*common
)
1928 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1929 AioContext
*aio_context
;
1935 aio_context
= bdrv_get_aio_context(state
->bs
);
1936 aio_context_acquire(aio_context
);
1938 bdrv_drained_end(state
->bs
);
1940 aio_context_release(aio_context
);
1943 typedef struct BlockDirtyBitmapState
{
1944 BlkActionState common
;
1945 BdrvDirtyBitmap
*bitmap
;
1946 BlockDriverState
*bs
;
1950 } BlockDirtyBitmapState
;
1952 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1955 Error
*local_err
= NULL
;
1956 BlockDirtyBitmapAdd
*action
;
1957 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1960 if (action_check_completion_mode(common
, errp
) < 0) {
1964 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1965 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1966 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
1967 action
->has_granularity
, action
->granularity
,
1968 action
->has_persistent
, action
->persistent
,
1969 action
->has_autoload
, action
->autoload
,
1970 action
->has_disabled
, action
->disabled
,
1974 state
->prepared
= true;
1976 error_propagate(errp
, local_err
);
1980 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
1982 BlockDirtyBitmapAdd
*action
;
1983 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1986 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1987 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1988 * then the node reference and bitmap name must have been valid.
1990 if (state
->prepared
) {
1991 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
1995 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
1998 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2000 BlockDirtyBitmap
*action
;
2002 if (action_check_completion_mode(common
, errp
) < 0) {
2006 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2007 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2011 if (!state
->bitmap
) {
2015 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_DEFAULT
, errp
)) {
2019 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2022 static void block_dirty_bitmap_restore(BlkActionState
*common
)
2024 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2027 if (state
->backup
) {
2028 bdrv_restore_dirty_bitmap(state
->bitmap
, state
->backup
);
2032 static void block_dirty_bitmap_free_backup(BlkActionState
*common
)
2034 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2037 hbitmap_free(state
->backup
);
2040 static void block_dirty_bitmap_enable_prepare(BlkActionState
*common
,
2043 BlockDirtyBitmap
*action
;
2044 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2047 if (action_check_completion_mode(common
, errp
) < 0) {
2051 action
= common
->action
->u
.block_dirty_bitmap_enable
.data
;
2052 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2056 if (!state
->bitmap
) {
2060 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2064 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2065 bdrv_enable_dirty_bitmap(state
->bitmap
);
2068 static void block_dirty_bitmap_enable_abort(BlkActionState
*common
)
2070 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2073 if (!state
->was_enabled
) {
2074 bdrv_disable_dirty_bitmap(state
->bitmap
);
2078 static void block_dirty_bitmap_disable_prepare(BlkActionState
*common
,
2081 BlockDirtyBitmap
*action
;
2082 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2085 if (action_check_completion_mode(common
, errp
) < 0) {
2089 action
= common
->action
->u
.block_dirty_bitmap_disable
.data
;
2090 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2094 if (!state
->bitmap
) {
2098 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2102 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2103 bdrv_disable_dirty_bitmap(state
->bitmap
);
2106 static void block_dirty_bitmap_disable_abort(BlkActionState
*common
)
2108 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2111 if (state
->was_enabled
) {
2112 bdrv_enable_dirty_bitmap(state
->bitmap
);
2116 static BdrvDirtyBitmap
*do_block_dirty_bitmap_merge(
2117 const char *node
, const char *target
,
2118 BlockDirtyBitmapMergeSourceList
*bitmaps
,
2119 HBitmap
**backup
, Error
**errp
);
2121 static void block_dirty_bitmap_merge_prepare(BlkActionState
*common
,
2124 BlockDirtyBitmapMerge
*action
;
2125 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2128 if (action_check_completion_mode(common
, errp
) < 0) {
2132 action
= common
->action
->u
.block_dirty_bitmap_merge
.data
;
2134 state
->bitmap
= do_block_dirty_bitmap_merge(action
->node
, action
->target
,
2135 action
->bitmaps
, &state
->backup
,
2139 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2141 error_setg(errp
, "Transaction aborted using Abort action");
2144 static void abort_commit(BlkActionState
*common
)
2146 g_assert_not_reached(); /* this action never succeeds */
2149 static const BlkActionOps actions
[] = {
2150 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2151 .instance_size
= sizeof(ExternalSnapshotState
),
2152 .prepare
= external_snapshot_prepare
,
2153 .commit
= external_snapshot_commit
,
2154 .abort
= external_snapshot_abort
,
2155 .clean
= external_snapshot_clean
,
2157 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2158 .instance_size
= sizeof(ExternalSnapshotState
),
2159 .prepare
= external_snapshot_prepare
,
2160 .commit
= external_snapshot_commit
,
2161 .abort
= external_snapshot_abort
,
2162 .clean
= external_snapshot_clean
,
2164 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2165 .instance_size
= sizeof(DriveBackupState
),
2166 .prepare
= drive_backup_prepare
,
2167 .commit
= drive_backup_commit
,
2168 .abort
= drive_backup_abort
,
2169 .clean
= drive_backup_clean
,
2171 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2172 .instance_size
= sizeof(BlockdevBackupState
),
2173 .prepare
= blockdev_backup_prepare
,
2174 .commit
= blockdev_backup_commit
,
2175 .abort
= blockdev_backup_abort
,
2176 .clean
= blockdev_backup_clean
,
2178 [TRANSACTION_ACTION_KIND_ABORT
] = {
2179 .instance_size
= sizeof(BlkActionState
),
2180 .prepare
= abort_prepare
,
2181 .commit
= abort_commit
,
2183 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2184 .instance_size
= sizeof(InternalSnapshotState
),
2185 .prepare
= internal_snapshot_prepare
,
2186 .abort
= internal_snapshot_abort
,
2187 .clean
= internal_snapshot_clean
,
2189 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2190 .instance_size
= sizeof(BlockDirtyBitmapState
),
2191 .prepare
= block_dirty_bitmap_add_prepare
,
2192 .abort
= block_dirty_bitmap_add_abort
,
2194 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2195 .instance_size
= sizeof(BlockDirtyBitmapState
),
2196 .prepare
= block_dirty_bitmap_clear_prepare
,
2197 .commit
= block_dirty_bitmap_free_backup
,
2198 .abort
= block_dirty_bitmap_restore
,
2200 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE
] = {
2201 .instance_size
= sizeof(BlockDirtyBitmapState
),
2202 .prepare
= block_dirty_bitmap_enable_prepare
,
2203 .abort
= block_dirty_bitmap_enable_abort
,
2205 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE
] = {
2206 .instance_size
= sizeof(BlockDirtyBitmapState
),
2207 .prepare
= block_dirty_bitmap_disable_prepare
,
2208 .abort
= block_dirty_bitmap_disable_abort
,
2210 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE
] = {
2211 .instance_size
= sizeof(BlockDirtyBitmapState
),
2212 .prepare
= block_dirty_bitmap_merge_prepare
,
2213 .commit
= block_dirty_bitmap_free_backup
,
2214 .abort
= block_dirty_bitmap_restore
,
2216 /* Where are transactions for MIRROR, COMMIT and STREAM?
2217 * Although these blockjobs use transaction callbacks like the backup job,
2218 * these jobs do not necessarily adhere to transaction semantics.
2219 * These jobs may not fully undo all of their actions on abort, nor do they
2220 * necessarily work in transactions with more than one job in them.
2225 * Allocate a TransactionProperties structure if necessary, and fill
2226 * that structure with desired defaults if they are unset.
2228 static TransactionProperties
*get_transaction_properties(
2229 TransactionProperties
*props
)
2232 props
= g_new0(TransactionProperties
, 1);
2235 if (!props
->has_completion_mode
) {
2236 props
->has_completion_mode
= true;
2237 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2244 * 'Atomic' group operations. The operations are performed as a set, and if
2245 * any fail then we roll back all operations in the group.
2247 void qmp_transaction(TransactionActionList
*dev_list
,
2249 struct TransactionProperties
*props
,
2252 TransactionActionList
*dev_entry
= dev_list
;
2253 JobTxn
*block_job_txn
= NULL
;
2254 BlkActionState
*state
, *next
;
2255 Error
*local_err
= NULL
;
2257 QTAILQ_HEAD(, BlkActionState
) snap_bdrv_states
;
2258 QTAILQ_INIT(&snap_bdrv_states
);
2260 /* Does this transaction get canceled as a group on failure?
2261 * If not, we don't really need to make a JobTxn.
2263 props
= get_transaction_properties(props
);
2264 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2265 block_job_txn
= job_txn_new();
2268 /* drain all i/o before any operations */
2271 /* We don't do anything in this loop that commits us to the operations */
2272 while (NULL
!= dev_entry
) {
2273 TransactionAction
*dev_info
= NULL
;
2274 const BlkActionOps
*ops
;
2276 dev_info
= dev_entry
->value
;
2277 dev_entry
= dev_entry
->next
;
2279 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2281 ops
= &actions
[dev_info
->type
];
2282 assert(ops
->instance_size
> 0);
2284 state
= g_malloc0(ops
->instance_size
);
2286 state
->action
= dev_info
;
2287 state
->block_job_txn
= block_job_txn
;
2288 state
->txn_props
= props
;
2289 QTAILQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2291 state
->ops
->prepare(state
, &local_err
);
2293 error_propagate(errp
, local_err
);
2294 goto delete_and_fail
;
2298 QTAILQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2299 if (state
->ops
->commit
) {
2300 state
->ops
->commit(state
);
2308 /* failure, and it is all-or-none; roll back all operations */
2309 QTAILQ_FOREACH_REVERSE(state
, &snap_bdrv_states
, entry
) {
2310 if (state
->ops
->abort
) {
2311 state
->ops
->abort(state
);
2315 QTAILQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2316 if (state
->ops
->clean
) {
2317 state
->ops
->clean(state
);
2322 qapi_free_TransactionProperties(props
);
2324 job_txn_unref(block_job_txn
);
2327 void qmp_eject(bool has_device
, const char *device
,
2328 bool has_id
, const char *id
,
2329 bool has_force
, bool force
, Error
**errp
)
2331 Error
*local_err
= NULL
;
2338 rc
= do_open_tray(has_device
? device
: NULL
,
2341 if (rc
&& rc
!= -ENOSYS
) {
2342 error_propagate(errp
, local_err
);
2345 error_free(local_err
);
2347 blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2350 void qmp_block_passwd(bool has_device
, const char *device
,
2351 bool has_node_name
, const char *node_name
,
2352 const char *password
, Error
**errp
)
2355 "Setting block passwords directly is no longer supported");
2359 * Attempt to open the tray of @device.
2360 * If @force, ignore its tray lock.
2361 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2362 * On error, store an error through @errp and return -errno.
2363 * If @device does not exist, return -ENODEV.
2364 * If it has no removable media, return -ENOTSUP.
2365 * If it has no tray, return -ENOSYS.
2366 * If the guest was asked to open the tray, return -EINPROGRESS.
2369 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2370 bool force
, Error
**errp
)
2373 const char *device
= qdev_id
?: blk_name
;
2376 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2381 if (!blk_dev_has_removable_media(blk
)) {
2382 error_setg(errp
, "Device '%s' is not removable", device
);
2386 if (!blk_dev_has_tray(blk
)) {
2387 error_setg(errp
, "Device '%s' does not have a tray", device
);
2391 if (blk_dev_is_tray_open(blk
)) {
2395 locked
= blk_dev_is_medium_locked(blk
);
2397 blk_dev_eject_request(blk
, force
);
2400 if (!locked
|| force
) {
2401 blk_dev_change_media_cb(blk
, false, &error_abort
);
2404 if (locked
&& !force
) {
2405 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2406 "wait for tray to open and try again", device
);
2407 return -EINPROGRESS
;
2413 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2414 bool has_id
, const char *id
,
2415 bool has_force
, bool force
,
2418 Error
*local_err
= NULL
;
2424 rc
= do_open_tray(has_device
? device
: NULL
,
2427 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2428 error_propagate(errp
, local_err
);
2431 error_free(local_err
);
2434 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2435 bool has_id
, const char *id
,
2439 Error
*local_err
= NULL
;
2441 device
= has_device
? device
: NULL
;
2442 id
= has_id
? id
: NULL
;
2444 blk
= qmp_get_blk(device
, id
, errp
);
2449 if (!blk_dev_has_removable_media(blk
)) {
2450 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2454 if (!blk_dev_has_tray(blk
)) {
2455 /* Ignore this command on tray-less devices */
2459 if (!blk_dev_is_tray_open(blk
)) {
2463 blk_dev_change_media_cb(blk
, true, &local_err
);
2465 error_propagate(errp
, local_err
);
2470 static void blockdev_remove_medium(bool has_device
, const char *device
,
2471 bool has_id
, const char *id
, Error
**errp
)
2474 BlockDriverState
*bs
;
2475 AioContext
*aio_context
;
2476 bool has_attached_device
;
2478 device
= has_device
? device
: NULL
;
2479 id
= has_id
? id
: NULL
;
2481 blk
= qmp_get_blk(device
, id
, errp
);
2486 /* For BBs without a device, we can exchange the BDS tree at will */
2487 has_attached_device
= blk_get_attached_dev(blk
);
2489 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2490 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2494 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2495 !blk_dev_is_tray_open(blk
))
2497 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2506 aio_context
= bdrv_get_aio_context(bs
);
2507 aio_context_acquire(aio_context
);
2509 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2515 if (!blk_dev_has_tray(blk
)) {
2516 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2517 * called at all); therefore, the medium needs to be ejected here.
2518 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2519 * value passed here (i.e. false). */
2520 blk_dev_change_media_cb(blk
, false, &error_abort
);
2524 aio_context_release(aio_context
);
2527 void qmp_blockdev_remove_medium(const char *id
, Error
**errp
)
2529 blockdev_remove_medium(false, NULL
, true, id
, errp
);
2532 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2533 BlockDriverState
*bs
, Error
**errp
)
2535 Error
*local_err
= NULL
;
2539 /* For BBs without a device, we can exchange the BDS tree at will */
2540 has_device
= blk_get_attached_dev(blk
);
2542 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2543 error_setg(errp
, "Device is not removable");
2547 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2548 error_setg(errp
, "Tray of the device is not open");
2553 error_setg(errp
, "There already is a medium in the device");
2557 ret
= blk_insert_bs(blk
, bs
, errp
);
2562 if (!blk_dev_has_tray(blk
)) {
2563 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2564 * called at all); therefore, the medium needs to be pushed into the
2566 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2567 * value passed here (i.e. true). */
2568 blk_dev_change_media_cb(blk
, true, &local_err
);
2570 error_propagate(errp
, local_err
);
2577 static void blockdev_insert_medium(bool has_device
, const char *device
,
2578 bool has_id
, const char *id
,
2579 const char *node_name
, Error
**errp
)
2582 BlockDriverState
*bs
;
2584 blk
= qmp_get_blk(has_device
? device
: NULL
,
2591 bs
= bdrv_find_node(node_name
);
2593 error_setg(errp
, "Node '%s' not found", node_name
);
2597 if (bdrv_has_blk(bs
)) {
2598 error_setg(errp
, "Node '%s' is already in use", node_name
);
2602 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2605 void qmp_blockdev_insert_medium(const char *id
, const char *node_name
,
2608 blockdev_insert_medium(false, NULL
, true, id
, node_name
, errp
);
2611 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2612 bool has_id
, const char *id
,
2613 const char *filename
,
2614 bool has_format
, const char *format
,
2616 BlockdevChangeReadOnlyMode read_only
,
2620 BlockDriverState
*medium_bs
= NULL
;
2624 QDict
*options
= NULL
;
2627 blk
= qmp_get_blk(has_device
? device
: NULL
,
2635 blk_update_root_state(blk
);
2638 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2639 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2640 BDRV_O_PROTOCOL
| BDRV_O_AUTO_RDONLY
);
2642 if (!has_read_only
) {
2643 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2646 switch (read_only
) {
2647 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2650 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2651 bdrv_flags
&= ~BDRV_O_RDWR
;
2654 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2655 bdrv_flags
|= BDRV_O_RDWR
;
2662 options
= qdict_new();
2663 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2664 qdict_put_str(options
, "detect-zeroes", detect_zeroes
? "on" : "off");
2667 qdict_put_str(options
, "driver", format
);
2670 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2675 rc
= do_open_tray(has_device
? device
: NULL
,
2678 if (rc
&& rc
!= -ENOSYS
) {
2679 error_propagate(errp
, err
);
2685 blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2687 error_propagate(errp
, err
);
2691 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2693 error_propagate(errp
, err
);
2697 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2700 /* If the medium has been inserted, the device has its own reference, so
2701 * ours must be relinquished; and if it has not been inserted successfully,
2702 * the reference must be relinquished anyway */
2703 bdrv_unref(medium_bs
);
2706 /* throttling disk I/O limits */
2707 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2710 BlockDriverState
*bs
;
2712 AioContext
*aio_context
;
2714 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2715 arg
->has_id
? arg
->id
: NULL
,
2721 aio_context
= blk_get_aio_context(blk
);
2722 aio_context_acquire(aio_context
);
2726 error_setg(errp
, "Device has no medium");
2730 throttle_config_init(&cfg
);
2731 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2732 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2733 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2735 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2736 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2737 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2739 if (arg
->has_bps_max
) {
2740 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2742 if (arg
->has_bps_rd_max
) {
2743 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2745 if (arg
->has_bps_wr_max
) {
2746 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2748 if (arg
->has_iops_max
) {
2749 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2751 if (arg
->has_iops_rd_max
) {
2752 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2754 if (arg
->has_iops_wr_max
) {
2755 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2758 if (arg
->has_bps_max_length
) {
2759 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2761 if (arg
->has_bps_rd_max_length
) {
2762 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2764 if (arg
->has_bps_wr_max_length
) {
2765 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2767 if (arg
->has_iops_max_length
) {
2768 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2770 if (arg
->has_iops_rd_max_length
) {
2771 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2773 if (arg
->has_iops_wr_max_length
) {
2774 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2777 if (arg
->has_iops_size
) {
2778 cfg
.op_size
= arg
->iops_size
;
2781 if (!throttle_is_valid(&cfg
, errp
)) {
2785 if (throttle_enabled(&cfg
)) {
2786 /* Enable I/O limits if they're not enabled yet, otherwise
2787 * just update the throttling group. */
2788 if (!blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2789 blk_io_limits_enable(blk
,
2790 arg
->has_group
? arg
->group
:
2791 arg
->has_device
? arg
->device
:
2793 } else if (arg
->has_group
) {
2794 blk_io_limits_update_group(blk
, arg
->group
);
2796 /* Set the new throttling configuration */
2797 blk_set_io_limits(blk
, &cfg
);
2798 } else if (blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2799 /* If all throttling settings are set to 0, disable I/O limits */
2800 blk_io_limits_disable(blk
);
2804 aio_context_release(aio_context
);
2807 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2808 bool has_granularity
, uint32_t granularity
,
2809 bool has_persistent
, bool persistent
,
2810 bool has_autoload
, bool autoload
,
2811 bool has_disabled
, bool disabled
,
2814 BlockDriverState
*bs
;
2815 BdrvDirtyBitmap
*bitmap
;
2817 if (!name
|| name
[0] == '\0') {
2818 error_setg(errp
, "Bitmap name cannot be empty");
2822 bs
= bdrv_lookup_bs(node
, node
, errp
);
2827 if (has_granularity
) {
2828 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2829 error_setg(errp
, "Granularity must be power of 2 "
2830 "and at least 512");
2834 /* Default to cluster size, if available: */
2835 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2838 if (!has_persistent
) {
2843 warn_report("Autoload option is deprecated and its value is ignored");
2846 if (!has_disabled
) {
2851 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
2854 aio_context_acquire(aio_context
);
2855 ok
= bdrv_can_store_new_dirty_bitmap(bs
, name
, granularity
, errp
);
2856 aio_context_release(aio_context
);
2862 bitmap
= bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2863 if (bitmap
== NULL
) {
2868 bdrv_disable_dirty_bitmap(bitmap
);
2871 bdrv_dirty_bitmap_set_persistence(bitmap
, persistent
);
2874 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2877 BlockDriverState
*bs
;
2878 BdrvDirtyBitmap
*bitmap
;
2880 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2881 if (!bitmap
|| !bs
) {
2885 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_BUSY
| BDRV_BITMAP_RO
,
2890 if (bdrv_dirty_bitmap_get_persistence(bitmap
)) {
2891 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
2892 Error
*local_err
= NULL
;
2894 aio_context_acquire(aio_context
);
2895 bdrv_remove_persistent_dirty_bitmap(bs
, name
, &local_err
);
2896 aio_context_release(aio_context
);
2897 if (local_err
!= NULL
) {
2898 error_propagate(errp
, local_err
);
2903 bdrv_release_dirty_bitmap(bs
, bitmap
);
2907 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2908 * immediately after a full backup operation.
2910 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2913 BdrvDirtyBitmap
*bitmap
;
2914 BlockDriverState
*bs
;
2916 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2917 if (!bitmap
|| !bs
) {
2921 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_DEFAULT
, errp
)) {
2925 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2928 void qmp_block_dirty_bitmap_enable(const char *node
, const char *name
,
2931 BlockDriverState
*bs
;
2932 BdrvDirtyBitmap
*bitmap
;
2934 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2939 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2943 bdrv_enable_dirty_bitmap(bitmap
);
2946 void qmp_block_dirty_bitmap_disable(const char *node
, const char *name
,
2949 BlockDriverState
*bs
;
2950 BdrvDirtyBitmap
*bitmap
;
2952 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2957 if (bdrv_dirty_bitmap_check(bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2961 bdrv_disable_dirty_bitmap(bitmap
);
2964 static BdrvDirtyBitmap
*do_block_dirty_bitmap_merge(
2965 const char *node
, const char *target
,
2966 BlockDirtyBitmapMergeSourceList
*bitmaps
,
2967 HBitmap
**backup
, Error
**errp
)
2969 BlockDriverState
*bs
;
2970 BdrvDirtyBitmap
*dst
, *src
, *anon
;
2971 BlockDirtyBitmapMergeSourceList
*lst
;
2972 Error
*local_err
= NULL
;
2974 dst
= block_dirty_bitmap_lookup(node
, target
, &bs
, errp
);
2979 anon
= bdrv_create_dirty_bitmap(bs
, bdrv_dirty_bitmap_granularity(dst
),
2985 for (lst
= bitmaps
; lst
; lst
= lst
->next
) {
2986 switch (lst
->value
->type
) {
2987 const char *name
, *node
;
2989 name
= lst
->value
->u
.local
;
2990 src
= bdrv_find_dirty_bitmap(bs
, name
);
2992 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
2998 node
= lst
->value
->u
.external
.node
;
2999 name
= lst
->value
->u
.external
.name
;
3000 src
= block_dirty_bitmap_lookup(node
, name
, NULL
, errp
);
3010 bdrv_merge_dirty_bitmap(anon
, src
, NULL
, &local_err
);
3012 error_propagate(errp
, local_err
);
3018 /* Merge into dst; dst is unchanged on failure. */
3019 bdrv_merge_dirty_bitmap(dst
, anon
, backup
, errp
);
3022 bdrv_release_dirty_bitmap(bs
, anon
);
3026 void qmp_block_dirty_bitmap_merge(const char *node
, const char *target
,
3027 BlockDirtyBitmapMergeSourceList
*bitmaps
,
3030 do_block_dirty_bitmap_merge(node
, target
, bitmaps
, NULL
, errp
);
3033 BlockDirtyBitmapSha256
*qmp_x_debug_block_dirty_bitmap_sha256(const char *node
,
3037 BdrvDirtyBitmap
*bitmap
;
3038 BlockDriverState
*bs
;
3039 BlockDirtyBitmapSha256
*ret
= NULL
;
3042 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3043 if (!bitmap
|| !bs
) {
3047 sha256
= bdrv_dirty_bitmap_sha256(bitmap
, errp
);
3048 if (sha256
== NULL
) {
3052 ret
= g_new(BlockDirtyBitmapSha256
, 1);
3053 ret
->sha256
= sha256
;
3058 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
3060 const char *id
= qdict_get_str(qdict
, "id");
3062 BlockDriverState
*bs
;
3063 AioContext
*aio_context
;
3064 Error
*local_err
= NULL
;
3066 bs
= bdrv_find_node(id
);
3068 qmp_blockdev_del(id
, &local_err
);
3070 error_report_err(local_err
);
3075 blk
= blk_by_name(id
);
3077 error_report("Device '%s' not found", id
);
3081 if (!blk_legacy_dinfo(blk
)) {
3082 error_report("Deleting device added with blockdev-add"
3083 " is not supported");
3087 aio_context
= blk_get_aio_context(blk
);
3088 aio_context_acquire(aio_context
);
3092 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
3093 error_report_err(local_err
);
3094 aio_context_release(aio_context
);
3101 /* Make the BlockBackend and the attached BlockDriverState anonymous */
3102 monitor_remove_blk(blk
);
3104 /* If this BlockBackend has a device attached to it, its refcount will be
3105 * decremented when the device is removed; otherwise we have to do so here.
3107 if (blk_get_attached_dev(blk
)) {
3108 /* Further I/O must not pause the guest */
3109 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
3110 BLOCKDEV_ON_ERROR_REPORT
);
3115 aio_context_release(aio_context
);
3118 void qmp_block_resize(bool has_device
, const char *device
,
3119 bool has_node_name
, const char *node_name
,
3120 int64_t size
, Error
**errp
)
3122 Error
*local_err
= NULL
;
3123 BlockBackend
*blk
= NULL
;
3124 BlockDriverState
*bs
;
3125 AioContext
*aio_context
;
3128 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
3129 has_node_name
? node_name
: NULL
,
3132 error_propagate(errp
, local_err
);
3136 aio_context
= bdrv_get_aio_context(bs
);
3137 aio_context_acquire(aio_context
);
3139 if (!bdrv_is_first_non_filter(bs
)) {
3140 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
3145 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
3149 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
3150 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
3154 blk
= blk_new(bdrv_get_aio_context(bs
), BLK_PERM_RESIZE
, BLK_PERM_ALL
);
3155 ret
= blk_insert_bs(blk
, bs
, errp
);
3160 bdrv_drained_begin(bs
);
3161 ret
= blk_truncate(blk
, size
, PREALLOC_MODE_OFF
, errp
);
3162 bdrv_drained_end(bs
);
3166 aio_context_release(aio_context
);
3169 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
3170 bool has_base
, const char *base
,
3171 bool has_base_node
, const char *base_node
,
3172 bool has_backing_file
, const char *backing_file
,
3173 bool has_speed
, int64_t speed
,
3174 bool has_on_error
, BlockdevOnError on_error
,
3175 bool has_auto_finalize
, bool auto_finalize
,
3176 bool has_auto_dismiss
, bool auto_dismiss
,
3179 BlockDriverState
*bs
, *iter
;
3180 BlockDriverState
*base_bs
= NULL
;
3181 AioContext
*aio_context
;
3182 Error
*local_err
= NULL
;
3183 const char *base_name
= NULL
;
3184 int job_flags
= JOB_DEFAULT
;
3186 if (!has_on_error
) {
3187 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3190 bs
= bdrv_lookup_bs(device
, device
, errp
);
3195 aio_context
= bdrv_get_aio_context(bs
);
3196 aio_context_acquire(aio_context
);
3198 if (has_base
&& has_base_node
) {
3199 error_setg(errp
, "'base' and 'base-node' cannot be specified "
3200 "at the same time");
3205 base_bs
= bdrv_find_backing_image(bs
, base
);
3206 if (base_bs
== NULL
) {
3207 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
3210 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3214 if (has_base_node
) {
3215 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3219 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
3220 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
3224 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3225 bdrv_refresh_filename(base_bs
);
3226 base_name
= base_bs
->filename
;
3229 /* Check for op blockers in the whole chain between bs and base */
3230 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
3231 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3236 /* if we are streaming the entire chain, the result will have no backing
3237 * file, and specifying one is therefore an error */
3238 if (base_bs
== NULL
&& has_backing_file
) {
3239 error_setg(errp
, "backing file specified, but streaming the "
3244 /* backing_file string overrides base bs filename */
3245 base_name
= has_backing_file
? backing_file
: base_name
;
3247 if (has_auto_finalize
&& !auto_finalize
) {
3248 job_flags
|= JOB_MANUAL_FINALIZE
;
3250 if (has_auto_dismiss
&& !auto_dismiss
) {
3251 job_flags
|= JOB_MANUAL_DISMISS
;
3254 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
3255 job_flags
, has_speed
? speed
: 0, on_error
, &local_err
);
3257 error_propagate(errp
, local_err
);
3261 trace_qmp_block_stream(bs
);
3264 aio_context_release(aio_context
);
3267 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
3268 bool has_base_node
, const char *base_node
,
3269 bool has_base
, const char *base
,
3270 bool has_top_node
, const char *top_node
,
3271 bool has_top
, const char *top
,
3272 bool has_backing_file
, const char *backing_file
,
3273 bool has_speed
, int64_t speed
,
3274 bool has_filter_node_name
, const char *filter_node_name
,
3275 bool has_auto_finalize
, bool auto_finalize
,
3276 bool has_auto_dismiss
, bool auto_dismiss
,
3279 BlockDriverState
*bs
;
3280 BlockDriverState
*iter
;
3281 BlockDriverState
*base_bs
, *top_bs
;
3282 AioContext
*aio_context
;
3283 Error
*local_err
= NULL
;
3284 /* This will be part of the QMP command, if/when the
3285 * BlockdevOnError change for blkmirror makes it in
3287 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3288 int job_flags
= JOB_DEFAULT
;
3293 if (!has_filter_node_name
) {
3294 filter_node_name
= NULL
;
3296 if (has_auto_finalize
&& !auto_finalize
) {
3297 job_flags
|= JOB_MANUAL_FINALIZE
;
3299 if (has_auto_dismiss
&& !auto_dismiss
) {
3300 job_flags
|= JOB_MANUAL_DISMISS
;
3304 * libvirt relies on the DeviceNotFound error class in order to probe for
3305 * live commit feature versions; for this to work, we must make sure to
3306 * perform the device lookup before any generic errors that may occur in a
3307 * scenario in which all optional arguments are omitted. */
3308 bs
= qmp_get_root_bs(device
, &local_err
);
3310 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3312 error_free(local_err
);
3313 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3314 "Device '%s' not found", device
);
3316 error_propagate(errp
, local_err
);
3321 aio_context
= bdrv_get_aio_context(bs
);
3322 aio_context_acquire(aio_context
);
3324 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3328 /* default top_bs is the active layer */
3331 if (has_top_node
&& has_top
) {
3332 error_setg(errp
, "'top-node' and 'top' are mutually exclusive");
3334 } else if (has_top_node
) {
3335 top_bs
= bdrv_lookup_bs(NULL
, top_node
, errp
);
3336 if (top_bs
== NULL
) {
3339 if (!bdrv_chain_contains(bs
, top_bs
)) {
3340 error_setg(errp
, "'%s' is not in this backing file chain",
3344 } else if (has_top
&& top
) {
3345 /* This strcmp() is just a shortcut, there is no need to
3346 * refresh @bs's filename. If it mismatches,
3347 * bdrv_find_backing_image() will do the refresh and may still
3349 if (strcmp(bs
->filename
, top
) != 0) {
3350 top_bs
= bdrv_find_backing_image(bs
, top
);
3354 if (top_bs
== NULL
) {
3355 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3359 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3361 if (has_base_node
&& has_base
) {
3362 error_setg(errp
, "'base-node' and 'base' are mutually exclusive");
3364 } else if (has_base_node
) {
3365 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3366 if (base_bs
== NULL
) {
3369 if (!bdrv_chain_contains(top_bs
, base_bs
)) {
3370 error_setg(errp
, "'%s' is not in this backing file chain",
3374 } else if (has_base
&& base
) {
3375 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3377 base_bs
= bdrv_find_base(top_bs
);
3380 if (base_bs
== NULL
) {
3381 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3385 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3387 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
3388 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3393 /* Do not allow attempts to commit an image into itself */
3394 if (top_bs
== base_bs
) {
3395 error_setg(errp
, "cannot commit an image into itself");
3400 if (has_backing_file
) {
3401 error_setg(errp
, "'backing-file' specified,"
3402 " but 'top' is the active layer");
3405 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
3406 job_flags
, speed
, on_error
,
3407 filter_node_name
, NULL
, NULL
, false, &local_err
);
3409 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
3410 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3413 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, job_flags
,
3414 speed
, on_error
, has_backing_file
? backing_file
: NULL
,
3415 filter_node_name
, &local_err
);
3417 if (local_err
!= NULL
) {
3418 error_propagate(errp
, local_err
);
3423 aio_context_release(aio_context
);
3426 /* Common QMP interface for drive-backup and blockdev-backup */
3427 static BlockJob
*do_backup_common(BackupCommon
*backup
,
3428 BlockDriverState
*bs
,
3429 BlockDriverState
*target_bs
,
3430 AioContext
*aio_context
,
3431 JobTxn
*txn
, Error
**errp
)
3433 BlockJob
*job
= NULL
;
3434 BdrvDirtyBitmap
*bmap
= NULL
;
3435 int job_flags
= JOB_DEFAULT
;
3438 if (!backup
->has_speed
) {
3441 if (!backup
->has_on_source_error
) {
3442 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3444 if (!backup
->has_on_target_error
) {
3445 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3447 if (!backup
->has_job_id
) {
3448 backup
->job_id
= NULL
;
3450 if (!backup
->has_auto_finalize
) {
3451 backup
->auto_finalize
= true;
3453 if (!backup
->has_auto_dismiss
) {
3454 backup
->auto_dismiss
= true;
3456 if (!backup
->has_compress
) {
3457 backup
->compress
= false;
3460 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
3465 if (backup
->sync
== MIRROR_SYNC_MODE_INCREMENTAL
) {
3466 if (backup
->has_bitmap_mode
&&
3467 backup
->bitmap_mode
!= BITMAP_SYNC_MODE_ON_SUCCESS
) {
3468 error_setg(errp
, "Bitmap sync mode must be '%s' "
3469 "when using sync mode '%s'",
3470 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS
),
3471 MirrorSyncMode_str(backup
->sync
));
3474 backup
->has_bitmap_mode
= true;
3475 backup
->sync
= MIRROR_SYNC_MODE_BITMAP
;
3476 backup
->bitmap_mode
= BITMAP_SYNC_MODE_ON_SUCCESS
;
3479 if (backup
->has_bitmap
) {
3480 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3482 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3485 if (!backup
->has_bitmap_mode
) {
3486 error_setg(errp
, "Bitmap sync mode must be given "
3487 "when providing a bitmap");
3490 if (bdrv_dirty_bitmap_check(bmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
3495 if (!backup
->auto_finalize
) {
3496 job_flags
|= JOB_MANUAL_FINALIZE
;
3498 if (!backup
->auto_dismiss
) {
3499 job_flags
|= JOB_MANUAL_DISMISS
;
3502 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3503 backup
->sync
, bmap
, backup
->bitmap_mode
,
3505 backup
->on_source_error
,
3506 backup
->on_target_error
,
3507 job_flags
, NULL
, NULL
, txn
, errp
);
3511 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
3514 BlockDriverState
*bs
;
3515 BlockDriverState
*target_bs
;
3516 BlockDriverState
*source
= NULL
;
3517 BlockJob
*job
= NULL
;
3518 AioContext
*aio_context
;
3519 QDict
*options
= NULL
;
3520 Error
*local_err
= NULL
;
3523 bool set_backing_hd
= false;
3525 if (!backup
->has_mode
) {
3526 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3529 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
3535 error_setg(errp
, "Device has no medium");
3539 aio_context
= bdrv_get_aio_context(bs
);
3540 aio_context_acquire(aio_context
);
3542 if (!backup
->has_format
) {
3543 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
3544 NULL
: (char*) bs
->drv
->format_name
;
3547 /* Early check to avoid creating target */
3548 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3552 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3554 /* See if we have a backing HD we can use to create our new image
3556 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
3557 source
= backing_bs(bs
);
3559 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
3562 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3564 flags
|= BDRV_O_NO_BACKING
;
3565 set_backing_hd
= true;
3568 size
= bdrv_getlength(bs
);
3570 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3574 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
3575 assert(backup
->format
);
3577 bdrv_refresh_filename(source
);
3578 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
3579 source
->drv
->format_name
, NULL
,
3580 size
, flags
, false, &local_err
);
3582 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
3583 size
, flags
, false, &local_err
);
3588 error_propagate(errp
, local_err
);
3592 if (backup
->format
) {
3594 options
= qdict_new();
3596 qdict_put_str(options
, "driver", backup
->format
);
3599 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
3604 if (set_backing_hd
) {
3605 bdrv_set_backing_hd(target_bs
, source
, &local_err
);
3611 job
= do_backup_common(qapi_DriveBackup_base(backup
),
3612 bs
, target_bs
, aio_context
, txn
, errp
);
3615 bdrv_unref(target_bs
);
3617 aio_context_release(aio_context
);
3621 void qmp_drive_backup(DriveBackup
*arg
, Error
**errp
)
3625 job
= do_drive_backup(arg
, NULL
, errp
);
3627 job_start(&job
->job
);
3631 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3633 return bdrv_named_nodes_list(errp
);
3636 XDbgBlockGraph
*qmp_x_debug_query_block_graph(Error
**errp
)
3638 return bdrv_get_xdbg_block_graph(errp
);
3641 BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
3644 BlockDriverState
*bs
;
3645 BlockDriverState
*target_bs
;
3646 AioContext
*aio_context
;
3649 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
3654 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
3659 aio_context
= bdrv_get_aio_context(bs
);
3660 aio_context_acquire(aio_context
);
3662 job
= do_backup_common(qapi_BlockdevBackup_base(backup
),
3663 bs
, target_bs
, aio_context
, txn
, errp
);
3665 aio_context_release(aio_context
);
3669 void qmp_blockdev_backup(BlockdevBackup
*arg
, Error
**errp
)
3672 job
= do_blockdev_backup(arg
, NULL
, errp
);
3674 job_start(&job
->job
);
3678 /* Parameter check and block job starting for drive mirroring.
3679 * Caller should hold @device and @target's aio context (must be the same).
3681 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3682 BlockDriverState
*target
,
3683 bool has_replaces
, const char *replaces
,
3684 enum MirrorSyncMode sync
,
3685 BlockMirrorBackingMode backing_mode
,
3686 bool has_speed
, int64_t speed
,
3687 bool has_granularity
, uint32_t granularity
,
3688 bool has_buf_size
, int64_t buf_size
,
3689 bool has_on_source_error
,
3690 BlockdevOnError on_source_error
,
3691 bool has_on_target_error
,
3692 BlockdevOnError on_target_error
,
3693 bool has_unmap
, bool unmap
,
3694 bool has_filter_node_name
,
3695 const char *filter_node_name
,
3696 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3697 bool has_auto_finalize
, bool auto_finalize
,
3698 bool has_auto_dismiss
, bool auto_dismiss
,
3701 int job_flags
= JOB_DEFAULT
;
3706 if (!has_on_source_error
) {
3707 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3709 if (!has_on_target_error
) {
3710 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3712 if (!has_granularity
) {
3715 if (!has_buf_size
) {
3721 if (!has_filter_node_name
) {
3722 filter_node_name
= NULL
;
3724 if (!has_copy_mode
) {
3725 copy_mode
= MIRROR_COPY_MODE_BACKGROUND
;
3727 if (has_auto_finalize
&& !auto_finalize
) {
3728 job_flags
|= JOB_MANUAL_FINALIZE
;
3730 if (has_auto_dismiss
&& !auto_dismiss
) {
3731 job_flags
|= JOB_MANUAL_DISMISS
;
3734 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3735 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3736 "a value in range [512B, 64MB]");
3739 if (granularity
& (granularity
- 1)) {
3740 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3745 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3748 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3752 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3753 sync
= MIRROR_SYNC_MODE_FULL
;
3757 BlockDriverState
*to_replace_bs
;
3758 AioContext
*replace_aio_context
;
3759 int64_t bs_size
, replace_size
;
3761 bs_size
= bdrv_getlength(bs
);
3763 error_setg_errno(errp
, -bs_size
, "Failed to query device's size");
3767 to_replace_bs
= check_to_replace_node(bs
, replaces
, errp
);
3768 if (!to_replace_bs
) {
3772 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3773 aio_context_acquire(replace_aio_context
);
3774 replace_size
= bdrv_getlength(to_replace_bs
);
3775 aio_context_release(replace_aio_context
);
3777 if (replace_size
< 0) {
3778 error_setg_errno(errp
, -replace_size
,
3779 "Failed to query the replacement node's size");
3782 if (bs_size
!= replace_size
) {
3783 error_setg(errp
, "cannot replace image with a mirror image of "
3789 /* pass the node name to replace to mirror start since it's loose coupling
3790 * and will allow to check whether the node still exist at mirror completion
3792 mirror_start(job_id
, bs
, target
,
3793 has_replaces
? replaces
: NULL
, job_flags
,
3794 speed
, granularity
, buf_size
, sync
, backing_mode
,
3795 on_source_error
, on_target_error
, unmap
, filter_node_name
,
3799 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3801 BlockDriverState
*bs
;
3802 BlockDriverState
*source
, *target_bs
;
3803 AioContext
*aio_context
;
3804 BlockMirrorBackingMode backing_mode
;
3805 Error
*local_err
= NULL
;
3806 QDict
*options
= NULL
;
3809 const char *format
= arg
->format
;
3812 bs
= qmp_get_root_bs(arg
->device
, errp
);
3817 /* Early check to avoid creating target */
3818 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3822 aio_context
= bdrv_get_aio_context(bs
);
3823 aio_context_acquire(aio_context
);
3825 if (!arg
->has_mode
) {
3826 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3829 if (!arg
->has_format
) {
3830 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3831 ? NULL
: bs
->drv
->format_name
);
3834 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3835 source
= backing_bs(bs
);
3836 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3837 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3839 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3843 size
= bdrv_getlength(bs
);
3845 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3849 if (arg
->has_replaces
) {
3850 if (!arg
->has_node_name
) {
3851 error_setg(errp
, "a node-name must be provided when replacing a"
3852 " named node of the graph");
3857 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3858 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3860 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3863 /* Don't open backing image in create() */
3864 flags
|= BDRV_O_NO_BACKING
;
3866 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3867 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3869 /* create new image w/o backing file */
3871 bdrv_img_create(arg
->target
, format
,
3872 NULL
, NULL
, NULL
, size
, flags
, false, &local_err
);
3874 switch (arg
->mode
) {
3875 case NEW_IMAGE_MODE_EXISTING
:
3877 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3878 /* create new image with backing file */
3879 bdrv_refresh_filename(source
);
3880 bdrv_img_create(arg
->target
, format
,
3882 source
->drv
->format_name
,
3883 NULL
, size
, flags
, false, &local_err
);
3891 error_propagate(errp
, local_err
);
3895 options
= qdict_new();
3896 if (arg
->has_node_name
) {
3897 qdict_put_str(options
, "node-name", arg
->node_name
);
3900 qdict_put_str(options
, "driver", format
);
3903 /* Mirroring takes care of copy-on-write using the source's backing
3906 target_bs
= bdrv_open(arg
->target
, NULL
, options
, flags
, errp
);
3911 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
3913 bdrv_unref(target_bs
);
3917 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3918 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3919 backing_mode
, arg
->has_speed
, arg
->speed
,
3920 arg
->has_granularity
, arg
->granularity
,
3921 arg
->has_buf_size
, arg
->buf_size
,
3922 arg
->has_on_source_error
, arg
->on_source_error
,
3923 arg
->has_on_target_error
, arg
->on_target_error
,
3924 arg
->has_unmap
, arg
->unmap
,
3926 arg
->has_copy_mode
, arg
->copy_mode
,
3927 arg
->has_auto_finalize
, arg
->auto_finalize
,
3928 arg
->has_auto_dismiss
, arg
->auto_dismiss
,
3930 bdrv_unref(target_bs
);
3931 error_propagate(errp
, local_err
);
3933 aio_context_release(aio_context
);
3936 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3937 const char *device
, const char *target
,
3938 bool has_replaces
, const char *replaces
,
3939 MirrorSyncMode sync
,
3940 bool has_speed
, int64_t speed
,
3941 bool has_granularity
, uint32_t granularity
,
3942 bool has_buf_size
, int64_t buf_size
,
3943 bool has_on_source_error
,
3944 BlockdevOnError on_source_error
,
3945 bool has_on_target_error
,
3946 BlockdevOnError on_target_error
,
3947 bool has_filter_node_name
,
3948 const char *filter_node_name
,
3949 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3950 bool has_auto_finalize
, bool auto_finalize
,
3951 bool has_auto_dismiss
, bool auto_dismiss
,
3954 BlockDriverState
*bs
;
3955 BlockDriverState
*target_bs
;
3956 AioContext
*aio_context
;
3957 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3958 Error
*local_err
= NULL
;
3961 bs
= qmp_get_root_bs(device
, errp
);
3966 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3971 aio_context
= bdrv_get_aio_context(bs
);
3972 aio_context_acquire(aio_context
);
3974 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
3979 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3980 has_replaces
, replaces
, sync
, backing_mode
,
3982 has_granularity
, granularity
,
3983 has_buf_size
, buf_size
,
3984 has_on_source_error
, on_source_error
,
3985 has_on_target_error
, on_target_error
,
3987 has_filter_node_name
, filter_node_name
,
3988 has_copy_mode
, copy_mode
,
3989 has_auto_finalize
, auto_finalize
,
3990 has_auto_dismiss
, auto_dismiss
,
3992 error_propagate(errp
, local_err
);
3994 aio_context_release(aio_context
);
3997 /* Get a block job using its ID and acquire its AioContext */
3998 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
4005 *aio_context
= NULL
;
4007 job
= block_job_get(id
);
4010 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
4011 "Block job '%s' not found", id
);
4015 *aio_context
= blk_get_aio_context(job
->blk
);
4016 aio_context_acquire(*aio_context
);
4021 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
4023 AioContext
*aio_context
;
4024 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4030 block_job_set_speed(job
, speed
, errp
);
4031 aio_context_release(aio_context
);
4034 void qmp_block_job_cancel(const char *device
,
4035 bool has_force
, bool force
, Error
**errp
)
4037 AioContext
*aio_context
;
4038 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4048 if (job_user_paused(&job
->job
) && !force
) {
4049 error_setg(errp
, "The block job for device '%s' is currently paused",
4054 trace_qmp_block_job_cancel(job
);
4055 job_user_cancel(&job
->job
, force
, errp
);
4057 aio_context_release(aio_context
);
4060 void qmp_block_job_pause(const char *device
, Error
**errp
)
4062 AioContext
*aio_context
;
4063 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4069 trace_qmp_block_job_pause(job
);
4070 job_user_pause(&job
->job
, errp
);
4071 aio_context_release(aio_context
);
4074 void qmp_block_job_resume(const char *device
, Error
**errp
)
4076 AioContext
*aio_context
;
4077 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4083 trace_qmp_block_job_resume(job
);
4084 job_user_resume(&job
->job
, errp
);
4085 aio_context_release(aio_context
);
4088 void qmp_block_job_complete(const char *device
, Error
**errp
)
4090 AioContext
*aio_context
;
4091 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4097 trace_qmp_block_job_complete(job
);
4098 job_complete(&job
->job
, errp
);
4099 aio_context_release(aio_context
);
4102 void qmp_block_job_finalize(const char *id
, Error
**errp
)
4104 AioContext
*aio_context
;
4105 BlockJob
*job
= find_block_job(id
, &aio_context
, errp
);
4111 trace_qmp_block_job_finalize(job
);
4112 job_finalize(&job
->job
, errp
);
4113 aio_context_release(aio_context
);
4116 void qmp_block_job_dismiss(const char *id
, Error
**errp
)
4118 AioContext
*aio_context
;
4119 BlockJob
*bjob
= find_block_job(id
, &aio_context
, errp
);
4126 trace_qmp_block_job_dismiss(bjob
);
4128 job_dismiss(&job
, errp
);
4129 aio_context_release(aio_context
);
4132 void qmp_change_backing_file(const char *device
,
4133 const char *image_node_name
,
4134 const char *backing_file
,
4137 BlockDriverState
*bs
= NULL
;
4138 AioContext
*aio_context
;
4139 BlockDriverState
*image_bs
= NULL
;
4140 Error
*local_err
= NULL
;
4144 bs
= qmp_get_root_bs(device
, errp
);
4149 aio_context
= bdrv_get_aio_context(bs
);
4150 aio_context_acquire(aio_context
);
4152 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
4154 error_propagate(errp
, local_err
);
4159 error_setg(errp
, "image file not found");
4163 if (bdrv_find_base(image_bs
) == image_bs
) {
4164 error_setg(errp
, "not allowing backing file change on an image "
4165 "without a backing file");
4169 /* even though we are not necessarily operating on bs, we need it to
4170 * determine if block ops are currently prohibited on the chain */
4171 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
4175 /* final sanity check */
4176 if (!bdrv_chain_contains(bs
, image_bs
)) {
4177 error_setg(errp
, "'%s' and image file are not in the same chain",
4182 /* if not r/w, reopen to make r/w */
4183 ro
= bdrv_is_read_only(image_bs
);
4186 if (bdrv_reopen_set_read_only(image_bs
, false, errp
) != 0) {
4191 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
4192 image_bs
->drv
? image_bs
->drv
->format_name
: "");
4195 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
4197 /* don't exit here, so we can try to restore open flags if
4202 bdrv_reopen_set_read_only(image_bs
, true, &local_err
);
4203 error_propagate(errp
, local_err
);
4207 aio_context_release(aio_context
);
4210 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
4214 Error
*local_err
= NULL
;
4216 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
4221 qdict
= qemu_opts_to_qdict(opts
, NULL
);
4223 if (!qdict_get_try_str(qdict
, "node-name")) {
4224 qobject_unref(qdict
);
4225 error_report("'node-name' needs to be specified");
4229 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
4231 error_report_err(local_err
);
4235 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4238 qemu_opts_del(opts
);
4241 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
4243 BlockDriverState
*bs
;
4245 Visitor
*v
= qobject_output_visitor_new(&obj
);
4247 Error
*local_err
= NULL
;
4249 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
4251 error_propagate(errp
, local_err
);
4255 visit_complete(v
, &obj
);
4256 qdict
= qobject_to(QDict
, obj
);
4258 qdict_flatten(qdict
);
4260 if (!qdict_get_try_str(qdict
, "node-name")) {
4261 error_setg(errp
, "'node-name' must be specified for the root node");
4265 bs
= bds_tree_init(qdict
, errp
);
4270 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4276 void qmp_x_blockdev_reopen(BlockdevOptions
*options
, Error
**errp
)
4278 BlockDriverState
*bs
;
4281 Visitor
*v
= qobject_output_visitor_new(&obj
);
4282 Error
*local_err
= NULL
;
4283 BlockReopenQueue
*queue
;
4286 /* Check for the selected node name */
4287 if (!options
->has_node_name
) {
4288 error_setg(errp
, "Node name not specified");
4292 bs
= bdrv_find_node(options
->node_name
);
4294 error_setg(errp
, "Cannot find node named '%s'", options
->node_name
);
4298 /* Put all options in a QDict and flatten it */
4299 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
4301 error_propagate(errp
, local_err
);
4305 visit_complete(v
, &obj
);
4306 qdict
= qobject_to(QDict
, obj
);
4308 qdict_flatten(qdict
);
4310 /* Perform the reopen operation */
4311 ctx
= bdrv_get_aio_context(bs
);
4312 aio_context_acquire(ctx
);
4313 bdrv_subtree_drained_begin(bs
);
4314 queue
= bdrv_reopen_queue(NULL
, bs
, qdict
, false);
4315 bdrv_reopen_multiple(queue
, errp
);
4316 bdrv_subtree_drained_end(bs
);
4317 aio_context_release(ctx
);
4323 void qmp_blockdev_del(const char *node_name
, Error
**errp
)
4325 AioContext
*aio_context
;
4326 BlockDriverState
*bs
;
4328 bs
= bdrv_find_node(node_name
);
4330 error_setg(errp
, "Cannot find node %s", node_name
);
4333 if (bdrv_has_blk(bs
)) {
4334 error_setg(errp
, "Node %s is in use", node_name
);
4337 aio_context
= bdrv_get_aio_context(bs
);
4338 aio_context_acquire(aio_context
);
4340 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
4344 if (!QTAILQ_IN_USE(bs
, monitor_list
)) {
4345 error_setg(errp
, "Node %s is not owned by the monitor",
4350 if (bs
->refcnt
> 1) {
4351 error_setg(errp
, "Block device %s is in use",
4352 bdrv_get_device_or_node_name(bs
));
4356 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
4360 aio_context_release(aio_context
);
4363 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
4364 const char *child_name
)
4368 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
4369 if (strcmp(child
->name
, child_name
) == 0) {
4377 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
4378 const char *child
, bool has_node
,
4379 const char *node
, Error
**errp
)
4381 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
4384 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
4389 if (has_child
== has_node
) {
4391 error_setg(errp
, "The parameters child and node are in conflict");
4393 error_setg(errp
, "Either child or node must be specified");
4399 p_child
= bdrv_find_child(parent_bs
, child
);
4401 error_setg(errp
, "Node '%s' does not have child '%s'",
4405 bdrv_del_child(parent_bs
, p_child
, errp
);
4409 new_bs
= bdrv_find_node(node
);
4411 error_setg(errp
, "Node '%s' not found", node
);
4414 bdrv_add_child(parent_bs
, new_bs
, errp
);
4418 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
4420 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
4423 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
4424 BlockJobInfoList
*elem
;
4425 AioContext
*aio_context
;
4427 if (block_job_is_internal(job
)) {
4430 elem
= g_new0(BlockJobInfoList
, 1);
4431 aio_context
= blk_get_aio_context(job
->blk
);
4432 aio_context_acquire(aio_context
);
4433 elem
->value
= block_job_query(job
, errp
);
4434 aio_context_release(aio_context
);
4437 qapi_free_BlockJobInfoList(head
);
4441 p_next
= &elem
->next
;
4447 void qmp_x_blockdev_set_iothread(const char *node_name
, StrOrNull
*iothread
,
4448 bool has_force
, bool force
, Error
**errp
)
4450 AioContext
*old_context
;
4451 AioContext
*new_context
;
4452 BlockDriverState
*bs
;
4454 bs
= bdrv_find_node(node_name
);
4456 error_setg(errp
, "Cannot find node %s", node_name
);
4460 /* Protects against accidents. */
4461 if (!(has_force
&& force
) && bdrv_has_blk(bs
)) {
4462 error_setg(errp
, "Node %s is associated with a BlockBackend and could "
4463 "be in use (use force=true to override this check)",
4468 if (iothread
->type
== QTYPE_QSTRING
) {
4469 IOThread
*obj
= iothread_by_id(iothread
->u
.s
);
4471 error_setg(errp
, "Cannot find iothread %s", iothread
->u
.s
);
4475 new_context
= iothread_get_aio_context(obj
);
4477 new_context
= qemu_get_aio_context();
4480 old_context
= bdrv_get_aio_context(bs
);
4481 aio_context_acquire(old_context
);
4483 bdrv_try_set_aio_context(bs
, new_context
, errp
);
4485 aio_context_release(old_context
);
4488 void qmp_block_latency_histogram_set(
4490 bool has_boundaries
, uint64List
*boundaries
,
4491 bool has_boundaries_read
, uint64List
*boundaries_read
,
4492 bool has_boundaries_write
, uint64List
*boundaries_write
,
4493 bool has_boundaries_flush
, uint64List
*boundaries_flush
,
4496 BlockBackend
*blk
= qmp_get_blk(NULL
, id
, errp
);
4497 BlockAcctStats
*stats
;
4504 stats
= blk_get_stats(blk
);
4506 if (!has_boundaries
&& !has_boundaries_read
&& !has_boundaries_write
&&
4507 !has_boundaries_flush
)
4509 block_latency_histograms_clear(stats
);
4513 if (has_boundaries
|| has_boundaries_read
) {
4514 ret
= block_latency_histogram_set(
4515 stats
, BLOCK_ACCT_READ
,
4516 has_boundaries_read
? boundaries_read
: boundaries
);
4518 error_setg(errp
, "Device '%s' set read boundaries fail", id
);
4523 if (has_boundaries
|| has_boundaries_write
) {
4524 ret
= block_latency_histogram_set(
4525 stats
, BLOCK_ACCT_WRITE
,
4526 has_boundaries_write
? boundaries_write
: boundaries
);
4528 error_setg(errp
, "Device '%s' set write boundaries fail", id
);
4533 if (has_boundaries
|| has_boundaries_flush
) {
4534 ret
= block_latency_histogram_set(
4535 stats
, BLOCK_ACCT_FLUSH
,
4536 has_boundaries_flush
? boundaries_flush
: boundaries
);
4538 error_setg(errp
, "Device '%s' set flush boundaries fail", id
);
4544 QemuOptsList qemu_common_drive_opts
= {
4546 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4550 .type
= QEMU_OPT_BOOL
,
4551 .help
= "enable/disable snapshot mode",
4554 .type
= QEMU_OPT_STRING
,
4555 .help
= "host AIO implementation (threads, native)",
4557 .name
= BDRV_OPT_CACHE_WB
,
4558 .type
= QEMU_OPT_BOOL
,
4559 .help
= "Enable writeback mode",
4562 .type
= QEMU_OPT_STRING
,
4563 .help
= "disk format (raw, qcow2, ...)",
4566 .type
= QEMU_OPT_STRING
,
4567 .help
= "read error action",
4570 .type
= QEMU_OPT_STRING
,
4571 .help
= "write error action",
4573 .name
= BDRV_OPT_READ_ONLY
,
4574 .type
= QEMU_OPT_BOOL
,
4575 .help
= "open drive file as read-only",
4581 .name
= "throttling.group",
4582 .type
= QEMU_OPT_STRING
,
4583 .help
= "name of the block throttling group",
4585 .name
= "copy-on-read",
4586 .type
= QEMU_OPT_BOOL
,
4587 .help
= "copy read data from backing file into image file",
4589 .name
= "detect-zeroes",
4590 .type
= QEMU_OPT_STRING
,
4591 .help
= "try to optimize zero writes (off, on, unmap)",
4593 .name
= "stats-account-invalid",
4594 .type
= QEMU_OPT_BOOL
,
4595 .help
= "whether to account for invalid I/O operations "
4596 "in the statistics",
4598 .name
= "stats-account-failed",
4599 .type
= QEMU_OPT_BOOL
,
4600 .help
= "whether to account for failed I/O operations "
4601 "in the statistics",
4603 { /* end of list */ }
4607 QemuOptsList qemu_drive_opts
= {
4609 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4612 * no elements => accept any params
4613 * validation will happen later
4615 { /* end of list */ }