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.
14 #include "qemu-option.h"
15 #include "qemu-config.h"
18 #include "block_int.h"
20 static QTAILQ_HEAD(drivelist
, DriveInfo
) drives
= QTAILQ_HEAD_INITIALIZER(drives
);
23 * We automatically delete the drive when a device using it gets
24 * unplugged. Questionable feature, but we can't just drop it.
25 * Device models call blockdev_mark_auto_del() to schedule the
26 * automatic deletion, and generic qdev code calls blockdev_auto_del()
27 * when deletion is actually safe.
29 void blockdev_mark_auto_del(BlockDriverState
*bs
)
31 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
38 void blockdev_auto_del(BlockDriverState
*bs
)
40 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
42 if (dinfo
&& dinfo
->auto_del
) {
47 QemuOpts
*drive_add(const char *file
, const char *fmt
, ...)
54 vsnprintf(optstr
, sizeof(optstr
), fmt
, ap
);
57 opts
= qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
62 qemu_opt_set(opts
, "file", file
);
66 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
70 /* seek interface, bus and unit */
72 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
73 if (dinfo
->type
== type
&&
82 int drive_get_max_bus(BlockInterfaceType type
)
88 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
89 if(dinfo
->type
== type
&&
96 /* Get a block device. This should only be used for single-drive devices
97 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
99 DriveInfo
*drive_get_next(BlockInterfaceType type
)
101 static int next_block_unit
[IF_COUNT
];
103 return drive_get(type
, 0, next_block_unit
[type
]++);
106 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
110 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
111 if (dinfo
->bdrv
== bs
) {
118 static void bdrv_format_print(void *opaque
, const char *name
)
120 error_printf(" %s", name
);
123 void drive_uninit(DriveInfo
*dinfo
)
125 qemu_opts_del(dinfo
->opts
);
126 bdrv_delete(dinfo
->bdrv
);
127 QTAILQ_REMOVE(&drives
, dinfo
, next
);
131 static int parse_block_error_action(const char *buf
, int is_read
)
133 if (!strcmp(buf
, "ignore")) {
134 return BLOCK_ERR_IGNORE
;
135 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
136 return BLOCK_ERR_STOP_ENOSPC
;
137 } else if (!strcmp(buf
, "stop")) {
138 return BLOCK_ERR_STOP_ANY
;
139 } else if (!strcmp(buf
, "report")) {
140 return BLOCK_ERR_REPORT
;
142 error_report("'%s' invalid %s error action",
143 buf
, is_read
? "read" : "write");
148 DriveInfo
*drive_init(QemuOpts
*opts
, int default_to_scsi
, int *fatal_error
)
151 const char *file
= NULL
;
154 const char *mediastr
= "";
155 BlockInterfaceType type
;
156 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
158 int cyls
, heads
, secs
, translation
;
159 BlockDriver
*drv
= NULL
;
164 int on_read_error
, on_write_error
;
172 translation
= BIOS_ATA_TRANSLATION_AUTO
;
174 if (default_to_scsi
) {
176 max_devs
= MAX_SCSI_DEVS
;
177 pstrcpy(devname
, sizeof(devname
), "scsi");
180 max_devs
= MAX_IDE_DEVS
;
181 pstrcpy(devname
, sizeof(devname
), "ide");
185 /* extract parameters */
186 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
187 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
188 index
= qemu_opt_get_number(opts
, "index", -1);
190 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
191 heads
= qemu_opt_get_number(opts
, "heads", 0);
192 secs
= qemu_opt_get_number(opts
, "secs", 0);
194 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
195 ro
= qemu_opt_get_bool(opts
, "readonly", 0);
197 file
= qemu_opt_get(opts
, "file");
198 serial
= qemu_opt_get(opts
, "serial");
200 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
201 pstrcpy(devname
, sizeof(devname
), buf
);
202 if (!strcmp(buf
, "ide")) {
204 max_devs
= MAX_IDE_DEVS
;
205 } else if (!strcmp(buf
, "scsi")) {
207 max_devs
= MAX_SCSI_DEVS
;
208 } else if (!strcmp(buf
, "floppy")) {
211 } else if (!strcmp(buf
, "pflash")) {
214 } else if (!strcmp(buf
, "mtd")) {
217 } else if (!strcmp(buf
, "sd")) {
220 } else if (!strcmp(buf
, "virtio")) {
223 } else if (!strcmp(buf
, "xen")) {
226 } else if (!strcmp(buf
, "none")) {
230 error_report("unsupported bus type '%s'", buf
);
235 if (cyls
|| heads
|| secs
) {
236 if (cyls
< 1 || (type
== IF_IDE
&& cyls
> 16383)) {
237 error_report("invalid physical cyls number");
240 if (heads
< 1 || (type
== IF_IDE
&& heads
> 16)) {
241 error_report("invalid physical heads number");
244 if (secs
< 1 || (type
== IF_IDE
&& secs
> 63)) {
245 error_report("invalid physical secs number");
250 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
252 error_report("'%s' trans must be used with cyls,heads and secs",
256 if (!strcmp(buf
, "none"))
257 translation
= BIOS_ATA_TRANSLATION_NONE
;
258 else if (!strcmp(buf
, "lba"))
259 translation
= BIOS_ATA_TRANSLATION_LBA
;
260 else if (!strcmp(buf
, "auto"))
261 translation
= BIOS_ATA_TRANSLATION_AUTO
;
263 error_report("'%s' invalid translation type", buf
);
268 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
269 if (!strcmp(buf
, "disk")) {
271 } else if (!strcmp(buf
, "cdrom")) {
272 if (cyls
|| secs
|| heads
) {
273 error_report("'%s' invalid physical CHS format", buf
);
278 error_report("'%s' invalid media", buf
);
283 if ((buf
= qemu_opt_get(opts
, "cache")) != NULL
) {
284 if (!strcmp(buf
, "off") || !strcmp(buf
, "none")) {
285 bdrv_flags
|= BDRV_O_NOCACHE
;
286 } else if (!strcmp(buf
, "writeback")) {
287 bdrv_flags
|= BDRV_O_CACHE_WB
;
288 } else if (!strcmp(buf
, "unsafe")) {
289 bdrv_flags
|= BDRV_O_CACHE_WB
;
290 bdrv_flags
|= BDRV_O_NO_FLUSH
;
291 } else if (!strcmp(buf
, "writethrough")) {
292 /* this is the default */
294 error_report("invalid cache option");
299 #ifdef CONFIG_LINUX_AIO
300 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
301 if (!strcmp(buf
, "native")) {
302 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
303 } else if (!strcmp(buf
, "threads")) {
304 /* this is the default */
306 error_report("invalid aio option");
312 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
313 if (strcmp(buf
, "?") == 0) {
314 error_printf("Supported formats:");
315 bdrv_iterate_format(bdrv_format_print
, NULL
);
319 drv
= bdrv_find_whitelisted_format(buf
);
321 error_report("'%s' invalid format", buf
);
326 on_write_error
= BLOCK_ERR_STOP_ENOSPC
;
327 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
328 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
329 error_report("werror is not supported by this bus type");
333 on_write_error
= parse_block_error_action(buf
, 0);
334 if (on_write_error
< 0) {
339 on_read_error
= BLOCK_ERR_REPORT
;
340 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
341 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
342 error_report("rerror is not supported by this bus type");
346 on_read_error
= parse_block_error_action(buf
, 1);
347 if (on_read_error
< 0) {
352 if ((devaddr
= qemu_opt_get(opts
, "addr")) != NULL
) {
353 if (type
!= IF_VIRTIO
) {
354 error_report("addr is not supported by this bus type");
359 /* compute bus and unit according index */
362 if (bus_id
!= 0 || unit_id
!= -1) {
363 error_report("index cannot be used with bus and unit");
371 unit_id
= index
% max_devs
;
372 bus_id
= index
/ max_devs
;
376 /* if user doesn't specify a unit_id,
377 * try to find the first free
382 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
384 if (max_devs
&& unit_id
>= max_devs
) {
393 if (max_devs
&& unit_id
>= max_devs
) {
394 error_report("unit %d too big (max is %d)",
395 unit_id
, max_devs
- 1);
400 * ignore multiple definitions
403 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
410 dinfo
= qemu_mallocz(sizeof(*dinfo
));
411 if ((buf
= qemu_opts_id(opts
)) != NULL
) {
412 dinfo
->id
= qemu_strdup(buf
);
414 /* no id supplied -> create one */
415 dinfo
->id
= qemu_mallocz(32);
416 if (type
== IF_IDE
|| type
== IF_SCSI
)
417 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
419 snprintf(dinfo
->id
, 32, "%s%i%s%i",
420 devname
, bus_id
, mediastr
, unit_id
);
422 snprintf(dinfo
->id
, 32, "%s%s%i",
423 devname
, mediastr
, unit_id
);
425 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
426 dinfo
->devaddr
= devaddr
;
429 dinfo
->unit
= unit_id
;
432 strncpy(dinfo
->serial
, serial
, sizeof(dinfo
->serial
) - 1);
433 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
435 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
445 bdrv_set_geometry_hint(dinfo
->bdrv
, cyls
, heads
, secs
);
446 bdrv_set_translation_hint(dinfo
->bdrv
, translation
);
450 bdrv_set_type_hint(dinfo
->bdrv
, BDRV_TYPE_CDROM
);
455 /* FIXME: This isn't really a floppy, but it's a reasonable
458 bdrv_set_type_hint(dinfo
->bdrv
, BDRV_TYPE_FLOPPY
);
464 /* add virtio block device */
465 opts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0);
466 qemu_opt_set(opts
, "driver", "virtio-blk-pci");
467 qemu_opt_set(opts
, "drive", dinfo
->id
);
469 qemu_opt_set(opts
, "addr", devaddr
);
474 if (!file
|| !*file
) {
479 /* always use cache=unsafe with snapshot */
480 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
481 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
484 if (media
== MEDIA_CDROM
) {
485 /* CDROM is fine for any interface, don't check. */
487 } else if (ro
== 1) {
488 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&& type
!= IF_NONE
) {
489 error_report("readonly not supported by this bus type");
494 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
496 ret
= bdrv_open(dinfo
->bdrv
, file
, bdrv_flags
, drv
);
498 error_report("could not open disk image %s: %s",
499 file
, strerror(-ret
));
503 if (bdrv_key_required(dinfo
->bdrv
))
509 void do_commit(Monitor
*mon
, const QDict
*qdict
)
511 const char *device
= qdict_get_str(qdict
, "device");
512 BlockDriverState
*bs
;
514 if (!strcmp(device
, "all")) {
517 bs
= bdrv_find(device
);
519 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
526 int do_snapshot_blkdev(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
528 const char *device
= qdict_get_str(qdict
, "device");
529 const char *filename
= qdict_get_try_str(qdict
, "snapshot_file");
530 const char *format
= qdict_get_try_str(qdict
, "format");
531 BlockDriverState
*bs
;
532 BlockDriver
*drv
, *proto_drv
;
537 qerror_report(QERR_MISSING_PARAMETER
, "snapshot_file");
542 bs
= bdrv_find(device
);
544 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
553 drv
= bdrv_find_format(format
);
555 qerror_report(QERR_INVALID_BLOCK_FORMAT
, format
);
560 proto_drv
= bdrv_find_protocol(filename
);
562 qerror_report(QERR_INVALID_BLOCK_FORMAT
, format
);
567 ret
= bdrv_img_create(filename
, format
, bs
->filename
,
568 bs
->drv
->format_name
, NULL
, -1, bs
->open_flags
);
576 flags
= bs
->open_flags
;
578 ret
= bdrv_open(bs
, filename
, flags
, drv
);
580 * If reopening the image file we just created fails, we really
594 static int eject_device(Monitor
*mon
, BlockDriverState
*bs
, int force
)
597 if (!bdrv_is_removable(bs
)) {
598 qerror_report(QERR_DEVICE_NOT_REMOVABLE
,
599 bdrv_get_device_name(bs
));
602 if (bdrv_is_locked(bs
)) {
603 qerror_report(QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
611 int do_eject(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
613 BlockDriverState
*bs
;
614 int force
= qdict_get_try_bool(qdict
, "force", 0);
615 const char *filename
= qdict_get_str(qdict
, "device");
617 bs
= bdrv_find(filename
);
619 qerror_report(QERR_DEVICE_NOT_FOUND
, filename
);
622 return eject_device(mon
, bs
, force
);
625 int do_block_set_passwd(Monitor
*mon
, const QDict
*qdict
,
628 BlockDriverState
*bs
;
631 bs
= bdrv_find(qdict_get_str(qdict
, "device"));
633 qerror_report(QERR_DEVICE_NOT_FOUND
, qdict_get_str(qdict
, "device"));
637 err
= bdrv_set_key(bs
, qdict_get_str(qdict
, "password"));
638 if (err
== -EINVAL
) {
639 qerror_report(QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
641 } else if (err
< 0) {
642 qerror_report(QERR_INVALID_PASSWORD
);
649 int do_change_block(Monitor
*mon
, const char *device
,
650 const char *filename
, const char *fmt
)
652 BlockDriverState
*bs
;
653 BlockDriver
*drv
= NULL
;
656 bs
= bdrv_find(device
);
658 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
662 drv
= bdrv_find_whitelisted_format(fmt
);
664 qerror_report(QERR_INVALID_BLOCK_FORMAT
, fmt
);
668 if (eject_device(mon
, bs
, 0) < 0) {
671 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
672 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
673 if (bdrv_open(bs
, filename
, bdrv_flags
, drv
) < 0) {
674 qerror_report(QERR_OPEN_FILE_FAILED
, filename
);
677 return monitor_read_bdrv_key_start(mon
, bs
, NULL
, NULL
);
680 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
682 const char *id
= qdict_get_str(qdict
, "id");
683 BlockDriverState
*bs
;
684 BlockDriverState
**ptr
;
689 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
693 /* quiesce block driver; prevent further io */
698 /* clean up guest state from pointing to host resource by
699 * finding and removing DeviceState "drive" property */
701 for (prop
= bs
->peer
->info
->props
; prop
&& prop
->name
; prop
++) {
702 if (prop
->info
->type
== PROP_TYPE_DRIVE
) {
703 ptr
= qdev_get_prop_ptr(bs
->peer
, prop
);
705 bdrv_detach(bs
, bs
->peer
);
713 /* clean up host side */
714 drive_uninit(drive_get_by_blockdev(bs
));
720 * XXX: replace the QERR_UNDEFINED_ERROR errors with real values once the
721 * existing QERR_ macro mess is cleaned up. A good example for better
722 * error reports can be found in the qemu-img resize code.
724 int do_block_resize(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
726 const char *device
= qdict_get_str(qdict
, "device");
727 int64_t size
= qdict_get_int(qdict
, "size");
728 BlockDriverState
*bs
;
730 bs
= bdrv_find(device
);
732 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
737 qerror_report(QERR_UNDEFINED_ERROR
);
741 if (bdrv_truncate(bs
, size
)) {
742 qerror_report(QERR_UNDEFINED_ERROR
);