qemu-iotests/081: Avoid blockdev-add with id
[qemu.git] / blockdev.c
blob405145ae95fcac08f7b6b418b927a32bae306bc6
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 *blk_name, const char *qdev_id,
60 bool force, Error **errp);
62 static const char *const if_name[IF_COUNT] = {
63 [IF_NONE] = "none",
64 [IF_IDE] = "ide",
65 [IF_SCSI] = "scsi",
66 [IF_FLOPPY] = "floppy",
67 [IF_PFLASH] = "pflash",
68 [IF_MTD] = "mtd",
69 [IF_SD] = "sd",
70 [IF_VIRTIO] = "virtio",
71 [IF_XEN] = "xen",
74 static int if_max_devs[IF_COUNT] = {
76 * Do not change these numbers! They govern how drive option
77 * index maps to unit and bus. That mapping is ABI.
79 * All controllers used to implement if=T drives need to support
80 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
81 * Otherwise, some index values map to "impossible" bus, unit
82 * values.
84 * For instance, if you change [IF_SCSI] to 255, -drive
85 * if=scsi,index=12 no longer means bus=1,unit=5, but
86 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
87 * the drive can't be set up. Regression.
89 [IF_IDE] = 2,
90 [IF_SCSI] = 7,
93 /**
94 * Boards may call this to offer board-by-board overrides
95 * of the default, global values.
97 void override_max_devs(BlockInterfaceType type, int max_devs)
99 BlockBackend *blk;
100 DriveInfo *dinfo;
102 if (max_devs <= 0) {
103 return;
106 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
107 dinfo = blk_legacy_dinfo(blk);
108 if (dinfo->type == type) {
109 fprintf(stderr, "Cannot override units-per-bus property of"
110 " the %s interface, because a drive of that type has"
111 " already been added.\n", if_name[type]);
112 g_assert_not_reached();
116 if_max_devs[type] = max_devs;
120 * We automatically delete the drive when a device using it gets
121 * unplugged. Questionable feature, but we can't just drop it.
122 * Device models call blockdev_mark_auto_del() to schedule the
123 * automatic deletion, and generic qdev code calls blockdev_auto_del()
124 * when deletion is actually safe.
126 void blockdev_mark_auto_del(BlockBackend *blk)
128 DriveInfo *dinfo = blk_legacy_dinfo(blk);
129 BlockDriverState *bs = blk_bs(blk);
130 AioContext *aio_context;
132 if (!dinfo) {
133 return;
136 if (bs) {
137 aio_context = bdrv_get_aio_context(bs);
138 aio_context_acquire(aio_context);
140 if (bs->job) {
141 block_job_cancel(bs->job);
144 aio_context_release(aio_context);
147 dinfo->auto_del = 1;
150 void blockdev_auto_del(BlockBackend *blk)
152 DriveInfo *dinfo = blk_legacy_dinfo(blk);
154 if (dinfo && dinfo->auto_del) {
155 monitor_remove_blk(blk);
156 blk_unref(blk);
161 * Returns the current mapping of how many units per bus
162 * a particular interface can support.
164 * A positive integer indicates n units per bus.
165 * 0 implies the mapping has not been established.
166 * -1 indicates an invalid BlockInterfaceType was given.
168 int drive_get_max_devs(BlockInterfaceType type)
170 if (type >= IF_IDE && type < IF_COUNT) {
171 return if_max_devs[type];
174 return -1;
177 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
179 int max_devs = if_max_devs[type];
180 return max_devs ? index / max_devs : 0;
183 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
185 int max_devs = if_max_devs[type];
186 return max_devs ? index % max_devs : index;
189 QemuOpts *drive_def(const char *optstr)
191 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
194 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
195 const char *optstr)
197 QemuOpts *opts;
199 opts = drive_def(optstr);
200 if (!opts) {
201 return NULL;
203 if (type != IF_DEFAULT) {
204 qemu_opt_set(opts, "if", if_name[type], &error_abort);
206 if (index >= 0) {
207 qemu_opt_set_number(opts, "index", index, &error_abort);
209 if (file)
210 qemu_opt_set(opts, "file", file, &error_abort);
211 return opts;
214 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
216 BlockBackend *blk;
217 DriveInfo *dinfo;
219 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
220 dinfo = blk_legacy_dinfo(blk);
221 if (dinfo && dinfo->type == type
222 && dinfo->bus == bus && dinfo->unit == unit) {
223 return dinfo;
227 return NULL;
230 bool drive_check_orphaned(void)
232 BlockBackend *blk;
233 DriveInfo *dinfo;
234 bool rs = false;
236 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
237 dinfo = blk_legacy_dinfo(blk);
238 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
239 /* Unless this is a default drive, this may be an oversight. */
240 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
241 dinfo->type != IF_NONE) {
242 fprintf(stderr, "Warning: Orphaned drive without device: "
243 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
244 blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
245 if_name[dinfo->type], dinfo->bus, dinfo->unit);
246 rs = true;
250 return rs;
253 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
255 return drive_get(type,
256 drive_index_to_bus_id(type, index),
257 drive_index_to_unit_id(type, index));
260 int drive_get_max_bus(BlockInterfaceType type)
262 int max_bus;
263 BlockBackend *blk;
264 DriveInfo *dinfo;
266 max_bus = -1;
267 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
268 dinfo = blk_legacy_dinfo(blk);
269 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
270 max_bus = dinfo->bus;
273 return max_bus;
276 /* Get a block device. This should only be used for single-drive devices
277 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
278 appropriate bus. */
279 DriveInfo *drive_get_next(BlockInterfaceType type)
281 static int next_block_unit[IF_COUNT];
283 return drive_get(type, 0, next_block_unit[type]++);
286 static void bdrv_format_print(void *opaque, const char *name)
288 error_printf(" %s", name);
291 typedef struct {
292 QEMUBH *bh;
293 BlockDriverState *bs;
294 } BDRVPutRefBH;
296 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
298 if (!strcmp(buf, "ignore")) {
299 return BLOCKDEV_ON_ERROR_IGNORE;
300 } else if (!is_read && !strcmp(buf, "enospc")) {
301 return BLOCKDEV_ON_ERROR_ENOSPC;
302 } else if (!strcmp(buf, "stop")) {
303 return BLOCKDEV_ON_ERROR_STOP;
304 } else if (!strcmp(buf, "report")) {
305 return BLOCKDEV_ON_ERROR_REPORT;
306 } else {
307 error_setg(errp, "'%s' invalid %s error action",
308 buf, is_read ? "read" : "write");
309 return -1;
313 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
314 Error **errp)
316 const QListEntry *entry;
317 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
318 switch (qobject_type(entry->value)) {
320 case QTYPE_QSTRING: {
321 unsigned long long length;
322 const char *str = qstring_get_str(qobject_to_qstring(entry->value));
323 if (parse_uint_full(str, &length, 10) == 0 &&
324 length > 0 && length <= UINT_MAX) {
325 block_acct_add_interval(stats, (unsigned) length);
326 } else {
327 error_setg(errp, "Invalid interval length: %s", str);
328 return false;
330 break;
333 case QTYPE_QINT: {
334 int64_t length = qint_get_int(qobject_to_qint(entry->value));
335 if (length > 0 && length <= UINT_MAX) {
336 block_acct_add_interval(stats, (unsigned) length);
337 } else {
338 error_setg(errp, "Invalid interval length: %" PRId64, length);
339 return false;
341 break;
344 default:
345 error_setg(errp, "The specification of stats-intervals is invalid");
346 return false;
349 return true;
352 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
354 /* All parameters but @opts are optional and may be set to NULL. */
355 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
356 const char **throttling_group, ThrottleConfig *throttle_cfg,
357 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
359 const char *discard;
360 Error *local_error = NULL;
361 const char *aio;
363 if (bdrv_flags) {
364 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
365 *bdrv_flags |= BDRV_O_COPY_ON_READ;
368 if ((discard = qemu_opt_get(opts, "discard")) != NULL) {
369 if (bdrv_parse_discard_flags(discard, bdrv_flags) != 0) {
370 error_setg(errp, "Invalid discard option");
371 return;
375 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
376 if (!strcmp(aio, "native")) {
377 *bdrv_flags |= BDRV_O_NATIVE_AIO;
378 } else if (!strcmp(aio, "threads")) {
379 /* this is the default */
380 } else {
381 error_setg(errp, "invalid aio option");
382 return;
387 /* disk I/O throttling */
388 if (throttling_group) {
389 *throttling_group = qemu_opt_get(opts, "throttling.group");
392 if (throttle_cfg) {
393 throttle_config_init(throttle_cfg);
394 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
395 qemu_opt_get_number(opts, "throttling.bps-total", 0);
396 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
397 qemu_opt_get_number(opts, "throttling.bps-read", 0);
398 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
399 qemu_opt_get_number(opts, "throttling.bps-write", 0);
400 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
401 qemu_opt_get_number(opts, "throttling.iops-total", 0);
402 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
403 qemu_opt_get_number(opts, "throttling.iops-read", 0);
404 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
405 qemu_opt_get_number(opts, "throttling.iops-write", 0);
407 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
408 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
409 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
410 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
411 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
412 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
413 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
414 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
415 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
416 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
417 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
418 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
420 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
421 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
422 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
423 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
424 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
425 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
426 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
427 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
428 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
429 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
430 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
431 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
433 throttle_cfg->op_size =
434 qemu_opt_get_number(opts, "throttling.iops-size", 0);
436 if (!throttle_is_valid(throttle_cfg, errp)) {
437 return;
441 if (detect_zeroes) {
442 *detect_zeroes =
443 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
444 qemu_opt_get(opts, "detect-zeroes"),
445 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
446 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
447 &local_error);
448 if (local_error) {
449 error_propagate(errp, local_error);
450 return;
453 if (bdrv_flags &&
454 *detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
455 !(*bdrv_flags & BDRV_O_UNMAP))
457 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
458 "without setting discard operation to unmap");
459 return;
464 /* Takes the ownership of bs_opts */
465 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
466 Error **errp)
468 const char *buf;
469 int bdrv_flags = 0;
470 int on_read_error, on_write_error;
471 bool account_invalid, account_failed;
472 bool writethrough, read_only;
473 BlockBackend *blk;
474 BlockDriverState *bs;
475 ThrottleConfig cfg;
476 int snapshot = 0;
477 Error *error = NULL;
478 QemuOpts *opts;
479 QDict *interval_dict = NULL;
480 QList *interval_list = NULL;
481 const char *id;
482 BlockdevDetectZeroesOptions detect_zeroes =
483 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
484 const char *throttling_group = NULL;
486 /* Check common options by copying from bs_opts to opts, all other options
487 * stay in bs_opts for processing by bdrv_open(). */
488 id = qdict_get_try_str(bs_opts, "id");
489 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
490 if (error) {
491 error_propagate(errp, error);
492 goto err_no_opts;
495 qemu_opts_absorb_qdict(opts, bs_opts, &error);
496 if (error) {
497 error_propagate(errp, error);
498 goto early_err;
501 if (id) {
502 qdict_del(bs_opts, "id");
505 /* extract parameters */
506 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
508 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
509 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
511 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
513 id = qemu_opts_id(opts);
515 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
516 qdict_array_split(interval_dict, &interval_list);
518 if (qdict_size(interval_dict) != 0) {
519 error_setg(errp, "Invalid option stats-intervals.%s",
520 qdict_first(interval_dict)->key);
521 goto early_err;
524 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
525 &detect_zeroes, &error);
526 if (error) {
527 error_propagate(errp, error);
528 goto early_err;
531 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
532 if (is_help_option(buf)) {
533 error_printf("Supported formats:");
534 bdrv_iterate_format(bdrv_format_print, NULL);
535 error_printf("\n");
536 goto early_err;
539 if (qdict_haskey(bs_opts, "driver")) {
540 error_setg(errp, "Cannot specify both 'driver' and 'format'");
541 goto early_err;
543 qdict_put(bs_opts, "driver", qstring_from_str(buf));
546 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
547 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
548 on_write_error = parse_block_error_action(buf, 0, &error);
549 if (error) {
550 error_propagate(errp, error);
551 goto early_err;
555 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
556 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
557 on_read_error = parse_block_error_action(buf, 1, &error);
558 if (error) {
559 error_propagate(errp, error);
560 goto early_err;
564 if (snapshot) {
565 bdrv_flags |= BDRV_O_SNAPSHOT;
568 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
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 = read_only;
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 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
592 read_only ? "on" : "off");
593 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
595 if (runstate_check(RUN_STATE_INMIGRATE)) {
596 bdrv_flags |= BDRV_O_INACTIVE;
599 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
600 if (!blk) {
601 goto err_no_bs_opts;
603 bs = blk_bs(blk);
605 bs->detect_zeroes = detect_zeroes;
607 if (bdrv_key_required(bs)) {
608 autostart = 0;
611 block_acct_init(blk_get_stats(blk), account_invalid, account_failed);
613 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
614 blk_unref(blk);
615 blk = NULL;
616 goto err_no_bs_opts;
620 /* disk I/O throttling */
621 if (throttle_enabled(&cfg)) {
622 if (!throttling_group) {
623 throttling_group = id;
625 blk_io_limits_enable(blk, throttling_group);
626 blk_set_io_limits(blk, &cfg);
629 blk_set_enable_write_cache(blk, !writethrough);
630 blk_set_on_error(blk, on_read_error, on_write_error);
632 if (!monitor_add_blk(blk, id, errp)) {
633 blk_unref(blk);
634 blk = NULL;
635 goto err_no_bs_opts;
638 err_no_bs_opts:
639 qemu_opts_del(opts);
640 QDECREF(interval_dict);
641 QDECREF(interval_list);
642 return blk;
644 early_err:
645 qemu_opts_del(opts);
646 QDECREF(interval_dict);
647 QDECREF(interval_list);
648 err_no_opts:
649 QDECREF(bs_opts);
650 return NULL;
653 static QemuOptsList qemu_root_bds_opts;
655 /* Takes the ownership of bs_opts */
656 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
658 BlockDriverState *bs;
659 QemuOpts *opts;
660 Error *local_error = NULL;
661 BlockdevDetectZeroesOptions detect_zeroes;
662 int bdrv_flags = 0;
664 opts = qemu_opts_create(&qemu_root_bds_opts, NULL, 1, errp);
665 if (!opts) {
666 goto fail;
669 qemu_opts_absorb_qdict(opts, bs_opts, &local_error);
670 if (local_error) {
671 error_propagate(errp, local_error);
672 goto fail;
675 extract_common_blockdev_options(opts, &bdrv_flags, NULL, NULL,
676 &detect_zeroes, &local_error);
677 if (local_error) {
678 error_propagate(errp, local_error);
679 goto fail;
682 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
683 * with other callers) rather than what we want as the real defaults.
684 * Apply the defaults here instead. */
685 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
686 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
687 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
689 if (runstate_check(RUN_STATE_INMIGRATE)) {
690 bdrv_flags |= BDRV_O_INACTIVE;
693 bs = bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
694 if (!bs) {
695 goto fail_no_bs_opts;
698 bs->detect_zeroes = detect_zeroes;
700 fail_no_bs_opts:
701 qemu_opts_del(opts);
702 return bs;
704 fail:
705 qemu_opts_del(opts);
706 QDECREF(bs_opts);
707 return NULL;
710 void blockdev_close_all_bdrv_states(void)
712 BlockDriverState *bs, *next_bs;
714 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
715 AioContext *ctx = bdrv_get_aio_context(bs);
717 aio_context_acquire(ctx);
718 bdrv_unref(bs);
719 aio_context_release(ctx);
723 /* Iterates over the list of monitor-owned BlockDriverStates */
724 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
726 return bs ? QTAILQ_NEXT(bs, monitor_list)
727 : QTAILQ_FIRST(&monitor_bdrv_states);
730 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
731 Error **errp)
733 const char *value;
735 value = qemu_opt_get(opts, from);
736 if (value) {
737 if (qemu_opt_find(opts, to)) {
738 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
739 "same time", to, from);
740 return;
744 /* rename all items in opts */
745 while ((value = qemu_opt_get(opts, from))) {
746 qemu_opt_set(opts, to, value, &error_abort);
747 qemu_opt_unset(opts, from);
751 QemuOptsList qemu_legacy_drive_opts = {
752 .name = "drive",
753 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
754 .desc = {
756 .name = "bus",
757 .type = QEMU_OPT_NUMBER,
758 .help = "bus number",
760 .name = "unit",
761 .type = QEMU_OPT_NUMBER,
762 .help = "unit number (i.e. lun for scsi)",
764 .name = "index",
765 .type = QEMU_OPT_NUMBER,
766 .help = "index number",
768 .name = "media",
769 .type = QEMU_OPT_STRING,
770 .help = "media type (disk, cdrom)",
772 .name = "if",
773 .type = QEMU_OPT_STRING,
774 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
776 .name = "cyls",
777 .type = QEMU_OPT_NUMBER,
778 .help = "number of cylinders (ide disk geometry)",
780 .name = "heads",
781 .type = QEMU_OPT_NUMBER,
782 .help = "number of heads (ide disk geometry)",
784 .name = "secs",
785 .type = QEMU_OPT_NUMBER,
786 .help = "number of sectors (ide disk geometry)",
788 .name = "trans",
789 .type = QEMU_OPT_STRING,
790 .help = "chs translation (auto, lba, none)",
792 .name = "boot",
793 .type = QEMU_OPT_BOOL,
794 .help = "(deprecated, ignored)",
796 .name = "addr",
797 .type = QEMU_OPT_STRING,
798 .help = "pci address (virtio only)",
800 .name = "serial",
801 .type = QEMU_OPT_STRING,
802 .help = "disk serial number",
804 .name = "file",
805 .type = QEMU_OPT_STRING,
806 .help = "file name",
809 /* Options that are passed on, but have special semantics with -drive */
811 .name = BDRV_OPT_READ_ONLY,
812 .type = QEMU_OPT_BOOL,
813 .help = "open drive file as read-only",
815 .name = "rerror",
816 .type = QEMU_OPT_STRING,
817 .help = "read error action",
819 .name = "werror",
820 .type = QEMU_OPT_STRING,
821 .help = "write error action",
823 .name = "copy-on-read",
824 .type = QEMU_OPT_BOOL,
825 .help = "copy read data from backing file into image file",
828 { /* end of list */ }
832 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
834 const char *value;
835 BlockBackend *blk;
836 DriveInfo *dinfo = NULL;
837 QDict *bs_opts;
838 QemuOpts *legacy_opts;
839 DriveMediaType media = MEDIA_DISK;
840 BlockInterfaceType type;
841 int cyls, heads, secs, translation;
842 int max_devs, bus_id, unit_id, index;
843 const char *devaddr;
844 const char *werror, *rerror;
845 bool read_only = false;
846 bool copy_on_read;
847 const char *serial;
848 const char *filename;
849 Error *local_err = NULL;
850 int i;
852 /* Change legacy command line options into QMP ones */
853 static const struct {
854 const char *from;
855 const char *to;
856 } opt_renames[] = {
857 { "iops", "throttling.iops-total" },
858 { "iops_rd", "throttling.iops-read" },
859 { "iops_wr", "throttling.iops-write" },
861 { "bps", "throttling.bps-total" },
862 { "bps_rd", "throttling.bps-read" },
863 { "bps_wr", "throttling.bps-write" },
865 { "iops_max", "throttling.iops-total-max" },
866 { "iops_rd_max", "throttling.iops-read-max" },
867 { "iops_wr_max", "throttling.iops-write-max" },
869 { "bps_max", "throttling.bps-total-max" },
870 { "bps_rd_max", "throttling.bps-read-max" },
871 { "bps_wr_max", "throttling.bps-write-max" },
873 { "iops_size", "throttling.iops-size" },
875 { "group", "throttling.group" },
877 { "readonly", BDRV_OPT_READ_ONLY },
880 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
881 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
882 &local_err);
883 if (local_err) {
884 error_report_err(local_err);
885 return NULL;
889 value = qemu_opt_get(all_opts, "cache");
890 if (value) {
891 int flags = 0;
892 bool writethrough;
894 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
895 error_report("invalid cache option");
896 return NULL;
899 /* Specific options take precedence */
900 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
901 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
902 !writethrough, &error_abort);
904 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
905 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
906 !!(flags & BDRV_O_NOCACHE), &error_abort);
908 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
909 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
910 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
912 qemu_opt_unset(all_opts, "cache");
915 /* Get a QDict for processing the options */
916 bs_opts = qdict_new();
917 qemu_opts_to_qdict(all_opts, bs_opts);
919 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
920 &error_abort);
921 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
922 if (local_err) {
923 error_report_err(local_err);
924 goto fail;
927 /* Deprecated option boot=[on|off] */
928 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
929 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
930 "ignored. Future versions will reject this parameter. Please "
931 "update your scripts.\n");
934 /* Media type */
935 value = qemu_opt_get(legacy_opts, "media");
936 if (value) {
937 if (!strcmp(value, "disk")) {
938 media = MEDIA_DISK;
939 } else if (!strcmp(value, "cdrom")) {
940 media = MEDIA_CDROM;
941 read_only = true;
942 } else {
943 error_report("'%s' invalid media", value);
944 goto fail;
948 /* copy-on-read is disabled with a warning for read-only devices */
949 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
950 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
952 if (read_only && copy_on_read) {
953 error_report("warning: disabling copy-on-read on read-only drive");
954 copy_on_read = false;
957 qdict_put(bs_opts, BDRV_OPT_READ_ONLY,
958 qstring_from_str(read_only ? "on" : "off"));
959 qdict_put(bs_opts, "copy-on-read",
960 qstring_from_str(copy_on_read ? "on" :"off"));
962 /* Controller type */
963 value = qemu_opt_get(legacy_opts, "if");
964 if (value) {
965 for (type = 0;
966 type < IF_COUNT && strcmp(value, if_name[type]);
967 type++) {
969 if (type == IF_COUNT) {
970 error_report("unsupported bus type '%s'", value);
971 goto fail;
973 } else {
974 type = block_default_type;
977 /* Geometry */
978 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
979 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
980 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
982 if (cyls || heads || secs) {
983 if (cyls < 1) {
984 error_report("invalid physical cyls number");
985 goto fail;
987 if (heads < 1) {
988 error_report("invalid physical heads number");
989 goto fail;
991 if (secs < 1) {
992 error_report("invalid physical secs number");
993 goto fail;
997 translation = BIOS_ATA_TRANSLATION_AUTO;
998 value = qemu_opt_get(legacy_opts, "trans");
999 if (value != NULL) {
1000 if (!cyls) {
1001 error_report("'%s' trans must be used with cyls, heads and secs",
1002 value);
1003 goto fail;
1005 if (!strcmp(value, "none")) {
1006 translation = BIOS_ATA_TRANSLATION_NONE;
1007 } else if (!strcmp(value, "lba")) {
1008 translation = BIOS_ATA_TRANSLATION_LBA;
1009 } else if (!strcmp(value, "large")) {
1010 translation = BIOS_ATA_TRANSLATION_LARGE;
1011 } else if (!strcmp(value, "rechs")) {
1012 translation = BIOS_ATA_TRANSLATION_RECHS;
1013 } else if (!strcmp(value, "auto")) {
1014 translation = BIOS_ATA_TRANSLATION_AUTO;
1015 } else {
1016 error_report("'%s' invalid translation type", value);
1017 goto fail;
1021 if (media == MEDIA_CDROM) {
1022 if (cyls || secs || heads) {
1023 error_report("CHS can't be set with media=cdrom");
1024 goto fail;
1028 /* Device address specified by bus/unit or index.
1029 * If none was specified, try to find the first free one. */
1030 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
1031 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
1032 index = qemu_opt_get_number(legacy_opts, "index", -1);
1034 max_devs = if_max_devs[type];
1036 if (index != -1) {
1037 if (bus_id != 0 || unit_id != -1) {
1038 error_report("index cannot be used with bus and unit");
1039 goto fail;
1041 bus_id = drive_index_to_bus_id(type, index);
1042 unit_id = drive_index_to_unit_id(type, index);
1045 if (unit_id == -1) {
1046 unit_id = 0;
1047 while (drive_get(type, bus_id, unit_id) != NULL) {
1048 unit_id++;
1049 if (max_devs && unit_id >= max_devs) {
1050 unit_id -= max_devs;
1051 bus_id++;
1056 if (max_devs && unit_id >= max_devs) {
1057 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
1058 goto fail;
1061 if (drive_get(type, bus_id, unit_id) != NULL) {
1062 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1063 bus_id, unit_id, index);
1064 goto fail;
1067 /* Serial number */
1068 serial = qemu_opt_get(legacy_opts, "serial");
1070 /* no id supplied -> create one */
1071 if (qemu_opts_id(all_opts) == NULL) {
1072 char *new_id;
1073 const char *mediastr = "";
1074 if (type == IF_IDE || type == IF_SCSI) {
1075 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
1077 if (max_devs) {
1078 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
1079 mediastr, unit_id);
1080 } else {
1081 new_id = g_strdup_printf("%s%s%i", if_name[type],
1082 mediastr, unit_id);
1084 qdict_put(bs_opts, "id", qstring_from_str(new_id));
1085 g_free(new_id);
1088 /* Add virtio block device */
1089 devaddr = qemu_opt_get(legacy_opts, "addr");
1090 if (devaddr && type != IF_VIRTIO) {
1091 error_report("addr is not supported by this bus type");
1092 goto fail;
1095 if (type == IF_VIRTIO) {
1096 QemuOpts *devopts;
1097 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
1098 &error_abort);
1099 if (arch_type == QEMU_ARCH_S390X) {
1100 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1101 } else {
1102 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1104 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
1105 &error_abort);
1106 if (devaddr) {
1107 qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1111 filename = qemu_opt_get(legacy_opts, "file");
1113 /* Check werror/rerror compatibility with if=... */
1114 werror = qemu_opt_get(legacy_opts, "werror");
1115 if (werror != NULL) {
1116 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
1117 type != IF_NONE) {
1118 error_report("werror is not supported by this bus type");
1119 goto fail;
1121 qdict_put(bs_opts, "werror", qstring_from_str(werror));
1124 rerror = qemu_opt_get(legacy_opts, "rerror");
1125 if (rerror != NULL) {
1126 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
1127 type != IF_NONE) {
1128 error_report("rerror is not supported by this bus type");
1129 goto fail;
1131 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
1134 /* Actual block device init: Functionality shared with blockdev-add */
1135 blk = blockdev_init(filename, bs_opts, &local_err);
1136 bs_opts = NULL;
1137 if (!blk) {
1138 if (local_err) {
1139 error_report_err(local_err);
1141 goto fail;
1142 } else {
1143 assert(!local_err);
1146 /* Create legacy DriveInfo */
1147 dinfo = g_malloc0(sizeof(*dinfo));
1148 dinfo->opts = all_opts;
1150 dinfo->cyls = cyls;
1151 dinfo->heads = heads;
1152 dinfo->secs = secs;
1153 dinfo->trans = translation;
1155 dinfo->type = type;
1156 dinfo->bus = bus_id;
1157 dinfo->unit = unit_id;
1158 dinfo->devaddr = devaddr;
1159 dinfo->serial = g_strdup(serial);
1161 blk_set_legacy_dinfo(blk, dinfo);
1163 switch(type) {
1164 case IF_IDE:
1165 case IF_SCSI:
1166 case IF_XEN:
1167 case IF_NONE:
1168 dinfo->media_cd = media == MEDIA_CDROM;
1169 break;
1170 default:
1171 break;
1174 fail:
1175 qemu_opts_del(legacy_opts);
1176 QDECREF(bs_opts);
1177 return dinfo;
1180 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1182 BlockDriverState *bs;
1184 bs = bdrv_lookup_bs(name, name, errp);
1185 if (bs == NULL) {
1186 return NULL;
1189 if (!bdrv_is_root_node(bs)) {
1190 error_setg(errp, "Need a root block node");
1191 return NULL;
1194 if (!bdrv_is_inserted(bs)) {
1195 error_setg(errp, "Device has no medium");
1196 return NULL;
1199 return bs;
1202 static BlockBackend *qmp_get_blk(const char *blk_name, const char *qdev_id,
1203 Error **errp)
1205 BlockBackend *blk;
1207 if (!blk_name == !qdev_id) {
1208 error_setg(errp, "Need exactly one of 'device' and 'id'");
1209 return NULL;
1212 if (qdev_id) {
1213 blk = blk_by_qdev_id(qdev_id, errp);
1214 } else {
1215 blk = blk_by_name(blk_name);
1216 if (blk == NULL) {
1217 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1218 "Device '%s' not found", blk_name);
1222 return blk;
1225 void hmp_commit(Monitor *mon, const QDict *qdict)
1227 const char *device = qdict_get_str(qdict, "device");
1228 BlockBackend *blk;
1229 int ret;
1231 if (!strcmp(device, "all")) {
1232 ret = blk_commit_all();
1233 } else {
1234 BlockDriverState *bs;
1235 AioContext *aio_context;
1237 blk = blk_by_name(device);
1238 if (!blk) {
1239 monitor_printf(mon, "Device '%s' not found\n", device);
1240 return;
1242 if (!blk_is_available(blk)) {
1243 monitor_printf(mon, "Device '%s' has no medium\n", device);
1244 return;
1247 bs = blk_bs(blk);
1248 aio_context = bdrv_get_aio_context(bs);
1249 aio_context_acquire(aio_context);
1251 ret = bdrv_commit(bs);
1253 aio_context_release(aio_context);
1255 if (ret < 0) {
1256 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1257 strerror(-ret));
1261 static void blockdev_do_action(TransactionAction *action, Error **errp)
1263 TransactionActionList list;
1265 list.value = action;
1266 list.next = NULL;
1267 qmp_transaction(&list, false, NULL, errp);
1270 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1271 bool has_node_name, const char *node_name,
1272 const char *snapshot_file,
1273 bool has_snapshot_node_name,
1274 const char *snapshot_node_name,
1275 bool has_format, const char *format,
1276 bool has_mode, NewImageMode mode, Error **errp)
1278 BlockdevSnapshotSync snapshot = {
1279 .has_device = has_device,
1280 .device = (char *) device,
1281 .has_node_name = has_node_name,
1282 .node_name = (char *) node_name,
1283 .snapshot_file = (char *) snapshot_file,
1284 .has_snapshot_node_name = has_snapshot_node_name,
1285 .snapshot_node_name = (char *) snapshot_node_name,
1286 .has_format = has_format,
1287 .format = (char *) format,
1288 .has_mode = has_mode,
1289 .mode = mode,
1291 TransactionAction action = {
1292 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1293 .u.blockdev_snapshot_sync.data = &snapshot,
1295 blockdev_do_action(&action, errp);
1298 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1299 Error **errp)
1301 BlockdevSnapshot snapshot_data = {
1302 .node = (char *) node,
1303 .overlay = (char *) overlay
1305 TransactionAction action = {
1306 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1307 .u.blockdev_snapshot.data = &snapshot_data,
1309 blockdev_do_action(&action, errp);
1312 void qmp_blockdev_snapshot_internal_sync(const char *device,
1313 const char *name,
1314 Error **errp)
1316 BlockdevSnapshotInternal snapshot = {
1317 .device = (char *) device,
1318 .name = (char *) name
1320 TransactionAction action = {
1321 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1322 .u.blockdev_snapshot_internal_sync.data = &snapshot,
1324 blockdev_do_action(&action, errp);
1327 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1328 bool has_id,
1329 const char *id,
1330 bool has_name,
1331 const char *name,
1332 Error **errp)
1334 BlockDriverState *bs;
1335 AioContext *aio_context;
1336 QEMUSnapshotInfo sn;
1337 Error *local_err = NULL;
1338 SnapshotInfo *info = NULL;
1339 int ret;
1341 bs = qmp_get_root_bs(device, errp);
1342 if (!bs) {
1343 return NULL;
1345 aio_context = bdrv_get_aio_context(bs);
1346 aio_context_acquire(aio_context);
1348 if (!has_id) {
1349 id = NULL;
1352 if (!has_name) {
1353 name = NULL;
1356 if (!id && !name) {
1357 error_setg(errp, "Name or id must be provided");
1358 goto out_aio_context;
1361 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1362 goto out_aio_context;
1365 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1366 if (local_err) {
1367 error_propagate(errp, local_err);
1368 goto out_aio_context;
1370 if (!ret) {
1371 error_setg(errp,
1372 "Snapshot with id '%s' and name '%s' does not exist on "
1373 "device '%s'",
1374 STR_OR_NULL(id), STR_OR_NULL(name), device);
1375 goto out_aio_context;
1378 bdrv_snapshot_delete(bs, id, name, &local_err);
1379 if (local_err) {
1380 error_propagate(errp, local_err);
1381 goto out_aio_context;
1384 aio_context_release(aio_context);
1386 info = g_new0(SnapshotInfo, 1);
1387 info->id = g_strdup(sn.id_str);
1388 info->name = g_strdup(sn.name);
1389 info->date_nsec = sn.date_nsec;
1390 info->date_sec = sn.date_sec;
1391 info->vm_state_size = sn.vm_state_size;
1392 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1393 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1395 return info;
1397 out_aio_context:
1398 aio_context_release(aio_context);
1399 return NULL;
1403 * block_dirty_bitmap_lookup:
1404 * Return a dirty bitmap (if present), after validating
1405 * the node reference and bitmap names.
1407 * @node: The name of the BDS node to search for bitmaps
1408 * @name: The name of the bitmap to search for
1409 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1410 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1411 * @errp: Output pointer for error information. Can be NULL.
1413 * @return: A bitmap object on success, or NULL on failure.
1415 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1416 const char *name,
1417 BlockDriverState **pbs,
1418 AioContext **paio,
1419 Error **errp)
1421 BlockDriverState *bs;
1422 BdrvDirtyBitmap *bitmap;
1423 AioContext *aio_context;
1425 if (!node) {
1426 error_setg(errp, "Node cannot be NULL");
1427 return NULL;
1429 if (!name) {
1430 error_setg(errp, "Bitmap name cannot be NULL");
1431 return NULL;
1433 bs = bdrv_lookup_bs(node, node, NULL);
1434 if (!bs) {
1435 error_setg(errp, "Node '%s' not found", node);
1436 return NULL;
1439 aio_context = bdrv_get_aio_context(bs);
1440 aio_context_acquire(aio_context);
1442 bitmap = bdrv_find_dirty_bitmap(bs, name);
1443 if (!bitmap) {
1444 error_setg(errp, "Dirty bitmap '%s' not found", name);
1445 goto fail;
1448 if (pbs) {
1449 *pbs = bs;
1451 if (paio) {
1452 *paio = aio_context;
1453 } else {
1454 aio_context_release(aio_context);
1457 return bitmap;
1459 fail:
1460 aio_context_release(aio_context);
1461 return NULL;
1464 /* New and old BlockDriverState structs for atomic group operations */
1466 typedef struct BlkActionState BlkActionState;
1469 * BlkActionOps:
1470 * Table of operations that define an Action.
1472 * @instance_size: Size of state struct, in bytes.
1473 * @prepare: Prepare the work, must NOT be NULL.
1474 * @commit: Commit the changes, can be NULL.
1475 * @abort: Abort the changes on fail, can be NULL.
1476 * @clean: Clean up resources after all transaction actions have called
1477 * commit() or abort(). Can be NULL.
1479 * Only prepare() may fail. In a single transaction, only one of commit() or
1480 * abort() will be called. clean() will always be called if it is present.
1482 typedef struct BlkActionOps {
1483 size_t instance_size;
1484 void (*prepare)(BlkActionState *common, Error **errp);
1485 void (*commit)(BlkActionState *common);
1486 void (*abort)(BlkActionState *common);
1487 void (*clean)(BlkActionState *common);
1488 } BlkActionOps;
1491 * BlkActionState:
1492 * Describes one Action's state within a Transaction.
1494 * @action: QAPI-defined enum identifying which Action to perform.
1495 * @ops: Table of ActionOps this Action can perform.
1496 * @block_job_txn: Transaction which this action belongs to.
1497 * @entry: List membership for all Actions in this Transaction.
1499 * This structure must be arranged as first member in a subclassed type,
1500 * assuming that the compiler will also arrange it to the same offsets as the
1501 * base class.
1503 struct BlkActionState {
1504 TransactionAction *action;
1505 const BlkActionOps *ops;
1506 BlockJobTxn *block_job_txn;
1507 TransactionProperties *txn_props;
1508 QSIMPLEQ_ENTRY(BlkActionState) entry;
1511 /* internal snapshot private data */
1512 typedef struct InternalSnapshotState {
1513 BlkActionState common;
1514 BlockDriverState *bs;
1515 AioContext *aio_context;
1516 QEMUSnapshotInfo sn;
1517 bool created;
1518 } InternalSnapshotState;
1521 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1523 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1524 error_setg(errp,
1525 "Action '%s' does not support Transaction property "
1526 "completion-mode = %s",
1527 TransactionActionKind_lookup[s->action->type],
1528 ActionCompletionMode_lookup[s->txn_props->completion_mode]);
1529 return -1;
1531 return 0;
1534 static void internal_snapshot_prepare(BlkActionState *common,
1535 Error **errp)
1537 Error *local_err = NULL;
1538 const char *device;
1539 const char *name;
1540 BlockDriverState *bs;
1541 QEMUSnapshotInfo old_sn, *sn;
1542 bool ret;
1543 qemu_timeval tv;
1544 BlockdevSnapshotInternal *internal;
1545 InternalSnapshotState *state;
1546 int ret1;
1548 g_assert(common->action->type ==
1549 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1550 internal = common->action->u.blockdev_snapshot_internal_sync.data;
1551 state = DO_UPCAST(InternalSnapshotState, common, common);
1553 /* 1. parse input */
1554 device = internal->device;
1555 name = internal->name;
1557 /* 2. check for validation */
1558 if (action_check_completion_mode(common, errp) < 0) {
1559 return;
1562 bs = qmp_get_root_bs(device, errp);
1563 if (!bs) {
1564 return;
1567 /* AioContext is released in .clean() */
1568 state->aio_context = bdrv_get_aio_context(bs);
1569 aio_context_acquire(state->aio_context);
1571 state->bs = bs;
1572 bdrv_drained_begin(bs);
1574 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1575 return;
1578 if (bdrv_is_read_only(bs)) {
1579 error_setg(errp, "Device '%s' is read only", device);
1580 return;
1583 if (!bdrv_can_snapshot(bs)) {
1584 error_setg(errp, "Block format '%s' used by device '%s' "
1585 "does not support internal snapshots",
1586 bs->drv->format_name, device);
1587 return;
1590 if (!strlen(name)) {
1591 error_setg(errp, "Name is empty");
1592 return;
1595 /* check whether a snapshot with name exist */
1596 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1597 &local_err);
1598 if (local_err) {
1599 error_propagate(errp, local_err);
1600 return;
1601 } else if (ret) {
1602 error_setg(errp,
1603 "Snapshot with name '%s' already exists on device '%s'",
1604 name, device);
1605 return;
1608 /* 3. take the snapshot */
1609 sn = &state->sn;
1610 pstrcpy(sn->name, sizeof(sn->name), name);
1611 qemu_gettimeofday(&tv);
1612 sn->date_sec = tv.tv_sec;
1613 sn->date_nsec = tv.tv_usec * 1000;
1614 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1616 ret1 = bdrv_snapshot_create(bs, sn);
1617 if (ret1 < 0) {
1618 error_setg_errno(errp, -ret1,
1619 "Failed to create snapshot '%s' on device '%s'",
1620 name, device);
1621 return;
1624 /* 4. succeed, mark a snapshot is created */
1625 state->created = true;
1628 static void internal_snapshot_abort(BlkActionState *common)
1630 InternalSnapshotState *state =
1631 DO_UPCAST(InternalSnapshotState, common, common);
1632 BlockDriverState *bs = state->bs;
1633 QEMUSnapshotInfo *sn = &state->sn;
1634 Error *local_error = NULL;
1636 if (!state->created) {
1637 return;
1640 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1641 error_reportf_err(local_error,
1642 "Failed to delete snapshot with id '%s' and "
1643 "name '%s' on device '%s' in abort: ",
1644 sn->id_str, sn->name,
1645 bdrv_get_device_name(bs));
1649 static void internal_snapshot_clean(BlkActionState *common)
1651 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1652 common, common);
1654 if (state->aio_context) {
1655 if (state->bs) {
1656 bdrv_drained_end(state->bs);
1658 aio_context_release(state->aio_context);
1662 /* external snapshot private data */
1663 typedef struct ExternalSnapshotState {
1664 BlkActionState common;
1665 BlockDriverState *old_bs;
1666 BlockDriverState *new_bs;
1667 AioContext *aio_context;
1668 } ExternalSnapshotState;
1670 static void external_snapshot_prepare(BlkActionState *common,
1671 Error **errp)
1673 int flags = 0;
1674 QDict *options = NULL;
1675 Error *local_err = NULL;
1676 /* Device and node name of the image to generate the snapshot from */
1677 const char *device;
1678 const char *node_name;
1679 /* Reference to the new image (for 'blockdev-snapshot') */
1680 const char *snapshot_ref;
1681 /* File name of the new image (for 'blockdev-snapshot-sync') */
1682 const char *new_image_file;
1683 ExternalSnapshotState *state =
1684 DO_UPCAST(ExternalSnapshotState, common, common);
1685 TransactionAction *action = common->action;
1687 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1688 * purpose but a different set of parameters */
1689 switch (action->type) {
1690 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1692 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1693 device = s->node;
1694 node_name = s->node;
1695 new_image_file = NULL;
1696 snapshot_ref = s->overlay;
1698 break;
1699 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1701 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1702 device = s->has_device ? s->device : NULL;
1703 node_name = s->has_node_name ? s->node_name : NULL;
1704 new_image_file = s->snapshot_file;
1705 snapshot_ref = NULL;
1707 break;
1708 default:
1709 g_assert_not_reached();
1712 /* start processing */
1713 if (action_check_completion_mode(common, errp) < 0) {
1714 return;
1717 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1718 if (!state->old_bs) {
1719 return;
1722 /* Acquire AioContext now so any threads operating on old_bs stop */
1723 state->aio_context = bdrv_get_aio_context(state->old_bs);
1724 aio_context_acquire(state->aio_context);
1725 bdrv_drained_begin(state->old_bs);
1727 if (!bdrv_is_inserted(state->old_bs)) {
1728 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1729 return;
1732 if (bdrv_op_is_blocked(state->old_bs,
1733 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1734 return;
1737 if (!bdrv_is_read_only(state->old_bs)) {
1738 if (bdrv_flush(state->old_bs)) {
1739 error_setg(errp, QERR_IO_ERROR);
1740 return;
1744 if (!bdrv_is_first_non_filter(state->old_bs)) {
1745 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1746 return;
1749 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1750 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1751 const char *format = s->has_format ? s->format : "qcow2";
1752 enum NewImageMode mode;
1753 const char *snapshot_node_name =
1754 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1756 if (node_name && !snapshot_node_name) {
1757 error_setg(errp, "New snapshot node name missing");
1758 return;
1761 if (snapshot_node_name &&
1762 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1763 error_setg(errp, "New snapshot node name already in use");
1764 return;
1767 flags = state->old_bs->open_flags;
1768 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1770 /* create new image w/backing file */
1771 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1772 if (mode != NEW_IMAGE_MODE_EXISTING) {
1773 int64_t size = bdrv_getlength(state->old_bs);
1774 if (size < 0) {
1775 error_setg_errno(errp, -size, "bdrv_getlength failed");
1776 return;
1778 bdrv_img_create(new_image_file, format,
1779 state->old_bs->filename,
1780 state->old_bs->drv->format_name,
1781 NULL, size, flags, &local_err, false);
1782 if (local_err) {
1783 error_propagate(errp, local_err);
1784 return;
1788 options = qdict_new();
1789 if (s->has_snapshot_node_name) {
1790 qdict_put(options, "node-name",
1791 qstring_from_str(snapshot_node_name));
1793 qdict_put(options, "driver", qstring_from_str(format));
1795 flags |= BDRV_O_NO_BACKING;
1798 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1799 errp);
1800 /* We will manually add the backing_hd field to the bs later */
1801 if (!state->new_bs) {
1802 return;
1805 if (bdrv_has_blk(state->new_bs)) {
1806 error_setg(errp, "The snapshot is already in use by %s",
1807 bdrv_get_parent_name(state->new_bs));
1808 return;
1811 if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
1812 errp)) {
1813 return;
1816 if (state->new_bs->backing != NULL) {
1817 error_setg(errp, "The snapshot already has a backing image");
1818 return;
1821 if (!state->new_bs->drv->supports_backing) {
1822 error_setg(errp, "The snapshot does not support backing images");
1826 static void external_snapshot_commit(BlkActionState *common)
1828 ExternalSnapshotState *state =
1829 DO_UPCAST(ExternalSnapshotState, common, common);
1831 bdrv_set_aio_context(state->new_bs, state->aio_context);
1833 /* This removes our old bs and adds the new bs */
1834 bdrv_append(state->new_bs, state->old_bs);
1835 /* We don't need (or want) to use the transactional
1836 * bdrv_reopen_multiple() across all the entries at once, because we
1837 * don't want to abort all of them if one of them fails the reopen */
1838 if (!state->old_bs->copy_on_read) {
1839 bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1840 NULL);
1844 static void external_snapshot_abort(BlkActionState *common)
1846 ExternalSnapshotState *state =
1847 DO_UPCAST(ExternalSnapshotState, common, common);
1848 if (state->new_bs) {
1849 bdrv_unref(state->new_bs);
1853 static void external_snapshot_clean(BlkActionState *common)
1855 ExternalSnapshotState *state =
1856 DO_UPCAST(ExternalSnapshotState, common, common);
1857 if (state->aio_context) {
1858 bdrv_drained_end(state->old_bs);
1859 aio_context_release(state->aio_context);
1863 typedef struct DriveBackupState {
1864 BlkActionState common;
1865 BlockDriverState *bs;
1866 AioContext *aio_context;
1867 BlockJob *job;
1868 } DriveBackupState;
1870 static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn,
1871 Error **errp);
1873 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1875 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1876 BlockDriverState *bs;
1877 DriveBackup *backup;
1878 Error *local_err = NULL;
1880 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1881 backup = common->action->u.drive_backup.data;
1883 bs = qmp_get_root_bs(backup->device, errp);
1884 if (!bs) {
1885 return;
1888 /* AioContext is released in .clean() */
1889 state->aio_context = bdrv_get_aio_context(bs);
1890 aio_context_acquire(state->aio_context);
1891 bdrv_drained_begin(bs);
1892 state->bs = bs;
1894 do_drive_backup(backup, common->block_job_txn, &local_err);
1895 if (local_err) {
1896 error_propagate(errp, local_err);
1897 return;
1900 state->job = state->bs->job;
1903 static void drive_backup_abort(BlkActionState *common)
1905 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1906 BlockDriverState *bs = state->bs;
1908 /* Only cancel if it's the job we started */
1909 if (bs && bs->job && bs->job == state->job) {
1910 block_job_cancel_sync(bs->job);
1914 static void drive_backup_clean(BlkActionState *common)
1916 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1918 if (state->aio_context) {
1919 bdrv_drained_end(state->bs);
1920 aio_context_release(state->aio_context);
1924 typedef struct BlockdevBackupState {
1925 BlkActionState common;
1926 BlockDriverState *bs;
1927 BlockJob *job;
1928 AioContext *aio_context;
1929 } BlockdevBackupState;
1931 static void do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn,
1932 Error **errp);
1934 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1936 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1937 BlockdevBackup *backup;
1938 BlockDriverState *bs, *target;
1939 Error *local_err = NULL;
1941 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1942 backup = common->action->u.blockdev_backup.data;
1944 bs = qmp_get_root_bs(backup->device, errp);
1945 if (!bs) {
1946 return;
1949 target = bdrv_lookup_bs(backup->target, backup->target, errp);
1950 if (!target) {
1951 return;
1954 /* AioContext is released in .clean() */
1955 state->aio_context = bdrv_get_aio_context(bs);
1956 if (state->aio_context != bdrv_get_aio_context(target)) {
1957 state->aio_context = NULL;
1958 error_setg(errp, "Backup between two IO threads is not implemented");
1959 return;
1961 aio_context_acquire(state->aio_context);
1962 state->bs = bs;
1963 bdrv_drained_begin(state->bs);
1965 do_blockdev_backup(backup, common->block_job_txn, &local_err);
1966 if (local_err) {
1967 error_propagate(errp, local_err);
1968 return;
1971 state->job = state->bs->job;
1974 static void blockdev_backup_abort(BlkActionState *common)
1976 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1977 BlockDriverState *bs = state->bs;
1979 /* Only cancel if it's the job we started */
1980 if (bs && bs->job && bs->job == state->job) {
1981 block_job_cancel_sync(bs->job);
1985 static void blockdev_backup_clean(BlkActionState *common)
1987 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1989 if (state->aio_context) {
1990 bdrv_drained_end(state->bs);
1991 aio_context_release(state->aio_context);
1995 typedef struct BlockDirtyBitmapState {
1996 BlkActionState common;
1997 BdrvDirtyBitmap *bitmap;
1998 BlockDriverState *bs;
1999 AioContext *aio_context;
2000 HBitmap *backup;
2001 bool prepared;
2002 } BlockDirtyBitmapState;
2004 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
2005 Error **errp)
2007 Error *local_err = NULL;
2008 BlockDirtyBitmapAdd *action;
2009 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2010 common, common);
2012 if (action_check_completion_mode(common, errp) < 0) {
2013 return;
2016 action = common->action->u.block_dirty_bitmap_add.data;
2017 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2018 qmp_block_dirty_bitmap_add(action->node, action->name,
2019 action->has_granularity, action->granularity,
2020 &local_err);
2022 if (!local_err) {
2023 state->prepared = true;
2024 } else {
2025 error_propagate(errp, local_err);
2029 static void block_dirty_bitmap_add_abort(BlkActionState *common)
2031 BlockDirtyBitmapAdd *action;
2032 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2033 common, common);
2035 action = common->action->u.block_dirty_bitmap_add.data;
2036 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2037 * then the node reference and bitmap name must have been valid.
2039 if (state->prepared) {
2040 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2044 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
2045 Error **errp)
2047 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2048 common, common);
2049 BlockDirtyBitmap *action;
2051 if (action_check_completion_mode(common, errp) < 0) {
2052 return;
2055 action = common->action->u.block_dirty_bitmap_clear.data;
2056 state->bitmap = block_dirty_bitmap_lookup(action->node,
2057 action->name,
2058 &state->bs,
2059 &state->aio_context,
2060 errp);
2061 if (!state->bitmap) {
2062 return;
2065 if (bdrv_dirty_bitmap_frozen(state->bitmap)) {
2066 error_setg(errp, "Cannot modify a frozen bitmap");
2067 return;
2068 } else if (!bdrv_dirty_bitmap_enabled(state->bitmap)) {
2069 error_setg(errp, "Cannot clear a disabled bitmap");
2070 return;
2073 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2074 /* AioContext is released in .clean() */
2077 static void block_dirty_bitmap_clear_abort(BlkActionState *common)
2079 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2080 common, common);
2082 bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
2085 static void block_dirty_bitmap_clear_commit(BlkActionState *common)
2087 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2088 common, common);
2090 hbitmap_free(state->backup);
2093 static void block_dirty_bitmap_clear_clean(BlkActionState *common)
2095 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2096 common, common);
2098 if (state->aio_context) {
2099 aio_context_release(state->aio_context);
2103 static void abort_prepare(BlkActionState *common, Error **errp)
2105 error_setg(errp, "Transaction aborted using Abort action");
2108 static void abort_commit(BlkActionState *common)
2110 g_assert_not_reached(); /* this action never succeeds */
2113 static const BlkActionOps actions[] = {
2114 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2115 .instance_size = sizeof(ExternalSnapshotState),
2116 .prepare = external_snapshot_prepare,
2117 .commit = external_snapshot_commit,
2118 .abort = external_snapshot_abort,
2119 .clean = external_snapshot_clean,
2121 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2122 .instance_size = sizeof(ExternalSnapshotState),
2123 .prepare = external_snapshot_prepare,
2124 .commit = external_snapshot_commit,
2125 .abort = external_snapshot_abort,
2126 .clean = external_snapshot_clean,
2128 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2129 .instance_size = sizeof(DriveBackupState),
2130 .prepare = drive_backup_prepare,
2131 .abort = drive_backup_abort,
2132 .clean = drive_backup_clean,
2134 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2135 .instance_size = sizeof(BlockdevBackupState),
2136 .prepare = blockdev_backup_prepare,
2137 .abort = blockdev_backup_abort,
2138 .clean = blockdev_backup_clean,
2140 [TRANSACTION_ACTION_KIND_ABORT] = {
2141 .instance_size = sizeof(BlkActionState),
2142 .prepare = abort_prepare,
2143 .commit = abort_commit,
2145 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2146 .instance_size = sizeof(InternalSnapshotState),
2147 .prepare = internal_snapshot_prepare,
2148 .abort = internal_snapshot_abort,
2149 .clean = internal_snapshot_clean,
2151 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2152 .instance_size = sizeof(BlockDirtyBitmapState),
2153 .prepare = block_dirty_bitmap_add_prepare,
2154 .abort = block_dirty_bitmap_add_abort,
2156 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2157 .instance_size = sizeof(BlockDirtyBitmapState),
2158 .prepare = block_dirty_bitmap_clear_prepare,
2159 .commit = block_dirty_bitmap_clear_commit,
2160 .abort = block_dirty_bitmap_clear_abort,
2161 .clean = block_dirty_bitmap_clear_clean,
2166 * Allocate a TransactionProperties structure if necessary, and fill
2167 * that structure with desired defaults if they are unset.
2169 static TransactionProperties *get_transaction_properties(
2170 TransactionProperties *props)
2172 if (!props) {
2173 props = g_new0(TransactionProperties, 1);
2176 if (!props->has_completion_mode) {
2177 props->has_completion_mode = true;
2178 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2181 return props;
2185 * 'Atomic' group operations. The operations are performed as a set, and if
2186 * any fail then we roll back all operations in the group.
2188 void qmp_transaction(TransactionActionList *dev_list,
2189 bool has_props,
2190 struct TransactionProperties *props,
2191 Error **errp)
2193 TransactionActionList *dev_entry = dev_list;
2194 BlockJobTxn *block_job_txn = NULL;
2195 BlkActionState *state, *next;
2196 Error *local_err = NULL;
2198 QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2199 QSIMPLEQ_INIT(&snap_bdrv_states);
2201 /* Does this transaction get canceled as a group on failure?
2202 * If not, we don't really need to make a BlockJobTxn.
2204 props = get_transaction_properties(props);
2205 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2206 block_job_txn = block_job_txn_new();
2209 /* drain all i/o before any operations */
2210 bdrv_drain_all();
2212 /* We don't do anything in this loop that commits us to the operations */
2213 while (NULL != dev_entry) {
2214 TransactionAction *dev_info = NULL;
2215 const BlkActionOps *ops;
2217 dev_info = dev_entry->value;
2218 dev_entry = dev_entry->next;
2220 assert(dev_info->type < ARRAY_SIZE(actions));
2222 ops = &actions[dev_info->type];
2223 assert(ops->instance_size > 0);
2225 state = g_malloc0(ops->instance_size);
2226 state->ops = ops;
2227 state->action = dev_info;
2228 state->block_job_txn = block_job_txn;
2229 state->txn_props = props;
2230 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2232 state->ops->prepare(state, &local_err);
2233 if (local_err) {
2234 error_propagate(errp, local_err);
2235 goto delete_and_fail;
2239 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2240 if (state->ops->commit) {
2241 state->ops->commit(state);
2245 /* success */
2246 goto exit;
2248 delete_and_fail:
2249 /* failure, and it is all-or-none; roll back all operations */
2250 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2251 if (state->ops->abort) {
2252 state->ops->abort(state);
2255 exit:
2256 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2257 if (state->ops->clean) {
2258 state->ops->clean(state);
2260 g_free(state);
2262 if (!has_props) {
2263 qapi_free_TransactionProperties(props);
2265 block_job_txn_unref(block_job_txn);
2268 void qmp_eject(bool has_device, const char *device,
2269 bool has_id, const char *id,
2270 bool has_force, bool force, Error **errp)
2272 Error *local_err = NULL;
2273 int rc;
2275 if (!has_force) {
2276 force = false;
2279 rc = do_open_tray(has_device ? device : NULL,
2280 has_id ? id : NULL,
2281 force, &local_err);
2282 if (rc && rc != -ENOSYS) {
2283 error_propagate(errp, local_err);
2284 return;
2286 error_free(local_err);
2288 qmp_x_blockdev_remove_medium(has_device, device, has_id, id, errp);
2291 void qmp_block_passwd(bool has_device, const char *device,
2292 bool has_node_name, const char *node_name,
2293 const char *password, Error **errp)
2295 Error *local_err = NULL;
2296 BlockDriverState *bs;
2297 AioContext *aio_context;
2299 bs = bdrv_lookup_bs(has_device ? device : NULL,
2300 has_node_name ? node_name : NULL,
2301 &local_err);
2302 if (local_err) {
2303 error_propagate(errp, local_err);
2304 return;
2307 aio_context = bdrv_get_aio_context(bs);
2308 aio_context_acquire(aio_context);
2310 bdrv_add_key(bs, password, errp);
2312 aio_context_release(aio_context);
2316 * Attempt to open the tray of @device.
2317 * If @force, ignore its tray lock.
2318 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2319 * On error, store an error through @errp and return -errno.
2320 * If @device does not exist, return -ENODEV.
2321 * If it has no removable media, return -ENOTSUP.
2322 * If it has no tray, return -ENOSYS.
2323 * If the guest was asked to open the tray, return -EINPROGRESS.
2324 * Else, return 0.
2326 static int do_open_tray(const char *blk_name, const char *qdev_id,
2327 bool force, Error **errp)
2329 BlockBackend *blk;
2330 const char *device = qdev_id ?: blk_name;
2331 bool locked;
2333 blk = qmp_get_blk(blk_name, qdev_id, errp);
2334 if (!blk) {
2335 return -ENODEV;
2338 if (!blk_dev_has_removable_media(blk)) {
2339 error_setg(errp, "Device '%s' is not removable", device);
2340 return -ENOTSUP;
2343 if (!blk_dev_has_tray(blk)) {
2344 error_setg(errp, "Device '%s' does not have a tray", device);
2345 return -ENOSYS;
2348 if (blk_dev_is_tray_open(blk)) {
2349 return 0;
2352 locked = blk_dev_is_medium_locked(blk);
2353 if (locked) {
2354 blk_dev_eject_request(blk, force);
2357 if (!locked || force) {
2358 blk_dev_change_media_cb(blk, false);
2361 if (locked && !force) {
2362 error_setg(errp, "Device '%s' is locked and force was not specified, "
2363 "wait for tray to open and try again", device);
2364 return -EINPROGRESS;
2367 return 0;
2370 void qmp_blockdev_open_tray(bool has_device, const char *device,
2371 bool has_id, const char *id,
2372 bool has_force, bool force,
2373 Error **errp)
2375 Error *local_err = NULL;
2376 int rc;
2378 if (!has_force) {
2379 force = false;
2381 rc = do_open_tray(has_device ? device : NULL,
2382 has_id ? id : NULL,
2383 force, &local_err);
2384 if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2385 error_propagate(errp, local_err);
2386 return;
2388 error_free(local_err);
2391 void qmp_blockdev_close_tray(bool has_device, const char *device,
2392 bool has_id, const char *id,
2393 Error **errp)
2395 BlockBackend *blk;
2397 device = has_device ? device : NULL;
2398 id = has_id ? id : NULL;
2400 blk = qmp_get_blk(device, id, errp);
2401 if (!blk) {
2402 return;
2405 if (!blk_dev_has_removable_media(blk)) {
2406 error_setg(errp, "Device '%s' is not removable", device ?: id);
2407 return;
2410 if (!blk_dev_has_tray(blk)) {
2411 /* Ignore this command on tray-less devices */
2412 return;
2415 if (!blk_dev_is_tray_open(blk)) {
2416 return;
2419 blk_dev_change_media_cb(blk, true);
2422 void qmp_x_blockdev_remove_medium(bool has_device, const char *device,
2423 bool has_id, const char *id, Error **errp)
2425 BlockBackend *blk;
2426 BlockDriverState *bs;
2427 AioContext *aio_context;
2428 bool has_attached_device;
2430 device = has_device ? device : NULL;
2431 id = has_id ? id : NULL;
2433 blk = qmp_get_blk(device, id, errp);
2434 if (!blk) {
2435 return;
2438 /* For BBs without a device, we can exchange the BDS tree at will */
2439 has_attached_device = blk_get_attached_dev(blk);
2441 if (has_attached_device && !blk_dev_has_removable_media(blk)) {
2442 error_setg(errp, "Device '%s' is not removable", device ?: id);
2443 return;
2446 if (has_attached_device && blk_dev_has_tray(blk) &&
2447 !blk_dev_is_tray_open(blk))
2449 error_setg(errp, "Tray of device '%s' is not open", device ?: id);
2450 return;
2453 bs = blk_bs(blk);
2454 if (!bs) {
2455 return;
2458 aio_context = bdrv_get_aio_context(bs);
2459 aio_context_acquire(aio_context);
2461 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2462 goto out;
2465 blk_remove_bs(blk);
2467 if (!blk_dev_has_tray(blk)) {
2468 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2469 * called at all); therefore, the medium needs to be ejected here.
2470 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2471 * value passed here (i.e. false). */
2472 blk_dev_change_media_cb(blk, false);
2475 out:
2476 aio_context_release(aio_context);
2479 static void qmp_blockdev_insert_anon_medium(BlockBackend *blk,
2480 BlockDriverState *bs, Error **errp)
2482 bool has_device;
2484 /* For BBs without a device, we can exchange the BDS tree at will */
2485 has_device = blk_get_attached_dev(blk);
2487 if (has_device && !blk_dev_has_removable_media(blk)) {
2488 error_setg(errp, "Device is not removable");
2489 return;
2492 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2493 error_setg(errp, "Tray of the device is not open");
2494 return;
2497 if (blk_bs(blk)) {
2498 error_setg(errp, "There already is a medium in the device");
2499 return;
2502 blk_insert_bs(blk, bs);
2504 if (!blk_dev_has_tray(blk)) {
2505 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2506 * called at all); therefore, the medium needs to be pushed into the
2507 * slot here.
2508 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2509 * value passed here (i.e. true). */
2510 blk_dev_change_media_cb(blk, true);
2514 void qmp_x_blockdev_insert_medium(bool has_device, const char *device,
2515 bool has_id, const char *id,
2516 const char *node_name, Error **errp)
2518 BlockBackend *blk;
2519 BlockDriverState *bs;
2521 blk = qmp_get_blk(has_device ? device : NULL,
2522 has_id ? id : NULL,
2523 errp);
2524 if (!blk) {
2525 return;
2528 bs = bdrv_find_node(node_name);
2529 if (!bs) {
2530 error_setg(errp, "Node '%s' not found", node_name);
2531 return;
2534 if (bdrv_has_blk(bs)) {
2535 error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
2536 bdrv_get_parent_name(bs));
2537 return;
2540 qmp_blockdev_insert_anon_medium(blk, bs, errp);
2543 void qmp_blockdev_change_medium(bool has_device, const char *device,
2544 bool has_id, const char *id,
2545 const char *filename,
2546 bool has_format, const char *format,
2547 bool has_read_only,
2548 BlockdevChangeReadOnlyMode read_only,
2549 Error **errp)
2551 BlockBackend *blk;
2552 BlockDriverState *medium_bs = NULL;
2553 int bdrv_flags;
2554 int rc;
2555 QDict *options = NULL;
2556 Error *err = NULL;
2558 blk = qmp_get_blk(has_device ? device : NULL,
2559 has_id ? id : NULL,
2560 errp);
2561 if (!blk) {
2562 goto fail;
2565 if (blk_bs(blk)) {
2566 blk_update_root_state(blk);
2569 bdrv_flags = blk_get_open_flags_from_root_state(blk);
2570 bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2571 BDRV_O_PROTOCOL);
2573 if (!has_read_only) {
2574 read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2577 switch (read_only) {
2578 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2579 break;
2581 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2582 bdrv_flags &= ~BDRV_O_RDWR;
2583 break;
2585 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2586 bdrv_flags |= BDRV_O_RDWR;
2587 break;
2589 default:
2590 abort();
2593 if (has_format) {
2594 options = qdict_new();
2595 qdict_put(options, "driver", qstring_from_str(format));
2598 medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2599 if (!medium_bs) {
2600 goto fail;
2603 bdrv_add_key(medium_bs, NULL, &err);
2604 if (err) {
2605 error_propagate(errp, err);
2606 goto fail;
2609 rc = do_open_tray(has_device ? device : NULL,
2610 has_id ? id : NULL,
2611 false, &err);
2612 if (rc && rc != -ENOSYS) {
2613 error_propagate(errp, err);
2614 goto fail;
2616 error_free(err);
2617 err = NULL;
2619 qmp_x_blockdev_remove_medium(has_device, device, has_id, id, errp);
2620 if (err) {
2621 error_propagate(errp, err);
2622 goto fail;
2625 qmp_blockdev_insert_anon_medium(blk, medium_bs, &err);
2626 if (err) {
2627 error_propagate(errp, err);
2628 goto fail;
2631 blk_apply_root_state(blk, medium_bs);
2633 qmp_blockdev_close_tray(has_device, device, has_id, id, errp);
2635 fail:
2636 /* If the medium has been inserted, the device has its own reference, so
2637 * ours must be relinquished; and if it has not been inserted successfully,
2638 * the reference must be relinquished anyway */
2639 bdrv_unref(medium_bs);
2642 /* throttling disk I/O limits */
2643 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2645 ThrottleConfig cfg;
2646 BlockDriverState *bs;
2647 BlockBackend *blk;
2648 AioContext *aio_context;
2650 blk = qmp_get_blk(arg->has_device ? arg->device : NULL,
2651 arg->has_id ? arg->id : NULL,
2652 errp);
2653 if (!blk) {
2654 return;
2657 aio_context = blk_get_aio_context(blk);
2658 aio_context_acquire(aio_context);
2660 bs = blk_bs(blk);
2661 if (!bs) {
2662 error_setg(errp, "Device has no medium");
2663 goto out;
2666 throttle_config_init(&cfg);
2667 cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2668 cfg.buckets[THROTTLE_BPS_READ].avg = arg->bps_rd;
2669 cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2671 cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2672 cfg.buckets[THROTTLE_OPS_READ].avg = arg->iops_rd;
2673 cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2675 if (arg->has_bps_max) {
2676 cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2678 if (arg->has_bps_rd_max) {
2679 cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2681 if (arg->has_bps_wr_max) {
2682 cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2684 if (arg->has_iops_max) {
2685 cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2687 if (arg->has_iops_rd_max) {
2688 cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2690 if (arg->has_iops_wr_max) {
2691 cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2694 if (arg->has_bps_max_length) {
2695 cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2697 if (arg->has_bps_rd_max_length) {
2698 cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2700 if (arg->has_bps_wr_max_length) {
2701 cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2703 if (arg->has_iops_max_length) {
2704 cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2706 if (arg->has_iops_rd_max_length) {
2707 cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2709 if (arg->has_iops_wr_max_length) {
2710 cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2713 if (arg->has_iops_size) {
2714 cfg.op_size = arg->iops_size;
2717 if (!throttle_is_valid(&cfg, errp)) {
2718 goto out;
2721 if (throttle_enabled(&cfg)) {
2722 /* Enable I/O limits if they're not enabled yet, otherwise
2723 * just update the throttling group. */
2724 if (!blk_get_public(blk)->throttle_state) {
2725 blk_io_limits_enable(blk,
2726 arg->has_group ? arg->group :
2727 arg->has_device ? arg->device :
2728 arg->id);
2729 } else if (arg->has_group) {
2730 blk_io_limits_update_group(blk, arg->group);
2732 /* Set the new throttling configuration */
2733 blk_set_io_limits(blk, &cfg);
2734 } else if (blk_get_public(blk)->throttle_state) {
2735 /* If all throttling settings are set to 0, disable I/O limits */
2736 blk_io_limits_disable(blk);
2739 out:
2740 aio_context_release(aio_context);
2743 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2744 bool has_granularity, uint32_t granularity,
2745 Error **errp)
2747 AioContext *aio_context;
2748 BlockDriverState *bs;
2750 if (!name || name[0] == '\0') {
2751 error_setg(errp, "Bitmap name cannot be empty");
2752 return;
2755 bs = bdrv_lookup_bs(node, node, errp);
2756 if (!bs) {
2757 return;
2760 aio_context = bdrv_get_aio_context(bs);
2761 aio_context_acquire(aio_context);
2763 if (has_granularity) {
2764 if (granularity < 512 || !is_power_of_2(granularity)) {
2765 error_setg(errp, "Granularity must be power of 2 "
2766 "and at least 512");
2767 goto out;
2769 } else {
2770 /* Default to cluster size, if available: */
2771 granularity = bdrv_get_default_bitmap_granularity(bs);
2774 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2776 out:
2777 aio_context_release(aio_context);
2780 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2781 Error **errp)
2783 AioContext *aio_context;
2784 BlockDriverState *bs;
2785 BdrvDirtyBitmap *bitmap;
2787 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2788 if (!bitmap || !bs) {
2789 return;
2792 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2793 error_setg(errp,
2794 "Bitmap '%s' is currently frozen and cannot be removed",
2795 name);
2796 goto out;
2798 bdrv_dirty_bitmap_make_anon(bitmap);
2799 bdrv_release_dirty_bitmap(bs, bitmap);
2801 out:
2802 aio_context_release(aio_context);
2806 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2807 * immediately after a full backup operation.
2809 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2810 Error **errp)
2812 AioContext *aio_context;
2813 BdrvDirtyBitmap *bitmap;
2814 BlockDriverState *bs;
2816 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2817 if (!bitmap || !bs) {
2818 return;
2821 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2822 error_setg(errp,
2823 "Bitmap '%s' is currently frozen and cannot be modified",
2824 name);
2825 goto out;
2826 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2827 error_setg(errp,
2828 "Bitmap '%s' is currently disabled and cannot be cleared",
2829 name);
2830 goto out;
2833 bdrv_clear_dirty_bitmap(bitmap, NULL);
2835 out:
2836 aio_context_release(aio_context);
2839 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2841 const char *id = qdict_get_str(qdict, "id");
2842 BlockBackend *blk;
2843 BlockDriverState *bs;
2844 AioContext *aio_context;
2845 Error *local_err = NULL;
2847 bs = bdrv_find_node(id);
2848 if (bs) {
2849 qmp_x_blockdev_del(false, NULL, true, id, &local_err);
2850 if (local_err) {
2851 error_report_err(local_err);
2853 return;
2856 blk = blk_by_name(id);
2857 if (!blk) {
2858 error_report("Device '%s' not found", id);
2859 return;
2862 if (!blk_legacy_dinfo(blk)) {
2863 error_report("Deleting device added with blockdev-add"
2864 " is not supported");
2865 return;
2868 aio_context = blk_get_aio_context(blk);
2869 aio_context_acquire(aio_context);
2871 bs = blk_bs(blk);
2872 if (bs) {
2873 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2874 error_report_err(local_err);
2875 aio_context_release(aio_context);
2876 return;
2879 blk_remove_bs(blk);
2882 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2883 monitor_remove_blk(blk);
2885 /* If this BlockBackend has a device attached to it, its refcount will be
2886 * decremented when the device is removed; otherwise we have to do so here.
2888 if (blk_get_attached_dev(blk)) {
2889 /* Further I/O must not pause the guest */
2890 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2891 BLOCKDEV_ON_ERROR_REPORT);
2892 } else {
2893 blk_unref(blk);
2896 aio_context_release(aio_context);
2899 void qmp_block_resize(bool has_device, const char *device,
2900 bool has_node_name, const char *node_name,
2901 int64_t size, Error **errp)
2903 Error *local_err = NULL;
2904 BlockDriverState *bs;
2905 AioContext *aio_context;
2906 int ret;
2908 bs = bdrv_lookup_bs(has_device ? device : NULL,
2909 has_node_name ? node_name : NULL,
2910 &local_err);
2911 if (local_err) {
2912 error_propagate(errp, local_err);
2913 return;
2916 aio_context = bdrv_get_aio_context(bs);
2917 aio_context_acquire(aio_context);
2919 if (!bdrv_is_first_non_filter(bs)) {
2920 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2921 goto out;
2924 if (size < 0) {
2925 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2926 goto out;
2929 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2930 error_setg(errp, QERR_DEVICE_IN_USE, device);
2931 goto out;
2934 /* complete all in-flight operations before resizing the device */
2935 bdrv_drain_all();
2937 ret = bdrv_truncate(bs, size);
2938 switch (ret) {
2939 case 0:
2940 break;
2941 case -ENOMEDIUM:
2942 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2943 break;
2944 case -ENOTSUP:
2945 error_setg(errp, QERR_UNSUPPORTED);
2946 break;
2947 case -EACCES:
2948 error_setg(errp, "Device '%s' is read only", device);
2949 break;
2950 case -EBUSY:
2951 error_setg(errp, QERR_DEVICE_IN_USE, device);
2952 break;
2953 default:
2954 error_setg_errno(errp, -ret, "Could not resize");
2955 break;
2958 out:
2959 aio_context_release(aio_context);
2962 static void block_job_cb(void *opaque, int ret)
2964 /* Note that this function may be executed from another AioContext besides
2965 * the QEMU main loop. If you need to access anything that assumes the
2966 * QEMU global mutex, use a BH or introduce a mutex.
2969 BlockDriverState *bs = opaque;
2970 const char *msg = NULL;
2972 trace_block_job_cb(bs, bs->job, ret);
2974 assert(bs->job);
2976 if (ret < 0) {
2977 msg = strerror(-ret);
2980 if (block_job_is_cancelled(bs->job)) {
2981 block_job_event_cancelled(bs->job);
2982 } else {
2983 block_job_event_completed(bs->job, msg);
2987 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
2988 bool has_base, const char *base,
2989 bool has_backing_file, const char *backing_file,
2990 bool has_speed, int64_t speed,
2991 bool has_on_error, BlockdevOnError on_error,
2992 Error **errp)
2994 BlockDriverState *bs;
2995 BlockDriverState *base_bs = NULL;
2996 AioContext *aio_context;
2997 Error *local_err = NULL;
2998 const char *base_name = NULL;
3000 if (!has_on_error) {
3001 on_error = BLOCKDEV_ON_ERROR_REPORT;
3004 bs = qmp_get_root_bs(device, errp);
3005 if (!bs) {
3006 return;
3009 aio_context = bdrv_get_aio_context(bs);
3010 aio_context_acquire(aio_context);
3012 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
3013 goto out;
3016 if (has_base) {
3017 base_bs = bdrv_find_backing_image(bs, base);
3018 if (base_bs == NULL) {
3019 error_setg(errp, QERR_BASE_NOT_FOUND, base);
3020 goto out;
3022 assert(bdrv_get_aio_context(base_bs) == aio_context);
3023 base_name = base;
3026 /* if we are streaming the entire chain, the result will have no backing
3027 * file, and specifying one is therefore an error */
3028 if (base_bs == NULL && has_backing_file) {
3029 error_setg(errp, "backing file specified, but streaming the "
3030 "entire chain");
3031 goto out;
3034 /* backing_file string overrides base bs filename */
3035 base_name = has_backing_file ? backing_file : base_name;
3037 stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
3038 has_speed ? speed : 0, on_error, block_job_cb, bs, &local_err);
3039 if (local_err) {
3040 error_propagate(errp, local_err);
3041 goto out;
3044 trace_qmp_block_stream(bs, bs->job);
3046 out:
3047 aio_context_release(aio_context);
3050 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3051 bool has_base, const char *base,
3052 bool has_top, const char *top,
3053 bool has_backing_file, const char *backing_file,
3054 bool has_speed, int64_t speed,
3055 Error **errp)
3057 BlockDriverState *bs;
3058 BlockDriverState *base_bs, *top_bs;
3059 AioContext *aio_context;
3060 Error *local_err = NULL;
3061 /* This will be part of the QMP command, if/when the
3062 * BlockdevOnError change for blkmirror makes it in
3064 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3066 if (!has_speed) {
3067 speed = 0;
3070 /* Important Note:
3071 * libvirt relies on the DeviceNotFound error class in order to probe for
3072 * live commit feature versions; for this to work, we must make sure to
3073 * perform the device lookup before any generic errors that may occur in a
3074 * scenario in which all optional arguments are omitted. */
3075 bs = qmp_get_root_bs(device, &local_err);
3076 if (!bs) {
3077 bs = bdrv_lookup_bs(device, device, NULL);
3078 if (!bs) {
3079 error_free(local_err);
3080 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3081 "Device '%s' not found", device);
3082 } else {
3083 error_propagate(errp, local_err);
3085 return;
3088 aio_context = bdrv_get_aio_context(bs);
3089 aio_context_acquire(aio_context);
3091 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3092 goto out;
3095 /* default top_bs is the active layer */
3096 top_bs = bs;
3098 if (has_top && top) {
3099 if (strcmp(bs->filename, top) != 0) {
3100 top_bs = bdrv_find_backing_image(bs, top);
3104 if (top_bs == NULL) {
3105 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3106 goto out;
3109 assert(bdrv_get_aio_context(top_bs) == aio_context);
3111 if (has_base && base) {
3112 base_bs = bdrv_find_backing_image(top_bs, base);
3113 } else {
3114 base_bs = bdrv_find_base(top_bs);
3117 if (base_bs == NULL) {
3118 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3119 goto out;
3122 assert(bdrv_get_aio_context(base_bs) == aio_context);
3124 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3125 goto out;
3128 /* Do not allow attempts to commit an image into itself */
3129 if (top_bs == base_bs) {
3130 error_setg(errp, "cannot commit an image into itself");
3131 goto out;
3134 if (top_bs == bs) {
3135 if (has_backing_file) {
3136 error_setg(errp, "'backing-file' specified,"
3137 " but 'top' is the active layer");
3138 goto out;
3140 commit_active_start(has_job_id ? job_id : NULL, bs, base_bs, speed,
3141 on_error, block_job_cb, bs, &local_err, false);
3142 } else {
3143 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, speed,
3144 on_error, block_job_cb, bs,
3145 has_backing_file ? backing_file : NULL, &local_err);
3147 if (local_err != NULL) {
3148 error_propagate(errp, local_err);
3149 goto out;
3152 out:
3153 aio_context_release(aio_context);
3156 static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn, Error **errp)
3158 BlockDriverState *bs;
3159 BlockDriverState *target_bs;
3160 BlockDriverState *source = NULL;
3161 BdrvDirtyBitmap *bmap = NULL;
3162 AioContext *aio_context;
3163 QDict *options = NULL;
3164 Error *local_err = NULL;
3165 int flags;
3166 int64_t size;
3168 if (!backup->has_speed) {
3169 backup->speed = 0;
3171 if (!backup->has_on_source_error) {
3172 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3174 if (!backup->has_on_target_error) {
3175 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3177 if (!backup->has_mode) {
3178 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3180 if (!backup->has_job_id) {
3181 backup->job_id = NULL;
3183 if (!backup->has_compress) {
3184 backup->compress = false;
3187 bs = qmp_get_root_bs(backup->device, errp);
3188 if (!bs) {
3189 return;
3192 aio_context = bdrv_get_aio_context(bs);
3193 aio_context_acquire(aio_context);
3195 if (!backup->has_format) {
3196 backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
3197 NULL : (char*) bs->drv->format_name;
3200 /* Early check to avoid creating target */
3201 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3202 goto out;
3205 flags = bs->open_flags | BDRV_O_RDWR;
3207 /* See if we have a backing HD we can use to create our new image
3208 * on top of. */
3209 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3210 source = backing_bs(bs);
3211 if (!source) {
3212 backup->sync = MIRROR_SYNC_MODE_FULL;
3215 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3216 source = bs;
3219 size = bdrv_getlength(bs);
3220 if (size < 0) {
3221 error_setg_errno(errp, -size, "bdrv_getlength failed");
3222 goto out;
3225 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
3226 assert(backup->format);
3227 if (source) {
3228 bdrv_img_create(backup->target, backup->format, source->filename,
3229 source->drv->format_name, NULL,
3230 size, flags, &local_err, false);
3231 } else {
3232 bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3233 size, flags, &local_err, false);
3237 if (local_err) {
3238 error_propagate(errp, local_err);
3239 goto out;
3242 if (backup->format) {
3243 options = qdict_new();
3244 qdict_put(options, "driver", qstring_from_str(backup->format));
3247 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
3248 if (!target_bs) {
3249 goto out;
3252 bdrv_set_aio_context(target_bs, aio_context);
3254 if (backup->has_bitmap) {
3255 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3256 if (!bmap) {
3257 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3258 bdrv_unref(target_bs);
3259 goto out;
3263 backup_start(backup->job_id, bs, target_bs, backup->speed, backup->sync,
3264 bmap, backup->compress, backup->on_source_error,
3265 backup->on_target_error, block_job_cb, bs, txn, &local_err);
3266 bdrv_unref(target_bs);
3267 if (local_err != NULL) {
3268 error_propagate(errp, local_err);
3269 goto out;
3272 out:
3273 aio_context_release(aio_context);
3276 void qmp_drive_backup(DriveBackup *arg, Error **errp)
3278 return do_drive_backup(arg, NULL, errp);
3281 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3283 return bdrv_named_nodes_list(errp);
3286 void do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn, Error **errp)
3288 BlockDriverState *bs;
3289 BlockDriverState *target_bs;
3290 Error *local_err = NULL;
3291 AioContext *aio_context;
3293 if (!backup->has_speed) {
3294 backup->speed = 0;
3296 if (!backup->has_on_source_error) {
3297 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3299 if (!backup->has_on_target_error) {
3300 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3302 if (!backup->has_job_id) {
3303 backup->job_id = NULL;
3305 if (!backup->has_compress) {
3306 backup->compress = false;
3309 bs = qmp_get_root_bs(backup->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(backup->target, backup->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(backup->job_id, bs, target_bs, backup->speed, backup->sync,
3334 NULL, backup->compress, backup->on_source_error,
3335 backup->on_target_error, block_job_cb, bs, txn, &local_err);
3336 if (local_err != NULL) {
3337 error_propagate(errp, local_err);
3339 out:
3340 aio_context_release(aio_context);
3343 void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
3345 do_blockdev_backup(arg, NULL, errp);
3348 /* Parameter check and block job starting for drive mirroring.
3349 * Caller should hold @device and @target's aio context (must be the same).
3351 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3352 BlockDriverState *target,
3353 bool has_replaces, const char *replaces,
3354 enum MirrorSyncMode sync,
3355 BlockMirrorBackingMode backing_mode,
3356 bool has_speed, int64_t speed,
3357 bool has_granularity, uint32_t granularity,
3358 bool has_buf_size, int64_t buf_size,
3359 bool has_on_source_error,
3360 BlockdevOnError on_source_error,
3361 bool has_on_target_error,
3362 BlockdevOnError on_target_error,
3363 bool has_unmap, bool unmap,
3364 Error **errp)
3367 if (!has_speed) {
3368 speed = 0;
3370 if (!has_on_source_error) {
3371 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3373 if (!has_on_target_error) {
3374 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3376 if (!has_granularity) {
3377 granularity = 0;
3379 if (!has_buf_size) {
3380 buf_size = 0;
3382 if (!has_unmap) {
3383 unmap = true;
3386 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3387 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3388 "a value in range [512B, 64MB]");
3389 return;
3391 if (granularity & (granularity - 1)) {
3392 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3393 "power of 2");
3394 return;
3397 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3398 return;
3400 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3401 return;
3404 if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3405 sync = MIRROR_SYNC_MODE_FULL;
3408 /* pass the node name to replace to mirror start since it's loose coupling
3409 * and will allow to check whether the node still exist at mirror completion
3411 mirror_start(job_id, bs, target,
3412 has_replaces ? replaces : NULL,
3413 speed, granularity, buf_size, sync, backing_mode,
3414 on_source_error, on_target_error, unmap,
3415 block_job_cb, bs, errp);
3418 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3420 BlockDriverState *bs;
3421 BlockDriverState *source, *target_bs;
3422 AioContext *aio_context;
3423 BlockMirrorBackingMode backing_mode;
3424 Error *local_err = NULL;
3425 QDict *options = NULL;
3426 int flags;
3427 int64_t size;
3428 const char *format = arg->format;
3430 bs = qmp_get_root_bs(arg->device, errp);
3431 if (!bs) {
3432 return;
3435 aio_context = bdrv_get_aio_context(bs);
3436 aio_context_acquire(aio_context);
3438 if (!arg->has_mode) {
3439 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3442 if (!arg->has_format) {
3443 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3444 ? NULL : bs->drv->format_name);
3447 flags = bs->open_flags | BDRV_O_RDWR;
3448 source = backing_bs(bs);
3449 if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3450 arg->sync = MIRROR_SYNC_MODE_FULL;
3452 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3453 source = bs;
3456 size = bdrv_getlength(bs);
3457 if (size < 0) {
3458 error_setg_errno(errp, -size, "bdrv_getlength failed");
3459 goto out;
3462 if (arg->has_replaces) {
3463 BlockDriverState *to_replace_bs;
3464 AioContext *replace_aio_context;
3465 int64_t replace_size;
3467 if (!arg->has_node_name) {
3468 error_setg(errp, "a node-name must be provided when replacing a"
3469 " named node of the graph");
3470 goto out;
3473 to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3475 if (!to_replace_bs) {
3476 error_propagate(errp, local_err);
3477 goto out;
3480 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3481 aio_context_acquire(replace_aio_context);
3482 replace_size = bdrv_getlength(to_replace_bs);
3483 aio_context_release(replace_aio_context);
3485 if (size != replace_size) {
3486 error_setg(errp, "cannot replace image with a mirror image of "
3487 "different size");
3488 goto out;
3492 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3493 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3494 } else {
3495 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3498 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3499 && arg->mode != NEW_IMAGE_MODE_EXISTING)
3501 /* create new image w/o backing file */
3502 assert(format);
3503 bdrv_img_create(arg->target, format,
3504 NULL, NULL, NULL, size, flags, &local_err, false);
3505 } else {
3506 switch (arg->mode) {
3507 case NEW_IMAGE_MODE_EXISTING:
3508 break;
3509 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3510 /* create new image with backing file */
3511 bdrv_img_create(arg->target, format,
3512 source->filename,
3513 source->drv->format_name,
3514 NULL, size, flags, &local_err, false);
3515 break;
3516 default:
3517 abort();
3521 if (local_err) {
3522 error_propagate(errp, local_err);
3523 goto out;
3526 options = qdict_new();
3527 if (arg->has_node_name) {
3528 qdict_put(options, "node-name", qstring_from_str(arg->node_name));
3530 if (format) {
3531 qdict_put(options, "driver", qstring_from_str(format));
3534 /* Mirroring takes care of copy-on-write using the source's backing
3535 * file.
3537 target_bs = bdrv_open(arg->target, NULL, options,
3538 flags | BDRV_O_NO_BACKING, errp);
3539 if (!target_bs) {
3540 goto out;
3543 bdrv_set_aio_context(target_bs, aio_context);
3545 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3546 arg->has_replaces, arg->replaces, arg->sync,
3547 backing_mode, arg->has_speed, arg->speed,
3548 arg->has_granularity, arg->granularity,
3549 arg->has_buf_size, arg->buf_size,
3550 arg->has_on_source_error, arg->on_source_error,
3551 arg->has_on_target_error, arg->on_target_error,
3552 arg->has_unmap, arg->unmap,
3553 &local_err);
3554 bdrv_unref(target_bs);
3555 error_propagate(errp, local_err);
3556 out:
3557 aio_context_release(aio_context);
3560 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3561 const char *device, const char *target,
3562 bool has_replaces, const char *replaces,
3563 MirrorSyncMode sync,
3564 bool has_speed, int64_t speed,
3565 bool has_granularity, uint32_t granularity,
3566 bool has_buf_size, int64_t buf_size,
3567 bool has_on_source_error,
3568 BlockdevOnError on_source_error,
3569 bool has_on_target_error,
3570 BlockdevOnError on_target_error,
3571 Error **errp)
3573 BlockDriverState *bs;
3574 BlockDriverState *target_bs;
3575 AioContext *aio_context;
3576 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3577 Error *local_err = NULL;
3579 bs = qmp_get_root_bs(device, errp);
3580 if (!bs) {
3581 return;
3584 target_bs = bdrv_lookup_bs(target, target, errp);
3585 if (!target_bs) {
3586 return;
3589 aio_context = bdrv_get_aio_context(bs);
3590 aio_context_acquire(aio_context);
3592 bdrv_set_aio_context(target_bs, aio_context);
3594 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3595 has_replaces, replaces, sync, backing_mode,
3596 has_speed, speed,
3597 has_granularity, granularity,
3598 has_buf_size, buf_size,
3599 has_on_source_error, on_source_error,
3600 has_on_target_error, on_target_error,
3601 true, true,
3602 &local_err);
3603 error_propagate(errp, local_err);
3605 aio_context_release(aio_context);
3608 /* Get a block job using its ID and acquire its AioContext */
3609 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3610 Error **errp)
3612 BlockJob *job;
3614 assert(id != NULL);
3616 *aio_context = NULL;
3618 job = block_job_get(id);
3620 if (!job) {
3621 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3622 "Block job '%s' not found", id);
3623 return NULL;
3626 *aio_context = blk_get_aio_context(job->blk);
3627 aio_context_acquire(*aio_context);
3629 return job;
3632 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3634 AioContext *aio_context;
3635 BlockJob *job = find_block_job(device, &aio_context, errp);
3637 if (!job) {
3638 return;
3641 block_job_set_speed(job, speed, errp);
3642 aio_context_release(aio_context);
3645 void qmp_block_job_cancel(const char *device,
3646 bool has_force, bool force, Error **errp)
3648 AioContext *aio_context;
3649 BlockJob *job = find_block_job(device, &aio_context, errp);
3651 if (!job) {
3652 return;
3655 if (!has_force) {
3656 force = false;
3659 if (job->user_paused && !force) {
3660 error_setg(errp, "The block job for device '%s' is currently paused",
3661 device);
3662 goto out;
3665 trace_qmp_block_job_cancel(job);
3666 block_job_cancel(job);
3667 out:
3668 aio_context_release(aio_context);
3671 void qmp_block_job_pause(const char *device, Error **errp)
3673 AioContext *aio_context;
3674 BlockJob *job = find_block_job(device, &aio_context, errp);
3676 if (!job || job->user_paused) {
3677 return;
3680 job->user_paused = true;
3681 trace_qmp_block_job_pause(job);
3682 block_job_pause(job);
3683 aio_context_release(aio_context);
3686 void qmp_block_job_resume(const char *device, Error **errp)
3688 AioContext *aio_context;
3689 BlockJob *job = find_block_job(device, &aio_context, errp);
3691 if (!job || !job->user_paused) {
3692 return;
3695 job->user_paused = false;
3696 trace_qmp_block_job_resume(job);
3697 block_job_iostatus_reset(job);
3698 block_job_resume(job);
3699 aio_context_release(aio_context);
3702 void qmp_block_job_complete(const char *device, Error **errp)
3704 AioContext *aio_context;
3705 BlockJob *job = find_block_job(device, &aio_context, errp);
3707 if (!job) {
3708 return;
3711 trace_qmp_block_job_complete(job);
3712 block_job_complete(job, errp);
3713 aio_context_release(aio_context);
3716 void qmp_change_backing_file(const char *device,
3717 const char *image_node_name,
3718 const char *backing_file,
3719 Error **errp)
3721 BlockDriverState *bs = NULL;
3722 AioContext *aio_context;
3723 BlockDriverState *image_bs = NULL;
3724 Error *local_err = NULL;
3725 bool ro;
3726 int open_flags;
3727 int ret;
3729 bs = qmp_get_root_bs(device, errp);
3730 if (!bs) {
3731 return;
3734 aio_context = bdrv_get_aio_context(bs);
3735 aio_context_acquire(aio_context);
3737 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3738 if (local_err) {
3739 error_propagate(errp, local_err);
3740 goto out;
3743 if (!image_bs) {
3744 error_setg(errp, "image file not found");
3745 goto out;
3748 if (bdrv_find_base(image_bs) == image_bs) {
3749 error_setg(errp, "not allowing backing file change on an image "
3750 "without a backing file");
3751 goto out;
3754 /* even though we are not necessarily operating on bs, we need it to
3755 * determine if block ops are currently prohibited on the chain */
3756 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3757 goto out;
3760 /* final sanity check */
3761 if (!bdrv_chain_contains(bs, image_bs)) {
3762 error_setg(errp, "'%s' and image file are not in the same chain",
3763 device);
3764 goto out;
3767 /* if not r/w, reopen to make r/w */
3768 open_flags = image_bs->open_flags;
3769 ro = bdrv_is_read_only(image_bs);
3771 if (ro) {
3772 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3773 if (local_err) {
3774 error_propagate(errp, local_err);
3775 goto out;
3779 ret = bdrv_change_backing_file(image_bs, backing_file,
3780 image_bs->drv ? image_bs->drv->format_name : "");
3782 if (ret < 0) {
3783 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3784 backing_file);
3785 /* don't exit here, so we can try to restore open flags if
3786 * appropriate */
3789 if (ro) {
3790 bdrv_reopen(image_bs, open_flags, &local_err);
3791 error_propagate(errp, local_err);
3794 out:
3795 aio_context_release(aio_context);
3798 void hmp_drive_add_node(Monitor *mon, const char *optstr)
3800 QemuOpts *opts;
3801 QDict *qdict;
3802 Error *local_err = NULL;
3804 opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
3805 if (!opts) {
3806 return;
3809 qdict = qemu_opts_to_qdict(opts, NULL);
3811 if (!qdict_get_try_str(qdict, "node-name")) {
3812 QDECREF(qdict);
3813 error_report("'node-name' needs to be specified");
3814 goto out;
3817 BlockDriverState *bs = bds_tree_init(qdict, &local_err);
3818 if (!bs) {
3819 error_report_err(local_err);
3820 goto out;
3823 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3825 out:
3826 qemu_opts_del(opts);
3829 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3831 BlockDriverState *bs;
3832 BlockBackend *blk = NULL;
3833 QObject *obj;
3834 Visitor *v = qmp_output_visitor_new(&obj);
3835 QDict *qdict;
3836 Error *local_err = NULL;
3838 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3839 * cache.direct=false instead of silently switching to aio=threads, except
3840 * when called from drive_new().
3842 * For now, simply forbidding the combination for all drivers will do. */
3843 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3844 bool direct = options->has_cache &&
3845 options->cache->has_direct &&
3846 options->cache->direct;
3847 if (!direct) {
3848 error_setg(errp, "aio=native requires cache.direct=true");
3849 goto fail;
3853 visit_type_BlockdevOptions(v, NULL, &options, &local_err);
3854 if (local_err) {
3855 error_propagate(errp, local_err);
3856 goto fail;
3859 visit_complete(v, &obj);
3860 qdict = qobject_to_qdict(obj);
3862 qdict_flatten(qdict);
3864 if (options->has_id) {
3865 blk = blockdev_init(NULL, qdict, &local_err);
3866 if (local_err) {
3867 error_propagate(errp, local_err);
3868 goto fail;
3871 bs = blk_bs(blk);
3872 } else {
3873 if (!qdict_get_try_str(qdict, "node-name")) {
3874 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3875 "the root node");
3876 goto fail;
3879 bs = bds_tree_init(qdict, errp);
3880 if (!bs) {
3881 goto fail;
3884 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3887 if (bs && bdrv_key_required(bs)) {
3888 if (blk) {
3889 monitor_remove_blk(blk);
3890 blk_unref(blk);
3891 } else {
3892 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3893 bdrv_unref(bs);
3895 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3896 goto fail;
3899 fail:
3900 visit_free(v);
3903 void qmp_x_blockdev_del(bool has_id, const char *id,
3904 bool has_node_name, const char *node_name, Error **errp)
3906 AioContext *aio_context;
3907 BlockBackend *blk;
3908 BlockDriverState *bs;
3910 if (has_id && has_node_name) {
3911 error_setg(errp, "Only one of id and node-name must be specified");
3912 return;
3913 } else if (!has_id && !has_node_name) {
3914 error_setg(errp, "No block device specified");
3915 return;
3918 if (has_id) {
3919 /* blk_by_name() never returns a BB that is not owned by the monitor */
3920 blk = blk_by_name(id);
3921 if (!blk) {
3922 error_setg(errp, "Cannot find block backend %s", id);
3923 return;
3925 if (blk_legacy_dinfo(blk)) {
3926 error_setg(errp, "Deleting block backend added with drive-add"
3927 " is not supported");
3928 return;
3930 if (blk_get_refcnt(blk) > 1) {
3931 error_setg(errp, "Block backend %s is in use", id);
3932 return;
3934 bs = blk_bs(blk);
3935 aio_context = blk_get_aio_context(blk);
3936 } else {
3937 blk = NULL;
3938 bs = bdrv_find_node(node_name);
3939 if (!bs) {
3940 error_setg(errp, "Cannot find node %s", node_name);
3941 return;
3943 if (bdrv_has_blk(bs)) {
3944 error_setg(errp, "Node %s is in use by %s",
3945 node_name, bdrv_get_parent_name(bs));
3946 return;
3948 aio_context = bdrv_get_aio_context(bs);
3951 aio_context_acquire(aio_context);
3953 if (bs) {
3954 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3955 goto out;
3958 if (!blk && !QTAILQ_IN_USE(bs, monitor_list)) {
3959 error_setg(errp, "Node %s is not owned by the monitor",
3960 bs->node_name);
3961 goto out;
3964 if (bs->refcnt > 1) {
3965 error_setg(errp, "Block device %s is in use",
3966 bdrv_get_device_or_node_name(bs));
3967 goto out;
3971 if (blk) {
3972 monitor_remove_blk(blk);
3973 blk_unref(blk);
3974 } else {
3975 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3976 bdrv_unref(bs);
3979 out:
3980 aio_context_release(aio_context);
3983 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3984 const char *child_name)
3986 BdrvChild *child;
3988 QLIST_FOREACH(child, &parent_bs->children, next) {
3989 if (strcmp(child->name, child_name) == 0) {
3990 return child;
3994 return NULL;
3997 void qmp_x_blockdev_change(const char *parent, bool has_child,
3998 const char *child, bool has_node,
3999 const char *node, Error **errp)
4001 BlockDriverState *parent_bs, *new_bs = NULL;
4002 BdrvChild *p_child;
4004 parent_bs = bdrv_lookup_bs(parent, parent, errp);
4005 if (!parent_bs) {
4006 return;
4009 if (has_child == has_node) {
4010 if (has_child) {
4011 error_setg(errp, "The parameters child and node are in conflict");
4012 } else {
4013 error_setg(errp, "Either child or node must be specified");
4015 return;
4018 if (has_child) {
4019 p_child = bdrv_find_child(parent_bs, child);
4020 if (!p_child) {
4021 error_setg(errp, "Node '%s' does not have child '%s'",
4022 parent, child);
4023 return;
4025 bdrv_del_child(parent_bs, p_child, errp);
4028 if (has_node) {
4029 new_bs = bdrv_find_node(node);
4030 if (!new_bs) {
4031 error_setg(errp, "Node '%s' not found", node);
4032 return;
4034 bdrv_add_child(parent_bs, new_bs, errp);
4038 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4040 BlockJobInfoList *head = NULL, **p_next = &head;
4041 BlockJob *job;
4043 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
4044 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
4045 AioContext *aio_context = blk_get_aio_context(job->blk);
4047 aio_context_acquire(aio_context);
4048 elem->value = block_job_query(job);
4049 aio_context_release(aio_context);
4051 *p_next = elem;
4052 p_next = &elem->next;
4055 return head;
4058 QemuOptsList qemu_common_drive_opts = {
4059 .name = "drive",
4060 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4061 .desc = {
4063 .name = "snapshot",
4064 .type = QEMU_OPT_BOOL,
4065 .help = "enable/disable snapshot mode",
4067 .name = "discard",
4068 .type = QEMU_OPT_STRING,
4069 .help = "discard operation (ignore/off, unmap/on)",
4071 .name = "aio",
4072 .type = QEMU_OPT_STRING,
4073 .help = "host AIO implementation (threads, native)",
4075 .name = BDRV_OPT_CACHE_WB,
4076 .type = QEMU_OPT_BOOL,
4077 .help = "Enable writeback mode",
4079 .name = "format",
4080 .type = QEMU_OPT_STRING,
4081 .help = "disk format (raw, qcow2, ...)",
4083 .name = "rerror",
4084 .type = QEMU_OPT_STRING,
4085 .help = "read error action",
4087 .name = "werror",
4088 .type = QEMU_OPT_STRING,
4089 .help = "write error action",
4091 .name = BDRV_OPT_READ_ONLY,
4092 .type = QEMU_OPT_BOOL,
4093 .help = "open drive file as read-only",
4095 .name = "throttling.iops-total",
4096 .type = QEMU_OPT_NUMBER,
4097 .help = "limit total I/O operations per second",
4099 .name = "throttling.iops-read",
4100 .type = QEMU_OPT_NUMBER,
4101 .help = "limit read operations per second",
4103 .name = "throttling.iops-write",
4104 .type = QEMU_OPT_NUMBER,
4105 .help = "limit write operations per second",
4107 .name = "throttling.bps-total",
4108 .type = QEMU_OPT_NUMBER,
4109 .help = "limit total bytes per second",
4111 .name = "throttling.bps-read",
4112 .type = QEMU_OPT_NUMBER,
4113 .help = "limit read bytes per second",
4115 .name = "throttling.bps-write",
4116 .type = QEMU_OPT_NUMBER,
4117 .help = "limit write bytes per second",
4119 .name = "throttling.iops-total-max",
4120 .type = QEMU_OPT_NUMBER,
4121 .help = "I/O operations burst",
4123 .name = "throttling.iops-read-max",
4124 .type = QEMU_OPT_NUMBER,
4125 .help = "I/O operations read burst",
4127 .name = "throttling.iops-write-max",
4128 .type = QEMU_OPT_NUMBER,
4129 .help = "I/O operations write burst",
4131 .name = "throttling.bps-total-max",
4132 .type = QEMU_OPT_NUMBER,
4133 .help = "total bytes burst",
4135 .name = "throttling.bps-read-max",
4136 .type = QEMU_OPT_NUMBER,
4137 .help = "total bytes read burst",
4139 .name = "throttling.bps-write-max",
4140 .type = QEMU_OPT_NUMBER,
4141 .help = "total bytes write burst",
4143 .name = "throttling.iops-total-max-length",
4144 .type = QEMU_OPT_NUMBER,
4145 .help = "length of the iops-total-max burst period, in seconds",
4147 .name = "throttling.iops-read-max-length",
4148 .type = QEMU_OPT_NUMBER,
4149 .help = "length of the iops-read-max burst period, in seconds",
4151 .name = "throttling.iops-write-max-length",
4152 .type = QEMU_OPT_NUMBER,
4153 .help = "length of the iops-write-max burst period, in seconds",
4155 .name = "throttling.bps-total-max-length",
4156 .type = QEMU_OPT_NUMBER,
4157 .help = "length of the bps-total-max burst period, in seconds",
4159 .name = "throttling.bps-read-max-length",
4160 .type = QEMU_OPT_NUMBER,
4161 .help = "length of the bps-read-max burst period, in seconds",
4163 .name = "throttling.bps-write-max-length",
4164 .type = QEMU_OPT_NUMBER,
4165 .help = "length of the bps-write-max burst period, in seconds",
4167 .name = "throttling.iops-size",
4168 .type = QEMU_OPT_NUMBER,
4169 .help = "when limiting by iops max size of an I/O in bytes",
4171 .name = "throttling.group",
4172 .type = QEMU_OPT_STRING,
4173 .help = "name of the block throttling group",
4175 .name = "copy-on-read",
4176 .type = QEMU_OPT_BOOL,
4177 .help = "copy read data from backing file into image file",
4179 .name = "detect-zeroes",
4180 .type = QEMU_OPT_STRING,
4181 .help = "try to optimize zero writes (off, on, unmap)",
4183 .name = "stats-account-invalid",
4184 .type = QEMU_OPT_BOOL,
4185 .help = "whether to account for invalid I/O operations "
4186 "in the statistics",
4188 .name = "stats-account-failed",
4189 .type = QEMU_OPT_BOOL,
4190 .help = "whether to account for failed I/O operations "
4191 "in the statistics",
4193 { /* end of list */ }
4197 static QemuOptsList qemu_root_bds_opts = {
4198 .name = "root-bds",
4199 .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4200 .desc = {
4202 .name = "discard",
4203 .type = QEMU_OPT_STRING,
4204 .help = "discard operation (ignore/off, unmap/on)",
4206 .name = "aio",
4207 .type = QEMU_OPT_STRING,
4208 .help = "host AIO implementation (threads, native)",
4210 .name = "copy-on-read",
4211 .type = QEMU_OPT_BOOL,
4212 .help = "copy read data from backing file into image file",
4214 .name = "detect-zeroes",
4215 .type = QEMU_OPT_STRING,
4216 .help = "try to optimize zero writes (off, on, unmap)",
4218 { /* end of list */ }
4222 QemuOptsList qemu_drive_opts = {
4223 .name = "drive",
4224 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4225 .desc = {
4227 * no elements => accept any params
4228 * validation will happen later
4230 { /* end of list */ }