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 "sysemu/block-backend.h"
34 #include "sysemu/blockdev.h"
35 #include "hw/block/block.h"
36 #include "block/blockjob.h"
37 #include "monitor/monitor.h"
38 #include "qemu/option.h"
39 #include "qemu/config-file.h"
40 #include "qapi/qmp/types.h"
41 #include "qapi-visit.h"
42 #include "qapi/qmp-output-visitor.h"
43 #include "qapi/util.h"
44 #include "sysemu/sysemu.h"
45 #include "block/block_int.h"
46 #include "qmp-commands.h"
48 #include "sysemu/arch_init.h"
50 static const char *const if_name
[IF_COUNT
] = {
54 [IF_FLOPPY
] = "floppy",
55 [IF_PFLASH
] = "pflash",
58 [IF_VIRTIO
] = "virtio",
62 static int if_max_devs
[IF_COUNT
] = {
64 * Do not change these numbers! They govern how drive option
65 * index maps to unit and bus. That mapping is ABI.
67 * All controllers used to imlement if=T drives need to support
68 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
69 * Otherwise, some index values map to "impossible" bus, unit
72 * For instance, if you change [IF_SCSI] to 255, -drive
73 * if=scsi,index=12 no longer means bus=1,unit=5, but
74 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
75 * the drive can't be set up. Regression.
82 * Boards may call this to offer board-by-board overrides
83 * of the default, global values.
85 void override_max_devs(BlockInterfaceType type
, int max_devs
)
94 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
95 dinfo
= blk_legacy_dinfo(blk
);
96 if (dinfo
->type
== type
) {
97 fprintf(stderr
, "Cannot override units-per-bus property of"
98 " the %s interface, because a drive of that type has"
99 " already been added.\n", if_name
[type
]);
100 g_assert_not_reached();
104 if_max_devs
[type
] = max_devs
;
108 * We automatically delete the drive when a device using it gets
109 * unplugged. Questionable feature, but we can't just drop it.
110 * Device models call blockdev_mark_auto_del() to schedule the
111 * automatic deletion, and generic qdev code calls blockdev_auto_del()
112 * when deletion is actually safe.
114 void blockdev_mark_auto_del(BlockBackend
*blk
)
116 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
117 BlockDriverState
*bs
= blk_bs(blk
);
118 AioContext
*aio_context
;
124 aio_context
= bdrv_get_aio_context(bs
);
125 aio_context_acquire(aio_context
);
128 block_job_cancel(bs
->job
);
131 aio_context_release(aio_context
);
136 void blockdev_auto_del(BlockBackend
*blk
)
138 DriveInfo
*dinfo
= blk_legacy_dinfo(blk
);
140 if (dinfo
&& dinfo
->auto_del
) {
146 * Returns the current mapping of how many units per bus
147 * a particular interface can support.
149 * A positive integer indicates n units per bus.
150 * 0 implies the mapping has not been established.
151 * -1 indicates an invalid BlockInterfaceType was given.
153 int drive_get_max_devs(BlockInterfaceType type
)
155 if (type
>= IF_IDE
&& type
< IF_COUNT
) {
156 return if_max_devs
[type
];
162 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
164 int max_devs
= if_max_devs
[type
];
165 return max_devs
? index
/ max_devs
: 0;
168 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
170 int max_devs
= if_max_devs
[type
];
171 return max_devs
? index
% max_devs
: index
;
174 QemuOpts
*drive_def(const char *optstr
)
176 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
179 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
184 opts
= drive_def(optstr
);
188 if (type
!= IF_DEFAULT
) {
189 qemu_opt_set(opts
, "if", if_name
[type
], &error_abort
);
192 qemu_opt_set_number(opts
, "index", index
, &error_abort
);
195 qemu_opt_set(opts
, "file", file
, &error_abort
);
199 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
204 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
205 dinfo
= blk_legacy_dinfo(blk
);
206 if (dinfo
&& dinfo
->type
== type
207 && dinfo
->bus
== bus
&& dinfo
->unit
== unit
) {
215 bool drive_check_orphaned(void)
221 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
222 dinfo
= blk_legacy_dinfo(blk
);
223 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
224 /* Unless this is a default drive, this may be an oversight. */
225 if (!blk_get_attached_dev(blk
) && !dinfo
->is_default
&&
226 dinfo
->type
!= IF_NONE
) {
227 fprintf(stderr
, "Warning: Orphaned drive without device: "
228 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
229 blk_name(blk
), blk_bs(blk
)->filename
, if_name
[dinfo
->type
],
230 dinfo
->bus
, dinfo
->unit
);
238 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
240 return drive_get(type
,
241 drive_index_to_bus_id(type
, index
),
242 drive_index_to_unit_id(type
, index
));
245 int drive_get_max_bus(BlockInterfaceType type
)
252 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
253 dinfo
= blk_legacy_dinfo(blk
);
254 if (dinfo
&& dinfo
->type
== type
&& dinfo
->bus
> max_bus
) {
255 max_bus
= dinfo
->bus
;
261 /* Get a block device. This should only be used for single-drive devices
262 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
264 DriveInfo
*drive_get_next(BlockInterfaceType type
)
266 static int next_block_unit
[IF_COUNT
];
268 return drive_get(type
, 0, next_block_unit
[type
]++);
271 static void bdrv_format_print(void *opaque
, const char *name
)
273 error_printf(" %s", name
);
278 BlockDriverState
*bs
;
281 static void bdrv_put_ref_bh(void *opaque
)
283 BDRVPutRefBH
*s
= opaque
;
286 qemu_bh_delete(s
->bh
);
291 * Release a BDS reference in a BH
293 * It is not safe to use bdrv_unref() from a callback function when the callers
294 * still need the BlockDriverState. In such cases we schedule a BH to release
297 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
301 s
= g_new(BDRVPutRefBH
, 1);
302 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
304 qemu_bh_schedule(s
->bh
);
307 static int parse_block_error_action(const char *buf
, bool is_read
, Error
**errp
)
309 if (!strcmp(buf
, "ignore")) {
310 return BLOCKDEV_ON_ERROR_IGNORE
;
311 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
312 return BLOCKDEV_ON_ERROR_ENOSPC
;
313 } else if (!strcmp(buf
, "stop")) {
314 return BLOCKDEV_ON_ERROR_STOP
;
315 } else if (!strcmp(buf
, "report")) {
316 return BLOCKDEV_ON_ERROR_REPORT
;
318 error_setg(errp
, "'%s' invalid %s error action",
319 buf
, is_read
? "read" : "write");
324 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
326 if (throttle_conflicting(cfg
)) {
327 error_setg(errp
, "bps/iops/max total values and read/write values"
328 " cannot be used at the same time");
332 if (!throttle_is_valid(cfg
)) {
333 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
340 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
342 /* Takes the ownership of bs_opts */
343 static BlockBackend
*blockdev_init(const char *file
, QDict
*bs_opts
,
349 int on_read_error
, on_write_error
;
351 BlockDriverState
*bs
;
358 bool has_driver_specific_opts
;
359 BlockdevDetectZeroesOptions detect_zeroes
;
361 /* Check common options by copying from bs_opts to opts, all other options
362 * stay in bs_opts for processing by bdrv_open(). */
363 id
= qdict_get_try_str(bs_opts
, "id");
364 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
366 error_propagate(errp
, error
);
370 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
372 error_propagate(errp
, error
);
377 qdict_del(bs_opts
, "id");
380 has_driver_specific_opts
= !!qdict_size(bs_opts
);
382 /* extract parameters */
383 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
384 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
385 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
387 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
388 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
389 error_setg(errp
, "invalid discard option");
394 if (qemu_opt_get_bool(opts
, "cache.writeback", true)) {
395 bdrv_flags
|= BDRV_O_CACHE_WB
;
397 if (qemu_opt_get_bool(opts
, "cache.direct", false)) {
398 bdrv_flags
|= BDRV_O_NOCACHE
;
400 if (qemu_opt_get_bool(opts
, "cache.no-flush", false)) {
401 bdrv_flags
|= BDRV_O_NO_FLUSH
;
404 #ifdef CONFIG_LINUX_AIO
405 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
406 if (!strcmp(buf
, "native")) {
407 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
408 } else if (!strcmp(buf
, "threads")) {
409 /* this is the default */
411 error_setg(errp
, "invalid aio option");
417 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
418 if (is_help_option(buf
)) {
419 error_printf("Supported formats:");
420 bdrv_iterate_format(bdrv_format_print
, NULL
);
425 if (qdict_haskey(bs_opts
, "driver")) {
426 error_setg(errp
, "Cannot specify both 'driver' and 'format'");
429 qdict_put(bs_opts
, "driver", qstring_from_str(buf
));
432 /* disk I/O throttling */
433 memset(&cfg
, 0, sizeof(cfg
));
434 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
435 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
436 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
437 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
438 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
439 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
440 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
441 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
442 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
443 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
444 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
445 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
447 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
448 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
449 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
450 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
451 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
452 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
453 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
454 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
455 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
456 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
457 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
458 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
460 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
462 if (!check_throttle_config(&cfg
, &error
)) {
463 error_propagate(errp
, error
);
467 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
468 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
469 on_write_error
= parse_block_error_action(buf
, 0, &error
);
471 error_propagate(errp
, error
);
476 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
477 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
478 on_read_error
= parse_block_error_action(buf
, 1, &error
);
480 error_propagate(errp
, error
);
486 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup
,
487 qemu_opt_get(opts
, "detect-zeroes"),
488 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX
,
489 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
492 error_propagate(errp
, error
);
496 if (detect_zeroes
== BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP
&&
497 !(bdrv_flags
& BDRV_O_UNMAP
)) {
498 error_setg(errp
, "setting detect-zeroes to unmap is not allowed "
499 "without setting discard operation to unmap");
504 if ((!file
|| !*file
) && !has_driver_specific_opts
) {
505 blk
= blk_new_with_bs(qemu_opts_id(opts
), errp
);
511 bs
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
516 if (file
&& !*file
) {
521 /* always use cache=unsafe with snapshot */
522 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
523 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
527 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
530 if (runstate_check(RUN_STATE_INMIGRATE
)) {
531 bdrv_flags
|= BDRV_O_INCOMING
;
534 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
536 blk
= blk_new_open(qemu_opts_id(opts
), file
, NULL
, bs_opts
, bdrv_flags
,
544 bs
->detect_zeroes
= detect_zeroes
;
546 bdrv_set_on_error(bs
, on_read_error
, on_write_error
);
548 /* disk I/O throttling */
549 if (throttle_enabled(&cfg
)) {
550 bdrv_io_limits_enable(bs
);
551 bdrv_set_io_limits(bs
, &cfg
);
554 if (bdrv_key_required(bs
)) {
569 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
,
574 value
= qemu_opt_get(opts
, from
);
576 if (qemu_opt_find(opts
, to
)) {
577 error_setg(errp
, "'%s' and its alias '%s' can't be used at the "
578 "same time", to
, from
);
583 /* rename all items in opts */
584 while ((value
= qemu_opt_get(opts
, from
))) {
585 qemu_opt_set(opts
, to
, value
, &error_abort
);
586 qemu_opt_unset(opts
, from
);
590 QemuOptsList qemu_legacy_drive_opts
= {
592 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
596 .type
= QEMU_OPT_NUMBER
,
597 .help
= "bus number",
600 .type
= QEMU_OPT_NUMBER
,
601 .help
= "unit number (i.e. lun for scsi)",
604 .type
= QEMU_OPT_NUMBER
,
605 .help
= "index number",
608 .type
= QEMU_OPT_STRING
,
609 .help
= "media type (disk, cdrom)",
612 .type
= QEMU_OPT_STRING
,
613 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
616 .type
= QEMU_OPT_NUMBER
,
617 .help
= "number of cylinders (ide disk geometry)",
620 .type
= QEMU_OPT_NUMBER
,
621 .help
= "number of heads (ide disk geometry)",
624 .type
= QEMU_OPT_NUMBER
,
625 .help
= "number of sectors (ide disk geometry)",
628 .type
= QEMU_OPT_STRING
,
629 .help
= "chs translation (auto, lba, none)",
632 .type
= QEMU_OPT_BOOL
,
633 .help
= "(deprecated, ignored)",
636 .type
= QEMU_OPT_STRING
,
637 .help
= "pci address (virtio only)",
640 .type
= QEMU_OPT_STRING
,
641 .help
= "disk serial number",
644 .type
= QEMU_OPT_STRING
,
648 /* Options that are passed on, but have special semantics with -drive */
651 .type
= QEMU_OPT_BOOL
,
652 .help
= "open drive file as read-only",
655 .type
= QEMU_OPT_STRING
,
656 .help
= "read error action",
659 .type
= QEMU_OPT_STRING
,
660 .help
= "write error action",
662 .name
= "copy-on-read",
663 .type
= QEMU_OPT_BOOL
,
664 .help
= "copy read data from backing file into image file",
667 { /* end of list */ }
671 DriveInfo
*drive_new(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
675 DriveInfo
*dinfo
= NULL
;
677 QemuOpts
*legacy_opts
;
678 DriveMediaType media
= MEDIA_DISK
;
679 BlockInterfaceType type
;
680 int cyls
, heads
, secs
, translation
;
681 int max_devs
, bus_id
, unit_id
, index
;
683 const char *werror
, *rerror
;
684 bool read_only
= false;
687 const char *filename
;
688 Error
*local_err
= NULL
;
691 /* Change legacy command line options into QMP ones */
692 static const struct {
696 { "iops", "throttling.iops-total" },
697 { "iops_rd", "throttling.iops-read" },
698 { "iops_wr", "throttling.iops-write" },
700 { "bps", "throttling.bps-total" },
701 { "bps_rd", "throttling.bps-read" },
702 { "bps_wr", "throttling.bps-write" },
704 { "iops_max", "throttling.iops-total-max" },
705 { "iops_rd_max", "throttling.iops-read-max" },
706 { "iops_wr_max", "throttling.iops-write-max" },
708 { "bps_max", "throttling.bps-total-max" },
709 { "bps_rd_max", "throttling.bps-read-max" },
710 { "bps_wr_max", "throttling.bps-write-max" },
712 { "iops_size", "throttling.iops-size" },
714 { "readonly", "read-only" },
717 for (i
= 0; i
< ARRAY_SIZE(opt_renames
); i
++) {
718 qemu_opt_rename(all_opts
, opt_renames
[i
].from
, opt_renames
[i
].to
,
721 error_report_err(local_err
);
726 value
= qemu_opt_get(all_opts
, "cache");
730 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
731 error_report("invalid cache option");
735 /* Specific options take precedence */
736 if (!qemu_opt_get(all_opts
, "cache.writeback")) {
737 qemu_opt_set_bool(all_opts
, "cache.writeback",
738 !!(flags
& BDRV_O_CACHE_WB
), &error_abort
);
740 if (!qemu_opt_get(all_opts
, "cache.direct")) {
741 qemu_opt_set_bool(all_opts
, "cache.direct",
742 !!(flags
& BDRV_O_NOCACHE
), &error_abort
);
744 if (!qemu_opt_get(all_opts
, "cache.no-flush")) {
745 qemu_opt_set_bool(all_opts
, "cache.no-flush",
746 !!(flags
& BDRV_O_NO_FLUSH
), &error_abort
);
748 qemu_opt_unset(all_opts
, "cache");
751 /* Get a QDict for processing the options */
752 bs_opts
= qdict_new();
753 qemu_opts_to_qdict(all_opts
, bs_opts
);
755 legacy_opts
= qemu_opts_create(&qemu_legacy_drive_opts
, NULL
, 0,
757 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
759 error_report_err(local_err
);
763 /* Deprecated option boot=[on|off] */
764 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
765 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
766 "ignored. Future versions will reject this parameter. Please "
767 "update your scripts.\n");
771 value
= qemu_opt_get(legacy_opts
, "media");
773 if (!strcmp(value
, "disk")) {
775 } else if (!strcmp(value
, "cdrom")) {
779 error_report("'%s' invalid media", value
);
784 /* copy-on-read is disabled with a warning for read-only devices */
785 read_only
|= qemu_opt_get_bool(legacy_opts
, "read-only", false);
786 copy_on_read
= qemu_opt_get_bool(legacy_opts
, "copy-on-read", false);
788 if (read_only
&& copy_on_read
) {
789 error_report("warning: disabling copy-on-read on read-only drive");
790 copy_on_read
= false;
793 qdict_put(bs_opts
, "read-only",
794 qstring_from_str(read_only
? "on" : "off"));
795 qdict_put(bs_opts
, "copy-on-read",
796 qstring_from_str(copy_on_read
? "on" :"off"));
798 /* Controller type */
799 value
= qemu_opt_get(legacy_opts
, "if");
802 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
805 if (type
== IF_COUNT
) {
806 error_report("unsupported bus type '%s'", value
);
810 type
= block_default_type
;
814 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
815 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
816 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
818 if (cyls
|| heads
|| secs
) {
820 error_report("invalid physical cyls number");
824 error_report("invalid physical heads number");
828 error_report("invalid physical secs number");
833 translation
= BIOS_ATA_TRANSLATION_AUTO
;
834 value
= qemu_opt_get(legacy_opts
, "trans");
837 error_report("'%s' trans must be used with cyls, heads and secs",
841 if (!strcmp(value
, "none")) {
842 translation
= BIOS_ATA_TRANSLATION_NONE
;
843 } else if (!strcmp(value
, "lba")) {
844 translation
= BIOS_ATA_TRANSLATION_LBA
;
845 } else if (!strcmp(value
, "large")) {
846 translation
= BIOS_ATA_TRANSLATION_LARGE
;
847 } else if (!strcmp(value
, "rechs")) {
848 translation
= BIOS_ATA_TRANSLATION_RECHS
;
849 } else if (!strcmp(value
, "auto")) {
850 translation
= BIOS_ATA_TRANSLATION_AUTO
;
852 error_report("'%s' invalid translation type", value
);
857 if (media
== MEDIA_CDROM
) {
858 if (cyls
|| secs
|| heads
) {
859 error_report("CHS can't be set with media=cdrom");
864 /* Device address specified by bus/unit or index.
865 * If none was specified, try to find the first free one. */
866 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
867 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
868 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
870 max_devs
= if_max_devs
[type
];
873 if (bus_id
!= 0 || unit_id
!= -1) {
874 error_report("index cannot be used with bus and unit");
877 bus_id
= drive_index_to_bus_id(type
, index
);
878 unit_id
= drive_index_to_unit_id(type
, index
);
883 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
885 if (max_devs
&& unit_id
>= max_devs
) {
892 if (max_devs
&& unit_id
>= max_devs
) {
893 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
897 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
898 error_report("drive with bus=%d, unit=%d (index=%d) exists",
899 bus_id
, unit_id
, index
);
904 serial
= qemu_opt_get(legacy_opts
, "serial");
906 /* no id supplied -> create one */
907 if (qemu_opts_id(all_opts
) == NULL
) {
909 const char *mediastr
= "";
910 if (type
== IF_IDE
|| type
== IF_SCSI
) {
911 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
914 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
917 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
920 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
924 /* Add virtio block device */
925 devaddr
= qemu_opt_get(legacy_opts
, "addr");
926 if (devaddr
&& type
!= IF_VIRTIO
) {
927 error_report("addr is not supported by this bus type");
931 if (type
== IF_VIRTIO
) {
933 devopts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0,
935 if (arch_type
== QEMU_ARCH_S390X
) {
936 qemu_opt_set(devopts
, "driver", "virtio-blk-s390", &error_abort
);
938 qemu_opt_set(devopts
, "driver", "virtio-blk-pci", &error_abort
);
940 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"),
943 qemu_opt_set(devopts
, "addr", devaddr
, &error_abort
);
947 filename
= qemu_opt_get(legacy_opts
, "file");
949 /* Check werror/rerror compatibility with if=... */
950 werror
= qemu_opt_get(legacy_opts
, "werror");
951 if (werror
!= NULL
) {
952 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&&
954 error_report("werror is not supported by this bus type");
957 qdict_put(bs_opts
, "werror", qstring_from_str(werror
));
960 rerror
= qemu_opt_get(legacy_opts
, "rerror");
961 if (rerror
!= NULL
) {
962 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&&
964 error_report("rerror is not supported by this bus type");
967 qdict_put(bs_opts
, "rerror", qstring_from_str(rerror
));
970 /* Actual block device init: Functionality shared with blockdev-add */
971 blk
= blockdev_init(filename
, bs_opts
, &local_err
);
975 error_report_err(local_err
);
982 /* Create legacy DriveInfo */
983 dinfo
= g_malloc0(sizeof(*dinfo
));
984 dinfo
->opts
= all_opts
;
987 dinfo
->heads
= heads
;
989 dinfo
->trans
= translation
;
993 dinfo
->unit
= unit_id
;
994 dinfo
->devaddr
= devaddr
;
995 dinfo
->serial
= g_strdup(serial
);
997 blk_set_legacy_dinfo(blk
, dinfo
);
1004 dinfo
->media_cd
= media
== MEDIA_CDROM
;
1011 qemu_opts_del(legacy_opts
);
1016 void hmp_commit(Monitor
*mon
, const QDict
*qdict
)
1018 const char *device
= qdict_get_str(qdict
, "device");
1022 if (!strcmp(device
, "all")) {
1023 ret
= bdrv_commit_all();
1025 blk
= blk_by_name(device
);
1027 monitor_printf(mon
, "Device '%s' not found\n", device
);
1030 ret
= bdrv_commit(blk_bs(blk
));
1033 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
1038 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
1040 TransactionAction action
;
1041 TransactionActionList list
;
1045 list
.value
= &action
;
1047 qmp_transaction(&list
, errp
);
1050 void qmp_blockdev_snapshot_sync(bool has_device
, const char *device
,
1051 bool has_node_name
, const char *node_name
,
1052 const char *snapshot_file
,
1053 bool has_snapshot_node_name
,
1054 const char *snapshot_node_name
,
1055 bool has_format
, const char *format
,
1056 bool has_mode
, NewImageMode mode
, Error
**errp
)
1058 BlockdevSnapshot snapshot
= {
1059 .has_device
= has_device
,
1060 .device
= (char *) device
,
1061 .has_node_name
= has_node_name
,
1062 .node_name
= (char *) node_name
,
1063 .snapshot_file
= (char *) snapshot_file
,
1064 .has_snapshot_node_name
= has_snapshot_node_name
,
1065 .snapshot_node_name
= (char *) snapshot_node_name
,
1066 .has_format
= has_format
,
1067 .format
= (char *) format
,
1068 .has_mode
= has_mode
,
1071 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
1075 void qmp_blockdev_snapshot_internal_sync(const char *device
,
1079 BlockdevSnapshotInternal snapshot
= {
1080 .device
= (char *) device
,
1081 .name
= (char *) name
1084 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
1088 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
1095 BlockDriverState
*bs
;
1097 AioContext
*aio_context
;
1098 QEMUSnapshotInfo sn
;
1099 Error
*local_err
= NULL
;
1100 SnapshotInfo
*info
= NULL
;
1103 blk
= blk_by_name(device
);
1105 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1119 error_setg(errp
, "Name or id must be provided");
1123 aio_context
= bdrv_get_aio_context(bs
);
1124 aio_context_acquire(aio_context
);
1126 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE
, errp
)) {
1127 goto out_aio_context
;
1130 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
1132 error_propagate(errp
, local_err
);
1133 goto out_aio_context
;
1137 "Snapshot with id '%s' and name '%s' does not exist on "
1139 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
1140 goto out_aio_context
;
1143 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
1145 error_propagate(errp
, local_err
);
1146 goto out_aio_context
;
1149 aio_context_release(aio_context
);
1151 info
= g_new0(SnapshotInfo
, 1);
1152 info
->id
= g_strdup(sn
.id_str
);
1153 info
->name
= g_strdup(sn
.name
);
1154 info
->date_nsec
= sn
.date_nsec
;
1155 info
->date_sec
= sn
.date_sec
;
1156 info
->vm_state_size
= sn
.vm_state_size
;
1157 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
1158 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1163 aio_context_release(aio_context
);
1168 * block_dirty_bitmap_lookup:
1169 * Return a dirty bitmap (if present), after validating
1170 * the node reference and bitmap names.
1172 * @node: The name of the BDS node to search for bitmaps
1173 * @name: The name of the bitmap to search for
1174 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1175 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1176 * @errp: Output pointer for error information. Can be NULL.
1178 * @return: A bitmap object on success, or NULL on failure.
1180 static BdrvDirtyBitmap
*block_dirty_bitmap_lookup(const char *node
,
1182 BlockDriverState
**pbs
,
1186 BlockDriverState
*bs
;
1187 BdrvDirtyBitmap
*bitmap
;
1188 AioContext
*aio_context
;
1191 error_setg(errp
, "Node cannot be NULL");
1195 error_setg(errp
, "Bitmap name cannot be NULL");
1198 bs
= bdrv_lookup_bs(node
, node
, NULL
);
1200 error_setg(errp
, "Node '%s' not found", node
);
1204 aio_context
= bdrv_get_aio_context(bs
);
1205 aio_context_acquire(aio_context
);
1207 bitmap
= bdrv_find_dirty_bitmap(bs
, name
);
1209 error_setg(errp
, "Dirty bitmap '%s' not found", name
);
1217 *paio
= aio_context
;
1219 aio_context_release(aio_context
);
1225 aio_context_release(aio_context
);
1229 /* New and old BlockDriverState structs for atomic group operations */
1231 typedef struct BlkTransactionState BlkTransactionState
;
1233 /* Only prepare() may fail. In a single transaction, only one of commit() or
1234 abort() will be called, clean() will always be called if it present. */
1235 typedef struct BdrvActionOps
{
1236 /* Size of state struct, in bytes. */
1237 size_t instance_size
;
1238 /* Prepare the work, must NOT be NULL. */
1239 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
1240 /* Commit the changes, can be NULL. */
1241 void (*commit
)(BlkTransactionState
*common
);
1242 /* Abort the changes on fail, can be NULL. */
1243 void (*abort
)(BlkTransactionState
*common
);
1244 /* Clean up resource in the end, can be NULL. */
1245 void (*clean
)(BlkTransactionState
*common
);
1249 * This structure must be arranged as first member in child type, assuming
1250 * that compiler will also arrange it to the same address with parent instance.
1251 * Later it will be used in free().
1253 struct BlkTransactionState
{
1254 TransactionAction
*action
;
1255 const BdrvActionOps
*ops
;
1256 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
1259 /* internal snapshot private data */
1260 typedef struct InternalSnapshotState
{
1261 BlkTransactionState common
;
1262 BlockDriverState
*bs
;
1263 AioContext
*aio_context
;
1264 QEMUSnapshotInfo sn
;
1265 } InternalSnapshotState
;
1267 static void internal_snapshot_prepare(BlkTransactionState
*common
,
1270 Error
*local_err
= NULL
;
1274 BlockDriverState
*bs
;
1275 QEMUSnapshotInfo old_sn
, *sn
;
1278 BlockdevSnapshotInternal
*internal
;
1279 InternalSnapshotState
*state
;
1282 g_assert(common
->action
->kind
==
1283 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1284 internal
= common
->action
->blockdev_snapshot_internal_sync
;
1285 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1287 /* 1. parse input */
1288 device
= internal
->device
;
1289 name
= internal
->name
;
1291 /* 2. check for validation */
1292 blk
= blk_by_name(device
);
1294 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1299 /* AioContext is released in .clean() */
1300 state
->aio_context
= bdrv_get_aio_context(bs
);
1301 aio_context_acquire(state
->aio_context
);
1303 if (!bdrv_is_inserted(bs
)) {
1304 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1308 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT
, errp
)) {
1312 if (bdrv_is_read_only(bs
)) {
1313 error_setg(errp
, "Device '%s' is read only", device
);
1317 if (!bdrv_can_snapshot(bs
)) {
1318 error_setg(errp
, "Block format '%s' used by device '%s' "
1319 "does not support internal snapshots",
1320 bs
->drv
->format_name
, device
);
1324 if (!strlen(name
)) {
1325 error_setg(errp
, "Name is empty");
1329 /* check whether a snapshot with name exist */
1330 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
,
1333 error_propagate(errp
, local_err
);
1337 "Snapshot with name '%s' already exists on device '%s'",
1342 /* 3. take the snapshot */
1344 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1345 qemu_gettimeofday(&tv
);
1346 sn
->date_sec
= tv
.tv_sec
;
1347 sn
->date_nsec
= tv
.tv_usec
* 1000;
1348 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1350 ret1
= bdrv_snapshot_create(bs
, sn
);
1352 error_setg_errno(errp
, -ret1
,
1353 "Failed to create snapshot '%s' on device '%s'",
1358 /* 4. succeed, mark a snapshot is created */
1362 static void internal_snapshot_abort(BlkTransactionState
*common
)
1364 InternalSnapshotState
*state
=
1365 DO_UPCAST(InternalSnapshotState
, common
, common
);
1366 BlockDriverState
*bs
= state
->bs
;
1367 QEMUSnapshotInfo
*sn
= &state
->sn
;
1368 Error
*local_error
= NULL
;
1374 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1375 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1376 "device '%s' in abort: %s",
1379 bdrv_get_device_name(bs
),
1380 error_get_pretty(local_error
));
1381 error_free(local_error
);
1385 static void internal_snapshot_clean(BlkTransactionState
*common
)
1387 InternalSnapshotState
*state
= DO_UPCAST(InternalSnapshotState
,
1390 if (state
->aio_context
) {
1391 aio_context_release(state
->aio_context
);
1395 /* external snapshot private data */
1396 typedef struct ExternalSnapshotState
{
1397 BlkTransactionState common
;
1398 BlockDriverState
*old_bs
;
1399 BlockDriverState
*new_bs
;
1400 AioContext
*aio_context
;
1401 } ExternalSnapshotState
;
1403 static void external_snapshot_prepare(BlkTransactionState
*common
,
1408 QDict
*options
= NULL
;
1409 Error
*local_err
= NULL
;
1410 bool has_device
= false;
1412 bool has_node_name
= false;
1413 const char *node_name
;
1414 bool has_snapshot_node_name
= false;
1415 const char *snapshot_node_name
;
1416 const char *new_image_file
;
1417 const char *format
= "qcow2";
1418 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1419 ExternalSnapshotState
*state
=
1420 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1421 TransactionAction
*action
= common
->action
;
1423 /* get parameters */
1424 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1426 has_device
= action
->blockdev_snapshot_sync
->has_device
;
1427 device
= action
->blockdev_snapshot_sync
->device
;
1428 has_node_name
= action
->blockdev_snapshot_sync
->has_node_name
;
1429 node_name
= action
->blockdev_snapshot_sync
->node_name
;
1430 has_snapshot_node_name
=
1431 action
->blockdev_snapshot_sync
->has_snapshot_node_name
;
1432 snapshot_node_name
= action
->blockdev_snapshot_sync
->snapshot_node_name
;
1434 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1435 if (action
->blockdev_snapshot_sync
->has_format
) {
1436 format
= action
->blockdev_snapshot_sync
->format
;
1438 if (action
->blockdev_snapshot_sync
->has_mode
) {
1439 mode
= action
->blockdev_snapshot_sync
->mode
;
1442 /* start processing */
1443 drv
= bdrv_find_format(format
);
1445 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1449 state
->old_bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
1450 has_node_name
? node_name
: NULL
,
1453 error_propagate(errp
, local_err
);
1457 if (has_node_name
&& !has_snapshot_node_name
) {
1458 error_setg(errp
, "New snapshot node name missing");
1462 if (has_snapshot_node_name
&& bdrv_find_node(snapshot_node_name
)) {
1463 error_setg(errp
, "New snapshot node name already existing");
1467 /* Acquire AioContext now so any threads operating on old_bs stop */
1468 state
->aio_context
= bdrv_get_aio_context(state
->old_bs
);
1469 aio_context_acquire(state
->aio_context
);
1471 if (!bdrv_is_inserted(state
->old_bs
)) {
1472 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1476 if (bdrv_op_is_blocked(state
->old_bs
,
1477 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT
, errp
)) {
1481 if (!bdrv_is_read_only(state
->old_bs
)) {
1482 if (bdrv_flush(state
->old_bs
)) {
1483 error_set(errp
, QERR_IO_ERROR
);
1488 if (!bdrv_is_first_non_filter(state
->old_bs
)) {
1489 error_set(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1493 flags
= state
->old_bs
->open_flags
;
1495 /* create new image w/backing file */
1496 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1497 bdrv_img_create(new_image_file
, format
,
1498 state
->old_bs
->filename
,
1499 state
->old_bs
->drv
->format_name
,
1500 NULL
, -1, flags
, &local_err
, false);
1502 error_propagate(errp
, local_err
);
1507 if (has_snapshot_node_name
) {
1508 options
= qdict_new();
1509 qdict_put(options
, "node-name",
1510 qstring_from_str(snapshot_node_name
));
1513 /* TODO Inherit bs->options or only take explicit options with an
1514 * extended QMP command? */
1515 assert(state
->new_bs
== NULL
);
1516 ret
= bdrv_open(&state
->new_bs
, new_image_file
, NULL
, options
,
1517 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
1518 /* We will manually add the backing_hd field to the bs later */
1520 error_propagate(errp
, local_err
);
1524 static void external_snapshot_commit(BlkTransactionState
*common
)
1526 ExternalSnapshotState
*state
=
1527 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1529 bdrv_set_aio_context(state
->new_bs
, state
->aio_context
);
1531 /* This removes our old bs and adds the new bs */
1532 bdrv_append(state
->new_bs
, state
->old_bs
);
1533 /* We don't need (or want) to use the transactional
1534 * bdrv_reopen_multiple() across all the entries at once, because we
1535 * don't want to abort all of them if one of them fails the reopen */
1536 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
1539 aio_context_release(state
->aio_context
);
1542 static void external_snapshot_abort(BlkTransactionState
*common
)
1544 ExternalSnapshotState
*state
=
1545 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1546 if (state
->new_bs
) {
1547 bdrv_unref(state
->new_bs
);
1549 if (state
->aio_context
) {
1550 aio_context_release(state
->aio_context
);
1554 typedef struct DriveBackupState
{
1555 BlkTransactionState common
;
1556 BlockDriverState
*bs
;
1557 AioContext
*aio_context
;
1561 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1563 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1564 BlockDriverState
*bs
;
1566 DriveBackup
*backup
;
1567 Error
*local_err
= NULL
;
1569 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1570 backup
= common
->action
->drive_backup
;
1572 blk
= blk_by_name(backup
->device
);
1574 error_set(errp
, QERR_DEVICE_NOT_FOUND
, backup
->device
);
1579 /* AioContext is released in .clean() */
1580 state
->aio_context
= bdrv_get_aio_context(bs
);
1581 aio_context_acquire(state
->aio_context
);
1583 qmp_drive_backup(backup
->device
, backup
->target
,
1584 backup
->has_format
, backup
->format
,
1586 backup
->has_mode
, backup
->mode
,
1587 backup
->has_speed
, backup
->speed
,
1588 backup
->has_bitmap
, backup
->bitmap
,
1589 backup
->has_on_source_error
, backup
->on_source_error
,
1590 backup
->has_on_target_error
, backup
->on_target_error
,
1593 error_propagate(errp
, local_err
);
1598 state
->job
= state
->bs
->job
;
1601 static void drive_backup_abort(BlkTransactionState
*common
)
1603 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1604 BlockDriverState
*bs
= state
->bs
;
1606 /* Only cancel if it's the job we started */
1607 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1608 block_job_cancel_sync(bs
->job
);
1612 static void drive_backup_clean(BlkTransactionState
*common
)
1614 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1616 if (state
->aio_context
) {
1617 aio_context_release(state
->aio_context
);
1621 typedef struct BlockdevBackupState
{
1622 BlkTransactionState common
;
1623 BlockDriverState
*bs
;
1625 AioContext
*aio_context
;
1626 } BlockdevBackupState
;
1628 static void blockdev_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1630 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1631 BlockdevBackup
*backup
;
1632 BlockDriverState
*bs
, *target
;
1634 Error
*local_err
= NULL
;
1636 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
);
1637 backup
= common
->action
->blockdev_backup
;
1639 blk
= blk_by_name(backup
->device
);
1641 error_setg(errp
, "Device '%s' not found", backup
->device
);
1646 blk
= blk_by_name(backup
->target
);
1648 error_setg(errp
, "Device '%s' not found", backup
->target
);
1651 target
= blk_bs(blk
);
1653 /* AioContext is released in .clean() */
1654 state
->aio_context
= bdrv_get_aio_context(bs
);
1655 if (state
->aio_context
!= bdrv_get_aio_context(target
)) {
1656 state
->aio_context
= NULL
;
1657 error_setg(errp
, "Backup between two IO threads is not implemented");
1660 aio_context_acquire(state
->aio_context
);
1662 qmp_blockdev_backup(backup
->device
, backup
->target
,
1664 backup
->has_speed
, backup
->speed
,
1665 backup
->has_on_source_error
, backup
->on_source_error
,
1666 backup
->has_on_target_error
, backup
->on_target_error
,
1669 error_propagate(errp
, local_err
);
1674 state
->job
= state
->bs
->job
;
1677 static void blockdev_backup_abort(BlkTransactionState
*common
)
1679 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1680 BlockDriverState
*bs
= state
->bs
;
1682 /* Only cancel if it's the job we started */
1683 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1684 block_job_cancel_sync(bs
->job
);
1688 static void blockdev_backup_clean(BlkTransactionState
*common
)
1690 BlockdevBackupState
*state
= DO_UPCAST(BlockdevBackupState
, common
, common
);
1692 if (state
->aio_context
) {
1693 aio_context_release(state
->aio_context
);
1697 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1699 error_setg(errp
, "Transaction aborted using Abort action");
1702 static void abort_commit(BlkTransactionState
*common
)
1704 g_assert_not_reached(); /* this action never succeeds */
1707 static const BdrvActionOps actions
[] = {
1708 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1709 .instance_size
= sizeof(ExternalSnapshotState
),
1710 .prepare
= external_snapshot_prepare
,
1711 .commit
= external_snapshot_commit
,
1712 .abort
= external_snapshot_abort
,
1714 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1715 .instance_size
= sizeof(DriveBackupState
),
1716 .prepare
= drive_backup_prepare
,
1717 .abort
= drive_backup_abort
,
1718 .clean
= drive_backup_clean
,
1720 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP
] = {
1721 .instance_size
= sizeof(BlockdevBackupState
),
1722 .prepare
= blockdev_backup_prepare
,
1723 .abort
= blockdev_backup_abort
,
1724 .clean
= blockdev_backup_clean
,
1726 [TRANSACTION_ACTION_KIND_ABORT
] = {
1727 .instance_size
= sizeof(BlkTransactionState
),
1728 .prepare
= abort_prepare
,
1729 .commit
= abort_commit
,
1731 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1732 .instance_size
= sizeof(InternalSnapshotState
),
1733 .prepare
= internal_snapshot_prepare
,
1734 .abort
= internal_snapshot_abort
,
1735 .clean
= internal_snapshot_clean
,
1740 * 'Atomic' group operations. The operations are performed as a set, and if
1741 * any fail then we roll back all operations in the group.
1743 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1745 TransactionActionList
*dev_entry
= dev_list
;
1746 BlkTransactionState
*state
, *next
;
1747 Error
*local_err
= NULL
;
1749 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1750 QSIMPLEQ_INIT(&snap_bdrv_states
);
1752 /* drain all i/o before any operations */
1755 /* We don't do anything in this loop that commits us to the operations */
1756 while (NULL
!= dev_entry
) {
1757 TransactionAction
*dev_info
= NULL
;
1758 const BdrvActionOps
*ops
;
1760 dev_info
= dev_entry
->value
;
1761 dev_entry
= dev_entry
->next
;
1763 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1765 ops
= &actions
[dev_info
->kind
];
1766 assert(ops
->instance_size
> 0);
1768 state
= g_malloc0(ops
->instance_size
);
1770 state
->action
= dev_info
;
1771 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1773 state
->ops
->prepare(state
, &local_err
);
1775 error_propagate(errp
, local_err
);
1776 goto delete_and_fail
;
1780 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1781 if (state
->ops
->commit
) {
1782 state
->ops
->commit(state
);
1790 /* failure, and it is all-or-none; roll back all operations */
1791 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1792 if (state
->ops
->abort
) {
1793 state
->ops
->abort(state
);
1797 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1798 if (state
->ops
->clean
) {
1799 state
->ops
->clean(state
);
1806 static void eject_device(BlockBackend
*blk
, int force
, Error
**errp
)
1808 BlockDriverState
*bs
= blk_bs(blk
);
1809 AioContext
*aio_context
;
1811 aio_context
= bdrv_get_aio_context(bs
);
1812 aio_context_acquire(aio_context
);
1814 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_EJECT
, errp
)) {
1817 if (!blk_dev_has_removable_media(blk
)) {
1818 error_setg(errp
, "Device '%s' is not removable",
1819 bdrv_get_device_name(bs
));
1823 if (blk_dev_is_medium_locked(blk
) && !blk_dev_is_tray_open(blk
)) {
1824 blk_dev_eject_request(blk
, force
);
1826 error_setg(errp
, "Device '%s' is locked",
1827 bdrv_get_device_name(bs
));
1835 aio_context_release(aio_context
);
1838 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1842 blk
= blk_by_name(device
);
1844 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1848 eject_device(blk
, force
, errp
);
1851 void qmp_block_passwd(bool has_device
, const char *device
,
1852 bool has_node_name
, const char *node_name
,
1853 const char *password
, Error
**errp
)
1855 Error
*local_err
= NULL
;
1856 BlockDriverState
*bs
;
1857 AioContext
*aio_context
;
1859 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
1860 has_node_name
? node_name
: NULL
,
1863 error_propagate(errp
, local_err
);
1867 aio_context
= bdrv_get_aio_context(bs
);
1868 aio_context_acquire(aio_context
);
1870 bdrv_add_key(bs
, password
, errp
);
1872 aio_context_release(aio_context
);
1875 /* Assumes AioContext is held */
1876 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1877 int bdrv_flags
, BlockDriver
*drv
,
1878 const char *password
, Error
**errp
)
1880 Error
*local_err
= NULL
;
1883 ret
= bdrv_open(&bs
, filename
, NULL
, NULL
, bdrv_flags
, drv
, &local_err
);
1885 error_propagate(errp
, local_err
);
1889 bdrv_add_key(bs
, password
, errp
);
1892 void qmp_change_blockdev(const char *device
, const char *filename
,
1893 const char *format
, Error
**errp
)
1896 BlockDriverState
*bs
;
1897 AioContext
*aio_context
;
1898 BlockDriver
*drv
= NULL
;
1902 blk
= blk_by_name(device
);
1904 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1909 aio_context
= bdrv_get_aio_context(bs
);
1910 aio_context_acquire(aio_context
);
1913 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1915 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1920 eject_device(blk
, 0, &err
);
1922 error_propagate(errp
, err
);
1926 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1927 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1929 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1932 aio_context_release(aio_context
);
1935 /* throttling disk I/O limits */
1936 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1943 bool has_bps_rd_max
,
1945 bool has_bps_wr_max
,
1949 bool has_iops_rd_max
,
1950 int64_t iops_rd_max
,
1951 bool has_iops_wr_max
,
1952 int64_t iops_wr_max
,
1954 int64_t iops_size
, Error
**errp
)
1957 BlockDriverState
*bs
;
1959 AioContext
*aio_context
;
1961 blk
= blk_by_name(device
);
1963 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1968 memset(&cfg
, 0, sizeof(cfg
));
1969 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
1970 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
1971 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
1973 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
1974 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
1975 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
1978 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
1980 if (has_bps_rd_max
) {
1981 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
1983 if (has_bps_wr_max
) {
1984 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
1987 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
1989 if (has_iops_rd_max
) {
1990 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
1992 if (has_iops_wr_max
) {
1993 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
1996 if (has_iops_size
) {
1997 cfg
.op_size
= iops_size
;
2000 if (!check_throttle_config(&cfg
, errp
)) {
2004 aio_context
= bdrv_get_aio_context(bs
);
2005 aio_context_acquire(aio_context
);
2007 if (!bs
->io_limits_enabled
&& throttle_enabled(&cfg
)) {
2008 bdrv_io_limits_enable(bs
);
2009 } else if (bs
->io_limits_enabled
&& !throttle_enabled(&cfg
)) {
2010 bdrv_io_limits_disable(bs
);
2013 if (bs
->io_limits_enabled
) {
2014 bdrv_set_io_limits(bs
, &cfg
);
2017 aio_context_release(aio_context
);
2020 void qmp_block_dirty_bitmap_add(const char *node
, const char *name
,
2021 bool has_granularity
, uint32_t granularity
,
2024 AioContext
*aio_context
;
2025 BlockDriverState
*bs
;
2027 if (!name
|| name
[0] == '\0') {
2028 error_setg(errp
, "Bitmap name cannot be empty");
2032 bs
= bdrv_lookup_bs(node
, node
, errp
);
2037 aio_context
= bdrv_get_aio_context(bs
);
2038 aio_context_acquire(aio_context
);
2040 if (has_granularity
) {
2041 if (granularity
< 512 || !is_power_of_2(granularity
)) {
2042 error_setg(errp
, "Granularity must be power of 2 "
2043 "and at least 512");
2047 /* Default to cluster size, if available: */
2048 granularity
= bdrv_get_default_bitmap_granularity(bs
);
2051 bdrv_create_dirty_bitmap(bs
, granularity
, name
, errp
);
2054 aio_context_release(aio_context
);
2057 void qmp_block_dirty_bitmap_remove(const char *node
, const char *name
,
2060 AioContext
*aio_context
;
2061 BlockDriverState
*bs
;
2062 BdrvDirtyBitmap
*bitmap
;
2064 bitmap
= block_dirty_bitmap_lookup(node
, name
, &bs
, &aio_context
, errp
);
2065 if (!bitmap
|| !bs
) {
2069 if (bdrv_dirty_bitmap_frozen(bitmap
)) {
2071 "Bitmap '%s' is currently frozen and cannot be removed",
2075 bdrv_dirty_bitmap_make_anon(bs
, bitmap
);
2076 bdrv_release_dirty_bitmap(bs
, bitmap
);
2079 aio_context_release(aio_context
);
2082 int hmp_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
2084 const char *id
= qdict_get_str(qdict
, "id");
2086 BlockDriverState
*bs
;
2087 AioContext
*aio_context
;
2088 Error
*local_err
= NULL
;
2090 blk
= blk_by_name(id
);
2092 error_report("Device '%s' not found", id
);
2097 if (!blk_legacy_dinfo(blk
)) {
2098 error_report("Deleting device added with blockdev-add"
2099 " is not supported");
2103 aio_context
= bdrv_get_aio_context(bs
);
2104 aio_context_acquire(aio_context
);
2106 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_DRIVE_DEL
, &local_err
)) {
2107 error_report_err(local_err
);
2108 aio_context_release(aio_context
);
2112 /* quiesce block driver; prevent further io */
2117 /* if we have a device attached to this BlockDriverState
2118 * then we need to make the drive anonymous until the device
2119 * can be removed. If this is a drive with no device backing
2120 * then we can just get rid of the block driver state right here.
2122 if (blk_get_attached_dev(blk
)) {
2123 blk_hide_on_behalf_of_hmp_drive_del(blk
);
2124 /* Further I/O must not pause the guest */
2125 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
2126 BLOCKDEV_ON_ERROR_REPORT
);
2131 aio_context_release(aio_context
);
2135 void qmp_block_resize(bool has_device
, const char *device
,
2136 bool has_node_name
, const char *node_name
,
2137 int64_t size
, Error
**errp
)
2139 Error
*local_err
= NULL
;
2140 BlockDriverState
*bs
;
2141 AioContext
*aio_context
;
2144 bs
= bdrv_lookup_bs(has_device
? device
: NULL
,
2145 has_node_name
? node_name
: NULL
,
2148 error_propagate(errp
, local_err
);
2152 aio_context
= bdrv_get_aio_context(bs
);
2153 aio_context_acquire(aio_context
);
2155 if (!bdrv_is_first_non_filter(bs
)) {
2156 error_set(errp
, QERR_FEATURE_DISABLED
, "resize");
2161 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
2165 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_RESIZE
, NULL
)) {
2166 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
2170 /* complete all in-flight operations before resizing the device */
2173 ret
= bdrv_truncate(bs
, size
);
2178 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2181 error_set(errp
, QERR_UNSUPPORTED
);
2184 error_setg(errp
, "Device '%s' is read only", device
);
2187 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
2190 error_setg_errno(errp
, -ret
, "Could not resize");
2195 aio_context_release(aio_context
);
2198 static void block_job_cb(void *opaque
, int ret
)
2200 /* Note that this function may be executed from another AioContext besides
2201 * the QEMU main loop. If you need to access anything that assumes the
2202 * QEMU global mutex, use a BH or introduce a mutex.
2205 BlockDriverState
*bs
= opaque
;
2206 const char *msg
= NULL
;
2208 trace_block_job_cb(bs
, bs
->job
, ret
);
2213 msg
= strerror(-ret
);
2216 if (block_job_is_cancelled(bs
->job
)) {
2217 block_job_event_cancelled(bs
->job
);
2219 block_job_event_completed(bs
->job
, msg
);
2222 bdrv_put_ref_bh_schedule(bs
);
2225 void qmp_block_stream(const char *device
,
2226 bool has_base
, const char *base
,
2227 bool has_backing_file
, const char *backing_file
,
2228 bool has_speed
, int64_t speed
,
2229 bool has_on_error
, BlockdevOnError on_error
,
2233 BlockDriverState
*bs
;
2234 BlockDriverState
*base_bs
= NULL
;
2235 AioContext
*aio_context
;
2236 Error
*local_err
= NULL
;
2237 const char *base_name
= NULL
;
2239 if (!has_on_error
) {
2240 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2243 blk
= blk_by_name(device
);
2245 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2250 aio_context
= bdrv_get_aio_context(bs
);
2251 aio_context_acquire(aio_context
);
2253 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_STREAM
, errp
)) {
2258 base_bs
= bdrv_find_backing_image(bs
, base
);
2259 if (base_bs
== NULL
) {
2260 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
2263 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2267 /* if we are streaming the entire chain, the result will have no backing
2268 * file, and specifying one is therefore an error */
2269 if (base_bs
== NULL
&& has_backing_file
) {
2270 error_setg(errp
, "backing file specified, but streaming the "
2275 /* backing_file string overrides base bs filename */
2276 base_name
= has_backing_file
? backing_file
: base_name
;
2278 stream_start(bs
, base_bs
, base_name
, has_speed
? speed
: 0,
2279 on_error
, block_job_cb
, bs
, &local_err
);
2281 error_propagate(errp
, local_err
);
2285 trace_qmp_block_stream(bs
, bs
->job
);
2288 aio_context_release(aio_context
);
2291 void qmp_block_commit(const char *device
,
2292 bool has_base
, const char *base
,
2293 bool has_top
, const char *top
,
2294 bool has_backing_file
, const char *backing_file
,
2295 bool has_speed
, int64_t speed
,
2299 BlockDriverState
*bs
;
2300 BlockDriverState
*base_bs
, *top_bs
;
2301 AioContext
*aio_context
;
2302 Error
*local_err
= NULL
;
2303 /* This will be part of the QMP command, if/when the
2304 * BlockdevOnError change for blkmirror makes it in
2306 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
2313 * libvirt relies on the DeviceNotFound error class in order to probe for
2314 * live commit feature versions; for this to work, we must make sure to
2315 * perform the device lookup before any generic errors that may occur in a
2316 * scenario in which all optional arguments are omitted. */
2317 blk
= blk_by_name(device
);
2319 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2324 aio_context
= bdrv_get_aio_context(bs
);
2325 aio_context_acquire(aio_context
);
2327 /* drain all i/o before commits */
2330 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_COMMIT_SOURCE
, errp
)) {
2334 /* default top_bs is the active layer */
2337 if (has_top
&& top
) {
2338 if (strcmp(bs
->filename
, top
) != 0) {
2339 top_bs
= bdrv_find_backing_image(bs
, top
);
2343 if (top_bs
== NULL
) {
2344 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
2348 assert(bdrv_get_aio_context(top_bs
) == aio_context
);
2350 if (has_base
&& base
) {
2351 base_bs
= bdrv_find_backing_image(top_bs
, base
);
2353 base_bs
= bdrv_find_base(top_bs
);
2356 if (base_bs
== NULL
) {
2357 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
2361 assert(bdrv_get_aio_context(base_bs
) == aio_context
);
2363 if (bdrv_op_is_blocked(base_bs
, BLOCK_OP_TYPE_COMMIT_TARGET
, errp
)) {
2367 /* Do not allow attempts to commit an image into itself */
2368 if (top_bs
== base_bs
) {
2369 error_setg(errp
, "cannot commit an image into itself");
2374 if (has_backing_file
) {
2375 error_setg(errp
, "'backing-file' specified,"
2376 " but 'top' is the active layer");
2379 commit_active_start(bs
, base_bs
, speed
, on_error
, block_job_cb
,
2382 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
2383 has_backing_file
? backing_file
: NULL
, &local_err
);
2385 if (local_err
!= NULL
) {
2386 error_propagate(errp
, local_err
);
2391 aio_context_release(aio_context
);
2394 void qmp_drive_backup(const char *device
, const char *target
,
2395 bool has_format
, const char *format
,
2396 enum MirrorSyncMode sync
,
2397 bool has_mode
, enum NewImageMode mode
,
2398 bool has_speed
, int64_t speed
,
2399 bool has_bitmap
, const char *bitmap
,
2400 bool has_on_source_error
, BlockdevOnError on_source_error
,
2401 bool has_on_target_error
, BlockdevOnError on_target_error
,
2405 BlockDriverState
*bs
;
2406 BlockDriverState
*target_bs
;
2407 BlockDriverState
*source
= NULL
;
2408 BdrvDirtyBitmap
*bmap
= NULL
;
2409 AioContext
*aio_context
;
2410 BlockDriver
*drv
= NULL
;
2411 Error
*local_err
= NULL
;
2419 if (!has_on_source_error
) {
2420 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2422 if (!has_on_target_error
) {
2423 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2426 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
2429 blk
= blk_by_name(device
);
2431 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2436 aio_context
= bdrv_get_aio_context(bs
);
2437 aio_context_acquire(aio_context
);
2439 /* Although backup_run has this check too, we need to use bs->drv below, so
2440 * do an early check redundantly. */
2441 if (!bdrv_is_inserted(bs
)) {
2442 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2447 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
2450 drv
= bdrv_find_format(format
);
2452 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
2457 /* Early check to avoid creating target */
2458 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_BACKUP_SOURCE
, errp
)) {
2462 flags
= bs
->open_flags
| BDRV_O_RDWR
;
2464 /* See if we have a backing HD we can use to create our new image
2466 if (sync
== MIRROR_SYNC_MODE_TOP
) {
2467 source
= bs
->backing_hd
;
2469 sync
= MIRROR_SYNC_MODE_FULL
;
2472 if (sync
== MIRROR_SYNC_MODE_NONE
) {
2476 size
= bdrv_getlength(bs
);
2478 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
2482 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
2483 assert(format
&& drv
);
2485 bdrv_img_create(target
, format
, source
->filename
,
2486 source
->drv
->format_name
, NULL
,
2487 size
, flags
, &local_err
, false);
2489 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
2490 size
, flags
, &local_err
, false);
2495 error_propagate(errp
, local_err
);
2500 ret
= bdrv_open(&target_bs
, target
, NULL
, NULL
, flags
, drv
, &local_err
);
2502 error_propagate(errp
, local_err
);
2506 bdrv_set_aio_context(target_bs
, aio_context
);
2509 bmap
= bdrv_find_dirty_bitmap(bs
, bitmap
);
2511 error_setg(errp
, "Bitmap '%s' could not be found", bitmap
);
2516 backup_start(bs
, target_bs
, speed
, sync
, bmap
,
2517 on_source_error
, on_target_error
,
2518 block_job_cb
, bs
, &local_err
);
2519 if (local_err
!= NULL
) {
2520 bdrv_unref(target_bs
);
2521 error_propagate(errp
, local_err
);
2526 aio_context_release(aio_context
);
2529 BlockDeviceInfoList
*qmp_query_named_block_nodes(Error
**errp
)
2531 return bdrv_named_nodes_list(errp
);
2534 void qmp_blockdev_backup(const char *device
, const char *target
,
2535 enum MirrorSyncMode sync
,
2536 bool has_speed
, int64_t speed
,
2537 bool has_on_source_error
,
2538 BlockdevOnError on_source_error
,
2539 bool has_on_target_error
,
2540 BlockdevOnError on_target_error
,
2544 BlockDriverState
*bs
;
2545 BlockDriverState
*target_bs
;
2546 Error
*local_err
= NULL
;
2547 AioContext
*aio_context
;
2552 if (!has_on_source_error
) {
2553 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2555 if (!has_on_target_error
) {
2556 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2559 blk
= blk_by_name(device
);
2561 error_setg(errp
, "Device '%s' not found", device
);
2566 aio_context
= bdrv_get_aio_context(bs
);
2567 aio_context_acquire(aio_context
);
2569 blk
= blk_by_name(target
);
2571 error_setg(errp
, "Device '%s' not found", target
);
2574 target_bs
= blk_bs(blk
);
2576 bdrv_ref(target_bs
);
2577 bdrv_set_aio_context(target_bs
, aio_context
);
2578 backup_start(bs
, target_bs
, speed
, sync
, NULL
, on_source_error
,
2579 on_target_error
, block_job_cb
, bs
, &local_err
);
2580 if (local_err
!= NULL
) {
2581 bdrv_unref(target_bs
);
2582 error_propagate(errp
, local_err
);
2585 aio_context_release(aio_context
);
2588 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
2590 void qmp_drive_mirror(const char *device
, const char *target
,
2591 bool has_format
, const char *format
,
2592 bool has_node_name
, const char *node_name
,
2593 bool has_replaces
, const char *replaces
,
2594 enum MirrorSyncMode sync
,
2595 bool has_mode
, enum NewImageMode mode
,
2596 bool has_speed
, int64_t speed
,
2597 bool has_granularity
, uint32_t granularity
,
2598 bool has_buf_size
, int64_t buf_size
,
2599 bool has_on_source_error
, BlockdevOnError on_source_error
,
2600 bool has_on_target_error
, BlockdevOnError on_target_error
,
2604 BlockDriverState
*bs
;
2605 BlockDriverState
*source
, *target_bs
;
2606 AioContext
*aio_context
;
2607 BlockDriver
*drv
= NULL
;
2608 Error
*local_err
= NULL
;
2609 QDict
*options
= NULL
;
2617 if (!has_on_source_error
) {
2618 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
2620 if (!has_on_target_error
) {
2621 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
2624 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
2626 if (!has_granularity
) {
2629 if (!has_buf_size
) {
2630 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
2633 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
2634 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity",
2635 "a value in range [512B, 64MB]");
2638 if (granularity
& (granularity
- 1)) {
2639 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "granularity", "power of 2");
2643 blk
= blk_by_name(device
);
2645 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2650 aio_context
= bdrv_get_aio_context(bs
);
2651 aio_context_acquire(aio_context
);
2653 if (!bdrv_is_inserted(bs
)) {
2654 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
2659 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
2662 drv
= bdrv_find_format(format
);
2664 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
2669 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_MIRROR
, errp
)) {
2673 flags
= bs
->open_flags
| BDRV_O_RDWR
;
2674 source
= bs
->backing_hd
;
2675 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
2676 sync
= MIRROR_SYNC_MODE_FULL
;
2678 if (sync
== MIRROR_SYNC_MODE_NONE
) {
2682 size
= bdrv_getlength(bs
);
2684 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
2689 BlockDriverState
*to_replace_bs
;
2690 AioContext
*replace_aio_context
;
2691 int64_t replace_size
;
2693 if (!has_node_name
) {
2694 error_setg(errp
, "a node-name must be provided when replacing a"
2695 " named node of the graph");
2699 to_replace_bs
= check_to_replace_node(replaces
, &local_err
);
2701 if (!to_replace_bs
) {
2702 error_propagate(errp
, local_err
);
2706 replace_aio_context
= bdrv_get_aio_context(to_replace_bs
);
2707 aio_context_acquire(replace_aio_context
);
2708 replace_size
= bdrv_getlength(to_replace_bs
);
2709 aio_context_release(replace_aio_context
);
2711 if (size
!= replace_size
) {
2712 error_setg(errp
, "cannot replace image with a mirror image of "
2718 if ((sync
== MIRROR_SYNC_MODE_FULL
|| !source
)
2719 && mode
!= NEW_IMAGE_MODE_EXISTING
)
2721 /* create new image w/o backing file */
2722 assert(format
&& drv
);
2723 bdrv_img_create(target
, format
,
2724 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
2727 case NEW_IMAGE_MODE_EXISTING
:
2729 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
2730 /* create new image with backing file */
2731 bdrv_img_create(target
, format
,
2733 source
->drv
->format_name
,
2734 NULL
, size
, flags
, &local_err
, false);
2742 error_propagate(errp
, local_err
);
2746 if (has_node_name
) {
2747 options
= qdict_new();
2748 qdict_put(options
, "node-name", qstring_from_str(node_name
));
2751 /* Mirroring takes care of copy-on-write using the source's backing
2755 ret
= bdrv_open(&target_bs
, target
, NULL
, options
,
2756 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
2758 error_propagate(errp
, local_err
);
2762 bdrv_set_aio_context(target_bs
, aio_context
);
2764 /* pass the node name to replace to mirror start since it's loose coupling
2765 * and will allow to check whether the node still exist at mirror completion
2767 mirror_start(bs
, target_bs
,
2768 has_replaces
? replaces
: NULL
,
2769 speed
, granularity
, buf_size
, sync
,
2770 on_source_error
, on_target_error
,
2771 block_job_cb
, bs
, &local_err
);
2772 if (local_err
!= NULL
) {
2773 bdrv_unref(target_bs
);
2774 error_propagate(errp
, local_err
);
2779 aio_context_release(aio_context
);
2782 /* Get the block job for a given device name and acquire its AioContext */
2783 static BlockJob
*find_block_job(const char *device
, AioContext
**aio_context
,
2787 BlockDriverState
*bs
;
2789 blk
= blk_by_name(device
);
2795 *aio_context
= bdrv_get_aio_context(bs
);
2796 aio_context_acquire(*aio_context
);
2799 aio_context_release(*aio_context
);
2806 error_set(errp
, ERROR_CLASS_DEVICE_NOT_ACTIVE
,
2807 "No active block job on device '%s'", device
);
2808 *aio_context
= NULL
;
2812 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
2814 AioContext
*aio_context
;
2815 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2821 block_job_set_speed(job
, speed
, errp
);
2822 aio_context_release(aio_context
);
2825 void qmp_block_job_cancel(const char *device
,
2826 bool has_force
, bool force
, Error
**errp
)
2828 AioContext
*aio_context
;
2829 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2839 if (job
->user_paused
&& !force
) {
2840 error_setg(errp
, "The block job for device '%s' is currently paused",
2845 trace_qmp_block_job_cancel(job
);
2846 block_job_cancel(job
);
2848 aio_context_release(aio_context
);
2851 void qmp_block_job_pause(const char *device
, Error
**errp
)
2853 AioContext
*aio_context
;
2854 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2856 if (!job
|| job
->user_paused
) {
2860 job
->user_paused
= true;
2861 trace_qmp_block_job_pause(job
);
2862 block_job_pause(job
);
2863 aio_context_release(aio_context
);
2866 void qmp_block_job_resume(const char *device
, Error
**errp
)
2868 AioContext
*aio_context
;
2869 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2871 if (!job
|| !job
->user_paused
) {
2875 job
->user_paused
= false;
2876 trace_qmp_block_job_resume(job
);
2877 block_job_resume(job
);
2878 aio_context_release(aio_context
);
2881 void qmp_block_job_complete(const char *device
, Error
**errp
)
2883 AioContext
*aio_context
;
2884 BlockJob
*job
= find_block_job(device
, &aio_context
, errp
);
2890 trace_qmp_block_job_complete(job
);
2891 block_job_complete(job
, errp
);
2892 aio_context_release(aio_context
);
2895 void qmp_change_backing_file(const char *device
,
2896 const char *image_node_name
,
2897 const char *backing_file
,
2901 BlockDriverState
*bs
= NULL
;
2902 AioContext
*aio_context
;
2903 BlockDriverState
*image_bs
= NULL
;
2904 Error
*local_err
= NULL
;
2909 blk
= blk_by_name(device
);
2911 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
2916 aio_context
= bdrv_get_aio_context(bs
);
2917 aio_context_acquire(aio_context
);
2919 image_bs
= bdrv_lookup_bs(NULL
, image_node_name
, &local_err
);
2921 error_propagate(errp
, local_err
);
2926 error_setg(errp
, "image file not found");
2930 if (bdrv_find_base(image_bs
) == image_bs
) {
2931 error_setg(errp
, "not allowing backing file change on an image "
2932 "without a backing file");
2936 /* even though we are not necessarily operating on bs, we need it to
2937 * determine if block ops are currently prohibited on the chain */
2938 if (bdrv_op_is_blocked(bs
, BLOCK_OP_TYPE_CHANGE
, errp
)) {
2942 /* final sanity check */
2943 if (!bdrv_chain_contains(bs
, image_bs
)) {
2944 error_setg(errp
, "'%s' and image file are not in the same chain",
2949 /* if not r/w, reopen to make r/w */
2950 open_flags
= image_bs
->open_flags
;
2951 ro
= bdrv_is_read_only(image_bs
);
2954 bdrv_reopen(image_bs
, open_flags
| BDRV_O_RDWR
, &local_err
);
2956 error_propagate(errp
, local_err
);
2961 ret
= bdrv_change_backing_file(image_bs
, backing_file
,
2962 image_bs
->drv
? image_bs
->drv
->format_name
: "");
2965 error_setg_errno(errp
, -ret
, "Could not change backing file to '%s'",
2967 /* don't exit here, so we can try to restore open flags if
2972 bdrv_reopen(image_bs
, open_flags
, &local_err
);
2974 error_propagate(errp
, local_err
); /* will preserve prior errp */
2979 aio_context_release(aio_context
);
2982 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
2984 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2988 Error
*local_err
= NULL
;
2990 /* Require an ID in the top level */
2991 if (!options
->has_id
) {
2992 error_setg(errp
, "Block device needs an ID");
2996 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
2997 * cache.direct=false instead of silently switching to aio=threads, except
2998 * when called from drive_new().
3000 * For now, simply forbidding the combination for all drivers will do. */
3001 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
3002 bool direct
= options
->has_cache
&&
3003 options
->cache
->has_direct
&&
3004 options
->cache
->direct
;
3006 error_setg(errp
, "aio=native requires cache.direct=true");
3011 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
),
3012 &options
, NULL
, &local_err
);
3014 error_propagate(errp
, local_err
);
3018 obj
= qmp_output_get_qobject(ov
);
3019 qdict
= qobject_to_qdict(obj
);
3021 qdict_flatten(qdict
);
3023 blk
= blockdev_init(NULL
, qdict
, &local_err
);
3025 error_propagate(errp
, local_err
);
3029 if (bdrv_key_required(blk_bs(blk
))) {
3031 error_setg(errp
, "blockdev-add doesn't support encrypted devices");
3036 qmp_output_visitor_cleanup(ov
);
3039 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
3041 BlockJobInfoList
*head
= NULL
, **p_next
= &head
;
3042 BlockDriverState
*bs
;
3044 for (bs
= bdrv_next(NULL
); bs
; bs
= bdrv_next(bs
)) {
3045 AioContext
*aio_context
= bdrv_get_aio_context(bs
);
3047 aio_context_acquire(aio_context
);
3050 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
3051 elem
->value
= block_job_query(bs
->job
);
3053 p_next
= &elem
->next
;
3056 aio_context_release(aio_context
);
3062 QemuOptsList qemu_common_drive_opts
= {
3064 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
3068 .type
= QEMU_OPT_BOOL
,
3069 .help
= "enable/disable snapshot mode",
3072 .type
= QEMU_OPT_STRING
,
3073 .help
= "discard operation (ignore/off, unmap/on)",
3075 .name
= "cache.writeback",
3076 .type
= QEMU_OPT_BOOL
,
3077 .help
= "enables writeback mode for any caches",
3079 .name
= "cache.direct",
3080 .type
= QEMU_OPT_BOOL
,
3081 .help
= "enables use of O_DIRECT (bypass the host page cache)",
3083 .name
= "cache.no-flush",
3084 .type
= QEMU_OPT_BOOL
,
3085 .help
= "ignore any flush requests for the device",
3088 .type
= QEMU_OPT_STRING
,
3089 .help
= "host AIO implementation (threads, native)",
3092 .type
= QEMU_OPT_STRING
,
3093 .help
= "disk format (raw, qcow2, ...)",
3096 .type
= QEMU_OPT_STRING
,
3097 .help
= "read error action",
3100 .type
= QEMU_OPT_STRING
,
3101 .help
= "write error action",
3103 .name
= "read-only",
3104 .type
= QEMU_OPT_BOOL
,
3105 .help
= "open drive file as read-only",
3107 .name
= "throttling.iops-total",
3108 .type
= QEMU_OPT_NUMBER
,
3109 .help
= "limit total I/O operations per second",
3111 .name
= "throttling.iops-read",
3112 .type
= QEMU_OPT_NUMBER
,
3113 .help
= "limit read operations per second",
3115 .name
= "throttling.iops-write",
3116 .type
= QEMU_OPT_NUMBER
,
3117 .help
= "limit write operations per second",
3119 .name
= "throttling.bps-total",
3120 .type
= QEMU_OPT_NUMBER
,
3121 .help
= "limit total bytes per second",
3123 .name
= "throttling.bps-read",
3124 .type
= QEMU_OPT_NUMBER
,
3125 .help
= "limit read bytes per second",
3127 .name
= "throttling.bps-write",
3128 .type
= QEMU_OPT_NUMBER
,
3129 .help
= "limit write bytes per second",
3131 .name
= "throttling.iops-total-max",
3132 .type
= QEMU_OPT_NUMBER
,
3133 .help
= "I/O operations burst",
3135 .name
= "throttling.iops-read-max",
3136 .type
= QEMU_OPT_NUMBER
,
3137 .help
= "I/O operations read burst",
3139 .name
= "throttling.iops-write-max",
3140 .type
= QEMU_OPT_NUMBER
,
3141 .help
= "I/O operations write burst",
3143 .name
= "throttling.bps-total-max",
3144 .type
= QEMU_OPT_NUMBER
,
3145 .help
= "total bytes burst",
3147 .name
= "throttling.bps-read-max",
3148 .type
= QEMU_OPT_NUMBER
,
3149 .help
= "total bytes read burst",
3151 .name
= "throttling.bps-write-max",
3152 .type
= QEMU_OPT_NUMBER
,
3153 .help
= "total bytes write burst",
3155 .name
= "throttling.iops-size",
3156 .type
= QEMU_OPT_NUMBER
,
3157 .help
= "when limiting by iops max size of an I/O in bytes",
3159 .name
= "copy-on-read",
3160 .type
= QEMU_OPT_BOOL
,
3161 .help
= "copy read data from backing file into image file",
3163 .name
= "detect-zeroes",
3164 .type
= QEMU_OPT_STRING
,
3165 .help
= "try to optimize zero writes (off, on, unmap)",
3167 { /* end of list */ }
3171 QemuOptsList qemu_drive_opts
= {
3173 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
3176 * no elements => accept any params
3177 * validation will happen later
3179 { /* end of list */ }