pc87312: Drop unused members of PC87312State
[qemu/cris-port.git] / blockdev.c
blobc126809d0e0ed4b40290b962185604669e9f9bf5
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);
119 if (dinfo && !dinfo->enable_auto_del) {
120 return;
123 if (bs->job) {
124 block_job_cancel(bs->job);
126 if (dinfo) {
127 dinfo->auto_del = 1;
131 void blockdev_auto_del(BlockBackend *blk)
133 DriveInfo *dinfo = blk_legacy_dinfo(blk);
135 if (dinfo && dinfo->auto_del) {
136 blk_unref(blk);
141 * Returns the current mapping of how many units per bus
142 * a particular interface can support.
144 * A positive integer indicates n units per bus.
145 * 0 implies the mapping has not been established.
146 * -1 indicates an invalid BlockInterfaceType was given.
148 int drive_get_max_devs(BlockInterfaceType type)
150 if (type >= IF_IDE && type < IF_COUNT) {
151 return if_max_devs[type];
154 return -1;
157 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
159 int max_devs = if_max_devs[type];
160 return max_devs ? index / max_devs : 0;
163 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
165 int max_devs = if_max_devs[type];
166 return max_devs ? index % max_devs : index;
169 QemuOpts *drive_def(const char *optstr)
171 return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
174 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
175 const char *optstr)
177 QemuOpts *opts;
178 char buf[32];
180 opts = drive_def(optstr);
181 if (!opts) {
182 return NULL;
184 if (type != IF_DEFAULT) {
185 qemu_opt_set(opts, "if", if_name[type]);
187 if (index >= 0) {
188 snprintf(buf, sizeof(buf), "%d", index);
189 qemu_opt_set(opts, "index", buf);
191 if (file)
192 qemu_opt_set(opts, "file", file);
193 return opts;
196 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
198 BlockBackend *blk;
199 DriveInfo *dinfo;
201 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
202 dinfo = blk_legacy_dinfo(blk);
203 if (dinfo && dinfo->type == type
204 && dinfo->bus == bus && dinfo->unit == unit) {
205 return dinfo;
209 return NULL;
212 bool drive_check_orphaned(void)
214 BlockBackend *blk;
215 DriveInfo *dinfo;
216 bool rs = false;
218 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
219 dinfo = blk_legacy_dinfo(blk);
220 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
221 /* Unless this is a default drive, this may be an oversight. */
222 if (!blk_bs(blk)->dev && !dinfo->is_default &&
223 dinfo->type != IF_NONE) {
224 fprintf(stderr, "Warning: Orphaned drive without device: "
225 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
226 dinfo->id, blk_bs(blk)->filename, if_name[dinfo->type],
227 dinfo->bus, dinfo->unit);
228 rs = true;
232 return rs;
235 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
237 return drive_get(type,
238 drive_index_to_bus_id(type, index),
239 drive_index_to_unit_id(type, index));
242 int drive_get_max_bus(BlockInterfaceType type)
244 int max_bus;
245 BlockBackend *blk;
246 DriveInfo *dinfo;
248 max_bus = -1;
249 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
250 dinfo = blk_legacy_dinfo(blk);
251 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
252 max_bus = dinfo->bus;
255 return max_bus;
258 /* Get a block device. This should only be used for single-drive devices
259 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
260 appropriate bus. */
261 DriveInfo *drive_get_next(BlockInterfaceType type)
263 static int next_block_unit[IF_COUNT];
265 return drive_get(type, 0, next_block_unit[type]++);
268 static void bdrv_format_print(void *opaque, const char *name)
270 error_printf(" %s", name);
273 typedef struct {
274 QEMUBH *bh;
275 BlockDriverState *bs;
276 } BDRVPutRefBH;
278 static void bdrv_put_ref_bh(void *opaque)
280 BDRVPutRefBH *s = opaque;
282 bdrv_unref(s->bs);
283 qemu_bh_delete(s->bh);
284 g_free(s);
288 * Release a BDS reference in a BH
290 * It is not safe to use bdrv_unref() from a callback function when the callers
291 * still need the BlockDriverState. In such cases we schedule a BH to release
292 * the reference.
294 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
296 BDRVPutRefBH *s;
298 s = g_new(BDRVPutRefBH, 1);
299 s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
300 s->bs = bs;
301 qemu_bh_schedule(s->bh);
304 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
306 if (!strcmp(buf, "ignore")) {
307 return BLOCKDEV_ON_ERROR_IGNORE;
308 } else if (!is_read && !strcmp(buf, "enospc")) {
309 return BLOCKDEV_ON_ERROR_ENOSPC;
310 } else if (!strcmp(buf, "stop")) {
311 return BLOCKDEV_ON_ERROR_STOP;
312 } else if (!strcmp(buf, "report")) {
313 return BLOCKDEV_ON_ERROR_REPORT;
314 } else {
315 error_setg(errp, "'%s' invalid %s error action",
316 buf, is_read ? "read" : "write");
317 return -1;
321 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
323 if (throttle_conflicting(cfg)) {
324 error_setg(errp, "bps/iops/max total values and read/write values"
325 " cannot be used at the same time");
326 return false;
329 if (!throttle_is_valid(cfg)) {
330 error_setg(errp, "bps/iops/maxs values must be 0 or greater");
331 return false;
334 return true;
337 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
339 /* Takes the ownership of bs_opts */
340 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
341 Error **errp)
343 const char *buf;
344 int ro = 0;
345 int bdrv_flags = 0;
346 int on_read_error, on_write_error;
347 BlockBackend *blk;
348 BlockDriverState *bs;
349 DriveInfo *dinfo;
350 ThrottleConfig cfg;
351 int snapshot = 0;
352 bool copy_on_read;
353 int ret;
354 Error *error = NULL;
355 QemuOpts *opts;
356 const char *id;
357 bool has_driver_specific_opts;
358 BlockdevDetectZeroesOptions detect_zeroes;
359 BlockDriver *drv = NULL;
361 /* Check common options by copying from bs_opts to opts, all other options
362 * stay in bs_opts for processing by bdrv_open(). */
363 id = qdict_get_try_str(bs_opts, "id");
364 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
365 if (error) {
366 error_propagate(errp, error);
367 goto err_no_opts;
370 qemu_opts_absorb_qdict(opts, bs_opts, &error);
371 if (error) {
372 error_propagate(errp, error);
373 goto early_err;
376 if (id) {
377 qdict_del(bs_opts, "id");
380 has_driver_specific_opts = !!qdict_size(bs_opts);
382 /* extract parameters */
383 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
384 ro = qemu_opt_get_bool(opts, "read-only", 0);
385 copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
387 if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
388 if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
389 error_setg(errp, "invalid discard option");
390 goto early_err;
394 if (qemu_opt_get_bool(opts, "cache.writeback", true)) {
395 bdrv_flags |= BDRV_O_CACHE_WB;
397 if (qemu_opt_get_bool(opts, "cache.direct", false)) {
398 bdrv_flags |= BDRV_O_NOCACHE;
400 if (qemu_opt_get_bool(opts, "cache.no-flush", false)) {
401 bdrv_flags |= BDRV_O_NO_FLUSH;
404 #ifdef CONFIG_LINUX_AIO
405 if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
406 if (!strcmp(buf, "native")) {
407 bdrv_flags |= BDRV_O_NATIVE_AIO;
408 } else if (!strcmp(buf, "threads")) {
409 /* this is the default */
410 } else {
411 error_setg(errp, "invalid aio option");
412 goto early_err;
415 #endif
417 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
418 if (is_help_option(buf)) {
419 error_printf("Supported formats:");
420 bdrv_iterate_format(bdrv_format_print, NULL);
421 error_printf("\n");
422 goto early_err;
425 drv = bdrv_find_format(buf);
426 if (!drv) {
427 error_setg(errp, "'%s' invalid format", buf);
428 goto early_err;
432 /* disk I/O throttling */
433 memset(&cfg, 0, sizeof(cfg));
434 cfg.buckets[THROTTLE_BPS_TOTAL].avg =
435 qemu_opt_get_number(opts, "throttling.bps-total", 0);
436 cfg.buckets[THROTTLE_BPS_READ].avg =
437 qemu_opt_get_number(opts, "throttling.bps-read", 0);
438 cfg.buckets[THROTTLE_BPS_WRITE].avg =
439 qemu_opt_get_number(opts, "throttling.bps-write", 0);
440 cfg.buckets[THROTTLE_OPS_TOTAL].avg =
441 qemu_opt_get_number(opts, "throttling.iops-total", 0);
442 cfg.buckets[THROTTLE_OPS_READ].avg =
443 qemu_opt_get_number(opts, "throttling.iops-read", 0);
444 cfg.buckets[THROTTLE_OPS_WRITE].avg =
445 qemu_opt_get_number(opts, "throttling.iops-write", 0);
447 cfg.buckets[THROTTLE_BPS_TOTAL].max =
448 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
449 cfg.buckets[THROTTLE_BPS_READ].max =
450 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
451 cfg.buckets[THROTTLE_BPS_WRITE].max =
452 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
453 cfg.buckets[THROTTLE_OPS_TOTAL].max =
454 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
455 cfg.buckets[THROTTLE_OPS_READ].max =
456 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
457 cfg.buckets[THROTTLE_OPS_WRITE].max =
458 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
460 cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
462 if (!check_throttle_config(&cfg, &error)) {
463 error_propagate(errp, error);
464 goto early_err;
467 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
468 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
469 on_write_error = parse_block_error_action(buf, 0, &error);
470 if (error) {
471 error_propagate(errp, error);
472 goto early_err;
476 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
477 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
478 on_read_error = parse_block_error_action(buf, 1, &error);
479 if (error) {
480 error_propagate(errp, error);
481 goto early_err;
485 detect_zeroes =
486 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
487 qemu_opt_get(opts, "detect-zeroes"),
488 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
489 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
490 &error);
491 if (error) {
492 error_propagate(errp, error);
493 goto early_err;
496 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
497 !(bdrv_flags & BDRV_O_UNMAP)) {
498 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
499 "without setting discard operation to unmap");
500 goto early_err;
503 /* init */
504 blk = blk_new_with_bs(qemu_opts_id(opts), errp);
505 if (!blk) {
506 goto early_err;
508 bs = blk_bs(blk);
509 bs->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
510 bs->read_only = ro;
511 bs->detect_zeroes = detect_zeroes;
513 bdrv_set_on_error(bs, on_read_error, on_write_error);
515 /* disk I/O throttling */
516 if (throttle_enabled(&cfg)) {
517 bdrv_io_limits_enable(bs);
518 bdrv_set_io_limits(bs, &cfg);
521 dinfo = g_malloc0(sizeof(*dinfo));
522 dinfo->id = g_strdup(qemu_opts_id(opts));
523 blk_set_legacy_dinfo(blk, dinfo);
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 ?: dinfo->id, 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 /* Set legacy DriveInfo fields */
995 dinfo = blk_legacy_dinfo(blk);
996 dinfo->enable_auto_del = true;
997 dinfo->opts = all_opts;
999 dinfo->cyls = cyls;
1000 dinfo->heads = heads;
1001 dinfo->secs = secs;
1002 dinfo->trans = translation;
1004 dinfo->type = type;
1005 dinfo->bus = bus_id;
1006 dinfo->unit = unit_id;
1007 dinfo->devaddr = devaddr;
1009 dinfo->serial = g_strdup(serial);
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 QEMUSnapshotInfo sn;
1109 Error *local_err = NULL;
1110 SnapshotInfo *info = NULL;
1111 int ret;
1113 if (!bs) {
1114 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1115 return NULL;
1118 if (!has_id) {
1119 id = NULL;
1122 if (!has_name) {
1123 name = NULL;
1126 if (!id && !name) {
1127 error_setg(errp, "Name or id must be provided");
1128 return NULL;
1131 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1132 if (local_err) {
1133 error_propagate(errp, local_err);
1134 return NULL;
1136 if (!ret) {
1137 error_setg(errp,
1138 "Snapshot with id '%s' and name '%s' does not exist on "
1139 "device '%s'",
1140 STR_OR_NULL(id), STR_OR_NULL(name), device);
1141 return NULL;
1144 bdrv_snapshot_delete(bs, id, name, &local_err);
1145 if (local_err) {
1146 error_propagate(errp, local_err);
1147 return NULL;
1150 info = g_new0(SnapshotInfo, 1);
1151 info->id = g_strdup(sn.id_str);
1152 info->name = g_strdup(sn.name);
1153 info->date_nsec = sn.date_nsec;
1154 info->date_sec = sn.date_sec;
1155 info->vm_state_size = sn.vm_state_size;
1156 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1157 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1159 return info;
1162 /* New and old BlockDriverState structs for group snapshots */
1164 typedef struct BlkTransactionState BlkTransactionState;
1166 /* Only prepare() may fail. In a single transaction, only one of commit() or
1167 abort() will be called, clean() will always be called if it present. */
1168 typedef struct BdrvActionOps {
1169 /* Size of state struct, in bytes. */
1170 size_t instance_size;
1171 /* Prepare the work, must NOT be NULL. */
1172 void (*prepare)(BlkTransactionState *common, Error **errp);
1173 /* Commit the changes, can be NULL. */
1174 void (*commit)(BlkTransactionState *common);
1175 /* Abort the changes on fail, can be NULL. */
1176 void (*abort)(BlkTransactionState *common);
1177 /* Clean up resource in the end, can be NULL. */
1178 void (*clean)(BlkTransactionState *common);
1179 } BdrvActionOps;
1182 * This structure must be arranged as first member in child type, assuming
1183 * that compiler will also arrange it to the same address with parent instance.
1184 * Later it will be used in free().
1186 struct BlkTransactionState {
1187 TransactionAction *action;
1188 const BdrvActionOps *ops;
1189 QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1192 /* internal snapshot private data */
1193 typedef struct InternalSnapshotState {
1194 BlkTransactionState common;
1195 BlockDriverState *bs;
1196 QEMUSnapshotInfo sn;
1197 } InternalSnapshotState;
1199 static void internal_snapshot_prepare(BlkTransactionState *common,
1200 Error **errp)
1202 Error *local_err = NULL;
1203 const char *device;
1204 const char *name;
1205 BlockDriverState *bs;
1206 QEMUSnapshotInfo old_sn, *sn;
1207 bool ret;
1208 qemu_timeval tv;
1209 BlockdevSnapshotInternal *internal;
1210 InternalSnapshotState *state;
1211 int ret1;
1213 g_assert(common->action->kind ==
1214 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1215 internal = common->action->blockdev_snapshot_internal_sync;
1216 state = DO_UPCAST(InternalSnapshotState, common, common);
1218 /* 1. parse input */
1219 device = internal->device;
1220 name = internal->name;
1222 /* 2. check for validation */
1223 bs = bdrv_find(device);
1224 if (!bs) {
1225 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1226 return;
1229 if (!bdrv_is_inserted(bs)) {
1230 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1231 return;
1234 if (bdrv_is_read_only(bs)) {
1235 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1236 return;
1239 if (!bdrv_can_snapshot(bs)) {
1240 error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1241 bs->drv->format_name, device, "internal snapshot");
1242 return;
1245 if (!strlen(name)) {
1246 error_setg(errp, "Name is empty");
1247 return;
1250 /* check whether a snapshot with name exist */
1251 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1252 &local_err);
1253 if (local_err) {
1254 error_propagate(errp, local_err);
1255 return;
1256 } else if (ret) {
1257 error_setg(errp,
1258 "Snapshot with name '%s' already exists on device '%s'",
1259 name, device);
1260 return;
1263 /* 3. take the snapshot */
1264 sn = &state->sn;
1265 pstrcpy(sn->name, sizeof(sn->name), name);
1266 qemu_gettimeofday(&tv);
1267 sn->date_sec = tv.tv_sec;
1268 sn->date_nsec = tv.tv_usec * 1000;
1269 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1271 ret1 = bdrv_snapshot_create(bs, sn);
1272 if (ret1 < 0) {
1273 error_setg_errno(errp, -ret1,
1274 "Failed to create snapshot '%s' on device '%s'",
1275 name, device);
1276 return;
1279 /* 4. succeed, mark a snapshot is created */
1280 state->bs = bs;
1283 static void internal_snapshot_abort(BlkTransactionState *common)
1285 InternalSnapshotState *state =
1286 DO_UPCAST(InternalSnapshotState, common, common);
1287 BlockDriverState *bs = state->bs;
1288 QEMUSnapshotInfo *sn = &state->sn;
1289 Error *local_error = NULL;
1291 if (!bs) {
1292 return;
1295 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1296 error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1297 "device '%s' in abort: %s",
1298 sn->id_str,
1299 sn->name,
1300 bdrv_get_device_name(bs),
1301 error_get_pretty(local_error));
1302 error_free(local_error);
1306 /* external snapshot private data */
1307 typedef struct ExternalSnapshotState {
1308 BlkTransactionState common;
1309 BlockDriverState *old_bs;
1310 BlockDriverState *new_bs;
1311 } ExternalSnapshotState;
1313 static void external_snapshot_prepare(BlkTransactionState *common,
1314 Error **errp)
1316 BlockDriver *drv;
1317 int flags, ret;
1318 QDict *options = NULL;
1319 Error *local_err = NULL;
1320 bool has_device = false;
1321 const char *device;
1322 bool has_node_name = false;
1323 const char *node_name;
1324 bool has_snapshot_node_name = false;
1325 const char *snapshot_node_name;
1326 const char *new_image_file;
1327 const char *format = "qcow2";
1328 enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1329 ExternalSnapshotState *state =
1330 DO_UPCAST(ExternalSnapshotState, common, common);
1331 TransactionAction *action = common->action;
1333 /* get parameters */
1334 g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1336 has_device = action->blockdev_snapshot_sync->has_device;
1337 device = action->blockdev_snapshot_sync->device;
1338 has_node_name = action->blockdev_snapshot_sync->has_node_name;
1339 node_name = action->blockdev_snapshot_sync->node_name;
1340 has_snapshot_node_name =
1341 action->blockdev_snapshot_sync->has_snapshot_node_name;
1342 snapshot_node_name = action->blockdev_snapshot_sync->snapshot_node_name;
1344 new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1345 if (action->blockdev_snapshot_sync->has_format) {
1346 format = action->blockdev_snapshot_sync->format;
1348 if (action->blockdev_snapshot_sync->has_mode) {
1349 mode = action->blockdev_snapshot_sync->mode;
1352 /* start processing */
1353 drv = bdrv_find_format(format);
1354 if (!drv) {
1355 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1356 return;
1359 state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
1360 has_node_name ? node_name : NULL,
1361 &local_err);
1362 if (local_err) {
1363 error_propagate(errp, local_err);
1364 return;
1367 if (has_node_name && !has_snapshot_node_name) {
1368 error_setg(errp, "New snapshot node name missing");
1369 return;
1372 if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
1373 error_setg(errp, "New snapshot node name already existing");
1374 return;
1377 if (!bdrv_is_inserted(state->old_bs)) {
1378 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1379 return;
1382 if (bdrv_op_is_blocked(state->old_bs,
1383 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1384 return;
1387 if (!bdrv_is_read_only(state->old_bs)) {
1388 if (bdrv_flush(state->old_bs)) {
1389 error_set(errp, QERR_IO_ERROR);
1390 return;
1394 if (!bdrv_is_first_non_filter(state->old_bs)) {
1395 error_set(errp, QERR_FEATURE_DISABLED, "snapshot");
1396 return;
1399 flags = state->old_bs->open_flags;
1401 /* create new image w/backing file */
1402 if (mode != NEW_IMAGE_MODE_EXISTING) {
1403 bdrv_img_create(new_image_file, format,
1404 state->old_bs->filename,
1405 state->old_bs->drv->format_name,
1406 NULL, -1, flags, &local_err, false);
1407 if (local_err) {
1408 error_propagate(errp, local_err);
1409 return;
1413 if (has_snapshot_node_name) {
1414 options = qdict_new();
1415 qdict_put(options, "node-name",
1416 qstring_from_str(snapshot_node_name));
1419 /* TODO Inherit bs->options or only take explicit options with an
1420 * extended QMP command? */
1421 assert(state->new_bs == NULL);
1422 ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
1423 flags | BDRV_O_NO_BACKING, drv, &local_err);
1424 /* We will manually add the backing_hd field to the bs later */
1425 if (ret != 0) {
1426 error_propagate(errp, local_err);
1430 static void external_snapshot_commit(BlkTransactionState *common)
1432 ExternalSnapshotState *state =
1433 DO_UPCAST(ExternalSnapshotState, common, common);
1435 /* This removes our old bs and adds the new bs */
1436 bdrv_append(state->new_bs, state->old_bs);
1437 /* We don't need (or want) to use the transactional
1438 * bdrv_reopen_multiple() across all the entries at once, because we
1439 * don't want to abort all of them if one of them fails the reopen */
1440 bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1441 NULL);
1444 static void external_snapshot_abort(BlkTransactionState *common)
1446 ExternalSnapshotState *state =
1447 DO_UPCAST(ExternalSnapshotState, common, common);
1448 if (state->new_bs) {
1449 bdrv_unref(state->new_bs);
1453 typedef struct DriveBackupState {
1454 BlkTransactionState common;
1455 BlockDriverState *bs;
1456 BlockJob *job;
1457 } DriveBackupState;
1459 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1461 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1462 DriveBackup *backup;
1463 Error *local_err = NULL;
1465 assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1466 backup = common->action->drive_backup;
1468 qmp_drive_backup(backup->device, backup->target,
1469 backup->has_format, backup->format,
1470 backup->sync,
1471 backup->has_mode, backup->mode,
1472 backup->has_speed, backup->speed,
1473 backup->has_on_source_error, backup->on_source_error,
1474 backup->has_on_target_error, backup->on_target_error,
1475 &local_err);
1476 if (local_err) {
1477 error_propagate(errp, local_err);
1478 state->bs = NULL;
1479 state->job = NULL;
1480 return;
1483 state->bs = bdrv_find(backup->device);
1484 state->job = state->bs->job;
1487 static void drive_backup_abort(BlkTransactionState *common)
1489 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1490 BlockDriverState *bs = state->bs;
1492 /* Only cancel if it's the job we started */
1493 if (bs && bs->job && bs->job == state->job) {
1494 block_job_cancel_sync(bs->job);
1498 static void abort_prepare(BlkTransactionState *common, Error **errp)
1500 error_setg(errp, "Transaction aborted using Abort action");
1503 static void abort_commit(BlkTransactionState *common)
1505 g_assert_not_reached(); /* this action never succeeds */
1508 static const BdrvActionOps actions[] = {
1509 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1510 .instance_size = sizeof(ExternalSnapshotState),
1511 .prepare = external_snapshot_prepare,
1512 .commit = external_snapshot_commit,
1513 .abort = external_snapshot_abort,
1515 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1516 .instance_size = sizeof(DriveBackupState),
1517 .prepare = drive_backup_prepare,
1518 .abort = drive_backup_abort,
1520 [TRANSACTION_ACTION_KIND_ABORT] = {
1521 .instance_size = sizeof(BlkTransactionState),
1522 .prepare = abort_prepare,
1523 .commit = abort_commit,
1525 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1526 .instance_size = sizeof(InternalSnapshotState),
1527 .prepare = internal_snapshot_prepare,
1528 .abort = internal_snapshot_abort,
1533 * 'Atomic' group snapshots. The snapshots are taken as a set, and if any fail
1534 * then we do not pivot any of the devices in the group, and abandon the
1535 * snapshots
1537 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1539 TransactionActionList *dev_entry = dev_list;
1540 BlkTransactionState *state, *next;
1541 Error *local_err = NULL;
1543 QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1544 QSIMPLEQ_INIT(&snap_bdrv_states);
1546 /* drain all i/o before any snapshots */
1547 bdrv_drain_all();
1549 /* We don't do anything in this loop that commits us to the snapshot */
1550 while (NULL != dev_entry) {
1551 TransactionAction *dev_info = NULL;
1552 const BdrvActionOps *ops;
1554 dev_info = dev_entry->value;
1555 dev_entry = dev_entry->next;
1557 assert(dev_info->kind < ARRAY_SIZE(actions));
1559 ops = &actions[dev_info->kind];
1560 assert(ops->instance_size > 0);
1562 state = g_malloc0(ops->instance_size);
1563 state->ops = ops;
1564 state->action = dev_info;
1565 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1567 state->ops->prepare(state, &local_err);
1568 if (local_err) {
1569 error_propagate(errp, local_err);
1570 goto delete_and_fail;
1574 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1575 if (state->ops->commit) {
1576 state->ops->commit(state);
1580 /* success */
1581 goto exit;
1583 delete_and_fail:
1585 * failure, and it is all-or-none; abandon each new bs, and keep using
1586 * the original bs for all images
1588 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1589 if (state->ops->abort) {
1590 state->ops->abort(state);
1593 exit:
1594 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1595 if (state->ops->clean) {
1596 state->ops->clean(state);
1598 g_free(state);
1603 static void eject_device(BlockDriverState *bs, int force, Error **errp)
1605 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1606 return;
1608 if (!bdrv_dev_has_removable_media(bs)) {
1609 error_setg(errp, "Device '%s' is not removable",
1610 bdrv_get_device_name(bs));
1611 return;
1614 if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
1615 bdrv_dev_eject_request(bs, force);
1616 if (!force) {
1617 error_setg(errp, "Device '%s' is locked",
1618 bdrv_get_device_name(bs));
1619 return;
1623 bdrv_close(bs);
1626 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1628 BlockDriverState *bs;
1630 bs = bdrv_find(device);
1631 if (!bs) {
1632 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1633 return;
1636 eject_device(bs, force, errp);
1639 void qmp_block_passwd(bool has_device, const char *device,
1640 bool has_node_name, const char *node_name,
1641 const char *password, Error **errp)
1643 Error *local_err = NULL;
1644 BlockDriverState *bs;
1645 int err;
1647 bs = bdrv_lookup_bs(has_device ? device : NULL,
1648 has_node_name ? node_name : NULL,
1649 &local_err);
1650 if (local_err) {
1651 error_propagate(errp, local_err);
1652 return;
1655 err = bdrv_set_key(bs, password);
1656 if (err == -EINVAL) {
1657 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1658 return;
1659 } else if (err < 0) {
1660 error_set(errp, QERR_INVALID_PASSWORD);
1661 return;
1665 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1666 int bdrv_flags, BlockDriver *drv,
1667 const char *password, Error **errp)
1669 Error *local_err = NULL;
1670 int ret;
1672 ret = bdrv_open(&bs, filename, NULL, NULL, bdrv_flags, drv, &local_err);
1673 if (ret < 0) {
1674 error_propagate(errp, local_err);
1675 return;
1678 if (bdrv_key_required(bs)) {
1679 if (password) {
1680 if (bdrv_set_key(bs, password) < 0) {
1681 error_set(errp, QERR_INVALID_PASSWORD);
1683 } else {
1684 error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
1685 bdrv_get_encrypted_filename(bs));
1687 } else if (password) {
1688 error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1692 void qmp_change_blockdev(const char *device, const char *filename,
1693 const char *format, Error **errp)
1695 BlockDriverState *bs;
1696 BlockDriver *drv = NULL;
1697 int bdrv_flags;
1698 Error *err = NULL;
1700 bs = bdrv_find(device);
1701 if (!bs) {
1702 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1703 return;
1706 if (format) {
1707 drv = bdrv_find_whitelisted_format(format, bs->read_only);
1708 if (!drv) {
1709 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1710 return;
1714 eject_device(bs, 0, &err);
1715 if (err) {
1716 error_propagate(errp, err);
1717 return;
1720 bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1721 bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1723 qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1726 /* throttling disk I/O limits */
1727 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1728 int64_t bps_wr,
1729 int64_t iops,
1730 int64_t iops_rd,
1731 int64_t iops_wr,
1732 bool has_bps_max,
1733 int64_t bps_max,
1734 bool has_bps_rd_max,
1735 int64_t bps_rd_max,
1736 bool has_bps_wr_max,
1737 int64_t bps_wr_max,
1738 bool has_iops_max,
1739 int64_t iops_max,
1740 bool has_iops_rd_max,
1741 int64_t iops_rd_max,
1742 bool has_iops_wr_max,
1743 int64_t iops_wr_max,
1744 bool has_iops_size,
1745 int64_t iops_size, Error **errp)
1747 ThrottleConfig cfg;
1748 BlockDriverState *bs;
1749 AioContext *aio_context;
1751 bs = bdrv_find(device);
1752 if (!bs) {
1753 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1754 return;
1757 memset(&cfg, 0, sizeof(cfg));
1758 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1759 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
1760 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1762 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1763 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
1764 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1766 if (has_bps_max) {
1767 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1769 if (has_bps_rd_max) {
1770 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
1772 if (has_bps_wr_max) {
1773 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
1775 if (has_iops_max) {
1776 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
1778 if (has_iops_rd_max) {
1779 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
1781 if (has_iops_wr_max) {
1782 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
1785 if (has_iops_size) {
1786 cfg.op_size = iops_size;
1789 if (!check_throttle_config(&cfg, errp)) {
1790 return;
1793 aio_context = bdrv_get_aio_context(bs);
1794 aio_context_acquire(aio_context);
1796 if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
1797 bdrv_io_limits_enable(bs);
1798 } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
1799 bdrv_io_limits_disable(bs);
1802 if (bs->io_limits_enabled) {
1803 bdrv_set_io_limits(bs, &cfg);
1806 aio_context_release(aio_context);
1809 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1811 const char *id = qdict_get_str(qdict, "id");
1812 BlockBackend *blk;
1813 BlockDriverState *bs;
1814 DriveInfo *dinfo;
1815 AioContext *aio_context;
1816 Error *local_err = NULL;
1818 blk = blk_by_name(id);
1819 if (!blk) {
1820 error_report("Device '%s' not found", id);
1821 return -1;
1823 bs = blk_bs(blk);
1825 dinfo = blk_legacy_dinfo(blk);
1826 if (dinfo && !dinfo->enable_auto_del) {
1827 error_report("Deleting device added with blockdev-add"
1828 " is not supported");
1829 return -1;
1832 aio_context = bdrv_get_aio_context(bs);
1833 aio_context_acquire(aio_context);
1835 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
1836 error_report("%s", error_get_pretty(local_err));
1837 error_free(local_err);
1838 aio_context_release(aio_context);
1839 return -1;
1842 /* quiesce block driver; prevent further io */
1843 bdrv_drain_all();
1844 bdrv_flush(bs);
1845 bdrv_close(bs);
1847 /* if we have a device attached to this BlockDriverState
1848 * then we need to make the drive anonymous until the device
1849 * can be removed. If this is a drive with no device backing
1850 * then we can just get rid of the block driver state right here.
1852 if (bdrv_get_attached_dev(bs)) {
1853 blk_hide_on_behalf_of_do_drive_del(blk);
1854 /* Further I/O must not pause the guest */
1855 bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
1856 BLOCKDEV_ON_ERROR_REPORT);
1857 } else {
1858 blk_unref(blk);
1861 aio_context_release(aio_context);
1862 return 0;
1865 void qmp_block_resize(bool has_device, const char *device,
1866 bool has_node_name, const char *node_name,
1867 int64_t size, Error **errp)
1869 Error *local_err = NULL;
1870 BlockDriverState *bs;
1871 AioContext *aio_context;
1872 int ret;
1874 bs = bdrv_lookup_bs(has_device ? device : NULL,
1875 has_node_name ? node_name : NULL,
1876 &local_err);
1877 if (local_err) {
1878 error_propagate(errp, local_err);
1879 return;
1882 aio_context = bdrv_get_aio_context(bs);
1883 aio_context_acquire(aio_context);
1885 if (!bdrv_is_first_non_filter(bs)) {
1886 error_set(errp, QERR_FEATURE_DISABLED, "resize");
1887 goto out;
1890 if (size < 0) {
1891 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
1892 goto out;
1895 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
1896 error_set(errp, QERR_DEVICE_IN_USE, device);
1897 goto out;
1900 /* complete all in-flight operations before resizing the device */
1901 bdrv_drain_all();
1903 ret = bdrv_truncate(bs, size);
1904 switch (ret) {
1905 case 0:
1906 break;
1907 case -ENOMEDIUM:
1908 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1909 break;
1910 case -ENOTSUP:
1911 error_set(errp, QERR_UNSUPPORTED);
1912 break;
1913 case -EACCES:
1914 error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1915 break;
1916 case -EBUSY:
1917 error_set(errp, QERR_DEVICE_IN_USE, device);
1918 break;
1919 default:
1920 error_setg_errno(errp, -ret, "Could not resize");
1921 break;
1924 out:
1925 aio_context_release(aio_context);
1928 static void block_job_cb(void *opaque, int ret)
1930 BlockDriverState *bs = opaque;
1931 const char *msg = NULL;
1933 trace_block_job_cb(bs, bs->job, ret);
1935 assert(bs->job);
1937 if (ret < 0) {
1938 msg = strerror(-ret);
1941 if (block_job_is_cancelled(bs->job)) {
1942 block_job_event_cancelled(bs->job);
1943 } else {
1944 block_job_event_completed(bs->job, msg);
1947 bdrv_put_ref_bh_schedule(bs);
1950 void qmp_block_stream(const char *device,
1951 bool has_base, const char *base,
1952 bool has_backing_file, const char *backing_file,
1953 bool has_speed, int64_t speed,
1954 bool has_on_error, BlockdevOnError on_error,
1955 Error **errp)
1957 BlockDriverState *bs;
1958 BlockDriverState *base_bs = NULL;
1959 Error *local_err = NULL;
1960 const char *base_name = NULL;
1962 if (!has_on_error) {
1963 on_error = BLOCKDEV_ON_ERROR_REPORT;
1966 bs = bdrv_find(device);
1967 if (!bs) {
1968 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1969 return;
1972 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
1973 return;
1976 if (has_base) {
1977 base_bs = bdrv_find_backing_image(bs, base);
1978 if (base_bs == NULL) {
1979 error_set(errp, QERR_BASE_NOT_FOUND, base);
1980 return;
1982 base_name = base;
1985 /* if we are streaming the entire chain, the result will have no backing
1986 * file, and specifying one is therefore an error */
1987 if (base_bs == NULL && has_backing_file) {
1988 error_setg(errp, "backing file specified, but streaming the "
1989 "entire chain");
1990 return;
1993 /* backing_file string overrides base bs filename */
1994 base_name = has_backing_file ? backing_file : base_name;
1996 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
1997 on_error, block_job_cb, bs, &local_err);
1998 if (local_err) {
1999 error_propagate(errp, local_err);
2000 return;
2003 trace_qmp_block_stream(bs, bs->job);
2006 void qmp_block_commit(const char *device,
2007 bool has_base, const char *base,
2008 bool has_top, const char *top,
2009 bool has_backing_file, const char *backing_file,
2010 bool has_speed, int64_t speed,
2011 Error **errp)
2013 BlockDriverState *bs;
2014 BlockDriverState *base_bs, *top_bs;
2015 Error *local_err = NULL;
2016 /* This will be part of the QMP command, if/when the
2017 * BlockdevOnError change for blkmirror makes it in
2019 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
2021 if (!has_speed) {
2022 speed = 0;
2025 /* drain all i/o before commits */
2026 bdrv_drain_all();
2028 /* Important Note:
2029 * libvirt relies on the DeviceNotFound error class in order to probe for
2030 * live commit feature versions; for this to work, we must make sure to
2031 * perform the device lookup before any generic errors that may occur in a
2032 * scenario in which all optional arguments are omitted. */
2033 bs = bdrv_find(device);
2034 if (!bs) {
2035 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2036 return;
2039 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT, errp)) {
2040 return;
2043 /* default top_bs is the active layer */
2044 top_bs = bs;
2046 if (has_top && top) {
2047 if (strcmp(bs->filename, top) != 0) {
2048 top_bs = bdrv_find_backing_image(bs, top);
2052 if (top_bs == NULL) {
2053 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2054 return;
2057 if (has_base && base) {
2058 base_bs = bdrv_find_backing_image(top_bs, base);
2059 } else {
2060 base_bs = bdrv_find_base(top_bs);
2063 if (base_bs == NULL) {
2064 error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
2065 return;
2068 /* Do not allow attempts to commit an image into itself */
2069 if (top_bs == base_bs) {
2070 error_setg(errp, "cannot commit an image into itself");
2071 return;
2074 if (top_bs == bs) {
2075 if (has_backing_file) {
2076 error_setg(errp, "'backing-file' specified,"
2077 " but 'top' is the active layer");
2078 return;
2080 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2081 bs, &local_err);
2082 } else {
2083 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
2084 has_backing_file ? backing_file : NULL, &local_err);
2086 if (local_err != NULL) {
2087 error_propagate(errp, local_err);
2088 return;
2092 void qmp_drive_backup(const char *device, const char *target,
2093 bool has_format, const char *format,
2094 enum MirrorSyncMode sync,
2095 bool has_mode, enum NewImageMode mode,
2096 bool has_speed, int64_t speed,
2097 bool has_on_source_error, BlockdevOnError on_source_error,
2098 bool has_on_target_error, BlockdevOnError on_target_error,
2099 Error **errp)
2101 BlockDriverState *bs;
2102 BlockDriverState *target_bs;
2103 BlockDriverState *source = NULL;
2104 BlockDriver *drv = NULL;
2105 Error *local_err = NULL;
2106 int flags;
2107 int64_t size;
2108 int ret;
2110 if (!has_speed) {
2111 speed = 0;
2113 if (!has_on_source_error) {
2114 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2116 if (!has_on_target_error) {
2117 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2119 if (!has_mode) {
2120 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2123 bs = bdrv_find(device);
2124 if (!bs) {
2125 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2126 return;
2129 if (!bdrv_is_inserted(bs)) {
2130 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2131 return;
2134 if (!has_format) {
2135 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2137 if (format) {
2138 drv = bdrv_find_format(format);
2139 if (!drv) {
2140 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
2141 return;
2145 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2146 return;
2149 flags = bs->open_flags | BDRV_O_RDWR;
2151 /* See if we have a backing HD we can use to create our new image
2152 * on top of. */
2153 if (sync == MIRROR_SYNC_MODE_TOP) {
2154 source = bs->backing_hd;
2155 if (!source) {
2156 sync = MIRROR_SYNC_MODE_FULL;
2159 if (sync == MIRROR_SYNC_MODE_NONE) {
2160 source = bs;
2163 size = bdrv_getlength(bs);
2164 if (size < 0) {
2165 error_setg_errno(errp, -size, "bdrv_getlength failed");
2166 return;
2169 if (mode != NEW_IMAGE_MODE_EXISTING) {
2170 assert(format && drv);
2171 if (source) {
2172 bdrv_img_create(target, format, source->filename,
2173 source->drv->format_name, NULL,
2174 size, flags, &local_err, false);
2175 } else {
2176 bdrv_img_create(target, format, NULL, NULL, NULL,
2177 size, flags, &local_err, false);
2181 if (local_err) {
2182 error_propagate(errp, local_err);
2183 return;
2186 target_bs = NULL;
2187 ret = bdrv_open(&target_bs, target, NULL, NULL, flags, drv, &local_err);
2188 if (ret < 0) {
2189 error_propagate(errp, local_err);
2190 return;
2193 backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
2194 block_job_cb, bs, &local_err);
2195 if (local_err != NULL) {
2196 bdrv_unref(target_bs);
2197 error_propagate(errp, local_err);
2198 return;
2202 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2204 return bdrv_named_nodes_list();
2207 #define DEFAULT_MIRROR_BUF_SIZE (10 << 20)
2209 void qmp_drive_mirror(const char *device, const char *target,
2210 bool has_format, const char *format,
2211 bool has_node_name, const char *node_name,
2212 bool has_replaces, const char *replaces,
2213 enum MirrorSyncMode sync,
2214 bool has_mode, enum NewImageMode mode,
2215 bool has_speed, int64_t speed,
2216 bool has_granularity, uint32_t granularity,
2217 bool has_buf_size, int64_t buf_size,
2218 bool has_on_source_error, BlockdevOnError on_source_error,
2219 bool has_on_target_error, BlockdevOnError on_target_error,
2220 Error **errp)
2222 BlockDriverState *bs;
2223 BlockDriverState *source, *target_bs;
2224 BlockDriver *drv = NULL;
2225 Error *local_err = NULL;
2226 QDict *options = NULL;
2227 int flags;
2228 int64_t size;
2229 int ret;
2231 if (!has_speed) {
2232 speed = 0;
2234 if (!has_on_source_error) {
2235 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2237 if (!has_on_target_error) {
2238 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2240 if (!has_mode) {
2241 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2243 if (!has_granularity) {
2244 granularity = 0;
2246 if (!has_buf_size) {
2247 buf_size = DEFAULT_MIRROR_BUF_SIZE;
2250 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
2251 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2252 "a value in range [512B, 64MB]");
2253 return;
2255 if (granularity & (granularity - 1)) {
2256 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "granularity", "power of 2");
2257 return;
2260 bs = bdrv_find(device);
2261 if (!bs) {
2262 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2263 return;
2266 if (!bdrv_is_inserted(bs)) {
2267 error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2268 return;
2271 if (!has_format) {
2272 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2274 if (format) {
2275 drv = bdrv_find_format(format);
2276 if (!drv) {
2277 error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
2278 return;
2282 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
2283 return;
2286 flags = bs->open_flags | BDRV_O_RDWR;
2287 source = bs->backing_hd;
2288 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
2289 sync = MIRROR_SYNC_MODE_FULL;
2291 if (sync == MIRROR_SYNC_MODE_NONE) {
2292 source = bs;
2295 size = bdrv_getlength(bs);
2296 if (size < 0) {
2297 error_setg_errno(errp, -size, "bdrv_getlength failed");
2298 return;
2301 if (has_replaces) {
2302 BlockDriverState *to_replace_bs;
2304 if (!has_node_name) {
2305 error_setg(errp, "a node-name must be provided when replacing a"
2306 " named node of the graph");
2307 return;
2310 to_replace_bs = check_to_replace_node(replaces, &local_err);
2312 if (!to_replace_bs) {
2313 error_propagate(errp, local_err);
2314 return;
2317 if (size != bdrv_getlength(to_replace_bs)) {
2318 error_setg(errp, "cannot replace image with a mirror image of "
2319 "different size");
2320 return;
2324 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
2325 && mode != NEW_IMAGE_MODE_EXISTING)
2327 /* create new image w/o backing file */
2328 assert(format && drv);
2329 bdrv_img_create(target, format,
2330 NULL, NULL, NULL, size, flags, &local_err, false);
2331 } else {
2332 switch (mode) {
2333 case NEW_IMAGE_MODE_EXISTING:
2334 break;
2335 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
2336 /* create new image with backing file */
2337 bdrv_img_create(target, format,
2338 source->filename,
2339 source->drv->format_name,
2340 NULL, size, flags, &local_err, false);
2341 break;
2342 default:
2343 abort();
2347 if (local_err) {
2348 error_propagate(errp, local_err);
2349 return;
2352 if (has_node_name) {
2353 options = qdict_new();
2354 qdict_put(options, "node-name", qstring_from_str(node_name));
2357 /* Mirroring takes care of copy-on-write using the source's backing
2358 * file.
2360 target_bs = NULL;
2361 ret = bdrv_open(&target_bs, target, NULL, options,
2362 flags | BDRV_O_NO_BACKING, drv, &local_err);
2363 if (ret < 0) {
2364 error_propagate(errp, local_err);
2365 return;
2368 /* pass the node name to replace to mirror start since it's loose coupling
2369 * and will allow to check whether the node still exist at mirror completion
2371 mirror_start(bs, target_bs,
2372 has_replaces ? replaces : NULL,
2373 speed, granularity, buf_size, sync,
2374 on_source_error, on_target_error,
2375 block_job_cb, bs, &local_err);
2376 if (local_err != NULL) {
2377 bdrv_unref(target_bs);
2378 error_propagate(errp, local_err);
2379 return;
2383 static BlockJob *find_block_job(const char *device)
2385 BlockDriverState *bs;
2387 bs = bdrv_find(device);
2388 if (!bs || !bs->job) {
2389 return NULL;
2391 return bs->job;
2394 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
2396 BlockJob *job = find_block_job(device);
2398 if (!job) {
2399 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2400 return;
2403 block_job_set_speed(job, speed, errp);
2406 void qmp_block_job_cancel(const char *device,
2407 bool has_force, bool force, Error **errp)
2409 BlockJob *job = find_block_job(device);
2411 if (!has_force) {
2412 force = false;
2415 if (!job) {
2416 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2417 return;
2419 if (job->paused && !force) {
2420 error_setg(errp, "The block job for device '%s' is currently paused",
2421 device);
2422 return;
2425 trace_qmp_block_job_cancel(job);
2426 block_job_cancel(job);
2429 void qmp_block_job_pause(const char *device, Error **errp)
2431 BlockJob *job = find_block_job(device);
2433 if (!job) {
2434 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2435 return;
2438 trace_qmp_block_job_pause(job);
2439 block_job_pause(job);
2442 void qmp_block_job_resume(const char *device, Error **errp)
2444 BlockJob *job = find_block_job(device);
2446 if (!job) {
2447 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2448 return;
2451 trace_qmp_block_job_resume(job);
2452 block_job_resume(job);
2455 void qmp_block_job_complete(const char *device, Error **errp)
2457 BlockJob *job = find_block_job(device);
2459 if (!job) {
2460 error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2461 return;
2464 trace_qmp_block_job_complete(job);
2465 block_job_complete(job, errp);
2468 void qmp_change_backing_file(const char *device,
2469 const char *image_node_name,
2470 const char *backing_file,
2471 Error **errp)
2473 BlockDriverState *bs = NULL;
2474 BlockDriverState *image_bs = NULL;
2475 Error *local_err = NULL;
2476 bool ro;
2477 int open_flags;
2478 int ret;
2480 /* find the top layer BDS of the chain */
2481 bs = bdrv_find(device);
2482 if (!bs) {
2483 error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2484 return;
2487 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
2488 if (local_err) {
2489 error_propagate(errp, local_err);
2490 return;
2493 if (!image_bs) {
2494 error_setg(errp, "image file not found");
2495 return;
2498 if (bdrv_find_base(image_bs) == image_bs) {
2499 error_setg(errp, "not allowing backing file change on an image "
2500 "without a backing file");
2501 return;
2504 /* even though we are not necessarily operating on bs, we need it to
2505 * determine if block ops are currently prohibited on the chain */
2506 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
2507 return;
2510 /* final sanity check */
2511 if (!bdrv_chain_contains(bs, image_bs)) {
2512 error_setg(errp, "'%s' and image file are not in the same chain",
2513 device);
2514 return;
2517 /* if not r/w, reopen to make r/w */
2518 open_flags = image_bs->open_flags;
2519 ro = bdrv_is_read_only(image_bs);
2521 if (ro) {
2522 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
2523 if (local_err) {
2524 error_propagate(errp, local_err);
2525 return;
2529 ret = bdrv_change_backing_file(image_bs, backing_file,
2530 image_bs->drv ? image_bs->drv->format_name : "");
2532 if (ret < 0) {
2533 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
2534 backing_file);
2535 /* don't exit here, so we can try to restore open flags if
2536 * appropriate */
2539 if (ro) {
2540 bdrv_reopen(image_bs, open_flags, &local_err);
2541 if (local_err) {
2542 error_propagate(errp, local_err); /* will preserve prior errp */
2547 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
2549 QmpOutputVisitor *ov = qmp_output_visitor_new();
2550 BlockBackend *blk;
2551 QObject *obj;
2552 QDict *qdict;
2553 Error *local_err = NULL;
2555 /* Require an ID in the top level */
2556 if (!options->has_id) {
2557 error_setg(errp, "Block device needs an ID");
2558 goto fail;
2561 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
2562 * cache.direct=false instead of silently switching to aio=threads, except
2563 * when called from drive_new().
2565 * For now, simply forbidding the combination for all drivers will do. */
2566 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
2567 bool direct = options->has_cache &&
2568 options->cache->has_direct &&
2569 options->cache->direct;
2570 if (!direct) {
2571 error_setg(errp, "aio=native requires cache.direct=true");
2572 goto fail;
2576 visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
2577 &options, NULL, &local_err);
2578 if (local_err) {
2579 error_propagate(errp, local_err);
2580 goto fail;
2583 obj = qmp_output_get_qobject(ov);
2584 qdict = qobject_to_qdict(obj);
2586 qdict_flatten(qdict);
2588 blk = blockdev_init(NULL, qdict, &local_err);
2589 if (local_err) {
2590 error_propagate(errp, local_err);
2591 goto fail;
2594 if (bdrv_key_required(blk_bs(blk))) {
2595 blk_unref(blk);
2596 error_setg(errp, "blockdev-add doesn't support encrypted devices");
2597 goto fail;
2600 fail:
2601 qmp_output_visitor_cleanup(ov);
2604 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
2606 BlockJobInfoList *head = NULL, **p_next = &head;
2607 BlockDriverState *bs;
2609 for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
2610 if (bs->job) {
2611 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
2612 elem->value = block_job_query(bs->job);
2613 *p_next = elem;
2614 p_next = &elem->next;
2618 return head;
2621 QemuOptsList qemu_common_drive_opts = {
2622 .name = "drive",
2623 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
2624 .desc = {
2626 .name = "snapshot",
2627 .type = QEMU_OPT_BOOL,
2628 .help = "enable/disable snapshot mode",
2630 .name = "discard",
2631 .type = QEMU_OPT_STRING,
2632 .help = "discard operation (ignore/off, unmap/on)",
2634 .name = "cache.writeback",
2635 .type = QEMU_OPT_BOOL,
2636 .help = "enables writeback mode for any caches",
2638 .name = "cache.direct",
2639 .type = QEMU_OPT_BOOL,
2640 .help = "enables use of O_DIRECT (bypass the host page cache)",
2642 .name = "cache.no-flush",
2643 .type = QEMU_OPT_BOOL,
2644 .help = "ignore any flush requests for the device",
2646 .name = "aio",
2647 .type = QEMU_OPT_STRING,
2648 .help = "host AIO implementation (threads, native)",
2650 .name = "format",
2651 .type = QEMU_OPT_STRING,
2652 .help = "disk format (raw, qcow2, ...)",
2654 .name = "rerror",
2655 .type = QEMU_OPT_STRING,
2656 .help = "read error action",
2658 .name = "werror",
2659 .type = QEMU_OPT_STRING,
2660 .help = "write error action",
2662 .name = "read-only",
2663 .type = QEMU_OPT_BOOL,
2664 .help = "open drive file as read-only",
2666 .name = "throttling.iops-total",
2667 .type = QEMU_OPT_NUMBER,
2668 .help = "limit total I/O operations per second",
2670 .name = "throttling.iops-read",
2671 .type = QEMU_OPT_NUMBER,
2672 .help = "limit read operations per second",
2674 .name = "throttling.iops-write",
2675 .type = QEMU_OPT_NUMBER,
2676 .help = "limit write operations per second",
2678 .name = "throttling.bps-total",
2679 .type = QEMU_OPT_NUMBER,
2680 .help = "limit total bytes per second",
2682 .name = "throttling.bps-read",
2683 .type = QEMU_OPT_NUMBER,
2684 .help = "limit read bytes per second",
2686 .name = "throttling.bps-write",
2687 .type = QEMU_OPT_NUMBER,
2688 .help = "limit write bytes per second",
2690 .name = "throttling.iops-total-max",
2691 .type = QEMU_OPT_NUMBER,
2692 .help = "I/O operations burst",
2694 .name = "throttling.iops-read-max",
2695 .type = QEMU_OPT_NUMBER,
2696 .help = "I/O operations read burst",
2698 .name = "throttling.iops-write-max",
2699 .type = QEMU_OPT_NUMBER,
2700 .help = "I/O operations write burst",
2702 .name = "throttling.bps-total-max",
2703 .type = QEMU_OPT_NUMBER,
2704 .help = "total bytes burst",
2706 .name = "throttling.bps-read-max",
2707 .type = QEMU_OPT_NUMBER,
2708 .help = "total bytes read burst",
2710 .name = "throttling.bps-write-max",
2711 .type = QEMU_OPT_NUMBER,
2712 .help = "total bytes write burst",
2714 .name = "throttling.iops-size",
2715 .type = QEMU_OPT_NUMBER,
2716 .help = "when limiting by iops max size of an I/O in bytes",
2718 .name = "copy-on-read",
2719 .type = QEMU_OPT_BOOL,
2720 .help = "copy read data from backing file into image file",
2722 .name = "detect-zeroes",
2723 .type = QEMU_OPT_STRING,
2724 .help = "try to optimize zero writes (off, on, unmap)",
2726 { /* end of list */ }
2730 QemuOptsList qemu_drive_opts = {
2731 .name = "drive",
2732 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
2733 .desc = {
2735 * no elements => accept any params
2736 * validation will happen later
2738 { /* end of list */ }