blockdev: acquire AioContext in QMP 'transaction' actions
[qemu/qmp-unstable.git] / blockdev.c
blobea59c39c15b5fb94c27c9c7949a486072658d3e2
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 "monitor/monitor.h"
38 #include "qemu/option.h"
39 #include "qemu/config-file.h"
40 #include "qapi/qmp/types.h"
41 #include "qapi-visit.h"
42 #include "qapi/qmp-output-visitor.h"
43 #include "qapi/util.h"
44 #include "sysemu/sysemu.h"
45 #include "block/block_int.h"
46 #include "qmp-commands.h"
47 #include "trace.h"
48 #include "sysemu/arch_init.h"
50 static const char *const if_name[IF_COUNT] = {
51 [IF_NONE] = "none",
52 [IF_IDE] = "ide",
53 [IF_SCSI] = "scsi",
54 [IF_FLOPPY] = "floppy",
55 [IF_PFLASH] = "pflash",
56 [IF_MTD] = "mtd",
57 [IF_SD] = "sd",
58 [IF_VIRTIO] = "virtio",
59 [IF_XEN] = "xen",
62 static int if_max_devs[IF_COUNT] = {
64 * Do not change these numbers! They govern how drive option
65 * index maps to unit and bus. That mapping is ABI.
67 * All controllers used to imlement if=T drives need to support
68 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
69 * Otherwise, some index values map to "impossible" bus, unit
70 * values.
72 * For instance, if you change [IF_SCSI] to 255, -drive
73 * if=scsi,index=12 no longer means bus=1,unit=5, but
74 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
75 * the drive can't be set up. Regression.
77 [IF_IDE] = 2,
78 [IF_SCSI] = 7,
81 /**
82 * Boards may call this to offer board-by-board overrides
83 * of the default, global values.
85 void override_max_devs(BlockInterfaceType type, int max_devs)
87 BlockBackend *blk;
88 DriveInfo *dinfo;
90 if (max_devs <= 0) {
91 return;
94 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
95 dinfo = blk_legacy_dinfo(blk);
96 if (dinfo->type == type) {
97 fprintf(stderr, "Cannot override units-per-bus property of"
98 " the %s interface, because a drive of that type has"
99 " already been added.\n", if_name[type]);
100 g_assert_not_reached();
104 if_max_devs[type] = max_devs;
108 * We automatically delete the drive when a device using it gets
109 * unplugged. Questionable feature, but we can't just drop it.
110 * Device models call blockdev_mark_auto_del() to schedule the
111 * automatic deletion, and generic qdev code calls blockdev_auto_del()
112 * when deletion is actually safe.
114 void blockdev_mark_auto_del(BlockBackend *blk)
116 DriveInfo *dinfo = blk_legacy_dinfo(blk);
117 BlockDriverState *bs = blk_bs(blk);
118 AioContext *aio_context;
120 if (!dinfo) {
121 return;
124 aio_context = bdrv_get_aio_context(bs);
125 aio_context_acquire(aio_context);
127 if (bs->job) {
128 block_job_cancel(bs->job);
131 aio_context_release(aio_context);
133 dinfo->auto_del = 1;
136 void blockdev_auto_del(BlockBackend *blk)
138 DriveInfo *dinfo = blk_legacy_dinfo(blk);
140 if (dinfo && dinfo->auto_del) {
141 blk_unref(blk);
146 * Returns the current mapping of how many units per bus
147 * a particular interface can support.
149 * A positive integer indicates n units per bus.
150 * 0 implies the mapping has not been established.
151 * -1 indicates an invalid BlockInterfaceType was given.
153 int drive_get_max_devs(BlockInterfaceType type)
155 if (type >= IF_IDE && type < IF_COUNT) {
156 return if_max_devs[type];
159 return -1;
162 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
164 int max_devs = if_max_devs[type];
165 return max_devs ? index / max_devs : 0;
168 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
170 int max_devs = if_max_devs[type];
171 return max_devs ? index % max_devs : index;
174 QemuOpts *drive_def(const char *optstr)
176 return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
179 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
180 const char *optstr)
182 QemuOpts *opts;
183 char buf[32];
185 opts = drive_def(optstr);
186 if (!opts) {
187 return NULL;
189 if (type != IF_DEFAULT) {
190 qemu_opt_set(opts, "if", if_name[type]);
192 if (index >= 0) {
193 snprintf(buf, sizeof(buf), "%d", index);
194 qemu_opt_set(opts, "index", buf);
196 if (file)
197 qemu_opt_set(opts, "file", file);
198 return opts;
201 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
203 BlockBackend *blk;
204 DriveInfo *dinfo;
206 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
207 dinfo = blk_legacy_dinfo(blk);
208 if (dinfo && dinfo->type == type
209 && dinfo->bus == bus && dinfo->unit == unit) {
210 return dinfo;
214 return NULL;
217 bool drive_check_orphaned(void)
219 BlockBackend *blk;
220 DriveInfo *dinfo;
221 bool rs = false;
223 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
224 dinfo = blk_legacy_dinfo(blk);
225 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
226 /* Unless this is a default drive, this may be an oversight. */
227 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
228 dinfo->type != IF_NONE) {
229 fprintf(stderr, "Warning: Orphaned drive without device: "
230 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
231 blk_name(blk), blk_bs(blk)->filename, if_name[dinfo->type],
232 dinfo->bus, dinfo->unit);
233 rs = true;
237 return rs;
240 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
242 return drive_get(type,
243 drive_index_to_bus_id(type, index),
244 drive_index_to_unit_id(type, index));
247 int drive_get_max_bus(BlockInterfaceType type)
249 int max_bus;
250 BlockBackend *blk;
251 DriveInfo *dinfo;
253 max_bus = -1;
254 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
255 dinfo = blk_legacy_dinfo(blk);
256 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
257 max_bus = dinfo->bus;
260 return max_bus;
263 /* Get a block device. This should only be used for single-drive devices
264 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
265 appropriate bus. */
266 DriveInfo *drive_get_next(BlockInterfaceType type)
268 static int next_block_unit[IF_COUNT];
270 return drive_get(type, 0, next_block_unit[type]++);
273 static void bdrv_format_print(void *opaque, const char *name)
275 error_printf(" %s", name);
278 typedef struct {
279 QEMUBH *bh;
280 BlockDriverState *bs;
281 } BDRVPutRefBH;
283 static void bdrv_put_ref_bh(void *opaque)
285 BDRVPutRefBH *s = opaque;
287 bdrv_unref(s->bs);
288 qemu_bh_delete(s->bh);
289 g_free(s);
293 * Release a BDS reference in a BH
295 * It is not safe to use bdrv_unref() from a callback function when the callers
296 * still need the BlockDriverState. In such cases we schedule a BH to release
297 * the reference.
299 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
301 BDRVPutRefBH *s;
303 s = g_new(BDRVPutRefBH, 1);
304 s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
305 s->bs = bs;
306 qemu_bh_schedule(s->bh);
309 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
311 if (!strcmp(buf, "ignore")) {
312 return BLOCKDEV_ON_ERROR_IGNORE;
313 } else if (!is_read && !strcmp(buf, "enospc")) {
314 return BLOCKDEV_ON_ERROR_ENOSPC;
315 } else if (!strcmp(buf, "stop")) {
316 return BLOCKDEV_ON_ERROR_STOP;
317 } else if (!strcmp(buf, "report")) {
318 return BLOCKDEV_ON_ERROR_REPORT;
319 } else {
320 error_setg(errp, "'%s' invalid %s error action",
321 buf, is_read ? "read" : "write");
322 return -1;
326 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
328 if (throttle_conflicting(cfg)) {
329 error_setg(errp, "bps/iops/max total values and read/write values"
330 " cannot be used at the same time");
331 return false;
334 if (!throttle_is_valid(cfg)) {
335 error_setg(errp, "bps/iops/maxs values must be 0 or greater");
336 return false;
339 return true;
342 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
344 /* Takes the ownership of bs_opts */
345 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
346 Error **errp)
348 const char *buf;
349 int ro = 0;
350 int bdrv_flags = 0;
351 int on_read_error, on_write_error;
352 BlockBackend *blk;
353 BlockDriverState *bs;
354 ThrottleConfig cfg;
355 int snapshot = 0;
356 bool copy_on_read;
357 int ret;
358 Error *error = NULL;
359 QemuOpts *opts;
360 const char *id;
361 bool has_driver_specific_opts;
362 BlockdevDetectZeroesOptions detect_zeroes;
363 BlockDriver *drv = NULL;
365 /* Check common options by copying from bs_opts to opts, all other options
366 * stay in bs_opts for processing by bdrv_open(). */
367 id = qdict_get_try_str(bs_opts, "id");
368 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
369 if (error) {
370 error_propagate(errp, error);
371 goto err_no_opts;
374 qemu_opts_absorb_qdict(opts, bs_opts, &error);
375 if (error) {
376 error_propagate(errp, error);
377 goto early_err;
380 if (id) {
381 qdict_del(bs_opts, "id");
384 has_driver_specific_opts = !!qdict_size(bs_opts);
386 /* extract parameters */
387 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
388 ro = qemu_opt_get_bool(opts, "read-only", 0);
389 copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
391 if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
392 if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
393 error_setg(errp, "invalid discard option");
394 goto early_err;
398 if (qemu_opt_get_bool(opts, "cache.writeback", true)) {
399 bdrv_flags |= BDRV_O_CACHE_WB;
401 if (qemu_opt_get_bool(opts, "cache.direct", false)) {
402 bdrv_flags |= BDRV_O_NOCACHE;
404 if (qemu_opt_get_bool(opts, "cache.no-flush", false)) {
405 bdrv_flags |= BDRV_O_NO_FLUSH;
408 #ifdef CONFIG_LINUX_AIO
409 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
410 if (!strcmp(buf, "native")) {
411 bdrv_flags |= BDRV_O_NATIVE_AIO;
412 } else if (!strcmp(buf, "threads")) {
413 /* this is the default */
414 } else {
415 error_setg(errp, "invalid aio option");
416 goto early_err;
419 #endif
421 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
422 if (is_help_option(buf)) {
423 error_printf("Supported formats:");
424 bdrv_iterate_format(bdrv_format_print, NULL);
425 error_printf("\n");
426 goto early_err;
429 drv = bdrv_find_format(buf);
430 if (!drv) {
431 error_setg(errp, "'%s' invalid format", buf);
432 goto early_err;
436 /* disk I/O throttling */
437 memset(&cfg, 0, sizeof(cfg));
438 cfg.buckets[THROTTLE_BPS_TOTAL].avg =
439 qemu_opt_get_number(opts, "throttling.bps-total", 0);
440 cfg.buckets[THROTTLE_BPS_READ].avg =
441 qemu_opt_get_number(opts, "throttling.bps-read", 0);
442 cfg.buckets[THROTTLE_BPS_WRITE].avg =
443 qemu_opt_get_number(opts, "throttling.bps-write", 0);
444 cfg.buckets[THROTTLE_OPS_TOTAL].avg =
445 qemu_opt_get_number(opts, "throttling.iops-total", 0);
446 cfg.buckets[THROTTLE_OPS_READ].avg =
447 qemu_opt_get_number(opts, "throttling.iops-read", 0);
448 cfg.buckets[THROTTLE_OPS_WRITE].avg =
449 qemu_opt_get_number(opts, "throttling.iops-write", 0);
451 cfg.buckets[THROTTLE_BPS_TOTAL].max =
452 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
453 cfg.buckets[THROTTLE_BPS_READ].max =
454 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
455 cfg.buckets[THROTTLE_BPS_WRITE].max =
456 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
457 cfg.buckets[THROTTLE_OPS_TOTAL].max =
458 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
459 cfg.buckets[THROTTLE_OPS_READ].max =
460 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
461 cfg.buckets[THROTTLE_OPS_WRITE].max =
462 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
464 cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
466 if (!check_throttle_config(&cfg, &error)) {
467 error_propagate(errp, error);
468 goto early_err;
471 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
472 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
473 on_write_error = parse_block_error_action(buf, 0, &error);
474 if (error) {
475 error_propagate(errp, error);
476 goto early_err;
480 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
481 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
482 on_read_error = parse_block_error_action(buf, 1, &error);
483 if (error) {
484 error_propagate(errp, error);
485 goto early_err;
489 detect_zeroes =
490 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
491 qemu_opt_get(opts, "detect-zeroes"),
492 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
493 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
494 &error);
495 if (error) {
496 error_propagate(errp, error);
497 goto early_err;
500 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
501 !(bdrv_flags & BDRV_O_UNMAP)) {
502 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
503 "without setting discard operation to unmap");
504 goto early_err;
507 /* init */
508 blk = blk_new_with_bs(qemu_opts_id(opts), errp);
509 if (!blk) {
510 goto early_err;
512 bs = blk_bs(blk);
513 bs->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
514 bs->read_only = ro;
515 bs->detect_zeroes = detect_zeroes;
517 bdrv_set_on_error(bs, on_read_error, on_write_error);
519 /* disk I/O throttling */
520 if (throttle_enabled(&cfg)) {
521 bdrv_io_limits_enable(bs);
522 bdrv_set_io_limits(bs, &cfg);
525 if (!file || !*file) {
526 if (has_driver_specific_opts) {
527 file = NULL;
528 } else {
529 QDECREF(bs_opts);
530 qemu_opts_del(opts);
531 return blk;
534 if (snapshot) {
535 /* always use cache=unsafe with snapshot */
536 bdrv_flags &= ~BDRV_O_CACHE_MASK;
537 bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
540 if (copy_on_read) {
541 bdrv_flags |= BDRV_O_COPY_ON_READ;
544 if (runstate_check(RUN_STATE_INMIGRATE)) {
545 bdrv_flags |= BDRV_O_INCOMING;
548 bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
550 QINCREF(bs_opts);
551 ret = bdrv_open(&bs, file, NULL, bs_opts, bdrv_flags, drv, &error);
552 assert(bs == blk_bs(blk));
554 if (ret < 0) {
555 error_setg(errp, "could not open disk image %s: %s",
556 file ?: blk_name(blk), error_get_pretty(error));
557 error_free(error);
558 goto err;
561 if (bdrv_key_required(bs)) {
562 autostart = 0;
565 QDECREF(bs_opts);
566 qemu_opts_del(opts);
568 return blk;
570 err:
571 blk_unref(blk);
572 early_err:
573 qemu_opts_del(opts);
574 err_no_opts:
575 QDECREF(bs_opts);
576 return NULL;
579 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
580 Error **errp)
582 const char *value;
584 value = qemu_opt_get(opts, from);
585 if (value) {
586 if (qemu_opt_find(opts, to)) {
587 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
588 "same time", to, from);
589 return;
593 /* rename all items in opts */
594 while ((value = qemu_opt_get(opts, from))) {
595 qemu_opt_set(opts, to, value);
596 qemu_opt_unset(opts, from);
600 QemuOptsList qemu_legacy_drive_opts = {
601 .name = "drive",
602 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
603 .desc = {
605 .name = "bus",
606 .type = QEMU_OPT_NUMBER,
607 .help = "bus number",
609 .name = "unit",
610 .type = QEMU_OPT_NUMBER,
611 .help = "unit number (i.e. lun for scsi)",
613 .name = "index",
614 .type = QEMU_OPT_NUMBER,
615 .help = "index number",
617 .name = "media",
618 .type = QEMU_OPT_STRING,
619 .help = "media type (disk, cdrom)",
621 .name = "if",
622 .type = QEMU_OPT_STRING,
623 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
625 .name = "cyls",
626 .type = QEMU_OPT_NUMBER,
627 .help = "number of cylinders (ide disk geometry)",
629 .name = "heads",
630 .type = QEMU_OPT_NUMBER,
631 .help = "number of heads (ide disk geometry)",
633 .name = "secs",
634 .type = QEMU_OPT_NUMBER,
635 .help = "number of sectors (ide disk geometry)",
637 .name = "trans",
638 .type = QEMU_OPT_STRING,
639 .help = "chs translation (auto, lba, none)",
641 .name = "boot",
642 .type = QEMU_OPT_BOOL,
643 .help = "(deprecated, ignored)",
645 .name = "addr",
646 .type = QEMU_OPT_STRING,
647 .help = "pci address (virtio only)",
649 .name = "serial",
650 .type = QEMU_OPT_STRING,
651 .help = "disk serial number",
653 .name = "file",
654 .type = QEMU_OPT_STRING,
655 .help = "file name",
658 /* Options that are passed on, but have special semantics with -drive */
660 .name = "read-only",
661 .type = QEMU_OPT_BOOL,
662 .help = "open drive file as read-only",
664 .name = "rerror",
665 .type = QEMU_OPT_STRING,
666 .help = "read error action",
668 .name = "werror",
669 .type = QEMU_OPT_STRING,
670 .help = "write error action",
672 .name = "copy-on-read",
673 .type = QEMU_OPT_BOOL,
674 .help = "copy read data from backing file into image file",
677 { /* end of list */ }
681 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
683 const char *value;
684 BlockBackend *blk;
685 DriveInfo *dinfo = NULL;
686 QDict *bs_opts;
687 QemuOpts *legacy_opts;
688 DriveMediaType media = MEDIA_DISK;
689 BlockInterfaceType type;
690 int cyls, heads, secs, translation;
691 int max_devs, bus_id, unit_id, index;
692 const char *devaddr;
693 const char *werror, *rerror;
694 bool read_only = false;
695 bool copy_on_read;
696 const char *serial;
697 const char *filename;
698 Error *local_err = NULL;
699 int i;
701 /* Change legacy command line options into QMP ones */
702 static const struct {
703 const char *from;
704 const char *to;
705 } opt_renames[] = {
706 { "iops", "throttling.iops-total" },
707 { "iops_rd", "throttling.iops-read" },
708 { "iops_wr", "throttling.iops-write" },
710 { "bps", "throttling.bps-total" },
711 { "bps_rd", "throttling.bps-read" },
712 { "bps_wr", "throttling.bps-write" },
714 { "iops_max", "throttling.iops-total-max" },
715 { "iops_rd_max", "throttling.iops-read-max" },
716 { "iops_wr_max", "throttling.iops-write-max" },
718 { "bps_max", "throttling.bps-total-max" },
719 { "bps_rd_max", "throttling.bps-read-max" },
720 { "bps_wr_max", "throttling.bps-write-max" },
722 { "iops_size", "throttling.iops-size" },
724 { "readonly", "read-only" },
727 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
728 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
729 &local_err);
730 if (local_err) {
731 error_report("%s", error_get_pretty(local_err));
732 error_free(local_err);
733 return NULL;
737 value = qemu_opt_get(all_opts, "cache");
738 if (value) {
739 int flags = 0;
741 if (bdrv_parse_cache_flags(value, &flags) != 0) {
742 error_report("invalid cache option");
743 return NULL;
746 /* Specific options take precedence */
747 if (!qemu_opt_get(all_opts, "cache.writeback")) {
748 qemu_opt_set_bool(all_opts, "cache.writeback",
749 !!(flags & BDRV_O_CACHE_WB));
751 if (!qemu_opt_get(all_opts, "cache.direct")) {
752 qemu_opt_set_bool(all_opts, "cache.direct",
753 !!(flags & BDRV_O_NOCACHE));
755 if (!qemu_opt_get(all_opts, "cache.no-flush")) {
756 qemu_opt_set_bool(all_opts, "cache.no-flush",
757 !!(flags & BDRV_O_NO_FLUSH));
759 qemu_opt_unset(all_opts, "cache");
762 /* Get a QDict for processing the options */
763 bs_opts = qdict_new();
764 qemu_opts_to_qdict(all_opts, bs_opts);
766 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
767 &error_abort);
768 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
769 if (local_err) {
770 error_report("%s", error_get_pretty(local_err));
771 error_free(local_err);
772 goto fail;
775 /* Deprecated option boot=[on|off] */
776 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
777 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
778 "ignored. Future versions will reject this parameter. Please "
779 "update your scripts.\n");
782 /* Media type */
783 value = qemu_opt_get(legacy_opts, "media");
784 if (value) {
785 if (!strcmp(value, "disk")) {
786 media = MEDIA_DISK;
787 } else if (!strcmp(value, "cdrom")) {
788 media = MEDIA_CDROM;
789 read_only = true;
790 } else {
791 error_report("'%s' invalid media", value);
792 goto fail;
796 /* copy-on-read is disabled with a warning for read-only devices */
797 read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
798 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
800 if (read_only && copy_on_read) {
801 error_report("warning: disabling copy-on-read on read-only drive");
802 copy_on_read = false;
805 qdict_put(bs_opts, "read-only",
806 qstring_from_str(read_only ? "on" : "off"));
807 qdict_put(bs_opts, "copy-on-read",
808 qstring_from_str(copy_on_read ? "on" :"off"));
810 /* Controller type */
811 value = qemu_opt_get(legacy_opts, "if");
812 if (value) {
813 for (type = 0;
814 type < IF_COUNT && strcmp(value, if_name[type]);
815 type++) {
817 if (type == IF_COUNT) {
818 error_report("unsupported bus type '%s'", value);
819 goto fail;
821 } else {
822 type = block_default_type;
825 /* Geometry */
826 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
827 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
828 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
830 if (cyls || heads || secs) {
831 if (cyls < 1) {
832 error_report("invalid physical cyls number");
833 goto fail;
835 if (heads < 1) {
836 error_report("invalid physical heads number");
837 goto fail;
839 if (secs < 1) {
840 error_report("invalid physical secs number");
841 goto fail;
845 translation = BIOS_ATA_TRANSLATION_AUTO;
846 value = qemu_opt_get(legacy_opts, "trans");
847 if (value != NULL) {
848 if (!cyls) {
849 error_report("'%s' trans must be used with cyls, heads and secs",
850 value);
851 goto fail;
853 if (!strcmp(value, "none")) {
854 translation = BIOS_ATA_TRANSLATION_NONE;
855 } else if (!strcmp(value, "lba")) {
856 translation = BIOS_ATA_TRANSLATION_LBA;
857 } else if (!strcmp(value, "large")) {
858 translation = BIOS_ATA_TRANSLATION_LARGE;
859 } else if (!strcmp(value, "rechs")) {
860 translation = BIOS_ATA_TRANSLATION_RECHS;
861 } else if (!strcmp(value, "auto")) {
862 translation = BIOS_ATA_TRANSLATION_AUTO;
863 } else {
864 error_report("'%s' invalid translation type", value);
865 goto fail;
869 if (media == MEDIA_CDROM) {
870 if (cyls || secs || heads) {
871 error_report("CHS can't be set with media=cdrom");
872 goto fail;
876 /* Device address specified by bus/unit or index.
877 * If none was specified, try to find the first free one. */
878 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
879 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
880 index = qemu_opt_get_number(legacy_opts, "index", -1);
882 max_devs = if_max_devs[type];
884 if (index != -1) {
885 if (bus_id != 0 || unit_id != -1) {
886 error_report("index cannot be used with bus and unit");
887 goto fail;
889 bus_id = drive_index_to_bus_id(type, index);
890 unit_id = drive_index_to_unit_id(type, index);
893 if (unit_id == -1) {
894 unit_id = 0;
895 while (drive_get(type, bus_id, unit_id) != NULL) {
896 unit_id++;
897 if (max_devs && unit_id >= max_devs) {
898 unit_id -= max_devs;
899 bus_id++;
904 if (max_devs && unit_id >= max_devs) {
905 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
906 goto fail;
909 if (drive_get(type, bus_id, unit_id) != NULL) {
910 error_report("drive with bus=%d, unit=%d (index=%d) exists",
911 bus_id, unit_id, index);
912 goto fail;
915 /* Serial number */
916 serial = qemu_opt_get(legacy_opts, "serial");
918 /* no id supplied -> create one */
919 if (qemu_opts_id(all_opts) == NULL) {
920 char *new_id;
921 const char *mediastr = "";
922 if (type == IF_IDE || type == IF_SCSI) {
923 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
925 if (max_devs) {
926 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
927 mediastr, unit_id);
928 } else {
929 new_id = g_strdup_printf("%s%s%i", if_name[type],
930 mediastr, unit_id);
932 qdict_put(bs_opts, "id", qstring_from_str(new_id));
933 g_free(new_id);
936 /* Add virtio block device */
937 devaddr = qemu_opt_get(legacy_opts, "addr");
938 if (devaddr && type != IF_VIRTIO) {
939 error_report("addr is not supported by this bus type");
940 goto fail;
943 if (type == IF_VIRTIO) {
944 QemuOpts *devopts;
945 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
946 &error_abort);
947 if (arch_type == QEMU_ARCH_S390X) {
948 qemu_opt_set(devopts, "driver", "virtio-blk-s390");
949 } else {
950 qemu_opt_set(devopts, "driver", "virtio-blk-pci");
952 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"));
953 if (devaddr) {
954 qemu_opt_set(devopts, "addr", devaddr);
958 filename = qemu_opt_get(legacy_opts, "file");
960 /* Check werror/rerror compatibility with if=... */
961 werror = qemu_opt_get(legacy_opts, "werror");
962 if (werror != NULL) {
963 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
964 type != IF_NONE) {
965 error_report("werror is not supported by this bus type");
966 goto fail;
968 qdict_put(bs_opts, "werror", qstring_from_str(werror));
971 rerror = qemu_opt_get(legacy_opts, "rerror");
972 if (rerror != NULL) {
973 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
974 type != IF_NONE) {
975 error_report("rerror is not supported by this bus type");
976 goto fail;
978 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
981 /* Actual block device init: Functionality shared with blockdev-add */
982 blk = blockdev_init(filename, bs_opts, &local_err);
983 bs_opts = NULL;
984 if (!blk) {
985 if (local_err) {
986 error_report("%s", error_get_pretty(local_err));
987 error_free(local_err);
989 goto fail;
990 } else {
991 assert(!local_err);
994 /* Create legacy DriveInfo */
995 dinfo = g_malloc0(sizeof(*dinfo));
996 dinfo->opts = all_opts;
998 dinfo->cyls = cyls;
999 dinfo->heads = heads;
1000 dinfo->secs = secs;
1001 dinfo->trans = translation;
1003 dinfo->type = type;
1004 dinfo->bus = bus_id;
1005 dinfo->unit = unit_id;
1006 dinfo->devaddr = devaddr;
1007 dinfo->serial = g_strdup(serial);
1009 blk_set_legacy_dinfo(blk, dinfo);
1011 switch(type) {
1012 case IF_IDE:
1013 case IF_SCSI:
1014 case IF_XEN:
1015 case IF_NONE:
1016 dinfo->media_cd = media == MEDIA_CDROM;
1017 break;
1018 default:
1019 break;
1022 fail:
1023 qemu_opts_del(legacy_opts);
1024 QDECREF(bs_opts);
1025 return dinfo;
1028 void do_commit(Monitor *mon, const QDict *qdict)
1030 const char *device = qdict_get_str(qdict, "device");
1031 BlockDriverState *bs;
1032 int ret;
1034 if (!strcmp(device, "all")) {
1035 ret = bdrv_commit_all();
1036 } else {
1037 bs = bdrv_find(device);
1038 if (!bs) {
1039 monitor_printf(mon, "Device '%s' not found\n", device);
1040 return;
1042 ret = bdrv_commit(bs);
1044 if (ret < 0) {
1045 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1046 strerror(-ret));
1050 static void blockdev_do_action(int kind, void *data, Error **errp)
1052 TransactionAction action;
1053 TransactionActionList list;
1055 action.kind = kind;
1056 action.data = data;
1057 list.value = &action;
1058 list.next = NULL;
1059 qmp_transaction(&list, errp);
1062 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1063 bool has_node_name, const char *node_name,
1064 const char *snapshot_file,
1065 bool has_snapshot_node_name,
1066 const char *snapshot_node_name,
1067 bool has_format, const char *format,
1068 bool has_mode, NewImageMode mode, Error **errp)
1070 BlockdevSnapshot snapshot = {
1071 .has_device = has_device,
1072 .device = (char *) device,
1073 .has_node_name = has_node_name,
1074 .node_name = (char *) node_name,
1075 .snapshot_file = (char *) snapshot_file,
1076 .has_snapshot_node_name = has_snapshot_node_name,
1077 .snapshot_node_name = (char *) snapshot_node_name,
1078 .has_format = has_format,
1079 .format = (char *) format,
1080 .has_mode = has_mode,
1081 .mode = mode,
1083 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1084 &snapshot, errp);
1087 void qmp_blockdev_snapshot_internal_sync(const char *device,
1088 const char *name,
1089 Error **errp)
1091 BlockdevSnapshotInternal snapshot = {
1092 .device = (char *) device,
1093 .name = (char *) name
1096 blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1097 &snapshot, errp);
1100 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1101 bool has_id,
1102 const char *id,
1103 bool has_name,
1104 const char *name,
1105 Error **errp)
1107 BlockDriverState *bs = bdrv_find(device);
1108 AioContext *aio_context;
1109 QEMUSnapshotInfo sn;
1110 Error *local_err = NULL;
1111 SnapshotInfo *info = NULL;
1112 int ret;
1114 if (!bs) {
1115 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1116 return NULL;
1119 if (!has_id) {
1120 id = NULL;
1123 if (!has_name) {
1124 name = NULL;
1127 if (!id && !name) {
1128 error_setg(errp, "Name or id must be provided");
1129 return NULL;
1132 aio_context = bdrv_get_aio_context(bs);
1133 aio_context_acquire(aio_context);
1135 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1136 goto out_aio_context;
1139 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1140 if (local_err) {
1141 error_propagate(errp, local_err);
1142 goto out_aio_context;
1144 if (!ret) {
1145 error_setg(errp,
1146 "Snapshot with id '%s' and name '%s' does not exist on "
1147 "device '%s'",
1148 STR_OR_NULL(id), STR_OR_NULL(name), device);
1149 goto out_aio_context;
1152 bdrv_snapshot_delete(bs, id, name, &local_err);
1153 if (local_err) {
1154 error_propagate(errp, local_err);
1155 goto out_aio_context;
1158 aio_context_release(aio_context);
1160 info = g_new0(SnapshotInfo, 1);
1161 info->id = g_strdup(sn.id_str);
1162 info->name = g_strdup(sn.name);
1163 info->date_nsec = sn.date_nsec;
1164 info->date_sec = sn.date_sec;
1165 info->vm_state_size = sn.vm_state_size;
1166 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1167 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1169 return info;
1171 out_aio_context:
1172 aio_context_release(aio_context);
1173 return NULL;
1176 /* New and old BlockDriverState structs for atomic group operations */
1178 typedef struct BlkTransactionState BlkTransactionState;
1180 /* Only prepare() may fail. In a single transaction, only one of commit() or
1181 abort() will be called, clean() will always be called if it present. */
1182 typedef struct BdrvActionOps {
1183 /* Size of state struct, in bytes. */
1184 size_t instance_size;
1185 /* Prepare the work, must NOT be NULL. */
1186 void (*prepare)(BlkTransactionState *common, Error **errp);
1187 /* Commit the changes, can be NULL. */
1188 void (*commit)(BlkTransactionState *common);
1189 /* Abort the changes on fail, can be NULL. */
1190 void (*abort)(BlkTransactionState *common);
1191 /* Clean up resource in the end, can be NULL. */
1192 void (*clean)(BlkTransactionState *common);
1193 } BdrvActionOps;
1196 * This structure must be arranged as first member in child type, assuming
1197 * that compiler will also arrange it to the same address with parent instance.
1198 * Later it will be used in free().
1200 struct BlkTransactionState {
1201 TransactionAction *action;
1202 const BdrvActionOps *ops;
1203 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1206 /* internal snapshot private data */
1207 typedef struct InternalSnapshotState {
1208 BlkTransactionState common;
1209 BlockDriverState *bs;
1210 AioContext *aio_context;
1211 QEMUSnapshotInfo sn;
1212 } InternalSnapshotState;
1214 static void internal_snapshot_prepare(BlkTransactionState *common,
1215 Error **errp)
1217 Error *local_err = NULL;
1218 const char *device;
1219 const char *name;
1220 BlockDriverState *bs;
1221 QEMUSnapshotInfo old_sn, *sn;
1222 bool ret;
1223 qemu_timeval tv;
1224 BlockdevSnapshotInternal *internal;
1225 InternalSnapshotState *state;
1226 int ret1;
1228 g_assert(common->action->kind ==
1229 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1230 internal = common->action->blockdev_snapshot_internal_sync;
1231 state = DO_UPCAST(InternalSnapshotState, common, common);
1233 /* 1. parse input */
1234 device = internal->device;
1235 name = internal->name;
1237 /* 2. check for validation */
1238 bs = bdrv_find(device);
1239 if (!bs) {
1240 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1241 return;
1244 /* AioContext is released in .clean() */
1245 state->aio_context = bdrv_get_aio_context(bs);
1246 aio_context_acquire(state->aio_context);
1248 if (!bdrv_is_inserted(bs)) {
1249 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1250 return;
1253 if (bdrv_is_read_only(bs)) {
1254 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1255 return;
1258 if (!bdrv_can_snapshot(bs)) {
1259 error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1260 bs->drv->format_name, device, "internal snapshot");
1261 return;
1264 if (!strlen(name)) {
1265 error_setg(errp, "Name is empty");
1266 return;
1269 /* check whether a snapshot with name exist */
1270 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1271 &local_err);
1272 if (local_err) {
1273 error_propagate(errp, local_err);
1274 return;
1275 } else if (ret) {
1276 error_setg(errp,
1277 "Snapshot with name '%s' already exists on device '%s'",
1278 name, device);
1279 return;
1282 /* 3. take the snapshot */
1283 sn = &state->sn;
1284 pstrcpy(sn->name, sizeof(sn->name), name);
1285 qemu_gettimeofday(&tv);
1286 sn->date_sec = tv.tv_sec;
1287 sn->date_nsec = tv.tv_usec * 1000;
1288 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1290 ret1 = bdrv_snapshot_create(bs, sn);
1291 if (ret1 < 0) {
1292 error_setg_errno(errp, -ret1,
1293 "Failed to create snapshot '%s' on device '%s'",
1294 name, device);
1295 return;
1298 /* 4. succeed, mark a snapshot is created */
1299 state->bs = bs;
1302 static void internal_snapshot_abort(BlkTransactionState *common)
1304 InternalSnapshotState *state =
1305 DO_UPCAST(InternalSnapshotState, common, common);
1306 BlockDriverState *bs = state->bs;
1307 QEMUSnapshotInfo *sn = &state->sn;
1308 Error *local_error = NULL;
1310 if (!bs) {
1311 return;
1314 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1315 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1316 "device '%s' in abort: %s",
1317 sn->id_str,
1318 sn->name,
1319 bdrv_get_device_name(bs),
1320 error_get_pretty(local_error));
1321 error_free(local_error);
1325 static void internal_snapshot_clean(BlkTransactionState *common)
1327 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1328 common, common);
1330 if (state->aio_context) {
1331 aio_context_release(state->aio_context);
1335 /* external snapshot private data */
1336 typedef struct ExternalSnapshotState {
1337 BlkTransactionState common;
1338 BlockDriverState *old_bs;
1339 BlockDriverState *new_bs;
1340 AioContext *aio_context;
1341 } ExternalSnapshotState;
1343 static void external_snapshot_prepare(BlkTransactionState *common,
1344 Error **errp)
1346 BlockDriver *drv;
1347 int flags, ret;
1348 QDict *options = NULL;
1349 Error *local_err = NULL;
1350 bool has_device = false;
1351 const char *device;
1352 bool has_node_name = false;
1353 const char *node_name;
1354 bool has_snapshot_node_name = false;
1355 const char *snapshot_node_name;
1356 const char *new_image_file;
1357 const char *format = "qcow2";
1358 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1359 ExternalSnapshotState *state =
1360 DO_UPCAST(ExternalSnapshotState, common, common);
1361 TransactionAction *action = common->action;
1363 /* get parameters */
1364 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1366 has_device = action->blockdev_snapshot_sync->has_device;
1367 device = action->blockdev_snapshot_sync->device;
1368 has_node_name = action->blockdev_snapshot_sync->has_node_name;
1369 node_name = action->blockdev_snapshot_sync->node_name;
1370 has_snapshot_node_name =
1371 action->blockdev_snapshot_sync->has_snapshot_node_name;
1372 snapshot_node_name = action->blockdev_snapshot_sync->snapshot_node_name;
1374 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1375 if (action->blockdev_snapshot_sync->has_format) {
1376 format = action->blockdev_snapshot_sync->format;
1378 if (action->blockdev_snapshot_sync->has_mode) {
1379 mode = action->blockdev_snapshot_sync->mode;
1382 /* start processing */
1383 drv = bdrv_find_format(format);
1384 if (!drv) {
1385 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1386 return;
1389 state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
1390 has_node_name ? node_name : NULL,
1391 &local_err);
1392 if (local_err) {
1393 error_propagate(errp, local_err);
1394 return;
1397 if (has_node_name && !has_snapshot_node_name) {
1398 error_setg(errp, "New snapshot node name missing");
1399 return;
1402 if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
1403 error_setg(errp, "New snapshot node name already existing");
1404 return;
1407 /* Acquire AioContext now so any threads operating on old_bs stop */
1408 state->aio_context = bdrv_get_aio_context(state->old_bs);
1409 aio_context_acquire(state->aio_context);
1411 if (!bdrv_is_inserted(state->old_bs)) {
1412 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1413 return;
1416 if (bdrv_op_is_blocked(state->old_bs,
1417 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1418 return;
1421 if (!bdrv_is_read_only(state->old_bs)) {
1422 if (bdrv_flush(state->old_bs)) {
1423 error_set(errp, QERR_IO_ERROR);
1424 return;
1428 if (!bdrv_is_first_non_filter(state->old_bs)) {
1429 error_set(errp, QERR_FEATURE_DISABLED, "snapshot");
1430 return;
1433 flags = state->old_bs->open_flags;
1435 /* create new image w/backing file */
1436 if (mode != NEW_IMAGE_MODE_EXISTING) {
1437 bdrv_img_create(new_image_file, format,
1438 state->old_bs->filename,
1439 state->old_bs->drv->format_name,
1440 NULL, -1, flags, &local_err, false);
1441 if (local_err) {
1442 error_propagate(errp, local_err);
1443 return;
1447 if (has_snapshot_node_name) {
1448 options = qdict_new();
1449 qdict_put(options, "node-name",
1450 qstring_from_str(snapshot_node_name));
1453 /* TODO Inherit bs->options or only take explicit options with an
1454 * extended QMP command? */
1455 assert(state->new_bs == NULL);
1456 ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
1457 flags | BDRV_O_NO_BACKING, drv, &local_err);
1458 /* We will manually add the backing_hd field to the bs later */
1459 if (ret != 0) {
1460 error_propagate(errp, local_err);
1464 static void external_snapshot_commit(BlkTransactionState *common)
1466 ExternalSnapshotState *state =
1467 DO_UPCAST(ExternalSnapshotState, common, common);
1469 bdrv_set_aio_context(state->new_bs, state->aio_context);
1471 /* This removes our old bs and adds the new bs */
1472 bdrv_append(state->new_bs, state->old_bs);
1473 /* We don't need (or want) to use the transactional
1474 * bdrv_reopen_multiple() across all the entries at once, because we
1475 * don't want to abort all of them if one of them fails the reopen */
1476 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1477 NULL);
1479 aio_context_release(state->aio_context);
1482 static void external_snapshot_abort(BlkTransactionState *common)
1484 ExternalSnapshotState *state =
1485 DO_UPCAST(ExternalSnapshotState, common, common);
1486 if (state->new_bs) {
1487 bdrv_unref(state->new_bs);
1489 if (state->aio_context) {
1490 aio_context_release(state->aio_context);
1494 typedef struct DriveBackupState {
1495 BlkTransactionState common;
1496 BlockDriverState *bs;
1497 AioContext *aio_context;
1498 BlockJob *job;
1499 } DriveBackupState;
1501 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1503 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1504 BlockDriverState *bs;
1505 DriveBackup *backup;
1506 Error *local_err = NULL;
1508 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1509 backup = common->action->drive_backup;
1511 bs = bdrv_find(backup->device);
1512 if (!bs) {
1513 error_set(errp, QERR_DEVICE_NOT_FOUND, backup->device);
1514 return;
1517 /* AioContext is released in .clean() */
1518 state->aio_context = bdrv_get_aio_context(bs);
1519 aio_context_acquire(state->aio_context);
1521 qmp_drive_backup(backup->device, backup->target,
1522 backup->has_format, backup->format,
1523 backup->sync,
1524 backup->has_mode, backup->mode,
1525 backup->has_speed, backup->speed,
1526 backup->has_on_source_error, backup->on_source_error,
1527 backup->has_on_target_error, backup->on_target_error,
1528 &local_err);
1529 if (local_err) {
1530 error_propagate(errp, local_err);
1531 return;
1534 state->bs = bs;
1535 state->job = state->bs->job;
1538 static void drive_backup_abort(BlkTransactionState *common)
1540 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1541 BlockDriverState *bs = state->bs;
1543 /* Only cancel if it's the job we started */
1544 if (bs && bs->job && bs->job == state->job) {
1545 block_job_cancel_sync(bs->job);
1549 static void drive_backup_clean(BlkTransactionState *common)
1551 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1553 if (state->aio_context) {
1554 aio_context_release(state->aio_context);
1558 static void abort_prepare(BlkTransactionState *common, Error **errp)
1560 error_setg(errp, "Transaction aborted using Abort action");
1563 static void abort_commit(BlkTransactionState *common)
1565 g_assert_not_reached(); /* this action never succeeds */
1568 static const BdrvActionOps actions[] = {
1569 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1570 .instance_size = sizeof(ExternalSnapshotState),
1571 .prepare = external_snapshot_prepare,
1572 .commit = external_snapshot_commit,
1573 .abort = external_snapshot_abort,
1575 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1576 .instance_size = sizeof(DriveBackupState),
1577 .prepare = drive_backup_prepare,
1578 .abort = drive_backup_abort,
1579 .clean = drive_backup_clean,
1581 [TRANSACTION_ACTION_KIND_ABORT] = {
1582 .instance_size = sizeof(BlkTransactionState),
1583 .prepare = abort_prepare,
1584 .commit = abort_commit,
1586 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1587 .instance_size = sizeof(InternalSnapshotState),
1588 .prepare = internal_snapshot_prepare,
1589 .abort = internal_snapshot_abort,
1590 .clean = internal_snapshot_clean,
1595 * 'Atomic' group operations. The operations are performed as a set, and if
1596 * any fail then we roll back all operations in the group.
1598 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1600 TransactionActionList *dev_entry = dev_list;
1601 BlkTransactionState *state, *next;
1602 Error *local_err = NULL;
1604 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1605 QSIMPLEQ_INIT(&snap_bdrv_states);
1607 /* drain all i/o before any operations */
1608 bdrv_drain_all();
1610 /* We don't do anything in this loop that commits us to the operations */
1611 while (NULL != dev_entry) {
1612 TransactionAction *dev_info = NULL;
1613 const BdrvActionOps *ops;
1615 dev_info = dev_entry->value;
1616 dev_entry = dev_entry->next;
1618 assert(dev_info->kind < ARRAY_SIZE(actions));
1620 ops = &actions[dev_info->kind];
1621 assert(ops->instance_size > 0);
1623 state = g_malloc0(ops->instance_size);
1624 state->ops = ops;
1625 state->action = dev_info;
1626 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1628 state->ops->prepare(state, &local_err);
1629 if (local_err) {
1630 error_propagate(errp, local_err);
1631 goto delete_and_fail;
1635 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1636 if (state->ops->commit) {
1637 state->ops->commit(state);
1641 /* success */
1642 goto exit;
1644 delete_and_fail:
1645 /* failure, and it is all-or-none; roll back all operations */
1646 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1647 if (state->ops->abort) {
1648 state->ops->abort(state);
1651 exit:
1652 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1653 if (state->ops->clean) {
1654 state->ops->clean(state);
1656 g_free(state);
1661 static void eject_device(BlockBackend *blk, int force, Error **errp)
1663 BlockDriverState *bs = blk_bs(blk);
1664 AioContext *aio_context;
1666 aio_context = bdrv_get_aio_context(bs);
1667 aio_context_acquire(aio_context);
1669 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1670 goto out;
1672 if (!blk_dev_has_removable_media(blk)) {
1673 error_setg(errp, "Device '%s' is not removable",
1674 bdrv_get_device_name(bs));
1675 goto out;
1678 if (blk_dev_is_medium_locked(blk) && !blk_dev_is_tray_open(blk)) {
1679 blk_dev_eject_request(blk, force);
1680 if (!force) {
1681 error_setg(errp, "Device '%s' is locked",
1682 bdrv_get_device_name(bs));
1683 goto out;
1687 bdrv_close(bs);
1689 out:
1690 aio_context_release(aio_context);
1693 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1695 BlockBackend *blk;
1697 blk = blk_by_name(device);
1698 if (!blk) {
1699 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1700 return;
1703 eject_device(blk, force, errp);
1706 void qmp_block_passwd(bool has_device, const char *device,
1707 bool has_node_name, const char *node_name,
1708 const char *password, Error **errp)
1710 Error *local_err = NULL;
1711 BlockDriverState *bs;
1712 AioContext *aio_context;
1713 int err;
1715 bs = bdrv_lookup_bs(has_device ? device : NULL,
1716 has_node_name ? node_name : NULL,
1717 &local_err);
1718 if (local_err) {
1719 error_propagate(errp, local_err);
1720 return;
1723 aio_context = bdrv_get_aio_context(bs);
1724 aio_context_acquire(aio_context);
1726 err = bdrv_set_key(bs, password);
1727 if (err == -EINVAL) {
1728 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1729 goto out;
1730 } else if (err < 0) {
1731 error_set(errp, QERR_INVALID_PASSWORD);
1732 goto out;
1735 out:
1736 aio_context_release(aio_context);
1739 /* Assumes AioContext is held */
1740 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1741 int bdrv_flags, BlockDriver *drv,
1742 const char *password, Error **errp)
1744 Error *local_err = NULL;
1745 int ret;
1747 ret = bdrv_open(&bs, filename, NULL, NULL, bdrv_flags, drv, &local_err);
1748 if (ret < 0) {
1749 error_propagate(errp, local_err);
1750 return;
1753 if (bdrv_key_required(bs)) {
1754 if (password) {
1755 if (bdrv_set_key(bs, password) < 0) {
1756 error_set(errp, QERR_INVALID_PASSWORD);
1758 } else {
1759 error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
1760 bdrv_get_encrypted_filename(bs));
1762 } else if (password) {
1763 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1767 void qmp_change_blockdev(const char *device, const char *filename,
1768 const char *format, Error **errp)
1770 BlockBackend *blk;
1771 BlockDriverState *bs;
1772 AioContext *aio_context;
1773 BlockDriver *drv = NULL;
1774 int bdrv_flags;
1775 Error *err = NULL;
1777 blk = blk_by_name(device);
1778 if (!blk) {
1779 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1780 return;
1782 bs = blk_bs(blk);
1784 aio_context = bdrv_get_aio_context(bs);
1785 aio_context_acquire(aio_context);
1787 if (format) {
1788 drv = bdrv_find_whitelisted_format(format, bs->read_only);
1789 if (!drv) {
1790 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1791 goto out;
1795 eject_device(blk, 0, &err);
1796 if (err) {
1797 error_propagate(errp, err);
1798 goto out;
1801 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1802 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1804 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1806 out:
1807 aio_context_release(aio_context);
1810 /* throttling disk I/O limits */
1811 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1812 int64_t bps_wr,
1813 int64_t iops,
1814 int64_t iops_rd,
1815 int64_t iops_wr,
1816 bool has_bps_max,
1817 int64_t bps_max,
1818 bool has_bps_rd_max,
1819 int64_t bps_rd_max,
1820 bool has_bps_wr_max,
1821 int64_t bps_wr_max,
1822 bool has_iops_max,
1823 int64_t iops_max,
1824 bool has_iops_rd_max,
1825 int64_t iops_rd_max,
1826 bool has_iops_wr_max,
1827 int64_t iops_wr_max,
1828 bool has_iops_size,
1829 int64_t iops_size, Error **errp)
1831 ThrottleConfig cfg;
1832 BlockDriverState *bs;
1833 AioContext *aio_context;
1835 bs = bdrv_find(device);
1836 if (!bs) {
1837 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1838 return;
1841 memset(&cfg, 0, sizeof(cfg));
1842 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1843 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
1844 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1846 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1847 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
1848 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1850 if (has_bps_max) {
1851 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1853 if (has_bps_rd_max) {
1854 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
1856 if (has_bps_wr_max) {
1857 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
1859 if (has_iops_max) {
1860 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
1862 if (has_iops_rd_max) {
1863 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
1865 if (has_iops_wr_max) {
1866 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
1869 if (has_iops_size) {
1870 cfg.op_size = iops_size;
1873 if (!check_throttle_config(&cfg, errp)) {
1874 return;
1877 aio_context = bdrv_get_aio_context(bs);
1878 aio_context_acquire(aio_context);
1880 if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
1881 bdrv_io_limits_enable(bs);
1882 } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
1883 bdrv_io_limits_disable(bs);
1886 if (bs->io_limits_enabled) {
1887 bdrv_set_io_limits(bs, &cfg);
1890 aio_context_release(aio_context);
1893 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1895 const char *id = qdict_get_str(qdict, "id");
1896 BlockBackend *blk;
1897 BlockDriverState *bs;
1898 AioContext *aio_context;
1899 Error *local_err = NULL;
1901 blk = blk_by_name(id);
1902 if (!blk) {
1903 error_report("Device '%s' not found", id);
1904 return -1;
1906 bs = blk_bs(blk);
1908 if (!blk_legacy_dinfo(blk)) {
1909 error_report("Deleting device added with blockdev-add"
1910 " is not supported");
1911 return -1;
1914 aio_context = bdrv_get_aio_context(bs);
1915 aio_context_acquire(aio_context);
1917 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
1918 error_report("%s", error_get_pretty(local_err));
1919 error_free(local_err);
1920 aio_context_release(aio_context);
1921 return -1;
1924 /* quiesce block driver; prevent further io */
1925 bdrv_drain_all();
1926 bdrv_flush(bs);
1927 bdrv_close(bs);
1929 /* if we have a device attached to this BlockDriverState
1930 * then we need to make the drive anonymous until the device
1931 * can be removed. If this is a drive with no device backing
1932 * then we can just get rid of the block driver state right here.
1934 if (blk_get_attached_dev(blk)) {
1935 blk_hide_on_behalf_of_do_drive_del(blk);
1936 /* Further I/O must not pause the guest */
1937 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
1938 BLOCKDEV_ON_ERROR_REPORT);
1939 } else {
1940 blk_unref(blk);
1943 aio_context_release(aio_context);
1944 return 0;
1947 void qmp_block_resize(bool has_device, const char *device,
1948 bool has_node_name, const char *node_name,
1949 int64_t size, Error **errp)
1951 Error *local_err = NULL;
1952 BlockDriverState *bs;
1953 AioContext *aio_context;
1954 int ret;
1956 bs = bdrv_lookup_bs(has_device ? device : NULL,
1957 has_node_name ? node_name : NULL,
1958 &local_err);
1959 if (local_err) {
1960 error_propagate(errp, local_err);
1961 return;
1964 aio_context = bdrv_get_aio_context(bs);
1965 aio_context_acquire(aio_context);
1967 if (!bdrv_is_first_non_filter(bs)) {
1968 error_set(errp, QERR_FEATURE_DISABLED, "resize");
1969 goto out;
1972 if (size < 0) {
1973 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
1974 goto out;
1977 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
1978 error_set(errp, QERR_DEVICE_IN_USE, device);
1979 goto out;
1982 /* complete all in-flight operations before resizing the device */
1983 bdrv_drain_all();
1985 ret = bdrv_truncate(bs, size);
1986 switch (ret) {
1987 case 0:
1988 break;
1989 case -ENOMEDIUM:
1990 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1991 break;
1992 case -ENOTSUP:
1993 error_set(errp, QERR_UNSUPPORTED);
1994 break;
1995 case -EACCES:
1996 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1997 break;
1998 case -EBUSY:
1999 error_set(errp, QERR_DEVICE_IN_USE, device);
2000 break;
2001 default:
2002 error_setg_errno(errp, -ret, "Could not resize");
2003 break;
2006 out:
2007 aio_context_release(aio_context);
2010 static void block_job_cb(void *opaque, int ret)
2012 /* Note that this function may be executed from another AioContext besides
2013 * the QEMU main loop. If you need to access anything that assumes the
2014 * QEMU global mutex, use a BH or introduce a mutex.
2017 BlockDriverState *bs = opaque;
2018 const char *msg = NULL;
2020 trace_block_job_cb(bs, bs->job, ret);
2022 assert(bs->job);
2024 if (ret < 0) {
2025 msg = strerror(-ret);
2028 if (block_job_is_cancelled(bs->job)) {
2029 block_job_event_cancelled(bs->job);
2030 } else {
2031 block_job_event_completed(bs->job, msg);
2034 bdrv_put_ref_bh_schedule(bs);
2037 void qmp_block_stream(const char *device,
2038 bool has_base, const char *base,
2039 bool has_backing_file, const char *backing_file,
2040 bool has_speed, int64_t speed,
2041 bool has_on_error, BlockdevOnError on_error,
2042 Error **errp)
2044 BlockDriverState *bs;
2045 BlockDriverState *base_bs = NULL;
2046 AioContext *aio_context;
2047 Error *local_err = NULL;
2048 const char *base_name = NULL;
2050 if (!has_on_error) {
2051 on_error = BLOCKDEV_ON_ERROR_REPORT;
2054 bs = bdrv_find(device);
2055 if (!bs) {
2056 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2057 return;
2060 aio_context = bdrv_get_aio_context(bs);
2061 aio_context_acquire(aio_context);
2063 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2064 goto out;
2067 if (has_base) {
2068 base_bs = bdrv_find_backing_image(bs, base);
2069 if (base_bs == NULL) {
2070 error_set(errp, QERR_BASE_NOT_FOUND, base);
2071 goto out;
2073 assert(bdrv_get_aio_context(base_bs) == aio_context);
2074 base_name = base;
2077 /* if we are streaming the entire chain, the result will have no backing
2078 * file, and specifying one is therefore an error */
2079 if (base_bs == NULL && has_backing_file) {
2080 error_setg(errp, "backing file specified, but streaming the "
2081 "entire chain");
2082 goto out;
2085 /* backing_file string overrides base bs filename */
2086 base_name = has_backing_file ? backing_file : base_name;
2088 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
2089 on_error, block_job_cb, bs, &local_err);
2090 if (local_err) {
2091 error_propagate(errp, local_err);
2092 goto out;
2095 trace_qmp_block_stream(bs, bs->job);
2097 out:
2098 aio_context_release(aio_context);
2101 void qmp_block_commit(const char *device,
2102 bool has_base, const char *base,
2103 bool has_top, const char *top,
2104 bool has_backing_file, const char *backing_file,
2105 bool has_speed, int64_t speed,
2106 Error **errp)
2108 BlockDriverState *bs;
2109 BlockDriverState *base_bs, *top_bs;
2110 AioContext *aio_context;
2111 Error *local_err = NULL;
2112 /* This will be part of the QMP command, if/when the
2113 * BlockdevOnError change for blkmirror makes it in
2115 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
2117 if (!has_speed) {
2118 speed = 0;
2121 /* Important Note:
2122 * libvirt relies on the DeviceNotFound error class in order to probe for
2123 * live commit feature versions; for this to work, we must make sure to
2124 * perform the device lookup before any generic errors that may occur in a
2125 * scenario in which all optional arguments are omitted. */
2126 bs = bdrv_find(device);
2127 if (!bs) {
2128 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2129 return;
2132 aio_context = bdrv_get_aio_context(bs);
2133 aio_context_acquire(aio_context);
2135 /* drain all i/o before commits */
2136 bdrv_drain_all();
2138 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT, errp)) {
2139 goto out;
2142 /* default top_bs is the active layer */
2143 top_bs = bs;
2145 if (has_top && top) {
2146 if (strcmp(bs->filename, top) != 0) {
2147 top_bs = bdrv_find_backing_image(bs, top);
2151 if (top_bs == NULL) {
2152 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2153 goto out;
2156 assert(bdrv_get_aio_context(top_bs) == aio_context);
2158 if (has_base && base) {
2159 base_bs = bdrv_find_backing_image(top_bs, base);
2160 } else {
2161 base_bs = bdrv_find_base(top_bs);
2164 if (base_bs == NULL) {
2165 error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
2166 goto out;
2169 assert(bdrv_get_aio_context(base_bs) == aio_context);
2171 /* Do not allow attempts to commit an image into itself */
2172 if (top_bs == base_bs) {
2173 error_setg(errp, "cannot commit an image into itself");
2174 goto out;
2177 if (top_bs == bs) {
2178 if (has_backing_file) {
2179 error_setg(errp, "'backing-file' specified,"
2180 " but 'top' is the active layer");
2181 goto out;
2183 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2184 bs, &local_err);
2185 } else {
2186 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
2187 has_backing_file ? backing_file : NULL, &local_err);
2189 if (local_err != NULL) {
2190 error_propagate(errp, local_err);
2191 goto out;
2194 out:
2195 aio_context_release(aio_context);
2198 void qmp_drive_backup(const char *device, const char *target,
2199 bool has_format, const char *format,
2200 enum MirrorSyncMode sync,
2201 bool has_mode, enum NewImageMode mode,
2202 bool has_speed, int64_t speed,
2203 bool has_on_source_error, BlockdevOnError on_source_error,
2204 bool has_on_target_error, BlockdevOnError on_target_error,
2205 Error **errp)
2207 BlockDriverState *bs;
2208 BlockDriverState *target_bs;
2209 BlockDriverState *source = NULL;
2210 AioContext *aio_context;
2211 BlockDriver *drv = NULL;
2212 Error *local_err = NULL;
2213 int flags;
2214 int64_t size;
2215 int ret;
2217 if (!has_speed) {
2218 speed = 0;
2220 if (!has_on_source_error) {
2221 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2223 if (!has_on_target_error) {
2224 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2226 if (!has_mode) {
2227 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2230 bs = bdrv_find(device);
2231 if (!bs) {
2232 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2233 return;
2236 aio_context = bdrv_get_aio_context(bs);
2237 aio_context_acquire(aio_context);
2239 if (!bdrv_is_inserted(bs)) {
2240 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2241 goto out;
2244 if (!has_format) {
2245 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2247 if (format) {
2248 drv = bdrv_find_format(format);
2249 if (!drv) {
2250 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
2251 goto out;
2255 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2256 goto out;
2259 flags = bs->open_flags | BDRV_O_RDWR;
2261 /* See if we have a backing HD we can use to create our new image
2262 * on top of. */
2263 if (sync == MIRROR_SYNC_MODE_TOP) {
2264 source = bs->backing_hd;
2265 if (!source) {
2266 sync = MIRROR_SYNC_MODE_FULL;
2269 if (sync == MIRROR_SYNC_MODE_NONE) {
2270 source = bs;
2273 size = bdrv_getlength(bs);
2274 if (size < 0) {
2275 error_setg_errno(errp, -size, "bdrv_getlength failed");
2276 goto out;
2279 if (mode != NEW_IMAGE_MODE_EXISTING) {
2280 assert(format && drv);
2281 if (source) {
2282 bdrv_img_create(target, format, source->filename,
2283 source->drv->format_name, NULL,
2284 size, flags, &local_err, false);
2285 } else {
2286 bdrv_img_create(target, format, NULL, NULL, NULL,
2287 size, flags, &local_err, false);
2291 if (local_err) {
2292 error_propagate(errp, local_err);
2293 goto out;
2296 target_bs = NULL;
2297 ret = bdrv_open(&target_bs, target, NULL, NULL, flags, drv, &local_err);
2298 if (ret < 0) {
2299 error_propagate(errp, local_err);
2300 goto out;
2303 bdrv_set_aio_context(target_bs, aio_context);
2305 backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
2306 block_job_cb, bs, &local_err);
2307 if (local_err != NULL) {
2308 bdrv_unref(target_bs);
2309 error_propagate(errp, local_err);
2310 goto out;
2313 out:
2314 aio_context_release(aio_context);
2317 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2319 return bdrv_named_nodes_list();
2322 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
2324 void qmp_drive_mirror(const char *device, const char *target,
2325 bool has_format, const char *format,
2326 bool has_node_name, const char *node_name,
2327 bool has_replaces, const char *replaces,
2328 enum MirrorSyncMode sync,
2329 bool has_mode, enum NewImageMode mode,
2330 bool has_speed, int64_t speed,
2331 bool has_granularity, uint32_t granularity,
2332 bool has_buf_size, int64_t buf_size,
2333 bool has_on_source_error, BlockdevOnError on_source_error,
2334 bool has_on_target_error, BlockdevOnError on_target_error,
2335 Error **errp)
2337 BlockDriverState *bs;
2338 BlockDriverState *source, *target_bs;
2339 AioContext *aio_context;
2340 BlockDriver *drv = NULL;
2341 Error *local_err = NULL;
2342 QDict *options = NULL;
2343 int flags;
2344 int64_t size;
2345 int ret;
2347 if (!has_speed) {
2348 speed = 0;
2350 if (!has_on_source_error) {
2351 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2353 if (!has_on_target_error) {
2354 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2356 if (!has_mode) {
2357 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2359 if (!has_granularity) {
2360 granularity = 0;
2362 if (!has_buf_size) {
2363 buf_size = DEFAULT_MIRROR_BUF_SIZE;
2366 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
2367 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2368 "a value in range [512B, 64MB]");
2369 return;
2371 if (granularity & (granularity - 1)) {
2372 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "granularity", "power of 2");
2373 return;
2376 bs = bdrv_find(device);
2377 if (!bs) {
2378 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2379 return;
2382 aio_context = bdrv_get_aio_context(bs);
2383 aio_context_acquire(aio_context);
2385 if (!bdrv_is_inserted(bs)) {
2386 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2387 goto out;
2390 if (!has_format) {
2391 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2393 if (format) {
2394 drv = bdrv_find_format(format);
2395 if (!drv) {
2396 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
2397 goto out;
2401 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
2402 goto out;
2405 flags = bs->open_flags | BDRV_O_RDWR;
2406 source = bs->backing_hd;
2407 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
2408 sync = MIRROR_SYNC_MODE_FULL;
2410 if (sync == MIRROR_SYNC_MODE_NONE) {
2411 source = bs;
2414 size = bdrv_getlength(bs);
2415 if (size < 0) {
2416 error_setg_errno(errp, -size, "bdrv_getlength failed");
2417 goto out;
2420 if (has_replaces) {
2421 BlockDriverState *to_replace_bs;
2422 AioContext *replace_aio_context;
2423 int64_t replace_size;
2425 if (!has_node_name) {
2426 error_setg(errp, "a node-name must be provided when replacing a"
2427 " named node of the graph");
2428 goto out;
2431 to_replace_bs = check_to_replace_node(replaces, &local_err);
2433 if (!to_replace_bs) {
2434 error_propagate(errp, local_err);
2435 goto out;
2438 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
2439 aio_context_acquire(replace_aio_context);
2440 replace_size = bdrv_getlength(to_replace_bs);
2441 aio_context_release(replace_aio_context);
2443 if (size != replace_size) {
2444 error_setg(errp, "cannot replace image with a mirror image of "
2445 "different size");
2446 goto out;
2450 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
2451 && mode != NEW_IMAGE_MODE_EXISTING)
2453 /* create new image w/o backing file */
2454 assert(format && drv);
2455 bdrv_img_create(target, format,
2456 NULL, NULL, NULL, size, flags, &local_err, false);
2457 } else {
2458 switch (mode) {
2459 case NEW_IMAGE_MODE_EXISTING:
2460 break;
2461 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
2462 /* create new image with backing file */
2463 bdrv_img_create(target, format,
2464 source->filename,
2465 source->drv->format_name,
2466 NULL, size, flags, &local_err, false);
2467 break;
2468 default:
2469 abort();
2473 if (local_err) {
2474 error_propagate(errp, local_err);
2475 goto out;
2478 if (has_node_name) {
2479 options = qdict_new();
2480 qdict_put(options, "node-name", qstring_from_str(node_name));
2483 /* Mirroring takes care of copy-on-write using the source's backing
2484 * file.
2486 target_bs = NULL;
2487 ret = bdrv_open(&target_bs, target, NULL, options,
2488 flags | BDRV_O_NO_BACKING, drv, &local_err);
2489 if (ret < 0) {
2490 error_propagate(errp, local_err);
2491 goto out;
2494 bdrv_set_aio_context(target_bs, aio_context);
2496 /* pass the node name to replace to mirror start since it's loose coupling
2497 * and will allow to check whether the node still exist at mirror completion
2499 mirror_start(bs, target_bs,
2500 has_replaces ? replaces : NULL,
2501 speed, granularity, buf_size, sync,
2502 on_source_error, on_target_error,
2503 block_job_cb, bs, &local_err);
2504 if (local_err != NULL) {
2505 bdrv_unref(target_bs);
2506 error_propagate(errp, local_err);
2507 goto out;
2510 out:
2511 aio_context_release(aio_context);
2514 /* Get the block job for a given device name and acquire its AioContext */
2515 static BlockJob *find_block_job(const char *device, AioContext **aio_context)
2517 BlockDriverState *bs;
2519 bs = bdrv_find(device);
2520 if (!bs) {
2521 goto notfound;
2524 *aio_context = bdrv_get_aio_context(bs);
2525 aio_context_acquire(*aio_context);
2527 if (!bs->job) {
2528 aio_context_release(*aio_context);
2529 goto notfound;
2532 return bs->job;
2534 notfound:
2535 *aio_context = NULL;
2536 return NULL;
2539 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
2541 AioContext *aio_context;
2542 BlockJob *job = find_block_job(device, &aio_context);
2544 if (!job) {
2545 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2546 return;
2549 block_job_set_speed(job, speed, errp);
2550 aio_context_release(aio_context);
2553 void qmp_block_job_cancel(const char *device,
2554 bool has_force, bool force, Error **errp)
2556 AioContext *aio_context;
2557 BlockJob *job = find_block_job(device, &aio_context);
2559 if (!job) {
2560 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2561 return;
2564 if (!has_force) {
2565 force = false;
2568 if (job->paused && !force) {
2569 error_setg(errp, "The block job for device '%s' is currently paused",
2570 device);
2571 goto out;
2574 trace_qmp_block_job_cancel(job);
2575 block_job_cancel(job);
2576 out:
2577 aio_context_release(aio_context);
2580 void qmp_block_job_pause(const char *device, Error **errp)
2582 AioContext *aio_context;
2583 BlockJob *job = find_block_job(device, &aio_context);
2585 if (!job) {
2586 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2587 return;
2590 trace_qmp_block_job_pause(job);
2591 block_job_pause(job);
2592 aio_context_release(aio_context);
2595 void qmp_block_job_resume(const char *device, Error **errp)
2597 AioContext *aio_context;
2598 BlockJob *job = find_block_job(device, &aio_context);
2600 if (!job) {
2601 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2602 return;
2605 trace_qmp_block_job_resume(job);
2606 block_job_resume(job);
2607 aio_context_release(aio_context);
2610 void qmp_block_job_complete(const char *device, Error **errp)
2612 AioContext *aio_context;
2613 BlockJob *job = find_block_job(device, &aio_context);
2615 if (!job) {
2616 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2617 return;
2620 trace_qmp_block_job_complete(job);
2621 block_job_complete(job, errp);
2622 aio_context_release(aio_context);
2625 void qmp_change_backing_file(const char *device,
2626 const char *image_node_name,
2627 const char *backing_file,
2628 Error **errp)
2630 BlockDriverState *bs = NULL;
2631 AioContext *aio_context;
2632 BlockDriverState *image_bs = NULL;
2633 Error *local_err = NULL;
2634 bool ro;
2635 int open_flags;
2636 int ret;
2638 /* find the top layer BDS of the chain */
2639 bs = bdrv_find(device);
2640 if (!bs) {
2641 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2642 return;
2645 aio_context = bdrv_get_aio_context(bs);
2646 aio_context_acquire(aio_context);
2648 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
2649 if (local_err) {
2650 error_propagate(errp, local_err);
2651 goto out;
2654 if (!image_bs) {
2655 error_setg(errp, "image file not found");
2656 goto out;
2659 if (bdrv_find_base(image_bs) == image_bs) {
2660 error_setg(errp, "not allowing backing file change on an image "
2661 "without a backing file");
2662 goto out;
2665 /* even though we are not necessarily operating on bs, we need it to
2666 * determine if block ops are currently prohibited on the chain */
2667 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
2668 goto out;
2671 /* final sanity check */
2672 if (!bdrv_chain_contains(bs, image_bs)) {
2673 error_setg(errp, "'%s' and image file are not in the same chain",
2674 device);
2675 goto out;
2678 /* if not r/w, reopen to make r/w */
2679 open_flags = image_bs->open_flags;
2680 ro = bdrv_is_read_only(image_bs);
2682 if (ro) {
2683 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
2684 if (local_err) {
2685 error_propagate(errp, local_err);
2686 goto out;
2690 ret = bdrv_change_backing_file(image_bs, backing_file,
2691 image_bs->drv ? image_bs->drv->format_name : "");
2693 if (ret < 0) {
2694 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
2695 backing_file);
2696 /* don't exit here, so we can try to restore open flags if
2697 * appropriate */
2700 if (ro) {
2701 bdrv_reopen(image_bs, open_flags, &local_err);
2702 if (local_err) {
2703 error_propagate(errp, local_err); /* will preserve prior errp */
2707 out:
2708 aio_context_release(aio_context);
2711 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
2713 QmpOutputVisitor *ov = qmp_output_visitor_new();
2714 BlockBackend *blk;
2715 QObject *obj;
2716 QDict *qdict;
2717 Error *local_err = NULL;
2719 /* Require an ID in the top level */
2720 if (!options->has_id) {
2721 error_setg(errp, "Block device needs an ID");
2722 goto fail;
2725 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
2726 * cache.direct=false instead of silently switching to aio=threads, except
2727 * when called from drive_new().
2729 * For now, simply forbidding the combination for all drivers will do. */
2730 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
2731 bool direct = options->has_cache &&
2732 options->cache->has_direct &&
2733 options->cache->direct;
2734 if (!direct) {
2735 error_setg(errp, "aio=native requires cache.direct=true");
2736 goto fail;
2740 visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
2741 &options, NULL, &local_err);
2742 if (local_err) {
2743 error_propagate(errp, local_err);
2744 goto fail;
2747 obj = qmp_output_get_qobject(ov);
2748 qdict = qobject_to_qdict(obj);
2750 qdict_flatten(qdict);
2752 blk = blockdev_init(NULL, qdict, &local_err);
2753 if (local_err) {
2754 error_propagate(errp, local_err);
2755 goto fail;
2758 if (bdrv_key_required(blk_bs(blk))) {
2759 blk_unref(blk);
2760 error_setg(errp, "blockdev-add doesn't support encrypted devices");
2761 goto fail;
2764 fail:
2765 qmp_output_visitor_cleanup(ov);
2768 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
2770 BlockJobInfoList *head = NULL, **p_next = &head;
2771 BlockDriverState *bs;
2773 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
2774 AioContext *aio_context = bdrv_get_aio_context(bs);
2776 aio_context_acquire(aio_context);
2778 if (bs->job) {
2779 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
2780 elem->value = block_job_query(bs->job);
2781 *p_next = elem;
2782 p_next = &elem->next;
2785 aio_context_release(aio_context);
2788 return head;
2791 QemuOptsList qemu_common_drive_opts = {
2792 .name = "drive",
2793 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
2794 .desc = {
2796 .name = "snapshot",
2797 .type = QEMU_OPT_BOOL,
2798 .help = "enable/disable snapshot mode",
2800 .name = "discard",
2801 .type = QEMU_OPT_STRING,
2802 .help = "discard operation (ignore/off, unmap/on)",
2804 .name = "cache.writeback",
2805 .type = QEMU_OPT_BOOL,
2806 .help = "enables writeback mode for any caches",
2808 .name = "cache.direct",
2809 .type = QEMU_OPT_BOOL,
2810 .help = "enables use of O_DIRECT (bypass the host page cache)",
2812 .name = "cache.no-flush",
2813 .type = QEMU_OPT_BOOL,
2814 .help = "ignore any flush requests for the device",
2816 .name = "aio",
2817 .type = QEMU_OPT_STRING,
2818 .help = "host AIO implementation (threads, native)",
2820 .name = "format",
2821 .type = QEMU_OPT_STRING,
2822 .help = "disk format (raw, qcow2, ...)",
2824 .name = "rerror",
2825 .type = QEMU_OPT_STRING,
2826 .help = "read error action",
2828 .name = "werror",
2829 .type = QEMU_OPT_STRING,
2830 .help = "write error action",
2832 .name = "read-only",
2833 .type = QEMU_OPT_BOOL,
2834 .help = "open drive file as read-only",
2836 .name = "throttling.iops-total",
2837 .type = QEMU_OPT_NUMBER,
2838 .help = "limit total I/O operations per second",
2840 .name = "throttling.iops-read",
2841 .type = QEMU_OPT_NUMBER,
2842 .help = "limit read operations per second",
2844 .name = "throttling.iops-write",
2845 .type = QEMU_OPT_NUMBER,
2846 .help = "limit write operations per second",
2848 .name = "throttling.bps-total",
2849 .type = QEMU_OPT_NUMBER,
2850 .help = "limit total bytes per second",
2852 .name = "throttling.bps-read",
2853 .type = QEMU_OPT_NUMBER,
2854 .help = "limit read bytes per second",
2856 .name = "throttling.bps-write",
2857 .type = QEMU_OPT_NUMBER,
2858 .help = "limit write bytes per second",
2860 .name = "throttling.iops-total-max",
2861 .type = QEMU_OPT_NUMBER,
2862 .help = "I/O operations burst",
2864 .name = "throttling.iops-read-max",
2865 .type = QEMU_OPT_NUMBER,
2866 .help = "I/O operations read burst",
2868 .name = "throttling.iops-write-max",
2869 .type = QEMU_OPT_NUMBER,
2870 .help = "I/O operations write burst",
2872 .name = "throttling.bps-total-max",
2873 .type = QEMU_OPT_NUMBER,
2874 .help = "total bytes burst",
2876 .name = "throttling.bps-read-max",
2877 .type = QEMU_OPT_NUMBER,
2878 .help = "total bytes read burst",
2880 .name = "throttling.bps-write-max",
2881 .type = QEMU_OPT_NUMBER,
2882 .help = "total bytes write burst",
2884 .name = "throttling.iops-size",
2885 .type = QEMU_OPT_NUMBER,
2886 .help = "when limiting by iops max size of an I/O in bytes",
2888 .name = "copy-on-read",
2889 .type = QEMU_OPT_BOOL,
2890 .help = "copy read data from backing file into image file",
2892 .name = "detect-zeroes",
2893 .type = QEMU_OPT_STRING,
2894 .help = "try to optimize zero writes (off, on, unmap)",
2896 { /* end of list */ }
2900 QemuOptsList qemu_drive_opts = {
2901 .name = "drive",
2902 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
2903 .desc = {
2905 * no elements => accept any params
2906 * validation will happen later
2908 { /* end of list */ }