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 "sysemu/sysemu.h"
42 #include "block/block_int.h"
43 #include "qmp-commands.h"
45 #include "sysemu/arch_init.h"
47 static QTAILQ_HEAD(drivelist
, DriveInfo
) drives
= QTAILQ_HEAD_INITIALIZER(drives
);
48 extern QemuOptsList qemu_common_drive_opts
;
49 extern QemuOptsList qemu_old_drive_opts
;
51 static const char *const if_name
[IF_COUNT
] = {
55 [IF_FLOPPY
] = "floppy",
56 [IF_PFLASH
] = "pflash",
59 [IF_VIRTIO
] = "virtio",
63 static const int if_max_devs
[IF_COUNT
] = {
65 * Do not change these numbers! They govern how drive option
66 * index maps to unit and bus. That mapping is ABI.
68 * All controllers used to imlement if=T drives need to support
69 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
70 * Otherwise, some index values map to "impossible" bus, unit
73 * For instance, if you change [IF_SCSI] to 255, -drive
74 * if=scsi,index=12 no longer means bus=1,unit=5, but
75 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
76 * the drive can't be set up. Regression.
83 * We automatically delete the drive when a device using it gets
84 * unplugged. Questionable feature, but we can't just drop it.
85 * Device models call blockdev_mark_auto_del() to schedule the
86 * automatic deletion, and generic qdev code calls blockdev_auto_del()
87 * when deletion is actually safe.
89 void blockdev_mark_auto_del(BlockDriverState
*bs
)
91 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
94 block_job_cancel(bs
->job
);
101 void blockdev_auto_del(BlockDriverState
*bs
)
103 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
105 if (dinfo
&& dinfo
->auto_del
) {
106 drive_put_ref(dinfo
);
110 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
112 int max_devs
= if_max_devs
[type
];
113 return max_devs
? index
/ max_devs
: 0;
116 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
118 int max_devs
= if_max_devs
[type
];
119 return max_devs
? index
% max_devs
: index
;
122 QemuOpts
*drive_def(const char *optstr
)
124 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
127 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
133 opts
= drive_def(optstr
);
137 if (type
!= IF_DEFAULT
) {
138 qemu_opt_set(opts
, "if", if_name
[type
]);
141 snprintf(buf
, sizeof(buf
), "%d", index
);
142 qemu_opt_set(opts
, "index", buf
);
145 qemu_opt_set(opts
, "file", file
);
149 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
153 /* seek interface, bus and unit */
155 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
156 if (dinfo
->type
== type
&&
165 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
167 return drive_get(type
,
168 drive_index_to_bus_id(type
, index
),
169 drive_index_to_unit_id(type
, index
));
172 int drive_get_max_bus(BlockInterfaceType type
)
178 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
179 if(dinfo
->type
== type
&&
180 dinfo
->bus
> max_bus
)
181 max_bus
= dinfo
->bus
;
186 /* Get a block device. This should only be used for single-drive devices
187 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
189 DriveInfo
*drive_get_next(BlockInterfaceType type
)
191 static int next_block_unit
[IF_COUNT
];
193 return drive_get(type
, 0, next_block_unit
[type
]++);
196 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
200 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
201 if (dinfo
->bdrv
== bs
) {
208 static void bdrv_format_print(void *opaque
, const char *name
)
210 error_printf(" %s", name
);
213 static void drive_uninit(DriveInfo
*dinfo
)
215 qemu_opts_del(dinfo
->opts
);
216 bdrv_delete(dinfo
->bdrv
);
218 QTAILQ_REMOVE(&drives
, dinfo
, next
);
219 g_free(dinfo
->serial
);
223 void drive_put_ref(DriveInfo
*dinfo
)
225 assert(dinfo
->refcount
);
226 if (--dinfo
->refcount
== 0) {
231 void drive_get_ref(DriveInfo
*dinfo
)
241 static void drive_put_ref_bh(void *opaque
)
243 DrivePutRefBH
*s
= opaque
;
245 drive_put_ref(s
->dinfo
);
246 qemu_bh_delete(s
->bh
);
251 * Release a drive reference in a BH
253 * It is not possible to use drive_put_ref() from a callback function when the
254 * callers still need the drive. In such cases we schedule a BH to release the
257 static void drive_put_ref_bh_schedule(DriveInfo
*dinfo
)
261 s
= g_new(DrivePutRefBH
, 1);
262 s
->bh
= qemu_bh_new(drive_put_ref_bh
, s
);
264 qemu_bh_schedule(s
->bh
);
267 static int parse_block_error_action(const char *buf
, bool is_read
)
269 if (!strcmp(buf
, "ignore")) {
270 return BLOCKDEV_ON_ERROR_IGNORE
;
271 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
272 return BLOCKDEV_ON_ERROR_ENOSPC
;
273 } else if (!strcmp(buf
, "stop")) {
274 return BLOCKDEV_ON_ERROR_STOP
;
275 } else if (!strcmp(buf
, "report")) {
276 return BLOCKDEV_ON_ERROR_REPORT
;
278 error_report("'%s' invalid %s error action",
279 buf
, is_read
? "read" : "write");
284 static bool do_check_io_limits(BlockIOLimit
*io_limits
, Error
**errp
)
291 bps_flag
= (io_limits
->bps
[BLOCK_IO_LIMIT_TOTAL
] != 0)
292 && ((io_limits
->bps
[BLOCK_IO_LIMIT_READ
] != 0)
293 || (io_limits
->bps
[BLOCK_IO_LIMIT_WRITE
] != 0));
294 iops_flag
= (io_limits
->iops
[BLOCK_IO_LIMIT_TOTAL
] != 0)
295 && ((io_limits
->iops
[BLOCK_IO_LIMIT_READ
] != 0)
296 || (io_limits
->iops
[BLOCK_IO_LIMIT_WRITE
] != 0));
297 if (bps_flag
|| iops_flag
) {
298 error_setg(errp
, "bps(iops) and bps_rd/bps_wr(iops_rd/iops_wr) "
299 "cannot be used at the same time");
303 if (io_limits
->bps
[BLOCK_IO_LIMIT_TOTAL
] < 0 ||
304 io_limits
->bps
[BLOCK_IO_LIMIT_WRITE
] < 0 ||
305 io_limits
->bps
[BLOCK_IO_LIMIT_READ
] < 0 ||
306 io_limits
->iops
[BLOCK_IO_LIMIT_TOTAL
] < 0 ||
307 io_limits
->iops
[BLOCK_IO_LIMIT_WRITE
] < 0 ||
308 io_limits
->iops
[BLOCK_IO_LIMIT_READ
] < 0) {
309 error_setg(errp
, "bps and iops values must be 0 or greater");
316 static DriveInfo
*blockdev_init(QemuOpts
*all_opts
,
317 BlockInterfaceType block_default_type
)
320 const char *file
= NULL
;
322 const char *mediastr
= "";
323 BlockInterfaceType type
;
324 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
326 int cyls
, heads
, secs
, translation
;
331 int on_read_error
, on_write_error
;
334 BlockIOLimit io_limits
;
342 bool has_driver_specific_opts
;
343 BlockDriver
*drv
= NULL
;
345 translation
= BIOS_ATA_TRANSLATION_AUTO
;
348 /* Check common options by copying from all_opts to opts, all other options
349 * are stored in bs_opts. */
350 id
= qemu_opts_id(all_opts
);
351 opts
= qemu_opts_create(&qemu_common_drive_opts
, id
, 1, &error
);
352 if (error_is_set(&error
)) {
353 qerror_report_err(error
);
358 bs_opts
= qdict_new();
359 qemu_opts_to_qdict(all_opts
, bs_opts
);
360 qemu_opts_absorb_qdict(opts
, bs_opts
, &error
);
361 if (error_is_set(&error
)) {
362 qerror_report_err(error
);
368 qdict_del(bs_opts
, "id");
371 has_driver_specific_opts
= !!qdict_size(bs_opts
);
373 /* extract parameters */
374 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
375 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
376 index
= qemu_opt_get_number(opts
, "index", -1);
378 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
379 heads
= qemu_opt_get_number(opts
, "heads", 0);
380 secs
= qemu_opt_get_number(opts
, "secs", 0);
382 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
383 ro
= qemu_opt_get_bool(opts
, "read-only", 0);
384 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
386 file
= qemu_opt_get(opts
, "file");
387 serial
= qemu_opt_get(opts
, "serial");
389 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
390 for (type
= 0; type
< IF_COUNT
&& strcmp(buf
, if_name
[type
]); type
++)
392 if (type
== IF_COUNT
) {
393 error_report("unsupported bus type '%s'", buf
);
397 type
= block_default_type
;
400 max_devs
= if_max_devs
[type
];
402 if (cyls
|| heads
|| secs
) {
404 error_report("invalid physical cyls number");
408 error_report("invalid physical heads number");
412 error_report("invalid physical secs number");
417 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
419 error_report("'%s' trans must be used with cyls, heads and secs",
423 if (!strcmp(buf
, "none"))
424 translation
= BIOS_ATA_TRANSLATION_NONE
;
425 else if (!strcmp(buf
, "lba"))
426 translation
= BIOS_ATA_TRANSLATION_LBA
;
427 else if (!strcmp(buf
, "auto"))
428 translation
= BIOS_ATA_TRANSLATION_AUTO
;
430 error_report("'%s' invalid translation type", buf
);
435 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
436 if (!strcmp(buf
, "disk")) {
438 } else if (!strcmp(buf
, "cdrom")) {
439 if (cyls
|| secs
|| heads
) {
440 error_report("CHS can't be set with media=%s", buf
);
445 error_report("'%s' invalid media", buf
);
450 if ((buf
= qemu_opt_get(opts
, "discard")) != NULL
) {
451 if (bdrv_parse_discard_flags(buf
, &bdrv_flags
) != 0) {
452 error_report("invalid discard option");
458 if (qemu_opt_get_bool(opts
, "cache.writeback", true)) {
459 bdrv_flags
|= BDRV_O_CACHE_WB
;
461 if (qemu_opt_get_bool(opts
, "cache.direct", false)) {
462 bdrv_flags
|= BDRV_O_NOCACHE
;
464 if (qemu_opt_get_bool(opts
, "cache.no-flush", true)) {
465 bdrv_flags
|= BDRV_O_NO_FLUSH
;
468 #ifdef CONFIG_LINUX_AIO
469 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
470 if (!strcmp(buf
, "native")) {
471 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
472 } else if (!strcmp(buf
, "threads")) {
473 /* this is the default */
475 error_report("invalid aio option");
481 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
482 if (is_help_option(buf
)) {
483 error_printf("Supported formats:");
484 bdrv_iterate_format(bdrv_format_print
, NULL
);
489 drv
= bdrv_find_whitelisted_format(buf
, ro
);
491 error_report("'%s' invalid format", buf
);
496 /* disk I/O throttling */
497 io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
] =
498 qemu_opt_get_number(opts
, "throttling.bps-total", 0);
499 io_limits
.bps
[BLOCK_IO_LIMIT_READ
] =
500 qemu_opt_get_number(opts
, "throttling.bps-read", 0);
501 io_limits
.bps
[BLOCK_IO_LIMIT_WRITE
] =
502 qemu_opt_get_number(opts
, "throttling.bps-write", 0);
503 io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
] =
504 qemu_opt_get_number(opts
, "throttling.iops-total", 0);
505 io_limits
.iops
[BLOCK_IO_LIMIT_READ
] =
506 qemu_opt_get_number(opts
, "throttling.iops-read", 0);
507 io_limits
.iops
[BLOCK_IO_LIMIT_WRITE
] =
508 qemu_opt_get_number(opts
, "throttling.iops-write", 0);
510 if (!do_check_io_limits(&io_limits
, &error
)) {
511 error_report("%s", error_get_pretty(error
));
516 if (qemu_opt_get(opts
, "boot") != NULL
) {
517 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
518 "ignored. Future versions will reject this parameter. Please "
519 "update your scripts.\n");
522 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
523 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
524 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
525 error_report("werror is not supported by this bus type");
529 on_write_error
= parse_block_error_action(buf
, 0);
530 if (on_write_error
< 0) {
535 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
536 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
537 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
538 error_report("rerror is not supported by this bus type");
542 on_read_error
= parse_block_error_action(buf
, 1);
543 if (on_read_error
< 0) {
548 if ((devaddr
= qemu_opt_get(opts
, "addr")) != NULL
) {
549 if (type
!= IF_VIRTIO
) {
550 error_report("addr is not supported by this bus type");
555 /* compute bus and unit according index */
558 if (bus_id
!= 0 || unit_id
!= -1) {
559 error_report("index cannot be used with bus and unit");
562 bus_id
= drive_index_to_bus_id(type
, index
);
563 unit_id
= drive_index_to_unit_id(type
, index
);
566 /* if user doesn't specify a unit_id,
567 * try to find the first free
572 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
574 if (max_devs
&& unit_id
>= max_devs
) {
583 if (max_devs
&& unit_id
>= max_devs
) {
584 error_report("unit %d too big (max is %d)",
585 unit_id
, max_devs
- 1);
590 * catch multiple definitions
593 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
594 error_report("drive with bus=%d, unit=%d (index=%d) exists",
595 bus_id
, unit_id
, index
);
601 dinfo
= g_malloc0(sizeof(*dinfo
));
602 if ((buf
= qemu_opts_id(opts
)) != NULL
) {
603 dinfo
->id
= g_strdup(buf
);
605 /* no id supplied -> create one */
606 dinfo
->id
= g_malloc0(32);
607 if (type
== IF_IDE
|| type
== IF_SCSI
)
608 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
610 snprintf(dinfo
->id
, 32, "%s%i%s%i",
611 if_name
[type
], bus_id
, mediastr
, unit_id
);
613 snprintf(dinfo
->id
, 32, "%s%s%i",
614 if_name
[type
], mediastr
, unit_id
);
616 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
617 dinfo
->bdrv
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
618 dinfo
->bdrv
->read_only
= ro
;
619 dinfo
->devaddr
= devaddr
;
622 dinfo
->unit
= unit_id
;
624 dinfo
->heads
= heads
;
626 dinfo
->trans
= translation
;
627 dinfo
->opts
= all_opts
;
629 if (serial
!= NULL
) {
630 dinfo
->serial
= g_strdup(serial
);
632 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
634 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
636 /* disk I/O throttling */
637 bdrv_set_io_limits(dinfo
->bdrv
, &io_limits
);
644 dinfo
->media_cd
= media
== MEDIA_CDROM
;
653 /* add virtio block device */
655 devopts
= qemu_opts_create_nofail(qemu_find_opts("device"));
656 if (arch_type
== QEMU_ARCH_S390X
) {
657 qemu_opt_set(devopts
, "driver", "virtio-blk-s390");
659 qemu_opt_set(devopts
, "driver", "virtio-blk-pci");
661 qemu_opt_set(devopts
, "drive", dinfo
->id
);
663 qemu_opt_set(devopts
, "addr", devaddr
);
669 if (!file
|| !*file
) {
670 if (has_driver_specific_opts
) {
677 /* always use cache=unsafe with snapshot */
678 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
679 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
683 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
686 if (runstate_check(RUN_STATE_INMIGRATE
)) {
687 bdrv_flags
|= BDRV_O_INCOMING
;
690 if (media
== MEDIA_CDROM
) {
691 /* CDROM is fine for any interface, don't check. */
693 } else if (ro
== 1) {
694 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&&
695 type
!= IF_NONE
&& type
!= IF_PFLASH
) {
696 error_report("read-only not supported by this bus type");
701 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
703 if (ro
&& copy_on_read
) {
704 error_report("warning: disabling copy_on_read on read-only drive");
708 ret
= bdrv_open(dinfo
->bdrv
, file
, bs_opts
, bdrv_flags
, drv
);
711 if (ret
== -EMEDIUMTYPE
) {
712 error_report("could not open disk image %s: not in %s format",
713 file
?: dinfo
->id
, drv
? drv
->format_name
:
714 qdict_get_str(bs_opts
, "driver"));
716 error_report("could not open disk image %s: %s",
717 file
?: dinfo
->id
, strerror(-ret
));
722 if (bdrv_key_required(dinfo
->bdrv
))
733 bdrv_delete(dinfo
->bdrv
);
735 QTAILQ_REMOVE(&drives
, dinfo
, next
);
740 static void qemu_opt_rename(QemuOpts
*opts
, const char *from
, const char *to
)
744 value
= qemu_opt_get(opts
, from
);
746 qemu_opt_set(opts
, to
, value
);
747 qemu_opt_unset(opts
, from
);
751 DriveInfo
*drive_init(QemuOpts
*all_opts
, BlockInterfaceType block_default_type
)
756 * Check that only old options are used by copying into a QemuOpts with
757 * stricter checks. Going through a QDict seems to be the easiest way to
760 QemuOpts
* check_opts
;
762 Error
*local_err
= NULL
;
764 qdict
= qemu_opts_to_qdict(all_opts
, NULL
);
765 check_opts
= qemu_opts_from_qdict(&qemu_old_drive_opts
, qdict
, &local_err
);
768 if (error_is_set(&local_err
)) {
769 qerror_report_err(local_err
);
770 error_free(local_err
);
773 qemu_opts_del(check_opts
);
775 /* Change legacy command line options into QMP ones */
776 qemu_opt_rename(all_opts
, "iops", "throttling.iops-total");
777 qemu_opt_rename(all_opts
, "iops_rd", "throttling.iops-read");
778 qemu_opt_rename(all_opts
, "iops_wr", "throttling.iops-write");
780 qemu_opt_rename(all_opts
, "bps", "throttling.bps-total");
781 qemu_opt_rename(all_opts
, "bps_rd", "throttling.bps-read");
782 qemu_opt_rename(all_opts
, "bps_wr", "throttling.bps-write");
784 qemu_opt_rename(all_opts
, "readonly", "read-only");
786 value
= qemu_opt_get(all_opts
, "cache");
790 if (bdrv_parse_cache_flags(value
, &flags
) != 0) {
791 error_report("invalid cache option");
795 /* Specific options take precedence */
796 if (!qemu_opt_get(all_opts
, "cache.writeback")) {
797 qemu_opt_set_bool(all_opts
, "cache.writeback",
798 !!(flags
& BDRV_O_CACHE_WB
));
800 if (!qemu_opt_get(all_opts
, "cache.direct")) {
801 qemu_opt_set_bool(all_opts
, "cache.direct",
802 !!(flags
& BDRV_O_NOCACHE
));
804 if (!qemu_opt_get(all_opts
, "cache.no-flush")) {
805 qemu_opt_set_bool(all_opts
, "cache.no-flush",
806 !!(flags
& BDRV_O_NO_FLUSH
));
808 qemu_opt_unset(all_opts
, "cache");
811 return blockdev_init(all_opts
, block_default_type
);
814 void do_commit(Monitor
*mon
, const QDict
*qdict
)
816 const char *device
= qdict_get_str(qdict
, "device");
817 BlockDriverState
*bs
;
820 if (!strcmp(device
, "all")) {
821 ret
= bdrv_commit_all();
823 bs
= bdrv_find(device
);
825 monitor_printf(mon
, "Device '%s' not found\n", device
);
828 ret
= bdrv_commit(bs
);
831 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
836 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
838 TransactionAction action
;
839 TransactionActionList list
;
843 list
.value
= &action
;
845 qmp_transaction(&list
, errp
);
848 void qmp_blockdev_snapshot_sync(const char *device
, const char *snapshot_file
,
849 bool has_format
, const char *format
,
850 bool has_mode
, enum NewImageMode mode
,
853 BlockdevSnapshot snapshot
= {
854 .device
= (char *) device
,
855 .snapshot_file
= (char *) snapshot_file
,
856 .has_format
= has_format
,
857 .format
= (char *) format
,
858 .has_mode
= has_mode
,
861 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
,
866 /* New and old BlockDriverState structs for group snapshots */
868 typedef struct BlkTransactionState BlkTransactionState
;
870 /* Only prepare() may fail. In a single transaction, only one of commit() or
871 abort() will be called, clean() will always be called if it present. */
872 typedef struct BdrvActionOps
{
873 /* Size of state struct, in bytes. */
874 size_t instance_size
;
875 /* Prepare the work, must NOT be NULL. */
876 void (*prepare
)(BlkTransactionState
*common
, Error
**errp
);
877 /* Commit the changes, can be NULL. */
878 void (*commit
)(BlkTransactionState
*common
);
879 /* Abort the changes on fail, can be NULL. */
880 void (*abort
)(BlkTransactionState
*common
);
881 /* Clean up resource in the end, can be NULL. */
882 void (*clean
)(BlkTransactionState
*common
);
886 * This structure must be arranged as first member in child type, assuming
887 * that compiler will also arrange it to the same address with parent instance.
888 * Later it will be used in free().
890 struct BlkTransactionState
{
891 TransactionAction
*action
;
892 const BdrvActionOps
*ops
;
893 QSIMPLEQ_ENTRY(BlkTransactionState
) entry
;
896 /* external snapshot private data */
897 typedef struct ExternalSnapshotState
{
898 BlkTransactionState common
;
899 BlockDriverState
*old_bs
;
900 BlockDriverState
*new_bs
;
901 } ExternalSnapshotState
;
903 static void external_snapshot_prepare(BlkTransactionState
*common
,
908 Error
*local_err
= NULL
;
910 const char *new_image_file
;
911 const char *format
= "qcow2";
912 enum NewImageMode mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
913 ExternalSnapshotState
*state
=
914 DO_UPCAST(ExternalSnapshotState
, common
, common
);
915 TransactionAction
*action
= common
->action
;
918 g_assert(action
->kind
== TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
);
920 device
= action
->blockdev_snapshot_sync
->device
;
921 new_image_file
= action
->blockdev_snapshot_sync
->snapshot_file
;
922 if (action
->blockdev_snapshot_sync
->has_format
) {
923 format
= action
->blockdev_snapshot_sync
->format
;
925 if (action
->blockdev_snapshot_sync
->has_mode
) {
926 mode
= action
->blockdev_snapshot_sync
->mode
;
929 /* start processing */
930 drv
= bdrv_find_format(format
);
932 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
936 state
->old_bs
= bdrv_find(device
);
937 if (!state
->old_bs
) {
938 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
942 if (!bdrv_is_inserted(state
->old_bs
)) {
943 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
947 if (bdrv_in_use(state
->old_bs
)) {
948 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
952 if (!bdrv_is_read_only(state
->old_bs
)) {
953 if (bdrv_flush(state
->old_bs
)) {
954 error_set(errp
, QERR_IO_ERROR
);
959 flags
= state
->old_bs
->open_flags
;
961 /* create new image w/backing file */
962 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
963 bdrv_img_create(new_image_file
, format
,
964 state
->old_bs
->filename
,
965 state
->old_bs
->drv
->format_name
,
966 NULL
, -1, flags
, &local_err
, false);
967 if (error_is_set(&local_err
)) {
968 error_propagate(errp
, local_err
);
973 /* We will manually add the backing_hd field to the bs later */
974 state
->new_bs
= bdrv_new("");
975 /* TODO Inherit bs->options or only take explicit options with an
976 * extended QMP command? */
977 ret
= bdrv_open(state
->new_bs
, new_image_file
, NULL
,
978 flags
| BDRV_O_NO_BACKING
, drv
);
980 error_setg_file_open(errp
, -ret
, new_image_file
);
984 static void external_snapshot_commit(BlkTransactionState
*common
)
986 ExternalSnapshotState
*state
=
987 DO_UPCAST(ExternalSnapshotState
, common
, common
);
989 /* This removes our old bs and adds the new bs */
990 bdrv_append(state
->new_bs
, state
->old_bs
);
991 /* We don't need (or want) to use the transactional
992 * bdrv_reopen_multiple() across all the entries at once, because we
993 * don't want to abort all of them if one of them fails the reopen */
994 bdrv_reopen(state
->new_bs
, state
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
998 static void external_snapshot_abort(BlkTransactionState
*common
)
1000 ExternalSnapshotState
*state
=
1001 DO_UPCAST(ExternalSnapshotState
, common
, common
);
1002 if (state
->new_bs
) {
1003 bdrv_delete(state
->new_bs
);
1007 typedef struct DriveBackupState
{
1008 BlkTransactionState common
;
1009 BlockDriverState
*bs
;
1013 static void drive_backup_prepare(BlkTransactionState
*common
, Error
**errp
)
1015 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1016 DriveBackup
*backup
;
1017 Error
*local_err
= NULL
;
1019 assert(common
->action
->kind
== TRANSACTION_ACTION_KIND_DRIVE_BACKUP
);
1020 backup
= common
->action
->drive_backup
;
1022 qmp_drive_backup(backup
->device
, backup
->target
,
1023 backup
->has_format
, backup
->format
,
1025 backup
->has_mode
, backup
->mode
,
1026 backup
->has_speed
, backup
->speed
,
1027 backup
->has_on_source_error
, backup
->on_source_error
,
1028 backup
->has_on_target_error
, backup
->on_target_error
,
1030 if (error_is_set(&local_err
)) {
1031 error_propagate(errp
, local_err
);
1037 state
->bs
= bdrv_find(backup
->device
);
1038 state
->job
= state
->bs
->job
;
1041 static void drive_backup_abort(BlkTransactionState
*common
)
1043 DriveBackupState
*state
= DO_UPCAST(DriveBackupState
, common
, common
);
1044 BlockDriverState
*bs
= state
->bs
;
1046 /* Only cancel if it's the job we started */
1047 if (bs
&& bs
->job
&& bs
->job
== state
->job
) {
1048 block_job_cancel_sync(bs
->job
);
1052 static void abort_prepare(BlkTransactionState
*common
, Error
**errp
)
1054 error_setg(errp
, "Transaction aborted using Abort action");
1057 static void abort_commit(BlkTransactionState
*common
)
1059 g_assert_not_reached(); /* this action never succeeds */
1062 static const BdrvActionOps actions
[] = {
1063 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
] = {
1064 .instance_size
= sizeof(ExternalSnapshotState
),
1065 .prepare
= external_snapshot_prepare
,
1066 .commit
= external_snapshot_commit
,
1067 .abort
= external_snapshot_abort
,
1069 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP
] = {
1070 .instance_size
= sizeof(DriveBackupState
),
1071 .prepare
= drive_backup_prepare
,
1072 .abort
= drive_backup_abort
,
1074 [TRANSACTION_ACTION_KIND_ABORT
] = {
1075 .instance_size
= sizeof(BlkTransactionState
),
1076 .prepare
= abort_prepare
,
1077 .commit
= abort_commit
,
1082 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1083 * then we do not pivot any of the devices in the group, and abandon the
1086 void qmp_transaction(TransactionActionList
*dev_list
, Error
**errp
)
1088 TransactionActionList
*dev_entry
= dev_list
;
1089 BlkTransactionState
*state
, *next
;
1090 Error
*local_err
= NULL
;
1092 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionState
) snap_bdrv_states
;
1093 QSIMPLEQ_INIT(&snap_bdrv_states
);
1095 /* drain all i/o before any snapshots */
1098 /* We don't do anything in this loop that commits us to the snapshot */
1099 while (NULL
!= dev_entry
) {
1100 TransactionAction
*dev_info
= NULL
;
1101 const BdrvActionOps
*ops
;
1103 dev_info
= dev_entry
->value
;
1104 dev_entry
= dev_entry
->next
;
1106 assert(dev_info
->kind
< ARRAY_SIZE(actions
));
1108 ops
= &actions
[dev_info
->kind
];
1109 state
= g_malloc0(ops
->instance_size
);
1111 state
->action
= dev_info
;
1112 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, state
, entry
);
1114 state
->ops
->prepare(state
, &local_err
);
1115 if (error_is_set(&local_err
)) {
1116 error_propagate(errp
, local_err
);
1117 goto delete_and_fail
;
1121 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1122 if (state
->ops
->commit
) {
1123 state
->ops
->commit(state
);
1132 * failure, and it is all-or-none; abandon each new bs, and keep using
1133 * the original bs for all images
1135 QSIMPLEQ_FOREACH(state
, &snap_bdrv_states
, entry
) {
1136 if (state
->ops
->abort
) {
1137 state
->ops
->abort(state
);
1141 QSIMPLEQ_FOREACH_SAFE(state
, &snap_bdrv_states
, entry
, next
) {
1142 if (state
->ops
->clean
) {
1143 state
->ops
->clean(state
);
1150 static void eject_device(BlockDriverState
*bs
, int force
, Error
**errp
)
1152 if (bdrv_in_use(bs
)) {
1153 error_set(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
1156 if (!bdrv_dev_has_removable_media(bs
)) {
1157 error_set(errp
, QERR_DEVICE_NOT_REMOVABLE
, bdrv_get_device_name(bs
));
1161 if (bdrv_dev_is_medium_locked(bs
) && !bdrv_dev_is_tray_open(bs
)) {
1162 bdrv_dev_eject_request(bs
, force
);
1164 error_set(errp
, QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
1172 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
1174 BlockDriverState
*bs
;
1176 bs
= bdrv_find(device
);
1178 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1182 eject_device(bs
, force
, errp
);
1185 void qmp_block_passwd(const char *device
, const char *password
, Error
**errp
)
1187 BlockDriverState
*bs
;
1190 bs
= bdrv_find(device
);
1192 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1196 err
= bdrv_set_key(bs
, password
);
1197 if (err
== -EINVAL
) {
1198 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1200 } else if (err
< 0) {
1201 error_set(errp
, QERR_INVALID_PASSWORD
);
1206 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
1207 int bdrv_flags
, BlockDriver
*drv
,
1208 const char *password
, Error
**errp
)
1212 ret
= bdrv_open(bs
, filename
, NULL
, bdrv_flags
, drv
);
1214 error_setg_file_open(errp
, -ret
, filename
);
1218 if (bdrv_key_required(bs
)) {
1220 if (bdrv_set_key(bs
, password
) < 0) {
1221 error_set(errp
, QERR_INVALID_PASSWORD
);
1224 error_set(errp
, QERR_DEVICE_ENCRYPTED
, bdrv_get_device_name(bs
),
1225 bdrv_get_encrypted_filename(bs
));
1227 } else if (password
) {
1228 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
1232 void qmp_change_blockdev(const char *device
, const char *filename
,
1233 bool has_format
, const char *format
, Error
**errp
)
1235 BlockDriverState
*bs
;
1236 BlockDriver
*drv
= NULL
;
1240 bs
= bdrv_find(device
);
1242 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1247 drv
= bdrv_find_whitelisted_format(format
, bs
->read_only
);
1249 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1254 eject_device(bs
, 0, &err
);
1255 if (error_is_set(&err
)) {
1256 error_propagate(errp
, err
);
1260 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
1261 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
1263 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
1266 /* throttling disk I/O limits */
1267 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
1268 int64_t bps_wr
, int64_t iops
, int64_t iops_rd
,
1269 int64_t iops_wr
, Error
**errp
)
1271 BlockIOLimit io_limits
;
1272 BlockDriverState
*bs
;
1274 bs
= bdrv_find(device
);
1276 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1280 io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
] = bps
;
1281 io_limits
.bps
[BLOCK_IO_LIMIT_READ
] = bps_rd
;
1282 io_limits
.bps
[BLOCK_IO_LIMIT_WRITE
] = bps_wr
;
1283 io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
]= iops
;
1284 io_limits
.iops
[BLOCK_IO_LIMIT_READ
] = iops_rd
;
1285 io_limits
.iops
[BLOCK_IO_LIMIT_WRITE
]= iops_wr
;
1287 if (!do_check_io_limits(&io_limits
, errp
)) {
1291 bs
->io_limits
= io_limits
;
1293 if (!bs
->io_limits_enabled
&& bdrv_io_limits_enabled(bs
)) {
1294 bdrv_io_limits_enable(bs
);
1295 } else if (bs
->io_limits_enabled
&& !bdrv_io_limits_enabled(bs
)) {
1296 bdrv_io_limits_disable(bs
);
1298 if (bs
->block_timer
) {
1299 qemu_mod_timer(bs
->block_timer
, qemu_get_clock_ns(vm_clock
));
1304 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
1306 const char *id
= qdict_get_str(qdict
, "id");
1307 BlockDriverState
*bs
;
1311 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
1314 if (bdrv_in_use(bs
)) {
1315 qerror_report(QERR_DEVICE_IN_USE
, id
);
1319 /* quiesce block driver; prevent further io */
1324 /* if we have a device attached to this BlockDriverState
1325 * then we need to make the drive anonymous until the device
1326 * can be removed. If this is a drive with no device backing
1327 * then we can just get rid of the block driver state right here.
1329 if (bdrv_get_attached_dev(bs
)) {
1332 /* Further I/O must not pause the guest */
1333 bdrv_set_on_error(bs
, BLOCKDEV_ON_ERROR_REPORT
,
1334 BLOCKDEV_ON_ERROR_REPORT
);
1336 drive_uninit(drive_get_by_blockdev(bs
));
1342 void qmp_block_resize(const char *device
, int64_t size
, Error
**errp
)
1344 BlockDriverState
*bs
;
1347 bs
= bdrv_find(device
);
1349 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1354 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
1358 /* complete all in-flight operations before resizing the device */
1361 ret
= bdrv_truncate(bs
, size
);
1366 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1369 error_set(errp
, QERR_UNSUPPORTED
);
1372 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1375 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1378 error_setg_errno(errp
, -ret
, "Could not resize");
1383 static void block_job_cb(void *opaque
, int ret
)
1385 BlockDriverState
*bs
= opaque
;
1388 trace_block_job_cb(bs
, bs
->job
, ret
);
1391 obj
= qobject_from_block_job(bs
->job
);
1393 QDict
*dict
= qobject_to_qdict(obj
);
1394 qdict_put(dict
, "error", qstring_from_str(strerror(-ret
)));
1397 if (block_job_is_cancelled(bs
->job
)) {
1398 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED
, obj
);
1400 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED
, obj
);
1402 qobject_decref(obj
);
1404 drive_put_ref_bh_schedule(drive_get_by_blockdev(bs
));
1407 void qmp_block_stream(const char *device
, bool has_base
,
1408 const char *base
, bool has_speed
, int64_t speed
,
1409 bool has_on_error
, BlockdevOnError on_error
,
1412 BlockDriverState
*bs
;
1413 BlockDriverState
*base_bs
= NULL
;
1414 Error
*local_err
= NULL
;
1416 if (!has_on_error
) {
1417 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1420 bs
= bdrv_find(device
);
1422 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1427 base_bs
= bdrv_find_backing_image(bs
, base
);
1428 if (base_bs
== NULL
) {
1429 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
1434 stream_start(bs
, base_bs
, base
, has_speed
? speed
: 0,
1435 on_error
, block_job_cb
, bs
, &local_err
);
1436 if (error_is_set(&local_err
)) {
1437 error_propagate(errp
, local_err
);
1441 /* Grab a reference so hotplug does not delete the BlockDriverState from
1444 drive_get_ref(drive_get_by_blockdev(bs
));
1446 trace_qmp_block_stream(bs
, bs
->job
);
1449 void qmp_block_commit(const char *device
,
1450 bool has_base
, const char *base
, const char *top
,
1451 bool has_speed
, int64_t speed
,
1454 BlockDriverState
*bs
;
1455 BlockDriverState
*base_bs
, *top_bs
;
1456 Error
*local_err
= NULL
;
1457 /* This will be part of the QMP command, if/when the
1458 * BlockdevOnError change for blkmirror makes it in
1460 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1462 /* drain all i/o before commits */
1465 bs
= bdrv_find(device
);
1467 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1471 /* default top_bs is the active layer */
1475 if (strcmp(bs
->filename
, top
) != 0) {
1476 top_bs
= bdrv_find_backing_image(bs
, top
);
1480 if (top_bs
== NULL
) {
1481 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
1485 if (has_base
&& base
) {
1486 base_bs
= bdrv_find_backing_image(top_bs
, base
);
1488 base_bs
= bdrv_find_base(top_bs
);
1491 if (base_bs
== NULL
) {
1492 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
1496 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
1498 if (local_err
!= NULL
) {
1499 error_propagate(errp
, local_err
);
1502 /* Grab a reference so hotplug does not delete the BlockDriverState from
1505 drive_get_ref(drive_get_by_blockdev(bs
));
1508 void qmp_drive_backup(const char *device
, const char *target
,
1509 bool has_format
, const char *format
,
1510 enum MirrorSyncMode sync
,
1511 bool has_mode
, enum NewImageMode mode
,
1512 bool has_speed
, int64_t speed
,
1513 bool has_on_source_error
, BlockdevOnError on_source_error
,
1514 bool has_on_target_error
, BlockdevOnError on_target_error
,
1517 BlockDriverState
*bs
;
1518 BlockDriverState
*target_bs
;
1519 BlockDriverState
*source
= NULL
;
1520 BlockDriver
*drv
= NULL
;
1521 Error
*local_err
= NULL
;
1529 if (!has_on_source_error
) {
1530 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1532 if (!has_on_target_error
) {
1533 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1536 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1539 bs
= bdrv_find(device
);
1541 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1545 if (!bdrv_is_inserted(bs
)) {
1546 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1551 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1554 drv
= bdrv_find_format(format
);
1556 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1561 if (bdrv_in_use(bs
)) {
1562 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1566 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1568 /* See if we have a backing HD we can use to create our new image
1570 if (sync
== MIRROR_SYNC_MODE_TOP
) {
1571 source
= bs
->backing_hd
;
1573 sync
= MIRROR_SYNC_MODE_FULL
;
1576 if (sync
== MIRROR_SYNC_MODE_NONE
) {
1580 size
= bdrv_getlength(bs
);
1582 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1586 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
1587 assert(format
&& drv
);
1589 bdrv_img_create(target
, format
, source
->filename
,
1590 source
->drv
->format_name
, NULL
,
1591 size
, flags
, &local_err
, false);
1593 bdrv_img_create(target
, format
, NULL
, NULL
, NULL
,
1594 size
, flags
, &local_err
, false);
1598 if (error_is_set(&local_err
)) {
1599 error_propagate(errp
, local_err
);
1603 target_bs
= bdrv_new("");
1604 ret
= bdrv_open(target_bs
, target
, NULL
, flags
, drv
);
1606 bdrv_delete(target_bs
);
1607 error_setg_file_open(errp
, -ret
, target
);
1611 backup_start(bs
, target_bs
, speed
, sync
, on_source_error
, on_target_error
,
1612 block_job_cb
, bs
, &local_err
);
1613 if (local_err
!= NULL
) {
1614 bdrv_delete(target_bs
);
1615 error_propagate(errp
, local_err
);
1619 /* Grab a reference so hotplug does not delete the BlockDriverState from
1622 drive_get_ref(drive_get_by_blockdev(bs
));
1625 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1627 void qmp_drive_mirror(const char *device
, const char *target
,
1628 bool has_format
, const char *format
,
1629 enum MirrorSyncMode sync
,
1630 bool has_mode
, enum NewImageMode mode
,
1631 bool has_speed
, int64_t speed
,
1632 bool has_granularity
, uint32_t granularity
,
1633 bool has_buf_size
, int64_t buf_size
,
1634 bool has_on_source_error
, BlockdevOnError on_source_error
,
1635 bool has_on_target_error
, BlockdevOnError on_target_error
,
1638 BlockDriverState
*bs
;
1639 BlockDriverState
*source
, *target_bs
;
1640 BlockDriver
*drv
= NULL
;
1641 Error
*local_err
= NULL
;
1649 if (!has_on_source_error
) {
1650 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1652 if (!has_on_target_error
) {
1653 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1656 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1658 if (!has_granularity
) {
1661 if (!has_buf_size
) {
1662 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1665 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
1666 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1669 if (granularity
& (granularity
- 1)) {
1670 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1674 bs
= bdrv_find(device
);
1676 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1680 if (!bdrv_is_inserted(bs
)) {
1681 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1686 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1689 drv
= bdrv_find_format(format
);
1691 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1696 if (bdrv_in_use(bs
)) {
1697 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1701 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1702 source
= bs
->backing_hd
;
1703 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
1704 sync
= MIRROR_SYNC_MODE_FULL
;
1707 size
= bdrv_getlength(bs
);
1709 error_setg_errno(errp
, -size
, "bdrv_getlength failed");
1713 if (sync
== MIRROR_SYNC_MODE_FULL
&& mode
!= NEW_IMAGE_MODE_EXISTING
) {
1714 /* create new image w/o backing file */
1715 assert(format
&& drv
);
1716 bdrv_img_create(target
, format
,
1717 NULL
, NULL
, NULL
, size
, flags
, &local_err
, false);
1720 case NEW_IMAGE_MODE_EXISTING
:
1723 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
1724 /* create new image with backing file */
1725 bdrv_img_create(target
, format
,
1727 source
->drv
->format_name
,
1728 NULL
, size
, flags
, &local_err
, false);
1735 if (error_is_set(&local_err
)) {
1736 error_propagate(errp
, local_err
);
1740 /* Mirroring takes care of copy-on-write using the source's backing
1743 target_bs
= bdrv_new("");
1744 ret
= bdrv_open(target_bs
, target
, NULL
, flags
| BDRV_O_NO_BACKING
, drv
);
1746 bdrv_delete(target_bs
);
1747 error_setg_file_open(errp
, -ret
, target
);
1751 mirror_start(bs
, target_bs
, speed
, granularity
, buf_size
, sync
,
1752 on_source_error
, on_target_error
,
1753 block_job_cb
, bs
, &local_err
);
1754 if (local_err
!= NULL
) {
1755 bdrv_delete(target_bs
);
1756 error_propagate(errp
, local_err
);
1760 /* Grab a reference so hotplug does not delete the BlockDriverState from
1763 drive_get_ref(drive_get_by_blockdev(bs
));
1766 static BlockJob
*find_block_job(const char *device
)
1768 BlockDriverState
*bs
;
1770 bs
= bdrv_find(device
);
1771 if (!bs
|| !bs
->job
) {
1777 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
1779 BlockJob
*job
= find_block_job(device
);
1782 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1786 block_job_set_speed(job
, speed
, errp
);
1789 void qmp_block_job_cancel(const char *device
,
1790 bool has_force
, bool force
, Error
**errp
)
1792 BlockJob
*job
= find_block_job(device
);
1799 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1802 if (job
->paused
&& !force
) {
1803 error_set(errp
, QERR_BLOCK_JOB_PAUSED
, device
);
1807 trace_qmp_block_job_cancel(job
);
1808 block_job_cancel(job
);
1811 void qmp_block_job_pause(const char *device
, Error
**errp
)
1813 BlockJob
*job
= find_block_job(device
);
1816 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1820 trace_qmp_block_job_pause(job
);
1821 block_job_pause(job
);
1824 void qmp_block_job_resume(const char *device
, Error
**errp
)
1826 BlockJob
*job
= find_block_job(device
);
1829 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1833 trace_qmp_block_job_resume(job
);
1834 block_job_resume(job
);
1837 void qmp_block_job_complete(const char *device
, Error
**errp
)
1839 BlockJob
*job
= find_block_job(device
);
1842 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1846 trace_qmp_block_job_complete(job
);
1847 block_job_complete(job
, errp
);
1850 static void do_qmp_query_block_jobs_one(void *opaque
, BlockDriverState
*bs
)
1852 BlockJobInfoList
**prev
= opaque
;
1853 BlockJob
*job
= bs
->job
;
1856 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
1857 elem
->value
= block_job_query(bs
->job
);
1858 (*prev
)->next
= elem
;
1863 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
1865 /* Dummy is a fake list element for holding the head pointer */
1866 BlockJobInfoList dummy
= {};
1867 BlockJobInfoList
*prev
= &dummy
;
1868 bdrv_iterate(do_qmp_query_block_jobs_one
, &prev
);
1872 QemuOptsList qemu_common_drive_opts
= {
1874 .head
= QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts
.head
),
1878 .type
= QEMU_OPT_NUMBER
,
1879 .help
= "bus number",
1882 .type
= QEMU_OPT_NUMBER
,
1883 .help
= "unit number (i.e. lun for scsi)",
1886 .type
= QEMU_OPT_STRING
,
1887 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
1890 .type
= QEMU_OPT_NUMBER
,
1891 .help
= "index number",
1894 .type
= QEMU_OPT_NUMBER
,
1895 .help
= "number of cylinders (ide disk geometry)",
1898 .type
= QEMU_OPT_NUMBER
,
1899 .help
= "number of heads (ide disk geometry)",
1902 .type
= QEMU_OPT_NUMBER
,
1903 .help
= "number of sectors (ide disk geometry)",
1906 .type
= QEMU_OPT_STRING
,
1907 .help
= "chs translation (auto, lba. none)",
1910 .type
= QEMU_OPT_STRING
,
1911 .help
= "media type (disk, cdrom)",
1914 .type
= QEMU_OPT_BOOL
,
1915 .help
= "enable/disable snapshot mode",
1918 .type
= QEMU_OPT_STRING
,
1919 .help
= "disk image",
1922 .type
= QEMU_OPT_STRING
,
1923 .help
= "discard operation (ignore/off, unmap/on)",
1925 .name
= "cache.writeback",
1926 .type
= QEMU_OPT_BOOL
,
1927 .help
= "enables writeback mode for any caches",
1929 .name
= "cache.direct",
1930 .type
= QEMU_OPT_BOOL
,
1931 .help
= "enables use of O_DIRECT (bypass the host page cache)",
1933 .name
= "cache.no-flush",
1934 .type
= QEMU_OPT_BOOL
,
1935 .help
= "ignore any flush requests for the device",
1938 .type
= QEMU_OPT_STRING
,
1939 .help
= "host AIO implementation (threads, native)",
1942 .type
= QEMU_OPT_STRING
,
1943 .help
= "disk format (raw, qcow2, ...)",
1946 .type
= QEMU_OPT_STRING
,
1947 .help
= "disk serial number",
1950 .type
= QEMU_OPT_STRING
,
1951 .help
= "read error action",
1954 .type
= QEMU_OPT_STRING
,
1955 .help
= "write error action",
1958 .type
= QEMU_OPT_STRING
,
1959 .help
= "pci address (virtio only)",
1961 .name
= "read-only",
1962 .type
= QEMU_OPT_BOOL
,
1963 .help
= "open drive file as read-only",
1965 .name
= "throttling.iops-total",
1966 .type
= QEMU_OPT_NUMBER
,
1967 .help
= "limit total I/O operations per second",
1969 .name
= "throttling.iops-read",
1970 .type
= QEMU_OPT_NUMBER
,
1971 .help
= "limit read operations per second",
1973 .name
= "throttling.iops-write",
1974 .type
= QEMU_OPT_NUMBER
,
1975 .help
= "limit write operations per second",
1977 .name
= "throttling.bps-total",
1978 .type
= QEMU_OPT_NUMBER
,
1979 .help
= "limit total bytes per second",
1981 .name
= "throttling.bps-read",
1982 .type
= QEMU_OPT_NUMBER
,
1983 .help
= "limit read bytes per second",
1985 .name
= "throttling.bps-write",
1986 .type
= QEMU_OPT_NUMBER
,
1987 .help
= "limit write bytes per second",
1989 .name
= "copy-on-read",
1990 .type
= QEMU_OPT_BOOL
,
1991 .help
= "copy read data from backing file into image file",
1994 .type
= QEMU_OPT_BOOL
,
1995 .help
= "(deprecated, ignored)",
1997 { /* end of list */ }
2001 QemuOptsList qemu_old_drive_opts
= {
2003 .head
= QTAILQ_HEAD_INITIALIZER(qemu_old_drive_opts
.head
),
2007 .type
= QEMU_OPT_NUMBER
,
2008 .help
= "bus number",
2011 .type
= QEMU_OPT_NUMBER
,
2012 .help
= "unit number (i.e. lun for scsi)",
2015 .type
= QEMU_OPT_STRING
,
2016 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2019 .type
= QEMU_OPT_NUMBER
,
2020 .help
= "index number",
2023 .type
= QEMU_OPT_NUMBER
,
2024 .help
= "number of cylinders (ide disk geometry)",
2027 .type
= QEMU_OPT_NUMBER
,
2028 .help
= "number of heads (ide disk geometry)",
2031 .type
= QEMU_OPT_NUMBER
,
2032 .help
= "number of sectors (ide disk geometry)",
2035 .type
= QEMU_OPT_STRING
,
2036 .help
= "chs translation (auto, lba. none)",
2039 .type
= QEMU_OPT_STRING
,
2040 .help
= "media type (disk, cdrom)",
2043 .type
= QEMU_OPT_BOOL
,
2044 .help
= "enable/disable snapshot mode",
2047 .type
= QEMU_OPT_STRING
,
2048 .help
= "disk image",
2051 .type
= QEMU_OPT_STRING
,
2052 .help
= "discard operation (ignore/off, unmap/on)",
2055 .type
= QEMU_OPT_STRING
,
2056 .help
= "host cache usage (none, writeback, writethrough, "
2057 "directsync, unsafe)",
2060 .type
= QEMU_OPT_STRING
,
2061 .help
= "host AIO implementation (threads, native)",
2064 .type
= QEMU_OPT_STRING
,
2065 .help
= "disk format (raw, qcow2, ...)",
2068 .type
= QEMU_OPT_STRING
,
2069 .help
= "disk serial number",
2072 .type
= QEMU_OPT_STRING
,
2073 .help
= "read error action",
2076 .type
= QEMU_OPT_STRING
,
2077 .help
= "write error action",
2080 .type
= QEMU_OPT_STRING
,
2081 .help
= "pci address (virtio only)",
2084 .type
= QEMU_OPT_BOOL
,
2085 .help
= "open drive file as read-only",
2088 .type
= QEMU_OPT_NUMBER
,
2089 .help
= "limit total I/O operations per second",
2092 .type
= QEMU_OPT_NUMBER
,
2093 .help
= "limit read operations per second",
2096 .type
= QEMU_OPT_NUMBER
,
2097 .help
= "limit write operations per second",
2100 .type
= QEMU_OPT_NUMBER
,
2101 .help
= "limit total bytes per second",
2104 .type
= QEMU_OPT_NUMBER
,
2105 .help
= "limit read bytes per second",
2108 .type
= QEMU_OPT_NUMBER
,
2109 .help
= "limit write bytes per second",
2111 .name
= "copy-on-read",
2112 .type
= QEMU_OPT_BOOL
,
2113 .help
= "copy read data from backing file into image file",
2116 .type
= QEMU_OPT_BOOL
,
2117 .help
= "(deprecated, ignored)",
2119 { /* end of list */ }
2123 QemuOptsList qemu_drive_opts
= {
2125 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
2128 * no elements => accept any params
2129 * validation will happen later
2131 { /* end of list */ }