2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
9 * This file incorporates work covered by the following copyright and
12 * Copyright (c) 2003-2008 Fabrice Bellard
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
33 #include "qemu/osdep.h"
34 #include "sysemu/block-backend.h"
35 #include "sysemu/blockdev.h"
36 #include "hw/block/block.h"
37 #include "block/blockjob.h"
38 #include "block/throttle-groups.h"
39 #include "monitor/monitor.h"
40 #include "qemu/error-report.h"
41 #include "qemu/option.h"
42 #include "qemu/config-file.h"
43 #include "qapi/qmp/types.h"
44 #include "qapi-visit.h"
45 #include "qapi/qmp/qerror.h"
46 #include "qapi/qobject-output-visitor.h"
47 #include "qapi/util.h"
48 #include "sysemu/sysemu.h"
49 #include "block/block_int.h"
50 #include "qmp-commands.h"
51 #include "block/trace.h"
52 #include "sysemu/arch_init.h"
53 #include "qemu/cutils.h"
54 #include "qemu/help_option.h"
55 #include "qemu/throttle-options.h"
57 static QTAILQ_HEAD(, BlockDriverState
) monitor_bdrv_states
=
58 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states
);
60 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
61 bool force
, Error
**errp
);
63 static const char *const if_name
[IF_COUNT
] = {
67 [IF_FLOPPY
] = "floppy",
68 [IF_PFLASH
] = "pflash",
71 [IF_VIRTIO
] = "virtio",
75 static int if_max_devs
[IF_COUNT
] = {
77 * Do not change these numbers! They govern how drive option
78 * index maps to unit and bus. That mapping is ABI.
80 * All controllers used to implement if=T drives need to support
81 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
82 * Otherwise, some index values map to "impossible" bus, unit
85 * For instance, if you change [IF_SCSI] to 255, -drive
86 * if=scsi,index=12 no longer means bus=1,unit=5, but
87 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
88 * the drive can't be set up. Regression.
95 * Boards may call this to offer board-by-board overrides
96 * of the default, global values.
98 void override_max_devs(BlockInterfaceType type
, int max_devs
)
107 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
108 dinfo
= blk_legacy_dinfo(blk
);
109 if (dinfo
->type
== type
) {
110 fprintf(stderr
, "Cannot override units-per-bus property of"
111 " the %s interface, because a drive of that type has"
112 " already been added.\n", if_name
[type
]);
113 g_assert_not_reached();
117 if_max_devs
[type
] = max_devs
;
121 * We automatically delete the drive when a device using it gets
122 * unplugged. Questionable feature, but we can't just drop it.
123 * Device models call blockdev_mark_auto_del() to schedule the
124 * automatic deletion, and generic qdev code calls blockdev_auto_del()
125 * when deletion is actually safe.
127 void blockdev_mark_auto_del(BlockBackend
*blk
)
129 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
130 BlockDriverState
*bs
= blk_bs(blk
);
131 AioContext
*aio_context
;
138 aio_context
= bdrv_get_aio_context(bs
);
139 aio_context_acquire(aio_context
);
142 block_job_cancel(bs
->job
);
145 aio_context_release(aio_context
);
151 void blockdev_auto_del(BlockBackend
*blk
)
153 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
155 if (dinfo
&& dinfo
->auto_del
) {
156 monitor_remove_blk(blk
);
162 * Returns the current mapping of how many units per bus
163 * a particular interface can support.
165 * A positive integer indicates n units per bus.
166 * 0 implies the mapping has not been established.
167 * -1 indicates an invalid BlockInterfaceType was given.
169 int drive_get_max_devs(BlockInterfaceType type
)
171 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
172 return if_max_devs
[type
];
178 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
180 int max_devs
= if_max_devs
[type
];
181 return max_devs
? index
/ max_devs
: 0;
184 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
186 int max_devs
= if_max_devs
[type
];
187 return max_devs
? index
% max_devs
: index
;
190 QemuOpts
*drive_def(const char *optstr
)
192 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr
, false);
195 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
200 opts
= drive_def(optstr
);
204 if (type
!= IF_DEFAULT
) {
205 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
208 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
211 qemu_opt_set(opts
, "file", file
, &error_abort
);
215 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
220 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
221 dinfo
= blk_legacy_dinfo(blk
);
222 if (dinfo
&& dinfo
->type
== type
223 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
231 void drive_check_orphaned(void)
236 bool orphans
= false;
238 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
239 dinfo
= blk_legacy_dinfo(blk
);
240 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
241 dinfo
->type
!= IF_NONE
) {
243 qemu_opts_loc_restore(dinfo
->opts
);
244 error_report("machine type does not support"
245 " if=%s,bus=%d,unit=%d",
246 if_name
[dinfo
->type
], dinfo
->bus
, dinfo
->unit
);
257 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
259 return drive_get(type
,
260 drive_index_to_bus_id(type
, index
),
261 drive_index_to_unit_id(type
, index
));
264 int drive_get_max_bus(BlockInterfaceType type
)
271 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
272 dinfo
= blk_legacy_dinfo(blk
);
273 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
274 max_bus
= dinfo
->bus
;
280 /* Get a block device. This should only be used for single-drive devices
281 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
283 DriveInfo
*drive_get_next(BlockInterfaceType type
)
285 static int next_block_unit
[IF_COUNT
];
287 return drive_get(type
, 0, next_block_unit
[type
]++);
290 static void bdrv_format_print(void *opaque
, const char *name
)
292 error_printf(" %s", name
);
297 BlockDriverState
*bs
;
300 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
302 if (!strcmp(buf
, "ignore")) {
303 return BLOCKDEV_ON_ERROR_IGNORE
;
304 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
305 return BLOCKDEV_ON_ERROR_ENOSPC
;
306 } else if (!strcmp(buf
, "stop")) {
307 return BLOCKDEV_ON_ERROR_STOP
;
308 } else if (!strcmp(buf
, "report")) {
309 return BLOCKDEV_ON_ERROR_REPORT
;
311 error_setg(errp
, "'%s' invalid %s error action",
312 buf
, is_read
? "read" : "write");
317 static bool parse_stats_intervals(BlockAcctStats
*stats
, QList
*intervals
,
320 const QListEntry
*entry
;
321 for (entry
= qlist_first(intervals
); entry
; entry
= qlist_next(entry
)) {
322 switch (qobject_type(entry
->value
)) {
324 case QTYPE_QSTRING
: {
325 unsigned long long length
;
326 const char *str
= qstring_get_str(qobject_to_qstring(entry
->value
));
327 if (parse_uint_full(str
, &length
, 10) == 0 &&
328 length
> 0 && length
<= UINT_MAX
) {
329 block_acct_add_interval(stats
, (unsigned) length
);
331 error_setg(errp
, "Invalid interval length: %s", str
);
338 int64_t length
= qnum_get_int(qobject_to_qnum(entry
->value
));
340 if (length
> 0 && length
<= UINT_MAX
) {
341 block_acct_add_interval(stats
, (unsigned) length
);
343 error_setg(errp
, "Invalid interval length: %" PRId64
, length
);
350 error_setg(errp
, "The specification of stats-intervals is invalid");
357 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
359 /* All parameters but @opts are optional and may be set to NULL. */
360 static void extract_common_blockdev_options(QemuOpts
*opts
, int *bdrv_flags
,
361 const char **throttling_group
, ThrottleConfig
*throttle_cfg
,
362 BlockdevDetectZeroesOptions
*detect_zeroes
, Error
**errp
)
364 Error
*local_error
= NULL
;
368 if (qemu_opt_get_bool(opts
, "copy-on-read", false)) {
369 *bdrv_flags
|= BDRV_O_COPY_ON_READ
;
372 if ((aio
= qemu_opt_get(opts
, "aio")) != NULL
) {
373 if (!strcmp(aio
, "native")) {
374 *bdrv_flags
|= BDRV_O_NATIVE_AIO
;
375 } else if (!strcmp(aio
, "threads")) {
376 /* this is the default */
378 error_setg(errp
, "invalid aio option");
384 /* disk I/O throttling */
385 if (throttling_group
) {
386 *throttling_group
= qemu_opt_get(opts
, "throttling.group");
390 throttle_config_init(throttle_cfg
);
391 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].avg
=
392 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
393 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].avg
=
394 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
395 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].avg
=
396 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
397 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].avg
=
398 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
399 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].avg
=
400 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
401 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].avg
=
402 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
404 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].max
=
405 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
406 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].max
=
407 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
408 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].max
=
409 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
410 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].max
=
411 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
412 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].max
=
413 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
414 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].max
=
415 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
417 throttle_cfg
->buckets
[THROTTLE_BPS_TOTAL
].burst_length
=
418 qemu_opt_get_number(opts
, "throttling.bps-total-max-length", 1);
419 throttle_cfg
->buckets
[THROTTLE_BPS_READ
].burst_length
=
420 qemu_opt_get_number(opts
, "throttling.bps-read-max-length", 1);
421 throttle_cfg
->buckets
[THROTTLE_BPS_WRITE
].burst_length
=
422 qemu_opt_get_number(opts
, "throttling.bps-write-max-length", 1);
423 throttle_cfg
->buckets
[THROTTLE_OPS_TOTAL
].burst_length
=
424 qemu_opt_get_number(opts
, "throttling.iops-total-max-length", 1);
425 throttle_cfg
->buckets
[THROTTLE_OPS_READ
].burst_length
=
426 qemu_opt_get_number(opts
, "throttling.iops-read-max-length", 1);
427 throttle_cfg
->buckets
[THROTTLE_OPS_WRITE
].burst_length
=
428 qemu_opt_get_number(opts
, "throttling.iops-write-max-length", 1);
430 throttle_cfg
->op_size
=
431 qemu_opt_get_number(opts
, "throttling.iops-size", 0);
433 if (!throttle_is_valid(throttle_cfg
, errp
)) {
440 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
441 qemu_opt_get(opts
, "detect-zeroes"),
442 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX
,
443 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
446 error_propagate(errp
, local_error
);
452 /* Takes the ownership of bs_opts */
453 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
458 int on_read_error
, on_write_error
;
459 bool account_invalid
, account_failed
;
460 bool writethrough
, read_only
;
462 BlockDriverState
*bs
;
467 QDict
*interval_dict
= NULL
;
468 QList
*interval_list
= NULL
;
470 BlockdevDetectZeroesOptions detect_zeroes
=
471 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
472 const char *throttling_group
= NULL
;
474 /* Check common options by copying from bs_opts to opts, all other options
475 * stay in bs_opts for processing by bdrv_open(). */
476 id
= qdict_get_try_str(bs_opts
, "id");
477 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
479 error_propagate(errp
, error
);
483 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
485 error_propagate(errp
, error
);
490 qdict_del(bs_opts
, "id");
493 /* extract parameters */
494 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
496 account_invalid
= qemu_opt_get_bool(opts
, "stats-account-invalid", true);
497 account_failed
= qemu_opt_get_bool(opts
, "stats-account-failed", true);
499 writethrough
= !qemu_opt_get_bool(opts
, BDRV_OPT_CACHE_WB
, true);
501 id
= qemu_opts_id(opts
);
503 qdict_extract_subqdict(bs_opts
, &interval_dict
, "stats-intervals.");
504 qdict_array_split(interval_dict
, &interval_list
);
506 if (qdict_size(interval_dict
) != 0) {
507 error_setg(errp
, "Invalid option stats-intervals.%s",
508 qdict_first(interval_dict
)->key
);
512 extract_common_blockdev_options(opts
, &bdrv_flags
, &throttling_group
, &cfg
,
513 &detect_zeroes
, &error
);
515 error_propagate(errp
, error
);
519 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
520 if (is_help_option(buf
)) {
521 error_printf("Supported formats:");
522 bdrv_iterate_format(bdrv_format_print
, NULL
);
527 if (qdict_haskey(bs_opts
, "driver")) {
528 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
531 qdict_put_str(bs_opts
, "driver", buf
);
534 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
535 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
536 on_write_error
= parse_block_error_action(buf
, 0, &error
);
538 error_propagate(errp
, error
);
543 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
544 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
545 on_read_error
= parse_block_error_action(buf
, 1, &error
);
547 error_propagate(errp
, error
);
553 bdrv_flags
|= BDRV_O_SNAPSHOT
;
556 read_only
= qemu_opt_get_bool(opts
, BDRV_OPT_READ_ONLY
, false);
559 if ((!file
|| !*file
) && !qdict_size(bs_opts
)) {
560 BlockBackendRootState
*blk_rs
;
562 blk
= blk_new(0, BLK_PERM_ALL
);
563 blk_rs
= blk_get_root_state(blk
);
564 blk_rs
->open_flags
= bdrv_flags
;
565 blk_rs
->read_only
= read_only
;
566 blk_rs
->detect_zeroes
= detect_zeroes
;
570 if (file
&& !*file
) {
574 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
575 * with other callers) rather than what we want as the real defaults.
576 * Apply the defaults here instead. */
577 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
578 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
579 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
,
580 read_only
? "on" : "off");
581 assert((bdrv_flags
& BDRV_O_CACHE_MASK
) == 0);
583 if (runstate_check(RUN_STATE_INMIGRATE
)) {
584 bdrv_flags
|= BDRV_O_INACTIVE
;
587 blk
= blk_new_open(file
, NULL
, bs_opts
, bdrv_flags
, errp
);
593 bs
->detect_zeroes
= detect_zeroes
;
595 if (bdrv_key_required(bs
)) {
599 block_acct_init(blk_get_stats(blk
), account_invalid
, account_failed
);
601 if (!parse_stats_intervals(blk_get_stats(blk
), interval_list
, errp
)) {
608 /* disk I/O throttling */
609 if (throttle_enabled(&cfg
)) {
610 if (!throttling_group
) {
611 throttling_group
= id
;
613 blk_io_limits_enable(blk
, throttling_group
);
614 blk_set_io_limits(blk
, &cfg
);
617 blk_set_enable_write_cache(blk
, !writethrough
);
618 blk_set_on_error(blk
, on_read_error
, on_write_error
);
620 if (!monitor_add_blk(blk
, id
, errp
)) {
628 QDECREF(interval_dict
);
629 QDECREF(interval_list
);
634 QDECREF(interval_dict
);
635 QDECREF(interval_list
);
641 /* Takes the ownership of bs_opts */
642 static BlockDriverState
*bds_tree_init(QDict
*bs_opts
, Error
**errp
)
646 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
647 * with other callers) rather than what we want as the real defaults.
648 * Apply the defaults here instead. */
649 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_DIRECT
, "off");
650 qdict_set_default_str(bs_opts
, BDRV_OPT_CACHE_NO_FLUSH
, "off");
651 qdict_set_default_str(bs_opts
, BDRV_OPT_READ_ONLY
, "off");
653 if (runstate_check(RUN_STATE_INMIGRATE
)) {
654 bdrv_flags
|= BDRV_O_INACTIVE
;
657 return bdrv_open(NULL
, NULL
, bs_opts
, bdrv_flags
, errp
);
660 void blockdev_close_all_bdrv_states(void)
662 BlockDriverState
*bs
, *next_bs
;
664 QTAILQ_FOREACH_SAFE(bs
, &monitor_bdrv_states
, monitor_list
, next_bs
) {
665 AioContext
*ctx
= bdrv_get_aio_context(bs
);
667 aio_context_acquire(ctx
);
669 aio_context_release(ctx
);
673 /* Iterates over the list of monitor-owned BlockDriverStates */
674 BlockDriverState
*bdrv_next_monitor_owned(BlockDriverState
*bs
)
676 return bs
? QTAILQ_NEXT(bs
, monitor_list
)
677 : QTAILQ_FIRST(&monitor_bdrv_states
);
680 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
685 value
= qemu_opt_get(opts
, from
);
687 if (qemu_opt_find(opts
, to
)) {
688 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
689 "same time", to
, from
);
694 /* rename all items in opts */
695 while ((value
= qemu_opt_get(opts
, from
))) {
696 qemu_opt_set(opts
, to
, value
, &error_abort
);
697 qemu_opt_unset(opts
, from
);
701 QemuOptsList qemu_legacy_drive_opts
= {
703 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
707 .type
= QEMU_OPT_NUMBER
,
708 .help
= "bus number",
711 .type
= QEMU_OPT_NUMBER
,
712 .help
= "unit number (i.e. lun for scsi)",
715 .type
= QEMU_OPT_NUMBER
,
716 .help
= "index number",
719 .type
= QEMU_OPT_STRING
,
720 .help
= "media type (disk, cdrom)",
723 .type
= QEMU_OPT_STRING
,
724 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
727 .type
= QEMU_OPT_NUMBER
,
728 .help
= "number of cylinders (ide disk geometry)",
731 .type
= QEMU_OPT_NUMBER
,
732 .help
= "number of heads (ide disk geometry)",
735 .type
= QEMU_OPT_NUMBER
,
736 .help
= "number of sectors (ide disk geometry)",
739 .type
= QEMU_OPT_STRING
,
740 .help
= "chs translation (auto, lba, none)",
743 .type
= QEMU_OPT_BOOL
,
744 .help
= "(deprecated, ignored)",
747 .type
= QEMU_OPT_STRING
,
748 .help
= "pci address (virtio only)",
751 .type
= QEMU_OPT_STRING
,
752 .help
= "disk serial number",
755 .type
= QEMU_OPT_STRING
,
759 /* Options that are passed on, but have special semantics with -drive */
761 .name
= BDRV_OPT_READ_ONLY
,
762 .type
= QEMU_OPT_BOOL
,
763 .help
= "open drive file as read-only",
766 .type
= QEMU_OPT_STRING
,
767 .help
= "read error action",
770 .type
= QEMU_OPT_STRING
,
771 .help
= "write error action",
773 .name
= "copy-on-read",
774 .type
= QEMU_OPT_BOOL
,
775 .help
= "copy read data from backing file into image file",
778 { /* end of list */ }
782 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
786 DriveInfo
*dinfo
= NULL
;
788 QemuOpts
*legacy_opts
;
789 DriveMediaType media
= MEDIA_DISK
;
790 BlockInterfaceType type
;
791 int cyls
, heads
, secs
, translation
;
792 int max_devs
, bus_id
, unit_id
, index
;
794 const char *werror
, *rerror
;
795 bool read_only
= false;
798 const char *filename
;
799 Error
*local_err
= NULL
;
802 /* Change legacy command line options into QMP ones */
803 static const struct {
807 { "iops", "throttling.iops-total" },
808 { "iops_rd", "throttling.iops-read" },
809 { "iops_wr", "throttling.iops-write" },
811 { "bps", "throttling.bps-total" },
812 { "bps_rd", "throttling.bps-read" },
813 { "bps_wr", "throttling.bps-write" },
815 { "iops_max", "throttling.iops-total-max" },
816 { "iops_rd_max", "throttling.iops-read-max" },
817 { "iops_wr_max", "throttling.iops-write-max" },
819 { "bps_max", "throttling.bps-total-max" },
820 { "bps_rd_max", "throttling.bps-read-max" },
821 { "bps_wr_max", "throttling.bps-write-max" },
823 { "iops_size", "throttling.iops-size" },
825 { "group", "throttling.group" },
827 { "readonly", BDRV_OPT_READ_ONLY
},
830 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
831 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
834 error_report_err(local_err
);
839 value
= qemu_opt_get(all_opts
, "cache");
844 if (bdrv_parse_cache_mode(value
, &flags
, &writethrough
) != 0) {
845 error_report("invalid cache option");
849 /* Specific options take precedence */
850 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_WB
)) {
851 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_WB
,
852 !writethrough
, &error_abort
);
854 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_DIRECT
)) {
855 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_DIRECT
,
856 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
858 if (!qemu_opt_get(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
)) {
859 qemu_opt_set_bool(all_opts
, BDRV_OPT_CACHE_NO_FLUSH
,
860 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
862 qemu_opt_unset(all_opts
, "cache");
865 /* Get a QDict for processing the options */
866 bs_opts
= qdict_new();
867 qemu_opts_to_qdict(all_opts
, bs_opts
);
869 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
871 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
873 error_report_err(local_err
);
877 /* Deprecated option boot=[on|off] */
878 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
879 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
880 "ignored. Future versions will reject this parameter. Please "
881 "update your scripts.\n");
885 value
= qemu_opt_get(legacy_opts
, "media");
887 if (!strcmp(value
, "disk")) {
889 } else if (!strcmp(value
, "cdrom")) {
893 error_report("'%s' invalid media", value
);
898 /* copy-on-read is disabled with a warning for read-only devices */
899 read_only
|= qemu_opt_get_bool(legacy_opts
, BDRV_OPT_READ_ONLY
, false);
900 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
902 if (read_only
&& copy_on_read
) {
903 error_report("warning: disabling copy-on-read on read-only drive");
904 copy_on_read
= false;
907 qdict_put_str(bs_opts
, BDRV_OPT_READ_ONLY
, read_only
? "on" : "off");
908 qdict_put_str(bs_opts
, "copy-on-read", copy_on_read
? "on" : "off");
910 /* Controller type */
911 value
= qemu_opt_get(legacy_opts
, "if");
914 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
917 if (type
== IF_COUNT
) {
918 error_report("unsupported bus type '%s'", value
);
922 type
= block_default_type
;
926 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
927 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
928 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
930 if (cyls
|| heads
|| secs
) {
932 error_report("invalid physical cyls number");
936 error_report("invalid physical heads number");
940 error_report("invalid physical secs number");
945 translation
= BIOS_ATA_TRANSLATION_AUTO
;
946 value
= qemu_opt_get(legacy_opts
, "trans");
949 error_report("'%s' trans must be used with cyls, heads and secs",
953 if (!strcmp(value
, "none")) {
954 translation
= BIOS_ATA_TRANSLATION_NONE
;
955 } else if (!strcmp(value
, "lba")) {
956 translation
= BIOS_ATA_TRANSLATION_LBA
;
957 } else if (!strcmp(value
, "large")) {
958 translation
= BIOS_ATA_TRANSLATION_LARGE
;
959 } else if (!strcmp(value
, "rechs")) {
960 translation
= BIOS_ATA_TRANSLATION_RECHS
;
961 } else if (!strcmp(value
, "auto")) {
962 translation
= BIOS_ATA_TRANSLATION_AUTO
;
964 error_report("'%s' invalid translation type", value
);
969 if (media
== MEDIA_CDROM
) {
970 if (cyls
|| secs
|| heads
) {
971 error_report("CHS can't be set with media=cdrom");
976 /* Device address specified by bus/unit or index.
977 * If none was specified, try to find the first free one. */
978 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
979 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
980 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
982 max_devs
= if_max_devs
[type
];
985 if (bus_id
!= 0 || unit_id
!= -1) {
986 error_report("index cannot be used with bus and unit");
989 bus_id
= drive_index_to_bus_id(type
, index
);
990 unit_id
= drive_index_to_unit_id(type
, index
);
995 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
997 if (max_devs
&& unit_id
>= max_devs
) {
1004 if (max_devs
&& unit_id
>= max_devs
) {
1005 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
1009 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
1010 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1011 bus_id
, unit_id
, index
);
1016 serial
= qemu_opt_get(legacy_opts
, "serial");
1018 /* no id supplied -> create one */
1019 if (qemu_opts_id(all_opts
) == NULL
) {
1021 const char *mediastr
= "";
1022 if (type
== IF_IDE
|| type
== IF_SCSI
) {
1023 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
1026 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
1029 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
1032 qdict_put_str(bs_opts
, "id", new_id
);
1036 /* Add virtio block device */
1037 devaddr
= qemu_opt_get(legacy_opts
, "addr");
1038 if (devaddr
&& type
!= IF_VIRTIO
) {
1039 error_report("addr is not supported by this bus type");
1043 if (type
== IF_VIRTIO
) {
1045 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
1047 if (arch_type
== QEMU_ARCH_S390X
) {
1048 qemu_opt_set(devopts
, "driver", "virtio-blk-ccw", &error_abort
);
1050 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
1052 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
1055 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
1059 filename
= qemu_opt_get(legacy_opts
, "file");
1061 /* Check werror/rerror compatibility with if=... */
1062 werror
= qemu_opt_get(legacy_opts
, "werror");
1063 if (werror
!= NULL
) {
1064 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
1066 error_report("werror is not supported by this bus type");
1069 qdict_put_str(bs_opts
, "werror", werror
);
1072 rerror
= qemu_opt_get(legacy_opts
, "rerror");
1073 if (rerror
!= NULL
) {
1074 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
1076 error_report("rerror is not supported by this bus type");
1079 qdict_put_str(bs_opts
, "rerror", rerror
);
1082 /* Actual block device init: Functionality shared with blockdev-add */
1083 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
1087 error_report_err(local_err
);
1094 /* Create legacy DriveInfo */
1095 dinfo
= g_malloc0(sizeof(*dinfo
));
1096 dinfo
->opts
= all_opts
;
1099 dinfo
->heads
= heads
;
1101 dinfo
->trans
= translation
;
1104 dinfo
->bus
= bus_id
;
1105 dinfo
->unit
= unit_id
;
1106 dinfo
->devaddr
= devaddr
;
1107 dinfo
->serial
= g_strdup(serial
);
1109 blk_set_legacy_dinfo(blk
, dinfo
);
1116 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1123 qemu_opts_del(legacy_opts
);
1128 static BlockDriverState
*qmp_get_root_bs(const char *name
, Error
**errp
)
1130 BlockDriverState
*bs
;
1132 bs
= bdrv_lookup_bs(name
, name
, errp
);
1137 if (!bdrv_is_root_node(bs
)) {
1138 error_setg(errp
, "Need a root block node");
1142 if (!bdrv_is_inserted(bs
)) {
1143 error_setg(errp
, "Device has no medium");
1150 static BlockBackend
*qmp_get_blk(const char *blk_name
, const char *qdev_id
,
1155 if (!blk_name
== !qdev_id
) {
1156 error_setg(errp
, "Need exactly one of 'device' and 'id'");
1161 blk
= blk_by_qdev_id(qdev_id
, errp
);
1163 blk
= blk_by_name(blk_name
);
1165 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1166 "Device '%s' not found", blk_name
);
1173 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1175 const char *device
= qdict_get_str(qdict
, "device");
1179 if (!strcmp(device
, "all")) {
1180 ret
= blk_commit_all();
1182 BlockDriverState
*bs
;
1183 AioContext
*aio_context
;
1185 blk
= blk_by_name(device
);
1187 monitor_printf(mon
, "Device '%s' not found\n", device
);
1190 if (!blk_is_available(blk
)) {
1191 monitor_printf(mon
, "Device '%s' has no medium\n", device
);
1196 aio_context
= bdrv_get_aio_context(bs
);
1197 aio_context_acquire(aio_context
);
1199 ret
= bdrv_commit(bs
);
1201 aio_context_release(aio_context
);
1204 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1209 static void blockdev_do_action(TransactionAction
*action
, Error
**errp
)
1211 TransactionActionList list
;
1213 list
.value
= action
;
1215 qmp_transaction(&list
, false, NULL
, errp
);
1218 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1219 bool has_node_name
, const char *node_name
,
1220 const char *snapshot_file
,
1221 bool has_snapshot_node_name
,
1222 const char *snapshot_node_name
,
1223 bool has_format
, const char *format
,
1224 bool has_mode
, NewImageMode mode
, Error
**errp
)
1226 BlockdevSnapshotSync snapshot
= {
1227 .has_device
= has_device
,
1228 .device
= (char *) device
,
1229 .has_node_name
= has_node_name
,
1230 .node_name
= (char *) node_name
,
1231 .snapshot_file
= (char *) snapshot_file
,
1232 .has_snapshot_node_name
= has_snapshot_node_name
,
1233 .snapshot_node_name
= (char *) snapshot_node_name
,
1234 .has_format
= has_format
,
1235 .format
= (char *) format
,
1236 .has_mode
= has_mode
,
1239 TransactionAction action
= {
1240 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1241 .u
.blockdev_snapshot_sync
.data
= &snapshot
,
1243 blockdev_do_action(&action
, errp
);
1246 void qmp_blockdev_snapshot(const char *node
, const char *overlay
,
1249 BlockdevSnapshot snapshot_data
= {
1250 .node
= (char *) node
,
1251 .overlay
= (char *) overlay
1253 TransactionAction action
= {
1254 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
,
1255 .u
.blockdev_snapshot
.data
= &snapshot_data
,
1257 blockdev_do_action(&action
, errp
);
1260 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1264 BlockdevSnapshotInternal snapshot
= {
1265 .device
= (char *) device
,
1266 .name
= (char *) name
1268 TransactionAction action
= {
1269 .type
= TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1270 .u
.blockdev_snapshot_internal_sync
.data
= &snapshot
,
1272 blockdev_do_action(&action
, errp
);
1275 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1282 BlockDriverState
*bs
;
1283 AioContext
*aio_context
;
1284 QEMUSnapshotInfo sn
;
1285 Error
*local_err
= NULL
;
1286 SnapshotInfo
*info
= NULL
;
1289 bs
= qmp_get_root_bs(device
, errp
);
1293 aio_context
= bdrv_get_aio_context(bs
);
1294 aio_context_acquire(aio_context
);
1305 error_setg(errp
, "Name or id must be provided");
1306 goto out_aio_context
;
1309 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1310 goto out_aio_context
;
1313 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1315 error_propagate(errp
, local_err
);
1316 goto out_aio_context
;
1320 "Snapshot with id '%s' and name '%s' does not exist on "
1322 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1323 goto out_aio_context
;
1326 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1328 error_propagate(errp
, local_err
);
1329 goto out_aio_context
;
1332 aio_context_release(aio_context
);
1334 info
= g_new0(SnapshotInfo
, 1);
1335 info
->id
= g_strdup(sn
.id_str
);
1336 info
->name
= g_strdup(sn
.name
);
1337 info
->date_nsec
= sn
.date_nsec
;
1338 info
->date_sec
= sn
.date_sec
;
1339 info
->vm_state_size
= sn
.vm_state_size
;
1340 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1341 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1346 aio_context_release(aio_context
);
1351 * block_dirty_bitmap_lookup:
1352 * Return a dirty bitmap (if present), after validating
1353 * the node reference and bitmap names.
1355 * @node: The name of the BDS node to search for bitmaps
1356 * @name: The name of the bitmap to search for
1357 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1358 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1359 * @errp: Output pointer for error information. Can be NULL.
1361 * @return: A bitmap object on success, or NULL on failure.
1363 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1365 BlockDriverState
**pbs
,
1369 BlockDriverState
*bs
;
1370 BdrvDirtyBitmap
*bitmap
;
1371 AioContext
*aio_context
;
1374 error_setg(errp
, "Node cannot be NULL");
1378 error_setg(errp
, "Bitmap name cannot be NULL");
1381 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1383 error_setg(errp
, "Node '%s' not found", node
);
1387 aio_context
= bdrv_get_aio_context(bs
);
1388 aio_context_acquire(aio_context
);
1390 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1392 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1400 *paio
= aio_context
;
1402 aio_context_release(aio_context
);
1408 aio_context_release(aio_context
);
1412 /* New and old BlockDriverState structs for atomic group operations */
1414 typedef struct BlkActionState BlkActionState
;
1418 * Table of operations that define an Action.
1420 * @instance_size: Size of state struct, in bytes.
1421 * @prepare: Prepare the work, must NOT be NULL.
1422 * @commit: Commit the changes, can be NULL.
1423 * @abort: Abort the changes on fail, can be NULL.
1424 * @clean: Clean up resources after all transaction actions have called
1425 * commit() or abort(). Can be NULL.
1427 * Only prepare() may fail. In a single transaction, only one of commit() or
1428 * abort() will be called. clean() will always be called if it is present.
1430 typedef struct BlkActionOps
{
1431 size_t instance_size
;
1432 void (*prepare
)(BlkActionState
*common
, Error
**errp
);
1433 void (*commit
)(BlkActionState
*common
);
1434 void (*abort
)(BlkActionState
*common
);
1435 void (*clean
)(BlkActionState
*common
);
1440 * Describes one Action's state within a Transaction.
1442 * @action: QAPI-defined enum identifying which Action to perform.
1443 * @ops: Table of ActionOps this Action can perform.
1444 * @block_job_txn: Transaction which this action belongs to.
1445 * @entry: List membership for all Actions in this Transaction.
1447 * This structure must be arranged as first member in a subclassed type,
1448 * assuming that the compiler will also arrange it to the same offsets as the
1451 struct BlkActionState
{
1452 TransactionAction
*action
;
1453 const BlkActionOps
*ops
;
1454 BlockJobTxn
*block_job_txn
;
1455 TransactionProperties
*txn_props
;
1456 QSIMPLEQ_ENTRY(BlkActionState
) entry
;
1459 /* internal snapshot private data */
1460 typedef struct InternalSnapshotState
{
1461 BlkActionState common
;
1462 BlockDriverState
*bs
;
1463 AioContext
*aio_context
;
1464 QEMUSnapshotInfo sn
;
1466 } InternalSnapshotState
;
1469 static int action_check_completion_mode(BlkActionState
*s
, Error
**errp
)
1471 if (s
->txn_props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
1473 "Action '%s' does not support Transaction property "
1474 "completion-mode = %s",
1475 TransactionActionKind_lookup
[s
->action
->type
],
1476 ActionCompletionMode_lookup
[s
->txn_props
->completion_mode
]);
1482 static void internal_snapshot_prepare(BlkActionState
*common
,
1485 Error
*local_err
= NULL
;
1488 BlockDriverState
*bs
;
1489 QEMUSnapshotInfo old_sn
, *sn
;
1492 BlockdevSnapshotInternal
*internal
;
1493 InternalSnapshotState
*state
;
1496 g_assert(common
->action
->type
==
1497 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1498 internal
= common
->action
->u
.blockdev_snapshot_internal_sync
.data
;
1499 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1501 /* 1. parse input */
1502 device
= internal
->device
;
1503 name
= internal
->name
;
1505 /* 2. check for validation */
1506 if (action_check_completion_mode(common
, errp
) < 0) {
1510 bs
= qmp_get_root_bs(device
, errp
);
1515 /* AioContext is released in .clean() */
1516 state
->aio_context
= bdrv_get_aio_context(bs
);
1517 aio_context_acquire(state
->aio_context
);
1520 bdrv_drained_begin(bs
);
1522 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1526 if (bdrv_is_read_only(bs
)) {
1527 error_setg(errp
, "Device '%s' is read only", device
);
1531 if (!bdrv_can_snapshot(bs
)) {
1532 error_setg(errp
, "Block format '%s' used by device '%s' "
1533 "does not support internal snapshots",
1534 bs
->drv
->format_name
, device
);
1538 if (!strlen(name
)) {
1539 error_setg(errp
, "Name is empty");
1543 /* check whether a snapshot with name exist */
1544 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1547 error_propagate(errp
, local_err
);
1551 "Snapshot with name '%s' already exists on device '%s'",
1556 /* 3. take the snapshot */
1558 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1559 qemu_gettimeofday(&tv
);
1560 sn
->date_sec
= tv
.tv_sec
;
1561 sn
->date_nsec
= tv
.tv_usec
* 1000;
1562 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1564 ret1
= bdrv_snapshot_create(bs
, sn
);
1566 error_setg_errno(errp
, -ret1
,
1567 "Failed to create snapshot '%s' on device '%s'",
1572 /* 4. succeed, mark a snapshot is created */
1573 state
->created
= true;
1576 static void internal_snapshot_abort(BlkActionState
*common
)
1578 InternalSnapshotState
*state
=
1579 DO_UPCAST(InternalSnapshotState
, common
, common
);
1580 BlockDriverState
*bs
= state
->bs
;
1581 QEMUSnapshotInfo
*sn
= &state
->sn
;
1582 Error
*local_error
= NULL
;
1584 if (!state
->created
) {
1588 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1589 error_reportf_err(local_error
,
1590 "Failed to delete snapshot with id '%s' and "
1591 "name '%s' on device '%s' in abort: ",
1592 sn
->id_str
, sn
->name
,
1593 bdrv_get_device_name(bs
));
1597 static void internal_snapshot_clean(BlkActionState
*common
)
1599 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1602 if (state
->aio_context
) {
1604 bdrv_drained_end(state
->bs
);
1606 aio_context_release(state
->aio_context
);
1610 /* external snapshot private data */
1611 typedef struct ExternalSnapshotState
{
1612 BlkActionState common
;
1613 BlockDriverState
*old_bs
;
1614 BlockDriverState
*new_bs
;
1615 AioContext
*aio_context
;
1616 bool overlay_appended
;
1617 } ExternalSnapshotState
;
1619 static void external_snapshot_prepare(BlkActionState
*common
,
1623 QDict
*options
= NULL
;
1624 Error
*local_err
= NULL
;
1625 /* Device and node name of the image to generate the snapshot from */
1627 const char *node_name
;
1628 /* Reference to the new image (for 'blockdev-snapshot') */
1629 const char *snapshot_ref
;
1630 /* File name of the new image (for 'blockdev-snapshot-sync') */
1631 const char *new_image_file
;
1632 ExternalSnapshotState
*state
=
1633 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1634 TransactionAction
*action
= common
->action
;
1636 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1637 * purpose but a different set of parameters */
1638 switch (action
->type
) {
1639 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
:
1641 BlockdevSnapshot
*s
= action
->u
.blockdev_snapshot
.data
;
1643 node_name
= s
->node
;
1644 new_image_file
= NULL
;
1645 snapshot_ref
= s
->overlay
;
1648 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
1650 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1651 device
= s
->has_device
? s
->device
: NULL
;
1652 node_name
= s
->has_node_name
? s
->node_name
: NULL
;
1653 new_image_file
= s
->snapshot_file
;
1654 snapshot_ref
= NULL
;
1658 g_assert_not_reached();
1661 /* start processing */
1662 if (action_check_completion_mode(common
, errp
) < 0) {
1666 state
->old_bs
= bdrv_lookup_bs(device
, node_name
, errp
);
1667 if (!state
->old_bs
) {
1671 /* Acquire AioContext now so any threads operating on old_bs stop */
1672 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1673 aio_context_acquire(state
->aio_context
);
1674 bdrv_drained_begin(state
->old_bs
);
1676 if (!bdrv_is_inserted(state
->old_bs
)) {
1677 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1681 if (bdrv_op_is_blocked(state
->old_bs
,
1682 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1686 if (!bdrv_is_read_only(state
->old_bs
)) {
1687 if (bdrv_flush(state
->old_bs
)) {
1688 error_setg(errp
, QERR_IO_ERROR
);
1693 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1694 error_setg(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1698 if (action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
) {
1699 BlockdevSnapshotSync
*s
= action
->u
.blockdev_snapshot_sync
.data
;
1700 const char *format
= s
->has_format
? s
->format
: "qcow2";
1701 enum NewImageMode mode
;
1702 const char *snapshot_node_name
=
1703 s
->has_snapshot_node_name
? s
->snapshot_node_name
: NULL
;
1705 if (node_name
&& !snapshot_node_name
) {
1706 error_setg(errp
, "New snapshot node name missing");
1710 if (snapshot_node_name
&&
1711 bdrv_lookup_bs(snapshot_node_name
, snapshot_node_name
, NULL
)) {
1712 error_setg(errp
, "New snapshot node name already in use");
1716 flags
= state
->old_bs
->open_flags
;
1717 flags
&= ~(BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
| BDRV_O_COPY_ON_READ
);
1719 /* create new image w/backing file */
1720 mode
= s
->has_mode
? s
->mode
: NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1721 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1722 int64_t size
= bdrv_getlength(state
->old_bs
);
1724 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1727 bdrv_img_create(new_image_file
, format
,
1728 state
->old_bs
->filename
,
1729 state
->old_bs
->drv
->format_name
,
1730 NULL
, size
, flags
, false, &local_err
);
1732 error_propagate(errp
, local_err
);
1737 options
= qdict_new();
1738 if (s
->has_snapshot_node_name
) {
1739 qdict_put_str(options
, "node-name", snapshot_node_name
);
1741 qdict_put_str(options
, "driver", format
);
1743 flags
|= BDRV_O_NO_BACKING
;
1746 state
->new_bs
= bdrv_open(new_image_file
, snapshot_ref
, options
, flags
,
1748 /* We will manually add the backing_hd field to the bs later */
1749 if (!state
->new_bs
) {
1753 if (bdrv_has_blk(state
->new_bs
)) {
1754 error_setg(errp
, "The snapshot is already in use");
1758 if (bdrv_op_is_blocked(state
->new_bs
, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
,
1763 if (state
->new_bs
->backing
!= NULL
) {
1764 error_setg(errp
, "The snapshot already has a backing image");
1768 if (!state
->new_bs
->drv
->supports_backing
) {
1769 error_setg(errp
, "The snapshot does not support backing images");
1773 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1775 /* This removes our old bs and adds the new bs. This is an operation that
1776 * can fail, so we need to do it in .prepare; undoing it for abort is
1777 * always possible. */
1778 bdrv_ref(state
->new_bs
);
1779 bdrv_append(state
->new_bs
, state
->old_bs
, &local_err
);
1781 error_propagate(errp
, local_err
);
1784 state
->overlay_appended
= true;
1787 static void external_snapshot_commit(BlkActionState
*common
)
1789 ExternalSnapshotState
*state
=
1790 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1792 /* We don't need (or want) to use the transactional
1793 * bdrv_reopen_multiple() across all the entries at once, because we
1794 * don't want to abort all of them if one of them fails the reopen */
1795 if (!state
->old_bs
->copy_on_read
) {
1796 bdrv_reopen(state
->old_bs
, state
->old_bs
->open_flags
& ~BDRV_O_RDWR
,
1801 static void external_snapshot_abort(BlkActionState
*common
)
1803 ExternalSnapshotState
*state
=
1804 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1805 if (state
->new_bs
) {
1806 if (state
->overlay_appended
) {
1807 bdrv_ref(state
->old_bs
); /* we can't let bdrv_set_backind_hd()
1808 close state->old_bs; we need it */
1809 bdrv_set_backing_hd(state
->new_bs
, NULL
, &error_abort
);
1810 bdrv_replace_node(state
->new_bs
, state
->old_bs
, &error_abort
);
1811 bdrv_unref(state
->old_bs
); /* bdrv_replace_node() ref'ed old_bs */
1816 static void external_snapshot_clean(BlkActionState
*common
)
1818 ExternalSnapshotState
*state
=
1819 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1820 if (state
->aio_context
) {
1821 bdrv_drained_end(state
->old_bs
);
1822 aio_context_release(state
->aio_context
);
1823 bdrv_unref(state
->new_bs
);
1827 typedef struct DriveBackupState
{
1828 BlkActionState common
;
1829 BlockDriverState
*bs
;
1830 AioContext
*aio_context
;
1834 static BlockJob
*do_drive_backup(DriveBackup
*backup
, BlockJobTxn
*txn
,
1837 static void drive_backup_prepare(BlkActionState
*common
, Error
**errp
)
1839 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1840 BlockDriverState
*bs
;
1841 DriveBackup
*backup
;
1842 Error
*local_err
= NULL
;
1844 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1845 backup
= common
->action
->u
.drive_backup
.data
;
1847 bs
= qmp_get_root_bs(backup
->device
, errp
);
1852 /* AioContext is released in .clean() */
1853 state
->aio_context
= bdrv_get_aio_context(bs
);
1854 aio_context_acquire(state
->aio_context
);
1855 bdrv_drained_begin(bs
);
1858 state
->job
= do_drive_backup(backup
, common
->block_job_txn
, &local_err
);
1860 error_propagate(errp
, local_err
);
1865 static void drive_backup_commit(BlkActionState
*common
)
1867 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1869 block_job_start(state
->job
);
1872 static void drive_backup_abort(BlkActionState
*common
)
1874 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1877 block_job_cancel_sync(state
->job
);
1881 static void drive_backup_clean(BlkActionState
*common
)
1883 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1885 if (state
->aio_context
) {
1886 bdrv_drained_end(state
->bs
);
1887 aio_context_release(state
->aio_context
);
1891 typedef struct BlockdevBackupState
{
1892 BlkActionState common
;
1893 BlockDriverState
*bs
;
1895 AioContext
*aio_context
;
1896 } BlockdevBackupState
;
1898 static BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, BlockJobTxn
*txn
,
1901 static void blockdev_backup_prepare(BlkActionState
*common
, Error
**errp
)
1903 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1904 BlockdevBackup
*backup
;
1905 BlockDriverState
*bs
, *target
;
1906 Error
*local_err
= NULL
;
1908 assert(common
->action
->type
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1909 backup
= common
->action
->u
.blockdev_backup
.data
;
1911 bs
= qmp_get_root_bs(backup
->device
, errp
);
1916 target
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
1921 /* AioContext is released in .clean() */
1922 state
->aio_context
= bdrv_get_aio_context(bs
);
1923 if (state
->aio_context
!= bdrv_get_aio_context(target
)) {
1924 state
->aio_context
= NULL
;
1925 error_setg(errp
, "Backup between two IO threads is not implemented");
1928 aio_context_acquire(state
->aio_context
);
1930 bdrv_drained_begin(state
->bs
);
1932 state
->job
= do_blockdev_backup(backup
, common
->block_job_txn
, &local_err
);
1934 error_propagate(errp
, local_err
);
1939 static void blockdev_backup_commit(BlkActionState
*common
)
1941 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1943 block_job_start(state
->job
);
1946 static void blockdev_backup_abort(BlkActionState
*common
)
1948 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1951 block_job_cancel_sync(state
->job
);
1955 static void blockdev_backup_clean(BlkActionState
*common
)
1957 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1959 if (state
->aio_context
) {
1960 bdrv_drained_end(state
->bs
);
1961 aio_context_release(state
->aio_context
);
1965 typedef struct BlockDirtyBitmapState
{
1966 BlkActionState common
;
1967 BdrvDirtyBitmap
*bitmap
;
1968 BlockDriverState
*bs
;
1969 AioContext
*aio_context
;
1972 } BlockDirtyBitmapState
;
1974 static void block_dirty_bitmap_add_prepare(BlkActionState
*common
,
1977 Error
*local_err
= NULL
;
1978 BlockDirtyBitmapAdd
*action
;
1979 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
1982 if (action_check_completion_mode(common
, errp
) < 0) {
1986 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
1987 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1988 qmp_block_dirty_bitmap_add(action
->node
, action
->name
,
1989 action
->has_granularity
, action
->granularity
,
1993 state
->prepared
= true;
1995 error_propagate(errp
, local_err
);
1999 static void block_dirty_bitmap_add_abort(BlkActionState
*common
)
2001 BlockDirtyBitmapAdd
*action
;
2002 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2005 action
= common
->action
->u
.block_dirty_bitmap_add
.data
;
2006 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2007 * then the node reference and bitmap name must have been valid.
2009 if (state
->prepared
) {
2010 qmp_block_dirty_bitmap_remove(action
->node
, action
->name
, &error_abort
);
2014 static void block_dirty_bitmap_clear_prepare(BlkActionState
*common
,
2017 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2019 BlockDirtyBitmap
*action
;
2021 if (action_check_completion_mode(common
, errp
) < 0) {
2025 action
= common
->action
->u
.block_dirty_bitmap_clear
.data
;
2026 state
->bitmap
= block_dirty_bitmap_lookup(action
->node
,
2029 &state
->aio_context
,
2031 if (!state
->bitmap
) {
2035 if (bdrv_dirty_bitmap_frozen(state
->bitmap
)) {
2036 error_setg(errp
, "Cannot modify a frozen bitmap");
2038 } else if (!bdrv_dirty_bitmap_enabled(state
->bitmap
)) {
2039 error_setg(errp
, "Cannot clear a disabled bitmap");
2043 bdrv_clear_dirty_bitmap(state
->bitmap
, &state
->backup
);
2044 /* AioContext is released in .clean() */
2047 static void block_dirty_bitmap_clear_abort(BlkActionState
*common
)
2049 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2052 if (state
->backup
) {
2053 bdrv_undo_clear_dirty_bitmap(state
->bitmap
, state
->backup
);
2057 static void block_dirty_bitmap_clear_commit(BlkActionState
*common
)
2059 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2062 hbitmap_free(state
->backup
);
2065 static void block_dirty_bitmap_clear_clean(BlkActionState
*common
)
2067 BlockDirtyBitmapState
*state
= DO_UPCAST(BlockDirtyBitmapState
,
2070 if (state
->aio_context
) {
2071 aio_context_release(state
->aio_context
);
2075 static void abort_prepare(BlkActionState
*common
, Error
**errp
)
2077 error_setg(errp
, "Transaction aborted using Abort action");
2080 static void abort_commit(BlkActionState
*common
)
2082 g_assert_not_reached(); /* this action never succeeds */
2085 static const BlkActionOps actions
[] = {
2086 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT
] = {
2087 .instance_size
= sizeof(ExternalSnapshotState
),
2088 .prepare
= external_snapshot_prepare
,
2089 .commit
= external_snapshot_commit
,
2090 .abort
= external_snapshot_abort
,
2091 .clean
= external_snapshot_clean
,
2093 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
2094 .instance_size
= sizeof(ExternalSnapshotState
),
2095 .prepare
= external_snapshot_prepare
,
2096 .commit
= external_snapshot_commit
,
2097 .abort
= external_snapshot_abort
,
2098 .clean
= external_snapshot_clean
,
2100 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
2101 .instance_size
= sizeof(DriveBackupState
),
2102 .prepare
= drive_backup_prepare
,
2103 .commit
= drive_backup_commit
,
2104 .abort
= drive_backup_abort
,
2105 .clean
= drive_backup_clean
,
2107 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
2108 .instance_size
= sizeof(BlockdevBackupState
),
2109 .prepare
= blockdev_backup_prepare
,
2110 .commit
= blockdev_backup_commit
,
2111 .abort
= blockdev_backup_abort
,
2112 .clean
= blockdev_backup_clean
,
2114 [TRANSACTION_ACTION_KIND_ABORT
] = {
2115 .instance_size
= sizeof(BlkActionState
),
2116 .prepare
= abort_prepare
,
2117 .commit
= abort_commit
,
2119 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
2120 .instance_size
= sizeof(InternalSnapshotState
),
2121 .prepare
= internal_snapshot_prepare
,
2122 .abort
= internal_snapshot_abort
,
2123 .clean
= internal_snapshot_clean
,
2125 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD
] = {
2126 .instance_size
= sizeof(BlockDirtyBitmapState
),
2127 .prepare
= block_dirty_bitmap_add_prepare
,
2128 .abort
= block_dirty_bitmap_add_abort
,
2130 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR
] = {
2131 .instance_size
= sizeof(BlockDirtyBitmapState
),
2132 .prepare
= block_dirty_bitmap_clear_prepare
,
2133 .commit
= block_dirty_bitmap_clear_commit
,
2134 .abort
= block_dirty_bitmap_clear_abort
,
2135 .clean
= block_dirty_bitmap_clear_clean
,
2140 * Allocate a TransactionProperties structure if necessary, and fill
2141 * that structure with desired defaults if they are unset.
2143 static TransactionProperties
*get_transaction_properties(
2144 TransactionProperties
*props
)
2147 props
= g_new0(TransactionProperties
, 1);
2150 if (!props
->has_completion_mode
) {
2151 props
->has_completion_mode
= true;
2152 props
->completion_mode
= ACTION_COMPLETION_MODE_INDIVIDUAL
;
2159 * 'Atomic' group operations. The operations are performed as a set, and if
2160 * any fail then we roll back all operations in the group.
2162 void qmp_transaction(TransactionActionList
*dev_list
,
2164 struct TransactionProperties
*props
,
2167 TransactionActionList
*dev_entry
= dev_list
;
2168 BlockJobTxn
*block_job_txn
= NULL
;
2169 BlkActionState
*state
, *next
;
2170 Error
*local_err
= NULL
;
2172 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkActionState
) snap_bdrv_states
;
2173 QSIMPLEQ_INIT(&snap_bdrv_states
);
2175 /* Does this transaction get canceled as a group on failure?
2176 * If not, we don't really need to make a BlockJobTxn.
2178 props
= get_transaction_properties(props
);
2179 if (props
->completion_mode
!= ACTION_COMPLETION_MODE_INDIVIDUAL
) {
2180 block_job_txn
= block_job_txn_new();
2183 /* drain all i/o before any operations */
2186 /* We don't do anything in this loop that commits us to the operations */
2187 while (NULL
!= dev_entry
) {
2188 TransactionAction
*dev_info
= NULL
;
2189 const BlkActionOps
*ops
;
2191 dev_info
= dev_entry
->value
;
2192 dev_entry
= dev_entry
->next
;
2194 assert(dev_info
->type
< ARRAY_SIZE(actions
));
2196 ops
= &actions
[dev_info
->type
];
2197 assert(ops
->instance_size
> 0);
2199 state
= g_malloc0(ops
->instance_size
);
2201 state
->action
= dev_info
;
2202 state
->block_job_txn
= block_job_txn
;
2203 state
->txn_props
= props
;
2204 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
2206 state
->ops
->prepare(state
, &local_err
);
2208 error_propagate(errp
, local_err
);
2209 goto delete_and_fail
;
2213 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2214 if (state
->ops
->commit
) {
2215 state
->ops
->commit(state
);
2223 /* failure, and it is all-or-none; roll back all operations */
2224 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
2225 if (state
->ops
->abort
) {
2226 state
->ops
->abort(state
);
2230 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
2231 if (state
->ops
->clean
) {
2232 state
->ops
->clean(state
);
2237 qapi_free_TransactionProperties(props
);
2239 block_job_txn_unref(block_job_txn
);
2242 void qmp_eject(bool has_device
, const char *device
,
2243 bool has_id
, const char *id
,
2244 bool has_force
, bool force
, Error
**errp
)
2246 Error
*local_err
= NULL
;
2253 rc
= do_open_tray(has_device
? device
: NULL
,
2256 if (rc
&& rc
!= -ENOSYS
) {
2257 error_propagate(errp
, local_err
);
2260 error_free(local_err
);
2262 qmp_x_blockdev_remove_medium(has_device
, device
, has_id
, id
, errp
);
2265 void qmp_block_passwd(bool has_device
, const char *device
,
2266 bool has_node_name
, const char *node_name
,
2267 const char *password
, Error
**errp
)
2269 Error
*local_err
= NULL
;
2270 BlockDriverState
*bs
;
2271 AioContext
*aio_context
;
2273 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2274 has_node_name
? node_name
: NULL
,
2277 error_propagate(errp
, local_err
);
2281 aio_context
= bdrv_get_aio_context(bs
);
2282 aio_context_acquire(aio_context
);
2284 bdrv_add_key(bs
, password
, errp
);
2286 aio_context_release(aio_context
);
2290 * Attempt to open the tray of @device.
2291 * If @force, ignore its tray lock.
2292 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2293 * On error, store an error through @errp and return -errno.
2294 * If @device does not exist, return -ENODEV.
2295 * If it has no removable media, return -ENOTSUP.
2296 * If it has no tray, return -ENOSYS.
2297 * If the guest was asked to open the tray, return -EINPROGRESS.
2300 static int do_open_tray(const char *blk_name
, const char *qdev_id
,
2301 bool force
, Error
**errp
)
2304 const char *device
= qdev_id
?: blk_name
;
2307 blk
= qmp_get_blk(blk_name
, qdev_id
, errp
);
2312 if (!blk_dev_has_removable_media(blk
)) {
2313 error_setg(errp
, "Device '%s' is not removable", device
);
2317 if (!blk_dev_has_tray(blk
)) {
2318 error_setg(errp
, "Device '%s' does not have a tray", device
);
2322 if (blk_dev_is_tray_open(blk
)) {
2326 locked
= blk_dev_is_medium_locked(blk
);
2328 blk_dev_eject_request(blk
, force
);
2331 if (!locked
|| force
) {
2332 blk_dev_change_media_cb(blk
, false, &error_abort
);
2335 if (locked
&& !force
) {
2336 error_setg(errp
, "Device '%s' is locked and force was not specified, "
2337 "wait for tray to open and try again", device
);
2338 return -EINPROGRESS
;
2344 void qmp_blockdev_open_tray(bool has_device
, const char *device
,
2345 bool has_id
, const char *id
,
2346 bool has_force
, bool force
,
2349 Error
*local_err
= NULL
;
2355 rc
= do_open_tray(has_device
? device
: NULL
,
2358 if (rc
&& rc
!= -ENOSYS
&& rc
!= -EINPROGRESS
) {
2359 error_propagate(errp
, local_err
);
2362 error_free(local_err
);
2365 void qmp_blockdev_close_tray(bool has_device
, const char *device
,
2366 bool has_id
, const char *id
,
2370 Error
*local_err
= NULL
;
2372 device
= has_device
? device
: NULL
;
2373 id
= has_id
? id
: NULL
;
2375 blk
= qmp_get_blk(device
, id
, errp
);
2380 if (!blk_dev_has_removable_media(blk
)) {
2381 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2385 if (!blk_dev_has_tray(blk
)) {
2386 /* Ignore this command on tray-less devices */
2390 if (!blk_dev_is_tray_open(blk
)) {
2394 blk_dev_change_media_cb(blk
, true, &local_err
);
2396 error_propagate(errp
, local_err
);
2401 void qmp_x_blockdev_remove_medium(bool has_device
, const char *device
,
2402 bool has_id
, const char *id
, Error
**errp
)
2405 BlockDriverState
*bs
;
2406 AioContext
*aio_context
;
2407 bool has_attached_device
;
2409 device
= has_device
? device
: NULL
;
2410 id
= has_id
? id
: NULL
;
2412 blk
= qmp_get_blk(device
, id
, errp
);
2417 /* For BBs without a device, we can exchange the BDS tree at will */
2418 has_attached_device
= blk_get_attached_dev(blk
);
2420 if (has_attached_device
&& !blk_dev_has_removable_media(blk
)) {
2421 error_setg(errp
, "Device '%s' is not removable", device
?: id
);
2425 if (has_attached_device
&& blk_dev_has_tray(blk
) &&
2426 !blk_dev_is_tray_open(blk
))
2428 error_setg(errp
, "Tray of device '%s' is not open", device
?: id
);
2437 aio_context
= bdrv_get_aio_context(bs
);
2438 aio_context_acquire(aio_context
);
2440 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
2446 if (!blk_dev_has_tray(blk
)) {
2447 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2448 * called at all); therefore, the medium needs to be ejected here.
2449 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2450 * value passed here (i.e. false). */
2451 blk_dev_change_media_cb(blk
, false, &error_abort
);
2455 aio_context_release(aio_context
);
2458 static void qmp_blockdev_insert_anon_medium(BlockBackend
*blk
,
2459 BlockDriverState
*bs
, Error
**errp
)
2461 Error
*local_err
= NULL
;
2465 /* For BBs without a device, we can exchange the BDS tree at will */
2466 has_device
= blk_get_attached_dev(blk
);
2468 if (has_device
&& !blk_dev_has_removable_media(blk
)) {
2469 error_setg(errp
, "Device is not removable");
2473 if (has_device
&& blk_dev_has_tray(blk
) && !blk_dev_is_tray_open(blk
)) {
2474 error_setg(errp
, "Tray of the device is not open");
2479 error_setg(errp
, "There already is a medium in the device");
2483 ret
= blk_insert_bs(blk
, bs
, errp
);
2488 if (!blk_dev_has_tray(blk
)) {
2489 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2490 * called at all); therefore, the medium needs to be pushed into the
2492 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2493 * value passed here (i.e. true). */
2494 blk_dev_change_media_cb(blk
, true, &local_err
);
2496 error_propagate(errp
, local_err
);
2503 void qmp_x_blockdev_insert_medium(bool has_device
, const char *device
,
2504 bool has_id
, const char *id
,
2505 const char *node_name
, Error
**errp
)
2508 BlockDriverState
*bs
;
2510 blk
= qmp_get_blk(has_device
? device
: NULL
,
2517 bs
= bdrv_find_node(node_name
);
2519 error_setg(errp
, "Node '%s' not found", node_name
);
2523 if (bdrv_has_blk(bs
)) {
2524 error_setg(errp
, "Node '%s' is already in use", node_name
);
2528 qmp_blockdev_insert_anon_medium(blk
, bs
, errp
);
2531 void qmp_blockdev_change_medium(bool has_device
, const char *device
,
2532 bool has_id
, const char *id
,
2533 const char *filename
,
2534 bool has_format
, const char *format
,
2536 BlockdevChangeReadOnlyMode read_only
,
2540 BlockDriverState
*medium_bs
= NULL
;
2544 QDict
*options
= NULL
;
2547 blk
= qmp_get_blk(has_device
? device
: NULL
,
2555 blk_update_root_state(blk
);
2558 bdrv_flags
= blk_get_open_flags_from_root_state(blk
);
2559 bdrv_flags
&= ~(BDRV_O_TEMPORARY
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
|
2562 if (!has_read_only
) {
2563 read_only
= BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
;
2566 switch (read_only
) {
2567 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN
:
2570 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY
:
2571 bdrv_flags
&= ~BDRV_O_RDWR
;
2574 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE
:
2575 bdrv_flags
|= BDRV_O_RDWR
;
2582 options
= qdict_new();
2583 detect_zeroes
= blk_get_detect_zeroes_from_root_state(blk
);
2584 qdict_put_str(options
, "detect-zeroes", detect_zeroes
? "on" : "off");
2587 qdict_put_str(options
, "driver", format
);
2590 medium_bs
= bdrv_open(filename
, NULL
, options
, bdrv_flags
, errp
);
2595 bdrv_add_key(medium_bs
, NULL
, &err
);
2597 error_propagate(errp
, err
);
2601 rc
= do_open_tray(has_device
? device
: NULL
,
2604 if (rc
&& rc
!= -ENOSYS
) {
2605 error_propagate(errp
, err
);
2611 qmp_x_blockdev_remove_medium(has_device
, device
, has_id
, id
, &err
);
2613 error_propagate(errp
, err
);
2617 qmp_blockdev_insert_anon_medium(blk
, medium_bs
, &err
);
2619 error_propagate(errp
, err
);
2623 qmp_blockdev_close_tray(has_device
, device
, has_id
, id
, errp
);
2626 /* If the medium has been inserted, the device has its own reference, so
2627 * ours must be relinquished; and if it has not been inserted successfully,
2628 * the reference must be relinquished anyway */
2629 bdrv_unref(medium_bs
);
2632 /* throttling disk I/O limits */
2633 void qmp_block_set_io_throttle(BlockIOThrottle
*arg
, Error
**errp
)
2636 BlockDriverState
*bs
;
2638 AioContext
*aio_context
;
2640 blk
= qmp_get_blk(arg
->has_device
? arg
->device
: NULL
,
2641 arg
->has_id
? arg
->id
: NULL
,
2647 aio_context
= blk_get_aio_context(blk
);
2648 aio_context_acquire(aio_context
);
2652 error_setg(errp
, "Device has no medium");
2656 throttle_config_init(&cfg
);
2657 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= arg
->bps
;
2658 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= arg
->bps_rd
;
2659 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= arg
->bps_wr
;
2661 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= arg
->iops
;
2662 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= arg
->iops_rd
;
2663 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= arg
->iops_wr
;
2665 if (arg
->has_bps_max
) {
2666 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= arg
->bps_max
;
2668 if (arg
->has_bps_rd_max
) {
2669 cfg
.buckets
[THROTTLE_BPS_READ
].max
= arg
->bps_rd_max
;
2671 if (arg
->has_bps_wr_max
) {
2672 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= arg
->bps_wr_max
;
2674 if (arg
->has_iops_max
) {
2675 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= arg
->iops_max
;
2677 if (arg
->has_iops_rd_max
) {
2678 cfg
.buckets
[THROTTLE_OPS_READ
].max
= arg
->iops_rd_max
;
2680 if (arg
->has_iops_wr_max
) {
2681 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= arg
->iops_wr_max
;
2684 if (arg
->has_bps_max_length
) {
2685 cfg
.buckets
[THROTTLE_BPS_TOTAL
].burst_length
= arg
->bps_max_length
;
2687 if (arg
->has_bps_rd_max_length
) {
2688 cfg
.buckets
[THROTTLE_BPS_READ
].burst_length
= arg
->bps_rd_max_length
;
2690 if (arg
->has_bps_wr_max_length
) {
2691 cfg
.buckets
[THROTTLE_BPS_WRITE
].burst_length
= arg
->bps_wr_max_length
;
2693 if (arg
->has_iops_max_length
) {
2694 cfg
.buckets
[THROTTLE_OPS_TOTAL
].burst_length
= arg
->iops_max_length
;
2696 if (arg
->has_iops_rd_max_length
) {
2697 cfg
.buckets
[THROTTLE_OPS_READ
].burst_length
= arg
->iops_rd_max_length
;
2699 if (arg
->has_iops_wr_max_length
) {
2700 cfg
.buckets
[THROTTLE_OPS_WRITE
].burst_length
= arg
->iops_wr_max_length
;
2703 if (arg
->has_iops_size
) {
2704 cfg
.op_size
= arg
->iops_size
;
2707 if (!throttle_is_valid(&cfg
, errp
)) {
2711 if (throttle_enabled(&cfg
)) {
2712 /* Enable I/O limits if they're not enabled yet, otherwise
2713 * just update the throttling group. */
2714 if (!blk_get_public(blk
)->throttle_state
) {
2715 blk_io_limits_enable(blk
,
2716 arg
->has_group
? arg
->group
:
2717 arg
->has_device
? arg
->device
:
2719 } else if (arg
->has_group
) {
2720 blk_io_limits_update_group(blk
, arg
->group
);
2722 /* Set the new throttling configuration */
2723 blk_set_io_limits(blk
, &cfg
);
2724 } else if (blk_get_public(blk
)->throttle_state
) {
2725 /* If all throttling settings are set to 0, disable I/O limits */
2726 blk_io_limits_disable(blk
);
2730 aio_context_release(aio_context
);
2733 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2734 bool has_granularity
, uint32_t granularity
,
2737 AioContext
*aio_context
;
2738 BlockDriverState
*bs
;
2740 if (!name
|| name
[0] == '\0') {
2741 error_setg(errp
, "Bitmap name cannot be empty");
2745 bs
= bdrv_lookup_bs(node
, node
, errp
);
2750 aio_context
= bdrv_get_aio_context(bs
);
2751 aio_context_acquire(aio_context
);
2753 if (has_granularity
) {
2754 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2755 error_setg(errp
, "Granularity must be power of 2 "
2756 "and at least 512");
2760 /* Default to cluster size, if available: */
2761 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2764 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2767 aio_context_release(aio_context
);
2770 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2773 AioContext
*aio_context
;
2774 BlockDriverState
*bs
;
2775 BdrvDirtyBitmap
*bitmap
;
2777 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2778 if (!bitmap
|| !bs
) {
2782 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2784 "Bitmap '%s' is currently frozen and cannot be removed",
2788 bdrv_dirty_bitmap_make_anon(bitmap
);
2789 bdrv_release_dirty_bitmap(bs
, bitmap
);
2792 aio_context_release(aio_context
);
2796 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2797 * immediately after a full backup operation.
2799 void qmp_block_dirty_bitmap_clear(const char *node
, const char *name
,
2802 AioContext
*aio_context
;
2803 BdrvDirtyBitmap
*bitmap
;
2804 BlockDriverState
*bs
;
2806 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2807 if (!bitmap
|| !bs
) {
2811 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2813 "Bitmap '%s' is currently frozen and cannot be modified",
2816 } else if (!bdrv_dirty_bitmap_enabled(bitmap
)) {
2818 "Bitmap '%s' is currently disabled and cannot be cleared",
2823 bdrv_clear_dirty_bitmap(bitmap
, NULL
);
2826 aio_context_release(aio_context
);
2829 void hmp_drive_del(Monitor
*mon
, const QDict
*qdict
)
2831 const char *id
= qdict_get_str(qdict
, "id");
2833 BlockDriverState
*bs
;
2834 AioContext
*aio_context
;
2835 Error
*local_err
= NULL
;
2837 bs
= bdrv_find_node(id
);
2839 qmp_blockdev_del(id
, &local_err
);
2841 error_report_err(local_err
);
2846 blk
= blk_by_name(id
);
2848 error_report("Device '%s' not found", id
);
2852 if (!blk_legacy_dinfo(blk
)) {
2853 error_report("Deleting device added with blockdev-add"
2854 " is not supported");
2858 aio_context
= blk_get_aio_context(blk
);
2859 aio_context_acquire(aio_context
);
2863 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2864 error_report_err(local_err
);
2865 aio_context_release(aio_context
);
2872 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2873 monitor_remove_blk(blk
);
2875 /* If this BlockBackend has a device attached to it, its refcount will be
2876 * decremented when the device is removed; otherwise we have to do so here.
2878 if (blk_get_attached_dev(blk
)) {
2879 /* Further I/O must not pause the guest */
2880 blk_set_on_error(blk
, BLOCKDEV_ON_ERROR_REPORT
,
2881 BLOCKDEV_ON_ERROR_REPORT
);
2886 aio_context_release(aio_context
);
2889 void qmp_block_resize(bool has_device
, const char *device
,
2890 bool has_node_name
, const char *node_name
,
2891 int64_t size
, Error
**errp
)
2893 Error
*local_err
= NULL
;
2894 BlockBackend
*blk
= NULL
;
2895 BlockDriverState
*bs
;
2896 AioContext
*aio_context
;
2899 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2900 has_node_name
? node_name
: NULL
,
2903 error_propagate(errp
, local_err
);
2907 aio_context
= bdrv_get_aio_context(bs
);
2908 aio_context_acquire(aio_context
);
2910 if (!bdrv_is_first_non_filter(bs
)) {
2911 error_setg(errp
, QERR_FEATURE_DISABLED
, "resize");
2916 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2920 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2921 error_setg(errp
, QERR_DEVICE_IN_USE
, device
);
2925 blk
= blk_new(BLK_PERM_RESIZE
, BLK_PERM_ALL
);
2926 ret
= blk_insert_bs(blk
, bs
, errp
);
2931 bdrv_drained_begin(bs
);
2932 ret
= blk_truncate(blk
, size
, errp
);
2933 bdrv_drained_end(bs
);
2937 aio_context_release(aio_context
);
2940 void qmp_block_stream(bool has_job_id
, const char *job_id
, const char *device
,
2941 bool has_base
, const char *base
,
2942 bool has_base_node
, const char *base_node
,
2943 bool has_backing_file
, const char *backing_file
,
2944 bool has_speed
, int64_t speed
,
2945 bool has_on_error
, BlockdevOnError on_error
,
2948 BlockDriverState
*bs
, *iter
;
2949 BlockDriverState
*base_bs
= NULL
;
2950 AioContext
*aio_context
;
2951 Error
*local_err
= NULL
;
2952 const char *base_name
= NULL
;
2954 if (!has_on_error
) {
2955 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2958 bs
= bdrv_lookup_bs(device
, device
, errp
);
2963 aio_context
= bdrv_get_aio_context(bs
);
2964 aio_context_acquire(aio_context
);
2966 if (has_base
&& has_base_node
) {
2967 error_setg(errp
, "'base' and 'base-node' cannot be specified "
2968 "at the same time");
2973 base_bs
= bdrv_find_backing_image(bs
, base
);
2974 if (base_bs
== NULL
) {
2975 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
);
2978 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2982 if (has_base_node
) {
2983 base_bs
= bdrv_lookup_bs(NULL
, base_node
, errp
);
2987 if (bs
== base_bs
|| !bdrv_chain_contains(bs
, base_bs
)) {
2988 error_setg(errp
, "Node '%s' is not a backing image of '%s'",
2992 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2993 base_name
= base_bs
->filename
;
2996 /* Check for op blockers in the whole chain between bs and base */
2997 for (iter
= bs
; iter
&& iter
!= base_bs
; iter
= backing_bs(iter
)) {
2998 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_STREAM
, errp
)) {
3003 /* if we are streaming the entire chain, the result will have no backing
3004 * file, and specifying one is therefore an error */
3005 if (base_bs
== NULL
&& has_backing_file
) {
3006 error_setg(errp
, "backing file specified, but streaming the "
3011 /* backing_file string overrides base bs filename */
3012 base_name
= has_backing_file
? backing_file
: base_name
;
3014 stream_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, base_name
,
3015 has_speed
? speed
: 0, on_error
, &local_err
);
3017 error_propagate(errp
, local_err
);
3021 trace_qmp_block_stream(bs
, bs
->job
);
3024 aio_context_release(aio_context
);
3027 void qmp_block_commit(bool has_job_id
, const char *job_id
, const char *device
,
3028 bool has_base
, const char *base
,
3029 bool has_top
, const char *top
,
3030 bool has_backing_file
, const char *backing_file
,
3031 bool has_speed
, int64_t speed
,
3032 bool has_filter_node_name
, const char *filter_node_name
,
3035 BlockDriverState
*bs
;
3036 BlockDriverState
*iter
;
3037 BlockDriverState
*base_bs
, *top_bs
;
3038 AioContext
*aio_context
;
3039 Error
*local_err
= NULL
;
3040 /* This will be part of the QMP command, if/when the
3041 * BlockdevOnError change for blkmirror makes it in
3043 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
3048 if (!has_filter_node_name
) {
3049 filter_node_name
= NULL
;
3053 * libvirt relies on the DeviceNotFound error class in order to probe for
3054 * live commit feature versions; for this to work, we must make sure to
3055 * perform the device lookup before any generic errors that may occur in a
3056 * scenario in which all optional arguments are omitted. */
3057 bs
= qmp_get_root_bs(device
, &local_err
);
3059 bs
= bdrv_lookup_bs(device
, device
, NULL
);
3061 error_free(local_err
);
3062 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
3063 "Device '%s' not found", device
);
3065 error_propagate(errp
, local_err
);
3070 aio_context
= bdrv_get_aio_context(bs
);
3071 aio_context_acquire(aio_context
);
3073 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
3077 /* default top_bs is the active layer */
3080 if (has_top
&& top
) {
3081 if (strcmp(bs
->filename
, top
) != 0) {
3082 top_bs
= bdrv_find_backing_image(bs
, top
);
3086 if (top_bs
== NULL
) {
3087 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
3091 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
3093 if (has_base
&& base
) {
3094 base_bs
= bdrv_find_backing_image(top_bs
, base
);
3096 base_bs
= bdrv_find_base(top_bs
);
3099 if (base_bs
== NULL
) {
3100 error_setg(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
3104 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
3106 for (iter
= top_bs
; iter
!= backing_bs(base_bs
); iter
= backing_bs(iter
)) {
3107 if (bdrv_op_is_blocked(iter
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3112 /* Do not allow attempts to commit an image into itself */
3113 if (top_bs
== base_bs
) {
3114 error_setg(errp
, "cannot commit an image into itself");
3119 if (has_backing_file
) {
3120 error_setg(errp
, "'backing-file' specified,"
3121 " but 'top' is the active layer");
3124 commit_active_start(has_job_id
? job_id
: NULL
, bs
, base_bs
,
3125 BLOCK_JOB_DEFAULT
, speed
, on_error
,
3126 filter_node_name
, NULL
, NULL
, false, &local_err
);
3128 BlockDriverState
*overlay_bs
= bdrv_find_overlay(bs
, top_bs
);
3129 if (bdrv_op_is_blocked(overlay_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
3132 commit_start(has_job_id
? job_id
: NULL
, bs
, base_bs
, top_bs
, speed
,
3133 on_error
, has_backing_file
? backing_file
: NULL
,
3134 filter_node_name
, &local_err
);
3136 if (local_err
!= NULL
) {
3137 error_propagate(errp
, local_err
);
3142 aio_context_release(aio_context
);
3145 static BlockJob
*do_drive_backup(DriveBackup
*backup
, BlockJobTxn
*txn
,
3148 BlockDriverState
*bs
;
3149 BlockDriverState
*target_bs
;
3150 BlockDriverState
*source
= NULL
;
3151 BlockJob
*job
= NULL
;
3152 BdrvDirtyBitmap
*bmap
= NULL
;
3153 AioContext
*aio_context
;
3154 QDict
*options
= NULL
;
3155 Error
*local_err
= NULL
;
3158 bool set_backing_hd
= false;
3160 if (!backup
->has_speed
) {
3163 if (!backup
->has_on_source_error
) {
3164 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3166 if (!backup
->has_on_target_error
) {
3167 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3169 if (!backup
->has_mode
) {
3170 backup
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3172 if (!backup
->has_job_id
) {
3173 backup
->job_id
= NULL
;
3175 if (!backup
->has_compress
) {
3176 backup
->compress
= false;
3179 bs
= qmp_get_root_bs(backup
->device
, errp
);
3184 aio_context
= bdrv_get_aio_context(bs
);
3185 aio_context_acquire(aio_context
);
3187 if (!backup
->has_format
) {
3188 backup
->format
= backup
->mode
== NEW_IMAGE_MODE_EXISTING
?
3189 NULL
: (char*) bs
->drv
->format_name
;
3192 /* Early check to avoid creating target */
3193 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
3197 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3199 /* See if we have a backing HD we can use to create our new image
3201 if (backup
->sync
== MIRROR_SYNC_MODE_TOP
) {
3202 source
= backing_bs(bs
);
3204 backup
->sync
= MIRROR_SYNC_MODE_FULL
;
3207 if (backup
->sync
== MIRROR_SYNC_MODE_NONE
) {
3209 flags
|= BDRV_O_NO_BACKING
;
3210 set_backing_hd
= true;
3213 size
= bdrv_getlength(bs
);
3215 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3219 if (backup
->mode
!= NEW_IMAGE_MODE_EXISTING
) {
3220 assert(backup
->format
);
3222 bdrv_img_create(backup
->target
, backup
->format
, source
->filename
,
3223 source
->drv
->format_name
, NULL
,
3224 size
, flags
, false, &local_err
);
3226 bdrv_img_create(backup
->target
, backup
->format
, NULL
, NULL
, NULL
,
3227 size
, flags
, false, &local_err
);
3232 error_propagate(errp
, local_err
);
3236 if (backup
->format
) {
3238 options
= qdict_new();
3240 qdict_put_str(options
, "driver", backup
->format
);
3243 target_bs
= bdrv_open(backup
->target
, NULL
, options
, flags
, errp
);
3248 bdrv_set_aio_context(target_bs
, aio_context
);
3250 if (set_backing_hd
) {
3251 bdrv_set_backing_hd(target_bs
, source
, &local_err
);
3253 bdrv_unref(target_bs
);
3258 if (backup
->has_bitmap
) {
3259 bmap
= bdrv_find_dirty_bitmap(bs
, backup
->bitmap
);
3261 error_setg(errp
, "Bitmap '%s' could not be found", backup
->bitmap
);
3262 bdrv_unref(target_bs
);
3267 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3268 backup
->sync
, bmap
, backup
->compress
,
3269 backup
->on_source_error
, backup
->on_target_error
,
3270 BLOCK_JOB_DEFAULT
, NULL
, NULL
, txn
, &local_err
);
3271 bdrv_unref(target_bs
);
3272 if (local_err
!= NULL
) {
3273 error_propagate(errp
, local_err
);
3278 aio_context_release(aio_context
);
3282 void qmp_drive_backup(DriveBackup
*arg
, Error
**errp
)
3286 job
= do_drive_backup(arg
, NULL
, errp
);
3288 block_job_start(job
);
3292 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
3294 return bdrv_named_nodes_list(errp
);
3297 BlockJob
*do_blockdev_backup(BlockdevBackup
*backup
, BlockJobTxn
*txn
,
3300 BlockDriverState
*bs
;
3301 BlockDriverState
*target_bs
;
3302 Error
*local_err
= NULL
;
3303 AioContext
*aio_context
;
3304 BlockJob
*job
= NULL
;
3306 if (!backup
->has_speed
) {
3309 if (!backup
->has_on_source_error
) {
3310 backup
->on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3312 if (!backup
->has_on_target_error
) {
3313 backup
->on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3315 if (!backup
->has_job_id
) {
3316 backup
->job_id
= NULL
;
3318 if (!backup
->has_compress
) {
3319 backup
->compress
= false;
3322 bs
= qmp_get_root_bs(backup
->device
, errp
);
3327 aio_context
= bdrv_get_aio_context(bs
);
3328 aio_context_acquire(aio_context
);
3330 target_bs
= bdrv_lookup_bs(backup
->target
, backup
->target
, errp
);
3335 if (bdrv_get_aio_context(target_bs
) != aio_context
) {
3336 if (!bdrv_has_blk(target_bs
)) {
3337 /* The target BDS is not attached, we can safely move it to another
3339 bdrv_set_aio_context(target_bs
, aio_context
);
3341 error_setg(errp
, "Target is attached to a different thread from "
3346 job
= backup_job_create(backup
->job_id
, bs
, target_bs
, backup
->speed
,
3347 backup
->sync
, NULL
, backup
->compress
,
3348 backup
->on_source_error
, backup
->on_target_error
,
3349 BLOCK_JOB_DEFAULT
, NULL
, NULL
, txn
, &local_err
);
3350 if (local_err
!= NULL
) {
3351 error_propagate(errp
, local_err
);
3354 aio_context_release(aio_context
);
3358 void qmp_blockdev_backup(BlockdevBackup
*arg
, Error
**errp
)
3361 job
= do_blockdev_backup(arg
, NULL
, errp
);
3363 block_job_start(job
);
3367 /* Parameter check and block job starting for drive mirroring.
3368 * Caller should hold @device and @target's aio context (must be the same).
3370 static void blockdev_mirror_common(const char *job_id
, BlockDriverState
*bs
,
3371 BlockDriverState
*target
,
3372 bool has_replaces
, const char *replaces
,
3373 enum MirrorSyncMode sync
,
3374 BlockMirrorBackingMode backing_mode
,
3375 bool has_speed
, int64_t speed
,
3376 bool has_granularity
, uint32_t granularity
,
3377 bool has_buf_size
, int64_t buf_size
,
3378 bool has_on_source_error
,
3379 BlockdevOnError on_source_error
,
3380 bool has_on_target_error
,
3381 BlockdevOnError on_target_error
,
3382 bool has_unmap
, bool unmap
,
3383 bool has_filter_node_name
,
3384 const char *filter_node_name
,
3391 if (!has_on_source_error
) {
3392 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
3394 if (!has_on_target_error
) {
3395 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
3397 if (!has_granularity
) {
3400 if (!has_buf_size
) {
3406 if (!has_filter_node_name
) {
3407 filter_node_name
= NULL
;
3410 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
3411 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3412 "a value in range [512B, 64MB]");
3415 if (granularity
& (granularity
- 1)) {
3416 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
3421 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR_SOURCE
, errp
)) {
3424 if (bdrv_op_is_blocked(target
, BLOCK_OP_TYPE_MIRROR_TARGET
, errp
)) {
3428 if (!bs
->backing
&& sync
== MIRROR_SYNC_MODE_TOP
) {
3429 sync
= MIRROR_SYNC_MODE_FULL
;
3432 /* pass the node name to replace to mirror start since it's loose coupling
3433 * and will allow to check whether the node still exist at mirror completion
3435 mirror_start(job_id
, bs
, target
,
3436 has_replaces
? replaces
: NULL
,
3437 speed
, granularity
, buf_size
, sync
, backing_mode
,
3438 on_source_error
, on_target_error
, unmap
, filter_node_name
,
3442 void qmp_drive_mirror(DriveMirror
*arg
, Error
**errp
)
3444 BlockDriverState
*bs
;
3445 BlockDriverState
*source
, *target_bs
;
3446 AioContext
*aio_context
;
3447 BlockMirrorBackingMode backing_mode
;
3448 Error
*local_err
= NULL
;
3449 QDict
*options
= NULL
;
3452 const char *format
= arg
->format
;
3454 bs
= qmp_get_root_bs(arg
->device
, errp
);
3459 aio_context
= bdrv_get_aio_context(bs
);
3460 aio_context_acquire(aio_context
);
3462 if (!arg
->has_mode
) {
3463 arg
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
3466 if (!arg
->has_format
) {
3467 format
= (arg
->mode
== NEW_IMAGE_MODE_EXISTING
3468 ? NULL
: bs
->drv
->format_name
);
3471 flags
= bs
->open_flags
| BDRV_O_RDWR
;
3472 source
= backing_bs(bs
);
3473 if (!source
&& arg
->sync
== MIRROR_SYNC_MODE_TOP
) {
3474 arg
->sync
= MIRROR_SYNC_MODE_FULL
;
3476 if (arg
->sync
== MIRROR_SYNC_MODE_NONE
) {
3480 size
= bdrv_getlength(bs
);
3482 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
3486 if (arg
->has_replaces
) {
3487 BlockDriverState
*to_replace_bs
;
3488 AioContext
*replace_aio_context
;
3489 int64_t replace_size
;
3491 if (!arg
->has_node_name
) {
3492 error_setg(errp
, "a node-name must be provided when replacing a"
3493 " named node of the graph");
3497 to_replace_bs
= check_to_replace_node(bs
, arg
->replaces
, &local_err
);
3499 if (!to_replace_bs
) {
3500 error_propagate(errp
, local_err
);
3504 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
3505 aio_context_acquire(replace_aio_context
);
3506 replace_size
= bdrv_getlength(to_replace_bs
);
3507 aio_context_release(replace_aio_context
);
3509 if (size
!= replace_size
) {
3510 error_setg(errp
, "cannot replace image with a mirror image of "
3516 if (arg
->mode
== NEW_IMAGE_MODE_ABSOLUTE_PATHS
) {
3517 backing_mode
= MIRROR_SOURCE_BACKING_CHAIN
;
3519 backing_mode
= MIRROR_OPEN_BACKING_CHAIN
;
3522 if ((arg
->sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
3523 && arg
->mode
!= NEW_IMAGE_MODE_EXISTING
)
3525 /* create new image w/o backing file */
3527 bdrv_img_create(arg
->target
, format
,
3528 NULL
, NULL
, NULL
, size
, flags
, false, &local_err
);
3530 switch (arg
->mode
) {
3531 case NEW_IMAGE_MODE_EXISTING
:
3533 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
3534 /* create new image with backing file */
3535 bdrv_img_create(arg
->target
, format
,
3537 source
->drv
->format_name
,
3538 NULL
, size
, flags
, false, &local_err
);
3546 error_propagate(errp
, local_err
);
3550 options
= qdict_new();
3551 if (arg
->has_node_name
) {
3552 qdict_put_str(options
, "node-name", arg
->node_name
);
3555 qdict_put_str(options
, "driver", format
);
3558 /* Mirroring takes care of copy-on-write using the source's backing
3561 target_bs
= bdrv_open(arg
->target
, NULL
, options
,
3562 flags
| BDRV_O_NO_BACKING
, errp
);
3567 bdrv_set_aio_context(target_bs
, aio_context
);
3569 blockdev_mirror_common(arg
->has_job_id
? arg
->job_id
: NULL
, bs
, target_bs
,
3570 arg
->has_replaces
, arg
->replaces
, arg
->sync
,
3571 backing_mode
, arg
->has_speed
, arg
->speed
,
3572 arg
->has_granularity
, arg
->granularity
,
3573 arg
->has_buf_size
, arg
->buf_size
,
3574 arg
->has_on_source_error
, arg
->on_source_error
,
3575 arg
->has_on_target_error
, arg
->on_target_error
,
3576 arg
->has_unmap
, arg
->unmap
,
3579 bdrv_unref(target_bs
);
3580 error_propagate(errp
, local_err
);
3582 aio_context_release(aio_context
);
3585 void qmp_blockdev_mirror(bool has_job_id
, const char *job_id
,
3586 const char *device
, const char *target
,
3587 bool has_replaces
, const char *replaces
,
3588 MirrorSyncMode sync
,
3589 bool has_speed
, int64_t speed
,
3590 bool has_granularity
, uint32_t granularity
,
3591 bool has_buf_size
, int64_t buf_size
,
3592 bool has_on_source_error
,
3593 BlockdevOnError on_source_error
,
3594 bool has_on_target_error
,
3595 BlockdevOnError on_target_error
,
3596 bool has_filter_node_name
,
3597 const char *filter_node_name
,
3600 BlockDriverState
*bs
;
3601 BlockDriverState
*target_bs
;
3602 AioContext
*aio_context
;
3603 BlockMirrorBackingMode backing_mode
= MIRROR_LEAVE_BACKING_CHAIN
;
3604 Error
*local_err
= NULL
;
3606 bs
= qmp_get_root_bs(device
, errp
);
3611 target_bs
= bdrv_lookup_bs(target
, target
, errp
);
3616 aio_context
= bdrv_get_aio_context(bs
);
3617 aio_context_acquire(aio_context
);
3619 bdrv_set_aio_context(target_bs
, aio_context
);
3621 blockdev_mirror_common(has_job_id
? job_id
: NULL
, bs
, target_bs
,
3622 has_replaces
, replaces
, sync
, backing_mode
,
3624 has_granularity
, granularity
,
3625 has_buf_size
, buf_size
,
3626 has_on_source_error
, on_source_error
,
3627 has_on_target_error
, on_target_error
,
3629 has_filter_node_name
, filter_node_name
,
3631 error_propagate(errp
, local_err
);
3633 aio_context_release(aio_context
);
3636 /* Get a block job using its ID and acquire its AioContext */
3637 static BlockJob
*find_block_job(const char *id
, AioContext
**aio_context
,
3644 *aio_context
= NULL
;
3646 job
= block_job_get(id
);
3649 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
3650 "Block job '%s' not found", id
);
3654 *aio_context
= blk_get_aio_context(job
->blk
);
3655 aio_context_acquire(*aio_context
);
3660 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
3662 AioContext
*aio_context
;
3663 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3669 block_job_set_speed(job
, speed
, errp
);
3670 aio_context_release(aio_context
);
3673 void qmp_block_job_cancel(const char *device
,
3674 bool has_force
, bool force
, Error
**errp
)
3676 AioContext
*aio_context
;
3677 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3687 if (block_job_user_paused(job
) && !force
) {
3688 error_setg(errp
, "The block job for device '%s' is currently paused",
3693 trace_qmp_block_job_cancel(job
);
3694 block_job_cancel(job
);
3696 aio_context_release(aio_context
);
3699 void qmp_block_job_pause(const char *device
, Error
**errp
)
3701 AioContext
*aio_context
;
3702 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3704 if (!job
|| block_job_user_paused(job
)) {
3708 trace_qmp_block_job_pause(job
);
3709 block_job_user_pause(job
);
3710 aio_context_release(aio_context
);
3713 void qmp_block_job_resume(const char *device
, Error
**errp
)
3715 AioContext
*aio_context
;
3716 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3718 if (!job
|| !block_job_user_paused(job
)) {
3722 trace_qmp_block_job_resume(job
);
3723 block_job_user_resume(job
);
3724 aio_context_release(aio_context
);
3727 void qmp_block_job_complete(const char *device
, Error
**errp
)
3729 AioContext
*aio_context
;
3730 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
3736 trace_qmp_block_job_complete(job
);
3737 block_job_complete(job
, errp
);
3738 aio_context_release(aio_context
);
3741 void qmp_change_backing_file(const char *device
,
3742 const char *image_node_name
,
3743 const char *backing_file
,
3746 BlockDriverState
*bs
= NULL
;
3747 AioContext
*aio_context
;
3748 BlockDriverState
*image_bs
= NULL
;
3749 Error
*local_err
= NULL
;
3754 bs
= qmp_get_root_bs(device
, errp
);
3759 aio_context
= bdrv_get_aio_context(bs
);
3760 aio_context_acquire(aio_context
);
3762 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
3764 error_propagate(errp
, local_err
);
3769 error_setg(errp
, "image file not found");
3773 if (bdrv_find_base(image_bs
) == image_bs
) {
3774 error_setg(errp
, "not allowing backing file change on an image "
3775 "without a backing file");
3779 /* even though we are not necessarily operating on bs, we need it to
3780 * determine if block ops are currently prohibited on the chain */
3781 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
3785 /* final sanity check */
3786 if (!bdrv_chain_contains(bs
, image_bs
)) {
3787 error_setg(errp
, "'%s' and image file are not in the same chain",
3792 /* if not r/w, reopen to make r/w */
3793 open_flags
= image_bs
->open_flags
;
3794 ro
= bdrv_is_read_only(image_bs
);
3797 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
3799 error_propagate(errp
, local_err
);
3804 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
3805 image_bs
->drv
? image_bs
->drv
->format_name
: "");
3808 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
3810 /* don't exit here, so we can try to restore open flags if
3815 bdrv_reopen(image_bs
, open_flags
, &local_err
);
3816 error_propagate(errp
, local_err
);
3820 aio_context_release(aio_context
);
3823 void hmp_drive_add_node(Monitor
*mon
, const char *optstr
)
3827 Error
*local_err
= NULL
;
3829 opts
= qemu_opts_parse_noisily(&qemu_drive_opts
, optstr
, false);
3834 qdict
= qemu_opts_to_qdict(opts
, NULL
);
3836 if (!qdict_get_try_str(qdict
, "node-name")) {
3838 error_report("'node-name' needs to be specified");
3842 BlockDriverState
*bs
= bds_tree_init(qdict
, &local_err
);
3844 error_report_err(local_err
);
3848 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3851 qemu_opts_del(opts
);
3854 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
3856 BlockDriverState
*bs
;
3858 Visitor
*v
= qobject_output_visitor_new(&obj
);
3860 Error
*local_err
= NULL
;
3862 visit_type_BlockdevOptions(v
, NULL
, &options
, &local_err
);
3864 error_propagate(errp
, local_err
);
3868 visit_complete(v
, &obj
);
3869 qdict
= qobject_to_qdict(obj
);
3871 qdict_flatten(qdict
);
3873 if (!qdict_get_try_str(qdict
, "node-name")) {
3874 error_setg(errp
, "'node-name' must be specified for the root node");
3878 bs
= bds_tree_init(qdict
, errp
);
3883 QTAILQ_INSERT_TAIL(&monitor_bdrv_states
, bs
, monitor_list
);
3885 if (bs
&& bdrv_key_required(bs
)) {
3886 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3888 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3896 void qmp_blockdev_del(const char *node_name
, Error
**errp
)
3898 AioContext
*aio_context
;
3899 BlockDriverState
*bs
;
3901 bs
= bdrv_find_node(node_name
);
3903 error_setg(errp
, "Cannot find node %s", node_name
);
3906 if (bdrv_has_blk(bs
)) {
3907 error_setg(errp
, "Node %s is in use", node_name
);
3910 aio_context
= bdrv_get_aio_context(bs
);
3911 aio_context_acquire(aio_context
);
3913 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, errp
)) {
3917 if (!bs
->monitor_list
.tqe_prev
) {
3918 error_setg(errp
, "Node %s is not owned by the monitor",
3923 if (bs
->refcnt
> 1) {
3924 error_setg(errp
, "Block device %s is in use",
3925 bdrv_get_device_or_node_name(bs
));
3929 QTAILQ_REMOVE(&monitor_bdrv_states
, bs
, monitor_list
);
3933 aio_context_release(aio_context
);
3936 static BdrvChild
*bdrv_find_child(BlockDriverState
*parent_bs
,
3937 const char *child_name
)
3941 QLIST_FOREACH(child
, &parent_bs
->children
, next
) {
3942 if (strcmp(child
->name
, child_name
) == 0) {
3950 void qmp_x_blockdev_change(const char *parent
, bool has_child
,
3951 const char *child
, bool has_node
,
3952 const char *node
, Error
**errp
)
3954 BlockDriverState
*parent_bs
, *new_bs
= NULL
;
3957 parent_bs
= bdrv_lookup_bs(parent
, parent
, errp
);
3962 if (has_child
== has_node
) {
3964 error_setg(errp
, "The parameters child and node are in conflict");
3966 error_setg(errp
, "Either child or node must be specified");
3972 p_child
= bdrv_find_child(parent_bs
, child
);
3974 error_setg(errp
, "Node '%s' does not have child '%s'",
3978 bdrv_del_child(parent_bs
, p_child
, errp
);
3982 new_bs
= bdrv_find_node(node
);
3984 error_setg(errp
, "Node '%s' not found", node
);
3987 bdrv_add_child(parent_bs
, new_bs
, errp
);
3991 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3993 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3996 for (job
= block_job_next(NULL
); job
; job
= block_job_next(job
)) {
3997 BlockJobInfoList
*elem
;
3998 AioContext
*aio_context
;
4000 if (block_job_is_internal(job
)) {
4003 elem
= g_new0(BlockJobInfoList
, 1);
4004 aio_context
= blk_get_aio_context(job
->blk
);
4005 aio_context_acquire(aio_context
);
4006 elem
->value
= block_job_query(job
, errp
);
4007 aio_context_release(aio_context
);
4010 qapi_free_BlockJobInfoList(head
);
4014 p_next
= &elem
->next
;
4020 QemuOptsList qemu_common_drive_opts
= {
4022 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
4026 .type
= QEMU_OPT_BOOL
,
4027 .help
= "enable/disable snapshot mode",
4030 .type
= QEMU_OPT_STRING
,
4031 .help
= "host AIO implementation (threads, native)",
4033 .name
= BDRV_OPT_CACHE_WB
,
4034 .type
= QEMU_OPT_BOOL
,
4035 .help
= "Enable writeback mode",
4038 .type
= QEMU_OPT_STRING
,
4039 .help
= "disk format (raw, qcow2, ...)",
4042 .type
= QEMU_OPT_STRING
,
4043 .help
= "read error action",
4046 .type
= QEMU_OPT_STRING
,
4047 .help
= "write error action",
4049 .name
= BDRV_OPT_READ_ONLY
,
4050 .type
= QEMU_OPT_BOOL
,
4051 .help
= "open drive file as read-only",
4057 .name
= "throttling.group",
4058 .type
= QEMU_OPT_STRING
,
4059 .help
= "name of the block throttling group",
4061 .name
= "copy-on-read",
4062 .type
= QEMU_OPT_BOOL
,
4063 .help
= "copy read data from backing file into image file",
4065 .name
= "detect-zeroes",
4066 .type
= QEMU_OPT_STRING
,
4067 .help
= "try to optimize zero writes (off, on, unmap)",
4069 .name
= "stats-account-invalid",
4070 .type
= QEMU_OPT_BOOL
,
4071 .help
= "whether to account for invalid I/O operations "
4072 "in the statistics",
4074 .name
= "stats-account-failed",
4075 .type
= QEMU_OPT_BOOL
,
4076 .help
= "whether to account for failed I/O operations "
4077 "in the statistics",
4079 { /* end of list */ }
4083 QemuOptsList qemu_drive_opts
= {
4085 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
4088 * no elements => accept any params
4089 * validation will happen later
4091 { /* end of list */ }