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/qmp-output-visitor.h"
47 #include "qapi/util.h"
48 #include "sysemu/sysemu.h"
49 #include "block/block_int.h"
50 #include "qmp-commands.h"
52 #include "sysemu/arch_init.h"
53 #include "qemu/cutils.h"
54 #include "qemu/help_option.h"
56 static QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
57 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
59 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
60 bool force
, Error
**errp
);
62 static const char *const if_name
[IF_COUNT
] = {
66 [IF_FLOPPY
] = "floppy",
67 [IF_PFLASH
] = "pflash",
70 [IF_VIRTIO
] = "virtio",
74 static int if_max_devs
[IF_COUNT
] = {
76 * Do not change these numbers! They govern how drive option
77 * index maps to unit and bus. That mapping is ABI.
79 * All controllers used to implement if=T drives need to support
80 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
81 * Otherwise, some index values map to "impossible" bus, unit
84 * For instance, if you change [IF_SCSI] to 255, -drive
85 * if=scsi,index=12 no longer means bus=1,unit=5, but
86 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
87 * the drive can't be set up. Regression.
94 * Boards may call this to offer board-by-board overrides
95 * of the default, global values.
97 void override_max_devs(BlockInterfaceType type
, int max_devs
)
106 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
107 dinfo
= blk_legacy_dinfo(blk
);
108 if (dinfo
->type
== type
) {
109 fprintf(stderr
, "Cannot override units-per-bus property of"
110 " the %s interface, because a drive of that type has"
111 " already been added.\n", if_name
[type
]);
112 g_assert_not_reached();
116 if_max_devs
[type
] = max_devs
;
120 * We automatically delete the drive when a device using it gets
121 * unplugged. Questionable feature, but we can't just drop it.
122 * Device models call blockdev_mark_auto_del() to schedule the
123 * automatic deletion, and generic qdev code calls blockdev_auto_del()
124 * when deletion is actually safe.
126 void blockdev_mark_auto_del(BlockBackend
*blk
)
128 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
129 BlockDriverState
*bs
= blk_bs(blk
);
130 AioContext
*aio_context
;
137 aio_context
= bdrv_get_aio_context(bs
);
138 aio_context_acquire(aio_context
);
141 block_job_cancel(bs
->job
);
144 aio_context_release(aio_context
);
150 void blockdev_auto_del(BlockBackend
*blk
)
152 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
154 if (dinfo
&& dinfo
->auto_del
) {
155 monitor_remove_blk(blk
);
161 * Returns the current mapping of how many units per bus
162 * a particular interface can support.
164 * A positive integer indicates n units per bus.
165 * 0 implies the mapping has not been established.
166 * -1 indicates an invalid BlockInterfaceType was given.
168 int drive_get_max_devs(BlockInterfaceType type
)
170 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
171 return if_max_devs
[type
];
177 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
179 int max_devs
= if_max_devs
[type
];
180 return max_devs
? index
/ max_devs
: 0;
183 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
185 int max_devs
= if_max_devs
[type
];
186 return max_devs
? index
% max_devs
: index
;
189 QemuOpts
*drive_def(const char *optstr
)
191 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
194 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
199 opts
= drive_def(optstr
);
203 if (type
!= IF_DEFAULT
) {
204 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
207 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
210 qemu_opt_set(opts
, "file", file
, &error_abort
);
214 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
219 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
220 dinfo
= blk_legacy_dinfo(blk
);
221 if (dinfo
&& dinfo
->type
== type
222 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
230 bool drive_check_orphaned(void)
236 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
237 dinfo
= blk_legacy_dinfo(blk
);
238 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
239 /* Unless this is a default drive, this may be an oversight. */
240 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
241 dinfo
->type
!= IF_NONE
) {
242 fprintf(stderr
, "Warning: Orphaned drive without device: "
243 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
244 blk_name(blk
), blk_bs(blk
) ? blk_bs(blk
)->filename
: "",
245 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
253 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
255 return drive_get(type
,
256 drive_index_to_bus_id(type
, index
),
257 drive_index_to_unit_id(type
, index
));
260 int drive_get_max_bus(BlockInterfaceType type
)
267 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
268 dinfo
= blk_legacy_dinfo(blk
);
269 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
270 max_bus
= dinfo
->bus
;
276 /* Get a block device. This should only be used for single-drive devices
277 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
279 DriveInfo
*drive_get_next(BlockInterfaceType type
)
281 static int next_block_unit
[IF_COUNT
];
283 return drive_get(type
, 0, next_block_unit
[type
]++);
286 static void bdrv_format_print(void *opaque
, const char *name
)
288 error_printf(" %s", name
);
293 BlockDriverState
*bs
;
296 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
298 if (!strcmp(buf
, "ignore")) {
299 return BLOCKDEV_ON_ERROR_IGNORE
;
300 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
301 return BLOCKDEV_ON_ERROR_ENOSPC
;
302 } else if (!strcmp(buf
, "stop")) {
303 return BLOCKDEV_ON_ERROR_STOP
;
304 } else if (!strcmp(buf
, "report")) {
305 return BLOCKDEV_ON_ERROR_REPORT
;
307 error_setg(errp
, "'%s' invalid %s error action",
308 buf
, is_read
? "read" : "write");
313 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
316 const QListEntry
*entry
;
317 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
318 switch (qobject_type(entry
->value
)) {
320 case QTYPE_QSTRING
: {
321 unsigned long long length
;
322 const char *str
= qstring_get_str(qobject_to_qstring(entry
->value
));
323 if (parse_uint_full(str
, &length
, 10) == 0 &&
324 length
> 0 && length
<= UINT_MAX
) {
325 block_acct_add_interval(stats
, (unsigned) length
);
327 error_setg(errp
, "Invalid interval length: %s", str
);
334 int64_t length
= qint_get_int(qobject_to_qint(entry
->value
));
335 if (length
> 0 && length
<= UINT_MAX
) {
336 block_acct_add_interval(stats
, (unsigned) length
);
338 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
345 error_setg(errp
, "The specification of stats-intervals is invalid");
352 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
354 /* All parameters but @opts are optional and may be set to NULL. */
355 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
356 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
357 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
359 Error
*local_error
= NULL
;
363 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
364 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
367 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
368 if (!strcmp(aio
, "native")) {
369 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
370 } else if (!strcmp(aio
, "threads")) {
371 /* this is the default */
373 error_setg(errp
, "invalid aio option");
379 /* disk I/O throttling */
380 if (throttling_group
) {
381 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
385 throttle_config_init(throttle_cfg
);
386 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
387 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
388 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
389 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
390 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
391 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
392 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
393 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
394 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
395 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
396 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
397 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
399 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
400 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
401 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
402 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
403 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
404 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
405 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
406 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
407 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
408 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
409 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
410 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
412 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].burst_length
=
413 qemu_opt_get_number(opts
, "throttling.bps-total-max-length", 1);
414 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].burst_length
=
415 qemu_opt_get_number(opts
, "throttling.bps-read-max-length", 1);
416 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].burst_length
=
417 qemu_opt_get_number(opts
, "throttling.bps-write-max-length", 1);
418 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].burst_length
=
419 qemu_opt_get_number(opts
, "throttling.iops-total-max-length", 1);
420 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].burst_length
=
421 qemu_opt_get_number(opts
, "throttling.iops-read-max-length", 1);
422 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].burst_length
=
423 qemu_opt_get_number(opts
, "throttling.iops-write-max-length", 1);
425 throttle_cfg
->op_size
=
426 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
428 if (!throttle_is_valid(throttle_cfg
, errp
)) {
435 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
436 qemu_opt_get(opts
, "detect-zeroes"),
437 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX
,
438 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
441 error_propagate(errp
, local_error
);
447 /* Takes the ownership of bs_opts */
448 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
453 int on_read_error
, on_write_error
;
454 bool account_invalid
, account_failed
;
455 bool writethrough
, read_only
;
457 BlockDriverState
*bs
;
462 QDict
*interval_dict
= NULL
;
463 QList
*interval_list
= NULL
;
465 BlockdevDetectZeroesOptions detect_zeroes
=
466 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
467 const char *throttling_group
= NULL
;
469 /* Check common options by copying from bs_opts to opts, all other options
470 * stay in bs_opts for processing by bdrv_open(). */
471 id
= qdict_get_try_str(bs_opts
, "id");
472 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
474 error_propagate(errp
, error
);
478 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
480 error_propagate(errp
, error
);
485 qdict_del(bs_opts
, "id");
488 /* extract parameters */
489 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
491 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
492 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
494 writethrough
= !qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true);
496 id
= qemu_opts_id(opts
);
498 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
499 qdict_array_split(interval_dict
, &interval_list
);
501 if (qdict_size(interval_dict
) != 0) {
502 error_setg(errp
, "Invalid option stats-intervals.%s",
503 qdict_first(interval_dict
)->key
);
507 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
508 &detect_zeroes
, &error
);
510 error_propagate(errp
, error
);
514 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
515 if (is_help_option(buf
)) {
516 error_printf("Supported formats:");
517 bdrv_iterate_format(bdrv_format_print
, NULL
);
522 if (qdict_haskey(bs_opts
, "driver")) {
523 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
526 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
529 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
530 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
531 on_write_error
= parse_block_error_action(buf
, 0, &error
);
533 error_propagate(errp
, error
);
538 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
539 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
540 on_read_error
= parse_block_error_action(buf
, 1, &error
);
542 error_propagate(errp
, error
);
548 bdrv_flags
|= BDRV_O_SNAPSHOT
;
551 read_only
= qemu_opt_get_bool(opts
, BDRV_OPT_READ_ONLY
, false);
554 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
555 BlockBackendRootState
*blk_rs
;
558 blk_rs
= blk_get_root_state(blk
);
559 blk_rs
->open_flags
= bdrv_flags
;
560 blk_rs
->read_only
= read_only
;
561 blk_rs
->detect_zeroes
= detect_zeroes
;
565 if (file
&& !*file
) {
569 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
570 * with other callers) rather than what we want as the real defaults.
571 * Apply the defaults here instead. */
572 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
573 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
574 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
,
575 read_only
? "on" : "off");
576 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
578 if (runstate_check(RUN_STATE_INMIGRATE
)) {
579 bdrv_flags
|= BDRV_O_INACTIVE
;
582 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
588 bs
->detect_zeroes
= detect_zeroes
;
590 if (bdrv_key_required(bs
)) {
594 block_acct_init(blk_get_stats(blk
), account_invalid
, account_failed
);
596 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
603 /* disk I/O throttling */
604 if (throttle_enabled(&cfg
)) {
605 if (!throttling_group
) {
606 throttling_group
= id
;
608 blk_io_limits_enable(blk
, throttling_group
);
609 blk_set_io_limits(blk
, &cfg
);
612 blk_set_enable_write_cache(blk
, !writethrough
);
613 blk_set_on_error(blk
, on_read_error
, on_write_error
);
615 if (!monitor_add_blk(blk
, id
, errp
)) {
623 QDECREF(interval_dict
);
624 QDECREF(interval_list
);
629 QDECREF(interval_dict
);
630 QDECREF(interval_list
);
636 /* Takes the ownership of bs_opts */
637 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
641 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
642 * with other callers) rather than what we want as the real defaults.
643 * Apply the defaults here instead. */
644 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
645 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
646 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
648 if (runstate_check(RUN_STATE_INMIGRATE
)) {
649 bdrv_flags
|= BDRV_O_INACTIVE
;
652 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
655 void blockdev_close_all_bdrv_states(void)
657 BlockDriverState
*bs
, *next_bs
;
659 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
660 AioContext
*ctx
= bdrv_get_aio_context(bs
);
662 aio_context_acquire(ctx
);
664 aio_context_release(ctx
);
668 /* Iterates over the list of monitor-owned BlockDriverStates */
669 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
671 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
672 : QTAILQ_FIRST(&monitor_bdrv_states
);
675 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
680 value
= qemu_opt_get(opts
, from
);
682 if (qemu_opt_find(opts
, to
)) {
683 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
684 "same time", to
, from
);
689 /* rename all items in opts */
690 while ((value
= qemu_opt_get(opts
, from
))) {
691 qemu_opt_set(opts
, to
, value
, &error_abort
);
692 qemu_opt_unset(opts
, from
);
696 QemuOptsList qemu_legacy_drive_opts
= {
698 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
702 .type
= QEMU_OPT_NUMBER
,
703 .help
= "bus number",
706 .type
= QEMU_OPT_NUMBER
,
707 .help
= "unit number (i.e. lun for scsi)",
710 .type
= QEMU_OPT_NUMBER
,
711 .help
= "index number",
714 .type
= QEMU_OPT_STRING
,
715 .help
= "media type (disk, cdrom)",
718 .type
= QEMU_OPT_STRING
,
719 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
722 .type
= QEMU_OPT_NUMBER
,
723 .help
= "number of cylinders (ide disk geometry)",
726 .type
= QEMU_OPT_NUMBER
,
727 .help
= "number of heads (ide disk geometry)",
730 .type
= QEMU_OPT_NUMBER
,
731 .help
= "number of sectors (ide disk geometry)",
734 .type
= QEMU_OPT_STRING
,
735 .help
= "chs translation (auto, lba, none)",
738 .type
= QEMU_OPT_BOOL
,
739 .help
= "(deprecated, ignored)",
742 .type
= QEMU_OPT_STRING
,
743 .help
= "pci address (virtio only)",
746 .type
= QEMU_OPT_STRING
,
747 .help
= "disk serial number",
750 .type
= QEMU_OPT_STRING
,
754 /* Options that are passed on, but have special semantics with -drive */
756 .name
= BDRV_OPT_READ_ONLY
,
757 .type
= QEMU_OPT_BOOL
,
758 .help
= "open drive file as read-only",
761 .type
= QEMU_OPT_STRING
,
762 .help
= "read error action",
765 .type
= QEMU_OPT_STRING
,
766 .help
= "write error action",
768 .name
= "copy-on-read",
769 .type
= QEMU_OPT_BOOL
,
770 .help
= "copy read data from backing file into image file",
773 { /* end of list */ }
777 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
781 DriveInfo
*dinfo
= NULL
;
783 QemuOpts
*legacy_opts
;
784 DriveMediaType media
= MEDIA_DISK
;
785 BlockInterfaceType type
;
786 int cyls
, heads
, secs
, translation
;
787 int max_devs
, bus_id
, unit_id
, index
;
789 const char *werror
, *rerror
;
790 bool read_only
= false;
793 const char *filename
;
794 Error
*local_err
= NULL
;
797 /* Change legacy command line options into QMP ones */
798 static const struct {
802 { "iops", "throttling.iops-total" },
803 { "iops_rd", "throttling.iops-read" },
804 { "iops_wr", "throttling.iops-write" },
806 { "bps", "throttling.bps-total" },
807 { "bps_rd", "throttling.bps-read" },
808 { "bps_wr", "throttling.bps-write" },
810 { "iops_max", "throttling.iops-total-max" },
811 { "iops_rd_max", "throttling.iops-read-max" },
812 { "iops_wr_max", "throttling.iops-write-max" },
814 { "bps_max", "throttling.bps-total-max" },
815 { "bps_rd_max", "throttling.bps-read-max" },
816 { "bps_wr_max", "throttling.bps-write-max" },
818 { "iops_size", "throttling.iops-size" },
820 { "group", "throttling.group" },
822 { "readonly", BDRV_OPT_READ_ONLY
},
825 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
826 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
829 error_report_err(local_err
);
834 value
= qemu_opt_get(all_opts
, "cache");
839 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
840 error_report("invalid cache option");
844 /* Specific options take precedence */
845 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
846 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
847 !writethrough
, &error_abort
);
849 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
850 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
851 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
853 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
854 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
855 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
857 qemu_opt_unset(all_opts
, "cache");
860 /* Get a QDict for processing the options */
861 bs_opts
= qdict_new();
862 qemu_opts_to_qdict(all_opts
, bs_opts
);
864 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
866 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
868 error_report_err(local_err
);
872 /* Deprecated option boot=[on|off] */
873 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
874 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
875 "ignored. Future versions will reject this parameter. Please "
876 "update your scripts.\n");
880 value
= qemu_opt_get(legacy_opts
, "media");
882 if (!strcmp(value
, "disk")) {
884 } else if (!strcmp(value
, "cdrom")) {
888 error_report("'%s' invalid media", value
);
893 /* copy-on-read is disabled with a warning for read-only devices */
894 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
895 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
897 if (read_only
&& copy_on_read
) {
898 error_report("warning: disabling copy-on-read on read-only drive");
899 copy_on_read
= false;
902 qdict_put(bs_opts
, BDRV_OPT_READ_ONLY
,
903 qstring_from_str(read_only
? "on" : "off"));
904 qdict_put(bs_opts
, "copy-on-read",
905 qstring_from_str(copy_on_read
? "on" :"off"));
907 /* Controller type */
908 value
= qemu_opt_get(legacy_opts
, "if");
911 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
914 if (type
== IF_COUNT
) {
915 error_report("unsupported bus type '%s'", value
);
919 type
= block_default_type
;
923 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
924 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
925 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
927 if (cyls
|| heads
|| secs
) {
929 error_report("invalid physical cyls number");
933 error_report("invalid physical heads number");
937 error_report("invalid physical secs number");
942 translation
= BIOS_ATA_TRANSLATION_AUTO
;
943 value
= qemu_opt_get(legacy_opts
, "trans");
946 error_report("'%s' trans must be used with cyls, heads and secs",
950 if (!strcmp(value
, "none")) {
951 translation
= BIOS_ATA_TRANSLATION_NONE
;
952 } else if (!strcmp(value
, "lba")) {
953 translation
= BIOS_ATA_TRANSLATION_LBA
;
954 } else if (!strcmp(value
, "large")) {
955 translation
= BIOS_ATA_TRANSLATION_LARGE
;
956 } else if (!strcmp(value
, "rechs")) {
957 translation
= BIOS_ATA_TRANSLATION_RECHS
;
958 } else if (!strcmp(value
, "auto")) {
959 translation
= BIOS_ATA_TRANSLATION_AUTO
;
961 error_report("'%s' invalid translation type", value
);
966 if (media
== MEDIA_CDROM
) {
967 if (cyls
|| secs
|| heads
) {
968 error_report("CHS can't be set with media=cdrom");
973 /* Device address specified by bus/unit or index.
974 * If none was specified, try to find the first free one. */
975 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
976 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
977 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
979 max_devs
= if_max_devs
[type
];
982 if (bus_id
!= 0 || unit_id
!= -1) {
983 error_report("index cannot be used with bus and unit");
986 bus_id
= drive_index_to_bus_id(type
, index
);
987 unit_id
= drive_index_to_unit_id(type
, index
);
992 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
994 if (max_devs
&& unit_id
>= max_devs
) {
1001 if (max_devs
&& unit_id
>= max_devs
) {
1002 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
1006 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1007 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1008 bus_id
, unit_id
, index
);
1013 serial
= qemu_opt_get(legacy_opts
, "serial");
1015 /* no id supplied -> create one */
1016 if (qemu_opts_id(all_opts
) == NULL
) {
1018 const char *mediastr
= "";
1019 if (type
== IF_IDE
|| type
== IF_SCSI
) {
1020 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
1023 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
1026 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
1029 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
1033 /* Add virtio block device */
1034 devaddr
= qemu_opt_get(legacy_opts
, "addr");
1035 if (devaddr
&& type
!= IF_VIRTIO
) {
1036 error_report("addr is not supported by this bus type");
1040 if (type
== IF_VIRTIO
) {
1042 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
1044 if (arch_type
== QEMU_ARCH_S390X
) {
1045 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
1047 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
1049 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
1052 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
1056 filename
= qemu_opt_get(legacy_opts
, "file");
1058 /* Check werror/rerror compatibility with if=... */
1059 werror
= qemu_opt_get(legacy_opts
, "werror");
1060 if (werror
!= NULL
) {
1061 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
1063 error_report("werror is not supported by this bus type");
1066 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
1069 rerror
= qemu_opt_get(legacy_opts
, "rerror");
1070 if (rerror
!= NULL
) {
1071 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
1073 error_report("rerror is not supported by this bus type");
1076 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
1079 /* Actual block device init: Functionality shared with blockdev-add */
1080 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
1084 error_report_err(local_err
);
1091 /* Create legacy DriveInfo */
1092 dinfo
= g_malloc0(sizeof(*dinfo
));
1093 dinfo
->opts
= all_opts
;
1096 dinfo
->heads
= heads
;
1098 dinfo
->trans
= translation
;
1101 dinfo
->bus
= bus_id
;
1102 dinfo
->unit
= unit_id
;
1103 dinfo
->devaddr
= devaddr
;
1104 dinfo
->serial
= g_strdup(serial
);
1106 blk_set_legacy_dinfo(blk
, dinfo
);
1113 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1120 qemu_opts_del(legacy_opts
);
1125 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1127 BlockDriverState
*bs
;
1129 bs
= bdrv_lookup_bs(name
, name
, errp
);
1134 if (!bdrv_is_root_node(bs
)) {
1135 error_setg(errp
, "Need a root block node");
1139 if (!bdrv_is_inserted(bs
)) {
1140 error_setg(errp
, "Device has no medium");
1147 static BlockBackend
*qmp_get_blk(const char *blk_name
, const char *qdev_id
,
1152 if (!blk_name
== !qdev_id
) {
1153 error_setg(errp
, "Need exactly one of 'device' and 'id'");
1158 blk
= blk_by_qdev_id(qdev_id
, errp
);
1160 blk
= blk_by_name(blk_name
);
1162 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1163 "Device '%s' not found", blk_name
);
1170 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1172 const char *device
= qdict_get_str(qdict
, "device");
1176 if (!strcmp(device
, "all")) {
1177 ret
= blk_commit_all();
1179 BlockDriverState
*bs
;
1180 AioContext
*aio_context
;
1182 blk
= blk_by_name(device
);
1184 monitor_printf(mon
, "Device '%s' not found\n", device
);
1187 if (!blk_is_available(blk
)) {
1188 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1193 aio_context
= bdrv_get_aio_context(bs
);
1194 aio_context_acquire(aio_context
);
1196 ret
= bdrv_commit(bs
);
1198 aio_context_release(aio_context
);
1201 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1206 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1208 TransactionActionList list
;
1210 list
.value
= action
;
1212 qmp_transaction(&list
, false, NULL
, errp
);
1215 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1216 bool has_node_name
, const char *node_name
,
1217 const char *snapshot_file
,
1218 bool has_snapshot_node_name
,
1219 const char *snapshot_node_name
,
1220 bool has_format
, const char *format
,
1221 bool has_mode
, NewImageMode mode
, Error
**errp
)
1223 BlockdevSnapshotSync snapshot
= {
1224 .has_device
= has_device
,
1225 .device
= (char *) device
,
1226 .has_node_name
= has_node_name
,
1227 .node_name
= (char *) node_name
,
1228 .snapshot_file
= (char *) snapshot_file
,
1229 .has_snapshot_node_name
= has_snapshot_node_name
,
1230 .snapshot_node_name
= (char *) snapshot_node_name
,
1231 .has_format
= has_format
,
1232 .format
= (char *) format
,
1233 .has_mode
= has_mode
,
1236 TransactionAction action
= {
1237 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1238 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1240 blockdev_do_action(&action
, errp
);
1243 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1246 BlockdevSnapshot snapshot_data
= {
1247 .node
= (char *) node
,
1248 .overlay
= (char *) overlay
1250 TransactionAction action
= {
1251 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1252 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1254 blockdev_do_action(&action
, errp
);
1257 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1261 BlockdevSnapshotInternal snapshot
= {
1262 .device
= (char *) device
,
1263 .name
= (char *) name
1265 TransactionAction action
= {
1266 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1267 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1269 blockdev_do_action(&action
, errp
);
1272 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1279 BlockDriverState
*bs
;
1280 AioContext
*aio_context
;
1281 QEMUSnapshotInfo sn
;
1282 Error
*local_err
= NULL
;
1283 SnapshotInfo
*info
= NULL
;
1286 bs
= qmp_get_root_bs(device
, errp
);
1290 aio_context
= bdrv_get_aio_context(bs
);
1291 aio_context_acquire(aio_context
);
1302 error_setg(errp
, "Name or id must be provided");
1303 goto out_aio_context
;
1306 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1307 goto out_aio_context
;
1310 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1312 error_propagate(errp
, local_err
);
1313 goto out_aio_context
;
1317 "Snapshot with id '%s' and name '%s' does not exist on "
1319 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1320 goto out_aio_context
;
1323 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1325 error_propagate(errp
, local_err
);
1326 goto out_aio_context
;
1329 aio_context_release(aio_context
);
1331 info
= g_new0(SnapshotInfo
, 1);
1332 info
->id
= g_strdup(sn
.id_str
);
1333 info
->name
= g_strdup(sn
.name
);
1334 info
->date_nsec
= sn
.date_nsec
;
1335 info
->date_sec
= sn
.date_sec
;
1336 info
->vm_state_size
= sn
.vm_state_size
;
1337 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1338 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1343 aio_context_release(aio_context
);
1348 * block_dirty_bitmap_lookup:
1349 * Return a dirty bitmap (if present), after validating
1350 * the node reference and bitmap names.
1352 * @node: The name of the BDS node to search for bitmaps
1353 * @name: The name of the bitmap to search for
1354 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1355 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1356 * @errp: Output pointer for error information. Can be NULL.
1358 * @return: A bitmap object on success, or NULL on failure.
1360 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1362 BlockDriverState
**pbs
,
1366 BlockDriverState
*bs
;
1367 BdrvDirtyBitmap
*bitmap
;
1368 AioContext
*aio_context
;
1371 error_setg(errp
, "Node cannot be NULL");
1375 error_setg(errp
, "Bitmap name cannot be NULL");
1378 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1380 error_setg(errp
, "Node '%s' not found", node
);
1384 aio_context
= bdrv_get_aio_context(bs
);
1385 aio_context_acquire(aio_context
);
1387 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1389 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1397 *paio
= aio_context
;
1399 aio_context_release(aio_context
);
1405 aio_context_release(aio_context
);
1409 /* New and old BlockDriverState structs for atomic group operations */
1411 typedef struct BlkActionState BlkActionState
;
1415 * Table of operations that define an Action.
1417 * @instance_size: Size of state struct, in bytes.
1418 * @prepare: Prepare the work, must NOT be NULL.
1419 * @commit: Commit the changes, can be NULL.
1420 * @abort: Abort the changes on fail, can be NULL.
1421 * @clean: Clean up resources after all transaction actions have called
1422 * commit() or abort(). Can be NULL.
1424 * Only prepare() may fail. In a single transaction, only one of commit() or
1425 * abort() will be called. clean() will always be called if it is present.
1427 typedef struct BlkActionOps
{
1428 size_t instance_size
;
1429 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1430 void (*commit
)(BlkActionState
*common
);
1431 void (*abort
)(BlkActionState
*common
);
1432 void (*clean
)(BlkActionState
*common
);
1437 * Describes one Action's state within a Transaction.
1439 * @action: QAPI-defined enum identifying which Action to perform.
1440 * @ops: Table of ActionOps this Action can perform.
1441 * @block_job_txn: Transaction which this action belongs to.
1442 * @entry: List membership for all Actions in this Transaction.
1444 * This structure must be arranged as first member in a subclassed type,
1445 * assuming that the compiler will also arrange it to the same offsets as the
1448 struct BlkActionState
{
1449 TransactionAction
*action
;
1450 const BlkActionOps
*ops
;
1451 BlockJobTxn
*block_job_txn
;
1452 TransactionProperties
*txn_props
;
1453 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1456 /* internal snapshot private data */
1457 typedef struct InternalSnapshotState
{
1458 BlkActionState common
;
1459 BlockDriverState
*bs
;
1460 AioContext
*aio_context
;
1461 QEMUSnapshotInfo sn
;
1463 } InternalSnapshotState
;
1466 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1468 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1470 "Action '%s' does not support Transaction property "
1471 "completion-mode = %s",
1472 TransactionActionKind_lookup
[s
->action
->type
],
1473 ActionCompletionMode_lookup
[s
->txn_props
->completion_mode
]);
1479 static void internal_snapshot_prepare(BlkActionState
*common
,
1482 Error
*local_err
= NULL
;
1485 BlockDriverState
*bs
;
1486 QEMUSnapshotInfo old_sn
, *sn
;
1489 BlockdevSnapshotInternal
*internal
;
1490 InternalSnapshotState
*state
;
1493 g_assert(common
->action
->type
==
1494 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1495 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1496 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1498 /* 1. parse input */
1499 device
= internal
->device
;
1500 name
= internal
->name
;
1502 /* 2. check for validation */
1503 if (action_check_completion_mode(common
, errp
) < 0) {
1507 bs
= qmp_get_root_bs(device
, errp
);
1512 /* AioContext is released in .clean() */
1513 state
->aio_context
= bdrv_get_aio_context(bs
);
1514 aio_context_acquire(state
->aio_context
);
1517 bdrv_drained_begin(bs
);
1519 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1523 if (bdrv_is_read_only(bs
)) {
1524 error_setg(errp
, "Device '%s' is read only", device
);
1528 if (!bdrv_can_snapshot(bs
)) {
1529 error_setg(errp
, "Block format '%s' used by device '%s' "
1530 "does not support internal snapshots",
1531 bs
->drv
->format_name
, device
);
1535 if (!strlen(name
)) {
1536 error_setg(errp
, "Name is empty");
1540 /* check whether a snapshot with name exist */
1541 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1544 error_propagate(errp
, local_err
);
1548 "Snapshot with name '%s' already exists on device '%s'",
1553 /* 3. take the snapshot */
1555 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1556 qemu_gettimeofday(&tv
);
1557 sn
->date_sec
= tv
.tv_sec
;
1558 sn
->date_nsec
= tv
.tv_usec
* 1000;
1559 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1561 ret1
= bdrv_snapshot_create(bs
, sn
);
1563 error_setg_errno(errp
, -ret1
,
1564 "Failed to create snapshot '%s' on device '%s'",
1569 /* 4. succeed, mark a snapshot is created */
1570 state
->created
= true;
1573 static void internal_snapshot_abort(BlkActionState
*common
)
1575 InternalSnapshotState
*state
=
1576 DO_UPCAST(InternalSnapshotState
, common
, common
);
1577 BlockDriverState
*bs
= state
->bs
;
1578 QEMUSnapshotInfo
*sn
= &state
->sn
;
1579 Error
*local_error
= NULL
;
1581 if (!state
->created
) {
1585 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1586 error_reportf_err(local_error
,
1587 "Failed to delete snapshot with id '%s' and "
1588 "name '%s' on device '%s' in abort: ",
1589 sn
->id_str
, sn
->name
,
1590 bdrv_get_device_name(bs
));
1594 static void internal_snapshot_clean(BlkActionState
*common
)
1596 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1599 if (state
->aio_context
) {
1601 bdrv_drained_end(state
->bs
);
1603 aio_context_release(state
->aio_context
);
1607 /* external snapshot private data */
1608 typedef struct ExternalSnapshotState
{
1609 BlkActionState common
;
1610 BlockDriverState
*old_bs
;
1611 BlockDriverState
*new_bs
;
1612 AioContext
*aio_context
;
1613 } ExternalSnapshotState
;
1615 static void external_snapshot_prepare(BlkActionState
*common
,
1619 QDict
*options
= NULL
;
1620 Error
*local_err
= NULL
;
1621 /* Device and node name of the image to generate the snapshot from */
1623 const char *node_name
;
1624 /* Reference to the new image (for 'blockdev-snapshot') */
1625 const char *snapshot_ref
;
1626 /* File name of the new image (for 'blockdev-snapshot-sync') */
1627 const char *new_image_file
;
1628 ExternalSnapshotState
*state
=
1629 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1630 TransactionAction
*action
= common
->action
;
1632 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1633 * purpose but a different set of parameters */
1634 switch (action
->type
) {
1635 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1637 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1639 node_name
= s
->node
;
1640 new_image_file
= NULL
;
1641 snapshot_ref
= s
->overlay
;
1644 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1646 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1647 device
= s
->has_device
? s
->device
: NULL
;
1648 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1649 new_image_file
= s
->snapshot_file
;
1650 snapshot_ref
= NULL
;
1654 g_assert_not_reached();
1657 /* start processing */
1658 if (action_check_completion_mode(common
, errp
) < 0) {
1662 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1663 if (!state
->old_bs
) {
1667 /* Acquire AioContext now so any threads operating on old_bs stop */
1668 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1669 aio_context_acquire(state
->aio_context
);
1670 bdrv_drained_begin(state
->old_bs
);
1672 if (!bdrv_is_inserted(state
->old_bs
)) {
1673 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1677 if (bdrv_op_is_blocked(state
->old_bs
,
1678 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1682 if (!bdrv_is_read_only(state
->old_bs
)) {
1683 if (bdrv_flush(state
->old_bs
)) {
1684 error_setg(errp
, QERR_IO_ERROR
);
1689 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1690 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1694 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1695 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1696 const char *format
= s
->has_format
? s
->format
: "qcow2";
1697 enum NewImageMode mode
;
1698 const char *snapshot_node_name
=
1699 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1701 if (node_name
&& !snapshot_node_name
) {
1702 error_setg(errp
, "New snapshot node name missing");
1706 if (snapshot_node_name
&&
1707 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1708 error_setg(errp
, "New snapshot node name already in use");
1712 flags
= state
->old_bs
->open_flags
;
1713 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
| BDRV_O_COPY_ON_READ
);
1715 /* create new image w/backing file */
1716 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1717 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1718 int64_t size
= bdrv_getlength(state
->old_bs
);
1720 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1723 bdrv_img_create(new_image_file
, format
,
1724 state
->old_bs
->filename
,
1725 state
->old_bs
->drv
->format_name
,
1726 NULL
, size
, flags
, &local_err
, false);
1728 error_propagate(errp
, local_err
);
1733 options
= qdict_new();
1734 if (s
->has_snapshot_node_name
) {
1735 qdict_put(options
, "node-name",
1736 qstring_from_str(snapshot_node_name
));
1738 qdict_put(options
, "driver", qstring_from_str(format
));
1740 flags
|= BDRV_O_NO_BACKING
;
1743 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1745 /* We will manually add the backing_hd field to the bs later */
1746 if (!state
->new_bs
) {
1750 if (bdrv_has_blk(state
->new_bs
)) {
1751 error_setg(errp
, "The snapshot is already in use");
1755 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1760 if (state
->new_bs
->backing
!= NULL
) {
1761 error_setg(errp
, "The snapshot already has a backing image");
1765 if (!state
->new_bs
->drv
->supports_backing
) {
1766 error_setg(errp
, "The snapshot does not support backing images");
1770 static void external_snapshot_commit(BlkActionState
*common
)
1772 ExternalSnapshotState
*state
=
1773 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1775 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1777 /* This removes our old bs and adds the new bs */
1778 bdrv_append(state
->new_bs
, state
->old_bs
);
1779 /* We don't need (or want) to use the transactional
1780 * bdrv_reopen_multiple() across all the entries at once, because we
1781 * don't want to abort all of them if one of them fails the reopen */
1782 if (!state
->old_bs
->copy_on_read
) {
1783 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1788 static void external_snapshot_abort(BlkActionState
*common
)
1790 ExternalSnapshotState
*state
=
1791 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1792 if (state
->new_bs
) {
1793 bdrv_unref(state
->new_bs
);
1797 static void external_snapshot_clean(BlkActionState
*common
)
1799 ExternalSnapshotState
*state
=
1800 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1801 if (state
->aio_context
) {
1802 bdrv_drained_end(state
->old_bs
);
1803 aio_context_release(state
->aio_context
);
1807 typedef struct DriveBackupState
{
1808 BlkActionState common
;
1809 BlockDriverState
*bs
;
1810 AioContext
*aio_context
;
1814 static void do_drive_backup(DriveBackup
*backup
, BlockJobTxn
*txn
,
1817 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1819 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1820 BlockDriverState
*bs
;
1821 DriveBackup
*backup
;
1822 Error
*local_err
= NULL
;
1824 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1825 backup
= common
->action
->u
.drive_backup
.data
;
1827 bs
= qmp_get_root_bs(backup
->device
, errp
);
1832 /* AioContext is released in .clean() */
1833 state
->aio_context
= bdrv_get_aio_context(bs
);
1834 aio_context_acquire(state
->aio_context
);
1835 bdrv_drained_begin(bs
);
1838 do_drive_backup(backup
, common
->block_job_txn
, &local_err
);
1840 error_propagate(errp
, local_err
);
1844 state
->job
= state
->bs
->job
;
1847 static void drive_backup_abort(BlkActionState
*common
)
1849 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1850 BlockDriverState
*bs
= state
->bs
;
1852 /* Only cancel if it's the job we started */
1853 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1854 block_job_cancel_sync(bs
->job
);
1858 static void drive_backup_clean(BlkActionState
*common
)
1860 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1862 if (state
->aio_context
) {
1863 bdrv_drained_end(state
->bs
);
1864 aio_context_release(state
->aio_context
);
1868 typedef struct BlockdevBackupState
{
1869 BlkActionState common
;
1870 BlockDriverState
*bs
;
1872 AioContext
*aio_context
;
1873 } BlockdevBackupState
;
1875 static void do_blockdev_backup(BlockdevBackup
*backup
, BlockJobTxn
*txn
,
1878 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1880 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1881 BlockdevBackup
*backup
;
1882 BlockDriverState
*bs
, *target
;
1883 Error
*local_err
= NULL
;
1885 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1886 backup
= common
->action
->u
.blockdev_backup
.data
;
1888 bs
= qmp_get_root_bs(backup
->device
, errp
);
1893 target
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1898 /* AioContext is released in .clean() */
1899 state
->aio_context
= bdrv_get_aio_context(bs
);
1900 if (state
->aio_context
!= bdrv_get_aio_context(target
)) {
1901 state
->aio_context
= NULL
;
1902 error_setg(errp
, "Backup between two IO threads is not implemented");
1905 aio_context_acquire(state
->aio_context
);
1907 bdrv_drained_begin(state
->bs
);
1909 do_blockdev_backup(backup
, common
->block_job_txn
, &local_err
);
1911 error_propagate(errp
, local_err
);
1915 state
->job
= state
->bs
->job
;
1918 static void blockdev_backup_abort(BlkActionState
*common
)
1920 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1921 BlockDriverState
*bs
= state
->bs
;
1923 /* Only cancel if it's the job we started */
1924 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1925 block_job_cancel_sync(bs
->job
);
1929 static void blockdev_backup_clean(BlkActionState
*common
)
1931 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1933 if (state
->aio_context
) {
1934 bdrv_drained_end(state
->bs
);
1935 aio_context_release(state
->aio_context
);
1939 typedef struct BlockDirtyBitmapState
{
1940 BlkActionState common
;
1941 BdrvDirtyBitmap
*bitmap
;
1942 BlockDriverState
*bs
;
1943 AioContext
*aio_context
;
1946 } BlockDirtyBitmapState
;
1948 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1951 Error
*local_err
= NULL
;
1952 BlockDirtyBitmapAdd
*action
;
1953 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1956 if (action_check_completion_mode(common
, errp
) < 0) {
1960 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1961 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1962 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
1963 action
->has_granularity
, action
->granularity
,
1967 state
->prepared
= true;
1969 error_propagate(errp
, local_err
);
1973 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
1975 BlockDirtyBitmapAdd
*action
;
1976 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1979 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1980 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1981 * then the node reference and bitmap name must have been valid.
1983 if (state
->prepared
) {
1984 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
1988 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
1991 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1993 BlockDirtyBitmap
*action
;
1995 if (action_check_completion_mode(common
, errp
) < 0) {
1999 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2000 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2003 &state
->aio_context
,
2005 if (!state
->bitmap
) {
2009 if (bdrv_dirty_bitmap_frozen(state
->bitmap
)) {
2010 error_setg(errp
, "Cannot modify a frozen bitmap");
2012 } else if (!bdrv_dirty_bitmap_enabled(state
->bitmap
)) {
2013 error_setg(errp
, "Cannot clear a disabled bitmap");
2017 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2018 /* AioContext is released in .clean() */
2021 static void block_dirty_bitmap_clear_abort(BlkActionState
*common
)
2023 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2026 bdrv_undo_clear_dirty_bitmap(state
->bitmap
, state
->backup
);
2029 static void block_dirty_bitmap_clear_commit(BlkActionState
*common
)
2031 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2034 hbitmap_free(state
->backup
);
2037 static void block_dirty_bitmap_clear_clean(BlkActionState
*common
)
2039 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2042 if (state
->aio_context
) {
2043 aio_context_release(state
->aio_context
);
2047 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2049 error_setg(errp
, "Transaction aborted using Abort action");
2052 static void abort_commit(BlkActionState
*common
)
2054 g_assert_not_reached(); /* this action never succeeds */
2057 static const BlkActionOps actions
[] = {
2058 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2059 .instance_size
= sizeof(ExternalSnapshotState
),
2060 .prepare
= external_snapshot_prepare
,
2061 .commit
= external_snapshot_commit
,
2062 .abort
= external_snapshot_abort
,
2063 .clean
= external_snapshot_clean
,
2065 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2066 .instance_size
= sizeof(ExternalSnapshotState
),
2067 .prepare
= external_snapshot_prepare
,
2068 .commit
= external_snapshot_commit
,
2069 .abort
= external_snapshot_abort
,
2070 .clean
= external_snapshot_clean
,
2072 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2073 .instance_size
= sizeof(DriveBackupState
),
2074 .prepare
= drive_backup_prepare
,
2075 .abort
= drive_backup_abort
,
2076 .clean
= drive_backup_clean
,
2078 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2079 .instance_size
= sizeof(BlockdevBackupState
),
2080 .prepare
= blockdev_backup_prepare
,
2081 .abort
= blockdev_backup_abort
,
2082 .clean
= blockdev_backup_clean
,
2084 [TRANSACTION_ACTION_KIND_ABORT
] = {
2085 .instance_size
= sizeof(BlkActionState
),
2086 .prepare
= abort_prepare
,
2087 .commit
= abort_commit
,
2089 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2090 .instance_size
= sizeof(InternalSnapshotState
),
2091 .prepare
= internal_snapshot_prepare
,
2092 .abort
= internal_snapshot_abort
,
2093 .clean
= internal_snapshot_clean
,
2095 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2096 .instance_size
= sizeof(BlockDirtyBitmapState
),
2097 .prepare
= block_dirty_bitmap_add_prepare
,
2098 .abort
= block_dirty_bitmap_add_abort
,
2100 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2101 .instance_size
= sizeof(BlockDirtyBitmapState
),
2102 .prepare
= block_dirty_bitmap_clear_prepare
,
2103 .commit
= block_dirty_bitmap_clear_commit
,
2104 .abort
= block_dirty_bitmap_clear_abort
,
2105 .clean
= block_dirty_bitmap_clear_clean
,
2110 * Allocate a TransactionProperties structure if necessary, and fill
2111 * that structure with desired defaults if they are unset.
2113 static TransactionProperties
*get_transaction_properties(
2114 TransactionProperties
*props
)
2117 props
= g_new0(TransactionProperties
, 1);
2120 if (!props
->has_completion_mode
) {
2121 props
->has_completion_mode
= true;
2122 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2129 * 'Atomic' group operations. The operations are performed as a set, and if
2130 * any fail then we roll back all operations in the group.
2132 void qmp_transaction(TransactionActionList
*dev_list
,
2134 struct TransactionProperties
*props
,
2137 TransactionActionList
*dev_entry
= dev_list
;
2138 BlockJobTxn
*block_job_txn
= NULL
;
2139 BlkActionState
*state
, *next
;
2140 Error
*local_err
= NULL
;
2142 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkActionState
) snap_bdrv_states
;
2143 QSIMPLEQ_INIT(&snap_bdrv_states
);
2145 /* Does this transaction get canceled as a group on failure?
2146 * If not, we don't really need to make a BlockJobTxn.
2148 props
= get_transaction_properties(props
);
2149 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2150 block_job_txn
= block_job_txn_new();
2153 /* drain all i/o before any operations */
2156 /* We don't do anything in this loop that commits us to the operations */
2157 while (NULL
!= dev_entry
) {
2158 TransactionAction
*dev_info
= NULL
;
2159 const BlkActionOps
*ops
;
2161 dev_info
= dev_entry
->value
;
2162 dev_entry
= dev_entry
->next
;
2164 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2166 ops
= &actions
[dev_info
->type
];
2167 assert(ops
->instance_size
> 0);
2169 state
= g_malloc0(ops
->instance_size
);
2171 state
->action
= dev_info
;
2172 state
->block_job_txn
= block_job_txn
;
2173 state
->txn_props
= props
;
2174 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2176 state
->ops
->prepare(state
, &local_err
);
2178 error_propagate(errp
, local_err
);
2179 goto delete_and_fail
;
2183 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2184 if (state
->ops
->commit
) {
2185 state
->ops
->commit(state
);
2193 /* failure, and it is all-or-none; roll back all operations */
2194 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2195 if (state
->ops
->abort
) {
2196 state
->ops
->abort(state
);
2200 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2201 if (state
->ops
->clean
) {
2202 state
->ops
->clean(state
);
2207 qapi_free_TransactionProperties(props
);
2209 block_job_txn_unref(block_job_txn
);
2212 void qmp_eject(bool has_device
, const char *device
,
2213 bool has_id
, const char *id
,
2214 bool has_force
, bool force
, Error
**errp
)
2216 Error
*local_err
= NULL
;
2223 rc
= do_open_tray(has_device
? device
: NULL
,
2226 if (rc
&& rc
!= -ENOSYS
) {
2227 error_propagate(errp
, local_err
);
2230 error_free(local_err
);
2232 qmp_x_blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2235 void qmp_block_passwd(bool has_device
, const char *device
,
2236 bool has_node_name
, const char *node_name
,
2237 const char *password
, Error
**errp
)
2239 Error
*local_err
= NULL
;
2240 BlockDriverState
*bs
;
2241 AioContext
*aio_context
;
2243 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2244 has_node_name
? node_name
: NULL
,
2247 error_propagate(errp
, local_err
);
2251 aio_context
= bdrv_get_aio_context(bs
);
2252 aio_context_acquire(aio_context
);
2254 bdrv_add_key(bs
, password
, errp
);
2256 aio_context_release(aio_context
);
2260 * Attempt to open the tray of @device.
2261 * If @force, ignore its tray lock.
2262 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2263 * On error, store an error through @errp and return -errno.
2264 * If @device does not exist, return -ENODEV.
2265 * If it has no removable media, return -ENOTSUP.
2266 * If it has no tray, return -ENOSYS.
2267 * If the guest was asked to open the tray, return -EINPROGRESS.
2270 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2271 bool force
, Error
**errp
)
2274 const char *device
= qdev_id
?: blk_name
;
2277 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2282 if (!blk_dev_has_removable_media(blk
)) {
2283 error_setg(errp
, "Device '%s' is not removable", device
);
2287 if (!blk_dev_has_tray(blk
)) {
2288 error_setg(errp
, "Device '%s' does not have a tray", device
);
2292 if (blk_dev_is_tray_open(blk
)) {
2296 locked
= blk_dev_is_medium_locked(blk
);
2298 blk_dev_eject_request(blk
, force
);
2301 if (!locked
|| force
) {
2302 blk_dev_change_media_cb(blk
, false);
2305 if (locked
&& !force
) {
2306 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2307 "wait for tray to open and try again", device
);
2308 return -EINPROGRESS
;
2314 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2315 bool has_id
, const char *id
,
2316 bool has_force
, bool force
,
2319 Error
*local_err
= NULL
;
2325 rc
= do_open_tray(has_device
? device
: NULL
,
2328 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2329 error_propagate(errp
, local_err
);
2332 error_free(local_err
);
2335 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2336 bool has_id
, const char *id
,
2341 device
= has_device
? device
: NULL
;
2342 id
= has_id
? id
: NULL
;
2344 blk
= qmp_get_blk(device
, id
, errp
);
2349 if (!blk_dev_has_removable_media(blk
)) {
2350 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2354 if (!blk_dev_has_tray(blk
)) {
2355 /* Ignore this command on tray-less devices */
2359 if (!blk_dev_is_tray_open(blk
)) {
2363 blk_dev_change_media_cb(blk
, true);
2366 void qmp_x_blockdev_remove_medium(bool has_device
, const char *device
,
2367 bool has_id
, const char *id
, Error
**errp
)
2370 BlockDriverState
*bs
;
2371 AioContext
*aio_context
;
2372 bool has_attached_device
;
2374 device
= has_device
? device
: NULL
;
2375 id
= has_id
? id
: NULL
;
2377 blk
= qmp_get_blk(device
, id
, errp
);
2382 /* For BBs without a device, we can exchange the BDS tree at will */
2383 has_attached_device
= blk_get_attached_dev(blk
);
2385 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2386 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2390 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2391 !blk_dev_is_tray_open(blk
))
2393 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2402 aio_context
= bdrv_get_aio_context(bs
);
2403 aio_context_acquire(aio_context
);
2405 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2411 if (!blk_dev_has_tray(blk
)) {
2412 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2413 * called at all); therefore, the medium needs to be ejected here.
2414 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2415 * value passed here (i.e. false). */
2416 blk_dev_change_media_cb(blk
, false);
2420 aio_context_release(aio_context
);
2423 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2424 BlockDriverState
*bs
, Error
**errp
)
2428 /* For BBs without a device, we can exchange the BDS tree at will */
2429 has_device
= blk_get_attached_dev(blk
);
2431 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2432 error_setg(errp
, "Device is not removable");
2436 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2437 error_setg(errp
, "Tray of the device is not open");
2442 error_setg(errp
, "There already is a medium in the device");
2446 blk_insert_bs(blk
, bs
);
2448 if (!blk_dev_has_tray(blk
)) {
2449 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2450 * called at all); therefore, the medium needs to be pushed into the
2452 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2453 * value passed here (i.e. true). */
2454 blk_dev_change_media_cb(blk
, true);
2458 void qmp_x_blockdev_insert_medium(bool has_device
, const char *device
,
2459 bool has_id
, const char *id
,
2460 const char *node_name
, Error
**errp
)
2463 BlockDriverState
*bs
;
2465 blk
= qmp_get_blk(has_device
? device
: NULL
,
2472 bs
= bdrv_find_node(node_name
);
2474 error_setg(errp
, "Node '%s' not found", node_name
);
2478 if (bdrv_has_blk(bs
)) {
2479 error_setg(errp
, "Node '%s' is already in use", node_name
);
2483 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2486 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2487 bool has_id
, const char *id
,
2488 const char *filename
,
2489 bool has_format
, const char *format
,
2491 BlockdevChangeReadOnlyMode read_only
,
2495 BlockDriverState
*medium_bs
= NULL
;
2499 QDict
*options
= NULL
;
2502 blk
= qmp_get_blk(has_device
? device
: NULL
,
2510 blk_update_root_state(blk
);
2513 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2514 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2517 if (!has_read_only
) {
2518 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2521 switch (read_only
) {
2522 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2525 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2526 bdrv_flags
&= ~BDRV_O_RDWR
;
2529 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2530 bdrv_flags
|= BDRV_O_RDWR
;
2537 options
= qdict_new();
2538 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2539 qdict_put(options
, "detect-zeroes",
2540 qstring_from_str(detect_zeroes
? "on" : "off"));
2543 qdict_put(options
, "driver", qstring_from_str(format
));
2546 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2551 bdrv_add_key(medium_bs
, NULL
, &err
);
2553 error_propagate(errp
, err
);
2557 rc
= do_open_tray(has_device
? device
: NULL
,
2560 if (rc
&& rc
!= -ENOSYS
) {
2561 error_propagate(errp
, err
);
2567 qmp_x_blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2569 error_propagate(errp
, err
);
2573 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2575 error_propagate(errp
, err
);
2579 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2582 /* If the medium has been inserted, the device has its own reference, so
2583 * ours must be relinquished; and if it has not been inserted successfully,
2584 * the reference must be relinquished anyway */
2585 bdrv_unref(medium_bs
);
2588 /* throttling disk I/O limits */
2589 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2592 BlockDriverState
*bs
;
2594 AioContext
*aio_context
;
2596 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2597 arg
->has_id
? arg
->id
: NULL
,
2603 aio_context
= blk_get_aio_context(blk
);
2604 aio_context_acquire(aio_context
);
2608 error_setg(errp
, "Device has no medium");
2612 throttle_config_init(&cfg
);
2613 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2614 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2615 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2617 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2618 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2619 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2621 if (arg
->has_bps_max
) {
2622 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2624 if (arg
->has_bps_rd_max
) {
2625 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2627 if (arg
->has_bps_wr_max
) {
2628 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2630 if (arg
->has_iops_max
) {
2631 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2633 if (arg
->has_iops_rd_max
) {
2634 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2636 if (arg
->has_iops_wr_max
) {
2637 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2640 if (arg
->has_bps_max_length
) {
2641 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2643 if (arg
->has_bps_rd_max_length
) {
2644 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2646 if (arg
->has_bps_wr_max_length
) {
2647 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2649 if (arg
->has_iops_max_length
) {
2650 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2652 if (arg
->has_iops_rd_max_length
) {
2653 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2655 if (arg
->has_iops_wr_max_length
) {
2656 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2659 if (arg
->has_iops_size
) {
2660 cfg
.op_size
= arg
->iops_size
;
2663 if (!throttle_is_valid(&cfg
, errp
)) {
2667 if (throttle_enabled(&cfg
)) {
2668 /* Enable I/O limits if they're not enabled yet, otherwise
2669 * just update the throttling group. */
2670 if (!blk_get_public(blk
)->throttle_state
) {
2671 blk_io_limits_enable(blk
,
2672 arg
->has_group
? arg
->group
:
2673 arg
->has_device
? arg
->device
:
2675 } else if (arg
->has_group
) {
2676 blk_io_limits_update_group(blk
, arg
->group
);
2678 /* Set the new throttling configuration */
2679 blk_set_io_limits(blk
, &cfg
);
2680 } else if (blk_get_public(blk
)->throttle_state
) {
2681 /* If all throttling settings are set to 0, disable I/O limits */
2682 blk_io_limits_disable(blk
);
2686 aio_context_release(aio_context
);
2689 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2690 bool has_granularity
, uint32_t granularity
,
2693 AioContext
*aio_context
;
2694 BlockDriverState
*bs
;
2696 if (!name
|| name
[0] == '\0') {
2697 error_setg(errp
, "Bitmap name cannot be empty");
2701 bs
= bdrv_lookup_bs(node
, node
, errp
);
2706 aio_context
= bdrv_get_aio_context(bs
);
2707 aio_context_acquire(aio_context
);
2709 if (has_granularity
) {
2710 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2711 error_setg(errp
, "Granularity must be power of 2 "
2712 "and at least 512");
2716 /* Default to cluster size, if available: */
2717 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2720 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2723 aio_context_release(aio_context
);
2726 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2729 AioContext
*aio_context
;
2730 BlockDriverState
*bs
;
2731 BdrvDirtyBitmap
*bitmap
;
2733 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2734 if (!bitmap
|| !bs
) {
2738 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2740 "Bitmap '%s' is currently frozen and cannot be removed",
2744 bdrv_dirty_bitmap_make_anon(bitmap
);
2745 bdrv_release_dirty_bitmap(bs
, bitmap
);
2748 aio_context_release(aio_context
);
2752 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2753 * immediately after a full backup operation.
2755 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2758 AioContext
*aio_context
;
2759 BdrvDirtyBitmap
*bitmap
;
2760 BlockDriverState
*bs
;
2762 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2763 if (!bitmap
|| !bs
) {
2767 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2769 "Bitmap '%s' is currently frozen and cannot be modified",
2772 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2774 "Bitmap '%s' is currently disabled and cannot be cleared",
2779 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2782 aio_context_release(aio_context
);
2785 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2787 const char *id
= qdict_get_str(qdict
, "id");
2789 BlockDriverState
*bs
;
2790 AioContext
*aio_context
;
2791 Error
*local_err
= NULL
;
2793 bs
= bdrv_find_node(id
);
2795 qmp_x_blockdev_del(id
, &local_err
);
2797 error_report_err(local_err
);
2802 blk
= blk_by_name(id
);
2804 error_report("Device '%s' not found", id
);
2808 if (!blk_legacy_dinfo(blk
)) {
2809 error_report("Deleting device added with blockdev-add"
2810 " is not supported");
2814 aio_context
= blk_get_aio_context(blk
);
2815 aio_context_acquire(aio_context
);
2819 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2820 error_report_err(local_err
);
2821 aio_context_release(aio_context
);
2828 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2829 monitor_remove_blk(blk
);
2831 /* If this BlockBackend has a device attached to it, its refcount will be
2832 * decremented when the device is removed; otherwise we have to do so here.
2834 if (blk_get_attached_dev(blk
)) {
2835 /* Further I/O must not pause the guest */
2836 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
2837 BLOCKDEV_ON_ERROR_REPORT
);
2842 aio_context_release(aio_context
);
2845 void qmp_block_resize(bool has_device
, const char *device
,
2846 bool has_node_name
, const char *node_name
,
2847 int64_t size
, Error
**errp
)
2849 Error
*local_err
= NULL
;
2850 BlockDriverState
*bs
;
2851 AioContext
*aio_context
;
2854 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2855 has_node_name
? node_name
: NULL
,
2858 error_propagate(errp
, local_err
);
2862 aio_context
= bdrv_get_aio_context(bs
);
2863 aio_context_acquire(aio_context
);
2865 if (!bdrv_is_first_non_filter(bs
)) {
2866 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
2871 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2875 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2876 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2880 /* complete all in-flight operations before resizing the device */
2883 ret
= bdrv_truncate(bs
, size
);
2888 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2891 error_setg(errp
, QERR_UNSUPPORTED
);
2894 error_setg(errp
, "Device '%s' is read only", device
);
2897 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2900 error_setg_errno(errp
, -ret
, "Could not resize");
2905 aio_context_release(aio_context
);
2908 static void block_job_cb(void *opaque
, int ret
)
2910 /* Note that this function may be executed from another AioContext besides
2911 * the QEMU main loop. If you need to access anything that assumes the
2912 * QEMU global mutex, use a BH or introduce a mutex.
2915 BlockDriverState
*bs
= opaque
;
2916 const char *msg
= NULL
;
2918 trace_block_job_cb(bs
, bs
->job
, ret
);
2923 msg
= strerror(-ret
);
2926 if (block_job_is_cancelled(bs
->job
)) {
2927 block_job_event_cancelled(bs
->job
);
2929 block_job_event_completed(bs
->job
, msg
);
2933 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
2934 bool has_base
, const char *base
,
2935 bool has_backing_file
, const char *backing_file
,
2936 bool has_speed
, int64_t speed
,
2937 bool has_on_error
, BlockdevOnError on_error
,
2940 BlockDriverState
*bs
;
2941 BlockDriverState
*base_bs
= NULL
;
2942 AioContext
*aio_context
;
2943 Error
*local_err
= NULL
;
2944 const char *base_name
= NULL
;
2946 if (!has_on_error
) {
2947 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2950 bs
= qmp_get_root_bs(device
, errp
);
2955 aio_context
= bdrv_get_aio_context(bs
);
2956 aio_context_acquire(aio_context
);
2958 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_STREAM
, errp
)) {
2963 base_bs
= bdrv_find_backing_image(bs
, base
);
2964 if (base_bs
== NULL
) {
2965 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
2968 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2972 /* if we are streaming the entire chain, the result will have no backing
2973 * file, and specifying one is therefore an error */
2974 if (base_bs
== NULL
&& has_backing_file
) {
2975 error_setg(errp
, "backing file specified, but streaming the "
2980 /* backing_file string overrides base bs filename */
2981 base_name
= has_backing_file
? backing_file
: base_name
;
2983 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
2984 has_speed
? speed
: 0, on_error
, block_job_cb
, bs
, &local_err
);
2986 error_propagate(errp
, local_err
);
2990 trace_qmp_block_stream(bs
, bs
->job
);
2993 aio_context_release(aio_context
);
2996 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
2997 bool has_base
, const char *base
,
2998 bool has_top
, const char *top
,
2999 bool has_backing_file
, const char *backing_file
,
3000 bool has_speed
, int64_t speed
,
3003 BlockDriverState
*bs
;
3004 BlockDriverState
*base_bs
, *top_bs
;
3005 AioContext
*aio_context
;
3006 Error
*local_err
= NULL
;
3007 /* This will be part of the QMP command, if/when the
3008 * BlockdevOnError change for blkmirror makes it in
3010 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3017 * libvirt relies on the DeviceNotFound error class in order to probe for
3018 * live commit feature versions; for this to work, we must make sure to
3019 * perform the device lookup before any generic errors that may occur in a
3020 * scenario in which all optional arguments are omitted. */
3021 bs
= qmp_get_root_bs(device
, &local_err
);
3023 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3025 error_free(local_err
);
3026 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3027 "Device '%s' not found", device
);
3029 error_propagate(errp
, local_err
);
3034 aio_context
= bdrv_get_aio_context(bs
);
3035 aio_context_acquire(aio_context
);
3037 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3041 /* default top_bs is the active layer */
3044 if (has_top
&& top
) {
3045 if (strcmp(bs
->filename
, top
) != 0) {
3046 top_bs
= bdrv_find_backing_image(bs
, top
);
3050 if (top_bs
== NULL
) {
3051 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3055 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3057 if (has_base
&& base
) {
3058 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3060 base_bs
= bdrv_find_base(top_bs
);
3063 if (base_bs
== NULL
) {
3064 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3068 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3070 if (bdrv_op_is_blocked(base_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3074 /* Do not allow attempts to commit an image into itself */
3075 if (top_bs
== base_bs
) {
3076 error_setg(errp
, "cannot commit an image into itself");
3081 if (has_backing_file
) {
3082 error_setg(errp
, "'backing-file' specified,"
3083 " but 'top' is the active layer");
3086 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, speed
,
3087 on_error
, block_job_cb
, bs
, &local_err
, false);
3089 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, speed
,
3090 on_error
, block_job_cb
, bs
,
3091 has_backing_file
? backing_file
: NULL
, &local_err
);
3093 if (local_err
!= NULL
) {
3094 error_propagate(errp
, local_err
);
3099 aio_context_release(aio_context
);
3102 static void do_drive_backup(DriveBackup
*backup
, BlockJobTxn
*txn
, Error
**errp
)
3104 BlockDriverState
*bs
;
3105 BlockDriverState
*target_bs
;
3106 BlockDriverState
*source
= NULL
;
3107 BdrvDirtyBitmap
*bmap
= NULL
;
3108 AioContext
*aio_context
;
3109 QDict
*options
= NULL
;
3110 Error
*local_err
= NULL
;
3114 if (!backup
->has_speed
) {
3117 if (!backup
->has_on_source_error
) {
3118 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3120 if (!backup
->has_on_target_error
) {
3121 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3123 if (!backup
->has_mode
) {
3124 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3126 if (!backup
->has_job_id
) {
3127 backup
->job_id
= NULL
;
3129 if (!backup
->has_compress
) {
3130 backup
->compress
= false;
3133 bs
= qmp_get_root_bs(backup
->device
, errp
);
3138 aio_context
= bdrv_get_aio_context(bs
);
3139 aio_context_acquire(aio_context
);
3141 if (!backup
->has_format
) {
3142 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
3143 NULL
: (char*) bs
->drv
->format_name
;
3146 /* Early check to avoid creating target */
3147 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3151 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3153 /* See if we have a backing HD we can use to create our new image
3155 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
3156 source
= backing_bs(bs
);
3158 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
3161 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3165 size
= bdrv_getlength(bs
);
3167 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3171 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
3172 assert(backup
->format
);
3174 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
3175 source
->drv
->format_name
, NULL
,
3176 size
, flags
, &local_err
, false);
3178 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
3179 size
, flags
, &local_err
, false);
3184 error_propagate(errp
, local_err
);
3188 if (backup
->format
) {
3189 options
= qdict_new();
3190 qdict_put(options
, "driver", qstring_from_str(backup
->format
));
3193 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
3198 bdrv_set_aio_context(target_bs
, aio_context
);
3200 if (backup
->has_bitmap
) {
3201 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3203 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3204 bdrv_unref(target_bs
);
3209 backup_start(backup
->job_id
, bs
, target_bs
, backup
->speed
, backup
->sync
,
3210 bmap
, backup
->compress
, backup
->on_source_error
,
3211 backup
->on_target_error
, block_job_cb
, bs
, txn
, &local_err
);
3212 bdrv_unref(target_bs
);
3213 if (local_err
!= NULL
) {
3214 error_propagate(errp
, local_err
);
3219 aio_context_release(aio_context
);
3222 void qmp_drive_backup(DriveBackup
*arg
, Error
**errp
)
3224 return do_drive_backup(arg
, NULL
, errp
);
3227 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3229 return bdrv_named_nodes_list(errp
);
3232 void do_blockdev_backup(BlockdevBackup
*backup
, BlockJobTxn
*txn
, Error
**errp
)
3234 BlockDriverState
*bs
;
3235 BlockDriverState
*target_bs
;
3236 Error
*local_err
= NULL
;
3237 AioContext
*aio_context
;
3239 if (!backup
->has_speed
) {
3242 if (!backup
->has_on_source_error
) {
3243 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3245 if (!backup
->has_on_target_error
) {
3246 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3248 if (!backup
->has_job_id
) {
3249 backup
->job_id
= NULL
;
3251 if (!backup
->has_compress
) {
3252 backup
->compress
= false;
3255 bs
= qmp_get_root_bs(backup
->device
, errp
);
3260 aio_context
= bdrv_get_aio_context(bs
);
3261 aio_context_acquire(aio_context
);
3263 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
3268 if (bdrv_get_aio_context(target_bs
) != aio_context
) {
3269 if (!bdrv_has_blk(target_bs
)) {
3270 /* The target BDS is not attached, we can safely move it to another
3272 bdrv_set_aio_context(target_bs
, aio_context
);
3274 error_setg(errp
, "Target is attached to a different thread from "
3279 backup_start(backup
->job_id
, bs
, target_bs
, backup
->speed
, backup
->sync
,
3280 NULL
, backup
->compress
, backup
->on_source_error
,
3281 backup
->on_target_error
, block_job_cb
, bs
, txn
, &local_err
);
3282 if (local_err
!= NULL
) {
3283 error_propagate(errp
, local_err
);
3286 aio_context_release(aio_context
);
3289 void qmp_blockdev_backup(BlockdevBackup
*arg
, Error
**errp
)
3291 do_blockdev_backup(arg
, NULL
, errp
);
3294 /* Parameter check and block job starting for drive mirroring.
3295 * Caller should hold @device and @target's aio context (must be the same).
3297 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3298 BlockDriverState
*target
,
3299 bool has_replaces
, const char *replaces
,
3300 enum MirrorSyncMode sync
,
3301 BlockMirrorBackingMode backing_mode
,
3302 bool has_speed
, int64_t speed
,
3303 bool has_granularity
, uint32_t granularity
,
3304 bool has_buf_size
, int64_t buf_size
,
3305 bool has_on_source_error
,
3306 BlockdevOnError on_source_error
,
3307 bool has_on_target_error
,
3308 BlockdevOnError on_target_error
,
3309 bool has_unmap
, bool unmap
,
3316 if (!has_on_source_error
) {
3317 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3319 if (!has_on_target_error
) {
3320 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3322 if (!has_granularity
) {
3325 if (!has_buf_size
) {
3332 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3333 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3334 "a value in range [512B, 64MB]");
3337 if (granularity
& (granularity
- 1)) {
3338 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3343 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3346 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3350 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3351 sync
= MIRROR_SYNC_MODE_FULL
;
3354 /* pass the node name to replace to mirror start since it's loose coupling
3355 * and will allow to check whether the node still exist at mirror completion
3357 mirror_start(job_id
, bs
, target
,
3358 has_replaces
? replaces
: NULL
,
3359 speed
, granularity
, buf_size
, sync
, backing_mode
,
3360 on_source_error
, on_target_error
, unmap
,
3361 block_job_cb
, bs
, errp
);
3364 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3366 BlockDriverState
*bs
;
3367 BlockDriverState
*source
, *target_bs
;
3368 AioContext
*aio_context
;
3369 BlockMirrorBackingMode backing_mode
;
3370 Error
*local_err
= NULL
;
3371 QDict
*options
= NULL
;
3374 const char *format
= arg
->format
;
3376 bs
= qmp_get_root_bs(arg
->device
, errp
);
3381 aio_context
= bdrv_get_aio_context(bs
);
3382 aio_context_acquire(aio_context
);
3384 if (!arg
->has_mode
) {
3385 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3388 if (!arg
->has_format
) {
3389 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3390 ? NULL
: bs
->drv
->format_name
);
3393 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3394 source
= backing_bs(bs
);
3395 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3396 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3398 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3402 size
= bdrv_getlength(bs
);
3404 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3408 if (arg
->has_replaces
) {
3409 BlockDriverState
*to_replace_bs
;
3410 AioContext
*replace_aio_context
;
3411 int64_t replace_size
;
3413 if (!arg
->has_node_name
) {
3414 error_setg(errp
, "a node-name must be provided when replacing a"
3415 " named node of the graph");
3419 to_replace_bs
= check_to_replace_node(bs
, arg
->replaces
, &local_err
);
3421 if (!to_replace_bs
) {
3422 error_propagate(errp
, local_err
);
3426 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3427 aio_context_acquire(replace_aio_context
);
3428 replace_size
= bdrv_getlength(to_replace_bs
);
3429 aio_context_release(replace_aio_context
);
3431 if (size
!= replace_size
) {
3432 error_setg(errp
, "cannot replace image with a mirror image of "
3438 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3439 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3441 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3444 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3445 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3447 /* create new image w/o backing file */
3449 bdrv_img_create(arg
->target
, format
,
3450 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
3452 switch (arg
->mode
) {
3453 case NEW_IMAGE_MODE_EXISTING
:
3455 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3456 /* create new image with backing file */
3457 bdrv_img_create(arg
->target
, format
,
3459 source
->drv
->format_name
,
3460 NULL
, size
, flags
, &local_err
, false);
3468 error_propagate(errp
, local_err
);
3472 options
= qdict_new();
3473 if (arg
->has_node_name
) {
3474 qdict_put(options
, "node-name", qstring_from_str(arg
->node_name
));
3477 qdict_put(options
, "driver", qstring_from_str(format
));
3480 /* Mirroring takes care of copy-on-write using the source's backing
3483 target_bs
= bdrv_open(arg
->target
, NULL
, options
,
3484 flags
| BDRV_O_NO_BACKING
, errp
);
3489 bdrv_set_aio_context(target_bs
, aio_context
);
3491 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3492 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3493 backing_mode
, arg
->has_speed
, arg
->speed
,
3494 arg
->has_granularity
, arg
->granularity
,
3495 arg
->has_buf_size
, arg
->buf_size
,
3496 arg
->has_on_source_error
, arg
->on_source_error
,
3497 arg
->has_on_target_error
, arg
->on_target_error
,
3498 arg
->has_unmap
, arg
->unmap
,
3500 bdrv_unref(target_bs
);
3501 error_propagate(errp
, local_err
);
3503 aio_context_release(aio_context
);
3506 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3507 const char *device
, const char *target
,
3508 bool has_replaces
, const char *replaces
,
3509 MirrorSyncMode sync
,
3510 bool has_speed
, int64_t speed
,
3511 bool has_granularity
, uint32_t granularity
,
3512 bool has_buf_size
, int64_t buf_size
,
3513 bool has_on_source_error
,
3514 BlockdevOnError on_source_error
,
3515 bool has_on_target_error
,
3516 BlockdevOnError on_target_error
,
3519 BlockDriverState
*bs
;
3520 BlockDriverState
*target_bs
;
3521 AioContext
*aio_context
;
3522 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3523 Error
*local_err
= NULL
;
3525 bs
= qmp_get_root_bs(device
, errp
);
3530 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3535 aio_context
= bdrv_get_aio_context(bs
);
3536 aio_context_acquire(aio_context
);
3538 bdrv_set_aio_context(target_bs
, aio_context
);
3540 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3541 has_replaces
, replaces
, sync
, backing_mode
,
3543 has_granularity
, granularity
,
3544 has_buf_size
, buf_size
,
3545 has_on_source_error
, on_source_error
,
3546 has_on_target_error
, on_target_error
,
3549 error_propagate(errp
, local_err
);
3551 aio_context_release(aio_context
);
3554 /* Get a block job using its ID and acquire its AioContext */
3555 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
3562 *aio_context
= NULL
;
3564 job
= block_job_get(id
);
3567 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3568 "Block job '%s' not found", id
);
3572 *aio_context
= blk_get_aio_context(job
->blk
);
3573 aio_context_acquire(*aio_context
);
3578 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3580 AioContext
*aio_context
;
3581 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3587 block_job_set_speed(job
, speed
, errp
);
3588 aio_context_release(aio_context
);
3591 void qmp_block_job_cancel(const char *device
,
3592 bool has_force
, bool force
, Error
**errp
)
3594 AioContext
*aio_context
;
3595 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3605 if (job
->user_paused
&& !force
) {
3606 error_setg(errp
, "The block job for device '%s' is currently paused",
3611 trace_qmp_block_job_cancel(job
);
3612 block_job_cancel(job
);
3614 aio_context_release(aio_context
);
3617 void qmp_block_job_pause(const char *device
, Error
**errp
)
3619 AioContext
*aio_context
;
3620 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3622 if (!job
|| job
->user_paused
) {
3626 job
->user_paused
= true;
3627 trace_qmp_block_job_pause(job
);
3628 block_job_pause(job
);
3629 aio_context_release(aio_context
);
3632 void qmp_block_job_resume(const char *device
, Error
**errp
)
3634 AioContext
*aio_context
;
3635 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3637 if (!job
|| !job
->user_paused
) {
3641 job
->user_paused
= false;
3642 trace_qmp_block_job_resume(job
);
3643 block_job_iostatus_reset(job
);
3644 block_job_resume(job
);
3645 aio_context_release(aio_context
);
3648 void qmp_block_job_complete(const char *device
, Error
**errp
)
3650 AioContext
*aio_context
;
3651 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3657 trace_qmp_block_job_complete(job
);
3658 block_job_complete(job
, errp
);
3659 aio_context_release(aio_context
);
3662 void qmp_change_backing_file(const char *device
,
3663 const char *image_node_name
,
3664 const char *backing_file
,
3667 BlockDriverState
*bs
= NULL
;
3668 AioContext
*aio_context
;
3669 BlockDriverState
*image_bs
= NULL
;
3670 Error
*local_err
= NULL
;
3675 bs
= qmp_get_root_bs(device
, errp
);
3680 aio_context
= bdrv_get_aio_context(bs
);
3681 aio_context_acquire(aio_context
);
3683 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3685 error_propagate(errp
, local_err
);
3690 error_setg(errp
, "image file not found");
3694 if (bdrv_find_base(image_bs
) == image_bs
) {
3695 error_setg(errp
, "not allowing backing file change on an image "
3696 "without a backing file");
3700 /* even though we are not necessarily operating on bs, we need it to
3701 * determine if block ops are currently prohibited on the chain */
3702 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3706 /* final sanity check */
3707 if (!bdrv_chain_contains(bs
, image_bs
)) {
3708 error_setg(errp
, "'%s' and image file are not in the same chain",
3713 /* if not r/w, reopen to make r/w */
3714 open_flags
= image_bs
->open_flags
;
3715 ro
= bdrv_is_read_only(image_bs
);
3718 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3720 error_propagate(errp
, local_err
);
3725 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3726 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3729 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3731 /* don't exit here, so we can try to restore open flags if
3736 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3737 error_propagate(errp
, local_err
);
3741 aio_context_release(aio_context
);
3744 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
3748 Error
*local_err
= NULL
;
3750 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
3755 qdict
= qemu_opts_to_qdict(opts
, NULL
);
3757 if (!qdict_get_try_str(qdict
, "node-name")) {
3759 error_report("'node-name' needs to be specified");
3763 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
3765 error_report_err(local_err
);
3769 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3772 qemu_opts_del(opts
);
3775 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3777 BlockDriverState
*bs
;
3779 Visitor
*v
= qmp_output_visitor_new(&obj
);
3781 Error
*local_err
= NULL
;
3783 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
3785 error_propagate(errp
, local_err
);
3789 visit_complete(v
, &obj
);
3790 qdict
= qobject_to_qdict(obj
);
3792 qdict_flatten(qdict
);
3794 if (!qdict_get_try_str(qdict
, "node-name")) {
3795 error_setg(errp
, "'node-name' must be specified for the root node");
3799 bs
= bds_tree_init(qdict
, errp
);
3804 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3806 if (bs
&& bdrv_key_required(bs
)) {
3807 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3809 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3817 void qmp_x_blockdev_del(const char *node_name
, Error
**errp
)
3819 AioContext
*aio_context
;
3820 BlockDriverState
*bs
;
3822 bs
= bdrv_find_node(node_name
);
3824 error_setg(errp
, "Cannot find node %s", node_name
);
3827 if (bdrv_has_blk(bs
)) {
3828 error_setg(errp
, "Node %s is in use", node_name
);
3831 aio_context
= bdrv_get_aio_context(bs
);
3832 aio_context_acquire(aio_context
);
3834 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
3838 if (!bs
->monitor_list
.tqe_prev
) {
3839 error_setg(errp
, "Node %s is not owned by the monitor",
3844 if (bs
->refcnt
> 1) {
3845 error_setg(errp
, "Block device %s is in use",
3846 bdrv_get_device_or_node_name(bs
));
3850 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3854 aio_context_release(aio_context
);
3857 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
3858 const char *child_name
)
3862 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
3863 if (strcmp(child
->name
, child_name
) == 0) {
3871 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
3872 const char *child
, bool has_node
,
3873 const char *node
, Error
**errp
)
3875 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
3878 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
3883 if (has_child
== has_node
) {
3885 error_setg(errp
, "The parameters child and node are in conflict");
3887 error_setg(errp
, "Either child or node must be specified");
3893 p_child
= bdrv_find_child(parent_bs
, child
);
3895 error_setg(errp
, "Node '%s' does not have child '%s'",
3899 bdrv_del_child(parent_bs
, p_child
, errp
);
3903 new_bs
= bdrv_find_node(node
);
3905 error_setg(errp
, "Node '%s' not found", node
);
3908 bdrv_add_child(parent_bs
, new_bs
, errp
);
3912 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3914 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3917 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
3918 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
3919 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
3921 aio_context_acquire(aio_context
);
3922 elem
->value
= block_job_query(job
);
3923 aio_context_release(aio_context
);
3926 p_next
= &elem
->next
;
3932 QemuOptsList qemu_common_drive_opts
= {
3934 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
3938 .type
= QEMU_OPT_BOOL
,
3939 .help
= "enable/disable snapshot mode",
3942 .type
= QEMU_OPT_STRING
,
3943 .help
= "host AIO implementation (threads, native)",
3945 .name
= BDRV_OPT_CACHE_WB
,
3946 .type
= QEMU_OPT_BOOL
,
3947 .help
= "Enable writeback mode",
3950 .type
= QEMU_OPT_STRING
,
3951 .help
= "disk format (raw, qcow2, ...)",
3954 .type
= QEMU_OPT_STRING
,
3955 .help
= "read error action",
3958 .type
= QEMU_OPT_STRING
,
3959 .help
= "write error action",
3961 .name
= BDRV_OPT_READ_ONLY
,
3962 .type
= QEMU_OPT_BOOL
,
3963 .help
= "open drive file as read-only",
3965 .name
= "throttling.iops-total",
3966 .type
= QEMU_OPT_NUMBER
,
3967 .help
= "limit total I/O operations per second",
3969 .name
= "throttling.iops-read",
3970 .type
= QEMU_OPT_NUMBER
,
3971 .help
= "limit read operations per second",
3973 .name
= "throttling.iops-write",
3974 .type
= QEMU_OPT_NUMBER
,
3975 .help
= "limit write operations per second",
3977 .name
= "throttling.bps-total",
3978 .type
= QEMU_OPT_NUMBER
,
3979 .help
= "limit total bytes per second",
3981 .name
= "throttling.bps-read",
3982 .type
= QEMU_OPT_NUMBER
,
3983 .help
= "limit read bytes per second",
3985 .name
= "throttling.bps-write",
3986 .type
= QEMU_OPT_NUMBER
,
3987 .help
= "limit write bytes per second",
3989 .name
= "throttling.iops-total-max",
3990 .type
= QEMU_OPT_NUMBER
,
3991 .help
= "I/O operations burst",
3993 .name
= "throttling.iops-read-max",
3994 .type
= QEMU_OPT_NUMBER
,
3995 .help
= "I/O operations read burst",
3997 .name
= "throttling.iops-write-max",
3998 .type
= QEMU_OPT_NUMBER
,
3999 .help
= "I/O operations write burst",
4001 .name
= "throttling.bps-total-max",
4002 .type
= QEMU_OPT_NUMBER
,
4003 .help
= "total bytes burst",
4005 .name
= "throttling.bps-read-max",
4006 .type
= QEMU_OPT_NUMBER
,
4007 .help
= "total bytes read burst",
4009 .name
= "throttling.bps-write-max",
4010 .type
= QEMU_OPT_NUMBER
,
4011 .help
= "total bytes write burst",
4013 .name
= "throttling.iops-total-max-length",
4014 .type
= QEMU_OPT_NUMBER
,
4015 .help
= "length of the iops-total-max burst period, in seconds",
4017 .name
= "throttling.iops-read-max-length",
4018 .type
= QEMU_OPT_NUMBER
,
4019 .help
= "length of the iops-read-max burst period, in seconds",
4021 .name
= "throttling.iops-write-max-length",
4022 .type
= QEMU_OPT_NUMBER
,
4023 .help
= "length of the iops-write-max burst period, in seconds",
4025 .name
= "throttling.bps-total-max-length",
4026 .type
= QEMU_OPT_NUMBER
,
4027 .help
= "length of the bps-total-max burst period, in seconds",
4029 .name
= "throttling.bps-read-max-length",
4030 .type
= QEMU_OPT_NUMBER
,
4031 .help
= "length of the bps-read-max burst period, in seconds",
4033 .name
= "throttling.bps-write-max-length",
4034 .type
= QEMU_OPT_NUMBER
,
4035 .help
= "length of the bps-write-max burst period, in seconds",
4037 .name
= "throttling.iops-size",
4038 .type
= QEMU_OPT_NUMBER
,
4039 .help
= "when limiting by iops max size of an I/O in bytes",
4041 .name
= "throttling.group",
4042 .type
= QEMU_OPT_STRING
,
4043 .help
= "name of the block throttling group",
4045 .name
= "copy-on-read",
4046 .type
= QEMU_OPT_BOOL
,
4047 .help
= "copy read data from backing file into image file",
4049 .name
= "detect-zeroes",
4050 .type
= QEMU_OPT_STRING
,
4051 .help
= "try to optimize zero writes (off, on, unmap)",
4053 .name
= "stats-account-invalid",
4054 .type
= QEMU_OPT_BOOL
,
4055 .help
= "whether to account for invalid I/O operations "
4056 "in the statistics",
4058 .name
= "stats-account-failed",
4059 .type
= QEMU_OPT_BOOL
,
4060 .help
= "whether to account for failed I/O operations "
4061 "in the statistics",
4063 { /* end of list */ }
4067 QemuOptsList qemu_drive_opts
= {
4069 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4072 * no elements => accept any params
4073 * validation will happen later
4075 { /* end of list */ }