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
);
22 static const char *const if_name
[IF_COUNT
] = {
26 [IF_FLOPPY
] = "floppy",
27 [IF_PFLASH
] = "pflash",
30 [IF_VIRTIO
] = "virtio",
34 static const int if_max_devs
[IF_COUNT
] = {
36 * Do not change these numbers! They govern how drive option
37 * index maps to unit and bus. That mapping is ABI.
39 * All controllers used to imlement if=T drives need to support
40 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
41 * Otherwise, some index values map to "impossible" bus, unit
44 * For instance, if you change [IF_SCSI] to 255, -drive
45 * if=scsi,index=12 no longer means bus=1,unit=5, but
46 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
47 * the drive can't be set up. Regression.
54 * We automatically delete the drive when a device using it gets
55 * unplugged. Questionable feature, but we can't just drop it.
56 * Device models call blockdev_mark_auto_del() to schedule the
57 * automatic deletion, and generic qdev code calls blockdev_auto_del()
58 * when deletion is actually safe.
60 void blockdev_mark_auto_del(BlockDriverState
*bs
)
62 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
69 void blockdev_auto_del(BlockDriverState
*bs
)
71 DriveInfo
*dinfo
= drive_get_by_blockdev(bs
);
73 if (dinfo
&& dinfo
->auto_del
) {
78 static int drive_index_to_bus_id(BlockInterfaceType type
, int index
)
80 int max_devs
= if_max_devs
[type
];
81 return max_devs
? index
/ max_devs
: 0;
84 static int drive_index_to_unit_id(BlockInterfaceType type
, int index
)
86 int max_devs
= if_max_devs
[type
];
87 return max_devs
? index
% max_devs
: index
;
90 QemuOpts
*drive_def(const char *optstr
)
92 return qemu_opts_parse(qemu_find_opts("drive"), optstr
, 0);
95 QemuOpts
*drive_add(BlockInterfaceType type
, int index
, const char *file
,
104 vsnprintf(optstr
, sizeof(optstr
), fmt
, ap
);
107 opts
= drive_def(optstr
);
111 if (type
!= IF_DEFAULT
) {
112 qemu_opt_set(opts
, "if", if_name
[type
]);
115 snprintf(buf
, sizeof(buf
), "%d", index
);
116 qemu_opt_set(opts
, "index", buf
);
119 qemu_opt_set(opts
, "file", file
);
123 DriveInfo
*drive_get(BlockInterfaceType type
, int bus
, int unit
)
127 /* seek interface, bus and unit */
129 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
130 if (dinfo
->type
== type
&&
139 int drive_get_max_bus(BlockInterfaceType type
)
145 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
146 if(dinfo
->type
== type
&&
147 dinfo
->bus
> max_bus
)
148 max_bus
= dinfo
->bus
;
153 /* Get a block device. This should only be used for single-drive devices
154 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
156 DriveInfo
*drive_get_next(BlockInterfaceType type
)
158 static int next_block_unit
[IF_COUNT
];
160 return drive_get(type
, 0, next_block_unit
[type
]++);
163 DriveInfo
*drive_get_by_blockdev(BlockDriverState
*bs
)
167 QTAILQ_FOREACH(dinfo
, &drives
, next
) {
168 if (dinfo
->bdrv
== bs
) {
175 static void bdrv_format_print(void *opaque
, const char *name
)
177 error_printf(" %s", name
);
180 void drive_uninit(DriveInfo
*dinfo
)
182 qemu_opts_del(dinfo
->opts
);
183 bdrv_delete(dinfo
->bdrv
);
184 QTAILQ_REMOVE(&drives
, dinfo
, next
);
188 static int parse_block_error_action(const char *buf
, int is_read
)
190 if (!strcmp(buf
, "ignore")) {
191 return BLOCK_ERR_IGNORE
;
192 } else if (!is_read
&& !strcmp(buf
, "enospc")) {
193 return BLOCK_ERR_STOP_ENOSPC
;
194 } else if (!strcmp(buf
, "stop")) {
195 return BLOCK_ERR_STOP_ANY
;
196 } else if (!strcmp(buf
, "report")) {
197 return BLOCK_ERR_REPORT
;
199 error_report("'%s' invalid %s error action",
200 buf
, is_read
? "read" : "write");
205 DriveInfo
*drive_init(QemuOpts
*opts
, int default_to_scsi
, int *fatal_error
)
208 const char *file
= NULL
;
211 const char *mediastr
= "";
212 BlockInterfaceType type
;
213 enum { MEDIA_DISK
, MEDIA_CDROM
} media
;
215 int cyls
, heads
, secs
, translation
;
216 BlockDriver
*drv
= NULL
;
221 int on_read_error
, on_write_error
;
229 translation
= BIOS_ATA_TRANSLATION_AUTO
;
231 if (default_to_scsi
) {
233 pstrcpy(devname
, sizeof(devname
), "scsi");
236 pstrcpy(devname
, sizeof(devname
), "ide");
240 /* extract parameters */
241 bus_id
= qemu_opt_get_number(opts
, "bus", 0);
242 unit_id
= qemu_opt_get_number(opts
, "unit", -1);
243 index
= qemu_opt_get_number(opts
, "index", -1);
245 cyls
= qemu_opt_get_number(opts
, "cyls", 0);
246 heads
= qemu_opt_get_number(opts
, "heads", 0);
247 secs
= qemu_opt_get_number(opts
, "secs", 0);
249 snapshot
= qemu_opt_get_bool(opts
, "snapshot", 0);
250 ro
= qemu_opt_get_bool(opts
, "readonly", 0);
252 file
= qemu_opt_get(opts
, "file");
253 serial
= qemu_opt_get(opts
, "serial");
255 if ((buf
= qemu_opt_get(opts
, "if")) != NULL
) {
256 pstrcpy(devname
, sizeof(devname
), buf
);
257 for (type
= 0; type
< IF_COUNT
&& strcmp(buf
, if_name
[type
]); type
++)
259 if (type
== IF_COUNT
) {
260 error_report("unsupported bus type '%s'", buf
);
264 max_devs
= if_max_devs
[type
];
266 if (cyls
|| heads
|| secs
) {
267 if (cyls
< 1 || (type
== IF_IDE
&& cyls
> 16383)) {
268 error_report("invalid physical cyls number");
271 if (heads
< 1 || (type
== IF_IDE
&& heads
> 16)) {
272 error_report("invalid physical heads number");
275 if (secs
< 1 || (type
== IF_IDE
&& secs
> 63)) {
276 error_report("invalid physical secs number");
281 if ((buf
= qemu_opt_get(opts
, "trans")) != NULL
) {
283 error_report("'%s' trans must be used with cyls,heads and secs",
287 if (!strcmp(buf
, "none"))
288 translation
= BIOS_ATA_TRANSLATION_NONE
;
289 else if (!strcmp(buf
, "lba"))
290 translation
= BIOS_ATA_TRANSLATION_LBA
;
291 else if (!strcmp(buf
, "auto"))
292 translation
= BIOS_ATA_TRANSLATION_AUTO
;
294 error_report("'%s' invalid translation type", buf
);
299 if ((buf
= qemu_opt_get(opts
, "media")) != NULL
) {
300 if (!strcmp(buf
, "disk")) {
302 } else if (!strcmp(buf
, "cdrom")) {
303 if (cyls
|| secs
|| heads
) {
304 error_report("'%s' invalid physical CHS format", buf
);
309 error_report("'%s' invalid media", buf
);
314 if ((buf
= qemu_opt_get(opts
, "cache")) != NULL
) {
315 if (!strcmp(buf
, "off") || !strcmp(buf
, "none")) {
316 bdrv_flags
|= BDRV_O_NOCACHE
;
317 } else if (!strcmp(buf
, "writeback")) {
318 bdrv_flags
|= BDRV_O_CACHE_WB
;
319 } else if (!strcmp(buf
, "unsafe")) {
320 bdrv_flags
|= BDRV_O_CACHE_WB
;
321 bdrv_flags
|= BDRV_O_NO_FLUSH
;
322 } else if (!strcmp(buf
, "writethrough")) {
323 /* this is the default */
325 error_report("invalid cache option");
330 #ifdef CONFIG_LINUX_AIO
331 if ((buf
= qemu_opt_get(opts
, "aio")) != NULL
) {
332 if (!strcmp(buf
, "native")) {
333 bdrv_flags
|= BDRV_O_NATIVE_AIO
;
334 } else if (!strcmp(buf
, "threads")) {
335 /* this is the default */
337 error_report("invalid aio option");
343 if ((buf
= qemu_opt_get(opts
, "format")) != NULL
) {
344 if (strcmp(buf
, "?") == 0) {
345 error_printf("Supported formats:");
346 bdrv_iterate_format(bdrv_format_print
, NULL
);
350 drv
= bdrv_find_whitelisted_format(buf
);
352 error_report("'%s' invalid format", buf
);
357 on_write_error
= BLOCK_ERR_STOP_ENOSPC
;
358 if ((buf
= qemu_opt_get(opts
, "werror")) != NULL
) {
359 if (type
!= IF_IDE
&& type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_NONE
) {
360 error_report("werror is not supported by this bus type");
364 on_write_error
= parse_block_error_action(buf
, 0);
365 if (on_write_error
< 0) {
370 on_read_error
= BLOCK_ERR_REPORT
;
371 if ((buf
= qemu_opt_get(opts
, "rerror")) != NULL
) {
372 if (type
!= IF_IDE
&& type
!= IF_VIRTIO
&& type
!= IF_SCSI
&& type
!= IF_NONE
) {
373 error_report("rerror is not supported by this bus type");
377 on_read_error
= parse_block_error_action(buf
, 1);
378 if (on_read_error
< 0) {
383 if ((devaddr
= qemu_opt_get(opts
, "addr")) != NULL
) {
384 if (type
!= IF_VIRTIO
) {
385 error_report("addr is not supported by this bus type");
390 /* compute bus and unit according index */
393 if (bus_id
!= 0 || unit_id
!= -1) {
394 error_report("index cannot be used with bus and unit");
397 bus_id
= drive_index_to_bus_id(type
, index
);
398 unit_id
= drive_index_to_unit_id(type
, index
);
401 /* if user doesn't specify a unit_id,
402 * try to find the first free
407 while (drive_get(type
, bus_id
, unit_id
) != NULL
) {
409 if (max_devs
&& unit_id
>= max_devs
) {
418 if (max_devs
&& unit_id
>= max_devs
) {
419 error_report("unit %d too big (max is %d)",
420 unit_id
, max_devs
- 1);
425 * ignore multiple definitions
428 if (drive_get(type
, bus_id
, unit_id
) != NULL
) {
435 dinfo
= qemu_mallocz(sizeof(*dinfo
));
436 if ((buf
= qemu_opts_id(opts
)) != NULL
) {
437 dinfo
->id
= qemu_strdup(buf
);
439 /* no id supplied -> create one */
440 dinfo
->id
= qemu_mallocz(32);
441 if (type
== IF_IDE
|| type
== IF_SCSI
)
442 mediastr
= (media
== MEDIA_CDROM
) ? "-cd" : "-hd";
444 snprintf(dinfo
->id
, 32, "%s%i%s%i",
445 devname
, bus_id
, mediastr
, unit_id
);
447 snprintf(dinfo
->id
, 32, "%s%s%i",
448 devname
, mediastr
, unit_id
);
450 dinfo
->bdrv
= bdrv_new(dinfo
->id
);
451 dinfo
->devaddr
= devaddr
;
454 dinfo
->unit
= unit_id
;
457 strncpy(dinfo
->serial
, serial
, sizeof(dinfo
->serial
) - 1);
458 QTAILQ_INSERT_TAIL(&drives
, dinfo
, next
);
460 bdrv_set_on_error(dinfo
->bdrv
, on_read_error
, on_write_error
);
470 bdrv_set_geometry_hint(dinfo
->bdrv
, cyls
, heads
, secs
);
471 bdrv_set_translation_hint(dinfo
->bdrv
, translation
);
475 bdrv_set_type_hint(dinfo
->bdrv
, BDRV_TYPE_CDROM
);
480 /* FIXME: This isn't really a floppy, but it's a reasonable
483 bdrv_set_type_hint(dinfo
->bdrv
, BDRV_TYPE_FLOPPY
);
489 /* add virtio block device */
490 opts
= qemu_opts_create(qemu_find_opts("device"), NULL
, 0);
491 qemu_opt_set(opts
, "driver", "virtio-blk-pci");
492 qemu_opt_set(opts
, "drive", dinfo
->id
);
494 qemu_opt_set(opts
, "addr", devaddr
);
499 if (!file
|| !*file
) {
504 /* always use cache=unsafe with snapshot */
505 bdrv_flags
&= ~BDRV_O_CACHE_MASK
;
506 bdrv_flags
|= (BDRV_O_SNAPSHOT
|BDRV_O_CACHE_WB
|BDRV_O_NO_FLUSH
);
509 if (media
== MEDIA_CDROM
) {
510 /* CDROM is fine for any interface, don't check. */
512 } else if (ro
== 1) {
513 if (type
!= IF_SCSI
&& type
!= IF_VIRTIO
&& type
!= IF_FLOPPY
&& type
!= IF_NONE
) {
514 error_report("readonly not supported by this bus type");
519 bdrv_flags
|= ro
? 0 : BDRV_O_RDWR
;
521 ret
= bdrv_open(dinfo
->bdrv
, file
, bdrv_flags
, drv
);
523 error_report("could not open disk image %s: %s",
524 file
, strerror(-ret
));
528 if (bdrv_key_required(dinfo
->bdrv
))
534 void do_commit(Monitor
*mon
, const QDict
*qdict
)
536 const char *device
= qdict_get_str(qdict
, "device");
537 BlockDriverState
*bs
;
539 if (!strcmp(device
, "all")) {
542 bs
= bdrv_find(device
);
544 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
551 int do_snapshot_blkdev(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
553 const char *device
= qdict_get_str(qdict
, "device");
554 const char *filename
= qdict_get_try_str(qdict
, "snapshot_file");
555 const char *format
= qdict_get_try_str(qdict
, "format");
556 BlockDriverState
*bs
;
557 BlockDriver
*drv
, *proto_drv
;
562 qerror_report(QERR_MISSING_PARAMETER
, "snapshot_file");
567 bs
= bdrv_find(device
);
569 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
578 drv
= bdrv_find_format(format
);
580 qerror_report(QERR_INVALID_BLOCK_FORMAT
, format
);
585 proto_drv
= bdrv_find_protocol(filename
);
587 qerror_report(QERR_INVALID_BLOCK_FORMAT
, format
);
592 ret
= bdrv_img_create(filename
, format
, bs
->filename
,
593 bs
->drv
->format_name
, NULL
, -1, bs
->open_flags
);
601 flags
= bs
->open_flags
;
603 ret
= bdrv_open(bs
, filename
, flags
, drv
);
605 * If reopening the image file we just created fails, we really
619 static int eject_device(Monitor
*mon
, BlockDriverState
*bs
, int force
)
622 if (!bdrv_is_removable(bs
)) {
623 qerror_report(QERR_DEVICE_NOT_REMOVABLE
,
624 bdrv_get_device_name(bs
));
627 if (bdrv_is_locked(bs
)) {
628 qerror_report(QERR_DEVICE_LOCKED
, bdrv_get_device_name(bs
));
636 int do_eject(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
638 BlockDriverState
*bs
;
639 int force
= qdict_get_try_bool(qdict
, "force", 0);
640 const char *filename
= qdict_get_str(qdict
, "device");
642 bs
= bdrv_find(filename
);
644 qerror_report(QERR_DEVICE_NOT_FOUND
, filename
);
647 return eject_device(mon
, bs
, force
);
650 int do_block_set_passwd(Monitor
*mon
, const QDict
*qdict
,
653 BlockDriverState
*bs
;
656 bs
= bdrv_find(qdict_get_str(qdict
, "device"));
658 qerror_report(QERR_DEVICE_NOT_FOUND
, qdict_get_str(qdict
, "device"));
662 err
= bdrv_set_key(bs
, qdict_get_str(qdict
, "password"));
663 if (err
== -EINVAL
) {
664 qerror_report(QERR_DEVICE_NOT_ENCRYPTED
, bdrv_get_device_name(bs
));
666 } else if (err
< 0) {
667 qerror_report(QERR_INVALID_PASSWORD
);
674 int do_change_block(Monitor
*mon
, const char *device
,
675 const char *filename
, const char *fmt
)
677 BlockDriverState
*bs
;
678 BlockDriver
*drv
= NULL
;
681 bs
= bdrv_find(device
);
683 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
687 drv
= bdrv_find_whitelisted_format(fmt
);
689 qerror_report(QERR_INVALID_BLOCK_FORMAT
, fmt
);
693 if (eject_device(mon
, bs
, 0) < 0) {
696 bdrv_flags
= bdrv_is_read_only(bs
) ? 0 : BDRV_O_RDWR
;
697 bdrv_flags
|= bdrv_is_snapshot(bs
) ? BDRV_O_SNAPSHOT
: 0;
698 if (bdrv_open(bs
, filename
, bdrv_flags
, drv
) < 0) {
699 qerror_report(QERR_OPEN_FILE_FAILED
, filename
);
702 return monitor_read_bdrv_key_start(mon
, bs
, NULL
, NULL
);
705 int do_drive_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
707 const char *id
= qdict_get_str(qdict
, "id");
708 BlockDriverState
*bs
;
709 BlockDriverState
**ptr
;
714 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
718 /* quiesce block driver; prevent further io */
723 /* clean up guest state from pointing to host resource by
724 * finding and removing DeviceState "drive" property */
726 for (prop
= bs
->peer
->info
->props
; prop
&& prop
->name
; prop
++) {
727 if (prop
->info
->type
== PROP_TYPE_DRIVE
) {
728 ptr
= qdev_get_prop_ptr(bs
->peer
, prop
);
730 bdrv_detach(bs
, bs
->peer
);
738 /* clean up host side */
739 drive_uninit(drive_get_by_blockdev(bs
));
745 * XXX: replace the QERR_UNDEFINED_ERROR errors with real values once the
746 * existing QERR_ macro mess is cleaned up. A good example for better
747 * error reports can be found in the qemu-img resize code.
749 int do_block_resize(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
751 const char *device
= qdict_get_str(qdict
, "device");
752 int64_t size
= qdict_get_int(qdict
, "size");
753 BlockDriverState
*bs
;
755 bs
= bdrv_find(device
);
757 qerror_report(QERR_DEVICE_NOT_FOUND
, device
);
762 qerror_report(QERR_UNDEFINED_ERROR
);
766 if (bdrv_truncate(bs
, size
)) {
767 qerror_report(QERR_UNDEFINED_ERROR
);