qcow: cleanup qcow_co_pwritev_compressed to avoid the recursion
[qemu.git] / blockdev.c
bloba392e08ed23ecdf874a956b7402ef87ca5cc983c
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(const char *job_id, const char *device,
1845 const char *target, bool has_format,
1846 const char *format, enum MirrorSyncMode sync,
1847 bool has_mode, enum NewImageMode mode,
1848 bool has_speed, int64_t speed,
1849 bool has_bitmap, const char *bitmap,
1850 bool has_on_source_error,
1851 BlockdevOnError on_source_error,
1852 bool has_on_target_error,
1853 BlockdevOnError on_target_error,
1854 BlockJobTxn *txn, Error **errp);
1856 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1858 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1859 BlockDriverState *bs;
1860 DriveBackup *backup;
1861 Error *local_err = NULL;
1863 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1864 backup = common->action->u.drive_backup.data;
1866 bs = qmp_get_root_bs(backup->device, errp);
1867 if (!bs) {
1868 return;
1871 /* AioContext is released in .clean() */
1872 state->aio_context = bdrv_get_aio_context(bs);
1873 aio_context_acquire(state->aio_context);
1874 bdrv_drained_begin(bs);
1875 state->bs = bs;
1877 do_drive_backup(backup->has_job_id ? backup->job_id : NULL,
1878 backup->device, backup->target,
1879 backup->has_format, backup->format,
1880 backup->sync,
1881 backup->has_mode, backup->mode,
1882 backup->has_speed, backup->speed,
1883 backup->has_bitmap, backup->bitmap,
1884 backup->has_on_source_error, backup->on_source_error,
1885 backup->has_on_target_error, backup->on_target_error,
1886 common->block_job_txn, &local_err);
1887 if (local_err) {
1888 error_propagate(errp, local_err);
1889 return;
1892 state->job = state->bs->job;
1895 static void drive_backup_abort(BlkActionState *common)
1897 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1898 BlockDriverState *bs = state->bs;
1900 /* Only cancel if it's the job we started */
1901 if (bs && bs->job && bs->job == state->job) {
1902 block_job_cancel_sync(bs->job);
1906 static void drive_backup_clean(BlkActionState *common)
1908 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1910 if (state->aio_context) {
1911 bdrv_drained_end(state->bs);
1912 aio_context_release(state->aio_context);
1916 typedef struct BlockdevBackupState {
1917 BlkActionState common;
1918 BlockDriverState *bs;
1919 BlockJob *job;
1920 AioContext *aio_context;
1921 } BlockdevBackupState;
1923 static void do_blockdev_backup(const char *job_id, const char *device,
1924 const char *target, enum MirrorSyncMode sync,
1925 bool has_speed, int64_t speed,
1926 bool has_on_source_error,
1927 BlockdevOnError on_source_error,
1928 bool has_on_target_error,
1929 BlockdevOnError on_target_error,
1930 BlockJobTxn *txn, Error **errp);
1932 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1934 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1935 BlockdevBackup *backup;
1936 BlockDriverState *bs, *target;
1937 Error *local_err = NULL;
1939 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1940 backup = common->action->u.blockdev_backup.data;
1942 bs = qmp_get_root_bs(backup->device, errp);
1943 if (!bs) {
1944 return;
1947 target = bdrv_lookup_bs(backup->target, backup->target, errp);
1948 if (!target) {
1949 return;
1952 /* AioContext is released in .clean() */
1953 state->aio_context = bdrv_get_aio_context(bs);
1954 if (state->aio_context != bdrv_get_aio_context(target)) {
1955 state->aio_context = NULL;
1956 error_setg(errp, "Backup between two IO threads is not implemented");
1957 return;
1959 aio_context_acquire(state->aio_context);
1960 state->bs = bs;
1961 bdrv_drained_begin(state->bs);
1963 do_blockdev_backup(backup->has_job_id ? backup->job_id : NULL,
1964 backup->device, backup->target, backup->sync,
1965 backup->has_speed, backup->speed,
1966 backup->has_on_source_error, backup->on_source_error,
1967 backup->has_on_target_error, backup->on_target_error,
1968 common->block_job_txn, &local_err);
1969 if (local_err) {
1970 error_propagate(errp, local_err);
1971 return;
1974 state->job = state->bs->job;
1977 static void blockdev_backup_abort(BlkActionState *common)
1979 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1980 BlockDriverState *bs = state->bs;
1982 /* Only cancel if it's the job we started */
1983 if (bs && bs->job && bs->job == state->job) {
1984 block_job_cancel_sync(bs->job);
1988 static void blockdev_backup_clean(BlkActionState *common)
1990 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1992 if (state->aio_context) {
1993 bdrv_drained_end(state->bs);
1994 aio_context_release(state->aio_context);
1998 typedef struct BlockDirtyBitmapState {
1999 BlkActionState common;
2000 BdrvDirtyBitmap *bitmap;
2001 BlockDriverState *bs;
2002 AioContext *aio_context;
2003 HBitmap *backup;
2004 bool prepared;
2005 } BlockDirtyBitmapState;
2007 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
2008 Error **errp)
2010 Error *local_err = NULL;
2011 BlockDirtyBitmapAdd *action;
2012 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2013 common, common);
2015 if (action_check_completion_mode(common, errp) < 0) {
2016 return;
2019 action = common->action->u.block_dirty_bitmap_add.data;
2020 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2021 qmp_block_dirty_bitmap_add(action->node, action->name,
2022 action->has_granularity, action->granularity,
2023 &local_err);
2025 if (!local_err) {
2026 state->prepared = true;
2027 } else {
2028 error_propagate(errp, local_err);
2032 static void block_dirty_bitmap_add_abort(BlkActionState *common)
2034 BlockDirtyBitmapAdd *action;
2035 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2036 common, common);
2038 action = common->action->u.block_dirty_bitmap_add.data;
2039 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2040 * then the node reference and bitmap name must have been valid.
2042 if (state->prepared) {
2043 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2047 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
2048 Error **errp)
2050 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2051 common, common);
2052 BlockDirtyBitmap *action;
2054 if (action_check_completion_mode(common, errp) < 0) {
2055 return;
2058 action = common->action->u.block_dirty_bitmap_clear.data;
2059 state->bitmap = block_dirty_bitmap_lookup(action->node,
2060 action->name,
2061 &state->bs,
2062 &state->aio_context,
2063 errp);
2064 if (!state->bitmap) {
2065 return;
2068 if (bdrv_dirty_bitmap_frozen(state->bitmap)) {
2069 error_setg(errp, "Cannot modify a frozen bitmap");
2070 return;
2071 } else if (!bdrv_dirty_bitmap_enabled(state->bitmap)) {
2072 error_setg(errp, "Cannot clear a disabled bitmap");
2073 return;
2076 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2077 /* AioContext is released in .clean() */
2080 static void block_dirty_bitmap_clear_abort(BlkActionState *common)
2082 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2083 common, common);
2085 bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
2088 static void block_dirty_bitmap_clear_commit(BlkActionState *common)
2090 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2091 common, common);
2093 hbitmap_free(state->backup);
2096 static void block_dirty_bitmap_clear_clean(BlkActionState *common)
2098 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2099 common, common);
2101 if (state->aio_context) {
2102 aio_context_release(state->aio_context);
2106 static void abort_prepare(BlkActionState *common, Error **errp)
2108 error_setg(errp, "Transaction aborted using Abort action");
2111 static void abort_commit(BlkActionState *common)
2113 g_assert_not_reached(); /* this action never succeeds */
2116 static const BlkActionOps actions[] = {
2117 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2118 .instance_size = sizeof(ExternalSnapshotState),
2119 .prepare = external_snapshot_prepare,
2120 .commit = external_snapshot_commit,
2121 .abort = external_snapshot_abort,
2122 .clean = external_snapshot_clean,
2124 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2125 .instance_size = sizeof(ExternalSnapshotState),
2126 .prepare = external_snapshot_prepare,
2127 .commit = external_snapshot_commit,
2128 .abort = external_snapshot_abort,
2129 .clean = external_snapshot_clean,
2131 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2132 .instance_size = sizeof(DriveBackupState),
2133 .prepare = drive_backup_prepare,
2134 .abort = drive_backup_abort,
2135 .clean = drive_backup_clean,
2137 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2138 .instance_size = sizeof(BlockdevBackupState),
2139 .prepare = blockdev_backup_prepare,
2140 .abort = blockdev_backup_abort,
2141 .clean = blockdev_backup_clean,
2143 [TRANSACTION_ACTION_KIND_ABORT] = {
2144 .instance_size = sizeof(BlkActionState),
2145 .prepare = abort_prepare,
2146 .commit = abort_commit,
2148 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2149 .instance_size = sizeof(InternalSnapshotState),
2150 .prepare = internal_snapshot_prepare,
2151 .abort = internal_snapshot_abort,
2152 .clean = internal_snapshot_clean,
2154 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2155 .instance_size = sizeof(BlockDirtyBitmapState),
2156 .prepare = block_dirty_bitmap_add_prepare,
2157 .abort = block_dirty_bitmap_add_abort,
2159 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2160 .instance_size = sizeof(BlockDirtyBitmapState),
2161 .prepare = block_dirty_bitmap_clear_prepare,
2162 .commit = block_dirty_bitmap_clear_commit,
2163 .abort = block_dirty_bitmap_clear_abort,
2164 .clean = block_dirty_bitmap_clear_clean,
2169 * Allocate a TransactionProperties structure if necessary, and fill
2170 * that structure with desired defaults if they are unset.
2172 static TransactionProperties *get_transaction_properties(
2173 TransactionProperties *props)
2175 if (!props) {
2176 props = g_new0(TransactionProperties, 1);
2179 if (!props->has_completion_mode) {
2180 props->has_completion_mode = true;
2181 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2184 return props;
2188 * 'Atomic' group operations. The operations are performed as a set, and if
2189 * any fail then we roll back all operations in the group.
2191 void qmp_transaction(TransactionActionList *dev_list,
2192 bool has_props,
2193 struct TransactionProperties *props,
2194 Error **errp)
2196 TransactionActionList *dev_entry = dev_list;
2197 BlockJobTxn *block_job_txn = NULL;
2198 BlkActionState *state, *next;
2199 Error *local_err = NULL;
2201 QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2202 QSIMPLEQ_INIT(&snap_bdrv_states);
2204 /* Does this transaction get canceled as a group on failure?
2205 * If not, we don't really need to make a BlockJobTxn.
2207 props = get_transaction_properties(props);
2208 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2209 block_job_txn = block_job_txn_new();
2212 /* drain all i/o before any operations */
2213 bdrv_drain_all();
2215 /* We don't do anything in this loop that commits us to the operations */
2216 while (NULL != dev_entry) {
2217 TransactionAction *dev_info = NULL;
2218 const BlkActionOps *ops;
2220 dev_info = dev_entry->value;
2221 dev_entry = dev_entry->next;
2223 assert(dev_info->type < ARRAY_SIZE(actions));
2225 ops = &actions[dev_info->type];
2226 assert(ops->instance_size > 0);
2228 state = g_malloc0(ops->instance_size);
2229 state->ops = ops;
2230 state->action = dev_info;
2231 state->block_job_txn = block_job_txn;
2232 state->txn_props = props;
2233 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2235 state->ops->prepare(state, &local_err);
2236 if (local_err) {
2237 error_propagate(errp, local_err);
2238 goto delete_and_fail;
2242 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2243 if (state->ops->commit) {
2244 state->ops->commit(state);
2248 /* success */
2249 goto exit;
2251 delete_and_fail:
2252 /* failure, and it is all-or-none; roll back all operations */
2253 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2254 if (state->ops->abort) {
2255 state->ops->abort(state);
2258 exit:
2259 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2260 if (state->ops->clean) {
2261 state->ops->clean(state);
2263 g_free(state);
2265 if (!has_props) {
2266 qapi_free_TransactionProperties(props);
2268 block_job_txn_unref(block_job_txn);
2271 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2273 Error *local_err = NULL;
2274 int rc;
2276 if (!has_force) {
2277 force = false;
2280 rc = do_open_tray(device, force, &local_err);
2281 if (rc && rc != -ENOSYS) {
2282 error_propagate(errp, local_err);
2283 return;
2285 error_free(local_err);
2287 qmp_x_blockdev_remove_medium(device, errp);
2290 void qmp_block_passwd(bool has_device, const char *device,
2291 bool has_node_name, const char *node_name,
2292 const char *password, Error **errp)
2294 Error *local_err = NULL;
2295 BlockDriverState *bs;
2296 AioContext *aio_context;
2298 bs = bdrv_lookup_bs(has_device ? device : NULL,
2299 has_node_name ? node_name : NULL,
2300 &local_err);
2301 if (local_err) {
2302 error_propagate(errp, local_err);
2303 return;
2306 aio_context = bdrv_get_aio_context(bs);
2307 aio_context_acquire(aio_context);
2309 bdrv_add_key(bs, password, errp);
2311 aio_context_release(aio_context);
2315 * Attempt to open the tray of @device.
2316 * If @force, ignore its tray lock.
2317 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2318 * On error, store an error through @errp and return -errno.
2319 * If @device does not exist, return -ENODEV.
2320 * If it has no removable media, return -ENOTSUP.
2321 * If it has no tray, return -ENOSYS.
2322 * If the guest was asked to open the tray, return -EINPROGRESS.
2323 * Else, return 0.
2325 static int do_open_tray(const char *device, bool force, Error **errp)
2327 BlockBackend *blk;
2328 bool locked;
2330 blk = blk_by_name(device);
2331 if (!blk) {
2332 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2333 "Device '%s' not found", device);
2334 return -ENODEV;
2337 if (!blk_dev_has_removable_media(blk)) {
2338 error_setg(errp, "Device '%s' is not removable", device);
2339 return -ENOTSUP;
2342 if (!blk_dev_has_tray(blk)) {
2343 error_setg(errp, "Device '%s' does not have a tray", device);
2344 return -ENOSYS;
2347 if (blk_dev_is_tray_open(blk)) {
2348 return 0;
2351 locked = blk_dev_is_medium_locked(blk);
2352 if (locked) {
2353 blk_dev_eject_request(blk, force);
2356 if (!locked || force) {
2357 blk_dev_change_media_cb(blk, false);
2360 if (locked && !force) {
2361 error_setg(errp, "Device '%s' is locked and force was not specified, "
2362 "wait for tray to open and try again", device);
2363 return -EINPROGRESS;
2366 return 0;
2369 void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
2370 Error **errp)
2372 Error *local_err = NULL;
2373 int rc;
2375 if (!has_force) {
2376 force = false;
2378 rc = do_open_tray(device, force, &local_err);
2379 if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2380 error_propagate(errp, local_err);
2381 return;
2383 error_free(local_err);
2386 void qmp_blockdev_close_tray(const char *device, Error **errp)
2388 BlockBackend *blk;
2390 blk = blk_by_name(device);
2391 if (!blk) {
2392 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2393 "Device '%s' not found", device);
2394 return;
2397 if (!blk_dev_has_removable_media(blk)) {
2398 error_setg(errp, "Device '%s' is not removable", device);
2399 return;
2402 if (!blk_dev_has_tray(blk)) {
2403 /* Ignore this command on tray-less devices */
2404 return;
2407 if (!blk_dev_is_tray_open(blk)) {
2408 return;
2411 blk_dev_change_media_cb(blk, true);
2414 void qmp_x_blockdev_remove_medium(const char *device, Error **errp)
2416 BlockBackend *blk;
2417 BlockDriverState *bs;
2418 AioContext *aio_context;
2419 bool has_device;
2421 blk = blk_by_name(device);
2422 if (!blk) {
2423 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2424 "Device '%s' not found", device);
2425 return;
2428 /* For BBs without a device, we can exchange the BDS tree at will */
2429 has_device = blk_get_attached_dev(blk);
2431 if (has_device && !blk_dev_has_removable_media(blk)) {
2432 error_setg(errp, "Device '%s' is not removable", device);
2433 return;
2436 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2437 error_setg(errp, "Tray of device '%s' is not open", device);
2438 return;
2441 bs = blk_bs(blk);
2442 if (!bs) {
2443 return;
2446 aio_context = bdrv_get_aio_context(bs);
2447 aio_context_acquire(aio_context);
2449 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2450 goto out;
2453 blk_remove_bs(blk);
2455 if (!blk_dev_has_tray(blk)) {
2456 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2457 * called at all); therefore, the medium needs to be ejected here.
2458 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2459 * value passed here (i.e. false). */
2460 blk_dev_change_media_cb(blk, false);
2463 out:
2464 aio_context_release(aio_context);
2467 static void qmp_blockdev_insert_anon_medium(const char *device,
2468 BlockDriverState *bs, Error **errp)
2470 BlockBackend *blk;
2471 bool has_device;
2473 blk = blk_by_name(device);
2474 if (!blk) {
2475 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2476 "Device '%s' not found", device);
2477 return;
2480 /* For BBs without a device, we can exchange the BDS tree at will */
2481 has_device = blk_get_attached_dev(blk);
2483 if (has_device && !blk_dev_has_removable_media(blk)) {
2484 error_setg(errp, "Device '%s' is not removable", device);
2485 return;
2488 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2489 error_setg(errp, "Tray of device '%s' is not open", device);
2490 return;
2493 if (blk_bs(blk)) {
2494 error_setg(errp, "There already is a medium in device '%s'", device);
2495 return;
2498 blk_insert_bs(blk, bs);
2500 if (!blk_dev_has_tray(blk)) {
2501 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2502 * called at all); therefore, the medium needs to be pushed into the
2503 * slot here.
2504 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2505 * value passed here (i.e. true). */
2506 blk_dev_change_media_cb(blk, true);
2510 void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
2511 Error **errp)
2513 BlockDriverState *bs;
2515 bs = bdrv_find_node(node_name);
2516 if (!bs) {
2517 error_setg(errp, "Node '%s' not found", node_name);
2518 return;
2521 if (bdrv_has_blk(bs)) {
2522 error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
2523 bdrv_get_parent_name(bs));
2524 return;
2527 qmp_blockdev_insert_anon_medium(device, bs, errp);
2530 void qmp_blockdev_change_medium(const char *device, const char *filename,
2531 bool has_format, const char *format,
2532 bool has_read_only,
2533 BlockdevChangeReadOnlyMode read_only,
2534 Error **errp)
2536 BlockBackend *blk;
2537 BlockDriverState *medium_bs = NULL;
2538 int bdrv_flags;
2539 int rc;
2540 QDict *options = NULL;
2541 Error *err = NULL;
2543 blk = blk_by_name(device);
2544 if (!blk) {
2545 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2546 "Device '%s' not found", device);
2547 goto fail;
2550 if (blk_bs(blk)) {
2551 blk_update_root_state(blk);
2554 bdrv_flags = blk_get_open_flags_from_root_state(blk);
2555 bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2556 BDRV_O_PROTOCOL);
2558 if (!has_read_only) {
2559 read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2562 switch (read_only) {
2563 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2564 break;
2566 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2567 bdrv_flags &= ~BDRV_O_RDWR;
2568 break;
2570 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2571 bdrv_flags |= BDRV_O_RDWR;
2572 break;
2574 default:
2575 abort();
2578 if (has_format) {
2579 options = qdict_new();
2580 qdict_put(options, "driver", qstring_from_str(format));
2583 medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2584 if (!medium_bs) {
2585 goto fail;
2588 bdrv_add_key(medium_bs, NULL, &err);
2589 if (err) {
2590 error_propagate(errp, err);
2591 goto fail;
2594 rc = do_open_tray(device, false, &err);
2595 if (rc && rc != -ENOSYS) {
2596 error_propagate(errp, err);
2597 goto fail;
2599 error_free(err);
2600 err = NULL;
2602 qmp_x_blockdev_remove_medium(device, &err);
2603 if (err) {
2604 error_propagate(errp, err);
2605 goto fail;
2608 qmp_blockdev_insert_anon_medium(device, medium_bs, &err);
2609 if (err) {
2610 error_propagate(errp, err);
2611 goto fail;
2614 blk_apply_root_state(blk, medium_bs);
2616 qmp_blockdev_close_tray(device, errp);
2618 fail:
2619 /* If the medium has been inserted, the device has its own reference, so
2620 * ours must be relinquished; and if it has not been inserted successfully,
2621 * the reference must be relinquished anyway */
2622 bdrv_unref(medium_bs);
2625 /* throttling disk I/O limits */
2626 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2628 ThrottleConfig cfg;
2629 BlockDriverState *bs;
2630 BlockBackend *blk;
2631 AioContext *aio_context;
2633 blk = blk_by_name(arg->device);
2634 if (!blk) {
2635 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2636 "Device '%s' not found", arg->device);
2637 return;
2640 aio_context = blk_get_aio_context(blk);
2641 aio_context_acquire(aio_context);
2643 bs = blk_bs(blk);
2644 if (!bs) {
2645 error_setg(errp, "Device '%s' has no medium", arg->device);
2646 goto out;
2649 throttle_config_init(&cfg);
2650 cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2651 cfg.buckets[THROTTLE_BPS_READ].avg = arg->bps_rd;
2652 cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2654 cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2655 cfg.buckets[THROTTLE_OPS_READ].avg = arg->iops_rd;
2656 cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2658 if (arg->has_bps_max) {
2659 cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2661 if (arg->has_bps_rd_max) {
2662 cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2664 if (arg->has_bps_wr_max) {
2665 cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2667 if (arg->has_iops_max) {
2668 cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2670 if (arg->has_iops_rd_max) {
2671 cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2673 if (arg->has_iops_wr_max) {
2674 cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2677 if (arg->has_bps_max_length) {
2678 cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2680 if (arg->has_bps_rd_max_length) {
2681 cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2683 if (arg->has_bps_wr_max_length) {
2684 cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2686 if (arg->has_iops_max_length) {
2687 cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2689 if (arg->has_iops_rd_max_length) {
2690 cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2692 if (arg->has_iops_wr_max_length) {
2693 cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2696 if (arg->has_iops_size) {
2697 cfg.op_size = arg->iops_size;
2700 if (!throttle_is_valid(&cfg, errp)) {
2701 goto out;
2704 if (throttle_enabled(&cfg)) {
2705 /* Enable I/O limits if they're not enabled yet, otherwise
2706 * just update the throttling group. */
2707 if (!blk_get_public(blk)->throttle_state) {
2708 blk_io_limits_enable(blk,
2709 arg->has_group ? arg->group : arg->device);
2710 } else if (arg->has_group) {
2711 blk_io_limits_update_group(blk, arg->group);
2713 /* Set the new throttling configuration */
2714 blk_set_io_limits(blk, &cfg);
2715 } else if (blk_get_public(blk)->throttle_state) {
2716 /* If all throttling settings are set to 0, disable I/O limits */
2717 blk_io_limits_disable(blk);
2720 out:
2721 aio_context_release(aio_context);
2724 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2725 bool has_granularity, uint32_t granularity,
2726 Error **errp)
2728 AioContext *aio_context;
2729 BlockDriverState *bs;
2731 if (!name || name[0] == '\0') {
2732 error_setg(errp, "Bitmap name cannot be empty");
2733 return;
2736 bs = bdrv_lookup_bs(node, node, errp);
2737 if (!bs) {
2738 return;
2741 aio_context = bdrv_get_aio_context(bs);
2742 aio_context_acquire(aio_context);
2744 if (has_granularity) {
2745 if (granularity < 512 || !is_power_of_2(granularity)) {
2746 error_setg(errp, "Granularity must be power of 2 "
2747 "and at least 512");
2748 goto out;
2750 } else {
2751 /* Default to cluster size, if available: */
2752 granularity = bdrv_get_default_bitmap_granularity(bs);
2755 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2757 out:
2758 aio_context_release(aio_context);
2761 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2762 Error **errp)
2764 AioContext *aio_context;
2765 BlockDriverState *bs;
2766 BdrvDirtyBitmap *bitmap;
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 removed",
2776 name);
2777 goto out;
2779 bdrv_dirty_bitmap_make_anon(bitmap);
2780 bdrv_release_dirty_bitmap(bs, bitmap);
2782 out:
2783 aio_context_release(aio_context);
2787 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2788 * immediately after a full backup operation.
2790 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2791 Error **errp)
2793 AioContext *aio_context;
2794 BdrvDirtyBitmap *bitmap;
2795 BlockDriverState *bs;
2797 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2798 if (!bitmap || !bs) {
2799 return;
2802 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2803 error_setg(errp,
2804 "Bitmap '%s' is currently frozen and cannot be modified",
2805 name);
2806 goto out;
2807 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2808 error_setg(errp,
2809 "Bitmap '%s' is currently disabled and cannot be cleared",
2810 name);
2811 goto out;
2814 bdrv_clear_dirty_bitmap(bitmap, NULL);
2816 out:
2817 aio_context_release(aio_context);
2820 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2822 const char *id = qdict_get_str(qdict, "id");
2823 BlockBackend *blk;
2824 BlockDriverState *bs;
2825 AioContext *aio_context;
2826 Error *local_err = NULL;
2828 bs = bdrv_find_node(id);
2829 if (bs) {
2830 qmp_x_blockdev_del(false, NULL, true, id, &local_err);
2831 if (local_err) {
2832 error_report_err(local_err);
2834 return;
2837 blk = blk_by_name(id);
2838 if (!blk) {
2839 error_report("Device '%s' not found", id);
2840 return;
2843 if (!blk_legacy_dinfo(blk)) {
2844 error_report("Deleting device added with blockdev-add"
2845 " is not supported");
2846 return;
2849 aio_context = blk_get_aio_context(blk);
2850 aio_context_acquire(aio_context);
2852 bs = blk_bs(blk);
2853 if (bs) {
2854 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2855 error_report_err(local_err);
2856 aio_context_release(aio_context);
2857 return;
2860 blk_remove_bs(blk);
2863 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2864 monitor_remove_blk(blk);
2866 /* If this BlockBackend has a device attached to it, its refcount will be
2867 * decremented when the device is removed; otherwise we have to do so here.
2869 if (blk_get_attached_dev(blk)) {
2870 /* Further I/O must not pause the guest */
2871 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2872 BLOCKDEV_ON_ERROR_REPORT);
2873 } else {
2874 blk_unref(blk);
2877 aio_context_release(aio_context);
2880 void qmp_block_resize(bool has_device, const char *device,
2881 bool has_node_name, const char *node_name,
2882 int64_t size, Error **errp)
2884 Error *local_err = NULL;
2885 BlockDriverState *bs;
2886 AioContext *aio_context;
2887 int ret;
2889 bs = bdrv_lookup_bs(has_device ? device : NULL,
2890 has_node_name ? node_name : NULL,
2891 &local_err);
2892 if (local_err) {
2893 error_propagate(errp, local_err);
2894 return;
2897 aio_context = bdrv_get_aio_context(bs);
2898 aio_context_acquire(aio_context);
2900 if (!bdrv_is_first_non_filter(bs)) {
2901 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2902 goto out;
2905 if (size < 0) {
2906 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2907 goto out;
2910 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2911 error_setg(errp, QERR_DEVICE_IN_USE, device);
2912 goto out;
2915 /* complete all in-flight operations before resizing the device */
2916 bdrv_drain_all();
2918 ret = bdrv_truncate(bs, size);
2919 switch (ret) {
2920 case 0:
2921 break;
2922 case -ENOMEDIUM:
2923 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2924 break;
2925 case -ENOTSUP:
2926 error_setg(errp, QERR_UNSUPPORTED);
2927 break;
2928 case -EACCES:
2929 error_setg(errp, "Device '%s' is read only", device);
2930 break;
2931 case -EBUSY:
2932 error_setg(errp, QERR_DEVICE_IN_USE, device);
2933 break;
2934 default:
2935 error_setg_errno(errp, -ret, "Could not resize");
2936 break;
2939 out:
2940 aio_context_release(aio_context);
2943 static void block_job_cb(void *opaque, int ret)
2945 /* Note that this function may be executed from another AioContext besides
2946 * the QEMU main loop. If you need to access anything that assumes the
2947 * QEMU global mutex, use a BH or introduce a mutex.
2950 BlockDriverState *bs = opaque;
2951 const char *msg = NULL;
2953 trace_block_job_cb(bs, bs->job, ret);
2955 assert(bs->job);
2957 if (ret < 0) {
2958 msg = strerror(-ret);
2961 if (block_job_is_cancelled(bs->job)) {
2962 block_job_event_cancelled(bs->job);
2963 } else {
2964 block_job_event_completed(bs->job, msg);
2968 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
2969 bool has_base, const char *base,
2970 bool has_backing_file, const char *backing_file,
2971 bool has_speed, int64_t speed,
2972 bool has_on_error, BlockdevOnError on_error,
2973 Error **errp)
2975 BlockDriverState *bs;
2976 BlockDriverState *base_bs = NULL;
2977 AioContext *aio_context;
2978 Error *local_err = NULL;
2979 const char *base_name = NULL;
2981 if (!has_on_error) {
2982 on_error = BLOCKDEV_ON_ERROR_REPORT;
2985 bs = qmp_get_root_bs(device, errp);
2986 if (!bs) {
2987 return;
2990 aio_context = bdrv_get_aio_context(bs);
2991 aio_context_acquire(aio_context);
2993 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2994 goto out;
2997 if (has_base) {
2998 base_bs = bdrv_find_backing_image(bs, base);
2999 if (base_bs == NULL) {
3000 error_setg(errp, QERR_BASE_NOT_FOUND, base);
3001 goto out;
3003 assert(bdrv_get_aio_context(base_bs) == aio_context);
3004 base_name = base;
3007 /* if we are streaming the entire chain, the result will have no backing
3008 * file, and specifying one is therefore an error */
3009 if (base_bs == NULL && has_backing_file) {
3010 error_setg(errp, "backing file specified, but streaming the "
3011 "entire chain");
3012 goto out;
3015 /* backing_file string overrides base bs filename */
3016 base_name = has_backing_file ? backing_file : base_name;
3018 stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
3019 has_speed ? speed : 0, on_error, block_job_cb, bs, &local_err);
3020 if (local_err) {
3021 error_propagate(errp, local_err);
3022 goto out;
3025 trace_qmp_block_stream(bs, bs->job);
3027 out:
3028 aio_context_release(aio_context);
3031 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3032 bool has_base, const char *base,
3033 bool has_top, const char *top,
3034 bool has_backing_file, const char *backing_file,
3035 bool has_speed, int64_t speed,
3036 Error **errp)
3038 BlockDriverState *bs;
3039 BlockDriverState *base_bs, *top_bs;
3040 AioContext *aio_context;
3041 Error *local_err = NULL;
3042 /* This will be part of the QMP command, if/when the
3043 * BlockdevOnError change for blkmirror makes it in
3045 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3047 if (!has_speed) {
3048 speed = 0;
3051 /* Important Note:
3052 * libvirt relies on the DeviceNotFound error class in order to probe for
3053 * live commit feature versions; for this to work, we must make sure to
3054 * perform the device lookup before any generic errors that may occur in a
3055 * scenario in which all optional arguments are omitted. */
3056 bs = qmp_get_root_bs(device, &local_err);
3057 if (!bs) {
3058 bs = bdrv_lookup_bs(device, device, NULL);
3059 if (!bs) {
3060 error_free(local_err);
3061 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3062 "Device '%s' not found", device);
3063 } else {
3064 error_propagate(errp, local_err);
3066 return;
3069 aio_context = bdrv_get_aio_context(bs);
3070 aio_context_acquire(aio_context);
3072 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3073 goto out;
3076 /* default top_bs is the active layer */
3077 top_bs = bs;
3079 if (has_top && top) {
3080 if (strcmp(bs->filename, top) != 0) {
3081 top_bs = bdrv_find_backing_image(bs, top);
3085 if (top_bs == NULL) {
3086 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3087 goto out;
3090 assert(bdrv_get_aio_context(top_bs) == aio_context);
3092 if (has_base && base) {
3093 base_bs = bdrv_find_backing_image(top_bs, base);
3094 } else {
3095 base_bs = bdrv_find_base(top_bs);
3098 if (base_bs == NULL) {
3099 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3100 goto out;
3103 assert(bdrv_get_aio_context(base_bs) == aio_context);
3105 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3106 goto out;
3109 /* Do not allow attempts to commit an image into itself */
3110 if (top_bs == base_bs) {
3111 error_setg(errp, "cannot commit an image into itself");
3112 goto out;
3115 if (top_bs == bs) {
3116 if (has_backing_file) {
3117 error_setg(errp, "'backing-file' specified,"
3118 " but 'top' is the active layer");
3119 goto out;
3121 commit_active_start(has_job_id ? job_id : NULL, bs, base_bs, speed,
3122 on_error, block_job_cb, bs, &local_err);
3123 } else {
3124 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, speed,
3125 on_error, block_job_cb, bs,
3126 has_backing_file ? backing_file : NULL, &local_err);
3128 if (local_err != NULL) {
3129 error_propagate(errp, local_err);
3130 goto out;
3133 out:
3134 aio_context_release(aio_context);
3137 static void do_drive_backup(const char *job_id, const char *device,
3138 const char *target, bool has_format,
3139 const char *format, enum MirrorSyncMode sync,
3140 bool has_mode, enum NewImageMode mode,
3141 bool has_speed, int64_t speed,
3142 bool has_bitmap, const char *bitmap,
3143 bool has_on_source_error,
3144 BlockdevOnError on_source_error,
3145 bool has_on_target_error,
3146 BlockdevOnError on_target_error,
3147 BlockJobTxn *txn, Error **errp)
3149 BlockDriverState *bs;
3150 BlockDriverState *target_bs;
3151 BlockDriverState *source = NULL;
3152 BdrvDirtyBitmap *bmap = NULL;
3153 AioContext *aio_context;
3154 QDict *options = NULL;
3155 Error *local_err = NULL;
3156 int flags;
3157 int64_t size;
3159 if (!has_speed) {
3160 speed = 0;
3162 if (!has_on_source_error) {
3163 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3165 if (!has_on_target_error) {
3166 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3168 if (!has_mode) {
3169 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3172 bs = qmp_get_root_bs(device, errp);
3173 if (!bs) {
3174 return;
3177 aio_context = bdrv_get_aio_context(bs);
3178 aio_context_acquire(aio_context);
3180 if (!has_format) {
3181 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
3184 /* Early check to avoid creating target */
3185 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3186 goto out;
3189 flags = bs->open_flags | BDRV_O_RDWR;
3191 /* See if we have a backing HD we can use to create our new image
3192 * on top of. */
3193 if (sync == MIRROR_SYNC_MODE_TOP) {
3194 source = backing_bs(bs);
3195 if (!source) {
3196 sync = MIRROR_SYNC_MODE_FULL;
3199 if (sync == MIRROR_SYNC_MODE_NONE) {
3200 source = bs;
3203 size = bdrv_getlength(bs);
3204 if (size < 0) {
3205 error_setg_errno(errp, -size, "bdrv_getlength failed");
3206 goto out;
3209 if (mode != NEW_IMAGE_MODE_EXISTING) {
3210 assert(format);
3211 if (source) {
3212 bdrv_img_create(target, format, source->filename,
3213 source->drv->format_name, NULL,
3214 size, flags, &local_err, false);
3215 } else {
3216 bdrv_img_create(target, format, NULL, NULL, NULL,
3217 size, flags, &local_err, false);
3221 if (local_err) {
3222 error_propagate(errp, local_err);
3223 goto out;
3226 if (format) {
3227 options = qdict_new();
3228 qdict_put(options, "driver", qstring_from_str(format));
3231 target_bs = bdrv_open(target, NULL, options, flags, errp);
3232 if (!target_bs) {
3233 goto out;
3236 bdrv_set_aio_context(target_bs, aio_context);
3238 if (has_bitmap) {
3239 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
3240 if (!bmap) {
3241 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
3242 bdrv_unref(target_bs);
3243 goto out;
3247 backup_start(job_id, bs, target_bs, speed, sync, bmap,
3248 on_source_error, on_target_error,
3249 block_job_cb, bs, txn, &local_err);
3250 bdrv_unref(target_bs);
3251 if (local_err != NULL) {
3252 error_propagate(errp, local_err);
3253 goto out;
3256 out:
3257 aio_context_release(aio_context);
3260 void qmp_drive_backup(bool has_job_id, const char *job_id,
3261 const char *device, const char *target,
3262 bool has_format, const char *format,
3263 enum MirrorSyncMode sync,
3264 bool has_mode, enum NewImageMode mode,
3265 bool has_speed, int64_t speed,
3266 bool has_bitmap, const char *bitmap,
3267 bool has_on_source_error, BlockdevOnError on_source_error,
3268 bool has_on_target_error, BlockdevOnError on_target_error,
3269 Error **errp)
3271 return do_drive_backup(has_job_id ? job_id : NULL, device, target,
3272 has_format, format, sync,
3273 has_mode, mode, has_speed, speed,
3274 has_bitmap, bitmap,
3275 has_on_source_error, on_source_error,
3276 has_on_target_error, on_target_error,
3277 NULL, errp);
3280 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3282 return bdrv_named_nodes_list(errp);
3285 void do_blockdev_backup(const char *job_id, const char *device,
3286 const char *target, enum MirrorSyncMode sync,
3287 bool has_speed, int64_t speed,
3288 bool has_on_source_error,
3289 BlockdevOnError on_source_error,
3290 bool has_on_target_error,
3291 BlockdevOnError on_target_error,
3292 BlockJobTxn *txn, Error **errp)
3294 BlockDriverState *bs;
3295 BlockDriverState *target_bs;
3296 Error *local_err = NULL;
3297 AioContext *aio_context;
3299 if (!has_speed) {
3300 speed = 0;
3302 if (!has_on_source_error) {
3303 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3305 if (!has_on_target_error) {
3306 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3309 bs = qmp_get_root_bs(device, errp);
3310 if (!bs) {
3311 return;
3314 aio_context = bdrv_get_aio_context(bs);
3315 aio_context_acquire(aio_context);
3317 target_bs = bdrv_lookup_bs(target, target, errp);
3318 if (!target_bs) {
3319 goto out;
3322 if (bdrv_get_aio_context(target_bs) != aio_context) {
3323 if (!bdrv_has_blk(target_bs)) {
3324 /* The target BDS is not attached, we can safely move it to another
3325 * AioContext. */
3326 bdrv_set_aio_context(target_bs, aio_context);
3327 } else {
3328 error_setg(errp, "Target is attached to a different thread from "
3329 "source.");
3330 goto out;
3333 backup_start(job_id, bs, target_bs, speed, sync, NULL, on_source_error,
3334 on_target_error, block_job_cb, bs, txn, &local_err);
3335 if (local_err != NULL) {
3336 error_propagate(errp, local_err);
3338 out:
3339 aio_context_release(aio_context);
3342 void qmp_blockdev_backup(bool has_job_id, const char *job_id,
3343 const char *device, const char *target,
3344 enum MirrorSyncMode sync,
3345 bool has_speed, int64_t speed,
3346 bool has_on_source_error,
3347 BlockdevOnError on_source_error,
3348 bool has_on_target_error,
3349 BlockdevOnError on_target_error,
3350 Error **errp)
3352 do_blockdev_backup(has_job_id ? job_id : NULL, device, target,
3353 sync, has_speed, speed,
3354 has_on_source_error, on_source_error,
3355 has_on_target_error, on_target_error,
3356 NULL, errp);
3359 /* Parameter check and block job starting for drive mirroring.
3360 * Caller should hold @device and @target's aio context (must be the same).
3362 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3363 BlockDriverState *target,
3364 bool has_replaces, const char *replaces,
3365 enum MirrorSyncMode sync,
3366 BlockMirrorBackingMode backing_mode,
3367 bool has_speed, int64_t speed,
3368 bool has_granularity, uint32_t granularity,
3369 bool has_buf_size, int64_t buf_size,
3370 bool has_on_source_error,
3371 BlockdevOnError on_source_error,
3372 bool has_on_target_error,
3373 BlockdevOnError on_target_error,
3374 bool has_unmap, bool unmap,
3375 Error **errp)
3378 if (!has_speed) {
3379 speed = 0;
3381 if (!has_on_source_error) {
3382 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3384 if (!has_on_target_error) {
3385 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3387 if (!has_granularity) {
3388 granularity = 0;
3390 if (!has_buf_size) {
3391 buf_size = 0;
3393 if (!has_unmap) {
3394 unmap = true;
3397 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3398 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3399 "a value in range [512B, 64MB]");
3400 return;
3402 if (granularity & (granularity - 1)) {
3403 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3404 "power of 2");
3405 return;
3408 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3409 return;
3411 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3412 return;
3415 if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3416 sync = MIRROR_SYNC_MODE_FULL;
3419 /* pass the node name to replace to mirror start since it's loose coupling
3420 * and will allow to check whether the node still exist at mirror completion
3422 mirror_start(job_id, bs, target,
3423 has_replaces ? replaces : NULL,
3424 speed, granularity, buf_size, sync, backing_mode,
3425 on_source_error, on_target_error, unmap,
3426 block_job_cb, bs, errp);
3429 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3431 BlockDriverState *bs;
3432 BlockDriverState *source, *target_bs;
3433 AioContext *aio_context;
3434 BlockMirrorBackingMode backing_mode;
3435 Error *local_err = NULL;
3436 QDict *options = NULL;
3437 int flags;
3438 int64_t size;
3439 const char *format = arg->format;
3441 bs = qmp_get_root_bs(arg->device, errp);
3442 if (!bs) {
3443 return;
3446 aio_context = bdrv_get_aio_context(bs);
3447 aio_context_acquire(aio_context);
3449 if (!arg->has_mode) {
3450 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3453 if (!arg->has_format) {
3454 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3455 ? NULL : bs->drv->format_name);
3458 flags = bs->open_flags | BDRV_O_RDWR;
3459 source = backing_bs(bs);
3460 if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3461 arg->sync = MIRROR_SYNC_MODE_FULL;
3463 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3464 source = bs;
3467 size = bdrv_getlength(bs);
3468 if (size < 0) {
3469 error_setg_errno(errp, -size, "bdrv_getlength failed");
3470 goto out;
3473 if (arg->has_replaces) {
3474 BlockDriverState *to_replace_bs;
3475 AioContext *replace_aio_context;
3476 int64_t replace_size;
3478 if (!arg->has_node_name) {
3479 error_setg(errp, "a node-name must be provided when replacing a"
3480 " named node of the graph");
3481 goto out;
3484 to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3486 if (!to_replace_bs) {
3487 error_propagate(errp, local_err);
3488 goto out;
3491 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3492 aio_context_acquire(replace_aio_context);
3493 replace_size = bdrv_getlength(to_replace_bs);
3494 aio_context_release(replace_aio_context);
3496 if (size != replace_size) {
3497 error_setg(errp, "cannot replace image with a mirror image of "
3498 "different size");
3499 goto out;
3503 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3504 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3505 } else {
3506 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3509 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3510 && arg->mode != NEW_IMAGE_MODE_EXISTING)
3512 /* create new image w/o backing file */
3513 assert(format);
3514 bdrv_img_create(arg->target, format,
3515 NULL, NULL, NULL, size, flags, &local_err, false);
3516 } else {
3517 switch (arg->mode) {
3518 case NEW_IMAGE_MODE_EXISTING:
3519 break;
3520 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3521 /* create new image with backing file */
3522 bdrv_img_create(arg->target, format,
3523 source->filename,
3524 source->drv->format_name,
3525 NULL, size, flags, &local_err, false);
3526 break;
3527 default:
3528 abort();
3532 if (local_err) {
3533 error_propagate(errp, local_err);
3534 goto out;
3537 options = qdict_new();
3538 if (arg->has_node_name) {
3539 qdict_put(options, "node-name", qstring_from_str(arg->node_name));
3541 if (format) {
3542 qdict_put(options, "driver", qstring_from_str(format));
3545 /* Mirroring takes care of copy-on-write using the source's backing
3546 * file.
3548 target_bs = bdrv_open(arg->target, NULL, options,
3549 flags | BDRV_O_NO_BACKING, errp);
3550 if (!target_bs) {
3551 goto out;
3554 bdrv_set_aio_context(target_bs, aio_context);
3556 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3557 arg->has_replaces, arg->replaces, arg->sync,
3558 backing_mode, arg->has_speed, arg->speed,
3559 arg->has_granularity, arg->granularity,
3560 arg->has_buf_size, arg->buf_size,
3561 arg->has_on_source_error, arg->on_source_error,
3562 arg->has_on_target_error, arg->on_target_error,
3563 arg->has_unmap, arg->unmap,
3564 &local_err);
3565 bdrv_unref(target_bs);
3566 error_propagate(errp, local_err);
3567 out:
3568 aio_context_release(aio_context);
3571 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3572 const char *device, const char *target,
3573 bool has_replaces, const char *replaces,
3574 MirrorSyncMode sync,
3575 bool has_speed, int64_t speed,
3576 bool has_granularity, uint32_t granularity,
3577 bool has_buf_size, int64_t buf_size,
3578 bool has_on_source_error,
3579 BlockdevOnError on_source_error,
3580 bool has_on_target_error,
3581 BlockdevOnError on_target_error,
3582 Error **errp)
3584 BlockDriverState *bs;
3585 BlockDriverState *target_bs;
3586 AioContext *aio_context;
3587 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3588 Error *local_err = NULL;
3590 bs = qmp_get_root_bs(device, errp);
3591 if (!bs) {
3592 return;
3595 target_bs = bdrv_lookup_bs(target, target, errp);
3596 if (!target_bs) {
3597 return;
3600 aio_context = bdrv_get_aio_context(bs);
3601 aio_context_acquire(aio_context);
3603 bdrv_set_aio_context(target_bs, aio_context);
3605 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3606 has_replaces, replaces, sync, backing_mode,
3607 has_speed, speed,
3608 has_granularity, granularity,
3609 has_buf_size, buf_size,
3610 has_on_source_error, on_source_error,
3611 has_on_target_error, on_target_error,
3612 true, true,
3613 &local_err);
3614 error_propagate(errp, local_err);
3616 aio_context_release(aio_context);
3619 /* Get a block job using its ID and acquire its AioContext */
3620 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3621 Error **errp)
3623 BlockJob *job;
3625 assert(id != NULL);
3627 *aio_context = NULL;
3629 job = block_job_get(id);
3631 if (!job) {
3632 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3633 "Block job '%s' not found", id);
3634 return NULL;
3637 *aio_context = blk_get_aio_context(job->blk);
3638 aio_context_acquire(*aio_context);
3640 return job;
3643 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3645 AioContext *aio_context;
3646 BlockJob *job = find_block_job(device, &aio_context, errp);
3648 if (!job) {
3649 return;
3652 block_job_set_speed(job, speed, errp);
3653 aio_context_release(aio_context);
3656 void qmp_block_job_cancel(const char *device,
3657 bool has_force, bool force, Error **errp)
3659 AioContext *aio_context;
3660 BlockJob *job = find_block_job(device, &aio_context, errp);
3662 if (!job) {
3663 return;
3666 if (!has_force) {
3667 force = false;
3670 if (job->user_paused && !force) {
3671 error_setg(errp, "The block job for device '%s' is currently paused",
3672 device);
3673 goto out;
3676 trace_qmp_block_job_cancel(job);
3677 block_job_cancel(job);
3678 out:
3679 aio_context_release(aio_context);
3682 void qmp_block_job_pause(const char *device, Error **errp)
3684 AioContext *aio_context;
3685 BlockJob *job = find_block_job(device, &aio_context, errp);
3687 if (!job || job->user_paused) {
3688 return;
3691 job->user_paused = true;
3692 trace_qmp_block_job_pause(job);
3693 block_job_pause(job);
3694 aio_context_release(aio_context);
3697 void qmp_block_job_resume(const char *device, Error **errp)
3699 AioContext *aio_context;
3700 BlockJob *job = find_block_job(device, &aio_context, errp);
3702 if (!job || !job->user_paused) {
3703 return;
3706 job->user_paused = false;
3707 trace_qmp_block_job_resume(job);
3708 block_job_iostatus_reset(job);
3709 block_job_resume(job);
3710 aio_context_release(aio_context);
3713 void qmp_block_job_complete(const char *device, Error **errp)
3715 AioContext *aio_context;
3716 BlockJob *job = find_block_job(device, &aio_context, errp);
3718 if (!job) {
3719 return;
3722 trace_qmp_block_job_complete(job);
3723 block_job_complete(job, errp);
3724 aio_context_release(aio_context);
3727 void qmp_change_backing_file(const char *device,
3728 const char *image_node_name,
3729 const char *backing_file,
3730 Error **errp)
3732 BlockDriverState *bs = NULL;
3733 AioContext *aio_context;
3734 BlockDriverState *image_bs = NULL;
3735 Error *local_err = NULL;
3736 bool ro;
3737 int open_flags;
3738 int ret;
3740 bs = qmp_get_root_bs(device, errp);
3741 if (!bs) {
3742 return;
3745 aio_context = bdrv_get_aio_context(bs);
3746 aio_context_acquire(aio_context);
3748 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3749 if (local_err) {
3750 error_propagate(errp, local_err);
3751 goto out;
3754 if (!image_bs) {
3755 error_setg(errp, "image file not found");
3756 goto out;
3759 if (bdrv_find_base(image_bs) == image_bs) {
3760 error_setg(errp, "not allowing backing file change on an image "
3761 "without a backing file");
3762 goto out;
3765 /* even though we are not necessarily operating on bs, we need it to
3766 * determine if block ops are currently prohibited on the chain */
3767 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3768 goto out;
3771 /* final sanity check */
3772 if (!bdrv_chain_contains(bs, image_bs)) {
3773 error_setg(errp, "'%s' and image file are not in the same chain",
3774 device);
3775 goto out;
3778 /* if not r/w, reopen to make r/w */
3779 open_flags = image_bs->open_flags;
3780 ro = bdrv_is_read_only(image_bs);
3782 if (ro) {
3783 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3784 if (local_err) {
3785 error_propagate(errp, local_err);
3786 goto out;
3790 ret = bdrv_change_backing_file(image_bs, backing_file,
3791 image_bs->drv ? image_bs->drv->format_name : "");
3793 if (ret < 0) {
3794 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3795 backing_file);
3796 /* don't exit here, so we can try to restore open flags if
3797 * appropriate */
3800 if (ro) {
3801 bdrv_reopen(image_bs, open_flags, &local_err);
3802 error_propagate(errp, local_err);
3805 out:
3806 aio_context_release(aio_context);
3809 void hmp_drive_add_node(Monitor *mon, const char *optstr)
3811 QemuOpts *opts;
3812 QDict *qdict;
3813 Error *local_err = NULL;
3815 opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
3816 if (!opts) {
3817 return;
3820 qdict = qemu_opts_to_qdict(opts, NULL);
3822 if (!qdict_get_try_str(qdict, "node-name")) {
3823 QDECREF(qdict);
3824 error_report("'node-name' needs to be specified");
3825 goto out;
3828 BlockDriverState *bs = bds_tree_init(qdict, &local_err);
3829 if (!bs) {
3830 error_report_err(local_err);
3831 goto out;
3834 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3836 out:
3837 qemu_opts_del(opts);
3840 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3842 BlockDriverState *bs;
3843 BlockBackend *blk = NULL;
3844 QObject *obj;
3845 Visitor *v = qmp_output_visitor_new(&obj);
3846 QDict *qdict;
3847 Error *local_err = NULL;
3849 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3850 * cache.direct=false instead of silently switching to aio=threads, except
3851 * when called from drive_new().
3853 * For now, simply forbidding the combination for all drivers will do. */
3854 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3855 bool direct = options->has_cache &&
3856 options->cache->has_direct &&
3857 options->cache->direct;
3858 if (!direct) {
3859 error_setg(errp, "aio=native requires cache.direct=true");
3860 goto fail;
3864 visit_type_BlockdevOptions(v, NULL, &options, &local_err);
3865 if (local_err) {
3866 error_propagate(errp, local_err);
3867 goto fail;
3870 visit_complete(v, &obj);
3871 qdict = qobject_to_qdict(obj);
3873 qdict_flatten(qdict);
3875 if (options->has_id) {
3876 blk = blockdev_init(NULL, qdict, &local_err);
3877 if (local_err) {
3878 error_propagate(errp, local_err);
3879 goto fail;
3882 bs = blk_bs(blk);
3883 } else {
3884 if (!qdict_get_try_str(qdict, "node-name")) {
3885 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3886 "the root node");
3887 goto fail;
3890 bs = bds_tree_init(qdict, errp);
3891 if (!bs) {
3892 goto fail;
3895 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3898 if (bs && bdrv_key_required(bs)) {
3899 if (blk) {
3900 monitor_remove_blk(blk);
3901 blk_unref(blk);
3902 } else {
3903 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3904 bdrv_unref(bs);
3906 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3907 goto fail;
3910 fail:
3911 visit_free(v);
3914 void qmp_x_blockdev_del(bool has_id, const char *id,
3915 bool has_node_name, const char *node_name, Error **errp)
3917 AioContext *aio_context;
3918 BlockBackend *blk;
3919 BlockDriverState *bs;
3921 if (has_id && has_node_name) {
3922 error_setg(errp, "Only one of id and node-name must be specified");
3923 return;
3924 } else if (!has_id && !has_node_name) {
3925 error_setg(errp, "No block device specified");
3926 return;
3929 if (has_id) {
3930 /* blk_by_name() never returns a BB that is not owned by the monitor */
3931 blk = blk_by_name(id);
3932 if (!blk) {
3933 error_setg(errp, "Cannot find block backend %s", id);
3934 return;
3936 if (blk_legacy_dinfo(blk)) {
3937 error_setg(errp, "Deleting block backend added with drive-add"
3938 " is not supported");
3939 return;
3941 if (blk_get_refcnt(blk) > 1) {
3942 error_setg(errp, "Block backend %s is in use", id);
3943 return;
3945 bs = blk_bs(blk);
3946 aio_context = blk_get_aio_context(blk);
3947 } else {
3948 blk = NULL;
3949 bs = bdrv_find_node(node_name);
3950 if (!bs) {
3951 error_setg(errp, "Cannot find node %s", node_name);
3952 return;
3954 if (bdrv_has_blk(bs)) {
3955 error_setg(errp, "Node %s is in use by %s",
3956 node_name, bdrv_get_parent_name(bs));
3957 return;
3959 aio_context = bdrv_get_aio_context(bs);
3962 aio_context_acquire(aio_context);
3964 if (bs) {
3965 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3966 goto out;
3969 if (!blk && !bs->monitor_list.tqe_prev) {
3970 error_setg(errp, "Node %s is not owned by the monitor",
3971 bs->node_name);
3972 goto out;
3975 if (bs->refcnt > 1) {
3976 error_setg(errp, "Block device %s is in use",
3977 bdrv_get_device_or_node_name(bs));
3978 goto out;
3982 if (blk) {
3983 monitor_remove_blk(blk);
3984 blk_unref(blk);
3985 } else {
3986 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3987 bdrv_unref(bs);
3990 out:
3991 aio_context_release(aio_context);
3994 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3995 const char *child_name)
3997 BdrvChild *child;
3999 QLIST_FOREACH(child, &parent_bs->children, next) {
4000 if (strcmp(child->name, child_name) == 0) {
4001 return child;
4005 return NULL;
4008 void qmp_x_blockdev_change(const char *parent, bool has_child,
4009 const char *child, bool has_node,
4010 const char *node, Error **errp)
4012 BlockDriverState *parent_bs, *new_bs = NULL;
4013 BdrvChild *p_child;
4015 parent_bs = bdrv_lookup_bs(parent, parent, errp);
4016 if (!parent_bs) {
4017 return;
4020 if (has_child == has_node) {
4021 if (has_child) {
4022 error_setg(errp, "The parameters child and node are in conflict");
4023 } else {
4024 error_setg(errp, "Either child or node must be specified");
4026 return;
4029 if (has_child) {
4030 p_child = bdrv_find_child(parent_bs, child);
4031 if (!p_child) {
4032 error_setg(errp, "Node '%s' does not have child '%s'",
4033 parent, child);
4034 return;
4036 bdrv_del_child(parent_bs, p_child, errp);
4039 if (has_node) {
4040 new_bs = bdrv_find_node(node);
4041 if (!new_bs) {
4042 error_setg(errp, "Node '%s' not found", node);
4043 return;
4045 bdrv_add_child(parent_bs, new_bs, errp);
4049 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4051 BlockJobInfoList *head = NULL, **p_next = &head;
4052 BlockJob *job;
4054 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
4055 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
4056 AioContext *aio_context = blk_get_aio_context(job->blk);
4058 aio_context_acquire(aio_context);
4059 elem->value = block_job_query(job);
4060 aio_context_release(aio_context);
4062 *p_next = elem;
4063 p_next = &elem->next;
4066 return head;
4069 QemuOptsList qemu_common_drive_opts = {
4070 .name = "drive",
4071 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4072 .desc = {
4074 .name = "snapshot",
4075 .type = QEMU_OPT_BOOL,
4076 .help = "enable/disable snapshot mode",
4078 .name = "discard",
4079 .type = QEMU_OPT_STRING,
4080 .help = "discard operation (ignore/off, unmap/on)",
4082 .name = "aio",
4083 .type = QEMU_OPT_STRING,
4084 .help = "host AIO implementation (threads, native)",
4086 .name = BDRV_OPT_CACHE_WB,
4087 .type = QEMU_OPT_BOOL,
4088 .help = "Enable writeback mode",
4090 .name = "format",
4091 .type = QEMU_OPT_STRING,
4092 .help = "disk format (raw, qcow2, ...)",
4094 .name = "rerror",
4095 .type = QEMU_OPT_STRING,
4096 .help = "read error action",
4098 .name = "werror",
4099 .type = QEMU_OPT_STRING,
4100 .help = "write error action",
4102 .name = "read-only",
4103 .type = QEMU_OPT_BOOL,
4104 .help = "open drive file as read-only",
4106 .name = "throttling.iops-total",
4107 .type = QEMU_OPT_NUMBER,
4108 .help = "limit total I/O operations per second",
4110 .name = "throttling.iops-read",
4111 .type = QEMU_OPT_NUMBER,
4112 .help = "limit read operations per second",
4114 .name = "throttling.iops-write",
4115 .type = QEMU_OPT_NUMBER,
4116 .help = "limit write operations per second",
4118 .name = "throttling.bps-total",
4119 .type = QEMU_OPT_NUMBER,
4120 .help = "limit total bytes per second",
4122 .name = "throttling.bps-read",
4123 .type = QEMU_OPT_NUMBER,
4124 .help = "limit read bytes per second",
4126 .name = "throttling.bps-write",
4127 .type = QEMU_OPT_NUMBER,
4128 .help = "limit write bytes per second",
4130 .name = "throttling.iops-total-max",
4131 .type = QEMU_OPT_NUMBER,
4132 .help = "I/O operations burst",
4134 .name = "throttling.iops-read-max",
4135 .type = QEMU_OPT_NUMBER,
4136 .help = "I/O operations read burst",
4138 .name = "throttling.iops-write-max",
4139 .type = QEMU_OPT_NUMBER,
4140 .help = "I/O operations write burst",
4142 .name = "throttling.bps-total-max",
4143 .type = QEMU_OPT_NUMBER,
4144 .help = "total bytes burst",
4146 .name = "throttling.bps-read-max",
4147 .type = QEMU_OPT_NUMBER,
4148 .help = "total bytes read burst",
4150 .name = "throttling.bps-write-max",
4151 .type = QEMU_OPT_NUMBER,
4152 .help = "total bytes write burst",
4154 .name = "throttling.iops-total-max-length",
4155 .type = QEMU_OPT_NUMBER,
4156 .help = "length of the iops-total-max burst period, in seconds",
4158 .name = "throttling.iops-read-max-length",
4159 .type = QEMU_OPT_NUMBER,
4160 .help = "length of the iops-read-max burst period, in seconds",
4162 .name = "throttling.iops-write-max-length",
4163 .type = QEMU_OPT_NUMBER,
4164 .help = "length of the iops-write-max burst period, in seconds",
4166 .name = "throttling.bps-total-max-length",
4167 .type = QEMU_OPT_NUMBER,
4168 .help = "length of the bps-total-max burst period, in seconds",
4170 .name = "throttling.bps-read-max-length",
4171 .type = QEMU_OPT_NUMBER,
4172 .help = "length of the bps-read-max burst period, in seconds",
4174 .name = "throttling.bps-write-max-length",
4175 .type = QEMU_OPT_NUMBER,
4176 .help = "length of the bps-write-max burst period, in seconds",
4178 .name = "throttling.iops-size",
4179 .type = QEMU_OPT_NUMBER,
4180 .help = "when limiting by iops max size of an I/O in bytes",
4182 .name = "throttling.group",
4183 .type = QEMU_OPT_STRING,
4184 .help = "name of the block throttling group",
4186 .name = "copy-on-read",
4187 .type = QEMU_OPT_BOOL,
4188 .help = "copy read data from backing file into image file",
4190 .name = "detect-zeroes",
4191 .type = QEMU_OPT_STRING,
4192 .help = "try to optimize zero writes (off, on, unmap)",
4194 .name = "stats-account-invalid",
4195 .type = QEMU_OPT_BOOL,
4196 .help = "whether to account for invalid I/O operations "
4197 "in the statistics",
4199 .name = "stats-account-failed",
4200 .type = QEMU_OPT_BOOL,
4201 .help = "whether to account for failed I/O operations "
4202 "in the statistics",
4204 { /* end of list */ }
4208 static QemuOptsList qemu_root_bds_opts = {
4209 .name = "root-bds",
4210 .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4211 .desc = {
4213 .name = "discard",
4214 .type = QEMU_OPT_STRING,
4215 .help = "discard operation (ignore/off, unmap/on)",
4217 .name = "aio",
4218 .type = QEMU_OPT_STRING,
4219 .help = "host AIO implementation (threads, native)",
4221 .name = "read-only",
4222 .type = QEMU_OPT_BOOL,
4223 .help = "open drive file as read-only",
4225 .name = "copy-on-read",
4226 .type = QEMU_OPT_BOOL,
4227 .help = "copy read data from backing file into image file",
4229 .name = "detect-zeroes",
4230 .type = QEMU_OPT_STRING,
4231 .help = "try to optimize zero writes (off, on, unmap)",
4233 { /* end of list */ }
4237 QemuOptsList qemu_drive_opts = {
4238 .name = "drive",
4239 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4240 .desc = {
4242 * no elements => accept any params
4243 * validation will happen later
4245 { /* end of list */ }