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/config-file.h"
44 #include "qapi/qapi-commands-block.h"
45 #include "qapi/qapi-commands-transaction.h"
46 #include "qapi/qapi-visit-block-core.h"
47 #include "qapi/qmp/qdict.h"
48 #include "qapi/qmp/qnum.h"
49 #include "qapi/qmp/qstring.h"
50 #include "qapi/error.h"
51 #include "qapi/qmp/qerror.h"
52 #include "qapi/qmp/qlist.h"
53 #include "qapi/qobject-output-visitor.h"
54 #include "sysemu/sysemu.h"
55 #include "sysemu/iothread.h"
56 #include "block/block_int.h"
57 #include "block/trace.h"
58 #include "sysemu/arch_init.h"
59 #include "sysemu/qtest.h"
60 #include "qemu/cutils.h"
61 #include "qemu/help_option.h"
62 #include "qemu/throttle-options.h"
64 static QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
65 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
67 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
68 bool force
, Error
**errp
);
69 static void blockdev_remove_medium(bool has_device
, const char *device
,
70 bool has_id
, const char *id
, Error
**errp
);
71 static void blockdev_insert_medium(bool has_device
, const char *device
,
72 bool has_id
, const char *id
,
73 const char *node_name
, Error
**errp
);
75 static const char *const if_name
[IF_COUNT
] = {
79 [IF_FLOPPY
] = "floppy",
80 [IF_PFLASH
] = "pflash",
83 [IF_VIRTIO
] = "virtio",
87 static int if_max_devs
[IF_COUNT
] = {
89 * Do not change these numbers! They govern how drive option
90 * index maps to unit and bus. That mapping is ABI.
92 * All controllers used to implement if=T drives need to support
93 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
94 * Otherwise, some index values map to "impossible" bus, unit
97 * For instance, if you change [IF_SCSI] to 255, -drive
98 * if=scsi,index=12 no longer means bus=1,unit=5, but
99 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
100 * the drive can't be set up. Regression.
107 * Boards may call this to offer board-by-board overrides
108 * of the default, global values.
110 void override_max_devs(BlockInterfaceType type
, int max_devs
)
119 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
120 dinfo
= blk_legacy_dinfo(blk
);
121 if (dinfo
->type
== type
) {
122 fprintf(stderr
, "Cannot override units-per-bus property of"
123 " the %s interface, because a drive of that type has"
124 " already been added.\n", if_name
[type
]);
125 g_assert_not_reached();
129 if_max_devs
[type
] = max_devs
;
133 * We automatically delete the drive when a device using it gets
134 * unplugged. Questionable feature, but we can't just drop it.
135 * Device models call blockdev_mark_auto_del() to schedule the
136 * automatic deletion, and generic qdev code calls blockdev_auto_del()
137 * when deletion is actually safe.
139 void blockdev_mark_auto_del(BlockBackend
*blk
)
141 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
142 BlockDriverState
*bs
= blk_bs(blk
);
143 AioContext
*aio_context
;
150 aio_context
= bdrv_get_aio_context(bs
);
151 aio_context_acquire(aio_context
);
154 job_cancel(&bs
->job
->job
, false);
157 aio_context_release(aio_context
);
163 void blockdev_auto_del(BlockBackend
*blk
)
165 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
167 if (dinfo
&& dinfo
->auto_del
) {
168 monitor_remove_blk(blk
);
174 * Returns the current mapping of how many units per bus
175 * a particular interface can support.
177 * A positive integer indicates n units per bus.
178 * 0 implies the mapping has not been established.
179 * -1 indicates an invalid BlockInterfaceType was given.
181 int drive_get_max_devs(BlockInterfaceType type
)
183 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
184 return if_max_devs
[type
];
190 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
192 int max_devs
= if_max_devs
[type
];
193 return max_devs
? index
/ max_devs
: 0;
196 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
198 int max_devs
= if_max_devs
[type
];
199 return max_devs
? index
% max_devs
: index
;
202 QemuOpts
*drive_def(const char *optstr
)
204 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
207 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
212 opts
= drive_def(optstr
);
216 if (type
!= IF_DEFAULT
) {
217 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
220 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
223 qemu_opt_set(opts
, "file", file
, &error_abort
);
227 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
232 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
233 dinfo
= blk_legacy_dinfo(blk
);
234 if (dinfo
&& dinfo
->type
== type
235 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
243 void drive_check_orphaned(void)
248 bool orphans
= false;
250 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
251 dinfo
= blk_legacy_dinfo(blk
);
252 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
253 dinfo
->type
!= IF_NONE
) {
255 qemu_opts_loc_restore(dinfo
->opts
);
256 error_report("machine type does not support"
257 " if=%s,bus=%d,unit=%d",
258 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
269 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
271 return drive_get(type
,
272 drive_index_to_bus_id(type
, index
),
273 drive_index_to_unit_id(type
, index
));
276 int drive_get_max_bus(BlockInterfaceType type
)
283 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
284 dinfo
= blk_legacy_dinfo(blk
);
285 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
286 max_bus
= dinfo
->bus
;
292 /* Get a block device. This should only be used for single-drive devices
293 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
295 DriveInfo
*drive_get_next(BlockInterfaceType type
)
297 static int next_block_unit
[IF_COUNT
];
299 return drive_get(type
, 0, next_block_unit
[type
]++);
302 static void bdrv_format_print(void *opaque
, const char *name
)
304 error_printf(" %s", name
);
309 BlockDriverState
*bs
;
312 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
314 if (!strcmp(buf
, "ignore")) {
315 return BLOCKDEV_ON_ERROR_IGNORE
;
316 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
317 return BLOCKDEV_ON_ERROR_ENOSPC
;
318 } else if (!strcmp(buf
, "stop")) {
319 return BLOCKDEV_ON_ERROR_STOP
;
320 } else if (!strcmp(buf
, "report")) {
321 return BLOCKDEV_ON_ERROR_REPORT
;
323 error_setg(errp
, "'%s' invalid %s error action",
324 buf
, is_read
? "read" : "write");
329 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
332 const QListEntry
*entry
;
333 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
334 switch (qobject_type(entry
->value
)) {
336 case QTYPE_QSTRING
: {
337 unsigned long long length
;
338 const char *str
= qstring_get_str(qobject_to(QString
,
340 if (parse_uint_full(str
, &length
, 10) == 0 &&
341 length
> 0 && length
<= UINT_MAX
) {
342 block_acct_add_interval(stats
, (unsigned) length
);
344 error_setg(errp
, "Invalid interval length: %s", str
);
351 int64_t length
= qnum_get_int(qobject_to(QNum
, entry
->value
));
353 if (length
> 0 && length
<= UINT_MAX
) {
354 block_acct_add_interval(stats
, (unsigned) length
);
356 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
363 error_setg(errp
, "The specification of stats-intervals is invalid");
370 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
372 /* All parameters but @opts are optional and may be set to NULL. */
373 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
374 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
375 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
377 Error
*local_error
= NULL
;
381 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
382 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
385 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
386 if (!strcmp(aio
, "native")) {
387 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
388 } else if (!strcmp(aio
, "threads")) {
389 /* this is the default */
391 error_setg(errp
, "invalid aio option");
397 /* disk I/O throttling */
398 if (throttling_group
) {
399 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
403 throttle_config_init(throttle_cfg
);
404 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
405 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
406 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
407 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
408 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
409 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
410 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
411 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
412 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
413 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
414 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
415 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
417 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
418 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
419 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
420 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
421 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
422 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
423 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
424 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
425 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
426 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
427 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
428 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
430 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].burst_length
=
431 qemu_opt_get_number(opts
, "throttling.bps-total-max-length", 1);
432 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].burst_length
=
433 qemu_opt_get_number(opts
, "throttling.bps-read-max-length", 1);
434 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].burst_length
=
435 qemu_opt_get_number(opts
, "throttling.bps-write-max-length", 1);
436 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].burst_length
=
437 qemu_opt_get_number(opts
, "throttling.iops-total-max-length", 1);
438 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].burst_length
=
439 qemu_opt_get_number(opts
, "throttling.iops-read-max-length", 1);
440 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].burst_length
=
441 qemu_opt_get_number(opts
, "throttling.iops-write-max-length", 1);
443 throttle_cfg
->op_size
=
444 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
446 if (!throttle_is_valid(throttle_cfg
, errp
)) {
453 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup
,
454 qemu_opt_get(opts
, "detect-zeroes"),
455 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
458 error_propagate(errp
, local_error
);
464 /* Takes the ownership of bs_opts */
465 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
470 int on_read_error
, on_write_error
;
471 bool account_invalid
, account_failed
;
472 bool writethrough
, read_only
;
474 BlockDriverState
*bs
;
479 QDict
*interval_dict
= NULL
;
480 QList
*interval_list
= NULL
;
482 BlockdevDetectZeroesOptions detect_zeroes
=
483 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
484 const char *throttling_group
= NULL
;
486 /* Check common options by copying from bs_opts to opts, all other options
487 * stay in bs_opts for processing by bdrv_open(). */
488 id
= qdict_get_try_str(bs_opts
, "id");
489 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
491 error_propagate(errp
, error
);
495 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
497 error_propagate(errp
, error
);
502 qdict_del(bs_opts
, "id");
505 /* extract parameters */
506 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
508 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
509 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
511 writethrough
= !qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true);
513 id
= qemu_opts_id(opts
);
515 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
516 qdict_array_split(interval_dict
, &interval_list
);
518 if (qdict_size(interval_dict
) != 0) {
519 error_setg(errp
, "Invalid option stats-intervals.%s",
520 qdict_first(interval_dict
)->key
);
524 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
525 &detect_zeroes
, &error
);
527 error_propagate(errp
, error
);
531 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
532 if (is_help_option(buf
)) {
533 error_printf("Supported formats:");
534 bdrv_iterate_format(bdrv_format_print
, NULL
);
539 if (qdict_haskey(bs_opts
, "driver")) {
540 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
543 qdict_put_str(bs_opts
, "driver", buf
);
546 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
547 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
548 on_write_error
= parse_block_error_action(buf
, 0, &error
);
550 error_propagate(errp
, error
);
555 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
556 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
557 on_read_error
= parse_block_error_action(buf
, 1, &error
);
559 error_propagate(errp
, error
);
565 bdrv_flags
|= BDRV_O_SNAPSHOT
;
568 read_only
= qemu_opt_get_bool(opts
, BDRV_OPT_READ_ONLY
, false);
571 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
572 BlockBackendRootState
*blk_rs
;
574 blk
= blk_new(0, BLK_PERM_ALL
);
575 blk_rs
= blk_get_root_state(blk
);
576 blk_rs
->open_flags
= bdrv_flags
;
577 blk_rs
->read_only
= read_only
;
578 blk_rs
->detect_zeroes
= detect_zeroes
;
580 qobject_unref(bs_opts
);
582 if (file
&& !*file
) {
586 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
587 * with other callers) rather than what we want as the real defaults.
588 * Apply the defaults here instead. */
589 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
590 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
591 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
,
592 read_only
? "on" : "off");
593 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
595 if (runstate_check(RUN_STATE_INMIGRATE
)) {
596 bdrv_flags
|= BDRV_O_INACTIVE
;
599 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
605 bs
->detect_zeroes
= detect_zeroes
;
607 block_acct_setup(blk_get_stats(blk
), account_invalid
, account_failed
);
609 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
616 /* disk I/O throttling */
617 if (throttle_enabled(&cfg
)) {
618 if (!throttling_group
) {
619 throttling_group
= id
;
621 blk_io_limits_enable(blk
, throttling_group
);
622 blk_set_io_limits(blk
, &cfg
);
625 blk_set_enable_write_cache(blk
, !writethrough
);
626 blk_set_on_error(blk
, on_read_error
, on_write_error
);
628 if (!monitor_add_blk(blk
, id
, errp
)) {
636 qobject_unref(interval_dict
);
637 qobject_unref(interval_list
);
642 qobject_unref(interval_dict
);
643 qobject_unref(interval_list
);
645 qobject_unref(bs_opts
);
649 /* Takes the ownership of bs_opts */
650 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
654 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
655 * with other callers) rather than what we want as the real defaults.
656 * Apply the defaults here instead. */
657 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
658 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
659 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
661 if (runstate_check(RUN_STATE_INMIGRATE
)) {
662 bdrv_flags
|= BDRV_O_INACTIVE
;
665 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
668 void blockdev_close_all_bdrv_states(void)
670 BlockDriverState
*bs
, *next_bs
;
672 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
673 AioContext
*ctx
= bdrv_get_aio_context(bs
);
675 aio_context_acquire(ctx
);
677 aio_context_release(ctx
);
681 /* Iterates over the list of monitor-owned BlockDriverStates */
682 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
684 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
685 : QTAILQ_FIRST(&monitor_bdrv_states
);
688 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
693 value
= qemu_opt_get(opts
, from
);
695 if (qemu_opt_find(opts
, to
)) {
696 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
697 "same time", to
, from
);
702 /* rename all items in opts */
703 while ((value
= qemu_opt_get(opts
, from
))) {
704 qemu_opt_set(opts
, to
, value
, &error_abort
);
705 qemu_opt_unset(opts
, from
);
709 QemuOptsList qemu_legacy_drive_opts
= {
711 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
715 .type
= QEMU_OPT_NUMBER
,
716 .help
= "bus number",
719 .type
= QEMU_OPT_NUMBER
,
720 .help
= "unit number (i.e. lun for scsi)",
723 .type
= QEMU_OPT_NUMBER
,
724 .help
= "index number",
727 .type
= QEMU_OPT_STRING
,
728 .help
= "media type (disk, cdrom)",
731 .type
= QEMU_OPT_STRING
,
732 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
735 .type
= QEMU_OPT_STRING
,
739 /* Options that are passed on, but have special semantics with -drive */
741 .name
= BDRV_OPT_READ_ONLY
,
742 .type
= QEMU_OPT_BOOL
,
743 .help
= "open drive file as read-only",
746 .type
= QEMU_OPT_STRING
,
747 .help
= "read error action",
750 .type
= QEMU_OPT_STRING
,
751 .help
= "write error action",
753 .name
= "copy-on-read",
754 .type
= QEMU_OPT_BOOL
,
755 .help
= "copy read data from backing file into image file",
758 { /* end of list */ }
762 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
,
767 DriveInfo
*dinfo
= NULL
;
769 QemuOpts
*legacy_opts
;
770 DriveMediaType media
= MEDIA_DISK
;
771 BlockInterfaceType type
;
772 int max_devs
, bus_id
, unit_id
, index
;
773 const char *werror
, *rerror
;
774 bool read_only
= false;
776 const char *filename
;
777 Error
*local_err
= NULL
;
780 /* Change legacy command line options into QMP ones */
781 static const struct {
785 { "iops", "throttling.iops-total" },
786 { "iops_rd", "throttling.iops-read" },
787 { "iops_wr", "throttling.iops-write" },
789 { "bps", "throttling.bps-total" },
790 { "bps_rd", "throttling.bps-read" },
791 { "bps_wr", "throttling.bps-write" },
793 { "iops_max", "throttling.iops-total-max" },
794 { "iops_rd_max", "throttling.iops-read-max" },
795 { "iops_wr_max", "throttling.iops-write-max" },
797 { "bps_max", "throttling.bps-total-max" },
798 { "bps_rd_max", "throttling.bps-read-max" },
799 { "bps_wr_max", "throttling.bps-write-max" },
801 { "iops_size", "throttling.iops-size" },
803 { "group", "throttling.group" },
805 { "readonly", BDRV_OPT_READ_ONLY
},
808 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
809 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
812 error_propagate(errp
, local_err
);
817 value
= qemu_opt_get(all_opts
, "cache");
822 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
823 error_setg(errp
, "invalid cache option");
827 /* Specific options take precedence */
828 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
829 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
830 !writethrough
, &error_abort
);
832 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
833 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
834 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
836 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
837 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
838 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
840 qemu_opt_unset(all_opts
, "cache");
843 /* Get a QDict for processing the options */
844 bs_opts
= qdict_new();
845 qemu_opts_to_qdict(all_opts
, bs_opts
);
847 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
849 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
851 error_propagate(errp
, local_err
);
856 value
= qemu_opt_get(legacy_opts
, "media");
858 if (!strcmp(value
, "disk")) {
860 } else if (!strcmp(value
, "cdrom")) {
864 error_setg(errp
, "'%s' invalid media", value
);
869 /* copy-on-read is disabled with a warning for read-only devices */
870 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
871 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
873 if (read_only
&& copy_on_read
) {
874 warn_report("disabling copy-on-read on read-only drive");
875 copy_on_read
= false;
878 qdict_put_str(bs_opts
, BDRV_OPT_READ_ONLY
, read_only
? "on" : "off");
879 qdict_put_str(bs_opts
, "copy-on-read", copy_on_read
? "on" : "off");
881 /* Controller type */
882 value
= qemu_opt_get(legacy_opts
, "if");
885 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
888 if (type
== IF_COUNT
) {
889 error_setg(errp
, "unsupported bus type '%s'", value
);
893 type
= block_default_type
;
896 /* Device address specified by bus/unit or index.
897 * If none was specified, try to find the first free one. */
898 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
899 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
900 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
902 max_devs
= if_max_devs
[type
];
905 if (bus_id
!= 0 || unit_id
!= -1) {
906 error_setg(errp
, "index cannot be used with bus and unit");
909 bus_id
= drive_index_to_bus_id(type
, index
);
910 unit_id
= drive_index_to_unit_id(type
, index
);
915 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
917 if (max_devs
&& unit_id
>= max_devs
) {
924 if (max_devs
&& unit_id
>= max_devs
) {
925 error_setg(errp
, "unit %d too big (max is %d)", unit_id
, max_devs
- 1);
929 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
930 error_setg(errp
, "drive with bus=%d, unit=%d (index=%d) exists",
931 bus_id
, unit_id
, index
);
935 /* no id supplied -> create one */
936 if (qemu_opts_id(all_opts
) == NULL
) {
938 const char *mediastr
= "";
939 if (type
== IF_IDE
|| type
== IF_SCSI
) {
940 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
943 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
946 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
949 qdict_put_str(bs_opts
, "id", new_id
);
953 /* Add virtio block device */
954 if (type
== IF_VIRTIO
) {
956 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
958 if (arch_type
== QEMU_ARCH_S390X
) {
959 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
961 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
963 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
967 filename
= qemu_opt_get(legacy_opts
, "file");
969 /* Check werror/rerror compatibility with if=... */
970 werror
= qemu_opt_get(legacy_opts
, "werror");
971 if (werror
!= NULL
) {
972 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
974 error_setg(errp
, "werror is not supported by this bus type");
977 qdict_put_str(bs_opts
, "werror", werror
);
980 rerror
= qemu_opt_get(legacy_opts
, "rerror");
981 if (rerror
!= NULL
) {
982 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
984 error_setg(errp
, "rerror is not supported by this bus type");
987 qdict_put_str(bs_opts
, "rerror", rerror
);
990 /* Actual block device init: Functionality shared with blockdev-add */
991 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
995 error_propagate(errp
, local_err
);
1002 /* Create legacy DriveInfo */
1003 dinfo
= g_malloc0(sizeof(*dinfo
));
1004 dinfo
->opts
= all_opts
;
1007 dinfo
->bus
= bus_id
;
1008 dinfo
->unit
= unit_id
;
1010 blk_set_legacy_dinfo(blk
, dinfo
);
1017 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1024 qemu_opts_del(legacy_opts
);
1025 qobject_unref(bs_opts
);
1029 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1031 BlockDriverState
*bs
;
1033 bs
= bdrv_lookup_bs(name
, name
, errp
);
1038 if (!bdrv_is_root_node(bs
)) {
1039 error_setg(errp
, "Need a root block node");
1043 if (!bdrv_is_inserted(bs
)) {
1044 error_setg(errp
, "Device has no medium");
1051 static BlockBackend
*qmp_get_blk(const char *blk_name
, const char *qdev_id
,
1056 if (!blk_name
== !qdev_id
) {
1057 error_setg(errp
, "Need exactly one of 'device' and 'id'");
1062 blk
= blk_by_qdev_id(qdev_id
, errp
);
1064 blk
= blk_by_name(blk_name
);
1066 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1067 "Device '%s' not found", blk_name
);
1074 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1076 const char *device
= qdict_get_str(qdict
, "device");
1080 if (!strcmp(device
, "all")) {
1081 ret
= blk_commit_all();
1083 BlockDriverState
*bs
;
1084 AioContext
*aio_context
;
1086 blk
= blk_by_name(device
);
1088 monitor_printf(mon
, "Device '%s' not found\n", device
);
1091 if (!blk_is_available(blk
)) {
1092 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1097 aio_context
= bdrv_get_aio_context(bs
);
1098 aio_context_acquire(aio_context
);
1100 ret
= bdrv_commit(bs
);
1102 aio_context_release(aio_context
);
1105 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1110 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1112 TransactionActionList list
;
1114 list
.value
= action
;
1116 qmp_transaction(&list
, false, NULL
, errp
);
1119 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1120 bool has_node_name
, const char *node_name
,
1121 const char *snapshot_file
,
1122 bool has_snapshot_node_name
,
1123 const char *snapshot_node_name
,
1124 bool has_format
, const char *format
,
1125 bool has_mode
, NewImageMode mode
, Error
**errp
)
1127 BlockdevSnapshotSync snapshot
= {
1128 .has_device
= has_device
,
1129 .device
= (char *) device
,
1130 .has_node_name
= has_node_name
,
1131 .node_name
= (char *) node_name
,
1132 .snapshot_file
= (char *) snapshot_file
,
1133 .has_snapshot_node_name
= has_snapshot_node_name
,
1134 .snapshot_node_name
= (char *) snapshot_node_name
,
1135 .has_format
= has_format
,
1136 .format
= (char *) format
,
1137 .has_mode
= has_mode
,
1140 TransactionAction action
= {
1141 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1142 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1144 blockdev_do_action(&action
, errp
);
1147 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1150 BlockdevSnapshot snapshot_data
= {
1151 .node
= (char *) node
,
1152 .overlay
= (char *) overlay
1154 TransactionAction action
= {
1155 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1156 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1158 blockdev_do_action(&action
, errp
);
1161 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1165 BlockdevSnapshotInternal snapshot
= {
1166 .device
= (char *) device
,
1167 .name
= (char *) name
1169 TransactionAction action
= {
1170 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1171 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1173 blockdev_do_action(&action
, errp
);
1176 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1183 BlockDriverState
*bs
;
1184 AioContext
*aio_context
;
1185 QEMUSnapshotInfo sn
;
1186 Error
*local_err
= NULL
;
1187 SnapshotInfo
*info
= NULL
;
1190 bs
= qmp_get_root_bs(device
, errp
);
1194 aio_context
= bdrv_get_aio_context(bs
);
1195 aio_context_acquire(aio_context
);
1206 error_setg(errp
, "Name or id must be provided");
1207 goto out_aio_context
;
1210 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1211 goto out_aio_context
;
1214 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1216 error_propagate(errp
, local_err
);
1217 goto out_aio_context
;
1221 "Snapshot with id '%s' and name '%s' does not exist on "
1223 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1224 goto out_aio_context
;
1227 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1229 error_propagate(errp
, local_err
);
1230 goto out_aio_context
;
1233 aio_context_release(aio_context
);
1235 info
= g_new0(SnapshotInfo
, 1);
1236 info
->id
= g_strdup(sn
.id_str
);
1237 info
->name
= g_strdup(sn
.name
);
1238 info
->date_nsec
= sn
.date_nsec
;
1239 info
->date_sec
= sn
.date_sec
;
1240 info
->vm_state_size
= sn
.vm_state_size
;
1241 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1242 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1247 aio_context_release(aio_context
);
1252 * block_dirty_bitmap_lookup:
1253 * Return a dirty bitmap (if present), after validating
1254 * the node reference and bitmap names.
1256 * @node: The name of the BDS node to search for bitmaps
1257 * @name: The name of the bitmap to search for
1258 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1259 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1260 * @errp: Output pointer for error information. Can be NULL.
1262 * @return: A bitmap object on success, or NULL on failure.
1264 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1266 BlockDriverState
**pbs
,
1269 BlockDriverState
*bs
;
1270 BdrvDirtyBitmap
*bitmap
;
1273 error_setg(errp
, "Node cannot be NULL");
1277 error_setg(errp
, "Bitmap name cannot be NULL");
1280 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1282 error_setg(errp
, "Node '%s' not found", node
);
1286 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1288 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1299 /* New and old BlockDriverState structs for atomic group operations */
1301 typedef struct BlkActionState BlkActionState
;
1305 * Table of operations that define an Action.
1307 * @instance_size: Size of state struct, in bytes.
1308 * @prepare: Prepare the work, must NOT be NULL.
1309 * @commit: Commit the changes, can be NULL.
1310 * @abort: Abort the changes on fail, can be NULL.
1311 * @clean: Clean up resources after all transaction actions have called
1312 * commit() or abort(). Can be NULL.
1314 * Only prepare() may fail. In a single transaction, only one of commit() or
1315 * abort() will be called. clean() will always be called if it is present.
1317 typedef struct BlkActionOps
{
1318 size_t instance_size
;
1319 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1320 void (*commit
)(BlkActionState
*common
);
1321 void (*abort
)(BlkActionState
*common
);
1322 void (*clean
)(BlkActionState
*common
);
1327 * Describes one Action's state within a Transaction.
1329 * @action: QAPI-defined enum identifying which Action to perform.
1330 * @ops: Table of ActionOps this Action can perform.
1331 * @block_job_txn: Transaction which this action belongs to.
1332 * @entry: List membership for all Actions in this Transaction.
1334 * This structure must be arranged as first member in a subclassed type,
1335 * assuming that the compiler will also arrange it to the same offsets as the
1338 struct BlkActionState
{
1339 TransactionAction
*action
;
1340 const BlkActionOps
*ops
;
1341 JobTxn
*block_job_txn
;
1342 TransactionProperties
*txn_props
;
1343 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1346 /* internal snapshot private data */
1347 typedef struct InternalSnapshotState
{
1348 BlkActionState common
;
1349 BlockDriverState
*bs
;
1350 QEMUSnapshotInfo sn
;
1352 } InternalSnapshotState
;
1355 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1357 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1359 "Action '%s' does not support Transaction property "
1360 "completion-mode = %s",
1361 TransactionActionKind_str(s
->action
->type
),
1362 ActionCompletionMode_str(s
->txn_props
->completion_mode
));
1368 static void internal_snapshot_prepare(BlkActionState
*common
,
1371 Error
*local_err
= NULL
;
1374 BlockDriverState
*bs
;
1375 QEMUSnapshotInfo old_sn
, *sn
;
1378 BlockdevSnapshotInternal
*internal
;
1379 InternalSnapshotState
*state
;
1380 AioContext
*aio_context
;
1383 g_assert(common
->action
->type
==
1384 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1385 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1386 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1388 /* 1. parse input */
1389 device
= internal
->device
;
1390 name
= internal
->name
;
1392 /* 2. check for validation */
1393 if (action_check_completion_mode(common
, errp
) < 0) {
1397 bs
= qmp_get_root_bs(device
, errp
);
1402 aio_context
= bdrv_get_aio_context(bs
);
1403 aio_context_acquire(aio_context
);
1407 /* Paired with .clean() */
1408 bdrv_drained_begin(bs
);
1410 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1414 if (bdrv_is_read_only(bs
)) {
1415 error_setg(errp
, "Device '%s' is read only", device
);
1419 if (!bdrv_can_snapshot(bs
)) {
1420 error_setg(errp
, "Block format '%s' used by device '%s' "
1421 "does not support internal snapshots",
1422 bs
->drv
->format_name
, device
);
1426 if (!strlen(name
)) {
1427 error_setg(errp
, "Name is empty");
1431 /* check whether a snapshot with name exist */
1432 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1435 error_propagate(errp
, local_err
);
1439 "Snapshot with name '%s' already exists on device '%s'",
1444 /* 3. take the snapshot */
1446 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1447 qemu_gettimeofday(&tv
);
1448 sn
->date_sec
= tv
.tv_sec
;
1449 sn
->date_nsec
= tv
.tv_usec
* 1000;
1450 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1452 ret1
= bdrv_snapshot_create(bs
, sn
);
1454 error_setg_errno(errp
, -ret1
,
1455 "Failed to create snapshot '%s' on device '%s'",
1460 /* 4. succeed, mark a snapshot is created */
1461 state
->created
= true;
1464 aio_context_release(aio_context
);
1467 static void internal_snapshot_abort(BlkActionState
*common
)
1469 InternalSnapshotState
*state
=
1470 DO_UPCAST(InternalSnapshotState
, common
, common
);
1471 BlockDriverState
*bs
= state
->bs
;
1472 QEMUSnapshotInfo
*sn
= &state
->sn
;
1473 AioContext
*aio_context
;
1474 Error
*local_error
= NULL
;
1476 if (!state
->created
) {
1480 aio_context
= bdrv_get_aio_context(state
->bs
);
1481 aio_context_acquire(aio_context
);
1483 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1484 error_reportf_err(local_error
,
1485 "Failed to delete snapshot with id '%s' and "
1486 "name '%s' on device '%s' in abort: ",
1487 sn
->id_str
, sn
->name
,
1488 bdrv_get_device_name(bs
));
1491 aio_context_release(aio_context
);
1494 static void internal_snapshot_clean(BlkActionState
*common
)
1496 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1498 AioContext
*aio_context
;
1504 aio_context
= bdrv_get_aio_context(state
->bs
);
1505 aio_context_acquire(aio_context
);
1507 bdrv_drained_end(state
->bs
);
1509 aio_context_release(aio_context
);
1512 /* external snapshot private data */
1513 typedef struct ExternalSnapshotState
{
1514 BlkActionState common
;
1515 BlockDriverState
*old_bs
;
1516 BlockDriverState
*new_bs
;
1517 bool overlay_appended
;
1518 } ExternalSnapshotState
;
1520 static void external_snapshot_prepare(BlkActionState
*common
,
1524 QDict
*options
= NULL
;
1525 Error
*local_err
= NULL
;
1526 /* Device and node name of the image to generate the snapshot from */
1528 const char *node_name
;
1529 /* Reference to the new image (for 'blockdev-snapshot') */
1530 const char *snapshot_ref
;
1531 /* File name of the new image (for 'blockdev-snapshot-sync') */
1532 const char *new_image_file
;
1533 ExternalSnapshotState
*state
=
1534 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1535 TransactionAction
*action
= common
->action
;
1536 AioContext
*aio_context
;
1538 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1539 * purpose but a different set of parameters */
1540 switch (action
->type
) {
1541 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1543 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1545 node_name
= s
->node
;
1546 new_image_file
= NULL
;
1547 snapshot_ref
= s
->overlay
;
1550 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1552 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1553 device
= s
->has_device
? s
->device
: NULL
;
1554 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1555 new_image_file
= s
->snapshot_file
;
1556 snapshot_ref
= NULL
;
1560 g_assert_not_reached();
1563 /* start processing */
1564 if (action_check_completion_mode(common
, errp
) < 0) {
1568 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1569 if (!state
->old_bs
) {
1573 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1574 aio_context_acquire(aio_context
);
1576 /* Paired with .clean() */
1577 bdrv_drained_begin(state
->old_bs
);
1579 if (!bdrv_is_inserted(state
->old_bs
)) {
1580 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1584 if (bdrv_op_is_blocked(state
->old_bs
,
1585 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1589 if (!bdrv_is_read_only(state
->old_bs
)) {
1590 if (bdrv_flush(state
->old_bs
)) {
1591 error_setg(errp
, QERR_IO_ERROR
);
1596 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1597 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1601 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1602 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1603 const char *format
= s
->has_format
? s
->format
: "qcow2";
1604 enum NewImageMode mode
;
1605 const char *snapshot_node_name
=
1606 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1608 if (node_name
&& !snapshot_node_name
) {
1609 error_setg(errp
, "New snapshot node name missing");
1613 if (snapshot_node_name
&&
1614 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1615 error_setg(errp
, "New snapshot node name already in use");
1619 flags
= state
->old_bs
->open_flags
;
1620 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_COPY_ON_READ
);
1621 flags
|= BDRV_O_NO_BACKING
;
1623 /* create new image w/backing file */
1624 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1625 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1626 int64_t size
= bdrv_getlength(state
->old_bs
);
1628 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1631 bdrv_img_create(new_image_file
, format
,
1632 state
->old_bs
->filename
,
1633 state
->old_bs
->drv
->format_name
,
1634 NULL
, size
, flags
, false, &local_err
);
1636 error_propagate(errp
, local_err
);
1641 options
= qdict_new();
1642 if (s
->has_snapshot_node_name
) {
1643 qdict_put_str(options
, "node-name", snapshot_node_name
);
1645 qdict_put_str(options
, "driver", format
);
1648 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1650 /* We will manually add the backing_hd field to the bs later */
1651 if (!state
->new_bs
) {
1655 if (bdrv_has_blk(state
->new_bs
)) {
1656 error_setg(errp
, "The snapshot is already in use");
1660 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1665 if (state
->new_bs
->backing
!= NULL
) {
1666 error_setg(errp
, "The snapshot already has a backing image");
1670 if (!state
->new_bs
->drv
->supports_backing
) {
1671 error_setg(errp
, "The snapshot does not support backing images");
1675 bdrv_set_aio_context(state
->new_bs
, aio_context
);
1677 /* This removes our old bs and adds the new bs. This is an operation that
1678 * can fail, so we need to do it in .prepare; undoing it for abort is
1679 * always possible. */
1680 bdrv_ref(state
->new_bs
);
1681 bdrv_append(state
->new_bs
, state
->old_bs
, &local_err
);
1683 error_propagate(errp
, local_err
);
1686 state
->overlay_appended
= true;
1689 aio_context_release(aio_context
);
1692 static void external_snapshot_commit(BlkActionState
*common
)
1694 ExternalSnapshotState
*state
=
1695 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1696 AioContext
*aio_context
;
1698 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1699 aio_context_acquire(aio_context
);
1701 /* We don't need (or want) to use the transactional
1702 * bdrv_reopen_multiple() across all the entries at once, because we
1703 * don't want to abort all of them if one of them fails the reopen */
1704 if (!atomic_read(&state
->old_bs
->copy_on_read
)) {
1705 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1709 aio_context_release(aio_context
);
1712 static void external_snapshot_abort(BlkActionState
*common
)
1714 ExternalSnapshotState
*state
=
1715 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1716 if (state
->new_bs
) {
1717 if (state
->overlay_appended
) {
1718 AioContext
*aio_context
;
1720 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1721 aio_context_acquire(aio_context
);
1723 bdrv_ref(state
->old_bs
); /* we can't let bdrv_set_backind_hd()
1724 close state->old_bs; we need it */
1725 bdrv_set_backing_hd(state
->new_bs
, NULL
, &error_abort
);
1726 bdrv_replace_node(state
->new_bs
, state
->old_bs
, &error_abort
);
1727 bdrv_unref(state
->old_bs
); /* bdrv_replace_node() ref'ed old_bs */
1729 aio_context_release(aio_context
);
1734 static void external_snapshot_clean(BlkActionState
*common
)
1736 ExternalSnapshotState
*state
=
1737 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1738 AioContext
*aio_context
;
1740 if (!state
->old_bs
) {
1744 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1745 aio_context_acquire(aio_context
);
1747 bdrv_drained_end(state
->old_bs
);
1748 bdrv_unref(state
->new_bs
);
1750 aio_context_release(aio_context
);
1753 typedef struct DriveBackupState
{
1754 BlkActionState common
;
1755 BlockDriverState
*bs
;
1759 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
1762 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1764 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1765 BlockDriverState
*bs
;
1766 DriveBackup
*backup
;
1767 AioContext
*aio_context
;
1768 Error
*local_err
= NULL
;
1770 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1771 backup
= common
->action
->u
.drive_backup
.data
;
1773 bs
= qmp_get_root_bs(backup
->device
, errp
);
1778 aio_context
= bdrv_get_aio_context(bs
);
1779 aio_context_acquire(aio_context
);
1781 /* Paired with .clean() */
1782 bdrv_drained_begin(bs
);
1786 state
->job
= do_drive_backup(backup
, common
->block_job_txn
, &local_err
);
1788 error_propagate(errp
, local_err
);
1793 aio_context_release(aio_context
);
1796 static void drive_backup_commit(BlkActionState
*common
)
1798 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1799 AioContext
*aio_context
;
1801 aio_context
= bdrv_get_aio_context(state
->bs
);
1802 aio_context_acquire(aio_context
);
1805 job_start(&state
->job
->job
);
1807 aio_context_release(aio_context
);
1810 static void drive_backup_abort(BlkActionState
*common
)
1812 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1815 AioContext
*aio_context
;
1817 aio_context
= bdrv_get_aio_context(state
->bs
);
1818 aio_context_acquire(aio_context
);
1820 job_cancel_sync(&state
->job
->job
);
1822 aio_context_release(aio_context
);
1826 static void drive_backup_clean(BlkActionState
*common
)
1828 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1829 AioContext
*aio_context
;
1835 aio_context
= bdrv_get_aio_context(state
->bs
);
1836 aio_context_acquire(aio_context
);
1838 bdrv_drained_end(state
->bs
);
1840 aio_context_release(aio_context
);
1843 typedef struct BlockdevBackupState
{
1844 BlkActionState common
;
1845 BlockDriverState
*bs
;
1847 } BlockdevBackupState
;
1849 static BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
1852 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1854 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1855 BlockdevBackup
*backup
;
1856 BlockDriverState
*bs
, *target
;
1857 AioContext
*aio_context
;
1858 Error
*local_err
= NULL
;
1860 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1861 backup
= common
->action
->u
.blockdev_backup
.data
;
1863 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1868 target
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1873 aio_context
= bdrv_get_aio_context(bs
);
1874 if (aio_context
!= bdrv_get_aio_context(target
)) {
1875 error_setg(errp
, "Backup between two IO threads is not implemented");
1878 aio_context_acquire(aio_context
);
1881 /* Paired with .clean() */
1882 bdrv_drained_begin(state
->bs
);
1884 state
->job
= do_blockdev_backup(backup
, common
->block_job_txn
, &local_err
);
1886 error_propagate(errp
, local_err
);
1891 aio_context_release(aio_context
);
1894 static void blockdev_backup_commit(BlkActionState
*common
)
1896 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1897 AioContext
*aio_context
;
1899 aio_context
= bdrv_get_aio_context(state
->bs
);
1900 aio_context_acquire(aio_context
);
1903 job_start(&state
->job
->job
);
1905 aio_context_release(aio_context
);
1908 static void blockdev_backup_abort(BlkActionState
*common
)
1910 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1913 AioContext
*aio_context
;
1915 aio_context
= bdrv_get_aio_context(state
->bs
);
1916 aio_context_acquire(aio_context
);
1918 job_cancel_sync(&state
->job
->job
);
1920 aio_context_release(aio_context
);
1924 static void blockdev_backup_clean(BlkActionState
*common
)
1926 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1927 AioContext
*aio_context
;
1933 aio_context
= bdrv_get_aio_context(state
->bs
);
1934 aio_context_acquire(aio_context
);
1936 bdrv_drained_end(state
->bs
);
1938 aio_context_release(aio_context
);
1941 typedef struct BlockDirtyBitmapState
{
1942 BlkActionState common
;
1943 BdrvDirtyBitmap
*bitmap
;
1944 BlockDriverState
*bs
;
1948 } BlockDirtyBitmapState
;
1950 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1953 Error
*local_err
= NULL
;
1954 BlockDirtyBitmapAdd
*action
;
1955 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1958 if (action_check_completion_mode(common
, errp
) < 0) {
1962 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1963 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1964 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
1965 action
->has_granularity
, action
->granularity
,
1966 action
->has_persistent
, action
->persistent
,
1967 action
->has_autoload
, action
->autoload
,
1968 action
->has_x_disabled
, action
->x_disabled
,
1972 state
->prepared
= true;
1974 error_propagate(errp
, local_err
);
1978 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
1980 BlockDirtyBitmapAdd
*action
;
1981 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1984 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1985 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1986 * then the node reference and bitmap name must have been valid.
1988 if (state
->prepared
) {
1989 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
1993 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
1996 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1998 BlockDirtyBitmap
*action
;
2000 if (action_check_completion_mode(common
, errp
) < 0) {
2004 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2005 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2009 if (!state
->bitmap
) {
2013 if (bdrv_dirty_bitmap_frozen(state
->bitmap
)) {
2014 error_setg(errp
, "Cannot modify a frozen bitmap");
2016 } else if (bdrv_dirty_bitmap_qmp_locked(state
->bitmap
)) {
2017 error_setg(errp
, "Cannot modify a locked bitmap");
2019 } else if (!bdrv_dirty_bitmap_enabled(state
->bitmap
)) {
2020 error_setg(errp
, "Cannot clear a disabled bitmap");
2022 } else if (bdrv_dirty_bitmap_readonly(state
->bitmap
)) {
2023 error_setg(errp
, "Cannot clear a readonly bitmap");
2027 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2030 static void block_dirty_bitmap_restore(BlkActionState
*common
)
2032 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2035 if (state
->backup
) {
2036 bdrv_restore_dirty_bitmap(state
->bitmap
, state
->backup
);
2040 static void block_dirty_bitmap_free_backup(BlkActionState
*common
)
2042 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2045 hbitmap_free(state
->backup
);
2048 static void block_dirty_bitmap_enable_prepare(BlkActionState
*common
,
2051 BlockDirtyBitmap
*action
;
2052 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2055 if (action_check_completion_mode(common
, errp
) < 0) {
2059 action
= common
->action
->u
.x_block_dirty_bitmap_enable
.data
;
2060 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2064 if (!state
->bitmap
) {
2068 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2069 bdrv_enable_dirty_bitmap(state
->bitmap
);
2072 static void block_dirty_bitmap_enable_abort(BlkActionState
*common
)
2074 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2077 if (!state
->was_enabled
) {
2078 bdrv_disable_dirty_bitmap(state
->bitmap
);
2082 static void block_dirty_bitmap_disable_prepare(BlkActionState
*common
,
2085 BlockDirtyBitmap
*action
;
2086 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2089 if (action_check_completion_mode(common
, errp
) < 0) {
2093 action
= common
->action
->u
.x_block_dirty_bitmap_disable
.data
;
2094 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2098 if (!state
->bitmap
) {
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 void abort_prepare(BlkActionState
*common
, Error
**errp
)
2118 error_setg(errp
, "Transaction aborted using Abort action");
2121 static void abort_commit(BlkActionState
*common
)
2123 g_assert_not_reached(); /* this action never succeeds */
2126 static const BlkActionOps actions
[] = {
2127 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2128 .instance_size
= sizeof(ExternalSnapshotState
),
2129 .prepare
= external_snapshot_prepare
,
2130 .commit
= external_snapshot_commit
,
2131 .abort
= external_snapshot_abort
,
2132 .clean
= external_snapshot_clean
,
2134 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2135 .instance_size
= sizeof(ExternalSnapshotState
),
2136 .prepare
= external_snapshot_prepare
,
2137 .commit
= external_snapshot_commit
,
2138 .abort
= external_snapshot_abort
,
2139 .clean
= external_snapshot_clean
,
2141 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2142 .instance_size
= sizeof(DriveBackupState
),
2143 .prepare
= drive_backup_prepare
,
2144 .commit
= drive_backup_commit
,
2145 .abort
= drive_backup_abort
,
2146 .clean
= drive_backup_clean
,
2148 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2149 .instance_size
= sizeof(BlockdevBackupState
),
2150 .prepare
= blockdev_backup_prepare
,
2151 .commit
= blockdev_backup_commit
,
2152 .abort
= blockdev_backup_abort
,
2153 .clean
= blockdev_backup_clean
,
2155 [TRANSACTION_ACTION_KIND_ABORT
] = {
2156 .instance_size
= sizeof(BlkActionState
),
2157 .prepare
= abort_prepare
,
2158 .commit
= abort_commit
,
2160 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2161 .instance_size
= sizeof(InternalSnapshotState
),
2162 .prepare
= internal_snapshot_prepare
,
2163 .abort
= internal_snapshot_abort
,
2164 .clean
= internal_snapshot_clean
,
2166 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2167 .instance_size
= sizeof(BlockDirtyBitmapState
),
2168 .prepare
= block_dirty_bitmap_add_prepare
,
2169 .abort
= block_dirty_bitmap_add_abort
,
2171 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2172 .instance_size
= sizeof(BlockDirtyBitmapState
),
2173 .prepare
= block_dirty_bitmap_clear_prepare
,
2174 .commit
= block_dirty_bitmap_free_backup
,
2175 .abort
= block_dirty_bitmap_restore
,
2177 [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_ENABLE
] = {
2178 .instance_size
= sizeof(BlockDirtyBitmapState
),
2179 .prepare
= block_dirty_bitmap_enable_prepare
,
2180 .abort
= block_dirty_bitmap_enable_abort
,
2182 [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_DISABLE
] = {
2183 .instance_size
= sizeof(BlockDirtyBitmapState
),
2184 .prepare
= block_dirty_bitmap_disable_prepare
,
2185 .abort
= block_dirty_bitmap_disable_abort
,
2187 /* Where are transactions for MIRROR, COMMIT and STREAM?
2188 * Although these blockjobs use transaction callbacks like the backup job,
2189 * these jobs do not necessarily adhere to transaction semantics.
2190 * These jobs may not fully undo all of their actions on abort, nor do they
2191 * necessarily work in transactions with more than one job in them.
2196 * Allocate a TransactionProperties structure if necessary, and fill
2197 * that structure with desired defaults if they are unset.
2199 static TransactionProperties
*get_transaction_properties(
2200 TransactionProperties
*props
)
2203 props
= g_new0(TransactionProperties
, 1);
2206 if (!props
->has_completion_mode
) {
2207 props
->has_completion_mode
= true;
2208 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2215 * 'Atomic' group operations. The operations are performed as a set, and if
2216 * any fail then we roll back all operations in the group.
2218 void qmp_transaction(TransactionActionList
*dev_list
,
2220 struct TransactionProperties
*props
,
2223 TransactionActionList
*dev_entry
= dev_list
;
2224 JobTxn
*block_job_txn
= NULL
;
2225 BlkActionState
*state
, *next
;
2226 Error
*local_err
= NULL
;
2228 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkActionState
) snap_bdrv_states
;
2229 QSIMPLEQ_INIT(&snap_bdrv_states
);
2231 /* Does this transaction get canceled as a group on failure?
2232 * If not, we don't really need to make a JobTxn.
2234 props
= get_transaction_properties(props
);
2235 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2236 block_job_txn
= job_txn_new();
2239 /* drain all i/o before any operations */
2242 /* We don't do anything in this loop that commits us to the operations */
2243 while (NULL
!= dev_entry
) {
2244 TransactionAction
*dev_info
= NULL
;
2245 const BlkActionOps
*ops
;
2247 dev_info
= dev_entry
->value
;
2248 dev_entry
= dev_entry
->next
;
2250 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2252 ops
= &actions
[dev_info
->type
];
2253 assert(ops
->instance_size
> 0);
2255 state
= g_malloc0(ops
->instance_size
);
2257 state
->action
= dev_info
;
2258 state
->block_job_txn
= block_job_txn
;
2259 state
->txn_props
= props
;
2260 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2262 state
->ops
->prepare(state
, &local_err
);
2264 error_propagate(errp
, local_err
);
2265 goto delete_and_fail
;
2269 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2270 if (state
->ops
->commit
) {
2271 state
->ops
->commit(state
);
2279 /* failure, and it is all-or-none; roll back all operations */
2280 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2281 if (state
->ops
->abort
) {
2282 state
->ops
->abort(state
);
2286 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2287 if (state
->ops
->clean
) {
2288 state
->ops
->clean(state
);
2293 qapi_free_TransactionProperties(props
);
2295 job_txn_unref(block_job_txn
);
2298 void qmp_eject(bool has_device
, const char *device
,
2299 bool has_id
, const char *id
,
2300 bool has_force
, bool force
, Error
**errp
)
2302 Error
*local_err
= NULL
;
2309 rc
= do_open_tray(has_device
? device
: NULL
,
2312 if (rc
&& rc
!= -ENOSYS
) {
2313 error_propagate(errp
, local_err
);
2316 error_free(local_err
);
2318 blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2321 void qmp_block_passwd(bool has_device
, const char *device
,
2322 bool has_node_name
, const char *node_name
,
2323 const char *password
, Error
**errp
)
2326 "Setting block passwords directly is no longer supported");
2330 * Attempt to open the tray of @device.
2331 * If @force, ignore its tray lock.
2332 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2333 * On error, store an error through @errp and return -errno.
2334 * If @device does not exist, return -ENODEV.
2335 * If it has no removable media, return -ENOTSUP.
2336 * If it has no tray, return -ENOSYS.
2337 * If the guest was asked to open the tray, return -EINPROGRESS.
2340 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2341 bool force
, Error
**errp
)
2344 const char *device
= qdev_id
?: blk_name
;
2347 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2352 if (!blk_dev_has_removable_media(blk
)) {
2353 error_setg(errp
, "Device '%s' is not removable", device
);
2357 if (!blk_dev_has_tray(blk
)) {
2358 error_setg(errp
, "Device '%s' does not have a tray", device
);
2362 if (blk_dev_is_tray_open(blk
)) {
2366 locked
= blk_dev_is_medium_locked(blk
);
2368 blk_dev_eject_request(blk
, force
);
2371 if (!locked
|| force
) {
2372 blk_dev_change_media_cb(blk
, false, &error_abort
);
2375 if (locked
&& !force
) {
2376 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2377 "wait for tray to open and try again", device
);
2378 return -EINPROGRESS
;
2384 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2385 bool has_id
, const char *id
,
2386 bool has_force
, bool force
,
2389 Error
*local_err
= NULL
;
2395 rc
= do_open_tray(has_device
? device
: NULL
,
2398 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2399 error_propagate(errp
, local_err
);
2402 error_free(local_err
);
2405 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2406 bool has_id
, const char *id
,
2410 Error
*local_err
= NULL
;
2412 device
= has_device
? device
: NULL
;
2413 id
= has_id
? id
: NULL
;
2415 blk
= qmp_get_blk(device
, id
, errp
);
2420 if (!blk_dev_has_removable_media(blk
)) {
2421 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2425 if (!blk_dev_has_tray(blk
)) {
2426 /* Ignore this command on tray-less devices */
2430 if (!blk_dev_is_tray_open(blk
)) {
2434 blk_dev_change_media_cb(blk
, true, &local_err
);
2436 error_propagate(errp
, local_err
);
2441 static void blockdev_remove_medium(bool has_device
, const char *device
,
2442 bool has_id
, const char *id
, Error
**errp
)
2445 BlockDriverState
*bs
;
2446 AioContext
*aio_context
;
2447 bool has_attached_device
;
2449 device
= has_device
? device
: NULL
;
2450 id
= has_id
? id
: NULL
;
2452 blk
= qmp_get_blk(device
, id
, errp
);
2457 /* For BBs without a device, we can exchange the BDS tree at will */
2458 has_attached_device
= blk_get_attached_dev(blk
);
2460 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2461 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2465 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2466 !blk_dev_is_tray_open(blk
))
2468 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2477 aio_context
= bdrv_get_aio_context(bs
);
2478 aio_context_acquire(aio_context
);
2480 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2486 if (!blk_dev_has_tray(blk
)) {
2487 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2488 * called at all); therefore, the medium needs to be ejected here.
2489 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2490 * value passed here (i.e. false). */
2491 blk_dev_change_media_cb(blk
, false, &error_abort
);
2495 aio_context_release(aio_context
);
2498 void qmp_blockdev_remove_medium(const char *id
, Error
**errp
)
2500 blockdev_remove_medium(false, NULL
, true, id
, errp
);
2503 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2504 BlockDriverState
*bs
, Error
**errp
)
2506 Error
*local_err
= NULL
;
2510 /* For BBs without a device, we can exchange the BDS tree at will */
2511 has_device
= blk_get_attached_dev(blk
);
2513 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2514 error_setg(errp
, "Device is not removable");
2518 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2519 error_setg(errp
, "Tray of the device is not open");
2524 error_setg(errp
, "There already is a medium in the device");
2528 ret
= blk_insert_bs(blk
, bs
, errp
);
2533 if (!blk_dev_has_tray(blk
)) {
2534 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2535 * called at all); therefore, the medium needs to be pushed into the
2537 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2538 * value passed here (i.e. true). */
2539 blk_dev_change_media_cb(blk
, true, &local_err
);
2541 error_propagate(errp
, local_err
);
2548 static void blockdev_insert_medium(bool has_device
, const char *device
,
2549 bool has_id
, const char *id
,
2550 const char *node_name
, Error
**errp
)
2553 BlockDriverState
*bs
;
2555 blk
= qmp_get_blk(has_device
? device
: NULL
,
2562 bs
= bdrv_find_node(node_name
);
2564 error_setg(errp
, "Node '%s' not found", node_name
);
2568 if (bdrv_has_blk(bs
)) {
2569 error_setg(errp
, "Node '%s' is already in use", node_name
);
2573 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2576 void qmp_blockdev_insert_medium(const char *id
, const char *node_name
,
2579 blockdev_insert_medium(false, NULL
, true, id
, node_name
, errp
);
2582 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2583 bool has_id
, const char *id
,
2584 const char *filename
,
2585 bool has_format
, const char *format
,
2587 BlockdevChangeReadOnlyMode read_only
,
2591 BlockDriverState
*medium_bs
= NULL
;
2595 QDict
*options
= NULL
;
2598 blk
= qmp_get_blk(has_device
? device
: NULL
,
2606 blk_update_root_state(blk
);
2609 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2610 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2613 if (!has_read_only
) {
2614 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2617 switch (read_only
) {
2618 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2621 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2622 bdrv_flags
&= ~BDRV_O_RDWR
;
2625 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2626 bdrv_flags
|= BDRV_O_RDWR
;
2633 options
= qdict_new();
2634 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2635 qdict_put_str(options
, "detect-zeroes", detect_zeroes
? "on" : "off");
2638 qdict_put_str(options
, "driver", format
);
2641 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2646 rc
= do_open_tray(has_device
? device
: NULL
,
2649 if (rc
&& rc
!= -ENOSYS
) {
2650 error_propagate(errp
, err
);
2656 blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2658 error_propagate(errp
, err
);
2662 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2664 error_propagate(errp
, err
);
2668 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2671 /* If the medium has been inserted, the device has its own reference, so
2672 * ours must be relinquished; and if it has not been inserted successfully,
2673 * the reference must be relinquished anyway */
2674 bdrv_unref(medium_bs
);
2677 /* throttling disk I/O limits */
2678 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2681 BlockDriverState
*bs
;
2683 AioContext
*aio_context
;
2685 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2686 arg
->has_id
? arg
->id
: NULL
,
2692 aio_context
= blk_get_aio_context(blk
);
2693 aio_context_acquire(aio_context
);
2697 error_setg(errp
, "Device has no medium");
2701 throttle_config_init(&cfg
);
2702 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2703 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2704 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2706 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2707 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2708 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2710 if (arg
->has_bps_max
) {
2711 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2713 if (arg
->has_bps_rd_max
) {
2714 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2716 if (arg
->has_bps_wr_max
) {
2717 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2719 if (arg
->has_iops_max
) {
2720 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2722 if (arg
->has_iops_rd_max
) {
2723 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2725 if (arg
->has_iops_wr_max
) {
2726 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2729 if (arg
->has_bps_max_length
) {
2730 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2732 if (arg
->has_bps_rd_max_length
) {
2733 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2735 if (arg
->has_bps_wr_max_length
) {
2736 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2738 if (arg
->has_iops_max_length
) {
2739 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2741 if (arg
->has_iops_rd_max_length
) {
2742 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2744 if (arg
->has_iops_wr_max_length
) {
2745 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2748 if (arg
->has_iops_size
) {
2749 cfg
.op_size
= arg
->iops_size
;
2752 if (!throttle_is_valid(&cfg
, errp
)) {
2756 if (throttle_enabled(&cfg
)) {
2757 /* Enable I/O limits if they're not enabled yet, otherwise
2758 * just update the throttling group. */
2759 if (!blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2760 blk_io_limits_enable(blk
,
2761 arg
->has_group
? arg
->group
:
2762 arg
->has_device
? arg
->device
:
2764 } else if (arg
->has_group
) {
2765 blk_io_limits_update_group(blk
, arg
->group
);
2767 /* Set the new throttling configuration */
2768 blk_set_io_limits(blk
, &cfg
);
2769 } else if (blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2770 /* If all throttling settings are set to 0, disable I/O limits */
2771 blk_io_limits_disable(blk
);
2775 aio_context_release(aio_context
);
2778 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2779 bool has_granularity
, uint32_t granularity
,
2780 bool has_persistent
, bool persistent
,
2781 bool has_autoload
, bool autoload
,
2782 bool has_disabled
, bool disabled
,
2785 BlockDriverState
*bs
;
2786 BdrvDirtyBitmap
*bitmap
;
2788 if (!name
|| name
[0] == '\0') {
2789 error_setg(errp
, "Bitmap name cannot be empty");
2793 bs
= bdrv_lookup_bs(node
, node
, errp
);
2798 if (has_granularity
) {
2799 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2800 error_setg(errp
, "Granularity must be power of 2 "
2801 "and at least 512");
2805 /* Default to cluster size, if available: */
2806 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2809 if (!has_persistent
) {
2814 warn_report("Autoload option is deprecated and its value is ignored");
2817 if (!has_disabled
) {
2822 !bdrv_can_store_new_dirty_bitmap(bs
, name
, granularity
, errp
))
2827 bitmap
= bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2828 if (bitmap
== NULL
) {
2833 bdrv_disable_dirty_bitmap(bitmap
);
2836 bdrv_dirty_bitmap_set_persistance(bitmap
, persistent
);
2839 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2842 BlockDriverState
*bs
;
2843 BdrvDirtyBitmap
*bitmap
;
2844 Error
*local_err
= NULL
;
2846 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2847 if (!bitmap
|| !bs
) {
2851 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2853 "Bitmap '%s' is currently frozen and cannot be removed",
2856 } else if (bdrv_dirty_bitmap_qmp_locked(bitmap
)) {
2858 "Bitmap '%s' is currently locked and cannot be removed",
2863 if (bdrv_dirty_bitmap_get_persistance(bitmap
)) {
2864 bdrv_remove_persistent_dirty_bitmap(bs
, name
, &local_err
);
2865 if (local_err
!= NULL
) {
2866 error_propagate(errp
, local_err
);
2871 bdrv_release_dirty_bitmap(bs
, bitmap
);
2875 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2876 * immediately after a full backup operation.
2878 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2881 BdrvDirtyBitmap
*bitmap
;
2882 BlockDriverState
*bs
;
2884 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2885 if (!bitmap
|| !bs
) {
2889 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2891 "Bitmap '%s' is currently frozen and cannot be modified",
2894 } else if (bdrv_dirty_bitmap_qmp_locked(bitmap
)) {
2896 "Bitmap '%s' is currently locked and cannot be modified",
2899 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2901 "Bitmap '%s' is currently disabled and cannot be cleared",
2904 } else if (bdrv_dirty_bitmap_readonly(bitmap
)) {
2905 error_setg(errp
, "Bitmap '%s' is readonly and cannot be cleared", name
);
2909 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2912 void qmp_x_block_dirty_bitmap_enable(const char *node
, const char *name
,
2915 BlockDriverState
*bs
;
2916 BdrvDirtyBitmap
*bitmap
;
2918 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2923 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2925 "Bitmap '%s' is currently frozen and cannot be enabled",
2930 bdrv_enable_dirty_bitmap(bitmap
);
2933 void qmp_x_block_dirty_bitmap_disable(const char *node
, const char *name
,
2936 BlockDriverState
*bs
;
2937 BdrvDirtyBitmap
*bitmap
;
2939 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2944 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2946 "Bitmap '%s' is currently frozen and cannot be disabled",
2951 bdrv_disable_dirty_bitmap(bitmap
);
2954 void qmp_x_block_dirty_bitmap_merge(const char *node
, const char *dst_name
,
2955 const char *src_name
, Error
**errp
)
2957 BlockDriverState
*bs
;
2958 BdrvDirtyBitmap
*dst
, *src
;
2960 dst
= block_dirty_bitmap_lookup(node
, dst_name
, &bs
, errp
);
2965 src
= bdrv_find_dirty_bitmap(bs
, src_name
);
2967 error_setg(errp
, "Dirty bitmap '%s' not found", src_name
);
2971 bdrv_merge_dirty_bitmap(dst
, src
, NULL
, errp
);
2974 BlockDirtyBitmapSha256
*qmp_x_debug_block_dirty_bitmap_sha256(const char *node
,
2978 BdrvDirtyBitmap
*bitmap
;
2979 BlockDriverState
*bs
;
2980 BlockDirtyBitmapSha256
*ret
= NULL
;
2983 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2984 if (!bitmap
|| !bs
) {
2988 sha256
= bdrv_dirty_bitmap_sha256(bitmap
, errp
);
2989 if (sha256
== NULL
) {
2993 ret
= g_new(BlockDirtyBitmapSha256
, 1);
2994 ret
->sha256
= sha256
;
2999 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
3001 const char *id
= qdict_get_str(qdict
, "id");
3003 BlockDriverState
*bs
;
3004 AioContext
*aio_context
;
3005 Error
*local_err
= NULL
;
3007 bs
= bdrv_find_node(id
);
3009 qmp_blockdev_del(id
, &local_err
);
3011 error_report_err(local_err
);
3016 blk
= blk_by_name(id
);
3018 error_report("Device '%s' not found", id
);
3022 if (!blk_legacy_dinfo(blk
)) {
3023 error_report("Deleting device added with blockdev-add"
3024 " is not supported");
3028 aio_context
= blk_get_aio_context(blk
);
3029 aio_context_acquire(aio_context
);
3033 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
3034 error_report_err(local_err
);
3035 aio_context_release(aio_context
);
3042 /* Make the BlockBackend and the attached BlockDriverState anonymous */
3043 monitor_remove_blk(blk
);
3045 /* If this BlockBackend has a device attached to it, its refcount will be
3046 * decremented when the device is removed; otherwise we have to do so here.
3048 if (blk_get_attached_dev(blk
)) {
3049 /* Further I/O must not pause the guest */
3050 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
3051 BLOCKDEV_ON_ERROR_REPORT
);
3056 aio_context_release(aio_context
);
3059 void qmp_block_resize(bool has_device
, const char *device
,
3060 bool has_node_name
, const char *node_name
,
3061 int64_t size
, Error
**errp
)
3063 Error
*local_err
= NULL
;
3064 BlockBackend
*blk
= NULL
;
3065 BlockDriverState
*bs
;
3066 AioContext
*aio_context
;
3069 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
3070 has_node_name
? node_name
: NULL
,
3073 error_propagate(errp
, local_err
);
3077 aio_context
= bdrv_get_aio_context(bs
);
3078 aio_context_acquire(aio_context
);
3080 if (!bdrv_is_first_non_filter(bs
)) {
3081 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
3086 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
3090 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
3091 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
3095 blk
= blk_new(BLK_PERM_RESIZE
, BLK_PERM_ALL
);
3096 ret
= blk_insert_bs(blk
, bs
, errp
);
3101 bdrv_drained_begin(bs
);
3102 ret
= blk_truncate(blk
, size
, PREALLOC_MODE_OFF
, errp
);
3103 bdrv_drained_end(bs
);
3107 aio_context_release(aio_context
);
3110 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
3111 bool has_base
, const char *base
,
3112 bool has_base_node
, const char *base_node
,
3113 bool has_backing_file
, const char *backing_file
,
3114 bool has_speed
, int64_t speed
,
3115 bool has_on_error
, BlockdevOnError on_error
,
3116 bool has_auto_finalize
, bool auto_finalize
,
3117 bool has_auto_dismiss
, bool auto_dismiss
,
3120 BlockDriverState
*bs
, *iter
;
3121 BlockDriverState
*base_bs
= NULL
;
3122 AioContext
*aio_context
;
3123 Error
*local_err
= NULL
;
3124 const char *base_name
= NULL
;
3125 int job_flags
= JOB_DEFAULT
;
3127 if (!has_on_error
) {
3128 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3131 bs
= bdrv_lookup_bs(device
, device
, errp
);
3136 aio_context
= bdrv_get_aio_context(bs
);
3137 aio_context_acquire(aio_context
);
3139 if (has_base
&& has_base_node
) {
3140 error_setg(errp
, "'base' and 'base-node' cannot be specified "
3141 "at the same time");
3146 base_bs
= bdrv_find_backing_image(bs
, base
);
3147 if (base_bs
== NULL
) {
3148 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
3151 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3155 if (has_base_node
) {
3156 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3160 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
3161 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
3165 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3166 base_name
= base_bs
->filename
;
3169 /* Check for op blockers in the whole chain between bs and base */
3170 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
3171 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3176 /* if we are streaming the entire chain, the result will have no backing
3177 * file, and specifying one is therefore an error */
3178 if (base_bs
== NULL
&& has_backing_file
) {
3179 error_setg(errp
, "backing file specified, but streaming the "
3184 /* backing_file string overrides base bs filename */
3185 base_name
= has_backing_file
? backing_file
: base_name
;
3187 if (has_auto_finalize
&& !auto_finalize
) {
3188 job_flags
|= JOB_MANUAL_FINALIZE
;
3190 if (has_auto_dismiss
&& !auto_dismiss
) {
3191 job_flags
|= JOB_MANUAL_DISMISS
;
3194 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
3195 job_flags
, has_speed
? speed
: 0, on_error
, &local_err
);
3197 error_propagate(errp
, local_err
);
3201 trace_qmp_block_stream(bs
, bs
->job
);
3204 aio_context_release(aio_context
);
3207 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
3208 bool has_base_node
, const char *base_node
,
3209 bool has_base
, const char *base
,
3210 bool has_top_node
, const char *top_node
,
3211 bool has_top
, const char *top
,
3212 bool has_backing_file
, const char *backing_file
,
3213 bool has_speed
, int64_t speed
,
3214 bool has_filter_node_name
, const char *filter_node_name
,
3215 bool has_auto_finalize
, bool auto_finalize
,
3216 bool has_auto_dismiss
, bool auto_dismiss
,
3219 BlockDriverState
*bs
;
3220 BlockDriverState
*iter
;
3221 BlockDriverState
*base_bs
, *top_bs
;
3222 AioContext
*aio_context
;
3223 Error
*local_err
= NULL
;
3224 /* This will be part of the QMP command, if/when the
3225 * BlockdevOnError change for blkmirror makes it in
3227 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3228 int job_flags
= JOB_DEFAULT
;
3233 if (!has_filter_node_name
) {
3234 filter_node_name
= NULL
;
3236 if (has_auto_finalize
&& !auto_finalize
) {
3237 job_flags
|= JOB_MANUAL_FINALIZE
;
3239 if (has_auto_dismiss
&& !auto_dismiss
) {
3240 job_flags
|= JOB_MANUAL_DISMISS
;
3244 * libvirt relies on the DeviceNotFound error class in order to probe for
3245 * live commit feature versions; for this to work, we must make sure to
3246 * perform the device lookup before any generic errors that may occur in a
3247 * scenario in which all optional arguments are omitted. */
3248 bs
= qmp_get_root_bs(device
, &local_err
);
3250 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3252 error_free(local_err
);
3253 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3254 "Device '%s' not found", device
);
3256 error_propagate(errp
, local_err
);
3261 aio_context
= bdrv_get_aio_context(bs
);
3262 aio_context_acquire(aio_context
);
3264 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3268 /* default top_bs is the active layer */
3271 if (has_top_node
&& has_top
) {
3272 error_setg(errp
, "'top-node' and 'top' are mutually exclusive");
3274 } else if (has_top_node
) {
3275 top_bs
= bdrv_lookup_bs(NULL
, top_node
, errp
);
3276 if (top_bs
== NULL
) {
3279 if (!bdrv_chain_contains(bs
, top_bs
)) {
3280 error_setg(errp
, "'%s' is not in this backing file chain",
3284 } else if (has_top
&& top
) {
3285 if (strcmp(bs
->filename
, top
) != 0) {
3286 top_bs
= bdrv_find_backing_image(bs
, top
);
3290 if (top_bs
== NULL
) {
3291 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3295 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3297 if (has_base_node
&& has_base
) {
3298 error_setg(errp
, "'base-node' and 'base' are mutually exclusive");
3300 } else if (has_base_node
) {
3301 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3302 if (base_bs
== NULL
) {
3305 if (!bdrv_chain_contains(top_bs
, base_bs
)) {
3306 error_setg(errp
, "'%s' is not in this backing file chain",
3310 } else if (has_base
&& base
) {
3311 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3313 base_bs
= bdrv_find_base(top_bs
);
3316 if (base_bs
== NULL
) {
3317 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3321 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3323 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
3324 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3329 /* Do not allow attempts to commit an image into itself */
3330 if (top_bs
== base_bs
) {
3331 error_setg(errp
, "cannot commit an image into itself");
3336 if (has_backing_file
) {
3337 error_setg(errp
, "'backing-file' specified,"
3338 " but 'top' is the active layer");
3341 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
3342 job_flags
, speed
, on_error
,
3343 filter_node_name
, NULL
, NULL
, false, &local_err
);
3345 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
3346 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3349 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, job_flags
,
3350 speed
, on_error
, has_backing_file
? backing_file
: NULL
,
3351 filter_node_name
, &local_err
);
3353 if (local_err
!= NULL
) {
3354 error_propagate(errp
, local_err
);
3359 aio_context_release(aio_context
);
3362 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
3365 BlockDriverState
*bs
;
3366 BlockDriverState
*target_bs
;
3367 BlockDriverState
*source
= NULL
;
3368 BlockJob
*job
= NULL
;
3369 BdrvDirtyBitmap
*bmap
= NULL
;
3370 AioContext
*aio_context
;
3371 QDict
*options
= NULL
;
3372 Error
*local_err
= NULL
;
3373 int flags
, job_flags
= JOB_DEFAULT
;
3375 bool set_backing_hd
= false;
3377 if (!backup
->has_speed
) {
3380 if (!backup
->has_on_source_error
) {
3381 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3383 if (!backup
->has_on_target_error
) {
3384 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3386 if (!backup
->has_mode
) {
3387 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3389 if (!backup
->has_job_id
) {
3390 backup
->job_id
= NULL
;
3392 if (!backup
->has_auto_finalize
) {
3393 backup
->auto_finalize
= true;
3395 if (!backup
->has_auto_dismiss
) {
3396 backup
->auto_dismiss
= true;
3398 if (!backup
->has_compress
) {
3399 backup
->compress
= false;
3402 bs
= qmp_get_root_bs(backup
->device
, errp
);
3407 aio_context
= bdrv_get_aio_context(bs
);
3408 aio_context_acquire(aio_context
);
3410 if (!backup
->has_format
) {
3411 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
3412 NULL
: (char*) bs
->drv
->format_name
;
3415 /* Early check to avoid creating target */
3416 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3420 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3422 /* See if we have a backing HD we can use to create our new image
3424 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
3425 source
= backing_bs(bs
);
3427 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
3430 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3432 flags
|= BDRV_O_NO_BACKING
;
3433 set_backing_hd
= true;
3436 size
= bdrv_getlength(bs
);
3438 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3442 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
3443 assert(backup
->format
);
3445 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
3446 source
->drv
->format_name
, NULL
,
3447 size
, flags
, false, &local_err
);
3449 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
3450 size
, flags
, false, &local_err
);
3455 error_propagate(errp
, local_err
);
3459 if (backup
->format
) {
3461 options
= qdict_new();
3463 qdict_put_str(options
, "driver", backup
->format
);
3466 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
3471 bdrv_set_aio_context(target_bs
, aio_context
);
3473 if (set_backing_hd
) {
3474 bdrv_set_backing_hd(target_bs
, source
, &local_err
);
3476 bdrv_unref(target_bs
);
3481 if (backup
->has_bitmap
) {
3482 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3484 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3485 bdrv_unref(target_bs
);
3488 if (bdrv_dirty_bitmap_qmp_locked(bmap
)) {
3490 "Bitmap '%s' is currently locked and cannot be used for "
3491 "backup", backup
->bitmap
);
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
->compress
,
3504 backup
->on_source_error
, backup
->on_target_error
,
3505 job_flags
, NULL
, NULL
, txn
, &local_err
);
3506 bdrv_unref(target_bs
);
3507 if (local_err
!= NULL
) {
3508 error_propagate(errp
, local_err
);
3513 aio_context_release(aio_context
);
3517 void qmp_drive_backup(DriveBackup
*arg
, Error
**errp
)
3521 job
= do_drive_backup(arg
, NULL
, errp
);
3523 job_start(&job
->job
);
3527 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3529 return bdrv_named_nodes_list(errp
);
3532 BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
3535 BlockDriverState
*bs
;
3536 BlockDriverState
*target_bs
;
3537 Error
*local_err
= NULL
;
3538 BdrvDirtyBitmap
*bmap
= NULL
;
3539 AioContext
*aio_context
;
3540 BlockJob
*job
= NULL
;
3541 int job_flags
= JOB_DEFAULT
;
3543 if (!backup
->has_speed
) {
3546 if (!backup
->has_on_source_error
) {
3547 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3549 if (!backup
->has_on_target_error
) {
3550 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3552 if (!backup
->has_job_id
) {
3553 backup
->job_id
= NULL
;
3555 if (!backup
->has_auto_finalize
) {
3556 backup
->auto_finalize
= true;
3558 if (!backup
->has_auto_dismiss
) {
3559 backup
->auto_dismiss
= true;
3561 if (!backup
->has_compress
) {
3562 backup
->compress
= false;
3565 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
3570 aio_context
= bdrv_get_aio_context(bs
);
3571 aio_context_acquire(aio_context
);
3573 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
3578 if (bdrv_get_aio_context(target_bs
) != aio_context
) {
3579 if (!bdrv_has_blk(target_bs
)) {
3580 /* The target BDS is not attached, we can safely move it to another
3582 bdrv_set_aio_context(target_bs
, aio_context
);
3584 error_setg(errp
, "Target is attached to a different thread from "
3590 if (backup
->has_bitmap
) {
3591 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3593 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3596 if (bdrv_dirty_bitmap_qmp_locked(bmap
)) {
3598 "Bitmap '%s' is currently locked and cannot be used for "
3599 "backup", backup
->bitmap
);
3604 if (!backup
->auto_finalize
) {
3605 job_flags
|= JOB_MANUAL_FINALIZE
;
3607 if (!backup
->auto_dismiss
) {
3608 job_flags
|= JOB_MANUAL_DISMISS
;
3610 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3611 backup
->sync
, bmap
, backup
->compress
,
3612 backup
->on_source_error
, backup
->on_target_error
,
3613 job_flags
, NULL
, NULL
, txn
, &local_err
);
3614 if (local_err
!= NULL
) {
3615 error_propagate(errp
, local_err
);
3618 aio_context_release(aio_context
);
3622 void qmp_blockdev_backup(BlockdevBackup
*arg
, Error
**errp
)
3625 job
= do_blockdev_backup(arg
, NULL
, errp
);
3627 job_start(&job
->job
);
3631 /* Parameter check and block job starting for drive mirroring.
3632 * Caller should hold @device and @target's aio context (must be the same).
3634 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3635 BlockDriverState
*target
,
3636 bool has_replaces
, const char *replaces
,
3637 enum MirrorSyncMode sync
,
3638 BlockMirrorBackingMode backing_mode
,
3639 bool has_speed
, int64_t speed
,
3640 bool has_granularity
, uint32_t granularity
,
3641 bool has_buf_size
, int64_t buf_size
,
3642 bool has_on_source_error
,
3643 BlockdevOnError on_source_error
,
3644 bool has_on_target_error
,
3645 BlockdevOnError on_target_error
,
3646 bool has_unmap
, bool unmap
,
3647 bool has_filter_node_name
,
3648 const char *filter_node_name
,
3649 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3650 bool has_auto_finalize
, bool auto_finalize
,
3651 bool has_auto_dismiss
, bool auto_dismiss
,
3654 int job_flags
= JOB_DEFAULT
;
3659 if (!has_on_source_error
) {
3660 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3662 if (!has_on_target_error
) {
3663 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3665 if (!has_granularity
) {
3668 if (!has_buf_size
) {
3674 if (!has_filter_node_name
) {
3675 filter_node_name
= NULL
;
3677 if (!has_copy_mode
) {
3678 copy_mode
= MIRROR_COPY_MODE_BACKGROUND
;
3680 if (has_auto_finalize
&& !auto_finalize
) {
3681 job_flags
|= JOB_MANUAL_FINALIZE
;
3683 if (has_auto_dismiss
&& !auto_dismiss
) {
3684 job_flags
|= JOB_MANUAL_DISMISS
;
3687 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3688 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3689 "a value in range [512B, 64MB]");
3692 if (granularity
& (granularity
- 1)) {
3693 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3698 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3701 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3705 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3706 sync
= MIRROR_SYNC_MODE_FULL
;
3709 /* pass the node name to replace to mirror start since it's loose coupling
3710 * and will allow to check whether the node still exist at mirror completion
3712 mirror_start(job_id
, bs
, target
,
3713 has_replaces
? replaces
: NULL
, job_flags
,
3714 speed
, granularity
, buf_size
, sync
, backing_mode
,
3715 on_source_error
, on_target_error
, unmap
, filter_node_name
,
3719 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3721 BlockDriverState
*bs
;
3722 BlockDriverState
*source
, *target_bs
;
3723 AioContext
*aio_context
;
3724 BlockMirrorBackingMode backing_mode
;
3725 Error
*local_err
= NULL
;
3726 QDict
*options
= NULL
;
3729 const char *format
= arg
->format
;
3731 bs
= qmp_get_root_bs(arg
->device
, errp
);
3736 /* Early check to avoid creating target */
3737 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3741 aio_context
= bdrv_get_aio_context(bs
);
3742 aio_context_acquire(aio_context
);
3744 if (!arg
->has_mode
) {
3745 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3748 if (!arg
->has_format
) {
3749 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3750 ? NULL
: bs
->drv
->format_name
);
3753 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3754 source
= backing_bs(bs
);
3755 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3756 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3758 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3762 size
= bdrv_getlength(bs
);
3764 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3768 if (arg
->has_replaces
) {
3769 BlockDriverState
*to_replace_bs
;
3770 AioContext
*replace_aio_context
;
3771 int64_t replace_size
;
3773 if (!arg
->has_node_name
) {
3774 error_setg(errp
, "a node-name must be provided when replacing a"
3775 " named node of the graph");
3779 to_replace_bs
= check_to_replace_node(bs
, arg
->replaces
, &local_err
);
3781 if (!to_replace_bs
) {
3782 error_propagate(errp
, local_err
);
3786 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3787 aio_context_acquire(replace_aio_context
);
3788 replace_size
= bdrv_getlength(to_replace_bs
);
3789 aio_context_release(replace_aio_context
);
3791 if (size
!= replace_size
) {
3792 error_setg(errp
, "cannot replace image with a mirror image of "
3798 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3799 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3801 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3804 /* Don't open backing image in create() */
3805 flags
|= BDRV_O_NO_BACKING
;
3807 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3808 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3810 /* create new image w/o backing file */
3812 bdrv_img_create(arg
->target
, format
,
3813 NULL
, NULL
, NULL
, size
, flags
, false, &local_err
);
3815 switch (arg
->mode
) {
3816 case NEW_IMAGE_MODE_EXISTING
:
3818 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3819 /* create new image with backing file */
3820 bdrv_img_create(arg
->target
, format
,
3822 source
->drv
->format_name
,
3823 NULL
, size
, flags
, false, &local_err
);
3831 error_propagate(errp
, local_err
);
3835 options
= qdict_new();
3836 if (arg
->has_node_name
) {
3837 qdict_put_str(options
, "node-name", arg
->node_name
);
3840 qdict_put_str(options
, "driver", format
);
3843 /* Mirroring takes care of copy-on-write using the source's backing
3846 target_bs
= bdrv_open(arg
->target
, NULL
, options
, flags
, errp
);
3851 bdrv_set_aio_context(target_bs
, aio_context
);
3853 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3854 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3855 backing_mode
, arg
->has_speed
, arg
->speed
,
3856 arg
->has_granularity
, arg
->granularity
,
3857 arg
->has_buf_size
, arg
->buf_size
,
3858 arg
->has_on_source_error
, arg
->on_source_error
,
3859 arg
->has_on_target_error
, arg
->on_target_error
,
3860 arg
->has_unmap
, arg
->unmap
,
3862 arg
->has_copy_mode
, arg
->copy_mode
,
3863 arg
->has_auto_finalize
, arg
->auto_finalize
,
3864 arg
->has_auto_dismiss
, arg
->auto_dismiss
,
3866 bdrv_unref(target_bs
);
3867 error_propagate(errp
, local_err
);
3869 aio_context_release(aio_context
);
3872 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3873 const char *device
, const char *target
,
3874 bool has_replaces
, const char *replaces
,
3875 MirrorSyncMode sync
,
3876 bool has_speed
, int64_t speed
,
3877 bool has_granularity
, uint32_t granularity
,
3878 bool has_buf_size
, int64_t buf_size
,
3879 bool has_on_source_error
,
3880 BlockdevOnError on_source_error
,
3881 bool has_on_target_error
,
3882 BlockdevOnError on_target_error
,
3883 bool has_filter_node_name
,
3884 const char *filter_node_name
,
3885 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3886 bool has_auto_finalize
, bool auto_finalize
,
3887 bool has_auto_dismiss
, bool auto_dismiss
,
3890 BlockDriverState
*bs
;
3891 BlockDriverState
*target_bs
;
3892 AioContext
*aio_context
;
3893 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3894 Error
*local_err
= NULL
;
3896 bs
= qmp_get_root_bs(device
, errp
);
3901 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3906 aio_context
= bdrv_get_aio_context(bs
);
3907 aio_context_acquire(aio_context
);
3909 bdrv_set_aio_context(target_bs
, aio_context
);
3911 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3912 has_replaces
, replaces
, sync
, backing_mode
,
3914 has_granularity
, granularity
,
3915 has_buf_size
, buf_size
,
3916 has_on_source_error
, on_source_error
,
3917 has_on_target_error
, on_target_error
,
3919 has_filter_node_name
, filter_node_name
,
3920 has_copy_mode
, copy_mode
,
3921 has_auto_finalize
, auto_finalize
,
3922 has_auto_dismiss
, auto_dismiss
,
3924 error_propagate(errp
, local_err
);
3926 aio_context_release(aio_context
);
3929 /* Get a block job using its ID and acquire its AioContext */
3930 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
3937 *aio_context
= NULL
;
3939 job
= block_job_get(id
);
3942 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3943 "Block job '%s' not found", id
);
3947 *aio_context
= blk_get_aio_context(job
->blk
);
3948 aio_context_acquire(*aio_context
);
3953 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3955 AioContext
*aio_context
;
3956 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3962 block_job_set_speed(job
, speed
, errp
);
3963 aio_context_release(aio_context
);
3966 void qmp_block_job_cancel(const char *device
,
3967 bool has_force
, bool force
, Error
**errp
)
3969 AioContext
*aio_context
;
3970 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3980 if (job_user_paused(&job
->job
) && !force
) {
3981 error_setg(errp
, "The block job for device '%s' is currently paused",
3986 trace_qmp_block_job_cancel(job
);
3987 job_user_cancel(&job
->job
, force
, errp
);
3989 aio_context_release(aio_context
);
3992 void qmp_block_job_pause(const char *device
, Error
**errp
)
3994 AioContext
*aio_context
;
3995 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4001 trace_qmp_block_job_pause(job
);
4002 job_user_pause(&job
->job
, errp
);
4003 aio_context_release(aio_context
);
4006 void qmp_block_job_resume(const char *device
, Error
**errp
)
4008 AioContext
*aio_context
;
4009 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4015 trace_qmp_block_job_resume(job
);
4016 job_user_resume(&job
->job
, errp
);
4017 aio_context_release(aio_context
);
4020 void qmp_block_job_complete(const char *device
, Error
**errp
)
4022 AioContext
*aio_context
;
4023 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4029 trace_qmp_block_job_complete(job
);
4030 job_complete(&job
->job
, errp
);
4031 aio_context_release(aio_context
);
4034 void qmp_block_job_finalize(const char *id
, Error
**errp
)
4036 AioContext
*aio_context
;
4037 BlockJob
*job
= find_block_job(id
, &aio_context
, errp
);
4043 trace_qmp_block_job_finalize(job
);
4044 job_finalize(&job
->job
, errp
);
4045 aio_context_release(aio_context
);
4048 void qmp_block_job_dismiss(const char *id
, Error
**errp
)
4050 AioContext
*aio_context
;
4051 BlockJob
*bjob
= find_block_job(id
, &aio_context
, errp
);
4058 trace_qmp_block_job_dismiss(bjob
);
4060 job_dismiss(&job
, errp
);
4061 aio_context_release(aio_context
);
4064 void qmp_change_backing_file(const char *device
,
4065 const char *image_node_name
,
4066 const char *backing_file
,
4069 BlockDriverState
*bs
= NULL
;
4070 AioContext
*aio_context
;
4071 BlockDriverState
*image_bs
= NULL
;
4072 Error
*local_err
= NULL
;
4077 bs
= qmp_get_root_bs(device
, errp
);
4082 aio_context
= bdrv_get_aio_context(bs
);
4083 aio_context_acquire(aio_context
);
4085 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
4087 error_propagate(errp
, local_err
);
4092 error_setg(errp
, "image file not found");
4096 if (bdrv_find_base(image_bs
) == image_bs
) {
4097 error_setg(errp
, "not allowing backing file change on an image "
4098 "without a backing file");
4102 /* even though we are not necessarily operating on bs, we need it to
4103 * determine if block ops are currently prohibited on the chain */
4104 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
4108 /* final sanity check */
4109 if (!bdrv_chain_contains(bs
, image_bs
)) {
4110 error_setg(errp
, "'%s' and image file are not in the same chain",
4115 /* if not r/w, reopen to make r/w */
4116 open_flags
= image_bs
->open_flags
;
4117 ro
= bdrv_is_read_only(image_bs
);
4120 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
4122 error_propagate(errp
, local_err
);
4127 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
4128 image_bs
->drv
? image_bs
->drv
->format_name
: "");
4131 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
4133 /* don't exit here, so we can try to restore open flags if
4138 bdrv_reopen(image_bs
, open_flags
, &local_err
);
4139 error_propagate(errp
, local_err
);
4143 aio_context_release(aio_context
);
4146 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
4150 Error
*local_err
= NULL
;
4152 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
4157 qdict
= qemu_opts_to_qdict(opts
, NULL
);
4159 if (!qdict_get_try_str(qdict
, "node-name")) {
4160 qobject_unref(qdict
);
4161 error_report("'node-name' needs to be specified");
4165 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
4167 error_report_err(local_err
);
4171 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4174 qemu_opts_del(opts
);
4177 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
4179 BlockDriverState
*bs
;
4181 Visitor
*v
= qobject_output_visitor_new(&obj
);
4183 Error
*local_err
= NULL
;
4185 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
4187 error_propagate(errp
, local_err
);
4191 visit_complete(v
, &obj
);
4192 qdict
= qobject_to(QDict
, obj
);
4194 qdict_flatten(qdict
);
4196 if (!qdict_get_try_str(qdict
, "node-name")) {
4197 error_setg(errp
, "'node-name' must be specified for the root node");
4201 bs
= bds_tree_init(qdict
, errp
);
4206 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4212 void qmp_blockdev_del(const char *node_name
, Error
**errp
)
4214 AioContext
*aio_context
;
4215 BlockDriverState
*bs
;
4217 bs
= bdrv_find_node(node_name
);
4219 error_setg(errp
, "Cannot find node %s", node_name
);
4222 if (bdrv_has_blk(bs
)) {
4223 error_setg(errp
, "Node %s is in use", node_name
);
4226 aio_context
= bdrv_get_aio_context(bs
);
4227 aio_context_acquire(aio_context
);
4229 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
4233 if (!bs
->monitor_list
.tqe_prev
) {
4234 error_setg(errp
, "Node %s is not owned by the monitor",
4239 if (bs
->refcnt
> 1) {
4240 error_setg(errp
, "Block device %s is in use",
4241 bdrv_get_device_or_node_name(bs
));
4245 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
4249 aio_context_release(aio_context
);
4252 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
4253 const char *child_name
)
4257 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
4258 if (strcmp(child
->name
, child_name
) == 0) {
4266 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
4267 const char *child
, bool has_node
,
4268 const char *node
, Error
**errp
)
4270 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
4273 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
4278 if (has_child
== has_node
) {
4280 error_setg(errp
, "The parameters child and node are in conflict");
4282 error_setg(errp
, "Either child or node must be specified");
4288 p_child
= bdrv_find_child(parent_bs
, child
);
4290 error_setg(errp
, "Node '%s' does not have child '%s'",
4294 bdrv_del_child(parent_bs
, p_child
, errp
);
4298 new_bs
= bdrv_find_node(node
);
4300 error_setg(errp
, "Node '%s' not found", node
);
4303 bdrv_add_child(parent_bs
, new_bs
, errp
);
4307 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
4309 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
4312 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
4313 BlockJobInfoList
*elem
;
4314 AioContext
*aio_context
;
4316 if (block_job_is_internal(job
)) {
4319 elem
= g_new0(BlockJobInfoList
, 1);
4320 aio_context
= blk_get_aio_context(job
->blk
);
4321 aio_context_acquire(aio_context
);
4322 elem
->value
= block_job_query(job
, errp
);
4323 aio_context_release(aio_context
);
4326 qapi_free_BlockJobInfoList(head
);
4330 p_next
= &elem
->next
;
4336 void qmp_x_blockdev_set_iothread(const char *node_name
, StrOrNull
*iothread
,
4337 bool has_force
, bool force
, Error
**errp
)
4339 AioContext
*old_context
;
4340 AioContext
*new_context
;
4341 BlockDriverState
*bs
;
4343 bs
= bdrv_find_node(node_name
);
4345 error_setg(errp
, "Cannot find node %s", node_name
);
4349 /* Protects against accidents. */
4350 if (!(has_force
&& force
) && bdrv_has_blk(bs
)) {
4351 error_setg(errp
, "Node %s is associated with a BlockBackend and could "
4352 "be in use (use force=true to override this check)",
4357 if (iothread
->type
== QTYPE_QSTRING
) {
4358 IOThread
*obj
= iothread_by_id(iothread
->u
.s
);
4360 error_setg(errp
, "Cannot find iothread %s", iothread
->u
.s
);
4364 new_context
= iothread_get_aio_context(obj
);
4366 new_context
= qemu_get_aio_context();
4369 old_context
= bdrv_get_aio_context(bs
);
4370 aio_context_acquire(old_context
);
4372 bdrv_set_aio_context(bs
, new_context
);
4374 aio_context_release(old_context
);
4377 void qmp_x_block_latency_histogram_set(
4379 bool has_boundaries
, uint64List
*boundaries
,
4380 bool has_boundaries_read
, uint64List
*boundaries_read
,
4381 bool has_boundaries_write
, uint64List
*boundaries_write
,
4382 bool has_boundaries_flush
, uint64List
*boundaries_flush
,
4385 BlockBackend
*blk
= blk_by_name(device
);
4386 BlockAcctStats
*stats
;
4389 error_setg(errp
, "Device '%s' not found", device
);
4392 stats
= blk_get_stats(blk
);
4394 if (!has_boundaries
&& !has_boundaries_read
&& !has_boundaries_write
&&
4395 !has_boundaries_flush
)
4397 block_latency_histograms_clear(stats
);
4401 if (has_boundaries
|| has_boundaries_read
) {
4402 block_latency_histogram_set(
4403 stats
, BLOCK_ACCT_READ
,
4404 has_boundaries_read
? boundaries_read
: boundaries
);
4407 if (has_boundaries
|| has_boundaries_write
) {
4408 block_latency_histogram_set(
4409 stats
, BLOCK_ACCT_WRITE
,
4410 has_boundaries_write
? boundaries_write
: boundaries
);
4413 if (has_boundaries
|| has_boundaries_flush
) {
4414 block_latency_histogram_set(
4415 stats
, BLOCK_ACCT_FLUSH
,
4416 has_boundaries_flush
? boundaries_flush
: boundaries
);
4420 QemuOptsList qemu_common_drive_opts
= {
4422 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4426 .type
= QEMU_OPT_BOOL
,
4427 .help
= "enable/disable snapshot mode",
4430 .type
= QEMU_OPT_STRING
,
4431 .help
= "host AIO implementation (threads, native)",
4433 .name
= BDRV_OPT_CACHE_WB
,
4434 .type
= QEMU_OPT_BOOL
,
4435 .help
= "Enable writeback mode",
4438 .type
= QEMU_OPT_STRING
,
4439 .help
= "disk format (raw, qcow2, ...)",
4442 .type
= QEMU_OPT_STRING
,
4443 .help
= "read error action",
4446 .type
= QEMU_OPT_STRING
,
4447 .help
= "write error action",
4449 .name
= BDRV_OPT_READ_ONLY
,
4450 .type
= QEMU_OPT_BOOL
,
4451 .help
= "open drive file as read-only",
4457 .name
= "throttling.group",
4458 .type
= QEMU_OPT_STRING
,
4459 .help
= "name of the block throttling group",
4461 .name
= "copy-on-read",
4462 .type
= QEMU_OPT_BOOL
,
4463 .help
= "copy read data from backing file into image file",
4465 .name
= "detect-zeroes",
4466 .type
= QEMU_OPT_STRING
,
4467 .help
= "try to optimize zero writes (off, on, unmap)",
4469 .name
= "stats-account-invalid",
4470 .type
= QEMU_OPT_BOOL
,
4471 .help
= "whether to account for invalid I/O operations "
4472 "in the statistics",
4474 .name
= "stats-account-failed",
4475 .type
= QEMU_OPT_BOOL
,
4476 .help
= "whether to account for failed I/O operations "
4477 "in the statistics",
4479 { /* end of list */ }
4483 QemuOptsList qemu_drive_opts
= {
4485 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4488 * no elements => accept any params
4489 * validation will happen later
4491 { /* end of list */ }