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