virtio-scsi: Don't abort when media is ejected
[qemu.git] / blockdev.c
blobc3b05934d7d8317ea79cef9372a6d5dadd236f6f
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 "qemu/osdep.h"
34 #include "sysemu/block-backend.h"
35 #include "sysemu/blockdev.h"
36 #include "hw/block/block.h"
37 #include "block/blockjob.h"
38 #include "block/throttle-groups.h"
39 #include "monitor/monitor.h"
40 #include "qemu/error-report.h"
41 #include "qemu/option.h"
42 #include "qemu/config-file.h"
43 #include "qapi/qmp/types.h"
44 #include "qapi-visit.h"
45 #include "qapi/qmp/qerror.h"
46 #include "qapi/qmp-output-visitor.h"
47 #include "qapi/util.h"
48 #include "sysemu/sysemu.h"
49 #include "block/block_int.h"
50 #include "qmp-commands.h"
51 #include "trace.h"
52 #include "sysemu/arch_init.h"
53 #include "qemu/cutils.h"
54 #include "qemu/help_option.h"
56 static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
57 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
59 static int do_open_tray(const char *device, bool force, Error **errp);
61 static const char *const if_name[IF_COUNT] = {
62 [IF_NONE] = "none",
63 [IF_IDE] = "ide",
64 [IF_SCSI] = "scsi",
65 [IF_FLOPPY] = "floppy",
66 [IF_PFLASH] = "pflash",
67 [IF_MTD] = "mtd",
68 [IF_SD] = "sd",
69 [IF_VIRTIO] = "virtio",
70 [IF_XEN] = "xen",
73 static int if_max_devs[IF_COUNT] = {
75 * Do not change these numbers! They govern how drive option
76 * index maps to unit and bus. That mapping is ABI.
78 * All controllers used to implement if=T drives need to support
79 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
80 * Otherwise, some index values map to "impossible" bus, unit
81 * values.
83 * For instance, if you change [IF_SCSI] to 255, -drive
84 * if=scsi,index=12 no longer means bus=1,unit=5, but
85 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
86 * the drive can't be set up. Regression.
88 [IF_IDE] = 2,
89 [IF_SCSI] = 7,
92 /**
93 * Boards may call this to offer board-by-board overrides
94 * of the default, global values.
96 void override_max_devs(BlockInterfaceType type, int max_devs)
98 BlockBackend *blk;
99 DriveInfo *dinfo;
101 if (max_devs <= 0) {
102 return;
105 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
106 dinfo = blk_legacy_dinfo(blk);
107 if (dinfo->type == type) {
108 fprintf(stderr, "Cannot override units-per-bus property of"
109 " the %s interface, because a drive of that type has"
110 " already been added.\n", if_name[type]);
111 g_assert_not_reached();
115 if_max_devs[type] = max_devs;
119 * We automatically delete the drive when a device using it gets
120 * unplugged. Questionable feature, but we can't just drop it.
121 * Device models call blockdev_mark_auto_del() to schedule the
122 * automatic deletion, and generic qdev code calls blockdev_auto_del()
123 * when deletion is actually safe.
125 void blockdev_mark_auto_del(BlockBackend *blk)
127 DriveInfo *dinfo = blk_legacy_dinfo(blk);
128 BlockDriverState *bs = blk_bs(blk);
129 AioContext *aio_context;
131 if (!dinfo) {
132 return;
135 if (bs) {
136 aio_context = bdrv_get_aio_context(bs);
137 aio_context_acquire(aio_context);
139 if (bs->job) {
140 block_job_cancel(bs->job);
143 aio_context_release(aio_context);
146 dinfo->auto_del = 1;
149 void blockdev_auto_del(BlockBackend *blk)
151 DriveInfo *dinfo = blk_legacy_dinfo(blk);
153 if (dinfo && dinfo->auto_del) {
154 monitor_remove_blk(blk);
155 blk_unref(blk);
160 * Returns the current mapping of how many units per bus
161 * a particular interface can support.
163 * A positive integer indicates n units per bus.
164 * 0 implies the mapping has not been established.
165 * -1 indicates an invalid BlockInterfaceType was given.
167 int drive_get_max_devs(BlockInterfaceType type)
169 if (type >= IF_IDE && type < IF_COUNT) {
170 return if_max_devs[type];
173 return -1;
176 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
178 int max_devs = if_max_devs[type];
179 return max_devs ? index / max_devs : 0;
182 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
184 int max_devs = if_max_devs[type];
185 return max_devs ? index % max_devs : index;
188 QemuOpts *drive_def(const char *optstr)
190 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
193 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
194 const char *optstr)
196 QemuOpts *opts;
198 opts = drive_def(optstr);
199 if (!opts) {
200 return NULL;
202 if (type != IF_DEFAULT) {
203 qemu_opt_set(opts, "if", if_name[type], &error_abort);
205 if (index >= 0) {
206 qemu_opt_set_number(opts, "index", index, &error_abort);
208 if (file)
209 qemu_opt_set(opts, "file", file, &error_abort);
210 return opts;
213 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
215 BlockBackend *blk;
216 DriveInfo *dinfo;
218 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
219 dinfo = blk_legacy_dinfo(blk);
220 if (dinfo && dinfo->type == type
221 && dinfo->bus == bus && dinfo->unit == unit) {
222 return dinfo;
226 return NULL;
229 bool drive_check_orphaned(void)
231 BlockBackend *blk;
232 DriveInfo *dinfo;
233 bool rs = false;
235 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
236 dinfo = blk_legacy_dinfo(blk);
237 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
238 /* Unless this is a default drive, this may be an oversight. */
239 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
240 dinfo->type != IF_NONE) {
241 fprintf(stderr, "Warning: Orphaned drive without device: "
242 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
243 blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
244 if_name[dinfo->type], dinfo->bus, dinfo->unit);
245 rs = true;
249 return rs;
252 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
254 return drive_get(type,
255 drive_index_to_bus_id(type, index),
256 drive_index_to_unit_id(type, index));
259 int drive_get_max_bus(BlockInterfaceType type)
261 int max_bus;
262 BlockBackend *blk;
263 DriveInfo *dinfo;
265 max_bus = -1;
266 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
267 dinfo = blk_legacy_dinfo(blk);
268 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
269 max_bus = dinfo->bus;
272 return max_bus;
275 /* Get a block device. This should only be used for single-drive devices
276 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
277 appropriate bus. */
278 DriveInfo *drive_get_next(BlockInterfaceType type)
280 static int next_block_unit[IF_COUNT];
282 return drive_get(type, 0, next_block_unit[type]++);
285 static void bdrv_format_print(void *opaque, const char *name)
287 error_printf(" %s", name);
290 typedef struct {
291 QEMUBH *bh;
292 BlockDriverState *bs;
293 } BDRVPutRefBH;
295 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
297 if (!strcmp(buf, "ignore")) {
298 return BLOCKDEV_ON_ERROR_IGNORE;
299 } else if (!is_read && !strcmp(buf, "enospc")) {
300 return BLOCKDEV_ON_ERROR_ENOSPC;
301 } else if (!strcmp(buf, "stop")) {
302 return BLOCKDEV_ON_ERROR_STOP;
303 } else if (!strcmp(buf, "report")) {
304 return BLOCKDEV_ON_ERROR_REPORT;
305 } else {
306 error_setg(errp, "'%s' invalid %s error action",
307 buf, is_read ? "read" : "write");
308 return -1;
312 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
313 Error **errp)
315 const QListEntry *entry;
316 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
317 switch (qobject_type(entry->value)) {
319 case QTYPE_QSTRING: {
320 unsigned long long length;
321 const char *str = qstring_get_str(qobject_to_qstring(entry->value));
322 if (parse_uint_full(str, &length, 10) == 0 &&
323 length > 0 && length <= UINT_MAX) {
324 block_acct_add_interval(stats, (unsigned) length);
325 } else {
326 error_setg(errp, "Invalid interval length: %s", str);
327 return false;
329 break;
332 case QTYPE_QINT: {
333 int64_t length = qint_get_int(qobject_to_qint(entry->value));
334 if (length > 0 && length <= UINT_MAX) {
335 block_acct_add_interval(stats, (unsigned) length);
336 } else {
337 error_setg(errp, "Invalid interval length: %" PRId64, length);
338 return false;
340 break;
343 default:
344 error_setg(errp, "The specification of stats-intervals is invalid");
345 return false;
348 return true;
351 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
353 /* All parameters but @opts are optional and may be set to NULL. */
354 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
355 const char **throttling_group, ThrottleConfig *throttle_cfg,
356 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
358 const char *discard;
359 Error *local_error = NULL;
360 const char *aio;
362 if (bdrv_flags) {
363 if (!qemu_opt_get_bool(opts, "read-only", false)) {
364 *bdrv_flags |= BDRV_O_RDWR;
366 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
367 *bdrv_flags |= BDRV_O_COPY_ON_READ;
370 if ((discard = qemu_opt_get(opts, "discard")) != NULL) {
371 if (bdrv_parse_discard_flags(discard, bdrv_flags) != 0) {
372 error_setg(errp, "Invalid discard option");
373 return;
377 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
378 if (!strcmp(aio, "native")) {
379 *bdrv_flags |= BDRV_O_NATIVE_AIO;
380 } else if (!strcmp(aio, "threads")) {
381 /* this is the default */
382 } else {
383 error_setg(errp, "invalid aio option");
384 return;
389 /* disk I/O throttling */
390 if (throttling_group) {
391 *throttling_group = qemu_opt_get(opts, "throttling.group");
394 if (throttle_cfg) {
395 throttle_config_init(throttle_cfg);
396 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
397 qemu_opt_get_number(opts, "throttling.bps-total", 0);
398 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
399 qemu_opt_get_number(opts, "throttling.bps-read", 0);
400 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
401 qemu_opt_get_number(opts, "throttling.bps-write", 0);
402 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
403 qemu_opt_get_number(opts, "throttling.iops-total", 0);
404 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
405 qemu_opt_get_number(opts, "throttling.iops-read", 0);
406 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
407 qemu_opt_get_number(opts, "throttling.iops-write", 0);
409 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
410 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
411 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
412 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
413 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
414 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
415 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
416 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
417 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
418 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
419 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
420 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
422 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
423 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
424 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
425 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
426 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
427 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
428 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
429 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
430 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
431 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
432 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
433 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
435 throttle_cfg->op_size =
436 qemu_opt_get_number(opts, "throttling.iops-size", 0);
438 if (!throttle_is_valid(throttle_cfg, errp)) {
439 return;
443 if (detect_zeroes) {
444 *detect_zeroes =
445 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
446 qemu_opt_get(opts, "detect-zeroes"),
447 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
448 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
449 &local_error);
450 if (local_error) {
451 error_propagate(errp, local_error);
452 return;
455 if (bdrv_flags &&
456 *detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
457 !(*bdrv_flags & BDRV_O_UNMAP))
459 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
460 "without setting discard operation to unmap");
461 return;
466 /* Takes the ownership of bs_opts */
467 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
468 Error **errp)
470 const char *buf;
471 int bdrv_flags = 0;
472 int on_read_error, on_write_error;
473 bool account_invalid, account_failed;
474 bool writethrough;
475 BlockBackend *blk;
476 BlockDriverState *bs;
477 ThrottleConfig cfg;
478 int snapshot = 0;
479 Error *error = NULL;
480 QemuOpts *opts;
481 QDict *interval_dict = NULL;
482 QList *interval_list = NULL;
483 const char *id;
484 BlockdevDetectZeroesOptions detect_zeroes =
485 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
486 const char *throttling_group = NULL;
488 /* Check common options by copying from bs_opts to opts, all other options
489 * stay in bs_opts for processing by bdrv_open(). */
490 id = qdict_get_try_str(bs_opts, "id");
491 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
492 if (error) {
493 error_propagate(errp, error);
494 goto err_no_opts;
497 qemu_opts_absorb_qdict(opts, bs_opts, &error);
498 if (error) {
499 error_propagate(errp, error);
500 goto early_err;
503 if (id) {
504 qdict_del(bs_opts, "id");
507 /* extract parameters */
508 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
510 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
511 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
513 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
515 id = qemu_opts_id(opts);
517 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
518 qdict_array_split(interval_dict, &interval_list);
520 if (qdict_size(interval_dict) != 0) {
521 error_setg(errp, "Invalid option stats-intervals.%s",
522 qdict_first(interval_dict)->key);
523 goto early_err;
526 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
527 &detect_zeroes, &error);
528 if (error) {
529 error_propagate(errp, error);
530 goto early_err;
533 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
534 if (is_help_option(buf)) {
535 error_printf("Supported formats:");
536 bdrv_iterate_format(bdrv_format_print, NULL);
537 error_printf("\n");
538 goto early_err;
541 if (qdict_haskey(bs_opts, "driver")) {
542 error_setg(errp, "Cannot specify both 'driver' and 'format'");
543 goto early_err;
545 qdict_put(bs_opts, "driver", qstring_from_str(buf));
548 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
549 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
550 on_write_error = parse_block_error_action(buf, 0, &error);
551 if (error) {
552 error_propagate(errp, error);
553 goto early_err;
557 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
558 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
559 on_read_error = parse_block_error_action(buf, 1, &error);
560 if (error) {
561 error_propagate(errp, error);
562 goto early_err;
566 if (snapshot) {
567 bdrv_flags |= BDRV_O_SNAPSHOT;
570 /* init */
571 if ((!file || !*file) && !qdict_size(bs_opts)) {
572 BlockBackendRootState *blk_rs;
574 blk = blk_new();
575 blk_rs = blk_get_root_state(blk);
576 blk_rs->open_flags = bdrv_flags;
577 blk_rs->read_only = !(bdrv_flags & BDRV_O_RDWR);
578 blk_rs->detect_zeroes = detect_zeroes;
580 QDECREF(bs_opts);
581 } else {
582 if (file && !*file) {
583 file = NULL;
586 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
587 * with other callers) rather than what we want as the real defaults.
588 * Apply the defaults here instead. */
589 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
590 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
591 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
593 if (runstate_check(RUN_STATE_INMIGRATE)) {
594 bdrv_flags |= BDRV_O_INACTIVE;
597 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
598 if (!blk) {
599 goto err_no_bs_opts;
601 bs = blk_bs(blk);
603 bs->detect_zeroes = detect_zeroes;
605 if (bdrv_key_required(bs)) {
606 autostart = 0;
609 block_acct_init(blk_get_stats(blk), account_invalid, account_failed);
611 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
612 blk_unref(blk);
613 blk = NULL;
614 goto err_no_bs_opts;
618 /* disk I/O throttling */
619 if (throttle_enabled(&cfg)) {
620 if (!throttling_group) {
621 throttling_group = id;
623 blk_io_limits_enable(blk, throttling_group);
624 blk_set_io_limits(blk, &cfg);
627 blk_set_enable_write_cache(blk, !writethrough);
628 blk_set_on_error(blk, on_read_error, on_write_error);
630 if (!monitor_add_blk(blk, id, errp)) {
631 blk_unref(blk);
632 blk = NULL;
633 goto err_no_bs_opts;
636 err_no_bs_opts:
637 qemu_opts_del(opts);
638 QDECREF(interval_dict);
639 QDECREF(interval_list);
640 return blk;
642 early_err:
643 qemu_opts_del(opts);
644 QDECREF(interval_dict);
645 QDECREF(interval_list);
646 err_no_opts:
647 QDECREF(bs_opts);
648 return NULL;
651 static QemuOptsList qemu_root_bds_opts;
653 /* Takes the ownership of bs_opts */
654 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
656 BlockDriverState *bs;
657 QemuOpts *opts;
658 Error *local_error = NULL;
659 BlockdevDetectZeroesOptions detect_zeroes;
660 int bdrv_flags = 0;
662 opts = qemu_opts_create(&qemu_root_bds_opts, NULL, 1, errp);
663 if (!opts) {
664 goto fail;
667 qemu_opts_absorb_qdict(opts, bs_opts, &local_error);
668 if (local_error) {
669 error_propagate(errp, local_error);
670 goto fail;
673 extract_common_blockdev_options(opts, &bdrv_flags, NULL, NULL,
674 &detect_zeroes, &local_error);
675 if (local_error) {
676 error_propagate(errp, local_error);
677 goto fail;
680 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
681 * with other callers) rather than what we want as the real defaults.
682 * Apply the defaults here instead. */
683 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
684 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
686 if (runstate_check(RUN_STATE_INMIGRATE)) {
687 bdrv_flags |= BDRV_O_INACTIVE;
690 bs = bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
691 if (!bs) {
692 goto fail_no_bs_opts;
695 bs->detect_zeroes = detect_zeroes;
697 fail_no_bs_opts:
698 qemu_opts_del(opts);
699 return bs;
701 fail:
702 qemu_opts_del(opts);
703 QDECREF(bs_opts);
704 return NULL;
707 void blockdev_close_all_bdrv_states(void)
709 BlockDriverState *bs, *next_bs;
711 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
712 AioContext *ctx = bdrv_get_aio_context(bs);
714 aio_context_acquire(ctx);
715 bdrv_unref(bs);
716 aio_context_release(ctx);
720 /* Iterates over the list of monitor-owned BlockDriverStates */
721 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
723 return bs ? QTAILQ_NEXT(bs, monitor_list)
724 : QTAILQ_FIRST(&monitor_bdrv_states);
727 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
728 Error **errp)
730 const char *value;
732 value = qemu_opt_get(opts, from);
733 if (value) {
734 if (qemu_opt_find(opts, to)) {
735 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
736 "same time", to, from);
737 return;
741 /* rename all items in opts */
742 while ((value = qemu_opt_get(opts, from))) {
743 qemu_opt_set(opts, to, value, &error_abort);
744 qemu_opt_unset(opts, from);
748 QemuOptsList qemu_legacy_drive_opts = {
749 .name = "drive",
750 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
751 .desc = {
753 .name = "bus",
754 .type = QEMU_OPT_NUMBER,
755 .help = "bus number",
757 .name = "unit",
758 .type = QEMU_OPT_NUMBER,
759 .help = "unit number (i.e. lun for scsi)",
761 .name = "index",
762 .type = QEMU_OPT_NUMBER,
763 .help = "index number",
765 .name = "media",
766 .type = QEMU_OPT_STRING,
767 .help = "media type (disk, cdrom)",
769 .name = "if",
770 .type = QEMU_OPT_STRING,
771 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
773 .name = "cyls",
774 .type = QEMU_OPT_NUMBER,
775 .help = "number of cylinders (ide disk geometry)",
777 .name = "heads",
778 .type = QEMU_OPT_NUMBER,
779 .help = "number of heads (ide disk geometry)",
781 .name = "secs",
782 .type = QEMU_OPT_NUMBER,
783 .help = "number of sectors (ide disk geometry)",
785 .name = "trans",
786 .type = QEMU_OPT_STRING,
787 .help = "chs translation (auto, lba, none)",
789 .name = "boot",
790 .type = QEMU_OPT_BOOL,
791 .help = "(deprecated, ignored)",
793 .name = "addr",
794 .type = QEMU_OPT_STRING,
795 .help = "pci address (virtio only)",
797 .name = "serial",
798 .type = QEMU_OPT_STRING,
799 .help = "disk serial number",
801 .name = "file",
802 .type = QEMU_OPT_STRING,
803 .help = "file name",
806 /* Options that are passed on, but have special semantics with -drive */
808 .name = "read-only",
809 .type = QEMU_OPT_BOOL,
810 .help = "open drive file as read-only",
812 .name = "rerror",
813 .type = QEMU_OPT_STRING,
814 .help = "read error action",
816 .name = "werror",
817 .type = QEMU_OPT_STRING,
818 .help = "write error action",
820 .name = "copy-on-read",
821 .type = QEMU_OPT_BOOL,
822 .help = "copy read data from backing file into image file",
825 { /* end of list */ }
829 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
831 const char *value;
832 BlockBackend *blk;
833 DriveInfo *dinfo = NULL;
834 QDict *bs_opts;
835 QemuOpts *legacy_opts;
836 DriveMediaType media = MEDIA_DISK;
837 BlockInterfaceType type;
838 int cyls, heads, secs, translation;
839 int max_devs, bus_id, unit_id, index;
840 const char *devaddr;
841 const char *werror, *rerror;
842 bool read_only = false;
843 bool copy_on_read;
844 const char *serial;
845 const char *filename;
846 Error *local_err = NULL;
847 int i;
849 /* Change legacy command line options into QMP ones */
850 static const struct {
851 const char *from;
852 const char *to;
853 } opt_renames[] = {
854 { "iops", "throttling.iops-total" },
855 { "iops_rd", "throttling.iops-read" },
856 { "iops_wr", "throttling.iops-write" },
858 { "bps", "throttling.bps-total" },
859 { "bps_rd", "throttling.bps-read" },
860 { "bps_wr", "throttling.bps-write" },
862 { "iops_max", "throttling.iops-total-max" },
863 { "iops_rd_max", "throttling.iops-read-max" },
864 { "iops_wr_max", "throttling.iops-write-max" },
866 { "bps_max", "throttling.bps-total-max" },
867 { "bps_rd_max", "throttling.bps-read-max" },
868 { "bps_wr_max", "throttling.bps-write-max" },
870 { "iops_size", "throttling.iops-size" },
872 { "group", "throttling.group" },
874 { "readonly", "read-only" },
877 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
878 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
879 &local_err);
880 if (local_err) {
881 error_report_err(local_err);
882 return NULL;
886 value = qemu_opt_get(all_opts, "cache");
887 if (value) {
888 int flags = 0;
889 bool writethrough;
891 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
892 error_report("invalid cache option");
893 return NULL;
896 /* Specific options take precedence */
897 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
898 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
899 !writethrough, &error_abort);
901 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
902 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
903 !!(flags & BDRV_O_NOCACHE), &error_abort);
905 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
906 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
907 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
909 qemu_opt_unset(all_opts, "cache");
912 /* Get a QDict for processing the options */
913 bs_opts = qdict_new();
914 qemu_opts_to_qdict(all_opts, bs_opts);
916 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
917 &error_abort);
918 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
919 if (local_err) {
920 error_report_err(local_err);
921 goto fail;
924 /* Deprecated option boot=[on|off] */
925 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
926 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
927 "ignored. Future versions will reject this parameter. Please "
928 "update your scripts.\n");
931 /* Media type */
932 value = qemu_opt_get(legacy_opts, "media");
933 if (value) {
934 if (!strcmp(value, "disk")) {
935 media = MEDIA_DISK;
936 } else if (!strcmp(value, "cdrom")) {
937 media = MEDIA_CDROM;
938 read_only = true;
939 } else {
940 error_report("'%s' invalid media", value);
941 goto fail;
945 /* copy-on-read is disabled with a warning for read-only devices */
946 read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
947 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
949 if (read_only && copy_on_read) {
950 error_report("warning: disabling copy-on-read on read-only drive");
951 copy_on_read = false;
954 qdict_put(bs_opts, "read-only",
955 qstring_from_str(read_only ? "on" : "off"));
956 qdict_put(bs_opts, "copy-on-read",
957 qstring_from_str(copy_on_read ? "on" :"off"));
959 /* Controller type */
960 value = qemu_opt_get(legacy_opts, "if");
961 if (value) {
962 for (type = 0;
963 type < IF_COUNT && strcmp(value, if_name[type]);
964 type++) {
966 if (type == IF_COUNT) {
967 error_report("unsupported bus type '%s'", value);
968 goto fail;
970 } else {
971 type = block_default_type;
974 /* Geometry */
975 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
976 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
977 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
979 if (cyls || heads || secs) {
980 if (cyls < 1) {
981 error_report("invalid physical cyls number");
982 goto fail;
984 if (heads < 1) {
985 error_report("invalid physical heads number");
986 goto fail;
988 if (secs < 1) {
989 error_report("invalid physical secs number");
990 goto fail;
994 translation = BIOS_ATA_TRANSLATION_AUTO;
995 value = qemu_opt_get(legacy_opts, "trans");
996 if (value != NULL) {
997 if (!cyls) {
998 error_report("'%s' trans must be used with cyls, heads and secs",
999 value);
1000 goto fail;
1002 if (!strcmp(value, "none")) {
1003 translation = BIOS_ATA_TRANSLATION_NONE;
1004 } else if (!strcmp(value, "lba")) {
1005 translation = BIOS_ATA_TRANSLATION_LBA;
1006 } else if (!strcmp(value, "large")) {
1007 translation = BIOS_ATA_TRANSLATION_LARGE;
1008 } else if (!strcmp(value, "rechs")) {
1009 translation = BIOS_ATA_TRANSLATION_RECHS;
1010 } else if (!strcmp(value, "auto")) {
1011 translation = BIOS_ATA_TRANSLATION_AUTO;
1012 } else {
1013 error_report("'%s' invalid translation type", value);
1014 goto fail;
1018 if (media == MEDIA_CDROM) {
1019 if (cyls || secs || heads) {
1020 error_report("CHS can't be set with media=cdrom");
1021 goto fail;
1025 /* Device address specified by bus/unit or index.
1026 * If none was specified, try to find the first free one. */
1027 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
1028 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
1029 index = qemu_opt_get_number(legacy_opts, "index", -1);
1031 max_devs = if_max_devs[type];
1033 if (index != -1) {
1034 if (bus_id != 0 || unit_id != -1) {
1035 error_report("index cannot be used with bus and unit");
1036 goto fail;
1038 bus_id = drive_index_to_bus_id(type, index);
1039 unit_id = drive_index_to_unit_id(type, index);
1042 if (unit_id == -1) {
1043 unit_id = 0;
1044 while (drive_get(type, bus_id, unit_id) != NULL) {
1045 unit_id++;
1046 if (max_devs && unit_id >= max_devs) {
1047 unit_id -= max_devs;
1048 bus_id++;
1053 if (max_devs && unit_id >= max_devs) {
1054 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
1055 goto fail;
1058 if (drive_get(type, bus_id, unit_id) != NULL) {
1059 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1060 bus_id, unit_id, index);
1061 goto fail;
1064 /* Serial number */
1065 serial = qemu_opt_get(legacy_opts, "serial");
1067 /* no id supplied -> create one */
1068 if (qemu_opts_id(all_opts) == NULL) {
1069 char *new_id;
1070 const char *mediastr = "";
1071 if (type == IF_IDE || type == IF_SCSI) {
1072 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
1074 if (max_devs) {
1075 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
1076 mediastr, unit_id);
1077 } else {
1078 new_id = g_strdup_printf("%s%s%i", if_name[type],
1079 mediastr, unit_id);
1081 qdict_put(bs_opts, "id", qstring_from_str(new_id));
1082 g_free(new_id);
1085 /* Add virtio block device */
1086 devaddr = qemu_opt_get(legacy_opts, "addr");
1087 if (devaddr && type != IF_VIRTIO) {
1088 error_report("addr is not supported by this bus type");
1089 goto fail;
1092 if (type == IF_VIRTIO) {
1093 QemuOpts *devopts;
1094 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
1095 &error_abort);
1096 if (arch_type == QEMU_ARCH_S390X) {
1097 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1098 } else {
1099 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1101 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
1102 &error_abort);
1103 if (devaddr) {
1104 qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1108 filename = qemu_opt_get(legacy_opts, "file");
1110 /* Check werror/rerror compatibility with if=... */
1111 werror = qemu_opt_get(legacy_opts, "werror");
1112 if (werror != NULL) {
1113 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
1114 type != IF_NONE) {
1115 error_report("werror is not supported by this bus type");
1116 goto fail;
1118 qdict_put(bs_opts, "werror", qstring_from_str(werror));
1121 rerror = qemu_opt_get(legacy_opts, "rerror");
1122 if (rerror != NULL) {
1123 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
1124 type != IF_NONE) {
1125 error_report("rerror is not supported by this bus type");
1126 goto fail;
1128 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
1131 /* Actual block device init: Functionality shared with blockdev-add */
1132 blk = blockdev_init(filename, bs_opts, &local_err);
1133 bs_opts = NULL;
1134 if (!blk) {
1135 if (local_err) {
1136 error_report_err(local_err);
1138 goto fail;
1139 } else {
1140 assert(!local_err);
1143 /* Create legacy DriveInfo */
1144 dinfo = g_malloc0(sizeof(*dinfo));
1145 dinfo->opts = all_opts;
1147 dinfo->cyls = cyls;
1148 dinfo->heads = heads;
1149 dinfo->secs = secs;
1150 dinfo->trans = translation;
1152 dinfo->type = type;
1153 dinfo->bus = bus_id;
1154 dinfo->unit = unit_id;
1155 dinfo->devaddr = devaddr;
1156 dinfo->serial = g_strdup(serial);
1158 blk_set_legacy_dinfo(blk, dinfo);
1160 switch(type) {
1161 case IF_IDE:
1162 case IF_SCSI:
1163 case IF_XEN:
1164 case IF_NONE:
1165 dinfo->media_cd = media == MEDIA_CDROM;
1166 break;
1167 default:
1168 break;
1171 fail:
1172 qemu_opts_del(legacy_opts);
1173 QDECREF(bs_opts);
1174 return dinfo;
1177 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1179 BlockDriverState *bs;
1181 bs = bdrv_lookup_bs(name, name, errp);
1182 if (bs == NULL) {
1183 return NULL;
1186 if (!bdrv_is_root_node(bs)) {
1187 error_setg(errp, "Need a root block node");
1188 return NULL;
1191 if (!bdrv_is_inserted(bs)) {
1192 error_setg(errp, "Device has no medium");
1193 return NULL;
1196 return bs;
1199 void hmp_commit(Monitor *mon, const QDict *qdict)
1201 const char *device = qdict_get_str(qdict, "device");
1202 BlockBackend *blk;
1203 int ret;
1205 if (!strcmp(device, "all")) {
1206 ret = blk_commit_all();
1207 } else {
1208 BlockDriverState *bs;
1209 AioContext *aio_context;
1211 blk = blk_by_name(device);
1212 if (!blk) {
1213 monitor_printf(mon, "Device '%s' not found\n", device);
1214 return;
1216 if (!blk_is_available(blk)) {
1217 monitor_printf(mon, "Device '%s' has no medium\n", device);
1218 return;
1221 bs = blk_bs(blk);
1222 aio_context = bdrv_get_aio_context(bs);
1223 aio_context_acquire(aio_context);
1225 ret = bdrv_commit(bs);
1227 aio_context_release(aio_context);
1229 if (ret < 0) {
1230 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1231 strerror(-ret));
1235 static void blockdev_do_action(TransactionAction *action, Error **errp)
1237 TransactionActionList list;
1239 list.value = action;
1240 list.next = NULL;
1241 qmp_transaction(&list, false, NULL, errp);
1244 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1245 bool has_node_name, const char *node_name,
1246 const char *snapshot_file,
1247 bool has_snapshot_node_name,
1248 const char *snapshot_node_name,
1249 bool has_format, const char *format,
1250 bool has_mode, NewImageMode mode, Error **errp)
1252 BlockdevSnapshotSync snapshot = {
1253 .has_device = has_device,
1254 .device = (char *) device,
1255 .has_node_name = has_node_name,
1256 .node_name = (char *) node_name,
1257 .snapshot_file = (char *) snapshot_file,
1258 .has_snapshot_node_name = has_snapshot_node_name,
1259 .snapshot_node_name = (char *) snapshot_node_name,
1260 .has_format = has_format,
1261 .format = (char *) format,
1262 .has_mode = has_mode,
1263 .mode = mode,
1265 TransactionAction action = {
1266 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1267 .u.blockdev_snapshot_sync.data = &snapshot,
1269 blockdev_do_action(&action, errp);
1272 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1273 Error **errp)
1275 BlockdevSnapshot snapshot_data = {
1276 .node = (char *) node,
1277 .overlay = (char *) overlay
1279 TransactionAction action = {
1280 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1281 .u.blockdev_snapshot.data = &snapshot_data,
1283 blockdev_do_action(&action, errp);
1286 void qmp_blockdev_snapshot_internal_sync(const char *device,
1287 const char *name,
1288 Error **errp)
1290 BlockdevSnapshotInternal snapshot = {
1291 .device = (char *) device,
1292 .name = (char *) name
1294 TransactionAction action = {
1295 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1296 .u.blockdev_snapshot_internal_sync.data = &snapshot,
1298 blockdev_do_action(&action, errp);
1301 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1302 bool has_id,
1303 const char *id,
1304 bool has_name,
1305 const char *name,
1306 Error **errp)
1308 BlockDriverState *bs;
1309 AioContext *aio_context;
1310 QEMUSnapshotInfo sn;
1311 Error *local_err = NULL;
1312 SnapshotInfo *info = NULL;
1313 int ret;
1315 bs = qmp_get_root_bs(device, errp);
1316 if (!bs) {
1317 return NULL;
1319 aio_context = bdrv_get_aio_context(bs);
1320 aio_context_acquire(aio_context);
1322 if (!has_id) {
1323 id = NULL;
1326 if (!has_name) {
1327 name = NULL;
1330 if (!id && !name) {
1331 error_setg(errp, "Name or id must be provided");
1332 goto out_aio_context;
1335 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1336 goto out_aio_context;
1339 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1340 if (local_err) {
1341 error_propagate(errp, local_err);
1342 goto out_aio_context;
1344 if (!ret) {
1345 error_setg(errp,
1346 "Snapshot with id '%s' and name '%s' does not exist on "
1347 "device '%s'",
1348 STR_OR_NULL(id), STR_OR_NULL(name), device);
1349 goto out_aio_context;
1352 bdrv_snapshot_delete(bs, id, name, &local_err);
1353 if (local_err) {
1354 error_propagate(errp, local_err);
1355 goto out_aio_context;
1358 aio_context_release(aio_context);
1360 info = g_new0(SnapshotInfo, 1);
1361 info->id = g_strdup(sn.id_str);
1362 info->name = g_strdup(sn.name);
1363 info->date_nsec = sn.date_nsec;
1364 info->date_sec = sn.date_sec;
1365 info->vm_state_size = sn.vm_state_size;
1366 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1367 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1369 return info;
1371 out_aio_context:
1372 aio_context_release(aio_context);
1373 return NULL;
1377 * block_dirty_bitmap_lookup:
1378 * Return a dirty bitmap (if present), after validating
1379 * the node reference and bitmap names.
1381 * @node: The name of the BDS node to search for bitmaps
1382 * @name: The name of the bitmap to search for
1383 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1384 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1385 * @errp: Output pointer for error information. Can be NULL.
1387 * @return: A bitmap object on success, or NULL on failure.
1389 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1390 const char *name,
1391 BlockDriverState **pbs,
1392 AioContext **paio,
1393 Error **errp)
1395 BlockDriverState *bs;
1396 BdrvDirtyBitmap *bitmap;
1397 AioContext *aio_context;
1399 if (!node) {
1400 error_setg(errp, "Node cannot be NULL");
1401 return NULL;
1403 if (!name) {
1404 error_setg(errp, "Bitmap name cannot be NULL");
1405 return NULL;
1407 bs = bdrv_lookup_bs(node, node, NULL);
1408 if (!bs) {
1409 error_setg(errp, "Node '%s' not found", node);
1410 return NULL;
1413 aio_context = bdrv_get_aio_context(bs);
1414 aio_context_acquire(aio_context);
1416 bitmap = bdrv_find_dirty_bitmap(bs, name);
1417 if (!bitmap) {
1418 error_setg(errp, "Dirty bitmap '%s' not found", name);
1419 goto fail;
1422 if (pbs) {
1423 *pbs = bs;
1425 if (paio) {
1426 *paio = aio_context;
1427 } else {
1428 aio_context_release(aio_context);
1431 return bitmap;
1433 fail:
1434 aio_context_release(aio_context);
1435 return NULL;
1438 /* New and old BlockDriverState structs for atomic group operations */
1440 typedef struct BlkActionState BlkActionState;
1443 * BlkActionOps:
1444 * Table of operations that define an Action.
1446 * @instance_size: Size of state struct, in bytes.
1447 * @prepare: Prepare the work, must NOT be NULL.
1448 * @commit: Commit the changes, can be NULL.
1449 * @abort: Abort the changes on fail, can be NULL.
1450 * @clean: Clean up resources after all transaction actions have called
1451 * commit() or abort(). Can be NULL.
1453 * Only prepare() may fail. In a single transaction, only one of commit() or
1454 * abort() will be called. clean() will always be called if it is present.
1456 typedef struct BlkActionOps {
1457 size_t instance_size;
1458 void (*prepare)(BlkActionState *common, Error **errp);
1459 void (*commit)(BlkActionState *common);
1460 void (*abort)(BlkActionState *common);
1461 void (*clean)(BlkActionState *common);
1462 } BlkActionOps;
1465 * BlkActionState:
1466 * Describes one Action's state within a Transaction.
1468 * @action: QAPI-defined enum identifying which Action to perform.
1469 * @ops: Table of ActionOps this Action can perform.
1470 * @block_job_txn: Transaction which this action belongs to.
1471 * @entry: List membership for all Actions in this Transaction.
1473 * This structure must be arranged as first member in a subclassed type,
1474 * assuming that the compiler will also arrange it to the same offsets as the
1475 * base class.
1477 struct BlkActionState {
1478 TransactionAction *action;
1479 const BlkActionOps *ops;
1480 BlockJobTxn *block_job_txn;
1481 TransactionProperties *txn_props;
1482 QSIMPLEQ_ENTRY(BlkActionState) entry;
1485 /* internal snapshot private data */
1486 typedef struct InternalSnapshotState {
1487 BlkActionState common;
1488 BlockDriverState *bs;
1489 AioContext *aio_context;
1490 QEMUSnapshotInfo sn;
1491 bool created;
1492 } InternalSnapshotState;
1495 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1497 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1498 error_setg(errp,
1499 "Action '%s' does not support Transaction property "
1500 "completion-mode = %s",
1501 TransactionActionKind_lookup[s->action->type],
1502 ActionCompletionMode_lookup[s->txn_props->completion_mode]);
1503 return -1;
1505 return 0;
1508 static void internal_snapshot_prepare(BlkActionState *common,
1509 Error **errp)
1511 Error *local_err = NULL;
1512 const char *device;
1513 const char *name;
1514 BlockDriverState *bs;
1515 QEMUSnapshotInfo old_sn, *sn;
1516 bool ret;
1517 qemu_timeval tv;
1518 BlockdevSnapshotInternal *internal;
1519 InternalSnapshotState *state;
1520 int ret1;
1522 g_assert(common->action->type ==
1523 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1524 internal = common->action->u.blockdev_snapshot_internal_sync.data;
1525 state = DO_UPCAST(InternalSnapshotState, common, common);
1527 /* 1. parse input */
1528 device = internal->device;
1529 name = internal->name;
1531 /* 2. check for validation */
1532 if (action_check_completion_mode(common, errp) < 0) {
1533 return;
1536 bs = qmp_get_root_bs(device, errp);
1537 if (!bs) {
1538 return;
1541 /* AioContext is released in .clean() */
1542 state->aio_context = bdrv_get_aio_context(bs);
1543 aio_context_acquire(state->aio_context);
1545 state->bs = bs;
1546 bdrv_drained_begin(bs);
1548 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1549 return;
1552 if (bdrv_is_read_only(bs)) {
1553 error_setg(errp, "Device '%s' is read only", device);
1554 return;
1557 if (!bdrv_can_snapshot(bs)) {
1558 error_setg(errp, "Block format '%s' used by device '%s' "
1559 "does not support internal snapshots",
1560 bs->drv->format_name, device);
1561 return;
1564 if (!strlen(name)) {
1565 error_setg(errp, "Name is empty");
1566 return;
1569 /* check whether a snapshot with name exist */
1570 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1571 &local_err);
1572 if (local_err) {
1573 error_propagate(errp, local_err);
1574 return;
1575 } else if (ret) {
1576 error_setg(errp,
1577 "Snapshot with name '%s' already exists on device '%s'",
1578 name, device);
1579 return;
1582 /* 3. take the snapshot */
1583 sn = &state->sn;
1584 pstrcpy(sn->name, sizeof(sn->name), name);
1585 qemu_gettimeofday(&tv);
1586 sn->date_sec = tv.tv_sec;
1587 sn->date_nsec = tv.tv_usec * 1000;
1588 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1590 ret1 = bdrv_snapshot_create(bs, sn);
1591 if (ret1 < 0) {
1592 error_setg_errno(errp, -ret1,
1593 "Failed to create snapshot '%s' on device '%s'",
1594 name, device);
1595 return;
1598 /* 4. succeed, mark a snapshot is created */
1599 state->created = true;
1602 static void internal_snapshot_abort(BlkActionState *common)
1604 InternalSnapshotState *state =
1605 DO_UPCAST(InternalSnapshotState, common, common);
1606 BlockDriverState *bs = state->bs;
1607 QEMUSnapshotInfo *sn = &state->sn;
1608 Error *local_error = NULL;
1610 if (!state->created) {
1611 return;
1614 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1615 error_reportf_err(local_error,
1616 "Failed to delete snapshot with id '%s' and "
1617 "name '%s' on device '%s' in abort: ",
1618 sn->id_str, sn->name,
1619 bdrv_get_device_name(bs));
1623 static void internal_snapshot_clean(BlkActionState *common)
1625 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1626 common, common);
1628 if (state->aio_context) {
1629 if (state->bs) {
1630 bdrv_drained_end(state->bs);
1632 aio_context_release(state->aio_context);
1636 /* external snapshot private data */
1637 typedef struct ExternalSnapshotState {
1638 BlkActionState common;
1639 BlockDriverState *old_bs;
1640 BlockDriverState *new_bs;
1641 AioContext *aio_context;
1642 } ExternalSnapshotState;
1644 static void external_snapshot_prepare(BlkActionState *common,
1645 Error **errp)
1647 int flags = 0;
1648 QDict *options = NULL;
1649 Error *local_err = NULL;
1650 /* Device and node name of the image to generate the snapshot from */
1651 const char *device;
1652 const char *node_name;
1653 /* Reference to the new image (for 'blockdev-snapshot') */
1654 const char *snapshot_ref;
1655 /* File name of the new image (for 'blockdev-snapshot-sync') */
1656 const char *new_image_file;
1657 ExternalSnapshotState *state =
1658 DO_UPCAST(ExternalSnapshotState, common, common);
1659 TransactionAction *action = common->action;
1661 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1662 * purpose but a different set of parameters */
1663 switch (action->type) {
1664 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1666 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1667 device = s->node;
1668 node_name = s->node;
1669 new_image_file = NULL;
1670 snapshot_ref = s->overlay;
1672 break;
1673 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1675 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1676 device = s->has_device ? s->device : NULL;
1677 node_name = s->has_node_name ? s->node_name : NULL;
1678 new_image_file = s->snapshot_file;
1679 snapshot_ref = NULL;
1681 break;
1682 default:
1683 g_assert_not_reached();
1686 /* start processing */
1687 if (action_check_completion_mode(common, errp) < 0) {
1688 return;
1691 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1692 if (!state->old_bs) {
1693 return;
1696 /* Acquire AioContext now so any threads operating on old_bs stop */
1697 state->aio_context = bdrv_get_aio_context(state->old_bs);
1698 aio_context_acquire(state->aio_context);
1699 bdrv_drained_begin(state->old_bs);
1701 if (!bdrv_is_inserted(state->old_bs)) {
1702 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1703 return;
1706 if (bdrv_op_is_blocked(state->old_bs,
1707 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1708 return;
1711 if (!bdrv_is_read_only(state->old_bs)) {
1712 if (bdrv_flush(state->old_bs)) {
1713 error_setg(errp, QERR_IO_ERROR);
1714 return;
1718 if (!bdrv_is_first_non_filter(state->old_bs)) {
1719 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1720 return;
1723 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1724 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1725 const char *format = s->has_format ? s->format : "qcow2";
1726 enum NewImageMode mode;
1727 const char *snapshot_node_name =
1728 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1730 if (node_name && !snapshot_node_name) {
1731 error_setg(errp, "New snapshot node name missing");
1732 return;
1735 if (snapshot_node_name &&
1736 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1737 error_setg(errp, "New snapshot node name already in use");
1738 return;
1741 flags = state->old_bs->open_flags;
1742 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1744 /* create new image w/backing file */
1745 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1746 if (mode != NEW_IMAGE_MODE_EXISTING) {
1747 int64_t size = bdrv_getlength(state->old_bs);
1748 if (size < 0) {
1749 error_setg_errno(errp, -size, "bdrv_getlength failed");
1750 return;
1752 bdrv_img_create(new_image_file, format,
1753 state->old_bs->filename,
1754 state->old_bs->drv->format_name,
1755 NULL, size, flags, &local_err, false);
1756 if (local_err) {
1757 error_propagate(errp, local_err);
1758 return;
1762 options = qdict_new();
1763 if (s->has_snapshot_node_name) {
1764 qdict_put(options, "node-name",
1765 qstring_from_str(snapshot_node_name));
1767 qdict_put(options, "driver", qstring_from_str(format));
1769 flags |= BDRV_O_NO_BACKING;
1772 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1773 errp);
1774 /* We will manually add the backing_hd field to the bs later */
1775 if (!state->new_bs) {
1776 return;
1779 if (bdrv_has_blk(state->new_bs)) {
1780 error_setg(errp, "The snapshot is already in use by %s",
1781 bdrv_get_parent_name(state->new_bs));
1782 return;
1785 if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
1786 errp)) {
1787 return;
1790 if (state->new_bs->backing != NULL) {
1791 error_setg(errp, "The snapshot already has a backing image");
1792 return;
1795 if (!state->new_bs->drv->supports_backing) {
1796 error_setg(errp, "The snapshot does not support backing images");
1800 static void external_snapshot_commit(BlkActionState *common)
1802 ExternalSnapshotState *state =
1803 DO_UPCAST(ExternalSnapshotState, common, common);
1805 bdrv_set_aio_context(state->new_bs, state->aio_context);
1807 /* This removes our old bs and adds the new bs */
1808 bdrv_append(state->new_bs, state->old_bs);
1809 /* We don't need (or want) to use the transactional
1810 * bdrv_reopen_multiple() across all the entries at once, because we
1811 * don't want to abort all of them if one of them fails the reopen */
1812 if (!state->old_bs->copy_on_read) {
1813 bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1814 NULL);
1818 static void external_snapshot_abort(BlkActionState *common)
1820 ExternalSnapshotState *state =
1821 DO_UPCAST(ExternalSnapshotState, common, common);
1822 if (state->new_bs) {
1823 bdrv_unref(state->new_bs);
1827 static void external_snapshot_clean(BlkActionState *common)
1829 ExternalSnapshotState *state =
1830 DO_UPCAST(ExternalSnapshotState, common, common);
1831 if (state->aio_context) {
1832 bdrv_drained_end(state->old_bs);
1833 aio_context_release(state->aio_context);
1837 typedef struct DriveBackupState {
1838 BlkActionState common;
1839 BlockDriverState *bs;
1840 AioContext *aio_context;
1841 BlockJob *job;
1842 } DriveBackupState;
1844 static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn,
1845 Error **errp);
1847 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1849 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1850 BlockDriverState *bs;
1851 DriveBackup *backup;
1852 Error *local_err = NULL;
1854 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1855 backup = common->action->u.drive_backup.data;
1857 bs = qmp_get_root_bs(backup->device, errp);
1858 if (!bs) {
1859 return;
1862 /* AioContext is released in .clean() */
1863 state->aio_context = bdrv_get_aio_context(bs);
1864 aio_context_acquire(state->aio_context);
1865 bdrv_drained_begin(bs);
1866 state->bs = bs;
1868 do_drive_backup(backup, common->block_job_txn, &local_err);
1869 if (local_err) {
1870 error_propagate(errp, local_err);
1871 return;
1874 state->job = state->bs->job;
1877 static void drive_backup_abort(BlkActionState *common)
1879 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1880 BlockDriverState *bs = state->bs;
1882 /* Only cancel if it's the job we started */
1883 if (bs && bs->job && bs->job == state->job) {
1884 block_job_cancel_sync(bs->job);
1888 static void drive_backup_clean(BlkActionState *common)
1890 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1892 if (state->aio_context) {
1893 bdrv_drained_end(state->bs);
1894 aio_context_release(state->aio_context);
1898 typedef struct BlockdevBackupState {
1899 BlkActionState common;
1900 BlockDriverState *bs;
1901 BlockJob *job;
1902 AioContext *aio_context;
1903 } BlockdevBackupState;
1905 static void do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn,
1906 Error **errp);
1908 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1910 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1911 BlockdevBackup *backup;
1912 BlockDriverState *bs, *target;
1913 Error *local_err = NULL;
1915 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1916 backup = common->action->u.blockdev_backup.data;
1918 bs = qmp_get_root_bs(backup->device, errp);
1919 if (!bs) {
1920 return;
1923 target = bdrv_lookup_bs(backup->target, backup->target, errp);
1924 if (!target) {
1925 return;
1928 /* AioContext is released in .clean() */
1929 state->aio_context = bdrv_get_aio_context(bs);
1930 if (state->aio_context != bdrv_get_aio_context(target)) {
1931 state->aio_context = NULL;
1932 error_setg(errp, "Backup between two IO threads is not implemented");
1933 return;
1935 aio_context_acquire(state->aio_context);
1936 state->bs = bs;
1937 bdrv_drained_begin(state->bs);
1939 do_blockdev_backup(backup, common->block_job_txn, &local_err);
1940 if (local_err) {
1941 error_propagate(errp, local_err);
1942 return;
1945 state->job = state->bs->job;
1948 static void blockdev_backup_abort(BlkActionState *common)
1950 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1951 BlockDriverState *bs = state->bs;
1953 /* Only cancel if it's the job we started */
1954 if (bs && bs->job && bs->job == state->job) {
1955 block_job_cancel_sync(bs->job);
1959 static void blockdev_backup_clean(BlkActionState *common)
1961 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1963 if (state->aio_context) {
1964 bdrv_drained_end(state->bs);
1965 aio_context_release(state->aio_context);
1969 typedef struct BlockDirtyBitmapState {
1970 BlkActionState common;
1971 BdrvDirtyBitmap *bitmap;
1972 BlockDriverState *bs;
1973 AioContext *aio_context;
1974 HBitmap *backup;
1975 bool prepared;
1976 } BlockDirtyBitmapState;
1978 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
1979 Error **errp)
1981 Error *local_err = NULL;
1982 BlockDirtyBitmapAdd *action;
1983 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1984 common, common);
1986 if (action_check_completion_mode(common, errp) < 0) {
1987 return;
1990 action = common->action->u.block_dirty_bitmap_add.data;
1991 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1992 qmp_block_dirty_bitmap_add(action->node, action->name,
1993 action->has_granularity, action->granularity,
1994 &local_err);
1996 if (!local_err) {
1997 state->prepared = true;
1998 } else {
1999 error_propagate(errp, local_err);
2003 static void block_dirty_bitmap_add_abort(BlkActionState *common)
2005 BlockDirtyBitmapAdd *action;
2006 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2007 common, common);
2009 action = common->action->u.block_dirty_bitmap_add.data;
2010 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2011 * then the node reference and bitmap name must have been valid.
2013 if (state->prepared) {
2014 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2018 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
2019 Error **errp)
2021 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2022 common, common);
2023 BlockDirtyBitmap *action;
2025 if (action_check_completion_mode(common, errp) < 0) {
2026 return;
2029 action = common->action->u.block_dirty_bitmap_clear.data;
2030 state->bitmap = block_dirty_bitmap_lookup(action->node,
2031 action->name,
2032 &state->bs,
2033 &state->aio_context,
2034 errp);
2035 if (!state->bitmap) {
2036 return;
2039 if (bdrv_dirty_bitmap_frozen(state->bitmap)) {
2040 error_setg(errp, "Cannot modify a frozen bitmap");
2041 return;
2042 } else if (!bdrv_dirty_bitmap_enabled(state->bitmap)) {
2043 error_setg(errp, "Cannot clear a disabled bitmap");
2044 return;
2047 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2048 /* AioContext is released in .clean() */
2051 static void block_dirty_bitmap_clear_abort(BlkActionState *common)
2053 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2054 common, common);
2056 bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
2059 static void block_dirty_bitmap_clear_commit(BlkActionState *common)
2061 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2062 common, common);
2064 hbitmap_free(state->backup);
2067 static void block_dirty_bitmap_clear_clean(BlkActionState *common)
2069 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2070 common, common);
2072 if (state->aio_context) {
2073 aio_context_release(state->aio_context);
2077 static void abort_prepare(BlkActionState *common, Error **errp)
2079 error_setg(errp, "Transaction aborted using Abort action");
2082 static void abort_commit(BlkActionState *common)
2084 g_assert_not_reached(); /* this action never succeeds */
2087 static const BlkActionOps actions[] = {
2088 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2089 .instance_size = sizeof(ExternalSnapshotState),
2090 .prepare = external_snapshot_prepare,
2091 .commit = external_snapshot_commit,
2092 .abort = external_snapshot_abort,
2093 .clean = external_snapshot_clean,
2095 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2096 .instance_size = sizeof(ExternalSnapshotState),
2097 .prepare = external_snapshot_prepare,
2098 .commit = external_snapshot_commit,
2099 .abort = external_snapshot_abort,
2100 .clean = external_snapshot_clean,
2102 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2103 .instance_size = sizeof(DriveBackupState),
2104 .prepare = drive_backup_prepare,
2105 .abort = drive_backup_abort,
2106 .clean = drive_backup_clean,
2108 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2109 .instance_size = sizeof(BlockdevBackupState),
2110 .prepare = blockdev_backup_prepare,
2111 .abort = blockdev_backup_abort,
2112 .clean = blockdev_backup_clean,
2114 [TRANSACTION_ACTION_KIND_ABORT] = {
2115 .instance_size = sizeof(BlkActionState),
2116 .prepare = abort_prepare,
2117 .commit = abort_commit,
2119 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2120 .instance_size = sizeof(InternalSnapshotState),
2121 .prepare = internal_snapshot_prepare,
2122 .abort = internal_snapshot_abort,
2123 .clean = internal_snapshot_clean,
2125 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2126 .instance_size = sizeof(BlockDirtyBitmapState),
2127 .prepare = block_dirty_bitmap_add_prepare,
2128 .abort = block_dirty_bitmap_add_abort,
2130 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2131 .instance_size = sizeof(BlockDirtyBitmapState),
2132 .prepare = block_dirty_bitmap_clear_prepare,
2133 .commit = block_dirty_bitmap_clear_commit,
2134 .abort = block_dirty_bitmap_clear_abort,
2135 .clean = block_dirty_bitmap_clear_clean,
2140 * Allocate a TransactionProperties structure if necessary, and fill
2141 * that structure with desired defaults if they are unset.
2143 static TransactionProperties *get_transaction_properties(
2144 TransactionProperties *props)
2146 if (!props) {
2147 props = g_new0(TransactionProperties, 1);
2150 if (!props->has_completion_mode) {
2151 props->has_completion_mode = true;
2152 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2155 return props;
2159 * 'Atomic' group operations. The operations are performed as a set, and if
2160 * any fail then we roll back all operations in the group.
2162 void qmp_transaction(TransactionActionList *dev_list,
2163 bool has_props,
2164 struct TransactionProperties *props,
2165 Error **errp)
2167 TransactionActionList *dev_entry = dev_list;
2168 BlockJobTxn *block_job_txn = NULL;
2169 BlkActionState *state, *next;
2170 Error *local_err = NULL;
2172 QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2173 QSIMPLEQ_INIT(&snap_bdrv_states);
2175 /* Does this transaction get canceled as a group on failure?
2176 * If not, we don't really need to make a BlockJobTxn.
2178 props = get_transaction_properties(props);
2179 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2180 block_job_txn = block_job_txn_new();
2183 /* drain all i/o before any operations */
2184 bdrv_drain_all();
2186 /* We don't do anything in this loop that commits us to the operations */
2187 while (NULL != dev_entry) {
2188 TransactionAction *dev_info = NULL;
2189 const BlkActionOps *ops;
2191 dev_info = dev_entry->value;
2192 dev_entry = dev_entry->next;
2194 assert(dev_info->type < ARRAY_SIZE(actions));
2196 ops = &actions[dev_info->type];
2197 assert(ops->instance_size > 0);
2199 state = g_malloc0(ops->instance_size);
2200 state->ops = ops;
2201 state->action = dev_info;
2202 state->block_job_txn = block_job_txn;
2203 state->txn_props = props;
2204 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2206 state->ops->prepare(state, &local_err);
2207 if (local_err) {
2208 error_propagate(errp, local_err);
2209 goto delete_and_fail;
2213 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2214 if (state->ops->commit) {
2215 state->ops->commit(state);
2219 /* success */
2220 goto exit;
2222 delete_and_fail:
2223 /* failure, and it is all-or-none; roll back all operations */
2224 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2225 if (state->ops->abort) {
2226 state->ops->abort(state);
2229 exit:
2230 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2231 if (state->ops->clean) {
2232 state->ops->clean(state);
2234 g_free(state);
2236 if (!has_props) {
2237 qapi_free_TransactionProperties(props);
2239 block_job_txn_unref(block_job_txn);
2242 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2244 Error *local_err = NULL;
2245 int rc;
2247 if (!has_force) {
2248 force = false;
2251 rc = do_open_tray(device, force, &local_err);
2252 if (rc && rc != -ENOSYS) {
2253 error_propagate(errp, local_err);
2254 return;
2256 error_free(local_err);
2258 qmp_x_blockdev_remove_medium(device, errp);
2261 void qmp_block_passwd(bool has_device, const char *device,
2262 bool has_node_name, const char *node_name,
2263 const char *password, Error **errp)
2265 Error *local_err = NULL;
2266 BlockDriverState *bs;
2267 AioContext *aio_context;
2269 bs = bdrv_lookup_bs(has_device ? device : NULL,
2270 has_node_name ? node_name : NULL,
2271 &local_err);
2272 if (local_err) {
2273 error_propagate(errp, local_err);
2274 return;
2277 aio_context = bdrv_get_aio_context(bs);
2278 aio_context_acquire(aio_context);
2280 bdrv_add_key(bs, password, errp);
2282 aio_context_release(aio_context);
2286 * Attempt to open the tray of @device.
2287 * If @force, ignore its tray lock.
2288 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2289 * On error, store an error through @errp and return -errno.
2290 * If @device does not exist, return -ENODEV.
2291 * If it has no removable media, return -ENOTSUP.
2292 * If it has no tray, return -ENOSYS.
2293 * If the guest was asked to open the tray, return -EINPROGRESS.
2294 * Else, return 0.
2296 static int do_open_tray(const char *device, bool force, Error **errp)
2298 BlockBackend *blk;
2299 bool locked;
2301 blk = blk_by_name(device);
2302 if (!blk) {
2303 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2304 "Device '%s' not found", device);
2305 return -ENODEV;
2308 if (!blk_dev_has_removable_media(blk)) {
2309 error_setg(errp, "Device '%s' is not removable", device);
2310 return -ENOTSUP;
2313 if (!blk_dev_has_tray(blk)) {
2314 error_setg(errp, "Device '%s' does not have a tray", device);
2315 return -ENOSYS;
2318 if (blk_dev_is_tray_open(blk)) {
2319 return 0;
2322 locked = blk_dev_is_medium_locked(blk);
2323 if (locked) {
2324 blk_dev_eject_request(blk, force);
2327 if (!locked || force) {
2328 blk_dev_change_media_cb(blk, false);
2331 if (locked && !force) {
2332 error_setg(errp, "Device '%s' is locked and force was not specified, "
2333 "wait for tray to open and try again", device);
2334 return -EINPROGRESS;
2337 return 0;
2340 void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
2341 Error **errp)
2343 Error *local_err = NULL;
2344 int rc;
2346 if (!has_force) {
2347 force = false;
2349 rc = do_open_tray(device, force, &local_err);
2350 if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2351 error_propagate(errp, local_err);
2352 return;
2354 error_free(local_err);
2357 void qmp_blockdev_close_tray(const char *device, Error **errp)
2359 BlockBackend *blk;
2361 blk = blk_by_name(device);
2362 if (!blk) {
2363 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2364 "Device '%s' not found", device);
2365 return;
2368 if (!blk_dev_has_removable_media(blk)) {
2369 error_setg(errp, "Device '%s' is not removable", device);
2370 return;
2373 if (!blk_dev_has_tray(blk)) {
2374 /* Ignore this command on tray-less devices */
2375 return;
2378 if (!blk_dev_is_tray_open(blk)) {
2379 return;
2382 blk_dev_change_media_cb(blk, true);
2385 void qmp_x_blockdev_remove_medium(const char *device, Error **errp)
2387 BlockBackend *blk;
2388 BlockDriverState *bs;
2389 AioContext *aio_context;
2390 bool has_device;
2392 blk = blk_by_name(device);
2393 if (!blk) {
2394 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2395 "Device '%s' not found", device);
2396 return;
2399 /* For BBs without a device, we can exchange the BDS tree at will */
2400 has_device = blk_get_attached_dev(blk);
2402 if (has_device && !blk_dev_has_removable_media(blk)) {
2403 error_setg(errp, "Device '%s' is not removable", device);
2404 return;
2407 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2408 error_setg(errp, "Tray of device '%s' is not open", device);
2409 return;
2412 bs = blk_bs(blk);
2413 if (!bs) {
2414 return;
2417 aio_context = bdrv_get_aio_context(bs);
2418 aio_context_acquire(aio_context);
2420 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2421 goto out;
2424 blk_remove_bs(blk);
2426 if (!blk_dev_has_tray(blk)) {
2427 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2428 * called at all); therefore, the medium needs to be ejected here.
2429 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2430 * value passed here (i.e. false). */
2431 blk_dev_change_media_cb(blk, false);
2434 out:
2435 aio_context_release(aio_context);
2438 static void qmp_blockdev_insert_anon_medium(const char *device,
2439 BlockDriverState *bs, Error **errp)
2441 BlockBackend *blk;
2442 bool has_device;
2444 blk = blk_by_name(device);
2445 if (!blk) {
2446 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2447 "Device '%s' not found", device);
2448 return;
2451 /* For BBs without a device, we can exchange the BDS tree at will */
2452 has_device = blk_get_attached_dev(blk);
2454 if (has_device && !blk_dev_has_removable_media(blk)) {
2455 error_setg(errp, "Device '%s' is not removable", device);
2456 return;
2459 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2460 error_setg(errp, "Tray of device '%s' is not open", device);
2461 return;
2464 if (blk_bs(blk)) {
2465 error_setg(errp, "There already is a medium in device '%s'", device);
2466 return;
2469 blk_insert_bs(blk, bs);
2471 if (!blk_dev_has_tray(blk)) {
2472 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2473 * called at all); therefore, the medium needs to be pushed into the
2474 * slot here.
2475 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2476 * value passed here (i.e. true). */
2477 blk_dev_change_media_cb(blk, true);
2481 void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
2482 Error **errp)
2484 BlockDriverState *bs;
2486 bs = bdrv_find_node(node_name);
2487 if (!bs) {
2488 error_setg(errp, "Node '%s' not found", node_name);
2489 return;
2492 if (bdrv_has_blk(bs)) {
2493 error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
2494 bdrv_get_parent_name(bs));
2495 return;
2498 qmp_blockdev_insert_anon_medium(device, bs, errp);
2501 void qmp_blockdev_change_medium(const char *device, const char *filename,
2502 bool has_format, const char *format,
2503 bool has_read_only,
2504 BlockdevChangeReadOnlyMode read_only,
2505 Error **errp)
2507 BlockBackend *blk;
2508 BlockDriverState *medium_bs = NULL;
2509 int bdrv_flags;
2510 int rc;
2511 QDict *options = NULL;
2512 Error *err = NULL;
2514 blk = blk_by_name(device);
2515 if (!blk) {
2516 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2517 "Device '%s' not found", device);
2518 goto fail;
2521 if (blk_bs(blk)) {
2522 blk_update_root_state(blk);
2525 bdrv_flags = blk_get_open_flags_from_root_state(blk);
2526 bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2527 BDRV_O_PROTOCOL);
2529 if (!has_read_only) {
2530 read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2533 switch (read_only) {
2534 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2535 break;
2537 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2538 bdrv_flags &= ~BDRV_O_RDWR;
2539 break;
2541 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2542 bdrv_flags |= BDRV_O_RDWR;
2543 break;
2545 default:
2546 abort();
2549 if (has_format) {
2550 options = qdict_new();
2551 qdict_put(options, "driver", qstring_from_str(format));
2554 medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2555 if (!medium_bs) {
2556 goto fail;
2559 bdrv_add_key(medium_bs, NULL, &err);
2560 if (err) {
2561 error_propagate(errp, err);
2562 goto fail;
2565 rc = do_open_tray(device, false, &err);
2566 if (rc && rc != -ENOSYS) {
2567 error_propagate(errp, err);
2568 goto fail;
2570 error_free(err);
2571 err = NULL;
2573 qmp_x_blockdev_remove_medium(device, &err);
2574 if (err) {
2575 error_propagate(errp, err);
2576 goto fail;
2579 qmp_blockdev_insert_anon_medium(device, medium_bs, &err);
2580 if (err) {
2581 error_propagate(errp, err);
2582 goto fail;
2585 blk_apply_root_state(blk, medium_bs);
2587 qmp_blockdev_close_tray(device, errp);
2589 fail:
2590 /* If the medium has been inserted, the device has its own reference, so
2591 * ours must be relinquished; and if it has not been inserted successfully,
2592 * the reference must be relinquished anyway */
2593 bdrv_unref(medium_bs);
2596 /* throttling disk I/O limits */
2597 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2599 ThrottleConfig cfg;
2600 BlockDriverState *bs;
2601 BlockBackend *blk;
2602 AioContext *aio_context;
2604 blk = blk_by_name(arg->device);
2605 if (!blk) {
2606 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2607 "Device '%s' not found", arg->device);
2608 return;
2611 aio_context = blk_get_aio_context(blk);
2612 aio_context_acquire(aio_context);
2614 bs = blk_bs(blk);
2615 if (!bs) {
2616 error_setg(errp, "Device '%s' has no medium", arg->device);
2617 goto out;
2620 throttle_config_init(&cfg);
2621 cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2622 cfg.buckets[THROTTLE_BPS_READ].avg = arg->bps_rd;
2623 cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2625 cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2626 cfg.buckets[THROTTLE_OPS_READ].avg = arg->iops_rd;
2627 cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2629 if (arg->has_bps_max) {
2630 cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2632 if (arg->has_bps_rd_max) {
2633 cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2635 if (arg->has_bps_wr_max) {
2636 cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2638 if (arg->has_iops_max) {
2639 cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2641 if (arg->has_iops_rd_max) {
2642 cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2644 if (arg->has_iops_wr_max) {
2645 cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2648 if (arg->has_bps_max_length) {
2649 cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2651 if (arg->has_bps_rd_max_length) {
2652 cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2654 if (arg->has_bps_wr_max_length) {
2655 cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2657 if (arg->has_iops_max_length) {
2658 cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2660 if (arg->has_iops_rd_max_length) {
2661 cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2663 if (arg->has_iops_wr_max_length) {
2664 cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2667 if (arg->has_iops_size) {
2668 cfg.op_size = arg->iops_size;
2671 if (!throttle_is_valid(&cfg, errp)) {
2672 goto out;
2675 if (throttle_enabled(&cfg)) {
2676 /* Enable I/O limits if they're not enabled yet, otherwise
2677 * just update the throttling group. */
2678 if (!blk_get_public(blk)->throttle_state) {
2679 blk_io_limits_enable(blk,
2680 arg->has_group ? arg->group : arg->device);
2681 } else if (arg->has_group) {
2682 blk_io_limits_update_group(blk, arg->group);
2684 /* Set the new throttling configuration */
2685 blk_set_io_limits(blk, &cfg);
2686 } else if (blk_get_public(blk)->throttle_state) {
2687 /* If all throttling settings are set to 0, disable I/O limits */
2688 blk_io_limits_disable(blk);
2691 out:
2692 aio_context_release(aio_context);
2695 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2696 bool has_granularity, uint32_t granularity,
2697 Error **errp)
2699 AioContext *aio_context;
2700 BlockDriverState *bs;
2702 if (!name || name[0] == '\0') {
2703 error_setg(errp, "Bitmap name cannot be empty");
2704 return;
2707 bs = bdrv_lookup_bs(node, node, errp);
2708 if (!bs) {
2709 return;
2712 aio_context = bdrv_get_aio_context(bs);
2713 aio_context_acquire(aio_context);
2715 if (has_granularity) {
2716 if (granularity < 512 || !is_power_of_2(granularity)) {
2717 error_setg(errp, "Granularity must be power of 2 "
2718 "and at least 512");
2719 goto out;
2721 } else {
2722 /* Default to cluster size, if available: */
2723 granularity = bdrv_get_default_bitmap_granularity(bs);
2726 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2728 out:
2729 aio_context_release(aio_context);
2732 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2733 Error **errp)
2735 AioContext *aio_context;
2736 BlockDriverState *bs;
2737 BdrvDirtyBitmap *bitmap;
2739 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2740 if (!bitmap || !bs) {
2741 return;
2744 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2745 error_setg(errp,
2746 "Bitmap '%s' is currently frozen and cannot be removed",
2747 name);
2748 goto out;
2750 bdrv_dirty_bitmap_make_anon(bitmap);
2751 bdrv_release_dirty_bitmap(bs, bitmap);
2753 out:
2754 aio_context_release(aio_context);
2758 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2759 * immediately after a full backup operation.
2761 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2762 Error **errp)
2764 AioContext *aio_context;
2765 BdrvDirtyBitmap *bitmap;
2766 BlockDriverState *bs;
2768 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2769 if (!bitmap || !bs) {
2770 return;
2773 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2774 error_setg(errp,
2775 "Bitmap '%s' is currently frozen and cannot be modified",
2776 name);
2777 goto out;
2778 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2779 error_setg(errp,
2780 "Bitmap '%s' is currently disabled and cannot be cleared",
2781 name);
2782 goto out;
2785 bdrv_clear_dirty_bitmap(bitmap, NULL);
2787 out:
2788 aio_context_release(aio_context);
2791 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2793 const char *id = qdict_get_str(qdict, "id");
2794 BlockBackend *blk;
2795 BlockDriverState *bs;
2796 AioContext *aio_context;
2797 Error *local_err = NULL;
2799 bs = bdrv_find_node(id);
2800 if (bs) {
2801 qmp_x_blockdev_del(false, NULL, true, id, &local_err);
2802 if (local_err) {
2803 error_report_err(local_err);
2805 return;
2808 blk = blk_by_name(id);
2809 if (!blk) {
2810 error_report("Device '%s' not found", id);
2811 return;
2814 if (!blk_legacy_dinfo(blk)) {
2815 error_report("Deleting device added with blockdev-add"
2816 " is not supported");
2817 return;
2820 aio_context = blk_get_aio_context(blk);
2821 aio_context_acquire(aio_context);
2823 bs = blk_bs(blk);
2824 if (bs) {
2825 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2826 error_report_err(local_err);
2827 aio_context_release(aio_context);
2828 return;
2831 blk_remove_bs(blk);
2834 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2835 monitor_remove_blk(blk);
2837 /* If this BlockBackend has a device attached to it, its refcount will be
2838 * decremented when the device is removed; otherwise we have to do so here.
2840 if (blk_get_attached_dev(blk)) {
2841 /* Further I/O must not pause the guest */
2842 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2843 BLOCKDEV_ON_ERROR_REPORT);
2844 } else {
2845 blk_unref(blk);
2848 aio_context_release(aio_context);
2851 void qmp_block_resize(bool has_device, const char *device,
2852 bool has_node_name, const char *node_name,
2853 int64_t size, Error **errp)
2855 Error *local_err = NULL;
2856 BlockDriverState *bs;
2857 AioContext *aio_context;
2858 int ret;
2860 bs = bdrv_lookup_bs(has_device ? device : NULL,
2861 has_node_name ? node_name : NULL,
2862 &local_err);
2863 if (local_err) {
2864 error_propagate(errp, local_err);
2865 return;
2868 aio_context = bdrv_get_aio_context(bs);
2869 aio_context_acquire(aio_context);
2871 if (!bdrv_is_first_non_filter(bs)) {
2872 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2873 goto out;
2876 if (size < 0) {
2877 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2878 goto out;
2881 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2882 error_setg(errp, QERR_DEVICE_IN_USE, device);
2883 goto out;
2886 /* complete all in-flight operations before resizing the device */
2887 bdrv_drain_all();
2889 ret = bdrv_truncate(bs, size);
2890 switch (ret) {
2891 case 0:
2892 break;
2893 case -ENOMEDIUM:
2894 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2895 break;
2896 case -ENOTSUP:
2897 error_setg(errp, QERR_UNSUPPORTED);
2898 break;
2899 case -EACCES:
2900 error_setg(errp, "Device '%s' is read only", device);
2901 break;
2902 case -EBUSY:
2903 error_setg(errp, QERR_DEVICE_IN_USE, device);
2904 break;
2905 default:
2906 error_setg_errno(errp, -ret, "Could not resize");
2907 break;
2910 out:
2911 aio_context_release(aio_context);
2914 static void block_job_cb(void *opaque, int ret)
2916 /* Note that this function may be executed from another AioContext besides
2917 * the QEMU main loop. If you need to access anything that assumes the
2918 * QEMU global mutex, use a BH or introduce a mutex.
2921 BlockDriverState *bs = opaque;
2922 const char *msg = NULL;
2924 trace_block_job_cb(bs, bs->job, ret);
2926 assert(bs->job);
2928 if (ret < 0) {
2929 msg = strerror(-ret);
2932 if (block_job_is_cancelled(bs->job)) {
2933 block_job_event_cancelled(bs->job);
2934 } else {
2935 block_job_event_completed(bs->job, msg);
2939 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
2940 bool has_base, const char *base,
2941 bool has_backing_file, const char *backing_file,
2942 bool has_speed, int64_t speed,
2943 bool has_on_error, BlockdevOnError on_error,
2944 Error **errp)
2946 BlockDriverState *bs;
2947 BlockDriverState *base_bs = NULL;
2948 AioContext *aio_context;
2949 Error *local_err = NULL;
2950 const char *base_name = NULL;
2952 if (!has_on_error) {
2953 on_error = BLOCKDEV_ON_ERROR_REPORT;
2956 bs = qmp_get_root_bs(device, errp);
2957 if (!bs) {
2958 return;
2961 aio_context = bdrv_get_aio_context(bs);
2962 aio_context_acquire(aio_context);
2964 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2965 goto out;
2968 if (has_base) {
2969 base_bs = bdrv_find_backing_image(bs, base);
2970 if (base_bs == NULL) {
2971 error_setg(errp, QERR_BASE_NOT_FOUND, base);
2972 goto out;
2974 assert(bdrv_get_aio_context(base_bs) == aio_context);
2975 base_name = base;
2978 /* if we are streaming the entire chain, the result will have no backing
2979 * file, and specifying one is therefore an error */
2980 if (base_bs == NULL && has_backing_file) {
2981 error_setg(errp, "backing file specified, but streaming the "
2982 "entire chain");
2983 goto out;
2986 /* backing_file string overrides base bs filename */
2987 base_name = has_backing_file ? backing_file : base_name;
2989 stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
2990 has_speed ? speed : 0, on_error, block_job_cb, bs, &local_err);
2991 if (local_err) {
2992 error_propagate(errp, local_err);
2993 goto out;
2996 trace_qmp_block_stream(bs, bs->job);
2998 out:
2999 aio_context_release(aio_context);
3002 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3003 bool has_base, const char *base,
3004 bool has_top, const char *top,
3005 bool has_backing_file, const char *backing_file,
3006 bool has_speed, int64_t speed,
3007 Error **errp)
3009 BlockDriverState *bs;
3010 BlockDriverState *base_bs, *top_bs;
3011 AioContext *aio_context;
3012 Error *local_err = NULL;
3013 /* This will be part of the QMP command, if/when the
3014 * BlockdevOnError change for blkmirror makes it in
3016 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3018 if (!has_speed) {
3019 speed = 0;
3022 /* Important Note:
3023 * libvirt relies on the DeviceNotFound error class in order to probe for
3024 * live commit feature versions; for this to work, we must make sure to
3025 * perform the device lookup before any generic errors that may occur in a
3026 * scenario in which all optional arguments are omitted. */
3027 bs = qmp_get_root_bs(device, &local_err);
3028 if (!bs) {
3029 bs = bdrv_lookup_bs(device, device, NULL);
3030 if (!bs) {
3031 error_free(local_err);
3032 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3033 "Device '%s' not found", device);
3034 } else {
3035 error_propagate(errp, local_err);
3037 return;
3040 aio_context = bdrv_get_aio_context(bs);
3041 aio_context_acquire(aio_context);
3043 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3044 goto out;
3047 /* default top_bs is the active layer */
3048 top_bs = bs;
3050 if (has_top && top) {
3051 if (strcmp(bs->filename, top) != 0) {
3052 top_bs = bdrv_find_backing_image(bs, top);
3056 if (top_bs == NULL) {
3057 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3058 goto out;
3061 assert(bdrv_get_aio_context(top_bs) == aio_context);
3063 if (has_base && base) {
3064 base_bs = bdrv_find_backing_image(top_bs, base);
3065 } else {
3066 base_bs = bdrv_find_base(top_bs);
3069 if (base_bs == NULL) {
3070 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3071 goto out;
3074 assert(bdrv_get_aio_context(base_bs) == aio_context);
3076 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3077 goto out;
3080 /* Do not allow attempts to commit an image into itself */
3081 if (top_bs == base_bs) {
3082 error_setg(errp, "cannot commit an image into itself");
3083 goto out;
3086 if (top_bs == bs) {
3087 if (has_backing_file) {
3088 error_setg(errp, "'backing-file' specified,"
3089 " but 'top' is the active layer");
3090 goto out;
3092 commit_active_start(has_job_id ? job_id : NULL, bs, base_bs, speed,
3093 on_error, block_job_cb, bs, &local_err);
3094 } else {
3095 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, speed,
3096 on_error, block_job_cb, bs,
3097 has_backing_file ? backing_file : NULL, &local_err);
3099 if (local_err != NULL) {
3100 error_propagate(errp, local_err);
3101 goto out;
3104 out:
3105 aio_context_release(aio_context);
3108 static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn, Error **errp)
3110 BlockDriverState *bs;
3111 BlockDriverState *target_bs;
3112 BlockDriverState *source = NULL;
3113 BdrvDirtyBitmap *bmap = NULL;
3114 AioContext *aio_context;
3115 QDict *options = NULL;
3116 Error *local_err = NULL;
3117 int flags;
3118 int64_t size;
3120 if (!backup->has_speed) {
3121 backup->speed = 0;
3123 if (!backup->has_on_source_error) {
3124 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3126 if (!backup->has_on_target_error) {
3127 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3129 if (!backup->has_mode) {
3130 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3132 if (!backup->has_job_id) {
3133 backup->job_id = NULL;
3135 if (!backup->has_compress) {
3136 backup->compress = false;
3139 bs = qmp_get_root_bs(backup->device, errp);
3140 if (!bs) {
3141 return;
3144 aio_context = bdrv_get_aio_context(bs);
3145 aio_context_acquire(aio_context);
3147 if (!backup->has_format) {
3148 backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
3149 NULL : (char*) bs->drv->format_name;
3152 /* Early check to avoid creating target */
3153 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3154 goto out;
3157 flags = bs->open_flags | BDRV_O_RDWR;
3159 /* See if we have a backing HD we can use to create our new image
3160 * on top of. */
3161 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3162 source = backing_bs(bs);
3163 if (!source) {
3164 backup->sync = MIRROR_SYNC_MODE_FULL;
3167 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3168 source = bs;
3171 size = bdrv_getlength(bs);
3172 if (size < 0) {
3173 error_setg_errno(errp, -size, "bdrv_getlength failed");
3174 goto out;
3177 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
3178 assert(backup->format);
3179 if (source) {
3180 bdrv_img_create(backup->target, backup->format, source->filename,
3181 source->drv->format_name, NULL,
3182 size, flags, &local_err, false);
3183 } else {
3184 bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3185 size, flags, &local_err, false);
3189 if (local_err) {
3190 error_propagate(errp, local_err);
3191 goto out;
3194 if (backup->format) {
3195 options = qdict_new();
3196 qdict_put(options, "driver", qstring_from_str(backup->format));
3199 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
3200 if (!target_bs) {
3201 goto out;
3204 bdrv_set_aio_context(target_bs, aio_context);
3206 if (backup->has_bitmap) {
3207 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3208 if (!bmap) {
3209 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3210 bdrv_unref(target_bs);
3211 goto out;
3215 backup_start(backup->job_id, bs, target_bs, backup->speed, backup->sync,
3216 bmap, backup->compress, backup->on_source_error,
3217 backup->on_target_error, block_job_cb, bs, txn, &local_err);
3218 bdrv_unref(target_bs);
3219 if (local_err != NULL) {
3220 error_propagate(errp, local_err);
3221 goto out;
3224 out:
3225 aio_context_release(aio_context);
3228 void qmp_drive_backup(DriveBackup *arg, Error **errp)
3230 return do_drive_backup(arg, NULL, errp);
3233 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3235 return bdrv_named_nodes_list(errp);
3238 void do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn, Error **errp)
3240 BlockDriverState *bs;
3241 BlockDriverState *target_bs;
3242 Error *local_err = NULL;
3243 AioContext *aio_context;
3245 if (!backup->has_speed) {
3246 backup->speed = 0;
3248 if (!backup->has_on_source_error) {
3249 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3251 if (!backup->has_on_target_error) {
3252 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3254 if (!backup->has_job_id) {
3255 backup->job_id = NULL;
3257 if (!backup->has_compress) {
3258 backup->compress = false;
3261 bs = qmp_get_root_bs(backup->device, errp);
3262 if (!bs) {
3263 return;
3266 aio_context = bdrv_get_aio_context(bs);
3267 aio_context_acquire(aio_context);
3269 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
3270 if (!target_bs) {
3271 goto out;
3274 if (bdrv_get_aio_context(target_bs) != aio_context) {
3275 if (!bdrv_has_blk(target_bs)) {
3276 /* The target BDS is not attached, we can safely move it to another
3277 * AioContext. */
3278 bdrv_set_aio_context(target_bs, aio_context);
3279 } else {
3280 error_setg(errp, "Target is attached to a different thread from "
3281 "source.");
3282 goto out;
3285 backup_start(backup->job_id, bs, target_bs, backup->speed, backup->sync,
3286 NULL, backup->compress, backup->on_source_error,
3287 backup->on_target_error, block_job_cb, bs, txn, &local_err);
3288 if (local_err != NULL) {
3289 error_propagate(errp, local_err);
3291 out:
3292 aio_context_release(aio_context);
3295 void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
3297 do_blockdev_backup(arg, NULL, errp);
3300 /* Parameter check and block job starting for drive mirroring.
3301 * Caller should hold @device and @target's aio context (must be the same).
3303 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3304 BlockDriverState *target,
3305 bool has_replaces, const char *replaces,
3306 enum MirrorSyncMode sync,
3307 BlockMirrorBackingMode backing_mode,
3308 bool has_speed, int64_t speed,
3309 bool has_granularity, uint32_t granularity,
3310 bool has_buf_size, int64_t buf_size,
3311 bool has_on_source_error,
3312 BlockdevOnError on_source_error,
3313 bool has_on_target_error,
3314 BlockdevOnError on_target_error,
3315 bool has_unmap, bool unmap,
3316 Error **errp)
3319 if (!has_speed) {
3320 speed = 0;
3322 if (!has_on_source_error) {
3323 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3325 if (!has_on_target_error) {
3326 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3328 if (!has_granularity) {
3329 granularity = 0;
3331 if (!has_buf_size) {
3332 buf_size = 0;
3334 if (!has_unmap) {
3335 unmap = true;
3338 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3339 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3340 "a value in range [512B, 64MB]");
3341 return;
3343 if (granularity & (granularity - 1)) {
3344 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3345 "power of 2");
3346 return;
3349 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3350 return;
3352 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3353 return;
3356 if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3357 sync = MIRROR_SYNC_MODE_FULL;
3360 /* pass the node name to replace to mirror start since it's loose coupling
3361 * and will allow to check whether the node still exist at mirror completion
3363 mirror_start(job_id, bs, target,
3364 has_replaces ? replaces : NULL,
3365 speed, granularity, buf_size, sync, backing_mode,
3366 on_source_error, on_target_error, unmap,
3367 block_job_cb, bs, errp);
3370 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3372 BlockDriverState *bs;
3373 BlockDriverState *source, *target_bs;
3374 AioContext *aio_context;
3375 BlockMirrorBackingMode backing_mode;
3376 Error *local_err = NULL;
3377 QDict *options = NULL;
3378 int flags;
3379 int64_t size;
3380 const char *format = arg->format;
3382 bs = qmp_get_root_bs(arg->device, errp);
3383 if (!bs) {
3384 return;
3387 aio_context = bdrv_get_aio_context(bs);
3388 aio_context_acquire(aio_context);
3390 if (!arg->has_mode) {
3391 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3394 if (!arg->has_format) {
3395 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3396 ? NULL : bs->drv->format_name);
3399 flags = bs->open_flags | BDRV_O_RDWR;
3400 source = backing_bs(bs);
3401 if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3402 arg->sync = MIRROR_SYNC_MODE_FULL;
3404 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3405 source = bs;
3408 size = bdrv_getlength(bs);
3409 if (size < 0) {
3410 error_setg_errno(errp, -size, "bdrv_getlength failed");
3411 goto out;
3414 if (arg->has_replaces) {
3415 BlockDriverState *to_replace_bs;
3416 AioContext *replace_aio_context;
3417 int64_t replace_size;
3419 if (!arg->has_node_name) {
3420 error_setg(errp, "a node-name must be provided when replacing a"
3421 " named node of the graph");
3422 goto out;
3425 to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3427 if (!to_replace_bs) {
3428 error_propagate(errp, local_err);
3429 goto out;
3432 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3433 aio_context_acquire(replace_aio_context);
3434 replace_size = bdrv_getlength(to_replace_bs);
3435 aio_context_release(replace_aio_context);
3437 if (size != replace_size) {
3438 error_setg(errp, "cannot replace image with a mirror image of "
3439 "different size");
3440 goto out;
3444 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3445 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3446 } else {
3447 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3450 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3451 && arg->mode != NEW_IMAGE_MODE_EXISTING)
3453 /* create new image w/o backing file */
3454 assert(format);
3455 bdrv_img_create(arg->target, format,
3456 NULL, NULL, NULL, size, flags, &local_err, false);
3457 } else {
3458 switch (arg->mode) {
3459 case NEW_IMAGE_MODE_EXISTING:
3460 break;
3461 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3462 /* create new image with backing file */
3463 bdrv_img_create(arg->target, format,
3464 source->filename,
3465 source->drv->format_name,
3466 NULL, size, flags, &local_err, false);
3467 break;
3468 default:
3469 abort();
3473 if (local_err) {
3474 error_propagate(errp, local_err);
3475 goto out;
3478 options = qdict_new();
3479 if (arg->has_node_name) {
3480 qdict_put(options, "node-name", qstring_from_str(arg->node_name));
3482 if (format) {
3483 qdict_put(options, "driver", qstring_from_str(format));
3486 /* Mirroring takes care of copy-on-write using the source's backing
3487 * file.
3489 target_bs = bdrv_open(arg->target, NULL, options,
3490 flags | BDRV_O_NO_BACKING, errp);
3491 if (!target_bs) {
3492 goto out;
3495 bdrv_set_aio_context(target_bs, aio_context);
3497 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3498 arg->has_replaces, arg->replaces, arg->sync,
3499 backing_mode, arg->has_speed, arg->speed,
3500 arg->has_granularity, arg->granularity,
3501 arg->has_buf_size, arg->buf_size,
3502 arg->has_on_source_error, arg->on_source_error,
3503 arg->has_on_target_error, arg->on_target_error,
3504 arg->has_unmap, arg->unmap,
3505 &local_err);
3506 bdrv_unref(target_bs);
3507 error_propagate(errp, local_err);
3508 out:
3509 aio_context_release(aio_context);
3512 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3513 const char *device, const char *target,
3514 bool has_replaces, const char *replaces,
3515 MirrorSyncMode sync,
3516 bool has_speed, int64_t speed,
3517 bool has_granularity, uint32_t granularity,
3518 bool has_buf_size, int64_t buf_size,
3519 bool has_on_source_error,
3520 BlockdevOnError on_source_error,
3521 bool has_on_target_error,
3522 BlockdevOnError on_target_error,
3523 Error **errp)
3525 BlockDriverState *bs;
3526 BlockDriverState *target_bs;
3527 AioContext *aio_context;
3528 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3529 Error *local_err = NULL;
3531 bs = qmp_get_root_bs(device, errp);
3532 if (!bs) {
3533 return;
3536 target_bs = bdrv_lookup_bs(target, target, errp);
3537 if (!target_bs) {
3538 return;
3541 aio_context = bdrv_get_aio_context(bs);
3542 aio_context_acquire(aio_context);
3544 bdrv_set_aio_context(target_bs, aio_context);
3546 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3547 has_replaces, replaces, sync, backing_mode,
3548 has_speed, speed,
3549 has_granularity, granularity,
3550 has_buf_size, buf_size,
3551 has_on_source_error, on_source_error,
3552 has_on_target_error, on_target_error,
3553 true, true,
3554 &local_err);
3555 error_propagate(errp, local_err);
3557 aio_context_release(aio_context);
3560 /* Get a block job using its ID and acquire its AioContext */
3561 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3562 Error **errp)
3564 BlockJob *job;
3566 assert(id != NULL);
3568 *aio_context = NULL;
3570 job = block_job_get(id);
3572 if (!job) {
3573 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3574 "Block job '%s' not found", id);
3575 return NULL;
3578 *aio_context = blk_get_aio_context(job->blk);
3579 aio_context_acquire(*aio_context);
3581 return job;
3584 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3586 AioContext *aio_context;
3587 BlockJob *job = find_block_job(device, &aio_context, errp);
3589 if (!job) {
3590 return;
3593 block_job_set_speed(job, speed, errp);
3594 aio_context_release(aio_context);
3597 void qmp_block_job_cancel(const char *device,
3598 bool has_force, bool force, Error **errp)
3600 AioContext *aio_context;
3601 BlockJob *job = find_block_job(device, &aio_context, errp);
3603 if (!job) {
3604 return;
3607 if (!has_force) {
3608 force = false;
3611 if (job->user_paused && !force) {
3612 error_setg(errp, "The block job for device '%s' is currently paused",
3613 device);
3614 goto out;
3617 trace_qmp_block_job_cancel(job);
3618 block_job_cancel(job);
3619 out:
3620 aio_context_release(aio_context);
3623 void qmp_block_job_pause(const char *device, Error **errp)
3625 AioContext *aio_context;
3626 BlockJob *job = find_block_job(device, &aio_context, errp);
3628 if (!job || job->user_paused) {
3629 return;
3632 job->user_paused = true;
3633 trace_qmp_block_job_pause(job);
3634 block_job_pause(job);
3635 aio_context_release(aio_context);
3638 void qmp_block_job_resume(const char *device, Error **errp)
3640 AioContext *aio_context;
3641 BlockJob *job = find_block_job(device, &aio_context, errp);
3643 if (!job || !job->user_paused) {
3644 return;
3647 job->user_paused = false;
3648 trace_qmp_block_job_resume(job);
3649 block_job_iostatus_reset(job);
3650 block_job_resume(job);
3651 aio_context_release(aio_context);
3654 void qmp_block_job_complete(const char *device, Error **errp)
3656 AioContext *aio_context;
3657 BlockJob *job = find_block_job(device, &aio_context, errp);
3659 if (!job) {
3660 return;
3663 trace_qmp_block_job_complete(job);
3664 block_job_complete(job, errp);
3665 aio_context_release(aio_context);
3668 void qmp_change_backing_file(const char *device,
3669 const char *image_node_name,
3670 const char *backing_file,
3671 Error **errp)
3673 BlockDriverState *bs = NULL;
3674 AioContext *aio_context;
3675 BlockDriverState *image_bs = NULL;
3676 Error *local_err = NULL;
3677 bool ro;
3678 int open_flags;
3679 int ret;
3681 bs = qmp_get_root_bs(device, errp);
3682 if (!bs) {
3683 return;
3686 aio_context = bdrv_get_aio_context(bs);
3687 aio_context_acquire(aio_context);
3689 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3690 if (local_err) {
3691 error_propagate(errp, local_err);
3692 goto out;
3695 if (!image_bs) {
3696 error_setg(errp, "image file not found");
3697 goto out;
3700 if (bdrv_find_base(image_bs) == image_bs) {
3701 error_setg(errp, "not allowing backing file change on an image "
3702 "without a backing file");
3703 goto out;
3706 /* even though we are not necessarily operating on bs, we need it to
3707 * determine if block ops are currently prohibited on the chain */
3708 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3709 goto out;
3712 /* final sanity check */
3713 if (!bdrv_chain_contains(bs, image_bs)) {
3714 error_setg(errp, "'%s' and image file are not in the same chain",
3715 device);
3716 goto out;
3719 /* if not r/w, reopen to make r/w */
3720 open_flags = image_bs->open_flags;
3721 ro = bdrv_is_read_only(image_bs);
3723 if (ro) {
3724 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3725 if (local_err) {
3726 error_propagate(errp, local_err);
3727 goto out;
3731 ret = bdrv_change_backing_file(image_bs, backing_file,
3732 image_bs->drv ? image_bs->drv->format_name : "");
3734 if (ret < 0) {
3735 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3736 backing_file);
3737 /* don't exit here, so we can try to restore open flags if
3738 * appropriate */
3741 if (ro) {
3742 bdrv_reopen(image_bs, open_flags, &local_err);
3743 error_propagate(errp, local_err);
3746 out:
3747 aio_context_release(aio_context);
3750 void hmp_drive_add_node(Monitor *mon, const char *optstr)
3752 QemuOpts *opts;
3753 QDict *qdict;
3754 Error *local_err = NULL;
3756 opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
3757 if (!opts) {
3758 return;
3761 qdict = qemu_opts_to_qdict(opts, NULL);
3763 if (!qdict_get_try_str(qdict, "node-name")) {
3764 QDECREF(qdict);
3765 error_report("'node-name' needs to be specified");
3766 goto out;
3769 BlockDriverState *bs = bds_tree_init(qdict, &local_err);
3770 if (!bs) {
3771 error_report_err(local_err);
3772 goto out;
3775 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3777 out:
3778 qemu_opts_del(opts);
3781 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3783 BlockDriverState *bs;
3784 BlockBackend *blk = NULL;
3785 QObject *obj;
3786 Visitor *v = qmp_output_visitor_new(&obj);
3787 QDict *qdict;
3788 Error *local_err = NULL;
3790 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3791 * cache.direct=false instead of silently switching to aio=threads, except
3792 * when called from drive_new().
3794 * For now, simply forbidding the combination for all drivers will do. */
3795 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3796 bool direct = options->has_cache &&
3797 options->cache->has_direct &&
3798 options->cache->direct;
3799 if (!direct) {
3800 error_setg(errp, "aio=native requires cache.direct=true");
3801 goto fail;
3805 visit_type_BlockdevOptions(v, NULL, &options, &local_err);
3806 if (local_err) {
3807 error_propagate(errp, local_err);
3808 goto fail;
3811 visit_complete(v, &obj);
3812 qdict = qobject_to_qdict(obj);
3814 qdict_flatten(qdict);
3816 if (options->has_id) {
3817 blk = blockdev_init(NULL, qdict, &local_err);
3818 if (local_err) {
3819 error_propagate(errp, local_err);
3820 goto fail;
3823 bs = blk_bs(blk);
3824 } else {
3825 if (!qdict_get_try_str(qdict, "node-name")) {
3826 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3827 "the root node");
3828 goto fail;
3831 bs = bds_tree_init(qdict, errp);
3832 if (!bs) {
3833 goto fail;
3836 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3839 if (bs && bdrv_key_required(bs)) {
3840 if (blk) {
3841 monitor_remove_blk(blk);
3842 blk_unref(blk);
3843 } else {
3844 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3845 bdrv_unref(bs);
3847 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3848 goto fail;
3851 fail:
3852 visit_free(v);
3855 void qmp_x_blockdev_del(bool has_id, const char *id,
3856 bool has_node_name, const char *node_name, Error **errp)
3858 AioContext *aio_context;
3859 BlockBackend *blk;
3860 BlockDriverState *bs;
3862 if (has_id && has_node_name) {
3863 error_setg(errp, "Only one of id and node-name must be specified");
3864 return;
3865 } else if (!has_id && !has_node_name) {
3866 error_setg(errp, "No block device specified");
3867 return;
3870 if (has_id) {
3871 /* blk_by_name() never returns a BB that is not owned by the monitor */
3872 blk = blk_by_name(id);
3873 if (!blk) {
3874 error_setg(errp, "Cannot find block backend %s", id);
3875 return;
3877 if (blk_legacy_dinfo(blk)) {
3878 error_setg(errp, "Deleting block backend added with drive-add"
3879 " is not supported");
3880 return;
3882 if (blk_get_refcnt(blk) > 1) {
3883 error_setg(errp, "Block backend %s is in use", id);
3884 return;
3886 bs = blk_bs(blk);
3887 aio_context = blk_get_aio_context(blk);
3888 } else {
3889 blk = NULL;
3890 bs = bdrv_find_node(node_name);
3891 if (!bs) {
3892 error_setg(errp, "Cannot find node %s", node_name);
3893 return;
3895 if (bdrv_has_blk(bs)) {
3896 error_setg(errp, "Node %s is in use by %s",
3897 node_name, bdrv_get_parent_name(bs));
3898 return;
3900 aio_context = bdrv_get_aio_context(bs);
3903 aio_context_acquire(aio_context);
3905 if (bs) {
3906 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3907 goto out;
3910 if (!blk && !QTAILQ_IN_USE(bs, monitor_list)) {
3911 error_setg(errp, "Node %s is not owned by the monitor",
3912 bs->node_name);
3913 goto out;
3916 if (bs->refcnt > 1) {
3917 error_setg(errp, "Block device %s is in use",
3918 bdrv_get_device_or_node_name(bs));
3919 goto out;
3923 if (blk) {
3924 monitor_remove_blk(blk);
3925 blk_unref(blk);
3926 } else {
3927 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3928 bdrv_unref(bs);
3931 out:
3932 aio_context_release(aio_context);
3935 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3936 const char *child_name)
3938 BdrvChild *child;
3940 QLIST_FOREACH(child, &parent_bs->children, next) {
3941 if (strcmp(child->name, child_name) == 0) {
3942 return child;
3946 return NULL;
3949 void qmp_x_blockdev_change(const char *parent, bool has_child,
3950 const char *child, bool has_node,
3951 const char *node, Error **errp)
3953 BlockDriverState *parent_bs, *new_bs = NULL;
3954 BdrvChild *p_child;
3956 parent_bs = bdrv_lookup_bs(parent, parent, errp);
3957 if (!parent_bs) {
3958 return;
3961 if (has_child == has_node) {
3962 if (has_child) {
3963 error_setg(errp, "The parameters child and node are in conflict");
3964 } else {
3965 error_setg(errp, "Either child or node must be specified");
3967 return;
3970 if (has_child) {
3971 p_child = bdrv_find_child(parent_bs, child);
3972 if (!p_child) {
3973 error_setg(errp, "Node '%s' does not have child '%s'",
3974 parent, child);
3975 return;
3977 bdrv_del_child(parent_bs, p_child, errp);
3980 if (has_node) {
3981 new_bs = bdrv_find_node(node);
3982 if (!new_bs) {
3983 error_setg(errp, "Node '%s' not found", node);
3984 return;
3986 bdrv_add_child(parent_bs, new_bs, errp);
3990 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3992 BlockJobInfoList *head = NULL, **p_next = &head;
3993 BlockJob *job;
3995 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
3996 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
3997 AioContext *aio_context = blk_get_aio_context(job->blk);
3999 aio_context_acquire(aio_context);
4000 elem->value = block_job_query(job);
4001 aio_context_release(aio_context);
4003 *p_next = elem;
4004 p_next = &elem->next;
4007 return head;
4010 QemuOptsList qemu_common_drive_opts = {
4011 .name = "drive",
4012 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4013 .desc = {
4015 .name = "snapshot",
4016 .type = QEMU_OPT_BOOL,
4017 .help = "enable/disable snapshot mode",
4019 .name = "discard",
4020 .type = QEMU_OPT_STRING,
4021 .help = "discard operation (ignore/off, unmap/on)",
4023 .name = "aio",
4024 .type = QEMU_OPT_STRING,
4025 .help = "host AIO implementation (threads, native)",
4027 .name = BDRV_OPT_CACHE_WB,
4028 .type = QEMU_OPT_BOOL,
4029 .help = "Enable writeback mode",
4031 .name = "format",
4032 .type = QEMU_OPT_STRING,
4033 .help = "disk format (raw, qcow2, ...)",
4035 .name = "rerror",
4036 .type = QEMU_OPT_STRING,
4037 .help = "read error action",
4039 .name = "werror",
4040 .type = QEMU_OPT_STRING,
4041 .help = "write error action",
4043 .name = "read-only",
4044 .type = QEMU_OPT_BOOL,
4045 .help = "open drive file as read-only",
4047 .name = "throttling.iops-total",
4048 .type = QEMU_OPT_NUMBER,
4049 .help = "limit total I/O operations per second",
4051 .name = "throttling.iops-read",
4052 .type = QEMU_OPT_NUMBER,
4053 .help = "limit read operations per second",
4055 .name = "throttling.iops-write",
4056 .type = QEMU_OPT_NUMBER,
4057 .help = "limit write operations per second",
4059 .name = "throttling.bps-total",
4060 .type = QEMU_OPT_NUMBER,
4061 .help = "limit total bytes per second",
4063 .name = "throttling.bps-read",
4064 .type = QEMU_OPT_NUMBER,
4065 .help = "limit read bytes per second",
4067 .name = "throttling.bps-write",
4068 .type = QEMU_OPT_NUMBER,
4069 .help = "limit write bytes per second",
4071 .name = "throttling.iops-total-max",
4072 .type = QEMU_OPT_NUMBER,
4073 .help = "I/O operations burst",
4075 .name = "throttling.iops-read-max",
4076 .type = QEMU_OPT_NUMBER,
4077 .help = "I/O operations read burst",
4079 .name = "throttling.iops-write-max",
4080 .type = QEMU_OPT_NUMBER,
4081 .help = "I/O operations write burst",
4083 .name = "throttling.bps-total-max",
4084 .type = QEMU_OPT_NUMBER,
4085 .help = "total bytes burst",
4087 .name = "throttling.bps-read-max",
4088 .type = QEMU_OPT_NUMBER,
4089 .help = "total bytes read burst",
4091 .name = "throttling.bps-write-max",
4092 .type = QEMU_OPT_NUMBER,
4093 .help = "total bytes write burst",
4095 .name = "throttling.iops-total-max-length",
4096 .type = QEMU_OPT_NUMBER,
4097 .help = "length of the iops-total-max burst period, in seconds",
4099 .name = "throttling.iops-read-max-length",
4100 .type = QEMU_OPT_NUMBER,
4101 .help = "length of the iops-read-max burst period, in seconds",
4103 .name = "throttling.iops-write-max-length",
4104 .type = QEMU_OPT_NUMBER,
4105 .help = "length of the iops-write-max burst period, in seconds",
4107 .name = "throttling.bps-total-max-length",
4108 .type = QEMU_OPT_NUMBER,
4109 .help = "length of the bps-total-max burst period, in seconds",
4111 .name = "throttling.bps-read-max-length",
4112 .type = QEMU_OPT_NUMBER,
4113 .help = "length of the bps-read-max burst period, in seconds",
4115 .name = "throttling.bps-write-max-length",
4116 .type = QEMU_OPT_NUMBER,
4117 .help = "length of the bps-write-max burst period, in seconds",
4119 .name = "throttling.iops-size",
4120 .type = QEMU_OPT_NUMBER,
4121 .help = "when limiting by iops max size of an I/O in bytes",
4123 .name = "throttling.group",
4124 .type = QEMU_OPT_STRING,
4125 .help = "name of the block throttling group",
4127 .name = "copy-on-read",
4128 .type = QEMU_OPT_BOOL,
4129 .help = "copy read data from backing file into image file",
4131 .name = "detect-zeroes",
4132 .type = QEMU_OPT_STRING,
4133 .help = "try to optimize zero writes (off, on, unmap)",
4135 .name = "stats-account-invalid",
4136 .type = QEMU_OPT_BOOL,
4137 .help = "whether to account for invalid I/O operations "
4138 "in the statistics",
4140 .name = "stats-account-failed",
4141 .type = QEMU_OPT_BOOL,
4142 .help = "whether to account for failed I/O operations "
4143 "in the statistics",
4145 { /* end of list */ }
4149 static QemuOptsList qemu_root_bds_opts = {
4150 .name = "root-bds",
4151 .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4152 .desc = {
4154 .name = "discard",
4155 .type = QEMU_OPT_STRING,
4156 .help = "discard operation (ignore/off, unmap/on)",
4158 .name = "aio",
4159 .type = QEMU_OPT_STRING,
4160 .help = "host AIO implementation (threads, native)",
4162 .name = "read-only",
4163 .type = QEMU_OPT_BOOL,
4164 .help = "open drive file as read-only",
4166 .name = "copy-on-read",
4167 .type = QEMU_OPT_BOOL,
4168 .help = "copy read data from backing file into image file",
4170 .name = "detect-zeroes",
4171 .type = QEMU_OPT_STRING,
4172 .help = "try to optimize zero writes (off, on, unmap)",
4174 { /* end of list */ }
4178 QemuOptsList qemu_drive_opts = {
4179 .name = "drive",
4180 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4181 .desc = {
4183 * no elements => accept any params
4184 * validation will happen later
4186 { /* end of list */ }