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"
17 #include "block_int.h"
19 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
21 static const char *const if_name[IF_COUNT] = {
25 [IF_FLOPPY] = "floppy",
26 [IF_PFLASH] = "pflash",
29 [IF_VIRTIO] = "virtio",
33 static const int if_max_devs[IF_COUNT] = {
35 * Do not change these numbers! They govern how drive option
36 * index maps to unit and bus. That mapping is ABI.
38 * All controllers used to imlement if=T drives need to support
39 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
40 * Otherwise, some index values map to "impossible" bus, unit
43 * For instance, if you change [IF_SCSI] to 255, -drive
44 * if=scsi,index=12 no longer means bus=1,unit=5, but
45 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
46 * the drive can't be set up. Regression.
53 * We automatically delete the drive when a device using it gets
54 * unplugged. Questionable feature, but we can't just drop it.
55 * Device models call blockdev_mark_auto_del() to schedule the
56 * automatic deletion, and generic qdev code calls blockdev_auto_del()
57 * when deletion is actually safe.
59 void blockdev_mark_auto_del(BlockDriverState *bs)
61 DriveInfo *dinfo = drive_get_by_blockdev(bs);
68 void blockdev_auto_del(BlockDriverState *bs)
70 DriveInfo *dinfo = drive_get_by_blockdev(bs);
72 if (dinfo && dinfo->auto_del) {
77 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
79 int max_devs = if_max_devs[type];
80 return max_devs ? index / max_devs : 0;
83 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
85 int max_devs = if_max_devs[type];
86 return max_devs ? index % max_devs : index;
89 QemuOpts *drive_def(const char *optstr)
91 return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
94 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
100 opts = drive_def(optstr);
104 if (type != IF_DEFAULT) {
105 qemu_opt_set(opts, "if", if_name[type]);
108 snprintf(buf, sizeof(buf), "%d", index);
109 qemu_opt_set(opts, "index", buf);
112 qemu_opt_set(opts, "file", file);
116 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
120 /* seek interface, bus and unit */
122 QTAILQ_FOREACH(dinfo, &drives, next) {
123 if (dinfo->type == type &&
132 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
134 return drive_get(type,
135 drive_index_to_bus_id(type, index),
136 drive_index_to_unit_id(type, index));
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 static void drive_uninit(DriveInfo *dinfo)
182 qemu_opts_del(dinfo->opts);
183 bdrv_delete(dinfo->bdrv);
185 QTAILQ_REMOVE(&drives, dinfo, next);
189 void drive_put_ref(DriveInfo *dinfo)
191 assert(dinfo->refcount);
192 if (--dinfo->refcount == 0) {
197 void drive_get_ref(DriveInfo *dinfo)
202 static int parse_block_error_action(const char *buf, int is_read)
204 if (!strcmp(buf, "ignore")) {
205 return BLOCK_ERR_IGNORE;
206 } else if (!is_read && !strcmp(buf, "enospc")) {
207 return BLOCK_ERR_STOP_ENOSPC;
208 } else if (!strcmp(buf, "stop")) {
209 return BLOCK_ERR_STOP_ANY;
210 } else if (!strcmp(buf, "report")) {
211 return BLOCK_ERR_REPORT;
213 error_report("'%s' invalid %s error action",
214 buf, is_read ? "read" : "write");
219 DriveInfo *drive_init(QemuOpts *opts, int default_to_scsi)
222 const char *file = NULL;
225 const char *mediastr = "";
226 BlockInterfaceType type;
227 enum { MEDIA_DISK, MEDIA_CDROM } media;
229 int cyls, heads, secs, translation;
230 BlockDriver *drv = NULL;
235 int on_read_error, on_write_error;
241 translation = BIOS_ATA_TRANSLATION_AUTO;
244 /* extract parameters */
245 bus_id = qemu_opt_get_number(opts, "bus", 0);
246 unit_id = qemu_opt_get_number(opts, "unit", -1);
247 index = qemu_opt_get_number(opts, "index", -1);
249 cyls = qemu_opt_get_number(opts, "cyls", 0);
250 heads = qemu_opt_get_number(opts, "heads", 0);
251 secs = qemu_opt_get_number(opts, "secs", 0);
253 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
254 ro = qemu_opt_get_bool(opts, "readonly", 0);
256 file = qemu_opt_get(opts, "file");
257 serial = qemu_opt_get(opts, "serial");
259 if ((buf = qemu_opt_get(opts, "if")) != NULL) {
260 pstrcpy(devname, sizeof(devname), buf);
261 for (type = 0; type < IF_COUNT && strcmp(buf, if_name[type]); type++)
263 if (type == IF_COUNT) {
264 error_report("unsupported bus type '%s'", buf);
268 type = default_to_scsi ? IF_SCSI : IF_IDE;
269 pstrcpy(devname, sizeof(devname), if_name[type]);
272 max_devs = if_max_devs[type];
274 if (cyls || heads || secs) {
275 if (cyls < 1 || (type == IF_IDE && cyls > 16383)) {
276 error_report("invalid physical cyls number");
279 if (heads < 1 || (type == IF_IDE && heads > 16)) {
280 error_report("invalid physical heads number");
283 if (secs < 1 || (type == IF_IDE && secs > 63)) {
284 error_report("invalid physical secs number");
289 if ((buf = qemu_opt_get(opts, "trans")) != NULL) {
291 error_report("'%s' trans must be used with cyls, heads and secs",
295 if (!strcmp(buf, "none"))
296 translation = BIOS_ATA_TRANSLATION_NONE;
297 else if (!strcmp(buf, "lba"))
298 translation = BIOS_ATA_TRANSLATION_LBA;
299 else if (!strcmp(buf, "auto"))
300 translation = BIOS_ATA_TRANSLATION_AUTO;
302 error_report("'%s' invalid translation type", buf);
307 if ((buf = qemu_opt_get(opts, "media")) != NULL) {
308 if (!strcmp(buf, "disk")) {
310 } else if (!strcmp(buf, "cdrom")) {
311 if (cyls || secs || heads) {
312 error_report("CHS can't be set with media=%s", buf);
317 error_report("'%s' invalid media", buf);
322 if ((buf = qemu_opt_get(opts, "cache")) != NULL) {
323 if (bdrv_parse_cache_flags(buf, &bdrv_flags) != 0) {
324 error_report("invalid cache option");
329 #ifdef CONFIG_LINUX_AIO
330 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
331 if (!strcmp(buf, "native")) {
332 bdrv_flags |= BDRV_O_NATIVE_AIO;
333 } else if (!strcmp(buf, "threads")) {
334 /* this is the default */
336 error_report("invalid aio option");
342 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
343 if (strcmp(buf, "?") == 0) {
344 error_printf("Supported formats:");
345 bdrv_iterate_format(bdrv_format_print, NULL);
349 drv = bdrv_find_whitelisted_format(buf);
351 error_report("'%s' invalid format", buf);
356 on_write_error = BLOCK_ERR_STOP_ENOSPC;
357 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
358 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO && type != IF_NONE) {
359 error_report("werror is not supported by this bus type");
363 on_write_error = parse_block_error_action(buf, 0);
364 if (on_write_error < 0) {
369 on_read_error = BLOCK_ERR_REPORT;
370 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
371 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI && type != IF_NONE) {
372 error_report("rerror is not supported by this bus type");
376 on_read_error = parse_block_error_action(buf, 1);
377 if (on_read_error < 0) {
382 if ((devaddr = qemu_opt_get(opts, "addr")) != NULL) {
383 if (type != IF_VIRTIO) {
384 error_report("addr is not supported by this bus type");
389 /* compute bus and unit according index */
392 if (bus_id != 0 || unit_id != -1) {
393 error_report("index cannot be used with bus and unit");
396 bus_id = drive_index_to_bus_id(type, index);
397 unit_id = drive_index_to_unit_id(type, index);
400 /* if user doesn't specify a unit_id,
401 * try to find the first free
406 while (drive_get(type, bus_id, unit_id) != NULL) {
408 if (max_devs && unit_id >= max_devs) {
417 if (max_devs && unit_id >= max_devs) {
418 error_report("unit %d too big (max is %d)",
419 unit_id, max_devs - 1);
424 * catch multiple definitions
427 if (drive_get(type, bus_id, unit_id) != NULL) {
428 error_report("drive with bus=%d, unit=%d (index=%d) exists",
429 bus_id, unit_id, index);
435 dinfo = g_malloc0(sizeof(*dinfo));
436 if ((buf = qemu_opts_id(opts)) != NULL) {
437 dinfo->id = g_strdup(buf);
439 /* no id supplied -> create one */
440 dinfo->id = g_malloc0(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;
458 strncpy(dinfo->serial, serial, sizeof(dinfo->serial) - 1);
459 QTAILQ_INSERT_TAIL(&drives, dinfo, next);
461 bdrv_set_on_error(dinfo->bdrv, on_read_error, on_write_error);
471 bdrv_set_geometry_hint(dinfo->bdrv, cyls, heads, secs);
472 bdrv_set_translation_hint(dinfo->bdrv, translation);
486 /* add virtio block device */
487 opts = qemu_opts_create(qemu_find_opts("device"), NULL, 0);
488 qemu_opt_set(opts, "driver", "virtio-blk");
489 qemu_opt_set(opts, "drive", dinfo->id);
491 qemu_opt_set(opts, "addr", devaddr);
496 if (!file || !*file) {
500 /* always use cache=unsafe with snapshot */
501 bdrv_flags &= ~BDRV_O_CACHE_MASK;
502 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
505 if (media == MEDIA_CDROM) {
506 /* CDROM is fine for any interface, don't check. */
508 } else if (ro == 1) {
509 if (type != IF_SCSI && type != IF_VIRTIO && type != IF_FLOPPY && type != IF_NONE) {
510 error_report("readonly not supported by this bus type");
515 bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
517 ret = bdrv_open(dinfo->bdrv, file, bdrv_flags, drv);
519 error_report("could not open disk image %s: %s",
520 file, strerror(-ret));
524 if (bdrv_key_required(dinfo->bdrv))
529 bdrv_delete(dinfo->bdrv);
531 QTAILQ_REMOVE(&drives, dinfo, next);
536 void do_commit(Monitor *mon, const QDict *qdict)
538 const char *device = qdict_get_str(qdict, "device");
539 BlockDriverState *bs;
541 if (!strcmp(device, "all")) {
544 bs = bdrv_find(device);
546 qerror_report(QERR_DEVICE_NOT_FOUND, device);
553 int do_snapshot_blkdev(Monitor *mon, const QDict *qdict, QObject **ret_data)
555 const char *device = qdict_get_str(qdict, "device");
556 const char *filename = qdict_get_try_str(qdict, "snapshot-file");
557 const char *format = qdict_get_try_str(qdict, "format");
558 BlockDriverState *bs;
559 BlockDriver *drv, *old_drv, *proto_drv;
562 char old_filename[1024];
565 qerror_report(QERR_MISSING_PARAMETER, "snapshot-file");
570 bs = bdrv_find(device);
572 qerror_report(QERR_DEVICE_NOT_FOUND, device);
577 pstrcpy(old_filename, sizeof(old_filename), bs->filename);
580 flags = bs->open_flags;
586 drv = bdrv_find_format(format);
588 qerror_report(QERR_INVALID_BLOCK_FORMAT, format);
593 proto_drv = bdrv_find_protocol(filename);
595 qerror_report(QERR_INVALID_BLOCK_FORMAT, format);
600 ret = bdrv_img_create(filename, format, bs->filename,
601 bs->drv->format_name, NULL, -1, flags);
610 ret = bdrv_open(bs, filename, flags, drv);
612 * If reopening the image file we just created fails, fall back
613 * and try to re-open the original image. If that fails too, we
614 * are in serious trouble.
617 ret = bdrv_open(bs, old_filename, flags, old_drv);
619 qerror_report(QERR_OPEN_FILE_FAILED, old_filename);
621 qerror_report(QERR_OPEN_FILE_FAILED, filename);
632 static int eject_device(Monitor *mon, BlockDriverState *bs, int force)
634 if (!bdrv_dev_has_removable_media(bs)) {
635 qerror_report(QERR_DEVICE_NOT_REMOVABLE, bdrv_get_device_name(bs));
638 if (!force && !bdrv_dev_is_tray_open(bs)
639 && bdrv_dev_is_medium_locked(bs)) {
640 qerror_report(QERR_DEVICE_LOCKED, bdrv_get_device_name(bs));
647 int do_eject(Monitor *mon, const QDict *qdict, QObject **ret_data)
649 BlockDriverState *bs;
650 int force = qdict_get_try_bool(qdict, "force", 0);
651 const char *filename = qdict_get_str(qdict, "device");
653 bs = bdrv_find(filename);
655 qerror_report(QERR_DEVICE_NOT_FOUND, filename);
658 return eject_device(mon, bs, force);
661 int do_block_set_passwd(Monitor *mon, const QDict *qdict,
664 BlockDriverState *bs;
667 bs = bdrv_find(qdict_get_str(qdict, "device"));
669 qerror_report(QERR_DEVICE_NOT_FOUND, qdict_get_str(qdict, "device"));
673 err = bdrv_set_key(bs, qdict_get_str(qdict, "password"));
674 if (err == -EINVAL) {
675 qerror_report(QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
677 } else if (err < 0) {
678 qerror_report(QERR_INVALID_PASSWORD);
685 int do_change_block(Monitor *mon, const char *device,
686 const char *filename, const char *fmt)
688 BlockDriverState *bs;
689 BlockDriver *drv = NULL;
692 bs = bdrv_find(device);
694 qerror_report(QERR_DEVICE_NOT_FOUND, device);
698 drv = bdrv_find_whitelisted_format(fmt);
700 qerror_report(QERR_INVALID_BLOCK_FORMAT, fmt);
704 if (eject_device(mon, bs, 0) < 0) {
707 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
708 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
709 if (bdrv_open(bs, filename, bdrv_flags, drv) < 0) {
710 qerror_report(QERR_OPEN_FILE_FAILED, filename);
713 return monitor_read_bdrv_key_start(mon, bs, NULL, NULL);
716 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
718 const char *id = qdict_get_str(qdict, "id");
719 BlockDriverState *bs;
723 qerror_report(QERR_DEVICE_NOT_FOUND, id);
726 if (bdrv_in_use(bs)) {
727 qerror_report(QERR_DEVICE_IN_USE, id);
731 /* quiesce block driver; prevent further io */
736 /* if we have a device attached to this BlockDriverState
737 * then we need to make the drive anonymous until the device
738 * can be removed. If this is a drive with no device backing
739 * then we can just get rid of the block driver state right here.
741 if (bdrv_get_attached_dev(bs)) {
744 drive_uninit(drive_get_by_blockdev(bs));
751 * XXX: replace the QERR_UNDEFINED_ERROR errors with real values once the
752 * existing QERR_ macro mess is cleaned up. A good example for better
753 * error reports can be found in the qemu-img resize code.
755 int do_block_resize(Monitor *mon, const QDict *qdict, QObject **ret_data)
757 const char *device = qdict_get_str(qdict, "device");
758 int64_t size = qdict_get_int(qdict, "size");
759 BlockDriverState *bs;
761 bs = bdrv_find(device);
763 qerror_report(QERR_DEVICE_NOT_FOUND, device);
768 qerror_report(QERR_UNDEFINED_ERROR);
772 if (bdrv_truncate(bs, size)) {
773 qerror_report(QERR_UNDEFINED_ERROR);