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 qdict_set_default_str(bs_opts
, BDRV_OPT_AUTO_READ_ONLY
, "on");
594 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
596 if (runstate_check(RUN_STATE_INMIGRATE
)) {
597 bdrv_flags
|= BDRV_O_INACTIVE
;
600 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
606 bs
->detect_zeroes
= detect_zeroes
;
608 block_acct_setup(blk_get_stats(blk
), account_invalid
, account_failed
);
610 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
617 /* disk I/O throttling */
618 if (throttle_enabled(&cfg
)) {
619 if (!throttling_group
) {
620 throttling_group
= id
;
622 blk_io_limits_enable(blk
, throttling_group
);
623 blk_set_io_limits(blk
, &cfg
);
626 blk_set_enable_write_cache(blk
, !writethrough
);
627 blk_set_on_error(blk
, on_read_error
, on_write_error
);
629 if (!monitor_add_blk(blk
, id
, errp
)) {
637 qobject_unref(interval_dict
);
638 qobject_unref(interval_list
);
643 qobject_unref(interval_dict
);
644 qobject_unref(interval_list
);
646 qobject_unref(bs_opts
);
650 /* Takes the ownership of bs_opts */
651 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
655 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
656 * with other callers) rather than what we want as the real defaults.
657 * Apply the defaults here instead. */
658 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
659 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
660 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
662 if (runstate_check(RUN_STATE_INMIGRATE
)) {
663 bdrv_flags
|= BDRV_O_INACTIVE
;
666 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
669 void blockdev_close_all_bdrv_states(void)
671 BlockDriverState
*bs
, *next_bs
;
673 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
674 AioContext
*ctx
= bdrv_get_aio_context(bs
);
676 aio_context_acquire(ctx
);
678 aio_context_release(ctx
);
682 /* Iterates over the list of monitor-owned BlockDriverStates */
683 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
685 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
686 : QTAILQ_FIRST(&monitor_bdrv_states
);
689 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
694 value
= qemu_opt_get(opts
, from
);
696 if (qemu_opt_find(opts
, to
)) {
697 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
698 "same time", to
, from
);
703 /* rename all items in opts */
704 while ((value
= qemu_opt_get(opts
, from
))) {
705 qemu_opt_set(opts
, to
, value
, &error_abort
);
706 qemu_opt_unset(opts
, from
);
710 QemuOptsList qemu_legacy_drive_opts
= {
712 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
716 .type
= QEMU_OPT_NUMBER
,
717 .help
= "bus number",
720 .type
= QEMU_OPT_NUMBER
,
721 .help
= "unit number (i.e. lun for scsi)",
724 .type
= QEMU_OPT_NUMBER
,
725 .help
= "index number",
728 .type
= QEMU_OPT_STRING
,
729 .help
= "media type (disk, cdrom)",
732 .type
= QEMU_OPT_STRING
,
733 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
736 .type
= QEMU_OPT_STRING
,
740 /* Options that are passed on, but have special semantics with -drive */
742 .name
= BDRV_OPT_READ_ONLY
,
743 .type
= QEMU_OPT_BOOL
,
744 .help
= "open drive file as read-only",
747 .type
= QEMU_OPT_STRING
,
748 .help
= "read error action",
751 .type
= QEMU_OPT_STRING
,
752 .help
= "write error action",
754 .name
= "copy-on-read",
755 .type
= QEMU_OPT_BOOL
,
756 .help
= "copy read data from backing file into image file",
759 { /* end of list */ }
763 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
,
768 DriveInfo
*dinfo
= NULL
;
770 QemuOpts
*legacy_opts
;
771 DriveMediaType media
= MEDIA_DISK
;
772 BlockInterfaceType type
;
773 int max_devs
, bus_id
, unit_id
, index
;
774 const char *werror
, *rerror
;
775 bool read_only
= false;
777 const char *filename
;
778 Error
*local_err
= NULL
;
781 /* Change legacy command line options into QMP ones */
782 static const struct {
786 { "iops", "throttling.iops-total" },
787 { "iops_rd", "throttling.iops-read" },
788 { "iops_wr", "throttling.iops-write" },
790 { "bps", "throttling.bps-total" },
791 { "bps_rd", "throttling.bps-read" },
792 { "bps_wr", "throttling.bps-write" },
794 { "iops_max", "throttling.iops-total-max" },
795 { "iops_rd_max", "throttling.iops-read-max" },
796 { "iops_wr_max", "throttling.iops-write-max" },
798 { "bps_max", "throttling.bps-total-max" },
799 { "bps_rd_max", "throttling.bps-read-max" },
800 { "bps_wr_max", "throttling.bps-write-max" },
802 { "iops_size", "throttling.iops-size" },
804 { "group", "throttling.group" },
806 { "readonly", BDRV_OPT_READ_ONLY
},
809 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
810 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
813 error_propagate(errp
, local_err
);
818 value
= qemu_opt_get(all_opts
, "cache");
823 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
824 error_setg(errp
, "invalid cache option");
828 /* Specific options take precedence */
829 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
830 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
831 !writethrough
, &error_abort
);
833 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
834 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
835 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
837 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
838 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
839 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
841 qemu_opt_unset(all_opts
, "cache");
844 /* Get a QDict for processing the options */
845 bs_opts
= qdict_new();
846 qemu_opts_to_qdict(all_opts
, bs_opts
);
848 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
850 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
852 error_propagate(errp
, local_err
);
857 value
= qemu_opt_get(legacy_opts
, "media");
859 if (!strcmp(value
, "disk")) {
861 } else if (!strcmp(value
, "cdrom")) {
865 error_setg(errp
, "'%s' invalid media", value
);
870 /* copy-on-read is disabled with a warning for read-only devices */
871 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
872 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
874 if (read_only
&& copy_on_read
) {
875 warn_report("disabling copy-on-read on read-only drive");
876 copy_on_read
= false;
879 qdict_put_str(bs_opts
, BDRV_OPT_READ_ONLY
, read_only
? "on" : "off");
880 qdict_put_str(bs_opts
, "copy-on-read", copy_on_read
? "on" : "off");
882 /* Controller type */
883 value
= qemu_opt_get(legacy_opts
, "if");
886 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
889 if (type
== IF_COUNT
) {
890 error_setg(errp
, "unsupported bus type '%s'", value
);
894 type
= block_default_type
;
897 /* Device address specified by bus/unit or index.
898 * If none was specified, try to find the first free one. */
899 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
900 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
901 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
903 max_devs
= if_max_devs
[type
];
906 if (bus_id
!= 0 || unit_id
!= -1) {
907 error_setg(errp
, "index cannot be used with bus and unit");
910 bus_id
= drive_index_to_bus_id(type
, index
);
911 unit_id
= drive_index_to_unit_id(type
, index
);
916 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
918 if (max_devs
&& unit_id
>= max_devs
) {
925 if (max_devs
&& unit_id
>= max_devs
) {
926 error_setg(errp
, "unit %d too big (max is %d)", unit_id
, max_devs
- 1);
930 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
931 error_setg(errp
, "drive with bus=%d, unit=%d (index=%d) exists",
932 bus_id
, unit_id
, index
);
936 /* no id supplied -> create one */
937 if (qemu_opts_id(all_opts
) == NULL
) {
939 const char *mediastr
= "";
940 if (type
== IF_IDE
|| type
== IF_SCSI
) {
941 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
944 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
947 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
950 qdict_put_str(bs_opts
, "id", new_id
);
954 /* Add virtio block device */
955 if (type
== IF_VIRTIO
) {
957 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
959 if (arch_type
== QEMU_ARCH_S390X
) {
960 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
962 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
964 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
968 filename
= qemu_opt_get(legacy_opts
, "file");
970 /* Check werror/rerror compatibility with if=... */
971 werror
= qemu_opt_get(legacy_opts
, "werror");
972 if (werror
!= NULL
) {
973 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
975 error_setg(errp
, "werror is not supported by this bus type");
978 qdict_put_str(bs_opts
, "werror", werror
);
981 rerror
= qemu_opt_get(legacy_opts
, "rerror");
982 if (rerror
!= NULL
) {
983 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
985 error_setg(errp
, "rerror is not supported by this bus type");
988 qdict_put_str(bs_opts
, "rerror", rerror
);
991 /* Actual block device init: Functionality shared with blockdev-add */
992 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
995 error_propagate(errp
, local_err
);
1001 /* Create legacy DriveInfo */
1002 dinfo
= g_malloc0(sizeof(*dinfo
));
1003 dinfo
->opts
= all_opts
;
1006 dinfo
->bus
= bus_id
;
1007 dinfo
->unit
= unit_id
;
1009 blk_set_legacy_dinfo(blk
, dinfo
);
1016 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1023 qemu_opts_del(legacy_opts
);
1024 qobject_unref(bs_opts
);
1028 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1030 BlockDriverState
*bs
;
1032 bs
= bdrv_lookup_bs(name
, name
, errp
);
1037 if (!bdrv_is_root_node(bs
)) {
1038 error_setg(errp
, "Need a root block node");
1042 if (!bdrv_is_inserted(bs
)) {
1043 error_setg(errp
, "Device has no medium");
1050 static BlockBackend
*qmp_get_blk(const char *blk_name
, const char *qdev_id
,
1055 if (!blk_name
== !qdev_id
) {
1056 error_setg(errp
, "Need exactly one of 'device' and 'id'");
1061 blk
= blk_by_qdev_id(qdev_id
, errp
);
1063 blk
= blk_by_name(blk_name
);
1065 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1066 "Device '%s' not found", blk_name
);
1073 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1075 const char *device
= qdict_get_str(qdict
, "device");
1079 if (!strcmp(device
, "all")) {
1080 ret
= blk_commit_all();
1082 BlockDriverState
*bs
;
1083 AioContext
*aio_context
;
1085 blk
= blk_by_name(device
);
1087 monitor_printf(mon
, "Device '%s' not found\n", device
);
1090 if (!blk_is_available(blk
)) {
1091 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1096 aio_context
= bdrv_get_aio_context(bs
);
1097 aio_context_acquire(aio_context
);
1099 ret
= bdrv_commit(bs
);
1101 aio_context_release(aio_context
);
1104 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1109 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1111 TransactionActionList list
;
1113 list
.value
= action
;
1115 qmp_transaction(&list
, false, NULL
, errp
);
1118 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1119 bool has_node_name
, const char *node_name
,
1120 const char *snapshot_file
,
1121 bool has_snapshot_node_name
,
1122 const char *snapshot_node_name
,
1123 bool has_format
, const char *format
,
1124 bool has_mode
, NewImageMode mode
, Error
**errp
)
1126 BlockdevSnapshotSync snapshot
= {
1127 .has_device
= has_device
,
1128 .device
= (char *) device
,
1129 .has_node_name
= has_node_name
,
1130 .node_name
= (char *) node_name
,
1131 .snapshot_file
= (char *) snapshot_file
,
1132 .has_snapshot_node_name
= has_snapshot_node_name
,
1133 .snapshot_node_name
= (char *) snapshot_node_name
,
1134 .has_format
= has_format
,
1135 .format
= (char *) format
,
1136 .has_mode
= has_mode
,
1139 TransactionAction action
= {
1140 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1141 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1143 blockdev_do_action(&action
, errp
);
1146 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1149 BlockdevSnapshot snapshot_data
= {
1150 .node
= (char *) node
,
1151 .overlay
= (char *) overlay
1153 TransactionAction action
= {
1154 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1155 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1157 blockdev_do_action(&action
, errp
);
1160 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1164 BlockdevSnapshotInternal snapshot
= {
1165 .device
= (char *) device
,
1166 .name
= (char *) name
1168 TransactionAction action
= {
1169 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1170 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1172 blockdev_do_action(&action
, errp
);
1175 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1182 BlockDriverState
*bs
;
1183 AioContext
*aio_context
;
1184 QEMUSnapshotInfo sn
;
1185 Error
*local_err
= NULL
;
1186 SnapshotInfo
*info
= NULL
;
1189 bs
= qmp_get_root_bs(device
, errp
);
1193 aio_context
= bdrv_get_aio_context(bs
);
1194 aio_context_acquire(aio_context
);
1205 error_setg(errp
, "Name or id must be provided");
1206 goto out_aio_context
;
1209 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1210 goto out_aio_context
;
1213 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1215 error_propagate(errp
, local_err
);
1216 goto out_aio_context
;
1220 "Snapshot with id '%s' and name '%s' does not exist on "
1222 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1223 goto out_aio_context
;
1226 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1228 error_propagate(errp
, local_err
);
1229 goto out_aio_context
;
1232 aio_context_release(aio_context
);
1234 info
= g_new0(SnapshotInfo
, 1);
1235 info
->id
= g_strdup(sn
.id_str
);
1236 info
->name
= g_strdup(sn
.name
);
1237 info
->date_nsec
= sn
.date_nsec
;
1238 info
->date_sec
= sn
.date_sec
;
1239 info
->vm_state_size
= sn
.vm_state_size
;
1240 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1241 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1246 aio_context_release(aio_context
);
1251 * block_dirty_bitmap_lookup:
1252 * Return a dirty bitmap (if present), after validating
1253 * the node reference and bitmap names.
1255 * @node: The name of the BDS node to search for bitmaps
1256 * @name: The name of the bitmap to search for
1257 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1258 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1259 * @errp: Output pointer for error information. Can be NULL.
1261 * @return: A bitmap object on success, or NULL on failure.
1263 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1265 BlockDriverState
**pbs
,
1268 BlockDriverState
*bs
;
1269 BdrvDirtyBitmap
*bitmap
;
1272 error_setg(errp
, "Node cannot be NULL");
1276 error_setg(errp
, "Bitmap name cannot be NULL");
1279 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1281 error_setg(errp
, "Node '%s' not found", node
);
1285 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1287 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1298 /* New and old BlockDriverState structs for atomic group operations */
1300 typedef struct BlkActionState BlkActionState
;
1304 * Table of operations that define an Action.
1306 * @instance_size: Size of state struct, in bytes.
1307 * @prepare: Prepare the work, must NOT be NULL.
1308 * @commit: Commit the changes, can be NULL.
1309 * @abort: Abort the changes on fail, can be NULL.
1310 * @clean: Clean up resources after all transaction actions have called
1311 * commit() or abort(). Can be NULL.
1313 * Only prepare() may fail. In a single transaction, only one of commit() or
1314 * abort() will be called. clean() will always be called if it is present.
1316 typedef struct BlkActionOps
{
1317 size_t instance_size
;
1318 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1319 void (*commit
)(BlkActionState
*common
);
1320 void (*abort
)(BlkActionState
*common
);
1321 void (*clean
)(BlkActionState
*common
);
1326 * Describes one Action's state within a Transaction.
1328 * @action: QAPI-defined enum identifying which Action to perform.
1329 * @ops: Table of ActionOps this Action can perform.
1330 * @block_job_txn: Transaction which this action belongs to.
1331 * @entry: List membership for all Actions in this Transaction.
1333 * This structure must be arranged as first member in a subclassed type,
1334 * assuming that the compiler will also arrange it to the same offsets as the
1337 struct BlkActionState
{
1338 TransactionAction
*action
;
1339 const BlkActionOps
*ops
;
1340 JobTxn
*block_job_txn
;
1341 TransactionProperties
*txn_props
;
1342 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1345 /* internal snapshot private data */
1346 typedef struct InternalSnapshotState
{
1347 BlkActionState common
;
1348 BlockDriverState
*bs
;
1349 QEMUSnapshotInfo sn
;
1351 } InternalSnapshotState
;
1354 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1356 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1358 "Action '%s' does not support Transaction property "
1359 "completion-mode = %s",
1360 TransactionActionKind_str(s
->action
->type
),
1361 ActionCompletionMode_str(s
->txn_props
->completion_mode
));
1367 static void internal_snapshot_prepare(BlkActionState
*common
,
1370 Error
*local_err
= NULL
;
1373 BlockDriverState
*bs
;
1374 QEMUSnapshotInfo old_sn
, *sn
;
1377 BlockdevSnapshotInternal
*internal
;
1378 InternalSnapshotState
*state
;
1379 AioContext
*aio_context
;
1382 g_assert(common
->action
->type
==
1383 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1384 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1385 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1387 /* 1. parse input */
1388 device
= internal
->device
;
1389 name
= internal
->name
;
1391 /* 2. check for validation */
1392 if (action_check_completion_mode(common
, errp
) < 0) {
1396 bs
= qmp_get_root_bs(device
, errp
);
1401 aio_context
= bdrv_get_aio_context(bs
);
1402 aio_context_acquire(aio_context
);
1406 /* Paired with .clean() */
1407 bdrv_drained_begin(bs
);
1409 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1413 if (bdrv_is_read_only(bs
)) {
1414 error_setg(errp
, "Device '%s' is read only", device
);
1418 if (!bdrv_can_snapshot(bs
)) {
1419 error_setg(errp
, "Block format '%s' used by device '%s' "
1420 "does not support internal snapshots",
1421 bs
->drv
->format_name
, device
);
1425 if (!strlen(name
)) {
1426 error_setg(errp
, "Name is empty");
1430 /* check whether a snapshot with name exist */
1431 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1434 error_propagate(errp
, local_err
);
1438 "Snapshot with name '%s' already exists on device '%s'",
1443 /* 3. take the snapshot */
1445 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1446 qemu_gettimeofday(&tv
);
1447 sn
->date_sec
= tv
.tv_sec
;
1448 sn
->date_nsec
= tv
.tv_usec
* 1000;
1449 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1451 ret1
= bdrv_snapshot_create(bs
, sn
);
1453 error_setg_errno(errp
, -ret1
,
1454 "Failed to create snapshot '%s' on device '%s'",
1459 /* 4. succeed, mark a snapshot is created */
1460 state
->created
= true;
1463 aio_context_release(aio_context
);
1466 static void internal_snapshot_abort(BlkActionState
*common
)
1468 InternalSnapshotState
*state
=
1469 DO_UPCAST(InternalSnapshotState
, common
, common
);
1470 BlockDriverState
*bs
= state
->bs
;
1471 QEMUSnapshotInfo
*sn
= &state
->sn
;
1472 AioContext
*aio_context
;
1473 Error
*local_error
= NULL
;
1475 if (!state
->created
) {
1479 aio_context
= bdrv_get_aio_context(state
->bs
);
1480 aio_context_acquire(aio_context
);
1482 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1483 error_reportf_err(local_error
,
1484 "Failed to delete snapshot with id '%s' and "
1485 "name '%s' on device '%s' in abort: ",
1486 sn
->id_str
, sn
->name
,
1487 bdrv_get_device_name(bs
));
1490 aio_context_release(aio_context
);
1493 static void internal_snapshot_clean(BlkActionState
*common
)
1495 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1497 AioContext
*aio_context
;
1503 aio_context
= bdrv_get_aio_context(state
->bs
);
1504 aio_context_acquire(aio_context
);
1506 bdrv_drained_end(state
->bs
);
1508 aio_context_release(aio_context
);
1511 /* external snapshot private data */
1512 typedef struct ExternalSnapshotState
{
1513 BlkActionState common
;
1514 BlockDriverState
*old_bs
;
1515 BlockDriverState
*new_bs
;
1516 bool overlay_appended
;
1517 } ExternalSnapshotState
;
1519 static void external_snapshot_prepare(BlkActionState
*common
,
1523 QDict
*options
= NULL
;
1524 Error
*local_err
= NULL
;
1525 /* Device and node name of the image to generate the snapshot from */
1527 const char *node_name
;
1528 /* Reference to the new image (for 'blockdev-snapshot') */
1529 const char *snapshot_ref
;
1530 /* File name of the new image (for 'blockdev-snapshot-sync') */
1531 const char *new_image_file
;
1532 ExternalSnapshotState
*state
=
1533 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1534 TransactionAction
*action
= common
->action
;
1535 AioContext
*aio_context
;
1537 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1538 * purpose but a different set of parameters */
1539 switch (action
->type
) {
1540 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1542 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1544 node_name
= s
->node
;
1545 new_image_file
= NULL
;
1546 snapshot_ref
= s
->overlay
;
1549 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1551 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1552 device
= s
->has_device
? s
->device
: NULL
;
1553 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1554 new_image_file
= s
->snapshot_file
;
1555 snapshot_ref
= NULL
;
1559 g_assert_not_reached();
1562 /* start processing */
1563 if (action_check_completion_mode(common
, errp
) < 0) {
1567 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1568 if (!state
->old_bs
) {
1572 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1573 aio_context_acquire(aio_context
);
1575 /* Paired with .clean() */
1576 bdrv_drained_begin(state
->old_bs
);
1578 if (!bdrv_is_inserted(state
->old_bs
)) {
1579 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1583 if (bdrv_op_is_blocked(state
->old_bs
,
1584 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1588 if (!bdrv_is_read_only(state
->old_bs
)) {
1589 if (bdrv_flush(state
->old_bs
)) {
1590 error_setg(errp
, QERR_IO_ERROR
);
1595 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1596 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1600 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1601 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1602 const char *format
= s
->has_format
? s
->format
: "qcow2";
1603 enum NewImageMode mode
;
1604 const char *snapshot_node_name
=
1605 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1607 if (node_name
&& !snapshot_node_name
) {
1608 error_setg(errp
, "New snapshot node name missing");
1612 if (snapshot_node_name
&&
1613 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1614 error_setg(errp
, "New snapshot node name already in use");
1618 flags
= state
->old_bs
->open_flags
;
1619 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_COPY_ON_READ
);
1620 flags
|= BDRV_O_NO_BACKING
;
1622 /* create new image w/backing file */
1623 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1624 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1625 int64_t size
= bdrv_getlength(state
->old_bs
);
1627 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1630 bdrv_img_create(new_image_file
, format
,
1631 state
->old_bs
->filename
,
1632 state
->old_bs
->drv
->format_name
,
1633 NULL
, size
, flags
, false, &local_err
);
1635 error_propagate(errp
, local_err
);
1640 options
= qdict_new();
1641 if (snapshot_node_name
) {
1642 qdict_put_str(options
, "node-name", snapshot_node_name
);
1644 qdict_put_str(options
, "driver", format
);
1647 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1649 /* We will manually add the backing_hd field to the bs later */
1650 if (!state
->new_bs
) {
1654 if (bdrv_has_blk(state
->new_bs
)) {
1655 error_setg(errp
, "The snapshot is already in use");
1659 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1664 if (state
->new_bs
->backing
!= NULL
) {
1665 error_setg(errp
, "The snapshot already has a backing image");
1669 if (!state
->new_bs
->drv
->supports_backing
) {
1670 error_setg(errp
, "The snapshot does not support backing images");
1674 bdrv_set_aio_context(state
->new_bs
, aio_context
);
1676 /* This removes our old bs and adds the new bs. This is an operation that
1677 * can fail, so we need to do it in .prepare; undoing it for abort is
1678 * always possible. */
1679 bdrv_ref(state
->new_bs
);
1680 bdrv_append(state
->new_bs
, state
->old_bs
, &local_err
);
1682 error_propagate(errp
, local_err
);
1685 state
->overlay_appended
= true;
1688 aio_context_release(aio_context
);
1691 static void external_snapshot_commit(BlkActionState
*common
)
1693 ExternalSnapshotState
*state
=
1694 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1695 AioContext
*aio_context
;
1697 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1698 aio_context_acquire(aio_context
);
1700 /* We don't need (or want) to use the transactional
1701 * bdrv_reopen_multiple() across all the entries at once, because we
1702 * don't want to abort all of them if one of them fails the reopen */
1703 if (!atomic_read(&state
->old_bs
->copy_on_read
)) {
1704 bdrv_reopen_set_read_only(state
->old_bs
, true, NULL
);
1707 aio_context_release(aio_context
);
1710 static void external_snapshot_abort(BlkActionState
*common
)
1712 ExternalSnapshotState
*state
=
1713 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1714 if (state
->new_bs
) {
1715 if (state
->overlay_appended
) {
1716 AioContext
*aio_context
;
1718 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1719 aio_context_acquire(aio_context
);
1721 bdrv_ref(state
->old_bs
); /* we can't let bdrv_set_backind_hd()
1722 close state->old_bs; we need it */
1723 bdrv_set_backing_hd(state
->new_bs
, NULL
, &error_abort
);
1724 bdrv_replace_node(state
->new_bs
, state
->old_bs
, &error_abort
);
1725 bdrv_unref(state
->old_bs
); /* bdrv_replace_node() ref'ed old_bs */
1727 aio_context_release(aio_context
);
1732 static void external_snapshot_clean(BlkActionState
*common
)
1734 ExternalSnapshotState
*state
=
1735 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1736 AioContext
*aio_context
;
1738 if (!state
->old_bs
) {
1742 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1743 aio_context_acquire(aio_context
);
1745 bdrv_drained_end(state
->old_bs
);
1746 bdrv_unref(state
->new_bs
);
1748 aio_context_release(aio_context
);
1751 typedef struct DriveBackupState
{
1752 BlkActionState common
;
1753 BlockDriverState
*bs
;
1757 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
1760 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1762 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1763 BlockDriverState
*bs
;
1764 DriveBackup
*backup
;
1765 AioContext
*aio_context
;
1766 Error
*local_err
= NULL
;
1768 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1769 backup
= common
->action
->u
.drive_backup
.data
;
1771 bs
= qmp_get_root_bs(backup
->device
, errp
);
1776 aio_context
= bdrv_get_aio_context(bs
);
1777 aio_context_acquire(aio_context
);
1779 /* Paired with .clean() */
1780 bdrv_drained_begin(bs
);
1784 state
->job
= do_drive_backup(backup
, common
->block_job_txn
, &local_err
);
1786 error_propagate(errp
, local_err
);
1791 aio_context_release(aio_context
);
1794 static void drive_backup_commit(BlkActionState
*common
)
1796 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1797 AioContext
*aio_context
;
1799 aio_context
= bdrv_get_aio_context(state
->bs
);
1800 aio_context_acquire(aio_context
);
1803 job_start(&state
->job
->job
);
1805 aio_context_release(aio_context
);
1808 static void drive_backup_abort(BlkActionState
*common
)
1810 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1813 AioContext
*aio_context
;
1815 aio_context
= bdrv_get_aio_context(state
->bs
);
1816 aio_context_acquire(aio_context
);
1818 job_cancel_sync(&state
->job
->job
);
1820 aio_context_release(aio_context
);
1824 static void drive_backup_clean(BlkActionState
*common
)
1826 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1827 AioContext
*aio_context
;
1833 aio_context
= bdrv_get_aio_context(state
->bs
);
1834 aio_context_acquire(aio_context
);
1836 bdrv_drained_end(state
->bs
);
1838 aio_context_release(aio_context
);
1841 typedef struct BlockdevBackupState
{
1842 BlkActionState common
;
1843 BlockDriverState
*bs
;
1845 } BlockdevBackupState
;
1847 static BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
1850 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1852 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1853 BlockdevBackup
*backup
;
1854 BlockDriverState
*bs
, *target
;
1855 AioContext
*aio_context
;
1856 Error
*local_err
= NULL
;
1858 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1859 backup
= common
->action
->u
.blockdev_backup
.data
;
1861 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1866 target
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1871 aio_context
= bdrv_get_aio_context(bs
);
1872 if (aio_context
!= bdrv_get_aio_context(target
)) {
1873 error_setg(errp
, "Backup between two IO threads is not implemented");
1876 aio_context_acquire(aio_context
);
1879 /* Paired with .clean() */
1880 bdrv_drained_begin(state
->bs
);
1882 state
->job
= do_blockdev_backup(backup
, common
->block_job_txn
, &local_err
);
1884 error_propagate(errp
, local_err
);
1889 aio_context_release(aio_context
);
1892 static void blockdev_backup_commit(BlkActionState
*common
)
1894 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1895 AioContext
*aio_context
;
1897 aio_context
= bdrv_get_aio_context(state
->bs
);
1898 aio_context_acquire(aio_context
);
1901 job_start(&state
->job
->job
);
1903 aio_context_release(aio_context
);
1906 static void blockdev_backup_abort(BlkActionState
*common
)
1908 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1911 AioContext
*aio_context
;
1913 aio_context
= bdrv_get_aio_context(state
->bs
);
1914 aio_context_acquire(aio_context
);
1916 job_cancel_sync(&state
->job
->job
);
1918 aio_context_release(aio_context
);
1922 static void blockdev_backup_clean(BlkActionState
*common
)
1924 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1925 AioContext
*aio_context
;
1931 aio_context
= bdrv_get_aio_context(state
->bs
);
1932 aio_context_acquire(aio_context
);
1934 bdrv_drained_end(state
->bs
);
1936 aio_context_release(aio_context
);
1939 typedef struct BlockDirtyBitmapState
{
1940 BlkActionState common
;
1941 BdrvDirtyBitmap
*bitmap
;
1942 BlockDriverState
*bs
;
1946 } BlockDirtyBitmapState
;
1948 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1951 Error
*local_err
= NULL
;
1952 BlockDirtyBitmapAdd
*action
;
1953 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1956 if (action_check_completion_mode(common
, errp
) < 0) {
1960 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1961 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1962 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
1963 action
->has_granularity
, action
->granularity
,
1964 action
->has_persistent
, action
->persistent
,
1965 action
->has_autoload
, action
->autoload
,
1966 action
->has_x_disabled
, action
->x_disabled
,
1970 state
->prepared
= true;
1972 error_propagate(errp
, local_err
);
1976 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
1978 BlockDirtyBitmapAdd
*action
;
1979 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1982 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1983 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1984 * then the node reference and bitmap name must have been valid.
1986 if (state
->prepared
) {
1987 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
1991 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
1994 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1996 BlockDirtyBitmap
*action
;
1998 if (action_check_completion_mode(common
, errp
) < 0) {
2002 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2003 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2007 if (!state
->bitmap
) {
2011 if (bdrv_dirty_bitmap_user_locked(state
->bitmap
)) {
2012 error_setg(errp
, "Cannot modify a bitmap in use by another operation");
2014 } else if (bdrv_dirty_bitmap_readonly(state
->bitmap
)) {
2015 error_setg(errp
, "Cannot clear a readonly bitmap");
2019 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2022 static void block_dirty_bitmap_restore(BlkActionState
*common
)
2024 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2027 if (state
->backup
) {
2028 bdrv_restore_dirty_bitmap(state
->bitmap
, state
->backup
);
2032 static void block_dirty_bitmap_free_backup(BlkActionState
*common
)
2034 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2037 hbitmap_free(state
->backup
);
2040 static void block_dirty_bitmap_enable_prepare(BlkActionState
*common
,
2043 BlockDirtyBitmap
*action
;
2044 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2047 if (action_check_completion_mode(common
, errp
) < 0) {
2051 action
= common
->action
->u
.x_block_dirty_bitmap_enable
.data
;
2052 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2056 if (!state
->bitmap
) {
2060 if (bdrv_dirty_bitmap_user_locked(state
->bitmap
)) {
2062 "Bitmap '%s' is currently in use by another operation"
2063 " and cannot be enabled", action
->name
);
2067 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2068 bdrv_enable_dirty_bitmap(state
->bitmap
);
2071 static void block_dirty_bitmap_enable_abort(BlkActionState
*common
)
2073 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2076 if (!state
->was_enabled
) {
2077 bdrv_disable_dirty_bitmap(state
->bitmap
);
2081 static void block_dirty_bitmap_disable_prepare(BlkActionState
*common
,
2084 BlockDirtyBitmap
*action
;
2085 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2088 if (action_check_completion_mode(common
, errp
) < 0) {
2092 action
= common
->action
->u
.x_block_dirty_bitmap_disable
.data
;
2093 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2097 if (!state
->bitmap
) {
2101 if (bdrv_dirty_bitmap_user_locked(state
->bitmap
)) {
2103 "Bitmap '%s' is currently in use by another operation"
2104 " and cannot be disabled", action
->name
);
2108 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2109 bdrv_disable_dirty_bitmap(state
->bitmap
);
2112 static void block_dirty_bitmap_disable_abort(BlkActionState
*common
)
2114 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2117 if (state
->was_enabled
) {
2118 bdrv_enable_dirty_bitmap(state
->bitmap
);
2122 static void block_dirty_bitmap_merge_prepare(BlkActionState
*common
,
2125 BlockDirtyBitmapMerge
*action
;
2126 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2128 BdrvDirtyBitmap
*merge_source
;
2130 if (action_check_completion_mode(common
, errp
) < 0) {
2134 action
= common
->action
->u
.x_block_dirty_bitmap_merge
.data
;
2135 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2139 if (!state
->bitmap
) {
2143 merge_source
= bdrv_find_dirty_bitmap(state
->bs
, action
->src_name
);
2144 if (!merge_source
) {
2148 bdrv_merge_dirty_bitmap(state
->bitmap
, merge_source
, &state
->backup
, errp
);
2151 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2153 error_setg(errp
, "Transaction aborted using Abort action");
2156 static void abort_commit(BlkActionState
*common
)
2158 g_assert_not_reached(); /* this action never succeeds */
2161 static const BlkActionOps actions
[] = {
2162 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2163 .instance_size
= sizeof(ExternalSnapshotState
),
2164 .prepare
= external_snapshot_prepare
,
2165 .commit
= external_snapshot_commit
,
2166 .abort
= external_snapshot_abort
,
2167 .clean
= external_snapshot_clean
,
2169 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2170 .instance_size
= sizeof(ExternalSnapshotState
),
2171 .prepare
= external_snapshot_prepare
,
2172 .commit
= external_snapshot_commit
,
2173 .abort
= external_snapshot_abort
,
2174 .clean
= external_snapshot_clean
,
2176 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2177 .instance_size
= sizeof(DriveBackupState
),
2178 .prepare
= drive_backup_prepare
,
2179 .commit
= drive_backup_commit
,
2180 .abort
= drive_backup_abort
,
2181 .clean
= drive_backup_clean
,
2183 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2184 .instance_size
= sizeof(BlockdevBackupState
),
2185 .prepare
= blockdev_backup_prepare
,
2186 .commit
= blockdev_backup_commit
,
2187 .abort
= blockdev_backup_abort
,
2188 .clean
= blockdev_backup_clean
,
2190 [TRANSACTION_ACTION_KIND_ABORT
] = {
2191 .instance_size
= sizeof(BlkActionState
),
2192 .prepare
= abort_prepare
,
2193 .commit
= abort_commit
,
2195 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2196 .instance_size
= sizeof(InternalSnapshotState
),
2197 .prepare
= internal_snapshot_prepare
,
2198 .abort
= internal_snapshot_abort
,
2199 .clean
= internal_snapshot_clean
,
2201 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2202 .instance_size
= sizeof(BlockDirtyBitmapState
),
2203 .prepare
= block_dirty_bitmap_add_prepare
,
2204 .abort
= block_dirty_bitmap_add_abort
,
2206 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2207 .instance_size
= sizeof(BlockDirtyBitmapState
),
2208 .prepare
= block_dirty_bitmap_clear_prepare
,
2209 .commit
= block_dirty_bitmap_free_backup
,
2210 .abort
= block_dirty_bitmap_restore
,
2212 [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_ENABLE
] = {
2213 .instance_size
= sizeof(BlockDirtyBitmapState
),
2214 .prepare
= block_dirty_bitmap_enable_prepare
,
2215 .abort
= block_dirty_bitmap_enable_abort
,
2217 [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_DISABLE
] = {
2218 .instance_size
= sizeof(BlockDirtyBitmapState
),
2219 .prepare
= block_dirty_bitmap_disable_prepare
,
2220 .abort
= block_dirty_bitmap_disable_abort
,
2222 [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_MERGE
] = {
2223 .instance_size
= sizeof(BlockDirtyBitmapState
),
2224 .prepare
= block_dirty_bitmap_merge_prepare
,
2225 .commit
= block_dirty_bitmap_free_backup
,
2226 .abort
= block_dirty_bitmap_restore
,
2228 /* Where are transactions for MIRROR, COMMIT and STREAM?
2229 * Although these blockjobs use transaction callbacks like the backup job,
2230 * these jobs do not necessarily adhere to transaction semantics.
2231 * These jobs may not fully undo all of their actions on abort, nor do they
2232 * necessarily work in transactions with more than one job in them.
2237 * Allocate a TransactionProperties structure if necessary, and fill
2238 * that structure with desired defaults if they are unset.
2240 static TransactionProperties
*get_transaction_properties(
2241 TransactionProperties
*props
)
2244 props
= g_new0(TransactionProperties
, 1);
2247 if (!props
->has_completion_mode
) {
2248 props
->has_completion_mode
= true;
2249 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2256 * 'Atomic' group operations. The operations are performed as a set, and if
2257 * any fail then we roll back all operations in the group.
2259 void qmp_transaction(TransactionActionList
*dev_list
,
2261 struct TransactionProperties
*props
,
2264 TransactionActionList
*dev_entry
= dev_list
;
2265 JobTxn
*block_job_txn
= NULL
;
2266 BlkActionState
*state
, *next
;
2267 Error
*local_err
= NULL
;
2269 QSIMPLEQ_HEAD(, BlkActionState
) snap_bdrv_states
;
2270 QSIMPLEQ_INIT(&snap_bdrv_states
);
2272 /* Does this transaction get canceled as a group on failure?
2273 * If not, we don't really need to make a JobTxn.
2275 props
= get_transaction_properties(props
);
2276 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2277 block_job_txn
= job_txn_new();
2280 /* drain all i/o before any operations */
2283 /* We don't do anything in this loop that commits us to the operations */
2284 while (NULL
!= dev_entry
) {
2285 TransactionAction
*dev_info
= NULL
;
2286 const BlkActionOps
*ops
;
2288 dev_info
= dev_entry
->value
;
2289 dev_entry
= dev_entry
->next
;
2291 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2293 ops
= &actions
[dev_info
->type
];
2294 assert(ops
->instance_size
> 0);
2296 state
= g_malloc0(ops
->instance_size
);
2298 state
->action
= dev_info
;
2299 state
->block_job_txn
= block_job_txn
;
2300 state
->txn_props
= props
;
2301 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2303 state
->ops
->prepare(state
, &local_err
);
2305 error_propagate(errp
, local_err
);
2306 goto delete_and_fail
;
2310 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2311 if (state
->ops
->commit
) {
2312 state
->ops
->commit(state
);
2320 /* failure, and it is all-or-none; roll back all operations */
2321 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2322 if (state
->ops
->abort
) {
2323 state
->ops
->abort(state
);
2327 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2328 if (state
->ops
->clean
) {
2329 state
->ops
->clean(state
);
2334 qapi_free_TransactionProperties(props
);
2336 job_txn_unref(block_job_txn
);
2339 void qmp_eject(bool has_device
, const char *device
,
2340 bool has_id
, const char *id
,
2341 bool has_force
, bool force
, Error
**errp
)
2343 Error
*local_err
= NULL
;
2350 rc
= do_open_tray(has_device
? device
: NULL
,
2353 if (rc
&& rc
!= -ENOSYS
) {
2354 error_propagate(errp
, local_err
);
2357 error_free(local_err
);
2359 blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2362 void qmp_block_passwd(bool has_device
, const char *device
,
2363 bool has_node_name
, const char *node_name
,
2364 const char *password
, Error
**errp
)
2367 "Setting block passwords directly is no longer supported");
2371 * Attempt to open the tray of @device.
2372 * If @force, ignore its tray lock.
2373 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2374 * On error, store an error through @errp and return -errno.
2375 * If @device does not exist, return -ENODEV.
2376 * If it has no removable media, return -ENOTSUP.
2377 * If it has no tray, return -ENOSYS.
2378 * If the guest was asked to open the tray, return -EINPROGRESS.
2381 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2382 bool force
, Error
**errp
)
2385 const char *device
= qdev_id
?: blk_name
;
2388 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2393 if (!blk_dev_has_removable_media(blk
)) {
2394 error_setg(errp
, "Device '%s' is not removable", device
);
2398 if (!blk_dev_has_tray(blk
)) {
2399 error_setg(errp
, "Device '%s' does not have a tray", device
);
2403 if (blk_dev_is_tray_open(blk
)) {
2407 locked
= blk_dev_is_medium_locked(blk
);
2409 blk_dev_eject_request(blk
, force
);
2412 if (!locked
|| force
) {
2413 blk_dev_change_media_cb(blk
, false, &error_abort
);
2416 if (locked
&& !force
) {
2417 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2418 "wait for tray to open and try again", device
);
2419 return -EINPROGRESS
;
2425 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2426 bool has_id
, const char *id
,
2427 bool has_force
, bool force
,
2430 Error
*local_err
= NULL
;
2436 rc
= do_open_tray(has_device
? device
: NULL
,
2439 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2440 error_propagate(errp
, local_err
);
2443 error_free(local_err
);
2446 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2447 bool has_id
, const char *id
,
2451 Error
*local_err
= NULL
;
2453 device
= has_device
? device
: NULL
;
2454 id
= has_id
? id
: NULL
;
2456 blk
= qmp_get_blk(device
, id
, errp
);
2461 if (!blk_dev_has_removable_media(blk
)) {
2462 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2466 if (!blk_dev_has_tray(blk
)) {
2467 /* Ignore this command on tray-less devices */
2471 if (!blk_dev_is_tray_open(blk
)) {
2475 blk_dev_change_media_cb(blk
, true, &local_err
);
2477 error_propagate(errp
, local_err
);
2482 static void blockdev_remove_medium(bool has_device
, const char *device
,
2483 bool has_id
, const char *id
, Error
**errp
)
2486 BlockDriverState
*bs
;
2487 AioContext
*aio_context
;
2488 bool has_attached_device
;
2490 device
= has_device
? device
: NULL
;
2491 id
= has_id
? id
: NULL
;
2493 blk
= qmp_get_blk(device
, id
, errp
);
2498 /* For BBs without a device, we can exchange the BDS tree at will */
2499 has_attached_device
= blk_get_attached_dev(blk
);
2501 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2502 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2506 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2507 !blk_dev_is_tray_open(blk
))
2509 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2518 aio_context
= bdrv_get_aio_context(bs
);
2519 aio_context_acquire(aio_context
);
2521 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2527 if (!blk_dev_has_tray(blk
)) {
2528 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2529 * called at all); therefore, the medium needs to be ejected here.
2530 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2531 * value passed here (i.e. false). */
2532 blk_dev_change_media_cb(blk
, false, &error_abort
);
2536 aio_context_release(aio_context
);
2539 void qmp_blockdev_remove_medium(const char *id
, Error
**errp
)
2541 blockdev_remove_medium(false, NULL
, true, id
, errp
);
2544 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2545 BlockDriverState
*bs
, Error
**errp
)
2547 Error
*local_err
= NULL
;
2551 /* For BBs without a device, we can exchange the BDS tree at will */
2552 has_device
= blk_get_attached_dev(blk
);
2554 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2555 error_setg(errp
, "Device is not removable");
2559 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2560 error_setg(errp
, "Tray of the device is not open");
2565 error_setg(errp
, "There already is a medium in the device");
2569 ret
= blk_insert_bs(blk
, bs
, errp
);
2574 if (!blk_dev_has_tray(blk
)) {
2575 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2576 * called at all); therefore, the medium needs to be pushed into the
2578 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2579 * value passed here (i.e. true). */
2580 blk_dev_change_media_cb(blk
, true, &local_err
);
2582 error_propagate(errp
, local_err
);
2589 static void blockdev_insert_medium(bool has_device
, const char *device
,
2590 bool has_id
, const char *id
,
2591 const char *node_name
, Error
**errp
)
2594 BlockDriverState
*bs
;
2596 blk
= qmp_get_blk(has_device
? device
: NULL
,
2603 bs
= bdrv_find_node(node_name
);
2605 error_setg(errp
, "Node '%s' not found", node_name
);
2609 if (bdrv_has_blk(bs
)) {
2610 error_setg(errp
, "Node '%s' is already in use", node_name
);
2614 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2617 void qmp_blockdev_insert_medium(const char *id
, const char *node_name
,
2620 blockdev_insert_medium(false, NULL
, true, id
, node_name
, errp
);
2623 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2624 bool has_id
, const char *id
,
2625 const char *filename
,
2626 bool has_format
, const char *format
,
2628 BlockdevChangeReadOnlyMode read_only
,
2632 BlockDriverState
*medium_bs
= NULL
;
2636 QDict
*options
= NULL
;
2639 blk
= qmp_get_blk(has_device
? device
: NULL
,
2647 blk_update_root_state(blk
);
2650 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2651 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2652 BDRV_O_PROTOCOL
| BDRV_O_AUTO_RDONLY
);
2654 if (!has_read_only
) {
2655 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2658 switch (read_only
) {
2659 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2662 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2663 bdrv_flags
&= ~BDRV_O_RDWR
;
2666 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2667 bdrv_flags
|= BDRV_O_RDWR
;
2674 options
= qdict_new();
2675 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2676 qdict_put_str(options
, "detect-zeroes", detect_zeroes
? "on" : "off");
2679 qdict_put_str(options
, "driver", format
);
2682 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2687 rc
= do_open_tray(has_device
? device
: NULL
,
2690 if (rc
&& rc
!= -ENOSYS
) {
2691 error_propagate(errp
, err
);
2697 blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2699 error_propagate(errp
, err
);
2703 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2705 error_propagate(errp
, err
);
2709 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2712 /* If the medium has been inserted, the device has its own reference, so
2713 * ours must be relinquished; and if it has not been inserted successfully,
2714 * the reference must be relinquished anyway */
2715 bdrv_unref(medium_bs
);
2718 /* throttling disk I/O limits */
2719 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2722 BlockDriverState
*bs
;
2724 AioContext
*aio_context
;
2726 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2727 arg
->has_id
? arg
->id
: NULL
,
2733 aio_context
= blk_get_aio_context(blk
);
2734 aio_context_acquire(aio_context
);
2738 error_setg(errp
, "Device has no medium");
2742 throttle_config_init(&cfg
);
2743 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2744 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2745 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2747 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2748 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2749 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2751 if (arg
->has_bps_max
) {
2752 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2754 if (arg
->has_bps_rd_max
) {
2755 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2757 if (arg
->has_bps_wr_max
) {
2758 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2760 if (arg
->has_iops_max
) {
2761 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2763 if (arg
->has_iops_rd_max
) {
2764 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2766 if (arg
->has_iops_wr_max
) {
2767 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2770 if (arg
->has_bps_max_length
) {
2771 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2773 if (arg
->has_bps_rd_max_length
) {
2774 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2776 if (arg
->has_bps_wr_max_length
) {
2777 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2779 if (arg
->has_iops_max_length
) {
2780 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2782 if (arg
->has_iops_rd_max_length
) {
2783 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2785 if (arg
->has_iops_wr_max_length
) {
2786 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2789 if (arg
->has_iops_size
) {
2790 cfg
.op_size
= arg
->iops_size
;
2793 if (!throttle_is_valid(&cfg
, errp
)) {
2797 if (throttle_enabled(&cfg
)) {
2798 /* Enable I/O limits if they're not enabled yet, otherwise
2799 * just update the throttling group. */
2800 if (!blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2801 blk_io_limits_enable(blk
,
2802 arg
->has_group
? arg
->group
:
2803 arg
->has_device
? arg
->device
:
2805 } else if (arg
->has_group
) {
2806 blk_io_limits_update_group(blk
, arg
->group
);
2808 /* Set the new throttling configuration */
2809 blk_set_io_limits(blk
, &cfg
);
2810 } else if (blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2811 /* If all throttling settings are set to 0, disable I/O limits */
2812 blk_io_limits_disable(blk
);
2816 aio_context_release(aio_context
);
2819 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2820 bool has_granularity
, uint32_t granularity
,
2821 bool has_persistent
, bool persistent
,
2822 bool has_autoload
, bool autoload
,
2823 bool has_disabled
, bool disabled
,
2826 BlockDriverState
*bs
;
2827 BdrvDirtyBitmap
*bitmap
;
2829 if (!name
|| name
[0] == '\0') {
2830 error_setg(errp
, "Bitmap name cannot be empty");
2834 bs
= bdrv_lookup_bs(node
, node
, errp
);
2839 if (has_granularity
) {
2840 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2841 error_setg(errp
, "Granularity must be power of 2 "
2842 "and at least 512");
2846 /* Default to cluster size, if available: */
2847 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2850 if (!has_persistent
) {
2855 warn_report("Autoload option is deprecated and its value is ignored");
2858 if (!has_disabled
) {
2863 !bdrv_can_store_new_dirty_bitmap(bs
, name
, granularity
, errp
))
2868 bitmap
= bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2869 if (bitmap
== NULL
) {
2874 bdrv_disable_dirty_bitmap(bitmap
);
2877 bdrv_dirty_bitmap_set_persistance(bitmap
, persistent
);
2880 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2883 BlockDriverState
*bs
;
2884 BdrvDirtyBitmap
*bitmap
;
2885 Error
*local_err
= NULL
;
2887 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2888 if (!bitmap
|| !bs
) {
2892 if (bdrv_dirty_bitmap_user_locked(bitmap
)) {
2894 "Bitmap '%s' is currently in use by another operation and"
2895 " cannot be removed", name
);
2899 if (bdrv_dirty_bitmap_get_persistance(bitmap
)) {
2900 bdrv_remove_persistent_dirty_bitmap(bs
, name
, &local_err
);
2901 if (local_err
!= NULL
) {
2902 error_propagate(errp
, local_err
);
2907 bdrv_release_dirty_bitmap(bs
, bitmap
);
2911 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2912 * immediately after a full backup operation.
2914 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2917 BdrvDirtyBitmap
*bitmap
;
2918 BlockDriverState
*bs
;
2920 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2921 if (!bitmap
|| !bs
) {
2925 if (bdrv_dirty_bitmap_user_locked(bitmap
)) {
2927 "Bitmap '%s' is currently in use by another operation"
2928 " and cannot be cleared", name
);
2930 } else if (bdrv_dirty_bitmap_readonly(bitmap
)) {
2931 error_setg(errp
, "Bitmap '%s' is readonly and cannot be cleared", name
);
2935 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2938 void qmp_x_block_dirty_bitmap_enable(const char *node
, const char *name
,
2941 BlockDriverState
*bs
;
2942 BdrvDirtyBitmap
*bitmap
;
2944 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2949 if (bdrv_dirty_bitmap_user_locked(bitmap
)) {
2951 "Bitmap '%s' is currently in use by another operation"
2952 " and cannot be enabled", name
);
2956 bdrv_enable_dirty_bitmap(bitmap
);
2959 void qmp_x_block_dirty_bitmap_disable(const char *node
, const char *name
,
2962 BlockDriverState
*bs
;
2963 BdrvDirtyBitmap
*bitmap
;
2965 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2970 if (bdrv_dirty_bitmap_user_locked(bitmap
)) {
2972 "Bitmap '%s' is currently in use by another operation"
2973 " and cannot be disabled", name
);
2977 bdrv_disable_dirty_bitmap(bitmap
);
2980 void qmp_x_block_dirty_bitmap_merge(const char *node
, const char *dst_name
,
2981 const char *src_name
, Error
**errp
)
2983 BlockDriverState
*bs
;
2984 BdrvDirtyBitmap
*dst
, *src
;
2986 dst
= block_dirty_bitmap_lookup(node
, dst_name
, &bs
, errp
);
2991 src
= bdrv_find_dirty_bitmap(bs
, src_name
);
2993 error_setg(errp
, "Dirty bitmap '%s' not found", src_name
);
2997 bdrv_merge_dirty_bitmap(dst
, src
, NULL
, errp
);
3000 BlockDirtyBitmapSha256
*qmp_x_debug_block_dirty_bitmap_sha256(const char *node
,
3004 BdrvDirtyBitmap
*bitmap
;
3005 BlockDriverState
*bs
;
3006 BlockDirtyBitmapSha256
*ret
= NULL
;
3009 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3010 if (!bitmap
|| !bs
) {
3014 sha256
= bdrv_dirty_bitmap_sha256(bitmap
, errp
);
3015 if (sha256
== NULL
) {
3019 ret
= g_new(BlockDirtyBitmapSha256
, 1);
3020 ret
->sha256
= sha256
;
3025 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
3027 const char *id
= qdict_get_str(qdict
, "id");
3029 BlockDriverState
*bs
;
3030 AioContext
*aio_context
;
3031 Error
*local_err
= NULL
;
3033 bs
= bdrv_find_node(id
);
3035 qmp_blockdev_del(id
, &local_err
);
3037 error_report_err(local_err
);
3042 blk
= blk_by_name(id
);
3044 error_report("Device '%s' not found", id
);
3048 if (!blk_legacy_dinfo(blk
)) {
3049 error_report("Deleting device added with blockdev-add"
3050 " is not supported");
3054 aio_context
= blk_get_aio_context(blk
);
3055 aio_context_acquire(aio_context
);
3059 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
3060 error_report_err(local_err
);
3061 aio_context_release(aio_context
);
3068 /* Make the BlockBackend and the attached BlockDriverState anonymous */
3069 monitor_remove_blk(blk
);
3071 /* If this BlockBackend has a device attached to it, its refcount will be
3072 * decremented when the device is removed; otherwise we have to do so here.
3074 if (blk_get_attached_dev(blk
)) {
3075 /* Further I/O must not pause the guest */
3076 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
3077 BLOCKDEV_ON_ERROR_REPORT
);
3082 aio_context_release(aio_context
);
3085 void qmp_block_resize(bool has_device
, const char *device
,
3086 bool has_node_name
, const char *node_name
,
3087 int64_t size
, Error
**errp
)
3089 Error
*local_err
= NULL
;
3090 BlockBackend
*blk
= NULL
;
3091 BlockDriverState
*bs
;
3092 AioContext
*aio_context
;
3095 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
3096 has_node_name
? node_name
: NULL
,
3099 error_propagate(errp
, local_err
);
3103 aio_context
= bdrv_get_aio_context(bs
);
3104 aio_context_acquire(aio_context
);
3106 if (!bdrv_is_first_non_filter(bs
)) {
3107 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
3112 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
3116 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
3117 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
3121 blk
= blk_new(BLK_PERM_RESIZE
, BLK_PERM_ALL
);
3122 ret
= blk_insert_bs(blk
, bs
, errp
);
3127 bdrv_drained_begin(bs
);
3128 ret
= blk_truncate(blk
, size
, PREALLOC_MODE_OFF
, errp
);
3129 bdrv_drained_end(bs
);
3133 aio_context_release(aio_context
);
3136 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
3137 bool has_base
, const char *base
,
3138 bool has_base_node
, const char *base_node
,
3139 bool has_backing_file
, const char *backing_file
,
3140 bool has_speed
, int64_t speed
,
3141 bool has_on_error
, BlockdevOnError on_error
,
3142 bool has_auto_finalize
, bool auto_finalize
,
3143 bool has_auto_dismiss
, bool auto_dismiss
,
3146 BlockDriverState
*bs
, *iter
;
3147 BlockDriverState
*base_bs
= NULL
;
3148 AioContext
*aio_context
;
3149 Error
*local_err
= NULL
;
3150 const char *base_name
= NULL
;
3151 int job_flags
= JOB_DEFAULT
;
3153 if (!has_on_error
) {
3154 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3157 bs
= bdrv_lookup_bs(device
, device
, errp
);
3162 aio_context
= bdrv_get_aio_context(bs
);
3163 aio_context_acquire(aio_context
);
3165 if (has_base
&& has_base_node
) {
3166 error_setg(errp
, "'base' and 'base-node' cannot be specified "
3167 "at the same time");
3172 base_bs
= bdrv_find_backing_image(bs
, base
);
3173 if (base_bs
== NULL
) {
3174 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
3177 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3181 if (has_base_node
) {
3182 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3186 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
3187 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
3191 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3192 base_name
= base_bs
->filename
;
3195 /* Check for op blockers in the whole chain between bs and base */
3196 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
3197 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3202 /* if we are streaming the entire chain, the result will have no backing
3203 * file, and specifying one is therefore an error */
3204 if (base_bs
== NULL
&& has_backing_file
) {
3205 error_setg(errp
, "backing file specified, but streaming the "
3210 /* backing_file string overrides base bs filename */
3211 base_name
= has_backing_file
? backing_file
: base_name
;
3213 if (has_auto_finalize
&& !auto_finalize
) {
3214 job_flags
|= JOB_MANUAL_FINALIZE
;
3216 if (has_auto_dismiss
&& !auto_dismiss
) {
3217 job_flags
|= JOB_MANUAL_DISMISS
;
3220 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
3221 job_flags
, has_speed
? speed
: 0, on_error
, &local_err
);
3223 error_propagate(errp
, local_err
);
3227 trace_qmp_block_stream(bs
, bs
->job
);
3230 aio_context_release(aio_context
);
3233 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
3234 bool has_base_node
, const char *base_node
,
3235 bool has_base
, const char *base
,
3236 bool has_top_node
, const char *top_node
,
3237 bool has_top
, const char *top
,
3238 bool has_backing_file
, const char *backing_file
,
3239 bool has_speed
, int64_t speed
,
3240 bool has_filter_node_name
, const char *filter_node_name
,
3241 bool has_auto_finalize
, bool auto_finalize
,
3242 bool has_auto_dismiss
, bool auto_dismiss
,
3245 BlockDriverState
*bs
;
3246 BlockDriverState
*iter
;
3247 BlockDriverState
*base_bs
, *top_bs
;
3248 AioContext
*aio_context
;
3249 Error
*local_err
= NULL
;
3250 /* This will be part of the QMP command, if/when the
3251 * BlockdevOnError change for blkmirror makes it in
3253 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3254 int job_flags
= JOB_DEFAULT
;
3259 if (!has_filter_node_name
) {
3260 filter_node_name
= NULL
;
3262 if (has_auto_finalize
&& !auto_finalize
) {
3263 job_flags
|= JOB_MANUAL_FINALIZE
;
3265 if (has_auto_dismiss
&& !auto_dismiss
) {
3266 job_flags
|= JOB_MANUAL_DISMISS
;
3270 * libvirt relies on the DeviceNotFound error class in order to probe for
3271 * live commit feature versions; for this to work, we must make sure to
3272 * perform the device lookup before any generic errors that may occur in a
3273 * scenario in which all optional arguments are omitted. */
3274 bs
= qmp_get_root_bs(device
, &local_err
);
3276 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3278 error_free(local_err
);
3279 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3280 "Device '%s' not found", device
);
3282 error_propagate(errp
, local_err
);
3287 aio_context
= bdrv_get_aio_context(bs
);
3288 aio_context_acquire(aio_context
);
3290 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3294 /* default top_bs is the active layer */
3297 if (has_top_node
&& has_top
) {
3298 error_setg(errp
, "'top-node' and 'top' are mutually exclusive");
3300 } else if (has_top_node
) {
3301 top_bs
= bdrv_lookup_bs(NULL
, top_node
, errp
);
3302 if (top_bs
== NULL
) {
3305 if (!bdrv_chain_contains(bs
, top_bs
)) {
3306 error_setg(errp
, "'%s' is not in this backing file chain",
3310 } else if (has_top
&& top
) {
3311 if (strcmp(bs
->filename
, top
) != 0) {
3312 top_bs
= bdrv_find_backing_image(bs
, top
);
3316 if (top_bs
== NULL
) {
3317 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3321 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3323 if (has_base_node
&& has_base
) {
3324 error_setg(errp
, "'base-node' and 'base' are mutually exclusive");
3326 } else if (has_base_node
) {
3327 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3328 if (base_bs
== NULL
) {
3331 if (!bdrv_chain_contains(top_bs
, base_bs
)) {
3332 error_setg(errp
, "'%s' is not in this backing file chain",
3336 } else if (has_base
&& base
) {
3337 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3339 base_bs
= bdrv_find_base(top_bs
);
3342 if (base_bs
== NULL
) {
3343 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3347 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3349 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
3350 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3355 /* Do not allow attempts to commit an image into itself */
3356 if (top_bs
== base_bs
) {
3357 error_setg(errp
, "cannot commit an image into itself");
3362 if (has_backing_file
) {
3363 error_setg(errp
, "'backing-file' specified,"
3364 " but 'top' is the active layer");
3367 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
3368 job_flags
, speed
, on_error
,
3369 filter_node_name
, NULL
, NULL
, false, &local_err
);
3371 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
3372 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3375 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, job_flags
,
3376 speed
, on_error
, has_backing_file
? backing_file
: NULL
,
3377 filter_node_name
, &local_err
);
3379 if (local_err
!= NULL
) {
3380 error_propagate(errp
, local_err
);
3385 aio_context_release(aio_context
);
3388 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
3391 BlockDriverState
*bs
;
3392 BlockDriverState
*target_bs
;
3393 BlockDriverState
*source
= NULL
;
3394 BlockJob
*job
= NULL
;
3395 BdrvDirtyBitmap
*bmap
= NULL
;
3396 AioContext
*aio_context
;
3397 QDict
*options
= NULL
;
3398 Error
*local_err
= NULL
;
3399 int flags
, job_flags
= JOB_DEFAULT
;
3401 bool set_backing_hd
= false;
3403 if (!backup
->has_speed
) {
3406 if (!backup
->has_on_source_error
) {
3407 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3409 if (!backup
->has_on_target_error
) {
3410 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3412 if (!backup
->has_mode
) {
3413 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3415 if (!backup
->has_job_id
) {
3416 backup
->job_id
= NULL
;
3418 if (!backup
->has_auto_finalize
) {
3419 backup
->auto_finalize
= true;
3421 if (!backup
->has_auto_dismiss
) {
3422 backup
->auto_dismiss
= true;
3424 if (!backup
->has_compress
) {
3425 backup
->compress
= false;
3428 bs
= qmp_get_root_bs(backup
->device
, errp
);
3433 aio_context
= bdrv_get_aio_context(bs
);
3434 aio_context_acquire(aio_context
);
3436 if (!backup
->has_format
) {
3437 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
3438 NULL
: (char*) bs
->drv
->format_name
;
3441 /* Early check to avoid creating target */
3442 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3446 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3448 /* See if we have a backing HD we can use to create our new image
3450 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
3451 source
= backing_bs(bs
);
3453 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
3456 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3458 flags
|= BDRV_O_NO_BACKING
;
3459 set_backing_hd
= true;
3462 size
= bdrv_getlength(bs
);
3464 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3468 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
3469 assert(backup
->format
);
3471 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
3472 source
->drv
->format_name
, NULL
,
3473 size
, flags
, false, &local_err
);
3475 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
3476 size
, flags
, false, &local_err
);
3481 error_propagate(errp
, local_err
);
3485 if (backup
->format
) {
3487 options
= qdict_new();
3489 qdict_put_str(options
, "driver", backup
->format
);
3492 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
3497 bdrv_set_aio_context(target_bs
, aio_context
);
3499 if (set_backing_hd
) {
3500 bdrv_set_backing_hd(target_bs
, source
, &local_err
);
3502 bdrv_unref(target_bs
);
3507 if (backup
->has_bitmap
) {
3508 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3510 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3511 bdrv_unref(target_bs
);
3514 if (bdrv_dirty_bitmap_user_locked(bmap
)) {
3516 "Bitmap '%s' is currently in use by another operation"
3517 " and cannot be used for backup", backup
->bitmap
);
3521 if (!backup
->auto_finalize
) {
3522 job_flags
|= JOB_MANUAL_FINALIZE
;
3524 if (!backup
->auto_dismiss
) {
3525 job_flags
|= JOB_MANUAL_DISMISS
;
3528 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3529 backup
->sync
, bmap
, backup
->compress
,
3530 backup
->on_source_error
, backup
->on_target_error
,
3531 job_flags
, NULL
, NULL
, txn
, &local_err
);
3532 bdrv_unref(target_bs
);
3533 if (local_err
!= NULL
) {
3534 error_propagate(errp
, local_err
);
3539 aio_context_release(aio_context
);
3543 void qmp_drive_backup(DriveBackup
*arg
, Error
**errp
)
3547 job
= do_drive_backup(arg
, NULL
, errp
);
3549 job_start(&job
->job
);
3553 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3555 return bdrv_named_nodes_list(errp
);
3558 BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
3561 BlockDriverState
*bs
;
3562 BlockDriverState
*target_bs
;
3563 Error
*local_err
= NULL
;
3564 BdrvDirtyBitmap
*bmap
= NULL
;
3565 AioContext
*aio_context
;
3566 BlockJob
*job
= NULL
;
3567 int job_flags
= JOB_DEFAULT
;
3569 if (!backup
->has_speed
) {
3572 if (!backup
->has_on_source_error
) {
3573 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3575 if (!backup
->has_on_target_error
) {
3576 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3578 if (!backup
->has_job_id
) {
3579 backup
->job_id
= NULL
;
3581 if (!backup
->has_auto_finalize
) {
3582 backup
->auto_finalize
= true;
3584 if (!backup
->has_auto_dismiss
) {
3585 backup
->auto_dismiss
= true;
3587 if (!backup
->has_compress
) {
3588 backup
->compress
= false;
3591 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
3596 aio_context
= bdrv_get_aio_context(bs
);
3597 aio_context_acquire(aio_context
);
3599 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
3604 if (bdrv_get_aio_context(target_bs
) != aio_context
) {
3605 if (!bdrv_has_blk(target_bs
)) {
3606 /* The target BDS is not attached, we can safely move it to another
3608 bdrv_set_aio_context(target_bs
, aio_context
);
3610 error_setg(errp
, "Target is attached to a different thread from "
3616 if (backup
->has_bitmap
) {
3617 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3619 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3622 if (bdrv_dirty_bitmap_user_locked(bmap
)) {
3624 "Bitmap '%s' is currently in use by another operation"
3625 " and cannot be used for backup", backup
->bitmap
);
3630 if (!backup
->auto_finalize
) {
3631 job_flags
|= JOB_MANUAL_FINALIZE
;
3633 if (!backup
->auto_dismiss
) {
3634 job_flags
|= JOB_MANUAL_DISMISS
;
3636 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3637 backup
->sync
, bmap
, backup
->compress
,
3638 backup
->on_source_error
, backup
->on_target_error
,
3639 job_flags
, NULL
, NULL
, txn
, &local_err
);
3640 if (local_err
!= NULL
) {
3641 error_propagate(errp
, local_err
);
3644 aio_context_release(aio_context
);
3648 void qmp_blockdev_backup(BlockdevBackup
*arg
, Error
**errp
)
3651 job
= do_blockdev_backup(arg
, NULL
, errp
);
3653 job_start(&job
->job
);
3657 /* Parameter check and block job starting for drive mirroring.
3658 * Caller should hold @device and @target's aio context (must be the same).
3660 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3661 BlockDriverState
*target
,
3662 bool has_replaces
, const char *replaces
,
3663 enum MirrorSyncMode sync
,
3664 BlockMirrorBackingMode backing_mode
,
3665 bool has_speed
, int64_t speed
,
3666 bool has_granularity
, uint32_t granularity
,
3667 bool has_buf_size
, int64_t buf_size
,
3668 bool has_on_source_error
,
3669 BlockdevOnError on_source_error
,
3670 bool has_on_target_error
,
3671 BlockdevOnError on_target_error
,
3672 bool has_unmap
, bool unmap
,
3673 bool has_filter_node_name
,
3674 const char *filter_node_name
,
3675 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3676 bool has_auto_finalize
, bool auto_finalize
,
3677 bool has_auto_dismiss
, bool auto_dismiss
,
3680 int job_flags
= JOB_DEFAULT
;
3685 if (!has_on_source_error
) {
3686 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3688 if (!has_on_target_error
) {
3689 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3691 if (!has_granularity
) {
3694 if (!has_buf_size
) {
3700 if (!has_filter_node_name
) {
3701 filter_node_name
= NULL
;
3703 if (!has_copy_mode
) {
3704 copy_mode
= MIRROR_COPY_MODE_BACKGROUND
;
3706 if (has_auto_finalize
&& !auto_finalize
) {
3707 job_flags
|= JOB_MANUAL_FINALIZE
;
3709 if (has_auto_dismiss
&& !auto_dismiss
) {
3710 job_flags
|= JOB_MANUAL_DISMISS
;
3713 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3714 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3715 "a value in range [512B, 64MB]");
3718 if (granularity
& (granularity
- 1)) {
3719 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3724 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3727 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3731 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3732 sync
= MIRROR_SYNC_MODE_FULL
;
3735 /* pass the node name to replace to mirror start since it's loose coupling
3736 * and will allow to check whether the node still exist at mirror completion
3738 mirror_start(job_id
, bs
, target
,
3739 has_replaces
? replaces
: NULL
, job_flags
,
3740 speed
, granularity
, buf_size
, sync
, backing_mode
,
3741 on_source_error
, on_target_error
, unmap
, filter_node_name
,
3745 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3747 BlockDriverState
*bs
;
3748 BlockDriverState
*source
, *target_bs
;
3749 AioContext
*aio_context
;
3750 BlockMirrorBackingMode backing_mode
;
3751 Error
*local_err
= NULL
;
3752 QDict
*options
= NULL
;
3755 const char *format
= arg
->format
;
3757 bs
= qmp_get_root_bs(arg
->device
, errp
);
3762 /* Early check to avoid creating target */
3763 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3767 aio_context
= bdrv_get_aio_context(bs
);
3768 aio_context_acquire(aio_context
);
3770 if (!arg
->has_mode
) {
3771 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3774 if (!arg
->has_format
) {
3775 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3776 ? NULL
: bs
->drv
->format_name
);
3779 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3780 source
= backing_bs(bs
);
3781 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3782 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3784 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3788 size
= bdrv_getlength(bs
);
3790 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3794 if (arg
->has_replaces
) {
3795 BlockDriverState
*to_replace_bs
;
3796 AioContext
*replace_aio_context
;
3797 int64_t replace_size
;
3799 if (!arg
->has_node_name
) {
3800 error_setg(errp
, "a node-name must be provided when replacing a"
3801 " named node of the graph");
3805 to_replace_bs
= check_to_replace_node(bs
, arg
->replaces
, &local_err
);
3807 if (!to_replace_bs
) {
3808 error_propagate(errp
, local_err
);
3812 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3813 aio_context_acquire(replace_aio_context
);
3814 replace_size
= bdrv_getlength(to_replace_bs
);
3815 aio_context_release(replace_aio_context
);
3817 if (size
!= replace_size
) {
3818 error_setg(errp
, "cannot replace image with a mirror image of "
3824 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3825 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3827 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3830 /* Don't open backing image in create() */
3831 flags
|= BDRV_O_NO_BACKING
;
3833 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3834 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3836 /* create new image w/o backing file */
3838 bdrv_img_create(arg
->target
, format
,
3839 NULL
, NULL
, NULL
, size
, flags
, false, &local_err
);
3841 switch (arg
->mode
) {
3842 case NEW_IMAGE_MODE_EXISTING
:
3844 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3845 /* create new image with backing file */
3846 bdrv_img_create(arg
->target
, format
,
3848 source
->drv
->format_name
,
3849 NULL
, size
, flags
, false, &local_err
);
3857 error_propagate(errp
, local_err
);
3861 options
= qdict_new();
3862 if (arg
->has_node_name
) {
3863 qdict_put_str(options
, "node-name", arg
->node_name
);
3866 qdict_put_str(options
, "driver", format
);
3869 /* Mirroring takes care of copy-on-write using the source's backing
3872 target_bs
= bdrv_open(arg
->target
, NULL
, options
, flags
, errp
);
3877 bdrv_set_aio_context(target_bs
, aio_context
);
3879 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3880 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3881 backing_mode
, arg
->has_speed
, arg
->speed
,
3882 arg
->has_granularity
, arg
->granularity
,
3883 arg
->has_buf_size
, arg
->buf_size
,
3884 arg
->has_on_source_error
, arg
->on_source_error
,
3885 arg
->has_on_target_error
, arg
->on_target_error
,
3886 arg
->has_unmap
, arg
->unmap
,
3888 arg
->has_copy_mode
, arg
->copy_mode
,
3889 arg
->has_auto_finalize
, arg
->auto_finalize
,
3890 arg
->has_auto_dismiss
, arg
->auto_dismiss
,
3892 bdrv_unref(target_bs
);
3893 error_propagate(errp
, local_err
);
3895 aio_context_release(aio_context
);
3898 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3899 const char *device
, const char *target
,
3900 bool has_replaces
, const char *replaces
,
3901 MirrorSyncMode sync
,
3902 bool has_speed
, int64_t speed
,
3903 bool has_granularity
, uint32_t granularity
,
3904 bool has_buf_size
, int64_t buf_size
,
3905 bool has_on_source_error
,
3906 BlockdevOnError on_source_error
,
3907 bool has_on_target_error
,
3908 BlockdevOnError on_target_error
,
3909 bool has_filter_node_name
,
3910 const char *filter_node_name
,
3911 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3912 bool has_auto_finalize
, bool auto_finalize
,
3913 bool has_auto_dismiss
, bool auto_dismiss
,
3916 BlockDriverState
*bs
;
3917 BlockDriverState
*target_bs
;
3918 AioContext
*aio_context
;
3919 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3920 Error
*local_err
= NULL
;
3922 bs
= qmp_get_root_bs(device
, errp
);
3927 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3932 aio_context
= bdrv_get_aio_context(bs
);
3933 aio_context_acquire(aio_context
);
3935 bdrv_set_aio_context(target_bs
, aio_context
);
3937 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3938 has_replaces
, replaces
, sync
, backing_mode
,
3940 has_granularity
, granularity
,
3941 has_buf_size
, buf_size
,
3942 has_on_source_error
, on_source_error
,
3943 has_on_target_error
, on_target_error
,
3945 has_filter_node_name
, filter_node_name
,
3946 has_copy_mode
, copy_mode
,
3947 has_auto_finalize
, auto_finalize
,
3948 has_auto_dismiss
, auto_dismiss
,
3950 error_propagate(errp
, local_err
);
3952 aio_context_release(aio_context
);
3955 /* Get a block job using its ID and acquire its AioContext */
3956 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
3963 *aio_context
= NULL
;
3965 job
= block_job_get(id
);
3968 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3969 "Block job '%s' not found", id
);
3973 *aio_context
= blk_get_aio_context(job
->blk
);
3974 aio_context_acquire(*aio_context
);
3979 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3981 AioContext
*aio_context
;
3982 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3988 block_job_set_speed(job
, speed
, errp
);
3989 aio_context_release(aio_context
);
3992 void qmp_block_job_cancel(const char *device
,
3993 bool has_force
, bool force
, Error
**errp
)
3995 AioContext
*aio_context
;
3996 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4006 if (job_user_paused(&job
->job
) && !force
) {
4007 error_setg(errp
, "The block job for device '%s' is currently paused",
4012 trace_qmp_block_job_cancel(job
);
4013 job_user_cancel(&job
->job
, force
, errp
);
4015 aio_context_release(aio_context
);
4018 void qmp_block_job_pause(const char *device
, Error
**errp
)
4020 AioContext
*aio_context
;
4021 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4027 trace_qmp_block_job_pause(job
);
4028 job_user_pause(&job
->job
, errp
);
4029 aio_context_release(aio_context
);
4032 void qmp_block_job_resume(const char *device
, Error
**errp
)
4034 AioContext
*aio_context
;
4035 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4041 trace_qmp_block_job_resume(job
);
4042 job_user_resume(&job
->job
, errp
);
4043 aio_context_release(aio_context
);
4046 void qmp_block_job_complete(const char *device
, Error
**errp
)
4048 AioContext
*aio_context
;
4049 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4055 trace_qmp_block_job_complete(job
);
4056 job_complete(&job
->job
, errp
);
4057 aio_context_release(aio_context
);
4060 void qmp_block_job_finalize(const char *id
, Error
**errp
)
4062 AioContext
*aio_context
;
4063 BlockJob
*job
= find_block_job(id
, &aio_context
, errp
);
4069 trace_qmp_block_job_finalize(job
);
4070 job_finalize(&job
->job
, errp
);
4071 aio_context_release(aio_context
);
4074 void qmp_block_job_dismiss(const char *id
, Error
**errp
)
4076 AioContext
*aio_context
;
4077 BlockJob
*bjob
= find_block_job(id
, &aio_context
, errp
);
4084 trace_qmp_block_job_dismiss(bjob
);
4086 job_dismiss(&job
, errp
);
4087 aio_context_release(aio_context
);
4090 void qmp_change_backing_file(const char *device
,
4091 const char *image_node_name
,
4092 const char *backing_file
,
4095 BlockDriverState
*bs
= NULL
;
4096 AioContext
*aio_context
;
4097 BlockDriverState
*image_bs
= NULL
;
4098 Error
*local_err
= NULL
;
4102 bs
= qmp_get_root_bs(device
, errp
);
4107 aio_context
= bdrv_get_aio_context(bs
);
4108 aio_context_acquire(aio_context
);
4110 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
4112 error_propagate(errp
, local_err
);
4117 error_setg(errp
, "image file not found");
4121 if (bdrv_find_base(image_bs
) == image_bs
) {
4122 error_setg(errp
, "not allowing backing file change on an image "
4123 "without a backing file");
4127 /* even though we are not necessarily operating on bs, we need it to
4128 * determine if block ops are currently prohibited on the chain */
4129 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
4133 /* final sanity check */
4134 if (!bdrv_chain_contains(bs
, image_bs
)) {
4135 error_setg(errp
, "'%s' and image file are not in the same chain",
4140 /* if not r/w, reopen to make r/w */
4141 ro
= bdrv_is_read_only(image_bs
);
4144 if (bdrv_reopen_set_read_only(image_bs
, false, errp
) != 0) {
4149 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
4150 image_bs
->drv
? image_bs
->drv
->format_name
: "");
4153 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
4155 /* don't exit here, so we can try to restore open flags if
4160 bdrv_reopen_set_read_only(image_bs
, true, &local_err
);
4161 error_propagate(errp
, local_err
);
4165 aio_context_release(aio_context
);
4168 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
4172 Error
*local_err
= NULL
;
4174 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
4179 qdict
= qemu_opts_to_qdict(opts
, NULL
);
4181 if (!qdict_get_try_str(qdict
, "node-name")) {
4182 qobject_unref(qdict
);
4183 error_report("'node-name' needs to be specified");
4187 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
4189 error_report_err(local_err
);
4193 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4196 qemu_opts_del(opts
);
4199 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
4201 BlockDriverState
*bs
;
4203 Visitor
*v
= qobject_output_visitor_new(&obj
);
4205 Error
*local_err
= NULL
;
4207 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
4209 error_propagate(errp
, local_err
);
4213 visit_complete(v
, &obj
);
4214 qdict
= qobject_to(QDict
, obj
);
4216 qdict_flatten(qdict
);
4218 if (!qdict_get_try_str(qdict
, "node-name")) {
4219 error_setg(errp
, "'node-name' must be specified for the root node");
4223 bs
= bds_tree_init(qdict
, errp
);
4228 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4234 void qmp_blockdev_del(const char *node_name
, Error
**errp
)
4236 AioContext
*aio_context
;
4237 BlockDriverState
*bs
;
4239 bs
= bdrv_find_node(node_name
);
4241 error_setg(errp
, "Cannot find node %s", node_name
);
4244 if (bdrv_has_blk(bs
)) {
4245 error_setg(errp
, "Node %s is in use", node_name
);
4248 aio_context
= bdrv_get_aio_context(bs
);
4249 aio_context_acquire(aio_context
);
4251 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
4255 if (!QTAILQ_IN_USE(bs
, monitor_list
)) {
4256 error_setg(errp
, "Node %s is not owned by the monitor",
4261 if (bs
->refcnt
> 1) {
4262 error_setg(errp
, "Block device %s is in use",
4263 bdrv_get_device_or_node_name(bs
));
4267 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
4271 aio_context_release(aio_context
);
4274 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
4275 const char *child_name
)
4279 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
4280 if (strcmp(child
->name
, child_name
) == 0) {
4288 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
4289 const char *child
, bool has_node
,
4290 const char *node
, Error
**errp
)
4292 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
4295 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
4300 if (has_child
== has_node
) {
4302 error_setg(errp
, "The parameters child and node are in conflict");
4304 error_setg(errp
, "Either child or node must be specified");
4310 p_child
= bdrv_find_child(parent_bs
, child
);
4312 error_setg(errp
, "Node '%s' does not have child '%s'",
4316 bdrv_del_child(parent_bs
, p_child
, errp
);
4320 new_bs
= bdrv_find_node(node
);
4322 error_setg(errp
, "Node '%s' not found", node
);
4325 bdrv_add_child(parent_bs
, new_bs
, errp
);
4329 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
4331 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
4334 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
4335 BlockJobInfoList
*elem
;
4336 AioContext
*aio_context
;
4338 if (block_job_is_internal(job
)) {
4341 elem
= g_new0(BlockJobInfoList
, 1);
4342 aio_context
= blk_get_aio_context(job
->blk
);
4343 aio_context_acquire(aio_context
);
4344 elem
->value
= block_job_query(job
, errp
);
4345 aio_context_release(aio_context
);
4348 qapi_free_BlockJobInfoList(head
);
4352 p_next
= &elem
->next
;
4358 void qmp_x_blockdev_set_iothread(const char *node_name
, StrOrNull
*iothread
,
4359 bool has_force
, bool force
, Error
**errp
)
4361 AioContext
*old_context
;
4362 AioContext
*new_context
;
4363 BlockDriverState
*bs
;
4365 bs
= bdrv_find_node(node_name
);
4367 error_setg(errp
, "Cannot find node %s", node_name
);
4371 /* Protects against accidents. */
4372 if (!(has_force
&& force
) && bdrv_has_blk(bs
)) {
4373 error_setg(errp
, "Node %s is associated with a BlockBackend and could "
4374 "be in use (use force=true to override this check)",
4379 if (iothread
->type
== QTYPE_QSTRING
) {
4380 IOThread
*obj
= iothread_by_id(iothread
->u
.s
);
4382 error_setg(errp
, "Cannot find iothread %s", iothread
->u
.s
);
4386 new_context
= iothread_get_aio_context(obj
);
4388 new_context
= qemu_get_aio_context();
4391 old_context
= bdrv_get_aio_context(bs
);
4392 aio_context_acquire(old_context
);
4394 bdrv_set_aio_context(bs
, new_context
);
4396 aio_context_release(old_context
);
4399 void qmp_x_block_latency_histogram_set(
4401 bool has_boundaries
, uint64List
*boundaries
,
4402 bool has_boundaries_read
, uint64List
*boundaries_read
,
4403 bool has_boundaries_write
, uint64List
*boundaries_write
,
4404 bool has_boundaries_flush
, uint64List
*boundaries_flush
,
4407 BlockBackend
*blk
= blk_by_name(device
);
4408 BlockAcctStats
*stats
;
4412 error_setg(errp
, "Device '%s' not found", device
);
4415 stats
= blk_get_stats(blk
);
4417 if (!has_boundaries
&& !has_boundaries_read
&& !has_boundaries_write
&&
4418 !has_boundaries_flush
)
4420 block_latency_histograms_clear(stats
);
4424 if (has_boundaries
|| has_boundaries_read
) {
4425 ret
= block_latency_histogram_set(
4426 stats
, BLOCK_ACCT_READ
,
4427 has_boundaries_read
? boundaries_read
: boundaries
);
4429 error_setg(errp
, "Device '%s' set read boundaries fail", device
);
4434 if (has_boundaries
|| has_boundaries_write
) {
4435 ret
= block_latency_histogram_set(
4436 stats
, BLOCK_ACCT_WRITE
,
4437 has_boundaries_write
? boundaries_write
: boundaries
);
4439 error_setg(errp
, "Device '%s' set write boundaries fail", device
);
4444 if (has_boundaries
|| has_boundaries_flush
) {
4445 ret
= block_latency_histogram_set(
4446 stats
, BLOCK_ACCT_FLUSH
,
4447 has_boundaries_flush
? boundaries_flush
: boundaries
);
4449 error_setg(errp
, "Device '%s' set flush boundaries fail", device
);
4455 QemuOptsList qemu_common_drive_opts
= {
4457 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4461 .type
= QEMU_OPT_BOOL
,
4462 .help
= "enable/disable snapshot mode",
4465 .type
= QEMU_OPT_STRING
,
4466 .help
= "host AIO implementation (threads, native)",
4468 .name
= BDRV_OPT_CACHE_WB
,
4469 .type
= QEMU_OPT_BOOL
,
4470 .help
= "Enable writeback mode",
4473 .type
= QEMU_OPT_STRING
,
4474 .help
= "disk format (raw, qcow2, ...)",
4477 .type
= QEMU_OPT_STRING
,
4478 .help
= "read error action",
4481 .type
= QEMU_OPT_STRING
,
4482 .help
= "write error action",
4484 .name
= BDRV_OPT_READ_ONLY
,
4485 .type
= QEMU_OPT_BOOL
,
4486 .help
= "open drive file as read-only",
4492 .name
= "throttling.group",
4493 .type
= QEMU_OPT_STRING
,
4494 .help
= "name of the block throttling group",
4496 .name
= "copy-on-read",
4497 .type
= QEMU_OPT_BOOL
,
4498 .help
= "copy read data from backing file into image file",
4500 .name
= "detect-zeroes",
4501 .type
= QEMU_OPT_STRING
,
4502 .help
= "try to optimize zero writes (off, on, unmap)",
4504 .name
= "stats-account-invalid",
4505 .type
= QEMU_OPT_BOOL
,
4506 .help
= "whether to account for invalid I/O operations "
4507 "in the statistics",
4509 .name
= "stats-account-failed",
4510 .type
= QEMU_OPT_BOOL
,
4511 .help
= "whether to account for failed I/O operations "
4512 "in the statistics",
4514 { /* end of list */ }
4518 QemuOptsList qemu_drive_opts
= {
4520 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4523 * no elements => accept any params
4524 * validation will happen later
4526 { /* end of list */ }