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/blockdev.h"
34 #include "hw/block/block.h"
35 #include "block/blockjob.h"
36 #include "monitor/monitor.h"
37 #include "qapi/qmp/qerror.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 "sysemu/sysemu.h"
44 #include "block/block_int.h"
45 #include "qmp-commands.h"
47 #include "sysemu/arch_init.h"
49 static QTAILQ_HEAD(drivelist
, DriveInfo
) drives
= QTAILQ_HEAD_INITIALIZER(drives
);
50 extern QemuOptsList qemu_common_drive_opts
;
52 static const char *const if_name
[IF_COUNT
] = {
56 [IF_FLOPPY
] = "floppy",
57 [IF_PFLASH
] = "pflash",
60 [IF_VIRTIO
] = "virtio",
64 static const int if_max_devs
[IF_COUNT
] = {
66 * Do not change these numbers! They govern how drive option
67 * index maps to unit and bus. That mapping is ABI.
69 * All controllers used to imlement if=T drives need to support
70 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
71 * Otherwise, some index values map to "impossible" bus, unit
74 * For instance, if you change [IF_SCSI] to 255, -drive
75 * if=scsi,index=12 no longer means bus=1,unit=5, but
76 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
77 * the drive can't be set up. Regression.
84 * We automatically delete the drive when a device using it gets
85 * unplugged. Questionable feature, but we can't just drop it.
86 * Device models call blockdev_mark_auto_del() to schedule the
87 * automatic deletion, and generic qdev code calls blockdev_auto_del()
88 * when deletion is actually safe.
90 void blockdev_mark_auto_del(BlockDriverState
*bs
)
92 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
94 if (dinfo
&& !dinfo
->enable_auto_del
) {
99 block_job_cancel(bs
->job
);
106 void blockdev_auto_del(BlockDriverState
*bs
)
108 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
110 if (dinfo
&& dinfo
->auto_del
) {
111 drive_put_ref(dinfo
);
115 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
117 int max_devs
= if_max_devs
[type
];
118 return max_devs
? index
/ max_devs
: 0;
121 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
123 int max_devs
= if_max_devs
[type
];
124 return max_devs
? index
% max_devs
: index
;
127 QemuOpts
*drive_def(const char *optstr
)
129 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
132 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
138 opts
= drive_def(optstr
);
142 if (type
!= IF_DEFAULT
) {
143 qemu_opt_set(opts
, "if", if_name
[type
]);
146 snprintf(buf
, sizeof(buf
), "%d", index
);
147 qemu_opt_set(opts
, "index", buf
);
150 qemu_opt_set(opts
, "file", file
);
154 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
158 /* seek interface, bus and unit */
160 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
161 if (dinfo
->type
== type
&&
170 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
172 return drive_get(type
,
173 drive_index_to_bus_id(type
, index
),
174 drive_index_to_unit_id(type
, index
));
177 int drive_get_max_bus(BlockInterfaceType type
)
183 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
184 if(dinfo
->type
== type
&&
185 dinfo
->bus
> max_bus
)
186 max_bus
= dinfo
->bus
;
191 /* Get a block device. This should only be used for single-drive devices
192 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
194 DriveInfo
*drive_get_next(BlockInterfaceType type
)
196 static int next_block_unit
[IF_COUNT
];
198 return drive_get(type
, 0, next_block_unit
[type
]++);
201 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
205 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
206 if (dinfo
->bdrv
== bs
) {
213 static void bdrv_format_print(void *opaque
, const char *name
)
215 error_printf(" %s", name
);
218 static void drive_uninit(DriveInfo
*dinfo
)
221 qemu_opts_del(dinfo
->opts
);
224 bdrv_unref(dinfo
->bdrv
);
226 QTAILQ_REMOVE(&drives
, dinfo
, next
);
227 g_free(dinfo
->serial
);
231 void drive_put_ref(DriveInfo
*dinfo
)
233 assert(dinfo
->refcount
);
234 if (--dinfo
->refcount
== 0) {
239 void drive_get_ref(DriveInfo
*dinfo
)
246 BlockDriverState
*bs
;
249 static void bdrv_put_ref_bh(void *opaque
)
251 BDRVPutRefBH
*s
= opaque
;
254 qemu_bh_delete(s
->bh
);
259 * Release a BDS reference in a BH
261 * It is not safe to use bdrv_unref() from a callback function when the callers
262 * still need the BlockDriverState. In such cases we schedule a BH to release
265 static void bdrv_put_ref_bh_schedule(BlockDriverState
*bs
)
269 s
= g_new(BDRVPutRefBH
, 1);
270 s
->bh
= qemu_bh_new(bdrv_put_ref_bh
, s
);
272 qemu_bh_schedule(s
->bh
);
275 static int parse_block_error_action(const char *buf
, bool is_read
)
277 if (!strcmp(buf
, "ignore")) {
278 return BLOCKDEV_ON_ERROR_IGNORE
;
279 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
280 return BLOCKDEV_ON_ERROR_ENOSPC
;
281 } else if (!strcmp(buf
, "stop")) {
282 return BLOCKDEV_ON_ERROR_STOP
;
283 } else if (!strcmp(buf
, "report")) {
284 return BLOCKDEV_ON_ERROR_REPORT
;
286 error_report("'%s' invalid %s error action",
287 buf
, is_read
? "read" : "write");
292 static bool check_throttle_config(ThrottleConfig
*cfg
, Error
**errp
)
294 if (throttle_conflicting(cfg
)) {
295 error_setg(errp
, "bps/iops/max total values and read/write values"
296 " cannot be used at the same time");
300 if (!throttle_is_valid(cfg
)) {
301 error_setg(errp
, "bps/iops/maxs values must be 0 or greater");
308 typedef enum { MEDIA_DISK
, MEDIA_CDROM
} DriveMediaType
;
310 /* Takes the ownership of bs_opts */
311 static DriveInfo
*blockdev_init(QDict
*bs_opts
,
312 BlockInterfaceType type
)
315 const char *file
= NULL
;
319 int on_read_error
, on_write_error
;
328 bool has_driver_specific_opts
;
329 BlockDriver
*drv
= NULL
;
331 /* Check common options by copying from bs_opts to opts, all other options
332 * stay in bs_opts for processing by bdrv_open(). */
333 id
= qdict_get_try_str(bs_opts
, "id");
334 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
335 if (error_is_set(&error
)) {
336 qerror_report_err(error
);
341 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
342 if (error_is_set(&error
)) {
343 qerror_report_err(error
);
349 qdict_del(bs_opts
, "id");
352 has_driver_specific_opts
= !!qdict_size(bs_opts
);
354 /* extract parameters */
355 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
356 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
357 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
359 file
= qemu_opt_get(opts
, "file");
360 serial
= qemu_opt_get(opts
, "serial");
362 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
363 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
364 error_report("invalid discard option");
369 if (qemu_opt_get_bool(opts
, "cache.writeback", true)) {
370 bdrv_flags
|= BDRV_O_CACHE_WB
;
372 if (qemu_opt_get_bool(opts
, "cache.direct", false)) {
373 bdrv_flags
|= BDRV_O_NOCACHE
;
375 if (qemu_opt_get_bool(opts
, "cache.no-flush", false)) {
376 bdrv_flags
|= BDRV_O_NO_FLUSH
;
379 #ifdef CONFIG_LINUX_AIO
380 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
381 if (!strcmp(buf
, "native")) {
382 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
383 } else if (!strcmp(buf
, "threads")) {
384 /* this is the default */
386 error_report("invalid aio option");
392 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
393 if (is_help_option(buf
)) {
394 error_printf("Supported formats:");
395 bdrv_iterate_format(bdrv_format_print
, NULL
);
400 drv
= bdrv_find_format(buf
);
402 error_report("'%s' invalid format", buf
);
407 /* disk I/O throttling */
408 memset(&cfg
, 0, sizeof(cfg
));
409 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
=
410 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
411 cfg
.buckets
[THROTTLE_BPS_READ
].avg
=
412 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
413 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
=
414 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
415 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
=
416 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
417 cfg
.buckets
[THROTTLE_OPS_READ
].avg
=
418 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
419 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
=
420 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
422 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
=
423 qemu_opt_get_number(opts
, "throttling.bps-total-max", 0);
424 cfg
.buckets
[THROTTLE_BPS_READ
].max
=
425 qemu_opt_get_number(opts
, "throttling.bps-read-max", 0);
426 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
=
427 qemu_opt_get_number(opts
, "throttling.bps-write-max", 0);
428 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
=
429 qemu_opt_get_number(opts
, "throttling.iops-total-max", 0);
430 cfg
.buckets
[THROTTLE_OPS_READ
].max
=
431 qemu_opt_get_number(opts
, "throttling.iops-read-max", 0);
432 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
=
433 qemu_opt_get_number(opts
, "throttling.iops-write-max", 0);
435 cfg
.op_size
= qemu_opt_get_number(opts
, "throttling.iops-size", 0);
437 if (!check_throttle_config(&cfg
, &error
)) {
438 error_report("%s", error_get_pretty(error
));
443 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
444 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
445 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
446 error_report("werror is not supported by this bus type");
450 on_write_error
= parse_block_error_action(buf
, 0);
451 if (on_write_error
< 0) {
456 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
457 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
458 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
459 error_report("rerror is not supported by this bus type");
463 on_read_error
= parse_block_error_action(buf
, 1);
464 if (on_read_error
< 0) {
470 dinfo
= g_malloc0(sizeof(*dinfo
));
471 dinfo
->id
= g_strdup(qemu_opts_id(opts
));
472 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
473 dinfo
->bdrv
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
474 dinfo
->bdrv
->read_only
= ro
;
477 if (serial
!= NULL
) {
478 dinfo
->serial
= g_strdup(serial
);
480 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
482 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
484 /* disk I/O throttling */
485 if (throttle_enabled(&cfg
)) {
486 bdrv_io_limits_enable(dinfo
->bdrv
);
487 bdrv_set_io_limits(dinfo
->bdrv
, &cfg
);
490 if (!file
|| !*file
) {
491 if (has_driver_specific_opts
) {
498 /* always use cache=unsafe with snapshot */
499 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
500 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
504 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
507 if (runstate_check(RUN_STATE_INMIGRATE
)) {
508 bdrv_flags
|= BDRV_O_INCOMING
;
511 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
513 if (ro
&& copy_on_read
) {
514 error_report("warning: disabling copy_on_read on read-only drive");
518 ret
= bdrv_open(dinfo
->bdrv
, file
, bs_opts
, bdrv_flags
, drv
, &error
);
521 error_report("could not open disk image %s: %s",
522 file
?: dinfo
->id
, error_get_pretty(error
));
526 if (bdrv_key_required(dinfo
->bdrv
))
537 bdrv_unref(dinfo
->bdrv
);
539 QTAILQ_REMOVE(&drives
, dinfo
, next
);
544 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
)
548 value
= qemu_opt_get(opts
, from
);
550 qemu_opt_set(opts
, to
, value
);
551 qemu_opt_unset(opts
, from
);
555 QemuOptsList qemu_legacy_drive_opts
= {
557 .head
= QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts
.head
),
561 .type
= QEMU_OPT_NUMBER
,
562 .help
= "bus number",
565 .type
= QEMU_OPT_NUMBER
,
566 .help
= "unit number (i.e. lun for scsi)",
569 .type
= QEMU_OPT_NUMBER
,
570 .help
= "index number",
573 .type
= QEMU_OPT_STRING
,
574 .help
= "media type (disk, cdrom)",
577 .type
= QEMU_OPT_STRING
,
578 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
581 .type
= QEMU_OPT_NUMBER
,
582 .help
= "number of cylinders (ide disk geometry)",
585 .type
= QEMU_OPT_NUMBER
,
586 .help
= "number of heads (ide disk geometry)",
589 .type
= QEMU_OPT_NUMBER
,
590 .help
= "number of sectors (ide disk geometry)",
593 .type
= QEMU_OPT_STRING
,
594 .help
= "chs translation (auto, lba, none)",
597 .type
= QEMU_OPT_BOOL
,
598 .help
= "(deprecated, ignored)",
601 .type
= QEMU_OPT_STRING
,
602 .help
= "pci address (virtio only)",
604 { /* end of list */ }
608 DriveInfo
*drive_init(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
611 DriveInfo
*dinfo
= NULL
;
613 QemuOpts
*legacy_opts
;
614 DriveMediaType media
= MEDIA_DISK
;
615 BlockInterfaceType type
;
616 int cyls
, heads
, secs
, translation
;
617 int max_devs
, bus_id
, unit_id
, index
;
619 Error
*local_err
= NULL
;
621 /* Change legacy command line options into QMP ones */
622 qemu_opt_rename(all_opts
, "iops", "throttling.iops-total");
623 qemu_opt_rename(all_opts
, "iops_rd", "throttling.iops-read");
624 qemu_opt_rename(all_opts
, "iops_wr", "throttling.iops-write");
626 qemu_opt_rename(all_opts
, "bps", "throttling.bps-total");
627 qemu_opt_rename(all_opts
, "bps_rd", "throttling.bps-read");
628 qemu_opt_rename(all_opts
, "bps_wr", "throttling.bps-write");
630 qemu_opt_rename(all_opts
, "iops_max", "throttling.iops-total-max");
631 qemu_opt_rename(all_opts
, "iops_rd_max", "throttling.iops-read-max");
632 qemu_opt_rename(all_opts
, "iops_wr_max", "throttling.iops-write-max");
634 qemu_opt_rename(all_opts
, "bps_max", "throttling.bps-total-max");
635 qemu_opt_rename(all_opts
, "bps_rd_max", "throttling.bps-read-max");
636 qemu_opt_rename(all_opts
, "bps_wr_max", "throttling.bps-write-max");
638 qemu_opt_rename(all_opts
,
639 "iops_size", "throttling.iops-size");
641 qemu_opt_rename(all_opts
, "readonly", "read-only");
643 value
= qemu_opt_get(all_opts
, "cache");
647 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
648 error_report("invalid cache option");
652 /* Specific options take precedence */
653 if (!qemu_opt_get(all_opts
, "cache.writeback")) {
654 qemu_opt_set_bool(all_opts
, "cache.writeback",
655 !!(flags
& BDRV_O_CACHE_WB
));
657 if (!qemu_opt_get(all_opts
, "cache.direct")) {
658 qemu_opt_set_bool(all_opts
, "cache.direct",
659 !!(flags
& BDRV_O_NOCACHE
));
661 if (!qemu_opt_get(all_opts
, "cache.no-flush")) {
662 qemu_opt_set_bool(all_opts
, "cache.no-flush",
663 !!(flags
& BDRV_O_NO_FLUSH
));
665 qemu_opt_unset(all_opts
, "cache");
668 /* Get a QDict for processing the options */
669 bs_opts
= qdict_new();
670 qemu_opts_to_qdict(all_opts
, bs_opts
);
672 legacy_opts
= qemu_opts_create_nofail(&qemu_legacy_drive_opts
);
673 qemu_opts_absorb_qdict(legacy_opts
, bs_opts
, &local_err
);
674 if (error_is_set(&local_err
)) {
675 qerror_report_err(local_err
);
676 error_free(local_err
);
680 /* Deprecated option boot=[on|off] */
681 if (qemu_opt_get(legacy_opts
, "boot") != NULL
) {
682 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
683 "ignored. Future versions will reject this parameter. Please "
684 "update your scripts.\n");
688 value
= qemu_opt_get(legacy_opts
, "media");
690 if (!strcmp(value
, "disk")) {
692 } else if (!strcmp(value
, "cdrom")) {
694 qdict_put(bs_opts
, "read-only", qstring_from_str("on"));
696 error_report("'%s' invalid media", value
);
701 /* Controller type */
702 value
= qemu_opt_get(legacy_opts
, "if");
705 type
< IF_COUNT
&& strcmp(value
, if_name
[type
]);
708 if (type
== IF_COUNT
) {
709 error_report("unsupported bus type '%s'", value
);
713 type
= block_default_type
;
717 cyls
= qemu_opt_get_number(legacy_opts
, "cyls", 0);
718 heads
= qemu_opt_get_number(legacy_opts
, "heads", 0);
719 secs
= qemu_opt_get_number(legacy_opts
, "secs", 0);
721 if (cyls
|| heads
|| secs
) {
723 error_report("invalid physical cyls number");
727 error_report("invalid physical heads number");
731 error_report("invalid physical secs number");
736 translation
= BIOS_ATA_TRANSLATION_AUTO
;
737 value
= qemu_opt_get(legacy_opts
, "trans");
740 error_report("'%s' trans must be used with cyls, heads and secs",
744 if (!strcmp(value
, "none")) {
745 translation
= BIOS_ATA_TRANSLATION_NONE
;
746 } else if (!strcmp(value
, "lba")) {
747 translation
= BIOS_ATA_TRANSLATION_LBA
;
748 } else if (!strcmp(value
, "auto")) {
749 translation
= BIOS_ATA_TRANSLATION_AUTO
;
751 error_report("'%s' invalid translation type", value
);
756 if (media
== MEDIA_CDROM
) {
757 if (cyls
|| secs
|| heads
) {
758 error_report("CHS can't be set with media=cdrom");
763 /* Device address specified by bus/unit or index.
764 * If none was specified, try to find the first free one. */
765 bus_id
= qemu_opt_get_number(legacy_opts
, "bus", 0);
766 unit_id
= qemu_opt_get_number(legacy_opts
, "unit", -1);
767 index
= qemu_opt_get_number(legacy_opts
, "index", -1);
769 max_devs
= if_max_devs
[type
];
772 if (bus_id
!= 0 || unit_id
!= -1) {
773 error_report("index cannot be used with bus and unit");
776 bus_id
= drive_index_to_bus_id(type
, index
);
777 unit_id
= drive_index_to_unit_id(type
, index
);
782 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
784 if (max_devs
&& unit_id
>= max_devs
) {
791 if (max_devs
&& unit_id
>= max_devs
) {
792 error_report("unit %d too big (max is %d)", unit_id
, max_devs
- 1);
796 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
797 error_report("drive with bus=%d, unit=%d (index=%d) exists",
798 bus_id
, unit_id
, index
);
802 /* no id supplied -> create one */
803 if (qemu_opts_id(all_opts
) == NULL
) {
805 const char *mediastr
= "";
806 if (type
== IF_IDE
|| type
== IF_SCSI
) {
807 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
810 new_id
= g_strdup_printf("%s%i%s%i", if_name
[type
], bus_id
,
813 new_id
= g_strdup_printf("%s%s%i", if_name
[type
],
816 qdict_put(bs_opts
, "id", qstring_from_str(new_id
));
820 /* Add virtio block device */
821 devaddr
= qemu_opt_get(legacy_opts
, "addr");
822 if (devaddr
&& type
!= IF_VIRTIO
) {
823 error_report("addr is not supported by this bus type");
827 if (type
== IF_VIRTIO
) {
829 devopts
= qemu_opts_create_nofail(qemu_find_opts("device"));
830 if (arch_type
== QEMU_ARCH_S390X
) {
831 qemu_opt_set(devopts
, "driver", "virtio-blk-s390");
833 qemu_opt_set(devopts
, "driver", "virtio-blk-pci");
835 qemu_opt_set(devopts
, "drive", qdict_get_str(bs_opts
, "id"));
837 qemu_opt_set(devopts
, "addr", devaddr
);
841 /* Actual block device init: Functionality shared with blockdev-add */
842 dinfo
= blockdev_init(bs_opts
, type
);
847 /* Set legacy DriveInfo fields */
848 dinfo
->enable_auto_del
= true;
849 dinfo
->opts
= all_opts
;
852 dinfo
->heads
= heads
;
854 dinfo
->trans
= translation
;
857 dinfo
->unit
= unit_id
;
858 dinfo
->devaddr
= devaddr
;
865 dinfo
->media_cd
= media
== MEDIA_CDROM
;
872 qemu_opts_del(legacy_opts
);
876 void do_commit(Monitor
*mon
, const QDict
*qdict
)
878 const char *device
= qdict_get_str(qdict
, "device");
879 BlockDriverState
*bs
;
882 if (!strcmp(device
, "all")) {
883 ret
= bdrv_commit_all();
885 bs
= bdrv_find(device
);
887 monitor_printf(mon
, "Device '%s' not found\n", device
);
890 ret
= bdrv_commit(bs
);
893 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
898 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
900 TransactionAction action
;
901 TransactionActionList list
;
905 list
.value
= &action
;
907 qmp_transaction(&list
, errp
);
910 void qmp_blockdev_snapshot_sync(const char *device
, const char *snapshot_file
,
911 bool has_format
, const char *format
,
912 bool has_mode
, enum NewImageMode mode
,
915 BlockdevSnapshot snapshot
= {
916 .device
= (char *) device
,
917 .snapshot_file
= (char *) snapshot_file
,
918 .has_format
= has_format
,
919 .format
= (char *) format
,
920 .has_mode
= has_mode
,
923 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
927 void qmp_blockdev_snapshot_internal_sync(const char *device
,
931 BlockdevSnapshotInternal snapshot
= {
932 .device
= (char *) device
,
933 .name
= (char *) name
936 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
,
940 SnapshotInfo
*qmp_blockdev_snapshot_delete_internal_sync(const char *device
,
947 BlockDriverState
*bs
= bdrv_find(device
);
949 Error
*local_err
= NULL
;
950 SnapshotInfo
*info
= NULL
;
954 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
967 error_setg(errp
, "Name or id must be provided");
971 ret
= bdrv_snapshot_find_by_id_and_name(bs
, id
, name
, &sn
, &local_err
);
972 if (error_is_set(&local_err
)) {
973 error_propagate(errp
, local_err
);
978 "Snapshot with id '%s' and name '%s' does not exist on "
980 STR_OR_NULL(id
), STR_OR_NULL(name
), device
);
984 bdrv_snapshot_delete(bs
, id
, name
, &local_err
);
985 if (error_is_set(&local_err
)) {
986 error_propagate(errp
, local_err
);
990 info
= g_malloc0(sizeof(SnapshotInfo
));
991 info
->id
= g_strdup(sn
.id_str
);
992 info
->name
= g_strdup(sn
.name
);
993 info
->date_nsec
= sn
.date_nsec
;
994 info
->date_sec
= sn
.date_sec
;
995 info
->vm_state_size
= sn
.vm_state_size
;
996 info
->vm_clock_nsec
= sn
.vm_clock_nsec
% 1000000000;
997 info
->vm_clock_sec
= sn
.vm_clock_nsec
/ 1000000000;
1002 /* New and old BlockDriverState structs for group snapshots */
1004 typedef struct BlkTransactionState BlkTransactionState
;
1006 /* Only prepare() may fail. In a single transaction, only one of commit() or
1007 abort() will be called, clean() will always be called if it present. */
1008 typedef struct BdrvActionOps
{
1009 /* Size of state struct, in bytes. */
1010 size_t instance_size
;
1011 /* Prepare the work, must NOT be NULL. */
1012 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
1013 /* Commit the changes, can be NULL. */
1014 void (*commit
)(BlkTransactionState
*common
);
1015 /* Abort the changes on fail, can be NULL. */
1016 void (*abort
)(BlkTransactionState
*common
);
1017 /* Clean up resource in the end, can be NULL. */
1018 void (*clean
)(BlkTransactionState
*common
);
1022 * This structure must be arranged as first member in child type, assuming
1023 * that compiler will also arrange it to the same address with parent instance.
1024 * Later it will be used in free().
1026 struct BlkTransactionState
{
1027 TransactionAction
*action
;
1028 const BdrvActionOps
*ops
;
1029 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
1032 /* internal snapshot private data */
1033 typedef struct InternalSnapshotState
{
1034 BlkTransactionState common
;
1035 BlockDriverState
*bs
;
1036 QEMUSnapshotInfo sn
;
1037 } InternalSnapshotState
;
1039 static void internal_snapshot_prepare(BlkTransactionState
*common
,
1044 BlockDriverState
*bs
;
1045 QEMUSnapshotInfo old_sn
, *sn
;
1048 BlockdevSnapshotInternal
*internal
;
1049 InternalSnapshotState
*state
;
1052 g_assert(common
->action
->kind
==
1053 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
);
1054 internal
= common
->action
->blockdev_snapshot_internal_sync
;
1055 state
= DO_UPCAST(InternalSnapshotState
, common
, common
);
1057 /* 1. parse input */
1058 device
= internal
->device
;
1059 name
= internal
->name
;
1061 /* 2. check for validation */
1062 bs
= bdrv_find(device
);
1064 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1068 if (!bdrv_is_inserted(bs
)) {
1069 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1073 if (bdrv_is_read_only(bs
)) {
1074 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1078 if (!bdrv_can_snapshot(bs
)) {
1079 error_set(errp
, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
1080 bs
->drv
->format_name
, device
, "internal snapshot");
1084 if (!strlen(name
)) {
1085 error_setg(errp
, "Name is empty");
1089 /* check whether a snapshot with name exist */
1090 ret
= bdrv_snapshot_find_by_id_and_name(bs
, NULL
, name
, &old_sn
, errp
);
1091 if (error_is_set(errp
)) {
1095 "Snapshot with name '%s' already exists on device '%s'",
1100 /* 3. take the snapshot */
1102 pstrcpy(sn
->name
, sizeof(sn
->name
), name
);
1103 qemu_gettimeofday(&tv
);
1104 sn
->date_sec
= tv
.tv_sec
;
1105 sn
->date_nsec
= tv
.tv_usec
* 1000;
1106 sn
->vm_clock_nsec
= qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL
);
1108 ret1
= bdrv_snapshot_create(bs
, sn
);
1110 error_setg_errno(errp
, -ret1
,
1111 "Failed to create snapshot '%s' on device '%s'",
1116 /* 4. succeed, mark a snapshot is created */
1120 static void internal_snapshot_abort(BlkTransactionState
*common
)
1122 InternalSnapshotState
*state
=
1123 DO_UPCAST(InternalSnapshotState
, common
, common
);
1124 BlockDriverState
*bs
= state
->bs
;
1125 QEMUSnapshotInfo
*sn
= &state
->sn
;
1126 Error
*local_error
= NULL
;
1132 if (bdrv_snapshot_delete(bs
, sn
->id_str
, sn
->name
, &local_error
) < 0) {
1133 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1134 "device '%s' in abort: %s",
1137 bdrv_get_device_name(bs
),
1138 error_get_pretty(local_error
));
1139 error_free(local_error
);
1143 /* external snapshot private data */
1144 typedef struct ExternalSnapshotState
{
1145 BlkTransactionState common
;
1146 BlockDriverState
*old_bs
;
1147 BlockDriverState
*new_bs
;
1148 } ExternalSnapshotState
;
1150 static void external_snapshot_prepare(BlkTransactionState
*common
,
1155 Error
*local_err
= NULL
;
1157 const char *new_image_file
;
1158 const char *format
= "qcow2";
1159 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1160 ExternalSnapshotState
*state
=
1161 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1162 TransactionAction
*action
= common
->action
;
1164 /* get parameters */
1165 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
1167 device
= action
->blockdev_snapshot_sync
->device
;
1168 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
1169 if (action
->blockdev_snapshot_sync
->has_format
) {
1170 format
= action
->blockdev_snapshot_sync
->format
;
1172 if (action
->blockdev_snapshot_sync
->has_mode
) {
1173 mode
= action
->blockdev_snapshot_sync
->mode
;
1176 /* start processing */
1177 drv
= bdrv_find_format(format
);
1179 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1183 state
->old_bs
= bdrv_find(device
);
1184 if (!state
->old_bs
) {
1185 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1189 if (!bdrv_is_inserted(state
->old_bs
)) {
1190 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1194 if (bdrv_in_use(state
->old_bs
)) {
1195 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1199 if (!bdrv_is_read_only(state
->old_bs
)) {
1200 if (bdrv_flush(state
->old_bs
)) {
1201 error_set(errp
, QERR_IO_ERROR
);
1206 if (bdrv_check_ext_snapshot(state
->old_bs
) != EXT_SNAPSHOT_ALLOWED
) {
1207 error_set(errp
, QERR_FEATURE_DISABLED
, "snapshot");
1211 flags
= state
->old_bs
->open_flags
;
1213 /* create new image w/backing file */
1214 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1215 bdrv_img_create(new_image_file
, format
,
1216 state
->old_bs
->filename
,
1217 state
->old_bs
->drv
->format_name
,
1218 NULL
, -1, flags
, &local_err
, false);
1219 if (error_is_set(&local_err
)) {
1220 error_propagate(errp
, local_err
);
1225 /* We will manually add the backing_hd field to the bs later */
1226 state
->new_bs
= bdrv_new("");
1227 /* TODO Inherit bs->options or only take explicit options with an
1228 * extended QMP command? */
1229 ret
= bdrv_open(state
->new_bs
, new_image_file
, NULL
,
1230 flags
| BDRV_O_NO_BACKING
, drv
, &local_err
);
1232 error_propagate(errp
, local_err
);
1236 static void external_snapshot_commit(BlkTransactionState
*common
)
1238 ExternalSnapshotState
*state
=
1239 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1241 /* This removes our old bs and adds the new bs */
1242 bdrv_append(state
->new_bs
, state
->old_bs
);
1243 /* We don't need (or want) to use the transactional
1244 * bdrv_reopen_multiple() across all the entries at once, because we
1245 * don't want to abort all of them if one of them fails the reopen */
1246 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
1250 static void external_snapshot_abort(BlkTransactionState
*common
)
1252 ExternalSnapshotState
*state
=
1253 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1254 if (state
->new_bs
) {
1255 bdrv_unref(state
->new_bs
);
1259 typedef struct DriveBackupState
{
1260 BlkTransactionState common
;
1261 BlockDriverState
*bs
;
1265 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1267 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1268 DriveBackup
*backup
;
1269 Error
*local_err
= NULL
;
1271 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1272 backup
= common
->action
->drive_backup
;
1274 qmp_drive_backup(backup
->device
, backup
->target
,
1275 backup
->has_format
, backup
->format
,
1277 backup
->has_mode
, backup
->mode
,
1278 backup
->has_speed
, backup
->speed
,
1279 backup
->has_on_source_error
, backup
->on_source_error
,
1280 backup
->has_on_target_error
, backup
->on_target_error
,
1282 if (error_is_set(&local_err
)) {
1283 error_propagate(errp
, local_err
);
1289 state
->bs
= bdrv_find(backup
->device
);
1290 state
->job
= state
->bs
->job
;
1293 static void drive_backup_abort(BlkTransactionState
*common
)
1295 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1296 BlockDriverState
*bs
= state
->bs
;
1298 /* Only cancel if it's the job we started */
1299 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1300 block_job_cancel_sync(bs
->job
);
1304 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1306 error_setg(errp
, "Transaction aborted using Abort action");
1309 static void abort_commit(BlkTransactionState
*common
)
1311 g_assert_not_reached(); /* this action never succeeds */
1314 static const BdrvActionOps actions
[] = {
1315 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1316 .instance_size
= sizeof(ExternalSnapshotState
),
1317 .prepare
= external_snapshot_prepare
,
1318 .commit
= external_snapshot_commit
,
1319 .abort
= external_snapshot_abort
,
1321 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1322 .instance_size
= sizeof(DriveBackupState
),
1323 .prepare
= drive_backup_prepare
,
1324 .abort
= drive_backup_abort
,
1326 [TRANSACTION_ACTION_KIND_ABORT
] = {
1327 .instance_size
= sizeof(BlkTransactionState
),
1328 .prepare
= abort_prepare
,
1329 .commit
= abort_commit
,
1331 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC
] = {
1332 .instance_size
= sizeof(InternalSnapshotState
),
1333 .prepare
= internal_snapshot_prepare
,
1334 .abort
= internal_snapshot_abort
,
1339 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1340 * then we do not pivot any of the devices in the group, and abandon the
1343 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1345 TransactionActionList
*dev_entry
= dev_list
;
1346 BlkTransactionState
*state
, *next
;
1347 Error
*local_err
= NULL
;
1349 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1350 QSIMPLEQ_INIT(&snap_bdrv_states
);
1352 /* drain all i/o before any snapshots */
1355 /* We don't do anything in this loop that commits us to the snapshot */
1356 while (NULL
!= dev_entry
) {
1357 TransactionAction
*dev_info
= NULL
;
1358 const BdrvActionOps
*ops
;
1360 dev_info
= dev_entry
->value
;
1361 dev_entry
= dev_entry
->next
;
1363 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1365 ops
= &actions
[dev_info
->kind
];
1366 assert(ops
->instance_size
> 0);
1368 state
= g_malloc0(ops
->instance_size
);
1370 state
->action
= dev_info
;
1371 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1373 state
->ops
->prepare(state
, &local_err
);
1374 if (error_is_set(&local_err
)) {
1375 error_propagate(errp
, local_err
);
1376 goto delete_and_fail
;
1380 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1381 if (state
->ops
->commit
) {
1382 state
->ops
->commit(state
);
1391 * failure, and it is all-or-none; abandon each new bs, and keep using
1392 * the original bs for all images
1394 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1395 if (state
->ops
->abort
) {
1396 state
->ops
->abort(state
);
1400 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1401 if (state
->ops
->clean
) {
1402 state
->ops
->clean(state
);
1409 static void eject_device(BlockDriverState
*bs
, int force
, Error
**errp
)
1411 if (bdrv_in_use(bs
)) {
1412 error_set(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
1415 if (!bdrv_dev_has_removable_media(bs
)) {
1416 error_set(errp
, QERR_DEVICE_NOT_REMOVABLE
, bdrv_get_device_name(bs
));
1420 if (bdrv_dev_is_medium_locked(bs
) && !bdrv_dev_is_tray_open(bs
)) {
1421 bdrv_dev_eject_request(bs
, force
);
1423 error_set(errp
, QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
1431 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1433 BlockDriverState
*bs
;
1435 bs
= bdrv_find(device
);
1437 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1441 eject_device(bs
, force
, errp
);
1444 void qmp_block_passwd(const char *device
, const char *password
, Error
**errp
)
1446 BlockDriverState
*bs
;
1449 bs
= bdrv_find(device
);
1451 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1455 err
= bdrv_set_key(bs
, password
);
1456 if (err
== -EINVAL
) {
1457 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1459 } else if (err
< 0) {
1460 error_set(errp
, QERR_INVALID_PASSWORD
);
1465 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1466 int bdrv_flags
, BlockDriver
*drv
,
1467 const char *password
, Error
**errp
)
1469 Error
*local_err
= NULL
;
1472 ret
= bdrv_open(bs
, filename
, NULL
, bdrv_flags
, drv
, &local_err
);
1474 error_propagate(errp
, local_err
);
1478 if (bdrv_key_required(bs
)) {
1480 if (bdrv_set_key(bs
, password
) < 0) {
1481 error_set(errp
, QERR_INVALID_PASSWORD
);
1484 error_set(errp
, QERR_DEVICE_ENCRYPTED
, bdrv_get_device_name(bs
),
1485 bdrv_get_encrypted_filename(bs
));
1487 } else if (password
) {
1488 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1492 void qmp_change_blockdev(const char *device
, const char *filename
,
1493 bool has_format
, const char *format
, Error
**errp
)
1495 BlockDriverState
*bs
;
1496 BlockDriver
*drv
= NULL
;
1500 bs
= bdrv_find(device
);
1502 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1507 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1509 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1514 eject_device(bs
, 0, &err
);
1515 if (error_is_set(&err
)) {
1516 error_propagate(errp
, err
);
1520 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1521 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1523 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1526 /* throttling disk I/O limits */
1527 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1534 bool has_bps_rd_max
,
1536 bool has_bps_wr_max
,
1540 bool has_iops_rd_max
,
1541 int64_t iops_rd_max
,
1542 bool has_iops_wr_max
,
1543 int64_t iops_wr_max
,
1545 int64_t iops_size
, Error
**errp
)
1548 BlockDriverState
*bs
;
1550 bs
= bdrv_find(device
);
1552 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1556 memset(&cfg
, 0, sizeof(cfg
));
1557 cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
= bps
;
1558 cfg
.buckets
[THROTTLE_BPS_READ
].avg
= bps_rd
;
1559 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= bps_wr
;
1561 cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
= iops
;
1562 cfg
.buckets
[THROTTLE_OPS_READ
].avg
= iops_rd
;
1563 cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
= iops_wr
;
1566 cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
= bps_max
;
1568 if (has_bps_rd_max
) {
1569 cfg
.buckets
[THROTTLE_BPS_READ
].max
= bps_rd_max
;
1571 if (has_bps_wr_max
) {
1572 cfg
.buckets
[THROTTLE_BPS_WRITE
].max
= bps_wr_max
;
1575 cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
= iops_max
;
1577 if (has_iops_rd_max
) {
1578 cfg
.buckets
[THROTTLE_OPS_READ
].max
= iops_rd_max
;
1580 if (has_iops_wr_max
) {
1581 cfg
.buckets
[THROTTLE_OPS_WRITE
].max
= iops_wr_max
;
1584 if (has_iops_size
) {
1585 cfg
.op_size
= iops_size
;
1588 if (!check_throttle_config(&cfg
, errp
)) {
1592 if (!bs
->io_limits_enabled
&& throttle_enabled(&cfg
)) {
1593 bdrv_io_limits_enable(bs
);
1594 } else if (bs
->io_limits_enabled
&& !throttle_enabled(&cfg
)) {
1595 bdrv_io_limits_disable(bs
);
1598 if (bs
->io_limits_enabled
) {
1599 bdrv_set_io_limits(bs
, &cfg
);
1603 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
1605 const char *id
= qdict_get_str(qdict
, "id");
1606 BlockDriverState
*bs
;
1610 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
1613 if (bdrv_in_use(bs
)) {
1614 qerror_report(QERR_DEVICE_IN_USE
, id
);
1618 /* quiesce block driver; prevent further io */
1623 /* if we have a device attached to this BlockDriverState
1624 * then we need to make the drive anonymous until the device
1625 * can be removed. If this is a drive with no device backing
1626 * then we can just get rid of the block driver state right here.
1628 if (bdrv_get_attached_dev(bs
)) {
1631 /* Further I/O must not pause the guest */
1632 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
1633 BLOCKDEV_ON_ERROR_REPORT
);
1635 drive_uninit(drive_get_by_blockdev(bs
));
1641 void qmp_block_resize(const char *device
, int64_t size
, Error
**errp
)
1643 BlockDriverState
*bs
;
1646 bs
= bdrv_find(device
);
1648 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1653 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
1657 /* complete all in-flight operations before resizing the device */
1660 ret
= bdrv_truncate(bs
, size
);
1665 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1668 error_set(errp
, QERR_UNSUPPORTED
);
1671 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1674 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1677 error_setg_errno(errp
, -ret
, "Could not resize");
1682 static void block_job_cb(void *opaque
, int ret
)
1684 BlockDriverState
*bs
= opaque
;
1687 trace_block_job_cb(bs
, bs
->job
, ret
);
1690 obj
= qobject_from_block_job(bs
->job
);
1692 QDict
*dict
= qobject_to_qdict(obj
);
1693 qdict_put(dict
, "error", qstring_from_str(strerror(-ret
)));
1696 if (block_job_is_cancelled(bs
->job
)) {
1697 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED
, obj
);
1699 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED
, obj
);
1701 qobject_decref(obj
);
1703 bdrv_put_ref_bh_schedule(bs
);
1706 void qmp_block_stream(const char *device
, bool has_base
,
1707 const char *base
, bool has_speed
, int64_t speed
,
1708 bool has_on_error
, BlockdevOnError on_error
,
1711 BlockDriverState
*bs
;
1712 BlockDriverState
*base_bs
= NULL
;
1713 Error
*local_err
= NULL
;
1715 if (!has_on_error
) {
1716 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1719 bs
= bdrv_find(device
);
1721 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1726 base_bs
= bdrv_find_backing_image(bs
, base
);
1727 if (base_bs
== NULL
) {
1728 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
1733 stream_start(bs
, base_bs
, base
, has_speed
? speed
: 0,
1734 on_error
, block_job_cb
, bs
, &local_err
);
1735 if (error_is_set(&local_err
)) {
1736 error_propagate(errp
, local_err
);
1740 trace_qmp_block_stream(bs
, bs
->job
);
1743 void qmp_block_commit(const char *device
,
1744 bool has_base
, const char *base
, const char *top
,
1745 bool has_speed
, int64_t speed
,
1748 BlockDriverState
*bs
;
1749 BlockDriverState
*base_bs
, *top_bs
;
1750 Error
*local_err
= NULL
;
1751 /* This will be part of the QMP command, if/when the
1752 * BlockdevOnError change for blkmirror makes it in
1754 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1756 /* drain all i/o before commits */
1759 bs
= bdrv_find(device
);
1761 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1765 /* default top_bs is the active layer */
1769 if (strcmp(bs
->filename
, top
) != 0) {
1770 top_bs
= bdrv_find_backing_image(bs
, top
);
1774 if (top_bs
== NULL
) {
1775 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
1779 if (has_base
&& base
) {
1780 base_bs
= bdrv_find_backing_image(top_bs
, base
);
1782 base_bs
= bdrv_find_base(top_bs
);
1785 if (base_bs
== NULL
) {
1786 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
1790 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
1792 if (local_err
!= NULL
) {
1793 error_propagate(errp
, local_err
);
1798 void qmp_drive_backup(const char *device
, const char *target
,
1799 bool has_format
, const char *format
,
1800 enum MirrorSyncMode sync
,
1801 bool has_mode
, enum NewImageMode mode
,
1802 bool has_speed
, int64_t speed
,
1803 bool has_on_source_error
, BlockdevOnError on_source_error
,
1804 bool has_on_target_error
, BlockdevOnError on_target_error
,
1807 BlockDriverState
*bs
;
1808 BlockDriverState
*target_bs
;
1809 BlockDriverState
*source
= NULL
;
1810 BlockDriver
*drv
= NULL
;
1811 Error
*local_err
= NULL
;
1819 if (!has_on_source_error
) {
1820 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1822 if (!has_on_target_error
) {
1823 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1826 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1829 bs
= bdrv_find(device
);
1831 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1835 if (!bdrv_is_inserted(bs
)) {
1836 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1841 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1844 drv
= bdrv_find_format(format
);
1846 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1851 if (bdrv_in_use(bs
)) {
1852 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1856 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1858 /* See if we have a backing HD we can use to create our new image
1860 if (sync
== MIRROR_SYNC_MODE_TOP
) {
1861 source
= bs
->backing_hd
;
1863 sync
= MIRROR_SYNC_MODE_FULL
;
1866 if (sync
== MIRROR_SYNC_MODE_NONE
) {
1870 size
= bdrv_getlength(bs
);
1872 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1876 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1877 assert(format
&& drv
);
1879 bdrv_img_create(target
, format
, source
->filename
,
1880 source
->drv
->format_name
, NULL
,
1881 size
, flags
, &local_err
, false);
1883 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
1884 size
, flags
, &local_err
, false);
1888 if (error_is_set(&local_err
)) {
1889 error_propagate(errp
, local_err
);
1893 target_bs
= bdrv_new("");
1894 ret
= bdrv_open(target_bs
, target
, NULL
, flags
, drv
, &local_err
);
1896 bdrv_unref(target_bs
);
1897 error_propagate(errp
, local_err
);
1901 backup_start(bs
, target_bs
, speed
, sync
, on_source_error
, on_target_error
,
1902 block_job_cb
, bs
, &local_err
);
1903 if (local_err
!= NULL
) {
1904 bdrv_unref(target_bs
);
1905 error_propagate(errp
, local_err
);
1910 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1912 void qmp_drive_mirror(const char *device
, const char *target
,
1913 bool has_format
, const char *format
,
1914 enum MirrorSyncMode sync
,
1915 bool has_mode
, enum NewImageMode mode
,
1916 bool has_speed
, int64_t speed
,
1917 bool has_granularity
, uint32_t granularity
,
1918 bool has_buf_size
, int64_t buf_size
,
1919 bool has_on_source_error
, BlockdevOnError on_source_error
,
1920 bool has_on_target_error
, BlockdevOnError on_target_error
,
1923 BlockDriverState
*bs
;
1924 BlockDriverState
*source
, *target_bs
;
1925 BlockDriver
*drv
= NULL
;
1926 Error
*local_err
= NULL
;
1934 if (!has_on_source_error
) {
1935 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1937 if (!has_on_target_error
) {
1938 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1941 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1943 if (!has_granularity
) {
1946 if (!has_buf_size
) {
1947 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1950 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
1951 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1954 if (granularity
& (granularity
- 1)) {
1955 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1959 bs
= bdrv_find(device
);
1961 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1965 if (!bdrv_is_inserted(bs
)) {
1966 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1971 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1974 drv
= bdrv_find_format(format
);
1976 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1981 if (bdrv_in_use(bs
)) {
1982 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1986 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1987 source
= bs
->backing_hd
;
1988 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
1989 sync
= MIRROR_SYNC_MODE_FULL
;
1992 size
= bdrv_getlength(bs
);
1994 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1998 if (sync
== MIRROR_SYNC_MODE_FULL
&& mode
!= NEW_IMAGE_MODE_EXISTING
) {
1999 /* create new image w/o backing file */
2000 assert(format
&& drv
);
2001 bdrv_img_create(target
, format
,
2002 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
2005 case NEW_IMAGE_MODE_EXISTING
:
2007 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
2008 /* create new image with backing file */
2009 bdrv_img_create(target
, format
,
2011 source
->drv
->format_name
,
2012 NULL
, size
, flags
, &local_err
, false);
2019 if (error_is_set(&local_err
)) {
2020 error_propagate(errp
, local_err
);
2024 /* Mirroring takes care of copy-on-write using the source's backing
2027 target_bs
= bdrv_new("");
2028 ret
= bdrv_open(target_bs
, target
, NULL
, flags
| BDRV_O_NO_BACKING
, drv
,
2031 bdrv_unref(target_bs
);
2032 error_propagate(errp
, local_err
);
2036 mirror_start(bs
, target_bs
, speed
, granularity
, buf_size
, sync
,
2037 on_source_error
, on_target_error
,
2038 block_job_cb
, bs
, &local_err
);
2039 if (local_err
!= NULL
) {
2040 bdrv_unref(target_bs
);
2041 error_propagate(errp
, local_err
);
2046 static BlockJob
*find_block_job(const char *device
)
2048 BlockDriverState
*bs
;
2050 bs
= bdrv_find(device
);
2051 if (!bs
|| !bs
->job
) {
2057 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
2059 BlockJob
*job
= find_block_job(device
);
2062 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2066 block_job_set_speed(job
, speed
, errp
);
2069 void qmp_block_job_cancel(const char *device
,
2070 bool has_force
, bool force
, Error
**errp
)
2072 BlockJob
*job
= find_block_job(device
);
2079 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2082 if (job
->paused
&& !force
) {
2083 error_set(errp
, QERR_BLOCK_JOB_PAUSED
, device
);
2087 trace_qmp_block_job_cancel(job
);
2088 block_job_cancel(job
);
2091 void qmp_block_job_pause(const char *device
, Error
**errp
)
2093 BlockJob
*job
= find_block_job(device
);
2096 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2100 trace_qmp_block_job_pause(job
);
2101 block_job_pause(job
);
2104 void qmp_block_job_resume(const char *device
, Error
**errp
)
2106 BlockJob
*job
= find_block_job(device
);
2109 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2113 trace_qmp_block_job_resume(job
);
2114 block_job_resume(job
);
2117 void qmp_block_job_complete(const char *device
, Error
**errp
)
2119 BlockJob
*job
= find_block_job(device
);
2122 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
2126 trace_qmp_block_job_complete(job
);
2127 block_job_complete(job
, errp
);
2130 void qmp_blockdev_add(BlockdevOptions
*options
, Error
**errp
)
2132 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2136 Error
*local_err
= NULL
;
2138 /* Require an ID in the top level */
2139 if (!options
->has_id
) {
2140 error_setg(errp
, "Block device needs an ID");
2144 /* TODO Sort it out in raw-posix and drive_init: Reject aio=native with
2145 * cache.direct=false instead of silently switching to aio=threads, except
2146 * if called from drive_init.
2148 * For now, simply forbidding the combination for all drivers will do. */
2149 if (options
->has_aio
&& options
->aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
) {
2150 bool direct
= options
->cache
->has_direct
&& options
->cache
->direct
;
2151 if (!options
->has_cache
&& !direct
) {
2152 error_setg(errp
, "aio=native requires cache.direct=true");
2157 visit_type_BlockdevOptions(qmp_output_get_visitor(ov
),
2158 &options
, NULL
, &local_err
);
2159 if (error_is_set(&local_err
)) {
2160 error_propagate(errp
, local_err
);
2164 obj
= qmp_output_get_qobject(ov
);
2165 qdict
= qobject_to_qdict(obj
);
2167 qdict_flatten(qdict
);
2169 dinfo
= blockdev_init(qdict
, IF_NONE
);
2171 error_setg(errp
, "Could not open image");
2176 qmp_output_visitor_cleanup(ov
);
2179 static void do_qmp_query_block_jobs_one(void *opaque
, BlockDriverState
*bs
)
2181 BlockJobInfoList
**prev
= opaque
;
2182 BlockJob
*job
= bs
->job
;
2185 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
2186 elem
->value
= block_job_query(bs
->job
);
2187 (*prev
)->next
= elem
;
2192 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
2194 /* Dummy is a fake list element for holding the head pointer */
2195 BlockJobInfoList dummy
= {};
2196 BlockJobInfoList
*prev
= &dummy
;
2197 bdrv_iterate(do_qmp_query_block_jobs_one
, &prev
);
2201 QemuOptsList qemu_common_drive_opts
= {
2203 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
2207 .type
= QEMU_OPT_BOOL
,
2208 .help
= "enable/disable snapshot mode",
2211 .type
= QEMU_OPT_STRING
,
2212 .help
= "disk image",
2215 .type
= QEMU_OPT_STRING
,
2216 .help
= "discard operation (ignore/off, unmap/on)",
2218 .name
= "cache.writeback",
2219 .type
= QEMU_OPT_BOOL
,
2220 .help
= "enables writeback mode for any caches",
2222 .name
= "cache.direct",
2223 .type
= QEMU_OPT_BOOL
,
2224 .help
= "enables use of O_DIRECT (bypass the host page cache)",
2226 .name
= "cache.no-flush",
2227 .type
= QEMU_OPT_BOOL
,
2228 .help
= "ignore any flush requests for the device",
2231 .type
= QEMU_OPT_STRING
,
2232 .help
= "host AIO implementation (threads, native)",
2235 .type
= QEMU_OPT_STRING
,
2236 .help
= "disk format (raw, qcow2, ...)",
2239 .type
= QEMU_OPT_STRING
,
2240 .help
= "disk serial number",
2243 .type
= QEMU_OPT_STRING
,
2244 .help
= "read error action",
2247 .type
= QEMU_OPT_STRING
,
2248 .help
= "write error action",
2250 .name
= "read-only",
2251 .type
= QEMU_OPT_BOOL
,
2252 .help
= "open drive file as read-only",
2254 .name
= "throttling.iops-total",
2255 .type
= QEMU_OPT_NUMBER
,
2256 .help
= "limit total I/O operations per second",
2258 .name
= "throttling.iops-read",
2259 .type
= QEMU_OPT_NUMBER
,
2260 .help
= "limit read operations per second",
2262 .name
= "throttling.iops-write",
2263 .type
= QEMU_OPT_NUMBER
,
2264 .help
= "limit write operations per second",
2266 .name
= "throttling.bps-total",
2267 .type
= QEMU_OPT_NUMBER
,
2268 .help
= "limit total bytes per second",
2270 .name
= "throttling.bps-read",
2271 .type
= QEMU_OPT_NUMBER
,
2272 .help
= "limit read bytes per second",
2274 .name
= "throttling.bps-write",
2275 .type
= QEMU_OPT_NUMBER
,
2276 .help
= "limit write bytes per second",
2278 .name
= "throttling.iops-total-max",
2279 .type
= QEMU_OPT_NUMBER
,
2280 .help
= "I/O operations burst",
2282 .name
= "throttling.iops-read-max",
2283 .type
= QEMU_OPT_NUMBER
,
2284 .help
= "I/O operations read burst",
2286 .name
= "throttling.iops-write-max",
2287 .type
= QEMU_OPT_NUMBER
,
2288 .help
= "I/O operations write burst",
2290 .name
= "throttling.bps-total-max",
2291 .type
= QEMU_OPT_NUMBER
,
2292 .help
= "total bytes burst",
2294 .name
= "throttling.bps-read-max",
2295 .type
= QEMU_OPT_NUMBER
,
2296 .help
= "total bytes read burst",
2298 .name
= "throttling.bps-write-max",
2299 .type
= QEMU_OPT_NUMBER
,
2300 .help
= "total bytes write burst",
2302 .name
= "throttling.iops-size",
2303 .type
= QEMU_OPT_NUMBER
,
2304 .help
= "when limiting by iops max size of an I/O in bytes",
2306 .name
= "copy-on-read",
2307 .type
= QEMU_OPT_BOOL
,
2308 .help
= "copy read data from backing file into image file",
2310 { /* end of list */ }
2314 QemuOptsList qemu_drive_opts
= {
2316 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
2319 * no elements => accept any params
2320 * validation will happen later
2322 { /* end of list */ }