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