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/throttle-groups.h"
39 #include "monitor/monitor.h"
40 #include "qemu/error-report.h"
41 #include "qemu/option.h"
42 #include "qemu/config-file.h"
43 #include "qapi/qmp/types.h"
44 #include "qapi-visit.h"
45 #include "qapi/qmp/qerror.h"
46 #include "qapi/qobject-output-visitor.h"
47 #include "qapi/util.h"
48 #include "sysemu/sysemu.h"
49 #include "block/block_int.h"
50 #include "qmp-commands.h"
51 #include "block/trace.h"
52 #include "sysemu/arch_init.h"
53 #include "qemu/cutils.h"
54 #include "qemu/help_option.h"
55 #include "qemu/throttle-options.h"
57 static QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
58 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
60 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
61 bool force
, Error
**errp
);
63 static const char *const if_name
[IF_COUNT
] = {
67 [IF_FLOPPY
] = "floppy",
68 [IF_PFLASH
] = "pflash",
71 [IF_VIRTIO
] = "virtio",
75 static int if_max_devs
[IF_COUNT
] = {
77 * Do not change these numbers! They govern how drive option
78 * index maps to unit and bus. That mapping is ABI.
80 * All controllers used to implement if=T drives need to support
81 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
82 * Otherwise, some index values map to "impossible" bus, unit
85 * For instance, if you change [IF_SCSI] to 255, -drive
86 * if=scsi,index=12 no longer means bus=1,unit=5, but
87 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
88 * the drive can't be set up. Regression.
95 * Boards may call this to offer board-by-board overrides
96 * of the default, global values.
98 void override_max_devs(BlockInterfaceType type
, int max_devs
)
107 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
108 dinfo
= blk_legacy_dinfo(blk
);
109 if (dinfo
->type
== type
) {
110 fprintf(stderr
, "Cannot override units-per-bus property of"
111 " the %s interface, because a drive of that type has"
112 " already been added.\n", if_name
[type
]);
113 g_assert_not_reached();
117 if_max_devs
[type
] = max_devs
;
121 * We automatically delete the drive when a device using it gets
122 * unplugged. Questionable feature, but we can't just drop it.
123 * Device models call blockdev_mark_auto_del() to schedule the
124 * automatic deletion, and generic qdev code calls blockdev_auto_del()
125 * when deletion is actually safe.
127 void blockdev_mark_auto_del(BlockBackend
*blk
)
129 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
130 BlockDriverState
*bs
= blk_bs(blk
);
131 AioContext
*aio_context
;
138 aio_context
= bdrv_get_aio_context(bs
);
139 aio_context_acquire(aio_context
);
142 block_job_cancel(bs
->job
);
145 aio_context_release(aio_context
);
151 void blockdev_auto_del(BlockBackend
*blk
)
153 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
155 if (dinfo
&& dinfo
->auto_del
) {
156 monitor_remove_blk(blk
);
162 * Returns the current mapping of how many units per bus
163 * a particular interface can support.
165 * A positive integer indicates n units per bus.
166 * 0 implies the mapping has not been established.
167 * -1 indicates an invalid BlockInterfaceType was given.
169 int drive_get_max_devs(BlockInterfaceType type
)
171 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
172 return if_max_devs
[type
];
178 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
180 int max_devs
= if_max_devs
[type
];
181 return max_devs
? index
/ max_devs
: 0;
184 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
186 int max_devs
= if_max_devs
[type
];
187 return max_devs
? index
% max_devs
: index
;
190 QemuOpts
*drive_def(const char *optstr
)
192 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
195 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
200 opts
= drive_def(optstr
);
204 if (type
!= IF_DEFAULT
) {
205 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
208 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
211 qemu_opt_set(opts
, "file", file
, &error_abort
);
215 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
220 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
221 dinfo
= blk_legacy_dinfo(blk
);
222 if (dinfo
&& dinfo
->type
== type
223 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
231 void drive_check_orphaned(void)
236 bool orphans
= false;
238 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
239 dinfo
= blk_legacy_dinfo(blk
);
240 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
241 dinfo
->type
!= IF_NONE
) {
243 qemu_opts_loc_restore(dinfo
->opts
);
244 error_report("machine type does not support"
245 " if=%s,bus=%d,unit=%d",
246 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
257 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
259 return drive_get(type
,
260 drive_index_to_bus_id(type
, index
),
261 drive_index_to_unit_id(type
, index
));
264 int drive_get_max_bus(BlockInterfaceType type
)
271 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
272 dinfo
= blk_legacy_dinfo(blk
);
273 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
274 max_bus
= dinfo
->bus
;
280 /* Get a block device. This should only be used for single-drive devices
281 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
283 DriveInfo
*drive_get_next(BlockInterfaceType type
)
285 static int next_block_unit
[IF_COUNT
];
287 return drive_get(type
, 0, next_block_unit
[type
]++);
290 static void bdrv_format_print(void *opaque
, const char *name
)
292 error_printf(" %s", name
);
297 BlockDriverState
*bs
;
300 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
302 if (!strcmp(buf
, "ignore")) {
303 return BLOCKDEV_ON_ERROR_IGNORE
;
304 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
305 return BLOCKDEV_ON_ERROR_ENOSPC
;
306 } else if (!strcmp(buf
, "stop")) {
307 return BLOCKDEV_ON_ERROR_STOP
;
308 } else if (!strcmp(buf
, "report")) {
309 return BLOCKDEV_ON_ERROR_REPORT
;
311 error_setg(errp
, "'%s' invalid %s error action",
312 buf
, is_read
? "read" : "write");
317 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
320 const QListEntry
*entry
;
321 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
322 switch (qobject_type(entry
->value
)) {
324 case QTYPE_QSTRING
: {
325 unsigned long long length
;
326 const char *str
= qstring_get_str(qobject_to_qstring(entry
->value
));
327 if (parse_uint_full(str
, &length
, 10) == 0 &&
328 length
> 0 && length
<= UINT_MAX
) {
329 block_acct_add_interval(stats
, (unsigned) length
);
331 error_setg(errp
, "Invalid interval length: %s", str
);
338 int64_t length
= qint_get_int(qobject_to_qint(entry
->value
));
339 if (length
> 0 && length
<= UINT_MAX
) {
340 block_acct_add_interval(stats
, (unsigned) length
);
342 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
349 error_setg(errp
, "The specification of stats-intervals is invalid");
356 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
358 /* All parameters but @opts are optional and may be set to NULL. */
359 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
360 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
361 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
363 Error
*local_error
= NULL
;
367 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
368 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
371 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
372 if (!strcmp(aio
, "native")) {
373 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
374 } else if (!strcmp(aio
, "threads")) {
375 /* this is the default */
377 error_setg(errp
, "invalid aio option");
383 /* disk I/O throttling */
384 if (throttling_group
) {
385 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
389 throttle_config_init(throttle_cfg
);
390 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
391 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
392 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
393 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
394 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
395 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
396 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
397 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
398 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
399 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
400 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
401 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
403 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
404 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
405 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
406 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
407 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
408 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
409 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
410 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
411 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
412 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
413 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
414 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
416 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].burst_length
=
417 qemu_opt_get_number(opts
, "throttling.bps-total-max-length", 1);
418 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].burst_length
=
419 qemu_opt_get_number(opts
, "throttling.bps-read-max-length", 1);
420 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].burst_length
=
421 qemu_opt_get_number(opts
, "throttling.bps-write-max-length", 1);
422 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].burst_length
=
423 qemu_opt_get_number(opts
, "throttling.iops-total-max-length", 1);
424 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].burst_length
=
425 qemu_opt_get_number(opts
, "throttling.iops-read-max-length", 1);
426 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].burst_length
=
427 qemu_opt_get_number(opts
, "throttling.iops-write-max-length", 1);
429 throttle_cfg
->op_size
=
430 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
432 if (!throttle_is_valid(throttle_cfg
, errp
)) {
439 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
440 qemu_opt_get(opts
, "detect-zeroes"),
441 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX
,
442 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
445 error_propagate(errp
, local_error
);
451 /* Takes the ownership of bs_opts */
452 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
457 int on_read_error
, on_write_error
;
458 bool account_invalid
, account_failed
;
459 bool writethrough
, read_only
;
461 BlockDriverState
*bs
;
466 QDict
*interval_dict
= NULL
;
467 QList
*interval_list
= NULL
;
469 BlockdevDetectZeroesOptions detect_zeroes
=
470 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
471 const char *throttling_group
= NULL
;
473 /* Check common options by copying from bs_opts to opts, all other options
474 * stay in bs_opts for processing by bdrv_open(). */
475 id
= qdict_get_try_str(bs_opts
, "id");
476 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
478 error_propagate(errp
, error
);
482 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
484 error_propagate(errp
, error
);
489 qdict_del(bs_opts
, "id");
492 /* extract parameters */
493 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
495 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
496 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
498 writethrough
= !qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true);
500 id
= qemu_opts_id(opts
);
502 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
503 qdict_array_split(interval_dict
, &interval_list
);
505 if (qdict_size(interval_dict
) != 0) {
506 error_setg(errp
, "Invalid option stats-intervals.%s",
507 qdict_first(interval_dict
)->key
);
511 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
512 &detect_zeroes
, &error
);
514 error_propagate(errp
, error
);
518 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
519 if (is_help_option(buf
)) {
520 error_printf("Supported formats:");
521 bdrv_iterate_format(bdrv_format_print
, NULL
);
526 if (qdict_haskey(bs_opts
, "driver")) {
527 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
530 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
533 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
534 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
535 on_write_error
= parse_block_error_action(buf
, 0, &error
);
537 error_propagate(errp
, error
);
542 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
543 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
544 on_read_error
= parse_block_error_action(buf
, 1, &error
);
546 error_propagate(errp
, error
);
552 bdrv_flags
|= BDRV_O_SNAPSHOT
;
555 read_only
= qemu_opt_get_bool(opts
, BDRV_OPT_READ_ONLY
, false);
558 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
559 BlockBackendRootState
*blk_rs
;
561 blk
= blk_new(0, BLK_PERM_ALL
);
562 blk_rs
= blk_get_root_state(blk
);
563 blk_rs
->open_flags
= bdrv_flags
;
564 blk_rs
->read_only
= read_only
;
565 blk_rs
->detect_zeroes
= detect_zeroes
;
569 if (file
&& !*file
) {
573 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
574 * with other callers) rather than what we want as the real defaults.
575 * Apply the defaults here instead. */
576 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
577 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
578 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
,
579 read_only
? "on" : "off");
580 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
582 if (runstate_check(RUN_STATE_INMIGRATE
)) {
583 bdrv_flags
|= BDRV_O_INACTIVE
;
586 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
592 bs
->detect_zeroes
= detect_zeroes
;
594 if (bdrv_key_required(bs
)) {
598 block_acct_init(blk_get_stats(blk
), account_invalid
, account_failed
);
600 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
607 /* disk I/O throttling */
608 if (throttle_enabled(&cfg
)) {
609 if (!throttling_group
) {
610 throttling_group
= id
;
612 blk_io_limits_enable(blk
, throttling_group
);
613 blk_set_io_limits(blk
, &cfg
);
616 blk_set_enable_write_cache(blk
, !writethrough
);
617 blk_set_on_error(blk
, on_read_error
, on_write_error
);
619 if (!monitor_add_blk(blk
, id
, errp
)) {
627 QDECREF(interval_dict
);
628 QDECREF(interval_list
);
633 QDECREF(interval_dict
);
634 QDECREF(interval_list
);
640 /* Takes the ownership of bs_opts */
641 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
645 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
646 * with other callers) rather than what we want as the real defaults.
647 * Apply the defaults here instead. */
648 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
649 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
650 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
652 if (runstate_check(RUN_STATE_INMIGRATE
)) {
653 bdrv_flags
|= BDRV_O_INACTIVE
;
656 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
659 void blockdev_close_all_bdrv_states(void)
661 BlockDriverState
*bs
, *next_bs
;
663 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
664 AioContext
*ctx
= bdrv_get_aio_context(bs
);
666 aio_context_acquire(ctx
);
668 aio_context_release(ctx
);
672 /* Iterates over the list of monitor-owned BlockDriverStates */
673 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
675 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
676 : QTAILQ_FIRST(&monitor_bdrv_states
);
679 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
684 value
= qemu_opt_get(opts
, from
);
686 if (qemu_opt_find(opts
, to
)) {
687 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
688 "same time", to
, from
);
693 /* rename all items in opts */
694 while ((value
= qemu_opt_get(opts
, from
))) {
695 qemu_opt_set(opts
, to
, value
, &error_abort
);
696 qemu_opt_unset(opts
, from
);
700 QemuOptsList qemu_legacy_drive_opts
= {
702 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
706 .type
= QEMU_OPT_NUMBER
,
707 .help
= "bus number",
710 .type
= QEMU_OPT_NUMBER
,
711 .help
= "unit number (i.e. lun for scsi)",
714 .type
= QEMU_OPT_NUMBER
,
715 .help
= "index number",
718 .type
= QEMU_OPT_STRING
,
719 .help
= "media type (disk, cdrom)",
722 .type
= QEMU_OPT_STRING
,
723 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
726 .type
= QEMU_OPT_NUMBER
,
727 .help
= "number of cylinders (ide disk geometry)",
730 .type
= QEMU_OPT_NUMBER
,
731 .help
= "number of heads (ide disk geometry)",
734 .type
= QEMU_OPT_NUMBER
,
735 .help
= "number of sectors (ide disk geometry)",
738 .type
= QEMU_OPT_STRING
,
739 .help
= "chs translation (auto, lba, none)",
742 .type
= QEMU_OPT_BOOL
,
743 .help
= "(deprecated, ignored)",
746 .type
= QEMU_OPT_STRING
,
747 .help
= "pci address (virtio only)",
750 .type
= QEMU_OPT_STRING
,
751 .help
= "disk serial number",
754 .type
= QEMU_OPT_STRING
,
758 /* Options that are passed on, but have special semantics with -drive */
760 .name
= BDRV_OPT_READ_ONLY
,
761 .type
= QEMU_OPT_BOOL
,
762 .help
= "open drive file as read-only",
765 .type
= QEMU_OPT_STRING
,
766 .help
= "read error action",
769 .type
= QEMU_OPT_STRING
,
770 .help
= "write error action",
772 .name
= "copy-on-read",
773 .type
= QEMU_OPT_BOOL
,
774 .help
= "copy read data from backing file into image file",
777 { /* end of list */ }
781 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
785 DriveInfo
*dinfo
= NULL
;
787 QemuOpts
*legacy_opts
;
788 DriveMediaType media
= MEDIA_DISK
;
789 BlockInterfaceType type
;
790 int cyls
, heads
, secs
, translation
;
791 int max_devs
, bus_id
, unit_id
, index
;
793 const char *werror
, *rerror
;
794 bool read_only
= false;
797 const char *filename
;
798 Error
*local_err
= NULL
;
801 /* Change legacy command line options into QMP ones */
802 static const struct {
806 { "iops", "throttling.iops-total" },
807 { "iops_rd", "throttling.iops-read" },
808 { "iops_wr", "throttling.iops-write" },
810 { "bps", "throttling.bps-total" },
811 { "bps_rd", "throttling.bps-read" },
812 { "bps_wr", "throttling.bps-write" },
814 { "iops_max", "throttling.iops-total-max" },
815 { "iops_rd_max", "throttling.iops-read-max" },
816 { "iops_wr_max", "throttling.iops-write-max" },
818 { "bps_max", "throttling.bps-total-max" },
819 { "bps_rd_max", "throttling.bps-read-max" },
820 { "bps_wr_max", "throttling.bps-write-max" },
822 { "iops_size", "throttling.iops-size" },
824 { "group", "throttling.group" },
826 { "readonly", BDRV_OPT_READ_ONLY
},
829 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
830 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
833 error_report_err(local_err
);
838 value
= qemu_opt_get(all_opts
, "cache");
843 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
844 error_report("invalid cache option");
848 /* Specific options take precedence */
849 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
850 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
851 !writethrough
, &error_abort
);
853 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
854 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
855 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
857 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
858 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
859 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
861 qemu_opt_unset(all_opts
, "cache");
864 /* Get a QDict for processing the options */
865 bs_opts
= qdict_new();
866 qemu_opts_to_qdict(all_opts
, bs_opts
);
868 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
870 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
872 error_report_err(local_err
);
876 /* Deprecated option boot=[on|off] */
877 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
878 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
879 "ignored. Future versions will reject this parameter. Please "
880 "update your scripts.\n");
884 value
= qemu_opt_get(legacy_opts
, "media");
886 if (!strcmp(value
, "disk")) {
888 } else if (!strcmp(value
, "cdrom")) {
892 error_report("'%s' invalid media", value
);
897 /* copy-on-read is disabled with a warning for read-only devices */
898 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
899 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
901 if (read_only
&& copy_on_read
) {
902 error_report("warning: disabling copy-on-read on read-only drive");
903 copy_on_read
= false;
906 qdict_put(bs_opts
, BDRV_OPT_READ_ONLY
,
907 qstring_from_str(read_only
? "on" : "off"));
908 qdict_put(bs_opts
, "copy-on-read",
909 qstring_from_str(copy_on_read
? "on" :"off"));
911 /* Controller type */
912 value
= qemu_opt_get(legacy_opts
, "if");
915 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
918 if (type
== IF_COUNT
) {
919 error_report("unsupported bus type '%s'", value
);
923 type
= block_default_type
;
927 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
928 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
929 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
931 if (cyls
|| heads
|| secs
) {
933 error_report("invalid physical cyls number");
937 error_report("invalid physical heads number");
941 error_report("invalid physical secs number");
946 translation
= BIOS_ATA_TRANSLATION_AUTO
;
947 value
= qemu_opt_get(legacy_opts
, "trans");
950 error_report("'%s' trans must be used with cyls, heads and secs",
954 if (!strcmp(value
, "none")) {
955 translation
= BIOS_ATA_TRANSLATION_NONE
;
956 } else if (!strcmp(value
, "lba")) {
957 translation
= BIOS_ATA_TRANSLATION_LBA
;
958 } else if (!strcmp(value
, "large")) {
959 translation
= BIOS_ATA_TRANSLATION_LARGE
;
960 } else if (!strcmp(value
, "rechs")) {
961 translation
= BIOS_ATA_TRANSLATION_RECHS
;
962 } else if (!strcmp(value
, "auto")) {
963 translation
= BIOS_ATA_TRANSLATION_AUTO
;
965 error_report("'%s' invalid translation type", value
);
970 if (media
== MEDIA_CDROM
) {
971 if (cyls
|| secs
|| heads
) {
972 error_report("CHS can't be set with media=cdrom");
977 /* Device address specified by bus/unit or index.
978 * If none was specified, try to find the first free one. */
979 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
980 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
981 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
983 max_devs
= if_max_devs
[type
];
986 if (bus_id
!= 0 || unit_id
!= -1) {
987 error_report("index cannot be used with bus and unit");
990 bus_id
= drive_index_to_bus_id(type
, index
);
991 unit_id
= drive_index_to_unit_id(type
, index
);
996 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
998 if (max_devs
&& unit_id
>= max_devs
) {
1005 if (max_devs
&& unit_id
>= max_devs
) {
1006 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
1010 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1011 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1012 bus_id
, unit_id
, index
);
1017 serial
= qemu_opt_get(legacy_opts
, "serial");
1019 /* no id supplied -> create one */
1020 if (qemu_opts_id(all_opts
) == NULL
) {
1022 const char *mediastr
= "";
1023 if (type
== IF_IDE
|| type
== IF_SCSI
) {
1024 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
1027 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
1030 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
1033 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
1037 /* Add virtio block device */
1038 devaddr
= qemu_opt_get(legacy_opts
, "addr");
1039 if (devaddr
&& type
!= IF_VIRTIO
) {
1040 error_report("addr is not supported by this bus type");
1044 if (type
== IF_VIRTIO
) {
1046 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
1048 if (arch_type
== QEMU_ARCH_S390X
) {
1049 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
1051 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
1053 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
1056 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
1060 filename
= qemu_opt_get(legacy_opts
, "file");
1062 /* Check werror/rerror compatibility with if=... */
1063 werror
= qemu_opt_get(legacy_opts
, "werror");
1064 if (werror
!= NULL
) {
1065 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
1067 error_report("werror is not supported by this bus type");
1070 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
1073 rerror
= qemu_opt_get(legacy_opts
, "rerror");
1074 if (rerror
!= NULL
) {
1075 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
1077 error_report("rerror is not supported by this bus type");
1080 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
1083 /* Actual block device init: Functionality shared with blockdev-add */
1084 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
1088 error_report_err(local_err
);
1095 /* Create legacy DriveInfo */
1096 dinfo
= g_malloc0(sizeof(*dinfo
));
1097 dinfo
->opts
= all_opts
;
1100 dinfo
->heads
= heads
;
1102 dinfo
->trans
= translation
;
1105 dinfo
->bus
= bus_id
;
1106 dinfo
->unit
= unit_id
;
1107 dinfo
->devaddr
= devaddr
;
1108 dinfo
->serial
= g_strdup(serial
);
1110 blk_set_legacy_dinfo(blk
, dinfo
);
1117 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1124 qemu_opts_del(legacy_opts
);
1129 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1131 BlockDriverState
*bs
;
1133 bs
= bdrv_lookup_bs(name
, name
, errp
);
1138 if (!bdrv_is_root_node(bs
)) {
1139 error_setg(errp
, "Need a root block node");
1143 if (!bdrv_is_inserted(bs
)) {
1144 error_setg(errp
, "Device has no medium");
1151 static BlockBackend
*qmp_get_blk(const char *blk_name
, const char *qdev_id
,
1156 if (!blk_name
== !qdev_id
) {
1157 error_setg(errp
, "Need exactly one of 'device' and 'id'");
1162 blk
= blk_by_qdev_id(qdev_id
, errp
);
1164 blk
= blk_by_name(blk_name
);
1166 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1167 "Device '%s' not found", blk_name
);
1174 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1176 const char *device
= qdict_get_str(qdict
, "device");
1180 if (!strcmp(device
, "all")) {
1181 ret
= blk_commit_all();
1183 BlockDriverState
*bs
;
1184 AioContext
*aio_context
;
1186 blk
= blk_by_name(device
);
1188 monitor_printf(mon
, "Device '%s' not found\n", device
);
1191 if (!blk_is_available(blk
)) {
1192 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1197 aio_context
= bdrv_get_aio_context(bs
);
1198 aio_context_acquire(aio_context
);
1200 ret
= bdrv_commit(bs
);
1202 aio_context_release(aio_context
);
1205 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1210 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1212 TransactionActionList list
;
1214 list
.value
= action
;
1216 qmp_transaction(&list
, false, NULL
, errp
);
1219 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1220 bool has_node_name
, const char *node_name
,
1221 const char *snapshot_file
,
1222 bool has_snapshot_node_name
,
1223 const char *snapshot_node_name
,
1224 bool has_format
, const char *format
,
1225 bool has_mode
, NewImageMode mode
, Error
**errp
)
1227 BlockdevSnapshotSync snapshot
= {
1228 .has_device
= has_device
,
1229 .device
= (char *) device
,
1230 .has_node_name
= has_node_name
,
1231 .node_name
= (char *) node_name
,
1232 .snapshot_file
= (char *) snapshot_file
,
1233 .has_snapshot_node_name
= has_snapshot_node_name
,
1234 .snapshot_node_name
= (char *) snapshot_node_name
,
1235 .has_format
= has_format
,
1236 .format
= (char *) format
,
1237 .has_mode
= has_mode
,
1240 TransactionAction action
= {
1241 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1242 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1244 blockdev_do_action(&action
, errp
);
1247 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1250 BlockdevSnapshot snapshot_data
= {
1251 .node
= (char *) node
,
1252 .overlay
= (char *) overlay
1254 TransactionAction action
= {
1255 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1256 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1258 blockdev_do_action(&action
, errp
);
1261 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1265 BlockdevSnapshotInternal snapshot
= {
1266 .device
= (char *) device
,
1267 .name
= (char *) name
1269 TransactionAction action
= {
1270 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1271 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1273 blockdev_do_action(&action
, errp
);
1276 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1283 BlockDriverState
*bs
;
1284 AioContext
*aio_context
;
1285 QEMUSnapshotInfo sn
;
1286 Error
*local_err
= NULL
;
1287 SnapshotInfo
*info
= NULL
;
1290 bs
= qmp_get_root_bs(device
, errp
);
1294 aio_context
= bdrv_get_aio_context(bs
);
1295 aio_context_acquire(aio_context
);
1306 error_setg(errp
, "Name or id must be provided");
1307 goto out_aio_context
;
1310 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1311 goto out_aio_context
;
1314 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1316 error_propagate(errp
, local_err
);
1317 goto out_aio_context
;
1321 "Snapshot with id '%s' and name '%s' does not exist on "
1323 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1324 goto out_aio_context
;
1327 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1329 error_propagate(errp
, local_err
);
1330 goto out_aio_context
;
1333 aio_context_release(aio_context
);
1335 info
= g_new0(SnapshotInfo
, 1);
1336 info
->id
= g_strdup(sn
.id_str
);
1337 info
->name
= g_strdup(sn
.name
);
1338 info
->date_nsec
= sn
.date_nsec
;
1339 info
->date_sec
= sn
.date_sec
;
1340 info
->vm_state_size
= sn
.vm_state_size
;
1341 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1342 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1347 aio_context_release(aio_context
);
1352 * block_dirty_bitmap_lookup:
1353 * Return a dirty bitmap (if present), after validating
1354 * the node reference and bitmap names.
1356 * @node: The name of the BDS node to search for bitmaps
1357 * @name: The name of the bitmap to search for
1358 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1359 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1360 * @errp: Output pointer for error information. Can be NULL.
1362 * @return: A bitmap object on success, or NULL on failure.
1364 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1366 BlockDriverState
**pbs
,
1370 BlockDriverState
*bs
;
1371 BdrvDirtyBitmap
*bitmap
;
1372 AioContext
*aio_context
;
1375 error_setg(errp
, "Node cannot be NULL");
1379 error_setg(errp
, "Bitmap name cannot be NULL");
1382 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1384 error_setg(errp
, "Node '%s' not found", node
);
1388 aio_context
= bdrv_get_aio_context(bs
);
1389 aio_context_acquire(aio_context
);
1391 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1393 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1401 *paio
= aio_context
;
1403 aio_context_release(aio_context
);
1409 aio_context_release(aio_context
);
1413 /* New and old BlockDriverState structs for atomic group operations */
1415 typedef struct BlkActionState BlkActionState
;
1419 * Table of operations that define an Action.
1421 * @instance_size: Size of state struct, in bytes.
1422 * @prepare: Prepare the work, must NOT be NULL.
1423 * @commit: Commit the changes, can be NULL.
1424 * @abort: Abort the changes on fail, can be NULL.
1425 * @clean: Clean up resources after all transaction actions have called
1426 * commit() or abort(). Can be NULL.
1428 * Only prepare() may fail. In a single transaction, only one of commit() or
1429 * abort() will be called. clean() will always be called if it is present.
1431 typedef struct BlkActionOps
{
1432 size_t instance_size
;
1433 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1434 void (*commit
)(BlkActionState
*common
);
1435 void (*abort
)(BlkActionState
*common
);
1436 void (*clean
)(BlkActionState
*common
);
1441 * Describes one Action's state within a Transaction.
1443 * @action: QAPI-defined enum identifying which Action to perform.
1444 * @ops: Table of ActionOps this Action can perform.
1445 * @block_job_txn: Transaction which this action belongs to.
1446 * @entry: List membership for all Actions in this Transaction.
1448 * This structure must be arranged as first member in a subclassed type,
1449 * assuming that the compiler will also arrange it to the same offsets as the
1452 struct BlkActionState
{
1453 TransactionAction
*action
;
1454 const BlkActionOps
*ops
;
1455 BlockJobTxn
*block_job_txn
;
1456 TransactionProperties
*txn_props
;
1457 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1460 /* internal snapshot private data */
1461 typedef struct InternalSnapshotState
{
1462 BlkActionState common
;
1463 BlockDriverState
*bs
;
1464 AioContext
*aio_context
;
1465 QEMUSnapshotInfo sn
;
1467 } InternalSnapshotState
;
1470 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1472 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1474 "Action '%s' does not support Transaction property "
1475 "completion-mode = %s",
1476 TransactionActionKind_lookup
[s
->action
->type
],
1477 ActionCompletionMode_lookup
[s
->txn_props
->completion_mode
]);
1483 static void internal_snapshot_prepare(BlkActionState
*common
,
1486 Error
*local_err
= NULL
;
1489 BlockDriverState
*bs
;
1490 QEMUSnapshotInfo old_sn
, *sn
;
1493 BlockdevSnapshotInternal
*internal
;
1494 InternalSnapshotState
*state
;
1497 g_assert(common
->action
->type
==
1498 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1499 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1500 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1502 /* 1. parse input */
1503 device
= internal
->device
;
1504 name
= internal
->name
;
1506 /* 2. check for validation */
1507 if (action_check_completion_mode(common
, errp
) < 0) {
1511 bs
= qmp_get_root_bs(device
, errp
);
1516 /* AioContext is released in .clean() */
1517 state
->aio_context
= bdrv_get_aio_context(bs
);
1518 aio_context_acquire(state
->aio_context
);
1521 bdrv_drained_begin(bs
);
1523 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1527 if (bdrv_is_read_only(bs
)) {
1528 error_setg(errp
, "Device '%s' is read only", device
);
1532 if (!bdrv_can_snapshot(bs
)) {
1533 error_setg(errp
, "Block format '%s' used by device '%s' "
1534 "does not support internal snapshots",
1535 bs
->drv
->format_name
, device
);
1539 if (!strlen(name
)) {
1540 error_setg(errp
, "Name is empty");
1544 /* check whether a snapshot with name exist */
1545 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1548 error_propagate(errp
, local_err
);
1552 "Snapshot with name '%s' already exists on device '%s'",
1557 /* 3. take the snapshot */
1559 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1560 qemu_gettimeofday(&tv
);
1561 sn
->date_sec
= tv
.tv_sec
;
1562 sn
->date_nsec
= tv
.tv_usec
* 1000;
1563 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1565 ret1
= bdrv_snapshot_create(bs
, sn
);
1567 error_setg_errno(errp
, -ret1
,
1568 "Failed to create snapshot '%s' on device '%s'",
1573 /* 4. succeed, mark a snapshot is created */
1574 state
->created
= true;
1577 static void internal_snapshot_abort(BlkActionState
*common
)
1579 InternalSnapshotState
*state
=
1580 DO_UPCAST(InternalSnapshotState
, common
, common
);
1581 BlockDriverState
*bs
= state
->bs
;
1582 QEMUSnapshotInfo
*sn
= &state
->sn
;
1583 Error
*local_error
= NULL
;
1585 if (!state
->created
) {
1589 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1590 error_reportf_err(local_error
,
1591 "Failed to delete snapshot with id '%s' and "
1592 "name '%s' on device '%s' in abort: ",
1593 sn
->id_str
, sn
->name
,
1594 bdrv_get_device_name(bs
));
1598 static void internal_snapshot_clean(BlkActionState
*common
)
1600 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1603 if (state
->aio_context
) {
1605 bdrv_drained_end(state
->bs
);
1607 aio_context_release(state
->aio_context
);
1611 /* external snapshot private data */
1612 typedef struct ExternalSnapshotState
{
1613 BlkActionState common
;
1614 BlockDriverState
*old_bs
;
1615 BlockDriverState
*new_bs
;
1616 AioContext
*aio_context
;
1617 } ExternalSnapshotState
;
1619 static void external_snapshot_prepare(BlkActionState
*common
,
1623 QDict
*options
= NULL
;
1624 Error
*local_err
= NULL
;
1625 /* Device and node name of the image to generate the snapshot from */
1627 const char *node_name
;
1628 /* Reference to the new image (for 'blockdev-snapshot') */
1629 const char *snapshot_ref
;
1630 /* File name of the new image (for 'blockdev-snapshot-sync') */
1631 const char *new_image_file
;
1632 ExternalSnapshotState
*state
=
1633 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1634 TransactionAction
*action
= common
->action
;
1636 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1637 * purpose but a different set of parameters */
1638 switch (action
->type
) {
1639 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1641 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1643 node_name
= s
->node
;
1644 new_image_file
= NULL
;
1645 snapshot_ref
= s
->overlay
;
1648 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1650 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1651 device
= s
->has_device
? s
->device
: NULL
;
1652 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1653 new_image_file
= s
->snapshot_file
;
1654 snapshot_ref
= NULL
;
1658 g_assert_not_reached();
1661 /* start processing */
1662 if (action_check_completion_mode(common
, errp
) < 0) {
1666 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1667 if (!state
->old_bs
) {
1671 /* Acquire AioContext now so any threads operating on old_bs stop */
1672 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1673 aio_context_acquire(state
->aio_context
);
1674 bdrv_drained_begin(state
->old_bs
);
1676 if (!bdrv_is_inserted(state
->old_bs
)) {
1677 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1681 if (bdrv_op_is_blocked(state
->old_bs
,
1682 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1686 if (!bdrv_is_read_only(state
->old_bs
)) {
1687 if (bdrv_flush(state
->old_bs
)) {
1688 error_setg(errp
, QERR_IO_ERROR
);
1693 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1694 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1698 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1699 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1700 const char *format
= s
->has_format
? s
->format
: "qcow2";
1701 enum NewImageMode mode
;
1702 const char *snapshot_node_name
=
1703 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1705 if (node_name
&& !snapshot_node_name
) {
1706 error_setg(errp
, "New snapshot node name missing");
1710 if (snapshot_node_name
&&
1711 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1712 error_setg(errp
, "New snapshot node name already in use");
1716 flags
= state
->old_bs
->open_flags
;
1717 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
| BDRV_O_COPY_ON_READ
);
1719 /* create new image w/backing file */
1720 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1721 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1722 int64_t size
= bdrv_getlength(state
->old_bs
);
1724 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1727 bdrv_img_create(new_image_file
, format
,
1728 state
->old_bs
->filename
,
1729 state
->old_bs
->drv
->format_name
,
1730 NULL
, size
, flags
, &local_err
, false);
1732 error_propagate(errp
, local_err
);
1737 options
= qdict_new();
1738 if (s
->has_snapshot_node_name
) {
1739 qdict_put(options
, "node-name",
1740 qstring_from_str(snapshot_node_name
));
1742 qdict_put(options
, "driver", qstring_from_str(format
));
1744 flags
|= BDRV_O_NO_BACKING
;
1747 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1749 /* We will manually add the backing_hd field to the bs later */
1750 if (!state
->new_bs
) {
1754 if (bdrv_has_blk(state
->new_bs
)) {
1755 error_setg(errp
, "The snapshot is already in use");
1759 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1764 if (state
->new_bs
->backing
!= NULL
) {
1765 error_setg(errp
, "The snapshot already has a backing image");
1769 if (!state
->new_bs
->drv
->supports_backing
) {
1770 error_setg(errp
, "The snapshot does not support backing images");
1774 static void external_snapshot_commit(BlkActionState
*common
)
1776 ExternalSnapshotState
*state
=
1777 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1779 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1781 /* This removes our old bs and adds the new bs */
1782 bdrv_append(state
->new_bs
, state
->old_bs
);
1783 /* We don't need (or want) to use the transactional
1784 * bdrv_reopen_multiple() across all the entries at once, because we
1785 * don't want to abort all of them if one of them fails the reopen */
1786 if (!state
->old_bs
->copy_on_read
) {
1787 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1792 static void external_snapshot_abort(BlkActionState
*common
)
1794 ExternalSnapshotState
*state
=
1795 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1796 if (state
->new_bs
) {
1797 bdrv_unref(state
->new_bs
);
1801 static void external_snapshot_clean(BlkActionState
*common
)
1803 ExternalSnapshotState
*state
=
1804 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1805 if (state
->aio_context
) {
1806 bdrv_drained_end(state
->old_bs
);
1807 aio_context_release(state
->aio_context
);
1811 typedef struct DriveBackupState
{
1812 BlkActionState common
;
1813 BlockDriverState
*bs
;
1814 AioContext
*aio_context
;
1818 static BlockJob
*do_drive_backup(DriveBackup
*backup
, BlockJobTxn
*txn
,
1821 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1823 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1824 BlockDriverState
*bs
;
1825 DriveBackup
*backup
;
1826 Error
*local_err
= NULL
;
1828 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1829 backup
= common
->action
->u
.drive_backup
.data
;
1831 bs
= qmp_get_root_bs(backup
->device
, errp
);
1836 /* AioContext is released in .clean() */
1837 state
->aio_context
= bdrv_get_aio_context(bs
);
1838 aio_context_acquire(state
->aio_context
);
1839 bdrv_drained_begin(bs
);
1842 state
->job
= do_drive_backup(backup
, common
->block_job_txn
, &local_err
);
1844 error_propagate(errp
, local_err
);
1849 static void drive_backup_commit(BlkActionState
*common
)
1851 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1853 block_job_start(state
->job
);
1856 static void drive_backup_abort(BlkActionState
*common
)
1858 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1861 block_job_cancel_sync(state
->job
);
1865 static void drive_backup_clean(BlkActionState
*common
)
1867 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1869 if (state
->aio_context
) {
1870 bdrv_drained_end(state
->bs
);
1871 aio_context_release(state
->aio_context
);
1875 typedef struct BlockdevBackupState
{
1876 BlkActionState common
;
1877 BlockDriverState
*bs
;
1879 AioContext
*aio_context
;
1880 } BlockdevBackupState
;
1882 static BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, BlockJobTxn
*txn
,
1885 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1887 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1888 BlockdevBackup
*backup
;
1889 BlockDriverState
*bs
, *target
;
1890 Error
*local_err
= NULL
;
1892 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1893 backup
= common
->action
->u
.blockdev_backup
.data
;
1895 bs
= qmp_get_root_bs(backup
->device
, errp
);
1900 target
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1905 /* AioContext is released in .clean() */
1906 state
->aio_context
= bdrv_get_aio_context(bs
);
1907 if (state
->aio_context
!= bdrv_get_aio_context(target
)) {
1908 state
->aio_context
= NULL
;
1909 error_setg(errp
, "Backup between two IO threads is not implemented");
1912 aio_context_acquire(state
->aio_context
);
1914 bdrv_drained_begin(state
->bs
);
1916 state
->job
= do_blockdev_backup(backup
, common
->block_job_txn
, &local_err
);
1918 error_propagate(errp
, local_err
);
1923 static void blockdev_backup_commit(BlkActionState
*common
)
1925 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1927 block_job_start(state
->job
);
1930 static void blockdev_backup_abort(BlkActionState
*common
)
1932 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1935 block_job_cancel_sync(state
->job
);
1939 static void blockdev_backup_clean(BlkActionState
*common
)
1941 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1943 if (state
->aio_context
) {
1944 bdrv_drained_end(state
->bs
);
1945 aio_context_release(state
->aio_context
);
1949 typedef struct BlockDirtyBitmapState
{
1950 BlkActionState common
;
1951 BdrvDirtyBitmap
*bitmap
;
1952 BlockDriverState
*bs
;
1953 AioContext
*aio_context
;
1956 } BlockDirtyBitmapState
;
1958 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1961 Error
*local_err
= NULL
;
1962 BlockDirtyBitmapAdd
*action
;
1963 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1966 if (action_check_completion_mode(common
, errp
) < 0) {
1970 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1971 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1972 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
1973 action
->has_granularity
, action
->granularity
,
1977 state
->prepared
= true;
1979 error_propagate(errp
, local_err
);
1983 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
1985 BlockDirtyBitmapAdd
*action
;
1986 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1989 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1990 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1991 * then the node reference and bitmap name must have been valid.
1993 if (state
->prepared
) {
1994 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
1998 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
2001 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2003 BlockDirtyBitmap
*action
;
2005 if (action_check_completion_mode(common
, errp
) < 0) {
2009 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2010 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2013 &state
->aio_context
,
2015 if (!state
->bitmap
) {
2019 if (bdrv_dirty_bitmap_frozen(state
->bitmap
)) {
2020 error_setg(errp
, "Cannot modify a frozen bitmap");
2022 } else if (!bdrv_dirty_bitmap_enabled(state
->bitmap
)) {
2023 error_setg(errp
, "Cannot clear a disabled bitmap");
2027 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2028 /* AioContext is released in .clean() */
2031 static void block_dirty_bitmap_clear_abort(BlkActionState
*common
)
2033 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2036 bdrv_undo_clear_dirty_bitmap(state
->bitmap
, state
->backup
);
2039 static void block_dirty_bitmap_clear_commit(BlkActionState
*common
)
2041 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2044 hbitmap_free(state
->backup
);
2047 static void block_dirty_bitmap_clear_clean(BlkActionState
*common
)
2049 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2052 if (state
->aio_context
) {
2053 aio_context_release(state
->aio_context
);
2057 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2059 error_setg(errp
, "Transaction aborted using Abort action");
2062 static void abort_commit(BlkActionState
*common
)
2064 g_assert_not_reached(); /* this action never succeeds */
2067 static const BlkActionOps actions
[] = {
2068 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2069 .instance_size
= sizeof(ExternalSnapshotState
),
2070 .prepare
= external_snapshot_prepare
,
2071 .commit
= external_snapshot_commit
,
2072 .abort
= external_snapshot_abort
,
2073 .clean
= external_snapshot_clean
,
2075 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2076 .instance_size
= sizeof(ExternalSnapshotState
),
2077 .prepare
= external_snapshot_prepare
,
2078 .commit
= external_snapshot_commit
,
2079 .abort
= external_snapshot_abort
,
2080 .clean
= external_snapshot_clean
,
2082 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2083 .instance_size
= sizeof(DriveBackupState
),
2084 .prepare
= drive_backup_prepare
,
2085 .commit
= drive_backup_commit
,
2086 .abort
= drive_backup_abort
,
2087 .clean
= drive_backup_clean
,
2089 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2090 .instance_size
= sizeof(BlockdevBackupState
),
2091 .prepare
= blockdev_backup_prepare
,
2092 .commit
= blockdev_backup_commit
,
2093 .abort
= blockdev_backup_abort
,
2094 .clean
= blockdev_backup_clean
,
2096 [TRANSACTION_ACTION_KIND_ABORT
] = {
2097 .instance_size
= sizeof(BlkActionState
),
2098 .prepare
= abort_prepare
,
2099 .commit
= abort_commit
,
2101 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2102 .instance_size
= sizeof(InternalSnapshotState
),
2103 .prepare
= internal_snapshot_prepare
,
2104 .abort
= internal_snapshot_abort
,
2105 .clean
= internal_snapshot_clean
,
2107 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2108 .instance_size
= sizeof(BlockDirtyBitmapState
),
2109 .prepare
= block_dirty_bitmap_add_prepare
,
2110 .abort
= block_dirty_bitmap_add_abort
,
2112 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2113 .instance_size
= sizeof(BlockDirtyBitmapState
),
2114 .prepare
= block_dirty_bitmap_clear_prepare
,
2115 .commit
= block_dirty_bitmap_clear_commit
,
2116 .abort
= block_dirty_bitmap_clear_abort
,
2117 .clean
= block_dirty_bitmap_clear_clean
,
2122 * Allocate a TransactionProperties structure if necessary, and fill
2123 * that structure with desired defaults if they are unset.
2125 static TransactionProperties
*get_transaction_properties(
2126 TransactionProperties
*props
)
2129 props
= g_new0(TransactionProperties
, 1);
2132 if (!props
->has_completion_mode
) {
2133 props
->has_completion_mode
= true;
2134 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2141 * 'Atomic' group operations. The operations are performed as a set, and if
2142 * any fail then we roll back all operations in the group.
2144 void qmp_transaction(TransactionActionList
*dev_list
,
2146 struct TransactionProperties
*props
,
2149 TransactionActionList
*dev_entry
= dev_list
;
2150 BlockJobTxn
*block_job_txn
= NULL
;
2151 BlkActionState
*state
, *next
;
2152 Error
*local_err
= NULL
;
2154 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkActionState
) snap_bdrv_states
;
2155 QSIMPLEQ_INIT(&snap_bdrv_states
);
2157 /* Does this transaction get canceled as a group on failure?
2158 * If not, we don't really need to make a BlockJobTxn.
2160 props
= get_transaction_properties(props
);
2161 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2162 block_job_txn
= block_job_txn_new();
2165 /* drain all i/o before any operations */
2168 /* We don't do anything in this loop that commits us to the operations */
2169 while (NULL
!= dev_entry
) {
2170 TransactionAction
*dev_info
= NULL
;
2171 const BlkActionOps
*ops
;
2173 dev_info
= dev_entry
->value
;
2174 dev_entry
= dev_entry
->next
;
2176 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2178 ops
= &actions
[dev_info
->type
];
2179 assert(ops
->instance_size
> 0);
2181 state
= g_malloc0(ops
->instance_size
);
2183 state
->action
= dev_info
;
2184 state
->block_job_txn
= block_job_txn
;
2185 state
->txn_props
= props
;
2186 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2188 state
->ops
->prepare(state
, &local_err
);
2190 error_propagate(errp
, local_err
);
2191 goto delete_and_fail
;
2195 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2196 if (state
->ops
->commit
) {
2197 state
->ops
->commit(state
);
2205 /* failure, and it is all-or-none; roll back all operations */
2206 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2207 if (state
->ops
->abort
) {
2208 state
->ops
->abort(state
);
2212 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2213 if (state
->ops
->clean
) {
2214 state
->ops
->clean(state
);
2219 qapi_free_TransactionProperties(props
);
2221 block_job_txn_unref(block_job_txn
);
2224 void qmp_eject(bool has_device
, const char *device
,
2225 bool has_id
, const char *id
,
2226 bool has_force
, bool force
, Error
**errp
)
2228 Error
*local_err
= NULL
;
2235 rc
= do_open_tray(has_device
? device
: NULL
,
2238 if (rc
&& rc
!= -ENOSYS
) {
2239 error_propagate(errp
, local_err
);
2242 error_free(local_err
);
2244 qmp_x_blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2247 void qmp_block_passwd(bool has_device
, const char *device
,
2248 bool has_node_name
, const char *node_name
,
2249 const char *password
, Error
**errp
)
2251 Error
*local_err
= NULL
;
2252 BlockDriverState
*bs
;
2253 AioContext
*aio_context
;
2255 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2256 has_node_name
? node_name
: NULL
,
2259 error_propagate(errp
, local_err
);
2263 aio_context
= bdrv_get_aio_context(bs
);
2264 aio_context_acquire(aio_context
);
2266 bdrv_add_key(bs
, password
, errp
);
2268 aio_context_release(aio_context
);
2272 * Attempt to open the tray of @device.
2273 * If @force, ignore its tray lock.
2274 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2275 * On error, store an error through @errp and return -errno.
2276 * If @device does not exist, return -ENODEV.
2277 * If it has no removable media, return -ENOTSUP.
2278 * If it has no tray, return -ENOSYS.
2279 * If the guest was asked to open the tray, return -EINPROGRESS.
2282 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2283 bool force
, Error
**errp
)
2286 const char *device
= qdev_id
?: blk_name
;
2289 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2294 if (!blk_dev_has_removable_media(blk
)) {
2295 error_setg(errp
, "Device '%s' is not removable", device
);
2299 if (!blk_dev_has_tray(blk
)) {
2300 error_setg(errp
, "Device '%s' does not have a tray", device
);
2304 if (blk_dev_is_tray_open(blk
)) {
2308 locked
= blk_dev_is_medium_locked(blk
);
2310 blk_dev_eject_request(blk
, force
);
2313 if (!locked
|| force
) {
2314 blk_dev_change_media_cb(blk
, false, &error_abort
);
2317 if (locked
&& !force
) {
2318 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2319 "wait for tray to open and try again", device
);
2320 return -EINPROGRESS
;
2326 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2327 bool has_id
, const char *id
,
2328 bool has_force
, bool force
,
2331 Error
*local_err
= NULL
;
2337 rc
= do_open_tray(has_device
? device
: NULL
,
2340 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2341 error_propagate(errp
, local_err
);
2344 error_free(local_err
);
2347 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2348 bool has_id
, const char *id
,
2352 Error
*local_err
= NULL
;
2354 device
= has_device
? device
: NULL
;
2355 id
= has_id
? id
: NULL
;
2357 blk
= qmp_get_blk(device
, id
, errp
);
2362 if (!blk_dev_has_removable_media(blk
)) {
2363 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2367 if (!blk_dev_has_tray(blk
)) {
2368 /* Ignore this command on tray-less devices */
2372 if (!blk_dev_is_tray_open(blk
)) {
2376 blk_dev_change_media_cb(blk
, true, &local_err
);
2378 error_propagate(errp
, local_err
);
2383 void qmp_x_blockdev_remove_medium(bool has_device
, const char *device
,
2384 bool has_id
, const char *id
, Error
**errp
)
2387 BlockDriverState
*bs
;
2388 AioContext
*aio_context
;
2389 bool has_attached_device
;
2391 device
= has_device
? device
: NULL
;
2392 id
= has_id
? id
: NULL
;
2394 blk
= qmp_get_blk(device
, id
, errp
);
2399 /* For BBs without a device, we can exchange the BDS tree at will */
2400 has_attached_device
= blk_get_attached_dev(blk
);
2402 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2403 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2407 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2408 !blk_dev_is_tray_open(blk
))
2410 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2419 aio_context
= bdrv_get_aio_context(bs
);
2420 aio_context_acquire(aio_context
);
2422 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2428 if (!blk_dev_has_tray(blk
)) {
2429 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2430 * called at all); therefore, the medium needs to be ejected here.
2431 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2432 * value passed here (i.e. false). */
2433 blk_dev_change_media_cb(blk
, false, &error_abort
);
2437 aio_context_release(aio_context
);
2440 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2441 BlockDriverState
*bs
, Error
**errp
)
2443 Error
*local_err
= NULL
;
2447 /* For BBs without a device, we can exchange the BDS tree at will */
2448 has_device
= blk_get_attached_dev(blk
);
2450 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2451 error_setg(errp
, "Device is not removable");
2455 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2456 error_setg(errp
, "Tray of the device is not open");
2461 error_setg(errp
, "There already is a medium in the device");
2465 ret
= blk_insert_bs(blk
, bs
, errp
);
2470 if (!blk_dev_has_tray(blk
)) {
2471 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2472 * called at all); therefore, the medium needs to be pushed into the
2474 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2475 * value passed here (i.e. true). */
2476 blk_dev_change_media_cb(blk
, true, &local_err
);
2478 error_propagate(errp
, local_err
);
2485 void qmp_x_blockdev_insert_medium(bool has_device
, const char *device
,
2486 bool has_id
, const char *id
,
2487 const char *node_name
, Error
**errp
)
2490 BlockDriverState
*bs
;
2492 blk
= qmp_get_blk(has_device
? device
: NULL
,
2499 bs
= bdrv_find_node(node_name
);
2501 error_setg(errp
, "Node '%s' not found", node_name
);
2505 if (bdrv_has_blk(bs
)) {
2506 error_setg(errp
, "Node '%s' is already in use", node_name
);
2510 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2513 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2514 bool has_id
, const char *id
,
2515 const char *filename
,
2516 bool has_format
, const char *format
,
2518 BlockdevChangeReadOnlyMode read_only
,
2522 BlockDriverState
*medium_bs
= NULL
;
2526 QDict
*options
= NULL
;
2529 blk
= qmp_get_blk(has_device
? device
: NULL
,
2537 blk_update_root_state(blk
);
2540 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2541 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2544 if (!has_read_only
) {
2545 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2548 switch (read_only
) {
2549 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2552 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2553 bdrv_flags
&= ~BDRV_O_RDWR
;
2556 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2557 bdrv_flags
|= BDRV_O_RDWR
;
2564 options
= qdict_new();
2565 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2566 qdict_put(options
, "detect-zeroes",
2567 qstring_from_str(detect_zeroes
? "on" : "off"));
2570 qdict_put(options
, "driver", qstring_from_str(format
));
2573 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2578 bdrv_add_key(medium_bs
, NULL
, &err
);
2580 error_propagate(errp
, err
);
2584 rc
= do_open_tray(has_device
? device
: NULL
,
2587 if (rc
&& rc
!= -ENOSYS
) {
2588 error_propagate(errp
, err
);
2594 qmp_x_blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2596 error_propagate(errp
, err
);
2600 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2602 error_propagate(errp
, err
);
2606 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2609 /* If the medium has been inserted, the device has its own reference, so
2610 * ours must be relinquished; and if it has not been inserted successfully,
2611 * the reference must be relinquished anyway */
2612 bdrv_unref(medium_bs
);
2615 /* throttling disk I/O limits */
2616 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2619 BlockDriverState
*bs
;
2621 AioContext
*aio_context
;
2623 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2624 arg
->has_id
? arg
->id
: NULL
,
2630 aio_context
= blk_get_aio_context(blk
);
2631 aio_context_acquire(aio_context
);
2635 error_setg(errp
, "Device has no medium");
2639 throttle_config_init(&cfg
);
2640 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2641 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2642 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2644 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2645 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2646 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2648 if (arg
->has_bps_max
) {
2649 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2651 if (arg
->has_bps_rd_max
) {
2652 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2654 if (arg
->has_bps_wr_max
) {
2655 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2657 if (arg
->has_iops_max
) {
2658 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2660 if (arg
->has_iops_rd_max
) {
2661 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2663 if (arg
->has_iops_wr_max
) {
2664 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2667 if (arg
->has_bps_max_length
) {
2668 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2670 if (arg
->has_bps_rd_max_length
) {
2671 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2673 if (arg
->has_bps_wr_max_length
) {
2674 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2676 if (arg
->has_iops_max_length
) {
2677 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2679 if (arg
->has_iops_rd_max_length
) {
2680 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2682 if (arg
->has_iops_wr_max_length
) {
2683 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2686 if (arg
->has_iops_size
) {
2687 cfg
.op_size
= arg
->iops_size
;
2690 if (!throttle_is_valid(&cfg
, errp
)) {
2694 if (throttle_enabled(&cfg
)) {
2695 /* Enable I/O limits if they're not enabled yet, otherwise
2696 * just update the throttling group. */
2697 if (!blk_get_public(blk
)->throttle_state
) {
2698 blk_io_limits_enable(blk
,
2699 arg
->has_group
? arg
->group
:
2700 arg
->has_device
? arg
->device
:
2702 } else if (arg
->has_group
) {
2703 blk_io_limits_update_group(blk
, arg
->group
);
2705 /* Set the new throttling configuration */
2706 blk_set_io_limits(blk
, &cfg
);
2707 } else if (blk_get_public(blk
)->throttle_state
) {
2708 /* If all throttling settings are set to 0, disable I/O limits */
2709 blk_io_limits_disable(blk
);
2713 aio_context_release(aio_context
);
2716 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2717 bool has_granularity
, uint32_t granularity
,
2720 AioContext
*aio_context
;
2721 BlockDriverState
*bs
;
2723 if (!name
|| name
[0] == '\0') {
2724 error_setg(errp
, "Bitmap name cannot be empty");
2728 bs
= bdrv_lookup_bs(node
, node
, errp
);
2733 aio_context
= bdrv_get_aio_context(bs
);
2734 aio_context_acquire(aio_context
);
2736 if (has_granularity
) {
2737 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2738 error_setg(errp
, "Granularity must be power of 2 "
2739 "and at least 512");
2743 /* Default to cluster size, if available: */
2744 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2747 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2750 aio_context_release(aio_context
);
2753 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2756 AioContext
*aio_context
;
2757 BlockDriverState
*bs
;
2758 BdrvDirtyBitmap
*bitmap
;
2760 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2761 if (!bitmap
|| !bs
) {
2765 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2767 "Bitmap '%s' is currently frozen and cannot be removed",
2771 bdrv_dirty_bitmap_make_anon(bitmap
);
2772 bdrv_release_dirty_bitmap(bs
, bitmap
);
2775 aio_context_release(aio_context
);
2779 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2780 * immediately after a full backup operation.
2782 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2785 AioContext
*aio_context
;
2786 BdrvDirtyBitmap
*bitmap
;
2787 BlockDriverState
*bs
;
2789 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2790 if (!bitmap
|| !bs
) {
2794 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2796 "Bitmap '%s' is currently frozen and cannot be modified",
2799 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2801 "Bitmap '%s' is currently disabled and cannot be cleared",
2806 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2809 aio_context_release(aio_context
);
2812 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2814 const char *id
= qdict_get_str(qdict
, "id");
2816 BlockDriverState
*bs
;
2817 AioContext
*aio_context
;
2818 Error
*local_err
= NULL
;
2820 bs
= bdrv_find_node(id
);
2822 qmp_x_blockdev_del(id
, &local_err
);
2824 error_report_err(local_err
);
2829 blk
= blk_by_name(id
);
2831 error_report("Device '%s' not found", id
);
2835 if (!blk_legacy_dinfo(blk
)) {
2836 error_report("Deleting device added with blockdev-add"
2837 " is not supported");
2841 aio_context
= blk_get_aio_context(blk
);
2842 aio_context_acquire(aio_context
);
2846 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2847 error_report_err(local_err
);
2848 aio_context_release(aio_context
);
2855 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2856 monitor_remove_blk(blk
);
2858 /* If this BlockBackend has a device attached to it, its refcount will be
2859 * decremented when the device is removed; otherwise we have to do so here.
2861 if (blk_get_attached_dev(blk
)) {
2862 /* Further I/O must not pause the guest */
2863 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
2864 BLOCKDEV_ON_ERROR_REPORT
);
2869 aio_context_release(aio_context
);
2872 void qmp_block_resize(bool has_device
, const char *device
,
2873 bool has_node_name
, const char *node_name
,
2874 int64_t size
, Error
**errp
)
2876 Error
*local_err
= NULL
;
2877 BlockBackend
*blk
= NULL
;
2878 BlockDriverState
*bs
;
2879 AioContext
*aio_context
;
2882 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2883 has_node_name
? node_name
: NULL
,
2886 error_propagate(errp
, local_err
);
2890 aio_context
= bdrv_get_aio_context(bs
);
2891 aio_context_acquire(aio_context
);
2893 if (!bdrv_is_first_non_filter(bs
)) {
2894 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
2899 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2903 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2904 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2908 blk
= blk_new(BLK_PERM_RESIZE
, BLK_PERM_ALL
);
2909 ret
= blk_insert_bs(blk
, bs
, errp
);
2914 /* complete all in-flight operations before resizing the device */
2917 ret
= blk_truncate(blk
, size
);
2922 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2925 error_setg(errp
, QERR_UNSUPPORTED
);
2928 error_setg(errp
, "Device '%s' is read only", device
);
2931 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2934 error_setg_errno(errp
, -ret
, "Could not resize");
2940 aio_context_release(aio_context
);
2943 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
2944 bool has_base
, const char *base
,
2945 bool has_base_node
, const char *base_node
,
2946 bool has_backing_file
, const char *backing_file
,
2947 bool has_speed
, int64_t speed
,
2948 bool has_on_error
, BlockdevOnError on_error
,
2951 BlockDriverState
*bs
, *iter
;
2952 BlockDriverState
*base_bs
= NULL
;
2953 AioContext
*aio_context
;
2954 Error
*local_err
= NULL
;
2955 const char *base_name
= NULL
;
2957 if (!has_on_error
) {
2958 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2961 bs
= bdrv_lookup_bs(device
, device
, errp
);
2966 aio_context
= bdrv_get_aio_context(bs
);
2967 aio_context_acquire(aio_context
);
2969 if (has_base
&& has_base_node
) {
2970 error_setg(errp
, "'base' and 'base-node' cannot be specified "
2971 "at the same time");
2976 base_bs
= bdrv_find_backing_image(bs
, base
);
2977 if (base_bs
== NULL
) {
2978 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
2981 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2985 if (has_base_node
) {
2986 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
2990 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
2991 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
2995 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2996 base_name
= base_bs
->filename
;
2999 /* Check for op blockers in the whole chain between bs and base */
3000 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
3001 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3006 /* if we are streaming the entire chain, the result will have no backing
3007 * file, and specifying one is therefore an error */
3008 if (base_bs
== NULL
&& has_backing_file
) {
3009 error_setg(errp
, "backing file specified, but streaming the "
3014 /* backing_file string overrides base bs filename */
3015 base_name
= has_backing_file
? backing_file
: base_name
;
3017 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
3018 has_speed
? speed
: 0, on_error
, &local_err
);
3020 error_propagate(errp
, local_err
);
3024 trace_qmp_block_stream(bs
, bs
->job
);
3027 aio_context_release(aio_context
);
3030 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
3031 bool has_base
, const char *base
,
3032 bool has_top
, const char *top
,
3033 bool has_backing_file
, const char *backing_file
,
3034 bool has_speed
, int64_t speed
,
3037 BlockDriverState
*bs
;
3038 BlockDriverState
*iter
;
3039 BlockDriverState
*base_bs
, *top_bs
;
3040 AioContext
*aio_context
;
3041 Error
*local_err
= NULL
;
3042 /* This will be part of the QMP command, if/when the
3043 * BlockdevOnError change for blkmirror makes it in
3045 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3052 * libvirt relies on the DeviceNotFound error class in order to probe for
3053 * live commit feature versions; for this to work, we must make sure to
3054 * perform the device lookup before any generic errors that may occur in a
3055 * scenario in which all optional arguments are omitted. */
3056 bs
= qmp_get_root_bs(device
, &local_err
);
3058 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3060 error_free(local_err
);
3061 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3062 "Device '%s' not found", device
);
3064 error_propagate(errp
, local_err
);
3069 aio_context
= bdrv_get_aio_context(bs
);
3070 aio_context_acquire(aio_context
);
3072 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3076 /* default top_bs is the active layer */
3079 if (has_top
&& top
) {
3080 if (strcmp(bs
->filename
, top
) != 0) {
3081 top_bs
= bdrv_find_backing_image(bs
, top
);
3085 if (top_bs
== NULL
) {
3086 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3090 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3092 if (has_base
&& base
) {
3093 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3095 base_bs
= bdrv_find_base(top_bs
);
3098 if (base_bs
== NULL
) {
3099 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3103 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3105 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
3106 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3111 /* Do not allow attempts to commit an image into itself */
3112 if (top_bs
== base_bs
) {
3113 error_setg(errp
, "cannot commit an image into itself");
3118 if (has_backing_file
) {
3119 error_setg(errp
, "'backing-file' specified,"
3120 " but 'top' is the active layer");
3123 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
3124 BLOCK_JOB_DEFAULT
, speed
, on_error
, NULL
, NULL
,
3127 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
3128 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3131 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, speed
,
3132 on_error
, has_backing_file
? backing_file
: NULL
,
3135 if (local_err
!= NULL
) {
3136 error_propagate(errp
, local_err
);
3141 aio_context_release(aio_context
);
3144 static BlockJob
*do_drive_backup(DriveBackup
*backup
, BlockJobTxn
*txn
,
3147 BlockDriverState
*bs
;
3148 BlockDriverState
*target_bs
;
3149 BlockDriverState
*source
= NULL
;
3150 BlockJob
*job
= NULL
;
3151 BdrvDirtyBitmap
*bmap
= NULL
;
3152 AioContext
*aio_context
;
3153 QDict
*options
= NULL
;
3154 Error
*local_err
= NULL
;
3158 if (!backup
->has_speed
) {
3161 if (!backup
->has_on_source_error
) {
3162 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3164 if (!backup
->has_on_target_error
) {
3165 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3167 if (!backup
->has_mode
) {
3168 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3170 if (!backup
->has_job_id
) {
3171 backup
->job_id
= NULL
;
3173 if (!backup
->has_compress
) {
3174 backup
->compress
= false;
3177 bs
= qmp_get_root_bs(backup
->device
, errp
);
3182 aio_context
= bdrv_get_aio_context(bs
);
3183 aio_context_acquire(aio_context
);
3185 if (!backup
->has_format
) {
3186 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
3187 NULL
: (char*) bs
->drv
->format_name
;
3190 /* Early check to avoid creating target */
3191 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3195 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3197 /* See if we have a backing HD we can use to create our new image
3199 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
3200 source
= backing_bs(bs
);
3202 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
3205 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3209 size
= bdrv_getlength(bs
);
3211 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3215 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
3216 assert(backup
->format
);
3218 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
3219 source
->drv
->format_name
, NULL
,
3220 size
, flags
, &local_err
, false);
3222 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
3223 size
, flags
, &local_err
, false);
3228 error_propagate(errp
, local_err
);
3232 if (backup
->format
) {
3233 options
= qdict_new();
3234 qdict_put(options
, "driver", qstring_from_str(backup
->format
));
3237 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
3242 bdrv_set_aio_context(target_bs
, aio_context
);
3244 if (backup
->has_bitmap
) {
3245 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3247 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3248 bdrv_unref(target_bs
);
3253 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3254 backup
->sync
, bmap
, backup
->compress
,
3255 backup
->on_source_error
, backup
->on_target_error
,
3256 BLOCK_JOB_DEFAULT
, NULL
, NULL
, txn
, &local_err
);
3257 bdrv_unref(target_bs
);
3258 if (local_err
!= NULL
) {
3259 error_propagate(errp
, local_err
);
3264 aio_context_release(aio_context
);
3268 void qmp_drive_backup(DriveBackup
*arg
, Error
**errp
)
3272 job
= do_drive_backup(arg
, NULL
, errp
);
3274 block_job_start(job
);
3278 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3280 return bdrv_named_nodes_list(errp
);
3283 BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, BlockJobTxn
*txn
,
3286 BlockDriverState
*bs
;
3287 BlockDriverState
*target_bs
;
3288 Error
*local_err
= NULL
;
3289 AioContext
*aio_context
;
3290 BlockJob
*job
= NULL
;
3292 if (!backup
->has_speed
) {
3295 if (!backup
->has_on_source_error
) {
3296 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3298 if (!backup
->has_on_target_error
) {
3299 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3301 if (!backup
->has_job_id
) {
3302 backup
->job_id
= NULL
;
3304 if (!backup
->has_compress
) {
3305 backup
->compress
= false;
3308 bs
= qmp_get_root_bs(backup
->device
, errp
);
3313 aio_context
= bdrv_get_aio_context(bs
);
3314 aio_context_acquire(aio_context
);
3316 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
3321 if (bdrv_get_aio_context(target_bs
) != aio_context
) {
3322 if (!bdrv_has_blk(target_bs
)) {
3323 /* The target BDS is not attached, we can safely move it to another
3325 bdrv_set_aio_context(target_bs
, aio_context
);
3327 error_setg(errp
, "Target is attached to a different thread from "
3332 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3333 backup
->sync
, NULL
, backup
->compress
,
3334 backup
->on_source_error
, backup
->on_target_error
,
3335 BLOCK_JOB_DEFAULT
, NULL
, NULL
, txn
, &local_err
);
3336 if (local_err
!= NULL
) {
3337 error_propagate(errp
, local_err
);
3340 aio_context_release(aio_context
);
3344 void qmp_blockdev_backup(BlockdevBackup
*arg
, Error
**errp
)
3347 job
= do_blockdev_backup(arg
, NULL
, errp
);
3349 block_job_start(job
);
3353 /* Parameter check and block job starting for drive mirroring.
3354 * Caller should hold @device and @target's aio context (must be the same).
3356 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3357 BlockDriverState
*target
,
3358 bool has_replaces
, const char *replaces
,
3359 enum MirrorSyncMode sync
,
3360 BlockMirrorBackingMode backing_mode
,
3361 bool has_speed
, int64_t speed
,
3362 bool has_granularity
, uint32_t granularity
,
3363 bool has_buf_size
, int64_t buf_size
,
3364 bool has_on_source_error
,
3365 BlockdevOnError on_source_error
,
3366 bool has_on_target_error
,
3367 BlockdevOnError on_target_error
,
3368 bool has_unmap
, bool unmap
,
3375 if (!has_on_source_error
) {
3376 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3378 if (!has_on_target_error
) {
3379 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3381 if (!has_granularity
) {
3384 if (!has_buf_size
) {
3391 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3392 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3393 "a value in range [512B, 64MB]");
3396 if (granularity
& (granularity
- 1)) {
3397 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3402 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3405 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3409 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3410 sync
= MIRROR_SYNC_MODE_FULL
;
3413 /* pass the node name to replace to mirror start since it's loose coupling
3414 * and will allow to check whether the node still exist at mirror completion
3416 mirror_start(job_id
, bs
, target
,
3417 has_replaces
? replaces
: NULL
,
3418 speed
, granularity
, buf_size
, sync
, backing_mode
,
3419 on_source_error
, on_target_error
, unmap
, errp
);
3422 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3424 BlockDriverState
*bs
;
3425 BlockDriverState
*source
, *target_bs
;
3426 AioContext
*aio_context
;
3427 BlockMirrorBackingMode backing_mode
;
3428 Error
*local_err
= NULL
;
3429 QDict
*options
= NULL
;
3432 const char *format
= arg
->format
;
3434 bs
= qmp_get_root_bs(arg
->device
, errp
);
3439 aio_context
= bdrv_get_aio_context(bs
);
3440 aio_context_acquire(aio_context
);
3442 if (!arg
->has_mode
) {
3443 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3446 if (!arg
->has_format
) {
3447 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3448 ? NULL
: bs
->drv
->format_name
);
3451 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3452 source
= backing_bs(bs
);
3453 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3454 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3456 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3460 size
= bdrv_getlength(bs
);
3462 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3466 if (arg
->has_replaces
) {
3467 BlockDriverState
*to_replace_bs
;
3468 AioContext
*replace_aio_context
;
3469 int64_t replace_size
;
3471 if (!arg
->has_node_name
) {
3472 error_setg(errp
, "a node-name must be provided when replacing a"
3473 " named node of the graph");
3477 to_replace_bs
= check_to_replace_node(bs
, arg
->replaces
, &local_err
);
3479 if (!to_replace_bs
) {
3480 error_propagate(errp
, local_err
);
3484 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3485 aio_context_acquire(replace_aio_context
);
3486 replace_size
= bdrv_getlength(to_replace_bs
);
3487 aio_context_release(replace_aio_context
);
3489 if (size
!= replace_size
) {
3490 error_setg(errp
, "cannot replace image with a mirror image of "
3496 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3497 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3499 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3502 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3503 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3505 /* create new image w/o backing file */
3507 bdrv_img_create(arg
->target
, format
,
3508 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
3510 switch (arg
->mode
) {
3511 case NEW_IMAGE_MODE_EXISTING
:
3513 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3514 /* create new image with backing file */
3515 bdrv_img_create(arg
->target
, format
,
3517 source
->drv
->format_name
,
3518 NULL
, size
, flags
, &local_err
, false);
3526 error_propagate(errp
, local_err
);
3530 options
= qdict_new();
3531 if (arg
->has_node_name
) {
3532 qdict_put(options
, "node-name", qstring_from_str(arg
->node_name
));
3535 qdict_put(options
, "driver", qstring_from_str(format
));
3538 /* Mirroring takes care of copy-on-write using the source's backing
3541 target_bs
= bdrv_open(arg
->target
, NULL
, options
,
3542 flags
| BDRV_O_NO_BACKING
, errp
);
3547 bdrv_set_aio_context(target_bs
, aio_context
);
3549 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3550 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3551 backing_mode
, arg
->has_speed
, arg
->speed
,
3552 arg
->has_granularity
, arg
->granularity
,
3553 arg
->has_buf_size
, arg
->buf_size
,
3554 arg
->has_on_source_error
, arg
->on_source_error
,
3555 arg
->has_on_target_error
, arg
->on_target_error
,
3556 arg
->has_unmap
, arg
->unmap
,
3558 bdrv_unref(target_bs
);
3559 error_propagate(errp
, local_err
);
3561 aio_context_release(aio_context
);
3564 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3565 const char *device
, const char *target
,
3566 bool has_replaces
, const char *replaces
,
3567 MirrorSyncMode sync
,
3568 bool has_speed
, int64_t speed
,
3569 bool has_granularity
, uint32_t granularity
,
3570 bool has_buf_size
, int64_t buf_size
,
3571 bool has_on_source_error
,
3572 BlockdevOnError on_source_error
,
3573 bool has_on_target_error
,
3574 BlockdevOnError on_target_error
,
3577 BlockDriverState
*bs
;
3578 BlockDriverState
*target_bs
;
3579 AioContext
*aio_context
;
3580 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3581 Error
*local_err
= NULL
;
3583 bs
= qmp_get_root_bs(device
, errp
);
3588 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3593 aio_context
= bdrv_get_aio_context(bs
);
3594 aio_context_acquire(aio_context
);
3596 bdrv_set_aio_context(target_bs
, aio_context
);
3598 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3599 has_replaces
, replaces
, sync
, backing_mode
,
3601 has_granularity
, granularity
,
3602 has_buf_size
, buf_size
,
3603 has_on_source_error
, on_source_error
,
3604 has_on_target_error
, on_target_error
,
3607 error_propagate(errp
, local_err
);
3609 aio_context_release(aio_context
);
3612 /* Get a block job using its ID and acquire its AioContext */
3613 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
3620 *aio_context
= NULL
;
3622 job
= block_job_get(id
);
3625 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3626 "Block job '%s' not found", id
);
3630 *aio_context
= blk_get_aio_context(job
->blk
);
3631 aio_context_acquire(*aio_context
);
3636 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3638 AioContext
*aio_context
;
3639 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3645 block_job_set_speed(job
, speed
, errp
);
3646 aio_context_release(aio_context
);
3649 void qmp_block_job_cancel(const char *device
,
3650 bool has_force
, bool force
, Error
**errp
)
3652 AioContext
*aio_context
;
3653 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3663 if (block_job_user_paused(job
) && !force
) {
3664 error_setg(errp
, "The block job for device '%s' is currently paused",
3669 trace_qmp_block_job_cancel(job
);
3670 block_job_cancel(job
);
3672 aio_context_release(aio_context
);
3675 void qmp_block_job_pause(const char *device
, Error
**errp
)
3677 AioContext
*aio_context
;
3678 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3680 if (!job
|| block_job_user_paused(job
)) {
3684 trace_qmp_block_job_pause(job
);
3685 block_job_user_pause(job
);
3686 aio_context_release(aio_context
);
3689 void qmp_block_job_resume(const char *device
, Error
**errp
)
3691 AioContext
*aio_context
;
3692 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3694 if (!job
|| !block_job_user_paused(job
)) {
3698 trace_qmp_block_job_resume(job
);
3699 block_job_iostatus_reset(job
);
3700 block_job_user_resume(job
);
3701 aio_context_release(aio_context
);
3704 void qmp_block_job_complete(const char *device
, Error
**errp
)
3706 AioContext
*aio_context
;
3707 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3713 trace_qmp_block_job_complete(job
);
3714 block_job_complete(job
, errp
);
3715 aio_context_release(aio_context
);
3718 void qmp_change_backing_file(const char *device
,
3719 const char *image_node_name
,
3720 const char *backing_file
,
3723 BlockDriverState
*bs
= NULL
;
3724 AioContext
*aio_context
;
3725 BlockDriverState
*image_bs
= NULL
;
3726 Error
*local_err
= NULL
;
3731 bs
= qmp_get_root_bs(device
, errp
);
3736 aio_context
= bdrv_get_aio_context(bs
);
3737 aio_context_acquire(aio_context
);
3739 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3741 error_propagate(errp
, local_err
);
3746 error_setg(errp
, "image file not found");
3750 if (bdrv_find_base(image_bs
) == image_bs
) {
3751 error_setg(errp
, "not allowing backing file change on an image "
3752 "without a backing file");
3756 /* even though we are not necessarily operating on bs, we need it to
3757 * determine if block ops are currently prohibited on the chain */
3758 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3762 /* final sanity check */
3763 if (!bdrv_chain_contains(bs
, image_bs
)) {
3764 error_setg(errp
, "'%s' and image file are not in the same chain",
3769 /* if not r/w, reopen to make r/w */
3770 open_flags
= image_bs
->open_flags
;
3771 ro
= bdrv_is_read_only(image_bs
);
3774 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3776 error_propagate(errp
, local_err
);
3781 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3782 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3785 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3787 /* don't exit here, so we can try to restore open flags if
3792 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3793 error_propagate(errp
, local_err
);
3797 aio_context_release(aio_context
);
3800 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
3804 Error
*local_err
= NULL
;
3806 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
3811 qdict
= qemu_opts_to_qdict(opts
, NULL
);
3813 if (!qdict_get_try_str(qdict
, "node-name")) {
3815 error_report("'node-name' needs to be specified");
3819 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
3821 error_report_err(local_err
);
3825 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3828 qemu_opts_del(opts
);
3831 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3833 BlockDriverState
*bs
;
3835 Visitor
*v
= qobject_output_visitor_new(&obj
);
3837 Error
*local_err
= NULL
;
3839 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
3841 error_propagate(errp
, local_err
);
3845 visit_complete(v
, &obj
);
3846 qdict
= qobject_to_qdict(obj
);
3848 qdict_flatten(qdict
);
3850 if (!qdict_get_try_str(qdict
, "node-name")) {
3851 error_setg(errp
, "'node-name' must be specified for the root node");
3855 bs
= bds_tree_init(qdict
, errp
);
3860 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3862 if (bs
&& bdrv_key_required(bs
)) {
3863 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3865 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3873 void qmp_x_blockdev_del(const char *node_name
, Error
**errp
)
3875 AioContext
*aio_context
;
3876 BlockDriverState
*bs
;
3878 bs
= bdrv_find_node(node_name
);
3880 error_setg(errp
, "Cannot find node %s", node_name
);
3883 if (bdrv_has_blk(bs
)) {
3884 error_setg(errp
, "Node %s is in use", node_name
);
3887 aio_context
= bdrv_get_aio_context(bs
);
3888 aio_context_acquire(aio_context
);
3890 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
3894 if (!bs
->monitor_list
.tqe_prev
) {
3895 error_setg(errp
, "Node %s is not owned by the monitor",
3900 if (bs
->refcnt
> 1) {
3901 error_setg(errp
, "Block device %s is in use",
3902 bdrv_get_device_or_node_name(bs
));
3906 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3910 aio_context_release(aio_context
);
3913 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
3914 const char *child_name
)
3918 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
3919 if (strcmp(child
->name
, child_name
) == 0) {
3927 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
3928 const char *child
, bool has_node
,
3929 const char *node
, Error
**errp
)
3931 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
3934 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
3939 if (has_child
== has_node
) {
3941 error_setg(errp
, "The parameters child and node are in conflict");
3943 error_setg(errp
, "Either child or node must be specified");
3949 p_child
= bdrv_find_child(parent_bs
, child
);
3951 error_setg(errp
, "Node '%s' does not have child '%s'",
3955 bdrv_del_child(parent_bs
, p_child
, errp
);
3959 new_bs
= bdrv_find_node(node
);
3961 error_setg(errp
, "Node '%s' not found", node
);
3964 bdrv_add_child(parent_bs
, new_bs
, errp
);
3968 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3970 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3973 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
3974 BlockJobInfoList
*elem
;
3975 AioContext
*aio_context
;
3977 if (block_job_is_internal(job
)) {
3980 elem
= g_new0(BlockJobInfoList
, 1);
3981 aio_context
= blk_get_aio_context(job
->blk
);
3982 aio_context_acquire(aio_context
);
3983 elem
->value
= block_job_query(job
, errp
);
3984 aio_context_release(aio_context
);
3987 qapi_free_BlockJobInfoList(head
);
3991 p_next
= &elem
->next
;
3997 QemuOptsList qemu_common_drive_opts
= {
3999 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4003 .type
= QEMU_OPT_BOOL
,
4004 .help
= "enable/disable snapshot mode",
4007 .type
= QEMU_OPT_STRING
,
4008 .help
= "host AIO implementation (threads, native)",
4010 .name
= BDRV_OPT_CACHE_WB
,
4011 .type
= QEMU_OPT_BOOL
,
4012 .help
= "Enable writeback mode",
4015 .type
= QEMU_OPT_STRING
,
4016 .help
= "disk format (raw, qcow2, ...)",
4019 .type
= QEMU_OPT_STRING
,
4020 .help
= "read error action",
4023 .type
= QEMU_OPT_STRING
,
4024 .help
= "write error action",
4026 .name
= BDRV_OPT_READ_ONLY
,
4027 .type
= QEMU_OPT_BOOL
,
4028 .help
= "open drive file as read-only",
4034 .name
= "throttling.group",
4035 .type
= QEMU_OPT_STRING
,
4036 .help
= "name of the block throttling group",
4038 .name
= "copy-on-read",
4039 .type
= QEMU_OPT_BOOL
,
4040 .help
= "copy read data from backing file into image file",
4042 .name
= "detect-zeroes",
4043 .type
= QEMU_OPT_STRING
,
4044 .help
= "try to optimize zero writes (off, on, unmap)",
4046 .name
= "stats-account-invalid",
4047 .type
= QEMU_OPT_BOOL
,
4048 .help
= "whether to account for invalid I/O operations "
4049 "in the statistics",
4051 .name
= "stats-account-failed",
4052 .type
= QEMU_OPT_BOOL
,
4053 .help
= "whether to account for failed I/O operations "
4054 "in the statistics",
4056 { /* end of list */ }
4060 QemuOptsList qemu_drive_opts
= {
4062 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4065 * no elements => accept any params
4066 * validation will happen later
4068 { /* end of list */ }