block: Accept node-name for blockdev-backup
[qemu/ar7.git] / blockdev.c
blob46beafdfad14f7682d5fea2824e9d16211547507
1 /*
2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
9 * This file incorporates work covered by the following copyright and
10 * permission notice:
12 * Copyright (c) 2003-2008 Fabrice Bellard
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
30 * THE SOFTWARE.
33 #include "qemu/osdep.h"
34 #include "sysemu/block-backend.h"
35 #include "sysemu/blockdev.h"
36 #include "hw/block/block.h"
37 #include "block/blockjob.h"
38 #include "block/throttle-groups.h"
39 #include "monitor/monitor.h"
40 #include "qemu/error-report.h"
41 #include "qemu/option.h"
42 #include "qemu/config-file.h"
43 #include "qapi/qmp/types.h"
44 #include "qapi-visit.h"
45 #include "qapi/qmp/qerror.h"
46 #include "qapi/qmp-output-visitor.h"
47 #include "qapi/util.h"
48 #include "sysemu/sysemu.h"
49 #include "block/block_int.h"
50 #include "qmp-commands.h"
51 #include "trace.h"
52 #include "sysemu/arch_init.h"
53 #include "qemu/cutils.h"
54 #include "qemu/help_option.h"
56 static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
57 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
59 static int do_open_tray(const char *device, bool force, Error **errp);
61 static const char *const if_name[IF_COUNT] = {
62 [IF_NONE] = "none",
63 [IF_IDE] = "ide",
64 [IF_SCSI] = "scsi",
65 [IF_FLOPPY] = "floppy",
66 [IF_PFLASH] = "pflash",
67 [IF_MTD] = "mtd",
68 [IF_SD] = "sd",
69 [IF_VIRTIO] = "virtio",
70 [IF_XEN] = "xen",
73 static int if_max_devs[IF_COUNT] = {
75 * Do not change these numbers! They govern how drive option
76 * index maps to unit and bus. That mapping is ABI.
78 * All controllers used to implement if=T drives need to support
79 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
80 * Otherwise, some index values map to "impossible" bus, unit
81 * values.
83 * For instance, if you change [IF_SCSI] to 255, -drive
84 * if=scsi,index=12 no longer means bus=1,unit=5, but
85 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
86 * the drive can't be set up. Regression.
88 [IF_IDE] = 2,
89 [IF_SCSI] = 7,
92 /**
93 * Boards may call this to offer board-by-board overrides
94 * of the default, global values.
96 void override_max_devs(BlockInterfaceType type, int max_devs)
98 BlockBackend *blk;
99 DriveInfo *dinfo;
101 if (max_devs <= 0) {
102 return;
105 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
106 dinfo = blk_legacy_dinfo(blk);
107 if (dinfo->type == type) {
108 fprintf(stderr, "Cannot override units-per-bus property of"
109 " the %s interface, because a drive of that type has"
110 " already been added.\n", if_name[type]);
111 g_assert_not_reached();
115 if_max_devs[type] = max_devs;
119 * We automatically delete the drive when a device using it gets
120 * unplugged. Questionable feature, but we can't just drop it.
121 * Device models call blockdev_mark_auto_del() to schedule the
122 * automatic deletion, and generic qdev code calls blockdev_auto_del()
123 * when deletion is actually safe.
125 void blockdev_mark_auto_del(BlockBackend *blk)
127 DriveInfo *dinfo = blk_legacy_dinfo(blk);
128 BlockDriverState *bs = blk_bs(blk);
129 AioContext *aio_context;
131 if (!dinfo) {
132 return;
135 if (bs) {
136 aio_context = bdrv_get_aio_context(bs);
137 aio_context_acquire(aio_context);
139 if (bs->job) {
140 block_job_cancel(bs->job);
143 aio_context_release(aio_context);
146 dinfo->auto_del = 1;
149 void blockdev_auto_del(BlockBackend *blk)
151 DriveInfo *dinfo = blk_legacy_dinfo(blk);
153 if (dinfo && dinfo->auto_del) {
154 monitor_remove_blk(blk);
155 blk_unref(blk);
160 * Returns the current mapping of how many units per bus
161 * a particular interface can support.
163 * A positive integer indicates n units per bus.
164 * 0 implies the mapping has not been established.
165 * -1 indicates an invalid BlockInterfaceType was given.
167 int drive_get_max_devs(BlockInterfaceType type)
169 if (type >= IF_IDE && type < IF_COUNT) {
170 return if_max_devs[type];
173 return -1;
176 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
178 int max_devs = if_max_devs[type];
179 return max_devs ? index / max_devs : 0;
182 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
184 int max_devs = if_max_devs[type];
185 return max_devs ? index % max_devs : index;
188 QemuOpts *drive_def(const char *optstr)
190 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
193 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
194 const char *optstr)
196 QemuOpts *opts;
198 opts = drive_def(optstr);
199 if (!opts) {
200 return NULL;
202 if (type != IF_DEFAULT) {
203 qemu_opt_set(opts, "if", if_name[type], &error_abort);
205 if (index >= 0) {
206 qemu_opt_set_number(opts, "index", index, &error_abort);
208 if (file)
209 qemu_opt_set(opts, "file", file, &error_abort);
210 return opts;
213 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
215 BlockBackend *blk;
216 DriveInfo *dinfo;
218 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
219 dinfo = blk_legacy_dinfo(blk);
220 if (dinfo && dinfo->type == type
221 && dinfo->bus == bus && dinfo->unit == unit) {
222 return dinfo;
226 return NULL;
229 bool drive_check_orphaned(void)
231 BlockBackend *blk;
232 DriveInfo *dinfo;
233 bool rs = false;
235 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
236 dinfo = blk_legacy_dinfo(blk);
237 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
238 /* Unless this is a default drive, this may be an oversight. */
239 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
240 dinfo->type != IF_NONE) {
241 fprintf(stderr, "Warning: Orphaned drive without device: "
242 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
243 blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
244 if_name[dinfo->type], dinfo->bus, dinfo->unit);
245 rs = true;
249 return rs;
252 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
254 return drive_get(type,
255 drive_index_to_bus_id(type, index),
256 drive_index_to_unit_id(type, index));
259 int drive_get_max_bus(BlockInterfaceType type)
261 int max_bus;
262 BlockBackend *blk;
263 DriveInfo *dinfo;
265 max_bus = -1;
266 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
267 dinfo = blk_legacy_dinfo(blk);
268 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
269 max_bus = dinfo->bus;
272 return max_bus;
275 /* Get a block device. This should only be used for single-drive devices
276 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
277 appropriate bus. */
278 DriveInfo *drive_get_next(BlockInterfaceType type)
280 static int next_block_unit[IF_COUNT];
282 return drive_get(type, 0, next_block_unit[type]++);
285 static void bdrv_format_print(void *opaque, const char *name)
287 error_printf(" %s", name);
290 typedef struct {
291 QEMUBH *bh;
292 BlockDriverState *bs;
293 } BDRVPutRefBH;
295 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
297 if (!strcmp(buf, "ignore")) {
298 return BLOCKDEV_ON_ERROR_IGNORE;
299 } else if (!is_read && !strcmp(buf, "enospc")) {
300 return BLOCKDEV_ON_ERROR_ENOSPC;
301 } else if (!strcmp(buf, "stop")) {
302 return BLOCKDEV_ON_ERROR_STOP;
303 } else if (!strcmp(buf, "report")) {
304 return BLOCKDEV_ON_ERROR_REPORT;
305 } else {
306 error_setg(errp, "'%s' invalid %s error action",
307 buf, is_read ? "read" : "write");
308 return -1;
312 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
313 Error **errp)
315 const QListEntry *entry;
316 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
317 switch (qobject_type(entry->value)) {
319 case QTYPE_QSTRING: {
320 unsigned long long length;
321 const char *str = qstring_get_str(qobject_to_qstring(entry->value));
322 if (parse_uint_full(str, &length, 10) == 0 &&
323 length > 0 && length <= UINT_MAX) {
324 block_acct_add_interval(stats, (unsigned) length);
325 } else {
326 error_setg(errp, "Invalid interval length: %s", str);
327 return false;
329 break;
332 case QTYPE_QINT: {
333 int64_t length = qint_get_int(qobject_to_qint(entry->value));
334 if (length > 0 && length <= UINT_MAX) {
335 block_acct_add_interval(stats, (unsigned) length);
336 } else {
337 error_setg(errp, "Invalid interval length: %" PRId64, length);
338 return false;
340 break;
343 default:
344 error_setg(errp, "The specification of stats-intervals is invalid");
345 return false;
348 return true;
351 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
353 /* All parameters but @opts are optional and may be set to NULL. */
354 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
355 const char **throttling_group, ThrottleConfig *throttle_cfg,
356 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
358 const char *discard;
359 Error *local_error = NULL;
360 const char *aio;
362 if (bdrv_flags) {
363 if (!qemu_opt_get_bool(opts, "read-only", false)) {
364 *bdrv_flags |= BDRV_O_RDWR;
366 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
367 *bdrv_flags |= BDRV_O_COPY_ON_READ;
370 if ((discard = qemu_opt_get(opts, "discard")) != NULL) {
371 if (bdrv_parse_discard_flags(discard, bdrv_flags) != 0) {
372 error_setg(errp, "Invalid discard option");
373 return;
377 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
378 if (!strcmp(aio, "native")) {
379 *bdrv_flags |= BDRV_O_NATIVE_AIO;
380 } else if (!strcmp(aio, "threads")) {
381 /* this is the default */
382 } else {
383 error_setg(errp, "invalid aio option");
384 return;
389 /* disk I/O throttling */
390 if (throttling_group) {
391 *throttling_group = qemu_opt_get(opts, "throttling.group");
394 if (throttle_cfg) {
395 throttle_config_init(throttle_cfg);
396 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
397 qemu_opt_get_number(opts, "throttling.bps-total", 0);
398 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
399 qemu_opt_get_number(opts, "throttling.bps-read", 0);
400 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
401 qemu_opt_get_number(opts, "throttling.bps-write", 0);
402 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
403 qemu_opt_get_number(opts, "throttling.iops-total", 0);
404 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
405 qemu_opt_get_number(opts, "throttling.iops-read", 0);
406 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
407 qemu_opt_get_number(opts, "throttling.iops-write", 0);
409 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
410 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
411 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
412 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
413 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
414 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
415 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
416 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
417 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
418 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
419 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
420 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
422 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
423 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
424 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
425 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
426 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
427 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
428 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
429 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
430 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
431 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
432 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
433 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
435 throttle_cfg->op_size =
436 qemu_opt_get_number(opts, "throttling.iops-size", 0);
438 if (!throttle_is_valid(throttle_cfg, errp)) {
439 return;
443 if (detect_zeroes) {
444 *detect_zeroes =
445 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
446 qemu_opt_get(opts, "detect-zeroes"),
447 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
448 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
449 &local_error);
450 if (local_error) {
451 error_propagate(errp, local_error);
452 return;
455 if (bdrv_flags &&
456 *detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
457 !(*bdrv_flags & BDRV_O_UNMAP))
459 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
460 "without setting discard operation to unmap");
461 return;
466 /* Takes the ownership of bs_opts */
467 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
468 Error **errp)
470 const char *buf;
471 int bdrv_flags = 0;
472 int on_read_error, on_write_error;
473 bool account_invalid, account_failed;
474 bool writethrough;
475 BlockBackend *blk;
476 BlockDriverState *bs;
477 ThrottleConfig cfg;
478 int snapshot = 0;
479 Error *error = NULL;
480 QemuOpts *opts;
481 QDict *interval_dict = NULL;
482 QList *interval_list = NULL;
483 const char *id;
484 BlockdevDetectZeroesOptions detect_zeroes =
485 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
486 const char *throttling_group = NULL;
488 /* Check common options by copying from bs_opts to opts, all other options
489 * stay in bs_opts for processing by bdrv_open(). */
490 id = qdict_get_try_str(bs_opts, "id");
491 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
492 if (error) {
493 error_propagate(errp, error);
494 goto err_no_opts;
497 qemu_opts_absorb_qdict(opts, bs_opts, &error);
498 if (error) {
499 error_propagate(errp, error);
500 goto early_err;
503 if (id) {
504 qdict_del(bs_opts, "id");
507 /* extract parameters */
508 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
510 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
511 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
513 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
515 id = qemu_opts_id(opts);
517 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
518 qdict_array_split(interval_dict, &interval_list);
520 if (qdict_size(interval_dict) != 0) {
521 error_setg(errp, "Invalid option stats-intervals.%s",
522 qdict_first(interval_dict)->key);
523 goto early_err;
526 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
527 &detect_zeroes, &error);
528 if (error) {
529 error_propagate(errp, error);
530 goto early_err;
533 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
534 if (is_help_option(buf)) {
535 error_printf("Supported formats:");
536 bdrv_iterate_format(bdrv_format_print, NULL);
537 error_printf("\n");
538 goto early_err;
541 if (qdict_haskey(bs_opts, "driver")) {
542 error_setg(errp, "Cannot specify both 'driver' and 'format'");
543 goto early_err;
545 qdict_put(bs_opts, "driver", qstring_from_str(buf));
548 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
549 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
550 on_write_error = parse_block_error_action(buf, 0, &error);
551 if (error) {
552 error_propagate(errp, error);
553 goto early_err;
557 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
558 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
559 on_read_error = parse_block_error_action(buf, 1, &error);
560 if (error) {
561 error_propagate(errp, error);
562 goto early_err;
566 if (snapshot) {
567 bdrv_flags |= BDRV_O_SNAPSHOT;
570 /* init */
571 if ((!file || !*file) && !qdict_size(bs_opts)) {
572 BlockBackendRootState *blk_rs;
574 blk = blk_new();
575 blk_rs = blk_get_root_state(blk);
576 blk_rs->open_flags = bdrv_flags;
577 blk_rs->read_only = !(bdrv_flags & BDRV_O_RDWR);
578 blk_rs->detect_zeroes = detect_zeroes;
580 QDECREF(bs_opts);
581 } else {
582 if (file && !*file) {
583 file = NULL;
586 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
587 * with other callers) rather than what we want as the real defaults.
588 * Apply the defaults here instead. */
589 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
590 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
591 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
593 if (runstate_check(RUN_STATE_INMIGRATE)) {
594 bdrv_flags |= BDRV_O_INACTIVE;
597 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
598 if (!blk) {
599 goto err_no_bs_opts;
601 bs = blk_bs(blk);
603 bs->detect_zeroes = detect_zeroes;
605 if (bdrv_key_required(bs)) {
606 autostart = 0;
609 block_acct_init(blk_get_stats(blk), account_invalid, account_failed);
611 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
612 blk_unref(blk);
613 blk = NULL;
614 goto err_no_bs_opts;
618 /* disk I/O throttling */
619 if (throttle_enabled(&cfg)) {
620 if (!throttling_group) {
621 throttling_group = id;
623 blk_io_limits_enable(blk, throttling_group);
624 blk_set_io_limits(blk, &cfg);
627 blk_set_enable_write_cache(blk, !writethrough);
628 blk_set_on_error(blk, on_read_error, on_write_error);
630 if (!monitor_add_blk(blk, id, errp)) {
631 blk_unref(blk);
632 blk = NULL;
633 goto err_no_bs_opts;
636 err_no_bs_opts:
637 qemu_opts_del(opts);
638 QDECREF(interval_dict);
639 QDECREF(interval_list);
640 return blk;
642 early_err:
643 qemu_opts_del(opts);
644 QDECREF(interval_dict);
645 QDECREF(interval_list);
646 err_no_opts:
647 QDECREF(bs_opts);
648 return NULL;
651 static QemuOptsList qemu_root_bds_opts;
653 /* Takes the ownership of bs_opts */
654 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
656 BlockDriverState *bs;
657 QemuOpts *opts;
658 Error *local_error = NULL;
659 BlockdevDetectZeroesOptions detect_zeroes;
660 int bdrv_flags = 0;
662 opts = qemu_opts_create(&qemu_root_bds_opts, NULL, 1, errp);
663 if (!opts) {
664 goto fail;
667 qemu_opts_absorb_qdict(opts, bs_opts, &local_error);
668 if (local_error) {
669 error_propagate(errp, local_error);
670 goto fail;
673 extract_common_blockdev_options(opts, &bdrv_flags, NULL, NULL,
674 &detect_zeroes, &local_error);
675 if (local_error) {
676 error_propagate(errp, local_error);
677 goto fail;
680 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
681 * with other callers) rather than what we want as the real defaults.
682 * Apply the defaults here instead. */
683 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
684 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
686 if (runstate_check(RUN_STATE_INMIGRATE)) {
687 bdrv_flags |= BDRV_O_INACTIVE;
690 bs = bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
691 if (!bs) {
692 goto fail_no_bs_opts;
695 bs->detect_zeroes = detect_zeroes;
697 fail_no_bs_opts:
698 qemu_opts_del(opts);
699 return bs;
701 fail:
702 qemu_opts_del(opts);
703 QDECREF(bs_opts);
704 return NULL;
707 void blockdev_close_all_bdrv_states(void)
709 BlockDriverState *bs, *next_bs;
711 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
712 AioContext *ctx = bdrv_get_aio_context(bs);
714 aio_context_acquire(ctx);
715 bdrv_unref(bs);
716 aio_context_release(ctx);
720 /* Iterates over the list of monitor-owned BlockDriverStates */
721 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
723 return bs ? QTAILQ_NEXT(bs, monitor_list)
724 : QTAILQ_FIRST(&monitor_bdrv_states);
727 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
728 Error **errp)
730 const char *value;
732 value = qemu_opt_get(opts, from);
733 if (value) {
734 if (qemu_opt_find(opts, to)) {
735 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
736 "same time", to, from);
737 return;
741 /* rename all items in opts */
742 while ((value = qemu_opt_get(opts, from))) {
743 qemu_opt_set(opts, to, value, &error_abort);
744 qemu_opt_unset(opts, from);
748 QemuOptsList qemu_legacy_drive_opts = {
749 .name = "drive",
750 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
751 .desc = {
753 .name = "bus",
754 .type = QEMU_OPT_NUMBER,
755 .help = "bus number",
757 .name = "unit",
758 .type = QEMU_OPT_NUMBER,
759 .help = "unit number (i.e. lun for scsi)",
761 .name = "index",
762 .type = QEMU_OPT_NUMBER,
763 .help = "index number",
765 .name = "media",
766 .type = QEMU_OPT_STRING,
767 .help = "media type (disk, cdrom)",
769 .name = "if",
770 .type = QEMU_OPT_STRING,
771 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
773 .name = "cyls",
774 .type = QEMU_OPT_NUMBER,
775 .help = "number of cylinders (ide disk geometry)",
777 .name = "heads",
778 .type = QEMU_OPT_NUMBER,
779 .help = "number of heads (ide disk geometry)",
781 .name = "secs",
782 .type = QEMU_OPT_NUMBER,
783 .help = "number of sectors (ide disk geometry)",
785 .name = "trans",
786 .type = QEMU_OPT_STRING,
787 .help = "chs translation (auto, lba, none)",
789 .name = "boot",
790 .type = QEMU_OPT_BOOL,
791 .help = "(deprecated, ignored)",
793 .name = "addr",
794 .type = QEMU_OPT_STRING,
795 .help = "pci address (virtio only)",
797 .name = "serial",
798 .type = QEMU_OPT_STRING,
799 .help = "disk serial number",
801 .name = "file",
802 .type = QEMU_OPT_STRING,
803 .help = "file name",
806 /* Options that are passed on, but have special semantics with -drive */
808 .name = "read-only",
809 .type = QEMU_OPT_BOOL,
810 .help = "open drive file as read-only",
812 .name = "rerror",
813 .type = QEMU_OPT_STRING,
814 .help = "read error action",
816 .name = "werror",
817 .type = QEMU_OPT_STRING,
818 .help = "write error action",
820 .name = "copy-on-read",
821 .type = QEMU_OPT_BOOL,
822 .help = "copy read data from backing file into image file",
825 { /* end of list */ }
829 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
831 const char *value;
832 BlockBackend *blk;
833 DriveInfo *dinfo = NULL;
834 QDict *bs_opts;
835 QemuOpts *legacy_opts;
836 DriveMediaType media = MEDIA_DISK;
837 BlockInterfaceType type;
838 int cyls, heads, secs, translation;
839 int max_devs, bus_id, unit_id, index;
840 const char *devaddr;
841 const char *werror, *rerror;
842 bool read_only = false;
843 bool copy_on_read;
844 const char *serial;
845 const char *filename;
846 Error *local_err = NULL;
847 int i;
849 /* Change legacy command line options into QMP ones */
850 static const struct {
851 const char *from;
852 const char *to;
853 } opt_renames[] = {
854 { "iops", "throttling.iops-total" },
855 { "iops_rd", "throttling.iops-read" },
856 { "iops_wr", "throttling.iops-write" },
858 { "bps", "throttling.bps-total" },
859 { "bps_rd", "throttling.bps-read" },
860 { "bps_wr", "throttling.bps-write" },
862 { "iops_max", "throttling.iops-total-max" },
863 { "iops_rd_max", "throttling.iops-read-max" },
864 { "iops_wr_max", "throttling.iops-write-max" },
866 { "bps_max", "throttling.bps-total-max" },
867 { "bps_rd_max", "throttling.bps-read-max" },
868 { "bps_wr_max", "throttling.bps-write-max" },
870 { "iops_size", "throttling.iops-size" },
872 { "group", "throttling.group" },
874 { "readonly", "read-only" },
877 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
878 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
879 &local_err);
880 if (local_err) {
881 error_report_err(local_err);
882 return NULL;
886 value = qemu_opt_get(all_opts, "cache");
887 if (value) {
888 int flags = 0;
889 bool writethrough;
891 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
892 error_report("invalid cache option");
893 return NULL;
896 /* Specific options take precedence */
897 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
898 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
899 !writethrough, &error_abort);
901 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
902 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
903 !!(flags & BDRV_O_NOCACHE), &error_abort);
905 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
906 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
907 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
909 qemu_opt_unset(all_opts, "cache");
912 /* Get a QDict for processing the options */
913 bs_opts = qdict_new();
914 qemu_opts_to_qdict(all_opts, bs_opts);
916 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
917 &error_abort);
918 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
919 if (local_err) {
920 error_report_err(local_err);
921 goto fail;
924 /* Deprecated option boot=[on|off] */
925 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
926 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
927 "ignored. Future versions will reject this parameter. Please "
928 "update your scripts.\n");
931 /* Media type */
932 value = qemu_opt_get(legacy_opts, "media");
933 if (value) {
934 if (!strcmp(value, "disk")) {
935 media = MEDIA_DISK;
936 } else if (!strcmp(value, "cdrom")) {
937 media = MEDIA_CDROM;
938 read_only = true;
939 } else {
940 error_report("'%s' invalid media", value);
941 goto fail;
945 /* copy-on-read is disabled with a warning for read-only devices */
946 read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
947 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
949 if (read_only && copy_on_read) {
950 error_report("warning: disabling copy-on-read on read-only drive");
951 copy_on_read = false;
954 qdict_put(bs_opts, "read-only",
955 qstring_from_str(read_only ? "on" : "off"));
956 qdict_put(bs_opts, "copy-on-read",
957 qstring_from_str(copy_on_read ? "on" :"off"));
959 /* Controller type */
960 value = qemu_opt_get(legacy_opts, "if");
961 if (value) {
962 for (type = 0;
963 type < IF_COUNT && strcmp(value, if_name[type]);
964 type++) {
966 if (type == IF_COUNT) {
967 error_report("unsupported bus type '%s'", value);
968 goto fail;
970 } else {
971 type = block_default_type;
974 /* Geometry */
975 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
976 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
977 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
979 if (cyls || heads || secs) {
980 if (cyls < 1) {
981 error_report("invalid physical cyls number");
982 goto fail;
984 if (heads < 1) {
985 error_report("invalid physical heads number");
986 goto fail;
988 if (secs < 1) {
989 error_report("invalid physical secs number");
990 goto fail;
994 translation = BIOS_ATA_TRANSLATION_AUTO;
995 value = qemu_opt_get(legacy_opts, "trans");
996 if (value != NULL) {
997 if (!cyls) {
998 error_report("'%s' trans must be used with cyls, heads and secs",
999 value);
1000 goto fail;
1002 if (!strcmp(value, "none")) {
1003 translation = BIOS_ATA_TRANSLATION_NONE;
1004 } else if (!strcmp(value, "lba")) {
1005 translation = BIOS_ATA_TRANSLATION_LBA;
1006 } else if (!strcmp(value, "large")) {
1007 translation = BIOS_ATA_TRANSLATION_LARGE;
1008 } else if (!strcmp(value, "rechs")) {
1009 translation = BIOS_ATA_TRANSLATION_RECHS;
1010 } else if (!strcmp(value, "auto")) {
1011 translation = BIOS_ATA_TRANSLATION_AUTO;
1012 } else {
1013 error_report("'%s' invalid translation type", value);
1014 goto fail;
1018 if (media == MEDIA_CDROM) {
1019 if (cyls || secs || heads) {
1020 error_report("CHS can't be set with media=cdrom");
1021 goto fail;
1025 /* Device address specified by bus/unit or index.
1026 * If none was specified, try to find the first free one. */
1027 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
1028 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
1029 index = qemu_opt_get_number(legacy_opts, "index", -1);
1031 max_devs = if_max_devs[type];
1033 if (index != -1) {
1034 if (bus_id != 0 || unit_id != -1) {
1035 error_report("index cannot be used with bus and unit");
1036 goto fail;
1038 bus_id = drive_index_to_bus_id(type, index);
1039 unit_id = drive_index_to_unit_id(type, index);
1042 if (unit_id == -1) {
1043 unit_id = 0;
1044 while (drive_get(type, bus_id, unit_id) != NULL) {
1045 unit_id++;
1046 if (max_devs && unit_id >= max_devs) {
1047 unit_id -= max_devs;
1048 bus_id++;
1053 if (max_devs && unit_id >= max_devs) {
1054 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
1055 goto fail;
1058 if (drive_get(type, bus_id, unit_id) != NULL) {
1059 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1060 bus_id, unit_id, index);
1061 goto fail;
1064 /* Serial number */
1065 serial = qemu_opt_get(legacy_opts, "serial");
1067 /* no id supplied -> create one */
1068 if (qemu_opts_id(all_opts) == NULL) {
1069 char *new_id;
1070 const char *mediastr = "";
1071 if (type == IF_IDE || type == IF_SCSI) {
1072 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
1074 if (max_devs) {
1075 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
1076 mediastr, unit_id);
1077 } else {
1078 new_id = g_strdup_printf("%s%s%i", if_name[type],
1079 mediastr, unit_id);
1081 qdict_put(bs_opts, "id", qstring_from_str(new_id));
1082 g_free(new_id);
1085 /* Add virtio block device */
1086 devaddr = qemu_opt_get(legacy_opts, "addr");
1087 if (devaddr && type != IF_VIRTIO) {
1088 error_report("addr is not supported by this bus type");
1089 goto fail;
1092 if (type == IF_VIRTIO) {
1093 QemuOpts *devopts;
1094 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
1095 &error_abort);
1096 if (arch_type == QEMU_ARCH_S390X) {
1097 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1098 } else {
1099 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1101 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
1102 &error_abort);
1103 if (devaddr) {
1104 qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1108 filename = qemu_opt_get(legacy_opts, "file");
1110 /* Check werror/rerror compatibility with if=... */
1111 werror = qemu_opt_get(legacy_opts, "werror");
1112 if (werror != NULL) {
1113 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
1114 type != IF_NONE) {
1115 error_report("werror is not supported by this bus type");
1116 goto fail;
1118 qdict_put(bs_opts, "werror", qstring_from_str(werror));
1121 rerror = qemu_opt_get(legacy_opts, "rerror");
1122 if (rerror != NULL) {
1123 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
1124 type != IF_NONE) {
1125 error_report("rerror is not supported by this bus type");
1126 goto fail;
1128 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
1131 /* Actual block device init: Functionality shared with blockdev-add */
1132 blk = blockdev_init(filename, bs_opts, &local_err);
1133 bs_opts = NULL;
1134 if (!blk) {
1135 if (local_err) {
1136 error_report_err(local_err);
1138 goto fail;
1139 } else {
1140 assert(!local_err);
1143 /* Create legacy DriveInfo */
1144 dinfo = g_malloc0(sizeof(*dinfo));
1145 dinfo->opts = all_opts;
1147 dinfo->cyls = cyls;
1148 dinfo->heads = heads;
1149 dinfo->secs = secs;
1150 dinfo->trans = translation;
1152 dinfo->type = type;
1153 dinfo->bus = bus_id;
1154 dinfo->unit = unit_id;
1155 dinfo->devaddr = devaddr;
1156 dinfo->serial = g_strdup(serial);
1158 blk_set_legacy_dinfo(blk, dinfo);
1160 switch(type) {
1161 case IF_IDE:
1162 case IF_SCSI:
1163 case IF_XEN:
1164 case IF_NONE:
1165 dinfo->media_cd = media == MEDIA_CDROM;
1166 break;
1167 default:
1168 break;
1171 fail:
1172 qemu_opts_del(legacy_opts);
1173 QDECREF(bs_opts);
1174 return dinfo;
1177 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1179 BlockDriverState *bs;
1181 bs = bdrv_lookup_bs(name, name, errp);
1182 if (bs == NULL) {
1183 return NULL;
1186 if (!bdrv_is_root_node(bs)) {
1187 error_setg(errp, "Need a root block node");
1188 return NULL;
1191 if (!bdrv_is_inserted(bs)) {
1192 error_setg(errp, "Device has no medium");
1193 return NULL;
1196 return bs;
1199 void hmp_commit(Monitor *mon, const QDict *qdict)
1201 const char *device = qdict_get_str(qdict, "device");
1202 BlockBackend *blk;
1203 int ret;
1205 if (!strcmp(device, "all")) {
1206 ret = blk_commit_all();
1207 } else {
1208 BlockDriverState *bs;
1209 AioContext *aio_context;
1211 blk = blk_by_name(device);
1212 if (!blk) {
1213 monitor_printf(mon, "Device '%s' not found\n", device);
1214 return;
1216 if (!blk_is_available(blk)) {
1217 monitor_printf(mon, "Device '%s' has no medium\n", device);
1218 return;
1221 bs = blk_bs(blk);
1222 aio_context = bdrv_get_aio_context(bs);
1223 aio_context_acquire(aio_context);
1225 ret = bdrv_commit(bs);
1227 aio_context_release(aio_context);
1229 if (ret < 0) {
1230 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1231 strerror(-ret));
1235 static void blockdev_do_action(TransactionAction *action, Error **errp)
1237 TransactionActionList list;
1239 list.value = action;
1240 list.next = NULL;
1241 qmp_transaction(&list, false, NULL, errp);
1244 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1245 bool has_node_name, const char *node_name,
1246 const char *snapshot_file,
1247 bool has_snapshot_node_name,
1248 const char *snapshot_node_name,
1249 bool has_format, const char *format,
1250 bool has_mode, NewImageMode mode, Error **errp)
1252 BlockdevSnapshotSync snapshot = {
1253 .has_device = has_device,
1254 .device = (char *) device,
1255 .has_node_name = has_node_name,
1256 .node_name = (char *) node_name,
1257 .snapshot_file = (char *) snapshot_file,
1258 .has_snapshot_node_name = has_snapshot_node_name,
1259 .snapshot_node_name = (char *) snapshot_node_name,
1260 .has_format = has_format,
1261 .format = (char *) format,
1262 .has_mode = has_mode,
1263 .mode = mode,
1265 TransactionAction action = {
1266 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1267 .u.blockdev_snapshot_sync.data = &snapshot,
1269 blockdev_do_action(&action, errp);
1272 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1273 Error **errp)
1275 BlockdevSnapshot snapshot_data = {
1276 .node = (char *) node,
1277 .overlay = (char *) overlay
1279 TransactionAction action = {
1280 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1281 .u.blockdev_snapshot.data = &snapshot_data,
1283 blockdev_do_action(&action, errp);
1286 void qmp_blockdev_snapshot_internal_sync(const char *device,
1287 const char *name,
1288 Error **errp)
1290 BlockdevSnapshotInternal snapshot = {
1291 .device = (char *) device,
1292 .name = (char *) name
1294 TransactionAction action = {
1295 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1296 .u.blockdev_snapshot_internal_sync.data = &snapshot,
1298 blockdev_do_action(&action, errp);
1301 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1302 bool has_id,
1303 const char *id,
1304 bool has_name,
1305 const char *name,
1306 Error **errp)
1308 BlockDriverState *bs;
1309 BlockBackend *blk;
1310 AioContext *aio_context;
1311 QEMUSnapshotInfo sn;
1312 Error *local_err = NULL;
1313 SnapshotInfo *info = NULL;
1314 int ret;
1316 blk = blk_by_name(device);
1317 if (!blk) {
1318 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1319 "Device '%s' not found", device);
1320 return NULL;
1323 aio_context = blk_get_aio_context(blk);
1324 aio_context_acquire(aio_context);
1326 if (!has_id) {
1327 id = NULL;
1330 if (!has_name) {
1331 name = NULL;
1334 if (!id && !name) {
1335 error_setg(errp, "Name or id must be provided");
1336 goto out_aio_context;
1339 if (!blk_is_available(blk)) {
1340 error_setg(errp, "Device '%s' has no medium", device);
1341 goto out_aio_context;
1343 bs = blk_bs(blk);
1345 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1346 goto out_aio_context;
1349 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1350 if (local_err) {
1351 error_propagate(errp, local_err);
1352 goto out_aio_context;
1354 if (!ret) {
1355 error_setg(errp,
1356 "Snapshot with id '%s' and name '%s' does not exist on "
1357 "device '%s'",
1358 STR_OR_NULL(id), STR_OR_NULL(name), device);
1359 goto out_aio_context;
1362 bdrv_snapshot_delete(bs, id, name, &local_err);
1363 if (local_err) {
1364 error_propagate(errp, local_err);
1365 goto out_aio_context;
1368 aio_context_release(aio_context);
1370 info = g_new0(SnapshotInfo, 1);
1371 info->id = g_strdup(sn.id_str);
1372 info->name = g_strdup(sn.name);
1373 info->date_nsec = sn.date_nsec;
1374 info->date_sec = sn.date_sec;
1375 info->vm_state_size = sn.vm_state_size;
1376 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1377 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1379 return info;
1381 out_aio_context:
1382 aio_context_release(aio_context);
1383 return NULL;
1387 * block_dirty_bitmap_lookup:
1388 * Return a dirty bitmap (if present), after validating
1389 * the node reference and bitmap names.
1391 * @node: The name of the BDS node to search for bitmaps
1392 * @name: The name of the bitmap to search for
1393 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1394 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1395 * @errp: Output pointer for error information. Can be NULL.
1397 * @return: A bitmap object on success, or NULL on failure.
1399 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1400 const char *name,
1401 BlockDriverState **pbs,
1402 AioContext **paio,
1403 Error **errp)
1405 BlockDriverState *bs;
1406 BdrvDirtyBitmap *bitmap;
1407 AioContext *aio_context;
1409 if (!node) {
1410 error_setg(errp, "Node cannot be NULL");
1411 return NULL;
1413 if (!name) {
1414 error_setg(errp, "Bitmap name cannot be NULL");
1415 return NULL;
1417 bs = bdrv_lookup_bs(node, node, NULL);
1418 if (!bs) {
1419 error_setg(errp, "Node '%s' not found", node);
1420 return NULL;
1423 aio_context = bdrv_get_aio_context(bs);
1424 aio_context_acquire(aio_context);
1426 bitmap = bdrv_find_dirty_bitmap(bs, name);
1427 if (!bitmap) {
1428 error_setg(errp, "Dirty bitmap '%s' not found", name);
1429 goto fail;
1432 if (pbs) {
1433 *pbs = bs;
1435 if (paio) {
1436 *paio = aio_context;
1437 } else {
1438 aio_context_release(aio_context);
1441 return bitmap;
1443 fail:
1444 aio_context_release(aio_context);
1445 return NULL;
1448 /* New and old BlockDriverState structs for atomic group operations */
1450 typedef struct BlkActionState BlkActionState;
1453 * BlkActionOps:
1454 * Table of operations that define an Action.
1456 * @instance_size: Size of state struct, in bytes.
1457 * @prepare: Prepare the work, must NOT be NULL.
1458 * @commit: Commit the changes, can be NULL.
1459 * @abort: Abort the changes on fail, can be NULL.
1460 * @clean: Clean up resources after all transaction actions have called
1461 * commit() or abort(). Can be NULL.
1463 * Only prepare() may fail. In a single transaction, only one of commit() or
1464 * abort() will be called. clean() will always be called if it is present.
1466 typedef struct BlkActionOps {
1467 size_t instance_size;
1468 void (*prepare)(BlkActionState *common, Error **errp);
1469 void (*commit)(BlkActionState *common);
1470 void (*abort)(BlkActionState *common);
1471 void (*clean)(BlkActionState *common);
1472 } BlkActionOps;
1475 * BlkActionState:
1476 * Describes one Action's state within a Transaction.
1478 * @action: QAPI-defined enum identifying which Action to perform.
1479 * @ops: Table of ActionOps this Action can perform.
1480 * @block_job_txn: Transaction which this action belongs to.
1481 * @entry: List membership for all Actions in this Transaction.
1483 * This structure must be arranged as first member in a subclassed type,
1484 * assuming that the compiler will also arrange it to the same offsets as the
1485 * base class.
1487 struct BlkActionState {
1488 TransactionAction *action;
1489 const BlkActionOps *ops;
1490 BlockJobTxn *block_job_txn;
1491 TransactionProperties *txn_props;
1492 QSIMPLEQ_ENTRY(BlkActionState) entry;
1495 /* internal snapshot private data */
1496 typedef struct InternalSnapshotState {
1497 BlkActionState common;
1498 BlockDriverState *bs;
1499 AioContext *aio_context;
1500 QEMUSnapshotInfo sn;
1501 bool created;
1502 } InternalSnapshotState;
1505 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1507 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1508 error_setg(errp,
1509 "Action '%s' does not support Transaction property "
1510 "completion-mode = %s",
1511 TransactionActionKind_lookup[s->action->type],
1512 ActionCompletionMode_lookup[s->txn_props->completion_mode]);
1513 return -1;
1515 return 0;
1518 static void internal_snapshot_prepare(BlkActionState *common,
1519 Error **errp)
1521 Error *local_err = NULL;
1522 const char *device;
1523 const char *name;
1524 BlockBackend *blk;
1525 BlockDriverState *bs;
1526 QEMUSnapshotInfo old_sn, *sn;
1527 bool ret;
1528 qemu_timeval tv;
1529 BlockdevSnapshotInternal *internal;
1530 InternalSnapshotState *state;
1531 int ret1;
1533 g_assert(common->action->type ==
1534 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1535 internal = common->action->u.blockdev_snapshot_internal_sync.data;
1536 state = DO_UPCAST(InternalSnapshotState, common, common);
1538 /* 1. parse input */
1539 device = internal->device;
1540 name = internal->name;
1542 /* 2. check for validation */
1543 if (action_check_completion_mode(common, errp) < 0) {
1544 return;
1547 blk = blk_by_name(device);
1548 if (!blk) {
1549 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1550 "Device '%s' not found", device);
1551 return;
1554 /* AioContext is released in .clean() */
1555 state->aio_context = blk_get_aio_context(blk);
1556 aio_context_acquire(state->aio_context);
1558 if (!blk_is_available(blk)) {
1559 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1560 return;
1562 bs = blk_bs(blk);
1564 state->bs = bs;
1565 bdrv_drained_begin(bs);
1567 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1568 return;
1571 if (bdrv_is_read_only(bs)) {
1572 error_setg(errp, "Device '%s' is read only", device);
1573 return;
1576 if (!bdrv_can_snapshot(bs)) {
1577 error_setg(errp, "Block format '%s' used by device '%s' "
1578 "does not support internal snapshots",
1579 bs->drv->format_name, device);
1580 return;
1583 if (!strlen(name)) {
1584 error_setg(errp, "Name is empty");
1585 return;
1588 /* check whether a snapshot with name exist */
1589 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1590 &local_err);
1591 if (local_err) {
1592 error_propagate(errp, local_err);
1593 return;
1594 } else if (ret) {
1595 error_setg(errp,
1596 "Snapshot with name '%s' already exists on device '%s'",
1597 name, device);
1598 return;
1601 /* 3. take the snapshot */
1602 sn = &state->sn;
1603 pstrcpy(sn->name, sizeof(sn->name), name);
1604 qemu_gettimeofday(&tv);
1605 sn->date_sec = tv.tv_sec;
1606 sn->date_nsec = tv.tv_usec * 1000;
1607 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1609 ret1 = bdrv_snapshot_create(bs, sn);
1610 if (ret1 < 0) {
1611 error_setg_errno(errp, -ret1,
1612 "Failed to create snapshot '%s' on device '%s'",
1613 name, device);
1614 return;
1617 /* 4. succeed, mark a snapshot is created */
1618 state->created = true;
1621 static void internal_snapshot_abort(BlkActionState *common)
1623 InternalSnapshotState *state =
1624 DO_UPCAST(InternalSnapshotState, common, common);
1625 BlockDriverState *bs = state->bs;
1626 QEMUSnapshotInfo *sn = &state->sn;
1627 Error *local_error = NULL;
1629 if (!state->created) {
1630 return;
1633 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1634 error_reportf_err(local_error,
1635 "Failed to delete snapshot with id '%s' and "
1636 "name '%s' on device '%s' in abort: ",
1637 sn->id_str, sn->name,
1638 bdrv_get_device_name(bs));
1642 static void internal_snapshot_clean(BlkActionState *common)
1644 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1645 common, common);
1647 if (state->aio_context) {
1648 if (state->bs) {
1649 bdrv_drained_end(state->bs);
1651 aio_context_release(state->aio_context);
1655 /* external snapshot private data */
1656 typedef struct ExternalSnapshotState {
1657 BlkActionState common;
1658 BlockDriverState *old_bs;
1659 BlockDriverState *new_bs;
1660 AioContext *aio_context;
1661 } ExternalSnapshotState;
1663 static void external_snapshot_prepare(BlkActionState *common,
1664 Error **errp)
1666 int flags = 0;
1667 QDict *options = NULL;
1668 Error *local_err = NULL;
1669 /* Device and node name of the image to generate the snapshot from */
1670 const char *device;
1671 const char *node_name;
1672 /* Reference to the new image (for 'blockdev-snapshot') */
1673 const char *snapshot_ref;
1674 /* File name of the new image (for 'blockdev-snapshot-sync') */
1675 const char *new_image_file;
1676 ExternalSnapshotState *state =
1677 DO_UPCAST(ExternalSnapshotState, common, common);
1678 TransactionAction *action = common->action;
1680 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1681 * purpose but a different set of parameters */
1682 switch (action->type) {
1683 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1685 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1686 device = s->node;
1687 node_name = s->node;
1688 new_image_file = NULL;
1689 snapshot_ref = s->overlay;
1691 break;
1692 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1694 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1695 device = s->has_device ? s->device : NULL;
1696 node_name = s->has_node_name ? s->node_name : NULL;
1697 new_image_file = s->snapshot_file;
1698 snapshot_ref = NULL;
1700 break;
1701 default:
1702 g_assert_not_reached();
1705 /* start processing */
1706 if (action_check_completion_mode(common, errp) < 0) {
1707 return;
1710 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1711 if (!state->old_bs) {
1712 return;
1715 /* Acquire AioContext now so any threads operating on old_bs stop */
1716 state->aio_context = bdrv_get_aio_context(state->old_bs);
1717 aio_context_acquire(state->aio_context);
1718 bdrv_drained_begin(state->old_bs);
1720 if (!bdrv_is_inserted(state->old_bs)) {
1721 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1722 return;
1725 if (bdrv_op_is_blocked(state->old_bs,
1726 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1727 return;
1730 if (!bdrv_is_read_only(state->old_bs)) {
1731 if (bdrv_flush(state->old_bs)) {
1732 error_setg(errp, QERR_IO_ERROR);
1733 return;
1737 if (!bdrv_is_first_non_filter(state->old_bs)) {
1738 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1739 return;
1742 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1743 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1744 const char *format = s->has_format ? s->format : "qcow2";
1745 enum NewImageMode mode;
1746 const char *snapshot_node_name =
1747 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1749 if (node_name && !snapshot_node_name) {
1750 error_setg(errp, "New snapshot node name missing");
1751 return;
1754 if (snapshot_node_name &&
1755 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1756 error_setg(errp, "New snapshot node name already in use");
1757 return;
1760 flags = state->old_bs->open_flags;
1761 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1763 /* create new image w/backing file */
1764 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1765 if (mode != NEW_IMAGE_MODE_EXISTING) {
1766 int64_t size = bdrv_getlength(state->old_bs);
1767 if (size < 0) {
1768 error_setg_errno(errp, -size, "bdrv_getlength failed");
1769 return;
1771 bdrv_img_create(new_image_file, format,
1772 state->old_bs->filename,
1773 state->old_bs->drv->format_name,
1774 NULL, size, flags, &local_err, false);
1775 if (local_err) {
1776 error_propagate(errp, local_err);
1777 return;
1781 options = qdict_new();
1782 if (s->has_snapshot_node_name) {
1783 qdict_put(options, "node-name",
1784 qstring_from_str(snapshot_node_name));
1786 qdict_put(options, "driver", qstring_from_str(format));
1788 flags |= BDRV_O_NO_BACKING;
1791 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1792 errp);
1793 /* We will manually add the backing_hd field to the bs later */
1794 if (!state->new_bs) {
1795 return;
1798 if (bdrv_has_blk(state->new_bs)) {
1799 error_setg(errp, "The snapshot is already in use by %s",
1800 bdrv_get_parent_name(state->new_bs));
1801 return;
1804 if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
1805 errp)) {
1806 return;
1809 if (state->new_bs->backing != NULL) {
1810 error_setg(errp, "The snapshot already has a backing image");
1811 return;
1814 if (!state->new_bs->drv->supports_backing) {
1815 error_setg(errp, "The snapshot does not support backing images");
1819 static void external_snapshot_commit(BlkActionState *common)
1821 ExternalSnapshotState *state =
1822 DO_UPCAST(ExternalSnapshotState, common, common);
1824 bdrv_set_aio_context(state->new_bs, state->aio_context);
1826 /* This removes our old bs and adds the new bs */
1827 bdrv_append(state->new_bs, state->old_bs);
1828 /* We don't need (or want) to use the transactional
1829 * bdrv_reopen_multiple() across all the entries at once, because we
1830 * don't want to abort all of them if one of them fails the reopen */
1831 if (!state->old_bs->copy_on_read) {
1832 bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1833 NULL);
1837 static void external_snapshot_abort(BlkActionState *common)
1839 ExternalSnapshotState *state =
1840 DO_UPCAST(ExternalSnapshotState, common, common);
1841 if (state->new_bs) {
1842 bdrv_unref(state->new_bs);
1846 static void external_snapshot_clean(BlkActionState *common)
1848 ExternalSnapshotState *state =
1849 DO_UPCAST(ExternalSnapshotState, common, common);
1850 if (state->aio_context) {
1851 bdrv_drained_end(state->old_bs);
1852 aio_context_release(state->aio_context);
1856 typedef struct DriveBackupState {
1857 BlkActionState common;
1858 BlockDriverState *bs;
1859 AioContext *aio_context;
1860 BlockJob *job;
1861 } DriveBackupState;
1863 static void do_drive_backup(const char *job_id, const char *device,
1864 const char *target, bool has_format,
1865 const char *format, enum MirrorSyncMode sync,
1866 bool has_mode, enum NewImageMode mode,
1867 bool has_speed, int64_t speed,
1868 bool has_bitmap, const char *bitmap,
1869 bool has_on_source_error,
1870 BlockdevOnError on_source_error,
1871 bool has_on_target_error,
1872 BlockdevOnError on_target_error,
1873 BlockJobTxn *txn, Error **errp);
1875 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1877 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1878 BlockBackend *blk;
1879 DriveBackup *backup;
1880 Error *local_err = NULL;
1882 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1883 backup = common->action->u.drive_backup.data;
1885 blk = blk_by_name(backup->device);
1886 if (!blk) {
1887 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1888 "Device '%s' not found", backup->device);
1889 return;
1892 if (!blk_is_available(blk)) {
1893 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1894 return;
1897 /* AioContext is released in .clean() */
1898 state->aio_context = blk_get_aio_context(blk);
1899 aio_context_acquire(state->aio_context);
1900 bdrv_drained_begin(blk_bs(blk));
1901 state->bs = blk_bs(blk);
1903 do_drive_backup(backup->has_job_id ? backup->job_id : NULL,
1904 backup->device, backup->target,
1905 backup->has_format, backup->format,
1906 backup->sync,
1907 backup->has_mode, backup->mode,
1908 backup->has_speed, backup->speed,
1909 backup->has_bitmap, backup->bitmap,
1910 backup->has_on_source_error, backup->on_source_error,
1911 backup->has_on_target_error, backup->on_target_error,
1912 common->block_job_txn, &local_err);
1913 if (local_err) {
1914 error_propagate(errp, local_err);
1915 return;
1918 state->job = state->bs->job;
1921 static void drive_backup_abort(BlkActionState *common)
1923 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1924 BlockDriverState *bs = state->bs;
1926 /* Only cancel if it's the job we started */
1927 if (bs && bs->job && bs->job == state->job) {
1928 block_job_cancel_sync(bs->job);
1932 static void drive_backup_clean(BlkActionState *common)
1934 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1936 if (state->aio_context) {
1937 bdrv_drained_end(state->bs);
1938 aio_context_release(state->aio_context);
1942 typedef struct BlockdevBackupState {
1943 BlkActionState common;
1944 BlockDriverState *bs;
1945 BlockJob *job;
1946 AioContext *aio_context;
1947 } BlockdevBackupState;
1949 static void do_blockdev_backup(const char *job_id, const char *device,
1950 const char *target, enum MirrorSyncMode sync,
1951 bool has_speed, int64_t speed,
1952 bool has_on_source_error,
1953 BlockdevOnError on_source_error,
1954 bool has_on_target_error,
1955 BlockdevOnError on_target_error,
1956 BlockJobTxn *txn, Error **errp);
1958 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1960 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1961 BlockdevBackup *backup;
1962 BlockDriverState *bs, *target;
1963 Error *local_err = NULL;
1965 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1966 backup = common->action->u.blockdev_backup.data;
1968 bs = qmp_get_root_bs(backup->device, errp);
1969 if (!bs) {
1970 return;
1973 target = bdrv_lookup_bs(backup->target, backup->target, errp);
1974 if (!target) {
1975 return;
1978 /* AioContext is released in .clean() */
1979 state->aio_context = bdrv_get_aio_context(bs);
1980 if (state->aio_context != bdrv_get_aio_context(target)) {
1981 state->aio_context = NULL;
1982 error_setg(errp, "Backup between two IO threads is not implemented");
1983 return;
1985 aio_context_acquire(state->aio_context);
1986 state->bs = bs;
1987 bdrv_drained_begin(state->bs);
1989 do_blockdev_backup(backup->has_job_id ? backup->job_id : NULL,
1990 backup->device, backup->target, backup->sync,
1991 backup->has_speed, backup->speed,
1992 backup->has_on_source_error, backup->on_source_error,
1993 backup->has_on_target_error, backup->on_target_error,
1994 common->block_job_txn, &local_err);
1995 if (local_err) {
1996 error_propagate(errp, local_err);
1997 return;
2000 state->job = state->bs->job;
2003 static void blockdev_backup_abort(BlkActionState *common)
2005 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
2006 BlockDriverState *bs = state->bs;
2008 /* Only cancel if it's the job we started */
2009 if (bs && bs->job && bs->job == state->job) {
2010 block_job_cancel_sync(bs->job);
2014 static void blockdev_backup_clean(BlkActionState *common)
2016 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
2018 if (state->aio_context) {
2019 bdrv_drained_end(state->bs);
2020 aio_context_release(state->aio_context);
2024 typedef struct BlockDirtyBitmapState {
2025 BlkActionState common;
2026 BdrvDirtyBitmap *bitmap;
2027 BlockDriverState *bs;
2028 AioContext *aio_context;
2029 HBitmap *backup;
2030 bool prepared;
2031 } BlockDirtyBitmapState;
2033 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
2034 Error **errp)
2036 Error *local_err = NULL;
2037 BlockDirtyBitmapAdd *action;
2038 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2039 common, common);
2041 if (action_check_completion_mode(common, errp) < 0) {
2042 return;
2045 action = common->action->u.block_dirty_bitmap_add.data;
2046 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2047 qmp_block_dirty_bitmap_add(action->node, action->name,
2048 action->has_granularity, action->granularity,
2049 &local_err);
2051 if (!local_err) {
2052 state->prepared = true;
2053 } else {
2054 error_propagate(errp, local_err);
2058 static void block_dirty_bitmap_add_abort(BlkActionState *common)
2060 BlockDirtyBitmapAdd *action;
2061 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2062 common, common);
2064 action = common->action->u.block_dirty_bitmap_add.data;
2065 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2066 * then the node reference and bitmap name must have been valid.
2068 if (state->prepared) {
2069 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2073 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
2074 Error **errp)
2076 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2077 common, common);
2078 BlockDirtyBitmap *action;
2080 if (action_check_completion_mode(common, errp) < 0) {
2081 return;
2084 action = common->action->u.block_dirty_bitmap_clear.data;
2085 state->bitmap = block_dirty_bitmap_lookup(action->node,
2086 action->name,
2087 &state->bs,
2088 &state->aio_context,
2089 errp);
2090 if (!state->bitmap) {
2091 return;
2094 if (bdrv_dirty_bitmap_frozen(state->bitmap)) {
2095 error_setg(errp, "Cannot modify a frozen bitmap");
2096 return;
2097 } else if (!bdrv_dirty_bitmap_enabled(state->bitmap)) {
2098 error_setg(errp, "Cannot clear a disabled bitmap");
2099 return;
2102 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2103 /* AioContext is released in .clean() */
2106 static void block_dirty_bitmap_clear_abort(BlkActionState *common)
2108 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2109 common, common);
2111 bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
2114 static void block_dirty_bitmap_clear_commit(BlkActionState *common)
2116 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2117 common, common);
2119 hbitmap_free(state->backup);
2122 static void block_dirty_bitmap_clear_clean(BlkActionState *common)
2124 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2125 common, common);
2127 if (state->aio_context) {
2128 aio_context_release(state->aio_context);
2132 static void abort_prepare(BlkActionState *common, Error **errp)
2134 error_setg(errp, "Transaction aborted using Abort action");
2137 static void abort_commit(BlkActionState *common)
2139 g_assert_not_reached(); /* this action never succeeds */
2142 static const BlkActionOps actions[] = {
2143 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2144 .instance_size = sizeof(ExternalSnapshotState),
2145 .prepare = external_snapshot_prepare,
2146 .commit = external_snapshot_commit,
2147 .abort = external_snapshot_abort,
2148 .clean = external_snapshot_clean,
2150 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2151 .instance_size = sizeof(ExternalSnapshotState),
2152 .prepare = external_snapshot_prepare,
2153 .commit = external_snapshot_commit,
2154 .abort = external_snapshot_abort,
2155 .clean = external_snapshot_clean,
2157 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2158 .instance_size = sizeof(DriveBackupState),
2159 .prepare = drive_backup_prepare,
2160 .abort = drive_backup_abort,
2161 .clean = drive_backup_clean,
2163 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2164 .instance_size = sizeof(BlockdevBackupState),
2165 .prepare = blockdev_backup_prepare,
2166 .abort = blockdev_backup_abort,
2167 .clean = blockdev_backup_clean,
2169 [TRANSACTION_ACTION_KIND_ABORT] = {
2170 .instance_size = sizeof(BlkActionState),
2171 .prepare = abort_prepare,
2172 .commit = abort_commit,
2174 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2175 .instance_size = sizeof(InternalSnapshotState),
2176 .prepare = internal_snapshot_prepare,
2177 .abort = internal_snapshot_abort,
2178 .clean = internal_snapshot_clean,
2180 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2181 .instance_size = sizeof(BlockDirtyBitmapState),
2182 .prepare = block_dirty_bitmap_add_prepare,
2183 .abort = block_dirty_bitmap_add_abort,
2185 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2186 .instance_size = sizeof(BlockDirtyBitmapState),
2187 .prepare = block_dirty_bitmap_clear_prepare,
2188 .commit = block_dirty_bitmap_clear_commit,
2189 .abort = block_dirty_bitmap_clear_abort,
2190 .clean = block_dirty_bitmap_clear_clean,
2195 * Allocate a TransactionProperties structure if necessary, and fill
2196 * that structure with desired defaults if they are unset.
2198 static TransactionProperties *get_transaction_properties(
2199 TransactionProperties *props)
2201 if (!props) {
2202 props = g_new0(TransactionProperties, 1);
2205 if (!props->has_completion_mode) {
2206 props->has_completion_mode = true;
2207 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2210 return props;
2214 * 'Atomic' group operations. The operations are performed as a set, and if
2215 * any fail then we roll back all operations in the group.
2217 void qmp_transaction(TransactionActionList *dev_list,
2218 bool has_props,
2219 struct TransactionProperties *props,
2220 Error **errp)
2222 TransactionActionList *dev_entry = dev_list;
2223 BlockJobTxn *block_job_txn = NULL;
2224 BlkActionState *state, *next;
2225 Error *local_err = NULL;
2227 QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2228 QSIMPLEQ_INIT(&snap_bdrv_states);
2230 /* Does this transaction get canceled as a group on failure?
2231 * If not, we don't really need to make a BlockJobTxn.
2233 props = get_transaction_properties(props);
2234 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2235 block_job_txn = block_job_txn_new();
2238 /* drain all i/o before any operations */
2239 bdrv_drain_all();
2241 /* We don't do anything in this loop that commits us to the operations */
2242 while (NULL != dev_entry) {
2243 TransactionAction *dev_info = NULL;
2244 const BlkActionOps *ops;
2246 dev_info = dev_entry->value;
2247 dev_entry = dev_entry->next;
2249 assert(dev_info->type < ARRAY_SIZE(actions));
2251 ops = &actions[dev_info->type];
2252 assert(ops->instance_size > 0);
2254 state = g_malloc0(ops->instance_size);
2255 state->ops = ops;
2256 state->action = dev_info;
2257 state->block_job_txn = block_job_txn;
2258 state->txn_props = props;
2259 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2261 state->ops->prepare(state, &local_err);
2262 if (local_err) {
2263 error_propagate(errp, local_err);
2264 goto delete_and_fail;
2268 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2269 if (state->ops->commit) {
2270 state->ops->commit(state);
2274 /* success */
2275 goto exit;
2277 delete_and_fail:
2278 /* failure, and it is all-or-none; roll back all operations */
2279 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2280 if (state->ops->abort) {
2281 state->ops->abort(state);
2284 exit:
2285 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2286 if (state->ops->clean) {
2287 state->ops->clean(state);
2289 g_free(state);
2291 if (!has_props) {
2292 qapi_free_TransactionProperties(props);
2294 block_job_txn_unref(block_job_txn);
2297 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2299 Error *local_err = NULL;
2300 int rc;
2302 if (!has_force) {
2303 force = false;
2306 rc = do_open_tray(device, force, &local_err);
2307 if (rc && rc != -ENOSYS) {
2308 error_propagate(errp, local_err);
2309 return;
2311 error_free(local_err);
2313 qmp_x_blockdev_remove_medium(device, errp);
2316 void qmp_block_passwd(bool has_device, const char *device,
2317 bool has_node_name, const char *node_name,
2318 const char *password, Error **errp)
2320 Error *local_err = NULL;
2321 BlockDriverState *bs;
2322 AioContext *aio_context;
2324 bs = bdrv_lookup_bs(has_device ? device : NULL,
2325 has_node_name ? node_name : NULL,
2326 &local_err);
2327 if (local_err) {
2328 error_propagate(errp, local_err);
2329 return;
2332 aio_context = bdrv_get_aio_context(bs);
2333 aio_context_acquire(aio_context);
2335 bdrv_add_key(bs, password, errp);
2337 aio_context_release(aio_context);
2341 * Attempt to open the tray of @device.
2342 * If @force, ignore its tray lock.
2343 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2344 * On error, store an error through @errp and return -errno.
2345 * If @device does not exist, return -ENODEV.
2346 * If it has no removable media, return -ENOTSUP.
2347 * If it has no tray, return -ENOSYS.
2348 * If the guest was asked to open the tray, return -EINPROGRESS.
2349 * Else, return 0.
2351 static int do_open_tray(const char *device, bool force, Error **errp)
2353 BlockBackend *blk;
2354 bool locked;
2356 blk = blk_by_name(device);
2357 if (!blk) {
2358 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2359 "Device '%s' not found", device);
2360 return -ENODEV;
2363 if (!blk_dev_has_removable_media(blk)) {
2364 error_setg(errp, "Device '%s' is not removable", device);
2365 return -ENOTSUP;
2368 if (!blk_dev_has_tray(blk)) {
2369 error_setg(errp, "Device '%s' does not have a tray", device);
2370 return -ENOSYS;
2373 if (blk_dev_is_tray_open(blk)) {
2374 return 0;
2377 locked = blk_dev_is_medium_locked(blk);
2378 if (locked) {
2379 blk_dev_eject_request(blk, force);
2382 if (!locked || force) {
2383 blk_dev_change_media_cb(blk, false);
2386 if (locked && !force) {
2387 error_setg(errp, "Device '%s' is locked and force was not specified, "
2388 "wait for tray to open and try again", device);
2389 return -EINPROGRESS;
2392 return 0;
2395 void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
2396 Error **errp)
2398 Error *local_err = NULL;
2399 int rc;
2401 if (!has_force) {
2402 force = false;
2404 rc = do_open_tray(device, force, &local_err);
2405 if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2406 error_propagate(errp, local_err);
2407 return;
2409 error_free(local_err);
2412 void qmp_blockdev_close_tray(const char *device, Error **errp)
2414 BlockBackend *blk;
2416 blk = blk_by_name(device);
2417 if (!blk) {
2418 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2419 "Device '%s' not found", device);
2420 return;
2423 if (!blk_dev_has_removable_media(blk)) {
2424 error_setg(errp, "Device '%s' is not removable", device);
2425 return;
2428 if (!blk_dev_has_tray(blk)) {
2429 /* Ignore this command on tray-less devices */
2430 return;
2433 if (!blk_dev_is_tray_open(blk)) {
2434 return;
2437 blk_dev_change_media_cb(blk, true);
2440 void qmp_x_blockdev_remove_medium(const char *device, Error **errp)
2442 BlockBackend *blk;
2443 BlockDriverState *bs;
2444 AioContext *aio_context;
2445 bool has_device;
2447 blk = blk_by_name(device);
2448 if (!blk) {
2449 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2450 "Device '%s' not found", device);
2451 return;
2454 /* For BBs without a device, we can exchange the BDS tree at will */
2455 has_device = blk_get_attached_dev(blk);
2457 if (has_device && !blk_dev_has_removable_media(blk)) {
2458 error_setg(errp, "Device '%s' is not removable", device);
2459 return;
2462 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2463 error_setg(errp, "Tray of device '%s' is not open", device);
2464 return;
2467 bs = blk_bs(blk);
2468 if (!bs) {
2469 return;
2472 aio_context = bdrv_get_aio_context(bs);
2473 aio_context_acquire(aio_context);
2475 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2476 goto out;
2479 blk_remove_bs(blk);
2481 if (!blk_dev_has_tray(blk)) {
2482 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2483 * called at all); therefore, the medium needs to be ejected here.
2484 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2485 * value passed here (i.e. false). */
2486 blk_dev_change_media_cb(blk, false);
2489 out:
2490 aio_context_release(aio_context);
2493 static void qmp_blockdev_insert_anon_medium(const char *device,
2494 BlockDriverState *bs, Error **errp)
2496 BlockBackend *blk;
2497 bool has_device;
2499 blk = blk_by_name(device);
2500 if (!blk) {
2501 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2502 "Device '%s' not found", device);
2503 return;
2506 /* For BBs without a device, we can exchange the BDS tree at will */
2507 has_device = blk_get_attached_dev(blk);
2509 if (has_device && !blk_dev_has_removable_media(blk)) {
2510 error_setg(errp, "Device '%s' is not removable", device);
2511 return;
2514 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2515 error_setg(errp, "Tray of device '%s' is not open", device);
2516 return;
2519 if (blk_bs(blk)) {
2520 error_setg(errp, "There already is a medium in device '%s'", device);
2521 return;
2524 blk_insert_bs(blk, bs);
2526 if (!blk_dev_has_tray(blk)) {
2527 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2528 * called at all); therefore, the medium needs to be pushed into the
2529 * slot here.
2530 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2531 * value passed here (i.e. true). */
2532 blk_dev_change_media_cb(blk, true);
2536 void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
2537 Error **errp)
2539 BlockDriverState *bs;
2541 bs = bdrv_find_node(node_name);
2542 if (!bs) {
2543 error_setg(errp, "Node '%s' not found", node_name);
2544 return;
2547 if (bdrv_has_blk(bs)) {
2548 error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
2549 bdrv_get_parent_name(bs));
2550 return;
2553 qmp_blockdev_insert_anon_medium(device, bs, errp);
2556 void qmp_blockdev_change_medium(const char *device, const char *filename,
2557 bool has_format, const char *format,
2558 bool has_read_only,
2559 BlockdevChangeReadOnlyMode read_only,
2560 Error **errp)
2562 BlockBackend *blk;
2563 BlockDriverState *medium_bs = NULL;
2564 int bdrv_flags;
2565 int rc;
2566 QDict *options = NULL;
2567 Error *err = NULL;
2569 blk = blk_by_name(device);
2570 if (!blk) {
2571 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2572 "Device '%s' not found", device);
2573 goto fail;
2576 if (blk_bs(blk)) {
2577 blk_update_root_state(blk);
2580 bdrv_flags = blk_get_open_flags_from_root_state(blk);
2581 bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2582 BDRV_O_PROTOCOL);
2584 if (!has_read_only) {
2585 read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2588 switch (read_only) {
2589 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2590 break;
2592 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2593 bdrv_flags &= ~BDRV_O_RDWR;
2594 break;
2596 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2597 bdrv_flags |= BDRV_O_RDWR;
2598 break;
2600 default:
2601 abort();
2604 if (has_format) {
2605 options = qdict_new();
2606 qdict_put(options, "driver", qstring_from_str(format));
2609 medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2610 if (!medium_bs) {
2611 goto fail;
2614 bdrv_add_key(medium_bs, NULL, &err);
2615 if (err) {
2616 error_propagate(errp, err);
2617 goto fail;
2620 rc = do_open_tray(device, false, &err);
2621 if (rc && rc != -ENOSYS) {
2622 error_propagate(errp, err);
2623 goto fail;
2625 error_free(err);
2626 err = NULL;
2628 qmp_x_blockdev_remove_medium(device, &err);
2629 if (err) {
2630 error_propagate(errp, err);
2631 goto fail;
2634 qmp_blockdev_insert_anon_medium(device, medium_bs, &err);
2635 if (err) {
2636 error_propagate(errp, err);
2637 goto fail;
2640 blk_apply_root_state(blk, medium_bs);
2642 qmp_blockdev_close_tray(device, errp);
2644 fail:
2645 /* If the medium has been inserted, the device has its own reference, so
2646 * ours must be relinquished; and if it has not been inserted successfully,
2647 * the reference must be relinquished anyway */
2648 bdrv_unref(medium_bs);
2651 /* throttling disk I/O limits */
2652 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2654 ThrottleConfig cfg;
2655 BlockDriverState *bs;
2656 BlockBackend *blk;
2657 AioContext *aio_context;
2659 blk = blk_by_name(arg->device);
2660 if (!blk) {
2661 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2662 "Device '%s' not found", arg->device);
2663 return;
2666 aio_context = blk_get_aio_context(blk);
2667 aio_context_acquire(aio_context);
2669 bs = blk_bs(blk);
2670 if (!bs) {
2671 error_setg(errp, "Device '%s' has no medium", arg->device);
2672 goto out;
2675 throttle_config_init(&cfg);
2676 cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2677 cfg.buckets[THROTTLE_BPS_READ].avg = arg->bps_rd;
2678 cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2680 cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2681 cfg.buckets[THROTTLE_OPS_READ].avg = arg->iops_rd;
2682 cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2684 if (arg->has_bps_max) {
2685 cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2687 if (arg->has_bps_rd_max) {
2688 cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2690 if (arg->has_bps_wr_max) {
2691 cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2693 if (arg->has_iops_max) {
2694 cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2696 if (arg->has_iops_rd_max) {
2697 cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2699 if (arg->has_iops_wr_max) {
2700 cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2703 if (arg->has_bps_max_length) {
2704 cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2706 if (arg->has_bps_rd_max_length) {
2707 cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2709 if (arg->has_bps_wr_max_length) {
2710 cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2712 if (arg->has_iops_max_length) {
2713 cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2715 if (arg->has_iops_rd_max_length) {
2716 cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2718 if (arg->has_iops_wr_max_length) {
2719 cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2722 if (arg->has_iops_size) {
2723 cfg.op_size = arg->iops_size;
2726 if (!throttle_is_valid(&cfg, errp)) {
2727 goto out;
2730 if (throttle_enabled(&cfg)) {
2731 /* Enable I/O limits if they're not enabled yet, otherwise
2732 * just update the throttling group. */
2733 if (!blk_get_public(blk)->throttle_state) {
2734 blk_io_limits_enable(blk,
2735 arg->has_group ? arg->group : arg->device);
2736 } else if (arg->has_group) {
2737 blk_io_limits_update_group(blk, arg->group);
2739 /* Set the new throttling configuration */
2740 blk_set_io_limits(blk, &cfg);
2741 } else if (blk_get_public(blk)->throttle_state) {
2742 /* If all throttling settings are set to 0, disable I/O limits */
2743 blk_io_limits_disable(blk);
2746 out:
2747 aio_context_release(aio_context);
2750 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2751 bool has_granularity, uint32_t granularity,
2752 Error **errp)
2754 AioContext *aio_context;
2755 BlockDriverState *bs;
2757 if (!name || name[0] == '\0') {
2758 error_setg(errp, "Bitmap name cannot be empty");
2759 return;
2762 bs = bdrv_lookup_bs(node, node, errp);
2763 if (!bs) {
2764 return;
2767 aio_context = bdrv_get_aio_context(bs);
2768 aio_context_acquire(aio_context);
2770 if (has_granularity) {
2771 if (granularity < 512 || !is_power_of_2(granularity)) {
2772 error_setg(errp, "Granularity must be power of 2 "
2773 "and at least 512");
2774 goto out;
2776 } else {
2777 /* Default to cluster size, if available: */
2778 granularity = bdrv_get_default_bitmap_granularity(bs);
2781 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2783 out:
2784 aio_context_release(aio_context);
2787 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2788 Error **errp)
2790 AioContext *aio_context;
2791 BlockDriverState *bs;
2792 BdrvDirtyBitmap *bitmap;
2794 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2795 if (!bitmap || !bs) {
2796 return;
2799 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2800 error_setg(errp,
2801 "Bitmap '%s' is currently frozen and cannot be removed",
2802 name);
2803 goto out;
2805 bdrv_dirty_bitmap_make_anon(bitmap);
2806 bdrv_release_dirty_bitmap(bs, bitmap);
2808 out:
2809 aio_context_release(aio_context);
2813 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2814 * immediately after a full backup operation.
2816 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2817 Error **errp)
2819 AioContext *aio_context;
2820 BdrvDirtyBitmap *bitmap;
2821 BlockDriverState *bs;
2823 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2824 if (!bitmap || !bs) {
2825 return;
2828 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2829 error_setg(errp,
2830 "Bitmap '%s' is currently frozen and cannot be modified",
2831 name);
2832 goto out;
2833 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2834 error_setg(errp,
2835 "Bitmap '%s' is currently disabled and cannot be cleared",
2836 name);
2837 goto out;
2840 bdrv_clear_dirty_bitmap(bitmap, NULL);
2842 out:
2843 aio_context_release(aio_context);
2846 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2848 const char *id = qdict_get_str(qdict, "id");
2849 BlockBackend *blk;
2850 BlockDriverState *bs;
2851 AioContext *aio_context;
2852 Error *local_err = NULL;
2854 bs = bdrv_find_node(id);
2855 if (bs) {
2856 qmp_x_blockdev_del(false, NULL, true, id, &local_err);
2857 if (local_err) {
2858 error_report_err(local_err);
2860 return;
2863 blk = blk_by_name(id);
2864 if (!blk) {
2865 error_report("Device '%s' not found", id);
2866 return;
2869 if (!blk_legacy_dinfo(blk)) {
2870 error_report("Deleting device added with blockdev-add"
2871 " is not supported");
2872 return;
2875 aio_context = blk_get_aio_context(blk);
2876 aio_context_acquire(aio_context);
2878 bs = blk_bs(blk);
2879 if (bs) {
2880 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2881 error_report_err(local_err);
2882 aio_context_release(aio_context);
2883 return;
2886 blk_remove_bs(blk);
2889 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2890 monitor_remove_blk(blk);
2892 /* If this BlockBackend has a device attached to it, its refcount will be
2893 * decremented when the device is removed; otherwise we have to do so here.
2895 if (blk_get_attached_dev(blk)) {
2896 /* Further I/O must not pause the guest */
2897 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2898 BLOCKDEV_ON_ERROR_REPORT);
2899 } else {
2900 blk_unref(blk);
2903 aio_context_release(aio_context);
2906 void qmp_block_resize(bool has_device, const char *device,
2907 bool has_node_name, const char *node_name,
2908 int64_t size, Error **errp)
2910 Error *local_err = NULL;
2911 BlockDriverState *bs;
2912 AioContext *aio_context;
2913 int ret;
2915 bs = bdrv_lookup_bs(has_device ? device : NULL,
2916 has_node_name ? node_name : NULL,
2917 &local_err);
2918 if (local_err) {
2919 error_propagate(errp, local_err);
2920 return;
2923 aio_context = bdrv_get_aio_context(bs);
2924 aio_context_acquire(aio_context);
2926 if (!bdrv_is_first_non_filter(bs)) {
2927 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2928 goto out;
2931 if (size < 0) {
2932 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2933 goto out;
2936 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2937 error_setg(errp, QERR_DEVICE_IN_USE, device);
2938 goto out;
2941 /* complete all in-flight operations before resizing the device */
2942 bdrv_drain_all();
2944 ret = bdrv_truncate(bs, size);
2945 switch (ret) {
2946 case 0:
2947 break;
2948 case -ENOMEDIUM:
2949 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2950 break;
2951 case -ENOTSUP:
2952 error_setg(errp, QERR_UNSUPPORTED);
2953 break;
2954 case -EACCES:
2955 error_setg(errp, "Device '%s' is read only", device);
2956 break;
2957 case -EBUSY:
2958 error_setg(errp, QERR_DEVICE_IN_USE, device);
2959 break;
2960 default:
2961 error_setg_errno(errp, -ret, "Could not resize");
2962 break;
2965 out:
2966 aio_context_release(aio_context);
2969 static void block_job_cb(void *opaque, int ret)
2971 /* Note that this function may be executed from another AioContext besides
2972 * the QEMU main loop. If you need to access anything that assumes the
2973 * QEMU global mutex, use a BH or introduce a mutex.
2976 BlockDriverState *bs = opaque;
2977 const char *msg = NULL;
2979 trace_block_job_cb(bs, bs->job, ret);
2981 assert(bs->job);
2983 if (ret < 0) {
2984 msg = strerror(-ret);
2987 if (block_job_is_cancelled(bs->job)) {
2988 block_job_event_cancelled(bs->job);
2989 } else {
2990 block_job_event_completed(bs->job, msg);
2994 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
2995 bool has_base, const char *base,
2996 bool has_backing_file, const char *backing_file,
2997 bool has_speed, int64_t speed,
2998 bool has_on_error, BlockdevOnError on_error,
2999 Error **errp)
3001 BlockDriverState *bs;
3002 BlockDriverState *base_bs = NULL;
3003 AioContext *aio_context;
3004 Error *local_err = NULL;
3005 const char *base_name = NULL;
3007 if (!has_on_error) {
3008 on_error = BLOCKDEV_ON_ERROR_REPORT;
3011 bs = qmp_get_root_bs(device, errp);
3012 if (!bs) {
3013 return;
3016 aio_context = bdrv_get_aio_context(bs);
3017 aio_context_acquire(aio_context);
3019 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
3020 goto out;
3023 if (has_base) {
3024 base_bs = bdrv_find_backing_image(bs, base);
3025 if (base_bs == NULL) {
3026 error_setg(errp, QERR_BASE_NOT_FOUND, base);
3027 goto out;
3029 assert(bdrv_get_aio_context(base_bs) == aio_context);
3030 base_name = base;
3033 /* if we are streaming the entire chain, the result will have no backing
3034 * file, and specifying one is therefore an error */
3035 if (base_bs == NULL && has_backing_file) {
3036 error_setg(errp, "backing file specified, but streaming the "
3037 "entire chain");
3038 goto out;
3041 /* backing_file string overrides base bs filename */
3042 base_name = has_backing_file ? backing_file : base_name;
3044 stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
3045 has_speed ? speed : 0, on_error, block_job_cb, bs, &local_err);
3046 if (local_err) {
3047 error_propagate(errp, local_err);
3048 goto out;
3051 trace_qmp_block_stream(bs, bs->job);
3053 out:
3054 aio_context_release(aio_context);
3057 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3058 bool has_base, const char *base,
3059 bool has_top, const char *top,
3060 bool has_backing_file, const char *backing_file,
3061 bool has_speed, int64_t speed,
3062 Error **errp)
3064 BlockDriverState *bs;
3065 BlockDriverState *base_bs, *top_bs;
3066 AioContext *aio_context;
3067 Error *local_err = NULL;
3068 /* This will be part of the QMP command, if/when the
3069 * BlockdevOnError change for blkmirror makes it in
3071 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3073 if (!has_speed) {
3074 speed = 0;
3077 /* Important Note:
3078 * libvirt relies on the DeviceNotFound error class in order to probe for
3079 * live commit feature versions; for this to work, we must make sure to
3080 * perform the device lookup before any generic errors that may occur in a
3081 * scenario in which all optional arguments are omitted. */
3082 bs = qmp_get_root_bs(device, &local_err);
3083 if (!bs) {
3084 bs = bdrv_lookup_bs(device, device, NULL);
3085 if (!bs) {
3086 error_free(local_err);
3087 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3088 "Device '%s' not found", device);
3089 } else {
3090 error_propagate(errp, local_err);
3092 return;
3095 aio_context = bdrv_get_aio_context(bs);
3096 aio_context_acquire(aio_context);
3098 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3099 goto out;
3102 /* default top_bs is the active layer */
3103 top_bs = bs;
3105 if (has_top && top) {
3106 if (strcmp(bs->filename, top) != 0) {
3107 top_bs = bdrv_find_backing_image(bs, top);
3111 if (top_bs == NULL) {
3112 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3113 goto out;
3116 assert(bdrv_get_aio_context(top_bs) == aio_context);
3118 if (has_base && base) {
3119 base_bs = bdrv_find_backing_image(top_bs, base);
3120 } else {
3121 base_bs = bdrv_find_base(top_bs);
3124 if (base_bs == NULL) {
3125 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3126 goto out;
3129 assert(bdrv_get_aio_context(base_bs) == aio_context);
3131 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3132 goto out;
3135 /* Do not allow attempts to commit an image into itself */
3136 if (top_bs == base_bs) {
3137 error_setg(errp, "cannot commit an image into itself");
3138 goto out;
3141 if (top_bs == bs) {
3142 if (has_backing_file) {
3143 error_setg(errp, "'backing-file' specified,"
3144 " but 'top' is the active layer");
3145 goto out;
3147 commit_active_start(has_job_id ? job_id : NULL, bs, base_bs, speed,
3148 on_error, block_job_cb, bs, &local_err);
3149 } else {
3150 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, speed,
3151 on_error, block_job_cb, bs,
3152 has_backing_file ? backing_file : NULL, &local_err);
3154 if (local_err != NULL) {
3155 error_propagate(errp, local_err);
3156 goto out;
3159 out:
3160 aio_context_release(aio_context);
3163 static void do_drive_backup(const char *job_id, const char *device,
3164 const char *target, bool has_format,
3165 const char *format, enum MirrorSyncMode sync,
3166 bool has_mode, enum NewImageMode mode,
3167 bool has_speed, int64_t speed,
3168 bool has_bitmap, const char *bitmap,
3169 bool has_on_source_error,
3170 BlockdevOnError on_source_error,
3171 bool has_on_target_error,
3172 BlockdevOnError on_target_error,
3173 BlockJobTxn *txn, Error **errp)
3175 BlockBackend *blk;
3176 BlockDriverState *bs;
3177 BlockDriverState *target_bs;
3178 BlockDriverState *source = NULL;
3179 BdrvDirtyBitmap *bmap = NULL;
3180 AioContext *aio_context;
3181 QDict *options = NULL;
3182 Error *local_err = NULL;
3183 int flags;
3184 int64_t size;
3186 if (!has_speed) {
3187 speed = 0;
3189 if (!has_on_source_error) {
3190 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3192 if (!has_on_target_error) {
3193 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3195 if (!has_mode) {
3196 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3199 blk = blk_by_name(device);
3200 if (!blk) {
3201 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3202 "Device '%s' not found", device);
3203 return;
3206 aio_context = blk_get_aio_context(blk);
3207 aio_context_acquire(aio_context);
3209 /* Although backup_run has this check too, we need to use bs->drv below, so
3210 * do an early check redundantly. */
3211 if (!blk_is_available(blk)) {
3212 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3213 goto out;
3215 bs = blk_bs(blk);
3217 if (!has_format) {
3218 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
3221 /* Early check to avoid creating target */
3222 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3223 goto out;
3226 flags = bs->open_flags | BDRV_O_RDWR;
3228 /* See if we have a backing HD we can use to create our new image
3229 * on top of. */
3230 if (sync == MIRROR_SYNC_MODE_TOP) {
3231 source = backing_bs(bs);
3232 if (!source) {
3233 sync = MIRROR_SYNC_MODE_FULL;
3236 if (sync == MIRROR_SYNC_MODE_NONE) {
3237 source = bs;
3240 size = bdrv_getlength(bs);
3241 if (size < 0) {
3242 error_setg_errno(errp, -size, "bdrv_getlength failed");
3243 goto out;
3246 if (mode != NEW_IMAGE_MODE_EXISTING) {
3247 assert(format);
3248 if (source) {
3249 bdrv_img_create(target, format, source->filename,
3250 source->drv->format_name, NULL,
3251 size, flags, &local_err, false);
3252 } else {
3253 bdrv_img_create(target, format, NULL, NULL, NULL,
3254 size, flags, &local_err, false);
3258 if (local_err) {
3259 error_propagate(errp, local_err);
3260 goto out;
3263 if (format) {
3264 options = qdict_new();
3265 qdict_put(options, "driver", qstring_from_str(format));
3268 target_bs = bdrv_open(target, NULL, options, flags, errp);
3269 if (!target_bs) {
3270 goto out;
3273 bdrv_set_aio_context(target_bs, aio_context);
3275 if (has_bitmap) {
3276 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
3277 if (!bmap) {
3278 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
3279 bdrv_unref(target_bs);
3280 goto out;
3284 backup_start(job_id, bs, target_bs, speed, sync, bmap,
3285 on_source_error, on_target_error,
3286 block_job_cb, bs, txn, &local_err);
3287 bdrv_unref(target_bs);
3288 if (local_err != NULL) {
3289 error_propagate(errp, local_err);
3290 goto out;
3293 out:
3294 aio_context_release(aio_context);
3297 void qmp_drive_backup(bool has_job_id, const char *job_id,
3298 const char *device, const char *target,
3299 bool has_format, const char *format,
3300 enum MirrorSyncMode sync,
3301 bool has_mode, enum NewImageMode mode,
3302 bool has_speed, int64_t speed,
3303 bool has_bitmap, const char *bitmap,
3304 bool has_on_source_error, BlockdevOnError on_source_error,
3305 bool has_on_target_error, BlockdevOnError on_target_error,
3306 Error **errp)
3308 return do_drive_backup(has_job_id ? job_id : NULL, device, target,
3309 has_format, format, sync,
3310 has_mode, mode, has_speed, speed,
3311 has_bitmap, bitmap,
3312 has_on_source_error, on_source_error,
3313 has_on_target_error, on_target_error,
3314 NULL, errp);
3317 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3319 return bdrv_named_nodes_list(errp);
3322 void do_blockdev_backup(const char *job_id, const char *device,
3323 const char *target, enum MirrorSyncMode sync,
3324 bool has_speed, int64_t speed,
3325 bool has_on_source_error,
3326 BlockdevOnError on_source_error,
3327 bool has_on_target_error,
3328 BlockdevOnError on_target_error,
3329 BlockJobTxn *txn, Error **errp)
3331 BlockDriverState *bs;
3332 BlockDriverState *target_bs;
3333 Error *local_err = NULL;
3334 AioContext *aio_context;
3336 if (!has_speed) {
3337 speed = 0;
3339 if (!has_on_source_error) {
3340 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3342 if (!has_on_target_error) {
3343 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3346 bs = qmp_get_root_bs(device, errp);
3347 if (!bs) {
3348 return;
3351 aio_context = bdrv_get_aio_context(bs);
3352 aio_context_acquire(aio_context);
3354 target_bs = bdrv_lookup_bs(target, target, errp);
3355 if (!target_bs) {
3356 goto out;
3359 if (bdrv_get_aio_context(target_bs) != aio_context) {
3360 if (!bdrv_has_blk(target_bs)) {
3361 /* The target BDS is not attached, we can safely move it to another
3362 * AioContext. */
3363 bdrv_set_aio_context(target_bs, aio_context);
3364 } else {
3365 error_setg(errp, "Target is attached to a different thread from "
3366 "source.");
3367 goto out;
3370 backup_start(job_id, bs, target_bs, speed, sync, NULL, on_source_error,
3371 on_target_error, block_job_cb, bs, txn, &local_err);
3372 if (local_err != NULL) {
3373 error_propagate(errp, local_err);
3375 out:
3376 aio_context_release(aio_context);
3379 void qmp_blockdev_backup(bool has_job_id, const char *job_id,
3380 const char *device, const char *target,
3381 enum MirrorSyncMode sync,
3382 bool has_speed, int64_t speed,
3383 bool has_on_source_error,
3384 BlockdevOnError on_source_error,
3385 bool has_on_target_error,
3386 BlockdevOnError on_target_error,
3387 Error **errp)
3389 do_blockdev_backup(has_job_id ? job_id : NULL, device, target,
3390 sync, has_speed, speed,
3391 has_on_source_error, on_source_error,
3392 has_on_target_error, on_target_error,
3393 NULL, errp);
3396 /* Parameter check and block job starting for drive mirroring.
3397 * Caller should hold @device and @target's aio context (must be the same).
3399 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3400 BlockDriverState *target,
3401 bool has_replaces, const char *replaces,
3402 enum MirrorSyncMode sync,
3403 BlockMirrorBackingMode backing_mode,
3404 bool has_speed, int64_t speed,
3405 bool has_granularity, uint32_t granularity,
3406 bool has_buf_size, int64_t buf_size,
3407 bool has_on_source_error,
3408 BlockdevOnError on_source_error,
3409 bool has_on_target_error,
3410 BlockdevOnError on_target_error,
3411 bool has_unmap, bool unmap,
3412 Error **errp)
3415 if (!has_speed) {
3416 speed = 0;
3418 if (!has_on_source_error) {
3419 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3421 if (!has_on_target_error) {
3422 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3424 if (!has_granularity) {
3425 granularity = 0;
3427 if (!has_buf_size) {
3428 buf_size = 0;
3430 if (!has_unmap) {
3431 unmap = true;
3434 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3435 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3436 "a value in range [512B, 64MB]");
3437 return;
3439 if (granularity & (granularity - 1)) {
3440 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3441 "power of 2");
3442 return;
3445 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3446 return;
3448 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3449 return;
3452 if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3453 sync = MIRROR_SYNC_MODE_FULL;
3456 /* pass the node name to replace to mirror start since it's loose coupling
3457 * and will allow to check whether the node still exist at mirror completion
3459 mirror_start(job_id, bs, target,
3460 has_replaces ? replaces : NULL,
3461 speed, granularity, buf_size, sync, backing_mode,
3462 on_source_error, on_target_error, unmap,
3463 block_job_cb, bs, errp);
3466 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3468 BlockDriverState *bs;
3469 BlockBackend *blk;
3470 BlockDriverState *source, *target_bs;
3471 AioContext *aio_context;
3472 BlockMirrorBackingMode backing_mode;
3473 Error *local_err = NULL;
3474 QDict *options = NULL;
3475 int flags;
3476 int64_t size;
3477 const char *format = arg->format;
3479 blk = blk_by_name(arg->device);
3480 if (!blk) {
3481 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3482 "Device '%s' not found", arg->device);
3483 return;
3486 aio_context = blk_get_aio_context(blk);
3487 aio_context_acquire(aio_context);
3489 if (!blk_is_available(blk)) {
3490 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, arg->device);
3491 goto out;
3493 bs = blk_bs(blk);
3494 if (!arg->has_mode) {
3495 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3498 if (!arg->has_format) {
3499 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3500 ? NULL : bs->drv->format_name);
3503 flags = bs->open_flags | BDRV_O_RDWR;
3504 source = backing_bs(bs);
3505 if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3506 arg->sync = MIRROR_SYNC_MODE_FULL;
3508 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3509 source = bs;
3512 size = bdrv_getlength(bs);
3513 if (size < 0) {
3514 error_setg_errno(errp, -size, "bdrv_getlength failed");
3515 goto out;
3518 if (arg->has_replaces) {
3519 BlockDriverState *to_replace_bs;
3520 AioContext *replace_aio_context;
3521 int64_t replace_size;
3523 if (!arg->has_node_name) {
3524 error_setg(errp, "a node-name must be provided when replacing a"
3525 " named node of the graph");
3526 goto out;
3529 to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3531 if (!to_replace_bs) {
3532 error_propagate(errp, local_err);
3533 goto out;
3536 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3537 aio_context_acquire(replace_aio_context);
3538 replace_size = bdrv_getlength(to_replace_bs);
3539 aio_context_release(replace_aio_context);
3541 if (size != replace_size) {
3542 error_setg(errp, "cannot replace image with a mirror image of "
3543 "different size");
3544 goto out;
3548 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3549 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3550 } else {
3551 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3554 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3555 && arg->mode != NEW_IMAGE_MODE_EXISTING)
3557 /* create new image w/o backing file */
3558 assert(format);
3559 bdrv_img_create(arg->target, format,
3560 NULL, NULL, NULL, size, flags, &local_err, false);
3561 } else {
3562 switch (arg->mode) {
3563 case NEW_IMAGE_MODE_EXISTING:
3564 break;
3565 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3566 /* create new image with backing file */
3567 bdrv_img_create(arg->target, format,
3568 source->filename,
3569 source->drv->format_name,
3570 NULL, size, flags, &local_err, false);
3571 break;
3572 default:
3573 abort();
3577 if (local_err) {
3578 error_propagate(errp, local_err);
3579 goto out;
3582 options = qdict_new();
3583 if (arg->has_node_name) {
3584 qdict_put(options, "node-name", qstring_from_str(arg->node_name));
3586 if (format) {
3587 qdict_put(options, "driver", qstring_from_str(format));
3590 /* Mirroring takes care of copy-on-write using the source's backing
3591 * file.
3593 target_bs = bdrv_open(arg->target, NULL, options,
3594 flags | BDRV_O_NO_BACKING, errp);
3595 if (!target_bs) {
3596 goto out;
3599 bdrv_set_aio_context(target_bs, aio_context);
3601 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3602 arg->has_replaces, arg->replaces, arg->sync,
3603 backing_mode, arg->has_speed, arg->speed,
3604 arg->has_granularity, arg->granularity,
3605 arg->has_buf_size, arg->buf_size,
3606 arg->has_on_source_error, arg->on_source_error,
3607 arg->has_on_target_error, arg->on_target_error,
3608 arg->has_unmap, arg->unmap,
3609 &local_err);
3610 bdrv_unref(target_bs);
3611 error_propagate(errp, local_err);
3612 out:
3613 aio_context_release(aio_context);
3616 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3617 const char *device, const char *target,
3618 bool has_replaces, const char *replaces,
3619 MirrorSyncMode sync,
3620 bool has_speed, int64_t speed,
3621 bool has_granularity, uint32_t granularity,
3622 bool has_buf_size, int64_t buf_size,
3623 bool has_on_source_error,
3624 BlockdevOnError on_source_error,
3625 bool has_on_target_error,
3626 BlockdevOnError on_target_error,
3627 Error **errp)
3629 BlockDriverState *bs;
3630 BlockBackend *blk;
3631 BlockDriverState *target_bs;
3632 AioContext *aio_context;
3633 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3634 Error *local_err = NULL;
3636 blk = blk_by_name(device);
3637 if (!blk) {
3638 error_setg(errp, "Device '%s' not found", device);
3639 return;
3641 bs = blk_bs(blk);
3643 if (!bs) {
3644 error_setg(errp, "Device '%s' has no media", device);
3645 return;
3648 target_bs = bdrv_lookup_bs(target, target, errp);
3649 if (!target_bs) {
3650 return;
3653 aio_context = bdrv_get_aio_context(bs);
3654 aio_context_acquire(aio_context);
3656 bdrv_set_aio_context(target_bs, aio_context);
3658 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3659 has_replaces, replaces, sync, backing_mode,
3660 has_speed, speed,
3661 has_granularity, granularity,
3662 has_buf_size, buf_size,
3663 has_on_source_error, on_source_error,
3664 has_on_target_error, on_target_error,
3665 true, true,
3666 &local_err);
3667 error_propagate(errp, local_err);
3669 aio_context_release(aio_context);
3672 /* Get a block job using its ID and acquire its AioContext */
3673 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3674 Error **errp)
3676 BlockJob *job;
3678 assert(id != NULL);
3680 *aio_context = NULL;
3682 job = block_job_get(id);
3684 if (!job) {
3685 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3686 "Block job '%s' not found", id);
3687 return NULL;
3690 *aio_context = blk_get_aio_context(job->blk);
3691 aio_context_acquire(*aio_context);
3693 return job;
3696 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3698 AioContext *aio_context;
3699 BlockJob *job = find_block_job(device, &aio_context, errp);
3701 if (!job) {
3702 return;
3705 block_job_set_speed(job, speed, errp);
3706 aio_context_release(aio_context);
3709 void qmp_block_job_cancel(const char *device,
3710 bool has_force, bool force, Error **errp)
3712 AioContext *aio_context;
3713 BlockJob *job = find_block_job(device, &aio_context, errp);
3715 if (!job) {
3716 return;
3719 if (!has_force) {
3720 force = false;
3723 if (job->user_paused && !force) {
3724 error_setg(errp, "The block job for device '%s' is currently paused",
3725 device);
3726 goto out;
3729 trace_qmp_block_job_cancel(job);
3730 block_job_cancel(job);
3731 out:
3732 aio_context_release(aio_context);
3735 void qmp_block_job_pause(const char *device, Error **errp)
3737 AioContext *aio_context;
3738 BlockJob *job = find_block_job(device, &aio_context, errp);
3740 if (!job || job->user_paused) {
3741 return;
3744 job->user_paused = true;
3745 trace_qmp_block_job_pause(job);
3746 block_job_pause(job);
3747 aio_context_release(aio_context);
3750 void qmp_block_job_resume(const char *device, Error **errp)
3752 AioContext *aio_context;
3753 BlockJob *job = find_block_job(device, &aio_context, errp);
3755 if (!job || !job->user_paused) {
3756 return;
3759 job->user_paused = false;
3760 trace_qmp_block_job_resume(job);
3761 block_job_iostatus_reset(job);
3762 block_job_resume(job);
3763 aio_context_release(aio_context);
3766 void qmp_block_job_complete(const char *device, Error **errp)
3768 AioContext *aio_context;
3769 BlockJob *job = find_block_job(device, &aio_context, errp);
3771 if (!job) {
3772 return;
3775 trace_qmp_block_job_complete(job);
3776 block_job_complete(job, errp);
3777 aio_context_release(aio_context);
3780 void qmp_change_backing_file(const char *device,
3781 const char *image_node_name,
3782 const char *backing_file,
3783 Error **errp)
3785 BlockBackend *blk;
3786 BlockDriverState *bs = NULL;
3787 AioContext *aio_context;
3788 BlockDriverState *image_bs = NULL;
3789 Error *local_err = NULL;
3790 bool ro;
3791 int open_flags;
3792 int ret;
3794 blk = blk_by_name(device);
3795 if (!blk) {
3796 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3797 "Device '%s' not found", device);
3798 return;
3801 aio_context = blk_get_aio_context(blk);
3802 aio_context_acquire(aio_context);
3804 if (!blk_is_available(blk)) {
3805 error_setg(errp, "Device '%s' has no medium", device);
3806 goto out;
3808 bs = blk_bs(blk);
3810 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3811 if (local_err) {
3812 error_propagate(errp, local_err);
3813 goto out;
3816 if (!image_bs) {
3817 error_setg(errp, "image file not found");
3818 goto out;
3821 if (bdrv_find_base(image_bs) == image_bs) {
3822 error_setg(errp, "not allowing backing file change on an image "
3823 "without a backing file");
3824 goto out;
3827 /* even though we are not necessarily operating on bs, we need it to
3828 * determine if block ops are currently prohibited on the chain */
3829 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3830 goto out;
3833 /* final sanity check */
3834 if (!bdrv_chain_contains(bs, image_bs)) {
3835 error_setg(errp, "'%s' and image file are not in the same chain",
3836 device);
3837 goto out;
3840 /* if not r/w, reopen to make r/w */
3841 open_flags = image_bs->open_flags;
3842 ro = bdrv_is_read_only(image_bs);
3844 if (ro) {
3845 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3846 if (local_err) {
3847 error_propagate(errp, local_err);
3848 goto out;
3852 ret = bdrv_change_backing_file(image_bs, backing_file,
3853 image_bs->drv ? image_bs->drv->format_name : "");
3855 if (ret < 0) {
3856 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3857 backing_file);
3858 /* don't exit here, so we can try to restore open flags if
3859 * appropriate */
3862 if (ro) {
3863 bdrv_reopen(image_bs, open_flags, &local_err);
3864 error_propagate(errp, local_err);
3867 out:
3868 aio_context_release(aio_context);
3871 void hmp_drive_add_node(Monitor *mon, const char *optstr)
3873 QemuOpts *opts;
3874 QDict *qdict;
3875 Error *local_err = NULL;
3877 opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
3878 if (!opts) {
3879 return;
3882 qdict = qemu_opts_to_qdict(opts, NULL);
3884 if (!qdict_get_try_str(qdict, "node-name")) {
3885 QDECREF(qdict);
3886 error_report("'node-name' needs to be specified");
3887 goto out;
3890 BlockDriverState *bs = bds_tree_init(qdict, &local_err);
3891 if (!bs) {
3892 error_report_err(local_err);
3893 goto out;
3896 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3898 out:
3899 qemu_opts_del(opts);
3902 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3904 BlockDriverState *bs;
3905 BlockBackend *blk = NULL;
3906 QObject *obj;
3907 Visitor *v = qmp_output_visitor_new(&obj);
3908 QDict *qdict;
3909 Error *local_err = NULL;
3911 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3912 * cache.direct=false instead of silently switching to aio=threads, except
3913 * when called from drive_new().
3915 * For now, simply forbidding the combination for all drivers will do. */
3916 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3917 bool direct = options->has_cache &&
3918 options->cache->has_direct &&
3919 options->cache->direct;
3920 if (!direct) {
3921 error_setg(errp, "aio=native requires cache.direct=true");
3922 goto fail;
3926 visit_type_BlockdevOptions(v, NULL, &options, &local_err);
3927 if (local_err) {
3928 error_propagate(errp, local_err);
3929 goto fail;
3932 visit_complete(v, &obj);
3933 qdict = qobject_to_qdict(obj);
3935 qdict_flatten(qdict);
3937 if (options->has_id) {
3938 blk = blockdev_init(NULL, qdict, &local_err);
3939 if (local_err) {
3940 error_propagate(errp, local_err);
3941 goto fail;
3944 bs = blk_bs(blk);
3945 } else {
3946 if (!qdict_get_try_str(qdict, "node-name")) {
3947 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3948 "the root node");
3949 goto fail;
3952 bs = bds_tree_init(qdict, errp);
3953 if (!bs) {
3954 goto fail;
3957 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3960 if (bs && bdrv_key_required(bs)) {
3961 if (blk) {
3962 monitor_remove_blk(blk);
3963 blk_unref(blk);
3964 } else {
3965 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3966 bdrv_unref(bs);
3968 error_setg(errp, "blockdev-add doesn't support encrypted devices");
3969 goto fail;
3972 fail:
3973 visit_free(v);
3976 void qmp_x_blockdev_del(bool has_id, const char *id,
3977 bool has_node_name, const char *node_name, Error **errp)
3979 AioContext *aio_context;
3980 BlockBackend *blk;
3981 BlockDriverState *bs;
3983 if (has_id && has_node_name) {
3984 error_setg(errp, "Only one of id and node-name must be specified");
3985 return;
3986 } else if (!has_id && !has_node_name) {
3987 error_setg(errp, "No block device specified");
3988 return;
3991 if (has_id) {
3992 /* blk_by_name() never returns a BB that is not owned by the monitor */
3993 blk = blk_by_name(id);
3994 if (!blk) {
3995 error_setg(errp, "Cannot find block backend %s", id);
3996 return;
3998 if (blk_legacy_dinfo(blk)) {
3999 error_setg(errp, "Deleting block backend added with drive-add"
4000 " is not supported");
4001 return;
4003 if (blk_get_refcnt(blk) > 1) {
4004 error_setg(errp, "Block backend %s is in use", id);
4005 return;
4007 bs = blk_bs(blk);
4008 aio_context = blk_get_aio_context(blk);
4009 } else {
4010 blk = NULL;
4011 bs = bdrv_find_node(node_name);
4012 if (!bs) {
4013 error_setg(errp, "Cannot find node %s", node_name);
4014 return;
4016 if (bdrv_has_blk(bs)) {
4017 error_setg(errp, "Node %s is in use by %s",
4018 node_name, bdrv_get_parent_name(bs));
4019 return;
4021 aio_context = bdrv_get_aio_context(bs);
4024 aio_context_acquire(aio_context);
4026 if (bs) {
4027 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
4028 goto out;
4031 if (!blk && !bs->monitor_list.tqe_prev) {
4032 error_setg(errp, "Node %s is not owned by the monitor",
4033 bs->node_name);
4034 goto out;
4037 if (bs->refcnt > 1) {
4038 error_setg(errp, "Block device %s is in use",
4039 bdrv_get_device_or_node_name(bs));
4040 goto out;
4044 if (blk) {
4045 monitor_remove_blk(blk);
4046 blk_unref(blk);
4047 } else {
4048 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4049 bdrv_unref(bs);
4052 out:
4053 aio_context_release(aio_context);
4056 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
4057 const char *child_name)
4059 BdrvChild *child;
4061 QLIST_FOREACH(child, &parent_bs->children, next) {
4062 if (strcmp(child->name, child_name) == 0) {
4063 return child;
4067 return NULL;
4070 void qmp_x_blockdev_change(const char *parent, bool has_child,
4071 const char *child, bool has_node,
4072 const char *node, Error **errp)
4074 BlockDriverState *parent_bs, *new_bs = NULL;
4075 BdrvChild *p_child;
4077 parent_bs = bdrv_lookup_bs(parent, parent, errp);
4078 if (!parent_bs) {
4079 return;
4082 if (has_child == has_node) {
4083 if (has_child) {
4084 error_setg(errp, "The parameters child and node are in conflict");
4085 } else {
4086 error_setg(errp, "Either child or node must be specified");
4088 return;
4091 if (has_child) {
4092 p_child = bdrv_find_child(parent_bs, child);
4093 if (!p_child) {
4094 error_setg(errp, "Node '%s' does not have child '%s'",
4095 parent, child);
4096 return;
4098 bdrv_del_child(parent_bs, p_child, errp);
4101 if (has_node) {
4102 new_bs = bdrv_find_node(node);
4103 if (!new_bs) {
4104 error_setg(errp, "Node '%s' not found", node);
4105 return;
4107 bdrv_add_child(parent_bs, new_bs, errp);
4111 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4113 BlockJobInfoList *head = NULL, **p_next = &head;
4114 BlockJob *job;
4116 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
4117 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
4118 AioContext *aio_context = blk_get_aio_context(job->blk);
4120 aio_context_acquire(aio_context);
4121 elem->value = block_job_query(job);
4122 aio_context_release(aio_context);
4124 *p_next = elem;
4125 p_next = &elem->next;
4128 return head;
4131 QemuOptsList qemu_common_drive_opts = {
4132 .name = "drive",
4133 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4134 .desc = {
4136 .name = "snapshot",
4137 .type = QEMU_OPT_BOOL,
4138 .help = "enable/disable snapshot mode",
4140 .name = "discard",
4141 .type = QEMU_OPT_STRING,
4142 .help = "discard operation (ignore/off, unmap/on)",
4144 .name = "aio",
4145 .type = QEMU_OPT_STRING,
4146 .help = "host AIO implementation (threads, native)",
4148 .name = BDRV_OPT_CACHE_WB,
4149 .type = QEMU_OPT_BOOL,
4150 .help = "Enable writeback mode",
4152 .name = "format",
4153 .type = QEMU_OPT_STRING,
4154 .help = "disk format (raw, qcow2, ...)",
4156 .name = "rerror",
4157 .type = QEMU_OPT_STRING,
4158 .help = "read error action",
4160 .name = "werror",
4161 .type = QEMU_OPT_STRING,
4162 .help = "write error action",
4164 .name = "read-only",
4165 .type = QEMU_OPT_BOOL,
4166 .help = "open drive file as read-only",
4168 .name = "throttling.iops-total",
4169 .type = QEMU_OPT_NUMBER,
4170 .help = "limit total I/O operations per second",
4172 .name = "throttling.iops-read",
4173 .type = QEMU_OPT_NUMBER,
4174 .help = "limit read operations per second",
4176 .name = "throttling.iops-write",
4177 .type = QEMU_OPT_NUMBER,
4178 .help = "limit write operations per second",
4180 .name = "throttling.bps-total",
4181 .type = QEMU_OPT_NUMBER,
4182 .help = "limit total bytes per second",
4184 .name = "throttling.bps-read",
4185 .type = QEMU_OPT_NUMBER,
4186 .help = "limit read bytes per second",
4188 .name = "throttling.bps-write",
4189 .type = QEMU_OPT_NUMBER,
4190 .help = "limit write bytes per second",
4192 .name = "throttling.iops-total-max",
4193 .type = QEMU_OPT_NUMBER,
4194 .help = "I/O operations burst",
4196 .name = "throttling.iops-read-max",
4197 .type = QEMU_OPT_NUMBER,
4198 .help = "I/O operations read burst",
4200 .name = "throttling.iops-write-max",
4201 .type = QEMU_OPT_NUMBER,
4202 .help = "I/O operations write burst",
4204 .name = "throttling.bps-total-max",
4205 .type = QEMU_OPT_NUMBER,
4206 .help = "total bytes burst",
4208 .name = "throttling.bps-read-max",
4209 .type = QEMU_OPT_NUMBER,
4210 .help = "total bytes read burst",
4212 .name = "throttling.bps-write-max",
4213 .type = QEMU_OPT_NUMBER,
4214 .help = "total bytes write burst",
4216 .name = "throttling.iops-total-max-length",
4217 .type = QEMU_OPT_NUMBER,
4218 .help = "length of the iops-total-max burst period, in seconds",
4220 .name = "throttling.iops-read-max-length",
4221 .type = QEMU_OPT_NUMBER,
4222 .help = "length of the iops-read-max burst period, in seconds",
4224 .name = "throttling.iops-write-max-length",
4225 .type = QEMU_OPT_NUMBER,
4226 .help = "length of the iops-write-max burst period, in seconds",
4228 .name = "throttling.bps-total-max-length",
4229 .type = QEMU_OPT_NUMBER,
4230 .help = "length of the bps-total-max burst period, in seconds",
4232 .name = "throttling.bps-read-max-length",
4233 .type = QEMU_OPT_NUMBER,
4234 .help = "length of the bps-read-max burst period, in seconds",
4236 .name = "throttling.bps-write-max-length",
4237 .type = QEMU_OPT_NUMBER,
4238 .help = "length of the bps-write-max burst period, in seconds",
4240 .name = "throttling.iops-size",
4241 .type = QEMU_OPT_NUMBER,
4242 .help = "when limiting by iops max size of an I/O in bytes",
4244 .name = "throttling.group",
4245 .type = QEMU_OPT_STRING,
4246 .help = "name of the block throttling group",
4248 .name = "copy-on-read",
4249 .type = QEMU_OPT_BOOL,
4250 .help = "copy read data from backing file into image file",
4252 .name = "detect-zeroes",
4253 .type = QEMU_OPT_STRING,
4254 .help = "try to optimize zero writes (off, on, unmap)",
4256 .name = "stats-account-invalid",
4257 .type = QEMU_OPT_BOOL,
4258 .help = "whether to account for invalid I/O operations "
4259 "in the statistics",
4261 .name = "stats-account-failed",
4262 .type = QEMU_OPT_BOOL,
4263 .help = "whether to account for failed I/O operations "
4264 "in the statistics",
4266 { /* end of list */ }
4270 static QemuOptsList qemu_root_bds_opts = {
4271 .name = "root-bds",
4272 .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4273 .desc = {
4275 .name = "discard",
4276 .type = QEMU_OPT_STRING,
4277 .help = "discard operation (ignore/off, unmap/on)",
4279 .name = "aio",
4280 .type = QEMU_OPT_STRING,
4281 .help = "host AIO implementation (threads, native)",
4283 .name = "read-only",
4284 .type = QEMU_OPT_BOOL,
4285 .help = "open drive file as read-only",
4287 .name = "copy-on-read",
4288 .type = QEMU_OPT_BOOL,
4289 .help = "copy read data from backing file into image file",
4291 .name = "detect-zeroes",
4292 .type = QEMU_OPT_STRING,
4293 .help = "try to optimize zero writes (off, on, unmap)",
4295 { /* end of list */ }
4299 QemuOptsList qemu_drive_opts = {
4300 .name = "drive",
4301 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4302 .desc = {
4304 * no elements => accept any params
4305 * validation will happen later
4307 { /* end of list */ }