block: Add "drained begin/end" for transactional blockdev-backup
[qemu/ar7.git] / blockdev.c
blob52f44b2867695a03fe5a830d63a1f1efebb0f63b
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 if (!blk_is_available(blk)) {
1688 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1689 return;
1692 /* AioContext is released in .clean() */
1693 state->aio_context = blk_get_aio_context(blk);
1694 aio_context_acquire(state->aio_context);
1695 bdrv_drained_begin(blk_bs(blk));
1696 state->bs = blk_bs(blk);
1698 qmp_drive_backup(backup->device, backup->target,
1699 backup->has_format, backup->format,
1700 backup->sync,
1701 backup->has_mode, backup->mode,
1702 backup->has_speed, backup->speed,
1703 backup->has_bitmap, backup->bitmap,
1704 backup->has_on_source_error, backup->on_source_error,
1705 backup->has_on_target_error, backup->on_target_error,
1706 &local_err);
1707 if (local_err) {
1708 error_propagate(errp, local_err);
1709 return;
1712 state->job = state->bs->job;
1715 static void drive_backup_abort(BlkTransactionState *common)
1717 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1718 BlockDriverState *bs = state->bs;
1720 /* Only cancel if it's the job we started */
1721 if (bs && bs->job && bs->job == state->job) {
1722 block_job_cancel_sync(bs->job);
1726 static void drive_backup_clean(BlkTransactionState *common)
1728 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1730 if (state->aio_context) {
1731 bdrv_drained_end(state->bs);
1732 aio_context_release(state->aio_context);
1736 typedef struct BlockdevBackupState {
1737 BlkTransactionState common;
1738 BlockDriverState *bs;
1739 BlockJob *job;
1740 AioContext *aio_context;
1741 } BlockdevBackupState;
1743 static void blockdev_backup_prepare(BlkTransactionState *common, Error **errp)
1745 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1746 BlockdevBackup *backup;
1747 BlockBackend *blk, *target;
1748 Error *local_err = NULL;
1750 assert(common->action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1751 backup = common->action->blockdev_backup;
1753 blk = blk_by_name(backup->device);
1754 if (!blk) {
1755 error_setg(errp, "Device '%s' not found", backup->device);
1756 return;
1759 if (!blk_is_available(blk)) {
1760 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1761 return;
1764 target = blk_by_name(backup->target);
1765 if (!target) {
1766 error_setg(errp, "Device '%s' not found", backup->target);
1767 return;
1770 /* AioContext is released in .clean() */
1771 state->aio_context = blk_get_aio_context(blk);
1772 if (state->aio_context != blk_get_aio_context(target)) {
1773 state->aio_context = NULL;
1774 error_setg(errp, "Backup between two IO threads is not implemented");
1775 return;
1777 aio_context_acquire(state->aio_context);
1778 state->bs = blk_bs(blk);
1779 bdrv_drained_begin(state->bs);
1781 qmp_blockdev_backup(backup->device, backup->target,
1782 backup->sync,
1783 backup->has_speed, backup->speed,
1784 backup->has_on_source_error, backup->on_source_error,
1785 backup->has_on_target_error, backup->on_target_error,
1786 &local_err);
1787 if (local_err) {
1788 error_propagate(errp, local_err);
1789 return;
1792 state->job = state->bs->job;
1795 static void blockdev_backup_abort(BlkTransactionState *common)
1797 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1798 BlockDriverState *bs = state->bs;
1800 /* Only cancel if it's the job we started */
1801 if (bs && bs->job && bs->job == state->job) {
1802 block_job_cancel_sync(bs->job);
1806 static void blockdev_backup_clean(BlkTransactionState *common)
1808 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1810 if (state->aio_context) {
1811 bdrv_drained_end(state->bs);
1812 aio_context_release(state->aio_context);
1816 static void abort_prepare(BlkTransactionState *common, Error **errp)
1818 error_setg(errp, "Transaction aborted using Abort action");
1821 static void abort_commit(BlkTransactionState *common)
1823 g_assert_not_reached(); /* this action never succeeds */
1826 static const BdrvActionOps actions[] = {
1827 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1828 .instance_size = sizeof(ExternalSnapshotState),
1829 .prepare = external_snapshot_prepare,
1830 .commit = external_snapshot_commit,
1831 .abort = external_snapshot_abort,
1832 .clean = external_snapshot_clean,
1834 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1835 .instance_size = sizeof(DriveBackupState),
1836 .prepare = drive_backup_prepare,
1837 .abort = drive_backup_abort,
1838 .clean = drive_backup_clean,
1840 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
1841 .instance_size = sizeof(BlockdevBackupState),
1842 .prepare = blockdev_backup_prepare,
1843 .abort = blockdev_backup_abort,
1844 .clean = blockdev_backup_clean,
1846 [TRANSACTION_ACTION_KIND_ABORT] = {
1847 .instance_size = sizeof(BlkTransactionState),
1848 .prepare = abort_prepare,
1849 .commit = abort_commit,
1851 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1852 .instance_size = sizeof(InternalSnapshotState),
1853 .prepare = internal_snapshot_prepare,
1854 .abort = internal_snapshot_abort,
1855 .clean = internal_snapshot_clean,
1860 * 'Atomic' group operations. The operations are performed as a set, and if
1861 * any fail then we roll back all operations in the group.
1863 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1865 TransactionActionList *dev_entry = dev_list;
1866 BlkTransactionState *state, *next;
1867 Error *local_err = NULL;
1869 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1870 QSIMPLEQ_INIT(&snap_bdrv_states);
1872 /* drain all i/o before any operations */
1873 bdrv_drain_all();
1875 /* We don't do anything in this loop that commits us to the operations */
1876 while (NULL != dev_entry) {
1877 TransactionAction *dev_info = NULL;
1878 const BdrvActionOps *ops;
1880 dev_info = dev_entry->value;
1881 dev_entry = dev_entry->next;
1883 assert(dev_info->kind < ARRAY_SIZE(actions));
1885 ops = &actions[dev_info->kind];
1886 assert(ops->instance_size > 0);
1888 state = g_malloc0(ops->instance_size);
1889 state->ops = ops;
1890 state->action = dev_info;
1891 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1893 state->ops->prepare(state, &local_err);
1894 if (local_err) {
1895 error_propagate(errp, local_err);
1896 goto delete_and_fail;
1900 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1901 if (state->ops->commit) {
1902 state->ops->commit(state);
1906 /* success */
1907 goto exit;
1909 delete_and_fail:
1910 /* failure, and it is all-or-none; roll back all operations */
1911 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1912 if (state->ops->abort) {
1913 state->ops->abort(state);
1916 exit:
1917 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1918 if (state->ops->clean) {
1919 state->ops->clean(state);
1921 g_free(state);
1926 static void eject_device(BlockBackend *blk, int force, Error **errp)
1928 BlockDriverState *bs = blk_bs(blk);
1929 AioContext *aio_context;
1931 if (!bs) {
1932 /* No medium inserted, so there is nothing to do */
1933 return;
1936 aio_context = bdrv_get_aio_context(bs);
1937 aio_context_acquire(aio_context);
1939 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1940 goto out;
1942 if (!blk_dev_has_removable_media(blk)) {
1943 error_setg(errp, "Device '%s' is not removable",
1944 bdrv_get_device_name(bs));
1945 goto out;
1948 if (blk_dev_is_medium_locked(blk) && !blk_dev_is_tray_open(blk)) {
1949 blk_dev_eject_request(blk, force);
1950 if (!force) {
1951 error_setg(errp, "Device '%s' is locked",
1952 bdrv_get_device_name(bs));
1953 goto out;
1957 bdrv_close(bs);
1959 out:
1960 aio_context_release(aio_context);
1963 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1965 BlockBackend *blk;
1967 blk = blk_by_name(device);
1968 if (!blk) {
1969 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1970 "Device '%s' not found", device);
1971 return;
1974 eject_device(blk, force, errp);
1977 void qmp_block_passwd(bool has_device, const char *device,
1978 bool has_node_name, const char *node_name,
1979 const char *password, Error **errp)
1981 Error *local_err = NULL;
1982 BlockDriverState *bs;
1983 AioContext *aio_context;
1985 bs = bdrv_lookup_bs(has_device ? device : NULL,
1986 has_node_name ? node_name : NULL,
1987 &local_err);
1988 if (local_err) {
1989 error_propagate(errp, local_err);
1990 return;
1993 aio_context = bdrv_get_aio_context(bs);
1994 aio_context_acquire(aio_context);
1996 bdrv_add_key(bs, password, errp);
1998 aio_context_release(aio_context);
2001 /* Assumes AioContext is held */
2002 static void qmp_bdrv_open_encrypted(BlockDriverState **pbs,
2003 const char *filename,
2004 int bdrv_flags, const char *format,
2005 const char *password, Error **errp)
2007 Error *local_err = NULL;
2008 QDict *options = NULL;
2009 int ret;
2011 if (format) {
2012 options = qdict_new();
2013 qdict_put(options, "driver", qstring_from_str(format));
2016 ret = bdrv_open(pbs, filename, NULL, options, bdrv_flags, &local_err);
2017 if (ret < 0) {
2018 error_propagate(errp, local_err);
2019 return;
2022 bdrv_add_key(*pbs, password, errp);
2025 void qmp_change_blockdev(const char *device, const char *filename,
2026 const char *format, Error **errp)
2028 BlockBackend *blk;
2029 BlockDriverState *bs;
2030 AioContext *aio_context;
2031 int bdrv_flags;
2032 bool new_bs;
2033 Error *err = NULL;
2035 blk = blk_by_name(device);
2036 if (!blk) {
2037 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2038 "Device '%s' not found", device);
2039 return;
2041 bs = blk_bs(blk);
2042 new_bs = !bs;
2044 aio_context = blk_get_aio_context(blk);
2045 aio_context_acquire(aio_context);
2047 eject_device(blk, 0, &err);
2048 if (err) {
2049 error_propagate(errp, err);
2050 goto out;
2053 bdrv_flags = blk_is_read_only(blk) ? 0 : BDRV_O_RDWR;
2054 bdrv_flags |= blk_get_root_state(blk)->open_flags & ~BDRV_O_RDWR;
2056 qmp_bdrv_open_encrypted(&bs, filename, bdrv_flags, format, NULL, &err);
2057 if (err) {
2058 error_propagate(errp, err);
2059 goto out;
2062 if (new_bs) {
2063 blk_insert_bs(blk, bs);
2064 /* Has been sent automatically by bdrv_open() if blk_bs(blk) was not
2065 * NULL */
2066 blk_dev_change_media_cb(blk, true);
2069 out:
2070 aio_context_release(aio_context);
2073 /* throttling disk I/O limits */
2074 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2075 int64_t bps_wr,
2076 int64_t iops,
2077 int64_t iops_rd,
2078 int64_t iops_wr,
2079 bool has_bps_max,
2080 int64_t bps_max,
2081 bool has_bps_rd_max,
2082 int64_t bps_rd_max,
2083 bool has_bps_wr_max,
2084 int64_t bps_wr_max,
2085 bool has_iops_max,
2086 int64_t iops_max,
2087 bool has_iops_rd_max,
2088 int64_t iops_rd_max,
2089 bool has_iops_wr_max,
2090 int64_t iops_wr_max,
2091 bool has_iops_size,
2092 int64_t iops_size,
2093 bool has_group,
2094 const char *group, Error **errp)
2096 ThrottleConfig cfg;
2097 BlockDriverState *bs;
2098 BlockBackend *blk;
2099 AioContext *aio_context;
2101 blk = blk_by_name(device);
2102 if (!blk) {
2103 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2104 "Device '%s' not found", device);
2105 return;
2108 aio_context = blk_get_aio_context(blk);
2109 aio_context_acquire(aio_context);
2111 bs = blk_bs(blk);
2112 if (!bs) {
2113 error_setg(errp, "Device '%s' has no medium", device);
2114 goto out;
2117 memset(&cfg, 0, sizeof(cfg));
2118 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
2119 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
2120 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
2122 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
2123 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
2124 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
2126 if (has_bps_max) {
2127 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
2129 if (has_bps_rd_max) {
2130 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
2132 if (has_bps_wr_max) {
2133 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
2135 if (has_iops_max) {
2136 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
2138 if (has_iops_rd_max) {
2139 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
2141 if (has_iops_wr_max) {
2142 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
2145 if (has_iops_size) {
2146 cfg.op_size = iops_size;
2149 if (!check_throttle_config(&cfg, errp)) {
2150 goto out;
2153 if (throttle_enabled(&cfg)) {
2154 /* Enable I/O limits if they're not enabled yet, otherwise
2155 * just update the throttling group. */
2156 if (!bs->io_limits_enabled) {
2157 bdrv_io_limits_enable(bs, has_group ? group : device);
2158 } else if (has_group) {
2159 bdrv_io_limits_update_group(bs, group);
2161 /* Set the new throttling configuration */
2162 bdrv_set_io_limits(bs, &cfg);
2163 } else if (bs->io_limits_enabled) {
2164 /* If all throttling settings are set to 0, disable I/O limits */
2165 bdrv_io_limits_disable(bs);
2168 out:
2169 aio_context_release(aio_context);
2172 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2173 bool has_granularity, uint32_t granularity,
2174 Error **errp)
2176 AioContext *aio_context;
2177 BlockDriverState *bs;
2179 if (!name || name[0] == '\0') {
2180 error_setg(errp, "Bitmap name cannot be empty");
2181 return;
2184 bs = bdrv_lookup_bs(node, node, errp);
2185 if (!bs) {
2186 return;
2189 aio_context = bdrv_get_aio_context(bs);
2190 aio_context_acquire(aio_context);
2192 if (has_granularity) {
2193 if (granularity < 512 || !is_power_of_2(granularity)) {
2194 error_setg(errp, "Granularity must be power of 2 "
2195 "and at least 512");
2196 goto out;
2198 } else {
2199 /* Default to cluster size, if available: */
2200 granularity = bdrv_get_default_bitmap_granularity(bs);
2203 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2205 out:
2206 aio_context_release(aio_context);
2209 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2210 Error **errp)
2212 AioContext *aio_context;
2213 BlockDriverState *bs;
2214 BdrvDirtyBitmap *bitmap;
2216 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2217 if (!bitmap || !bs) {
2218 return;
2221 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2222 error_setg(errp,
2223 "Bitmap '%s' is currently frozen and cannot be removed",
2224 name);
2225 goto out;
2227 bdrv_dirty_bitmap_make_anon(bitmap);
2228 bdrv_release_dirty_bitmap(bs, bitmap);
2230 out:
2231 aio_context_release(aio_context);
2235 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2236 * immediately after a full backup operation.
2238 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2239 Error **errp)
2241 AioContext *aio_context;
2242 BdrvDirtyBitmap *bitmap;
2243 BlockDriverState *bs;
2245 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2246 if (!bitmap || !bs) {
2247 return;
2250 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2251 error_setg(errp,
2252 "Bitmap '%s' is currently frozen and cannot be modified",
2253 name);
2254 goto out;
2255 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2256 error_setg(errp,
2257 "Bitmap '%s' is currently disabled and cannot be cleared",
2258 name);
2259 goto out;
2262 bdrv_clear_dirty_bitmap(bitmap);
2264 out:
2265 aio_context_release(aio_context);
2268 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2270 const char *id = qdict_get_str(qdict, "id");
2271 BlockBackend *blk;
2272 BlockDriverState *bs;
2273 AioContext *aio_context;
2274 Error *local_err = NULL;
2276 blk = blk_by_name(id);
2277 if (!blk) {
2278 error_report("Device '%s' not found", id);
2279 return;
2282 if (!blk_legacy_dinfo(blk)) {
2283 error_report("Deleting device added with blockdev-add"
2284 " is not supported");
2285 return;
2288 aio_context = blk_get_aio_context(blk);
2289 aio_context_acquire(aio_context);
2291 bs = blk_bs(blk);
2292 if (bs) {
2293 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2294 error_report_err(local_err);
2295 aio_context_release(aio_context);
2296 return;
2299 bdrv_close(bs);
2302 /* if we have a device attached to this BlockDriverState
2303 * then we need to make the drive anonymous until the device
2304 * can be removed. If this is a drive with no device backing
2305 * then we can just get rid of the block driver state right here.
2307 if (blk_get_attached_dev(blk)) {
2308 blk_hide_on_behalf_of_hmp_drive_del(blk);
2309 /* Further I/O must not pause the guest */
2310 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2311 BLOCKDEV_ON_ERROR_REPORT);
2312 } else {
2313 blk_unref(blk);
2316 aio_context_release(aio_context);
2319 void qmp_block_resize(bool has_device, const char *device,
2320 bool has_node_name, const char *node_name,
2321 int64_t size, Error **errp)
2323 Error *local_err = NULL;
2324 BlockDriverState *bs;
2325 AioContext *aio_context;
2326 int ret;
2328 bs = bdrv_lookup_bs(has_device ? device : NULL,
2329 has_node_name ? node_name : NULL,
2330 &local_err);
2331 if (local_err) {
2332 error_propagate(errp, local_err);
2333 return;
2336 aio_context = bdrv_get_aio_context(bs);
2337 aio_context_acquire(aio_context);
2339 if (!bdrv_is_first_non_filter(bs)) {
2340 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2341 goto out;
2344 if (size < 0) {
2345 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2346 goto out;
2349 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2350 error_setg(errp, QERR_DEVICE_IN_USE, device);
2351 goto out;
2354 /* complete all in-flight operations before resizing the device */
2355 bdrv_drain_all();
2357 ret = bdrv_truncate(bs, size);
2358 switch (ret) {
2359 case 0:
2360 break;
2361 case -ENOMEDIUM:
2362 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2363 break;
2364 case -ENOTSUP:
2365 error_setg(errp, QERR_UNSUPPORTED);
2366 break;
2367 case -EACCES:
2368 error_setg(errp, "Device '%s' is read only", device);
2369 break;
2370 case -EBUSY:
2371 error_setg(errp, QERR_DEVICE_IN_USE, device);
2372 break;
2373 default:
2374 error_setg_errno(errp, -ret, "Could not resize");
2375 break;
2378 out:
2379 aio_context_release(aio_context);
2382 static void block_job_cb(void *opaque, int ret)
2384 /* Note that this function may be executed from another AioContext besides
2385 * the QEMU main loop. If you need to access anything that assumes the
2386 * QEMU global mutex, use a BH or introduce a mutex.
2389 BlockDriverState *bs = opaque;
2390 const char *msg = NULL;
2392 trace_block_job_cb(bs, bs->job, ret);
2394 assert(bs->job);
2396 if (ret < 0) {
2397 msg = strerror(-ret);
2400 if (block_job_is_cancelled(bs->job)) {
2401 block_job_event_cancelled(bs->job);
2402 } else {
2403 block_job_event_completed(bs->job, msg);
2406 bdrv_put_ref_bh_schedule(bs);
2409 void qmp_block_stream(const char *device,
2410 bool has_base, const char *base,
2411 bool has_backing_file, const char *backing_file,
2412 bool has_speed, int64_t speed,
2413 bool has_on_error, BlockdevOnError on_error,
2414 Error **errp)
2416 BlockBackend *blk;
2417 BlockDriverState *bs;
2418 BlockDriverState *base_bs = NULL;
2419 AioContext *aio_context;
2420 Error *local_err = NULL;
2421 const char *base_name = NULL;
2423 if (!has_on_error) {
2424 on_error = BLOCKDEV_ON_ERROR_REPORT;
2427 blk = blk_by_name(device);
2428 if (!blk) {
2429 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2430 "Device '%s' not found", device);
2431 return;
2434 aio_context = blk_get_aio_context(blk);
2435 aio_context_acquire(aio_context);
2437 if (!blk_is_available(blk)) {
2438 error_setg(errp, "Device '%s' has no medium", device);
2439 goto out;
2441 bs = blk_bs(blk);
2443 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2444 goto out;
2447 if (has_base) {
2448 base_bs = bdrv_find_backing_image(bs, base);
2449 if (base_bs == NULL) {
2450 error_setg(errp, QERR_BASE_NOT_FOUND, base);
2451 goto out;
2453 assert(bdrv_get_aio_context(base_bs) == aio_context);
2454 base_name = base;
2457 /* if we are streaming the entire chain, the result will have no backing
2458 * file, and specifying one is therefore an error */
2459 if (base_bs == NULL && has_backing_file) {
2460 error_setg(errp, "backing file specified, but streaming the "
2461 "entire chain");
2462 goto out;
2465 /* backing_file string overrides base bs filename */
2466 base_name = has_backing_file ? backing_file : base_name;
2468 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
2469 on_error, block_job_cb, bs, &local_err);
2470 if (local_err) {
2471 error_propagate(errp, local_err);
2472 goto out;
2475 trace_qmp_block_stream(bs, bs->job);
2477 out:
2478 aio_context_release(aio_context);
2481 void qmp_block_commit(const char *device,
2482 bool has_base, const char *base,
2483 bool has_top, const char *top,
2484 bool has_backing_file, const char *backing_file,
2485 bool has_speed, int64_t speed,
2486 Error **errp)
2488 BlockBackend *blk;
2489 BlockDriverState *bs;
2490 BlockDriverState *base_bs, *top_bs;
2491 AioContext *aio_context;
2492 Error *local_err = NULL;
2493 /* This will be part of the QMP command, if/when the
2494 * BlockdevOnError change for blkmirror makes it in
2496 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
2498 if (!has_speed) {
2499 speed = 0;
2502 /* Important Note:
2503 * libvirt relies on the DeviceNotFound error class in order to probe for
2504 * live commit feature versions; for this to work, we must make sure to
2505 * perform the device lookup before any generic errors that may occur in a
2506 * scenario in which all optional arguments are omitted. */
2507 blk = blk_by_name(device);
2508 if (!blk) {
2509 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2510 "Device '%s' not found", device);
2511 return;
2514 aio_context = blk_get_aio_context(blk);
2515 aio_context_acquire(aio_context);
2517 if (!blk_is_available(blk)) {
2518 error_setg(errp, "Device '%s' has no medium", device);
2519 goto out;
2521 bs = blk_bs(blk);
2523 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2524 goto out;
2527 /* default top_bs is the active layer */
2528 top_bs = bs;
2530 if (has_top && top) {
2531 if (strcmp(bs->filename, top) != 0) {
2532 top_bs = bdrv_find_backing_image(bs, top);
2536 if (top_bs == NULL) {
2537 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2538 goto out;
2541 assert(bdrv_get_aio_context(top_bs) == aio_context);
2543 if (has_base && base) {
2544 base_bs = bdrv_find_backing_image(top_bs, base);
2545 } else {
2546 base_bs = bdrv_find_base(top_bs);
2549 if (base_bs == NULL) {
2550 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
2551 goto out;
2554 assert(bdrv_get_aio_context(base_bs) == aio_context);
2556 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2557 goto out;
2560 /* Do not allow attempts to commit an image into itself */
2561 if (top_bs == base_bs) {
2562 error_setg(errp, "cannot commit an image into itself");
2563 goto out;
2566 if (top_bs == bs) {
2567 if (has_backing_file) {
2568 error_setg(errp, "'backing-file' specified,"
2569 " but 'top' is the active layer");
2570 goto out;
2572 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2573 bs, &local_err);
2574 } else {
2575 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
2576 has_backing_file ? backing_file : NULL, &local_err);
2578 if (local_err != NULL) {
2579 error_propagate(errp, local_err);
2580 goto out;
2583 out:
2584 aio_context_release(aio_context);
2587 void qmp_drive_backup(const char *device, const char *target,
2588 bool has_format, const char *format,
2589 enum MirrorSyncMode sync,
2590 bool has_mode, enum NewImageMode mode,
2591 bool has_speed, int64_t speed,
2592 bool has_bitmap, const char *bitmap,
2593 bool has_on_source_error, BlockdevOnError on_source_error,
2594 bool has_on_target_error, BlockdevOnError on_target_error,
2595 Error **errp)
2597 BlockBackend *blk;
2598 BlockDriverState *bs;
2599 BlockDriverState *target_bs;
2600 BlockDriverState *source = NULL;
2601 BdrvDirtyBitmap *bmap = NULL;
2602 AioContext *aio_context;
2603 QDict *options = NULL;
2604 Error *local_err = NULL;
2605 int flags;
2606 int64_t size;
2607 int ret;
2609 if (!has_speed) {
2610 speed = 0;
2612 if (!has_on_source_error) {
2613 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2615 if (!has_on_target_error) {
2616 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2618 if (!has_mode) {
2619 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2622 blk = blk_by_name(device);
2623 if (!blk) {
2624 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2625 "Device '%s' not found", device);
2626 return;
2629 aio_context = blk_get_aio_context(blk);
2630 aio_context_acquire(aio_context);
2632 /* Although backup_run has this check too, we need to use bs->drv below, so
2633 * do an early check redundantly. */
2634 if (!blk_is_available(blk)) {
2635 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2636 goto out;
2638 bs = blk_bs(blk);
2640 if (!has_format) {
2641 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2644 /* Early check to avoid creating target */
2645 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2646 goto out;
2649 flags = bs->open_flags | BDRV_O_RDWR;
2651 /* See if we have a backing HD we can use to create our new image
2652 * on top of. */
2653 if (sync == MIRROR_SYNC_MODE_TOP) {
2654 source = backing_bs(bs);
2655 if (!source) {
2656 sync = MIRROR_SYNC_MODE_FULL;
2659 if (sync == MIRROR_SYNC_MODE_NONE) {
2660 source = bs;
2663 size = bdrv_getlength(bs);
2664 if (size < 0) {
2665 error_setg_errno(errp, -size, "bdrv_getlength failed");
2666 goto out;
2669 if (mode != NEW_IMAGE_MODE_EXISTING) {
2670 assert(format);
2671 if (source) {
2672 bdrv_img_create(target, format, source->filename,
2673 source->drv->format_name, NULL,
2674 size, flags, &local_err, false);
2675 } else {
2676 bdrv_img_create(target, format, NULL, NULL, NULL,
2677 size, flags, &local_err, false);
2681 if (local_err) {
2682 error_propagate(errp, local_err);
2683 goto out;
2686 if (format) {
2687 options = qdict_new();
2688 qdict_put(options, "driver", qstring_from_str(format));
2691 target_bs = NULL;
2692 ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
2693 if (ret < 0) {
2694 error_propagate(errp, local_err);
2695 goto out;
2698 bdrv_set_aio_context(target_bs, aio_context);
2700 if (has_bitmap) {
2701 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
2702 if (!bmap) {
2703 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
2704 goto out;
2708 backup_start(bs, target_bs, speed, sync, bmap,
2709 on_source_error, on_target_error,
2710 block_job_cb, bs, &local_err);
2711 if (local_err != NULL) {
2712 bdrv_unref(target_bs);
2713 error_propagate(errp, local_err);
2714 goto out;
2717 out:
2718 aio_context_release(aio_context);
2721 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2723 return bdrv_named_nodes_list(errp);
2726 void qmp_blockdev_backup(const char *device, const char *target,
2727 enum MirrorSyncMode sync,
2728 bool has_speed, int64_t speed,
2729 bool has_on_source_error,
2730 BlockdevOnError on_source_error,
2731 bool has_on_target_error,
2732 BlockdevOnError on_target_error,
2733 Error **errp)
2735 BlockBackend *blk, *target_blk;
2736 BlockDriverState *bs;
2737 BlockDriverState *target_bs;
2738 Error *local_err = NULL;
2739 AioContext *aio_context;
2741 if (!has_speed) {
2742 speed = 0;
2744 if (!has_on_source_error) {
2745 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2747 if (!has_on_target_error) {
2748 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2751 blk = blk_by_name(device);
2752 if (!blk) {
2753 error_setg(errp, "Device '%s' not found", device);
2754 return;
2757 aio_context = blk_get_aio_context(blk);
2758 aio_context_acquire(aio_context);
2760 if (!blk_is_available(blk)) {
2761 error_setg(errp, "Device '%s' has no medium", device);
2762 goto out;
2764 bs = blk_bs(blk);
2766 target_blk = blk_by_name(target);
2767 if (!target_blk) {
2768 error_setg(errp, "Device '%s' not found", target);
2769 goto out;
2772 if (!blk_is_available(target_blk)) {
2773 error_setg(errp, "Device '%s' has no medium", target);
2774 goto out;
2776 target_bs = blk_bs(target_blk);
2778 bdrv_ref(target_bs);
2779 bdrv_set_aio_context(target_bs, aio_context);
2780 backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
2781 on_target_error, block_job_cb, bs, &local_err);
2782 if (local_err != NULL) {
2783 bdrv_unref(target_bs);
2784 error_propagate(errp, local_err);
2786 out:
2787 aio_context_release(aio_context);
2790 void qmp_drive_mirror(const char *device, const char *target,
2791 bool has_format, const char *format,
2792 bool has_node_name, const char *node_name,
2793 bool has_replaces, const char *replaces,
2794 enum MirrorSyncMode sync,
2795 bool has_mode, enum NewImageMode mode,
2796 bool has_speed, int64_t speed,
2797 bool has_granularity, uint32_t granularity,
2798 bool has_buf_size, int64_t buf_size,
2799 bool has_on_source_error, BlockdevOnError on_source_error,
2800 bool has_on_target_error, BlockdevOnError on_target_error,
2801 bool has_unmap, bool unmap,
2802 Error **errp)
2804 BlockBackend *blk;
2805 BlockDriverState *bs;
2806 BlockDriverState *source, *target_bs;
2807 AioContext *aio_context;
2808 Error *local_err = NULL;
2809 QDict *options;
2810 int flags;
2811 int64_t size;
2812 int ret;
2814 if (!has_speed) {
2815 speed = 0;
2817 if (!has_on_source_error) {
2818 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2820 if (!has_on_target_error) {
2821 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2823 if (!has_mode) {
2824 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2826 if (!has_granularity) {
2827 granularity = 0;
2829 if (!has_buf_size) {
2830 buf_size = 0;
2832 if (!has_unmap) {
2833 unmap = true;
2836 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
2837 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2838 "a value in range [512B, 64MB]");
2839 return;
2841 if (granularity & (granularity - 1)) {
2842 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2843 "power of 2");
2844 return;
2847 blk = blk_by_name(device);
2848 if (!blk) {
2849 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2850 "Device '%s' not found", device);
2851 return;
2854 aio_context = blk_get_aio_context(blk);
2855 aio_context_acquire(aio_context);
2857 if (!blk_is_available(blk)) {
2858 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2859 goto out;
2861 bs = blk_bs(blk);
2863 if (!has_format) {
2864 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2867 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
2868 goto out;
2871 flags = bs->open_flags | BDRV_O_RDWR;
2872 source = backing_bs(bs);
2873 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
2874 sync = MIRROR_SYNC_MODE_FULL;
2876 if (sync == MIRROR_SYNC_MODE_NONE) {
2877 source = bs;
2880 size = bdrv_getlength(bs);
2881 if (size < 0) {
2882 error_setg_errno(errp, -size, "bdrv_getlength failed");
2883 goto out;
2886 if (has_replaces) {
2887 BlockDriverState *to_replace_bs;
2888 AioContext *replace_aio_context;
2889 int64_t replace_size;
2891 if (!has_node_name) {
2892 error_setg(errp, "a node-name must be provided when replacing a"
2893 " named node of the graph");
2894 goto out;
2897 to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
2899 if (!to_replace_bs) {
2900 error_propagate(errp, local_err);
2901 goto out;
2904 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
2905 aio_context_acquire(replace_aio_context);
2906 replace_size = bdrv_getlength(to_replace_bs);
2907 aio_context_release(replace_aio_context);
2909 if (size != replace_size) {
2910 error_setg(errp, "cannot replace image with a mirror image of "
2911 "different size");
2912 goto out;
2916 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
2917 && mode != NEW_IMAGE_MODE_EXISTING)
2919 /* create new image w/o backing file */
2920 assert(format);
2921 bdrv_img_create(target, format,
2922 NULL, NULL, NULL, size, flags, &local_err, false);
2923 } else {
2924 switch (mode) {
2925 case NEW_IMAGE_MODE_EXISTING:
2926 break;
2927 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
2928 /* create new image with backing file */
2929 bdrv_img_create(target, format,
2930 source->filename,
2931 source->drv->format_name,
2932 NULL, size, flags, &local_err, false);
2933 break;
2934 default:
2935 abort();
2939 if (local_err) {
2940 error_propagate(errp, local_err);
2941 goto out;
2944 options = qdict_new();
2945 if (has_node_name) {
2946 qdict_put(options, "node-name", qstring_from_str(node_name));
2948 if (format) {
2949 qdict_put(options, "driver", qstring_from_str(format));
2952 /* Mirroring takes care of copy-on-write using the source's backing
2953 * file.
2955 target_bs = NULL;
2956 ret = bdrv_open(&target_bs, target, NULL, options,
2957 flags | BDRV_O_NO_BACKING, &local_err);
2958 if (ret < 0) {
2959 error_propagate(errp, local_err);
2960 goto out;
2963 bdrv_set_aio_context(target_bs, aio_context);
2965 /* pass the node name to replace to mirror start since it's loose coupling
2966 * and will allow to check whether the node still exist at mirror completion
2968 mirror_start(bs, target_bs,
2969 has_replaces ? replaces : NULL,
2970 speed, granularity, buf_size, sync,
2971 on_source_error, on_target_error,
2972 unmap,
2973 block_job_cb, bs, &local_err);
2974 if (local_err != NULL) {
2975 bdrv_unref(target_bs);
2976 error_propagate(errp, local_err);
2977 goto out;
2980 out:
2981 aio_context_release(aio_context);
2984 /* Get the block job for a given device name and acquire its AioContext */
2985 static BlockJob *find_block_job(const char *device, AioContext **aio_context,
2986 Error **errp)
2988 BlockBackend *blk;
2989 BlockDriverState *bs;
2991 *aio_context = NULL;
2993 blk = blk_by_name(device);
2994 if (!blk) {
2995 goto notfound;
2998 *aio_context = blk_get_aio_context(blk);
2999 aio_context_acquire(*aio_context);
3001 if (!blk_is_available(blk)) {
3002 goto notfound;
3004 bs = blk_bs(blk);
3006 if (!bs->job) {
3007 goto notfound;
3010 return bs->job;
3012 notfound:
3013 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3014 "No active block job on device '%s'", device);
3015 if (*aio_context) {
3016 aio_context_release(*aio_context);
3017 *aio_context = NULL;
3019 return NULL;
3022 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3024 AioContext *aio_context;
3025 BlockJob *job = find_block_job(device, &aio_context, errp);
3027 if (!job) {
3028 return;
3031 block_job_set_speed(job, speed, errp);
3032 aio_context_release(aio_context);
3035 void qmp_block_job_cancel(const char *device,
3036 bool has_force, bool force, Error **errp)
3038 AioContext *aio_context;
3039 BlockJob *job = find_block_job(device, &aio_context, errp);
3041 if (!job) {
3042 return;
3045 if (!has_force) {
3046 force = false;
3049 if (job->user_paused && !force) {
3050 error_setg(errp, "The block job for device '%s' is currently paused",
3051 device);
3052 goto out;
3055 trace_qmp_block_job_cancel(job);
3056 block_job_cancel(job);
3057 out:
3058 aio_context_release(aio_context);
3061 void qmp_block_job_pause(const char *device, Error **errp)
3063 AioContext *aio_context;
3064 BlockJob *job = find_block_job(device, &aio_context, errp);
3066 if (!job || job->user_paused) {
3067 return;
3070 job->user_paused = true;
3071 trace_qmp_block_job_pause(job);
3072 block_job_pause(job);
3073 aio_context_release(aio_context);
3076 void qmp_block_job_resume(const char *device, Error **errp)
3078 AioContext *aio_context;
3079 BlockJob *job = find_block_job(device, &aio_context, errp);
3081 if (!job || !job->user_paused) {
3082 return;
3085 job->user_paused = false;
3086 trace_qmp_block_job_resume(job);
3087 block_job_resume(job);
3088 aio_context_release(aio_context);
3091 void qmp_block_job_complete(const char *device, Error **errp)
3093 AioContext *aio_context;
3094 BlockJob *job = find_block_job(device, &aio_context, errp);
3096 if (!job) {
3097 return;
3100 trace_qmp_block_job_complete(job);
3101 block_job_complete(job, errp);
3102 aio_context_release(aio_context);
3105 void qmp_change_backing_file(const char *device,
3106 const char *image_node_name,
3107 const char *backing_file,
3108 Error **errp)
3110 BlockBackend *blk;
3111 BlockDriverState *bs = NULL;
3112 AioContext *aio_context;
3113 BlockDriverState *image_bs = NULL;
3114 Error *local_err = NULL;
3115 bool ro;
3116 int open_flags;
3117 int ret;
3119 blk = blk_by_name(device);
3120 if (!blk) {
3121 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3122 "Device '%s' not found", device);
3123 return;
3126 aio_context = blk_get_aio_context(blk);
3127 aio_context_acquire(aio_context);
3129 if (!blk_is_available(blk)) {
3130 error_setg(errp, "Device '%s' has no medium", device);
3131 goto out;
3133 bs = blk_bs(blk);
3135 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3136 if (local_err) {
3137 error_propagate(errp, local_err);
3138 goto out;
3141 if (!image_bs) {
3142 error_setg(errp, "image file not found");
3143 goto out;
3146 if (bdrv_find_base(image_bs) == image_bs) {
3147 error_setg(errp, "not allowing backing file change on an image "
3148 "without a backing file");
3149 goto out;
3152 /* even though we are not necessarily operating on bs, we need it to
3153 * determine if block ops are currently prohibited on the chain */
3154 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3155 goto out;
3158 /* final sanity check */
3159 if (!bdrv_chain_contains(bs, image_bs)) {
3160 error_setg(errp, "'%s' and image file are not in the same chain",
3161 device);
3162 goto out;
3165 /* if not r/w, reopen to make r/w */
3166 open_flags = image_bs->open_flags;
3167 ro = bdrv_is_read_only(image_bs);
3169 if (ro) {
3170 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3171 if (local_err) {
3172 error_propagate(errp, local_err);
3173 goto out;
3177 ret = bdrv_change_backing_file(image_bs, backing_file,
3178 image_bs->drv ? image_bs->drv->format_name : "");
3180 if (ret < 0) {
3181 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3182 backing_file);
3183 /* don't exit here, so we can try to restore open flags if
3184 * appropriate */
3187 if (ro) {
3188 bdrv_reopen(image_bs, open_flags, &local_err);
3189 if (local_err) {
3190 error_propagate(errp, local_err); /* will preserve prior errp */
3194 out:
3195 aio_context_release(aio_context);
3198 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3200 QmpOutputVisitor *ov = qmp_output_visitor_new();
3201 BlockDriverState *bs;
3202 BlockBackend *blk = NULL;
3203 QObject *obj;
3204 QDict *qdict;
3205 Error *local_err = NULL;
3207 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3208 * cache.direct=false instead of silently switching to aio=threads, except
3209 * when called from drive_new().
3211 * For now, simply forbidding the combination for all drivers will do. */
3212 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3213 bool direct = options->has_cache &&
3214 options->cache->has_direct &&
3215 options->cache->direct;
3216 if (!direct) {
3217 error_setg(errp, "aio=native requires cache.direct=true");
3218 goto fail;
3222 visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
3223 &options, NULL, &local_err);
3224 if (local_err) {
3225 error_propagate(errp, local_err);
3226 goto fail;
3229 obj = qmp_output_get_qobject(ov);
3230 qdict = qobject_to_qdict(obj);
3232 qdict_flatten(qdict);
3234 if (options->has_id) {
3235 blk = blockdev_init(NULL, qdict, &local_err);
3236 if (local_err) {
3237 error_propagate(errp, local_err);
3238 goto fail;
3241 bs = blk_bs(blk);
3242 } else {
3243 if (!qdict_get_try_str(qdict, "node-name")) {
3244 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3245 "the root node");
3246 goto fail;
3249 bs = bds_tree_init(qdict, errp);
3250 if (!bs) {
3251 goto fail;
3255 if (bs && bdrv_key_required(bs)) {
3256 if (blk) {
3257 blk_unref(blk);
3258 } else {
3259 bdrv_unref(bs);
3261 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3262 goto fail;
3265 fail:
3266 qmp_output_visitor_cleanup(ov);
3269 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3271 BlockJobInfoList *head = NULL, **p_next = &head;
3272 BlockDriverState *bs;
3274 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
3275 AioContext *aio_context = bdrv_get_aio_context(bs);
3277 aio_context_acquire(aio_context);
3279 if (bs->job) {
3280 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
3281 elem->value = block_job_query(bs->job);
3282 *p_next = elem;
3283 p_next = &elem->next;
3286 aio_context_release(aio_context);
3289 return head;
3292 QemuOptsList qemu_common_drive_opts = {
3293 .name = "drive",
3294 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3295 .desc = {
3297 .name = "snapshot",
3298 .type = QEMU_OPT_BOOL,
3299 .help = "enable/disable snapshot mode",
3301 .name = "discard",
3302 .type = QEMU_OPT_STRING,
3303 .help = "discard operation (ignore/off, unmap/on)",
3305 .name = BDRV_OPT_CACHE_WB,
3306 .type = QEMU_OPT_BOOL,
3307 .help = "enables writeback mode for any caches",
3309 .name = BDRV_OPT_CACHE_DIRECT,
3310 .type = QEMU_OPT_BOOL,
3311 .help = "enables use of O_DIRECT (bypass the host page cache)",
3313 .name = BDRV_OPT_CACHE_NO_FLUSH,
3314 .type = QEMU_OPT_BOOL,
3315 .help = "ignore any flush requests for the device",
3317 .name = "aio",
3318 .type = QEMU_OPT_STRING,
3319 .help = "host AIO implementation (threads, native)",
3321 .name = "format",
3322 .type = QEMU_OPT_STRING,
3323 .help = "disk format (raw, qcow2, ...)",
3325 .name = "rerror",
3326 .type = QEMU_OPT_STRING,
3327 .help = "read error action",
3329 .name = "werror",
3330 .type = QEMU_OPT_STRING,
3331 .help = "write error action",
3333 .name = "read-only",
3334 .type = QEMU_OPT_BOOL,
3335 .help = "open drive file as read-only",
3337 .name = "throttling.iops-total",
3338 .type = QEMU_OPT_NUMBER,
3339 .help = "limit total I/O operations per second",
3341 .name = "throttling.iops-read",
3342 .type = QEMU_OPT_NUMBER,
3343 .help = "limit read operations per second",
3345 .name = "throttling.iops-write",
3346 .type = QEMU_OPT_NUMBER,
3347 .help = "limit write operations per second",
3349 .name = "throttling.bps-total",
3350 .type = QEMU_OPT_NUMBER,
3351 .help = "limit total bytes per second",
3353 .name = "throttling.bps-read",
3354 .type = QEMU_OPT_NUMBER,
3355 .help = "limit read bytes per second",
3357 .name = "throttling.bps-write",
3358 .type = QEMU_OPT_NUMBER,
3359 .help = "limit write bytes per second",
3361 .name = "throttling.iops-total-max",
3362 .type = QEMU_OPT_NUMBER,
3363 .help = "I/O operations burst",
3365 .name = "throttling.iops-read-max",
3366 .type = QEMU_OPT_NUMBER,
3367 .help = "I/O operations read burst",
3369 .name = "throttling.iops-write-max",
3370 .type = QEMU_OPT_NUMBER,
3371 .help = "I/O operations write burst",
3373 .name = "throttling.bps-total-max",
3374 .type = QEMU_OPT_NUMBER,
3375 .help = "total bytes burst",
3377 .name = "throttling.bps-read-max",
3378 .type = QEMU_OPT_NUMBER,
3379 .help = "total bytes read burst",
3381 .name = "throttling.bps-write-max",
3382 .type = QEMU_OPT_NUMBER,
3383 .help = "total bytes write burst",
3385 .name = "throttling.iops-size",
3386 .type = QEMU_OPT_NUMBER,
3387 .help = "when limiting by iops max size of an I/O in bytes",
3389 .name = "throttling.group",
3390 .type = QEMU_OPT_STRING,
3391 .help = "name of the block throttling group",
3393 .name = "copy-on-read",
3394 .type = QEMU_OPT_BOOL,
3395 .help = "copy read data from backing file into image file",
3397 .name = "detect-zeroes",
3398 .type = QEMU_OPT_STRING,
3399 .help = "try to optimize zero writes (off, on, unmap)",
3401 { /* end of list */ }
3405 static QemuOptsList qemu_root_bds_opts = {
3406 .name = "root-bds",
3407 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3408 .desc = {
3410 .name = "discard",
3411 .type = QEMU_OPT_STRING,
3412 .help = "discard operation (ignore/off, unmap/on)",
3414 .name = "cache.writeback",
3415 .type = QEMU_OPT_BOOL,
3416 .help = "enables writeback mode for any caches",
3418 .name = "cache.direct",
3419 .type = QEMU_OPT_BOOL,
3420 .help = "enables use of O_DIRECT (bypass the host page cache)",
3422 .name = "cache.no-flush",
3423 .type = QEMU_OPT_BOOL,
3424 .help = "ignore any flush requests for the device",
3426 .name = "aio",
3427 .type = QEMU_OPT_STRING,
3428 .help = "host AIO implementation (threads, native)",
3430 .name = "read-only",
3431 .type = QEMU_OPT_BOOL,
3432 .help = "open drive file as read-only",
3434 .name = "copy-on-read",
3435 .type = QEMU_OPT_BOOL,
3436 .help = "copy read data from backing file into image file",
3438 .name = "detect-zeroes",
3439 .type = QEMU_OPT_STRING,
3440 .help = "try to optimize zero writes (off, on, unmap)",
3442 { /* end of list */ }
3446 QemuOptsList qemu_drive_opts = {
3447 .name = "drive",
3448 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3449 .desc = {
3451 * no elements => accept any params
3452 * validation will happen later
3454 { /* end of list */ }