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.
10 #include "sysemu/blockdev.h"
11 #include "hw/block-common.h"
12 #include "block/blockjob.h"
13 #include "monitor/monitor.h"
14 #include "qapi/qmp/qerror.h"
15 #include "qemu/option.h"
16 #include "qemu/config-file.h"
17 #include "qapi/qmp/types.h"
18 #include "sysemu/sysemu.h"
19 #include "block/block_int.h"
20 #include "qmp-commands.h"
22 #include "sysemu/arch_init.h"
24 static QTAILQ_HEAD(drivelist
, DriveInfo
) drives
= QTAILQ_HEAD_INITIALIZER(drives
);
26 static const char *const if_name
[IF_COUNT
] = {
30 [IF_FLOPPY
] = "floppy",
31 [IF_PFLASH
] = "pflash",
34 [IF_VIRTIO
] = "virtio",
38 static const int if_max_devs
[IF_COUNT
] = {
40 * Do not change these numbers! They govern how drive option
41 * index maps to unit and bus. That mapping is ABI.
43 * All controllers used to imlement if=T drives need to support
44 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
45 * Otherwise, some index values map to "impossible" bus, unit
48 * For instance, if you change [IF_SCSI] to 255, -drive
49 * if=scsi,index=12 no longer means bus=1,unit=5, but
50 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
51 * the drive can't be set up. Regression.
58 * We automatically delete the drive when a device using it gets
59 * unplugged. Questionable feature, but we can't just drop it.
60 * Device models call blockdev_mark_auto_del() to schedule the
61 * automatic deletion, and generic qdev code calls blockdev_auto_del()
62 * when deletion is actually safe.
64 void blockdev_mark_auto_del(BlockDriverState
*bs
)
66 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
69 block_job_cancel(bs
->job
);
76 void blockdev_auto_del(BlockDriverState
*bs
)
78 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
80 if (dinfo
&& dinfo
->auto_del
) {
85 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
87 int max_devs
= if_max_devs
[type
];
88 return max_devs
? index
/ max_devs
: 0;
91 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
93 int max_devs
= if_max_devs
[type
];
94 return max_devs
? index
% max_devs
: index
;
97 QemuOpts
*drive_def(const char *optstr
)
99 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
102 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
108 opts
= drive_def(optstr
);
112 if (type
!= IF_DEFAULT
) {
113 qemu_opt_set(opts
, "if", if_name
[type
]);
116 snprintf(buf
, sizeof(buf
), "%d", index
);
117 qemu_opt_set(opts
, "index", buf
);
120 qemu_opt_set(opts
, "file", file
);
124 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
128 /* seek interface, bus and unit */
130 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
131 if (dinfo
->type
== type
&&
140 DriveInfo
*drive_get_by_index(BlockInterfaceType type
, int index
)
142 return drive_get(type
,
143 drive_index_to_bus_id(type
, index
),
144 drive_index_to_unit_id(type
, index
));
147 int drive_get_max_bus(BlockInterfaceType type
)
153 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
154 if(dinfo
->type
== type
&&
155 dinfo
->bus
> max_bus
)
156 max_bus
= dinfo
->bus
;
161 /* Get a block device. This should only be used for single-drive devices
162 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
164 DriveInfo
*drive_get_next(BlockInterfaceType type
)
166 static int next_block_unit
[IF_COUNT
];
168 return drive_get(type
, 0, next_block_unit
[type
]++);
171 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
175 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
176 if (dinfo
->bdrv
== bs
) {
183 static void bdrv_format_print(void *opaque
, const char *name
)
185 error_printf(" %s", name
);
188 static void drive_uninit(DriveInfo
*dinfo
)
190 qemu_opts_del(dinfo
->opts
);
191 bdrv_delete(dinfo
->bdrv
);
193 QTAILQ_REMOVE(&drives
, dinfo
, next
);
197 void drive_put_ref(DriveInfo
*dinfo
)
199 assert(dinfo
->refcount
);
200 if (--dinfo
->refcount
== 0) {
205 void drive_get_ref(DriveInfo
*dinfo
)
215 static void drive_put_ref_bh(void *opaque
)
217 DrivePutRefBH
*s
= opaque
;
219 drive_put_ref(s
->dinfo
);
220 qemu_bh_delete(s
->bh
);
225 * Release a drive reference in a BH
227 * It is not possible to use drive_put_ref() from a callback function when the
228 * callers still need the drive. In such cases we schedule a BH to release the
231 static void drive_put_ref_bh_schedule(DriveInfo
*dinfo
)
235 s
= g_new(DrivePutRefBH
, 1);
236 s
->bh
= qemu_bh_new(drive_put_ref_bh
, s
);
238 qemu_bh_schedule(s
->bh
);
241 static int parse_block_error_action(const char *buf
, bool is_read
)
243 if (!strcmp(buf
, "ignore")) {
244 return BLOCKDEV_ON_ERROR_IGNORE
;
245 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
246 return BLOCKDEV_ON_ERROR_ENOSPC
;
247 } else if (!strcmp(buf
, "stop")) {
248 return BLOCKDEV_ON_ERROR_STOP
;
249 } else if (!strcmp(buf
, "report")) {
250 return BLOCKDEV_ON_ERROR_REPORT
;
252 error_report("'%s' invalid %s error action",
253 buf
, is_read
? "read" : "write");
258 static bool do_check_io_limits(BlockIOLimit
*io_limits
, Error
**errp
)
265 bps_flag
= (io_limits
->bps
[BLOCK_IO_LIMIT_TOTAL
] != 0)
266 && ((io_limits
->bps
[BLOCK_IO_LIMIT_READ
] != 0)
267 || (io_limits
->bps
[BLOCK_IO_LIMIT_WRITE
] != 0));
268 iops_flag
= (io_limits
->iops
[BLOCK_IO_LIMIT_TOTAL
] != 0)
269 && ((io_limits
->iops
[BLOCK_IO_LIMIT_READ
] != 0)
270 || (io_limits
->iops
[BLOCK_IO_LIMIT_WRITE
] != 0));
271 if (bps_flag
|| iops_flag
) {
272 error_setg(errp
, "bps(iops) and bps_rd/bps_wr(iops_rd/iops_wr) "
273 "cannot be used at the same time");
280 DriveInfo
*drive_init(QemuOpts
*opts
, BlockInterfaceType block_default_type
)
283 const char *file
= NULL
;
285 const char *mediastr
= "";
286 BlockInterfaceType type
;
287 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
289 int cyls
, heads
, secs
, translation
;
290 BlockDriver
*drv
= NULL
;
295 int on_read_error
, on_write_error
;
298 BlockIOLimit io_limits
;
304 translation
= BIOS_ATA_TRANSLATION_AUTO
;
307 /* extract parameters */
308 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
309 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
310 index
= qemu_opt_get_number(opts
, "index", -1);
312 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
313 heads
= qemu_opt_get_number(opts
, "heads", 0);
314 secs
= qemu_opt_get_number(opts
, "secs", 0);
316 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
317 ro
= qemu_opt_get_bool(opts
, "readonly", 0);
318 copy_on_read
= qemu_opt_get_bool(opts
, "copy-on-read", false);
320 file
= qemu_opt_get(opts
, "file");
321 serial
= qemu_opt_get(opts
, "serial");
323 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
324 for (type
= 0; type
< IF_COUNT
&& strcmp(buf
, if_name
[type
]); type
++)
326 if (type
== IF_COUNT
) {
327 error_report("unsupported bus type '%s'", buf
);
331 type
= block_default_type
;
334 max_devs
= if_max_devs
[type
];
336 if (cyls
|| heads
|| secs
) {
338 error_report("invalid physical cyls number");
342 error_report("invalid physical heads number");
346 error_report("invalid physical secs number");
351 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
353 error_report("'%s' trans must be used with cyls, heads and secs",
357 if (!strcmp(buf
, "none"))
358 translation
= BIOS_ATA_TRANSLATION_NONE
;
359 else if (!strcmp(buf
, "lba"))
360 translation
= BIOS_ATA_TRANSLATION_LBA
;
361 else if (!strcmp(buf
, "auto"))
362 translation
= BIOS_ATA_TRANSLATION_AUTO
;
364 error_report("'%s' invalid translation type", buf
);
369 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
370 if (!strcmp(buf
, "disk")) {
372 } else if (!strcmp(buf
, "cdrom")) {
373 if (cyls
|| secs
|| heads
) {
374 error_report("CHS can't be set with media=%s", buf
);
379 error_report("'%s' invalid media", buf
);
384 bdrv_flags
|= BDRV_O_CACHE_WB
;
385 if ((buf
= qemu_opt_get(opts
, "cache")) != NULL
) {
386 if (bdrv_parse_cache_flags(buf
, &bdrv_flags
) != 0) {
387 error_report("invalid cache option");
392 #ifdef CONFIG_LINUX_AIO
393 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
394 if (!strcmp(buf
, "native")) {
395 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
396 } else if (!strcmp(buf
, "threads")) {
397 /* this is the default */
399 error_report("invalid aio option");
405 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
406 if (is_help_option(buf
)) {
407 error_printf("Supported formats:");
408 bdrv_iterate_format(bdrv_format_print
, NULL
);
412 drv
= bdrv_find_whitelisted_format(buf
);
414 error_report("'%s' invalid format", buf
);
419 /* disk I/O throttling */
420 io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
] =
421 qemu_opt_get_number(opts
, "bps", 0);
422 io_limits
.bps
[BLOCK_IO_LIMIT_READ
] =
423 qemu_opt_get_number(opts
, "bps_rd", 0);
424 io_limits
.bps
[BLOCK_IO_LIMIT_WRITE
] =
425 qemu_opt_get_number(opts
, "bps_wr", 0);
426 io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
] =
427 qemu_opt_get_number(opts
, "iops", 0);
428 io_limits
.iops
[BLOCK_IO_LIMIT_READ
] =
429 qemu_opt_get_number(opts
, "iops_rd", 0);
430 io_limits
.iops
[BLOCK_IO_LIMIT_WRITE
] =
431 qemu_opt_get_number(opts
, "iops_wr", 0);
433 if (!do_check_io_limits(&io_limits
, &error
)) {
434 error_report("%s", error_get_pretty(error
));
439 if (qemu_opt_get(opts
, "boot") != NULL
) {
440 fprintf(stderr
, "qemu-kvm: boot=on|off is deprecated and will be "
441 "ignored. Future versions will reject this parameter. Please "
442 "update your scripts.\n");
445 on_write_error
= BLOCKDEV_ON_ERROR_ENOSPC
;
446 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
447 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
448 error_report("werror is not supported by this bus type");
452 on_write_error
= parse_block_error_action(buf
, 0);
453 if (on_write_error
< 0) {
458 on_read_error
= BLOCKDEV_ON_ERROR_REPORT
;
459 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
460 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
461 error_report("rerror is not supported by this bus type");
465 on_read_error
= parse_block_error_action(buf
, 1);
466 if (on_read_error
< 0) {
471 if ((devaddr
= qemu_opt_get(opts
, "addr")) != NULL
) {
472 if (type
!= IF_VIRTIO
) {
473 error_report("addr is not supported by this bus type");
478 /* compute bus and unit according index */
481 if (bus_id
!= 0 || unit_id
!= -1) {
482 error_report("index cannot be used with bus and unit");
485 bus_id
= drive_index_to_bus_id(type
, index
);
486 unit_id
= drive_index_to_unit_id(type
, index
);
489 /* if user doesn't specify a unit_id,
490 * try to find the first free
495 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
497 if (max_devs
&& unit_id
>= max_devs
) {
506 if (max_devs
&& unit_id
>= max_devs
) {
507 error_report("unit %d too big (max is %d)",
508 unit_id
, max_devs
- 1);
513 * catch multiple definitions
516 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
517 error_report("drive with bus=%d, unit=%d (index=%d) exists",
518 bus_id
, unit_id
, index
);
524 dinfo
= g_malloc0(sizeof(*dinfo
));
525 if ((buf
= qemu_opts_id(opts
)) != NULL
) {
526 dinfo
->id
= g_strdup(buf
);
528 /* no id supplied -> create one */
529 dinfo
->id
= g_malloc0(32);
530 if (type
== IF_IDE
|| type
== IF_SCSI
)
531 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
533 snprintf(dinfo
->id
, 32, "%s%i%s%i",
534 if_name
[type
], bus_id
, mediastr
, unit_id
);
536 snprintf(dinfo
->id
, 32, "%s%s%i",
537 if_name
[type
], mediastr
, unit_id
);
539 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
540 dinfo
->bdrv
->open_flags
= snapshot
? BDRV_O_SNAPSHOT
: 0;
541 dinfo
->bdrv
->read_only
= ro
;
542 dinfo
->devaddr
= devaddr
;
545 dinfo
->unit
= unit_id
;
547 dinfo
->heads
= heads
;
549 dinfo
->trans
= translation
;
552 dinfo
->serial
= serial
;
553 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
555 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
557 /* disk I/O throttling */
558 bdrv_set_io_limits(dinfo
->bdrv
, &io_limits
);
565 dinfo
->media_cd
= media
== MEDIA_CDROM
;
573 /* add virtio block device */
574 opts
= qemu_opts_create_nofail(qemu_find_opts("device"));
575 if (arch_type
== QEMU_ARCH_S390X
) {
576 qemu_opt_set(opts
, "driver", "virtio-blk-s390");
578 qemu_opt_set(opts
, "driver", "virtio-blk-pci");
580 qemu_opt_set(opts
, "drive", dinfo
->id
);
582 qemu_opt_set(opts
, "addr", devaddr
);
587 if (!file
|| !*file
) {
591 /* always use cache=unsafe with snapshot */
592 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
593 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
597 bdrv_flags
|= BDRV_O_COPY_ON_READ
;
600 if (runstate_check(RUN_STATE_INMIGRATE
)) {
601 bdrv_flags
|= BDRV_O_INCOMING
;
604 if (media
== MEDIA_CDROM
) {
605 /* CDROM is fine for any interface, don't check. */
607 } else if (ro
== 1) {
608 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&&
609 type
!= IF_NONE
&& type
!= IF_PFLASH
) {
610 error_report("readonly not supported by this bus type");
615 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
617 if (ro
&& copy_on_read
) {
618 error_report("warning: disabling copy_on_read on readonly drive");
621 ret
= bdrv_open(dinfo
->bdrv
, file
, bdrv_flags
, drv
);
623 if (ret
== -EMEDIUMTYPE
) {
624 error_report("could not open disk image %s: not in %s format",
625 file
, drv
->format_name
);
627 error_report("could not open disk image %s: %s",
628 file
, strerror(-ret
));
633 if (bdrv_key_required(dinfo
->bdrv
))
638 bdrv_delete(dinfo
->bdrv
);
640 QTAILQ_REMOVE(&drives
, dinfo
, next
);
645 void do_commit(Monitor
*mon
, const QDict
*qdict
)
647 const char *device
= qdict_get_str(qdict
, "device");
648 BlockDriverState
*bs
;
651 if (!strcmp(device
, "all")) {
652 ret
= bdrv_commit_all();
654 bs
= bdrv_find(device
);
656 monitor_printf(mon
, "Device '%s' not found\n", device
);
659 ret
= bdrv_commit(bs
);
662 monitor_printf(mon
, "'commit' error for '%s': %s\n", device
,
667 static void blockdev_do_action(int kind
, void *data
, Error
**errp
)
669 BlockdevAction action
;
670 BlockdevActionList list
;
674 list
.value
= &action
;
676 qmp_transaction(&list
, errp
);
679 void qmp_blockdev_snapshot_sync(const char *device
, const char *snapshot_file
,
680 bool has_format
, const char *format
,
681 bool has_mode
, enum NewImageMode mode
,
684 BlockdevSnapshot snapshot
= {
685 .device
= (char *) device
,
686 .snapshot_file
= (char *) snapshot_file
,
687 .has_format
= has_format
,
688 .format
= (char *) format
,
689 .has_mode
= has_mode
,
692 blockdev_do_action(BLOCKDEV_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
, &snapshot
,
697 /* New and old BlockDriverState structs for group snapshots */
698 typedef struct BlkTransactionStates
{
699 BlockDriverState
*old_bs
;
700 BlockDriverState
*new_bs
;
701 QSIMPLEQ_ENTRY(BlkTransactionStates
) entry
;
702 } BlkTransactionStates
;
705 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
706 * then we do not pivot any of the devices in the group, and abandon the
709 void qmp_transaction(BlockdevActionList
*dev_list
, Error
**errp
)
712 BlockdevActionList
*dev_entry
= dev_list
;
713 BlkTransactionStates
*states
, *next
;
714 Error
*local_err
= NULL
;
716 QSIMPLEQ_HEAD(snap_bdrv_states
, BlkTransactionStates
) snap_bdrv_states
;
717 QSIMPLEQ_INIT(&snap_bdrv_states
);
719 /* drain all i/o before any snapshots */
722 /* We don't do anything in this loop that commits us to the snapshot */
723 while (NULL
!= dev_entry
) {
724 BlockdevAction
*dev_info
= NULL
;
725 BlockDriver
*proto_drv
;
728 enum NewImageMode mode
;
729 const char *new_image_file
;
731 const char *format
= "qcow2";
733 dev_info
= dev_entry
->value
;
734 dev_entry
= dev_entry
->next
;
736 states
= g_malloc0(sizeof(BlkTransactionStates
));
737 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states
, states
, entry
);
739 switch (dev_info
->kind
) {
740 case BLOCKDEV_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC
:
741 device
= dev_info
->blockdev_snapshot_sync
->device
;
742 if (!dev_info
->blockdev_snapshot_sync
->has_mode
) {
743 dev_info
->blockdev_snapshot_sync
->mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
745 new_image_file
= dev_info
->blockdev_snapshot_sync
->snapshot_file
;
746 if (dev_info
->blockdev_snapshot_sync
->has_format
) {
747 format
= dev_info
->blockdev_snapshot_sync
->format
;
749 mode
= dev_info
->blockdev_snapshot_sync
->mode
;
755 drv
= bdrv_find_format(format
);
757 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
758 goto delete_and_fail
;
761 states
->old_bs
= bdrv_find(device
);
762 if (!states
->old_bs
) {
763 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
764 goto delete_and_fail
;
767 if (!bdrv_is_inserted(states
->old_bs
)) {
768 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
769 goto delete_and_fail
;
772 if (bdrv_in_use(states
->old_bs
)) {
773 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
774 goto delete_and_fail
;
777 if (!bdrv_is_read_only(states
->old_bs
)) {
778 if (bdrv_flush(states
->old_bs
)) {
779 error_set(errp
, QERR_IO_ERROR
);
780 goto delete_and_fail
;
784 flags
= states
->old_bs
->open_flags
;
786 proto_drv
= bdrv_find_protocol(new_image_file
);
788 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
789 goto delete_and_fail
;
792 /* create new image w/backing file */
793 if (mode
!= NEW_IMAGE_MODE_EXISTING
) {
794 bdrv_img_create(new_image_file
, format
,
795 states
->old_bs
->filename
,
796 states
->old_bs
->drv
->format_name
,
797 NULL
, -1, flags
, &local_err
);
798 if (error_is_set(&local_err
)) {
799 error_propagate(errp
, local_err
);
800 goto delete_and_fail
;
804 /* We will manually add the backing_hd field to the bs later */
805 states
->new_bs
= bdrv_new("");
806 ret
= bdrv_open(states
->new_bs
, new_image_file
,
807 flags
| BDRV_O_NO_BACKING
, drv
);
809 error_set(errp
, QERR_OPEN_FILE_FAILED
, new_image_file
);
810 goto delete_and_fail
;
815 /* Now we are going to do the actual pivot. Everything up to this point
816 * is reversible, but we are committed at this point */
817 QSIMPLEQ_FOREACH(states
, &snap_bdrv_states
, entry
) {
818 /* This removes our old bs from the bdrv_states, and adds the new bs */
819 bdrv_append(states
->new_bs
, states
->old_bs
);
820 /* We don't need (or want) to use the transactional
821 * bdrv_reopen_multiple() across all the entries at once, because we
822 * don't want to abort all of them if one of them fails the reopen */
823 bdrv_reopen(states
->new_bs
, states
->new_bs
->open_flags
& ~BDRV_O_RDWR
,
832 * failure, and it is all-or-none; abandon each new bs, and keep using
833 * the original bs for all images
835 QSIMPLEQ_FOREACH(states
, &snap_bdrv_states
, entry
) {
836 if (states
->new_bs
) {
837 bdrv_delete(states
->new_bs
);
841 QSIMPLEQ_FOREACH_SAFE(states
, &snap_bdrv_states
, entry
, next
) {
847 static void eject_device(BlockDriverState
*bs
, int force
, Error
**errp
)
849 if (bdrv_in_use(bs
)) {
850 error_set(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
853 if (!bdrv_dev_has_removable_media(bs
)) {
854 error_set(errp
, QERR_DEVICE_NOT_REMOVABLE
, bdrv_get_device_name(bs
));
858 if (bdrv_dev_is_medium_locked(bs
) && !bdrv_dev_is_tray_open(bs
)) {
859 bdrv_dev_eject_request(bs
, force
);
861 error_set(errp
, QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
869 void qmp_eject(const char *device
, bool has_force
, bool force
, Error
**errp
)
871 BlockDriverState
*bs
;
873 bs
= bdrv_find(device
);
875 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
879 eject_device(bs
, force
, errp
);
882 void qmp_block_passwd(const char *device
, const char *password
, Error
**errp
)
884 BlockDriverState
*bs
;
887 bs
= bdrv_find(device
);
889 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
893 err
= bdrv_set_key(bs
, password
);
894 if (err
== -EINVAL
) {
895 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
897 } else if (err
< 0) {
898 error_set(errp
, QERR_INVALID_PASSWORD
);
903 static void qmp_bdrv_open_encrypted(BlockDriverState
*bs
, const char *filename
,
904 int bdrv_flags
, BlockDriver
*drv
,
905 const char *password
, Error
**errp
)
907 if (bdrv_open(bs
, filename
, bdrv_flags
, drv
) < 0) {
908 error_set(errp
, QERR_OPEN_FILE_FAILED
, filename
);
912 if (bdrv_key_required(bs
)) {
914 if (bdrv_set_key(bs
, password
) < 0) {
915 error_set(errp
, QERR_INVALID_PASSWORD
);
918 error_set(errp
, QERR_DEVICE_ENCRYPTED
, bdrv_get_device_name(bs
),
919 bdrv_get_encrypted_filename(bs
));
921 } else if (password
) {
922 error_set(errp
, QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
926 void qmp_change_blockdev(const char *device
, const char *filename
,
927 bool has_format
, const char *format
, Error
**errp
)
929 BlockDriverState
*bs
;
930 BlockDriver
*drv
= NULL
;
934 bs
= bdrv_find(device
);
936 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
941 drv
= bdrv_find_whitelisted_format(format
);
943 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
948 eject_device(bs
, 0, &err
);
949 if (error_is_set(&err
)) {
950 error_propagate(errp
, err
);
954 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
955 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
957 qmp_bdrv_open_encrypted(bs
, filename
, bdrv_flags
, drv
, NULL
, errp
);
960 /* throttling disk I/O limits */
961 void qmp_block_set_io_throttle(const char *device
, int64_t bps
, int64_t bps_rd
,
962 int64_t bps_wr
, int64_t iops
, int64_t iops_rd
,
963 int64_t iops_wr
, Error
**errp
)
965 BlockIOLimit io_limits
;
966 BlockDriverState
*bs
;
968 bs
= bdrv_find(device
);
970 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
974 io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
] = bps
;
975 io_limits
.bps
[BLOCK_IO_LIMIT_READ
] = bps_rd
;
976 io_limits
.bps
[BLOCK_IO_LIMIT_WRITE
] = bps_wr
;
977 io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
]= iops
;
978 io_limits
.iops
[BLOCK_IO_LIMIT_READ
] = iops_rd
;
979 io_limits
.iops
[BLOCK_IO_LIMIT_WRITE
]= iops_wr
;
981 if (!do_check_io_limits(&io_limits
, errp
)) {
985 bs
->io_limits
= io_limits
;
986 bs
->slice_time
= BLOCK_IO_SLICE_TIME
;
988 if (!bs
->io_limits_enabled
&& bdrv_io_limits_enabled(bs
)) {
989 bdrv_io_limits_enable(bs
);
990 } else if (bs
->io_limits_enabled
&& !bdrv_io_limits_enabled(bs
)) {
991 bdrv_io_limits_disable(bs
);
993 if (bs
->block_timer
) {
994 qemu_mod_timer(bs
->block_timer
, qemu_get_clock_ns(vm_clock
));
999 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
1001 const char *id
= qdict_get_str(qdict
, "id");
1002 BlockDriverState
*bs
;
1006 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
1009 if (bdrv_in_use(bs
)) {
1010 qerror_report(QERR_DEVICE_IN_USE
, id
);
1014 /* quiesce block driver; prevent further io */
1019 /* if we have a device attached to this BlockDriverState
1020 * then we need to make the drive anonymous until the device
1021 * can be removed. If this is a drive with no device backing
1022 * then we can just get rid of the block driver state right here.
1024 if (bdrv_get_attached_dev(bs
)) {
1027 drive_uninit(drive_get_by_blockdev(bs
));
1033 void qmp_block_resize(const char *device
, int64_t size
, Error
**errp
)
1035 BlockDriverState
*bs
;
1037 bs
= bdrv_find(device
);
1039 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1044 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "size", "a >0 size");
1048 switch (bdrv_truncate(bs
, size
)) {
1052 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1055 error_set(errp
, QERR_UNSUPPORTED
);
1058 error_set(errp
, QERR_DEVICE_IS_READ_ONLY
, device
);
1061 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1064 error_set(errp
, QERR_UNDEFINED_ERROR
);
1069 static void block_job_cb(void *opaque
, int ret
)
1071 BlockDriverState
*bs
= opaque
;
1074 trace_block_job_cb(bs
, bs
->job
, ret
);
1077 obj
= qobject_from_block_job(bs
->job
);
1079 QDict
*dict
= qobject_to_qdict(obj
);
1080 qdict_put(dict
, "error", qstring_from_str(strerror(-ret
)));
1083 if (block_job_is_cancelled(bs
->job
)) {
1084 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED
, obj
);
1086 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED
, obj
);
1088 qobject_decref(obj
);
1090 drive_put_ref_bh_schedule(drive_get_by_blockdev(bs
));
1093 void qmp_block_stream(const char *device
, bool has_base
,
1094 const char *base
, bool has_speed
, int64_t speed
,
1095 bool has_on_error
, BlockdevOnError on_error
,
1098 BlockDriverState
*bs
;
1099 BlockDriverState
*base_bs
= NULL
;
1100 Error
*local_err
= NULL
;
1102 if (!has_on_error
) {
1103 on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1106 bs
= bdrv_find(device
);
1108 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1113 base_bs
= bdrv_find_backing_image(bs
, base
);
1114 if (base_bs
== NULL
) {
1115 error_set(errp
, QERR_BASE_NOT_FOUND
, base
);
1120 stream_start(bs
, base_bs
, base
, has_speed
? speed
: 0,
1121 on_error
, block_job_cb
, bs
, &local_err
);
1122 if (error_is_set(&local_err
)) {
1123 error_propagate(errp
, local_err
);
1127 /* Grab a reference so hotplug does not delete the BlockDriverState from
1130 drive_get_ref(drive_get_by_blockdev(bs
));
1132 trace_qmp_block_stream(bs
, bs
->job
);
1135 void qmp_block_commit(const char *device
,
1136 bool has_base
, const char *base
, const char *top
,
1137 bool has_speed
, int64_t speed
,
1140 BlockDriverState
*bs
;
1141 BlockDriverState
*base_bs
, *top_bs
;
1142 Error
*local_err
= NULL
;
1143 /* This will be part of the QMP command, if/when the
1144 * BlockdevOnError change for blkmirror makes it in
1146 BlockdevOnError on_error
= BLOCKDEV_ON_ERROR_REPORT
;
1148 /* drain all i/o before commits */
1151 bs
= bdrv_find(device
);
1153 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1157 /* default top_bs is the active layer */
1161 if (strcmp(bs
->filename
, top
) != 0) {
1162 top_bs
= bdrv_find_backing_image(bs
, top
);
1166 if (top_bs
== NULL
) {
1167 error_setg(errp
, "Top image file %s not found", top
? top
: "NULL");
1171 if (has_base
&& base
) {
1172 base_bs
= bdrv_find_backing_image(top_bs
, base
);
1174 base_bs
= bdrv_find_base(top_bs
);
1177 if (base_bs
== NULL
) {
1178 error_set(errp
, QERR_BASE_NOT_FOUND
, base
? base
: "NULL");
1182 commit_start(bs
, base_bs
, top_bs
, speed
, on_error
, block_job_cb
, bs
,
1184 if (local_err
!= NULL
) {
1185 error_propagate(errp
, local_err
);
1188 /* Grab a reference so hotplug does not delete the BlockDriverState from
1191 drive_get_ref(drive_get_by_blockdev(bs
));
1194 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1196 void qmp_drive_mirror(const char *device
, const char *target
,
1197 bool has_format
, const char *format
,
1198 enum MirrorSyncMode sync
,
1199 bool has_mode
, enum NewImageMode mode
,
1200 bool has_speed
, int64_t speed
,
1201 bool has_granularity
, uint32_t granularity
,
1202 bool has_buf_size
, int64_t buf_size
,
1203 bool has_on_source_error
, BlockdevOnError on_source_error
,
1204 bool has_on_target_error
, BlockdevOnError on_target_error
,
1207 BlockDriverState
*bs
;
1208 BlockDriverState
*source
, *target_bs
;
1209 BlockDriver
*proto_drv
;
1210 BlockDriver
*drv
= NULL
;
1211 Error
*local_err
= NULL
;
1219 if (!has_on_source_error
) {
1220 on_source_error
= BLOCKDEV_ON_ERROR_REPORT
;
1222 if (!has_on_target_error
) {
1223 on_target_error
= BLOCKDEV_ON_ERROR_REPORT
;
1226 mode
= NEW_IMAGE_MODE_ABSOLUTE_PATHS
;
1228 if (!has_granularity
) {
1231 if (!has_buf_size
) {
1232 buf_size
= DEFAULT_MIRROR_BUF_SIZE
;
1235 if (granularity
!= 0 && (granularity
< 512 || granularity
> 1048576 * 64)) {
1236 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1239 if (granularity
& (granularity
- 1)) {
1240 error_set(errp
, QERR_INVALID_PARAMETER
, device
);
1244 bs
= bdrv_find(device
);
1246 error_set(errp
, QERR_DEVICE_NOT_FOUND
, device
);
1250 if (!bdrv_is_inserted(bs
)) {
1251 error_set(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, device
);
1256 format
= mode
== NEW_IMAGE_MODE_EXISTING
? NULL
: bs
->drv
->format_name
;
1259 drv
= bdrv_find_format(format
);
1261 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1266 if (bdrv_in_use(bs
)) {
1267 error_set(errp
, QERR_DEVICE_IN_USE
, device
);
1271 flags
= bs
->open_flags
| BDRV_O_RDWR
;
1272 source
= bs
->backing_hd
;
1273 if (!source
&& sync
== MIRROR_SYNC_MODE_TOP
) {
1274 sync
= MIRROR_SYNC_MODE_FULL
;
1277 proto_drv
= bdrv_find_protocol(target
);
1279 error_set(errp
, QERR_INVALID_BLOCK_FORMAT
, format
);
1283 bdrv_get_geometry(bs
, &size
);
1285 if (sync
== MIRROR_SYNC_MODE_FULL
&& mode
!= NEW_IMAGE_MODE_EXISTING
) {
1286 /* create new image w/o backing file */
1287 assert(format
&& drv
);
1288 bdrv_img_create(target
, format
,
1289 NULL
, NULL
, NULL
, size
, flags
, &local_err
);
1292 case NEW_IMAGE_MODE_EXISTING
:
1295 case NEW_IMAGE_MODE_ABSOLUTE_PATHS
:
1296 /* create new image with backing file */
1297 bdrv_img_create(target
, format
,
1299 source
->drv
->format_name
,
1300 NULL
, size
, flags
, &local_err
);
1307 if (error_is_set(&local_err
)) {
1308 error_propagate(errp
, local_err
);
1312 /* Mirroring takes care of copy-on-write using the source's backing
1315 target_bs
= bdrv_new("");
1316 ret
= bdrv_open(target_bs
, target
, flags
| BDRV_O_NO_BACKING
, drv
);
1319 bdrv_delete(target_bs
);
1320 error_set(errp
, QERR_OPEN_FILE_FAILED
, target
);
1324 mirror_start(bs
, target_bs
, speed
, granularity
, buf_size
, sync
,
1325 on_source_error
, on_target_error
,
1326 block_job_cb
, bs
, &local_err
);
1327 if (local_err
!= NULL
) {
1328 bdrv_delete(target_bs
);
1329 error_propagate(errp
, local_err
);
1333 /* Grab a reference so hotplug does not delete the BlockDriverState from
1336 drive_get_ref(drive_get_by_blockdev(bs
));
1339 static BlockJob
*find_block_job(const char *device
)
1341 BlockDriverState
*bs
;
1343 bs
= bdrv_find(device
);
1344 if (!bs
|| !bs
->job
) {
1350 void qmp_block_job_set_speed(const char *device
, int64_t speed
, Error
**errp
)
1352 BlockJob
*job
= find_block_job(device
);
1355 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1359 block_job_set_speed(job
, speed
, errp
);
1362 void qmp_block_job_cancel(const char *device
,
1363 bool has_force
, bool force
, Error
**errp
)
1365 BlockJob
*job
= find_block_job(device
);
1372 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1375 if (job
->paused
&& !force
) {
1376 error_set(errp
, QERR_BLOCK_JOB_PAUSED
, device
);
1380 trace_qmp_block_job_cancel(job
);
1381 block_job_cancel(job
);
1384 void qmp_block_job_pause(const char *device
, Error
**errp
)
1386 BlockJob
*job
= find_block_job(device
);
1389 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1393 trace_qmp_block_job_pause(job
);
1394 block_job_pause(job
);
1397 void qmp_block_job_resume(const char *device
, Error
**errp
)
1399 BlockJob
*job
= find_block_job(device
);
1402 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1406 trace_qmp_block_job_resume(job
);
1407 block_job_resume(job
);
1410 void qmp_block_job_complete(const char *device
, Error
**errp
)
1412 BlockJob
*job
= find_block_job(device
);
1415 error_set(errp
, QERR_BLOCK_JOB_NOT_ACTIVE
, device
);
1419 trace_qmp_block_job_complete(job
);
1420 block_job_complete(job
, errp
);
1423 static void do_qmp_query_block_jobs_one(void *opaque
, BlockDriverState
*bs
)
1425 BlockJobInfoList
**prev
= opaque
;
1426 BlockJob
*job
= bs
->job
;
1429 BlockJobInfoList
*elem
= g_new0(BlockJobInfoList
, 1);
1430 elem
->value
= block_job_query(bs
->job
);
1431 (*prev
)->next
= elem
;
1436 BlockJobInfoList
*qmp_query_block_jobs(Error
**errp
)
1438 /* Dummy is a fake list element for holding the head pointer */
1439 BlockJobInfoList dummy
= {};
1440 BlockJobInfoList
*prev
= &dummy
;
1441 bdrv_iterate(do_qmp_query_block_jobs_one
, &prev
);
1445 QemuOptsList qemu_drive_opts
= {
1447 .head
= QTAILQ_HEAD_INITIALIZER(qemu_drive_opts
.head
),
1451 .type
= QEMU_OPT_NUMBER
,
1452 .help
= "bus number",
1455 .type
= QEMU_OPT_NUMBER
,
1456 .help
= "unit number (i.e. lun for scsi)",
1459 .type
= QEMU_OPT_STRING
,
1460 .help
= "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
1463 .type
= QEMU_OPT_NUMBER
,
1464 .help
= "index number",
1467 .type
= QEMU_OPT_NUMBER
,
1468 .help
= "number of cylinders (ide disk geometry)",
1471 .type
= QEMU_OPT_NUMBER
,
1472 .help
= "number of heads (ide disk geometry)",
1475 .type
= QEMU_OPT_NUMBER
,
1476 .help
= "number of sectors (ide disk geometry)",
1479 .type
= QEMU_OPT_STRING
,
1480 .help
= "chs translation (auto, lba. none)",
1483 .type
= QEMU_OPT_STRING
,
1484 .help
= "media type (disk, cdrom)",
1487 .type
= QEMU_OPT_BOOL
,
1488 .help
= "enable/disable snapshot mode",
1491 .type
= QEMU_OPT_STRING
,
1492 .help
= "disk image",
1495 .type
= QEMU_OPT_STRING
,
1496 .help
= "host cache usage (none, writeback, writethrough, "
1497 "directsync, unsafe)",
1500 .type
= QEMU_OPT_STRING
,
1501 .help
= "host AIO implementation (threads, native)",
1504 .type
= QEMU_OPT_STRING
,
1505 .help
= "disk format (raw, qcow2, ...)",
1508 .type
= QEMU_OPT_STRING
,
1509 .help
= "disk serial number",
1512 .type
= QEMU_OPT_STRING
,
1513 .help
= "read error action",
1516 .type
= QEMU_OPT_STRING
,
1517 .help
= "write error action",
1520 .type
= QEMU_OPT_STRING
,
1521 .help
= "pci address (virtio only)",
1524 .type
= QEMU_OPT_BOOL
,
1525 .help
= "open drive file as read-only",
1528 .type
= QEMU_OPT_NUMBER
,
1529 .help
= "limit total I/O operations per second",
1532 .type
= QEMU_OPT_NUMBER
,
1533 .help
= "limit read operations per second",
1536 .type
= QEMU_OPT_NUMBER
,
1537 .help
= "limit write operations per second",
1540 .type
= QEMU_OPT_NUMBER
,
1541 .help
= "limit total bytes per second",
1544 .type
= QEMU_OPT_NUMBER
,
1545 .help
= "limit read bytes per second",
1548 .type
= QEMU_OPT_NUMBER
,
1549 .help
= "limit write bytes per second",
1551 .name
= "copy-on-read",
1552 .type
= QEMU_OPT_BOOL
,
1553 .help
= "copy read data from backing file into image file",
1556 .type
= QEMU_OPT_BOOL
,
1557 .help
= "(deprecated, ignored)",
1559 { /* end of list */ }