block: Add "drained begin/end" for transactional external snapshot
[qemu.git] / blockdev.c
blobe4a5eb43b8394afc312d096cc5561e0f0a9df938
1 /*
2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
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.
9 * This file incorporates work covered by the following copyright and
10 * permission notice:
12 * Copyright (c) 2003-2008 Fabrice Bellard
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:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
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.
33 #include "sysemu/block-backend.h"
34 #include "sysemu/blockdev.h"
35 #include "hw/block/block.h"
36 #include "block/blockjob.h"
37 #include "block/throttle-groups.h"
38 #include "monitor/monitor.h"
39 #include "qemu/error-report.h"
40 #include "qemu/option.h"
41 #include "qemu/config-file.h"
42 #include "qapi/qmp/types.h"
43 #include "qapi-visit.h"
44 #include "qapi/qmp/qerror.h"
45 #include "qapi/qmp-output-visitor.h"
46 #include "qapi/util.h"
47 #include "sysemu/sysemu.h"
48 #include "block/block_int.h"
49 #include "qmp-commands.h"
50 #include "trace.h"
51 #include "sysemu/arch_init.h"
53 static 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",
65 static int if_max_devs[IF_COUNT] = {
67 * Do not change these numbers! They govern how drive option
68 * index maps to unit and bus. That mapping is ABI.
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.
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.
80 [IF_IDE] = 2,
81 [IF_SCSI] = 7,
84 /**
85 * Boards may call this to offer board-by-board overrides
86 * of the default, global values.
88 void override_max_devs(BlockInterfaceType type, int max_devs)
90 BlockBackend *blk;
91 DriveInfo *dinfo;
93 if (max_devs <= 0) {
94 return;
97 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
98 dinfo = blk_legacy_dinfo(blk);
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();
107 if_max_devs[type] = max_devs;
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.
117 void blockdev_mark_auto_del(BlockBackend *blk)
119 DriveInfo *dinfo = blk_legacy_dinfo(blk);
120 BlockDriverState *bs = blk_bs(blk);
121 AioContext *aio_context;
123 if (!dinfo) {
124 return;
127 if (bs) {
128 aio_context = bdrv_get_aio_context(bs);
129 aio_context_acquire(aio_context);
131 if (bs->job) {
132 block_job_cancel(bs->job);
135 aio_context_release(aio_context);
138 dinfo->auto_del = 1;
141 void blockdev_auto_del(BlockBackend *blk)
143 DriveInfo *dinfo = blk_legacy_dinfo(blk);
145 if (dinfo && dinfo->auto_del) {
146 blk_unref(blk);
151 * Returns the current mapping of how many units per bus
152 * a particular interface can support.
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.
158 int drive_get_max_devs(BlockInterfaceType type)
160 if (type >= IF_IDE && type < IF_COUNT) {
161 return if_max_devs[type];
164 return -1;
167 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
169 int max_devs = if_max_devs[type];
170 return max_devs ? index / max_devs : 0;
173 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
175 int max_devs = if_max_devs[type];
176 return max_devs ? index % max_devs : index;
179 QemuOpts *drive_def(const char *optstr)
181 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
184 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
185 const char *optstr)
187 QemuOpts *opts;
189 opts = drive_def(optstr);
190 if (!opts) {
191 return NULL;
193 if (type != IF_DEFAULT) {
194 qemu_opt_set(opts, "if", if_name[type], &error_abort);
196 if (index >= 0) {
197 qemu_opt_set_number(opts, "index", index, &error_abort);
199 if (file)
200 qemu_opt_set(opts, "file", file, &error_abort);
201 return opts;
204 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
206 BlockBackend *blk;
207 DriveInfo *dinfo;
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) {
213 return dinfo;
217 return NULL;
220 bool drive_check_orphaned(void)
222 BlockBackend *blk;
223 DriveInfo *dinfo;
224 bool rs = false;
226 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
227 dinfo = blk_legacy_dinfo(blk);
228 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
229 /* Unless this is a default drive, this may be an oversight. */
230 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
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",
234 blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
235 if_name[dinfo->type], dinfo->bus, dinfo->unit);
236 rs = true;
240 return rs;
243 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
245 return drive_get(type,
246 drive_index_to_bus_id(type, index),
247 drive_index_to_unit_id(type, index));
250 int drive_get_max_bus(BlockInterfaceType type)
252 int max_bus;
253 BlockBackend *blk;
254 DriveInfo *dinfo;
256 max_bus = -1;
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) {
260 max_bus = dinfo->bus;
263 return max_bus;
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. */
269 DriveInfo *drive_get_next(BlockInterfaceType type)
271 static int next_block_unit[IF_COUNT];
273 return drive_get(type, 0, next_block_unit[type]++);
276 static void bdrv_format_print(void *opaque, const char *name)
278 error_printf(" %s", name);
281 typedef struct {
282 QEMUBH *bh;
283 BlockDriverState *bs;
284 } BDRVPutRefBH;
286 static void bdrv_put_ref_bh(void *opaque)
288 BDRVPutRefBH *s = opaque;
290 bdrv_unref(s->bs);
291 qemu_bh_delete(s->bh);
292 g_free(s);
296 * Release a BDS reference in a BH
298 * It is not safe to use bdrv_unref() from a callback function when the callers
299 * still need the BlockDriverState. In such cases we schedule a BH to release
300 * the reference.
302 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
304 BDRVPutRefBH *s;
306 s = g_new(BDRVPutRefBH, 1);
307 s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
308 s->bs = bs;
309 qemu_bh_schedule(s->bh);
312 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
314 if (!strcmp(buf, "ignore")) {
315 return BLOCKDEV_ON_ERROR_IGNORE;
316 } else if (!is_read && !strcmp(buf, "enospc")) {
317 return BLOCKDEV_ON_ERROR_ENOSPC;
318 } else if (!strcmp(buf, "stop")) {
319 return BLOCKDEV_ON_ERROR_STOP;
320 } else if (!strcmp(buf, "report")) {
321 return BLOCKDEV_ON_ERROR_REPORT;
322 } else {
323 error_setg(errp, "'%s' invalid %s error action",
324 buf, is_read ? "read" : "write");
325 return -1;
329 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
331 if (throttle_conflicting(cfg)) {
332 error_setg(errp, "bps/iops/max total values and read/write values"
333 " cannot be used at the same time");
334 return false;
337 if (!throttle_is_valid(cfg)) {
338 error_setg(errp, "bps/iops/maxs values must be 0 or greater");
339 return false;
342 if (throttle_max_is_missing_limit(cfg)) {
343 error_setg(errp, "bps_max/iops_max require corresponding"
344 " bps/iops values");
345 return false;
348 return true;
351 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
353 /* All parameters but @opts are optional and may be set to NULL. */
354 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
355 const char **throttling_group, ThrottleConfig *throttle_cfg,
356 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
358 const char *discard;
359 Error *local_error = NULL;
360 const char *aio;
362 if (bdrv_flags) {
363 if (!qemu_opt_get_bool(opts, "read-only", false)) {
364 *bdrv_flags |= BDRV_O_RDWR;
366 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
367 *bdrv_flags |= BDRV_O_COPY_ON_READ;
370 if ((discard = qemu_opt_get(opts, "discard")) != NULL) {
371 if (bdrv_parse_discard_flags(discard, bdrv_flags) != 0) {
372 error_setg(errp, "Invalid discard option");
373 return;
377 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true)) {
378 *bdrv_flags |= BDRV_O_CACHE_WB;
380 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) {
381 *bdrv_flags |= BDRV_O_NOCACHE;
383 if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) {
384 *bdrv_flags |= BDRV_O_NO_FLUSH;
387 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
388 if (!strcmp(aio, "native")) {
389 *bdrv_flags |= BDRV_O_NATIVE_AIO;
390 } else if (!strcmp(aio, "threads")) {
391 /* this is the default */
392 } else {
393 error_setg(errp, "invalid aio option");
394 return;
399 /* disk I/O throttling */
400 if (throttling_group) {
401 *throttling_group = qemu_opt_get(opts, "throttling.group");
404 if (throttle_cfg) {
405 memset(throttle_cfg, 0, sizeof(*throttle_cfg));
406 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
407 qemu_opt_get_number(opts, "throttling.bps-total", 0);
408 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
409 qemu_opt_get_number(opts, "throttling.bps-read", 0);
410 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
411 qemu_opt_get_number(opts, "throttling.bps-write", 0);
412 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
413 qemu_opt_get_number(opts, "throttling.iops-total", 0);
414 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
415 qemu_opt_get_number(opts, "throttling.iops-read", 0);
416 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
417 qemu_opt_get_number(opts, "throttling.iops-write", 0);
419 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
420 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
421 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
422 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
423 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
424 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
425 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
426 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
427 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
428 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
429 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
430 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
432 throttle_cfg->op_size =
433 qemu_opt_get_number(opts, "throttling.iops-size", 0);
435 if (!check_throttle_config(throttle_cfg, errp)) {
436 return;
440 if (detect_zeroes) {
441 *detect_zeroes =
442 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
443 qemu_opt_get(opts, "detect-zeroes"),
444 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
445 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
446 &local_error);
447 if (local_error) {
448 error_propagate(errp, local_error);
449 return;
452 if (bdrv_flags &&
453 *detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
454 !(*bdrv_flags & BDRV_O_UNMAP))
456 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
457 "without setting discard operation to unmap");
458 return;
463 /* Takes the ownership of bs_opts */
464 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
465 Error **errp)
467 const char *buf;
468 int bdrv_flags = 0;
469 int on_read_error, on_write_error;
470 BlockBackend *blk;
471 BlockDriverState *bs;
472 ThrottleConfig cfg;
473 int snapshot = 0;
474 Error *error = NULL;
475 QemuOpts *opts;
476 const char *id;
477 bool has_driver_specific_opts;
478 BlockdevDetectZeroesOptions detect_zeroes =
479 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
480 const char *throttling_group = NULL;
482 /* Check common options by copying from bs_opts to opts, all other options
483 * stay in bs_opts for processing by bdrv_open(). */
484 id = qdict_get_try_str(bs_opts, "id");
485 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
486 if (error) {
487 error_propagate(errp, error);
488 goto err_no_opts;
491 qemu_opts_absorb_qdict(opts, bs_opts, &error);
492 if (error) {
493 error_propagate(errp, error);
494 goto early_err;
497 if (id) {
498 qdict_del(bs_opts, "id");
501 has_driver_specific_opts = !!qdict_size(bs_opts);
503 /* extract parameters */
504 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
506 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
507 &detect_zeroes, &error);
508 if (error) {
509 error_propagate(errp, error);
510 goto early_err;
513 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
514 if (is_help_option(buf)) {
515 error_printf("Supported formats:");
516 bdrv_iterate_format(bdrv_format_print, NULL);
517 error_printf("\n");
518 goto early_err;
521 if (qdict_haskey(bs_opts, "driver")) {
522 error_setg(errp, "Cannot specify both 'driver' and 'format'");
523 goto early_err;
525 qdict_put(bs_opts, "driver", qstring_from_str(buf));
528 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
529 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
530 on_write_error = parse_block_error_action(buf, 0, &error);
531 if (error) {
532 error_propagate(errp, error);
533 goto early_err;
537 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
538 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
539 on_read_error = parse_block_error_action(buf, 1, &error);
540 if (error) {
541 error_propagate(errp, error);
542 goto early_err;
546 if (snapshot) {
547 /* always use cache=unsafe with snapshot */
548 bdrv_flags &= ~BDRV_O_CACHE_MASK;
549 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
552 /* init */
553 if ((!file || !*file) && !has_driver_specific_opts) {
554 BlockBackendRootState *blk_rs;
556 blk = blk_new(qemu_opts_id(opts), errp);
557 if (!blk) {
558 goto early_err;
561 blk_rs = blk_get_root_state(blk);
562 blk_rs->open_flags = bdrv_flags;
563 blk_rs->read_only = !(bdrv_flags & BDRV_O_RDWR);
564 blk_rs->detect_zeroes = detect_zeroes;
566 if (throttle_enabled(&cfg)) {
567 if (!throttling_group) {
568 throttling_group = blk_name(blk);
570 blk_rs->throttle_group = g_strdup(throttling_group);
571 blk_rs->throttle_state = throttle_group_incref(throttling_group);
572 blk_rs->throttle_state->cfg = cfg;
575 QDECREF(bs_opts);
576 } else {
577 if (file && !*file) {
578 file = NULL;
581 blk = blk_new_open(qemu_opts_id(opts), file, NULL, bs_opts, bdrv_flags,
582 errp);
583 if (!blk) {
584 goto err_no_bs_opts;
586 bs = blk_bs(blk);
588 bs->detect_zeroes = detect_zeroes;
590 /* disk I/O throttling */
591 if (throttle_enabled(&cfg)) {
592 if (!throttling_group) {
593 throttling_group = blk_name(blk);
595 bdrv_io_limits_enable(bs, throttling_group);
596 bdrv_set_io_limits(bs, &cfg);
599 if (bdrv_key_required(bs)) {
600 autostart = 0;
604 blk_set_on_error(blk, on_read_error, on_write_error);
606 err_no_bs_opts:
607 qemu_opts_del(opts);
608 return blk;
610 early_err:
611 qemu_opts_del(opts);
612 err_no_opts:
613 QDECREF(bs_opts);
614 return NULL;
617 static QemuOptsList qemu_root_bds_opts;
619 /* Takes the ownership of bs_opts */
620 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
622 BlockDriverState *bs;
623 QemuOpts *opts;
624 Error *local_error = NULL;
625 BlockdevDetectZeroesOptions detect_zeroes;
626 int ret;
627 int bdrv_flags = 0;
629 opts = qemu_opts_create(&qemu_root_bds_opts, NULL, 1, errp);
630 if (!opts) {
631 goto fail;
634 qemu_opts_absorb_qdict(opts, bs_opts, &local_error);
635 if (local_error) {
636 error_propagate(errp, local_error);
637 goto fail;
640 extract_common_blockdev_options(opts, &bdrv_flags, NULL, NULL,
641 &detect_zeroes, &local_error);
642 if (local_error) {
643 error_propagate(errp, local_error);
644 goto fail;
647 bs = NULL;
648 ret = bdrv_open(&bs, NULL, NULL, bs_opts, bdrv_flags, errp);
649 if (ret < 0) {
650 goto fail_no_bs_opts;
653 bs->detect_zeroes = detect_zeroes;
655 fail_no_bs_opts:
656 qemu_opts_del(opts);
657 return bs;
659 fail:
660 qemu_opts_del(opts);
661 QDECREF(bs_opts);
662 return NULL;
665 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
666 Error **errp)
668 const char *value;
670 value = qemu_opt_get(opts, from);
671 if (value) {
672 if (qemu_opt_find(opts, to)) {
673 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
674 "same time", to, from);
675 return;
679 /* rename all items in opts */
680 while ((value = qemu_opt_get(opts, from))) {
681 qemu_opt_set(opts, to, value, &error_abort);
682 qemu_opt_unset(opts, from);
686 QemuOptsList qemu_legacy_drive_opts = {
687 .name = "drive",
688 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
689 .desc = {
691 .name = "bus",
692 .type = QEMU_OPT_NUMBER,
693 .help = "bus number",
695 .name = "unit",
696 .type = QEMU_OPT_NUMBER,
697 .help = "unit number (i.e. lun for scsi)",
699 .name = "index",
700 .type = QEMU_OPT_NUMBER,
701 .help = "index number",
703 .name = "media",
704 .type = QEMU_OPT_STRING,
705 .help = "media type (disk, cdrom)",
707 .name = "if",
708 .type = QEMU_OPT_STRING,
709 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
711 .name = "cyls",
712 .type = QEMU_OPT_NUMBER,
713 .help = "number of cylinders (ide disk geometry)",
715 .name = "heads",
716 .type = QEMU_OPT_NUMBER,
717 .help = "number of heads (ide disk geometry)",
719 .name = "secs",
720 .type = QEMU_OPT_NUMBER,
721 .help = "number of sectors (ide disk geometry)",
723 .name = "trans",
724 .type = QEMU_OPT_STRING,
725 .help = "chs translation (auto, lba, none)",
727 .name = "boot",
728 .type = QEMU_OPT_BOOL,
729 .help = "(deprecated, ignored)",
731 .name = "addr",
732 .type = QEMU_OPT_STRING,
733 .help = "pci address (virtio only)",
735 .name = "serial",
736 .type = QEMU_OPT_STRING,
737 .help = "disk serial number",
739 .name = "file",
740 .type = QEMU_OPT_STRING,
741 .help = "file name",
744 /* Options that are passed on, but have special semantics with -drive */
746 .name = "read-only",
747 .type = QEMU_OPT_BOOL,
748 .help = "open drive file as read-only",
750 .name = "rerror",
751 .type = QEMU_OPT_STRING,
752 .help = "read error action",
754 .name = "werror",
755 .type = QEMU_OPT_STRING,
756 .help = "write error action",
758 .name = "copy-on-read",
759 .type = QEMU_OPT_BOOL,
760 .help = "copy read data from backing file into image file",
763 { /* end of list */ }
767 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
769 const char *value;
770 BlockBackend *blk;
771 DriveInfo *dinfo = NULL;
772 QDict *bs_opts;
773 QemuOpts *legacy_opts;
774 DriveMediaType media = MEDIA_DISK;
775 BlockInterfaceType type;
776 int cyls, heads, secs, translation;
777 int max_devs, bus_id, unit_id, index;
778 const char *devaddr;
779 const char *werror, *rerror;
780 bool read_only = false;
781 bool copy_on_read;
782 const char *serial;
783 const char *filename;
784 Error *local_err = NULL;
785 int i;
787 /* Change legacy command line options into QMP ones */
788 static const struct {
789 const char *from;
790 const char *to;
791 } opt_renames[] = {
792 { "iops", "throttling.iops-total" },
793 { "iops_rd", "throttling.iops-read" },
794 { "iops_wr", "throttling.iops-write" },
796 { "bps", "throttling.bps-total" },
797 { "bps_rd", "throttling.bps-read" },
798 { "bps_wr", "throttling.bps-write" },
800 { "iops_max", "throttling.iops-total-max" },
801 { "iops_rd_max", "throttling.iops-read-max" },
802 { "iops_wr_max", "throttling.iops-write-max" },
804 { "bps_max", "throttling.bps-total-max" },
805 { "bps_rd_max", "throttling.bps-read-max" },
806 { "bps_wr_max", "throttling.bps-write-max" },
808 { "iops_size", "throttling.iops-size" },
810 { "group", "throttling.group" },
812 { "readonly", "read-only" },
815 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
816 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
817 &local_err);
818 if (local_err) {
819 error_report_err(local_err);
820 return NULL;
824 value = qemu_opt_get(all_opts, "cache");
825 if (value) {
826 int flags = 0;
828 if (bdrv_parse_cache_flags(value, &flags) != 0) {
829 error_report("invalid cache option");
830 return NULL;
833 /* Specific options take precedence */
834 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
835 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
836 !!(flags & BDRV_O_CACHE_WB), &error_abort);
838 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
839 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
840 !!(flags & BDRV_O_NOCACHE), &error_abort);
842 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
843 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
844 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
846 qemu_opt_unset(all_opts, "cache");
849 /* Get a QDict for processing the options */
850 bs_opts = qdict_new();
851 qemu_opts_to_qdict(all_opts, bs_opts);
853 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
854 &error_abort);
855 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
856 if (local_err) {
857 error_report_err(local_err);
858 goto fail;
861 /* Deprecated option boot=[on|off] */
862 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
863 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
864 "ignored. Future versions will reject this parameter. Please "
865 "update your scripts.\n");
868 /* Media type */
869 value = qemu_opt_get(legacy_opts, "media");
870 if (value) {
871 if (!strcmp(value, "disk")) {
872 media = MEDIA_DISK;
873 } else if (!strcmp(value, "cdrom")) {
874 media = MEDIA_CDROM;
875 read_only = true;
876 } else {
877 error_report("'%s' invalid media", value);
878 goto fail;
882 /* copy-on-read is disabled with a warning for read-only devices */
883 read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
884 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
886 if (read_only && copy_on_read) {
887 error_report("warning: disabling copy-on-read on read-only drive");
888 copy_on_read = false;
891 qdict_put(bs_opts, "read-only",
892 qstring_from_str(read_only ? "on" : "off"));
893 qdict_put(bs_opts, "copy-on-read",
894 qstring_from_str(copy_on_read ? "on" :"off"));
896 /* Controller type */
897 value = qemu_opt_get(legacy_opts, "if");
898 if (value) {
899 for (type = 0;
900 type < IF_COUNT && strcmp(value, if_name[type]);
901 type++) {
903 if (type == IF_COUNT) {
904 error_report("unsupported bus type '%s'", value);
905 goto fail;
907 } else {
908 type = block_default_type;
911 /* Geometry */
912 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
913 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
914 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
916 if (cyls || heads || secs) {
917 if (cyls < 1) {
918 error_report("invalid physical cyls number");
919 goto fail;
921 if (heads < 1) {
922 error_report("invalid physical heads number");
923 goto fail;
925 if (secs < 1) {
926 error_report("invalid physical secs number");
927 goto fail;
931 translation = BIOS_ATA_TRANSLATION_AUTO;
932 value = qemu_opt_get(legacy_opts, "trans");
933 if (value != NULL) {
934 if (!cyls) {
935 error_report("'%s' trans must be used with cyls, heads and secs",
936 value);
937 goto fail;
939 if (!strcmp(value, "none")) {
940 translation = BIOS_ATA_TRANSLATION_NONE;
941 } else if (!strcmp(value, "lba")) {
942 translation = BIOS_ATA_TRANSLATION_LBA;
943 } else if (!strcmp(value, "large")) {
944 translation = BIOS_ATA_TRANSLATION_LARGE;
945 } else if (!strcmp(value, "rechs")) {
946 translation = BIOS_ATA_TRANSLATION_RECHS;
947 } else if (!strcmp(value, "auto")) {
948 translation = BIOS_ATA_TRANSLATION_AUTO;
949 } else {
950 error_report("'%s' invalid translation type", value);
951 goto fail;
955 if (media == MEDIA_CDROM) {
956 if (cyls || secs || heads) {
957 error_report("CHS can't be set with media=cdrom");
958 goto fail;
962 /* Device address specified by bus/unit or index.
963 * If none was specified, try to find the first free one. */
964 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
965 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
966 index = qemu_opt_get_number(legacy_opts, "index", -1);
968 max_devs = if_max_devs[type];
970 if (index != -1) {
971 if (bus_id != 0 || unit_id != -1) {
972 error_report("index cannot be used with bus and unit");
973 goto fail;
975 bus_id = drive_index_to_bus_id(type, index);
976 unit_id = drive_index_to_unit_id(type, index);
979 if (unit_id == -1) {
980 unit_id = 0;
981 while (drive_get(type, bus_id, unit_id) != NULL) {
982 unit_id++;
983 if (max_devs && unit_id >= max_devs) {
984 unit_id -= max_devs;
985 bus_id++;
990 if (max_devs && unit_id >= max_devs) {
991 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
992 goto fail;
995 if (drive_get(type, bus_id, unit_id) != NULL) {
996 error_report("drive with bus=%d, unit=%d (index=%d) exists",
997 bus_id, unit_id, index);
998 goto fail;
1001 /* Serial number */
1002 serial = qemu_opt_get(legacy_opts, "serial");
1004 /* no id supplied -> create one */
1005 if (qemu_opts_id(all_opts) == NULL) {
1006 char *new_id;
1007 const char *mediastr = "";
1008 if (type == IF_IDE || type == IF_SCSI) {
1009 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
1011 if (max_devs) {
1012 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
1013 mediastr, unit_id);
1014 } else {
1015 new_id = g_strdup_printf("%s%s%i", if_name[type],
1016 mediastr, unit_id);
1018 qdict_put(bs_opts, "id", qstring_from_str(new_id));
1019 g_free(new_id);
1022 /* Add virtio block device */
1023 devaddr = qemu_opt_get(legacy_opts, "addr");
1024 if (devaddr && type != IF_VIRTIO) {
1025 error_report("addr is not supported by this bus type");
1026 goto fail;
1029 if (type == IF_VIRTIO) {
1030 QemuOpts *devopts;
1031 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
1032 &error_abort);
1033 if (arch_type == QEMU_ARCH_S390X) {
1034 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1035 } else {
1036 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1038 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
1039 &error_abort);
1040 if (devaddr) {
1041 qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1045 filename = qemu_opt_get(legacy_opts, "file");
1047 /* Check werror/rerror compatibility with if=... */
1048 werror = qemu_opt_get(legacy_opts, "werror");
1049 if (werror != NULL) {
1050 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
1051 type != IF_NONE) {
1052 error_report("werror is not supported by this bus type");
1053 goto fail;
1055 qdict_put(bs_opts, "werror", qstring_from_str(werror));
1058 rerror = qemu_opt_get(legacy_opts, "rerror");
1059 if (rerror != NULL) {
1060 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
1061 type != IF_NONE) {
1062 error_report("rerror is not supported by this bus type");
1063 goto fail;
1065 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
1068 /* Actual block device init: Functionality shared with blockdev-add */
1069 blk = blockdev_init(filename, bs_opts, &local_err);
1070 bs_opts = NULL;
1071 if (!blk) {
1072 if (local_err) {
1073 error_report_err(local_err);
1075 goto fail;
1076 } else {
1077 assert(!local_err);
1080 /* Create legacy DriveInfo */
1081 dinfo = g_malloc0(sizeof(*dinfo));
1082 dinfo->opts = all_opts;
1084 dinfo->cyls = cyls;
1085 dinfo->heads = heads;
1086 dinfo->secs = secs;
1087 dinfo->trans = translation;
1089 dinfo->type = type;
1090 dinfo->bus = bus_id;
1091 dinfo->unit = unit_id;
1092 dinfo->devaddr = devaddr;
1093 dinfo->serial = g_strdup(serial);
1095 blk_set_legacy_dinfo(blk, dinfo);
1097 switch(type) {
1098 case IF_IDE:
1099 case IF_SCSI:
1100 case IF_XEN:
1101 case IF_NONE:
1102 dinfo->media_cd = media == MEDIA_CDROM;
1103 break;
1104 default:
1105 break;
1108 fail:
1109 qemu_opts_del(legacy_opts);
1110 QDECREF(bs_opts);
1111 return dinfo;
1114 void hmp_commit(Monitor *mon, const QDict *qdict)
1116 const char *device = qdict_get_str(qdict, "device");
1117 BlockBackend *blk;
1118 int ret;
1120 if (!strcmp(device, "all")) {
1121 ret = bdrv_commit_all();
1122 } else {
1123 blk = blk_by_name(device);
1124 if (!blk) {
1125 monitor_printf(mon, "Device '%s' not found\n", device);
1126 return;
1128 if (!blk_is_available(blk)) {
1129 monitor_printf(mon, "Device '%s' has no medium\n", device);
1130 return;
1132 ret = bdrv_commit(blk_bs(blk));
1134 if (ret < 0) {
1135 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1136 strerror(-ret));
1140 static void blockdev_do_action(int kind, void *data, Error **errp)
1142 TransactionAction action;
1143 TransactionActionList list;
1145 action.kind = kind;
1146 action.data = data;
1147 list.value = &action;
1148 list.next = NULL;
1149 qmp_transaction(&list, errp);
1152 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1153 bool has_node_name, const char *node_name,
1154 const char *snapshot_file,
1155 bool has_snapshot_node_name,
1156 const char *snapshot_node_name,
1157 bool has_format, const char *format,
1158 bool has_mode, NewImageMode mode, Error **errp)
1160 BlockdevSnapshot snapshot = {
1161 .has_device = has_device,
1162 .device = (char *) device,
1163 .has_node_name = has_node_name,
1164 .node_name = (char *) node_name,
1165 .snapshot_file = (char *) snapshot_file,
1166 .has_snapshot_node_name = has_snapshot_node_name,
1167 .snapshot_node_name = (char *) snapshot_node_name,
1168 .has_format = has_format,
1169 .format = (char *) format,
1170 .has_mode = has_mode,
1171 .mode = mode,
1173 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1174 &snapshot, errp);
1177 void qmp_blockdev_snapshot_internal_sync(const char *device,
1178 const char *name,
1179 Error **errp)
1181 BlockdevSnapshotInternal snapshot = {
1182 .device = (char *) device,
1183 .name = (char *) name
1186 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1187 &snapshot, errp);
1190 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1191 bool has_id,
1192 const char *id,
1193 bool has_name,
1194 const char *name,
1195 Error **errp)
1197 BlockDriverState *bs;
1198 BlockBackend *blk;
1199 AioContext *aio_context;
1200 QEMUSnapshotInfo sn;
1201 Error *local_err = NULL;
1202 SnapshotInfo *info = NULL;
1203 int ret;
1205 blk = blk_by_name(device);
1206 if (!blk) {
1207 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1208 "Device '%s' not found", device);
1209 return NULL;
1212 aio_context = blk_get_aio_context(blk);
1213 aio_context_acquire(aio_context);
1215 if (!has_id) {
1216 id = NULL;
1219 if (!has_name) {
1220 name = NULL;
1223 if (!id && !name) {
1224 error_setg(errp, "Name or id must be provided");
1225 goto out_aio_context;
1228 if (!blk_is_available(blk)) {
1229 error_setg(errp, "Device '%s' has no medium", device);
1230 goto out_aio_context;
1232 bs = blk_bs(blk);
1234 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1235 goto out_aio_context;
1238 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1239 if (local_err) {
1240 error_propagate(errp, local_err);
1241 goto out_aio_context;
1243 if (!ret) {
1244 error_setg(errp,
1245 "Snapshot with id '%s' and name '%s' does not exist on "
1246 "device '%s'",
1247 STR_OR_NULL(id), STR_OR_NULL(name), device);
1248 goto out_aio_context;
1251 bdrv_snapshot_delete(bs, id, name, &local_err);
1252 if (local_err) {
1253 error_propagate(errp, local_err);
1254 goto out_aio_context;
1257 aio_context_release(aio_context);
1259 info = g_new0(SnapshotInfo, 1);
1260 info->id = g_strdup(sn.id_str);
1261 info->name = g_strdup(sn.name);
1262 info->date_nsec = sn.date_nsec;
1263 info->date_sec = sn.date_sec;
1264 info->vm_state_size = sn.vm_state_size;
1265 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1266 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1268 return info;
1270 out_aio_context:
1271 aio_context_release(aio_context);
1272 return NULL;
1276 * block_dirty_bitmap_lookup:
1277 * Return a dirty bitmap (if present), after validating
1278 * the node reference and bitmap names.
1280 * @node: The name of the BDS node to search for bitmaps
1281 * @name: The name of the bitmap to search for
1282 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1283 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1284 * @errp: Output pointer for error information. Can be NULL.
1286 * @return: A bitmap object on success, or NULL on failure.
1288 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1289 const char *name,
1290 BlockDriverState **pbs,
1291 AioContext **paio,
1292 Error **errp)
1294 BlockDriverState *bs;
1295 BdrvDirtyBitmap *bitmap;
1296 AioContext *aio_context;
1298 if (!node) {
1299 error_setg(errp, "Node cannot be NULL");
1300 return NULL;
1302 if (!name) {
1303 error_setg(errp, "Bitmap name cannot be NULL");
1304 return NULL;
1306 bs = bdrv_lookup_bs(node, node, NULL);
1307 if (!bs) {
1308 error_setg(errp, "Node '%s' not found", node);
1309 return NULL;
1312 aio_context = bdrv_get_aio_context(bs);
1313 aio_context_acquire(aio_context);
1315 bitmap = bdrv_find_dirty_bitmap(bs, name);
1316 if (!bitmap) {
1317 error_setg(errp, "Dirty bitmap '%s' not found", name);
1318 goto fail;
1321 if (pbs) {
1322 *pbs = bs;
1324 if (paio) {
1325 *paio = aio_context;
1326 } else {
1327 aio_context_release(aio_context);
1330 return bitmap;
1332 fail:
1333 aio_context_release(aio_context);
1334 return NULL;
1337 /* New and old BlockDriverState structs for atomic group operations */
1339 typedef struct BlkTransactionState BlkTransactionState;
1341 /* Only prepare() may fail. In a single transaction, only one of commit() or
1342 abort() will be called, clean() will always be called if it present. */
1343 typedef struct BdrvActionOps {
1344 /* Size of state struct, in bytes. */
1345 size_t instance_size;
1346 /* Prepare the work, must NOT be NULL. */
1347 void (*prepare)(BlkTransactionState *common, Error **errp);
1348 /* Commit the changes, can be NULL. */
1349 void (*commit)(BlkTransactionState *common);
1350 /* Abort the changes on fail, can be NULL. */
1351 void (*abort)(BlkTransactionState *common);
1352 /* Clean up resource in the end, can be NULL. */
1353 void (*clean)(BlkTransactionState *common);
1354 } BdrvActionOps;
1357 * This structure must be arranged as first member in child type, assuming
1358 * that compiler will also arrange it to the same address with parent instance.
1359 * Later it will be used in free().
1361 struct BlkTransactionState {
1362 TransactionAction *action;
1363 const BdrvActionOps *ops;
1364 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1367 /* internal snapshot private data */
1368 typedef struct InternalSnapshotState {
1369 BlkTransactionState common;
1370 BlockDriverState *bs;
1371 AioContext *aio_context;
1372 QEMUSnapshotInfo sn;
1373 } InternalSnapshotState;
1375 static void internal_snapshot_prepare(BlkTransactionState *common,
1376 Error **errp)
1378 Error *local_err = NULL;
1379 const char *device;
1380 const char *name;
1381 BlockBackend *blk;
1382 BlockDriverState *bs;
1383 QEMUSnapshotInfo old_sn, *sn;
1384 bool ret;
1385 qemu_timeval tv;
1386 BlockdevSnapshotInternal *internal;
1387 InternalSnapshotState *state;
1388 int ret1;
1390 g_assert(common->action->kind ==
1391 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1392 internal = common->action->blockdev_snapshot_internal_sync;
1393 state = DO_UPCAST(InternalSnapshotState, common, common);
1395 /* 1. parse input */
1396 device = internal->device;
1397 name = internal->name;
1399 /* 2. check for validation */
1400 blk = blk_by_name(device);
1401 if (!blk) {
1402 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1403 "Device '%s' not found", device);
1404 return;
1407 /* AioContext is released in .clean() */
1408 state->aio_context = blk_get_aio_context(blk);
1409 aio_context_acquire(state->aio_context);
1411 if (!blk_is_available(blk)) {
1412 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1413 return;
1415 bs = blk_bs(blk);
1417 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1418 return;
1421 if (bdrv_is_read_only(bs)) {
1422 error_setg(errp, "Device '%s' is read only", device);
1423 return;
1426 if (!bdrv_can_snapshot(bs)) {
1427 error_setg(errp, "Block format '%s' used by device '%s' "
1428 "does not support internal snapshots",
1429 bs->drv->format_name, device);
1430 return;
1433 if (!strlen(name)) {
1434 error_setg(errp, "Name is empty");
1435 return;
1438 /* check whether a snapshot with name exist */
1439 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1440 &local_err);
1441 if (local_err) {
1442 error_propagate(errp, local_err);
1443 return;
1444 } else if (ret) {
1445 error_setg(errp,
1446 "Snapshot with name '%s' already exists on device '%s'",
1447 name, device);
1448 return;
1451 /* 3. take the snapshot */
1452 sn = &state->sn;
1453 pstrcpy(sn->name, sizeof(sn->name), name);
1454 qemu_gettimeofday(&tv);
1455 sn->date_sec = tv.tv_sec;
1456 sn->date_nsec = tv.tv_usec * 1000;
1457 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1459 ret1 = bdrv_snapshot_create(bs, sn);
1460 if (ret1 < 0) {
1461 error_setg_errno(errp, -ret1,
1462 "Failed to create snapshot '%s' on device '%s'",
1463 name, device);
1464 return;
1467 /* 4. succeed, mark a snapshot is created */
1468 state->bs = bs;
1471 static void internal_snapshot_abort(BlkTransactionState *common)
1473 InternalSnapshotState *state =
1474 DO_UPCAST(InternalSnapshotState, common, common);
1475 BlockDriverState *bs = state->bs;
1476 QEMUSnapshotInfo *sn = &state->sn;
1477 Error *local_error = NULL;
1479 if (!bs) {
1480 return;
1483 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1484 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1485 "device '%s' in abort: %s",
1486 sn->id_str,
1487 sn->name,
1488 bdrv_get_device_name(bs),
1489 error_get_pretty(local_error));
1490 error_free(local_error);
1494 static void internal_snapshot_clean(BlkTransactionState *common)
1496 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1497 common, common);
1499 if (state->aio_context) {
1500 aio_context_release(state->aio_context);
1504 /* external snapshot private data */
1505 typedef struct ExternalSnapshotState {
1506 BlkTransactionState common;
1507 BlockDriverState *old_bs;
1508 BlockDriverState *new_bs;
1509 AioContext *aio_context;
1510 } ExternalSnapshotState;
1512 static void external_snapshot_prepare(BlkTransactionState *common,
1513 Error **errp)
1515 int flags, ret;
1516 QDict *options;
1517 Error *local_err = NULL;
1518 bool has_device = false;
1519 const char *device;
1520 bool has_node_name = false;
1521 const char *node_name;
1522 bool has_snapshot_node_name = false;
1523 const char *snapshot_node_name;
1524 const char *new_image_file;
1525 const char *format = "qcow2";
1526 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1527 ExternalSnapshotState *state =
1528 DO_UPCAST(ExternalSnapshotState, common, common);
1529 TransactionAction *action = common->action;
1531 /* get parameters */
1532 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1534 has_device = action->blockdev_snapshot_sync->has_device;
1535 device = action->blockdev_snapshot_sync->device;
1536 has_node_name = action->blockdev_snapshot_sync->has_node_name;
1537 node_name = action->blockdev_snapshot_sync->node_name;
1538 has_snapshot_node_name =
1539 action->blockdev_snapshot_sync->has_snapshot_node_name;
1540 snapshot_node_name = action->blockdev_snapshot_sync->snapshot_node_name;
1542 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1543 if (action->blockdev_snapshot_sync->has_format) {
1544 format = action->blockdev_snapshot_sync->format;
1546 if (action->blockdev_snapshot_sync->has_mode) {
1547 mode = action->blockdev_snapshot_sync->mode;
1550 /* start processing */
1551 state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
1552 has_node_name ? node_name : NULL,
1553 &local_err);
1554 if (local_err) {
1555 error_propagate(errp, local_err);
1556 return;
1559 if (has_node_name && !has_snapshot_node_name) {
1560 error_setg(errp, "New snapshot node name missing");
1561 return;
1564 if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
1565 error_setg(errp, "New snapshot node name already existing");
1566 return;
1569 /* Acquire AioContext now so any threads operating on old_bs stop */
1570 state->aio_context = bdrv_get_aio_context(state->old_bs);
1571 aio_context_acquire(state->aio_context);
1572 bdrv_drained_begin(state->old_bs);
1574 if (!bdrv_is_inserted(state->old_bs)) {
1575 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1576 return;
1579 if (bdrv_op_is_blocked(state->old_bs,
1580 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1581 return;
1584 if (!bdrv_is_read_only(state->old_bs)) {
1585 if (bdrv_flush(state->old_bs)) {
1586 error_setg(errp, QERR_IO_ERROR);
1587 return;
1591 if (!bdrv_is_first_non_filter(state->old_bs)) {
1592 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1593 return;
1596 flags = state->old_bs->open_flags;
1598 /* create new image w/backing file */
1599 if (mode != NEW_IMAGE_MODE_EXISTING) {
1600 bdrv_img_create(new_image_file, format,
1601 state->old_bs->filename,
1602 state->old_bs->drv->format_name,
1603 NULL, -1, flags, &local_err, false);
1604 if (local_err) {
1605 error_propagate(errp, local_err);
1606 return;
1610 options = qdict_new();
1611 if (has_snapshot_node_name) {
1612 qdict_put(options, "node-name",
1613 qstring_from_str(snapshot_node_name));
1615 qdict_put(options, "driver", qstring_from_str(format));
1617 /* TODO Inherit bs->options or only take explicit options with an
1618 * extended QMP command? */
1619 assert(state->new_bs == NULL);
1620 ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
1621 flags | BDRV_O_NO_BACKING, &local_err);
1622 /* We will manually add the backing_hd field to the bs later */
1623 if (ret != 0) {
1624 error_propagate(errp, local_err);
1628 static void external_snapshot_commit(BlkTransactionState *common)
1630 ExternalSnapshotState *state =
1631 DO_UPCAST(ExternalSnapshotState, common, common);
1633 bdrv_set_aio_context(state->new_bs, state->aio_context);
1635 /* This removes our old bs and adds the new bs */
1636 bdrv_append(state->new_bs, state->old_bs);
1637 /* We don't need (or want) to use the transactional
1638 * bdrv_reopen_multiple() across all the entries at once, because we
1639 * don't want to abort all of them if one of them fails the reopen */
1640 bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1641 NULL);
1644 static void external_snapshot_abort(BlkTransactionState *common)
1646 ExternalSnapshotState *state =
1647 DO_UPCAST(ExternalSnapshotState, common, common);
1648 if (state->new_bs) {
1649 bdrv_unref(state->new_bs);
1653 static void external_snapshot_clean(BlkTransactionState *common)
1655 ExternalSnapshotState *state =
1656 DO_UPCAST(ExternalSnapshotState, common, common);
1657 if (state->aio_context) {
1658 bdrv_drained_end(state->old_bs);
1659 aio_context_release(state->aio_context);
1663 typedef struct DriveBackupState {
1664 BlkTransactionState common;
1665 BlockDriverState *bs;
1666 AioContext *aio_context;
1667 BlockJob *job;
1668 } DriveBackupState;
1670 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1672 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1673 BlockBackend *blk;
1674 DriveBackup *backup;
1675 Error *local_err = NULL;
1677 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1678 backup = common->action->drive_backup;
1680 blk = blk_by_name(backup->device);
1681 if (!blk) {
1682 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1683 "Device '%s' not found", backup->device);
1684 return;
1687 /* AioContext is released in .clean() */
1688 state->aio_context = blk_get_aio_context(blk);
1689 aio_context_acquire(state->aio_context);
1691 qmp_drive_backup(backup->device, backup->target,
1692 backup->has_format, backup->format,
1693 backup->sync,
1694 backup->has_mode, backup->mode,
1695 backup->has_speed, backup->speed,
1696 backup->has_bitmap, backup->bitmap,
1697 backup->has_on_source_error, backup->on_source_error,
1698 backup->has_on_target_error, backup->on_target_error,
1699 &local_err);
1700 if (local_err) {
1701 error_propagate(errp, local_err);
1702 return;
1705 state->bs = blk_bs(blk);
1706 state->job = state->bs->job;
1709 static void drive_backup_abort(BlkTransactionState *common)
1711 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1712 BlockDriverState *bs = state->bs;
1714 /* Only cancel if it's the job we started */
1715 if (bs && bs->job && bs->job == state->job) {
1716 block_job_cancel_sync(bs->job);
1720 static void drive_backup_clean(BlkTransactionState *common)
1722 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1724 if (state->aio_context) {
1725 aio_context_release(state->aio_context);
1729 typedef struct BlockdevBackupState {
1730 BlkTransactionState common;
1731 BlockDriverState *bs;
1732 BlockJob *job;
1733 AioContext *aio_context;
1734 } BlockdevBackupState;
1736 static void blockdev_backup_prepare(BlkTransactionState *common, Error **errp)
1738 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1739 BlockdevBackup *backup;
1740 BlockBackend *blk, *target;
1741 Error *local_err = NULL;
1743 assert(common->action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1744 backup = common->action->blockdev_backup;
1746 blk = blk_by_name(backup->device);
1747 if (!blk) {
1748 error_setg(errp, "Device '%s' not found", backup->device);
1749 return;
1752 target = blk_by_name(backup->target);
1753 if (!target) {
1754 error_setg(errp, "Device '%s' not found", backup->target);
1755 return;
1758 /* AioContext is released in .clean() */
1759 state->aio_context = blk_get_aio_context(blk);
1760 if (state->aio_context != blk_get_aio_context(target)) {
1761 state->aio_context = NULL;
1762 error_setg(errp, "Backup between two IO threads is not implemented");
1763 return;
1765 aio_context_acquire(state->aio_context);
1767 qmp_blockdev_backup(backup->device, backup->target,
1768 backup->sync,
1769 backup->has_speed, backup->speed,
1770 backup->has_on_source_error, backup->on_source_error,
1771 backup->has_on_target_error, backup->on_target_error,
1772 &local_err);
1773 if (local_err) {
1774 error_propagate(errp, local_err);
1775 return;
1778 state->bs = blk_bs(blk);
1779 state->job = state->bs->job;
1782 static void blockdev_backup_abort(BlkTransactionState *common)
1784 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1785 BlockDriverState *bs = state->bs;
1787 /* Only cancel if it's the job we started */
1788 if (bs && bs->job && bs->job == state->job) {
1789 block_job_cancel_sync(bs->job);
1793 static void blockdev_backup_clean(BlkTransactionState *common)
1795 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1797 if (state->aio_context) {
1798 aio_context_release(state->aio_context);
1802 static void abort_prepare(BlkTransactionState *common, Error **errp)
1804 error_setg(errp, "Transaction aborted using Abort action");
1807 static void abort_commit(BlkTransactionState *common)
1809 g_assert_not_reached(); /* this action never succeeds */
1812 static const BdrvActionOps actions[] = {
1813 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1814 .instance_size = sizeof(ExternalSnapshotState),
1815 .prepare = external_snapshot_prepare,
1816 .commit = external_snapshot_commit,
1817 .abort = external_snapshot_abort,
1818 .clean = external_snapshot_clean,
1820 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1821 .instance_size = sizeof(DriveBackupState),
1822 .prepare = drive_backup_prepare,
1823 .abort = drive_backup_abort,
1824 .clean = drive_backup_clean,
1826 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
1827 .instance_size = sizeof(BlockdevBackupState),
1828 .prepare = blockdev_backup_prepare,
1829 .abort = blockdev_backup_abort,
1830 .clean = blockdev_backup_clean,
1832 [TRANSACTION_ACTION_KIND_ABORT] = {
1833 .instance_size = sizeof(BlkTransactionState),
1834 .prepare = abort_prepare,
1835 .commit = abort_commit,
1837 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1838 .instance_size = sizeof(InternalSnapshotState),
1839 .prepare = internal_snapshot_prepare,
1840 .abort = internal_snapshot_abort,
1841 .clean = internal_snapshot_clean,
1846 * 'Atomic' group operations. The operations are performed as a set, and if
1847 * any fail then we roll back all operations in the group.
1849 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1851 TransactionActionList *dev_entry = dev_list;
1852 BlkTransactionState *state, *next;
1853 Error *local_err = NULL;
1855 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1856 QSIMPLEQ_INIT(&snap_bdrv_states);
1858 /* drain all i/o before any operations */
1859 bdrv_drain_all();
1861 /* We don't do anything in this loop that commits us to the operations */
1862 while (NULL != dev_entry) {
1863 TransactionAction *dev_info = NULL;
1864 const BdrvActionOps *ops;
1866 dev_info = dev_entry->value;
1867 dev_entry = dev_entry->next;
1869 assert(dev_info->kind < ARRAY_SIZE(actions));
1871 ops = &actions[dev_info->kind];
1872 assert(ops->instance_size > 0);
1874 state = g_malloc0(ops->instance_size);
1875 state->ops = ops;
1876 state->action = dev_info;
1877 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1879 state->ops->prepare(state, &local_err);
1880 if (local_err) {
1881 error_propagate(errp, local_err);
1882 goto delete_and_fail;
1886 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1887 if (state->ops->commit) {
1888 state->ops->commit(state);
1892 /* success */
1893 goto exit;
1895 delete_and_fail:
1896 /* failure, and it is all-or-none; roll back all operations */
1897 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1898 if (state->ops->abort) {
1899 state->ops->abort(state);
1902 exit:
1903 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1904 if (state->ops->clean) {
1905 state->ops->clean(state);
1907 g_free(state);
1912 static void eject_device(BlockBackend *blk, int force, Error **errp)
1914 BlockDriverState *bs = blk_bs(blk);
1915 AioContext *aio_context;
1917 if (!bs) {
1918 /* No medium inserted, so there is nothing to do */
1919 return;
1922 aio_context = bdrv_get_aio_context(bs);
1923 aio_context_acquire(aio_context);
1925 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1926 goto out;
1928 if (!blk_dev_has_removable_media(blk)) {
1929 error_setg(errp, "Device '%s' is not removable",
1930 bdrv_get_device_name(bs));
1931 goto out;
1934 if (blk_dev_is_medium_locked(blk) && !blk_dev_is_tray_open(blk)) {
1935 blk_dev_eject_request(blk, force);
1936 if (!force) {
1937 error_setg(errp, "Device '%s' is locked",
1938 bdrv_get_device_name(bs));
1939 goto out;
1943 bdrv_close(bs);
1945 out:
1946 aio_context_release(aio_context);
1949 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1951 BlockBackend *blk;
1953 blk = blk_by_name(device);
1954 if (!blk) {
1955 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1956 "Device '%s' not found", device);
1957 return;
1960 eject_device(blk, force, errp);
1963 void qmp_block_passwd(bool has_device, const char *device,
1964 bool has_node_name, const char *node_name,
1965 const char *password, Error **errp)
1967 Error *local_err = NULL;
1968 BlockDriverState *bs;
1969 AioContext *aio_context;
1971 bs = bdrv_lookup_bs(has_device ? device : NULL,
1972 has_node_name ? node_name : NULL,
1973 &local_err);
1974 if (local_err) {
1975 error_propagate(errp, local_err);
1976 return;
1979 aio_context = bdrv_get_aio_context(bs);
1980 aio_context_acquire(aio_context);
1982 bdrv_add_key(bs, password, errp);
1984 aio_context_release(aio_context);
1987 /* Assumes AioContext is held */
1988 static void qmp_bdrv_open_encrypted(BlockDriverState **pbs,
1989 const char *filename,
1990 int bdrv_flags, const char *format,
1991 const char *password, Error **errp)
1993 Error *local_err = NULL;
1994 QDict *options = NULL;
1995 int ret;
1997 if (format) {
1998 options = qdict_new();
1999 qdict_put(options, "driver", qstring_from_str(format));
2002 ret = bdrv_open(pbs, filename, NULL, options, bdrv_flags, &local_err);
2003 if (ret < 0) {
2004 error_propagate(errp, local_err);
2005 return;
2008 bdrv_add_key(*pbs, password, errp);
2011 void qmp_change_blockdev(const char *device, const char *filename,
2012 const char *format, Error **errp)
2014 BlockBackend *blk;
2015 BlockDriverState *bs;
2016 AioContext *aio_context;
2017 int bdrv_flags;
2018 bool new_bs;
2019 Error *err = NULL;
2021 blk = blk_by_name(device);
2022 if (!blk) {
2023 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2024 "Device '%s' not found", device);
2025 return;
2027 bs = blk_bs(blk);
2028 new_bs = !bs;
2030 aio_context = blk_get_aio_context(blk);
2031 aio_context_acquire(aio_context);
2033 eject_device(blk, 0, &err);
2034 if (err) {
2035 error_propagate(errp, err);
2036 goto out;
2039 bdrv_flags = blk_is_read_only(blk) ? 0 : BDRV_O_RDWR;
2040 bdrv_flags |= blk_get_root_state(blk)->open_flags & ~BDRV_O_RDWR;
2042 qmp_bdrv_open_encrypted(&bs, filename, bdrv_flags, format, NULL, &err);
2043 if (err) {
2044 error_propagate(errp, err);
2045 goto out;
2048 if (new_bs) {
2049 blk_insert_bs(blk, bs);
2050 /* Has been sent automatically by bdrv_open() if blk_bs(blk) was not
2051 * NULL */
2052 blk_dev_change_media_cb(blk, true);
2055 out:
2056 aio_context_release(aio_context);
2059 /* throttling disk I/O limits */
2060 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2061 int64_t bps_wr,
2062 int64_t iops,
2063 int64_t iops_rd,
2064 int64_t iops_wr,
2065 bool has_bps_max,
2066 int64_t bps_max,
2067 bool has_bps_rd_max,
2068 int64_t bps_rd_max,
2069 bool has_bps_wr_max,
2070 int64_t bps_wr_max,
2071 bool has_iops_max,
2072 int64_t iops_max,
2073 bool has_iops_rd_max,
2074 int64_t iops_rd_max,
2075 bool has_iops_wr_max,
2076 int64_t iops_wr_max,
2077 bool has_iops_size,
2078 int64_t iops_size,
2079 bool has_group,
2080 const char *group, Error **errp)
2082 ThrottleConfig cfg;
2083 BlockDriverState *bs;
2084 BlockBackend *blk;
2085 AioContext *aio_context;
2087 blk = blk_by_name(device);
2088 if (!blk) {
2089 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2090 "Device '%s' not found", device);
2091 return;
2094 aio_context = blk_get_aio_context(blk);
2095 aio_context_acquire(aio_context);
2097 bs = blk_bs(blk);
2098 if (!bs) {
2099 error_setg(errp, "Device '%s' has no medium", device);
2100 goto out;
2103 memset(&cfg, 0, sizeof(cfg));
2104 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
2105 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
2106 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
2108 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
2109 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
2110 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
2112 if (has_bps_max) {
2113 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
2115 if (has_bps_rd_max) {
2116 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
2118 if (has_bps_wr_max) {
2119 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
2121 if (has_iops_max) {
2122 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
2124 if (has_iops_rd_max) {
2125 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
2127 if (has_iops_wr_max) {
2128 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
2131 if (has_iops_size) {
2132 cfg.op_size = iops_size;
2135 if (!check_throttle_config(&cfg, errp)) {
2136 goto out;
2139 if (throttle_enabled(&cfg)) {
2140 /* Enable I/O limits if they're not enabled yet, otherwise
2141 * just update the throttling group. */
2142 if (!bs->io_limits_enabled) {
2143 bdrv_io_limits_enable(bs, has_group ? group : device);
2144 } else if (has_group) {
2145 bdrv_io_limits_update_group(bs, group);
2147 /* Set the new throttling configuration */
2148 bdrv_set_io_limits(bs, &cfg);
2149 } else if (bs->io_limits_enabled) {
2150 /* If all throttling settings are set to 0, disable I/O limits */
2151 bdrv_io_limits_disable(bs);
2154 out:
2155 aio_context_release(aio_context);
2158 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2159 bool has_granularity, uint32_t granularity,
2160 Error **errp)
2162 AioContext *aio_context;
2163 BlockDriverState *bs;
2165 if (!name || name[0] == '\0') {
2166 error_setg(errp, "Bitmap name cannot be empty");
2167 return;
2170 bs = bdrv_lookup_bs(node, node, errp);
2171 if (!bs) {
2172 return;
2175 aio_context = bdrv_get_aio_context(bs);
2176 aio_context_acquire(aio_context);
2178 if (has_granularity) {
2179 if (granularity < 512 || !is_power_of_2(granularity)) {
2180 error_setg(errp, "Granularity must be power of 2 "
2181 "and at least 512");
2182 goto out;
2184 } else {
2185 /* Default to cluster size, if available: */
2186 granularity = bdrv_get_default_bitmap_granularity(bs);
2189 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2191 out:
2192 aio_context_release(aio_context);
2195 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2196 Error **errp)
2198 AioContext *aio_context;
2199 BlockDriverState *bs;
2200 BdrvDirtyBitmap *bitmap;
2202 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2203 if (!bitmap || !bs) {
2204 return;
2207 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2208 error_setg(errp,
2209 "Bitmap '%s' is currently frozen and cannot be removed",
2210 name);
2211 goto out;
2213 bdrv_dirty_bitmap_make_anon(bitmap);
2214 bdrv_release_dirty_bitmap(bs, bitmap);
2216 out:
2217 aio_context_release(aio_context);
2221 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2222 * immediately after a full backup operation.
2224 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2225 Error **errp)
2227 AioContext *aio_context;
2228 BdrvDirtyBitmap *bitmap;
2229 BlockDriverState *bs;
2231 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2232 if (!bitmap || !bs) {
2233 return;
2236 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2237 error_setg(errp,
2238 "Bitmap '%s' is currently frozen and cannot be modified",
2239 name);
2240 goto out;
2241 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2242 error_setg(errp,
2243 "Bitmap '%s' is currently disabled and cannot be cleared",
2244 name);
2245 goto out;
2248 bdrv_clear_dirty_bitmap(bitmap);
2250 out:
2251 aio_context_release(aio_context);
2254 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2256 const char *id = qdict_get_str(qdict, "id");
2257 BlockBackend *blk;
2258 BlockDriverState *bs;
2259 AioContext *aio_context;
2260 Error *local_err = NULL;
2262 blk = blk_by_name(id);
2263 if (!blk) {
2264 error_report("Device '%s' not found", id);
2265 return;
2268 if (!blk_legacy_dinfo(blk)) {
2269 error_report("Deleting device added with blockdev-add"
2270 " is not supported");
2271 return;
2274 aio_context = blk_get_aio_context(blk);
2275 aio_context_acquire(aio_context);
2277 bs = blk_bs(blk);
2278 if (bs) {
2279 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2280 error_report_err(local_err);
2281 aio_context_release(aio_context);
2282 return;
2285 bdrv_close(bs);
2288 /* if we have a device attached to this BlockDriverState
2289 * then we need to make the drive anonymous until the device
2290 * can be removed. If this is a drive with no device backing
2291 * then we can just get rid of the block driver state right here.
2293 if (blk_get_attached_dev(blk)) {
2294 blk_hide_on_behalf_of_hmp_drive_del(blk);
2295 /* Further I/O must not pause the guest */
2296 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2297 BLOCKDEV_ON_ERROR_REPORT);
2298 } else {
2299 blk_unref(blk);
2302 aio_context_release(aio_context);
2305 void qmp_block_resize(bool has_device, const char *device,
2306 bool has_node_name, const char *node_name,
2307 int64_t size, Error **errp)
2309 Error *local_err = NULL;
2310 BlockDriverState *bs;
2311 AioContext *aio_context;
2312 int ret;
2314 bs = bdrv_lookup_bs(has_device ? device : NULL,
2315 has_node_name ? node_name : NULL,
2316 &local_err);
2317 if (local_err) {
2318 error_propagate(errp, local_err);
2319 return;
2322 aio_context = bdrv_get_aio_context(bs);
2323 aio_context_acquire(aio_context);
2325 if (!bdrv_is_first_non_filter(bs)) {
2326 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2327 goto out;
2330 if (size < 0) {
2331 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2332 goto out;
2335 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2336 error_setg(errp, QERR_DEVICE_IN_USE, device);
2337 goto out;
2340 /* complete all in-flight operations before resizing the device */
2341 bdrv_drain_all();
2343 ret = bdrv_truncate(bs, size);
2344 switch (ret) {
2345 case 0:
2346 break;
2347 case -ENOMEDIUM:
2348 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2349 break;
2350 case -ENOTSUP:
2351 error_setg(errp, QERR_UNSUPPORTED);
2352 break;
2353 case -EACCES:
2354 error_setg(errp, "Device '%s' is read only", device);
2355 break;
2356 case -EBUSY:
2357 error_setg(errp, QERR_DEVICE_IN_USE, device);
2358 break;
2359 default:
2360 error_setg_errno(errp, -ret, "Could not resize");
2361 break;
2364 out:
2365 aio_context_release(aio_context);
2368 static void block_job_cb(void *opaque, int ret)
2370 /* Note that this function may be executed from another AioContext besides
2371 * the QEMU main loop. If you need to access anything that assumes the
2372 * QEMU global mutex, use a BH or introduce a mutex.
2375 BlockDriverState *bs = opaque;
2376 const char *msg = NULL;
2378 trace_block_job_cb(bs, bs->job, ret);
2380 assert(bs->job);
2382 if (ret < 0) {
2383 msg = strerror(-ret);
2386 if (block_job_is_cancelled(bs->job)) {
2387 block_job_event_cancelled(bs->job);
2388 } else {
2389 block_job_event_completed(bs->job, msg);
2392 bdrv_put_ref_bh_schedule(bs);
2395 void qmp_block_stream(const char *device,
2396 bool has_base, const char *base,
2397 bool has_backing_file, const char *backing_file,
2398 bool has_speed, int64_t speed,
2399 bool has_on_error, BlockdevOnError on_error,
2400 Error **errp)
2402 BlockBackend *blk;
2403 BlockDriverState *bs;
2404 BlockDriverState *base_bs = NULL;
2405 AioContext *aio_context;
2406 Error *local_err = NULL;
2407 const char *base_name = NULL;
2409 if (!has_on_error) {
2410 on_error = BLOCKDEV_ON_ERROR_REPORT;
2413 blk = blk_by_name(device);
2414 if (!blk) {
2415 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2416 "Device '%s' not found", device);
2417 return;
2420 aio_context = blk_get_aio_context(blk);
2421 aio_context_acquire(aio_context);
2423 if (!blk_is_available(blk)) {
2424 error_setg(errp, "Device '%s' has no medium", device);
2425 goto out;
2427 bs = blk_bs(blk);
2429 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2430 goto out;
2433 if (has_base) {
2434 base_bs = bdrv_find_backing_image(bs, base);
2435 if (base_bs == NULL) {
2436 error_setg(errp, QERR_BASE_NOT_FOUND, base);
2437 goto out;
2439 assert(bdrv_get_aio_context(base_bs) == aio_context);
2440 base_name = base;
2443 /* if we are streaming the entire chain, the result will have no backing
2444 * file, and specifying one is therefore an error */
2445 if (base_bs == NULL && has_backing_file) {
2446 error_setg(errp, "backing file specified, but streaming the "
2447 "entire chain");
2448 goto out;
2451 /* backing_file string overrides base bs filename */
2452 base_name = has_backing_file ? backing_file : base_name;
2454 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
2455 on_error, block_job_cb, bs, &local_err);
2456 if (local_err) {
2457 error_propagate(errp, local_err);
2458 goto out;
2461 trace_qmp_block_stream(bs, bs->job);
2463 out:
2464 aio_context_release(aio_context);
2467 void qmp_block_commit(const char *device,
2468 bool has_base, const char *base,
2469 bool has_top, const char *top,
2470 bool has_backing_file, const char *backing_file,
2471 bool has_speed, int64_t speed,
2472 Error **errp)
2474 BlockBackend *blk;
2475 BlockDriverState *bs;
2476 BlockDriverState *base_bs, *top_bs;
2477 AioContext *aio_context;
2478 Error *local_err = NULL;
2479 /* This will be part of the QMP command, if/when the
2480 * BlockdevOnError change for blkmirror makes it in
2482 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
2484 if (!has_speed) {
2485 speed = 0;
2488 /* Important Note:
2489 * libvirt relies on the DeviceNotFound error class in order to probe for
2490 * live commit feature versions; for this to work, we must make sure to
2491 * perform the device lookup before any generic errors that may occur in a
2492 * scenario in which all optional arguments are omitted. */
2493 blk = blk_by_name(device);
2494 if (!blk) {
2495 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2496 "Device '%s' not found", device);
2497 return;
2500 aio_context = blk_get_aio_context(blk);
2501 aio_context_acquire(aio_context);
2503 if (!blk_is_available(blk)) {
2504 error_setg(errp, "Device '%s' has no medium", device);
2505 goto out;
2507 bs = blk_bs(blk);
2509 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2510 goto out;
2513 /* default top_bs is the active layer */
2514 top_bs = bs;
2516 if (has_top && top) {
2517 if (strcmp(bs->filename, top) != 0) {
2518 top_bs = bdrv_find_backing_image(bs, top);
2522 if (top_bs == NULL) {
2523 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2524 goto out;
2527 assert(bdrv_get_aio_context(top_bs) == aio_context);
2529 if (has_base && base) {
2530 base_bs = bdrv_find_backing_image(top_bs, base);
2531 } else {
2532 base_bs = bdrv_find_base(top_bs);
2535 if (base_bs == NULL) {
2536 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
2537 goto out;
2540 assert(bdrv_get_aio_context(base_bs) == aio_context);
2542 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2543 goto out;
2546 /* Do not allow attempts to commit an image into itself */
2547 if (top_bs == base_bs) {
2548 error_setg(errp, "cannot commit an image into itself");
2549 goto out;
2552 if (top_bs == bs) {
2553 if (has_backing_file) {
2554 error_setg(errp, "'backing-file' specified,"
2555 " but 'top' is the active layer");
2556 goto out;
2558 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2559 bs, &local_err);
2560 } else {
2561 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
2562 has_backing_file ? backing_file : NULL, &local_err);
2564 if (local_err != NULL) {
2565 error_propagate(errp, local_err);
2566 goto out;
2569 out:
2570 aio_context_release(aio_context);
2573 void qmp_drive_backup(const char *device, const char *target,
2574 bool has_format, const char *format,
2575 enum MirrorSyncMode sync,
2576 bool has_mode, enum NewImageMode mode,
2577 bool has_speed, int64_t speed,
2578 bool has_bitmap, const char *bitmap,
2579 bool has_on_source_error, BlockdevOnError on_source_error,
2580 bool has_on_target_error, BlockdevOnError on_target_error,
2581 Error **errp)
2583 BlockBackend *blk;
2584 BlockDriverState *bs;
2585 BlockDriverState *target_bs;
2586 BlockDriverState *source = NULL;
2587 BdrvDirtyBitmap *bmap = NULL;
2588 AioContext *aio_context;
2589 QDict *options = NULL;
2590 Error *local_err = NULL;
2591 int flags;
2592 int64_t size;
2593 int ret;
2595 if (!has_speed) {
2596 speed = 0;
2598 if (!has_on_source_error) {
2599 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2601 if (!has_on_target_error) {
2602 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2604 if (!has_mode) {
2605 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2608 blk = blk_by_name(device);
2609 if (!blk) {
2610 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2611 "Device '%s' not found", device);
2612 return;
2615 aio_context = blk_get_aio_context(blk);
2616 aio_context_acquire(aio_context);
2618 /* Although backup_run has this check too, we need to use bs->drv below, so
2619 * do an early check redundantly. */
2620 if (!blk_is_available(blk)) {
2621 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2622 goto out;
2624 bs = blk_bs(blk);
2626 if (!has_format) {
2627 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2630 /* Early check to avoid creating target */
2631 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2632 goto out;
2635 flags = bs->open_flags | BDRV_O_RDWR;
2637 /* See if we have a backing HD we can use to create our new image
2638 * on top of. */
2639 if (sync == MIRROR_SYNC_MODE_TOP) {
2640 source = backing_bs(bs);
2641 if (!source) {
2642 sync = MIRROR_SYNC_MODE_FULL;
2645 if (sync == MIRROR_SYNC_MODE_NONE) {
2646 source = bs;
2649 size = bdrv_getlength(bs);
2650 if (size < 0) {
2651 error_setg_errno(errp, -size, "bdrv_getlength failed");
2652 goto out;
2655 if (mode != NEW_IMAGE_MODE_EXISTING) {
2656 assert(format);
2657 if (source) {
2658 bdrv_img_create(target, format, source->filename,
2659 source->drv->format_name, NULL,
2660 size, flags, &local_err, false);
2661 } else {
2662 bdrv_img_create(target, format, NULL, NULL, NULL,
2663 size, flags, &local_err, false);
2667 if (local_err) {
2668 error_propagate(errp, local_err);
2669 goto out;
2672 if (format) {
2673 options = qdict_new();
2674 qdict_put(options, "driver", qstring_from_str(format));
2677 target_bs = NULL;
2678 ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
2679 if (ret < 0) {
2680 error_propagate(errp, local_err);
2681 goto out;
2684 bdrv_set_aio_context(target_bs, aio_context);
2686 if (has_bitmap) {
2687 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
2688 if (!bmap) {
2689 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
2690 goto out;
2694 backup_start(bs, target_bs, speed, sync, bmap,
2695 on_source_error, on_target_error,
2696 block_job_cb, bs, &local_err);
2697 if (local_err != NULL) {
2698 bdrv_unref(target_bs);
2699 error_propagate(errp, local_err);
2700 goto out;
2703 out:
2704 aio_context_release(aio_context);
2707 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2709 return bdrv_named_nodes_list(errp);
2712 void qmp_blockdev_backup(const char *device, const char *target,
2713 enum MirrorSyncMode sync,
2714 bool has_speed, int64_t speed,
2715 bool has_on_source_error,
2716 BlockdevOnError on_source_error,
2717 bool has_on_target_error,
2718 BlockdevOnError on_target_error,
2719 Error **errp)
2721 BlockBackend *blk, *target_blk;
2722 BlockDriverState *bs;
2723 BlockDriverState *target_bs;
2724 Error *local_err = NULL;
2725 AioContext *aio_context;
2727 if (!has_speed) {
2728 speed = 0;
2730 if (!has_on_source_error) {
2731 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2733 if (!has_on_target_error) {
2734 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2737 blk = blk_by_name(device);
2738 if (!blk) {
2739 error_setg(errp, "Device '%s' not found", device);
2740 return;
2743 aio_context = blk_get_aio_context(blk);
2744 aio_context_acquire(aio_context);
2746 if (!blk_is_available(blk)) {
2747 error_setg(errp, "Device '%s' has no medium", device);
2748 goto out;
2750 bs = blk_bs(blk);
2752 target_blk = blk_by_name(target);
2753 if (!target_blk) {
2754 error_setg(errp, "Device '%s' not found", target);
2755 goto out;
2758 if (!blk_is_available(target_blk)) {
2759 error_setg(errp, "Device '%s' has no medium", target);
2760 goto out;
2762 target_bs = blk_bs(target_blk);
2764 bdrv_ref(target_bs);
2765 bdrv_set_aio_context(target_bs, aio_context);
2766 backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
2767 on_target_error, block_job_cb, bs, &local_err);
2768 if (local_err != NULL) {
2769 bdrv_unref(target_bs);
2770 error_propagate(errp, local_err);
2772 out:
2773 aio_context_release(aio_context);
2776 void qmp_drive_mirror(const char *device, const char *target,
2777 bool has_format, const char *format,
2778 bool has_node_name, const char *node_name,
2779 bool has_replaces, const char *replaces,
2780 enum MirrorSyncMode sync,
2781 bool has_mode, enum NewImageMode mode,
2782 bool has_speed, int64_t speed,
2783 bool has_granularity, uint32_t granularity,
2784 bool has_buf_size, int64_t buf_size,
2785 bool has_on_source_error, BlockdevOnError on_source_error,
2786 bool has_on_target_error, BlockdevOnError on_target_error,
2787 bool has_unmap, bool unmap,
2788 Error **errp)
2790 BlockBackend *blk;
2791 BlockDriverState *bs;
2792 BlockDriverState *source, *target_bs;
2793 AioContext *aio_context;
2794 Error *local_err = NULL;
2795 QDict *options;
2796 int flags;
2797 int64_t size;
2798 int ret;
2800 if (!has_speed) {
2801 speed = 0;
2803 if (!has_on_source_error) {
2804 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2806 if (!has_on_target_error) {
2807 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2809 if (!has_mode) {
2810 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2812 if (!has_granularity) {
2813 granularity = 0;
2815 if (!has_buf_size) {
2816 buf_size = 0;
2818 if (!has_unmap) {
2819 unmap = true;
2822 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
2823 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2824 "a value in range [512B, 64MB]");
2825 return;
2827 if (granularity & (granularity - 1)) {
2828 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2829 "power of 2");
2830 return;
2833 blk = blk_by_name(device);
2834 if (!blk) {
2835 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2836 "Device '%s' not found", device);
2837 return;
2840 aio_context = blk_get_aio_context(blk);
2841 aio_context_acquire(aio_context);
2843 if (!blk_is_available(blk)) {
2844 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2845 goto out;
2847 bs = blk_bs(blk);
2849 if (!has_format) {
2850 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2853 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
2854 goto out;
2857 flags = bs->open_flags | BDRV_O_RDWR;
2858 source = backing_bs(bs);
2859 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
2860 sync = MIRROR_SYNC_MODE_FULL;
2862 if (sync == MIRROR_SYNC_MODE_NONE) {
2863 source = bs;
2866 size = bdrv_getlength(bs);
2867 if (size < 0) {
2868 error_setg_errno(errp, -size, "bdrv_getlength failed");
2869 goto out;
2872 if (has_replaces) {
2873 BlockDriverState *to_replace_bs;
2874 AioContext *replace_aio_context;
2875 int64_t replace_size;
2877 if (!has_node_name) {
2878 error_setg(errp, "a node-name must be provided when replacing a"
2879 " named node of the graph");
2880 goto out;
2883 to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
2885 if (!to_replace_bs) {
2886 error_propagate(errp, local_err);
2887 goto out;
2890 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
2891 aio_context_acquire(replace_aio_context);
2892 replace_size = bdrv_getlength(to_replace_bs);
2893 aio_context_release(replace_aio_context);
2895 if (size != replace_size) {
2896 error_setg(errp, "cannot replace image with a mirror image of "
2897 "different size");
2898 goto out;
2902 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
2903 && mode != NEW_IMAGE_MODE_EXISTING)
2905 /* create new image w/o backing file */
2906 assert(format);
2907 bdrv_img_create(target, format,
2908 NULL, NULL, NULL, size, flags, &local_err, false);
2909 } else {
2910 switch (mode) {
2911 case NEW_IMAGE_MODE_EXISTING:
2912 break;
2913 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
2914 /* create new image with backing file */
2915 bdrv_img_create(target, format,
2916 source->filename,
2917 source->drv->format_name,
2918 NULL, size, flags, &local_err, false);
2919 break;
2920 default:
2921 abort();
2925 if (local_err) {
2926 error_propagate(errp, local_err);
2927 goto out;
2930 options = qdict_new();
2931 if (has_node_name) {
2932 qdict_put(options, "node-name", qstring_from_str(node_name));
2934 if (format) {
2935 qdict_put(options, "driver", qstring_from_str(format));
2938 /* Mirroring takes care of copy-on-write using the source's backing
2939 * file.
2941 target_bs = NULL;
2942 ret = bdrv_open(&target_bs, target, NULL, options,
2943 flags | BDRV_O_NO_BACKING, &local_err);
2944 if (ret < 0) {
2945 error_propagate(errp, local_err);
2946 goto out;
2949 bdrv_set_aio_context(target_bs, aio_context);
2951 /* pass the node name to replace to mirror start since it's loose coupling
2952 * and will allow to check whether the node still exist at mirror completion
2954 mirror_start(bs, target_bs,
2955 has_replaces ? replaces : NULL,
2956 speed, granularity, buf_size, sync,
2957 on_source_error, on_target_error,
2958 unmap,
2959 block_job_cb, bs, &local_err);
2960 if (local_err != NULL) {
2961 bdrv_unref(target_bs);
2962 error_propagate(errp, local_err);
2963 goto out;
2966 out:
2967 aio_context_release(aio_context);
2970 /* Get the block job for a given device name and acquire its AioContext */
2971 static BlockJob *find_block_job(const char *device, AioContext **aio_context,
2972 Error **errp)
2974 BlockBackend *blk;
2975 BlockDriverState *bs;
2977 *aio_context = NULL;
2979 blk = blk_by_name(device);
2980 if (!blk) {
2981 goto notfound;
2984 *aio_context = blk_get_aio_context(blk);
2985 aio_context_acquire(*aio_context);
2987 if (!blk_is_available(blk)) {
2988 goto notfound;
2990 bs = blk_bs(blk);
2992 if (!bs->job) {
2993 goto notfound;
2996 return bs->job;
2998 notfound:
2999 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3000 "No active block job on device '%s'", device);
3001 if (*aio_context) {
3002 aio_context_release(*aio_context);
3003 *aio_context = NULL;
3005 return NULL;
3008 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3010 AioContext *aio_context;
3011 BlockJob *job = find_block_job(device, &aio_context, errp);
3013 if (!job) {
3014 return;
3017 block_job_set_speed(job, speed, errp);
3018 aio_context_release(aio_context);
3021 void qmp_block_job_cancel(const char *device,
3022 bool has_force, bool force, Error **errp)
3024 AioContext *aio_context;
3025 BlockJob *job = find_block_job(device, &aio_context, errp);
3027 if (!job) {
3028 return;
3031 if (!has_force) {
3032 force = false;
3035 if (job->user_paused && !force) {
3036 error_setg(errp, "The block job for device '%s' is currently paused",
3037 device);
3038 goto out;
3041 trace_qmp_block_job_cancel(job);
3042 block_job_cancel(job);
3043 out:
3044 aio_context_release(aio_context);
3047 void qmp_block_job_pause(const char *device, Error **errp)
3049 AioContext *aio_context;
3050 BlockJob *job = find_block_job(device, &aio_context, errp);
3052 if (!job || job->user_paused) {
3053 return;
3056 job->user_paused = true;
3057 trace_qmp_block_job_pause(job);
3058 block_job_pause(job);
3059 aio_context_release(aio_context);
3062 void qmp_block_job_resume(const char *device, Error **errp)
3064 AioContext *aio_context;
3065 BlockJob *job = find_block_job(device, &aio_context, errp);
3067 if (!job || !job->user_paused) {
3068 return;
3071 job->user_paused = false;
3072 trace_qmp_block_job_resume(job);
3073 block_job_resume(job);
3074 aio_context_release(aio_context);
3077 void qmp_block_job_complete(const char *device, Error **errp)
3079 AioContext *aio_context;
3080 BlockJob *job = find_block_job(device, &aio_context, errp);
3082 if (!job) {
3083 return;
3086 trace_qmp_block_job_complete(job);
3087 block_job_complete(job, errp);
3088 aio_context_release(aio_context);
3091 void qmp_change_backing_file(const char *device,
3092 const char *image_node_name,
3093 const char *backing_file,
3094 Error **errp)
3096 BlockBackend *blk;
3097 BlockDriverState *bs = NULL;
3098 AioContext *aio_context;
3099 BlockDriverState *image_bs = NULL;
3100 Error *local_err = NULL;
3101 bool ro;
3102 int open_flags;
3103 int ret;
3105 blk = blk_by_name(device);
3106 if (!blk) {
3107 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3108 "Device '%s' not found", device);
3109 return;
3112 aio_context = blk_get_aio_context(blk);
3113 aio_context_acquire(aio_context);
3115 if (!blk_is_available(blk)) {
3116 error_setg(errp, "Device '%s' has no medium", device);
3117 goto out;
3119 bs = blk_bs(blk);
3121 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3122 if (local_err) {
3123 error_propagate(errp, local_err);
3124 goto out;
3127 if (!image_bs) {
3128 error_setg(errp, "image file not found");
3129 goto out;
3132 if (bdrv_find_base(image_bs) == image_bs) {
3133 error_setg(errp, "not allowing backing file change on an image "
3134 "without a backing file");
3135 goto out;
3138 /* even though we are not necessarily operating on bs, we need it to
3139 * determine if block ops are currently prohibited on the chain */
3140 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3141 goto out;
3144 /* final sanity check */
3145 if (!bdrv_chain_contains(bs, image_bs)) {
3146 error_setg(errp, "'%s' and image file are not in the same chain",
3147 device);
3148 goto out;
3151 /* if not r/w, reopen to make r/w */
3152 open_flags = image_bs->open_flags;
3153 ro = bdrv_is_read_only(image_bs);
3155 if (ro) {
3156 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3157 if (local_err) {
3158 error_propagate(errp, local_err);
3159 goto out;
3163 ret = bdrv_change_backing_file(image_bs, backing_file,
3164 image_bs->drv ? image_bs->drv->format_name : "");
3166 if (ret < 0) {
3167 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3168 backing_file);
3169 /* don't exit here, so we can try to restore open flags if
3170 * appropriate */
3173 if (ro) {
3174 bdrv_reopen(image_bs, open_flags, &local_err);
3175 if (local_err) {
3176 error_propagate(errp, local_err); /* will preserve prior errp */
3180 out:
3181 aio_context_release(aio_context);
3184 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3186 QmpOutputVisitor *ov = qmp_output_visitor_new();
3187 BlockDriverState *bs;
3188 BlockBackend *blk = NULL;
3189 QObject *obj;
3190 QDict *qdict;
3191 Error *local_err = NULL;
3193 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3194 * cache.direct=false instead of silently switching to aio=threads, except
3195 * when called from drive_new().
3197 * For now, simply forbidding the combination for all drivers will do. */
3198 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3199 bool direct = options->has_cache &&
3200 options->cache->has_direct &&
3201 options->cache->direct;
3202 if (!direct) {
3203 error_setg(errp, "aio=native requires cache.direct=true");
3204 goto fail;
3208 visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
3209 &options, NULL, &local_err);
3210 if (local_err) {
3211 error_propagate(errp, local_err);
3212 goto fail;
3215 obj = qmp_output_get_qobject(ov);
3216 qdict = qobject_to_qdict(obj);
3218 qdict_flatten(qdict);
3220 if (options->has_id) {
3221 blk = blockdev_init(NULL, qdict, &local_err);
3222 if (local_err) {
3223 error_propagate(errp, local_err);
3224 goto fail;
3227 bs = blk_bs(blk);
3228 } else {
3229 if (!qdict_get_try_str(qdict, "node-name")) {
3230 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3231 "the root node");
3232 goto fail;
3235 bs = bds_tree_init(qdict, errp);
3236 if (!bs) {
3237 goto fail;
3241 if (bs && bdrv_key_required(bs)) {
3242 if (blk) {
3243 blk_unref(blk);
3244 } else {
3245 bdrv_unref(bs);
3247 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3248 goto fail;
3251 fail:
3252 qmp_output_visitor_cleanup(ov);
3255 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3257 BlockJobInfoList *head = NULL, **p_next = &head;
3258 BlockDriverState *bs;
3260 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
3261 AioContext *aio_context = bdrv_get_aio_context(bs);
3263 aio_context_acquire(aio_context);
3265 if (bs->job) {
3266 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
3267 elem->value = block_job_query(bs->job);
3268 *p_next = elem;
3269 p_next = &elem->next;
3272 aio_context_release(aio_context);
3275 return head;
3278 QemuOptsList qemu_common_drive_opts = {
3279 .name = "drive",
3280 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3281 .desc = {
3283 .name = "snapshot",
3284 .type = QEMU_OPT_BOOL,
3285 .help = "enable/disable snapshot mode",
3287 .name = "discard",
3288 .type = QEMU_OPT_STRING,
3289 .help = "discard operation (ignore/off, unmap/on)",
3291 .name = BDRV_OPT_CACHE_WB,
3292 .type = QEMU_OPT_BOOL,
3293 .help = "enables writeback mode for any caches",
3295 .name = BDRV_OPT_CACHE_DIRECT,
3296 .type = QEMU_OPT_BOOL,
3297 .help = "enables use of O_DIRECT (bypass the host page cache)",
3299 .name = BDRV_OPT_CACHE_NO_FLUSH,
3300 .type = QEMU_OPT_BOOL,
3301 .help = "ignore any flush requests for the device",
3303 .name = "aio",
3304 .type = QEMU_OPT_STRING,
3305 .help = "host AIO implementation (threads, native)",
3307 .name = "format",
3308 .type = QEMU_OPT_STRING,
3309 .help = "disk format (raw, qcow2, ...)",
3311 .name = "rerror",
3312 .type = QEMU_OPT_STRING,
3313 .help = "read error action",
3315 .name = "werror",
3316 .type = QEMU_OPT_STRING,
3317 .help = "write error action",
3319 .name = "read-only",
3320 .type = QEMU_OPT_BOOL,
3321 .help = "open drive file as read-only",
3323 .name = "throttling.iops-total",
3324 .type = QEMU_OPT_NUMBER,
3325 .help = "limit total I/O operations per second",
3327 .name = "throttling.iops-read",
3328 .type = QEMU_OPT_NUMBER,
3329 .help = "limit read operations per second",
3331 .name = "throttling.iops-write",
3332 .type = QEMU_OPT_NUMBER,
3333 .help = "limit write operations per second",
3335 .name = "throttling.bps-total",
3336 .type = QEMU_OPT_NUMBER,
3337 .help = "limit total bytes per second",
3339 .name = "throttling.bps-read",
3340 .type = QEMU_OPT_NUMBER,
3341 .help = "limit read bytes per second",
3343 .name = "throttling.bps-write",
3344 .type = QEMU_OPT_NUMBER,
3345 .help = "limit write bytes per second",
3347 .name = "throttling.iops-total-max",
3348 .type = QEMU_OPT_NUMBER,
3349 .help = "I/O operations burst",
3351 .name = "throttling.iops-read-max",
3352 .type = QEMU_OPT_NUMBER,
3353 .help = "I/O operations read burst",
3355 .name = "throttling.iops-write-max",
3356 .type = QEMU_OPT_NUMBER,
3357 .help = "I/O operations write burst",
3359 .name = "throttling.bps-total-max",
3360 .type = QEMU_OPT_NUMBER,
3361 .help = "total bytes burst",
3363 .name = "throttling.bps-read-max",
3364 .type = QEMU_OPT_NUMBER,
3365 .help = "total bytes read burst",
3367 .name = "throttling.bps-write-max",
3368 .type = QEMU_OPT_NUMBER,
3369 .help = "total bytes write burst",
3371 .name = "throttling.iops-size",
3372 .type = QEMU_OPT_NUMBER,
3373 .help = "when limiting by iops max size of an I/O in bytes",
3375 .name = "throttling.group",
3376 .type = QEMU_OPT_STRING,
3377 .help = "name of the block throttling group",
3379 .name = "copy-on-read",
3380 .type = QEMU_OPT_BOOL,
3381 .help = "copy read data from backing file into image file",
3383 .name = "detect-zeroes",
3384 .type = QEMU_OPT_STRING,
3385 .help = "try to optimize zero writes (off, on, unmap)",
3387 { /* end of list */ }
3391 static QemuOptsList qemu_root_bds_opts = {
3392 .name = "root-bds",
3393 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3394 .desc = {
3396 .name = "discard",
3397 .type = QEMU_OPT_STRING,
3398 .help = "discard operation (ignore/off, unmap/on)",
3400 .name = "cache.writeback",
3401 .type = QEMU_OPT_BOOL,
3402 .help = "enables writeback mode for any caches",
3404 .name = "cache.direct",
3405 .type = QEMU_OPT_BOOL,
3406 .help = "enables use of O_DIRECT (bypass the host page cache)",
3408 .name = "cache.no-flush",
3409 .type = QEMU_OPT_BOOL,
3410 .help = "ignore any flush requests for the device",
3412 .name = "aio",
3413 .type = QEMU_OPT_STRING,
3414 .help = "host AIO implementation (threads, native)",
3416 .name = "read-only",
3417 .type = QEMU_OPT_BOOL,
3418 .help = "open drive file as read-only",
3420 .name = "copy-on-read",
3421 .type = QEMU_OPT_BOOL,
3422 .help = "copy read data from backing file into image file",
3424 .name = "detect-zeroes",
3425 .type = QEMU_OPT_STRING,
3426 .help = "try to optimize zero writes (off, on, unmap)",
3428 { /* end of list */ }
3432 QemuOptsList qemu_drive_opts = {
3433 .name = "drive",
3434 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3435 .desc = {
3437 * no elements => accept any params
3438 * validation will happen later
3440 { /* end of list */ }