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
, false);
535 error_printf("\nSupported formats (read-only):");
536 bdrv_iterate_format(bdrv_format_print
, NULL
, true);
541 if (qdict_haskey(bs_opts
, "driver")) {
542 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
545 qdict_put_str(bs_opts
, "driver", buf
);
548 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
549 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
550 on_write_error
= parse_block_error_action(buf
, 0, &error
);
552 error_propagate(errp
, error
);
557 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
558 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
559 on_read_error
= parse_block_error_action(buf
, 1, &error
);
561 error_propagate(errp
, error
);
567 bdrv_flags
|= BDRV_O_SNAPSHOT
;
570 read_only
= qemu_opt_get_bool(opts
, BDRV_OPT_READ_ONLY
, false);
573 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
574 BlockBackendRootState
*blk_rs
;
576 blk
= blk_new(0, BLK_PERM_ALL
);
577 blk_rs
= blk_get_root_state(blk
);
578 blk_rs
->open_flags
= bdrv_flags
;
579 blk_rs
->read_only
= read_only
;
580 blk_rs
->detect_zeroes
= detect_zeroes
;
582 qobject_unref(bs_opts
);
584 if (file
&& !*file
) {
588 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
589 * with other callers) rather than what we want as the real defaults.
590 * Apply the defaults here instead. */
591 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
592 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
593 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
,
594 read_only
? "on" : "off");
595 qdict_set_default_str(bs_opts
, BDRV_OPT_AUTO_READ_ONLY
, "on");
596 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
598 if (runstate_check(RUN_STATE_INMIGRATE
)) {
599 bdrv_flags
|= BDRV_O_INACTIVE
;
602 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
608 bs
->detect_zeroes
= detect_zeroes
;
610 block_acct_setup(blk_get_stats(blk
), account_invalid
, account_failed
);
612 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
619 /* disk I/O throttling */
620 if (throttle_enabled(&cfg
)) {
621 if (!throttling_group
) {
622 throttling_group
= id
;
624 blk_io_limits_enable(blk
, throttling_group
);
625 blk_set_io_limits(blk
, &cfg
);
628 blk_set_enable_write_cache(blk
, !writethrough
);
629 blk_set_on_error(blk
, on_read_error
, on_write_error
);
631 if (!monitor_add_blk(blk
, id
, errp
)) {
639 qobject_unref(interval_dict
);
640 qobject_unref(interval_list
);
645 qobject_unref(interval_dict
);
646 qobject_unref(interval_list
);
648 qobject_unref(bs_opts
);
652 /* Takes the ownership of bs_opts */
653 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
657 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
658 * with other callers) rather than what we want as the real defaults.
659 * Apply the defaults here instead. */
660 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
661 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
662 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
664 if (runstate_check(RUN_STATE_INMIGRATE
)) {
665 bdrv_flags
|= BDRV_O_INACTIVE
;
668 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
671 void blockdev_close_all_bdrv_states(void)
673 BlockDriverState
*bs
, *next_bs
;
675 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
676 AioContext
*ctx
= bdrv_get_aio_context(bs
);
678 aio_context_acquire(ctx
);
680 aio_context_release(ctx
);
684 /* Iterates over the list of monitor-owned BlockDriverStates */
685 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
687 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
688 : QTAILQ_FIRST(&monitor_bdrv_states
);
691 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
696 value
= qemu_opt_get(opts
, from
);
698 if (qemu_opt_find(opts
, to
)) {
699 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
700 "same time", to
, from
);
705 /* rename all items in opts */
706 while ((value
= qemu_opt_get(opts
, from
))) {
707 qemu_opt_set(opts
, to
, value
, &error_abort
);
708 qemu_opt_unset(opts
, from
);
712 QemuOptsList qemu_legacy_drive_opts
= {
714 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
718 .type
= QEMU_OPT_NUMBER
,
719 .help
= "bus number",
722 .type
= QEMU_OPT_NUMBER
,
723 .help
= "unit number (i.e. lun for scsi)",
726 .type
= QEMU_OPT_NUMBER
,
727 .help
= "index number",
730 .type
= QEMU_OPT_STRING
,
731 .help
= "media type (disk, cdrom)",
734 .type
= QEMU_OPT_STRING
,
735 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
738 .type
= QEMU_OPT_STRING
,
742 /* Options that are passed on, but have special semantics with -drive */
744 .name
= BDRV_OPT_READ_ONLY
,
745 .type
= QEMU_OPT_BOOL
,
746 .help
= "open drive file as read-only",
749 .type
= QEMU_OPT_STRING
,
750 .help
= "read error action",
753 .type
= QEMU_OPT_STRING
,
754 .help
= "write error action",
756 .name
= "copy-on-read",
757 .type
= QEMU_OPT_BOOL
,
758 .help
= "copy read data from backing file into image file",
761 { /* end of list */ }
765 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
,
770 DriveInfo
*dinfo
= NULL
;
772 QemuOpts
*legacy_opts
;
773 DriveMediaType media
= MEDIA_DISK
;
774 BlockInterfaceType type
;
775 int max_devs
, bus_id
, unit_id
, index
;
776 const char *werror
, *rerror
;
777 bool read_only
= false;
779 const char *filename
;
780 Error
*local_err
= NULL
;
783 /* Change legacy command line options into QMP ones */
784 static const struct {
788 { "iops", "throttling.iops-total" },
789 { "iops_rd", "throttling.iops-read" },
790 { "iops_wr", "throttling.iops-write" },
792 { "bps", "throttling.bps-total" },
793 { "bps_rd", "throttling.bps-read" },
794 { "bps_wr", "throttling.bps-write" },
796 { "iops_max", "throttling.iops-total-max" },
797 { "iops_rd_max", "throttling.iops-read-max" },
798 { "iops_wr_max", "throttling.iops-write-max" },
800 { "bps_max", "throttling.bps-total-max" },
801 { "bps_rd_max", "throttling.bps-read-max" },
802 { "bps_wr_max", "throttling.bps-write-max" },
804 { "iops_size", "throttling.iops-size" },
806 { "group", "throttling.group" },
808 { "readonly", BDRV_OPT_READ_ONLY
},
811 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
812 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
815 error_propagate(errp
, local_err
);
820 value
= qemu_opt_get(all_opts
, "cache");
825 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
826 error_setg(errp
, "invalid cache option");
830 /* Specific options take precedence */
831 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
832 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
833 !writethrough
, &error_abort
);
835 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
836 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
837 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
839 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
840 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
841 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
843 qemu_opt_unset(all_opts
, "cache");
846 /* Get a QDict for processing the options */
847 bs_opts
= qdict_new();
848 qemu_opts_to_qdict(all_opts
, bs_opts
);
850 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
852 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
854 error_propagate(errp
, local_err
);
859 value
= qemu_opt_get(legacy_opts
, "media");
861 if (!strcmp(value
, "disk")) {
863 } else if (!strcmp(value
, "cdrom")) {
867 error_setg(errp
, "'%s' invalid media", value
);
872 /* copy-on-read is disabled with a warning for read-only devices */
873 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
874 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
876 if (read_only
&& copy_on_read
) {
877 warn_report("disabling copy-on-read on read-only drive");
878 copy_on_read
= false;
881 qdict_put_str(bs_opts
, BDRV_OPT_READ_ONLY
, read_only
? "on" : "off");
882 qdict_put_str(bs_opts
, "copy-on-read", copy_on_read
? "on" : "off");
884 /* Controller type */
885 value
= qemu_opt_get(legacy_opts
, "if");
888 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
891 if (type
== IF_COUNT
) {
892 error_setg(errp
, "unsupported bus type '%s'", value
);
896 type
= block_default_type
;
899 /* Device address specified by bus/unit or index.
900 * If none was specified, try to find the first free one. */
901 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
902 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
903 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
905 max_devs
= if_max_devs
[type
];
908 if (bus_id
!= 0 || unit_id
!= -1) {
909 error_setg(errp
, "index cannot be used with bus and unit");
912 bus_id
= drive_index_to_bus_id(type
, index
);
913 unit_id
= drive_index_to_unit_id(type
, index
);
918 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
920 if (max_devs
&& unit_id
>= max_devs
) {
927 if (max_devs
&& unit_id
>= max_devs
) {
928 error_setg(errp
, "unit %d too big (max is %d)", unit_id
, max_devs
- 1);
932 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
933 error_setg(errp
, "drive with bus=%d, unit=%d (index=%d) exists",
934 bus_id
, unit_id
, index
);
938 /* no id supplied -> create one */
939 if (qemu_opts_id(all_opts
) == NULL
) {
941 const char *mediastr
= "";
942 if (type
== IF_IDE
|| type
== IF_SCSI
) {
943 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
946 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
949 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
952 qdict_put_str(bs_opts
, "id", new_id
);
956 /* Add virtio block device */
957 if (type
== IF_VIRTIO
) {
959 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
961 if (arch_type
== QEMU_ARCH_S390X
) {
962 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
964 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
966 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
970 filename
= qemu_opt_get(legacy_opts
, "file");
972 /* Check werror/rerror compatibility with if=... */
973 werror
= qemu_opt_get(legacy_opts
, "werror");
974 if (werror
!= NULL
) {
975 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
977 error_setg(errp
, "werror is not supported by this bus type");
980 qdict_put_str(bs_opts
, "werror", werror
);
983 rerror
= qemu_opt_get(legacy_opts
, "rerror");
984 if (rerror
!= NULL
) {
985 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
987 error_setg(errp
, "rerror is not supported by this bus type");
990 qdict_put_str(bs_opts
, "rerror", rerror
);
993 /* Actual block device init: Functionality shared with blockdev-add */
994 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
997 error_propagate(errp
, local_err
);
1003 /* Create legacy DriveInfo */
1004 dinfo
= g_malloc0(sizeof(*dinfo
));
1005 dinfo
->opts
= all_opts
;
1008 dinfo
->bus
= bus_id
;
1009 dinfo
->unit
= unit_id
;
1011 blk_set_legacy_dinfo(blk
, dinfo
);
1018 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1025 qemu_opts_del(legacy_opts
);
1026 qobject_unref(bs_opts
);
1030 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1032 BlockDriverState
*bs
;
1034 bs
= bdrv_lookup_bs(name
, name
, errp
);
1039 if (!bdrv_is_root_node(bs
)) {
1040 error_setg(errp
, "Need a root block node");
1044 if (!bdrv_is_inserted(bs
)) {
1045 error_setg(errp
, "Device has no medium");
1052 static BlockBackend
*qmp_get_blk(const char *blk_name
, const char *qdev_id
,
1057 if (!blk_name
== !qdev_id
) {
1058 error_setg(errp
, "Need exactly one of 'device' and 'id'");
1063 blk
= blk_by_qdev_id(qdev_id
, errp
);
1065 blk
= blk_by_name(blk_name
);
1067 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1068 "Device '%s' not found", blk_name
);
1075 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1077 const char *device
= qdict_get_str(qdict
, "device");
1081 if (!strcmp(device
, "all")) {
1082 ret
= blk_commit_all();
1084 BlockDriverState
*bs
;
1085 AioContext
*aio_context
;
1087 blk
= blk_by_name(device
);
1089 monitor_printf(mon
, "Device '%s' not found\n", device
);
1092 if (!blk_is_available(blk
)) {
1093 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1098 aio_context
= bdrv_get_aio_context(bs
);
1099 aio_context_acquire(aio_context
);
1101 ret
= bdrv_commit(bs
);
1103 aio_context_release(aio_context
);
1106 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1111 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1113 TransactionActionList list
;
1115 list
.value
= action
;
1117 qmp_transaction(&list
, false, NULL
, errp
);
1120 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1121 bool has_node_name
, const char *node_name
,
1122 const char *snapshot_file
,
1123 bool has_snapshot_node_name
,
1124 const char *snapshot_node_name
,
1125 bool has_format
, const char *format
,
1126 bool has_mode
, NewImageMode mode
, Error
**errp
)
1128 BlockdevSnapshotSync snapshot
= {
1129 .has_device
= has_device
,
1130 .device
= (char *) device
,
1131 .has_node_name
= has_node_name
,
1132 .node_name
= (char *) node_name
,
1133 .snapshot_file
= (char *) snapshot_file
,
1134 .has_snapshot_node_name
= has_snapshot_node_name
,
1135 .snapshot_node_name
= (char *) snapshot_node_name
,
1136 .has_format
= has_format
,
1137 .format
= (char *) format
,
1138 .has_mode
= has_mode
,
1141 TransactionAction action
= {
1142 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1143 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1145 blockdev_do_action(&action
, errp
);
1148 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1151 BlockdevSnapshot snapshot_data
= {
1152 .node
= (char *) node
,
1153 .overlay
= (char *) overlay
1155 TransactionAction action
= {
1156 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1157 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1159 blockdev_do_action(&action
, errp
);
1162 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1166 BlockdevSnapshotInternal snapshot
= {
1167 .device
= (char *) device
,
1168 .name
= (char *) name
1170 TransactionAction action
= {
1171 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1172 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1174 blockdev_do_action(&action
, errp
);
1177 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1184 BlockDriverState
*bs
;
1185 AioContext
*aio_context
;
1186 QEMUSnapshotInfo sn
;
1187 Error
*local_err
= NULL
;
1188 SnapshotInfo
*info
= NULL
;
1191 bs
= qmp_get_root_bs(device
, errp
);
1195 aio_context
= bdrv_get_aio_context(bs
);
1196 aio_context_acquire(aio_context
);
1207 error_setg(errp
, "Name or id must be provided");
1208 goto out_aio_context
;
1211 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1212 goto out_aio_context
;
1215 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1217 error_propagate(errp
, local_err
);
1218 goto out_aio_context
;
1222 "Snapshot with id '%s' and name '%s' does not exist on "
1224 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1225 goto out_aio_context
;
1228 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1230 error_propagate(errp
, local_err
);
1231 goto out_aio_context
;
1234 aio_context_release(aio_context
);
1236 info
= g_new0(SnapshotInfo
, 1);
1237 info
->id
= g_strdup(sn
.id_str
);
1238 info
->name
= g_strdup(sn
.name
);
1239 info
->date_nsec
= sn
.date_nsec
;
1240 info
->date_sec
= sn
.date_sec
;
1241 info
->vm_state_size
= sn
.vm_state_size
;
1242 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1243 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1248 aio_context_release(aio_context
);
1253 * block_dirty_bitmap_lookup:
1254 * Return a dirty bitmap (if present), after validating
1255 * the node reference and bitmap names.
1257 * @node: The name of the BDS node to search for bitmaps
1258 * @name: The name of the bitmap to search for
1259 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1260 * @errp: Output pointer for error information. Can be NULL.
1262 * @return: A bitmap object on success, or NULL on failure.
1264 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1266 BlockDriverState
**pbs
,
1269 BlockDriverState
*bs
;
1270 BdrvDirtyBitmap
*bitmap
;
1273 error_setg(errp
, "Node cannot be NULL");
1277 error_setg(errp
, "Bitmap name cannot be NULL");
1280 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1282 error_setg(errp
, "Node '%s' not found", node
);
1286 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1288 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1299 /* New and old BlockDriverState structs for atomic group operations */
1301 typedef struct BlkActionState BlkActionState
;
1305 * Table of operations that define an Action.
1307 * @instance_size: Size of state struct, in bytes.
1308 * @prepare: Prepare the work, must NOT be NULL.
1309 * @commit: Commit the changes, can be NULL.
1310 * @abort: Abort the changes on fail, can be NULL.
1311 * @clean: Clean up resources after all transaction actions have called
1312 * commit() or abort(). Can be NULL.
1314 * Only prepare() may fail. In a single transaction, only one of commit() or
1315 * abort() will be called. clean() will always be called if it is present.
1317 typedef struct BlkActionOps
{
1318 size_t instance_size
;
1319 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1320 void (*commit
)(BlkActionState
*common
);
1321 void (*abort
)(BlkActionState
*common
);
1322 void (*clean
)(BlkActionState
*common
);
1327 * Describes one Action's state within a Transaction.
1329 * @action: QAPI-defined enum identifying which Action to perform.
1330 * @ops: Table of ActionOps this Action can perform.
1331 * @block_job_txn: Transaction which this action belongs to.
1332 * @entry: List membership for all Actions in this Transaction.
1334 * This structure must be arranged as first member in a subclassed type,
1335 * assuming that the compiler will also arrange it to the same offsets as the
1338 struct BlkActionState
{
1339 TransactionAction
*action
;
1340 const BlkActionOps
*ops
;
1341 JobTxn
*block_job_txn
;
1342 TransactionProperties
*txn_props
;
1343 QTAILQ_ENTRY(BlkActionState
) entry
;
1346 /* internal snapshot private data */
1347 typedef struct InternalSnapshotState
{
1348 BlkActionState common
;
1349 BlockDriverState
*bs
;
1350 QEMUSnapshotInfo sn
;
1352 } InternalSnapshotState
;
1355 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1357 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1359 "Action '%s' does not support Transaction property "
1360 "completion-mode = %s",
1361 TransactionActionKind_str(s
->action
->type
),
1362 ActionCompletionMode_str(s
->txn_props
->completion_mode
));
1368 static void internal_snapshot_prepare(BlkActionState
*common
,
1371 Error
*local_err
= NULL
;
1374 BlockDriverState
*bs
;
1375 QEMUSnapshotInfo old_sn
, *sn
;
1378 BlockdevSnapshotInternal
*internal
;
1379 InternalSnapshotState
*state
;
1380 AioContext
*aio_context
;
1383 g_assert(common
->action
->type
==
1384 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1385 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1386 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1388 /* 1. parse input */
1389 device
= internal
->device
;
1390 name
= internal
->name
;
1392 /* 2. check for validation */
1393 if (action_check_completion_mode(common
, errp
) < 0) {
1397 bs
= qmp_get_root_bs(device
, errp
);
1402 aio_context
= bdrv_get_aio_context(bs
);
1403 aio_context_acquire(aio_context
);
1407 /* Paired with .clean() */
1408 bdrv_drained_begin(bs
);
1410 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1414 if (bdrv_is_read_only(bs
)) {
1415 error_setg(errp
, "Device '%s' is read only", device
);
1419 if (!bdrv_can_snapshot(bs
)) {
1420 error_setg(errp
, "Block format '%s' used by device '%s' "
1421 "does not support internal snapshots",
1422 bs
->drv
->format_name
, device
);
1426 if (!strlen(name
)) {
1427 error_setg(errp
, "Name is empty");
1431 /* check whether a snapshot with name exist */
1432 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1435 error_propagate(errp
, local_err
);
1439 "Snapshot with name '%s' already exists on device '%s'",
1444 /* 3. take the snapshot */
1446 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1447 qemu_gettimeofday(&tv
);
1448 sn
->date_sec
= tv
.tv_sec
;
1449 sn
->date_nsec
= tv
.tv_usec
* 1000;
1450 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1452 ret1
= bdrv_snapshot_create(bs
, sn
);
1454 error_setg_errno(errp
, -ret1
,
1455 "Failed to create snapshot '%s' on device '%s'",
1460 /* 4. succeed, mark a snapshot is created */
1461 state
->created
= true;
1464 aio_context_release(aio_context
);
1467 static void internal_snapshot_abort(BlkActionState
*common
)
1469 InternalSnapshotState
*state
=
1470 DO_UPCAST(InternalSnapshotState
, common
, common
);
1471 BlockDriverState
*bs
= state
->bs
;
1472 QEMUSnapshotInfo
*sn
= &state
->sn
;
1473 AioContext
*aio_context
;
1474 Error
*local_error
= NULL
;
1476 if (!state
->created
) {
1480 aio_context
= bdrv_get_aio_context(state
->bs
);
1481 aio_context_acquire(aio_context
);
1483 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1484 error_reportf_err(local_error
,
1485 "Failed to delete snapshot with id '%s' and "
1486 "name '%s' on device '%s' in abort: ",
1487 sn
->id_str
, sn
->name
,
1488 bdrv_get_device_name(bs
));
1491 aio_context_release(aio_context
);
1494 static void internal_snapshot_clean(BlkActionState
*common
)
1496 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1498 AioContext
*aio_context
;
1504 aio_context
= bdrv_get_aio_context(state
->bs
);
1505 aio_context_acquire(aio_context
);
1507 bdrv_drained_end(state
->bs
);
1509 aio_context_release(aio_context
);
1512 /* external snapshot private data */
1513 typedef struct ExternalSnapshotState
{
1514 BlkActionState common
;
1515 BlockDriverState
*old_bs
;
1516 BlockDriverState
*new_bs
;
1517 bool overlay_appended
;
1518 } ExternalSnapshotState
;
1520 static void external_snapshot_prepare(BlkActionState
*common
,
1524 QDict
*options
= NULL
;
1525 Error
*local_err
= NULL
;
1526 /* Device and node name of the image to generate the snapshot from */
1528 const char *node_name
;
1529 /* Reference to the new image (for 'blockdev-snapshot') */
1530 const char *snapshot_ref
;
1531 /* File name of the new image (for 'blockdev-snapshot-sync') */
1532 const char *new_image_file
;
1533 ExternalSnapshotState
*state
=
1534 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1535 TransactionAction
*action
= common
->action
;
1536 AioContext
*aio_context
;
1538 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1539 * purpose but a different set of parameters */
1540 switch (action
->type
) {
1541 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1543 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1545 node_name
= s
->node
;
1546 new_image_file
= NULL
;
1547 snapshot_ref
= s
->overlay
;
1550 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1552 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1553 device
= s
->has_device
? s
->device
: NULL
;
1554 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1555 new_image_file
= s
->snapshot_file
;
1556 snapshot_ref
= NULL
;
1560 g_assert_not_reached();
1563 /* start processing */
1564 if (action_check_completion_mode(common
, errp
) < 0) {
1568 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1569 if (!state
->old_bs
) {
1573 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1574 aio_context_acquire(aio_context
);
1576 /* Paired with .clean() */
1577 bdrv_drained_begin(state
->old_bs
);
1579 if (!bdrv_is_inserted(state
->old_bs
)) {
1580 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1584 if (bdrv_op_is_blocked(state
->old_bs
,
1585 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1589 if (!bdrv_is_read_only(state
->old_bs
)) {
1590 if (bdrv_flush(state
->old_bs
)) {
1591 error_setg(errp
, QERR_IO_ERROR
);
1596 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1597 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1601 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1602 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1603 const char *format
= s
->has_format
? s
->format
: "qcow2";
1604 enum NewImageMode mode
;
1605 const char *snapshot_node_name
=
1606 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1608 if (node_name
&& !snapshot_node_name
) {
1609 error_setg(errp
, "New snapshot node name missing");
1613 if (snapshot_node_name
&&
1614 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1615 error_setg(errp
, "New snapshot node name already in use");
1619 flags
= state
->old_bs
->open_flags
;
1620 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_COPY_ON_READ
);
1621 flags
|= BDRV_O_NO_BACKING
;
1623 /* create new image w/backing file */
1624 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1625 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1626 int64_t size
= bdrv_getlength(state
->old_bs
);
1628 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1631 bdrv_refresh_filename(state
->old_bs
);
1632 bdrv_img_create(new_image_file
, format
,
1633 state
->old_bs
->filename
,
1634 state
->old_bs
->drv
->format_name
,
1635 NULL
, size
, flags
, false, &local_err
);
1637 error_propagate(errp
, local_err
);
1642 options
= qdict_new();
1643 if (snapshot_node_name
) {
1644 qdict_put_str(options
, "node-name", snapshot_node_name
);
1646 qdict_put_str(options
, "driver", format
);
1649 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1651 /* We will manually add the backing_hd field to the bs later */
1652 if (!state
->new_bs
) {
1656 if (bdrv_has_blk(state
->new_bs
)) {
1657 error_setg(errp
, "The snapshot is already in use");
1661 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1666 if (state
->new_bs
->backing
!= NULL
) {
1667 error_setg(errp
, "The snapshot already has a backing image");
1671 if (!state
->new_bs
->drv
->supports_backing
) {
1672 error_setg(errp
, "The snapshot does not support backing images");
1676 bdrv_set_aio_context(state
->new_bs
, aio_context
);
1678 /* This removes our old bs and adds the new bs. This is an operation that
1679 * can fail, so we need to do it in .prepare; undoing it for abort is
1680 * always possible. */
1681 bdrv_ref(state
->new_bs
);
1682 bdrv_append(state
->new_bs
, state
->old_bs
, &local_err
);
1684 error_propagate(errp
, local_err
);
1687 state
->overlay_appended
= true;
1690 aio_context_release(aio_context
);
1693 static void external_snapshot_commit(BlkActionState
*common
)
1695 ExternalSnapshotState
*state
=
1696 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1697 AioContext
*aio_context
;
1699 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1700 aio_context_acquire(aio_context
);
1702 /* We don't need (or want) to use the transactional
1703 * bdrv_reopen_multiple() across all the entries at once, because we
1704 * don't want to abort all of them if one of them fails the reopen */
1705 if (!atomic_read(&state
->old_bs
->copy_on_read
)) {
1706 bdrv_reopen_set_read_only(state
->old_bs
, true, NULL
);
1709 aio_context_release(aio_context
);
1712 static void external_snapshot_abort(BlkActionState
*common
)
1714 ExternalSnapshotState
*state
=
1715 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1716 if (state
->new_bs
) {
1717 if (state
->overlay_appended
) {
1718 AioContext
*aio_context
;
1720 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1721 aio_context_acquire(aio_context
);
1723 bdrv_ref(state
->old_bs
); /* we can't let bdrv_set_backind_hd()
1724 close state->old_bs; we need it */
1725 bdrv_set_backing_hd(state
->new_bs
, NULL
, &error_abort
);
1726 bdrv_replace_node(state
->new_bs
, state
->old_bs
, &error_abort
);
1727 bdrv_unref(state
->old_bs
); /* bdrv_replace_node() ref'ed old_bs */
1729 aio_context_release(aio_context
);
1734 static void external_snapshot_clean(BlkActionState
*common
)
1736 ExternalSnapshotState
*state
=
1737 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1738 AioContext
*aio_context
;
1740 if (!state
->old_bs
) {
1744 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1745 aio_context_acquire(aio_context
);
1747 bdrv_drained_end(state
->old_bs
);
1748 bdrv_unref(state
->new_bs
);
1750 aio_context_release(aio_context
);
1753 typedef struct DriveBackupState
{
1754 BlkActionState common
;
1755 BlockDriverState
*bs
;
1759 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
1762 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1764 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1765 BlockDriverState
*bs
;
1766 DriveBackup
*backup
;
1767 AioContext
*aio_context
;
1768 Error
*local_err
= NULL
;
1770 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1771 backup
= common
->action
->u
.drive_backup
.data
;
1773 bs
= qmp_get_root_bs(backup
->device
, errp
);
1778 aio_context
= bdrv_get_aio_context(bs
);
1779 aio_context_acquire(aio_context
);
1781 /* Paired with .clean() */
1782 bdrv_drained_begin(bs
);
1786 state
->job
= do_drive_backup(backup
, common
->block_job_txn
, &local_err
);
1788 error_propagate(errp
, local_err
);
1793 aio_context_release(aio_context
);
1796 static void drive_backup_commit(BlkActionState
*common
)
1798 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1799 AioContext
*aio_context
;
1801 aio_context
= bdrv_get_aio_context(state
->bs
);
1802 aio_context_acquire(aio_context
);
1805 job_start(&state
->job
->job
);
1807 aio_context_release(aio_context
);
1810 static void drive_backup_abort(BlkActionState
*common
)
1812 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1815 AioContext
*aio_context
;
1817 aio_context
= bdrv_get_aio_context(state
->bs
);
1818 aio_context_acquire(aio_context
);
1820 job_cancel_sync(&state
->job
->job
);
1822 aio_context_release(aio_context
);
1826 static void drive_backup_clean(BlkActionState
*common
)
1828 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1829 AioContext
*aio_context
;
1835 aio_context
= bdrv_get_aio_context(state
->bs
);
1836 aio_context_acquire(aio_context
);
1838 bdrv_drained_end(state
->bs
);
1840 aio_context_release(aio_context
);
1843 typedef struct BlockdevBackupState
{
1844 BlkActionState common
;
1845 BlockDriverState
*bs
;
1847 } BlockdevBackupState
;
1849 static BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
1852 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1854 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1855 BlockdevBackup
*backup
;
1856 BlockDriverState
*bs
, *target
;
1857 AioContext
*aio_context
;
1858 Error
*local_err
= NULL
;
1860 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1861 backup
= common
->action
->u
.blockdev_backup
.data
;
1863 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1868 target
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1873 aio_context
= bdrv_get_aio_context(bs
);
1874 if (aio_context
!= bdrv_get_aio_context(target
)) {
1875 error_setg(errp
, "Backup between two IO threads is not implemented");
1878 aio_context_acquire(aio_context
);
1881 /* Paired with .clean() */
1882 bdrv_drained_begin(state
->bs
);
1884 state
->job
= do_blockdev_backup(backup
, common
->block_job_txn
, &local_err
);
1886 error_propagate(errp
, local_err
);
1891 aio_context_release(aio_context
);
1894 static void blockdev_backup_commit(BlkActionState
*common
)
1896 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1897 AioContext
*aio_context
;
1899 aio_context
= bdrv_get_aio_context(state
->bs
);
1900 aio_context_acquire(aio_context
);
1903 job_start(&state
->job
->job
);
1905 aio_context_release(aio_context
);
1908 static void blockdev_backup_abort(BlkActionState
*common
)
1910 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1913 AioContext
*aio_context
;
1915 aio_context
= bdrv_get_aio_context(state
->bs
);
1916 aio_context_acquire(aio_context
);
1918 job_cancel_sync(&state
->job
->job
);
1920 aio_context_release(aio_context
);
1924 static void blockdev_backup_clean(BlkActionState
*common
)
1926 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1927 AioContext
*aio_context
;
1933 aio_context
= bdrv_get_aio_context(state
->bs
);
1934 aio_context_acquire(aio_context
);
1936 bdrv_drained_end(state
->bs
);
1938 aio_context_release(aio_context
);
1941 typedef struct BlockDirtyBitmapState
{
1942 BlkActionState common
;
1943 BdrvDirtyBitmap
*bitmap
;
1944 BlockDriverState
*bs
;
1948 } BlockDirtyBitmapState
;
1950 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1953 Error
*local_err
= NULL
;
1954 BlockDirtyBitmapAdd
*action
;
1955 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1958 if (action_check_completion_mode(common
, errp
) < 0) {
1962 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1963 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1964 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
1965 action
->has_granularity
, action
->granularity
,
1966 action
->has_persistent
, action
->persistent
,
1967 action
->has_autoload
, action
->autoload
,
1968 action
->has_disabled
, action
->disabled
,
1972 state
->prepared
= true;
1974 error_propagate(errp
, local_err
);
1978 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
1980 BlockDirtyBitmapAdd
*action
;
1981 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1984 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1985 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1986 * then the node reference and bitmap name must have been valid.
1988 if (state
->prepared
) {
1989 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
1993 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
1996 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1998 BlockDirtyBitmap
*action
;
2000 if (action_check_completion_mode(common
, errp
) < 0) {
2004 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2005 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2009 if (!state
->bitmap
) {
2013 if (bdrv_dirty_bitmap_busy(state
->bitmap
)) {
2014 error_setg(errp
, "Cannot modify a bitmap in use by another operation");
2016 } else if (bdrv_dirty_bitmap_readonly(state
->bitmap
)) {
2017 error_setg(errp
, "Cannot clear a readonly bitmap");
2021 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2024 static void block_dirty_bitmap_restore(BlkActionState
*common
)
2026 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2029 if (state
->backup
) {
2030 bdrv_restore_dirty_bitmap(state
->bitmap
, state
->backup
);
2034 static void block_dirty_bitmap_free_backup(BlkActionState
*common
)
2036 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2039 hbitmap_free(state
->backup
);
2042 static void block_dirty_bitmap_enable_prepare(BlkActionState
*common
,
2045 BlockDirtyBitmap
*action
;
2046 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2049 if (action_check_completion_mode(common
, errp
) < 0) {
2053 action
= common
->action
->u
.block_dirty_bitmap_enable
.data
;
2054 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2058 if (!state
->bitmap
) {
2062 if (bdrv_dirty_bitmap_busy(state
->bitmap
)) {
2064 "Bitmap '%s' is currently in use by another operation"
2065 " and cannot be enabled", action
->name
);
2069 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2070 bdrv_enable_dirty_bitmap(state
->bitmap
);
2073 static void block_dirty_bitmap_enable_abort(BlkActionState
*common
)
2075 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2078 if (!state
->was_enabled
) {
2079 bdrv_disable_dirty_bitmap(state
->bitmap
);
2083 static void block_dirty_bitmap_disable_prepare(BlkActionState
*common
,
2086 BlockDirtyBitmap
*action
;
2087 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2090 if (action_check_completion_mode(common
, errp
) < 0) {
2094 action
= common
->action
->u
.block_dirty_bitmap_disable
.data
;
2095 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2099 if (!state
->bitmap
) {
2103 if (bdrv_dirty_bitmap_busy(state
->bitmap
)) {
2105 "Bitmap '%s' is currently in use by another operation"
2106 " and cannot be disabled", action
->name
);
2110 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2111 bdrv_disable_dirty_bitmap(state
->bitmap
);
2114 static void block_dirty_bitmap_disable_abort(BlkActionState
*common
)
2116 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2119 if (state
->was_enabled
) {
2120 bdrv_enable_dirty_bitmap(state
->bitmap
);
2124 static BdrvDirtyBitmap
*do_block_dirty_bitmap_merge(const char *node
,
2130 static void block_dirty_bitmap_merge_prepare(BlkActionState
*common
,
2133 BlockDirtyBitmapMerge
*action
;
2134 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2137 if (action_check_completion_mode(common
, errp
) < 0) {
2141 action
= common
->action
->u
.block_dirty_bitmap_merge
.data
;
2143 state
->bitmap
= do_block_dirty_bitmap_merge(action
->node
, action
->target
,
2144 action
->bitmaps
, &state
->backup
,
2148 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2150 error_setg(errp
, "Transaction aborted using Abort action");
2153 static void abort_commit(BlkActionState
*common
)
2155 g_assert_not_reached(); /* this action never succeeds */
2158 static const BlkActionOps actions
[] = {
2159 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2160 .instance_size
= sizeof(ExternalSnapshotState
),
2161 .prepare
= external_snapshot_prepare
,
2162 .commit
= external_snapshot_commit
,
2163 .abort
= external_snapshot_abort
,
2164 .clean
= external_snapshot_clean
,
2166 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2167 .instance_size
= sizeof(ExternalSnapshotState
),
2168 .prepare
= external_snapshot_prepare
,
2169 .commit
= external_snapshot_commit
,
2170 .abort
= external_snapshot_abort
,
2171 .clean
= external_snapshot_clean
,
2173 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2174 .instance_size
= sizeof(DriveBackupState
),
2175 .prepare
= drive_backup_prepare
,
2176 .commit
= drive_backup_commit
,
2177 .abort
= drive_backup_abort
,
2178 .clean
= drive_backup_clean
,
2180 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2181 .instance_size
= sizeof(BlockdevBackupState
),
2182 .prepare
= blockdev_backup_prepare
,
2183 .commit
= blockdev_backup_commit
,
2184 .abort
= blockdev_backup_abort
,
2185 .clean
= blockdev_backup_clean
,
2187 [TRANSACTION_ACTION_KIND_ABORT
] = {
2188 .instance_size
= sizeof(BlkActionState
),
2189 .prepare
= abort_prepare
,
2190 .commit
= abort_commit
,
2192 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2193 .instance_size
= sizeof(InternalSnapshotState
),
2194 .prepare
= internal_snapshot_prepare
,
2195 .abort
= internal_snapshot_abort
,
2196 .clean
= internal_snapshot_clean
,
2198 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2199 .instance_size
= sizeof(BlockDirtyBitmapState
),
2200 .prepare
= block_dirty_bitmap_add_prepare
,
2201 .abort
= block_dirty_bitmap_add_abort
,
2203 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2204 .instance_size
= sizeof(BlockDirtyBitmapState
),
2205 .prepare
= block_dirty_bitmap_clear_prepare
,
2206 .commit
= block_dirty_bitmap_free_backup
,
2207 .abort
= block_dirty_bitmap_restore
,
2209 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE
] = {
2210 .instance_size
= sizeof(BlockDirtyBitmapState
),
2211 .prepare
= block_dirty_bitmap_enable_prepare
,
2212 .abort
= block_dirty_bitmap_enable_abort
,
2214 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE
] = {
2215 .instance_size
= sizeof(BlockDirtyBitmapState
),
2216 .prepare
= block_dirty_bitmap_disable_prepare
,
2217 .abort
= block_dirty_bitmap_disable_abort
,
2219 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE
] = {
2220 .instance_size
= sizeof(BlockDirtyBitmapState
),
2221 .prepare
= block_dirty_bitmap_merge_prepare
,
2222 .commit
= block_dirty_bitmap_free_backup
,
2223 .abort
= block_dirty_bitmap_restore
,
2225 /* Where are transactions for MIRROR, COMMIT and STREAM?
2226 * Although these blockjobs use transaction callbacks like the backup job,
2227 * these jobs do not necessarily adhere to transaction semantics.
2228 * These jobs may not fully undo all of their actions on abort, nor do they
2229 * necessarily work in transactions with more than one job in them.
2234 * Allocate a TransactionProperties structure if necessary, and fill
2235 * that structure with desired defaults if they are unset.
2237 static TransactionProperties
*get_transaction_properties(
2238 TransactionProperties
*props
)
2241 props
= g_new0(TransactionProperties
, 1);
2244 if (!props
->has_completion_mode
) {
2245 props
->has_completion_mode
= true;
2246 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2253 * 'Atomic' group operations. The operations are performed as a set, and if
2254 * any fail then we roll back all operations in the group.
2256 void qmp_transaction(TransactionActionList
*dev_list
,
2258 struct TransactionProperties
*props
,
2261 TransactionActionList
*dev_entry
= dev_list
;
2262 JobTxn
*block_job_txn
= NULL
;
2263 BlkActionState
*state
, *next
;
2264 Error
*local_err
= NULL
;
2266 QTAILQ_HEAD(, BlkActionState
) snap_bdrv_states
;
2267 QTAILQ_INIT(&snap_bdrv_states
);
2269 /* Does this transaction get canceled as a group on failure?
2270 * If not, we don't really need to make a JobTxn.
2272 props
= get_transaction_properties(props
);
2273 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2274 block_job_txn
= job_txn_new();
2277 /* drain all i/o before any operations */
2280 /* We don't do anything in this loop that commits us to the operations */
2281 while (NULL
!= dev_entry
) {
2282 TransactionAction
*dev_info
= NULL
;
2283 const BlkActionOps
*ops
;
2285 dev_info
= dev_entry
->value
;
2286 dev_entry
= dev_entry
->next
;
2288 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2290 ops
= &actions
[dev_info
->type
];
2291 assert(ops
->instance_size
> 0);
2293 state
= g_malloc0(ops
->instance_size
);
2295 state
->action
= dev_info
;
2296 state
->block_job_txn
= block_job_txn
;
2297 state
->txn_props
= props
;
2298 QTAILQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2300 state
->ops
->prepare(state
, &local_err
);
2302 error_propagate(errp
, local_err
);
2303 goto delete_and_fail
;
2307 QTAILQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2308 if (state
->ops
->commit
) {
2309 state
->ops
->commit(state
);
2317 /* failure, and it is all-or-none; roll back all operations */
2318 QTAILQ_FOREACH_REVERSE(state
, &snap_bdrv_states
, entry
) {
2319 if (state
->ops
->abort
) {
2320 state
->ops
->abort(state
);
2324 QTAILQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2325 if (state
->ops
->clean
) {
2326 state
->ops
->clean(state
);
2331 qapi_free_TransactionProperties(props
);
2333 job_txn_unref(block_job_txn
);
2336 void qmp_eject(bool has_device
, const char *device
,
2337 bool has_id
, const char *id
,
2338 bool has_force
, bool force
, Error
**errp
)
2340 Error
*local_err
= NULL
;
2347 rc
= do_open_tray(has_device
? device
: NULL
,
2350 if (rc
&& rc
!= -ENOSYS
) {
2351 error_propagate(errp
, local_err
);
2354 error_free(local_err
);
2356 blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2359 void qmp_block_passwd(bool has_device
, const char *device
,
2360 bool has_node_name
, const char *node_name
,
2361 const char *password
, Error
**errp
)
2364 "Setting block passwords directly is no longer supported");
2368 * Attempt to open the tray of @device.
2369 * If @force, ignore its tray lock.
2370 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2371 * On error, store an error through @errp and return -errno.
2372 * If @device does not exist, return -ENODEV.
2373 * If it has no removable media, return -ENOTSUP.
2374 * If it has no tray, return -ENOSYS.
2375 * If the guest was asked to open the tray, return -EINPROGRESS.
2378 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2379 bool force
, Error
**errp
)
2382 const char *device
= qdev_id
?: blk_name
;
2385 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2390 if (!blk_dev_has_removable_media(blk
)) {
2391 error_setg(errp
, "Device '%s' is not removable", device
);
2395 if (!blk_dev_has_tray(blk
)) {
2396 error_setg(errp
, "Device '%s' does not have a tray", device
);
2400 if (blk_dev_is_tray_open(blk
)) {
2404 locked
= blk_dev_is_medium_locked(blk
);
2406 blk_dev_eject_request(blk
, force
);
2409 if (!locked
|| force
) {
2410 blk_dev_change_media_cb(blk
, false, &error_abort
);
2413 if (locked
&& !force
) {
2414 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2415 "wait for tray to open and try again", device
);
2416 return -EINPROGRESS
;
2422 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2423 bool has_id
, const char *id
,
2424 bool has_force
, bool force
,
2427 Error
*local_err
= NULL
;
2433 rc
= do_open_tray(has_device
? device
: NULL
,
2436 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2437 error_propagate(errp
, local_err
);
2440 error_free(local_err
);
2443 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2444 bool has_id
, const char *id
,
2448 Error
*local_err
= NULL
;
2450 device
= has_device
? device
: NULL
;
2451 id
= has_id
? id
: NULL
;
2453 blk
= qmp_get_blk(device
, id
, errp
);
2458 if (!blk_dev_has_removable_media(blk
)) {
2459 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2463 if (!blk_dev_has_tray(blk
)) {
2464 /* Ignore this command on tray-less devices */
2468 if (!blk_dev_is_tray_open(blk
)) {
2472 blk_dev_change_media_cb(blk
, true, &local_err
);
2474 error_propagate(errp
, local_err
);
2479 static void blockdev_remove_medium(bool has_device
, const char *device
,
2480 bool has_id
, const char *id
, Error
**errp
)
2483 BlockDriverState
*bs
;
2484 AioContext
*aio_context
;
2485 bool has_attached_device
;
2487 device
= has_device
? device
: NULL
;
2488 id
= has_id
? id
: NULL
;
2490 blk
= qmp_get_blk(device
, id
, errp
);
2495 /* For BBs without a device, we can exchange the BDS tree at will */
2496 has_attached_device
= blk_get_attached_dev(blk
);
2498 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2499 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2503 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2504 !blk_dev_is_tray_open(blk
))
2506 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2515 aio_context
= bdrv_get_aio_context(bs
);
2516 aio_context_acquire(aio_context
);
2518 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2524 if (!blk_dev_has_tray(blk
)) {
2525 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2526 * called at all); therefore, the medium needs to be ejected here.
2527 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2528 * value passed here (i.e. false). */
2529 blk_dev_change_media_cb(blk
, false, &error_abort
);
2533 aio_context_release(aio_context
);
2536 void qmp_blockdev_remove_medium(const char *id
, Error
**errp
)
2538 blockdev_remove_medium(false, NULL
, true, id
, errp
);
2541 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2542 BlockDriverState
*bs
, Error
**errp
)
2544 Error
*local_err
= NULL
;
2548 /* For BBs without a device, we can exchange the BDS tree at will */
2549 has_device
= blk_get_attached_dev(blk
);
2551 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2552 error_setg(errp
, "Device is not removable");
2556 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2557 error_setg(errp
, "Tray of the device is not open");
2562 error_setg(errp
, "There already is a medium in the device");
2566 ret
= blk_insert_bs(blk
, bs
, errp
);
2571 if (!blk_dev_has_tray(blk
)) {
2572 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2573 * called at all); therefore, the medium needs to be pushed into the
2575 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2576 * value passed here (i.e. true). */
2577 blk_dev_change_media_cb(blk
, true, &local_err
);
2579 error_propagate(errp
, local_err
);
2586 static void blockdev_insert_medium(bool has_device
, const char *device
,
2587 bool has_id
, const char *id
,
2588 const char *node_name
, Error
**errp
)
2591 BlockDriverState
*bs
;
2593 blk
= qmp_get_blk(has_device
? device
: NULL
,
2600 bs
= bdrv_find_node(node_name
);
2602 error_setg(errp
, "Node '%s' not found", node_name
);
2606 if (bdrv_has_blk(bs
)) {
2607 error_setg(errp
, "Node '%s' is already in use", node_name
);
2611 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2614 void qmp_blockdev_insert_medium(const char *id
, const char *node_name
,
2617 blockdev_insert_medium(false, NULL
, true, id
, node_name
, errp
);
2620 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2621 bool has_id
, const char *id
,
2622 const char *filename
,
2623 bool has_format
, const char *format
,
2625 BlockdevChangeReadOnlyMode read_only
,
2629 BlockDriverState
*medium_bs
= NULL
;
2633 QDict
*options
= NULL
;
2636 blk
= qmp_get_blk(has_device
? device
: NULL
,
2644 blk_update_root_state(blk
);
2647 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2648 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2649 BDRV_O_PROTOCOL
| BDRV_O_AUTO_RDONLY
);
2651 if (!has_read_only
) {
2652 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2655 switch (read_only
) {
2656 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2659 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2660 bdrv_flags
&= ~BDRV_O_RDWR
;
2663 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2664 bdrv_flags
|= BDRV_O_RDWR
;
2671 options
= qdict_new();
2672 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2673 qdict_put_str(options
, "detect-zeroes", detect_zeroes
? "on" : "off");
2676 qdict_put_str(options
, "driver", format
);
2679 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2684 rc
= do_open_tray(has_device
? device
: NULL
,
2687 if (rc
&& rc
!= -ENOSYS
) {
2688 error_propagate(errp
, err
);
2694 blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2696 error_propagate(errp
, err
);
2700 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2702 error_propagate(errp
, err
);
2706 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2709 /* If the medium has been inserted, the device has its own reference, so
2710 * ours must be relinquished; and if it has not been inserted successfully,
2711 * the reference must be relinquished anyway */
2712 bdrv_unref(medium_bs
);
2715 /* throttling disk I/O limits */
2716 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2719 BlockDriverState
*bs
;
2721 AioContext
*aio_context
;
2723 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2724 arg
->has_id
? arg
->id
: NULL
,
2730 aio_context
= blk_get_aio_context(blk
);
2731 aio_context_acquire(aio_context
);
2735 error_setg(errp
, "Device has no medium");
2739 throttle_config_init(&cfg
);
2740 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2741 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2742 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2744 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2745 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2746 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2748 if (arg
->has_bps_max
) {
2749 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2751 if (arg
->has_bps_rd_max
) {
2752 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2754 if (arg
->has_bps_wr_max
) {
2755 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2757 if (arg
->has_iops_max
) {
2758 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2760 if (arg
->has_iops_rd_max
) {
2761 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2763 if (arg
->has_iops_wr_max
) {
2764 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2767 if (arg
->has_bps_max_length
) {
2768 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2770 if (arg
->has_bps_rd_max_length
) {
2771 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2773 if (arg
->has_bps_wr_max_length
) {
2774 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2776 if (arg
->has_iops_max_length
) {
2777 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2779 if (arg
->has_iops_rd_max_length
) {
2780 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2782 if (arg
->has_iops_wr_max_length
) {
2783 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2786 if (arg
->has_iops_size
) {
2787 cfg
.op_size
= arg
->iops_size
;
2790 if (!throttle_is_valid(&cfg
, errp
)) {
2794 if (throttle_enabled(&cfg
)) {
2795 /* Enable I/O limits if they're not enabled yet, otherwise
2796 * just update the throttling group. */
2797 if (!blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2798 blk_io_limits_enable(blk
,
2799 arg
->has_group
? arg
->group
:
2800 arg
->has_device
? arg
->device
:
2802 } else if (arg
->has_group
) {
2803 blk_io_limits_update_group(blk
, arg
->group
);
2805 /* Set the new throttling configuration */
2806 blk_set_io_limits(blk
, &cfg
);
2807 } else if (blk_get_public(blk
)->throttle_group_member
.throttle_state
) {
2808 /* If all throttling settings are set to 0, disable I/O limits */
2809 blk_io_limits_disable(blk
);
2813 aio_context_release(aio_context
);
2816 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2817 bool has_granularity
, uint32_t granularity
,
2818 bool has_persistent
, bool persistent
,
2819 bool has_autoload
, bool autoload
,
2820 bool has_disabled
, bool disabled
,
2823 BlockDriverState
*bs
;
2824 BdrvDirtyBitmap
*bitmap
;
2825 AioContext
*aio_context
= NULL
;
2827 if (!name
|| name
[0] == '\0') {
2828 error_setg(errp
, "Bitmap name cannot be empty");
2832 bs
= bdrv_lookup_bs(node
, node
, errp
);
2837 if (has_granularity
) {
2838 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2839 error_setg(errp
, "Granularity must be power of 2 "
2840 "and at least 512");
2844 /* Default to cluster size, if available: */
2845 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2848 if (!has_persistent
) {
2853 warn_report("Autoload option is deprecated and its value is ignored");
2856 if (!has_disabled
) {
2861 aio_context
= bdrv_get_aio_context(bs
);
2862 aio_context_acquire(aio_context
);
2863 if (!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 aio_context_release(aio_context
);
2884 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2887 BlockDriverState
*bs
;
2888 BdrvDirtyBitmap
*bitmap
;
2889 Error
*local_err
= NULL
;
2890 AioContext
*aio_context
= NULL
;
2892 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2893 if (!bitmap
|| !bs
) {
2897 if (bdrv_dirty_bitmap_busy(bitmap
)) {
2899 "Bitmap '%s' is currently in use by another operation and"
2900 " cannot be removed", name
);
2904 if (bdrv_dirty_bitmap_get_persistance(bitmap
)) {
2905 aio_context
= bdrv_get_aio_context(bs
);
2906 aio_context_acquire(aio_context
);
2907 bdrv_remove_persistent_dirty_bitmap(bs
, name
, &local_err
);
2908 if (local_err
!= NULL
) {
2909 error_propagate(errp
, local_err
);
2914 bdrv_release_dirty_bitmap(bs
, bitmap
);
2917 aio_context_release(aio_context
);
2922 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2923 * immediately after a full backup operation.
2925 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2928 BdrvDirtyBitmap
*bitmap
;
2929 BlockDriverState
*bs
;
2931 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2932 if (!bitmap
|| !bs
) {
2936 if (bdrv_dirty_bitmap_busy(bitmap
)) {
2938 "Bitmap '%s' is currently in use by another operation"
2939 " and cannot be cleared", name
);
2941 } else if (bdrv_dirty_bitmap_readonly(bitmap
)) {
2942 error_setg(errp
, "Bitmap '%s' is readonly and cannot be cleared", name
);
2946 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2949 void qmp_block_dirty_bitmap_enable(const char *node
, const char *name
,
2952 BlockDriverState
*bs
;
2953 BdrvDirtyBitmap
*bitmap
;
2955 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2960 if (bdrv_dirty_bitmap_busy(bitmap
)) {
2962 "Bitmap '%s' is currently in use by another operation"
2963 " and cannot be enabled", name
);
2967 bdrv_enable_dirty_bitmap(bitmap
);
2970 void qmp_block_dirty_bitmap_disable(const char *node
, const char *name
,
2973 BlockDriverState
*bs
;
2974 BdrvDirtyBitmap
*bitmap
;
2976 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2981 if (bdrv_dirty_bitmap_busy(bitmap
)) {
2983 "Bitmap '%s' is currently in use by another operation"
2984 " and cannot be disabled", name
);
2988 bdrv_disable_dirty_bitmap(bitmap
);
2991 static BdrvDirtyBitmap
*do_block_dirty_bitmap_merge(const char *node
,
2997 BlockDriverState
*bs
;
2998 BdrvDirtyBitmap
*dst
, *src
, *anon
;
3000 Error
*local_err
= NULL
;
3002 dst
= block_dirty_bitmap_lookup(node
, target
, &bs
, errp
);
3007 anon
= bdrv_create_dirty_bitmap(bs
, bdrv_dirty_bitmap_granularity(dst
),
3013 for (lst
= bitmaps
; lst
; lst
= lst
->next
) {
3014 src
= bdrv_find_dirty_bitmap(bs
, lst
->value
);
3016 error_setg(errp
, "Dirty bitmap '%s' not found", lst
->value
);
3021 bdrv_merge_dirty_bitmap(anon
, src
, NULL
, &local_err
);
3023 error_propagate(errp
, local_err
);
3029 /* Merge into dst; dst is unchanged on failure. */
3030 bdrv_merge_dirty_bitmap(dst
, anon
, backup
, errp
);
3033 bdrv_release_dirty_bitmap(bs
, anon
);
3037 void qmp_block_dirty_bitmap_merge(const char *node
, const char *target
,
3038 strList
*bitmaps
, Error
**errp
)
3040 do_block_dirty_bitmap_merge(node
, target
, bitmaps
, NULL
, errp
);
3043 BlockDirtyBitmapSha256
*qmp_x_debug_block_dirty_bitmap_sha256(const char *node
,
3047 BdrvDirtyBitmap
*bitmap
;
3048 BlockDriverState
*bs
;
3049 BlockDirtyBitmapSha256
*ret
= NULL
;
3052 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
3053 if (!bitmap
|| !bs
) {
3057 sha256
= bdrv_dirty_bitmap_sha256(bitmap
, errp
);
3058 if (sha256
== NULL
) {
3062 ret
= g_new(BlockDirtyBitmapSha256
, 1);
3063 ret
->sha256
= sha256
;
3068 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
3070 const char *id
= qdict_get_str(qdict
, "id");
3072 BlockDriverState
*bs
;
3073 AioContext
*aio_context
;
3074 Error
*local_err
= NULL
;
3076 bs
= bdrv_find_node(id
);
3078 qmp_blockdev_del(id
, &local_err
);
3080 error_report_err(local_err
);
3085 blk
= blk_by_name(id
);
3087 error_report("Device '%s' not found", id
);
3091 if (!blk_legacy_dinfo(blk
)) {
3092 error_report("Deleting device added with blockdev-add"
3093 " is not supported");
3097 aio_context
= blk_get_aio_context(blk
);
3098 aio_context_acquire(aio_context
);
3102 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
3103 error_report_err(local_err
);
3104 aio_context_release(aio_context
);
3111 /* Make the BlockBackend and the attached BlockDriverState anonymous */
3112 monitor_remove_blk(blk
);
3114 /* If this BlockBackend has a device attached to it, its refcount will be
3115 * decremented when the device is removed; otherwise we have to do so here.
3117 if (blk_get_attached_dev(blk
)) {
3118 /* Further I/O must not pause the guest */
3119 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
3120 BLOCKDEV_ON_ERROR_REPORT
);
3125 aio_context_release(aio_context
);
3128 void qmp_block_resize(bool has_device
, const char *device
,
3129 bool has_node_name
, const char *node_name
,
3130 int64_t size
, Error
**errp
)
3132 Error
*local_err
= NULL
;
3133 BlockBackend
*blk
= NULL
;
3134 BlockDriverState
*bs
;
3135 AioContext
*aio_context
;
3138 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
3139 has_node_name
? node_name
: NULL
,
3142 error_propagate(errp
, local_err
);
3146 aio_context
= bdrv_get_aio_context(bs
);
3147 aio_context_acquire(aio_context
);
3149 if (!bdrv_is_first_non_filter(bs
)) {
3150 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
3155 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
3159 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
3160 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
3164 blk
= blk_new(BLK_PERM_RESIZE
, BLK_PERM_ALL
);
3165 ret
= blk_insert_bs(blk
, bs
, errp
);
3170 bdrv_drained_begin(bs
);
3171 ret
= blk_truncate(blk
, size
, PREALLOC_MODE_OFF
, errp
);
3172 bdrv_drained_end(bs
);
3176 aio_context_release(aio_context
);
3179 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
3180 bool has_base
, const char *base
,
3181 bool has_base_node
, const char *base_node
,
3182 bool has_backing_file
, const char *backing_file
,
3183 bool has_speed
, int64_t speed
,
3184 bool has_on_error
, BlockdevOnError on_error
,
3185 bool has_auto_finalize
, bool auto_finalize
,
3186 bool has_auto_dismiss
, bool auto_dismiss
,
3189 BlockDriverState
*bs
, *iter
;
3190 BlockDriverState
*base_bs
= NULL
;
3191 AioContext
*aio_context
;
3192 Error
*local_err
= NULL
;
3193 const char *base_name
= NULL
;
3194 int job_flags
= JOB_DEFAULT
;
3196 if (!has_on_error
) {
3197 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3200 bs
= bdrv_lookup_bs(device
, device
, errp
);
3205 aio_context
= bdrv_get_aio_context(bs
);
3206 aio_context_acquire(aio_context
);
3208 if (has_base
&& has_base_node
) {
3209 error_setg(errp
, "'base' and 'base-node' cannot be specified "
3210 "at the same time");
3215 base_bs
= bdrv_find_backing_image(bs
, base
);
3216 if (base_bs
== NULL
) {
3217 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
3220 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3224 if (has_base_node
) {
3225 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3229 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
3230 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
3234 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3235 bdrv_refresh_filename(base_bs
);
3236 base_name
= base_bs
->filename
;
3239 /* Check for op blockers in the whole chain between bs and base */
3240 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
3241 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3246 /* if we are streaming the entire chain, the result will have no backing
3247 * file, and specifying one is therefore an error */
3248 if (base_bs
== NULL
&& has_backing_file
) {
3249 error_setg(errp
, "backing file specified, but streaming the "
3254 /* backing_file string overrides base bs filename */
3255 base_name
= has_backing_file
? backing_file
: base_name
;
3257 if (has_auto_finalize
&& !auto_finalize
) {
3258 job_flags
|= JOB_MANUAL_FINALIZE
;
3260 if (has_auto_dismiss
&& !auto_dismiss
) {
3261 job_flags
|= JOB_MANUAL_DISMISS
;
3264 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
3265 job_flags
, has_speed
? speed
: 0, on_error
, &local_err
);
3267 error_propagate(errp
, local_err
);
3271 trace_qmp_block_stream(bs
, bs
->job
);
3274 aio_context_release(aio_context
);
3277 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
3278 bool has_base_node
, const char *base_node
,
3279 bool has_base
, const char *base
,
3280 bool has_top_node
, const char *top_node
,
3281 bool has_top
, const char *top
,
3282 bool has_backing_file
, const char *backing_file
,
3283 bool has_speed
, int64_t speed
,
3284 bool has_filter_node_name
, const char *filter_node_name
,
3285 bool has_auto_finalize
, bool auto_finalize
,
3286 bool has_auto_dismiss
, bool auto_dismiss
,
3289 BlockDriverState
*bs
;
3290 BlockDriverState
*iter
;
3291 BlockDriverState
*base_bs
, *top_bs
;
3292 AioContext
*aio_context
;
3293 Error
*local_err
= NULL
;
3294 /* This will be part of the QMP command, if/when the
3295 * BlockdevOnError change for blkmirror makes it in
3297 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3298 int job_flags
= JOB_DEFAULT
;
3303 if (!has_filter_node_name
) {
3304 filter_node_name
= NULL
;
3306 if (has_auto_finalize
&& !auto_finalize
) {
3307 job_flags
|= JOB_MANUAL_FINALIZE
;
3309 if (has_auto_dismiss
&& !auto_dismiss
) {
3310 job_flags
|= JOB_MANUAL_DISMISS
;
3314 * libvirt relies on the DeviceNotFound error class in order to probe for
3315 * live commit feature versions; for this to work, we must make sure to
3316 * perform the device lookup before any generic errors that may occur in a
3317 * scenario in which all optional arguments are omitted. */
3318 bs
= qmp_get_root_bs(device
, &local_err
);
3320 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3322 error_free(local_err
);
3323 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3324 "Device '%s' not found", device
);
3326 error_propagate(errp
, local_err
);
3331 aio_context
= bdrv_get_aio_context(bs
);
3332 aio_context_acquire(aio_context
);
3334 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3338 /* default top_bs is the active layer */
3341 if (has_top_node
&& has_top
) {
3342 error_setg(errp
, "'top-node' and 'top' are mutually exclusive");
3344 } else if (has_top_node
) {
3345 top_bs
= bdrv_lookup_bs(NULL
, top_node
, errp
);
3346 if (top_bs
== NULL
) {
3349 if (!bdrv_chain_contains(bs
, top_bs
)) {
3350 error_setg(errp
, "'%s' is not in this backing file chain",
3354 } else if (has_top
&& top
) {
3355 /* This strcmp() is just a shortcut, there is no need to
3356 * refresh @bs's filename. If it mismatches,
3357 * bdrv_find_backing_image() will do the refresh and may still
3359 if (strcmp(bs
->filename
, top
) != 0) {
3360 top_bs
= bdrv_find_backing_image(bs
, top
);
3364 if (top_bs
== NULL
) {
3365 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3369 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3371 if (has_base_node
&& has_base
) {
3372 error_setg(errp
, "'base-node' and 'base' are mutually exclusive");
3374 } else if (has_base_node
) {
3375 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
3376 if (base_bs
== NULL
) {
3379 if (!bdrv_chain_contains(top_bs
, base_bs
)) {
3380 error_setg(errp
, "'%s' is not in this backing file chain",
3384 } else if (has_base
&& base
) {
3385 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3387 base_bs
= bdrv_find_base(top_bs
);
3390 if (base_bs
== NULL
) {
3391 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3395 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3397 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
3398 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3403 /* Do not allow attempts to commit an image into itself */
3404 if (top_bs
== base_bs
) {
3405 error_setg(errp
, "cannot commit an image into itself");
3410 if (has_backing_file
) {
3411 error_setg(errp
, "'backing-file' specified,"
3412 " but 'top' is the active layer");
3415 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
3416 job_flags
, speed
, on_error
,
3417 filter_node_name
, NULL
, NULL
, false, &local_err
);
3419 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
3420 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3423 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, job_flags
,
3424 speed
, on_error
, has_backing_file
? backing_file
: NULL
,
3425 filter_node_name
, &local_err
);
3427 if (local_err
!= NULL
) {
3428 error_propagate(errp
, local_err
);
3433 aio_context_release(aio_context
);
3436 static BlockJob
*do_drive_backup(DriveBackup
*backup
, JobTxn
*txn
,
3439 BlockDriverState
*bs
;
3440 BlockDriverState
*target_bs
;
3441 BlockDriverState
*source
= NULL
;
3442 BlockJob
*job
= NULL
;
3443 BdrvDirtyBitmap
*bmap
= NULL
;
3444 AioContext
*aio_context
;
3445 QDict
*options
= NULL
;
3446 Error
*local_err
= NULL
;
3447 int flags
, job_flags
= JOB_DEFAULT
;
3449 bool set_backing_hd
= false;
3451 if (!backup
->has_speed
) {
3454 if (!backup
->has_on_source_error
) {
3455 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3457 if (!backup
->has_on_target_error
) {
3458 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3460 if (!backup
->has_mode
) {
3461 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3463 if (!backup
->has_job_id
) {
3464 backup
->job_id
= NULL
;
3466 if (!backup
->has_auto_finalize
) {
3467 backup
->auto_finalize
= true;
3469 if (!backup
->has_auto_dismiss
) {
3470 backup
->auto_dismiss
= true;
3472 if (!backup
->has_compress
) {
3473 backup
->compress
= false;
3476 bs
= qmp_get_root_bs(backup
->device
, errp
);
3481 aio_context
= bdrv_get_aio_context(bs
);
3482 aio_context_acquire(aio_context
);
3484 if (!backup
->has_format
) {
3485 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
3486 NULL
: (char*) bs
->drv
->format_name
;
3489 /* Early check to avoid creating target */
3490 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3494 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3496 /* See if we have a backing HD we can use to create our new image
3498 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
3499 source
= backing_bs(bs
);
3501 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
3504 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3506 flags
|= BDRV_O_NO_BACKING
;
3507 set_backing_hd
= true;
3510 size
= bdrv_getlength(bs
);
3512 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3516 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
3517 assert(backup
->format
);
3519 bdrv_refresh_filename(source
);
3520 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
3521 source
->drv
->format_name
, NULL
,
3522 size
, flags
, false, &local_err
);
3524 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
3525 size
, flags
, false, &local_err
);
3530 error_propagate(errp
, local_err
);
3534 if (backup
->format
) {
3536 options
= qdict_new();
3538 qdict_put_str(options
, "driver", backup
->format
);
3541 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
3546 bdrv_set_aio_context(target_bs
, aio_context
);
3548 if (set_backing_hd
) {
3549 bdrv_set_backing_hd(target_bs
, source
, &local_err
);
3551 bdrv_unref(target_bs
);
3556 if (backup
->has_bitmap
) {
3557 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3559 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3560 bdrv_unref(target_bs
);
3563 if (bdrv_dirty_bitmap_busy(bmap
)) {
3565 "Bitmap '%s' is currently in use by another operation"
3566 " and cannot be used for backup", backup
->bitmap
);
3570 if (!backup
->auto_finalize
) {
3571 job_flags
|= JOB_MANUAL_FINALIZE
;
3573 if (!backup
->auto_dismiss
) {
3574 job_flags
|= JOB_MANUAL_DISMISS
;
3577 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3578 backup
->sync
, bmap
, backup
->compress
,
3579 backup
->on_source_error
, backup
->on_target_error
,
3580 job_flags
, NULL
, NULL
, txn
, &local_err
);
3581 bdrv_unref(target_bs
);
3582 if (local_err
!= NULL
) {
3583 error_propagate(errp
, local_err
);
3588 aio_context_release(aio_context
);
3592 void qmp_drive_backup(DriveBackup
*arg
, Error
**errp
)
3596 job
= do_drive_backup(arg
, NULL
, errp
);
3598 job_start(&job
->job
);
3602 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3604 return bdrv_named_nodes_list(errp
);
3607 XDbgBlockGraph
*qmp_x_debug_query_block_graph(Error
**errp
)
3609 return bdrv_get_xdbg_block_graph(errp
);
3612 BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, JobTxn
*txn
,
3615 BlockDriverState
*bs
;
3616 BlockDriverState
*target_bs
;
3617 Error
*local_err
= NULL
;
3618 BdrvDirtyBitmap
*bmap
= NULL
;
3619 AioContext
*aio_context
;
3620 BlockJob
*job
= NULL
;
3621 int job_flags
= JOB_DEFAULT
;
3623 if (!backup
->has_speed
) {
3626 if (!backup
->has_on_source_error
) {
3627 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3629 if (!backup
->has_on_target_error
) {
3630 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3632 if (!backup
->has_job_id
) {
3633 backup
->job_id
= NULL
;
3635 if (!backup
->has_auto_finalize
) {
3636 backup
->auto_finalize
= true;
3638 if (!backup
->has_auto_dismiss
) {
3639 backup
->auto_dismiss
= true;
3641 if (!backup
->has_compress
) {
3642 backup
->compress
= false;
3645 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
3650 aio_context
= bdrv_get_aio_context(bs
);
3651 aio_context_acquire(aio_context
);
3653 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
3658 if (bdrv_get_aio_context(target_bs
) != aio_context
) {
3659 if (!bdrv_has_blk(target_bs
)) {
3660 /* The target BDS is not attached, we can safely move it to another
3662 bdrv_set_aio_context(target_bs
, aio_context
);
3664 error_setg(errp
, "Target is attached to a different thread from "
3670 if (backup
->has_bitmap
) {
3671 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3673 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3676 if (bdrv_dirty_bitmap_busy(bmap
)) {
3678 "Bitmap '%s' is currently in use by another operation"
3679 " and cannot be used for backup", backup
->bitmap
);
3684 if (!backup
->auto_finalize
) {
3685 job_flags
|= JOB_MANUAL_FINALIZE
;
3687 if (!backup
->auto_dismiss
) {
3688 job_flags
|= JOB_MANUAL_DISMISS
;
3690 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3691 backup
->sync
, bmap
, backup
->compress
,
3692 backup
->on_source_error
, backup
->on_target_error
,
3693 job_flags
, NULL
, NULL
, txn
, &local_err
);
3694 if (local_err
!= NULL
) {
3695 error_propagate(errp
, local_err
);
3698 aio_context_release(aio_context
);
3702 void qmp_blockdev_backup(BlockdevBackup
*arg
, Error
**errp
)
3705 job
= do_blockdev_backup(arg
, NULL
, errp
);
3707 job_start(&job
->job
);
3711 /* Parameter check and block job starting for drive mirroring.
3712 * Caller should hold @device and @target's aio context (must be the same).
3714 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3715 BlockDriverState
*target
,
3716 bool has_replaces
, const char *replaces
,
3717 enum MirrorSyncMode sync
,
3718 BlockMirrorBackingMode backing_mode
,
3719 bool has_speed
, int64_t speed
,
3720 bool has_granularity
, uint32_t granularity
,
3721 bool has_buf_size
, int64_t buf_size
,
3722 bool has_on_source_error
,
3723 BlockdevOnError on_source_error
,
3724 bool has_on_target_error
,
3725 BlockdevOnError on_target_error
,
3726 bool has_unmap
, bool unmap
,
3727 bool has_filter_node_name
,
3728 const char *filter_node_name
,
3729 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3730 bool has_auto_finalize
, bool auto_finalize
,
3731 bool has_auto_dismiss
, bool auto_dismiss
,
3734 int job_flags
= JOB_DEFAULT
;
3739 if (!has_on_source_error
) {
3740 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3742 if (!has_on_target_error
) {
3743 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3745 if (!has_granularity
) {
3748 if (!has_buf_size
) {
3754 if (!has_filter_node_name
) {
3755 filter_node_name
= NULL
;
3757 if (!has_copy_mode
) {
3758 copy_mode
= MIRROR_COPY_MODE_BACKGROUND
;
3760 if (has_auto_finalize
&& !auto_finalize
) {
3761 job_flags
|= JOB_MANUAL_FINALIZE
;
3763 if (has_auto_dismiss
&& !auto_dismiss
) {
3764 job_flags
|= JOB_MANUAL_DISMISS
;
3767 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3768 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3769 "a value in range [512B, 64MB]");
3772 if (granularity
& (granularity
- 1)) {
3773 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3778 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3781 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3785 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3786 sync
= MIRROR_SYNC_MODE_FULL
;
3789 /* pass the node name to replace to mirror start since it's loose coupling
3790 * and will allow to check whether the node still exist at mirror completion
3792 mirror_start(job_id
, bs
, target
,
3793 has_replaces
? replaces
: NULL
, job_flags
,
3794 speed
, granularity
, buf_size
, sync
, backing_mode
,
3795 on_source_error
, on_target_error
, unmap
, filter_node_name
,
3799 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3801 BlockDriverState
*bs
;
3802 BlockDriverState
*source
, *target_bs
;
3803 AioContext
*aio_context
;
3804 BlockMirrorBackingMode backing_mode
;
3805 Error
*local_err
= NULL
;
3806 QDict
*options
= NULL
;
3809 const char *format
= arg
->format
;
3811 bs
= qmp_get_root_bs(arg
->device
, errp
);
3816 /* Early check to avoid creating target */
3817 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3821 aio_context
= bdrv_get_aio_context(bs
);
3822 aio_context_acquire(aio_context
);
3824 if (!arg
->has_mode
) {
3825 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3828 if (!arg
->has_format
) {
3829 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3830 ? NULL
: bs
->drv
->format_name
);
3833 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3834 source
= backing_bs(bs
);
3835 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3836 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3838 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3842 size
= bdrv_getlength(bs
);
3844 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3848 if (arg
->has_replaces
) {
3849 BlockDriverState
*to_replace_bs
;
3850 AioContext
*replace_aio_context
;
3851 int64_t replace_size
;
3853 if (!arg
->has_node_name
) {
3854 error_setg(errp
, "a node-name must be provided when replacing a"
3855 " named node of the graph");
3859 to_replace_bs
= check_to_replace_node(bs
, arg
->replaces
, &local_err
);
3861 if (!to_replace_bs
) {
3862 error_propagate(errp
, local_err
);
3866 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3867 aio_context_acquire(replace_aio_context
);
3868 replace_size
= bdrv_getlength(to_replace_bs
);
3869 aio_context_release(replace_aio_context
);
3871 if (size
!= replace_size
) {
3872 error_setg(errp
, "cannot replace image with a mirror image of "
3878 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3879 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3881 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3884 /* Don't open backing image in create() */
3885 flags
|= BDRV_O_NO_BACKING
;
3887 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3888 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3890 /* create new image w/o backing file */
3892 bdrv_img_create(arg
->target
, format
,
3893 NULL
, NULL
, NULL
, size
, flags
, false, &local_err
);
3895 switch (arg
->mode
) {
3896 case NEW_IMAGE_MODE_EXISTING
:
3898 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3899 /* create new image with backing file */
3900 bdrv_refresh_filename(source
);
3901 bdrv_img_create(arg
->target
, format
,
3903 source
->drv
->format_name
,
3904 NULL
, size
, flags
, false, &local_err
);
3912 error_propagate(errp
, local_err
);
3916 options
= qdict_new();
3917 if (arg
->has_node_name
) {
3918 qdict_put_str(options
, "node-name", arg
->node_name
);
3921 qdict_put_str(options
, "driver", format
);
3924 /* Mirroring takes care of copy-on-write using the source's backing
3927 target_bs
= bdrv_open(arg
->target
, NULL
, options
, flags
, errp
);
3932 bdrv_set_aio_context(target_bs
, aio_context
);
3934 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3935 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3936 backing_mode
, arg
->has_speed
, arg
->speed
,
3937 arg
->has_granularity
, arg
->granularity
,
3938 arg
->has_buf_size
, arg
->buf_size
,
3939 arg
->has_on_source_error
, arg
->on_source_error
,
3940 arg
->has_on_target_error
, arg
->on_target_error
,
3941 arg
->has_unmap
, arg
->unmap
,
3943 arg
->has_copy_mode
, arg
->copy_mode
,
3944 arg
->has_auto_finalize
, arg
->auto_finalize
,
3945 arg
->has_auto_dismiss
, arg
->auto_dismiss
,
3947 bdrv_unref(target_bs
);
3948 error_propagate(errp
, local_err
);
3950 aio_context_release(aio_context
);
3953 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3954 const char *device
, const char *target
,
3955 bool has_replaces
, const char *replaces
,
3956 MirrorSyncMode sync
,
3957 bool has_speed
, int64_t speed
,
3958 bool has_granularity
, uint32_t granularity
,
3959 bool has_buf_size
, int64_t buf_size
,
3960 bool has_on_source_error
,
3961 BlockdevOnError on_source_error
,
3962 bool has_on_target_error
,
3963 BlockdevOnError on_target_error
,
3964 bool has_filter_node_name
,
3965 const char *filter_node_name
,
3966 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3967 bool has_auto_finalize
, bool auto_finalize
,
3968 bool has_auto_dismiss
, bool auto_dismiss
,
3971 BlockDriverState
*bs
;
3972 BlockDriverState
*target_bs
;
3973 AioContext
*aio_context
;
3974 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3975 Error
*local_err
= NULL
;
3977 bs
= qmp_get_root_bs(device
, errp
);
3982 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3987 aio_context
= bdrv_get_aio_context(bs
);
3988 aio_context_acquire(aio_context
);
3990 bdrv_set_aio_context(target_bs
, aio_context
);
3992 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3993 has_replaces
, replaces
, sync
, backing_mode
,
3995 has_granularity
, granularity
,
3996 has_buf_size
, buf_size
,
3997 has_on_source_error
, on_source_error
,
3998 has_on_target_error
, on_target_error
,
4000 has_filter_node_name
, filter_node_name
,
4001 has_copy_mode
, copy_mode
,
4002 has_auto_finalize
, auto_finalize
,
4003 has_auto_dismiss
, auto_dismiss
,
4005 error_propagate(errp
, local_err
);
4007 aio_context_release(aio_context
);
4010 /* Get a block job using its ID and acquire its AioContext */
4011 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
4018 *aio_context
= NULL
;
4020 job
= block_job_get(id
);
4023 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
4024 "Block job '%s' not found", id
);
4028 *aio_context
= blk_get_aio_context(job
->blk
);
4029 aio_context_acquire(*aio_context
);
4034 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
4036 AioContext
*aio_context
;
4037 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4043 block_job_set_speed(job
, speed
, errp
);
4044 aio_context_release(aio_context
);
4047 void qmp_block_job_cancel(const char *device
,
4048 bool has_force
, bool force
, Error
**errp
)
4050 AioContext
*aio_context
;
4051 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4061 if (job_user_paused(&job
->job
) && !force
) {
4062 error_setg(errp
, "The block job for device '%s' is currently paused",
4067 trace_qmp_block_job_cancel(job
);
4068 job_user_cancel(&job
->job
, force
, errp
);
4070 aio_context_release(aio_context
);
4073 void qmp_block_job_pause(const char *device
, Error
**errp
)
4075 AioContext
*aio_context
;
4076 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4082 trace_qmp_block_job_pause(job
);
4083 job_user_pause(&job
->job
, errp
);
4084 aio_context_release(aio_context
);
4087 void qmp_block_job_resume(const char *device
, Error
**errp
)
4089 AioContext
*aio_context
;
4090 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4096 trace_qmp_block_job_resume(job
);
4097 job_user_resume(&job
->job
, errp
);
4098 aio_context_release(aio_context
);
4101 void qmp_block_job_complete(const char *device
, Error
**errp
)
4103 AioContext
*aio_context
;
4104 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
4110 trace_qmp_block_job_complete(job
);
4111 job_complete(&job
->job
, errp
);
4112 aio_context_release(aio_context
);
4115 void qmp_block_job_finalize(const char *id
, Error
**errp
)
4117 AioContext
*aio_context
;
4118 BlockJob
*job
= find_block_job(id
, &aio_context
, errp
);
4124 trace_qmp_block_job_finalize(job
);
4125 job_finalize(&job
->job
, errp
);
4126 aio_context_release(aio_context
);
4129 void qmp_block_job_dismiss(const char *id
, Error
**errp
)
4131 AioContext
*aio_context
;
4132 BlockJob
*bjob
= find_block_job(id
, &aio_context
, errp
);
4139 trace_qmp_block_job_dismiss(bjob
);
4141 job_dismiss(&job
, errp
);
4142 aio_context_release(aio_context
);
4145 void qmp_change_backing_file(const char *device
,
4146 const char *image_node_name
,
4147 const char *backing_file
,
4150 BlockDriverState
*bs
= NULL
;
4151 AioContext
*aio_context
;
4152 BlockDriverState
*image_bs
= NULL
;
4153 Error
*local_err
= NULL
;
4157 bs
= qmp_get_root_bs(device
, errp
);
4162 aio_context
= bdrv_get_aio_context(bs
);
4163 aio_context_acquire(aio_context
);
4165 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
4167 error_propagate(errp
, local_err
);
4172 error_setg(errp
, "image file not found");
4176 if (bdrv_find_base(image_bs
) == image_bs
) {
4177 error_setg(errp
, "not allowing backing file change on an image "
4178 "without a backing file");
4182 /* even though we are not necessarily operating on bs, we need it to
4183 * determine if block ops are currently prohibited on the chain */
4184 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
4188 /* final sanity check */
4189 if (!bdrv_chain_contains(bs
, image_bs
)) {
4190 error_setg(errp
, "'%s' and image file are not in the same chain",
4195 /* if not r/w, reopen to make r/w */
4196 ro
= bdrv_is_read_only(image_bs
);
4199 if (bdrv_reopen_set_read_only(image_bs
, false, errp
) != 0) {
4204 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
4205 image_bs
->drv
? image_bs
->drv
->format_name
: "");
4208 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
4210 /* don't exit here, so we can try to restore open flags if
4215 bdrv_reopen_set_read_only(image_bs
, true, &local_err
);
4216 error_propagate(errp
, local_err
);
4220 aio_context_release(aio_context
);
4223 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
4227 Error
*local_err
= NULL
;
4229 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
4234 qdict
= qemu_opts_to_qdict(opts
, NULL
);
4236 if (!qdict_get_try_str(qdict
, "node-name")) {
4237 qobject_unref(qdict
);
4238 error_report("'node-name' needs to be specified");
4242 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
4244 error_report_err(local_err
);
4248 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4251 qemu_opts_del(opts
);
4254 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
4256 BlockDriverState
*bs
;
4258 Visitor
*v
= qobject_output_visitor_new(&obj
);
4260 Error
*local_err
= NULL
;
4262 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
4264 error_propagate(errp
, local_err
);
4268 visit_complete(v
, &obj
);
4269 qdict
= qobject_to(QDict
, obj
);
4271 qdict_flatten(qdict
);
4273 if (!qdict_get_try_str(qdict
, "node-name")) {
4274 error_setg(errp
, "'node-name' must be specified for the root node");
4278 bs
= bds_tree_init(qdict
, errp
);
4283 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
4289 void qmp_blockdev_del(const char *node_name
, Error
**errp
)
4291 AioContext
*aio_context
;
4292 BlockDriverState
*bs
;
4294 bs
= bdrv_find_node(node_name
);
4296 error_setg(errp
, "Cannot find node %s", node_name
);
4299 if (bdrv_has_blk(bs
)) {
4300 error_setg(errp
, "Node %s is in use", node_name
);
4303 aio_context
= bdrv_get_aio_context(bs
);
4304 aio_context_acquire(aio_context
);
4306 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
4310 if (!QTAILQ_IN_USE(bs
, monitor_list
)) {
4311 error_setg(errp
, "Node %s is not owned by the monitor",
4316 if (bs
->refcnt
> 1) {
4317 error_setg(errp
, "Block device %s is in use",
4318 bdrv_get_device_or_node_name(bs
));
4322 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
4326 aio_context_release(aio_context
);
4329 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
4330 const char *child_name
)
4334 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
4335 if (strcmp(child
->name
, child_name
) == 0) {
4343 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
4344 const char *child
, bool has_node
,
4345 const char *node
, Error
**errp
)
4347 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
4350 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
4355 if (has_child
== has_node
) {
4357 error_setg(errp
, "The parameters child and node are in conflict");
4359 error_setg(errp
, "Either child or node must be specified");
4365 p_child
= bdrv_find_child(parent_bs
, child
);
4367 error_setg(errp
, "Node '%s' does not have child '%s'",
4371 bdrv_del_child(parent_bs
, p_child
, errp
);
4375 new_bs
= bdrv_find_node(node
);
4377 error_setg(errp
, "Node '%s' not found", node
);
4380 bdrv_add_child(parent_bs
, new_bs
, errp
);
4384 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
4386 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
4389 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
4390 BlockJobInfoList
*elem
;
4391 AioContext
*aio_context
;
4393 if (block_job_is_internal(job
)) {
4396 elem
= g_new0(BlockJobInfoList
, 1);
4397 aio_context
= blk_get_aio_context(job
->blk
);
4398 aio_context_acquire(aio_context
);
4399 elem
->value
= block_job_query(job
, errp
);
4400 aio_context_release(aio_context
);
4403 qapi_free_BlockJobInfoList(head
);
4407 p_next
= &elem
->next
;
4413 void qmp_x_blockdev_set_iothread(const char *node_name
, StrOrNull
*iothread
,
4414 bool has_force
, bool force
, Error
**errp
)
4416 AioContext
*old_context
;
4417 AioContext
*new_context
;
4418 BlockDriverState
*bs
;
4420 bs
= bdrv_find_node(node_name
);
4422 error_setg(errp
, "Cannot find node %s", node_name
);
4426 /* Protects against accidents. */
4427 if (!(has_force
&& force
) && bdrv_has_blk(bs
)) {
4428 error_setg(errp
, "Node %s is associated with a BlockBackend and could "
4429 "be in use (use force=true to override this check)",
4434 if (iothread
->type
== QTYPE_QSTRING
) {
4435 IOThread
*obj
= iothread_by_id(iothread
->u
.s
);
4437 error_setg(errp
, "Cannot find iothread %s", iothread
->u
.s
);
4441 new_context
= iothread_get_aio_context(obj
);
4443 new_context
= qemu_get_aio_context();
4446 old_context
= bdrv_get_aio_context(bs
);
4447 aio_context_acquire(old_context
);
4449 bdrv_set_aio_context(bs
, new_context
);
4451 aio_context_release(old_context
);
4454 void qmp_x_block_latency_histogram_set(
4456 bool has_boundaries
, uint64List
*boundaries
,
4457 bool has_boundaries_read
, uint64List
*boundaries_read
,
4458 bool has_boundaries_write
, uint64List
*boundaries_write
,
4459 bool has_boundaries_flush
, uint64List
*boundaries_flush
,
4462 BlockBackend
*blk
= blk_by_name(device
);
4463 BlockAcctStats
*stats
;
4467 error_setg(errp
, "Device '%s' not found", device
);
4470 stats
= blk_get_stats(blk
);
4472 if (!has_boundaries
&& !has_boundaries_read
&& !has_boundaries_write
&&
4473 !has_boundaries_flush
)
4475 block_latency_histograms_clear(stats
);
4479 if (has_boundaries
|| has_boundaries_read
) {
4480 ret
= block_latency_histogram_set(
4481 stats
, BLOCK_ACCT_READ
,
4482 has_boundaries_read
? boundaries_read
: boundaries
);
4484 error_setg(errp
, "Device '%s' set read boundaries fail", device
);
4489 if (has_boundaries
|| has_boundaries_write
) {
4490 ret
= block_latency_histogram_set(
4491 stats
, BLOCK_ACCT_WRITE
,
4492 has_boundaries_write
? boundaries_write
: boundaries
);
4494 error_setg(errp
, "Device '%s' set write boundaries fail", device
);
4499 if (has_boundaries
|| has_boundaries_flush
) {
4500 ret
= block_latency_histogram_set(
4501 stats
, BLOCK_ACCT_FLUSH
,
4502 has_boundaries_flush
? boundaries_flush
: boundaries
);
4504 error_setg(errp
, "Device '%s' set flush boundaries fail", device
);
4510 QemuOptsList qemu_common_drive_opts
= {
4512 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4516 .type
= QEMU_OPT_BOOL
,
4517 .help
= "enable/disable snapshot mode",
4520 .type
= QEMU_OPT_STRING
,
4521 .help
= "host AIO implementation (threads, native)",
4523 .name
= BDRV_OPT_CACHE_WB
,
4524 .type
= QEMU_OPT_BOOL
,
4525 .help
= "Enable writeback mode",
4528 .type
= QEMU_OPT_STRING
,
4529 .help
= "disk format (raw, qcow2, ...)",
4532 .type
= QEMU_OPT_STRING
,
4533 .help
= "read error action",
4536 .type
= QEMU_OPT_STRING
,
4537 .help
= "write error action",
4539 .name
= BDRV_OPT_READ_ONLY
,
4540 .type
= QEMU_OPT_BOOL
,
4541 .help
= "open drive file as read-only",
4547 .name
= "throttling.group",
4548 .type
= QEMU_OPT_STRING
,
4549 .help
= "name of the block throttling group",
4551 .name
= "copy-on-read",
4552 .type
= QEMU_OPT_BOOL
,
4553 .help
= "copy read data from backing file into image file",
4555 .name
= "detect-zeroes",
4556 .type
= QEMU_OPT_STRING
,
4557 .help
= "try to optimize zero writes (off, on, unmap)",
4559 .name
= "stats-account-invalid",
4560 .type
= QEMU_OPT_BOOL
,
4561 .help
= "whether to account for invalid I/O operations "
4562 "in the statistics",
4564 .name
= "stats-account-failed",
4565 .type
= QEMU_OPT_BOOL
,
4566 .help
= "whether to account for failed I/O operations "
4567 "in the statistics",
4569 { /* end of list */ }
4573 QemuOptsList qemu_drive_opts
= {
4575 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4578 * no elements => accept any params
4579 * validation will happen later
4581 { /* end of list */ }