blockdev: Implement eject with basic operations
[qemu.git] / blockdev.c
blob16242972961ae99996d414768fdd599d8cd21e81
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 BlockDriverState *bs;
1124 AioContext *aio_context;
1126 blk = blk_by_name(device);
1127 if (!blk) {
1128 monitor_printf(mon, "Device '%s' not found\n", device);
1129 return;
1131 if (!blk_is_available(blk)) {
1132 monitor_printf(mon, "Device '%s' has no medium\n", device);
1133 return;
1136 bs = blk_bs(blk);
1137 aio_context = bdrv_get_aio_context(bs);
1138 aio_context_acquire(aio_context);
1140 ret = bdrv_commit(bs);
1142 aio_context_release(aio_context);
1144 if (ret < 0) {
1145 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1146 strerror(-ret));
1150 static void blockdev_do_action(TransactionActionKind type, void *data,
1151 Error **errp)
1153 TransactionAction action;
1154 TransactionActionList list;
1156 action.type = type;
1157 action.u.data = data;
1158 list.value = &action;
1159 list.next = NULL;
1160 qmp_transaction(&list, errp);
1163 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1164 bool has_node_name, const char *node_name,
1165 const char *snapshot_file,
1166 bool has_snapshot_node_name,
1167 const char *snapshot_node_name,
1168 bool has_format, const char *format,
1169 bool has_mode, NewImageMode mode, Error **errp)
1171 BlockdevSnapshot snapshot = {
1172 .has_device = has_device,
1173 .device = (char *) device,
1174 .has_node_name = has_node_name,
1175 .node_name = (char *) node_name,
1176 .snapshot_file = (char *) snapshot_file,
1177 .has_snapshot_node_name = has_snapshot_node_name,
1178 .snapshot_node_name = (char *) snapshot_node_name,
1179 .has_format = has_format,
1180 .format = (char *) format,
1181 .has_mode = has_mode,
1182 .mode = mode,
1184 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1185 &snapshot, errp);
1188 void qmp_blockdev_snapshot_internal_sync(const char *device,
1189 const char *name,
1190 Error **errp)
1192 BlockdevSnapshotInternal snapshot = {
1193 .device = (char *) device,
1194 .name = (char *) name
1197 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1198 &snapshot, errp);
1201 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1202 bool has_id,
1203 const char *id,
1204 bool has_name,
1205 const char *name,
1206 Error **errp)
1208 BlockDriverState *bs;
1209 BlockBackend *blk;
1210 AioContext *aio_context;
1211 QEMUSnapshotInfo sn;
1212 Error *local_err = NULL;
1213 SnapshotInfo *info = NULL;
1214 int ret;
1216 blk = blk_by_name(device);
1217 if (!blk) {
1218 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1219 "Device '%s' not found", device);
1220 return NULL;
1223 aio_context = blk_get_aio_context(blk);
1224 aio_context_acquire(aio_context);
1226 if (!has_id) {
1227 id = NULL;
1230 if (!has_name) {
1231 name = NULL;
1234 if (!id && !name) {
1235 error_setg(errp, "Name or id must be provided");
1236 goto out_aio_context;
1239 if (!blk_is_available(blk)) {
1240 error_setg(errp, "Device '%s' has no medium", device);
1241 goto out_aio_context;
1243 bs = blk_bs(blk);
1245 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1246 goto out_aio_context;
1249 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1250 if (local_err) {
1251 error_propagate(errp, local_err);
1252 goto out_aio_context;
1254 if (!ret) {
1255 error_setg(errp,
1256 "Snapshot with id '%s' and name '%s' does not exist on "
1257 "device '%s'",
1258 STR_OR_NULL(id), STR_OR_NULL(name), device);
1259 goto out_aio_context;
1262 bdrv_snapshot_delete(bs, id, name, &local_err);
1263 if (local_err) {
1264 error_propagate(errp, local_err);
1265 goto out_aio_context;
1268 aio_context_release(aio_context);
1270 info = g_new0(SnapshotInfo, 1);
1271 info->id = g_strdup(sn.id_str);
1272 info->name = g_strdup(sn.name);
1273 info->date_nsec = sn.date_nsec;
1274 info->date_sec = sn.date_sec;
1275 info->vm_state_size = sn.vm_state_size;
1276 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1277 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1279 return info;
1281 out_aio_context:
1282 aio_context_release(aio_context);
1283 return NULL;
1287 * block_dirty_bitmap_lookup:
1288 * Return a dirty bitmap (if present), after validating
1289 * the node reference and bitmap names.
1291 * @node: The name of the BDS node to search for bitmaps
1292 * @name: The name of the bitmap to search for
1293 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1294 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1295 * @errp: Output pointer for error information. Can be NULL.
1297 * @return: A bitmap object on success, or NULL on failure.
1299 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1300 const char *name,
1301 BlockDriverState **pbs,
1302 AioContext **paio,
1303 Error **errp)
1305 BlockDriverState *bs;
1306 BdrvDirtyBitmap *bitmap;
1307 AioContext *aio_context;
1309 if (!node) {
1310 error_setg(errp, "Node cannot be NULL");
1311 return NULL;
1313 if (!name) {
1314 error_setg(errp, "Bitmap name cannot be NULL");
1315 return NULL;
1317 bs = bdrv_lookup_bs(node, node, NULL);
1318 if (!bs) {
1319 error_setg(errp, "Node '%s' not found", node);
1320 return NULL;
1323 aio_context = bdrv_get_aio_context(bs);
1324 aio_context_acquire(aio_context);
1326 bitmap = bdrv_find_dirty_bitmap(bs, name);
1327 if (!bitmap) {
1328 error_setg(errp, "Dirty bitmap '%s' not found", name);
1329 goto fail;
1332 if (pbs) {
1333 *pbs = bs;
1335 if (paio) {
1336 *paio = aio_context;
1337 } else {
1338 aio_context_release(aio_context);
1341 return bitmap;
1343 fail:
1344 aio_context_release(aio_context);
1345 return NULL;
1348 /* New and old BlockDriverState structs for atomic group operations */
1350 typedef struct BlkTransactionState BlkTransactionState;
1352 /* Only prepare() may fail. In a single transaction, only one of commit() or
1353 abort() will be called, clean() will always be called if it present. */
1354 typedef struct BdrvActionOps {
1355 /* Size of state struct, in bytes. */
1356 size_t instance_size;
1357 /* Prepare the work, must NOT be NULL. */
1358 void (*prepare)(BlkTransactionState *common, Error **errp);
1359 /* Commit the changes, can be NULL. */
1360 void (*commit)(BlkTransactionState *common);
1361 /* Abort the changes on fail, can be NULL. */
1362 void (*abort)(BlkTransactionState *common);
1363 /* Clean up resource in the end, can be NULL. */
1364 void (*clean)(BlkTransactionState *common);
1365 } BdrvActionOps;
1368 * This structure must be arranged as first member in child type, assuming
1369 * that compiler will also arrange it to the same address with parent instance.
1370 * Later it will be used in free().
1372 struct BlkTransactionState {
1373 TransactionAction *action;
1374 const BdrvActionOps *ops;
1375 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1378 /* internal snapshot private data */
1379 typedef struct InternalSnapshotState {
1380 BlkTransactionState common;
1381 BlockDriverState *bs;
1382 AioContext *aio_context;
1383 QEMUSnapshotInfo sn;
1384 bool created;
1385 } InternalSnapshotState;
1387 static void internal_snapshot_prepare(BlkTransactionState *common,
1388 Error **errp)
1390 Error *local_err = NULL;
1391 const char *device;
1392 const char *name;
1393 BlockBackend *blk;
1394 BlockDriverState *bs;
1395 QEMUSnapshotInfo old_sn, *sn;
1396 bool ret;
1397 qemu_timeval tv;
1398 BlockdevSnapshotInternal *internal;
1399 InternalSnapshotState *state;
1400 int ret1;
1402 g_assert(common->action->type ==
1403 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1404 internal = common->action->u.blockdev_snapshot_internal_sync;
1405 state = DO_UPCAST(InternalSnapshotState, common, common);
1407 /* 1. parse input */
1408 device = internal->device;
1409 name = internal->name;
1411 /* 2. check for validation */
1412 blk = blk_by_name(device);
1413 if (!blk) {
1414 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1415 "Device '%s' not found", device);
1416 return;
1419 /* AioContext is released in .clean() */
1420 state->aio_context = blk_get_aio_context(blk);
1421 aio_context_acquire(state->aio_context);
1423 if (!blk_is_available(blk)) {
1424 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1425 return;
1427 bs = blk_bs(blk);
1429 state->bs = bs;
1430 bdrv_drained_begin(bs);
1432 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1433 return;
1436 if (bdrv_is_read_only(bs)) {
1437 error_setg(errp, "Device '%s' is read only", device);
1438 return;
1441 if (!bdrv_can_snapshot(bs)) {
1442 error_setg(errp, "Block format '%s' used by device '%s' "
1443 "does not support internal snapshots",
1444 bs->drv->format_name, device);
1445 return;
1448 if (!strlen(name)) {
1449 error_setg(errp, "Name is empty");
1450 return;
1453 /* check whether a snapshot with name exist */
1454 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1455 &local_err);
1456 if (local_err) {
1457 error_propagate(errp, local_err);
1458 return;
1459 } else if (ret) {
1460 error_setg(errp,
1461 "Snapshot with name '%s' already exists on device '%s'",
1462 name, device);
1463 return;
1466 /* 3. take the snapshot */
1467 sn = &state->sn;
1468 pstrcpy(sn->name, sizeof(sn->name), name);
1469 qemu_gettimeofday(&tv);
1470 sn->date_sec = tv.tv_sec;
1471 sn->date_nsec = tv.tv_usec * 1000;
1472 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1474 ret1 = bdrv_snapshot_create(bs, sn);
1475 if (ret1 < 0) {
1476 error_setg_errno(errp, -ret1,
1477 "Failed to create snapshot '%s' on device '%s'",
1478 name, device);
1479 return;
1482 /* 4. succeed, mark a snapshot is created */
1483 state->created = true;
1486 static void internal_snapshot_abort(BlkTransactionState *common)
1488 InternalSnapshotState *state =
1489 DO_UPCAST(InternalSnapshotState, common, common);
1490 BlockDriverState *bs = state->bs;
1491 QEMUSnapshotInfo *sn = &state->sn;
1492 Error *local_error = NULL;
1494 if (!state->created) {
1495 return;
1498 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1499 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1500 "device '%s' in abort: %s",
1501 sn->id_str,
1502 sn->name,
1503 bdrv_get_device_name(bs),
1504 error_get_pretty(local_error));
1505 error_free(local_error);
1509 static void internal_snapshot_clean(BlkTransactionState *common)
1511 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1512 common, common);
1514 if (state->aio_context) {
1515 if (state->bs) {
1516 bdrv_drained_end(state->bs);
1518 aio_context_release(state->aio_context);
1522 /* external snapshot private data */
1523 typedef struct ExternalSnapshotState {
1524 BlkTransactionState common;
1525 BlockDriverState *old_bs;
1526 BlockDriverState *new_bs;
1527 AioContext *aio_context;
1528 } ExternalSnapshotState;
1530 static void external_snapshot_prepare(BlkTransactionState *common,
1531 Error **errp)
1533 int flags, ret;
1534 QDict *options;
1535 Error *local_err = NULL;
1536 bool has_device = false;
1537 const char *device;
1538 bool has_node_name = false;
1539 const char *node_name;
1540 bool has_snapshot_node_name = false;
1541 const char *snapshot_node_name;
1542 const char *new_image_file;
1543 const char *format = "qcow2";
1544 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1545 ExternalSnapshotState *state =
1546 DO_UPCAST(ExternalSnapshotState, common, common);
1547 TransactionAction *action = common->action;
1549 /* get parameters */
1550 g_assert(action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1552 has_device = action->u.blockdev_snapshot_sync->has_device;
1553 device = action->u.blockdev_snapshot_sync->device;
1554 has_node_name = action->u.blockdev_snapshot_sync->has_node_name;
1555 node_name = action->u.blockdev_snapshot_sync->node_name;
1556 has_snapshot_node_name =
1557 action->u.blockdev_snapshot_sync->has_snapshot_node_name;
1558 snapshot_node_name = action->u.blockdev_snapshot_sync->snapshot_node_name;
1560 new_image_file = action->u.blockdev_snapshot_sync->snapshot_file;
1561 if (action->u.blockdev_snapshot_sync->has_format) {
1562 format = action->u.blockdev_snapshot_sync->format;
1564 if (action->u.blockdev_snapshot_sync->has_mode) {
1565 mode = action->u.blockdev_snapshot_sync->mode;
1568 /* start processing */
1569 state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
1570 has_node_name ? node_name : NULL,
1571 &local_err);
1572 if (local_err) {
1573 error_propagate(errp, local_err);
1574 return;
1577 if (has_node_name && !has_snapshot_node_name) {
1578 error_setg(errp, "New snapshot node name missing");
1579 return;
1582 if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
1583 error_setg(errp, "New snapshot node name already existing");
1584 return;
1587 /* Acquire AioContext now so any threads operating on old_bs stop */
1588 state->aio_context = bdrv_get_aio_context(state->old_bs);
1589 aio_context_acquire(state->aio_context);
1590 bdrv_drained_begin(state->old_bs);
1592 if (!bdrv_is_inserted(state->old_bs)) {
1593 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1594 return;
1597 if (bdrv_op_is_blocked(state->old_bs,
1598 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1599 return;
1602 if (!bdrv_is_read_only(state->old_bs)) {
1603 if (bdrv_flush(state->old_bs)) {
1604 error_setg(errp, QERR_IO_ERROR);
1605 return;
1609 if (!bdrv_is_first_non_filter(state->old_bs)) {
1610 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1611 return;
1614 flags = state->old_bs->open_flags;
1616 /* create new image w/backing file */
1617 if (mode != NEW_IMAGE_MODE_EXISTING) {
1618 bdrv_img_create(new_image_file, format,
1619 state->old_bs->filename,
1620 state->old_bs->drv->format_name,
1621 NULL, -1, flags, &local_err, false);
1622 if (local_err) {
1623 error_propagate(errp, local_err);
1624 return;
1628 options = qdict_new();
1629 if (has_snapshot_node_name) {
1630 qdict_put(options, "node-name",
1631 qstring_from_str(snapshot_node_name));
1633 qdict_put(options, "driver", qstring_from_str(format));
1635 /* TODO Inherit bs->options or only take explicit options with an
1636 * extended QMP command? */
1637 assert(state->new_bs == NULL);
1638 ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
1639 flags | BDRV_O_NO_BACKING, &local_err);
1640 /* We will manually add the backing_hd field to the bs later */
1641 if (ret != 0) {
1642 error_propagate(errp, local_err);
1646 static void external_snapshot_commit(BlkTransactionState *common)
1648 ExternalSnapshotState *state =
1649 DO_UPCAST(ExternalSnapshotState, common, common);
1651 bdrv_set_aio_context(state->new_bs, state->aio_context);
1653 /* This removes our old bs and adds the new bs */
1654 bdrv_append(state->new_bs, state->old_bs);
1655 /* We don't need (or want) to use the transactional
1656 * bdrv_reopen_multiple() across all the entries at once, because we
1657 * don't want to abort all of them if one of them fails the reopen */
1658 bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1659 NULL);
1662 static void external_snapshot_abort(BlkTransactionState *common)
1664 ExternalSnapshotState *state =
1665 DO_UPCAST(ExternalSnapshotState, common, common);
1666 if (state->new_bs) {
1667 bdrv_unref(state->new_bs);
1671 static void external_snapshot_clean(BlkTransactionState *common)
1673 ExternalSnapshotState *state =
1674 DO_UPCAST(ExternalSnapshotState, common, common);
1675 if (state->aio_context) {
1676 bdrv_drained_end(state->old_bs);
1677 aio_context_release(state->aio_context);
1681 typedef struct DriveBackupState {
1682 BlkTransactionState common;
1683 BlockDriverState *bs;
1684 AioContext *aio_context;
1685 BlockJob *job;
1686 } DriveBackupState;
1688 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1690 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1691 BlockBackend *blk;
1692 DriveBackup *backup;
1693 Error *local_err = NULL;
1695 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1696 backup = common->action->u.drive_backup;
1698 blk = blk_by_name(backup->device);
1699 if (!blk) {
1700 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1701 "Device '%s' not found", backup->device);
1702 return;
1705 if (!blk_is_available(blk)) {
1706 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1707 return;
1710 /* AioContext is released in .clean() */
1711 state->aio_context = blk_get_aio_context(blk);
1712 aio_context_acquire(state->aio_context);
1713 bdrv_drained_begin(blk_bs(blk));
1714 state->bs = blk_bs(blk);
1716 qmp_drive_backup(backup->device, backup->target,
1717 backup->has_format, backup->format,
1718 backup->sync,
1719 backup->has_mode, backup->mode,
1720 backup->has_speed, backup->speed,
1721 backup->has_bitmap, backup->bitmap,
1722 backup->has_on_source_error, backup->on_source_error,
1723 backup->has_on_target_error, backup->on_target_error,
1724 &local_err);
1725 if (local_err) {
1726 error_propagate(errp, local_err);
1727 return;
1730 state->job = state->bs->job;
1733 static void drive_backup_abort(BlkTransactionState *common)
1735 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1736 BlockDriverState *bs = state->bs;
1738 /* Only cancel if it's the job we started */
1739 if (bs && bs->job && bs->job == state->job) {
1740 block_job_cancel_sync(bs->job);
1744 static void drive_backup_clean(BlkTransactionState *common)
1746 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1748 if (state->aio_context) {
1749 bdrv_drained_end(state->bs);
1750 aio_context_release(state->aio_context);
1754 typedef struct BlockdevBackupState {
1755 BlkTransactionState common;
1756 BlockDriverState *bs;
1757 BlockJob *job;
1758 AioContext *aio_context;
1759 } BlockdevBackupState;
1761 static void blockdev_backup_prepare(BlkTransactionState *common, Error **errp)
1763 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1764 BlockdevBackup *backup;
1765 BlockBackend *blk, *target;
1766 Error *local_err = NULL;
1768 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1769 backup = common->action->u.blockdev_backup;
1771 blk = blk_by_name(backup->device);
1772 if (!blk) {
1773 error_setg(errp, "Device '%s' not found", backup->device);
1774 return;
1777 if (!blk_is_available(blk)) {
1778 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1779 return;
1782 target = blk_by_name(backup->target);
1783 if (!target) {
1784 error_setg(errp, "Device '%s' not found", backup->target);
1785 return;
1788 /* AioContext is released in .clean() */
1789 state->aio_context = blk_get_aio_context(blk);
1790 if (state->aio_context != blk_get_aio_context(target)) {
1791 state->aio_context = NULL;
1792 error_setg(errp, "Backup between two IO threads is not implemented");
1793 return;
1795 aio_context_acquire(state->aio_context);
1796 state->bs = blk_bs(blk);
1797 bdrv_drained_begin(state->bs);
1799 qmp_blockdev_backup(backup->device, backup->target,
1800 backup->sync,
1801 backup->has_speed, backup->speed,
1802 backup->has_on_source_error, backup->on_source_error,
1803 backup->has_on_target_error, backup->on_target_error,
1804 &local_err);
1805 if (local_err) {
1806 error_propagate(errp, local_err);
1807 return;
1810 state->job = state->bs->job;
1813 static void blockdev_backup_abort(BlkTransactionState *common)
1815 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1816 BlockDriverState *bs = state->bs;
1818 /* Only cancel if it's the job we started */
1819 if (bs && bs->job && bs->job == state->job) {
1820 block_job_cancel_sync(bs->job);
1824 static void blockdev_backup_clean(BlkTransactionState *common)
1826 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1828 if (state->aio_context) {
1829 bdrv_drained_end(state->bs);
1830 aio_context_release(state->aio_context);
1834 static void abort_prepare(BlkTransactionState *common, Error **errp)
1836 error_setg(errp, "Transaction aborted using Abort action");
1839 static void abort_commit(BlkTransactionState *common)
1841 g_assert_not_reached(); /* this action never succeeds */
1844 static const BdrvActionOps actions[] = {
1845 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1846 .instance_size = sizeof(ExternalSnapshotState),
1847 .prepare = external_snapshot_prepare,
1848 .commit = external_snapshot_commit,
1849 .abort = external_snapshot_abort,
1850 .clean = external_snapshot_clean,
1852 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1853 .instance_size = sizeof(DriveBackupState),
1854 .prepare = drive_backup_prepare,
1855 .abort = drive_backup_abort,
1856 .clean = drive_backup_clean,
1858 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
1859 .instance_size = sizeof(BlockdevBackupState),
1860 .prepare = blockdev_backup_prepare,
1861 .abort = blockdev_backup_abort,
1862 .clean = blockdev_backup_clean,
1864 [TRANSACTION_ACTION_KIND_ABORT] = {
1865 .instance_size = sizeof(BlkTransactionState),
1866 .prepare = abort_prepare,
1867 .commit = abort_commit,
1869 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1870 .instance_size = sizeof(InternalSnapshotState),
1871 .prepare = internal_snapshot_prepare,
1872 .abort = internal_snapshot_abort,
1873 .clean = internal_snapshot_clean,
1878 * 'Atomic' group operations. The operations are performed as a set, and if
1879 * any fail then we roll back all operations in the group.
1881 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1883 TransactionActionList *dev_entry = dev_list;
1884 BlkTransactionState *state, *next;
1885 Error *local_err = NULL;
1887 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1888 QSIMPLEQ_INIT(&snap_bdrv_states);
1890 /* drain all i/o before any operations */
1891 bdrv_drain_all();
1893 /* We don't do anything in this loop that commits us to the operations */
1894 while (NULL != dev_entry) {
1895 TransactionAction *dev_info = NULL;
1896 const BdrvActionOps *ops;
1898 dev_info = dev_entry->value;
1899 dev_entry = dev_entry->next;
1901 assert(dev_info->type < ARRAY_SIZE(actions));
1903 ops = &actions[dev_info->type];
1904 assert(ops->instance_size > 0);
1906 state = g_malloc0(ops->instance_size);
1907 state->ops = ops;
1908 state->action = dev_info;
1909 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1911 state->ops->prepare(state, &local_err);
1912 if (local_err) {
1913 error_propagate(errp, local_err);
1914 goto delete_and_fail;
1918 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1919 if (state->ops->commit) {
1920 state->ops->commit(state);
1924 /* success */
1925 goto exit;
1927 delete_and_fail:
1928 /* failure, and it is all-or-none; roll back all operations */
1929 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1930 if (state->ops->abort) {
1931 state->ops->abort(state);
1934 exit:
1935 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1936 if (state->ops->clean) {
1937 state->ops->clean(state);
1939 g_free(state);
1944 static void eject_device(BlockBackend *blk, int force, Error **errp)
1946 BlockDriverState *bs = blk_bs(blk);
1947 AioContext *aio_context;
1949 if (!bs) {
1950 /* No medium inserted, so there is nothing to do */
1951 return;
1954 aio_context = bdrv_get_aio_context(bs);
1955 aio_context_acquire(aio_context);
1957 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1958 goto out;
1960 if (!blk_dev_has_removable_media(blk)) {
1961 error_setg(errp, "Device '%s' is not removable",
1962 bdrv_get_device_name(bs));
1963 goto out;
1966 if (blk_dev_is_medium_locked(blk) && !blk_dev_is_tray_open(blk)) {
1967 blk_dev_eject_request(blk, force);
1968 if (!force) {
1969 error_setg(errp, "Device '%s' is locked",
1970 bdrv_get_device_name(bs));
1971 goto out;
1975 bdrv_close(bs);
1977 out:
1978 aio_context_release(aio_context);
1981 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1983 Error *local_err = NULL;
1985 qmp_blockdev_open_tray(device, has_force, force, &local_err);
1986 if (local_err) {
1987 error_propagate(errp, local_err);
1988 return;
1991 qmp_blockdev_remove_medium(device, errp);
1994 void qmp_block_passwd(bool has_device, const char *device,
1995 bool has_node_name, const char *node_name,
1996 const char *password, Error **errp)
1998 Error *local_err = NULL;
1999 BlockDriverState *bs;
2000 AioContext *aio_context;
2002 bs = bdrv_lookup_bs(has_device ? device : NULL,
2003 has_node_name ? node_name : NULL,
2004 &local_err);
2005 if (local_err) {
2006 error_propagate(errp, local_err);
2007 return;
2010 aio_context = bdrv_get_aio_context(bs);
2011 aio_context_acquire(aio_context);
2013 bdrv_add_key(bs, password, errp);
2015 aio_context_release(aio_context);
2018 /* Assumes AioContext is held */
2019 static void qmp_bdrv_open_encrypted(BlockDriverState **pbs,
2020 const char *filename,
2021 int bdrv_flags, const char *format,
2022 const char *password, Error **errp)
2024 Error *local_err = NULL;
2025 QDict *options = NULL;
2026 int ret;
2028 if (format) {
2029 options = qdict_new();
2030 qdict_put(options, "driver", qstring_from_str(format));
2033 ret = bdrv_open(pbs, filename, NULL, options, bdrv_flags, &local_err);
2034 if (ret < 0) {
2035 error_propagate(errp, local_err);
2036 return;
2039 bdrv_add_key(*pbs, password, errp);
2042 void qmp_change_blockdev(const char *device, const char *filename,
2043 const char *format, Error **errp)
2045 BlockBackend *blk;
2046 BlockDriverState *bs;
2047 AioContext *aio_context;
2048 int bdrv_flags;
2049 bool new_bs;
2050 Error *err = NULL;
2052 blk = blk_by_name(device);
2053 if (!blk) {
2054 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2055 "Device '%s' not found", device);
2056 return;
2058 bs = blk_bs(blk);
2059 new_bs = !bs;
2061 aio_context = blk_get_aio_context(blk);
2062 aio_context_acquire(aio_context);
2064 eject_device(blk, 0, &err);
2065 if (err) {
2066 error_propagate(errp, err);
2067 goto out;
2070 bdrv_flags = blk_is_read_only(blk) ? 0 : BDRV_O_RDWR;
2071 bdrv_flags |= blk_get_root_state(blk)->open_flags & ~BDRV_O_RDWR;
2073 qmp_bdrv_open_encrypted(&bs, filename, bdrv_flags, format, NULL, &err);
2074 if (err) {
2075 error_propagate(errp, err);
2076 goto out;
2079 if (new_bs) {
2080 blk_insert_bs(blk, bs);
2081 /* Has been sent automatically by bdrv_open() if blk_bs(blk) was not
2082 * NULL */
2083 blk_dev_change_media_cb(blk, true);
2086 out:
2087 aio_context_release(aio_context);
2090 void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
2091 Error **errp)
2093 BlockBackend *blk;
2094 bool locked;
2096 if (!has_force) {
2097 force = false;
2100 blk = blk_by_name(device);
2101 if (!blk) {
2102 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2103 "Device '%s' not found", device);
2104 return;
2107 if (!blk_dev_has_removable_media(blk)) {
2108 error_setg(errp, "Device '%s' is not removable", device);
2109 return;
2112 if (blk_dev_is_tray_open(blk)) {
2113 return;
2116 locked = blk_dev_is_medium_locked(blk);
2117 if (locked) {
2118 blk_dev_eject_request(blk, force);
2121 if (!locked || force) {
2122 blk_dev_change_media_cb(blk, false);
2126 void qmp_blockdev_close_tray(const char *device, Error **errp)
2128 BlockBackend *blk;
2130 blk = blk_by_name(device);
2131 if (!blk) {
2132 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2133 "Device '%s' not found", device);
2134 return;
2137 if (!blk_dev_has_removable_media(blk)) {
2138 error_setg(errp, "Device '%s' is not removable", device);
2139 return;
2142 if (!blk_dev_is_tray_open(blk)) {
2143 return;
2146 blk_dev_change_media_cb(blk, true);
2149 void qmp_blockdev_remove_medium(const char *device, Error **errp)
2151 BlockBackend *blk;
2152 BlockDriverState *bs;
2153 AioContext *aio_context;
2154 bool has_device;
2156 blk = blk_by_name(device);
2157 if (!blk) {
2158 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2159 "Device '%s' not found", device);
2160 return;
2163 /* For BBs without a device, we can exchange the BDS tree at will */
2164 has_device = blk_get_attached_dev(blk);
2166 if (has_device && !blk_dev_has_removable_media(blk)) {
2167 error_setg(errp, "Device '%s' is not removable", device);
2168 return;
2171 if (has_device && !blk_dev_is_tray_open(blk)) {
2172 error_setg(errp, "Tray of device '%s' is not open", device);
2173 return;
2176 bs = blk_bs(blk);
2177 if (!bs) {
2178 return;
2181 aio_context = bdrv_get_aio_context(bs);
2182 aio_context_acquire(aio_context);
2184 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2185 goto out;
2188 /* This follows the convention established by bdrv_make_anon() */
2189 if (bs->device_list.tqe_prev) {
2190 QTAILQ_REMOVE(&bdrv_states, bs, device_list);
2191 bs->device_list.tqe_prev = NULL;
2194 blk_remove_bs(blk);
2196 out:
2197 aio_context_release(aio_context);
2200 static void qmp_blockdev_insert_anon_medium(const char *device,
2201 BlockDriverState *bs, Error **errp)
2203 BlockBackend *blk;
2204 bool has_device;
2206 blk = blk_by_name(device);
2207 if (!blk) {
2208 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2209 "Device '%s' not found", device);
2210 return;
2213 /* For BBs without a device, we can exchange the BDS tree at will */
2214 has_device = blk_get_attached_dev(blk);
2216 if (has_device && !blk_dev_has_removable_media(blk)) {
2217 error_setg(errp, "Device '%s' is not removable", device);
2218 return;
2221 if (has_device && !blk_dev_is_tray_open(blk)) {
2222 error_setg(errp, "Tray of device '%s' is not open", device);
2223 return;
2226 if (blk_bs(blk)) {
2227 error_setg(errp, "There already is a medium in device '%s'", device);
2228 return;
2231 blk_insert_bs(blk, bs);
2233 QTAILQ_INSERT_TAIL(&bdrv_states, bs, device_list);
2236 void qmp_blockdev_insert_medium(const char *device, const char *node_name,
2237 Error **errp)
2239 BlockDriverState *bs;
2241 bs = bdrv_find_node(node_name);
2242 if (!bs) {
2243 error_setg(errp, "Node '%s' not found", node_name);
2244 return;
2247 if (bs->blk) {
2248 error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
2249 blk_name(bs->blk));
2250 return;
2253 qmp_blockdev_insert_anon_medium(device, bs, errp);
2256 /* throttling disk I/O limits */
2257 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2258 int64_t bps_wr,
2259 int64_t iops,
2260 int64_t iops_rd,
2261 int64_t iops_wr,
2262 bool has_bps_max,
2263 int64_t bps_max,
2264 bool has_bps_rd_max,
2265 int64_t bps_rd_max,
2266 bool has_bps_wr_max,
2267 int64_t bps_wr_max,
2268 bool has_iops_max,
2269 int64_t iops_max,
2270 bool has_iops_rd_max,
2271 int64_t iops_rd_max,
2272 bool has_iops_wr_max,
2273 int64_t iops_wr_max,
2274 bool has_iops_size,
2275 int64_t iops_size,
2276 bool has_group,
2277 const char *group, Error **errp)
2279 ThrottleConfig cfg;
2280 BlockDriverState *bs;
2281 BlockBackend *blk;
2282 AioContext *aio_context;
2284 blk = blk_by_name(device);
2285 if (!blk) {
2286 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2287 "Device '%s' not found", device);
2288 return;
2291 aio_context = blk_get_aio_context(blk);
2292 aio_context_acquire(aio_context);
2294 bs = blk_bs(blk);
2295 if (!bs) {
2296 error_setg(errp, "Device '%s' has no medium", device);
2297 goto out;
2300 memset(&cfg, 0, sizeof(cfg));
2301 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
2302 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
2303 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
2305 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
2306 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
2307 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
2309 if (has_bps_max) {
2310 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
2312 if (has_bps_rd_max) {
2313 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
2315 if (has_bps_wr_max) {
2316 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
2318 if (has_iops_max) {
2319 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
2321 if (has_iops_rd_max) {
2322 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
2324 if (has_iops_wr_max) {
2325 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
2328 if (has_iops_size) {
2329 cfg.op_size = iops_size;
2332 if (!check_throttle_config(&cfg, errp)) {
2333 goto out;
2336 if (throttle_enabled(&cfg)) {
2337 /* Enable I/O limits if they're not enabled yet, otherwise
2338 * just update the throttling group. */
2339 if (!bs->io_limits_enabled) {
2340 bdrv_io_limits_enable(bs, has_group ? group : device);
2341 } else if (has_group) {
2342 bdrv_io_limits_update_group(bs, group);
2344 /* Set the new throttling configuration */
2345 bdrv_set_io_limits(bs, &cfg);
2346 } else if (bs->io_limits_enabled) {
2347 /* If all throttling settings are set to 0, disable I/O limits */
2348 bdrv_io_limits_disable(bs);
2351 out:
2352 aio_context_release(aio_context);
2355 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2356 bool has_granularity, uint32_t granularity,
2357 Error **errp)
2359 AioContext *aio_context;
2360 BlockDriverState *bs;
2362 if (!name || name[0] == '\0') {
2363 error_setg(errp, "Bitmap name cannot be empty");
2364 return;
2367 bs = bdrv_lookup_bs(node, node, errp);
2368 if (!bs) {
2369 return;
2372 aio_context = bdrv_get_aio_context(bs);
2373 aio_context_acquire(aio_context);
2375 if (has_granularity) {
2376 if (granularity < 512 || !is_power_of_2(granularity)) {
2377 error_setg(errp, "Granularity must be power of 2 "
2378 "and at least 512");
2379 goto out;
2381 } else {
2382 /* Default to cluster size, if available: */
2383 granularity = bdrv_get_default_bitmap_granularity(bs);
2386 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2388 out:
2389 aio_context_release(aio_context);
2392 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2393 Error **errp)
2395 AioContext *aio_context;
2396 BlockDriverState *bs;
2397 BdrvDirtyBitmap *bitmap;
2399 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2400 if (!bitmap || !bs) {
2401 return;
2404 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2405 error_setg(errp,
2406 "Bitmap '%s' is currently frozen and cannot be removed",
2407 name);
2408 goto out;
2410 bdrv_dirty_bitmap_make_anon(bitmap);
2411 bdrv_release_dirty_bitmap(bs, bitmap);
2413 out:
2414 aio_context_release(aio_context);
2418 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2419 * immediately after a full backup operation.
2421 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2422 Error **errp)
2424 AioContext *aio_context;
2425 BdrvDirtyBitmap *bitmap;
2426 BlockDriverState *bs;
2428 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2429 if (!bitmap || !bs) {
2430 return;
2433 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2434 error_setg(errp,
2435 "Bitmap '%s' is currently frozen and cannot be modified",
2436 name);
2437 goto out;
2438 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2439 error_setg(errp,
2440 "Bitmap '%s' is currently disabled and cannot be cleared",
2441 name);
2442 goto out;
2445 bdrv_clear_dirty_bitmap(bitmap);
2447 out:
2448 aio_context_release(aio_context);
2451 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2453 const char *id = qdict_get_str(qdict, "id");
2454 BlockBackend *blk;
2455 BlockDriverState *bs;
2456 AioContext *aio_context;
2457 Error *local_err = NULL;
2459 blk = blk_by_name(id);
2460 if (!blk) {
2461 error_report("Device '%s' not found", id);
2462 return;
2465 if (!blk_legacy_dinfo(blk)) {
2466 error_report("Deleting device added with blockdev-add"
2467 " is not supported");
2468 return;
2471 aio_context = blk_get_aio_context(blk);
2472 aio_context_acquire(aio_context);
2474 bs = blk_bs(blk);
2475 if (bs) {
2476 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2477 error_report_err(local_err);
2478 aio_context_release(aio_context);
2479 return;
2482 bdrv_close(bs);
2485 /* if we have a device attached to this BlockDriverState
2486 * then we need to make the drive anonymous until the device
2487 * can be removed. If this is a drive with no device backing
2488 * then we can just get rid of the block driver state right here.
2490 if (blk_get_attached_dev(blk)) {
2491 blk_hide_on_behalf_of_hmp_drive_del(blk);
2492 /* Further I/O must not pause the guest */
2493 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2494 BLOCKDEV_ON_ERROR_REPORT);
2495 } else {
2496 blk_unref(blk);
2499 aio_context_release(aio_context);
2502 void qmp_block_resize(bool has_device, const char *device,
2503 bool has_node_name, const char *node_name,
2504 int64_t size, Error **errp)
2506 Error *local_err = NULL;
2507 BlockDriverState *bs;
2508 AioContext *aio_context;
2509 int ret;
2511 bs = bdrv_lookup_bs(has_device ? device : NULL,
2512 has_node_name ? node_name : NULL,
2513 &local_err);
2514 if (local_err) {
2515 error_propagate(errp, local_err);
2516 return;
2519 aio_context = bdrv_get_aio_context(bs);
2520 aio_context_acquire(aio_context);
2522 if (!bdrv_is_first_non_filter(bs)) {
2523 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2524 goto out;
2527 if (size < 0) {
2528 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2529 goto out;
2532 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2533 error_setg(errp, QERR_DEVICE_IN_USE, device);
2534 goto out;
2537 /* complete all in-flight operations before resizing the device */
2538 bdrv_drain_all();
2540 ret = bdrv_truncate(bs, size);
2541 switch (ret) {
2542 case 0:
2543 break;
2544 case -ENOMEDIUM:
2545 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2546 break;
2547 case -ENOTSUP:
2548 error_setg(errp, QERR_UNSUPPORTED);
2549 break;
2550 case -EACCES:
2551 error_setg(errp, "Device '%s' is read only", device);
2552 break;
2553 case -EBUSY:
2554 error_setg(errp, QERR_DEVICE_IN_USE, device);
2555 break;
2556 default:
2557 error_setg_errno(errp, -ret, "Could not resize");
2558 break;
2561 out:
2562 aio_context_release(aio_context);
2565 static void block_job_cb(void *opaque, int ret)
2567 /* Note that this function may be executed from another AioContext besides
2568 * the QEMU main loop. If you need to access anything that assumes the
2569 * QEMU global mutex, use a BH or introduce a mutex.
2572 BlockDriverState *bs = opaque;
2573 const char *msg = NULL;
2575 trace_block_job_cb(bs, bs->job, ret);
2577 assert(bs->job);
2579 if (ret < 0) {
2580 msg = strerror(-ret);
2583 if (block_job_is_cancelled(bs->job)) {
2584 block_job_event_cancelled(bs->job);
2585 } else {
2586 block_job_event_completed(bs->job, msg);
2589 bdrv_put_ref_bh_schedule(bs);
2592 void qmp_block_stream(const char *device,
2593 bool has_base, const char *base,
2594 bool has_backing_file, const char *backing_file,
2595 bool has_speed, int64_t speed,
2596 bool has_on_error, BlockdevOnError on_error,
2597 Error **errp)
2599 BlockBackend *blk;
2600 BlockDriverState *bs;
2601 BlockDriverState *base_bs = NULL;
2602 AioContext *aio_context;
2603 Error *local_err = NULL;
2604 const char *base_name = NULL;
2606 if (!has_on_error) {
2607 on_error = BLOCKDEV_ON_ERROR_REPORT;
2610 blk = blk_by_name(device);
2611 if (!blk) {
2612 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2613 "Device '%s' not found", device);
2614 return;
2617 aio_context = blk_get_aio_context(blk);
2618 aio_context_acquire(aio_context);
2620 if (!blk_is_available(blk)) {
2621 error_setg(errp, "Device '%s' has no medium", device);
2622 goto out;
2624 bs = blk_bs(blk);
2626 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2627 goto out;
2630 if (has_base) {
2631 base_bs = bdrv_find_backing_image(bs, base);
2632 if (base_bs == NULL) {
2633 error_setg(errp, QERR_BASE_NOT_FOUND, base);
2634 goto out;
2636 assert(bdrv_get_aio_context(base_bs) == aio_context);
2637 base_name = base;
2640 /* if we are streaming the entire chain, the result will have no backing
2641 * file, and specifying one is therefore an error */
2642 if (base_bs == NULL && has_backing_file) {
2643 error_setg(errp, "backing file specified, but streaming the "
2644 "entire chain");
2645 goto out;
2648 /* backing_file string overrides base bs filename */
2649 base_name = has_backing_file ? backing_file : base_name;
2651 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
2652 on_error, block_job_cb, bs, &local_err);
2653 if (local_err) {
2654 error_propagate(errp, local_err);
2655 goto out;
2658 trace_qmp_block_stream(bs, bs->job);
2660 out:
2661 aio_context_release(aio_context);
2664 void qmp_block_commit(const char *device,
2665 bool has_base, const char *base,
2666 bool has_top, const char *top,
2667 bool has_backing_file, const char *backing_file,
2668 bool has_speed, int64_t speed,
2669 Error **errp)
2671 BlockBackend *blk;
2672 BlockDriverState *bs;
2673 BlockDriverState *base_bs, *top_bs;
2674 AioContext *aio_context;
2675 Error *local_err = NULL;
2676 /* This will be part of the QMP command, if/when the
2677 * BlockdevOnError change for blkmirror makes it in
2679 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
2681 if (!has_speed) {
2682 speed = 0;
2685 /* Important Note:
2686 * libvirt relies on the DeviceNotFound error class in order to probe for
2687 * live commit feature versions; for this to work, we must make sure to
2688 * perform the device lookup before any generic errors that may occur in a
2689 * scenario in which all optional arguments are omitted. */
2690 blk = blk_by_name(device);
2691 if (!blk) {
2692 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2693 "Device '%s' not found", device);
2694 return;
2697 aio_context = blk_get_aio_context(blk);
2698 aio_context_acquire(aio_context);
2700 if (!blk_is_available(blk)) {
2701 error_setg(errp, "Device '%s' has no medium", device);
2702 goto out;
2704 bs = blk_bs(blk);
2706 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2707 goto out;
2710 /* default top_bs is the active layer */
2711 top_bs = bs;
2713 if (has_top && top) {
2714 if (strcmp(bs->filename, top) != 0) {
2715 top_bs = bdrv_find_backing_image(bs, top);
2719 if (top_bs == NULL) {
2720 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2721 goto out;
2724 assert(bdrv_get_aio_context(top_bs) == aio_context);
2726 if (has_base && base) {
2727 base_bs = bdrv_find_backing_image(top_bs, base);
2728 } else {
2729 base_bs = bdrv_find_base(top_bs);
2732 if (base_bs == NULL) {
2733 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
2734 goto out;
2737 assert(bdrv_get_aio_context(base_bs) == aio_context);
2739 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2740 goto out;
2743 /* Do not allow attempts to commit an image into itself */
2744 if (top_bs == base_bs) {
2745 error_setg(errp, "cannot commit an image into itself");
2746 goto out;
2749 if (top_bs == bs) {
2750 if (has_backing_file) {
2751 error_setg(errp, "'backing-file' specified,"
2752 " but 'top' is the active layer");
2753 goto out;
2755 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2756 bs, &local_err);
2757 } else {
2758 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
2759 has_backing_file ? backing_file : NULL, &local_err);
2761 if (local_err != NULL) {
2762 error_propagate(errp, local_err);
2763 goto out;
2766 out:
2767 aio_context_release(aio_context);
2770 void qmp_drive_backup(const char *device, const char *target,
2771 bool has_format, const char *format,
2772 enum MirrorSyncMode sync,
2773 bool has_mode, enum NewImageMode mode,
2774 bool has_speed, int64_t speed,
2775 bool has_bitmap, const char *bitmap,
2776 bool has_on_source_error, BlockdevOnError on_source_error,
2777 bool has_on_target_error, BlockdevOnError on_target_error,
2778 Error **errp)
2780 BlockBackend *blk;
2781 BlockDriverState *bs;
2782 BlockDriverState *target_bs;
2783 BlockDriverState *source = NULL;
2784 BdrvDirtyBitmap *bmap = NULL;
2785 AioContext *aio_context;
2786 QDict *options = NULL;
2787 Error *local_err = NULL;
2788 int flags;
2789 int64_t size;
2790 int ret;
2792 if (!has_speed) {
2793 speed = 0;
2795 if (!has_on_source_error) {
2796 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2798 if (!has_on_target_error) {
2799 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2801 if (!has_mode) {
2802 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2805 blk = blk_by_name(device);
2806 if (!blk) {
2807 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2808 "Device '%s' not found", device);
2809 return;
2812 aio_context = blk_get_aio_context(blk);
2813 aio_context_acquire(aio_context);
2815 /* Although backup_run has this check too, we need to use bs->drv below, so
2816 * do an early check redundantly. */
2817 if (!blk_is_available(blk)) {
2818 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2819 goto out;
2821 bs = blk_bs(blk);
2823 if (!has_format) {
2824 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2827 /* Early check to avoid creating target */
2828 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2829 goto out;
2832 flags = bs->open_flags | BDRV_O_RDWR;
2834 /* See if we have a backing HD we can use to create our new image
2835 * on top of. */
2836 if (sync == MIRROR_SYNC_MODE_TOP) {
2837 source = backing_bs(bs);
2838 if (!source) {
2839 sync = MIRROR_SYNC_MODE_FULL;
2842 if (sync == MIRROR_SYNC_MODE_NONE) {
2843 source = bs;
2846 size = bdrv_getlength(bs);
2847 if (size < 0) {
2848 error_setg_errno(errp, -size, "bdrv_getlength failed");
2849 goto out;
2852 if (mode != NEW_IMAGE_MODE_EXISTING) {
2853 assert(format);
2854 if (source) {
2855 bdrv_img_create(target, format, source->filename,
2856 source->drv->format_name, NULL,
2857 size, flags, &local_err, false);
2858 } else {
2859 bdrv_img_create(target, format, NULL, NULL, NULL,
2860 size, flags, &local_err, false);
2864 if (local_err) {
2865 error_propagate(errp, local_err);
2866 goto out;
2869 if (format) {
2870 options = qdict_new();
2871 qdict_put(options, "driver", qstring_from_str(format));
2874 target_bs = NULL;
2875 ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
2876 if (ret < 0) {
2877 error_propagate(errp, local_err);
2878 goto out;
2881 bdrv_set_aio_context(target_bs, aio_context);
2883 if (has_bitmap) {
2884 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
2885 if (!bmap) {
2886 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
2887 goto out;
2891 backup_start(bs, target_bs, speed, sync, bmap,
2892 on_source_error, on_target_error,
2893 block_job_cb, bs, &local_err);
2894 if (local_err != NULL) {
2895 bdrv_unref(target_bs);
2896 error_propagate(errp, local_err);
2897 goto out;
2900 out:
2901 aio_context_release(aio_context);
2904 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2906 return bdrv_named_nodes_list(errp);
2909 void qmp_blockdev_backup(const char *device, const char *target,
2910 enum MirrorSyncMode sync,
2911 bool has_speed, int64_t speed,
2912 bool has_on_source_error,
2913 BlockdevOnError on_source_error,
2914 bool has_on_target_error,
2915 BlockdevOnError on_target_error,
2916 Error **errp)
2918 BlockBackend *blk, *target_blk;
2919 BlockDriverState *bs;
2920 BlockDriverState *target_bs;
2921 Error *local_err = NULL;
2922 AioContext *aio_context;
2924 if (!has_speed) {
2925 speed = 0;
2927 if (!has_on_source_error) {
2928 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2930 if (!has_on_target_error) {
2931 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2934 blk = blk_by_name(device);
2935 if (!blk) {
2936 error_setg(errp, "Device '%s' not found", device);
2937 return;
2940 aio_context = blk_get_aio_context(blk);
2941 aio_context_acquire(aio_context);
2943 if (!blk_is_available(blk)) {
2944 error_setg(errp, "Device '%s' has no medium", device);
2945 goto out;
2947 bs = blk_bs(blk);
2949 target_blk = blk_by_name(target);
2950 if (!target_blk) {
2951 error_setg(errp, "Device '%s' not found", target);
2952 goto out;
2955 if (!blk_is_available(target_blk)) {
2956 error_setg(errp, "Device '%s' has no medium", target);
2957 goto out;
2959 target_bs = blk_bs(target_blk);
2961 bdrv_ref(target_bs);
2962 bdrv_set_aio_context(target_bs, aio_context);
2963 backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
2964 on_target_error, block_job_cb, bs, &local_err);
2965 if (local_err != NULL) {
2966 bdrv_unref(target_bs);
2967 error_propagate(errp, local_err);
2969 out:
2970 aio_context_release(aio_context);
2973 void qmp_drive_mirror(const char *device, const char *target,
2974 bool has_format, const char *format,
2975 bool has_node_name, const char *node_name,
2976 bool has_replaces, const char *replaces,
2977 enum MirrorSyncMode sync,
2978 bool has_mode, enum NewImageMode mode,
2979 bool has_speed, int64_t speed,
2980 bool has_granularity, uint32_t granularity,
2981 bool has_buf_size, int64_t buf_size,
2982 bool has_on_source_error, BlockdevOnError on_source_error,
2983 bool has_on_target_error, BlockdevOnError on_target_error,
2984 bool has_unmap, bool unmap,
2985 Error **errp)
2987 BlockBackend *blk;
2988 BlockDriverState *bs;
2989 BlockDriverState *source, *target_bs;
2990 AioContext *aio_context;
2991 Error *local_err = NULL;
2992 QDict *options;
2993 int flags;
2994 int64_t size;
2995 int ret;
2997 if (!has_speed) {
2998 speed = 0;
3000 if (!has_on_source_error) {
3001 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3003 if (!has_on_target_error) {
3004 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3006 if (!has_mode) {
3007 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3009 if (!has_granularity) {
3010 granularity = 0;
3012 if (!has_buf_size) {
3013 buf_size = 0;
3015 if (!has_unmap) {
3016 unmap = true;
3019 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3020 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3021 "a value in range [512B, 64MB]");
3022 return;
3024 if (granularity & (granularity - 1)) {
3025 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3026 "power of 2");
3027 return;
3030 blk = blk_by_name(device);
3031 if (!blk) {
3032 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3033 "Device '%s' not found", device);
3034 return;
3037 aio_context = blk_get_aio_context(blk);
3038 aio_context_acquire(aio_context);
3040 if (!blk_is_available(blk)) {
3041 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3042 goto out;
3044 bs = blk_bs(blk);
3046 if (!has_format) {
3047 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
3050 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
3051 goto out;
3054 flags = bs->open_flags | BDRV_O_RDWR;
3055 source = backing_bs(bs);
3056 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
3057 sync = MIRROR_SYNC_MODE_FULL;
3059 if (sync == MIRROR_SYNC_MODE_NONE) {
3060 source = bs;
3063 size = bdrv_getlength(bs);
3064 if (size < 0) {
3065 error_setg_errno(errp, -size, "bdrv_getlength failed");
3066 goto out;
3069 if (has_replaces) {
3070 BlockDriverState *to_replace_bs;
3071 AioContext *replace_aio_context;
3072 int64_t replace_size;
3074 if (!has_node_name) {
3075 error_setg(errp, "a node-name must be provided when replacing a"
3076 " named node of the graph");
3077 goto out;
3080 to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
3082 if (!to_replace_bs) {
3083 error_propagate(errp, local_err);
3084 goto out;
3087 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3088 aio_context_acquire(replace_aio_context);
3089 replace_size = bdrv_getlength(to_replace_bs);
3090 aio_context_release(replace_aio_context);
3092 if (size != replace_size) {
3093 error_setg(errp, "cannot replace image with a mirror image of "
3094 "different size");
3095 goto out;
3099 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
3100 && mode != NEW_IMAGE_MODE_EXISTING)
3102 /* create new image w/o backing file */
3103 assert(format);
3104 bdrv_img_create(target, format,
3105 NULL, NULL, NULL, size, flags, &local_err, false);
3106 } else {
3107 switch (mode) {
3108 case NEW_IMAGE_MODE_EXISTING:
3109 break;
3110 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3111 /* create new image with backing file */
3112 bdrv_img_create(target, format,
3113 source->filename,
3114 source->drv->format_name,
3115 NULL, size, flags, &local_err, false);
3116 break;
3117 default:
3118 abort();
3122 if (local_err) {
3123 error_propagate(errp, local_err);
3124 goto out;
3127 options = qdict_new();
3128 if (has_node_name) {
3129 qdict_put(options, "node-name", qstring_from_str(node_name));
3131 if (format) {
3132 qdict_put(options, "driver", qstring_from_str(format));
3135 /* Mirroring takes care of copy-on-write using the source's backing
3136 * file.
3138 target_bs = NULL;
3139 ret = bdrv_open(&target_bs, target, NULL, options,
3140 flags | BDRV_O_NO_BACKING, &local_err);
3141 if (ret < 0) {
3142 error_propagate(errp, local_err);
3143 goto out;
3146 bdrv_set_aio_context(target_bs, aio_context);
3148 /* pass the node name to replace to mirror start since it's loose coupling
3149 * and will allow to check whether the node still exist at mirror completion
3151 mirror_start(bs, target_bs,
3152 has_replaces ? replaces : NULL,
3153 speed, granularity, buf_size, sync,
3154 on_source_error, on_target_error,
3155 unmap,
3156 block_job_cb, bs, &local_err);
3157 if (local_err != NULL) {
3158 bdrv_unref(target_bs);
3159 error_propagate(errp, local_err);
3160 goto out;
3163 out:
3164 aio_context_release(aio_context);
3167 /* Get the block job for a given device name and acquire its AioContext */
3168 static BlockJob *find_block_job(const char *device, AioContext **aio_context,
3169 Error **errp)
3171 BlockBackend *blk;
3172 BlockDriverState *bs;
3174 *aio_context = NULL;
3176 blk = blk_by_name(device);
3177 if (!blk) {
3178 goto notfound;
3181 *aio_context = blk_get_aio_context(blk);
3182 aio_context_acquire(*aio_context);
3184 if (!blk_is_available(blk)) {
3185 goto notfound;
3187 bs = blk_bs(blk);
3189 if (!bs->job) {
3190 goto notfound;
3193 return bs->job;
3195 notfound:
3196 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3197 "No active block job on device '%s'", device);
3198 if (*aio_context) {
3199 aio_context_release(*aio_context);
3200 *aio_context = NULL;
3202 return NULL;
3205 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3207 AioContext *aio_context;
3208 BlockJob *job = find_block_job(device, &aio_context, errp);
3210 if (!job) {
3211 return;
3214 block_job_set_speed(job, speed, errp);
3215 aio_context_release(aio_context);
3218 void qmp_block_job_cancel(const char *device,
3219 bool has_force, bool force, Error **errp)
3221 AioContext *aio_context;
3222 BlockJob *job = find_block_job(device, &aio_context, errp);
3224 if (!job) {
3225 return;
3228 if (!has_force) {
3229 force = false;
3232 if (job->user_paused && !force) {
3233 error_setg(errp, "The block job for device '%s' is currently paused",
3234 device);
3235 goto out;
3238 trace_qmp_block_job_cancel(job);
3239 block_job_cancel(job);
3240 out:
3241 aio_context_release(aio_context);
3244 void qmp_block_job_pause(const char *device, Error **errp)
3246 AioContext *aio_context;
3247 BlockJob *job = find_block_job(device, &aio_context, errp);
3249 if (!job || job->user_paused) {
3250 return;
3253 job->user_paused = true;
3254 trace_qmp_block_job_pause(job);
3255 block_job_pause(job);
3256 aio_context_release(aio_context);
3259 void qmp_block_job_resume(const char *device, Error **errp)
3261 AioContext *aio_context;
3262 BlockJob *job = find_block_job(device, &aio_context, errp);
3264 if (!job || !job->user_paused) {
3265 return;
3268 job->user_paused = false;
3269 trace_qmp_block_job_resume(job);
3270 block_job_resume(job);
3271 aio_context_release(aio_context);
3274 void qmp_block_job_complete(const char *device, Error **errp)
3276 AioContext *aio_context;
3277 BlockJob *job = find_block_job(device, &aio_context, errp);
3279 if (!job) {
3280 return;
3283 trace_qmp_block_job_complete(job);
3284 block_job_complete(job, errp);
3285 aio_context_release(aio_context);
3288 void qmp_change_backing_file(const char *device,
3289 const char *image_node_name,
3290 const char *backing_file,
3291 Error **errp)
3293 BlockBackend *blk;
3294 BlockDriverState *bs = NULL;
3295 AioContext *aio_context;
3296 BlockDriverState *image_bs = NULL;
3297 Error *local_err = NULL;
3298 bool ro;
3299 int open_flags;
3300 int ret;
3302 blk = blk_by_name(device);
3303 if (!blk) {
3304 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3305 "Device '%s' not found", device);
3306 return;
3309 aio_context = blk_get_aio_context(blk);
3310 aio_context_acquire(aio_context);
3312 if (!blk_is_available(blk)) {
3313 error_setg(errp, "Device '%s' has no medium", device);
3314 goto out;
3316 bs = blk_bs(blk);
3318 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3319 if (local_err) {
3320 error_propagate(errp, local_err);
3321 goto out;
3324 if (!image_bs) {
3325 error_setg(errp, "image file not found");
3326 goto out;
3329 if (bdrv_find_base(image_bs) == image_bs) {
3330 error_setg(errp, "not allowing backing file change on an image "
3331 "without a backing file");
3332 goto out;
3335 /* even though we are not necessarily operating on bs, we need it to
3336 * determine if block ops are currently prohibited on the chain */
3337 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3338 goto out;
3341 /* final sanity check */
3342 if (!bdrv_chain_contains(bs, image_bs)) {
3343 error_setg(errp, "'%s' and image file are not in the same chain",
3344 device);
3345 goto out;
3348 /* if not r/w, reopen to make r/w */
3349 open_flags = image_bs->open_flags;
3350 ro = bdrv_is_read_only(image_bs);
3352 if (ro) {
3353 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3354 if (local_err) {
3355 error_propagate(errp, local_err);
3356 goto out;
3360 ret = bdrv_change_backing_file(image_bs, backing_file,
3361 image_bs->drv ? image_bs->drv->format_name : "");
3363 if (ret < 0) {
3364 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3365 backing_file);
3366 /* don't exit here, so we can try to restore open flags if
3367 * appropriate */
3370 if (ro) {
3371 bdrv_reopen(image_bs, open_flags, &local_err);
3372 if (local_err) {
3373 error_propagate(errp, local_err); /* will preserve prior errp */
3377 out:
3378 aio_context_release(aio_context);
3381 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3383 QmpOutputVisitor *ov = qmp_output_visitor_new();
3384 BlockDriverState *bs;
3385 BlockBackend *blk = NULL;
3386 QObject *obj;
3387 QDict *qdict;
3388 Error *local_err = NULL;
3390 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3391 * cache.direct=false instead of silently switching to aio=threads, except
3392 * when called from drive_new().
3394 * For now, simply forbidding the combination for all drivers will do. */
3395 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3396 bool direct = options->has_cache &&
3397 options->cache->has_direct &&
3398 options->cache->direct;
3399 if (!direct) {
3400 error_setg(errp, "aio=native requires cache.direct=true");
3401 goto fail;
3405 visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
3406 &options, NULL, &local_err);
3407 if (local_err) {
3408 error_propagate(errp, local_err);
3409 goto fail;
3412 obj = qmp_output_get_qobject(ov);
3413 qdict = qobject_to_qdict(obj);
3415 qdict_flatten(qdict);
3417 if (options->has_id) {
3418 blk = blockdev_init(NULL, qdict, &local_err);
3419 if (local_err) {
3420 error_propagate(errp, local_err);
3421 goto fail;
3424 bs = blk_bs(blk);
3425 } else {
3426 if (!qdict_get_try_str(qdict, "node-name")) {
3427 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3428 "the root node");
3429 goto fail;
3432 bs = bds_tree_init(qdict, errp);
3433 if (!bs) {
3434 goto fail;
3438 if (bs && bdrv_key_required(bs)) {
3439 if (blk) {
3440 blk_unref(blk);
3441 } else {
3442 bdrv_unref(bs);
3444 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3445 goto fail;
3448 fail:
3449 qmp_output_visitor_cleanup(ov);
3452 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3454 BlockJobInfoList *head = NULL, **p_next = &head;
3455 BlockDriverState *bs;
3457 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
3458 AioContext *aio_context = bdrv_get_aio_context(bs);
3460 aio_context_acquire(aio_context);
3462 if (bs->job) {
3463 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
3464 elem->value = block_job_query(bs->job);
3465 *p_next = elem;
3466 p_next = &elem->next;
3469 aio_context_release(aio_context);
3472 return head;
3475 QemuOptsList qemu_common_drive_opts = {
3476 .name = "drive",
3477 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3478 .desc = {
3480 .name = "snapshot",
3481 .type = QEMU_OPT_BOOL,
3482 .help = "enable/disable snapshot mode",
3484 .name = "discard",
3485 .type = QEMU_OPT_STRING,
3486 .help = "discard operation (ignore/off, unmap/on)",
3488 .name = BDRV_OPT_CACHE_WB,
3489 .type = QEMU_OPT_BOOL,
3490 .help = "enables writeback mode for any caches",
3492 .name = BDRV_OPT_CACHE_DIRECT,
3493 .type = QEMU_OPT_BOOL,
3494 .help = "enables use of O_DIRECT (bypass the host page cache)",
3496 .name = BDRV_OPT_CACHE_NO_FLUSH,
3497 .type = QEMU_OPT_BOOL,
3498 .help = "ignore any flush requests for the device",
3500 .name = "aio",
3501 .type = QEMU_OPT_STRING,
3502 .help = "host AIO implementation (threads, native)",
3504 .name = "format",
3505 .type = QEMU_OPT_STRING,
3506 .help = "disk format (raw, qcow2, ...)",
3508 .name = "rerror",
3509 .type = QEMU_OPT_STRING,
3510 .help = "read error action",
3512 .name = "werror",
3513 .type = QEMU_OPT_STRING,
3514 .help = "write error action",
3516 .name = "read-only",
3517 .type = QEMU_OPT_BOOL,
3518 .help = "open drive file as read-only",
3520 .name = "throttling.iops-total",
3521 .type = QEMU_OPT_NUMBER,
3522 .help = "limit total I/O operations per second",
3524 .name = "throttling.iops-read",
3525 .type = QEMU_OPT_NUMBER,
3526 .help = "limit read operations per second",
3528 .name = "throttling.iops-write",
3529 .type = QEMU_OPT_NUMBER,
3530 .help = "limit write operations per second",
3532 .name = "throttling.bps-total",
3533 .type = QEMU_OPT_NUMBER,
3534 .help = "limit total bytes per second",
3536 .name = "throttling.bps-read",
3537 .type = QEMU_OPT_NUMBER,
3538 .help = "limit read bytes per second",
3540 .name = "throttling.bps-write",
3541 .type = QEMU_OPT_NUMBER,
3542 .help = "limit write bytes per second",
3544 .name = "throttling.iops-total-max",
3545 .type = QEMU_OPT_NUMBER,
3546 .help = "I/O operations burst",
3548 .name = "throttling.iops-read-max",
3549 .type = QEMU_OPT_NUMBER,
3550 .help = "I/O operations read burst",
3552 .name = "throttling.iops-write-max",
3553 .type = QEMU_OPT_NUMBER,
3554 .help = "I/O operations write burst",
3556 .name = "throttling.bps-total-max",
3557 .type = QEMU_OPT_NUMBER,
3558 .help = "total bytes burst",
3560 .name = "throttling.bps-read-max",
3561 .type = QEMU_OPT_NUMBER,
3562 .help = "total bytes read burst",
3564 .name = "throttling.bps-write-max",
3565 .type = QEMU_OPT_NUMBER,
3566 .help = "total bytes write burst",
3568 .name = "throttling.iops-size",
3569 .type = QEMU_OPT_NUMBER,
3570 .help = "when limiting by iops max size of an I/O in bytes",
3572 .name = "throttling.group",
3573 .type = QEMU_OPT_STRING,
3574 .help = "name of the block throttling group",
3576 .name = "copy-on-read",
3577 .type = QEMU_OPT_BOOL,
3578 .help = "copy read data from backing file into image file",
3580 .name = "detect-zeroes",
3581 .type = QEMU_OPT_STRING,
3582 .help = "try to optimize zero writes (off, on, unmap)",
3584 { /* end of list */ }
3588 static QemuOptsList qemu_root_bds_opts = {
3589 .name = "root-bds",
3590 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3591 .desc = {
3593 .name = "discard",
3594 .type = QEMU_OPT_STRING,
3595 .help = "discard operation (ignore/off, unmap/on)",
3597 .name = "cache.writeback",
3598 .type = QEMU_OPT_BOOL,
3599 .help = "enables writeback mode for any caches",
3601 .name = "cache.direct",
3602 .type = QEMU_OPT_BOOL,
3603 .help = "enables use of O_DIRECT (bypass the host page cache)",
3605 .name = "cache.no-flush",
3606 .type = QEMU_OPT_BOOL,
3607 .help = "ignore any flush requests for the device",
3609 .name = "aio",
3610 .type = QEMU_OPT_STRING,
3611 .help = "host AIO implementation (threads, native)",
3613 .name = "read-only",
3614 .type = QEMU_OPT_BOOL,
3615 .help = "open drive file as read-only",
3617 .name = "copy-on-read",
3618 .type = QEMU_OPT_BOOL,
3619 .help = "copy read data from backing file into image file",
3621 .name = "detect-zeroes",
3622 .type = QEMU_OPT_STRING,
3623 .help = "try to optimize zero writes (off, on, unmap)",
3625 { /* end of list */ }
3629 QemuOptsList qemu_drive_opts = {
3630 .name = "drive",
3631 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3632 .desc = {
3634 * no elements => accept any params
3635 * validation will happen later
3637 { /* end of list */ }