]> git.proxmox.com Git - mirror_qemu.git/blame - blockdev.c
block: Add bdrv_get_block_status_above
[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
26f54e9a 33#include "sysemu/block-backend.h"
9c17d615 34#include "sysemu/blockdev.h"
0d09e41a 35#include "hw/block/block.h"
737e150e 36#include "block/blockjob.h"
76f4afb4 37#include "block/throttle-groups.h"
83c9089e 38#include "monitor/monitor.h"
d49b6836 39#include "qemu/error-report.h"
1de7afc9
PB
40#include "qemu/option.h"
41#include "qemu/config-file.h"
7b1b5d19 42#include "qapi/qmp/types.h"
d26c9a15 43#include "qapi-visit.h"
cc7a8ea7 44#include "qapi/qmp/qerror.h"
d26c9a15 45#include "qapi/qmp-output-visitor.h"
9e7dac7c 46#include "qapi/util.h"
9c17d615 47#include "sysemu/sysemu.h"
737e150e 48#include "block/block_int.h"
a4dea8a9 49#include "qmp-commands.h"
12bd451f 50#include "trace.h"
9c17d615 51#include "sysemu/arch_init.h"
666daa68 52
1960966d
MA
53static const char *const if_name[IF_COUNT] = {
54 [IF_NONE] = "none",
55 [IF_IDE] = "ide",
56 [IF_SCSI] = "scsi",
57 [IF_FLOPPY] = "floppy",
58 [IF_PFLASH] = "pflash",
59 [IF_MTD] = "mtd",
60 [IF_SD] = "sd",
61 [IF_VIRTIO] = "virtio",
62 [IF_XEN] = "xen",
63};
64
21dff8cf 65static int if_max_devs[IF_COUNT] = {
27d6bf40
MA
66 /*
67 * Do not change these numbers! They govern how drive option
68 * index maps to unit and bus. That mapping is ABI.
69 *
70 * All controllers used to imlement if=T drives need to support
71 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
72 * Otherwise, some index values map to "impossible" bus, unit
73 * values.
74 *
75 * For instance, if you change [IF_SCSI] to 255, -drive
76 * if=scsi,index=12 no longer means bus=1,unit=5, but
77 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
78 * the drive can't be set up. Regression.
79 */
80 [IF_IDE] = 2,
81 [IF_SCSI] = 7,
1960966d
MA
82};
83
21dff8cf
JS
84/**
85 * Boards may call this to offer board-by-board overrides
86 * of the default, global values.
87 */
88void override_max_devs(BlockInterfaceType type, int max_devs)
89{
18e46a03 90 BlockBackend *blk;
21dff8cf
JS
91 DriveInfo *dinfo;
92
93 if (max_devs <= 0) {
94 return;
95 }
96
18e46a03
MA
97 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
98 dinfo = blk_legacy_dinfo(blk);
21dff8cf
JS
99 if (dinfo->type == type) {
100 fprintf(stderr, "Cannot override units-per-bus property of"
101 " the %s interface, because a drive of that type has"
102 " already been added.\n", if_name[type]);
103 g_assert_not_reached();
104 }
105 }
106
107 if_max_devs[type] = max_devs;
108}
109
14bafc54
MA
110/*
111 * We automatically delete the drive when a device using it gets
112 * unplugged. Questionable feature, but we can't just drop it.
113 * Device models call blockdev_mark_auto_del() to schedule the
114 * automatic deletion, and generic qdev code calls blockdev_auto_del()
115 * when deletion is actually safe.
116 */
4be74634 117void blockdev_mark_auto_del(BlockBackend *blk)
14bafc54 118{
18e46a03 119 DriveInfo *dinfo = blk_legacy_dinfo(blk);
4be74634 120 BlockDriverState *bs = blk_bs(blk);
91fddb0d 121 AioContext *aio_context;
14bafc54 122
26f8b3a8 123 if (!dinfo) {
2d246f01
KW
124 return;
125 }
126
91fddb0d
SH
127 aio_context = bdrv_get_aio_context(bs);
128 aio_context_acquire(aio_context);
129
12bde0ee
PB
130 if (bs->job) {
131 block_job_cancel(bs->job);
132 }
91fddb0d
SH
133
134 aio_context_release(aio_context);
135
26f8b3a8 136 dinfo->auto_del = 1;
14bafc54
MA
137}
138
4be74634 139void blockdev_auto_del(BlockBackend *blk)
14bafc54 140{
18e46a03 141 DriveInfo *dinfo = blk_legacy_dinfo(blk);
14bafc54 142
0fc0f1fa 143 if (dinfo && dinfo->auto_del) {
b9fe8a7a 144 blk_unref(blk);
14bafc54
MA
145 }
146}
147
d8f94e1b
JS
148/**
149 * Returns the current mapping of how many units per bus
150 * a particular interface can support.
151 *
152 * A positive integer indicates n units per bus.
153 * 0 implies the mapping has not been established.
154 * -1 indicates an invalid BlockInterfaceType was given.
155 */
156int drive_get_max_devs(BlockInterfaceType type)
157{
158 if (type >= IF_IDE && type < IF_COUNT) {
159 return if_max_devs[type];
160 }
161
162 return -1;
163}
164
505a7fb1
MA
165static int drive_index_to_bus_id(BlockInterfaceType type, int index)
166{
167 int max_devs = if_max_devs[type];
168 return max_devs ? index / max_devs : 0;
169}
170
171static int drive_index_to_unit_id(BlockInterfaceType type, int index)
172{
173 int max_devs = if_max_devs[type];
174 return max_devs ? index % max_devs : index;
175}
176
2292ddae
MA
177QemuOpts *drive_def(const char *optstr)
178{
70b94331 179 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
2292ddae
MA
180}
181
182QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
5645b0f4 183 const char *optstr)
666daa68 184{
666daa68
MA
185 QemuOpts *opts;
186
2292ddae 187 opts = drive_def(optstr);
666daa68
MA
188 if (!opts) {
189 return NULL;
190 }
2292ddae 191 if (type != IF_DEFAULT) {
f43e47db 192 qemu_opt_set(opts, "if", if_name[type], &error_abort);
2292ddae
MA
193 }
194 if (index >= 0) {
a8b18f8f 195 qemu_opt_set_number(opts, "index", index, &error_abort);
2292ddae 196 }
666daa68 197 if (file)
f43e47db 198 qemu_opt_set(opts, "file", file, &error_abort);
666daa68
MA
199 return opts;
200}
201
202DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
203{
18e46a03 204 BlockBackend *blk;
666daa68
MA
205 DriveInfo *dinfo;
206
18e46a03
MA
207 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
208 dinfo = blk_legacy_dinfo(blk);
209 if (dinfo && dinfo->type == type
210 && dinfo->bus == bus && dinfo->unit == unit) {
666daa68 211 return dinfo;
18e46a03 212 }
666daa68
MA
213 }
214
215 return NULL;
216}
217
a66c9dc7
JS
218bool drive_check_orphaned(void)
219{
18e46a03 220 BlockBackend *blk;
a66c9dc7
JS
221 DriveInfo *dinfo;
222 bool rs = false;
223
18e46a03
MA
224 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
225 dinfo = blk_legacy_dinfo(blk);
a66c9dc7
JS
226 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
227 /* Unless this is a default drive, this may be an oversight. */
a7f53e26 228 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
a66c9dc7
JS
229 dinfo->type != IF_NONE) {
230 fprintf(stderr, "Warning: Orphaned drive without device: "
231 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
d3aeb1b7 232 blk_name(blk), blk_bs(blk)->filename, if_name[dinfo->type],
a66c9dc7
JS
233 dinfo->bus, dinfo->unit);
234 rs = true;
235 }
236 }
237
238 return rs;
239}
240
f1bd51ac
MA
241DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
242{
243 return drive_get(type,
244 drive_index_to_bus_id(type, index),
245 drive_index_to_unit_id(type, index));
246}
247
666daa68
MA
248int drive_get_max_bus(BlockInterfaceType type)
249{
250 int max_bus;
18e46a03 251 BlockBackend *blk;
666daa68
MA
252 DriveInfo *dinfo;
253
254 max_bus = -1;
18e46a03
MA
255 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
256 dinfo = blk_legacy_dinfo(blk);
257 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
666daa68 258 max_bus = dinfo->bus;
18e46a03 259 }
666daa68
MA
260 }
261 return max_bus;
262}
263
13839974
MA
264/* Get a block device. This should only be used for single-drive devices
265 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
266 appropriate bus. */
267DriveInfo *drive_get_next(BlockInterfaceType type)
268{
269 static int next_block_unit[IF_COUNT];
270
271 return drive_get(type, 0, next_block_unit[type]++);
272}
273
666daa68
MA
274static void bdrv_format_print(void *opaque, const char *name)
275{
807105a7 276 error_printf(" %s", name);
666daa68
MA
277}
278
aa398a5c
SH
279typedef struct {
280 QEMUBH *bh;
fa510ebf
FZ
281 BlockDriverState *bs;
282} BDRVPutRefBH;
aa398a5c 283
fa510ebf 284static void bdrv_put_ref_bh(void *opaque)
aa398a5c 285{
fa510ebf 286 BDRVPutRefBH *s = opaque;
aa398a5c 287
fa510ebf 288 bdrv_unref(s->bs);
aa398a5c
SH
289 qemu_bh_delete(s->bh);
290 g_free(s);
291}
292
293/*
fa510ebf 294 * Release a BDS reference in a BH
aa398a5c 295 *
fa510ebf
FZ
296 * It is not safe to use bdrv_unref() from a callback function when the callers
297 * still need the BlockDriverState. In such cases we schedule a BH to release
298 * the reference.
aa398a5c 299 */
fa510ebf 300static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
aa398a5c 301{
fa510ebf 302 BDRVPutRefBH *s;
aa398a5c 303
fa510ebf
FZ
304 s = g_new(BDRVPutRefBH, 1);
305 s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
306 s->bs = bs;
aa398a5c
SH
307 qemu_bh_schedule(s->bh);
308}
309
b681072d 310static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
666daa68
MA
311{
312 if (!strcmp(buf, "ignore")) {
92aa5c6d 313 return BLOCKDEV_ON_ERROR_IGNORE;
666daa68 314 } else if (!is_read && !strcmp(buf, "enospc")) {
92aa5c6d 315 return BLOCKDEV_ON_ERROR_ENOSPC;
666daa68 316 } else if (!strcmp(buf, "stop")) {
92aa5c6d 317 return BLOCKDEV_ON_ERROR_STOP;
666daa68 318 } else if (!strcmp(buf, "report")) {
92aa5c6d 319 return BLOCKDEV_ON_ERROR_REPORT;
666daa68 320 } else {
b681072d
KW
321 error_setg(errp, "'%s' invalid %s error action",
322 buf, is_read ? "read" : "write");
666daa68
MA
323 return -1;
324 }
325}
326
cc0681c4 327static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
0563e191 328{
cc0681c4
BC
329 if (throttle_conflicting(cfg)) {
330 error_setg(errp, "bps/iops/max total values and read/write values"
331 " cannot be used at the same time");
0563e191
ZYW
332 return false;
333 }
334
cc0681c4
BC
335 if (!throttle_is_valid(cfg)) {
336 error_setg(errp, "bps/iops/maxs values must be 0 or greater");
7d81c141
SH
337 return false;
338 }
339
0563e191
ZYW
340 return true;
341}
342
33cb7dc8
KW
343typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
344
f298d071 345/* Takes the ownership of bs_opts */
18e46a03
MA
346static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
347 Error **errp)
666daa68
MA
348{
349 const char *buf;
666daa68
MA
350 int ro = 0;
351 int bdrv_flags = 0;
352 int on_read_error, on_write_error;
26f54e9a 353 BlockBackend *blk;
a0f1eab1 354 BlockDriverState *bs;
cc0681c4 355 ThrottleConfig cfg;
666daa68 356 int snapshot = 0;
fb0490f6 357 bool copy_on_read;
c546194f 358 Error *error = NULL;
0006383e 359 QemuOpts *opts;
0006383e 360 const char *id;
74fe54f2 361 bool has_driver_specific_opts;
465bee1d 362 BlockdevDetectZeroesOptions detect_zeroes;
76f4afb4 363 const char *throttling_group;
666daa68 364
f298d071
KW
365 /* Check common options by copying from bs_opts to opts, all other options
366 * stay in bs_opts for processing by bdrv_open(). */
367 id = qdict_get_try_str(bs_opts, "id");
0006383e 368 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
84d18f06 369 if (error) {
b681072d 370 error_propagate(errp, error);
6376f952 371 goto err_no_opts;
0006383e
KW
372 }
373
0006383e 374 qemu_opts_absorb_qdict(opts, bs_opts, &error);
84d18f06 375 if (error) {
b681072d 376 error_propagate(errp, error);
ec9c10d2 377 goto early_err;
0006383e
KW
378 }
379
380 if (id) {
381 qdict_del(bs_opts, "id");
382 }
383
74fe54f2
KW
384 has_driver_specific_opts = !!qdict_size(bs_opts);
385
666daa68 386 /* extract parameters */
666daa68 387 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
0f227a94 388 ro = qemu_opt_get_bool(opts, "read-only", 0);
fb0490f6 389 copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
666daa68 390
a9384aff
PB
391 if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
392 if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
b681072d 393 error_setg(errp, "invalid discard option");
ec9c10d2 394 goto early_err;
a9384aff
PB
395 }
396 }
397
54861b92 398 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true)) {
29c4e2b5
KW
399 bdrv_flags |= BDRV_O_CACHE_WB;
400 }
54861b92 401 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) {
29c4e2b5
KW
402 bdrv_flags |= BDRV_O_NOCACHE;
403 }
54861b92 404 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) {
29c4e2b5 405 bdrv_flags |= BDRV_O_NO_FLUSH;
666daa68
MA
406 }
407
408#ifdef CONFIG_LINUX_AIO
409 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
410 if (!strcmp(buf, "native")) {
411 bdrv_flags |= BDRV_O_NATIVE_AIO;
412 } else if (!strcmp(buf, "threads")) {
413 /* this is the default */
414 } else {
b681072d 415 error_setg(errp, "invalid aio option");
ec9c10d2 416 goto early_err;
666daa68
MA
417 }
418 }
419#endif
420
421 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
c8057f95
PM
422 if (is_help_option(buf)) {
423 error_printf("Supported formats:");
424 bdrv_iterate_format(bdrv_format_print, NULL);
425 error_printf("\n");
ec9c10d2 426 goto early_err;
666daa68 427 }
74fe54f2 428
e4342ce5
HR
429 if (qdict_haskey(bs_opts, "driver")) {
430 error_setg(errp, "Cannot specify both 'driver' and 'format'");
ec9c10d2 431 goto early_err;
6db5f5d6 432 }
e4342ce5 433 qdict_put(bs_opts, "driver", qstring_from_str(buf));
666daa68
MA
434 }
435
0563e191 436 /* disk I/O throttling */
cc0681c4
BC
437 memset(&cfg, 0, sizeof(cfg));
438 cfg.buckets[THROTTLE_BPS_TOTAL].avg =
57975222 439 qemu_opt_get_number(opts, "throttling.bps-total", 0);
cc0681c4 440 cfg.buckets[THROTTLE_BPS_READ].avg =
57975222 441 qemu_opt_get_number(opts, "throttling.bps-read", 0);
cc0681c4 442 cfg.buckets[THROTTLE_BPS_WRITE].avg =
57975222 443 qemu_opt_get_number(opts, "throttling.bps-write", 0);
cc0681c4 444 cfg.buckets[THROTTLE_OPS_TOTAL].avg =
57975222 445 qemu_opt_get_number(opts, "throttling.iops-total", 0);
cc0681c4 446 cfg.buckets[THROTTLE_OPS_READ].avg =
57975222 447 qemu_opt_get_number(opts, "throttling.iops-read", 0);
cc0681c4 448 cfg.buckets[THROTTLE_OPS_WRITE].avg =
57975222 449 qemu_opt_get_number(opts, "throttling.iops-write", 0);
0563e191 450
3e9fab69
BC
451 cfg.buckets[THROTTLE_BPS_TOTAL].max =
452 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
453 cfg.buckets[THROTTLE_BPS_READ].max =
454 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
455 cfg.buckets[THROTTLE_BPS_WRITE].max =
456 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
457 cfg.buckets[THROTTLE_OPS_TOTAL].max =
458 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
459 cfg.buckets[THROTTLE_OPS_READ].max =
460 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
461 cfg.buckets[THROTTLE_OPS_WRITE].max =
462 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
cc0681c4 463
2024c1df 464 cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
cc0681c4 465
76f4afb4
AG
466 throttling_group = qemu_opt_get(opts, "throttling.group");
467
cc0681c4 468 if (!check_throttle_config(&cfg, &error)) {
b681072d 469 error_propagate(errp, error);
ec9c10d2 470 goto early_err;
0563e191
ZYW
471 }
472
92aa5c6d 473 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
666daa68 474 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
b681072d 475 on_write_error = parse_block_error_action(buf, 0, &error);
84d18f06 476 if (error) {
b681072d 477 error_propagate(errp, error);
ec9c10d2 478 goto early_err;
666daa68
MA
479 }
480 }
481
92aa5c6d 482 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
666daa68 483 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
b681072d 484 on_read_error = parse_block_error_action(buf, 1, &error);
84d18f06 485 if (error) {
b681072d 486 error_propagate(errp, error);
ec9c10d2 487 goto early_err;
666daa68
MA
488 }
489 }
490
465bee1d 491 detect_zeroes =
9e7dac7c
PL
492 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
493 qemu_opt_get(opts, "detect-zeroes"),
494 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
495 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
496 &error);
465bee1d
PL
497 if (error) {
498 error_propagate(errp, error);
499 goto early_err;
500 }
501
502 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
503 !(bdrv_flags & BDRV_O_UNMAP)) {
504 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
505 "without setting discard operation to unmap");
506 goto early_err;
507 }
508
326642bc 509 /* init */
e4342ce5
HR
510 if ((!file || !*file) && !has_driver_specific_opts) {
511 blk = blk_new_with_bs(qemu_opts_id(opts), errp);
512 if (!blk) {
513 goto early_err;
514 }
abd7f68d 515
e4342ce5
HR
516 bs = blk_bs(blk);
517 bs->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
518 bs->read_only = ro;
0563e191 519
e4342ce5
HR
520 QDECREF(bs_opts);
521 } else {
522 if (file && !*file) {
c2ad1b0c 523 file = NULL;
c2ad1b0c 524 }
666daa68 525
e4342ce5
HR
526 if (snapshot) {
527 /* always use cache=unsafe with snapshot */
528 bdrv_flags &= ~BDRV_O_CACHE_MASK;
529 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
530 }
531
532 if (copy_on_read) {
533 bdrv_flags |= BDRV_O_COPY_ON_READ;
534 }
fb0490f6 535
e4342ce5
HR
536 if (runstate_check(RUN_STATE_INMIGRATE)) {
537 bdrv_flags |= BDRV_O_INCOMING;
538 }
539
540 bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
541
542 blk = blk_new_open(qemu_opts_id(opts), file, NULL, bs_opts, bdrv_flags,
543 errp);
544 if (!blk) {
545 goto err_no_bs_opts;
546 }
547 bs = blk_bs(blk);
ed9d4205
BC
548 }
549
e4342ce5 550 bs->detect_zeroes = detect_zeroes;
666daa68 551
e4342ce5 552 bdrv_set_on_error(bs, on_read_error, on_write_error);
0006383e 553
e4342ce5
HR
554 /* disk I/O throttling */
555 if (throttle_enabled(&cfg)) {
76f4afb4
AG
556 if (!throttling_group) {
557 throttling_group = blk_name(blk);
558 }
559 bdrv_io_limits_enable(bs, throttling_group);
e4342ce5 560 bdrv_set_io_limits(bs, &cfg);
666daa68
MA
561 }
562
a0f1eab1 563 if (bdrv_key_required(bs)) {
666daa68 564 autostart = 0;
a0f1eab1 565 }
0006383e 566
e4342ce5 567err_no_bs_opts:
0006383e 568 qemu_opts_del(opts);
18e46a03 569 return blk;
a9ae2bff 570
ec9c10d2 571early_err:
ec9c10d2 572 qemu_opts_del(opts);
6376f952
MA
573err_no_opts:
574 QDECREF(bs_opts);
a9ae2bff 575 return NULL;
666daa68
MA
576}
577
5abbf0ee
KW
578static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
579 Error **errp)
57975222
KW
580{
581 const char *value;
582
583 value = qemu_opt_get(opts, from);
584 if (value) {
5abbf0ee
KW
585 if (qemu_opt_find(opts, to)) {
586 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
587 "same time", to, from);
588 return;
589 }
20d6cd47
JL
590 }
591
592 /* rename all items in opts */
593 while ((value = qemu_opt_get(opts, from))) {
f43e47db 594 qemu_opt_set(opts, to, value, &error_abort);
57975222
KW
595 qemu_opt_unset(opts, from);
596 }
597}
598
33cb7dc8
KW
599QemuOptsList qemu_legacy_drive_opts = {
600 .name = "drive",
601 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
602 .desc = {
603 {
87a899c5
KW
604 .name = "bus",
605 .type = QEMU_OPT_NUMBER,
606 .help = "bus number",
607 },{
608 .name = "unit",
609 .type = QEMU_OPT_NUMBER,
610 .help = "unit number (i.e. lun for scsi)",
611 },{
612 .name = "index",
613 .type = QEMU_OPT_NUMBER,
614 .help = "index number",
615 },{
33cb7dc8
KW
616 .name = "media",
617 .type = QEMU_OPT_STRING,
618 .help = "media type (disk, cdrom)",
593d464b
KW
619 },{
620 .name = "if",
621 .type = QEMU_OPT_STRING,
622 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
b41a7338
KW
623 },{
624 .name = "cyls",
625 .type = QEMU_OPT_NUMBER,
626 .help = "number of cylinders (ide disk geometry)",
627 },{
628 .name = "heads",
629 .type = QEMU_OPT_NUMBER,
630 .help = "number of heads (ide disk geometry)",
631 },{
632 .name = "secs",
633 .type = QEMU_OPT_NUMBER,
634 .help = "number of sectors (ide disk geometry)",
635 },{
636 .name = "trans",
637 .type = QEMU_OPT_STRING,
638 .help = "chs translation (auto, lba, none)",
26929298
KW
639 },{
640 .name = "boot",
641 .type = QEMU_OPT_BOOL,
642 .help = "(deprecated, ignored)",
394c7d4d
KW
643 },{
644 .name = "addr",
645 .type = QEMU_OPT_STRING,
646 .help = "pci address (virtio only)",
bcf83158
KW
647 },{
648 .name = "serial",
649 .type = QEMU_OPT_STRING,
650 .help = "disk serial number",
d095b465
HR
651 },{
652 .name = "file",
653 .type = QEMU_OPT_STRING,
654 .help = "file name",
33cb7dc8 655 },
0ebd24e0
KW
656
657 /* Options that are passed on, but have special semantics with -drive */
658 {
659 .name = "read-only",
660 .type = QEMU_OPT_BOOL,
661 .help = "open drive file as read-only",
ee13ed1c
KW
662 },{
663 .name = "rerror",
664 .type = QEMU_OPT_STRING,
665 .help = "read error action",
666 },{
667 .name = "werror",
668 .type = QEMU_OPT_STRING,
669 .help = "write error action",
0ebd24e0
KW
670 },{
671 .name = "copy-on-read",
672 .type = QEMU_OPT_BOOL,
673 .help = "copy read data from backing file into image file",
674 },
675
33cb7dc8
KW
676 { /* end of list */ }
677 },
678};
679
60e19e06 680DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
57975222 681{
29c4e2b5 682 const char *value;
18e46a03 683 BlockBackend *blk;
33cb7dc8 684 DriveInfo *dinfo = NULL;
f298d071 685 QDict *bs_opts;
33cb7dc8
KW
686 QemuOpts *legacy_opts;
687 DriveMediaType media = MEDIA_DISK;
593d464b 688 BlockInterfaceType type;
b41a7338 689 int cyls, heads, secs, translation;
87a899c5 690 int max_devs, bus_id, unit_id, index;
394c7d4d 691 const char *devaddr;
ee13ed1c 692 const char *werror, *rerror;
a7fdbcf0
FZ
693 bool read_only = false;
694 bool copy_on_read;
bcf83158 695 const char *serial;
d095b465 696 const char *filename;
33cb7dc8 697 Error *local_err = NULL;
247147fb 698 int i;
29c4e2b5 699
57975222 700 /* Change legacy command line options into QMP ones */
247147fb
KW
701 static const struct {
702 const char *from;
703 const char *to;
704 } opt_renames[] = {
705 { "iops", "throttling.iops-total" },
706 { "iops_rd", "throttling.iops-read" },
707 { "iops_wr", "throttling.iops-write" },
57975222 708
247147fb
KW
709 { "bps", "throttling.bps-total" },
710 { "bps_rd", "throttling.bps-read" },
711 { "bps_wr", "throttling.bps-write" },
57975222 712
247147fb
KW
713 { "iops_max", "throttling.iops-total-max" },
714 { "iops_rd_max", "throttling.iops-read-max" },
715 { "iops_wr_max", "throttling.iops-write-max" },
3e9fab69 716
247147fb
KW
717 { "bps_max", "throttling.bps-total-max" },
718 { "bps_rd_max", "throttling.bps-read-max" },
719 { "bps_wr_max", "throttling.bps-write-max" },
3e9fab69 720
247147fb 721 { "iops_size", "throttling.iops-size" },
2024c1df 722
76f4afb4
AG
723 { "group", "throttling.group" },
724
247147fb
KW
725 { "readonly", "read-only" },
726 };
727
728 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
5abbf0ee
KW
729 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
730 &local_err);
731 if (local_err) {
565f65d2 732 error_report_err(local_err);
5abbf0ee
KW
733 return NULL;
734 }
247147fb 735 }
0f227a94 736
29c4e2b5
KW
737 value = qemu_opt_get(all_opts, "cache");
738 if (value) {
739 int flags = 0;
740
741 if (bdrv_parse_cache_flags(value, &flags) != 0) {
742 error_report("invalid cache option");
743 return NULL;
744 }
745
746 /* Specific options take precedence */
54861b92
KW
747 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
748 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
cccb7967 749 !!(flags & BDRV_O_CACHE_WB), &error_abort);
29c4e2b5 750 }
54861b92
KW
751 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
752 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
cccb7967 753 !!(flags & BDRV_O_NOCACHE), &error_abort);
29c4e2b5 754 }
54861b92
KW
755 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
756 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
cccb7967 757 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
29c4e2b5
KW
758 }
759 qemu_opt_unset(all_opts, "cache");
760 }
761
f298d071
KW
762 /* Get a QDict for processing the options */
763 bs_opts = qdict_new();
764 qemu_opts_to_qdict(all_opts, bs_opts);
765
87ea75d5
PC
766 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
767 &error_abort);
33cb7dc8 768 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
84d18f06 769 if (local_err) {
565f65d2 770 error_report_err(local_err);
33cb7dc8
KW
771 goto fail;
772 }
773
26929298
KW
774 /* Deprecated option boot=[on|off] */
775 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
776 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
777 "ignored. Future versions will reject this parameter. Please "
778 "update your scripts.\n");
779 }
780
33cb7dc8
KW
781 /* Media type */
782 value = qemu_opt_get(legacy_opts, "media");
783 if (value) {
784 if (!strcmp(value, "disk")) {
785 media = MEDIA_DISK;
786 } else if (!strcmp(value, "cdrom")) {
787 media = MEDIA_CDROM;
a7fdbcf0 788 read_only = true;
33cb7dc8
KW
789 } else {
790 error_report("'%s' invalid media", value);
791 goto fail;
792 }
793 }
794
0ebd24e0 795 /* copy-on-read is disabled with a warning for read-only devices */
a7fdbcf0 796 read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
0ebd24e0
KW
797 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
798
799 if (read_only && copy_on_read) {
800 error_report("warning: disabling copy-on-read on read-only drive");
801 copy_on_read = false;
802 }
803
804 qdict_put(bs_opts, "read-only",
805 qstring_from_str(read_only ? "on" : "off"));
806 qdict_put(bs_opts, "copy-on-read",
807 qstring_from_str(copy_on_read ? "on" :"off"));
808
593d464b
KW
809 /* Controller type */
810 value = qemu_opt_get(legacy_opts, "if");
811 if (value) {
812 for (type = 0;
813 type < IF_COUNT && strcmp(value, if_name[type]);
814 type++) {
815 }
816 if (type == IF_COUNT) {
817 error_report("unsupported bus type '%s'", value);
818 goto fail;
819 }
820 } else {
821 type = block_default_type;
822 }
823
b41a7338
KW
824 /* Geometry */
825 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
826 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
827 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
828
829 if (cyls || heads || secs) {
830 if (cyls < 1) {
831 error_report("invalid physical cyls number");
832 goto fail;
833 }
834 if (heads < 1) {
835 error_report("invalid physical heads number");
836 goto fail;
837 }
838 if (secs < 1) {
839 error_report("invalid physical secs number");
840 goto fail;
841 }
842 }
843
844 translation = BIOS_ATA_TRANSLATION_AUTO;
845 value = qemu_opt_get(legacy_opts, "trans");
846 if (value != NULL) {
847 if (!cyls) {
848 error_report("'%s' trans must be used with cyls, heads and secs",
849 value);
850 goto fail;
851 }
852 if (!strcmp(value, "none")) {
853 translation = BIOS_ATA_TRANSLATION_NONE;
854 } else if (!strcmp(value, "lba")) {
855 translation = BIOS_ATA_TRANSLATION_LBA;
f31c41ff
PB
856 } else if (!strcmp(value, "large")) {
857 translation = BIOS_ATA_TRANSLATION_LARGE;
858 } else if (!strcmp(value, "rechs")) {
859 translation = BIOS_ATA_TRANSLATION_RECHS;
b41a7338
KW
860 } else if (!strcmp(value, "auto")) {
861 translation = BIOS_ATA_TRANSLATION_AUTO;
862 } else {
863 error_report("'%s' invalid translation type", value);
864 goto fail;
865 }
866 }
867
868 if (media == MEDIA_CDROM) {
869 if (cyls || secs || heads) {
870 error_report("CHS can't be set with media=cdrom");
871 goto fail;
872 }
873 }
874
87a899c5
KW
875 /* Device address specified by bus/unit or index.
876 * If none was specified, try to find the first free one. */
877 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
878 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
879 index = qemu_opt_get_number(legacy_opts, "index", -1);
880
881 max_devs = if_max_devs[type];
882
883 if (index != -1) {
884 if (bus_id != 0 || unit_id != -1) {
885 error_report("index cannot be used with bus and unit");
886 goto fail;
887 }
888 bus_id = drive_index_to_bus_id(type, index);
889 unit_id = drive_index_to_unit_id(type, index);
890 }
891
892 if (unit_id == -1) {
893 unit_id = 0;
894 while (drive_get(type, bus_id, unit_id) != NULL) {
895 unit_id++;
896 if (max_devs && unit_id >= max_devs) {
897 unit_id -= max_devs;
898 bus_id++;
899 }
900 }
901 }
902
903 if (max_devs && unit_id >= max_devs) {
904 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
905 goto fail;
906 }
907
908 if (drive_get(type, bus_id, unit_id) != NULL) {
909 error_report("drive with bus=%d, unit=%d (index=%d) exists",
910 bus_id, unit_id, index);
911 goto fail;
912 }
913
bcf83158
KW
914 /* Serial number */
915 serial = qemu_opt_get(legacy_opts, "serial");
916
87a899c5
KW
917 /* no id supplied -> create one */
918 if (qemu_opts_id(all_opts) == NULL) {
919 char *new_id;
920 const char *mediastr = "";
921 if (type == IF_IDE || type == IF_SCSI) {
922 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
923 }
924 if (max_devs) {
925 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
926 mediastr, unit_id);
927 } else {
928 new_id = g_strdup_printf("%s%s%i", if_name[type],
929 mediastr, unit_id);
930 }
931 qdict_put(bs_opts, "id", qstring_from_str(new_id));
932 g_free(new_id);
933 }
934
394c7d4d
KW
935 /* Add virtio block device */
936 devaddr = qemu_opt_get(legacy_opts, "addr");
937 if (devaddr && type != IF_VIRTIO) {
938 error_report("addr is not supported by this bus type");
939 goto fail;
940 }
941
942 if (type == IF_VIRTIO) {
943 QemuOpts *devopts;
87ea75d5
PC
944 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
945 &error_abort);
394c7d4d 946 if (arch_type == QEMU_ARCH_S390X) {
1f68f1d3 947 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
394c7d4d 948 } else {
f43e47db 949 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
394c7d4d 950 }
f43e47db
MA
951 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
952 &error_abort);
394c7d4d 953 if (devaddr) {
f43e47db 954 qemu_opt_set(devopts, "addr", devaddr, &error_abort);
394c7d4d
KW
955 }
956 }
957
d095b465
HR
958 filename = qemu_opt_get(legacy_opts, "file");
959
ee13ed1c
KW
960 /* Check werror/rerror compatibility with if=... */
961 werror = qemu_opt_get(legacy_opts, "werror");
962 if (werror != NULL) {
963 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
964 type != IF_NONE) {
965 error_report("werror is not supported by this bus type");
966 goto fail;
967 }
968 qdict_put(bs_opts, "werror", qstring_from_str(werror));
969 }
970
971 rerror = qemu_opt_get(legacy_opts, "rerror");
972 if (rerror != NULL) {
973 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
974 type != IF_NONE) {
975 error_report("rerror is not supported by this bus type");
976 goto fail;
977 }
978 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
979 }
980
2d246f01 981 /* Actual block device init: Functionality shared with blockdev-add */
18e46a03 982 blk = blockdev_init(filename, bs_opts, &local_err);
3cb0e25c 983 bs_opts = NULL;
18e46a03 984 if (!blk) {
84d18f06 985 if (local_err) {
565f65d2 986 error_report_err(local_err);
b681072d 987 }
2d246f01 988 goto fail;
b681072d 989 } else {
84d18f06 990 assert(!local_err);
2d246f01
KW
991 }
992
26f8b3a8
MA
993 /* Create legacy DriveInfo */
994 dinfo = g_malloc0(sizeof(*dinfo));
f298d071 995 dinfo->opts = all_opts;
2d246f01 996
b41a7338
KW
997 dinfo->cyls = cyls;
998 dinfo->heads = heads;
999 dinfo->secs = secs;
1000 dinfo->trans = translation;
1001
ee13ed1c 1002 dinfo->type = type;
87a899c5
KW
1003 dinfo->bus = bus_id;
1004 dinfo->unit = unit_id;
394c7d4d 1005 dinfo->devaddr = devaddr;
bcf83158
KW
1006 dinfo->serial = g_strdup(serial);
1007
26f8b3a8
MA
1008 blk_set_legacy_dinfo(blk, dinfo);
1009
e34ef046
KW
1010 switch(type) {
1011 case IF_IDE:
1012 case IF_SCSI:
1013 case IF_XEN:
1014 case IF_NONE:
1015 dinfo->media_cd = media == MEDIA_CDROM;
1016 break;
1017 default:
1018 break;
1019 }
1020
2d246f01 1021fail:
33cb7dc8 1022 qemu_opts_del(legacy_opts);
3cb0e25c 1023 QDECREF(bs_opts);
2d246f01 1024 return dinfo;
57975222
KW
1025}
1026
3e5a50d6 1027void hmp_commit(Monitor *mon, const QDict *qdict)
666daa68 1028{
666daa68 1029 const char *device = qdict_get_str(qdict, "device");
a0e8544c 1030 BlockBackend *blk;
e8877497 1031 int ret;
666daa68 1032
6ab4b5ab 1033 if (!strcmp(device, "all")) {
e8877497 1034 ret = bdrv_commit_all();
6ab4b5ab 1035 } else {
a0e8544c
FZ
1036 blk = blk_by_name(device);
1037 if (!blk) {
58513bde 1038 monitor_printf(mon, "Device '%s' not found\n", device);
ac59eb95 1039 return;
6ab4b5ab 1040 }
a0e8544c 1041 ret = bdrv_commit(blk_bs(blk));
58513bde
JC
1042 }
1043 if (ret < 0) {
1044 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1045 strerror(-ret));
666daa68
MA
1046 }
1047}
1048
6cc2a415
PB
1049static void blockdev_do_action(int kind, void *data, Error **errp)
1050{
c8a83e85
KW
1051 TransactionAction action;
1052 TransactionActionList list;
6cc2a415
PB
1053
1054 action.kind = kind;
1055 action.data = data;
1056 list.value = &action;
1057 list.next = NULL;
1058 qmp_transaction(&list, errp);
1059}
1060
0901f67e
BC
1061void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1062 bool has_node_name, const char *node_name,
1063 const char *snapshot_file,
1064 bool has_snapshot_node_name,
1065 const char *snapshot_node_name,
6106e249 1066 bool has_format, const char *format,
0901f67e 1067 bool has_mode, NewImageMode mode, Error **errp)
f8882568 1068{
6cc2a415 1069 BlockdevSnapshot snapshot = {
0901f67e 1070 .has_device = has_device,
6cc2a415 1071 .device = (char *) device,
0901f67e
BC
1072 .has_node_name = has_node_name,
1073 .node_name = (char *) node_name,
6cc2a415 1074 .snapshot_file = (char *) snapshot_file,
0901f67e
BC
1075 .has_snapshot_node_name = has_snapshot_node_name,
1076 .snapshot_node_name = (char *) snapshot_node_name,
6cc2a415
PB
1077 .has_format = has_format,
1078 .format = (char *) format,
1079 .has_mode = has_mode,
1080 .mode = mode,
1081 };
c8a83e85
KW
1082 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1083 &snapshot, errp);
f8882568
JS
1084}
1085
f323bc9e
WX
1086void qmp_blockdev_snapshot_internal_sync(const char *device,
1087 const char *name,
1088 Error **errp)
1089{
1090 BlockdevSnapshotInternal snapshot = {
1091 .device = (char *) device,
1092 .name = (char *) name
1093 };
1094
1095 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1096 &snapshot, errp);
1097}
1098
44e3e053
WX
1099SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1100 bool has_id,
1101 const char *id,
1102 bool has_name,
1103 const char *name,
1104 Error **errp)
1105{
a0e8544c
FZ
1106 BlockDriverState *bs;
1107 BlockBackend *blk;
4ef3982a 1108 AioContext *aio_context;
44e3e053
WX
1109 QEMUSnapshotInfo sn;
1110 Error *local_err = NULL;
1111 SnapshotInfo *info = NULL;
1112 int ret;
1113
a0e8544c
FZ
1114 blk = blk_by_name(device);
1115 if (!blk) {
75158ebb
MA
1116 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1117 "Device '%s' not found", device);
44e3e053
WX
1118 return NULL;
1119 }
a0e8544c 1120 bs = blk_bs(blk);
44e3e053
WX
1121
1122 if (!has_id) {
1123 id = NULL;
1124 }
1125
1126 if (!has_name) {
1127 name = NULL;
1128 }
1129
1130 if (!id && !name) {
1131 error_setg(errp, "Name or id must be provided");
1132 return NULL;
1133 }
1134
4ef3982a
SH
1135 aio_context = bdrv_get_aio_context(bs);
1136 aio_context_acquire(aio_context);
1137
0b928854
SH
1138 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1139 goto out_aio_context;
1140 }
1141
44e3e053 1142 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
84d18f06 1143 if (local_err) {
44e3e053 1144 error_propagate(errp, local_err);
4ef3982a 1145 goto out_aio_context;
44e3e053
WX
1146 }
1147 if (!ret) {
1148 error_setg(errp,
1149 "Snapshot with id '%s' and name '%s' does not exist on "
1150 "device '%s'",
1151 STR_OR_NULL(id), STR_OR_NULL(name), device);
4ef3982a 1152 goto out_aio_context;
44e3e053
WX
1153 }
1154
1155 bdrv_snapshot_delete(bs, id, name, &local_err);
84d18f06 1156 if (local_err) {
44e3e053 1157 error_propagate(errp, local_err);
4ef3982a 1158 goto out_aio_context;
44e3e053
WX
1159 }
1160
4ef3982a
SH
1161 aio_context_release(aio_context);
1162
5839e53b 1163 info = g_new0(SnapshotInfo, 1);
44e3e053
WX
1164 info->id = g_strdup(sn.id_str);
1165 info->name = g_strdup(sn.name);
1166 info->date_nsec = sn.date_nsec;
1167 info->date_sec = sn.date_sec;
1168 info->vm_state_size = sn.vm_state_size;
1169 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1170 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1171
1172 return info;
4ef3982a
SH
1173
1174out_aio_context:
1175 aio_context_release(aio_context);
1176 return NULL;
44e3e053 1177}
8802d1fd 1178
341ebc2f
JS
1179/**
1180 * block_dirty_bitmap_lookup:
1181 * Return a dirty bitmap (if present), after validating
1182 * the node reference and bitmap names.
1183 *
1184 * @node: The name of the BDS node to search for bitmaps
1185 * @name: The name of the bitmap to search for
1186 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1187 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1188 * @errp: Output pointer for error information. Can be NULL.
1189 *
1190 * @return: A bitmap object on success, or NULL on failure.
1191 */
1192static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1193 const char *name,
1194 BlockDriverState **pbs,
1195 AioContext **paio,
1196 Error **errp)
1197{
1198 BlockDriverState *bs;
1199 BdrvDirtyBitmap *bitmap;
1200 AioContext *aio_context;
1201
1202 if (!node) {
1203 error_setg(errp, "Node cannot be NULL");
1204 return NULL;
1205 }
1206 if (!name) {
1207 error_setg(errp, "Bitmap name cannot be NULL");
1208 return NULL;
1209 }
1210 bs = bdrv_lookup_bs(node, node, NULL);
1211 if (!bs) {
1212 error_setg(errp, "Node '%s' not found", node);
1213 return NULL;
1214 }
1215
1216 aio_context = bdrv_get_aio_context(bs);
1217 aio_context_acquire(aio_context);
1218
1219 bitmap = bdrv_find_dirty_bitmap(bs, name);
1220 if (!bitmap) {
1221 error_setg(errp, "Dirty bitmap '%s' not found", name);
1222 goto fail;
1223 }
1224
1225 if (pbs) {
1226 *pbs = bs;
1227 }
1228 if (paio) {
1229 *paio = aio_context;
1230 } else {
1231 aio_context_release(aio_context);
1232 }
1233
1234 return bitmap;
1235
1236 fail:
1237 aio_context_release(aio_context);
1238 return NULL;
1239}
1240
b756b9ce 1241/* New and old BlockDriverState structs for atomic group operations */
ba0c86a3 1242
ba5d6ab6 1243typedef struct BlkTransactionState BlkTransactionState;
ba0c86a3
WX
1244
1245/* Only prepare() may fail. In a single transaction, only one of commit() or
1246 abort() will be called, clean() will always be called if it present. */
1247typedef struct BdrvActionOps {
1248 /* Size of state struct, in bytes. */
1249 size_t instance_size;
1250 /* Prepare the work, must NOT be NULL. */
ba5d6ab6 1251 void (*prepare)(BlkTransactionState *common, Error **errp);
f9ea81e8 1252 /* Commit the changes, can be NULL. */
ba5d6ab6 1253 void (*commit)(BlkTransactionState *common);
ba0c86a3 1254 /* Abort the changes on fail, can be NULL. */
ba5d6ab6 1255 void (*abort)(BlkTransactionState *common);
ba0c86a3 1256 /* Clean up resource in the end, can be NULL. */
ba5d6ab6 1257 void (*clean)(BlkTransactionState *common);
ba0c86a3
WX
1258} BdrvActionOps;
1259
1260/*
1261 * This structure must be arranged as first member in child type, assuming
1262 * that compiler will also arrange it to the same address with parent instance.
1263 * Later it will be used in free().
1264 */
ba5d6ab6 1265struct BlkTransactionState {
c8a83e85 1266 TransactionAction *action;
ba0c86a3 1267 const BdrvActionOps *ops;
ba5d6ab6 1268 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
ba0c86a3
WX
1269};
1270
bbe86010
WX
1271/* internal snapshot private data */
1272typedef struct InternalSnapshotState {
1273 BlkTransactionState common;
1274 BlockDriverState *bs;
5d6e96ef 1275 AioContext *aio_context;
bbe86010
WX
1276 QEMUSnapshotInfo sn;
1277} InternalSnapshotState;
1278
1279static void internal_snapshot_prepare(BlkTransactionState *common,
1280 Error **errp)
1281{
f70edf99 1282 Error *local_err = NULL;
bbe86010
WX
1283 const char *device;
1284 const char *name;
a0e8544c 1285 BlockBackend *blk;
bbe86010
WX
1286 BlockDriverState *bs;
1287 QEMUSnapshotInfo old_sn, *sn;
1288 bool ret;
1289 qemu_timeval tv;
1290 BlockdevSnapshotInternal *internal;
1291 InternalSnapshotState *state;
1292 int ret1;
1293
1294 g_assert(common->action->kind ==
1295 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1296 internal = common->action->blockdev_snapshot_internal_sync;
1297 state = DO_UPCAST(InternalSnapshotState, common, common);
1298
1299 /* 1. parse input */
1300 device = internal->device;
1301 name = internal->name;
1302
1303 /* 2. check for validation */
a0e8544c
FZ
1304 blk = blk_by_name(device);
1305 if (!blk) {
75158ebb
MA
1306 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1307 "Device '%s' not found", device);
bbe86010
WX
1308 return;
1309 }
a0e8544c 1310 bs = blk_bs(blk);
bbe86010 1311
5d6e96ef
SH
1312 /* AioContext is released in .clean() */
1313 state->aio_context = bdrv_get_aio_context(bs);
1314 aio_context_acquire(state->aio_context);
1315
bbe86010 1316 if (!bdrv_is_inserted(bs)) {
c6bd8c70 1317 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
bbe86010
WX
1318 return;
1319 }
1320
3dc7ca3c
SH
1321 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1322 return;
1323 }
1324
bbe86010 1325 if (bdrv_is_read_only(bs)) {
81e5f78a 1326 error_setg(errp, "Device '%s' is read only", device);
bbe86010
WX
1327 return;
1328 }
1329
1330 if (!bdrv_can_snapshot(bs)) {
81e5f78a
AG
1331 error_setg(errp, "Block format '%s' used by device '%s' "
1332 "does not support internal snapshots",
1333 bs->drv->format_name, device);
bbe86010
WX
1334 return;
1335 }
1336
1337 if (!strlen(name)) {
1338 error_setg(errp, "Name is empty");
1339 return;
1340 }
1341
1342 /* check whether a snapshot with name exist */
f70edf99
MA
1343 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1344 &local_err);
1345 if (local_err) {
1346 error_propagate(errp, local_err);
bbe86010
WX
1347 return;
1348 } else if (ret) {
1349 error_setg(errp,
1350 "Snapshot with name '%s' already exists on device '%s'",
1351 name, device);
1352 return;
1353 }
1354
1355 /* 3. take the snapshot */
1356 sn = &state->sn;
1357 pstrcpy(sn->name, sizeof(sn->name), name);
1358 qemu_gettimeofday(&tv);
1359 sn->date_sec = tv.tv_sec;
1360 sn->date_nsec = tv.tv_usec * 1000;
1361 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1362
1363 ret1 = bdrv_snapshot_create(bs, sn);
1364 if (ret1 < 0) {
1365 error_setg_errno(errp, -ret1,
1366 "Failed to create snapshot '%s' on device '%s'",
1367 name, device);
1368 return;
1369 }
1370
1371 /* 4. succeed, mark a snapshot is created */
1372 state->bs = bs;
1373}
1374
1375static void internal_snapshot_abort(BlkTransactionState *common)
1376{
1377 InternalSnapshotState *state =
1378 DO_UPCAST(InternalSnapshotState, common, common);
1379 BlockDriverState *bs = state->bs;
1380 QEMUSnapshotInfo *sn = &state->sn;
1381 Error *local_error = NULL;
1382
1383 if (!bs) {
1384 return;
1385 }
1386
1387 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1388 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1389 "device '%s' in abort: %s",
1390 sn->id_str,
1391 sn->name,
1392 bdrv_get_device_name(bs),
1393 error_get_pretty(local_error));
1394 error_free(local_error);
1395 }
1396}
1397
5d6e96ef
SH
1398static void internal_snapshot_clean(BlkTransactionState *common)
1399{
1400 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1401 common, common);
1402
1403 if (state->aio_context) {
1404 aio_context_release(state->aio_context);
1405 }
1406}
1407
ba0c86a3 1408/* external snapshot private data */
ba5d6ab6
SH
1409typedef struct ExternalSnapshotState {
1410 BlkTransactionState common;
8802d1fd
JC
1411 BlockDriverState *old_bs;
1412 BlockDriverState *new_bs;
5d6e96ef 1413 AioContext *aio_context;
ba5d6ab6 1414} ExternalSnapshotState;
8802d1fd 1415
ba5d6ab6 1416static void external_snapshot_prepare(BlkTransactionState *common,
9b9877ee
WX
1417 Error **errp)
1418{
9b9877ee
WX
1419 BlockDriver *drv;
1420 int flags, ret;
0901f67e 1421 QDict *options = NULL;
9b9877ee 1422 Error *local_err = NULL;
0901f67e 1423 bool has_device = false;
e2a31e87 1424 const char *device;
0901f67e
BC
1425 bool has_node_name = false;
1426 const char *node_name;
1427 bool has_snapshot_node_name = false;
1428 const char *snapshot_node_name;
e2a31e87
WX
1429 const char *new_image_file;
1430 const char *format = "qcow2";
1431 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
ba5d6ab6
SH
1432 ExternalSnapshotState *state =
1433 DO_UPCAST(ExternalSnapshotState, common, common);
c8a83e85 1434 TransactionAction *action = common->action;
9b9877ee 1435
e2a31e87 1436 /* get parameters */
c8a83e85 1437 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
e2a31e87 1438
0901f67e 1439 has_device = action->blockdev_snapshot_sync->has_device;
e2a31e87 1440 device = action->blockdev_snapshot_sync->device;
0901f67e
BC
1441 has_node_name = action->blockdev_snapshot_sync->has_node_name;
1442 node_name = action->blockdev_snapshot_sync->node_name;
1443 has_snapshot_node_name =
1444 action->blockdev_snapshot_sync->has_snapshot_node_name;
1445 snapshot_node_name = action->blockdev_snapshot_sync->snapshot_node_name;
1446
e2a31e87
WX
1447 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1448 if (action->blockdev_snapshot_sync->has_format) {
1449 format = action->blockdev_snapshot_sync->format;
1450 }
1451 if (action->blockdev_snapshot_sync->has_mode) {
1452 mode = action->blockdev_snapshot_sync->mode;
1453 }
1454
1455 /* start processing */
9b9877ee
WX
1456 drv = bdrv_find_format(format);
1457 if (!drv) {
c6bd8c70 1458 error_setg(errp, QERR_INVALID_BLOCK_FORMAT, format);
9b9877ee
WX
1459 return;
1460 }
1461
0901f67e
BC
1462 state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
1463 has_node_name ? node_name : NULL,
1464 &local_err);
84d18f06 1465 if (local_err) {
0901f67e
BC
1466 error_propagate(errp, local_err);
1467 return;
1468 }
1469
1470 if (has_node_name && !has_snapshot_node_name) {
1471 error_setg(errp, "New snapshot node name missing");
1472 return;
1473 }
1474
1475 if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
1476 error_setg(errp, "New snapshot node name already existing");
9b9877ee
WX
1477 return;
1478 }
1479
5d6e96ef
SH
1480 /* Acquire AioContext now so any threads operating on old_bs stop */
1481 state->aio_context = bdrv_get_aio_context(state->old_bs);
1482 aio_context_acquire(state->aio_context);
1483
ba5d6ab6 1484 if (!bdrv_is_inserted(state->old_bs)) {
c6bd8c70 1485 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
9b9877ee
WX
1486 return;
1487 }
1488
3718d8ab
FZ
1489 if (bdrv_op_is_blocked(state->old_bs,
1490 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
9b9877ee
WX
1491 return;
1492 }
1493
ba5d6ab6
SH
1494 if (!bdrv_is_read_only(state->old_bs)) {
1495 if (bdrv_flush(state->old_bs)) {
c6bd8c70 1496 error_setg(errp, QERR_IO_ERROR);
9b9877ee
WX
1497 return;
1498 }
1499 }
1500
212a5a8f 1501 if (!bdrv_is_first_non_filter(state->old_bs)) {
c6bd8c70 1502 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
f6186f49
BC
1503 return;
1504 }
1505
ba5d6ab6 1506 flags = state->old_bs->open_flags;
9b9877ee 1507
9b9877ee
WX
1508 /* create new image w/backing file */
1509 if (mode != NEW_IMAGE_MODE_EXISTING) {
1510 bdrv_img_create(new_image_file, format,
ba5d6ab6
SH
1511 state->old_bs->filename,
1512 state->old_bs->drv->format_name,
9b9877ee 1513 NULL, -1, flags, &local_err, false);
84d18f06 1514 if (local_err) {
9b9877ee
WX
1515 error_propagate(errp, local_err);
1516 return;
1517 }
1518 }
1519
0901f67e
BC
1520 if (has_snapshot_node_name) {
1521 options = qdict_new();
1522 qdict_put(options, "node-name",
1523 qstring_from_str(snapshot_node_name));
1524 }
1525
9b9877ee
WX
1526 /* TODO Inherit bs->options or only take explicit options with an
1527 * extended QMP command? */
f67503e5 1528 assert(state->new_bs == NULL);
ddf5636d 1529 ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
34b5d2c6 1530 flags | BDRV_O_NO_BACKING, drv, &local_err);
f67503e5 1531 /* We will manually add the backing_hd field to the bs later */
9b9877ee 1532 if (ret != 0) {
34b5d2c6 1533 error_propagate(errp, local_err);
9b9877ee
WX
1534 }
1535}
1536
ba5d6ab6 1537static void external_snapshot_commit(BlkTransactionState *common)
3b0047e8 1538{
ba5d6ab6
SH
1539 ExternalSnapshotState *state =
1540 DO_UPCAST(ExternalSnapshotState, common, common);
ba0c86a3 1541
5d6e96ef
SH
1542 bdrv_set_aio_context(state->new_bs, state->aio_context);
1543
ba5d6ab6
SH
1544 /* This removes our old bs and adds the new bs */
1545 bdrv_append(state->new_bs, state->old_bs);
3b0047e8
WX
1546 /* We don't need (or want) to use the transactional
1547 * bdrv_reopen_multiple() across all the entries at once, because we
1548 * don't want to abort all of them if one of them fails the reopen */
ba5d6ab6 1549 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
3b0047e8 1550 NULL);
5d6e96ef
SH
1551
1552 aio_context_release(state->aio_context);
3b0047e8
WX
1553}
1554
ba5d6ab6 1555static void external_snapshot_abort(BlkTransactionState *common)
96b86bf7 1556{
ba5d6ab6
SH
1557 ExternalSnapshotState *state =
1558 DO_UPCAST(ExternalSnapshotState, common, common);
1559 if (state->new_bs) {
4f6fd349 1560 bdrv_unref(state->new_bs);
96b86bf7 1561 }
5d6e96ef
SH
1562 if (state->aio_context) {
1563 aio_context_release(state->aio_context);
1564 }
96b86bf7
WX
1565}
1566
3037f364
SH
1567typedef struct DriveBackupState {
1568 BlkTransactionState common;
1569 BlockDriverState *bs;
5d6e96ef 1570 AioContext *aio_context;
3037f364
SH
1571 BlockJob *job;
1572} DriveBackupState;
1573
1574static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1575{
1576 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
5d6e96ef 1577 BlockDriverState *bs;
a0e8544c 1578 BlockBackend *blk;
3037f364
SH
1579 DriveBackup *backup;
1580 Error *local_err = NULL;
1581
1582 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1583 backup = common->action->drive_backup;
1584
a0e8544c
FZ
1585 blk = blk_by_name(backup->device);
1586 if (!blk) {
75158ebb
MA
1587 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1588 "Device '%s' not found", backup->device);
5d6e96ef
SH
1589 return;
1590 }
a0e8544c 1591 bs = blk_bs(blk);
5d6e96ef
SH
1592
1593 /* AioContext is released in .clean() */
1594 state->aio_context = bdrv_get_aio_context(bs);
1595 aio_context_acquire(state->aio_context);
1596
3037f364
SH
1597 qmp_drive_backup(backup->device, backup->target,
1598 backup->has_format, backup->format,
b53169ea 1599 backup->sync,
3037f364
SH
1600 backup->has_mode, backup->mode,
1601 backup->has_speed, backup->speed,
d58d8453 1602 backup->has_bitmap, backup->bitmap,
3037f364
SH
1603 backup->has_on_source_error, backup->on_source_error,
1604 backup->has_on_target_error, backup->on_target_error,
1605 &local_err);
84d18f06 1606 if (local_err) {
3037f364 1607 error_propagate(errp, local_err);
3037f364
SH
1608 return;
1609 }
1610
5d6e96ef 1611 state->bs = bs;
3037f364
SH
1612 state->job = state->bs->job;
1613}
1614
1615static void drive_backup_abort(BlkTransactionState *common)
1616{
1617 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1618 BlockDriverState *bs = state->bs;
1619
1620 /* Only cancel if it's the job we started */
1621 if (bs && bs->job && bs->job == state->job) {
1622 block_job_cancel_sync(bs->job);
1623 }
1624}
1625
5d6e96ef
SH
1626static void drive_backup_clean(BlkTransactionState *common)
1627{
1628 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1629
1630 if (state->aio_context) {
1631 aio_context_release(state->aio_context);
1632 }
1633}
1634
bd8baecd
FZ
1635typedef struct BlockdevBackupState {
1636 BlkTransactionState common;
1637 BlockDriverState *bs;
1638 BlockJob *job;
1639 AioContext *aio_context;
1640} BlockdevBackupState;
1641
1642static void blockdev_backup_prepare(BlkTransactionState *common, Error **errp)
1643{
1644 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1645 BlockdevBackup *backup;
1646 BlockDriverState *bs, *target;
a0e8544c 1647 BlockBackend *blk;
bd8baecd
FZ
1648 Error *local_err = NULL;
1649
1650 assert(common->action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1651 backup = common->action->blockdev_backup;
1652
a0e8544c
FZ
1653 blk = blk_by_name(backup->device);
1654 if (!blk) {
5b347c54 1655 error_setg(errp, "Device '%s' not found", backup->device);
bd8baecd
FZ
1656 return;
1657 }
a0e8544c 1658 bs = blk_bs(blk);
bd8baecd 1659
a0e8544c
FZ
1660 blk = blk_by_name(backup->target);
1661 if (!blk) {
5b347c54 1662 error_setg(errp, "Device '%s' not found", backup->target);
bd8baecd
FZ
1663 return;
1664 }
a0e8544c 1665 target = blk_bs(blk);
bd8baecd
FZ
1666
1667 /* AioContext is released in .clean() */
1668 state->aio_context = bdrv_get_aio_context(bs);
1669 if (state->aio_context != bdrv_get_aio_context(target)) {
1670 state->aio_context = NULL;
1671 error_setg(errp, "Backup between two IO threads is not implemented");
1672 return;
1673 }
1674 aio_context_acquire(state->aio_context);
1675
1676 qmp_blockdev_backup(backup->device, backup->target,
1677 backup->sync,
1678 backup->has_speed, backup->speed,
1679 backup->has_on_source_error, backup->on_source_error,
1680 backup->has_on_target_error, backup->on_target_error,
1681 &local_err);
1682 if (local_err) {
1683 error_propagate(errp, local_err);
1684 return;
1685 }
1686
1687 state->bs = bs;
1688 state->job = state->bs->job;
1689}
1690
1691static void blockdev_backup_abort(BlkTransactionState *common)
1692{
1693 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1694 BlockDriverState *bs = state->bs;
1695
1696 /* Only cancel if it's the job we started */
1697 if (bs && bs->job && bs->job == state->job) {
1698 block_job_cancel_sync(bs->job);
1699 }
1700}
1701
1702static void blockdev_backup_clean(BlkTransactionState *common)
1703{
1704 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1705
1706 if (state->aio_context) {
1707 aio_context_release(state->aio_context);
1708 }
1709}
1710
78b18b78
SH
1711static void abort_prepare(BlkTransactionState *common, Error **errp)
1712{
1713 error_setg(errp, "Transaction aborted using Abort action");
1714}
1715
1716static void abort_commit(BlkTransactionState *common)
1717{
dfc6f865 1718 g_assert_not_reached(); /* this action never succeeds */
78b18b78
SH
1719}
1720
ba0c86a3 1721static const BdrvActionOps actions[] = {
c8a83e85 1722 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
ba5d6ab6 1723 .instance_size = sizeof(ExternalSnapshotState),
ba0c86a3
WX
1724 .prepare = external_snapshot_prepare,
1725 .commit = external_snapshot_commit,
1726 .abort = external_snapshot_abort,
1727 },
3037f364
SH
1728 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1729 .instance_size = sizeof(DriveBackupState),
1730 .prepare = drive_backup_prepare,
1731 .abort = drive_backup_abort,
5d6e96ef 1732 .clean = drive_backup_clean,
3037f364 1733 },
bd8baecd
FZ
1734 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
1735 .instance_size = sizeof(BlockdevBackupState),
1736 .prepare = blockdev_backup_prepare,
1737 .abort = blockdev_backup_abort,
1738 .clean = blockdev_backup_clean,
1739 },
78b18b78
SH
1740 [TRANSACTION_ACTION_KIND_ABORT] = {
1741 .instance_size = sizeof(BlkTransactionState),
1742 .prepare = abort_prepare,
1743 .commit = abort_commit,
1744 },
bbe86010
WX
1745 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1746 .instance_size = sizeof(InternalSnapshotState),
1747 .prepare = internal_snapshot_prepare,
1748 .abort = internal_snapshot_abort,
5d6e96ef 1749 .clean = internal_snapshot_clean,
bbe86010 1750 },
ba0c86a3
WX
1751};
1752
8802d1fd 1753/*
b756b9ce
SH
1754 * 'Atomic' group operations. The operations are performed as a set, and if
1755 * any fail then we roll back all operations in the group.
8802d1fd 1756 */
c8a83e85 1757void qmp_transaction(TransactionActionList *dev_list, Error **errp)
8802d1fd 1758{
c8a83e85 1759 TransactionActionList *dev_entry = dev_list;
ba5d6ab6 1760 BlkTransactionState *state, *next;
43e17041 1761 Error *local_err = NULL;
8802d1fd 1762
ba5d6ab6 1763 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
8802d1fd
JC
1764 QSIMPLEQ_INIT(&snap_bdrv_states);
1765
b756b9ce 1766 /* drain all i/o before any operations */
8802d1fd
JC
1767 bdrv_drain_all();
1768
b756b9ce 1769 /* We don't do anything in this loop that commits us to the operations */
8802d1fd 1770 while (NULL != dev_entry) {
c8a83e85 1771 TransactionAction *dev_info = NULL;
ba0c86a3 1772 const BdrvActionOps *ops;
52e7c241 1773
8802d1fd
JC
1774 dev_info = dev_entry->value;
1775 dev_entry = dev_entry->next;
1776
ba0c86a3
WX
1777 assert(dev_info->kind < ARRAY_SIZE(actions));
1778
1779 ops = &actions[dev_info->kind];
aa3fe714
HR
1780 assert(ops->instance_size > 0);
1781
ba5d6ab6
SH
1782 state = g_malloc0(ops->instance_size);
1783 state->ops = ops;
1784 state->action = dev_info;
1785 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
8802d1fd 1786
ba5d6ab6 1787 state->ops->prepare(state, &local_err);
84d18f06 1788 if (local_err) {
ba0c86a3
WX
1789 error_propagate(errp, local_err);
1790 goto delete_and_fail;
8802d1fd 1791 }
8802d1fd
JC
1792 }
1793
ba5d6ab6 1794 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
f9ea81e8
SH
1795 if (state->ops->commit) {
1796 state->ops->commit(state);
1797 }
8802d1fd
JC
1798 }
1799
1800 /* success */
1801 goto exit;
1802
1803delete_and_fail:
b756b9ce 1804 /* failure, and it is all-or-none; roll back all operations */
ba5d6ab6
SH
1805 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1806 if (state->ops->abort) {
1807 state->ops->abort(state);
ba0c86a3 1808 }
8802d1fd
JC
1809 }
1810exit:
ba5d6ab6
SH
1811 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1812 if (state->ops->clean) {
1813 state->ops->clean(state);
ba0c86a3 1814 }
ba5d6ab6 1815 g_free(state);
8802d1fd 1816 }
8802d1fd
JC
1817}
1818
1819
6007cdd4 1820static void eject_device(BlockBackend *blk, int force, Error **errp)
666daa68 1821{
6007cdd4 1822 BlockDriverState *bs = blk_bs(blk);
e3442099
SH
1823 AioContext *aio_context;
1824
1825 aio_context = bdrv_get_aio_context(bs);
1826 aio_context_acquire(aio_context);
6007cdd4 1827
3718d8ab 1828 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
e3442099 1829 goto out;
2d3735d3 1830 }
a7f53e26 1831 if (!blk_dev_has_removable_media(blk)) {
f231b88d
CR
1832 error_setg(errp, "Device '%s' is not removable",
1833 bdrv_get_device_name(bs));
e3442099 1834 goto out;
ea8f942f 1835 }
92d48558 1836
a7f53e26
MA
1837 if (blk_dev_is_medium_locked(blk) && !blk_dev_is_tray_open(blk)) {
1838 blk_dev_eject_request(blk, force);
025ccaa7 1839 if (!force) {
f231b88d
CR
1840 error_setg(errp, "Device '%s' is locked",
1841 bdrv_get_device_name(bs));
e3442099 1842 goto out;
025ccaa7 1843 }
666daa68 1844 }
92d48558 1845
3b5276b5 1846 bdrv_close(bs);
e3442099
SH
1847
1848out:
1849 aio_context_release(aio_context);
666daa68
MA
1850}
1851
c245b6a3 1852void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
666daa68 1853{
6007cdd4 1854 BlockBackend *blk;
666daa68 1855
6007cdd4
MA
1856 blk = blk_by_name(device);
1857 if (!blk) {
75158ebb
MA
1858 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1859 "Device '%s' not found", device);
c245b6a3 1860 return;
92d48558
LC
1861 }
1862
6007cdd4 1863 eject_device(blk, force, errp);
666daa68
MA
1864}
1865
12d3ba82
BC
1866void qmp_block_passwd(bool has_device, const char *device,
1867 bool has_node_name, const char *node_name,
1868 const char *password, Error **errp)
666daa68 1869{
12d3ba82 1870 Error *local_err = NULL;
666daa68 1871 BlockDriverState *bs;
e3442099 1872 AioContext *aio_context;
666daa68 1873
12d3ba82
BC
1874 bs = bdrv_lookup_bs(has_device ? device : NULL,
1875 has_node_name ? node_name : NULL,
1876 &local_err);
84d18f06 1877 if (local_err) {
12d3ba82 1878 error_propagate(errp, local_err);
a4dea8a9 1879 return;
666daa68
MA
1880 }
1881
e3442099
SH
1882 aio_context = bdrv_get_aio_context(bs);
1883 aio_context_acquire(aio_context);
1884
4d2855a3 1885 bdrv_add_key(bs, password, errp);
e3442099 1886
e3442099 1887 aio_context_release(aio_context);
666daa68
MA
1888}
1889
e3442099 1890/* Assumes AioContext is held */
333a96ec
LC
1891static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1892 int bdrv_flags, BlockDriver *drv,
1893 const char *password, Error **errp)
1894{
34b5d2c6 1895 Error *local_err = NULL;
0eef407c
LC
1896 int ret;
1897
ddf5636d 1898 ret = bdrv_open(&bs, filename, NULL, NULL, bdrv_flags, drv, &local_err);
0eef407c 1899 if (ret < 0) {
34b5d2c6 1900 error_propagate(errp, local_err);
333a96ec
LC
1901 return;
1902 }
1903
4d2855a3 1904 bdrv_add_key(bs, password, errp);
333a96ec
LC
1905}
1906
1907void qmp_change_blockdev(const char *device, const char *filename,
314f7ea7 1908 const char *format, Error **errp)
666daa68 1909{
6007cdd4 1910 BlockBackend *blk;
666daa68 1911 BlockDriverState *bs;
e3442099 1912 AioContext *aio_context;
666daa68
MA
1913 BlockDriver *drv = NULL;
1914 int bdrv_flags;
92d48558 1915 Error *err = NULL;
666daa68 1916
6007cdd4
MA
1917 blk = blk_by_name(device);
1918 if (!blk) {
75158ebb
MA
1919 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1920 "Device '%s' not found", device);
333a96ec 1921 return;
666daa68 1922 }
6007cdd4 1923 bs = blk_bs(blk);
333a96ec 1924
e3442099
SH
1925 aio_context = bdrv_get_aio_context(bs);
1926 aio_context_acquire(aio_context);
1927
333a96ec 1928 if (format) {
b64ec4e4 1929 drv = bdrv_find_whitelisted_format(format, bs->read_only);
666daa68 1930 if (!drv) {
c6bd8c70 1931 error_setg(errp, QERR_INVALID_BLOCK_FORMAT, format);
e3442099 1932 goto out;
666daa68
MA
1933 }
1934 }
333a96ec 1935
6007cdd4 1936 eject_device(blk, 0, &err);
84d18f06 1937 if (err) {
333a96ec 1938 error_propagate(errp, err);
e3442099 1939 goto out;
666daa68 1940 }
333a96ec 1941
528f7663 1942 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
199630b6 1943 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
333a96ec
LC
1944
1945 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
e3442099
SH
1946
1947out:
1948 aio_context_release(aio_context);
666daa68 1949}
9063f814 1950
727f005e 1951/* throttling disk I/O limits */
80047da5 1952void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
3e9fab69
BC
1953 int64_t bps_wr,
1954 int64_t iops,
1955 int64_t iops_rd,
1956 int64_t iops_wr,
1957 bool has_bps_max,
1958 int64_t bps_max,
1959 bool has_bps_rd_max,
1960 int64_t bps_rd_max,
1961 bool has_bps_wr_max,
1962 int64_t bps_wr_max,
1963 bool has_iops_max,
1964 int64_t iops_max,
1965 bool has_iops_rd_max,
1966 int64_t iops_rd_max,
1967 bool has_iops_wr_max,
2024c1df
BC
1968 int64_t iops_wr_max,
1969 bool has_iops_size,
76f4afb4
AG
1970 int64_t iops_size,
1971 bool has_group,
1972 const char *group, Error **errp)
727f005e 1973{
cc0681c4 1974 ThrottleConfig cfg;
727f005e 1975 BlockDriverState *bs;
a0e8544c 1976 BlockBackend *blk;
b15446fd 1977 AioContext *aio_context;
727f005e 1978
a0e8544c
FZ
1979 blk = blk_by_name(device);
1980 if (!blk) {
75158ebb
MA
1981 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1982 "Device '%s' not found", device);
80047da5 1983 return;
727f005e 1984 }
a0e8544c 1985 bs = blk_bs(blk);
727f005e 1986
cc0681c4
BC
1987 memset(&cfg, 0, sizeof(cfg));
1988 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1989 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
1990 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1991
1992 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1993 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
1994 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1995
3e9fab69
BC
1996 if (has_bps_max) {
1997 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1998 }
1999 if (has_bps_rd_max) {
2000 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
2001 }
2002 if (has_bps_wr_max) {
2003 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
2004 }
2005 if (has_iops_max) {
2006 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
2007 }
2008 if (has_iops_rd_max) {
2009 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
2010 }
2011 if (has_iops_wr_max) {
2012 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
2013 }
727f005e 2014
2024c1df
BC
2015 if (has_iops_size) {
2016 cfg.op_size = iops_size;
2017 }
cc0681c4
BC
2018
2019 if (!check_throttle_config(&cfg, errp)) {
80047da5 2020 return;
727f005e
ZYW
2021 }
2022
b15446fd
SH
2023 aio_context = bdrv_get_aio_context(bs);
2024 aio_context_acquire(aio_context);
2025
76f4afb4
AG
2026 if (throttle_enabled(&cfg)) {
2027 /* Enable I/O limits if they're not enabled yet, otherwise
2028 * just update the throttling group. */
2029 if (!bs->io_limits_enabled) {
2030 bdrv_io_limits_enable(bs, has_group ? group : device);
2031 } else if (has_group) {
2032 bdrv_io_limits_update_group(bs, group);
2033 }
2034 /* Set the new throttling configuration */
cc0681c4 2035 bdrv_set_io_limits(bs, &cfg);
76f4afb4
AG
2036 } else if (bs->io_limits_enabled) {
2037 /* If all throttling settings are set to 0, disable I/O limits */
2038 bdrv_io_limits_disable(bs);
727f005e 2039 }
b15446fd
SH
2040
2041 aio_context_release(aio_context);
727f005e
ZYW
2042}
2043
341ebc2f
JS
2044void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2045 bool has_granularity, uint32_t granularity,
2046 Error **errp)
2047{
2048 AioContext *aio_context;
2049 BlockDriverState *bs;
2050
2051 if (!name || name[0] == '\0') {
2052 error_setg(errp, "Bitmap name cannot be empty");
2053 return;
2054 }
2055
2056 bs = bdrv_lookup_bs(node, node, errp);
2057 if (!bs) {
2058 return;
2059 }
2060
2061 aio_context = bdrv_get_aio_context(bs);
2062 aio_context_acquire(aio_context);
2063
2064 if (has_granularity) {
2065 if (granularity < 512 || !is_power_of_2(granularity)) {
2066 error_setg(errp, "Granularity must be power of 2 "
2067 "and at least 512");
2068 goto out;
2069 }
2070 } else {
2071 /* Default to cluster size, if available: */
2072 granularity = bdrv_get_default_bitmap_granularity(bs);
2073 }
2074
2075 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2076
2077 out:
2078 aio_context_release(aio_context);
2079}
2080
2081void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2082 Error **errp)
2083{
2084 AioContext *aio_context;
2085 BlockDriverState *bs;
2086 BdrvDirtyBitmap *bitmap;
2087
2088 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2089 if (!bitmap || !bs) {
2090 return;
2091 }
2092
9bd2b08f
JS
2093 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2094 error_setg(errp,
2095 "Bitmap '%s' is currently frozen and cannot be removed",
2096 name);
2097 goto out;
2098 }
20dca810 2099 bdrv_dirty_bitmap_make_anon(bitmap);
341ebc2f
JS
2100 bdrv_release_dirty_bitmap(bs, bitmap);
2101
9bd2b08f 2102 out:
341ebc2f
JS
2103 aio_context_release(aio_context);
2104}
2105
e74e6b78
JS
2106/**
2107 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2108 * immediately after a full backup operation.
2109 */
2110void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2111 Error **errp)
2112{
2113 AioContext *aio_context;
2114 BdrvDirtyBitmap *bitmap;
2115 BlockDriverState *bs;
2116
2117 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2118 if (!bitmap || !bs) {
2119 return;
2120 }
2121
2122 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2123 error_setg(errp,
2124 "Bitmap '%s' is currently frozen and cannot be modified",
2125 name);
2126 goto out;
2127 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2128 error_setg(errp,
2129 "Bitmap '%s' is currently disabled and cannot be cleared",
2130 name);
2131 goto out;
2132 }
2133
2134 bdrv_clear_dirty_bitmap(bitmap);
2135
2136 out:
2137 aio_context_release(aio_context);
2138}
2139
072ebe6b 2140void hmp_drive_del(Monitor *mon, const QDict *qdict)
9063f814
RH
2141{
2142 const char *id = qdict_get_str(qdict, "id");
7e7d56d9 2143 BlockBackend *blk;
9063f814 2144 BlockDriverState *bs;
8ad4202b 2145 AioContext *aio_context;
3718d8ab 2146 Error *local_err = NULL;
9063f814 2147
7e7d56d9
MA
2148 blk = blk_by_name(id);
2149 if (!blk) {
b1422f20 2150 error_report("Device '%s' not found", id);
072ebe6b 2151 return;
9063f814 2152 }
7e7d56d9 2153 bs = blk_bs(blk);
8ad4202b 2154
26f8b3a8 2155 if (!blk_legacy_dinfo(blk)) {
48f364dd
MA
2156 error_report("Deleting device added with blockdev-add"
2157 " is not supported");
072ebe6b 2158 return;
48f364dd
MA
2159 }
2160
8ad4202b
SH
2161 aio_context = bdrv_get_aio_context(bs);
2162 aio_context_acquire(aio_context);
2163
3718d8ab 2164 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
565f65d2 2165 error_report_err(local_err);
8ad4202b 2166 aio_context_release(aio_context);
072ebe6b 2167 return;
8591675f 2168 }
9063f814 2169
9063f814
RH
2170 bdrv_close(bs);
2171
fa879d62 2172 /* if we have a device attached to this BlockDriverState
d22b2f41
RH
2173 * then we need to make the drive anonymous until the device
2174 * can be removed. If this is a drive with no device backing
2175 * then we can just get rid of the block driver state right here.
2176 */
a7f53e26 2177 if (blk_get_attached_dev(blk)) {
3e5a50d6 2178 blk_hide_on_behalf_of_hmp_drive_del(blk);
293c51a6
SH
2179 /* Further I/O must not pause the guest */
2180 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
2181 BLOCKDEV_ON_ERROR_REPORT);
d22b2f41 2182 } else {
b9fe8a7a 2183 blk_unref(blk);
9063f814
RH
2184 }
2185
8ad4202b 2186 aio_context_release(aio_context);
9063f814 2187}
6d4a2b3a 2188
3b1dbd11
BC
2189void qmp_block_resize(bool has_device, const char *device,
2190 bool has_node_name, const char *node_name,
2191 int64_t size, Error **errp)
6d4a2b3a 2192{
3b1dbd11 2193 Error *local_err = NULL;
6d4a2b3a 2194 BlockDriverState *bs;
927e0e76 2195 AioContext *aio_context;
8732901e 2196 int ret;
6d4a2b3a 2197
3b1dbd11
BC
2198 bs = bdrv_lookup_bs(has_device ? device : NULL,
2199 has_node_name ? node_name : NULL,
2200 &local_err);
84d18f06 2201 if (local_err) {
3b1dbd11
BC
2202 error_propagate(errp, local_err);
2203 return;
2204 }
2205
927e0e76
SH
2206 aio_context = bdrv_get_aio_context(bs);
2207 aio_context_acquire(aio_context);
2208
3b1dbd11 2209 if (!bdrv_is_first_non_filter(bs)) {
c6bd8c70 2210 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
927e0e76 2211 goto out;
6d4a2b3a
CH
2212 }
2213
2214 if (size < 0) {
c6bd8c70 2215 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
927e0e76 2216 goto out;
6d4a2b3a
CH
2217 }
2218
9c75e168 2219 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
c6bd8c70 2220 error_setg(errp, QERR_DEVICE_IN_USE, device);
927e0e76 2221 goto out;
9c75e168
JC
2222 }
2223
92b7a08d
PL
2224 /* complete all in-flight operations before resizing the device */
2225 bdrv_drain_all();
2226
8732901e
KW
2227 ret = bdrv_truncate(bs, size);
2228 switch (ret) {
939a1cc3
SH
2229 case 0:
2230 break;
2231 case -ENOMEDIUM:
c6bd8c70 2232 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
939a1cc3
SH
2233 break;
2234 case -ENOTSUP:
c6bd8c70 2235 error_setg(errp, QERR_UNSUPPORTED);
939a1cc3
SH
2236 break;
2237 case -EACCES:
81e5f78a 2238 error_setg(errp, "Device '%s' is read only", device);
939a1cc3
SH
2239 break;
2240 case -EBUSY:
c6bd8c70 2241 error_setg(errp, QERR_DEVICE_IN_USE, device);
939a1cc3
SH
2242 break;
2243 default:
8732901e 2244 error_setg_errno(errp, -ret, "Could not resize");
939a1cc3 2245 break;
6d4a2b3a 2246 }
927e0e76
SH
2247
2248out:
2249 aio_context_release(aio_context);
6d4a2b3a 2250}
12bd451f 2251
9abf2dba 2252static void block_job_cb(void *opaque, int ret)
12bd451f 2253{
723c5d93
SH
2254 /* Note that this function may be executed from another AioContext besides
2255 * the QEMU main loop. If you need to access anything that assumes the
2256 * QEMU global mutex, use a BH or introduce a mutex.
2257 */
2258
12bd451f 2259 BlockDriverState *bs = opaque;
bcada37b 2260 const char *msg = NULL;
12bd451f 2261
9abf2dba 2262 trace_block_job_cb(bs, bs->job, ret);
12bd451f
SH
2263
2264 assert(bs->job);
bcada37b 2265
12bd451f 2266 if (ret < 0) {
bcada37b 2267 msg = strerror(-ret);
12bd451f
SH
2268 }
2269
370521a1 2270 if (block_job_is_cancelled(bs->job)) {
bcada37b 2271 block_job_event_cancelled(bs->job);
370521a1 2272 } else {
bcada37b 2273 block_job_event_completed(bs->job, msg);
370521a1 2274 }
aa398a5c 2275
fa510ebf 2276 bdrv_put_ref_bh_schedule(bs);
12bd451f
SH
2277}
2278
13d8cc51
JC
2279void qmp_block_stream(const char *device,
2280 bool has_base, const char *base,
2281 bool has_backing_file, const char *backing_file,
2282 bool has_speed, int64_t speed,
1d809098
PB
2283 bool has_on_error, BlockdevOnError on_error,
2284 Error **errp)
12bd451f 2285{
a0e8544c 2286 BlockBackend *blk;
12bd451f 2287 BlockDriverState *bs;
c8c3080f 2288 BlockDriverState *base_bs = NULL;
f3e69beb 2289 AioContext *aio_context;
fd7f8c65 2290 Error *local_err = NULL;
13d8cc51 2291 const char *base_name = NULL;
12bd451f 2292
1d809098
PB
2293 if (!has_on_error) {
2294 on_error = BLOCKDEV_ON_ERROR_REPORT;
2295 }
2296
a0e8544c
FZ
2297 blk = blk_by_name(device);
2298 if (!blk) {
75158ebb
MA
2299 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2300 "Device '%s' not found", device);
12bd451f
SH
2301 return;
2302 }
a0e8544c 2303 bs = blk_bs(blk);
12bd451f 2304
f3e69beb
SH
2305 aio_context = bdrv_get_aio_context(bs);
2306 aio_context_acquire(aio_context);
2307
628ff683 2308 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
f3e69beb 2309 goto out;
628ff683
FZ
2310 }
2311
13d8cc51 2312 if (has_base) {
c8c3080f
MT
2313 base_bs = bdrv_find_backing_image(bs, base);
2314 if (base_bs == NULL) {
c6bd8c70 2315 error_setg(errp, QERR_BASE_NOT_FOUND, base);
f3e69beb 2316 goto out;
c8c3080f 2317 }
f3e69beb 2318 assert(bdrv_get_aio_context(base_bs) == aio_context);
13d8cc51 2319 base_name = base;
12bd451f
SH
2320 }
2321
13d8cc51
JC
2322 /* if we are streaming the entire chain, the result will have no backing
2323 * file, and specifying one is therefore an error */
2324 if (base_bs == NULL && has_backing_file) {
2325 error_setg(errp, "backing file specified, but streaming the "
2326 "entire chain");
f3e69beb 2327 goto out;
13d8cc51
JC
2328 }
2329
2330 /* backing_file string overrides base bs filename */
2331 base_name = has_backing_file ? backing_file : base_name;
2332
2333 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
1d809098 2334 on_error, block_job_cb, bs, &local_err);
84d18f06 2335 if (local_err) {
fd7f8c65 2336 error_propagate(errp, local_err);
f3e69beb 2337 goto out;
12bd451f
SH
2338 }
2339
2340 trace_qmp_block_stream(bs, bs->job);
f3e69beb
SH
2341
2342out:
2343 aio_context_release(aio_context);
12bd451f 2344}
2d47c6e9 2345
ed61fc10 2346void qmp_block_commit(const char *device,
7676e2c5
JC
2347 bool has_base, const char *base,
2348 bool has_top, const char *top,
54e26900 2349 bool has_backing_file, const char *backing_file,
ed61fc10
JC
2350 bool has_speed, int64_t speed,
2351 Error **errp)
2352{
a0e8544c 2353 BlockBackend *blk;
ed61fc10
JC
2354 BlockDriverState *bs;
2355 BlockDriverState *base_bs, *top_bs;
9e85cd5c 2356 AioContext *aio_context;
ed61fc10
JC
2357 Error *local_err = NULL;
2358 /* This will be part of the QMP command, if/when the
2359 * BlockdevOnError change for blkmirror makes it in
2360 */
92aa5c6d 2361 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
ed61fc10 2362
54504663
HR
2363 if (!has_speed) {
2364 speed = 0;
2365 }
2366
7676e2c5
JC
2367 /* Important Note:
2368 * libvirt relies on the DeviceNotFound error class in order to probe for
2369 * live commit feature versions; for this to work, we must make sure to
2370 * perform the device lookup before any generic errors that may occur in a
2371 * scenario in which all optional arguments are omitted. */
a0e8544c
FZ
2372 blk = blk_by_name(device);
2373 if (!blk) {
75158ebb
MA
2374 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2375 "Device '%s' not found", device);
ed61fc10 2376 return;
628ff683 2377 }
a0e8544c 2378 bs = blk_bs(blk);
628ff683 2379
9e85cd5c
SH
2380 aio_context = bdrv_get_aio_context(bs);
2381 aio_context_acquire(aio_context);
2382
2383 /* drain all i/o before commits */
2384 bdrv_drain_all();
2385
bb00021d 2386 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
9e85cd5c 2387 goto out;
ed61fc10 2388 }
ed61fc10
JC
2389
2390 /* default top_bs is the active layer */
2391 top_bs = bs;
2392
7676e2c5 2393 if (has_top && top) {
ed61fc10
JC
2394 if (strcmp(bs->filename, top) != 0) {
2395 top_bs = bdrv_find_backing_image(bs, top);
2396 }
2397 }
2398
2399 if (top_bs == NULL) {
2400 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
9e85cd5c 2401 goto out;
ed61fc10
JC
2402 }
2403
9e85cd5c
SH
2404 assert(bdrv_get_aio_context(top_bs) == aio_context);
2405
d5208c45
JC
2406 if (has_base && base) {
2407 base_bs = bdrv_find_backing_image(top_bs, base);
2408 } else {
2409 base_bs = bdrv_find_base(top_bs);
2410 }
2411
2412 if (base_bs == NULL) {
c6bd8c70 2413 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
9e85cd5c 2414 goto out;
d5208c45
JC
2415 }
2416
9e85cd5c
SH
2417 assert(bdrv_get_aio_context(base_bs) == aio_context);
2418
bb00021d
FZ
2419 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2420 goto out;
2421 }
2422
7676e2c5
JC
2423 /* Do not allow attempts to commit an image into itself */
2424 if (top_bs == base_bs) {
2425 error_setg(errp, "cannot commit an image into itself");
9e85cd5c 2426 goto out;
7676e2c5
JC
2427 }
2428
20a63d2c 2429 if (top_bs == bs) {
54e26900
JC
2430 if (has_backing_file) {
2431 error_setg(errp, "'backing-file' specified,"
2432 " but 'top' is the active layer");
9e85cd5c 2433 goto out;
54e26900 2434 }
20a63d2c
FZ
2435 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2436 bs, &local_err);
2437 } else {
2438 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
54e26900 2439 has_backing_file ? backing_file : NULL, &local_err);
20a63d2c 2440 }
ed61fc10
JC
2441 if (local_err != NULL) {
2442 error_propagate(errp, local_err);
9e85cd5c 2443 goto out;
ed61fc10 2444 }
9e85cd5c
SH
2445
2446out:
2447 aio_context_release(aio_context);
ed61fc10
JC
2448}
2449
99a9addf
SH
2450void qmp_drive_backup(const char *device, const char *target,
2451 bool has_format, const char *format,
b53169ea 2452 enum MirrorSyncMode sync,
99a9addf
SH
2453 bool has_mode, enum NewImageMode mode,
2454 bool has_speed, int64_t speed,
d58d8453 2455 bool has_bitmap, const char *bitmap,
99a9addf
SH
2456 bool has_on_source_error, BlockdevOnError on_source_error,
2457 bool has_on_target_error, BlockdevOnError on_target_error,
2458 Error **errp)
2459{
a0e8544c 2460 BlockBackend *blk;
99a9addf
SH
2461 BlockDriverState *bs;
2462 BlockDriverState *target_bs;
fc5d3f84 2463 BlockDriverState *source = NULL;
d58d8453 2464 BdrvDirtyBitmap *bmap = NULL;
761731b1 2465 AioContext *aio_context;
99a9addf
SH
2466 BlockDriver *drv = NULL;
2467 Error *local_err = NULL;
2468 int flags;
2469 int64_t size;
2470 int ret;
2471
2472 if (!has_speed) {
2473 speed = 0;
2474 }
2475 if (!has_on_source_error) {
2476 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2477 }
2478 if (!has_on_target_error) {
2479 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2480 }
2481 if (!has_mode) {
2482 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2483 }
2484
a0e8544c
FZ
2485 blk = blk_by_name(device);
2486 if (!blk) {
75158ebb
MA
2487 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2488 "Device '%s' not found", device);
99a9addf
SH
2489 return;
2490 }
a0e8544c 2491 bs = blk_bs(blk);
99a9addf 2492
761731b1
SH
2493 aio_context = bdrv_get_aio_context(bs);
2494 aio_context_acquire(aio_context);
2495
c29c1dd3
FZ
2496 /* Although backup_run has this check too, we need to use bs->drv below, so
2497 * do an early check redundantly. */
99a9addf 2498 if (!bdrv_is_inserted(bs)) {
c6bd8c70 2499 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
761731b1 2500 goto out;
99a9addf
SH
2501 }
2502
2503 if (!has_format) {
2504 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2505 }
2506 if (format) {
2507 drv = bdrv_find_format(format);
2508 if (!drv) {
c6bd8c70 2509 error_setg(errp, QERR_INVALID_BLOCK_FORMAT, format);
761731b1 2510 goto out;
99a9addf
SH
2511 }
2512 }
2513
c29c1dd3 2514 /* Early check to avoid creating target */
3718d8ab 2515 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
761731b1 2516 goto out;
99a9addf
SH
2517 }
2518
2519 flags = bs->open_flags | BDRV_O_RDWR;
2520
fc5d3f84
IM
2521 /* See if we have a backing HD we can use to create our new image
2522 * on top of. */
2523 if (sync == MIRROR_SYNC_MODE_TOP) {
2524 source = bs->backing_hd;
2525 if (!source) {
2526 sync = MIRROR_SYNC_MODE_FULL;
2527 }
2528 }
2529 if (sync == MIRROR_SYNC_MODE_NONE) {
2530 source = bs;
2531 }
2532
99a9addf
SH
2533 size = bdrv_getlength(bs);
2534 if (size < 0) {
2535 error_setg_errno(errp, -size, "bdrv_getlength failed");
761731b1 2536 goto out;
99a9addf
SH
2537 }
2538
2539 if (mode != NEW_IMAGE_MODE_EXISTING) {
2540 assert(format && drv);
fc5d3f84
IM
2541 if (source) {
2542 bdrv_img_create(target, format, source->filename,
2543 source->drv->format_name, NULL,
2544 size, flags, &local_err, false);
2545 } else {
2546 bdrv_img_create(target, format, NULL, NULL, NULL,
2547 size, flags, &local_err, false);
2548 }
99a9addf
SH
2549 }
2550
84d18f06 2551 if (local_err) {
99a9addf 2552 error_propagate(errp, local_err);
761731b1 2553 goto out;
99a9addf
SH
2554 }
2555
f67503e5 2556 target_bs = NULL;
ddf5636d 2557 ret = bdrv_open(&target_bs, target, NULL, NULL, flags, drv, &local_err);
99a9addf 2558 if (ret < 0) {
34b5d2c6 2559 error_propagate(errp, local_err);
761731b1 2560 goto out;
99a9addf
SH
2561 }
2562
761731b1
SH
2563 bdrv_set_aio_context(target_bs, aio_context);
2564
d58d8453
JS
2565 if (has_bitmap) {
2566 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
2567 if (!bmap) {
2568 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
2569 goto out;
2570 }
2571 }
2572
2573 backup_start(bs, target_bs, speed, sync, bmap,
2574 on_source_error, on_target_error,
99a9addf
SH
2575 block_job_cb, bs, &local_err);
2576 if (local_err != NULL) {
4f6fd349 2577 bdrv_unref(target_bs);
99a9addf 2578 error_propagate(errp, local_err);
761731b1 2579 goto out;
99a9addf 2580 }
761731b1
SH
2581
2582out:
2583 aio_context_release(aio_context);
99a9addf
SH
2584}
2585
c13163fb
BC
2586BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2587{
d5a8ee60 2588 return bdrv_named_nodes_list(errp);
c13163fb
BC
2589}
2590
c29c1dd3
FZ
2591void qmp_blockdev_backup(const char *device, const char *target,
2592 enum MirrorSyncMode sync,
2593 bool has_speed, int64_t speed,
2594 bool has_on_source_error,
2595 BlockdevOnError on_source_error,
2596 bool has_on_target_error,
2597 BlockdevOnError on_target_error,
2598 Error **errp)
2599{
a0e8544c 2600 BlockBackend *blk;
c29c1dd3
FZ
2601 BlockDriverState *bs;
2602 BlockDriverState *target_bs;
2603 Error *local_err = NULL;
2604 AioContext *aio_context;
2605
2606 if (!has_speed) {
2607 speed = 0;
2608 }
2609 if (!has_on_source_error) {
2610 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2611 }
2612 if (!has_on_target_error) {
2613 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2614 }
2615
a0e8544c
FZ
2616 blk = blk_by_name(device);
2617 if (!blk) {
5b347c54 2618 error_setg(errp, "Device '%s' not found", device);
c29c1dd3
FZ
2619 return;
2620 }
a0e8544c 2621 bs = blk_bs(blk);
c29c1dd3
FZ
2622
2623 aio_context = bdrv_get_aio_context(bs);
2624 aio_context_acquire(aio_context);
2625
a0e8544c
FZ
2626 blk = blk_by_name(target);
2627 if (!blk) {
5b347c54 2628 error_setg(errp, "Device '%s' not found", target);
c29c1dd3
FZ
2629 goto out;
2630 }
a0e8544c 2631 target_bs = blk_bs(blk);
c29c1dd3
FZ
2632
2633 bdrv_ref(target_bs);
2634 bdrv_set_aio_context(target_bs, aio_context);
d58d8453
JS
2635 backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
2636 on_target_error, block_job_cb, bs, &local_err);
c29c1dd3
FZ
2637 if (local_err != NULL) {
2638 bdrv_unref(target_bs);
2639 error_propagate(errp, local_err);
2640 }
2641out:
2642 aio_context_release(aio_context);
2643}
2644
08e4ed6c
PB
2645#define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
2646
d9b902db
PB
2647void qmp_drive_mirror(const char *device, const char *target,
2648 bool has_format, const char *format,
4c828dc6 2649 bool has_node_name, const char *node_name,
09158f00 2650 bool has_replaces, const char *replaces,
d9b902db
PB
2651 enum MirrorSyncMode sync,
2652 bool has_mode, enum NewImageMode mode,
b952b558 2653 bool has_speed, int64_t speed,
eee13dfe 2654 bool has_granularity, uint32_t granularity,
08e4ed6c 2655 bool has_buf_size, int64_t buf_size,
b952b558
PB
2656 bool has_on_source_error, BlockdevOnError on_source_error,
2657 bool has_on_target_error, BlockdevOnError on_target_error,
2658 Error **errp)
d9b902db 2659{
a0e8544c 2660 BlockBackend *blk;
d9b902db
PB
2661 BlockDriverState *bs;
2662 BlockDriverState *source, *target_bs;
5a7e7a0b 2663 AioContext *aio_context;
d9b902db
PB
2664 BlockDriver *drv = NULL;
2665 Error *local_err = NULL;
4c828dc6 2666 QDict *options = NULL;
d9b902db 2667 int flags;
ac3c5d83 2668 int64_t size;
d9b902db
PB
2669 int ret;
2670
2671 if (!has_speed) {
2672 speed = 0;
2673 }
b952b558
PB
2674 if (!has_on_source_error) {
2675 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2676 }
2677 if (!has_on_target_error) {
2678 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2679 }
d9b902db
PB
2680 if (!has_mode) {
2681 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2682 }
eee13dfe
PB
2683 if (!has_granularity) {
2684 granularity = 0;
2685 }
08e4ed6c
PB
2686 if (!has_buf_size) {
2687 buf_size = DEFAULT_MIRROR_BUF_SIZE;
2688 }
2689
eee13dfe 2690 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
c6bd8c70
MA
2691 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2692 "a value in range [512B, 64MB]");
eee13dfe
PB
2693 return;
2694 }
2695 if (granularity & (granularity - 1)) {
c6bd8c70
MA
2696 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2697 "power of 2");
eee13dfe
PB
2698 return;
2699 }
d9b902db 2700
a0e8544c
FZ
2701 blk = blk_by_name(device);
2702 if (!blk) {
75158ebb
MA
2703 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2704 "Device '%s' not found", device);
d9b902db
PB
2705 return;
2706 }
a0e8544c 2707 bs = blk_bs(blk);
d9b902db 2708
5a7e7a0b
SH
2709 aio_context = bdrv_get_aio_context(bs);
2710 aio_context_acquire(aio_context);
2711
d9b902db 2712 if (!bdrv_is_inserted(bs)) {
c6bd8c70 2713 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
5a7e7a0b 2714 goto out;
d9b902db
PB
2715 }
2716
2717 if (!has_format) {
2718 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2719 }
2720 if (format) {
2721 drv = bdrv_find_format(format);
2722 if (!drv) {
c6bd8c70 2723 error_setg(errp, QERR_INVALID_BLOCK_FORMAT, format);
5a7e7a0b 2724 goto out;
d9b902db
PB
2725 }
2726 }
2727
3718d8ab 2728 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
5a7e7a0b 2729 goto out;
d9b902db
PB
2730 }
2731
2732 flags = bs->open_flags | BDRV_O_RDWR;
2733 source = bs->backing_hd;
2734 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
2735 sync = MIRROR_SYNC_MODE_FULL;
2736 }
117e0c82
HR
2737 if (sync == MIRROR_SYNC_MODE_NONE) {
2738 source = bs;
2739 }
d9b902db 2740
ac3c5d83
SH
2741 size = bdrv_getlength(bs);
2742 if (size < 0) {
2743 error_setg_errno(errp, -size, "bdrv_getlength failed");
5a7e7a0b 2744 goto out;
ac3c5d83
SH
2745 }
2746
09158f00
BC
2747 if (has_replaces) {
2748 BlockDriverState *to_replace_bs;
5a7e7a0b
SH
2749 AioContext *replace_aio_context;
2750 int64_t replace_size;
09158f00
BC
2751
2752 if (!has_node_name) {
2753 error_setg(errp, "a node-name must be provided when replacing a"
2754 " named node of the graph");
5a7e7a0b 2755 goto out;
09158f00
BC
2756 }
2757
2758 to_replace_bs = check_to_replace_node(replaces, &local_err);
2759
2760 if (!to_replace_bs) {
2761 error_propagate(errp, local_err);
5a7e7a0b 2762 goto out;
09158f00
BC
2763 }
2764
5a7e7a0b
SH
2765 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
2766 aio_context_acquire(replace_aio_context);
2767 replace_size = bdrv_getlength(to_replace_bs);
2768 aio_context_release(replace_aio_context);
2769
2770 if (size != replace_size) {
09158f00
BC
2771 error_setg(errp, "cannot replace image with a mirror image of "
2772 "different size");
5a7e7a0b 2773 goto out;
09158f00
BC
2774 }
2775 }
2776
14526864
HR
2777 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
2778 && mode != NEW_IMAGE_MODE_EXISTING)
2779 {
d9b902db
PB
2780 /* create new image w/o backing file */
2781 assert(format && drv);
cf8f2426 2782 bdrv_img_create(target, format,
f382d43a 2783 NULL, NULL, NULL, size, flags, &local_err, false);
d9b902db
PB
2784 } else {
2785 switch (mode) {
2786 case NEW_IMAGE_MODE_EXISTING:
d9b902db
PB
2787 break;
2788 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
2789 /* create new image with backing file */
cf8f2426
LC
2790 bdrv_img_create(target, format,
2791 source->filename,
2792 source->drv->format_name,
f382d43a 2793 NULL, size, flags, &local_err, false);
d9b902db
PB
2794 break;
2795 default:
2796 abort();
2797 }
2798 }
2799
84d18f06 2800 if (local_err) {
cf8f2426 2801 error_propagate(errp, local_err);
5a7e7a0b 2802 goto out;
d9b902db
PB
2803 }
2804
4c828dc6
BC
2805 if (has_node_name) {
2806 options = qdict_new();
2807 qdict_put(options, "node-name", qstring_from_str(node_name));
2808 }
2809
b812f671
PB
2810 /* Mirroring takes care of copy-on-write using the source's backing
2811 * file.
2812 */
f67503e5 2813 target_bs = NULL;
4c828dc6
BC
2814 ret = bdrv_open(&target_bs, target, NULL, options,
2815 flags | BDRV_O_NO_BACKING, drv, &local_err);
d9b902db 2816 if (ret < 0) {
34b5d2c6 2817 error_propagate(errp, local_err);
5a7e7a0b 2818 goto out;
d9b902db
PB
2819 }
2820
5a7e7a0b
SH
2821 bdrv_set_aio_context(target_bs, aio_context);
2822
09158f00
BC
2823 /* pass the node name to replace to mirror start since it's loose coupling
2824 * and will allow to check whether the node still exist at mirror completion
2825 */
2826 mirror_start(bs, target_bs,
2827 has_replaces ? replaces : NULL,
2828 speed, granularity, buf_size, sync,
eee13dfe 2829 on_source_error, on_target_error,
b952b558 2830 block_job_cb, bs, &local_err);
d9b902db 2831 if (local_err != NULL) {
4f6fd349 2832 bdrv_unref(target_bs);
d9b902db 2833 error_propagate(errp, local_err);
5a7e7a0b 2834 goto out;
d9b902db 2835 }
5a7e7a0b
SH
2836
2837out:
2838 aio_context_release(aio_context);
d9b902db
PB
2839}
2840
3d948cdf 2841/* Get the block job for a given device name and acquire its AioContext */
24d6bffe
MA
2842static BlockJob *find_block_job(const char *device, AioContext **aio_context,
2843 Error **errp)
2d47c6e9 2844{
a0e8544c 2845 BlockBackend *blk;
2d47c6e9
SH
2846 BlockDriverState *bs;
2847
a0e8544c
FZ
2848 blk = blk_by_name(device);
2849 if (!blk) {
3d948cdf
SH
2850 goto notfound;
2851 }
a0e8544c 2852 bs = blk_bs(blk);
3d948cdf
SH
2853
2854 *aio_context = bdrv_get_aio_context(bs);
2855 aio_context_acquire(*aio_context);
2856
2857 if (!bs->job) {
2858 aio_context_release(*aio_context);
2859 goto notfound;
2d47c6e9 2860 }
3d948cdf 2861
2d47c6e9 2862 return bs->job;
3d948cdf
SH
2863
2864notfound:
2e3a0266
MA
2865 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
2866 "No active block job on device '%s'", device);
3d948cdf
SH
2867 *aio_context = NULL;
2868 return NULL;
2d47c6e9
SH
2869}
2870
882ec7ce 2871void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
2d47c6e9 2872{
3d948cdf 2873 AioContext *aio_context;
24d6bffe 2874 BlockJob *job = find_block_job(device, &aio_context, errp);
2d47c6e9
SH
2875
2876 if (!job) {
2d47c6e9
SH
2877 return;
2878 }
2879
882ec7ce 2880 block_job_set_speed(job, speed, errp);
3d948cdf 2881 aio_context_release(aio_context);
2d47c6e9 2882}
370521a1 2883
6e37fb81
PB
2884void qmp_block_job_cancel(const char *device,
2885 bool has_force, bool force, Error **errp)
370521a1 2886{
3d948cdf 2887 AioContext *aio_context;
24d6bffe 2888 BlockJob *job = find_block_job(device, &aio_context, errp);
6e37fb81 2889
370521a1 2890 if (!job) {
370521a1
SH
2891 return;
2892 }
3d948cdf
SH
2893
2894 if (!has_force) {
2895 force = false;
2896 }
2897
751ebd76 2898 if (job->user_paused && !force) {
f231b88d
CR
2899 error_setg(errp, "The block job for device '%s' is currently paused",
2900 device);
3d948cdf 2901 goto out;
8acc72a4 2902 }
370521a1
SH
2903
2904 trace_qmp_block_job_cancel(job);
2905 block_job_cancel(job);
3d948cdf
SH
2906out:
2907 aio_context_release(aio_context);
370521a1 2908}
fb5458cd 2909
6e37fb81
PB
2910void qmp_block_job_pause(const char *device, Error **errp)
2911{
3d948cdf 2912 AioContext *aio_context;
24d6bffe 2913 BlockJob *job = find_block_job(device, &aio_context, errp);
6e37fb81 2914
751ebd76 2915 if (!job || job->user_paused) {
6e37fb81
PB
2916 return;
2917 }
2918
751ebd76 2919 job->user_paused = true;
6e37fb81
PB
2920 trace_qmp_block_job_pause(job);
2921 block_job_pause(job);
3d948cdf 2922 aio_context_release(aio_context);
6e37fb81
PB
2923}
2924
2925void qmp_block_job_resume(const char *device, Error **errp)
2926{
3d948cdf 2927 AioContext *aio_context;
24d6bffe 2928 BlockJob *job = find_block_job(device, &aio_context, errp);
6e37fb81 2929
751ebd76 2930 if (!job || !job->user_paused) {
6e37fb81
PB
2931 return;
2932 }
2933
751ebd76 2934 job->user_paused = false;
6e37fb81
PB
2935 trace_qmp_block_job_resume(job);
2936 block_job_resume(job);
3d948cdf 2937 aio_context_release(aio_context);
6e37fb81
PB
2938}
2939
aeae883b
PB
2940void qmp_block_job_complete(const char *device, Error **errp)
2941{
3d948cdf 2942 AioContext *aio_context;
24d6bffe 2943 BlockJob *job = find_block_job(device, &aio_context, errp);
aeae883b
PB
2944
2945 if (!job) {
aeae883b
PB
2946 return;
2947 }
2948
2949 trace_qmp_block_job_complete(job);
2950 block_job_complete(job, errp);
3d948cdf 2951 aio_context_release(aio_context);
aeae883b
PB
2952}
2953
fa40e656
JC
2954void qmp_change_backing_file(const char *device,
2955 const char *image_node_name,
2956 const char *backing_file,
2957 Error **errp)
2958{
a0e8544c 2959 BlockBackend *blk;
fa40e656 2960 BlockDriverState *bs = NULL;
729962f6 2961 AioContext *aio_context;
fa40e656
JC
2962 BlockDriverState *image_bs = NULL;
2963 Error *local_err = NULL;
2964 bool ro;
2965 int open_flags;
2966 int ret;
2967
a0e8544c
FZ
2968 blk = blk_by_name(device);
2969 if (!blk) {
75158ebb
MA
2970 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2971 "Device '%s' not found", device);
fa40e656
JC
2972 return;
2973 }
a0e8544c 2974 bs = blk_bs(blk);
fa40e656 2975
729962f6
SH
2976 aio_context = bdrv_get_aio_context(bs);
2977 aio_context_acquire(aio_context);
2978
fa40e656
JC
2979 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
2980 if (local_err) {
2981 error_propagate(errp, local_err);
729962f6 2982 goto out;
fa40e656
JC
2983 }
2984
2985 if (!image_bs) {
2986 error_setg(errp, "image file not found");
729962f6 2987 goto out;
fa40e656
JC
2988 }
2989
2990 if (bdrv_find_base(image_bs) == image_bs) {
2991 error_setg(errp, "not allowing backing file change on an image "
2992 "without a backing file");
729962f6 2993 goto out;
fa40e656
JC
2994 }
2995
2996 /* even though we are not necessarily operating on bs, we need it to
2997 * determine if block ops are currently prohibited on the chain */
2998 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
729962f6 2999 goto out;
fa40e656
JC
3000 }
3001
3002 /* final sanity check */
3003 if (!bdrv_chain_contains(bs, image_bs)) {
3004 error_setg(errp, "'%s' and image file are not in the same chain",
3005 device);
729962f6 3006 goto out;
fa40e656
JC
3007 }
3008
3009 /* if not r/w, reopen to make r/w */
3010 open_flags = image_bs->open_flags;
3011 ro = bdrv_is_read_only(image_bs);
3012
3013 if (ro) {
3014 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3015 if (local_err) {
3016 error_propagate(errp, local_err);
729962f6 3017 goto out;
fa40e656
JC
3018 }
3019 }
3020
3021 ret = bdrv_change_backing_file(image_bs, backing_file,
3022 image_bs->drv ? image_bs->drv->format_name : "");
3023
3024 if (ret < 0) {
3025 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3026 backing_file);
3027 /* don't exit here, so we can try to restore open flags if
3028 * appropriate */
3029 }
3030
3031 if (ro) {
3032 bdrv_reopen(image_bs, open_flags, &local_err);
3033 if (local_err) {
3034 error_propagate(errp, local_err); /* will preserve prior errp */
3035 }
3036 }
729962f6
SH
3037
3038out:
3039 aio_context_release(aio_context);
fa40e656
JC
3040}
3041
d26c9a15
KW
3042void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3043{
3044 QmpOutputVisitor *ov = qmp_output_visitor_new();
18e46a03 3045 BlockBackend *blk;
d26c9a15
KW
3046 QObject *obj;
3047 QDict *qdict;
d26c9a15
KW
3048 Error *local_err = NULL;
3049
3050 /* Require an ID in the top level */
3051 if (!options->has_id) {
3052 error_setg(errp, "Block device needs an ID");
3053 goto fail;
3054 }
3055
60e19e06 3056 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
d26c9a15 3057 * cache.direct=false instead of silently switching to aio=threads, except
60e19e06 3058 * when called from drive_new().
d26c9a15
KW
3059 *
3060 * For now, simply forbidding the combination for all drivers will do. */
3061 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
c6e0bd9b
KW
3062 bool direct = options->has_cache &&
3063 options->cache->has_direct &&
3064 options->cache->direct;
3065 if (!direct) {
d26c9a15
KW
3066 error_setg(errp, "aio=native requires cache.direct=true");
3067 goto fail;
3068 }
3069 }
3070
3071 visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
3072 &options, NULL, &local_err);
84d18f06 3073 if (local_err) {
d26c9a15
KW
3074 error_propagate(errp, local_err);
3075 goto fail;
3076 }
3077
3078 obj = qmp_output_get_qobject(ov);
3079 qdict = qobject_to_qdict(obj);
3080
3081 qdict_flatten(qdict);
3082
18e46a03 3083 blk = blockdev_init(NULL, qdict, &local_err);
84d18f06 3084 if (local_err) {
b681072d 3085 error_propagate(errp, local_err);
d26c9a15
KW
3086 goto fail;
3087 }
3088
18e46a03 3089 if (bdrv_key_required(blk_bs(blk))) {
18e46a03 3090 blk_unref(blk);
8ae8e904
KW
3091 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3092 goto fail;
3093 }
3094
d26c9a15
KW
3095fail:
3096 qmp_output_visitor_cleanup(ov);
3097}
3098
fea68bb6 3099BlockJobInfoList *qmp_query_block_jobs(Error **errp)
fb5458cd 3100{
fea68bb6
MA
3101 BlockJobInfoList *head = NULL, **p_next = &head;
3102 BlockDriverState *bs;
fb5458cd 3103
fea68bb6 3104 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
69691e72
SH
3105 AioContext *aio_context = bdrv_get_aio_context(bs);
3106
3107 aio_context_acquire(aio_context);
3108
fea68bb6
MA
3109 if (bs->job) {
3110 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
3111 elem->value = block_job_query(bs->job);
3112 *p_next = elem;
3113 p_next = &elem->next;
3114 }
69691e72
SH
3115
3116 aio_context_release(aio_context);
fb5458cd 3117 }
fb5458cd 3118
fea68bb6 3119 return head;
fb5458cd 3120}
4d454574 3121
0006383e 3122QemuOptsList qemu_common_drive_opts = {
4d454574 3123 .name = "drive",
0006383e 3124 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4d454574
PB
3125 .desc = {
3126 {
4d454574
PB
3127 .name = "snapshot",
3128 .type = QEMU_OPT_BOOL,
3129 .help = "enable/disable snapshot mode",
a9384aff
PB
3130 },{
3131 .name = "discard",
3132 .type = QEMU_OPT_STRING,
3133 .help = "discard operation (ignore/off, unmap/on)",
4d454574 3134 },{
54861b92 3135 .name = BDRV_OPT_CACHE_WB,
29c4e2b5
KW
3136 .type = QEMU_OPT_BOOL,
3137 .help = "enables writeback mode for any caches",
3138 },{
54861b92 3139 .name = BDRV_OPT_CACHE_DIRECT,
29c4e2b5
KW
3140 .type = QEMU_OPT_BOOL,
3141 .help = "enables use of O_DIRECT (bypass the host page cache)",
3142 },{
54861b92 3143 .name = BDRV_OPT_CACHE_NO_FLUSH,
29c4e2b5
KW
3144 .type = QEMU_OPT_BOOL,
3145 .help = "ignore any flush requests for the device",
4d454574
PB
3146 },{
3147 .name = "aio",
3148 .type = QEMU_OPT_STRING,
3149 .help = "host AIO implementation (threads, native)",
3150 },{
3151 .name = "format",
3152 .type = QEMU_OPT_STRING,
3153 .help = "disk format (raw, qcow2, ...)",
4d454574
PB
3154 },{
3155 .name = "rerror",
3156 .type = QEMU_OPT_STRING,
3157 .help = "read error action",
3158 },{
3159 .name = "werror",
3160 .type = QEMU_OPT_STRING,
3161 .help = "write error action",
4d454574 3162 },{
0f227a94 3163 .name = "read-only",
4d454574
PB
3164 .type = QEMU_OPT_BOOL,
3165 .help = "open drive file as read-only",
3166 },{
57975222 3167 .name = "throttling.iops-total",
4d454574
PB
3168 .type = QEMU_OPT_NUMBER,
3169 .help = "limit total I/O operations per second",
3170 },{
57975222 3171 .name = "throttling.iops-read",
4d454574
PB
3172 .type = QEMU_OPT_NUMBER,
3173 .help = "limit read operations per second",
3174 },{
57975222 3175 .name = "throttling.iops-write",
4d454574
PB
3176 .type = QEMU_OPT_NUMBER,
3177 .help = "limit write operations per second",
3178 },{
57975222 3179 .name = "throttling.bps-total",
4d454574
PB
3180 .type = QEMU_OPT_NUMBER,
3181 .help = "limit total bytes per second",
3182 },{
57975222 3183 .name = "throttling.bps-read",
4d454574
PB
3184 .type = QEMU_OPT_NUMBER,
3185 .help = "limit read bytes per second",
3186 },{
57975222 3187 .name = "throttling.bps-write",
4d454574
PB
3188 .type = QEMU_OPT_NUMBER,
3189 .help = "limit write bytes per second",
3e9fab69
BC
3190 },{
3191 .name = "throttling.iops-total-max",
3192 .type = QEMU_OPT_NUMBER,
3193 .help = "I/O operations burst",
3194 },{
3195 .name = "throttling.iops-read-max",
3196 .type = QEMU_OPT_NUMBER,
3197 .help = "I/O operations read burst",
3198 },{
3199 .name = "throttling.iops-write-max",
3200 .type = QEMU_OPT_NUMBER,
3201 .help = "I/O operations write burst",
3202 },{
3203 .name = "throttling.bps-total-max",
3204 .type = QEMU_OPT_NUMBER,
3205 .help = "total bytes burst",
3206 },{
3207 .name = "throttling.bps-read-max",
3208 .type = QEMU_OPT_NUMBER,
3209 .help = "total bytes read burst",
3210 },{
3211 .name = "throttling.bps-write-max",
3212 .type = QEMU_OPT_NUMBER,
3213 .help = "total bytes write burst",
2024c1df
BC
3214 },{
3215 .name = "throttling.iops-size",
3216 .type = QEMU_OPT_NUMBER,
3217 .help = "when limiting by iops max size of an I/O in bytes",
76f4afb4
AG
3218 },{
3219 .name = "throttling.group",
3220 .type = QEMU_OPT_STRING,
3221 .help = "name of the block throttling group",
4d454574
PB
3222 },{
3223 .name = "copy-on-read",
3224 .type = QEMU_OPT_BOOL,
3225 .help = "copy read data from backing file into image file",
465bee1d
PL
3226 },{
3227 .name = "detect-zeroes",
3228 .type = QEMU_OPT_STRING,
3229 .help = "try to optimize zero writes (off, on, unmap)",
4d454574
PB
3230 },
3231 { /* end of list */ }
3232 },
3233};
0006383e
KW
3234
3235QemuOptsList qemu_drive_opts = {
3236 .name = "drive",
3237 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3238 .desc = {
492fdc6f
KW
3239 /*
3240 * no elements => accept any params
3241 * validation will happen later
3242 */
0006383e
KW
3243 { /* end of list */ }
3244 },
3245};