]> git.proxmox.com Git - qemu.git/blob - blockdev.c
52996eada38b7b8d92232747bc2613767c8f0e97
[qemu.git] / blockdev.c
1 /*
2 * QEMU host block devices
3 *
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 *
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.
8 *
9 * This file incorporates work covered by the following copyright and
10 * permission notice:
11 *
12 * Copyright (c) 2003-2008 Fabrice Bellard
13 *
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:
20 *
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
23 *
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
30 * THE SOFTWARE.
31 */
32
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"
44 #include "trace.h"
45 #include "sysemu/arch_init.h"
46
47 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
48 extern QemuOptsList qemu_common_drive_opts;
49
50 static const char *const if_name[IF_COUNT] = {
51 [IF_NONE] = "none",
52 [IF_IDE] = "ide",
53 [IF_SCSI] = "scsi",
54 [IF_FLOPPY] = "floppy",
55 [IF_PFLASH] = "pflash",
56 [IF_MTD] = "mtd",
57 [IF_SD] = "sd",
58 [IF_VIRTIO] = "virtio",
59 [IF_XEN] = "xen",
60 };
61
62 static const int if_max_devs[IF_COUNT] = {
63 /*
64 * Do not change these numbers! They govern how drive option
65 * index maps to unit and bus. That mapping is ABI.
66 *
67 * All controllers used to imlement if=T drives need to support
68 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
69 * Otherwise, some index values map to "impossible" bus, unit
70 * values.
71 *
72 * For instance, if you change [IF_SCSI] to 255, -drive
73 * if=scsi,index=12 no longer means bus=1,unit=5, but
74 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
75 * the drive can't be set up. Regression.
76 */
77 [IF_IDE] = 2,
78 [IF_SCSI] = 7,
79 };
80
81 /*
82 * We automatically delete the drive when a device using it gets
83 * unplugged. Questionable feature, but we can't just drop it.
84 * Device models call blockdev_mark_auto_del() to schedule the
85 * automatic deletion, and generic qdev code calls blockdev_auto_del()
86 * when deletion is actually safe.
87 */
88 void blockdev_mark_auto_del(BlockDriverState *bs)
89 {
90 DriveInfo *dinfo = drive_get_by_blockdev(bs);
91
92 if (dinfo && !dinfo->enable_auto_del) {
93 return;
94 }
95
96 if (bs->job) {
97 block_job_cancel(bs->job);
98 }
99 if (dinfo) {
100 dinfo->auto_del = 1;
101 }
102 }
103
104 void blockdev_auto_del(BlockDriverState *bs)
105 {
106 DriveInfo *dinfo = drive_get_by_blockdev(bs);
107
108 if (dinfo && dinfo->auto_del) {
109 drive_put_ref(dinfo);
110 }
111 }
112
113 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
114 {
115 int max_devs = if_max_devs[type];
116 return max_devs ? index / max_devs : 0;
117 }
118
119 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
120 {
121 int max_devs = if_max_devs[type];
122 return max_devs ? index % max_devs : index;
123 }
124
125 QemuOpts *drive_def(const char *optstr)
126 {
127 return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
128 }
129
130 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
131 const char *optstr)
132 {
133 QemuOpts *opts;
134 char buf[32];
135
136 opts = drive_def(optstr);
137 if (!opts) {
138 return NULL;
139 }
140 if (type != IF_DEFAULT) {
141 qemu_opt_set(opts, "if", if_name[type]);
142 }
143 if (index >= 0) {
144 snprintf(buf, sizeof(buf), "%d", index);
145 qemu_opt_set(opts, "index", buf);
146 }
147 if (file)
148 qemu_opt_set(opts, "file", file);
149 return opts;
150 }
151
152 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
153 {
154 DriveInfo *dinfo;
155
156 /* seek interface, bus and unit */
157
158 QTAILQ_FOREACH(dinfo, &drives, next) {
159 if (dinfo->type == type &&
160 dinfo->bus == bus &&
161 dinfo->unit == unit)
162 return dinfo;
163 }
164
165 return NULL;
166 }
167
168 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
169 {
170 return drive_get(type,
171 drive_index_to_bus_id(type, index),
172 drive_index_to_unit_id(type, index));
173 }
174
175 int drive_get_max_bus(BlockInterfaceType type)
176 {
177 int max_bus;
178 DriveInfo *dinfo;
179
180 max_bus = -1;
181 QTAILQ_FOREACH(dinfo, &drives, next) {
182 if(dinfo->type == type &&
183 dinfo->bus > max_bus)
184 max_bus = dinfo->bus;
185 }
186 return max_bus;
187 }
188
189 /* Get a block device. This should only be used for single-drive devices
190 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
191 appropriate bus. */
192 DriveInfo *drive_get_next(BlockInterfaceType type)
193 {
194 static int next_block_unit[IF_COUNT];
195
196 return drive_get(type, 0, next_block_unit[type]++);
197 }
198
199 DriveInfo *drive_get_by_blockdev(BlockDriverState *bs)
200 {
201 DriveInfo *dinfo;
202
203 QTAILQ_FOREACH(dinfo, &drives, next) {
204 if (dinfo->bdrv == bs) {
205 return dinfo;
206 }
207 }
208 return NULL;
209 }
210
211 static void bdrv_format_print(void *opaque, const char *name)
212 {
213 error_printf(" %s", name);
214 }
215
216 static void drive_uninit(DriveInfo *dinfo)
217 {
218 qemu_opts_del(dinfo->opts);
219 bdrv_unref(dinfo->bdrv);
220 g_free(dinfo->id);
221 QTAILQ_REMOVE(&drives, dinfo, next);
222 g_free(dinfo->serial);
223 g_free(dinfo);
224 }
225
226 void drive_put_ref(DriveInfo *dinfo)
227 {
228 assert(dinfo->refcount);
229 if (--dinfo->refcount == 0) {
230 drive_uninit(dinfo);
231 }
232 }
233
234 void drive_get_ref(DriveInfo *dinfo)
235 {
236 dinfo->refcount++;
237 }
238
239 typedef struct {
240 QEMUBH *bh;
241 BlockDriverState *bs;
242 } BDRVPutRefBH;
243
244 static void bdrv_put_ref_bh(void *opaque)
245 {
246 BDRVPutRefBH *s = opaque;
247
248 bdrv_unref(s->bs);
249 qemu_bh_delete(s->bh);
250 g_free(s);
251 }
252
253 /*
254 * Release a BDS reference in a BH
255 *
256 * It is not safe to use bdrv_unref() from a callback function when the callers
257 * still need the BlockDriverState. In such cases we schedule a BH to release
258 * the reference.
259 */
260 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
261 {
262 BDRVPutRefBH *s;
263
264 s = g_new(BDRVPutRefBH, 1);
265 s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
266 s->bs = bs;
267 qemu_bh_schedule(s->bh);
268 }
269
270 static int parse_block_error_action(const char *buf, bool is_read)
271 {
272 if (!strcmp(buf, "ignore")) {
273 return BLOCKDEV_ON_ERROR_IGNORE;
274 } else if (!is_read && !strcmp(buf, "enospc")) {
275 return BLOCKDEV_ON_ERROR_ENOSPC;
276 } else if (!strcmp(buf, "stop")) {
277 return BLOCKDEV_ON_ERROR_STOP;
278 } else if (!strcmp(buf, "report")) {
279 return BLOCKDEV_ON_ERROR_REPORT;
280 } else {
281 error_report("'%s' invalid %s error action",
282 buf, is_read ? "read" : "write");
283 return -1;
284 }
285 }
286
287 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
288 {
289 if (throttle_conflicting(cfg)) {
290 error_setg(errp, "bps/iops/max total values and read/write values"
291 " cannot be used at the same time");
292 return false;
293 }
294
295 if (!throttle_is_valid(cfg)) {
296 error_setg(errp, "bps/iops/maxs values must be 0 or greater");
297 return false;
298 }
299
300 return true;
301 }
302
303 static DriveInfo *blockdev_init(QemuOpts *all_opts,
304 BlockInterfaceType block_default_type)
305 {
306 const char *buf;
307 const char *file = NULL;
308 const char *serial;
309 const char *mediastr = "";
310 BlockInterfaceType type;
311 enum { MEDIA_DISK, MEDIA_CDROM } media;
312 int bus_id, unit_id;
313 int cyls, heads, secs, translation;
314 int max_devs;
315 int index;
316 int ro = 0;
317 int bdrv_flags = 0;
318 int on_read_error, on_write_error;
319 const char *devaddr;
320 DriveInfo *dinfo;
321 ThrottleConfig cfg;
322 int snapshot = 0;
323 bool copy_on_read;
324 int ret;
325 Error *error = NULL;
326 QemuOpts *opts;
327 QDict *bs_opts;
328 const char *id;
329 bool has_driver_specific_opts;
330 BlockDriver *drv = NULL;
331
332 translation = BIOS_ATA_TRANSLATION_AUTO;
333 media = MEDIA_DISK;
334
335 /* Check common options by copying from all_opts to opts, all other options
336 * are stored in bs_opts. */
337 id = qemu_opts_id(all_opts);
338 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
339 if (error_is_set(&error)) {
340 qerror_report_err(error);
341 error_free(error);
342 return NULL;
343 }
344
345 bs_opts = qdict_new();
346 qemu_opts_to_qdict(all_opts, bs_opts);
347 qemu_opts_absorb_qdict(opts, bs_opts, &error);
348 if (error_is_set(&error)) {
349 qerror_report_err(error);
350 error_free(error);
351 return NULL;
352 }
353
354 if (id) {
355 qdict_del(bs_opts, "id");
356 }
357
358 has_driver_specific_opts = !!qdict_size(bs_opts);
359
360 /* extract parameters */
361 bus_id = qemu_opt_get_number(opts, "bus", 0);
362 unit_id = qemu_opt_get_number(opts, "unit", -1);
363 index = qemu_opt_get_number(opts, "index", -1);
364
365 cyls = qemu_opt_get_number(opts, "cyls", 0);
366 heads = qemu_opt_get_number(opts, "heads", 0);
367 secs = qemu_opt_get_number(opts, "secs", 0);
368
369 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
370 ro = qemu_opt_get_bool(opts, "read-only", 0);
371 copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
372
373 file = qemu_opt_get(opts, "file");
374 serial = qemu_opt_get(opts, "serial");
375
376 if ((buf = qemu_opt_get(opts, "if")) != NULL) {
377 for (type = 0; type < IF_COUNT && strcmp(buf, if_name[type]); type++)
378 ;
379 if (type == IF_COUNT) {
380 error_report("unsupported bus type '%s'", buf);
381 return NULL;
382 }
383 } else {
384 type = block_default_type;
385 }
386
387 max_devs = if_max_devs[type];
388
389 if (cyls || heads || secs) {
390 if (cyls < 1) {
391 error_report("invalid physical cyls number");
392 return NULL;
393 }
394 if (heads < 1) {
395 error_report("invalid physical heads number");
396 return NULL;
397 }
398 if (secs < 1) {
399 error_report("invalid physical secs number");
400 return NULL;
401 }
402 }
403
404 if ((buf = qemu_opt_get(opts, "trans")) != NULL) {
405 if (!cyls) {
406 error_report("'%s' trans must be used with cyls, heads and secs",
407 buf);
408 return NULL;
409 }
410 if (!strcmp(buf, "none"))
411 translation = BIOS_ATA_TRANSLATION_NONE;
412 else if (!strcmp(buf, "lba"))
413 translation = BIOS_ATA_TRANSLATION_LBA;
414 else if (!strcmp(buf, "auto"))
415 translation = BIOS_ATA_TRANSLATION_AUTO;
416 else {
417 error_report("'%s' invalid translation type", buf);
418 return NULL;
419 }
420 }
421
422 if ((buf = qemu_opt_get(opts, "media")) != NULL) {
423 if (!strcmp(buf, "disk")) {
424 media = MEDIA_DISK;
425 } else if (!strcmp(buf, "cdrom")) {
426 if (cyls || secs || heads) {
427 error_report("CHS can't be set with media=%s", buf);
428 return NULL;
429 }
430 media = MEDIA_CDROM;
431 } else {
432 error_report("'%s' invalid media", buf);
433 return NULL;
434 }
435 }
436
437 if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
438 if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
439 error_report("invalid discard option");
440 return NULL;
441 }
442 }
443
444 if (qemu_opt_get_bool(opts, "cache.writeback", true)) {
445 bdrv_flags |= BDRV_O_CACHE_WB;
446 }
447 if (qemu_opt_get_bool(opts, "cache.direct", false)) {
448 bdrv_flags |= BDRV_O_NOCACHE;
449 }
450 if (qemu_opt_get_bool(opts, "cache.no-flush", false)) {
451 bdrv_flags |= BDRV_O_NO_FLUSH;
452 }
453
454 #ifdef CONFIG_LINUX_AIO
455 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
456 if (!strcmp(buf, "native")) {
457 bdrv_flags |= BDRV_O_NATIVE_AIO;
458 } else if (!strcmp(buf, "threads")) {
459 /* this is the default */
460 } else {
461 error_report("invalid aio option");
462 return NULL;
463 }
464 }
465 #endif
466
467 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
468 if (is_help_option(buf)) {
469 error_printf("Supported formats:");
470 bdrv_iterate_format(bdrv_format_print, NULL);
471 error_printf("\n");
472 return NULL;
473 }
474
475 drv = bdrv_find_format(buf);
476 if (!drv) {
477 error_report("'%s' invalid format", buf);
478 return NULL;
479 }
480 }
481
482 /* disk I/O throttling */
483 memset(&cfg, 0, sizeof(cfg));
484 cfg.buckets[THROTTLE_BPS_TOTAL].avg =
485 qemu_opt_get_number(opts, "throttling.bps-total", 0);
486 cfg.buckets[THROTTLE_BPS_READ].avg =
487 qemu_opt_get_number(opts, "throttling.bps-read", 0);
488 cfg.buckets[THROTTLE_BPS_WRITE].avg =
489 qemu_opt_get_number(opts, "throttling.bps-write", 0);
490 cfg.buckets[THROTTLE_OPS_TOTAL].avg =
491 qemu_opt_get_number(opts, "throttling.iops-total", 0);
492 cfg.buckets[THROTTLE_OPS_READ].avg =
493 qemu_opt_get_number(opts, "throttling.iops-read", 0);
494 cfg.buckets[THROTTLE_OPS_WRITE].avg =
495 qemu_opt_get_number(opts, "throttling.iops-write", 0);
496
497 cfg.buckets[THROTTLE_BPS_TOTAL].max =
498 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
499 cfg.buckets[THROTTLE_BPS_READ].max =
500 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
501 cfg.buckets[THROTTLE_BPS_WRITE].max =
502 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
503 cfg.buckets[THROTTLE_OPS_TOTAL].max =
504 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
505 cfg.buckets[THROTTLE_OPS_READ].max =
506 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
507 cfg.buckets[THROTTLE_OPS_WRITE].max =
508 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
509
510 cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
511
512 if (!check_throttle_config(&cfg, &error)) {
513 error_report("%s", error_get_pretty(error));
514 error_free(error);
515 return NULL;
516 }
517
518 if (qemu_opt_get(opts, "boot") != NULL) {
519 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
520 "ignored. Future versions will reject this parameter. Please "
521 "update your scripts.\n");
522 }
523
524 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
525 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
526 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO && type != IF_NONE) {
527 error_report("werror is not supported by this bus type");
528 return NULL;
529 }
530
531 on_write_error = parse_block_error_action(buf, 0);
532 if (on_write_error < 0) {
533 return NULL;
534 }
535 }
536
537 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
538 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
539 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI && type != IF_NONE) {
540 error_report("rerror is not supported by this bus type");
541 return NULL;
542 }
543
544 on_read_error = parse_block_error_action(buf, 1);
545 if (on_read_error < 0) {
546 return NULL;
547 }
548 }
549
550 if ((devaddr = qemu_opt_get(opts, "addr")) != NULL) {
551 if (type != IF_VIRTIO) {
552 error_report("addr is not supported by this bus type");
553 return NULL;
554 }
555 }
556
557 /* compute bus and unit according index */
558
559 if (index != -1) {
560 if (bus_id != 0 || unit_id != -1) {
561 error_report("index cannot be used with bus and unit");
562 return NULL;
563 }
564 bus_id = drive_index_to_bus_id(type, index);
565 unit_id = drive_index_to_unit_id(type, index);
566 }
567
568 /* if user doesn't specify a unit_id,
569 * try to find the first free
570 */
571
572 if (unit_id == -1) {
573 unit_id = 0;
574 while (drive_get(type, bus_id, unit_id) != NULL) {
575 unit_id++;
576 if (max_devs && unit_id >= max_devs) {
577 unit_id -= max_devs;
578 bus_id++;
579 }
580 }
581 }
582
583 /* check unit id */
584
585 if (max_devs && unit_id >= max_devs) {
586 error_report("unit %d too big (max is %d)",
587 unit_id, max_devs - 1);
588 return NULL;
589 }
590
591 /*
592 * catch multiple definitions
593 */
594
595 if (drive_get(type, bus_id, unit_id) != NULL) {
596 error_report("drive with bus=%d, unit=%d (index=%d) exists",
597 bus_id, unit_id, index);
598 return NULL;
599 }
600
601 /* init */
602
603 dinfo = g_malloc0(sizeof(*dinfo));
604 if ((buf = qemu_opts_id(opts)) != NULL) {
605 dinfo->id = g_strdup(buf);
606 } else {
607 /* no id supplied -> create one */
608 dinfo->id = g_malloc0(32);
609 if (type == IF_IDE || type == IF_SCSI)
610 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
611 if (max_devs)
612 snprintf(dinfo->id, 32, "%s%i%s%i",
613 if_name[type], bus_id, mediastr, unit_id);
614 else
615 snprintf(dinfo->id, 32, "%s%s%i",
616 if_name[type], mediastr, unit_id);
617 }
618 dinfo->bdrv = bdrv_new(dinfo->id);
619 dinfo->bdrv->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
620 dinfo->bdrv->read_only = ro;
621 dinfo->devaddr = devaddr;
622 dinfo->type = type;
623 dinfo->bus = bus_id;
624 dinfo->unit = unit_id;
625 dinfo->cyls = cyls;
626 dinfo->heads = heads;
627 dinfo->secs = secs;
628 dinfo->trans = translation;
629 dinfo->opts = all_opts;
630 dinfo->refcount = 1;
631 if (serial != NULL) {
632 dinfo->serial = g_strdup(serial);
633 }
634 QTAILQ_INSERT_TAIL(&drives, dinfo, next);
635
636 bdrv_set_on_error(dinfo->bdrv, on_read_error, on_write_error);
637
638 /* disk I/O throttling */
639 if (throttle_enabled(&cfg)) {
640 bdrv_io_limits_enable(dinfo->bdrv);
641 bdrv_set_io_limits(dinfo->bdrv, &cfg);
642 }
643
644 switch(type) {
645 case IF_IDE:
646 case IF_SCSI:
647 case IF_XEN:
648 case IF_NONE:
649 dinfo->media_cd = media == MEDIA_CDROM;
650 break;
651 case IF_SD:
652 case IF_FLOPPY:
653 case IF_PFLASH:
654 case IF_MTD:
655 break;
656 case IF_VIRTIO:
657 {
658 /* add virtio block device */
659 QemuOpts *devopts;
660 devopts = qemu_opts_create_nofail(qemu_find_opts("device"));
661 if (arch_type == QEMU_ARCH_S390X) {
662 qemu_opt_set(devopts, "driver", "virtio-blk-s390");
663 } else {
664 qemu_opt_set(devopts, "driver", "virtio-blk-pci");
665 }
666 qemu_opt_set(devopts, "drive", dinfo->id);
667 if (devaddr)
668 qemu_opt_set(devopts, "addr", devaddr);
669 break;
670 }
671 default:
672 abort();
673 }
674 if (!file || !*file) {
675 if (has_driver_specific_opts) {
676 file = NULL;
677 } else {
678 return dinfo;
679 }
680 }
681 if (snapshot) {
682 /* always use cache=unsafe with snapshot */
683 bdrv_flags &= ~BDRV_O_CACHE_MASK;
684 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
685 }
686
687 if (copy_on_read) {
688 bdrv_flags |= BDRV_O_COPY_ON_READ;
689 }
690
691 if (runstate_check(RUN_STATE_INMIGRATE)) {
692 bdrv_flags |= BDRV_O_INCOMING;
693 }
694
695 if (media == MEDIA_CDROM) {
696 /* CDROM is fine for any interface, don't check. */
697 ro = 1;
698 } else if (ro == 1) {
699 if (type != IF_SCSI && type != IF_VIRTIO && type != IF_FLOPPY &&
700 type != IF_NONE && type != IF_PFLASH) {
701 error_report("read-only not supported by this bus type");
702 goto err;
703 }
704 }
705
706 bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
707
708 if (ro && copy_on_read) {
709 error_report("warning: disabling copy_on_read on read-only drive");
710 }
711
712 QINCREF(bs_opts);
713 ret = bdrv_open(dinfo->bdrv, file, bs_opts, bdrv_flags, drv, &error);
714
715 if (ret < 0) {
716 error_report("could not open disk image %s: %s",
717 file ?: dinfo->id, error_get_pretty(error));
718 goto err;
719 }
720
721 if (bdrv_key_required(dinfo->bdrv))
722 autostart = 0;
723
724 QDECREF(bs_opts);
725 qemu_opts_del(opts);
726
727 return dinfo;
728
729 err:
730 qemu_opts_del(opts);
731 QDECREF(bs_opts);
732 bdrv_unref(dinfo->bdrv);
733 g_free(dinfo->id);
734 QTAILQ_REMOVE(&drives, dinfo, next);
735 g_free(dinfo);
736 return NULL;
737 }
738
739 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to)
740 {
741 const char *value;
742
743 value = qemu_opt_get(opts, from);
744 if (value) {
745 qemu_opt_set(opts, to, value);
746 qemu_opt_unset(opts, from);
747 }
748 }
749
750 DriveInfo *drive_init(QemuOpts *all_opts, BlockInterfaceType block_default_type)
751 {
752 const char *value;
753 DriveInfo *dinfo;
754
755 /* Change legacy command line options into QMP ones */
756 qemu_opt_rename(all_opts, "iops", "throttling.iops-total");
757 qemu_opt_rename(all_opts, "iops_rd", "throttling.iops-read");
758 qemu_opt_rename(all_opts, "iops_wr", "throttling.iops-write");
759
760 qemu_opt_rename(all_opts, "bps", "throttling.bps-total");
761 qemu_opt_rename(all_opts, "bps_rd", "throttling.bps-read");
762 qemu_opt_rename(all_opts, "bps_wr", "throttling.bps-write");
763
764 qemu_opt_rename(all_opts, "iops_max", "throttling.iops-total-max");
765 qemu_opt_rename(all_opts, "iops_rd_max", "throttling.iops-read-max");
766 qemu_opt_rename(all_opts, "iops_wr_max", "throttling.iops-write-max");
767
768 qemu_opt_rename(all_opts, "bps_max", "throttling.bps-total-max");
769 qemu_opt_rename(all_opts, "bps_rd_max", "throttling.bps-read-max");
770 qemu_opt_rename(all_opts, "bps_wr_max", "throttling.bps-write-max");
771
772 qemu_opt_rename(all_opts,
773 "iops_size", "throttling.iops-size");
774
775 qemu_opt_rename(all_opts, "readonly", "read-only");
776
777 value = qemu_opt_get(all_opts, "cache");
778 if (value) {
779 int flags = 0;
780
781 if (bdrv_parse_cache_flags(value, &flags) != 0) {
782 error_report("invalid cache option");
783 return NULL;
784 }
785
786 /* Specific options take precedence */
787 if (!qemu_opt_get(all_opts, "cache.writeback")) {
788 qemu_opt_set_bool(all_opts, "cache.writeback",
789 !!(flags & BDRV_O_CACHE_WB));
790 }
791 if (!qemu_opt_get(all_opts, "cache.direct")) {
792 qemu_opt_set_bool(all_opts, "cache.direct",
793 !!(flags & BDRV_O_NOCACHE));
794 }
795 if (!qemu_opt_get(all_opts, "cache.no-flush")) {
796 qemu_opt_set_bool(all_opts, "cache.no-flush",
797 !!(flags & BDRV_O_NO_FLUSH));
798 }
799 qemu_opt_unset(all_opts, "cache");
800 }
801
802 /* Actual block device init: Functionality shared with blockdev-add */
803 dinfo = blockdev_init(all_opts, block_default_type);
804 if (dinfo == NULL) {
805 goto fail;
806 }
807
808 /* Set legacy DriveInfo fields */
809 dinfo->enable_auto_del = true;
810
811 fail:
812 return dinfo;
813 }
814
815 void do_commit(Monitor *mon, const QDict *qdict)
816 {
817 const char *device = qdict_get_str(qdict, "device");
818 BlockDriverState *bs;
819 int ret;
820
821 if (!strcmp(device, "all")) {
822 ret = bdrv_commit_all();
823 } else {
824 bs = bdrv_find(device);
825 if (!bs) {
826 monitor_printf(mon, "Device '%s' not found\n", device);
827 return;
828 }
829 ret = bdrv_commit(bs);
830 }
831 if (ret < 0) {
832 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
833 strerror(-ret));
834 }
835 }
836
837 static void blockdev_do_action(int kind, void *data, Error **errp)
838 {
839 TransactionAction action;
840 TransactionActionList list;
841
842 action.kind = kind;
843 action.data = data;
844 list.value = &action;
845 list.next = NULL;
846 qmp_transaction(&list, errp);
847 }
848
849 void qmp_blockdev_snapshot_sync(const char *device, const char *snapshot_file,
850 bool has_format, const char *format,
851 bool has_mode, enum NewImageMode mode,
852 Error **errp)
853 {
854 BlockdevSnapshot snapshot = {
855 .device = (char *) device,
856 .snapshot_file = (char *) snapshot_file,
857 .has_format = has_format,
858 .format = (char *) format,
859 .has_mode = has_mode,
860 .mode = mode,
861 };
862 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
863 &snapshot, errp);
864 }
865
866 void qmp_blockdev_snapshot_internal_sync(const char *device,
867 const char *name,
868 Error **errp)
869 {
870 BlockdevSnapshotInternal snapshot = {
871 .device = (char *) device,
872 .name = (char *) name
873 };
874
875 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
876 &snapshot, errp);
877 }
878
879 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
880 bool has_id,
881 const char *id,
882 bool has_name,
883 const char *name,
884 Error **errp)
885 {
886 BlockDriverState *bs = bdrv_find(device);
887 QEMUSnapshotInfo sn;
888 Error *local_err = NULL;
889 SnapshotInfo *info = NULL;
890 int ret;
891
892 if (!bs) {
893 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
894 return NULL;
895 }
896
897 if (!has_id) {
898 id = NULL;
899 }
900
901 if (!has_name) {
902 name = NULL;
903 }
904
905 if (!id && !name) {
906 error_setg(errp, "Name or id must be provided");
907 return NULL;
908 }
909
910 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
911 if (error_is_set(&local_err)) {
912 error_propagate(errp, local_err);
913 return NULL;
914 }
915 if (!ret) {
916 error_setg(errp,
917 "Snapshot with id '%s' and name '%s' does not exist on "
918 "device '%s'",
919 STR_OR_NULL(id), STR_OR_NULL(name), device);
920 return NULL;
921 }
922
923 bdrv_snapshot_delete(bs, id, name, &local_err);
924 if (error_is_set(&local_err)) {
925 error_propagate(errp, local_err);
926 return NULL;
927 }
928
929 info = g_malloc0(sizeof(SnapshotInfo));
930 info->id = g_strdup(sn.id_str);
931 info->name = g_strdup(sn.name);
932 info->date_nsec = sn.date_nsec;
933 info->date_sec = sn.date_sec;
934 info->vm_state_size = sn.vm_state_size;
935 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
936 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
937
938 return info;
939 }
940
941 /* New and old BlockDriverState structs for group snapshots */
942
943 typedef struct BlkTransactionState BlkTransactionState;
944
945 /* Only prepare() may fail. In a single transaction, only one of commit() or
946 abort() will be called, clean() will always be called if it present. */
947 typedef struct BdrvActionOps {
948 /* Size of state struct, in bytes. */
949 size_t instance_size;
950 /* Prepare the work, must NOT be NULL. */
951 void (*prepare)(BlkTransactionState *common, Error **errp);
952 /* Commit the changes, can be NULL. */
953 void (*commit)(BlkTransactionState *common);
954 /* Abort the changes on fail, can be NULL. */
955 void (*abort)(BlkTransactionState *common);
956 /* Clean up resource in the end, can be NULL. */
957 void (*clean)(BlkTransactionState *common);
958 } BdrvActionOps;
959
960 /*
961 * This structure must be arranged as first member in child type, assuming
962 * that compiler will also arrange it to the same address with parent instance.
963 * Later it will be used in free().
964 */
965 struct BlkTransactionState {
966 TransactionAction *action;
967 const BdrvActionOps *ops;
968 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
969 };
970
971 /* internal snapshot private data */
972 typedef struct InternalSnapshotState {
973 BlkTransactionState common;
974 BlockDriverState *bs;
975 QEMUSnapshotInfo sn;
976 } InternalSnapshotState;
977
978 static void internal_snapshot_prepare(BlkTransactionState *common,
979 Error **errp)
980 {
981 const char *device;
982 const char *name;
983 BlockDriverState *bs;
984 QEMUSnapshotInfo old_sn, *sn;
985 bool ret;
986 qemu_timeval tv;
987 BlockdevSnapshotInternal *internal;
988 InternalSnapshotState *state;
989 int ret1;
990
991 g_assert(common->action->kind ==
992 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
993 internal = common->action->blockdev_snapshot_internal_sync;
994 state = DO_UPCAST(InternalSnapshotState, common, common);
995
996 /* 1. parse input */
997 device = internal->device;
998 name = internal->name;
999
1000 /* 2. check for validation */
1001 bs = bdrv_find(device);
1002 if (!bs) {
1003 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1004 return;
1005 }
1006
1007 if (!bdrv_is_inserted(bs)) {
1008 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1009 return;
1010 }
1011
1012 if (bdrv_is_read_only(bs)) {
1013 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1014 return;
1015 }
1016
1017 if (!bdrv_can_snapshot(bs)) {
1018 error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1019 bs->drv->format_name, device, "internal snapshot");
1020 return;
1021 }
1022
1023 if (!strlen(name)) {
1024 error_setg(errp, "Name is empty");
1025 return;
1026 }
1027
1028 /* check whether a snapshot with name exist */
1029 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn, errp);
1030 if (error_is_set(errp)) {
1031 return;
1032 } else if (ret) {
1033 error_setg(errp,
1034 "Snapshot with name '%s' already exists on device '%s'",
1035 name, device);
1036 return;
1037 }
1038
1039 /* 3. take the snapshot */
1040 sn = &state->sn;
1041 pstrcpy(sn->name, sizeof(sn->name), name);
1042 qemu_gettimeofday(&tv);
1043 sn->date_sec = tv.tv_sec;
1044 sn->date_nsec = tv.tv_usec * 1000;
1045 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1046
1047 ret1 = bdrv_snapshot_create(bs, sn);
1048 if (ret1 < 0) {
1049 error_setg_errno(errp, -ret1,
1050 "Failed to create snapshot '%s' on device '%s'",
1051 name, device);
1052 return;
1053 }
1054
1055 /* 4. succeed, mark a snapshot is created */
1056 state->bs = bs;
1057 }
1058
1059 static void internal_snapshot_abort(BlkTransactionState *common)
1060 {
1061 InternalSnapshotState *state =
1062 DO_UPCAST(InternalSnapshotState, common, common);
1063 BlockDriverState *bs = state->bs;
1064 QEMUSnapshotInfo *sn = &state->sn;
1065 Error *local_error = NULL;
1066
1067 if (!bs) {
1068 return;
1069 }
1070
1071 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1072 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1073 "device '%s' in abort: %s",
1074 sn->id_str,
1075 sn->name,
1076 bdrv_get_device_name(bs),
1077 error_get_pretty(local_error));
1078 error_free(local_error);
1079 }
1080 }
1081
1082 /* external snapshot private data */
1083 typedef struct ExternalSnapshotState {
1084 BlkTransactionState common;
1085 BlockDriverState *old_bs;
1086 BlockDriverState *new_bs;
1087 } ExternalSnapshotState;
1088
1089 static void external_snapshot_prepare(BlkTransactionState *common,
1090 Error **errp)
1091 {
1092 BlockDriver *drv;
1093 int flags, ret;
1094 Error *local_err = NULL;
1095 const char *device;
1096 const char *new_image_file;
1097 const char *format = "qcow2";
1098 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1099 ExternalSnapshotState *state =
1100 DO_UPCAST(ExternalSnapshotState, common, common);
1101 TransactionAction *action = common->action;
1102
1103 /* get parameters */
1104 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1105
1106 device = action->blockdev_snapshot_sync->device;
1107 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1108 if (action->blockdev_snapshot_sync->has_format) {
1109 format = action->blockdev_snapshot_sync->format;
1110 }
1111 if (action->blockdev_snapshot_sync->has_mode) {
1112 mode = action->blockdev_snapshot_sync->mode;
1113 }
1114
1115 /* start processing */
1116 drv = bdrv_find_format(format);
1117 if (!drv) {
1118 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1119 return;
1120 }
1121
1122 state->old_bs = bdrv_find(device);
1123 if (!state->old_bs) {
1124 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1125 return;
1126 }
1127
1128 if (!bdrv_is_inserted(state->old_bs)) {
1129 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1130 return;
1131 }
1132
1133 if (bdrv_in_use(state->old_bs)) {
1134 error_set(errp, QERR_DEVICE_IN_USE, device);
1135 return;
1136 }
1137
1138 if (!bdrv_is_read_only(state->old_bs)) {
1139 if (bdrv_flush(state->old_bs)) {
1140 error_set(errp, QERR_IO_ERROR);
1141 return;
1142 }
1143 }
1144
1145 if (bdrv_check_ext_snapshot(state->old_bs) != EXT_SNAPSHOT_ALLOWED) {
1146 error_set(errp, QERR_FEATURE_DISABLED, "snapshot");
1147 return;
1148 }
1149
1150 flags = state->old_bs->open_flags;
1151
1152 /* create new image w/backing file */
1153 if (mode != NEW_IMAGE_MODE_EXISTING) {
1154 bdrv_img_create(new_image_file, format,
1155 state->old_bs->filename,
1156 state->old_bs->drv->format_name,
1157 NULL, -1, flags, &local_err, false);
1158 if (error_is_set(&local_err)) {
1159 error_propagate(errp, local_err);
1160 return;
1161 }
1162 }
1163
1164 /* We will manually add the backing_hd field to the bs later */
1165 state->new_bs = bdrv_new("");
1166 /* TODO Inherit bs->options or only take explicit options with an
1167 * extended QMP command? */
1168 ret = bdrv_open(state->new_bs, new_image_file, NULL,
1169 flags | BDRV_O_NO_BACKING, drv, &local_err);
1170 if (ret != 0) {
1171 error_propagate(errp, local_err);
1172 }
1173 }
1174
1175 static void external_snapshot_commit(BlkTransactionState *common)
1176 {
1177 ExternalSnapshotState *state =
1178 DO_UPCAST(ExternalSnapshotState, common, common);
1179
1180 /* This removes our old bs and adds the new bs */
1181 bdrv_append(state->new_bs, state->old_bs);
1182 /* We don't need (or want) to use the transactional
1183 * bdrv_reopen_multiple() across all the entries at once, because we
1184 * don't want to abort all of them if one of them fails the reopen */
1185 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1186 NULL);
1187 }
1188
1189 static void external_snapshot_abort(BlkTransactionState *common)
1190 {
1191 ExternalSnapshotState *state =
1192 DO_UPCAST(ExternalSnapshotState, common, common);
1193 if (state->new_bs) {
1194 bdrv_unref(state->new_bs);
1195 }
1196 }
1197
1198 typedef struct DriveBackupState {
1199 BlkTransactionState common;
1200 BlockDriverState *bs;
1201 BlockJob *job;
1202 } DriveBackupState;
1203
1204 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1205 {
1206 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1207 DriveBackup *backup;
1208 Error *local_err = NULL;
1209
1210 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1211 backup = common->action->drive_backup;
1212
1213 qmp_drive_backup(backup->device, backup->target,
1214 backup->has_format, backup->format,
1215 backup->sync,
1216 backup->has_mode, backup->mode,
1217 backup->has_speed, backup->speed,
1218 backup->has_on_source_error, backup->on_source_error,
1219 backup->has_on_target_error, backup->on_target_error,
1220 &local_err);
1221 if (error_is_set(&local_err)) {
1222 error_propagate(errp, local_err);
1223 state->bs = NULL;
1224 state->job = NULL;
1225 return;
1226 }
1227
1228 state->bs = bdrv_find(backup->device);
1229 state->job = state->bs->job;
1230 }
1231
1232 static void drive_backup_abort(BlkTransactionState *common)
1233 {
1234 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1235 BlockDriverState *bs = state->bs;
1236
1237 /* Only cancel if it's the job we started */
1238 if (bs && bs->job && bs->job == state->job) {
1239 block_job_cancel_sync(bs->job);
1240 }
1241 }
1242
1243 static void abort_prepare(BlkTransactionState *common, Error **errp)
1244 {
1245 error_setg(errp, "Transaction aborted using Abort action");
1246 }
1247
1248 static void abort_commit(BlkTransactionState *common)
1249 {
1250 g_assert_not_reached(); /* this action never succeeds */
1251 }
1252
1253 static const BdrvActionOps actions[] = {
1254 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1255 .instance_size = sizeof(ExternalSnapshotState),
1256 .prepare = external_snapshot_prepare,
1257 .commit = external_snapshot_commit,
1258 .abort = external_snapshot_abort,
1259 },
1260 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1261 .instance_size = sizeof(DriveBackupState),
1262 .prepare = drive_backup_prepare,
1263 .abort = drive_backup_abort,
1264 },
1265 [TRANSACTION_ACTION_KIND_ABORT] = {
1266 .instance_size = sizeof(BlkTransactionState),
1267 .prepare = abort_prepare,
1268 .commit = abort_commit,
1269 },
1270 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1271 .instance_size = sizeof(InternalSnapshotState),
1272 .prepare = internal_snapshot_prepare,
1273 .abort = internal_snapshot_abort,
1274 },
1275 };
1276
1277 /*
1278 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1279 * then we do not pivot any of the devices in the group, and abandon the
1280 * snapshots
1281 */
1282 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1283 {
1284 TransactionActionList *dev_entry = dev_list;
1285 BlkTransactionState *state, *next;
1286 Error *local_err = NULL;
1287
1288 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1289 QSIMPLEQ_INIT(&snap_bdrv_states);
1290
1291 /* drain all i/o before any snapshots */
1292 bdrv_drain_all();
1293
1294 /* We don't do anything in this loop that commits us to the snapshot */
1295 while (NULL != dev_entry) {
1296 TransactionAction *dev_info = NULL;
1297 const BdrvActionOps *ops;
1298
1299 dev_info = dev_entry->value;
1300 dev_entry = dev_entry->next;
1301
1302 assert(dev_info->kind < ARRAY_SIZE(actions));
1303
1304 ops = &actions[dev_info->kind];
1305 assert(ops->instance_size > 0);
1306
1307 state = g_malloc0(ops->instance_size);
1308 state->ops = ops;
1309 state->action = dev_info;
1310 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1311
1312 state->ops->prepare(state, &local_err);
1313 if (error_is_set(&local_err)) {
1314 error_propagate(errp, local_err);
1315 goto delete_and_fail;
1316 }
1317 }
1318
1319 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1320 if (state->ops->commit) {
1321 state->ops->commit(state);
1322 }
1323 }
1324
1325 /* success */
1326 goto exit;
1327
1328 delete_and_fail:
1329 /*
1330 * failure, and it is all-or-none; abandon each new bs, and keep using
1331 * the original bs for all images
1332 */
1333 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1334 if (state->ops->abort) {
1335 state->ops->abort(state);
1336 }
1337 }
1338 exit:
1339 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1340 if (state->ops->clean) {
1341 state->ops->clean(state);
1342 }
1343 g_free(state);
1344 }
1345 }
1346
1347
1348 static void eject_device(BlockDriverState *bs, int force, Error **errp)
1349 {
1350 if (bdrv_in_use(bs)) {
1351 error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
1352 return;
1353 }
1354 if (!bdrv_dev_has_removable_media(bs)) {
1355 error_set(errp, QERR_DEVICE_NOT_REMOVABLE, bdrv_get_device_name(bs));
1356 return;
1357 }
1358
1359 if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
1360 bdrv_dev_eject_request(bs, force);
1361 if (!force) {
1362 error_set(errp, QERR_DEVICE_LOCKED, bdrv_get_device_name(bs));
1363 return;
1364 }
1365 }
1366
1367 bdrv_close(bs);
1368 }
1369
1370 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1371 {
1372 BlockDriverState *bs;
1373
1374 bs = bdrv_find(device);
1375 if (!bs) {
1376 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1377 return;
1378 }
1379
1380 eject_device(bs, force, errp);
1381 }
1382
1383 void qmp_block_passwd(const char *device, const char *password, Error **errp)
1384 {
1385 BlockDriverState *bs;
1386 int err;
1387
1388 bs = bdrv_find(device);
1389 if (!bs) {
1390 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1391 return;
1392 }
1393
1394 err = bdrv_set_key(bs, password);
1395 if (err == -EINVAL) {
1396 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1397 return;
1398 } else if (err < 0) {
1399 error_set(errp, QERR_INVALID_PASSWORD);
1400 return;
1401 }
1402 }
1403
1404 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1405 int bdrv_flags, BlockDriver *drv,
1406 const char *password, Error **errp)
1407 {
1408 Error *local_err = NULL;
1409 int ret;
1410
1411 ret = bdrv_open(bs, filename, NULL, bdrv_flags, drv, &local_err);
1412 if (ret < 0) {
1413 error_propagate(errp, local_err);
1414 return;
1415 }
1416
1417 if (bdrv_key_required(bs)) {
1418 if (password) {
1419 if (bdrv_set_key(bs, password) < 0) {
1420 error_set(errp, QERR_INVALID_PASSWORD);
1421 }
1422 } else {
1423 error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
1424 bdrv_get_encrypted_filename(bs));
1425 }
1426 } else if (password) {
1427 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1428 }
1429 }
1430
1431 void qmp_change_blockdev(const char *device, const char *filename,
1432 bool has_format, const char *format, Error **errp)
1433 {
1434 BlockDriverState *bs;
1435 BlockDriver *drv = NULL;
1436 int bdrv_flags;
1437 Error *err = NULL;
1438
1439 bs = bdrv_find(device);
1440 if (!bs) {
1441 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1442 return;
1443 }
1444
1445 if (format) {
1446 drv = bdrv_find_whitelisted_format(format, bs->read_only);
1447 if (!drv) {
1448 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1449 return;
1450 }
1451 }
1452
1453 eject_device(bs, 0, &err);
1454 if (error_is_set(&err)) {
1455 error_propagate(errp, err);
1456 return;
1457 }
1458
1459 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1460 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1461
1462 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1463 }
1464
1465 /* throttling disk I/O limits */
1466 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1467 int64_t bps_wr,
1468 int64_t iops,
1469 int64_t iops_rd,
1470 int64_t iops_wr,
1471 bool has_bps_max,
1472 int64_t bps_max,
1473 bool has_bps_rd_max,
1474 int64_t bps_rd_max,
1475 bool has_bps_wr_max,
1476 int64_t bps_wr_max,
1477 bool has_iops_max,
1478 int64_t iops_max,
1479 bool has_iops_rd_max,
1480 int64_t iops_rd_max,
1481 bool has_iops_wr_max,
1482 int64_t iops_wr_max,
1483 bool has_iops_size,
1484 int64_t iops_size, Error **errp)
1485 {
1486 ThrottleConfig cfg;
1487 BlockDriverState *bs;
1488
1489 bs = bdrv_find(device);
1490 if (!bs) {
1491 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1492 return;
1493 }
1494
1495 memset(&cfg, 0, sizeof(cfg));
1496 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1497 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
1498 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1499
1500 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1501 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
1502 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1503
1504 if (has_bps_max) {
1505 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1506 }
1507 if (has_bps_rd_max) {
1508 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
1509 }
1510 if (has_bps_wr_max) {
1511 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
1512 }
1513 if (has_iops_max) {
1514 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
1515 }
1516 if (has_iops_rd_max) {
1517 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
1518 }
1519 if (has_iops_wr_max) {
1520 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
1521 }
1522
1523 if (has_iops_size) {
1524 cfg.op_size = iops_size;
1525 }
1526
1527 if (!check_throttle_config(&cfg, errp)) {
1528 return;
1529 }
1530
1531 if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
1532 bdrv_io_limits_enable(bs);
1533 } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
1534 bdrv_io_limits_disable(bs);
1535 }
1536
1537 if (bs->io_limits_enabled) {
1538 bdrv_set_io_limits(bs, &cfg);
1539 }
1540 }
1541
1542 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1543 {
1544 const char *id = qdict_get_str(qdict, "id");
1545 BlockDriverState *bs;
1546
1547 bs = bdrv_find(id);
1548 if (!bs) {
1549 qerror_report(QERR_DEVICE_NOT_FOUND, id);
1550 return -1;
1551 }
1552 if (bdrv_in_use(bs)) {
1553 qerror_report(QERR_DEVICE_IN_USE, id);
1554 return -1;
1555 }
1556
1557 /* quiesce block driver; prevent further io */
1558 bdrv_drain_all();
1559 bdrv_flush(bs);
1560 bdrv_close(bs);
1561
1562 /* if we have a device attached to this BlockDriverState
1563 * then we need to make the drive anonymous until the device
1564 * can be removed. If this is a drive with no device backing
1565 * then we can just get rid of the block driver state right here.
1566 */
1567 if (bdrv_get_attached_dev(bs)) {
1568 bdrv_make_anon(bs);
1569
1570 /* Further I/O must not pause the guest */
1571 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
1572 BLOCKDEV_ON_ERROR_REPORT);
1573 } else {
1574 drive_uninit(drive_get_by_blockdev(bs));
1575 }
1576
1577 return 0;
1578 }
1579
1580 void qmp_block_resize(const char *device, int64_t size, Error **errp)
1581 {
1582 BlockDriverState *bs;
1583 int ret;
1584
1585 bs = bdrv_find(device);
1586 if (!bs) {
1587 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1588 return;
1589 }
1590
1591 if (size < 0) {
1592 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
1593 return;
1594 }
1595
1596 /* complete all in-flight operations before resizing the device */
1597 bdrv_drain_all();
1598
1599 ret = bdrv_truncate(bs, size);
1600 switch (ret) {
1601 case 0:
1602 break;
1603 case -ENOMEDIUM:
1604 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1605 break;
1606 case -ENOTSUP:
1607 error_set(errp, QERR_UNSUPPORTED);
1608 break;
1609 case -EACCES:
1610 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1611 break;
1612 case -EBUSY:
1613 error_set(errp, QERR_DEVICE_IN_USE, device);
1614 break;
1615 default:
1616 error_setg_errno(errp, -ret, "Could not resize");
1617 break;
1618 }
1619 }
1620
1621 static void block_job_cb(void *opaque, int ret)
1622 {
1623 BlockDriverState *bs = opaque;
1624 QObject *obj;
1625
1626 trace_block_job_cb(bs, bs->job, ret);
1627
1628 assert(bs->job);
1629 obj = qobject_from_block_job(bs->job);
1630 if (ret < 0) {
1631 QDict *dict = qobject_to_qdict(obj);
1632 qdict_put(dict, "error", qstring_from_str(strerror(-ret)));
1633 }
1634
1635 if (block_job_is_cancelled(bs->job)) {
1636 monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED, obj);
1637 } else {
1638 monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED, obj);
1639 }
1640 qobject_decref(obj);
1641
1642 bdrv_put_ref_bh_schedule(bs);
1643 }
1644
1645 void qmp_block_stream(const char *device, bool has_base,
1646 const char *base, bool has_speed, int64_t speed,
1647 bool has_on_error, BlockdevOnError on_error,
1648 Error **errp)
1649 {
1650 BlockDriverState *bs;
1651 BlockDriverState *base_bs = NULL;
1652 Error *local_err = NULL;
1653
1654 if (!has_on_error) {
1655 on_error = BLOCKDEV_ON_ERROR_REPORT;
1656 }
1657
1658 bs = bdrv_find(device);
1659 if (!bs) {
1660 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1661 return;
1662 }
1663
1664 if (base) {
1665 base_bs = bdrv_find_backing_image(bs, base);
1666 if (base_bs == NULL) {
1667 error_set(errp, QERR_BASE_NOT_FOUND, base);
1668 return;
1669 }
1670 }
1671
1672 stream_start(bs, base_bs, base, has_speed ? speed : 0,
1673 on_error, block_job_cb, bs, &local_err);
1674 if (error_is_set(&local_err)) {
1675 error_propagate(errp, local_err);
1676 return;
1677 }
1678
1679 trace_qmp_block_stream(bs, bs->job);
1680 }
1681
1682 void qmp_block_commit(const char *device,
1683 bool has_base, const char *base, const char *top,
1684 bool has_speed, int64_t speed,
1685 Error **errp)
1686 {
1687 BlockDriverState *bs;
1688 BlockDriverState *base_bs, *top_bs;
1689 Error *local_err = NULL;
1690 /* This will be part of the QMP command, if/when the
1691 * BlockdevOnError change for blkmirror makes it in
1692 */
1693 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
1694
1695 /* drain all i/o before commits */
1696 bdrv_drain_all();
1697
1698 bs = bdrv_find(device);
1699 if (!bs) {
1700 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1701 return;
1702 }
1703
1704 /* default top_bs is the active layer */
1705 top_bs = bs;
1706
1707 if (top) {
1708 if (strcmp(bs->filename, top) != 0) {
1709 top_bs = bdrv_find_backing_image(bs, top);
1710 }
1711 }
1712
1713 if (top_bs == NULL) {
1714 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
1715 return;
1716 }
1717
1718 if (has_base && base) {
1719 base_bs = bdrv_find_backing_image(top_bs, base);
1720 } else {
1721 base_bs = bdrv_find_base(top_bs);
1722 }
1723
1724 if (base_bs == NULL) {
1725 error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
1726 return;
1727 }
1728
1729 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
1730 &local_err);
1731 if (local_err != NULL) {
1732 error_propagate(errp, local_err);
1733 return;
1734 }
1735 }
1736
1737 void qmp_drive_backup(const char *device, const char *target,
1738 bool has_format, const char *format,
1739 enum MirrorSyncMode sync,
1740 bool has_mode, enum NewImageMode mode,
1741 bool has_speed, int64_t speed,
1742 bool has_on_source_error, BlockdevOnError on_source_error,
1743 bool has_on_target_error, BlockdevOnError on_target_error,
1744 Error **errp)
1745 {
1746 BlockDriverState *bs;
1747 BlockDriverState *target_bs;
1748 BlockDriverState *source = NULL;
1749 BlockDriver *drv = NULL;
1750 Error *local_err = NULL;
1751 int flags;
1752 int64_t size;
1753 int ret;
1754
1755 if (!has_speed) {
1756 speed = 0;
1757 }
1758 if (!has_on_source_error) {
1759 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1760 }
1761 if (!has_on_target_error) {
1762 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1763 }
1764 if (!has_mode) {
1765 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1766 }
1767
1768 bs = bdrv_find(device);
1769 if (!bs) {
1770 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1771 return;
1772 }
1773
1774 if (!bdrv_is_inserted(bs)) {
1775 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1776 return;
1777 }
1778
1779 if (!has_format) {
1780 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1781 }
1782 if (format) {
1783 drv = bdrv_find_format(format);
1784 if (!drv) {
1785 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1786 return;
1787 }
1788 }
1789
1790 if (bdrv_in_use(bs)) {
1791 error_set(errp, QERR_DEVICE_IN_USE, device);
1792 return;
1793 }
1794
1795 flags = bs->open_flags | BDRV_O_RDWR;
1796
1797 /* See if we have a backing HD we can use to create our new image
1798 * on top of. */
1799 if (sync == MIRROR_SYNC_MODE_TOP) {
1800 source = bs->backing_hd;
1801 if (!source) {
1802 sync = MIRROR_SYNC_MODE_FULL;
1803 }
1804 }
1805 if (sync == MIRROR_SYNC_MODE_NONE) {
1806 source = bs;
1807 }
1808
1809 size = bdrv_getlength(bs);
1810 if (size < 0) {
1811 error_setg_errno(errp, -size, "bdrv_getlength failed");
1812 return;
1813 }
1814
1815 if (mode != NEW_IMAGE_MODE_EXISTING) {
1816 assert(format && drv);
1817 if (source) {
1818 bdrv_img_create(target, format, source->filename,
1819 source->drv->format_name, NULL,
1820 size, flags, &local_err, false);
1821 } else {
1822 bdrv_img_create(target, format, NULL, NULL, NULL,
1823 size, flags, &local_err, false);
1824 }
1825 }
1826
1827 if (error_is_set(&local_err)) {
1828 error_propagate(errp, local_err);
1829 return;
1830 }
1831
1832 target_bs = bdrv_new("");
1833 ret = bdrv_open(target_bs, target, NULL, flags, drv, &local_err);
1834 if (ret < 0) {
1835 bdrv_unref(target_bs);
1836 error_propagate(errp, local_err);
1837 return;
1838 }
1839
1840 backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
1841 block_job_cb, bs, &local_err);
1842 if (local_err != NULL) {
1843 bdrv_unref(target_bs);
1844 error_propagate(errp, local_err);
1845 return;
1846 }
1847 }
1848
1849 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
1850
1851 void qmp_drive_mirror(const char *device, const char *target,
1852 bool has_format, const char *format,
1853 enum MirrorSyncMode sync,
1854 bool has_mode, enum NewImageMode mode,
1855 bool has_speed, int64_t speed,
1856 bool has_granularity, uint32_t granularity,
1857 bool has_buf_size, int64_t buf_size,
1858 bool has_on_source_error, BlockdevOnError on_source_error,
1859 bool has_on_target_error, BlockdevOnError on_target_error,
1860 Error **errp)
1861 {
1862 BlockDriverState *bs;
1863 BlockDriverState *source, *target_bs;
1864 BlockDriver *drv = NULL;
1865 Error *local_err = NULL;
1866 int flags;
1867 int64_t size;
1868 int ret;
1869
1870 if (!has_speed) {
1871 speed = 0;
1872 }
1873 if (!has_on_source_error) {
1874 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1875 }
1876 if (!has_on_target_error) {
1877 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1878 }
1879 if (!has_mode) {
1880 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1881 }
1882 if (!has_granularity) {
1883 granularity = 0;
1884 }
1885 if (!has_buf_size) {
1886 buf_size = DEFAULT_MIRROR_BUF_SIZE;
1887 }
1888
1889 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
1890 error_set(errp, QERR_INVALID_PARAMETER, device);
1891 return;
1892 }
1893 if (granularity & (granularity - 1)) {
1894 error_set(errp, QERR_INVALID_PARAMETER, device);
1895 return;
1896 }
1897
1898 bs = bdrv_find(device);
1899 if (!bs) {
1900 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1901 return;
1902 }
1903
1904 if (!bdrv_is_inserted(bs)) {
1905 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1906 return;
1907 }
1908
1909 if (!has_format) {
1910 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1911 }
1912 if (format) {
1913 drv = bdrv_find_format(format);
1914 if (!drv) {
1915 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1916 return;
1917 }
1918 }
1919
1920 if (bdrv_in_use(bs)) {
1921 error_set(errp, QERR_DEVICE_IN_USE, device);
1922 return;
1923 }
1924
1925 flags = bs->open_flags | BDRV_O_RDWR;
1926 source = bs->backing_hd;
1927 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
1928 sync = MIRROR_SYNC_MODE_FULL;
1929 }
1930
1931 size = bdrv_getlength(bs);
1932 if (size < 0) {
1933 error_setg_errno(errp, -size, "bdrv_getlength failed");
1934 return;
1935 }
1936
1937 if (sync == MIRROR_SYNC_MODE_FULL && mode != NEW_IMAGE_MODE_EXISTING) {
1938 /* create new image w/o backing file */
1939 assert(format && drv);
1940 bdrv_img_create(target, format,
1941 NULL, NULL, NULL, size, flags, &local_err, false);
1942 } else {
1943 switch (mode) {
1944 case NEW_IMAGE_MODE_EXISTING:
1945 break;
1946 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
1947 /* create new image with backing file */
1948 bdrv_img_create(target, format,
1949 source->filename,
1950 source->drv->format_name,
1951 NULL, size, flags, &local_err, false);
1952 break;
1953 default:
1954 abort();
1955 }
1956 }
1957
1958 if (error_is_set(&local_err)) {
1959 error_propagate(errp, local_err);
1960 return;
1961 }
1962
1963 /* Mirroring takes care of copy-on-write using the source's backing
1964 * file.
1965 */
1966 target_bs = bdrv_new("");
1967 ret = bdrv_open(target_bs, target, NULL, flags | BDRV_O_NO_BACKING, drv,
1968 &local_err);
1969 if (ret < 0) {
1970 bdrv_unref(target_bs);
1971 error_propagate(errp, local_err);
1972 return;
1973 }
1974
1975 mirror_start(bs, target_bs, speed, granularity, buf_size, sync,
1976 on_source_error, on_target_error,
1977 block_job_cb, bs, &local_err);
1978 if (local_err != NULL) {
1979 bdrv_unref(target_bs);
1980 error_propagate(errp, local_err);
1981 return;
1982 }
1983 }
1984
1985 static BlockJob *find_block_job(const char *device)
1986 {
1987 BlockDriverState *bs;
1988
1989 bs = bdrv_find(device);
1990 if (!bs || !bs->job) {
1991 return NULL;
1992 }
1993 return bs->job;
1994 }
1995
1996 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
1997 {
1998 BlockJob *job = find_block_job(device);
1999
2000 if (!job) {
2001 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2002 return;
2003 }
2004
2005 block_job_set_speed(job, speed, errp);
2006 }
2007
2008 void qmp_block_job_cancel(const char *device,
2009 bool has_force, bool force, Error **errp)
2010 {
2011 BlockJob *job = find_block_job(device);
2012
2013 if (!has_force) {
2014 force = false;
2015 }
2016
2017 if (!job) {
2018 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2019 return;
2020 }
2021 if (job->paused && !force) {
2022 error_set(errp, QERR_BLOCK_JOB_PAUSED, device);
2023 return;
2024 }
2025
2026 trace_qmp_block_job_cancel(job);
2027 block_job_cancel(job);
2028 }
2029
2030 void qmp_block_job_pause(const char *device, Error **errp)
2031 {
2032 BlockJob *job = find_block_job(device);
2033
2034 if (!job) {
2035 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2036 return;
2037 }
2038
2039 trace_qmp_block_job_pause(job);
2040 block_job_pause(job);
2041 }
2042
2043 void qmp_block_job_resume(const char *device, Error **errp)
2044 {
2045 BlockJob *job = find_block_job(device);
2046
2047 if (!job) {
2048 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2049 return;
2050 }
2051
2052 trace_qmp_block_job_resume(job);
2053 block_job_resume(job);
2054 }
2055
2056 void qmp_block_job_complete(const char *device, Error **errp)
2057 {
2058 BlockJob *job = find_block_job(device);
2059
2060 if (!job) {
2061 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2062 return;
2063 }
2064
2065 trace_qmp_block_job_complete(job);
2066 block_job_complete(job, errp);
2067 }
2068
2069 static void do_qmp_query_block_jobs_one(void *opaque, BlockDriverState *bs)
2070 {
2071 BlockJobInfoList **prev = opaque;
2072 BlockJob *job = bs->job;
2073
2074 if (job) {
2075 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
2076 elem->value = block_job_query(bs->job);
2077 (*prev)->next = elem;
2078 *prev = elem;
2079 }
2080 }
2081
2082 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
2083 {
2084 /* Dummy is a fake list element for holding the head pointer */
2085 BlockJobInfoList dummy = {};
2086 BlockJobInfoList *prev = &dummy;
2087 bdrv_iterate(do_qmp_query_block_jobs_one, &prev);
2088 return dummy.next;
2089 }
2090
2091 QemuOptsList qemu_common_drive_opts = {
2092 .name = "drive",
2093 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
2094 .desc = {
2095 {
2096 .name = "bus",
2097 .type = QEMU_OPT_NUMBER,
2098 .help = "bus number",
2099 },{
2100 .name = "unit",
2101 .type = QEMU_OPT_NUMBER,
2102 .help = "unit number (i.e. lun for scsi)",
2103 },{
2104 .name = "if",
2105 .type = QEMU_OPT_STRING,
2106 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
2107 },{
2108 .name = "index",
2109 .type = QEMU_OPT_NUMBER,
2110 .help = "index number",
2111 },{
2112 .name = "cyls",
2113 .type = QEMU_OPT_NUMBER,
2114 .help = "number of cylinders (ide disk geometry)",
2115 },{
2116 .name = "heads",
2117 .type = QEMU_OPT_NUMBER,
2118 .help = "number of heads (ide disk geometry)",
2119 },{
2120 .name = "secs",
2121 .type = QEMU_OPT_NUMBER,
2122 .help = "number of sectors (ide disk geometry)",
2123 },{
2124 .name = "trans",
2125 .type = QEMU_OPT_STRING,
2126 .help = "chs translation (auto, lba. none)",
2127 },{
2128 .name = "media",
2129 .type = QEMU_OPT_STRING,
2130 .help = "media type (disk, cdrom)",
2131 },{
2132 .name = "snapshot",
2133 .type = QEMU_OPT_BOOL,
2134 .help = "enable/disable snapshot mode",
2135 },{
2136 .name = "file",
2137 .type = QEMU_OPT_STRING,
2138 .help = "disk image",
2139 },{
2140 .name = "discard",
2141 .type = QEMU_OPT_STRING,
2142 .help = "discard operation (ignore/off, unmap/on)",
2143 },{
2144 .name = "cache.writeback",
2145 .type = QEMU_OPT_BOOL,
2146 .help = "enables writeback mode for any caches",
2147 },{
2148 .name = "cache.direct",
2149 .type = QEMU_OPT_BOOL,
2150 .help = "enables use of O_DIRECT (bypass the host page cache)",
2151 },{
2152 .name = "cache.no-flush",
2153 .type = QEMU_OPT_BOOL,
2154 .help = "ignore any flush requests for the device",
2155 },{
2156 .name = "aio",
2157 .type = QEMU_OPT_STRING,
2158 .help = "host AIO implementation (threads, native)",
2159 },{
2160 .name = "format",
2161 .type = QEMU_OPT_STRING,
2162 .help = "disk format (raw, qcow2, ...)",
2163 },{
2164 .name = "serial",
2165 .type = QEMU_OPT_STRING,
2166 .help = "disk serial number",
2167 },{
2168 .name = "rerror",
2169 .type = QEMU_OPT_STRING,
2170 .help = "read error action",
2171 },{
2172 .name = "werror",
2173 .type = QEMU_OPT_STRING,
2174 .help = "write error action",
2175 },{
2176 .name = "addr",
2177 .type = QEMU_OPT_STRING,
2178 .help = "pci address (virtio only)",
2179 },{
2180 .name = "read-only",
2181 .type = QEMU_OPT_BOOL,
2182 .help = "open drive file as read-only",
2183 },{
2184 .name = "throttling.iops-total",
2185 .type = QEMU_OPT_NUMBER,
2186 .help = "limit total I/O operations per second",
2187 },{
2188 .name = "throttling.iops-read",
2189 .type = QEMU_OPT_NUMBER,
2190 .help = "limit read operations per second",
2191 },{
2192 .name = "throttling.iops-write",
2193 .type = QEMU_OPT_NUMBER,
2194 .help = "limit write operations per second",
2195 },{
2196 .name = "throttling.bps-total",
2197 .type = QEMU_OPT_NUMBER,
2198 .help = "limit total bytes per second",
2199 },{
2200 .name = "throttling.bps-read",
2201 .type = QEMU_OPT_NUMBER,
2202 .help = "limit read bytes per second",
2203 },{
2204 .name = "throttling.bps-write",
2205 .type = QEMU_OPT_NUMBER,
2206 .help = "limit write bytes per second",
2207 },{
2208 .name = "throttling.iops-total-max",
2209 .type = QEMU_OPT_NUMBER,
2210 .help = "I/O operations burst",
2211 },{
2212 .name = "throttling.iops-read-max",
2213 .type = QEMU_OPT_NUMBER,
2214 .help = "I/O operations read burst",
2215 },{
2216 .name = "throttling.iops-write-max",
2217 .type = QEMU_OPT_NUMBER,
2218 .help = "I/O operations write burst",
2219 },{
2220 .name = "throttling.bps-total-max",
2221 .type = QEMU_OPT_NUMBER,
2222 .help = "total bytes burst",
2223 },{
2224 .name = "throttling.bps-read-max",
2225 .type = QEMU_OPT_NUMBER,
2226 .help = "total bytes read burst",
2227 },{
2228 .name = "throttling.bps-write-max",
2229 .type = QEMU_OPT_NUMBER,
2230 .help = "total bytes write burst",
2231 },{
2232 .name = "throttling.iops-size",
2233 .type = QEMU_OPT_NUMBER,
2234 .help = "when limiting by iops max size of an I/O in bytes",
2235 },{
2236 .name = "copy-on-read",
2237 .type = QEMU_OPT_BOOL,
2238 .help = "copy read data from backing file into image file",
2239 },{
2240 .name = "boot",
2241 .type = QEMU_OPT_BOOL,
2242 .help = "(deprecated, ignored)",
2243 },
2244 { /* end of list */ }
2245 },
2246 };
2247
2248 QemuOptsList qemu_drive_opts = {
2249 .name = "drive",
2250 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
2251 .desc = {
2252 /*
2253 * no elements => accept any params
2254 * validation will happen later
2255 */
2256 { /* end of list */ }
2257 },
2258 };