2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
9 * This file incorporates work covered by the following copyright and
12 * Copyright (c) 2003-2008 Fabrice Bellard
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
33 #include "qemu/osdep.h"
34 #include "sysemu/block-backend.h"
35 #include "sysemu/blockdev.h"
36 #include "hw/block/block.h"
37 #include "block/blockjob.h"
38 #include "block/qdict.h"
39 #include "block/throttle-groups.h"
40 #include "monitor/monitor.h"
41 #include "qemu/error-report.h"
42 #include "qemu/option.h"
43 #include "qemu/qemu-print.h"
44 #include "qemu/config-file.h"
45 #include "qapi/qapi-commands-block.h"
46 #include "qapi/qapi-commands-transaction.h"
47 #include "qapi/qapi-visit-block-core.h"
48 #include "qapi/qmp/qdict.h"
49 #include "qapi/qmp/qnum.h"
50 #include "qapi/qmp/qstring.h"
51 #include "qapi/error.h"
52 #include "qapi/qmp/qerror.h"
53 #include "qapi/qmp/qlist.h"
54 #include "qapi/qobject-output-visitor.h"
55 #include "sysemu/sysemu.h"
56 #include "sysemu/iothread.h"
57 #include "block/block_int.h"
58 #include "block/trace.h"
59 #include "sysemu/arch_init.h"
60 #include "sysemu/qtest.h"
61 #include "sysemu/runstate.h"
62 #include "qemu/cutils.h"
63 #include "qemu/help_option.h"
64 #include "qemu/main-loop.h"
65 #include "qemu/throttle-options.h"
67 QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
68 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
70 void bdrv_set_monitor_owned(BlockDriverState
*bs
)
72 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
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
);
148 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
149 if (block_job_has_bdrv(job
, blk_bs(blk
))) {
150 AioContext
*aio_context
= job
->job
.aio_context
;
151 aio_context_acquire(aio_context
);
153 job_cancel(&job
->job
, false);
155 aio_context_release(aio_context
);
162 void blockdev_auto_del(BlockBackend
*blk
)
164 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
166 if (dinfo
&& dinfo
->auto_del
) {
167 monitor_remove_blk(blk
);
173 * Returns the current mapping of how many units per bus
174 * a particular interface can support.
176 * A positive integer indicates n units per bus.
177 * 0 implies the mapping has not been established.
178 * -1 indicates an invalid BlockInterfaceType was given.
180 int drive_get_max_devs(BlockInterfaceType type
)
182 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
183 return if_max_devs
[type
];
189 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
191 int max_devs
= if_max_devs
[type
];
192 return max_devs
? index
/ max_devs
: 0;
195 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
197 int max_devs
= if_max_devs
[type
];
198 return max_devs
? index
% max_devs
: index
;
201 QemuOpts
*drive_def(const char *optstr
)
203 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
206 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
211 opts
= drive_def(optstr
);
215 if (type
!= IF_DEFAULT
) {
216 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
219 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
222 qemu_opt_set(opts
, "file", file
, &error_abort
);
226 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
231 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
232 dinfo
= blk_legacy_dinfo(blk
);
233 if (dinfo
&& dinfo
->type
== type
234 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
242 void drive_mark_claimed_by_board(void)
247 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
248 dinfo
= blk_legacy_dinfo(blk
);
249 if (dinfo
&& blk_get_attached_dev(blk
)) {
250 dinfo
->claimed_by_board
= true;
255 void drive_check_orphaned(void)
260 bool orphans
= false;
262 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
263 dinfo
= blk_legacy_dinfo(blk
);
264 if (dinfo
->is_default
|| dinfo
->type
== IF_NONE
) {
267 if (!blk_get_attached_dev(blk
)) {
269 qemu_opts_loc_restore(dinfo
->opts
);
270 error_report("machine type does not support"
271 " if=%s,bus=%d,unit=%d",
272 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
277 if (!dinfo
->claimed_by_board
&& dinfo
->type
!= IF_VIRTIO
) {
279 qemu_opts_loc_restore(dinfo
->opts
);
280 warn_report("bogus if=%s is deprecated, use if=none",
281 if_name
[dinfo
->type
]);
291 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
293 return drive_get(type
,
294 drive_index_to_bus_id(type
, index
),
295 drive_index_to_unit_id(type
, index
));
298 int drive_get_max_bus(BlockInterfaceType type
)
305 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
306 dinfo
= blk_legacy_dinfo(blk
);
307 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
308 max_bus
= dinfo
->bus
;
314 /* Get a block device. This should only be used for single-drive devices
315 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
317 DriveInfo
*drive_get_next(BlockInterfaceType type
)
319 static int next_block_unit
[IF_COUNT
];
321 return drive_get(type
, 0, next_block_unit
[type
]++);
324 static void bdrv_format_print(void *opaque
, const char *name
)
326 qemu_printf(" %s", name
);
331 BlockDriverState
*bs
;
334 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
336 if (!strcmp(buf
, "ignore")) {
337 return BLOCKDEV_ON_ERROR_IGNORE
;
338 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
339 return BLOCKDEV_ON_ERROR_ENOSPC
;
340 } else if (!strcmp(buf
, "stop")) {
341 return BLOCKDEV_ON_ERROR_STOP
;
342 } else if (!strcmp(buf
, "report")) {
343 return BLOCKDEV_ON_ERROR_REPORT
;
345 error_setg(errp
, "'%s' invalid %s error action",
346 buf
, is_read
? "read" : "write");
351 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
354 const QListEntry
*entry
;
355 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
356 switch (qobject_type(entry
->value
)) {
358 case QTYPE_QSTRING
: {
359 unsigned long long length
;
360 const char *str
= qstring_get_str(qobject_to(QString
,
362 if (parse_uint_full(str
, &length
, 10) == 0 &&
363 length
> 0 && length
<= UINT_MAX
) {
364 block_acct_add_interval(stats
, (unsigned) length
);
366 error_setg(errp
, "Invalid interval length: %s", str
);
373 int64_t length
= qnum_get_int(qobject_to(QNum
, entry
->value
));
375 if (length
> 0 && length
<= UINT_MAX
) {
376 block_acct_add_interval(stats
, (unsigned) length
);
378 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
385 error_setg(errp
, "The specification of stats-intervals is invalid");
392 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
394 /* All parameters but @opts are optional and may be set to NULL. */
395 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
396 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
397 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
399 Error
*local_error
= NULL
;
403 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
404 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
407 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
408 if (bdrv_parse_aio(aio
, bdrv_flags
) < 0) {
409 error_setg(errp
, "invalid aio option");
415 /* disk I/O throttling */
416 if (throttling_group
) {
417 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
421 throttle_config_init(throttle_cfg
);
422 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
423 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
424 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
425 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
426 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
427 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
428 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
429 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
430 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
431 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
432 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
433 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
435 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
436 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
437 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
438 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
439 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
440 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
441 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
442 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
443 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
444 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
445 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
446 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
448 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].burst_length
=
449 qemu_opt_get_number(opts
, "throttling.bps-total-max-length", 1);
450 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].burst_length
=
451 qemu_opt_get_number(opts
, "throttling.bps-read-max-length", 1);
452 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].burst_length
=
453 qemu_opt_get_number(opts
, "throttling.bps-write-max-length", 1);
454 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].burst_length
=
455 qemu_opt_get_number(opts
, "throttling.iops-total-max-length", 1);
456 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].burst_length
=
457 qemu_opt_get_number(opts
, "throttling.iops-read-max-length", 1);
458 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].burst_length
=
459 qemu_opt_get_number(opts
, "throttling.iops-write-max-length", 1);
461 throttle_cfg
->op_size
=
462 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
464 if (!throttle_is_valid(throttle_cfg
, errp
)) {
471 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup
,
472 qemu_opt_get(opts
, "detect-zeroes"),
473 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
476 error_propagate(errp
, local_error
);
482 /* Takes the ownership of bs_opts */
483 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
488 int on_read_error
, on_write_error
;
489 bool account_invalid
, account_failed
;
490 bool writethrough
, read_only
;
492 BlockDriverState
*bs
;
497 QDict
*interval_dict
= NULL
;
498 QList
*interval_list
= NULL
;
500 BlockdevDetectZeroesOptions detect_zeroes
=
501 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
502 const char *throttling_group
= NULL
;
504 /* Check common options by copying from bs_opts to opts, all other options
505 * stay in bs_opts for processing by bdrv_open(). */
506 id
= qdict_get_try_str(bs_opts
, "id");
507 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, errp
);
512 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
514 error_propagate(errp
, error
);
519 qdict_del(bs_opts
, "id");
522 /* extract parameters */
523 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
525 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
526 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
528 writethrough
= !qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true);
530 id
= qemu_opts_id(opts
);
532 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
533 qdict_array_split(interval_dict
, &interval_list
);
535 if (qdict_size(interval_dict
) != 0) {
536 error_setg(errp
, "Invalid option stats-intervals.%s",
537 qdict_first(interval_dict
)->key
);
541 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
542 &detect_zeroes
, &error
);
544 error_propagate(errp
, error
);
548 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
549 if (is_help_option(buf
)) {
550 qemu_printf("Supported formats:");
551 bdrv_iterate_format(bdrv_format_print
, NULL
, false);
552 qemu_printf("\nSupported formats (read-only):");
553 bdrv_iterate_format(bdrv_format_print
, NULL
, true);
558 if (qdict_haskey(bs_opts
, "driver")) {
559 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
562 qdict_put_str(bs_opts
, "driver", buf
);
565 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
566 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
567 on_write_error
= parse_block_error_action(buf
, 0, &error
);
569 error_propagate(errp
, error
);
574 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
575 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
576 on_read_error
= parse_block_error_action(buf
, 1, &error
);
578 error_propagate(errp
, error
);
584 bdrv_flags
|= BDRV_O_SNAPSHOT
;
587 read_only
= qemu_opt_get_bool(opts
, BDRV_OPT_READ_ONLY
, false);
590 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
591 BlockBackendRootState
*blk_rs
;
593 blk
= blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL
);
594 blk_rs
= blk_get_root_state(blk
);
595 blk_rs
->open_flags
= bdrv_flags
;
596 blk_rs
->read_only
= read_only
;
597 blk_rs
->detect_zeroes
= detect_zeroes
;
599 qobject_unref(bs_opts
);
601 if (file
&& !*file
) {
605 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
606 * with other callers) rather than what we want as the real defaults.
607 * Apply the defaults here instead. */
608 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
609 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
610 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
,
611 read_only
? "on" : "off");
612 qdict_set_default_str(bs_opts
, BDRV_OPT_AUTO_READ_ONLY
, "on");
613 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
615 if (runstate_check(RUN_STATE_INMIGRATE
)) {
616 bdrv_flags
|= BDRV_O_INACTIVE
;
619 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
625 bs
->detect_zeroes
= detect_zeroes
;
627 block_acct_setup(blk_get_stats(blk
), account_invalid
, account_failed
);
629 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
636 /* disk I/O throttling */
637 if (throttle_enabled(&cfg
)) {
638 if (!throttling_group
) {
639 throttling_group
= id
;
641 blk_io_limits_enable(blk
, throttling_group
);
642 blk_set_io_limits(blk
, &cfg
);
645 blk_set_enable_write_cache(blk
, !writethrough
);
646 blk_set_on_error(blk
, on_read_error
, on_write_error
);
648 if (!monitor_add_blk(blk
, id
, errp
)) {
656 qobject_unref(interval_dict
);
657 qobject_unref(interval_list
);
662 qobject_unref(interval_dict
);
663 qobject_unref(interval_list
);
665 qobject_unref(bs_opts
);
669 /* Takes the ownership of bs_opts */
670 BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
674 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
675 * with other callers) rather than what we want as the real defaults.
676 * Apply the defaults here instead. */
677 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
678 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
679 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
681 if (runstate_check(RUN_STATE_INMIGRATE
)) {
682 bdrv_flags
|= BDRV_O_INACTIVE
;
685 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
688 void blockdev_close_all_bdrv_states(void)
690 BlockDriverState
*bs
, *next_bs
;
692 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
693 AioContext
*ctx
= bdrv_get_aio_context(bs
);
695 aio_context_acquire(ctx
);
697 aio_context_release(ctx
);
701 /* Iterates over the list of monitor-owned BlockDriverStates */
702 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
704 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
705 : QTAILQ_FIRST(&monitor_bdrv_states
);
708 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
713 value
= qemu_opt_get(opts
, from
);
715 if (qemu_opt_find(opts
, to
)) {
716 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
717 "same time", to
, from
);
722 /* rename all items in opts */
723 while ((value
= qemu_opt_get(opts
, from
))) {
724 qemu_opt_set(opts
, to
, value
, &error_abort
);
725 qemu_opt_unset(opts
, from
);
729 QemuOptsList qemu_legacy_drive_opts
= {
731 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
735 .type
= QEMU_OPT_NUMBER
,
736 .help
= "bus number",
739 .type
= QEMU_OPT_NUMBER
,
740 .help
= "unit number (i.e. lun for scsi)",
743 .type
= QEMU_OPT_NUMBER
,
744 .help
= "index number",
747 .type
= QEMU_OPT_STRING
,
748 .help
= "media type (disk, cdrom)",
751 .type
= QEMU_OPT_STRING
,
752 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
755 .type
= QEMU_OPT_STRING
,
759 /* Options that are passed on, but have special semantics with -drive */
761 .name
= BDRV_OPT_READ_ONLY
,
762 .type
= QEMU_OPT_BOOL
,
763 .help
= "open drive file as read-only",
766 .type
= QEMU_OPT_STRING
,
767 .help
= "read error action",
770 .type
= QEMU_OPT_STRING
,
771 .help
= "write error action",
773 .name
= "copy-on-read",
774 .type
= QEMU_OPT_BOOL
,
775 .help
= "copy read data from backing file into image file",
778 { /* end of list */ }
782 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
,
787 DriveInfo
*dinfo
= NULL
;
789 QemuOpts
*legacy_opts
;
790 DriveMediaType media
= MEDIA_DISK
;
791 BlockInterfaceType type
;
792 int max_devs
, bus_id
, unit_id
, index
;
793 const char *werror
, *rerror
;
794 bool read_only
= false;
796 const char *filename
;
797 Error
*local_err
= NULL
;
800 /* Change legacy command line options into QMP ones */
801 static const struct {
805 { "iops", "throttling.iops-total" },
806 { "iops_rd", "throttling.iops-read" },
807 { "iops_wr", "throttling.iops-write" },
809 { "bps", "throttling.bps-total" },
810 { "bps_rd", "throttling.bps-read" },
811 { "bps_wr", "throttling.bps-write" },
813 { "iops_max", "throttling.iops-total-max" },
814 { "iops_rd_max", "throttling.iops-read-max" },
815 { "iops_wr_max", "throttling.iops-write-max" },
817 { "bps_max", "throttling.bps-total-max" },
818 { "bps_rd_max", "throttling.bps-read-max" },
819 { "bps_wr_max", "throttling.bps-write-max" },
821 { "iops_size", "throttling.iops-size" },
823 { "group", "throttling.group" },
825 { "readonly", BDRV_OPT_READ_ONLY
},
828 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
829 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
832 error_propagate(errp
, local_err
);
837 value
= qemu_opt_get(all_opts
, "cache");
842 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
843 error_setg(errp
, "invalid cache option");
847 /* Specific options take precedence */
848 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
849 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
850 !writethrough
, &error_abort
);
852 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
853 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
854 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
856 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
857 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
858 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
860 qemu_opt_unset(all_opts
, "cache");
863 /* Get a QDict for processing the options */
864 bs_opts
= qdict_new();
865 qemu_opts_to_qdict(all_opts
, bs_opts
);
867 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
869 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
871 error_propagate(errp
, local_err
);
876 value
= qemu_opt_get(legacy_opts
, "media");
878 if (!strcmp(value
, "disk")) {
880 } else if (!strcmp(value
, "cdrom")) {
884 error_setg(errp
, "'%s' invalid media", value
);
889 /* copy-on-read is disabled with a warning for read-only devices */
890 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
891 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
893 if (read_only
&& copy_on_read
) {
894 warn_report("disabling copy-on-read on read-only drive");
895 copy_on_read
= false;
898 qdict_put_str(bs_opts
, BDRV_OPT_READ_ONLY
, read_only
? "on" : "off");
899 qdict_put_str(bs_opts
, "copy-on-read", copy_on_read
? "on" : "off");
901 /* Controller type */
902 value
= qemu_opt_get(legacy_opts
, "if");
905 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
908 if (type
== IF_COUNT
) {
909 error_setg(errp
, "unsupported bus type '%s'", value
);
913 type
= block_default_type
;
916 /* Device address specified by bus/unit or index.
917 * If none was specified, try to find the first free one. */
918 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
919 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
920 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
922 max_devs
= if_max_devs
[type
];
925 if (bus_id
!= 0 || unit_id
!= -1) {
926 error_setg(errp
, "index cannot be used with bus and unit");
929 bus_id
= drive_index_to_bus_id(type
, index
);
930 unit_id
= drive_index_to_unit_id(type
, index
);
935 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
937 if (max_devs
&& unit_id
>= max_devs
) {
944 if (max_devs
&& unit_id
>= max_devs
) {
945 error_setg(errp
, "unit %d too big (max is %d)", unit_id
, max_devs
- 1);
949 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
950 error_setg(errp
, "drive with bus=%d, unit=%d (index=%d) exists",
951 bus_id
, unit_id
, index
);
955 /* no id supplied -> create one */
956 if (qemu_opts_id(all_opts
) == NULL
) {
958 const char *mediastr
= "";
959 if (type
== IF_IDE
|| type
== IF_SCSI
) {
960 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
963 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
966 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
969 qdict_put_str(bs_opts
, "id", new_id
);
973 /* Add virtio block device */
974 if (type
== IF_VIRTIO
) {
976 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
978 if (arch_type
== QEMU_ARCH_S390X
) {
979 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
981 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
983 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
987 filename
= qemu_opt_get(legacy_opts
, "file");
989 /* Check werror/rerror compatibility with if=... */
990 werror
= qemu_opt_get(legacy_opts
, "werror");
991 if (werror
!= NULL
) {
992 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
994 error_setg(errp
, "werror is not supported by this bus type");
997 qdict_put_str(bs_opts
, "werror", werror
);
1000 rerror
= qemu_opt_get(legacy_opts
, "rerror");
1001 if (rerror
!= NULL
) {
1002 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
1004 error_setg(errp
, "rerror is not supported by this bus type");
1007 qdict_put_str(bs_opts
, "rerror", rerror
);
1010 /* Actual block device init: Functionality shared with blockdev-add */
1011 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
1014 error_propagate(errp
, local_err
);
1020 /* Create legacy DriveInfo */
1021 dinfo
= g_malloc0(sizeof(*dinfo
));
1022 dinfo
->opts
= all_opts
;
1025 dinfo
->bus
= bus_id
;
1026 dinfo
->unit
= unit_id
;
1028 blk_set_legacy_dinfo(blk
, dinfo
);
1035 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1042 qemu_opts_del(legacy_opts
);
1043 qobject_unref(bs_opts
);
1047 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1049 BlockDriverState
*bs
;
1051 bs
= bdrv_lookup_bs(name
, name
, errp
);
1056 if (!bdrv_is_root_node(bs
)) {
1057 error_setg(errp
, "Need a root block node");
1061 if (!bdrv_is_inserted(bs
)) {
1062 error_setg(errp
, "Device has no medium");
1069 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1071 TransactionActionList list
;
1073 list
.value
= action
;
1075 qmp_transaction(&list
, false, NULL
, errp
);
1078 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1079 bool has_node_name
, const char *node_name
,
1080 const char *snapshot_file
,
1081 bool has_snapshot_node_name
,
1082 const char *snapshot_node_name
,
1083 bool has_format
, const char *format
,
1084 bool has_mode
, NewImageMode mode
, Error
**errp
)
1086 BlockdevSnapshotSync snapshot
= {
1087 .has_device
= has_device
,
1088 .device
= (char *) device
,
1089 .has_node_name
= has_node_name
,
1090 .node_name
= (char *) node_name
,
1091 .snapshot_file
= (char *) snapshot_file
,
1092 .has_snapshot_node_name
= has_snapshot_node_name
,
1093 .snapshot_node_name
= (char *) snapshot_node_name
,
1094 .has_format
= has_format
,
1095 .format
= (char *) format
,
1096 .has_mode
= has_mode
,
1099 TransactionAction action
= {
1100 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1101 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1103 blockdev_do_action(&action
, errp
);
1106 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1109 BlockdevSnapshot snapshot_data
= {
1110 .node
= (char *) node
,
1111 .overlay
= (char *) overlay
1113 TransactionAction action
= {
1114 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1115 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1117 blockdev_do_action(&action
, errp
);
1120 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1124 BlockdevSnapshotInternal snapshot
= {
1125 .device
= (char *) device
,
1126 .name
= (char *) name
1128 TransactionAction action
= {
1129 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1130 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1132 blockdev_do_action(&action
, errp
);
1135 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1142 BlockDriverState
*bs
;
1143 AioContext
*aio_context
;
1144 QEMUSnapshotInfo sn
;
1145 Error
*local_err
= NULL
;
1146 SnapshotInfo
*info
= NULL
;
1149 bs
= qmp_get_root_bs(device
, errp
);
1153 aio_context
= bdrv_get_aio_context(bs
);
1154 aio_context_acquire(aio_context
);
1165 error_setg(errp
, "Name or id must be provided");
1166 goto out_aio_context
;
1169 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1170 goto out_aio_context
;
1173 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1175 error_propagate(errp
, local_err
);
1176 goto out_aio_context
;
1180 "Snapshot with id '%s' and name '%s' does not exist on "
1182 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1183 goto out_aio_context
;
1186 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1188 error_propagate(errp
, local_err
);
1189 goto out_aio_context
;
1192 aio_context_release(aio_context
);
1194 info
= g_new0(SnapshotInfo
, 1);
1195 info
->id
= g_strdup(sn
.id_str
);
1196 info
->name
= g_strdup(sn
.name
);
1197 info
->date_nsec
= sn
.date_nsec
;
1198 info
->date_sec
= sn
.date_sec
;
1199 info
->vm_state_size
= sn
.vm_state_size
;
1200 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1201 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1206 aio_context_release(aio_context
);
1210 /* New and old BlockDriverState structs for atomic group operations */
1212 typedef struct BlkActionState BlkActionState
;
1216 * Table of operations that define an Action.
1218 * @instance_size: Size of state struct, in bytes.
1219 * @prepare: Prepare the work, must NOT be NULL.
1220 * @commit: Commit the changes, can be NULL.
1221 * @abort: Abort the changes on fail, can be NULL.
1222 * @clean: Clean up resources after all transaction actions have called
1223 * commit() or abort(). Can be NULL.
1225 * Only prepare() may fail. In a single transaction, only one of commit() or
1226 * abort() will be called. clean() will always be called if it is present.
1228 typedef struct BlkActionOps
{
1229 size_t instance_size
;
1230 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1231 void (*commit
)(BlkActionState
*common
);
1232 void (*abort
)(BlkActionState
*common
);
1233 void (*clean
)(BlkActionState
*common
);
1238 * Describes one Action's state within a Transaction.
1240 * @action: QAPI-defined enum identifying which Action to perform.
1241 * @ops: Table of ActionOps this Action can perform.
1242 * @block_job_txn: Transaction which this action belongs to.
1243 * @entry: List membership for all Actions in this Transaction.
1245 * This structure must be arranged as first member in a subclassed type,
1246 * assuming that the compiler will also arrange it to the same offsets as the
1249 struct BlkActionState
{
1250 TransactionAction
*action
;
1251 const BlkActionOps
*ops
;
1252 JobTxn
*block_job_txn
;
1253 TransactionProperties
*txn_props
;
1254 QTAILQ_ENTRY(BlkActionState
) entry
;
1257 /* internal snapshot private data */
1258 typedef struct InternalSnapshotState
{
1259 BlkActionState common
;
1260 BlockDriverState
*bs
;
1261 QEMUSnapshotInfo sn
;
1263 } InternalSnapshotState
;
1266 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1268 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1270 "Action '%s' does not support Transaction property "
1271 "completion-mode = %s",
1272 TransactionActionKind_str(s
->action
->type
),
1273 ActionCompletionMode_str(s
->txn_props
->completion_mode
));
1279 static void internal_snapshot_prepare(BlkActionState
*common
,
1282 Error
*local_err
= NULL
;
1285 BlockDriverState
*bs
;
1286 QEMUSnapshotInfo old_sn
, *sn
;
1289 BlockdevSnapshotInternal
*internal
;
1290 InternalSnapshotState
*state
;
1291 AioContext
*aio_context
;
1294 g_assert(common
->action
->type
==
1295 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1296 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1297 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1299 /* 1. parse input */
1300 device
= internal
->device
;
1301 name
= internal
->name
;
1303 /* 2. check for validation */
1304 if (action_check_completion_mode(common
, errp
) < 0) {
1308 bs
= qmp_get_root_bs(device
, errp
);
1313 aio_context
= bdrv_get_aio_context(bs
);
1314 aio_context_acquire(aio_context
);
1318 /* Paired with .clean() */
1319 bdrv_drained_begin(bs
);
1321 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1325 if (bdrv_is_read_only(bs
)) {
1326 error_setg(errp
, "Device '%s' is read only", device
);
1330 if (!bdrv_can_snapshot(bs
)) {
1331 error_setg(errp
, "Block format '%s' used by device '%s' "
1332 "does not support internal snapshots",
1333 bs
->drv
->format_name
, device
);
1337 if (!strlen(name
)) {
1338 error_setg(errp
, "Name is empty");
1342 /* check whether a snapshot with name exist */
1343 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1346 error_propagate(errp
, local_err
);
1350 "Snapshot with name '%s' already exists on device '%s'",
1355 /* 3. take the snapshot */
1357 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1358 qemu_gettimeofday(&tv
);
1359 sn
->date_sec
= tv
.tv_sec
;
1360 sn
->date_nsec
= tv
.tv_usec
* 1000;
1361 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1363 ret1
= bdrv_snapshot_create(bs
, sn
);
1365 error_setg_errno(errp
, -ret1
,
1366 "Failed to create snapshot '%s' on device '%s'",
1371 /* 4. succeed, mark a snapshot is created */
1372 state
->created
= true;
1375 aio_context_release(aio_context
);
1378 static void internal_snapshot_abort(BlkActionState
*common
)
1380 InternalSnapshotState
*state
=
1381 DO_UPCAST(InternalSnapshotState
, common
, common
);
1382 BlockDriverState
*bs
= state
->bs
;
1383 QEMUSnapshotInfo
*sn
= &state
->sn
;
1384 AioContext
*aio_context
;
1385 Error
*local_error
= NULL
;
1387 if (!state
->created
) {
1391 aio_context
= bdrv_get_aio_context(state
->bs
);
1392 aio_context_acquire(aio_context
);
1394 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1395 error_reportf_err(local_error
,
1396 "Failed to delete snapshot with id '%s' and "
1397 "name '%s' on device '%s' in abort: ",
1398 sn
->id_str
, sn
->name
,
1399 bdrv_get_device_name(bs
));
1402 aio_context_release(aio_context
);
1405 static void internal_snapshot_clean(BlkActionState
*common
)
1407 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1409 AioContext
*aio_context
;
1415 aio_context
= bdrv_get_aio_context(state
->bs
);
1416 aio_context_acquire(aio_context
);
1418 bdrv_drained_end(state
->bs
);
1420 aio_context_release(aio_context
);
1423 /* external snapshot private data */
1424 typedef struct ExternalSnapshotState
{
1425 BlkActionState common
;
1426 BlockDriverState
*old_bs
;
1427 BlockDriverState
*new_bs
;
1428 bool overlay_appended
;
1429 } ExternalSnapshotState
;
1431 static void external_snapshot_prepare(BlkActionState
*common
,
1435 QDict
*options
= NULL
;
1436 Error
*local_err
= NULL
;
1437 /* Device and node name of the image to generate the snapshot from */
1439 const char *node_name
;
1440 /* Reference to the new image (for 'blockdev-snapshot') */
1441 const char *snapshot_ref
;
1442 /* File name of the new image (for 'blockdev-snapshot-sync') */
1443 const char *new_image_file
;
1444 ExternalSnapshotState
*state
=
1445 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1446 TransactionAction
*action
= common
->action
;
1447 AioContext
*aio_context
;
1448 uint64_t perm
, shared
;
1450 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1451 * purpose but a different set of parameters */
1452 switch (action
->type
) {
1453 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1455 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1457 node_name
= s
->node
;
1458 new_image_file
= NULL
;
1459 snapshot_ref
= s
->overlay
;
1462 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1464 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1465 device
= s
->has_device
? s
->device
: NULL
;
1466 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1467 new_image_file
= s
->snapshot_file
;
1468 snapshot_ref
= NULL
;
1472 g_assert_not_reached();
1475 /* start processing */
1476 if (action_check_completion_mode(common
, errp
) < 0) {
1480 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1481 if (!state
->old_bs
) {
1485 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1486 aio_context_acquire(aio_context
);
1488 /* Paired with .clean() */
1489 bdrv_drained_begin(state
->old_bs
);
1491 if (!bdrv_is_inserted(state
->old_bs
)) {
1492 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1496 if (bdrv_op_is_blocked(state
->old_bs
,
1497 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1501 if (!bdrv_is_read_only(state
->old_bs
)) {
1502 if (bdrv_flush(state
->old_bs
)) {
1503 error_setg(errp
, QERR_IO_ERROR
);
1508 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1509 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1510 const char *format
= s
->has_format
? s
->format
: "qcow2";
1511 enum NewImageMode mode
;
1512 const char *snapshot_node_name
=
1513 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1515 if (node_name
&& !snapshot_node_name
) {
1516 error_setg(errp
, "New overlay node name missing");
1520 if (snapshot_node_name
&&
1521 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1522 error_setg(errp
, "New overlay node name already in use");
1526 flags
= state
->old_bs
->open_flags
;
1527 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_COPY_ON_READ
);
1528 flags
|= BDRV_O_NO_BACKING
;
1530 /* create new image w/backing file */
1531 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1532 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1533 int64_t size
= bdrv_getlength(state
->old_bs
);
1535 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1538 bdrv_refresh_filename(state
->old_bs
);
1539 bdrv_img_create(new_image_file
, format
,
1540 state
->old_bs
->filename
,
1541 state
->old_bs
->drv
->format_name
,
1542 NULL
, size
, flags
, false, &local_err
);
1544 error_propagate(errp
, local_err
);
1549 options
= qdict_new();
1550 if (snapshot_node_name
) {
1551 qdict_put_str(options
, "node-name", snapshot_node_name
);
1553 qdict_put_str(options
, "driver", format
);
1556 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1558 /* We will manually add the backing_hd field to the bs later */
1559 if (!state
->new_bs
) {
1564 * Allow attaching a backing file to an overlay that's already in use only
1565 * if the parents don't assume that they are already seeing a valid image.
1566 * (Specifically, allow it as a mirror target, which is write-only access.)
1568 bdrv_get_cumulative_perm(state
->new_bs
, &perm
, &shared
);
1569 if (perm
& BLK_PERM_CONSISTENT_READ
) {
1570 error_setg(errp
, "The overlay is already in use");
1574 if (state
->new_bs
->backing
!= NULL
) {
1575 error_setg(errp
, "The overlay already has a backing image");
1579 if (!state
->new_bs
->drv
->supports_backing
) {
1580 error_setg(errp
, "The overlay does not support backing images");
1584 /* This removes our old bs and adds the new bs. This is an operation that
1585 * can fail, so we need to do it in .prepare; undoing it for abort is
1586 * always possible. */
1587 bdrv_ref(state
->new_bs
);
1588 bdrv_append(state
->new_bs
, state
->old_bs
, &local_err
);
1590 error_propagate(errp
, local_err
);
1593 state
->overlay_appended
= true;
1596 aio_context_release(aio_context
);
1599 static void external_snapshot_commit(BlkActionState
*common
)
1601 ExternalSnapshotState
*state
=
1602 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1603 AioContext
*aio_context
;
1605 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1606 aio_context_acquire(aio_context
);
1608 /* We don't need (or want) to use the transactional
1609 * bdrv_reopen_multiple() across all the entries at once, because we
1610 * don't want to abort all of them if one of them fails the reopen */
1611 if (!atomic_read(&state
->old_bs
->copy_on_read
)) {
1612 bdrv_reopen_set_read_only(state
->old_bs
, true, NULL
);
1615 aio_context_release(aio_context
);
1618 static void external_snapshot_abort(BlkActionState
*common
)
1620 ExternalSnapshotState
*state
=
1621 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1622 if (state
->new_bs
) {
1623 if (state
->overlay_appended
) {
1624 AioContext
*aio_context
;
1625 AioContext
*tmp_context
;
1628 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1629 aio_context_acquire(aio_context
);
1631 bdrv_ref(state
->old_bs
); /* we can't let bdrv_set_backind_hd()
1632 close state->old_bs; we need it */
1633 bdrv_set_backing_hd(state
->new_bs
, NULL
, &error_abort
);
1636 * The call to bdrv_set_backing_hd() above returns state->old_bs to
1637 * the main AioContext. As we're still going to be using it, return
1638 * it to the AioContext it was before.
1640 tmp_context
= bdrv_get_aio_context(state
->old_bs
);
1641 if (aio_context
!= tmp_context
) {
1642 aio_context_release(aio_context
);
1643 aio_context_acquire(tmp_context
);
1645 ret
= bdrv_try_set_aio_context(state
->old_bs
,
1649 aio_context_release(tmp_context
);
1650 aio_context_acquire(aio_context
);
1653 bdrv_replace_node(state
->new_bs
, state
->old_bs
, &error_abort
);
1654 bdrv_unref(state
->old_bs
); /* bdrv_replace_node() ref'ed old_bs */
1656 aio_context_release(aio_context
);
1661 static void external_snapshot_clean(BlkActionState
*common
)
1663 ExternalSnapshotState
*state
=
1664 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1665 AioContext
*aio_context
;
1667 if (!state
->old_bs
) {
1671 aio_context
= bdrv_get_aio_context(state
->old_bs
);
1672 aio_context_acquire(aio_context
);
1674 bdrv_drained_end(state
->old_bs
);
1675 bdrv_unref(state
->new_bs
);
1677 aio_context_release(aio_context
);
1680 typedef struct DriveBackupState
{
1681 BlkActionState common
;
1682 BlockDriverState
*bs
;
1686 static BlockJob
*do_backup_common(BackupCommon
*backup
,
1687 BlockDriverState
*bs
,
1688 BlockDriverState
*target_bs
,
1689 AioContext
*aio_context
,
1690 JobTxn
*txn
, Error
**errp
);
1692 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1694 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1695 DriveBackup
*backup
;
1696 BlockDriverState
*bs
;
1697 BlockDriverState
*target_bs
;
1698 BlockDriverState
*source
= NULL
;
1699 AioContext
*aio_context
;
1700 AioContext
*old_context
;
1702 Error
*local_err
= NULL
;
1705 bool set_backing_hd
= false;
1708 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1709 backup
= common
->action
->u
.drive_backup
.data
;
1711 if (!backup
->has_mode
) {
1712 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1715 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1721 error_setg(errp
, "Device has no medium");
1725 aio_context
= bdrv_get_aio_context(bs
);
1726 aio_context_acquire(aio_context
);
1728 /* Paired with .clean() */
1729 bdrv_drained_begin(bs
);
1731 if (!backup
->has_format
) {
1732 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
1733 NULL
: (char *) bs
->drv
->format_name
;
1736 /* Early check to avoid creating target */
1737 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
1741 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1744 * See if we have a backing HD we can use to create our new image
1747 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
1748 source
= backing_bs(bs
);
1750 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
1753 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
1755 flags
|= BDRV_O_NO_BACKING
;
1756 set_backing_hd
= true;
1759 size
= bdrv_getlength(bs
);
1761 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1765 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
1766 assert(backup
->format
);
1768 bdrv_refresh_filename(source
);
1769 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
1770 source
->drv
->format_name
, NULL
,
1771 size
, flags
, false, &local_err
);
1773 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
1774 size
, flags
, false, &local_err
);
1779 error_propagate(errp
, local_err
);
1783 options
= qdict_new();
1784 qdict_put_str(options
, "discard", "unmap");
1785 qdict_put_str(options
, "detect-zeroes", "unmap");
1786 if (backup
->format
) {
1787 qdict_put_str(options
, "driver", backup
->format
);
1790 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
1795 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
1796 old_context
= bdrv_get_aio_context(target_bs
);
1797 aio_context_release(aio_context
);
1798 aio_context_acquire(old_context
);
1800 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
1802 bdrv_unref(target_bs
);
1803 aio_context_release(old_context
);
1807 aio_context_release(old_context
);
1808 aio_context_acquire(aio_context
);
1810 if (set_backing_hd
) {
1811 bdrv_set_backing_hd(target_bs
, source
, &local_err
);
1819 state
->job
= do_backup_common(qapi_DriveBackup_base(backup
),
1820 bs
, target_bs
, aio_context
,
1821 common
->block_job_txn
, errp
);
1824 bdrv_unref(target_bs
);
1826 aio_context_release(aio_context
);
1829 static void drive_backup_commit(BlkActionState
*common
)
1831 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1832 AioContext
*aio_context
;
1834 aio_context
= bdrv_get_aio_context(state
->bs
);
1835 aio_context_acquire(aio_context
);
1838 job_start(&state
->job
->job
);
1840 aio_context_release(aio_context
);
1843 static void drive_backup_abort(BlkActionState
*common
)
1845 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1848 AioContext
*aio_context
;
1850 aio_context
= bdrv_get_aio_context(state
->bs
);
1851 aio_context_acquire(aio_context
);
1853 job_cancel_sync(&state
->job
->job
);
1855 aio_context_release(aio_context
);
1859 static void drive_backup_clean(BlkActionState
*common
)
1861 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1862 AioContext
*aio_context
;
1868 aio_context
= bdrv_get_aio_context(state
->bs
);
1869 aio_context_acquire(aio_context
);
1871 bdrv_drained_end(state
->bs
);
1873 aio_context_release(aio_context
);
1876 typedef struct BlockdevBackupState
{
1877 BlkActionState common
;
1878 BlockDriverState
*bs
;
1880 } BlockdevBackupState
;
1882 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1884 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1885 BlockdevBackup
*backup
;
1886 BlockDriverState
*bs
;
1887 BlockDriverState
*target_bs
;
1888 AioContext
*aio_context
;
1889 AioContext
*old_context
;
1892 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1893 backup
= common
->action
->u
.blockdev_backup
.data
;
1895 bs
= bdrv_lookup_bs(backup
->device
, backup
->device
, errp
);
1900 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1905 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
1906 aio_context
= bdrv_get_aio_context(bs
);
1907 old_context
= bdrv_get_aio_context(target_bs
);
1908 aio_context_acquire(old_context
);
1910 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
1912 aio_context_release(old_context
);
1916 aio_context_release(old_context
);
1917 aio_context_acquire(aio_context
);
1920 /* Paired with .clean() */
1921 bdrv_drained_begin(state
->bs
);
1923 state
->job
= do_backup_common(qapi_BlockdevBackup_base(backup
),
1924 bs
, target_bs
, aio_context
,
1925 common
->block_job_txn
, errp
);
1927 aio_context_release(aio_context
);
1930 static void blockdev_backup_commit(BlkActionState
*common
)
1932 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1933 AioContext
*aio_context
;
1935 aio_context
= bdrv_get_aio_context(state
->bs
);
1936 aio_context_acquire(aio_context
);
1939 job_start(&state
->job
->job
);
1941 aio_context_release(aio_context
);
1944 static void blockdev_backup_abort(BlkActionState
*common
)
1946 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1949 AioContext
*aio_context
;
1951 aio_context
= bdrv_get_aio_context(state
->bs
);
1952 aio_context_acquire(aio_context
);
1954 job_cancel_sync(&state
->job
->job
);
1956 aio_context_release(aio_context
);
1960 static void blockdev_backup_clean(BlkActionState
*common
)
1962 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1963 AioContext
*aio_context
;
1969 aio_context
= bdrv_get_aio_context(state
->bs
);
1970 aio_context_acquire(aio_context
);
1972 bdrv_drained_end(state
->bs
);
1974 aio_context_release(aio_context
);
1977 typedef struct BlockDirtyBitmapState
{
1978 BlkActionState common
;
1979 BdrvDirtyBitmap
*bitmap
;
1980 BlockDriverState
*bs
;
1984 } BlockDirtyBitmapState
;
1986 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1989 Error
*local_err
= NULL
;
1990 BlockDirtyBitmapAdd
*action
;
1991 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1994 if (action_check_completion_mode(common
, errp
) < 0) {
1998 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1999 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2000 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
2001 action
->has_granularity
, action
->granularity
,
2002 action
->has_persistent
, action
->persistent
,
2003 action
->has_disabled
, action
->disabled
,
2007 state
->prepared
= true;
2009 error_propagate(errp
, local_err
);
2013 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
2015 BlockDirtyBitmapAdd
*action
;
2016 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2019 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
2020 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2021 * then the node reference and bitmap name must have been valid.
2023 if (state
->prepared
) {
2024 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
2028 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
2031 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2033 BlockDirtyBitmap
*action
;
2035 if (action_check_completion_mode(common
, errp
) < 0) {
2039 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2040 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2044 if (!state
->bitmap
) {
2048 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_DEFAULT
, errp
)) {
2052 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2055 static void block_dirty_bitmap_restore(BlkActionState
*common
)
2057 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2060 if (state
->backup
) {
2061 bdrv_restore_dirty_bitmap(state
->bitmap
, state
->backup
);
2065 static void block_dirty_bitmap_free_backup(BlkActionState
*common
)
2067 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2070 hbitmap_free(state
->backup
);
2073 static void block_dirty_bitmap_enable_prepare(BlkActionState
*common
,
2076 BlockDirtyBitmap
*action
;
2077 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2080 if (action_check_completion_mode(common
, errp
) < 0) {
2084 action
= common
->action
->u
.block_dirty_bitmap_enable
.data
;
2085 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2089 if (!state
->bitmap
) {
2093 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2097 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2098 bdrv_enable_dirty_bitmap(state
->bitmap
);
2101 static void block_dirty_bitmap_enable_abort(BlkActionState
*common
)
2103 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2106 if (!state
->was_enabled
) {
2107 bdrv_disable_dirty_bitmap(state
->bitmap
);
2111 static void block_dirty_bitmap_disable_prepare(BlkActionState
*common
,
2114 BlockDirtyBitmap
*action
;
2115 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2118 if (action_check_completion_mode(common
, errp
) < 0) {
2122 action
= common
->action
->u
.block_dirty_bitmap_disable
.data
;
2123 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2127 if (!state
->bitmap
) {
2131 if (bdrv_dirty_bitmap_check(state
->bitmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2135 state
->was_enabled
= bdrv_dirty_bitmap_enabled(state
->bitmap
);
2136 bdrv_disable_dirty_bitmap(state
->bitmap
);
2139 static void block_dirty_bitmap_disable_abort(BlkActionState
*common
)
2141 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2144 if (state
->was_enabled
) {
2145 bdrv_enable_dirty_bitmap(state
->bitmap
);
2149 static void block_dirty_bitmap_merge_prepare(BlkActionState
*common
,
2152 BlockDirtyBitmapMerge
*action
;
2153 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2156 if (action_check_completion_mode(common
, errp
) < 0) {
2160 action
= common
->action
->u
.block_dirty_bitmap_merge
.data
;
2162 state
->bitmap
= block_dirty_bitmap_merge(action
->node
, action
->target
,
2163 action
->bitmaps
, &state
->backup
,
2167 static void block_dirty_bitmap_remove_prepare(BlkActionState
*common
,
2170 BlockDirtyBitmap
*action
;
2171 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2174 if (action_check_completion_mode(common
, errp
) < 0) {
2178 action
= common
->action
->u
.block_dirty_bitmap_remove
.data
;
2180 state
->bitmap
= block_dirty_bitmap_remove(action
->node
, action
->name
,
2181 false, &state
->bs
, errp
);
2182 if (state
->bitmap
) {
2183 bdrv_dirty_bitmap_skip_store(state
->bitmap
, true);
2184 bdrv_dirty_bitmap_set_busy(state
->bitmap
, true);
2188 static void block_dirty_bitmap_remove_abort(BlkActionState
*common
)
2190 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2193 if (state
->bitmap
) {
2194 bdrv_dirty_bitmap_skip_store(state
->bitmap
, false);
2195 bdrv_dirty_bitmap_set_busy(state
->bitmap
, false);
2199 static void block_dirty_bitmap_remove_commit(BlkActionState
*common
)
2201 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2204 bdrv_dirty_bitmap_set_busy(state
->bitmap
, false);
2205 bdrv_release_dirty_bitmap(state
->bitmap
);
2208 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2210 error_setg(errp
, "Transaction aborted using Abort action");
2213 static void abort_commit(BlkActionState
*common
)
2215 g_assert_not_reached(); /* this action never succeeds */
2218 static const BlkActionOps actions
[] = {
2219 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2220 .instance_size
= sizeof(ExternalSnapshotState
),
2221 .prepare
= external_snapshot_prepare
,
2222 .commit
= external_snapshot_commit
,
2223 .abort
= external_snapshot_abort
,
2224 .clean
= external_snapshot_clean
,
2226 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2227 .instance_size
= sizeof(ExternalSnapshotState
),
2228 .prepare
= external_snapshot_prepare
,
2229 .commit
= external_snapshot_commit
,
2230 .abort
= external_snapshot_abort
,
2231 .clean
= external_snapshot_clean
,
2233 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2234 .instance_size
= sizeof(DriveBackupState
),
2235 .prepare
= drive_backup_prepare
,
2236 .commit
= drive_backup_commit
,
2237 .abort
= drive_backup_abort
,
2238 .clean
= drive_backup_clean
,
2240 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2241 .instance_size
= sizeof(BlockdevBackupState
),
2242 .prepare
= blockdev_backup_prepare
,
2243 .commit
= blockdev_backup_commit
,
2244 .abort
= blockdev_backup_abort
,
2245 .clean
= blockdev_backup_clean
,
2247 [TRANSACTION_ACTION_KIND_ABORT
] = {
2248 .instance_size
= sizeof(BlkActionState
),
2249 .prepare
= abort_prepare
,
2250 .commit
= abort_commit
,
2252 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2253 .instance_size
= sizeof(InternalSnapshotState
),
2254 .prepare
= internal_snapshot_prepare
,
2255 .abort
= internal_snapshot_abort
,
2256 .clean
= internal_snapshot_clean
,
2258 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2259 .instance_size
= sizeof(BlockDirtyBitmapState
),
2260 .prepare
= block_dirty_bitmap_add_prepare
,
2261 .abort
= block_dirty_bitmap_add_abort
,
2263 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2264 .instance_size
= sizeof(BlockDirtyBitmapState
),
2265 .prepare
= block_dirty_bitmap_clear_prepare
,
2266 .commit
= block_dirty_bitmap_free_backup
,
2267 .abort
= block_dirty_bitmap_restore
,
2269 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE
] = {
2270 .instance_size
= sizeof(BlockDirtyBitmapState
),
2271 .prepare
= block_dirty_bitmap_enable_prepare
,
2272 .abort
= block_dirty_bitmap_enable_abort
,
2274 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE
] = {
2275 .instance_size
= sizeof(BlockDirtyBitmapState
),
2276 .prepare
= block_dirty_bitmap_disable_prepare
,
2277 .abort
= block_dirty_bitmap_disable_abort
,
2279 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE
] = {
2280 .instance_size
= sizeof(BlockDirtyBitmapState
),
2281 .prepare
= block_dirty_bitmap_merge_prepare
,
2282 .commit
= block_dirty_bitmap_free_backup
,
2283 .abort
= block_dirty_bitmap_restore
,
2285 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE
] = {
2286 .instance_size
= sizeof(BlockDirtyBitmapState
),
2287 .prepare
= block_dirty_bitmap_remove_prepare
,
2288 .commit
= block_dirty_bitmap_remove_commit
,
2289 .abort
= block_dirty_bitmap_remove_abort
,
2291 /* Where are transactions for MIRROR, COMMIT and STREAM?
2292 * Although these blockjobs use transaction callbacks like the backup job,
2293 * these jobs do not necessarily adhere to transaction semantics.
2294 * These jobs may not fully undo all of their actions on abort, nor do they
2295 * necessarily work in transactions with more than one job in them.
2300 * Allocate a TransactionProperties structure if necessary, and fill
2301 * that structure with desired defaults if they are unset.
2303 static TransactionProperties
*get_transaction_properties(
2304 TransactionProperties
*props
)
2307 props
= g_new0(TransactionProperties
, 1);
2310 if (!props
->has_completion_mode
) {
2311 props
->has_completion_mode
= true;
2312 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2319 * 'Atomic' group operations. The operations are performed as a set, and if
2320 * any fail then we roll back all operations in the group.
2322 void qmp_transaction(TransactionActionList
*dev_list
,
2324 struct TransactionProperties
*props
,
2327 TransactionActionList
*dev_entry
= dev_list
;
2328 JobTxn
*block_job_txn
= NULL
;
2329 BlkActionState
*state
, *next
;
2330 Error
*local_err
= NULL
;
2332 QTAILQ_HEAD(, BlkActionState
) snap_bdrv_states
;
2333 QTAILQ_INIT(&snap_bdrv_states
);
2335 /* Does this transaction get canceled as a group on failure?
2336 * If not, we don't really need to make a JobTxn.
2338 props
= get_transaction_properties(props
);
2339 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2340 block_job_txn
= job_txn_new();
2343 /* drain all i/o before any operations */
2346 /* We don't do anything in this loop that commits us to the operations */
2347 while (NULL
!= dev_entry
) {
2348 TransactionAction
*dev_info
= NULL
;
2349 const BlkActionOps
*ops
;
2351 dev_info
= dev_entry
->value
;
2352 dev_entry
= dev_entry
->next
;
2354 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2356 ops
= &actions
[dev_info
->type
];
2357 assert(ops
->instance_size
> 0);
2359 state
= g_malloc0(ops
->instance_size
);
2361 state
->action
= dev_info
;
2362 state
->block_job_txn
= block_job_txn
;
2363 state
->txn_props
= props
;
2364 QTAILQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2366 state
->ops
->prepare(state
, &local_err
);
2368 error_propagate(errp
, local_err
);
2369 goto delete_and_fail
;
2373 QTAILQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2374 if (state
->ops
->commit
) {
2375 state
->ops
->commit(state
);
2383 /* failure, and it is all-or-none; roll back all operations */
2384 QTAILQ_FOREACH_REVERSE(state
, &snap_bdrv_states
, entry
) {
2385 if (state
->ops
->abort
) {
2386 state
->ops
->abort(state
);
2390 QTAILQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2391 if (state
->ops
->clean
) {
2392 state
->ops
->clean(state
);
2397 qapi_free_TransactionProperties(props
);
2399 job_txn_unref(block_job_txn
);
2402 void qmp_block_passwd(bool has_device
, const char *device
,
2403 bool has_node_name
, const char *node_name
,
2404 const char *password
, Error
**errp
)
2407 "Setting block passwords directly is no longer supported");
2410 BlockDirtyBitmapSha256
*qmp_x_debug_block_dirty_bitmap_sha256(const char *node
,
2414 BdrvDirtyBitmap
*bitmap
;
2415 BlockDriverState
*bs
;
2416 BlockDirtyBitmapSha256
*ret
= NULL
;
2419 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, errp
);
2420 if (!bitmap
|| !bs
) {
2424 sha256
= bdrv_dirty_bitmap_sha256(bitmap
, errp
);
2425 if (sha256
== NULL
) {
2429 ret
= g_new(BlockDirtyBitmapSha256
, 1);
2430 ret
->sha256
= sha256
;
2435 void qmp_block_resize(bool has_device
, const char *device
,
2436 bool has_node_name
, const char *node_name
,
2437 int64_t size
, Error
**errp
)
2439 Error
*local_err
= NULL
;
2440 BlockBackend
*blk
= NULL
;
2441 BlockDriverState
*bs
;
2442 AioContext
*aio_context
;
2444 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2445 has_node_name
? node_name
: NULL
,
2448 error_propagate(errp
, local_err
);
2452 aio_context
= bdrv_get_aio_context(bs
);
2453 aio_context_acquire(aio_context
);
2456 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2460 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2461 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2465 blk
= blk_new_with_bs(bs
, BLK_PERM_RESIZE
, BLK_PERM_ALL
, errp
);
2470 bdrv_drained_begin(bs
);
2471 blk_truncate(blk
, size
, false, PREALLOC_MODE_OFF
, 0, errp
);
2472 bdrv_drained_end(bs
);
2476 aio_context_release(aio_context
);
2479 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
2480 bool has_base
, const char *base
,
2481 bool has_base_node
, const char *base_node
,
2482 bool has_backing_file
, const char *backing_file
,
2483 bool has_speed
, int64_t speed
,
2484 bool has_on_error
, BlockdevOnError on_error
,
2485 bool has_auto_finalize
, bool auto_finalize
,
2486 bool has_auto_dismiss
, bool auto_dismiss
,
2489 BlockDriverState
*bs
, *iter
;
2490 BlockDriverState
*base_bs
= NULL
;
2491 AioContext
*aio_context
;
2492 Error
*local_err
= NULL
;
2493 const char *base_name
= NULL
;
2494 int job_flags
= JOB_DEFAULT
;
2496 if (!has_on_error
) {
2497 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2500 bs
= bdrv_lookup_bs(device
, device
, errp
);
2505 aio_context
= bdrv_get_aio_context(bs
);
2506 aio_context_acquire(aio_context
);
2508 if (has_base
&& has_base_node
) {
2509 error_setg(errp
, "'base' and 'base-node' cannot be specified "
2510 "at the same time");
2515 base_bs
= bdrv_find_backing_image(bs
, base
);
2516 if (base_bs
== NULL
) {
2517 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
2520 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2524 if (has_base_node
) {
2525 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
2529 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
2530 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
2534 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2535 bdrv_refresh_filename(base_bs
);
2536 base_name
= base_bs
->filename
;
2539 /* Check for op blockers in the whole chain between bs and base */
2540 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
2541 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
2546 /* if we are streaming the entire chain, the result will have no backing
2547 * file, and specifying one is therefore an error */
2548 if (base_bs
== NULL
&& has_backing_file
) {
2549 error_setg(errp
, "backing file specified, but streaming the "
2554 /* backing_file string overrides base bs filename */
2555 base_name
= has_backing_file
? backing_file
: base_name
;
2557 if (has_auto_finalize
&& !auto_finalize
) {
2558 job_flags
|= JOB_MANUAL_FINALIZE
;
2560 if (has_auto_dismiss
&& !auto_dismiss
) {
2561 job_flags
|= JOB_MANUAL_DISMISS
;
2564 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
2565 job_flags
, has_speed
? speed
: 0, on_error
, &local_err
);
2567 error_propagate(errp
, local_err
);
2571 trace_qmp_block_stream(bs
);
2574 aio_context_release(aio_context
);
2577 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
2578 bool has_base_node
, const char *base_node
,
2579 bool has_base
, const char *base
,
2580 bool has_top_node
, const char *top_node
,
2581 bool has_top
, const char *top
,
2582 bool has_backing_file
, const char *backing_file
,
2583 bool has_speed
, int64_t speed
,
2584 bool has_on_error
, BlockdevOnError on_error
,
2585 bool has_filter_node_name
, const char *filter_node_name
,
2586 bool has_auto_finalize
, bool auto_finalize
,
2587 bool has_auto_dismiss
, bool auto_dismiss
,
2590 BlockDriverState
*bs
;
2591 BlockDriverState
*iter
;
2592 BlockDriverState
*base_bs
, *top_bs
;
2593 AioContext
*aio_context
;
2594 Error
*local_err
= NULL
;
2595 int job_flags
= JOB_DEFAULT
;
2600 if (!has_on_error
) {
2601 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2603 if (!has_filter_node_name
) {
2604 filter_node_name
= NULL
;
2606 if (has_auto_finalize
&& !auto_finalize
) {
2607 job_flags
|= JOB_MANUAL_FINALIZE
;
2609 if (has_auto_dismiss
&& !auto_dismiss
) {
2610 job_flags
|= JOB_MANUAL_DISMISS
;
2614 * libvirt relies on the DeviceNotFound error class in order to probe for
2615 * live commit feature versions; for this to work, we must make sure to
2616 * perform the device lookup before any generic errors that may occur in a
2617 * scenario in which all optional arguments are omitted. */
2618 bs
= qmp_get_root_bs(device
, &local_err
);
2620 bs
= bdrv_lookup_bs(device
, device
, NULL
);
2622 error_free(local_err
);
2623 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
2624 "Device '%s' not found", device
);
2626 error_propagate(errp
, local_err
);
2631 aio_context
= bdrv_get_aio_context(bs
);
2632 aio_context_acquire(aio_context
);
2634 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
2638 /* default top_bs is the active layer */
2641 if (has_top_node
&& has_top
) {
2642 error_setg(errp
, "'top-node' and 'top' are mutually exclusive");
2644 } else if (has_top_node
) {
2645 top_bs
= bdrv_lookup_bs(NULL
, top_node
, errp
);
2646 if (top_bs
== NULL
) {
2649 if (!bdrv_chain_contains(bs
, top_bs
)) {
2650 error_setg(errp
, "'%s' is not in this backing file chain",
2654 } else if (has_top
&& top
) {
2655 /* This strcmp() is just a shortcut, there is no need to
2656 * refresh @bs's filename. If it mismatches,
2657 * bdrv_find_backing_image() will do the refresh and may still
2659 if (strcmp(bs
->filename
, top
) != 0) {
2660 top_bs
= bdrv_find_backing_image(bs
, top
);
2664 if (top_bs
== NULL
) {
2665 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
2669 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
2671 if (has_base_node
&& has_base
) {
2672 error_setg(errp
, "'base-node' and 'base' are mutually exclusive");
2674 } else if (has_base_node
) {
2675 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
2676 if (base_bs
== NULL
) {
2679 if (!bdrv_chain_contains(top_bs
, base_bs
)) {
2680 error_setg(errp
, "'%s' is not in this backing file chain",
2684 } else if (has_base
&& base
) {
2685 base_bs
= bdrv_find_backing_image(top_bs
, base
);
2687 base_bs
= bdrv_find_base(top_bs
);
2690 if (base_bs
== NULL
) {
2691 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
2695 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2697 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
2698 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
2703 /* Do not allow attempts to commit an image into itself */
2704 if (top_bs
== base_bs
) {
2705 error_setg(errp
, "cannot commit an image into itself");
2710 if (has_backing_file
) {
2711 error_setg(errp
, "'backing-file' specified,"
2712 " but 'top' is the active layer");
2715 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
2716 job_flags
, speed
, on_error
,
2717 filter_node_name
, NULL
, NULL
, false, &local_err
);
2719 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
2720 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
2723 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, job_flags
,
2724 speed
, on_error
, has_backing_file
? backing_file
: NULL
,
2725 filter_node_name
, &local_err
);
2727 if (local_err
!= NULL
) {
2728 error_propagate(errp
, local_err
);
2733 aio_context_release(aio_context
);
2736 /* Common QMP interface for drive-backup and blockdev-backup */
2737 static BlockJob
*do_backup_common(BackupCommon
*backup
,
2738 BlockDriverState
*bs
,
2739 BlockDriverState
*target_bs
,
2740 AioContext
*aio_context
,
2741 JobTxn
*txn
, Error
**errp
)
2743 BlockJob
*job
= NULL
;
2744 BdrvDirtyBitmap
*bmap
= NULL
;
2745 int job_flags
= JOB_DEFAULT
;
2747 if (!backup
->has_speed
) {
2750 if (!backup
->has_on_source_error
) {
2751 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2753 if (!backup
->has_on_target_error
) {
2754 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2756 if (!backup
->has_job_id
) {
2757 backup
->job_id
= NULL
;
2759 if (!backup
->has_auto_finalize
) {
2760 backup
->auto_finalize
= true;
2762 if (!backup
->has_auto_dismiss
) {
2763 backup
->auto_dismiss
= true;
2765 if (!backup
->has_compress
) {
2766 backup
->compress
= false;
2769 if ((backup
->sync
== MIRROR_SYNC_MODE_BITMAP
) ||
2770 (backup
->sync
== MIRROR_SYNC_MODE_INCREMENTAL
)) {
2771 /* done before desugaring 'incremental' to print the right message */
2772 if (!backup
->has_bitmap
) {
2773 error_setg(errp
, "must provide a valid bitmap name for "
2774 "'%s' sync mode", MirrorSyncMode_str(backup
->sync
));
2779 if (backup
->sync
== MIRROR_SYNC_MODE_INCREMENTAL
) {
2780 if (backup
->has_bitmap_mode
&&
2781 backup
->bitmap_mode
!= BITMAP_SYNC_MODE_ON_SUCCESS
) {
2782 error_setg(errp
, "Bitmap sync mode must be '%s' "
2783 "when using sync mode '%s'",
2784 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS
),
2785 MirrorSyncMode_str(backup
->sync
));
2788 backup
->has_bitmap_mode
= true;
2789 backup
->sync
= MIRROR_SYNC_MODE_BITMAP
;
2790 backup
->bitmap_mode
= BITMAP_SYNC_MODE_ON_SUCCESS
;
2793 if (backup
->has_bitmap
) {
2794 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
2796 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
2799 if (!backup
->has_bitmap_mode
) {
2800 error_setg(errp
, "Bitmap sync mode must be given "
2801 "when providing a bitmap");
2804 if (bdrv_dirty_bitmap_check(bmap
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
2808 /* This does not produce a useful bitmap artifact: */
2809 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
2810 error_setg(errp
, "sync mode '%s' does not produce meaningful bitmap"
2811 " outputs", MirrorSyncMode_str(backup
->sync
));
2815 /* If the bitmap isn't used for input or output, this is useless: */
2816 if (backup
->bitmap_mode
== BITMAP_SYNC_MODE_NEVER
&&
2817 backup
->sync
!= MIRROR_SYNC_MODE_BITMAP
) {
2818 error_setg(errp
, "Bitmap sync mode '%s' has no meaningful effect"
2819 " when combined with sync mode '%s'",
2820 BitmapSyncMode_str(backup
->bitmap_mode
),
2821 MirrorSyncMode_str(backup
->sync
));
2826 if (!backup
->has_bitmap
&& backup
->has_bitmap_mode
) {
2827 error_setg(errp
, "Cannot specify bitmap sync mode without a bitmap");
2831 if (!backup
->auto_finalize
) {
2832 job_flags
|= JOB_MANUAL_FINALIZE
;
2834 if (!backup
->auto_dismiss
) {
2835 job_flags
|= JOB_MANUAL_DISMISS
;
2838 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
2839 backup
->sync
, bmap
, backup
->bitmap_mode
,
2841 backup
->filter_node_name
,
2842 backup
->on_source_error
,
2843 backup
->on_target_error
,
2844 job_flags
, NULL
, NULL
, txn
, errp
);
2848 void qmp_drive_backup(DriveBackup
*backup
, Error
**errp
)
2850 TransactionAction action
= {
2851 .type
= TRANSACTION_ACTION_KIND_DRIVE_BACKUP
,
2852 .u
.drive_backup
.data
= backup
,
2854 blockdev_do_action(&action
, errp
);
2857 BlockDeviceInfoList
*qmp_query_named_block_nodes(bool has_flat
,
2861 bool return_flat
= has_flat
&& flat
;
2863 return bdrv_named_nodes_list(return_flat
, errp
);
2866 XDbgBlockGraph
*qmp_x_debug_query_block_graph(Error
**errp
)
2868 return bdrv_get_xdbg_block_graph(errp
);
2871 void qmp_blockdev_backup(BlockdevBackup
*backup
, Error
**errp
)
2873 TransactionAction action
= {
2874 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
,
2875 .u
.blockdev_backup
.data
= backup
,
2877 blockdev_do_action(&action
, errp
);
2880 /* Parameter check and block job starting for drive mirroring.
2881 * Caller should hold @device and @target's aio context (must be the same).
2883 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
2884 BlockDriverState
*target
,
2885 bool has_replaces
, const char *replaces
,
2886 enum MirrorSyncMode sync
,
2887 BlockMirrorBackingMode backing_mode
,
2889 bool has_speed
, int64_t speed
,
2890 bool has_granularity
, uint32_t granularity
,
2891 bool has_buf_size
, int64_t buf_size
,
2892 bool has_on_source_error
,
2893 BlockdevOnError on_source_error
,
2894 bool has_on_target_error
,
2895 BlockdevOnError on_target_error
,
2896 bool has_unmap
, bool unmap
,
2897 bool has_filter_node_name
,
2898 const char *filter_node_name
,
2899 bool has_copy_mode
, MirrorCopyMode copy_mode
,
2900 bool has_auto_finalize
, bool auto_finalize
,
2901 bool has_auto_dismiss
, bool auto_dismiss
,
2904 int job_flags
= JOB_DEFAULT
;
2909 if (!has_on_source_error
) {
2910 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2912 if (!has_on_target_error
) {
2913 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2915 if (!has_granularity
) {
2918 if (!has_buf_size
) {
2924 if (!has_filter_node_name
) {
2925 filter_node_name
= NULL
;
2927 if (!has_copy_mode
) {
2928 copy_mode
= MIRROR_COPY_MODE_BACKGROUND
;
2930 if (has_auto_finalize
&& !auto_finalize
) {
2931 job_flags
|= JOB_MANUAL_FINALIZE
;
2933 if (has_auto_dismiss
&& !auto_dismiss
) {
2934 job_flags
|= JOB_MANUAL_DISMISS
;
2937 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
2938 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
2939 "a value in range [512B, 64MB]");
2942 if (granularity
& (granularity
- 1)) {
2943 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
2948 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
2951 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
2955 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
2956 sync
= MIRROR_SYNC_MODE_FULL
;
2960 BlockDriverState
*to_replace_bs
;
2961 AioContext
*replace_aio_context
;
2962 int64_t bs_size
, replace_size
;
2964 bs_size
= bdrv_getlength(bs
);
2966 error_setg_errno(errp
, -bs_size
, "Failed to query device's size");
2970 to_replace_bs
= check_to_replace_node(bs
, replaces
, errp
);
2971 if (!to_replace_bs
) {
2975 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
2976 aio_context_acquire(replace_aio_context
);
2977 replace_size
= bdrv_getlength(to_replace_bs
);
2978 aio_context_release(replace_aio_context
);
2980 if (replace_size
< 0) {
2981 error_setg_errno(errp
, -replace_size
,
2982 "Failed to query the replacement node's size");
2985 if (bs_size
!= replace_size
) {
2986 error_setg(errp
, "cannot replace image with a mirror image of "
2992 /* pass the node name to replace to mirror start since it's loose coupling
2993 * and will allow to check whether the node still exist at mirror completion
2995 mirror_start(job_id
, bs
, target
,
2996 has_replaces
? replaces
: NULL
, job_flags
,
2997 speed
, granularity
, buf_size
, sync
, backing_mode
, zero_target
,
2998 on_source_error
, on_target_error
, unmap
, filter_node_name
,
3002 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3004 BlockDriverState
*bs
;
3005 BlockDriverState
*source
, *target_bs
;
3006 AioContext
*aio_context
;
3007 AioContext
*old_context
;
3008 BlockMirrorBackingMode backing_mode
;
3009 Error
*local_err
= NULL
;
3010 QDict
*options
= NULL
;
3013 const char *format
= arg
->format
;
3017 bs
= qmp_get_root_bs(arg
->device
, errp
);
3022 /* Early check to avoid creating target */
3023 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3027 aio_context
= bdrv_get_aio_context(bs
);
3028 aio_context_acquire(aio_context
);
3030 if (!arg
->has_mode
) {
3031 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3034 if (!arg
->has_format
) {
3035 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3036 ? NULL
: bs
->drv
->format_name
);
3039 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3040 source
= backing_bs(bs
);
3041 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3042 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3044 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3048 size
= bdrv_getlength(bs
);
3050 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3054 if (arg
->has_replaces
) {
3055 if (!arg
->has_node_name
) {
3056 error_setg(errp
, "a node-name must be provided when replacing a"
3057 " named node of the graph");
3062 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3063 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3065 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3068 /* Don't open backing image in create() */
3069 flags
|= BDRV_O_NO_BACKING
;
3071 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3072 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3074 /* create new image w/o backing file */
3076 bdrv_img_create(arg
->target
, format
,
3077 NULL
, NULL
, NULL
, size
, flags
, false, &local_err
);
3079 switch (arg
->mode
) {
3080 case NEW_IMAGE_MODE_EXISTING
:
3082 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3083 /* create new image with backing file */
3084 bdrv_refresh_filename(source
);
3085 bdrv_img_create(arg
->target
, format
,
3087 source
->drv
->format_name
,
3088 NULL
, size
, flags
, false, &local_err
);
3096 error_propagate(errp
, local_err
);
3100 options
= qdict_new();
3101 if (arg
->has_node_name
) {
3102 qdict_put_str(options
, "node-name", arg
->node_name
);
3105 qdict_put_str(options
, "driver", format
);
3108 /* Mirroring takes care of copy-on-write using the source's backing
3111 target_bs
= bdrv_open(arg
->target
, NULL
, options
, flags
, errp
);
3116 zero_target
= (arg
->sync
== MIRROR_SYNC_MODE_FULL
&&
3117 (arg
->mode
== NEW_IMAGE_MODE_EXISTING
||
3118 !bdrv_has_zero_init(target_bs
)));
3121 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3122 old_context
= bdrv_get_aio_context(target_bs
);
3123 aio_context_release(aio_context
);
3124 aio_context_acquire(old_context
);
3126 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
3128 bdrv_unref(target_bs
);
3129 aio_context_release(old_context
);
3133 aio_context_release(old_context
);
3134 aio_context_acquire(aio_context
);
3136 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3137 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3138 backing_mode
, zero_target
,
3139 arg
->has_speed
, arg
->speed
,
3140 arg
->has_granularity
, arg
->granularity
,
3141 arg
->has_buf_size
, arg
->buf_size
,
3142 arg
->has_on_source_error
, arg
->on_source_error
,
3143 arg
->has_on_target_error
, arg
->on_target_error
,
3144 arg
->has_unmap
, arg
->unmap
,
3146 arg
->has_copy_mode
, arg
->copy_mode
,
3147 arg
->has_auto_finalize
, arg
->auto_finalize
,
3148 arg
->has_auto_dismiss
, arg
->auto_dismiss
,
3150 bdrv_unref(target_bs
);
3151 error_propagate(errp
, local_err
);
3153 aio_context_release(aio_context
);
3156 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3157 const char *device
, const char *target
,
3158 bool has_replaces
, const char *replaces
,
3159 MirrorSyncMode sync
,
3160 bool has_speed
, int64_t speed
,
3161 bool has_granularity
, uint32_t granularity
,
3162 bool has_buf_size
, int64_t buf_size
,
3163 bool has_on_source_error
,
3164 BlockdevOnError on_source_error
,
3165 bool has_on_target_error
,
3166 BlockdevOnError on_target_error
,
3167 bool has_filter_node_name
,
3168 const char *filter_node_name
,
3169 bool has_copy_mode
, MirrorCopyMode copy_mode
,
3170 bool has_auto_finalize
, bool auto_finalize
,
3171 bool has_auto_dismiss
, bool auto_dismiss
,
3174 BlockDriverState
*bs
;
3175 BlockDriverState
*target_bs
;
3176 AioContext
*aio_context
;
3177 AioContext
*old_context
;
3178 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3179 Error
*local_err
= NULL
;
3183 bs
= qmp_get_root_bs(device
, errp
);
3188 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3193 zero_target
= (sync
== MIRROR_SYNC_MODE_FULL
);
3195 /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3196 old_context
= bdrv_get_aio_context(target_bs
);
3197 aio_context
= bdrv_get_aio_context(bs
);
3198 aio_context_acquire(old_context
);
3200 ret
= bdrv_try_set_aio_context(target_bs
, aio_context
, errp
);
3202 aio_context_release(old_context
);
3203 aio_context_acquire(aio_context
);
3209 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3210 has_replaces
, replaces
, sync
, backing_mode
,
3211 zero_target
, has_speed
, speed
,
3212 has_granularity
, granularity
,
3213 has_buf_size
, buf_size
,
3214 has_on_source_error
, on_source_error
,
3215 has_on_target_error
, on_target_error
,
3217 has_filter_node_name
, filter_node_name
,
3218 has_copy_mode
, copy_mode
,
3219 has_auto_finalize
, auto_finalize
,
3220 has_auto_dismiss
, auto_dismiss
,
3222 error_propagate(errp
, local_err
);
3224 aio_context_release(aio_context
);
3227 /* Get a block job using its ID and acquire its AioContext */
3228 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
3235 *aio_context
= NULL
;
3237 job
= block_job_get(id
);
3240 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3241 "Block job '%s' not found", id
);
3245 *aio_context
= blk_get_aio_context(job
->blk
);
3246 aio_context_acquire(*aio_context
);
3251 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3253 AioContext
*aio_context
;
3254 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3260 block_job_set_speed(job
, speed
, errp
);
3261 aio_context_release(aio_context
);
3264 void qmp_block_job_cancel(const char *device
,
3265 bool has_force
, bool force
, Error
**errp
)
3267 AioContext
*aio_context
;
3268 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3278 if (job_user_paused(&job
->job
) && !force
) {
3279 error_setg(errp
, "The block job for device '%s' is currently paused",
3284 trace_qmp_block_job_cancel(job
);
3285 job_user_cancel(&job
->job
, force
, errp
);
3287 aio_context_release(aio_context
);
3290 void qmp_block_job_pause(const char *device
, Error
**errp
)
3292 AioContext
*aio_context
;
3293 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3299 trace_qmp_block_job_pause(job
);
3300 job_user_pause(&job
->job
, errp
);
3301 aio_context_release(aio_context
);
3304 void qmp_block_job_resume(const char *device
, Error
**errp
)
3306 AioContext
*aio_context
;
3307 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3313 trace_qmp_block_job_resume(job
);
3314 job_user_resume(&job
->job
, errp
);
3315 aio_context_release(aio_context
);
3318 void qmp_block_job_complete(const char *device
, Error
**errp
)
3320 AioContext
*aio_context
;
3321 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3327 trace_qmp_block_job_complete(job
);
3328 job_complete(&job
->job
, errp
);
3329 aio_context_release(aio_context
);
3332 void qmp_block_job_finalize(const char *id
, Error
**errp
)
3334 AioContext
*aio_context
;
3335 BlockJob
*job
= find_block_job(id
, &aio_context
, errp
);
3341 trace_qmp_block_job_finalize(job
);
3343 job_finalize(&job
->job
, errp
);
3346 * Job's context might have changed via job_finalize (and job_txn_apply
3347 * automatically acquires the new one), so make sure we release the correct
3350 aio_context
= blk_get_aio_context(job
->blk
);
3351 job_unref(&job
->job
);
3352 aio_context_release(aio_context
);
3355 void qmp_block_job_dismiss(const char *id
, Error
**errp
)
3357 AioContext
*aio_context
;
3358 BlockJob
*bjob
= find_block_job(id
, &aio_context
, errp
);
3365 trace_qmp_block_job_dismiss(bjob
);
3367 job_dismiss(&job
, errp
);
3368 aio_context_release(aio_context
);
3371 void qmp_change_backing_file(const char *device
,
3372 const char *image_node_name
,
3373 const char *backing_file
,
3376 BlockDriverState
*bs
= NULL
;
3377 AioContext
*aio_context
;
3378 BlockDriverState
*image_bs
= NULL
;
3379 Error
*local_err
= NULL
;
3383 bs
= qmp_get_root_bs(device
, errp
);
3388 aio_context
= bdrv_get_aio_context(bs
);
3389 aio_context_acquire(aio_context
);
3391 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3393 error_propagate(errp
, local_err
);
3398 error_setg(errp
, "image file not found");
3402 if (bdrv_find_base(image_bs
) == image_bs
) {
3403 error_setg(errp
, "not allowing backing file change on an image "
3404 "without a backing file");
3408 /* even though we are not necessarily operating on bs, we need it to
3409 * determine if block ops are currently prohibited on the chain */
3410 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3414 /* final sanity check */
3415 if (!bdrv_chain_contains(bs
, image_bs
)) {
3416 error_setg(errp
, "'%s' and image file are not in the same chain",
3421 /* if not r/w, reopen to make r/w */
3422 ro
= bdrv_is_read_only(image_bs
);
3425 if (bdrv_reopen_set_read_only(image_bs
, false, errp
) != 0) {
3430 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3431 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3434 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3436 /* don't exit here, so we can try to restore open flags if
3441 bdrv_reopen_set_read_only(image_bs
, true, &local_err
);
3442 error_propagate(errp
, local_err
);
3446 aio_context_release(aio_context
);
3449 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3451 BlockDriverState
*bs
;
3453 Visitor
*v
= qobject_output_visitor_new(&obj
);
3456 visit_type_BlockdevOptions(v
, NULL
, &options
, &error_abort
);
3457 visit_complete(v
, &obj
);
3458 qdict
= qobject_to(QDict
, obj
);
3460 qdict_flatten(qdict
);
3462 if (!qdict_get_try_str(qdict
, "node-name")) {
3463 error_setg(errp
, "'node-name' must be specified for the root node");
3467 bs
= bds_tree_init(qdict
, errp
);
3472 bdrv_set_monitor_owned(bs
);
3478 void qmp_x_blockdev_reopen(BlockdevOptions
*options
, Error
**errp
)
3480 BlockDriverState
*bs
;
3483 Visitor
*v
= qobject_output_visitor_new(&obj
);
3484 BlockReopenQueue
*queue
;
3487 /* Check for the selected node name */
3488 if (!options
->has_node_name
) {
3489 error_setg(errp
, "Node name not specified");
3493 bs
= bdrv_find_node(options
->node_name
);
3495 error_setg(errp
, "Cannot find node named '%s'", options
->node_name
);
3499 /* Put all options in a QDict and flatten it */
3500 visit_type_BlockdevOptions(v
, NULL
, &options
, &error_abort
);
3501 visit_complete(v
, &obj
);
3502 qdict
= qobject_to(QDict
, obj
);
3504 qdict_flatten(qdict
);
3506 /* Perform the reopen operation */
3507 ctx
= bdrv_get_aio_context(bs
);
3508 aio_context_acquire(ctx
);
3509 bdrv_subtree_drained_begin(bs
);
3510 queue
= bdrv_reopen_queue(NULL
, bs
, qdict
, false);
3511 bdrv_reopen_multiple(queue
, errp
);
3512 bdrv_subtree_drained_end(bs
);
3513 aio_context_release(ctx
);
3519 void qmp_blockdev_del(const char *node_name
, Error
**errp
)
3521 AioContext
*aio_context
;
3522 BlockDriverState
*bs
;
3524 bs
= bdrv_find_node(node_name
);
3526 error_setg(errp
, "Cannot find node %s", node_name
);
3529 if (bdrv_has_blk(bs
)) {
3530 error_setg(errp
, "Node %s is in use", node_name
);
3533 aio_context
= bdrv_get_aio_context(bs
);
3534 aio_context_acquire(aio_context
);
3536 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
3540 if (!QTAILQ_IN_USE(bs
, monitor_list
)) {
3541 error_setg(errp
, "Node %s is not owned by the monitor",
3546 if (bs
->refcnt
> 1) {
3547 error_setg(errp
, "Block device %s is in use",
3548 bdrv_get_device_or_node_name(bs
));
3552 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3556 aio_context_release(aio_context
);
3559 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
3560 const char *child_name
)
3564 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
3565 if (strcmp(child
->name
, child_name
) == 0) {
3573 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
3574 const char *child
, bool has_node
,
3575 const char *node
, Error
**errp
)
3577 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
3580 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
3585 if (has_child
== has_node
) {
3587 error_setg(errp
, "The parameters child and node are in conflict");
3589 error_setg(errp
, "Either child or node must be specified");
3595 p_child
= bdrv_find_child(parent_bs
, child
);
3597 error_setg(errp
, "Node '%s' does not have child '%s'",
3601 bdrv_del_child(parent_bs
, p_child
, errp
);
3605 new_bs
= bdrv_find_node(node
);
3607 error_setg(errp
, "Node '%s' not found", node
);
3610 bdrv_add_child(parent_bs
, new_bs
, errp
);
3614 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3616 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3619 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
3620 BlockJobInfoList
*elem
;
3621 AioContext
*aio_context
;
3623 if (block_job_is_internal(job
)) {
3626 elem
= g_new0(BlockJobInfoList
, 1);
3627 aio_context
= blk_get_aio_context(job
->blk
);
3628 aio_context_acquire(aio_context
);
3629 elem
->value
= block_job_query(job
, errp
);
3630 aio_context_release(aio_context
);
3633 qapi_free_BlockJobInfoList(head
);
3637 p_next
= &elem
->next
;
3643 void qmp_x_blockdev_set_iothread(const char *node_name
, StrOrNull
*iothread
,
3644 bool has_force
, bool force
, Error
**errp
)
3646 AioContext
*old_context
;
3647 AioContext
*new_context
;
3648 BlockDriverState
*bs
;
3650 bs
= bdrv_find_node(node_name
);
3652 error_setg(errp
, "Cannot find node %s", node_name
);
3656 /* Protects against accidents. */
3657 if (!(has_force
&& force
) && bdrv_has_blk(bs
)) {
3658 error_setg(errp
, "Node %s is associated with a BlockBackend and could "
3659 "be in use (use force=true to override this check)",
3664 if (iothread
->type
== QTYPE_QSTRING
) {
3665 IOThread
*obj
= iothread_by_id(iothread
->u
.s
);
3667 error_setg(errp
, "Cannot find iothread %s", iothread
->u
.s
);
3671 new_context
= iothread_get_aio_context(obj
);
3673 new_context
= qemu_get_aio_context();
3676 old_context
= bdrv_get_aio_context(bs
);
3677 aio_context_acquire(old_context
);
3679 bdrv_try_set_aio_context(bs
, new_context
, errp
);
3681 aio_context_release(old_context
);
3684 QemuOptsList qemu_common_drive_opts
= {
3686 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
3690 .type
= QEMU_OPT_BOOL
,
3691 .help
= "enable/disable snapshot mode",
3694 .type
= QEMU_OPT_STRING
,
3695 .help
= "host AIO implementation (threads, native, io_uring)",
3697 .name
= BDRV_OPT_CACHE_WB
,
3698 .type
= QEMU_OPT_BOOL
,
3699 .help
= "Enable writeback mode",
3702 .type
= QEMU_OPT_STRING
,
3703 .help
= "disk format (raw, qcow2, ...)",
3706 .type
= QEMU_OPT_STRING
,
3707 .help
= "read error action",
3710 .type
= QEMU_OPT_STRING
,
3711 .help
= "write error action",
3713 .name
= BDRV_OPT_READ_ONLY
,
3714 .type
= QEMU_OPT_BOOL
,
3715 .help
= "open drive file as read-only",
3721 .name
= "throttling.group",
3722 .type
= QEMU_OPT_STRING
,
3723 .help
= "name of the block throttling group",
3725 .name
= "copy-on-read",
3726 .type
= QEMU_OPT_BOOL
,
3727 .help
= "copy read data from backing file into image file",
3729 .name
= "detect-zeroes",
3730 .type
= QEMU_OPT_STRING
,
3731 .help
= "try to optimize zero writes (off, on, unmap)",
3733 .name
= "stats-account-invalid",
3734 .type
= QEMU_OPT_BOOL
,
3735 .help
= "whether to account for invalid I/O operations "
3736 "in the statistics",
3738 .name
= "stats-account-failed",
3739 .type
= QEMU_OPT_BOOL
,
3740 .help
= "whether to account for failed I/O operations "
3741 "in the statistics",
3743 { /* end of list */ }
3747 QemuOptsList qemu_drive_opts
= {
3749 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
3752 * no elements => accept any params
3753 * validation will happen later
3755 { /* end of list */ }