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