target/mips: Make R5900 DMULT[U], DDIV[U], LL[D] and SC[D] user only
[qemu/ar7.git] / blockdev.c
blob574adbcb7f5e2880a1c52d0529f8fb3be226cce9
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/qdict.h"
39 #include "block/throttle-groups.h"
40 #include "monitor/monitor.h"
41 #include "qemu/error-report.h"
42 #include "qemu/option.h"
43 #include "qemu/config-file.h"
44 #include "qapi/qapi-commands-block.h"
45 #include "qapi/qapi-commands-transaction.h"
46 #include "qapi/qapi-visit-block-core.h"
47 #include "qapi/qmp/qdict.h"
48 #include "qapi/qmp/qnum.h"
49 #include "qapi/qmp/qstring.h"
50 #include "qapi/error.h"
51 #include "qapi/qmp/qerror.h"
52 #include "qapi/qmp/qlist.h"
53 #include "qapi/qobject-output-visitor.h"
54 #include "sysemu/sysemu.h"
55 #include "sysemu/iothread.h"
56 #include "block/block_int.h"
57 #include "block/trace.h"
58 #include "sysemu/arch_init.h"
59 #include "sysemu/qtest.h"
60 #include "qemu/cutils.h"
61 #include "qemu/help_option.h"
62 #include "qemu/throttle-options.h"
64 static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
65 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
67 static int do_open_tray(const char *blk_name, const char *qdev_id,
68 bool force, Error **errp);
69 static void blockdev_remove_medium(bool has_device, const char *device,
70 bool has_id, const char *id, Error **errp);
71 static void blockdev_insert_medium(bool has_device, const char *device,
72 bool has_id, const char *id,
73 const char *node_name, Error **errp);
75 static const char *const if_name[IF_COUNT] = {
76 [IF_NONE] = "none",
77 [IF_IDE] = "ide",
78 [IF_SCSI] = "scsi",
79 [IF_FLOPPY] = "floppy",
80 [IF_PFLASH] = "pflash",
81 [IF_MTD] = "mtd",
82 [IF_SD] = "sd",
83 [IF_VIRTIO] = "virtio",
84 [IF_XEN] = "xen",
87 static int if_max_devs[IF_COUNT] = {
89 * Do not change these numbers! They govern how drive option
90 * index maps to unit and bus. That mapping is ABI.
92 * All controllers used to implement if=T drives need to support
93 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
94 * Otherwise, some index values map to "impossible" bus, unit
95 * values.
97 * For instance, if you change [IF_SCSI] to 255, -drive
98 * if=scsi,index=12 no longer means bus=1,unit=5, but
99 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
100 * the drive can't be set up. Regression.
102 [IF_IDE] = 2,
103 [IF_SCSI] = 7,
107 * Boards may call this to offer board-by-board overrides
108 * of the default, global values.
110 void override_max_devs(BlockInterfaceType type, int max_devs)
112 BlockBackend *blk;
113 DriveInfo *dinfo;
115 if (max_devs <= 0) {
116 return;
119 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
120 dinfo = blk_legacy_dinfo(blk);
121 if (dinfo->type == type) {
122 fprintf(stderr, "Cannot override units-per-bus property of"
123 " the %s interface, because a drive of that type has"
124 " already been added.\n", if_name[type]);
125 g_assert_not_reached();
129 if_max_devs[type] = max_devs;
133 * We automatically delete the drive when a device using it gets
134 * unplugged. Questionable feature, but we can't just drop it.
135 * Device models call blockdev_mark_auto_del() to schedule the
136 * automatic deletion, and generic qdev code calls blockdev_auto_del()
137 * when deletion is actually safe.
139 void blockdev_mark_auto_del(BlockBackend *blk)
141 DriveInfo *dinfo = blk_legacy_dinfo(blk);
142 BlockDriverState *bs = blk_bs(blk);
143 AioContext *aio_context;
145 if (!dinfo) {
146 return;
149 if (bs) {
150 aio_context = bdrv_get_aio_context(bs);
151 aio_context_acquire(aio_context);
153 if (bs->job) {
154 job_cancel(&bs->job->job, false);
157 aio_context_release(aio_context);
160 dinfo->auto_del = 1;
163 void blockdev_auto_del(BlockBackend *blk)
165 DriveInfo *dinfo = blk_legacy_dinfo(blk);
167 if (dinfo && dinfo->auto_del) {
168 monitor_remove_blk(blk);
169 blk_unref(blk);
174 * Returns the current mapping of how many units per bus
175 * a particular interface can support.
177 * A positive integer indicates n units per bus.
178 * 0 implies the mapping has not been established.
179 * -1 indicates an invalid BlockInterfaceType was given.
181 int drive_get_max_devs(BlockInterfaceType type)
183 if (type >= IF_IDE && type < IF_COUNT) {
184 return if_max_devs[type];
187 return -1;
190 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
192 int max_devs = if_max_devs[type];
193 return max_devs ? index / max_devs : 0;
196 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
198 int max_devs = if_max_devs[type];
199 return max_devs ? index % max_devs : index;
202 QemuOpts *drive_def(const char *optstr)
204 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
207 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
208 const char *optstr)
210 QemuOpts *opts;
212 opts = drive_def(optstr);
213 if (!opts) {
214 return NULL;
216 if (type != IF_DEFAULT) {
217 qemu_opt_set(opts, "if", if_name[type], &error_abort);
219 if (index >= 0) {
220 qemu_opt_set_number(opts, "index", index, &error_abort);
222 if (file)
223 qemu_opt_set(opts, "file", file, &error_abort);
224 return opts;
227 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
229 BlockBackend *blk;
230 DriveInfo *dinfo;
232 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
233 dinfo = blk_legacy_dinfo(blk);
234 if (dinfo && dinfo->type == type
235 && dinfo->bus == bus && dinfo->unit == unit) {
236 return dinfo;
240 return NULL;
243 void drive_check_orphaned(void)
245 BlockBackend *blk;
246 DriveInfo *dinfo;
247 Location loc;
248 bool orphans = false;
250 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
251 dinfo = blk_legacy_dinfo(blk);
252 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
253 dinfo->type != IF_NONE) {
254 loc_push_none(&loc);
255 qemu_opts_loc_restore(dinfo->opts);
256 error_report("machine type does not support"
257 " if=%s,bus=%d,unit=%d",
258 if_name[dinfo->type], dinfo->bus, dinfo->unit);
259 loc_pop(&loc);
260 orphans = true;
264 if (orphans) {
265 exit(1);
269 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
271 return drive_get(type,
272 drive_index_to_bus_id(type, index),
273 drive_index_to_unit_id(type, index));
276 int drive_get_max_bus(BlockInterfaceType type)
278 int max_bus;
279 BlockBackend *blk;
280 DriveInfo *dinfo;
282 max_bus = -1;
283 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
284 dinfo = blk_legacy_dinfo(blk);
285 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
286 max_bus = dinfo->bus;
289 return max_bus;
292 /* Get a block device. This should only be used for single-drive devices
293 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
294 appropriate bus. */
295 DriveInfo *drive_get_next(BlockInterfaceType type)
297 static int next_block_unit[IF_COUNT];
299 return drive_get(type, 0, next_block_unit[type]++);
302 static void bdrv_format_print(void *opaque, const char *name)
304 error_printf(" %s", name);
307 typedef struct {
308 QEMUBH *bh;
309 BlockDriverState *bs;
310 } BDRVPutRefBH;
312 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
314 if (!strcmp(buf, "ignore")) {
315 return BLOCKDEV_ON_ERROR_IGNORE;
316 } else if (!is_read && !strcmp(buf, "enospc")) {
317 return BLOCKDEV_ON_ERROR_ENOSPC;
318 } else if (!strcmp(buf, "stop")) {
319 return BLOCKDEV_ON_ERROR_STOP;
320 } else if (!strcmp(buf, "report")) {
321 return BLOCKDEV_ON_ERROR_REPORT;
322 } else {
323 error_setg(errp, "'%s' invalid %s error action",
324 buf, is_read ? "read" : "write");
325 return -1;
329 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
330 Error **errp)
332 const QListEntry *entry;
333 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
334 switch (qobject_type(entry->value)) {
336 case QTYPE_QSTRING: {
337 unsigned long long length;
338 const char *str = qstring_get_str(qobject_to(QString,
339 entry->value));
340 if (parse_uint_full(str, &length, 10) == 0 &&
341 length > 0 && length <= UINT_MAX) {
342 block_acct_add_interval(stats, (unsigned) length);
343 } else {
344 error_setg(errp, "Invalid interval length: %s", str);
345 return false;
347 break;
350 case QTYPE_QNUM: {
351 int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
353 if (length > 0 && length <= UINT_MAX) {
354 block_acct_add_interval(stats, (unsigned) length);
355 } else {
356 error_setg(errp, "Invalid interval length: %" PRId64, length);
357 return false;
359 break;
362 default:
363 error_setg(errp, "The specification of stats-intervals is invalid");
364 return false;
367 return true;
370 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
372 /* All parameters but @opts are optional and may be set to NULL. */
373 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
374 const char **throttling_group, ThrottleConfig *throttle_cfg,
375 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
377 Error *local_error = NULL;
378 const char *aio;
380 if (bdrv_flags) {
381 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
382 *bdrv_flags |= BDRV_O_COPY_ON_READ;
385 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
386 if (!strcmp(aio, "native")) {
387 *bdrv_flags |= BDRV_O_NATIVE_AIO;
388 } else if (!strcmp(aio, "threads")) {
389 /* this is the default */
390 } else {
391 error_setg(errp, "invalid aio option");
392 return;
397 /* disk I/O throttling */
398 if (throttling_group) {
399 *throttling_group = qemu_opt_get(opts, "throttling.group");
402 if (throttle_cfg) {
403 throttle_config_init(throttle_cfg);
404 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
405 qemu_opt_get_number(opts, "throttling.bps-total", 0);
406 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
407 qemu_opt_get_number(opts, "throttling.bps-read", 0);
408 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
409 qemu_opt_get_number(opts, "throttling.bps-write", 0);
410 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
411 qemu_opt_get_number(opts, "throttling.iops-total", 0);
412 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
413 qemu_opt_get_number(opts, "throttling.iops-read", 0);
414 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
415 qemu_opt_get_number(opts, "throttling.iops-write", 0);
417 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
418 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
419 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
420 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
421 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
422 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
423 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
424 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
425 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
426 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
427 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
428 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
430 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
431 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
432 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
433 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
434 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
435 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
436 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
437 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
438 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
439 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
440 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
441 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
443 throttle_cfg->op_size =
444 qemu_opt_get_number(opts, "throttling.iops-size", 0);
446 if (!throttle_is_valid(throttle_cfg, errp)) {
447 return;
451 if (detect_zeroes) {
452 *detect_zeroes =
453 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
454 qemu_opt_get(opts, "detect-zeroes"),
455 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
456 &local_error);
457 if (local_error) {
458 error_propagate(errp, local_error);
459 return;
464 /* Takes the ownership of bs_opts */
465 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
466 Error **errp)
468 const char *buf;
469 int bdrv_flags = 0;
470 int on_read_error, on_write_error;
471 bool account_invalid, account_failed;
472 bool writethrough, read_only;
473 BlockBackend *blk;
474 BlockDriverState *bs;
475 ThrottleConfig cfg;
476 int snapshot = 0;
477 Error *error = NULL;
478 QemuOpts *opts;
479 QDict *interval_dict = NULL;
480 QList *interval_list = NULL;
481 const char *id;
482 BlockdevDetectZeroesOptions detect_zeroes =
483 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
484 const char *throttling_group = NULL;
486 /* Check common options by copying from bs_opts to opts, all other options
487 * stay in bs_opts for processing by bdrv_open(). */
488 id = qdict_get_try_str(bs_opts, "id");
489 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
490 if (error) {
491 error_propagate(errp, error);
492 goto err_no_opts;
495 qemu_opts_absorb_qdict(opts, bs_opts, &error);
496 if (error) {
497 error_propagate(errp, error);
498 goto early_err;
501 if (id) {
502 qdict_del(bs_opts, "id");
505 /* extract parameters */
506 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
508 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
509 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
511 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
513 id = qemu_opts_id(opts);
515 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
516 qdict_array_split(interval_dict, &interval_list);
518 if (qdict_size(interval_dict) != 0) {
519 error_setg(errp, "Invalid option stats-intervals.%s",
520 qdict_first(interval_dict)->key);
521 goto early_err;
524 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
525 &detect_zeroes, &error);
526 if (error) {
527 error_propagate(errp, error);
528 goto early_err;
531 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
532 if (is_help_option(buf)) {
533 error_printf("Supported formats:");
534 bdrv_iterate_format(bdrv_format_print, NULL);
535 error_printf("\n");
536 goto early_err;
539 if (qdict_haskey(bs_opts, "driver")) {
540 error_setg(errp, "Cannot specify both 'driver' and 'format'");
541 goto early_err;
543 qdict_put_str(bs_opts, "driver", buf);
546 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
547 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
548 on_write_error = parse_block_error_action(buf, 0, &error);
549 if (error) {
550 error_propagate(errp, error);
551 goto early_err;
555 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
556 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
557 on_read_error = parse_block_error_action(buf, 1, &error);
558 if (error) {
559 error_propagate(errp, error);
560 goto early_err;
564 if (snapshot) {
565 bdrv_flags |= BDRV_O_SNAPSHOT;
568 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
570 /* init */
571 if ((!file || !*file) && !qdict_size(bs_opts)) {
572 BlockBackendRootState *blk_rs;
574 blk = blk_new(0, BLK_PERM_ALL);
575 blk_rs = blk_get_root_state(blk);
576 blk_rs->open_flags = bdrv_flags;
577 blk_rs->read_only = read_only;
578 blk_rs->detect_zeroes = detect_zeroes;
580 qobject_unref(bs_opts);
581 } else {
582 if (file && !*file) {
583 file = NULL;
586 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
587 * with other callers) rather than what we want as the real defaults.
588 * Apply the defaults here instead. */
589 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
590 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
591 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
592 read_only ? "on" : "off");
593 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
595 if (runstate_check(RUN_STATE_INMIGRATE)) {
596 bdrv_flags |= BDRV_O_INACTIVE;
599 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
600 if (!blk) {
601 goto err_no_bs_opts;
603 bs = blk_bs(blk);
605 bs->detect_zeroes = detect_zeroes;
607 block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
609 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
610 blk_unref(blk);
611 blk = NULL;
612 goto err_no_bs_opts;
616 /* disk I/O throttling */
617 if (throttle_enabled(&cfg)) {
618 if (!throttling_group) {
619 throttling_group = id;
621 blk_io_limits_enable(blk, throttling_group);
622 blk_set_io_limits(blk, &cfg);
625 blk_set_enable_write_cache(blk, !writethrough);
626 blk_set_on_error(blk, on_read_error, on_write_error);
628 if (!monitor_add_blk(blk, id, errp)) {
629 blk_unref(blk);
630 blk = NULL;
631 goto err_no_bs_opts;
634 err_no_bs_opts:
635 qemu_opts_del(opts);
636 qobject_unref(interval_dict);
637 qobject_unref(interval_list);
638 return blk;
640 early_err:
641 qemu_opts_del(opts);
642 qobject_unref(interval_dict);
643 qobject_unref(interval_list);
644 err_no_opts:
645 qobject_unref(bs_opts);
646 return NULL;
649 /* Takes the ownership of bs_opts */
650 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
652 int bdrv_flags = 0;
654 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
655 * with other callers) rather than what we want as the real defaults.
656 * Apply the defaults here instead. */
657 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
658 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
659 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
661 if (runstate_check(RUN_STATE_INMIGRATE)) {
662 bdrv_flags |= BDRV_O_INACTIVE;
665 return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
668 void blockdev_close_all_bdrv_states(void)
670 BlockDriverState *bs, *next_bs;
672 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
673 AioContext *ctx = bdrv_get_aio_context(bs);
675 aio_context_acquire(ctx);
676 bdrv_unref(bs);
677 aio_context_release(ctx);
681 /* Iterates over the list of monitor-owned BlockDriverStates */
682 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
684 return bs ? QTAILQ_NEXT(bs, monitor_list)
685 : QTAILQ_FIRST(&monitor_bdrv_states);
688 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
689 Error **errp)
691 const char *value;
693 value = qemu_opt_get(opts, from);
694 if (value) {
695 if (qemu_opt_find(opts, to)) {
696 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
697 "same time", to, from);
698 return;
702 /* rename all items in opts */
703 while ((value = qemu_opt_get(opts, from))) {
704 qemu_opt_set(opts, to, value, &error_abort);
705 qemu_opt_unset(opts, from);
709 QemuOptsList qemu_legacy_drive_opts = {
710 .name = "drive",
711 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
712 .desc = {
714 .name = "bus",
715 .type = QEMU_OPT_NUMBER,
716 .help = "bus number",
718 .name = "unit",
719 .type = QEMU_OPT_NUMBER,
720 .help = "unit number (i.e. lun for scsi)",
722 .name = "index",
723 .type = QEMU_OPT_NUMBER,
724 .help = "index number",
726 .name = "media",
727 .type = QEMU_OPT_STRING,
728 .help = "media type (disk, cdrom)",
730 .name = "if",
731 .type = QEMU_OPT_STRING,
732 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
734 .name = "file",
735 .type = QEMU_OPT_STRING,
736 .help = "file name",
739 /* Options that are passed on, but have special semantics with -drive */
741 .name = BDRV_OPT_READ_ONLY,
742 .type = QEMU_OPT_BOOL,
743 .help = "open drive file as read-only",
745 .name = "rerror",
746 .type = QEMU_OPT_STRING,
747 .help = "read error action",
749 .name = "werror",
750 .type = QEMU_OPT_STRING,
751 .help = "write error action",
753 .name = "copy-on-read",
754 .type = QEMU_OPT_BOOL,
755 .help = "copy read data from backing file into image file",
758 { /* end of list */ }
762 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
763 Error **errp)
765 const char *value;
766 BlockBackend *blk;
767 DriveInfo *dinfo = NULL;
768 QDict *bs_opts;
769 QemuOpts *legacy_opts;
770 DriveMediaType media = MEDIA_DISK;
771 BlockInterfaceType type;
772 int max_devs, bus_id, unit_id, index;
773 const char *werror, *rerror;
774 bool read_only = false;
775 bool copy_on_read;
776 const char *filename;
777 Error *local_err = NULL;
778 int i;
780 /* Change legacy command line options into QMP ones */
781 static const struct {
782 const char *from;
783 const char *to;
784 } opt_renames[] = {
785 { "iops", "throttling.iops-total" },
786 { "iops_rd", "throttling.iops-read" },
787 { "iops_wr", "throttling.iops-write" },
789 { "bps", "throttling.bps-total" },
790 { "bps_rd", "throttling.bps-read" },
791 { "bps_wr", "throttling.bps-write" },
793 { "iops_max", "throttling.iops-total-max" },
794 { "iops_rd_max", "throttling.iops-read-max" },
795 { "iops_wr_max", "throttling.iops-write-max" },
797 { "bps_max", "throttling.bps-total-max" },
798 { "bps_rd_max", "throttling.bps-read-max" },
799 { "bps_wr_max", "throttling.bps-write-max" },
801 { "iops_size", "throttling.iops-size" },
803 { "group", "throttling.group" },
805 { "readonly", BDRV_OPT_READ_ONLY },
808 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
809 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
810 &local_err);
811 if (local_err) {
812 error_propagate(errp, local_err);
813 return NULL;
817 value = qemu_opt_get(all_opts, "cache");
818 if (value) {
819 int flags = 0;
820 bool writethrough;
822 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
823 error_setg(errp, "invalid cache option");
824 return NULL;
827 /* Specific options take precedence */
828 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
829 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
830 !writethrough, &error_abort);
832 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
833 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
834 !!(flags & BDRV_O_NOCACHE), &error_abort);
836 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
837 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
838 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
840 qemu_opt_unset(all_opts, "cache");
843 /* Get a QDict for processing the options */
844 bs_opts = qdict_new();
845 qemu_opts_to_qdict(all_opts, bs_opts);
847 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
848 &error_abort);
849 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
850 if (local_err) {
851 error_propagate(errp, local_err);
852 goto fail;
855 /* Media type */
856 value = qemu_opt_get(legacy_opts, "media");
857 if (value) {
858 if (!strcmp(value, "disk")) {
859 media = MEDIA_DISK;
860 } else if (!strcmp(value, "cdrom")) {
861 media = MEDIA_CDROM;
862 read_only = true;
863 } else {
864 error_setg(errp, "'%s' invalid media", value);
865 goto fail;
869 /* copy-on-read is disabled with a warning for read-only devices */
870 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
871 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
873 if (read_only && copy_on_read) {
874 warn_report("disabling copy-on-read on read-only drive");
875 copy_on_read = false;
878 qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
879 qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
881 /* Controller type */
882 value = qemu_opt_get(legacy_opts, "if");
883 if (value) {
884 for (type = 0;
885 type < IF_COUNT && strcmp(value, if_name[type]);
886 type++) {
888 if (type == IF_COUNT) {
889 error_setg(errp, "unsupported bus type '%s'", value);
890 goto fail;
892 } else {
893 type = block_default_type;
896 /* Device address specified by bus/unit or index.
897 * If none was specified, try to find the first free one. */
898 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
899 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
900 index = qemu_opt_get_number(legacy_opts, "index", -1);
902 max_devs = if_max_devs[type];
904 if (index != -1) {
905 if (bus_id != 0 || unit_id != -1) {
906 error_setg(errp, "index cannot be used with bus and unit");
907 goto fail;
909 bus_id = drive_index_to_bus_id(type, index);
910 unit_id = drive_index_to_unit_id(type, index);
913 if (unit_id == -1) {
914 unit_id = 0;
915 while (drive_get(type, bus_id, unit_id) != NULL) {
916 unit_id++;
917 if (max_devs && unit_id >= max_devs) {
918 unit_id -= max_devs;
919 bus_id++;
924 if (max_devs && unit_id >= max_devs) {
925 error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
926 goto fail;
929 if (drive_get(type, bus_id, unit_id) != NULL) {
930 error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
931 bus_id, unit_id, index);
932 goto fail;
935 /* no id supplied -> create one */
936 if (qemu_opts_id(all_opts) == NULL) {
937 char *new_id;
938 const char *mediastr = "";
939 if (type == IF_IDE || type == IF_SCSI) {
940 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
942 if (max_devs) {
943 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
944 mediastr, unit_id);
945 } else {
946 new_id = g_strdup_printf("%s%s%i", if_name[type],
947 mediastr, unit_id);
949 qdict_put_str(bs_opts, "id", new_id);
950 g_free(new_id);
953 /* Add virtio block device */
954 if (type == IF_VIRTIO) {
955 QemuOpts *devopts;
956 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
957 &error_abort);
958 if (arch_type == QEMU_ARCH_S390X) {
959 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
960 } else {
961 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
963 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
964 &error_abort);
967 filename = qemu_opt_get(legacy_opts, "file");
969 /* Check werror/rerror compatibility with if=... */
970 werror = qemu_opt_get(legacy_opts, "werror");
971 if (werror != NULL) {
972 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
973 type != IF_NONE) {
974 error_setg(errp, "werror is not supported by this bus type");
975 goto fail;
977 qdict_put_str(bs_opts, "werror", werror);
980 rerror = qemu_opt_get(legacy_opts, "rerror");
981 if (rerror != NULL) {
982 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
983 type != IF_NONE) {
984 error_setg(errp, "rerror is not supported by this bus type");
985 goto fail;
987 qdict_put_str(bs_opts, "rerror", rerror);
990 /* Actual block device init: Functionality shared with blockdev-add */
991 blk = blockdev_init(filename, bs_opts, &local_err);
992 bs_opts = NULL;
993 if (!blk) {
994 if (local_err) {
995 error_propagate(errp, local_err);
997 goto fail;
998 } else {
999 assert(!local_err);
1002 /* Create legacy DriveInfo */
1003 dinfo = g_malloc0(sizeof(*dinfo));
1004 dinfo->opts = all_opts;
1006 dinfo->type = type;
1007 dinfo->bus = bus_id;
1008 dinfo->unit = unit_id;
1010 blk_set_legacy_dinfo(blk, dinfo);
1012 switch(type) {
1013 case IF_IDE:
1014 case IF_SCSI:
1015 case IF_XEN:
1016 case IF_NONE:
1017 dinfo->media_cd = media == MEDIA_CDROM;
1018 break;
1019 default:
1020 break;
1023 fail:
1024 qemu_opts_del(legacy_opts);
1025 qobject_unref(bs_opts);
1026 return dinfo;
1029 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1031 BlockDriverState *bs;
1033 bs = bdrv_lookup_bs(name, name, errp);
1034 if (bs == NULL) {
1035 return NULL;
1038 if (!bdrv_is_root_node(bs)) {
1039 error_setg(errp, "Need a root block node");
1040 return NULL;
1043 if (!bdrv_is_inserted(bs)) {
1044 error_setg(errp, "Device has no medium");
1045 return NULL;
1048 return bs;
1051 static BlockBackend *qmp_get_blk(const char *blk_name, const char *qdev_id,
1052 Error **errp)
1054 BlockBackend *blk;
1056 if (!blk_name == !qdev_id) {
1057 error_setg(errp, "Need exactly one of 'device' and 'id'");
1058 return NULL;
1061 if (qdev_id) {
1062 blk = blk_by_qdev_id(qdev_id, errp);
1063 } else {
1064 blk = blk_by_name(blk_name);
1065 if (blk == NULL) {
1066 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1067 "Device '%s' not found", blk_name);
1071 return blk;
1074 void hmp_commit(Monitor *mon, const QDict *qdict)
1076 const char *device = qdict_get_str(qdict, "device");
1077 BlockBackend *blk;
1078 int ret;
1080 if (!strcmp(device, "all")) {
1081 ret = blk_commit_all();
1082 } else {
1083 BlockDriverState *bs;
1084 AioContext *aio_context;
1086 blk = blk_by_name(device);
1087 if (!blk) {
1088 monitor_printf(mon, "Device '%s' not found\n", device);
1089 return;
1091 if (!blk_is_available(blk)) {
1092 monitor_printf(mon, "Device '%s' has no medium\n", device);
1093 return;
1096 bs = blk_bs(blk);
1097 aio_context = bdrv_get_aio_context(bs);
1098 aio_context_acquire(aio_context);
1100 ret = bdrv_commit(bs);
1102 aio_context_release(aio_context);
1104 if (ret < 0) {
1105 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1106 strerror(-ret));
1110 static void blockdev_do_action(TransactionAction *action, Error **errp)
1112 TransactionActionList list;
1114 list.value = action;
1115 list.next = NULL;
1116 qmp_transaction(&list, false, NULL, errp);
1119 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1120 bool has_node_name, const char *node_name,
1121 const char *snapshot_file,
1122 bool has_snapshot_node_name,
1123 const char *snapshot_node_name,
1124 bool has_format, const char *format,
1125 bool has_mode, NewImageMode mode, Error **errp)
1127 BlockdevSnapshotSync snapshot = {
1128 .has_device = has_device,
1129 .device = (char *) device,
1130 .has_node_name = has_node_name,
1131 .node_name = (char *) node_name,
1132 .snapshot_file = (char *) snapshot_file,
1133 .has_snapshot_node_name = has_snapshot_node_name,
1134 .snapshot_node_name = (char *) snapshot_node_name,
1135 .has_format = has_format,
1136 .format = (char *) format,
1137 .has_mode = has_mode,
1138 .mode = mode,
1140 TransactionAction action = {
1141 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1142 .u.blockdev_snapshot_sync.data = &snapshot,
1144 blockdev_do_action(&action, errp);
1147 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1148 Error **errp)
1150 BlockdevSnapshot snapshot_data = {
1151 .node = (char *) node,
1152 .overlay = (char *) overlay
1154 TransactionAction action = {
1155 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1156 .u.blockdev_snapshot.data = &snapshot_data,
1158 blockdev_do_action(&action, errp);
1161 void qmp_blockdev_snapshot_internal_sync(const char *device,
1162 const char *name,
1163 Error **errp)
1165 BlockdevSnapshotInternal snapshot = {
1166 .device = (char *) device,
1167 .name = (char *) name
1169 TransactionAction action = {
1170 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1171 .u.blockdev_snapshot_internal_sync.data = &snapshot,
1173 blockdev_do_action(&action, errp);
1176 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1177 bool has_id,
1178 const char *id,
1179 bool has_name,
1180 const char *name,
1181 Error **errp)
1183 BlockDriverState *bs;
1184 AioContext *aio_context;
1185 QEMUSnapshotInfo sn;
1186 Error *local_err = NULL;
1187 SnapshotInfo *info = NULL;
1188 int ret;
1190 bs = qmp_get_root_bs(device, errp);
1191 if (!bs) {
1192 return NULL;
1194 aio_context = bdrv_get_aio_context(bs);
1195 aio_context_acquire(aio_context);
1197 if (!has_id) {
1198 id = NULL;
1201 if (!has_name) {
1202 name = NULL;
1205 if (!id && !name) {
1206 error_setg(errp, "Name or id must be provided");
1207 goto out_aio_context;
1210 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1211 goto out_aio_context;
1214 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1215 if (local_err) {
1216 error_propagate(errp, local_err);
1217 goto out_aio_context;
1219 if (!ret) {
1220 error_setg(errp,
1221 "Snapshot with id '%s' and name '%s' does not exist on "
1222 "device '%s'",
1223 STR_OR_NULL(id), STR_OR_NULL(name), device);
1224 goto out_aio_context;
1227 bdrv_snapshot_delete(bs, id, name, &local_err);
1228 if (local_err) {
1229 error_propagate(errp, local_err);
1230 goto out_aio_context;
1233 aio_context_release(aio_context);
1235 info = g_new0(SnapshotInfo, 1);
1236 info->id = g_strdup(sn.id_str);
1237 info->name = g_strdup(sn.name);
1238 info->date_nsec = sn.date_nsec;
1239 info->date_sec = sn.date_sec;
1240 info->vm_state_size = sn.vm_state_size;
1241 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1242 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1244 return info;
1246 out_aio_context:
1247 aio_context_release(aio_context);
1248 return NULL;
1252 * block_dirty_bitmap_lookup:
1253 * Return a dirty bitmap (if present), after validating
1254 * the node reference and bitmap names.
1256 * @node: The name of the BDS node to search for bitmaps
1257 * @name: The name of the bitmap to search for
1258 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1259 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1260 * @errp: Output pointer for error information. Can be NULL.
1262 * @return: A bitmap object on success, or NULL on failure.
1264 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1265 const char *name,
1266 BlockDriverState **pbs,
1267 Error **errp)
1269 BlockDriverState *bs;
1270 BdrvDirtyBitmap *bitmap;
1272 if (!node) {
1273 error_setg(errp, "Node cannot be NULL");
1274 return NULL;
1276 if (!name) {
1277 error_setg(errp, "Bitmap name cannot be NULL");
1278 return NULL;
1280 bs = bdrv_lookup_bs(node, node, NULL);
1281 if (!bs) {
1282 error_setg(errp, "Node '%s' not found", node);
1283 return NULL;
1286 bitmap = bdrv_find_dirty_bitmap(bs, name);
1287 if (!bitmap) {
1288 error_setg(errp, "Dirty bitmap '%s' not found", name);
1289 return NULL;
1292 if (pbs) {
1293 *pbs = bs;
1296 return bitmap;
1299 /* New and old BlockDriverState structs for atomic group operations */
1301 typedef struct BlkActionState BlkActionState;
1304 * BlkActionOps:
1305 * Table of operations that define an Action.
1307 * @instance_size: Size of state struct, in bytes.
1308 * @prepare: Prepare the work, must NOT be NULL.
1309 * @commit: Commit the changes, can be NULL.
1310 * @abort: Abort the changes on fail, can be NULL.
1311 * @clean: Clean up resources after all transaction actions have called
1312 * commit() or abort(). Can be NULL.
1314 * Only prepare() may fail. In a single transaction, only one of commit() or
1315 * abort() will be called. clean() will always be called if it is present.
1317 typedef struct BlkActionOps {
1318 size_t instance_size;
1319 void (*prepare)(BlkActionState *common, Error **errp);
1320 void (*commit)(BlkActionState *common);
1321 void (*abort)(BlkActionState *common);
1322 void (*clean)(BlkActionState *common);
1323 } BlkActionOps;
1326 * BlkActionState:
1327 * Describes one Action's state within a Transaction.
1329 * @action: QAPI-defined enum identifying which Action to perform.
1330 * @ops: Table of ActionOps this Action can perform.
1331 * @block_job_txn: Transaction which this action belongs to.
1332 * @entry: List membership for all Actions in this Transaction.
1334 * This structure must be arranged as first member in a subclassed type,
1335 * assuming that the compiler will also arrange it to the same offsets as the
1336 * base class.
1338 struct BlkActionState {
1339 TransactionAction *action;
1340 const BlkActionOps *ops;
1341 JobTxn *block_job_txn;
1342 TransactionProperties *txn_props;
1343 QSIMPLEQ_ENTRY(BlkActionState) entry;
1346 /* internal snapshot private data */
1347 typedef struct InternalSnapshotState {
1348 BlkActionState common;
1349 BlockDriverState *bs;
1350 QEMUSnapshotInfo sn;
1351 bool created;
1352 } InternalSnapshotState;
1355 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1357 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1358 error_setg(errp,
1359 "Action '%s' does not support Transaction property "
1360 "completion-mode = %s",
1361 TransactionActionKind_str(s->action->type),
1362 ActionCompletionMode_str(s->txn_props->completion_mode));
1363 return -1;
1365 return 0;
1368 static void internal_snapshot_prepare(BlkActionState *common,
1369 Error **errp)
1371 Error *local_err = NULL;
1372 const char *device;
1373 const char *name;
1374 BlockDriverState *bs;
1375 QEMUSnapshotInfo old_sn, *sn;
1376 bool ret;
1377 qemu_timeval tv;
1378 BlockdevSnapshotInternal *internal;
1379 InternalSnapshotState *state;
1380 AioContext *aio_context;
1381 int ret1;
1383 g_assert(common->action->type ==
1384 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1385 internal = common->action->u.blockdev_snapshot_internal_sync.data;
1386 state = DO_UPCAST(InternalSnapshotState, common, common);
1388 /* 1. parse input */
1389 device = internal->device;
1390 name = internal->name;
1392 /* 2. check for validation */
1393 if (action_check_completion_mode(common, errp) < 0) {
1394 return;
1397 bs = qmp_get_root_bs(device, errp);
1398 if (!bs) {
1399 return;
1402 aio_context = bdrv_get_aio_context(bs);
1403 aio_context_acquire(aio_context);
1405 state->bs = bs;
1407 /* Paired with .clean() */
1408 bdrv_drained_begin(bs);
1410 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1411 goto out;
1414 if (bdrv_is_read_only(bs)) {
1415 error_setg(errp, "Device '%s' is read only", device);
1416 goto out;
1419 if (!bdrv_can_snapshot(bs)) {
1420 error_setg(errp, "Block format '%s' used by device '%s' "
1421 "does not support internal snapshots",
1422 bs->drv->format_name, device);
1423 goto out;
1426 if (!strlen(name)) {
1427 error_setg(errp, "Name is empty");
1428 goto out;
1431 /* check whether a snapshot with name exist */
1432 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1433 &local_err);
1434 if (local_err) {
1435 error_propagate(errp, local_err);
1436 goto out;
1437 } else if (ret) {
1438 error_setg(errp,
1439 "Snapshot with name '%s' already exists on device '%s'",
1440 name, device);
1441 goto out;
1444 /* 3. take the snapshot */
1445 sn = &state->sn;
1446 pstrcpy(sn->name, sizeof(sn->name), name);
1447 qemu_gettimeofday(&tv);
1448 sn->date_sec = tv.tv_sec;
1449 sn->date_nsec = tv.tv_usec * 1000;
1450 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1452 ret1 = bdrv_snapshot_create(bs, sn);
1453 if (ret1 < 0) {
1454 error_setg_errno(errp, -ret1,
1455 "Failed to create snapshot '%s' on device '%s'",
1456 name, device);
1457 goto out;
1460 /* 4. succeed, mark a snapshot is created */
1461 state->created = true;
1463 out:
1464 aio_context_release(aio_context);
1467 static void internal_snapshot_abort(BlkActionState *common)
1469 InternalSnapshotState *state =
1470 DO_UPCAST(InternalSnapshotState, common, common);
1471 BlockDriverState *bs = state->bs;
1472 QEMUSnapshotInfo *sn = &state->sn;
1473 AioContext *aio_context;
1474 Error *local_error = NULL;
1476 if (!state->created) {
1477 return;
1480 aio_context = bdrv_get_aio_context(state->bs);
1481 aio_context_acquire(aio_context);
1483 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1484 error_reportf_err(local_error,
1485 "Failed to delete snapshot with id '%s' and "
1486 "name '%s' on device '%s' in abort: ",
1487 sn->id_str, sn->name,
1488 bdrv_get_device_name(bs));
1491 aio_context_release(aio_context);
1494 static void internal_snapshot_clean(BlkActionState *common)
1496 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1497 common, common);
1498 AioContext *aio_context;
1500 if (!state->bs) {
1501 return;
1504 aio_context = bdrv_get_aio_context(state->bs);
1505 aio_context_acquire(aio_context);
1507 bdrv_drained_end(state->bs);
1509 aio_context_release(aio_context);
1512 /* external snapshot private data */
1513 typedef struct ExternalSnapshotState {
1514 BlkActionState common;
1515 BlockDriverState *old_bs;
1516 BlockDriverState *new_bs;
1517 bool overlay_appended;
1518 } ExternalSnapshotState;
1520 static void external_snapshot_prepare(BlkActionState *common,
1521 Error **errp)
1523 int flags = 0;
1524 QDict *options = NULL;
1525 Error *local_err = NULL;
1526 /* Device and node name of the image to generate the snapshot from */
1527 const char *device;
1528 const char *node_name;
1529 /* Reference to the new image (for 'blockdev-snapshot') */
1530 const char *snapshot_ref;
1531 /* File name of the new image (for 'blockdev-snapshot-sync') */
1532 const char *new_image_file;
1533 ExternalSnapshotState *state =
1534 DO_UPCAST(ExternalSnapshotState, common, common);
1535 TransactionAction *action = common->action;
1536 AioContext *aio_context;
1538 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1539 * purpose but a different set of parameters */
1540 switch (action->type) {
1541 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1543 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1544 device = s->node;
1545 node_name = s->node;
1546 new_image_file = NULL;
1547 snapshot_ref = s->overlay;
1549 break;
1550 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1552 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1553 device = s->has_device ? s->device : NULL;
1554 node_name = s->has_node_name ? s->node_name : NULL;
1555 new_image_file = s->snapshot_file;
1556 snapshot_ref = NULL;
1558 break;
1559 default:
1560 g_assert_not_reached();
1563 /* start processing */
1564 if (action_check_completion_mode(common, errp) < 0) {
1565 return;
1568 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1569 if (!state->old_bs) {
1570 return;
1573 aio_context = bdrv_get_aio_context(state->old_bs);
1574 aio_context_acquire(aio_context);
1576 /* Paired with .clean() */
1577 bdrv_drained_begin(state->old_bs);
1579 if (!bdrv_is_inserted(state->old_bs)) {
1580 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1581 goto out;
1584 if (bdrv_op_is_blocked(state->old_bs,
1585 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1586 goto out;
1589 if (!bdrv_is_read_only(state->old_bs)) {
1590 if (bdrv_flush(state->old_bs)) {
1591 error_setg(errp, QERR_IO_ERROR);
1592 goto out;
1596 if (!bdrv_is_first_non_filter(state->old_bs)) {
1597 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1598 goto out;
1601 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1602 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1603 const char *format = s->has_format ? s->format : "qcow2";
1604 enum NewImageMode mode;
1605 const char *snapshot_node_name =
1606 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1608 if (node_name && !snapshot_node_name) {
1609 error_setg(errp, "New snapshot node name missing");
1610 goto out;
1613 if (snapshot_node_name &&
1614 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1615 error_setg(errp, "New snapshot node name already in use");
1616 goto out;
1619 flags = state->old_bs->open_flags;
1620 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1621 flags |= BDRV_O_NO_BACKING;
1623 /* create new image w/backing file */
1624 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1625 if (mode != NEW_IMAGE_MODE_EXISTING) {
1626 int64_t size = bdrv_getlength(state->old_bs);
1627 if (size < 0) {
1628 error_setg_errno(errp, -size, "bdrv_getlength failed");
1629 goto out;
1631 bdrv_img_create(new_image_file, format,
1632 state->old_bs->filename,
1633 state->old_bs->drv->format_name,
1634 NULL, size, flags, false, &local_err);
1635 if (local_err) {
1636 error_propagate(errp, local_err);
1637 goto out;
1641 options = qdict_new();
1642 if (s->has_snapshot_node_name) {
1643 qdict_put_str(options, "node-name", snapshot_node_name);
1645 qdict_put_str(options, "driver", format);
1648 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1649 errp);
1650 /* We will manually add the backing_hd field to the bs later */
1651 if (!state->new_bs) {
1652 goto out;
1655 if (bdrv_has_blk(state->new_bs)) {
1656 error_setg(errp, "The snapshot is already in use");
1657 goto out;
1660 if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
1661 errp)) {
1662 goto out;
1665 if (state->new_bs->backing != NULL) {
1666 error_setg(errp, "The snapshot already has a backing image");
1667 goto out;
1670 if (!state->new_bs->drv->supports_backing) {
1671 error_setg(errp, "The snapshot does not support backing images");
1672 goto out;
1675 bdrv_set_aio_context(state->new_bs, aio_context);
1677 /* This removes our old bs and adds the new bs. This is an operation that
1678 * can fail, so we need to do it in .prepare; undoing it for abort is
1679 * always possible. */
1680 bdrv_ref(state->new_bs);
1681 bdrv_append(state->new_bs, state->old_bs, &local_err);
1682 if (local_err) {
1683 error_propagate(errp, local_err);
1684 goto out;
1686 state->overlay_appended = true;
1688 out:
1689 aio_context_release(aio_context);
1692 static void external_snapshot_commit(BlkActionState *common)
1694 ExternalSnapshotState *state =
1695 DO_UPCAST(ExternalSnapshotState, common, common);
1696 AioContext *aio_context;
1698 aio_context = bdrv_get_aio_context(state->old_bs);
1699 aio_context_acquire(aio_context);
1701 /* We don't need (or want) to use the transactional
1702 * bdrv_reopen_multiple() across all the entries at once, because we
1703 * don't want to abort all of them if one of them fails the reopen */
1704 if (!atomic_read(&state->old_bs->copy_on_read)) {
1705 bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1706 NULL);
1709 aio_context_release(aio_context);
1712 static void external_snapshot_abort(BlkActionState *common)
1714 ExternalSnapshotState *state =
1715 DO_UPCAST(ExternalSnapshotState, common, common);
1716 if (state->new_bs) {
1717 if (state->overlay_appended) {
1718 AioContext *aio_context;
1720 aio_context = bdrv_get_aio_context(state->old_bs);
1721 aio_context_acquire(aio_context);
1723 bdrv_ref(state->old_bs); /* we can't let bdrv_set_backind_hd()
1724 close state->old_bs; we need it */
1725 bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
1726 bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
1727 bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
1729 aio_context_release(aio_context);
1734 static void external_snapshot_clean(BlkActionState *common)
1736 ExternalSnapshotState *state =
1737 DO_UPCAST(ExternalSnapshotState, common, common);
1738 AioContext *aio_context;
1740 if (!state->old_bs) {
1741 return;
1744 aio_context = bdrv_get_aio_context(state->old_bs);
1745 aio_context_acquire(aio_context);
1747 bdrv_drained_end(state->old_bs);
1748 bdrv_unref(state->new_bs);
1750 aio_context_release(aio_context);
1753 typedef struct DriveBackupState {
1754 BlkActionState common;
1755 BlockDriverState *bs;
1756 BlockJob *job;
1757 } DriveBackupState;
1759 static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
1760 Error **errp);
1762 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1764 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1765 BlockDriverState *bs;
1766 DriveBackup *backup;
1767 AioContext *aio_context;
1768 Error *local_err = NULL;
1770 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1771 backup = common->action->u.drive_backup.data;
1773 bs = qmp_get_root_bs(backup->device, errp);
1774 if (!bs) {
1775 return;
1778 aio_context = bdrv_get_aio_context(bs);
1779 aio_context_acquire(aio_context);
1781 /* Paired with .clean() */
1782 bdrv_drained_begin(bs);
1784 state->bs = bs;
1786 state->job = do_drive_backup(backup, common->block_job_txn, &local_err);
1787 if (local_err) {
1788 error_propagate(errp, local_err);
1789 goto out;
1792 out:
1793 aio_context_release(aio_context);
1796 static void drive_backup_commit(BlkActionState *common)
1798 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1799 AioContext *aio_context;
1801 aio_context = bdrv_get_aio_context(state->bs);
1802 aio_context_acquire(aio_context);
1804 assert(state->job);
1805 job_start(&state->job->job);
1807 aio_context_release(aio_context);
1810 static void drive_backup_abort(BlkActionState *common)
1812 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1814 if (state->job) {
1815 AioContext *aio_context;
1817 aio_context = bdrv_get_aio_context(state->bs);
1818 aio_context_acquire(aio_context);
1820 job_cancel_sync(&state->job->job);
1822 aio_context_release(aio_context);
1826 static void drive_backup_clean(BlkActionState *common)
1828 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1829 AioContext *aio_context;
1831 if (!state->bs) {
1832 return;
1835 aio_context = bdrv_get_aio_context(state->bs);
1836 aio_context_acquire(aio_context);
1838 bdrv_drained_end(state->bs);
1840 aio_context_release(aio_context);
1843 typedef struct BlockdevBackupState {
1844 BlkActionState common;
1845 BlockDriverState *bs;
1846 BlockJob *job;
1847 } BlockdevBackupState;
1849 static BlockJob *do_blockdev_backup(BlockdevBackup *backup, JobTxn *txn,
1850 Error **errp);
1852 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1854 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1855 BlockdevBackup *backup;
1856 BlockDriverState *bs, *target;
1857 AioContext *aio_context;
1858 Error *local_err = NULL;
1860 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1861 backup = common->action->u.blockdev_backup.data;
1863 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1864 if (!bs) {
1865 return;
1868 target = bdrv_lookup_bs(backup->target, backup->target, errp);
1869 if (!target) {
1870 return;
1873 aio_context = bdrv_get_aio_context(bs);
1874 if (aio_context != bdrv_get_aio_context(target)) {
1875 error_setg(errp, "Backup between two IO threads is not implemented");
1876 return;
1878 aio_context_acquire(aio_context);
1879 state->bs = bs;
1881 /* Paired with .clean() */
1882 bdrv_drained_begin(state->bs);
1884 state->job = do_blockdev_backup(backup, common->block_job_txn, &local_err);
1885 if (local_err) {
1886 error_propagate(errp, local_err);
1887 goto out;
1890 out:
1891 aio_context_release(aio_context);
1894 static void blockdev_backup_commit(BlkActionState *common)
1896 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1897 AioContext *aio_context;
1899 aio_context = bdrv_get_aio_context(state->bs);
1900 aio_context_acquire(aio_context);
1902 assert(state->job);
1903 job_start(&state->job->job);
1905 aio_context_release(aio_context);
1908 static void blockdev_backup_abort(BlkActionState *common)
1910 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1912 if (state->job) {
1913 AioContext *aio_context;
1915 aio_context = bdrv_get_aio_context(state->bs);
1916 aio_context_acquire(aio_context);
1918 job_cancel_sync(&state->job->job);
1920 aio_context_release(aio_context);
1924 static void blockdev_backup_clean(BlkActionState *common)
1926 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1927 AioContext *aio_context;
1929 if (!state->bs) {
1930 return;
1933 aio_context = bdrv_get_aio_context(state->bs);
1934 aio_context_acquire(aio_context);
1936 bdrv_drained_end(state->bs);
1938 aio_context_release(aio_context);
1941 typedef struct BlockDirtyBitmapState {
1942 BlkActionState common;
1943 BdrvDirtyBitmap *bitmap;
1944 BlockDriverState *bs;
1945 HBitmap *backup;
1946 bool prepared;
1947 bool was_enabled;
1948 } BlockDirtyBitmapState;
1950 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
1951 Error **errp)
1953 Error *local_err = NULL;
1954 BlockDirtyBitmapAdd *action;
1955 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1956 common, common);
1958 if (action_check_completion_mode(common, errp) < 0) {
1959 return;
1962 action = common->action->u.block_dirty_bitmap_add.data;
1963 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1964 qmp_block_dirty_bitmap_add(action->node, action->name,
1965 action->has_granularity, action->granularity,
1966 action->has_persistent, action->persistent,
1967 action->has_autoload, action->autoload,
1968 action->has_x_disabled, action->x_disabled,
1969 &local_err);
1971 if (!local_err) {
1972 state->prepared = true;
1973 } else {
1974 error_propagate(errp, local_err);
1978 static void block_dirty_bitmap_add_abort(BlkActionState *common)
1980 BlockDirtyBitmapAdd *action;
1981 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1982 common, common);
1984 action = common->action->u.block_dirty_bitmap_add.data;
1985 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1986 * then the node reference and bitmap name must have been valid.
1988 if (state->prepared) {
1989 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
1993 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
1994 Error **errp)
1996 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1997 common, common);
1998 BlockDirtyBitmap *action;
2000 if (action_check_completion_mode(common, errp) < 0) {
2001 return;
2004 action = common->action->u.block_dirty_bitmap_clear.data;
2005 state->bitmap = block_dirty_bitmap_lookup(action->node,
2006 action->name,
2007 &state->bs,
2008 errp);
2009 if (!state->bitmap) {
2010 return;
2013 if (bdrv_dirty_bitmap_frozen(state->bitmap)) {
2014 error_setg(errp, "Cannot modify a frozen bitmap");
2015 return;
2016 } else if (bdrv_dirty_bitmap_qmp_locked(state->bitmap)) {
2017 error_setg(errp, "Cannot modify a locked bitmap");
2018 return;
2019 } else if (!bdrv_dirty_bitmap_enabled(state->bitmap)) {
2020 error_setg(errp, "Cannot clear a disabled bitmap");
2021 return;
2022 } else if (bdrv_dirty_bitmap_readonly(state->bitmap)) {
2023 error_setg(errp, "Cannot clear a readonly bitmap");
2024 return;
2027 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2030 static void block_dirty_bitmap_clear_abort(BlkActionState *common)
2032 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2033 common, common);
2035 if (state->backup) {
2036 bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
2040 static void block_dirty_bitmap_clear_commit(BlkActionState *common)
2042 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2043 common, common);
2045 hbitmap_free(state->backup);
2048 static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2049 Error **errp)
2051 BlockDirtyBitmap *action;
2052 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2053 common, common);
2055 if (action_check_completion_mode(common, errp) < 0) {
2056 return;
2059 action = common->action->u.x_block_dirty_bitmap_enable.data;
2060 state->bitmap = block_dirty_bitmap_lookup(action->node,
2061 action->name,
2062 NULL,
2063 errp);
2064 if (!state->bitmap) {
2065 return;
2068 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2069 bdrv_enable_dirty_bitmap(state->bitmap);
2072 static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2074 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2075 common, common);
2077 if (!state->was_enabled) {
2078 bdrv_disable_dirty_bitmap(state->bitmap);
2082 static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2083 Error **errp)
2085 BlockDirtyBitmap *action;
2086 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2087 common, common);
2089 if (action_check_completion_mode(common, errp) < 0) {
2090 return;
2093 action = common->action->u.x_block_dirty_bitmap_disable.data;
2094 state->bitmap = block_dirty_bitmap_lookup(action->node,
2095 action->name,
2096 NULL,
2097 errp);
2098 if (!state->bitmap) {
2099 return;
2102 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2103 bdrv_disable_dirty_bitmap(state->bitmap);
2106 static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2108 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2109 common, common);
2111 if (state->was_enabled) {
2112 bdrv_enable_dirty_bitmap(state->bitmap);
2116 static void abort_prepare(BlkActionState *common, Error **errp)
2118 error_setg(errp, "Transaction aborted using Abort action");
2121 static void abort_commit(BlkActionState *common)
2123 g_assert_not_reached(); /* this action never succeeds */
2126 static const BlkActionOps actions[] = {
2127 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2128 .instance_size = sizeof(ExternalSnapshotState),
2129 .prepare = external_snapshot_prepare,
2130 .commit = external_snapshot_commit,
2131 .abort = external_snapshot_abort,
2132 .clean = external_snapshot_clean,
2134 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2135 .instance_size = sizeof(ExternalSnapshotState),
2136 .prepare = external_snapshot_prepare,
2137 .commit = external_snapshot_commit,
2138 .abort = external_snapshot_abort,
2139 .clean = external_snapshot_clean,
2141 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2142 .instance_size = sizeof(DriveBackupState),
2143 .prepare = drive_backup_prepare,
2144 .commit = drive_backup_commit,
2145 .abort = drive_backup_abort,
2146 .clean = drive_backup_clean,
2148 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2149 .instance_size = sizeof(BlockdevBackupState),
2150 .prepare = blockdev_backup_prepare,
2151 .commit = blockdev_backup_commit,
2152 .abort = blockdev_backup_abort,
2153 .clean = blockdev_backup_clean,
2155 [TRANSACTION_ACTION_KIND_ABORT] = {
2156 .instance_size = sizeof(BlkActionState),
2157 .prepare = abort_prepare,
2158 .commit = abort_commit,
2160 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2161 .instance_size = sizeof(InternalSnapshotState),
2162 .prepare = internal_snapshot_prepare,
2163 .abort = internal_snapshot_abort,
2164 .clean = internal_snapshot_clean,
2166 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2167 .instance_size = sizeof(BlockDirtyBitmapState),
2168 .prepare = block_dirty_bitmap_add_prepare,
2169 .abort = block_dirty_bitmap_add_abort,
2171 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2172 .instance_size = sizeof(BlockDirtyBitmapState),
2173 .prepare = block_dirty_bitmap_clear_prepare,
2174 .commit = block_dirty_bitmap_clear_commit,
2175 .abort = block_dirty_bitmap_clear_abort,
2177 [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_ENABLE] = {
2178 .instance_size = sizeof(BlockDirtyBitmapState),
2179 .prepare = block_dirty_bitmap_enable_prepare,
2180 .abort = block_dirty_bitmap_enable_abort,
2182 [TRANSACTION_ACTION_KIND_X_BLOCK_DIRTY_BITMAP_DISABLE] = {
2183 .instance_size = sizeof(BlockDirtyBitmapState),
2184 .prepare = block_dirty_bitmap_disable_prepare,
2185 .abort = block_dirty_bitmap_disable_abort,
2187 /* Where are transactions for MIRROR, COMMIT and STREAM?
2188 * Although these blockjobs use transaction callbacks like the backup job,
2189 * these jobs do not necessarily adhere to transaction semantics.
2190 * These jobs may not fully undo all of their actions on abort, nor do they
2191 * necessarily work in transactions with more than one job in them.
2196 * Allocate a TransactionProperties structure if necessary, and fill
2197 * that structure with desired defaults if they are unset.
2199 static TransactionProperties *get_transaction_properties(
2200 TransactionProperties *props)
2202 if (!props) {
2203 props = g_new0(TransactionProperties, 1);
2206 if (!props->has_completion_mode) {
2207 props->has_completion_mode = true;
2208 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2211 return props;
2215 * 'Atomic' group operations. The operations are performed as a set, and if
2216 * any fail then we roll back all operations in the group.
2218 void qmp_transaction(TransactionActionList *dev_list,
2219 bool has_props,
2220 struct TransactionProperties *props,
2221 Error **errp)
2223 TransactionActionList *dev_entry = dev_list;
2224 JobTxn *block_job_txn = NULL;
2225 BlkActionState *state, *next;
2226 Error *local_err = NULL;
2228 QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2229 QSIMPLEQ_INIT(&snap_bdrv_states);
2231 /* Does this transaction get canceled as a group on failure?
2232 * If not, we don't really need to make a JobTxn.
2234 props = get_transaction_properties(props);
2235 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2236 block_job_txn = job_txn_new();
2239 /* drain all i/o before any operations */
2240 bdrv_drain_all();
2242 /* We don't do anything in this loop that commits us to the operations */
2243 while (NULL != dev_entry) {
2244 TransactionAction *dev_info = NULL;
2245 const BlkActionOps *ops;
2247 dev_info = dev_entry->value;
2248 dev_entry = dev_entry->next;
2250 assert(dev_info->type < ARRAY_SIZE(actions));
2252 ops = &actions[dev_info->type];
2253 assert(ops->instance_size > 0);
2255 state = g_malloc0(ops->instance_size);
2256 state->ops = ops;
2257 state->action = dev_info;
2258 state->block_job_txn = block_job_txn;
2259 state->txn_props = props;
2260 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2262 state->ops->prepare(state, &local_err);
2263 if (local_err) {
2264 error_propagate(errp, local_err);
2265 goto delete_and_fail;
2269 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2270 if (state->ops->commit) {
2271 state->ops->commit(state);
2275 /* success */
2276 goto exit;
2278 delete_and_fail:
2279 /* failure, and it is all-or-none; roll back all operations */
2280 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2281 if (state->ops->abort) {
2282 state->ops->abort(state);
2285 exit:
2286 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2287 if (state->ops->clean) {
2288 state->ops->clean(state);
2290 g_free(state);
2292 if (!has_props) {
2293 qapi_free_TransactionProperties(props);
2295 job_txn_unref(block_job_txn);
2298 void qmp_eject(bool has_device, const char *device,
2299 bool has_id, const char *id,
2300 bool has_force, bool force, Error **errp)
2302 Error *local_err = NULL;
2303 int rc;
2305 if (!has_force) {
2306 force = false;
2309 rc = do_open_tray(has_device ? device : NULL,
2310 has_id ? id : NULL,
2311 force, &local_err);
2312 if (rc && rc != -ENOSYS) {
2313 error_propagate(errp, local_err);
2314 return;
2316 error_free(local_err);
2318 blockdev_remove_medium(has_device, device, has_id, id, errp);
2321 void qmp_block_passwd(bool has_device, const char *device,
2322 bool has_node_name, const char *node_name,
2323 const char *password, Error **errp)
2325 error_setg(errp,
2326 "Setting block passwords directly is no longer supported");
2330 * Attempt to open the tray of @device.
2331 * If @force, ignore its tray lock.
2332 * Else, if the tray is locked, don't open it, but ask the guest to open it.
2333 * On error, store an error through @errp and return -errno.
2334 * If @device does not exist, return -ENODEV.
2335 * If it has no removable media, return -ENOTSUP.
2336 * If it has no tray, return -ENOSYS.
2337 * If the guest was asked to open the tray, return -EINPROGRESS.
2338 * Else, return 0.
2340 static int do_open_tray(const char *blk_name, const char *qdev_id,
2341 bool force, Error **errp)
2343 BlockBackend *blk;
2344 const char *device = qdev_id ?: blk_name;
2345 bool locked;
2347 blk = qmp_get_blk(blk_name, qdev_id, errp);
2348 if (!blk) {
2349 return -ENODEV;
2352 if (!blk_dev_has_removable_media(blk)) {
2353 error_setg(errp, "Device '%s' is not removable", device);
2354 return -ENOTSUP;
2357 if (!blk_dev_has_tray(blk)) {
2358 error_setg(errp, "Device '%s' does not have a tray", device);
2359 return -ENOSYS;
2362 if (blk_dev_is_tray_open(blk)) {
2363 return 0;
2366 locked = blk_dev_is_medium_locked(blk);
2367 if (locked) {
2368 blk_dev_eject_request(blk, force);
2371 if (!locked || force) {
2372 blk_dev_change_media_cb(blk, false, &error_abort);
2375 if (locked && !force) {
2376 error_setg(errp, "Device '%s' is locked and force was not specified, "
2377 "wait for tray to open and try again", device);
2378 return -EINPROGRESS;
2381 return 0;
2384 void qmp_blockdev_open_tray(bool has_device, const char *device,
2385 bool has_id, const char *id,
2386 bool has_force, bool force,
2387 Error **errp)
2389 Error *local_err = NULL;
2390 int rc;
2392 if (!has_force) {
2393 force = false;
2395 rc = do_open_tray(has_device ? device : NULL,
2396 has_id ? id : NULL,
2397 force, &local_err);
2398 if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2399 error_propagate(errp, local_err);
2400 return;
2402 error_free(local_err);
2405 void qmp_blockdev_close_tray(bool has_device, const char *device,
2406 bool has_id, const char *id,
2407 Error **errp)
2409 BlockBackend *blk;
2410 Error *local_err = NULL;
2412 device = has_device ? device : NULL;
2413 id = has_id ? id : NULL;
2415 blk = qmp_get_blk(device, id, errp);
2416 if (!blk) {
2417 return;
2420 if (!blk_dev_has_removable_media(blk)) {
2421 error_setg(errp, "Device '%s' is not removable", device ?: id);
2422 return;
2425 if (!blk_dev_has_tray(blk)) {
2426 /* Ignore this command on tray-less devices */
2427 return;
2430 if (!blk_dev_is_tray_open(blk)) {
2431 return;
2434 blk_dev_change_media_cb(blk, true, &local_err);
2435 if (local_err) {
2436 error_propagate(errp, local_err);
2437 return;
2441 static void blockdev_remove_medium(bool has_device, const char *device,
2442 bool has_id, const char *id, Error **errp)
2444 BlockBackend *blk;
2445 BlockDriverState *bs;
2446 AioContext *aio_context;
2447 bool has_attached_device;
2449 device = has_device ? device : NULL;
2450 id = has_id ? id : NULL;
2452 blk = qmp_get_blk(device, id, errp);
2453 if (!blk) {
2454 return;
2457 /* For BBs without a device, we can exchange the BDS tree at will */
2458 has_attached_device = blk_get_attached_dev(blk);
2460 if (has_attached_device && !blk_dev_has_removable_media(blk)) {
2461 error_setg(errp, "Device '%s' is not removable", device ?: id);
2462 return;
2465 if (has_attached_device && blk_dev_has_tray(blk) &&
2466 !blk_dev_is_tray_open(blk))
2468 error_setg(errp, "Tray of device '%s' is not open", device ?: id);
2469 return;
2472 bs = blk_bs(blk);
2473 if (!bs) {
2474 return;
2477 aio_context = bdrv_get_aio_context(bs);
2478 aio_context_acquire(aio_context);
2480 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2481 goto out;
2484 blk_remove_bs(blk);
2486 if (!blk_dev_has_tray(blk)) {
2487 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2488 * called at all); therefore, the medium needs to be ejected here.
2489 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2490 * value passed here (i.e. false). */
2491 blk_dev_change_media_cb(blk, false, &error_abort);
2494 out:
2495 aio_context_release(aio_context);
2498 void qmp_blockdev_remove_medium(const char *id, Error **errp)
2500 blockdev_remove_medium(false, NULL, true, id, errp);
2503 static void qmp_blockdev_insert_anon_medium(BlockBackend *blk,
2504 BlockDriverState *bs, Error **errp)
2506 Error *local_err = NULL;
2507 bool has_device;
2508 int ret;
2510 /* For BBs without a device, we can exchange the BDS tree at will */
2511 has_device = blk_get_attached_dev(blk);
2513 if (has_device && !blk_dev_has_removable_media(blk)) {
2514 error_setg(errp, "Device is not removable");
2515 return;
2518 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2519 error_setg(errp, "Tray of the device is not open");
2520 return;
2523 if (blk_bs(blk)) {
2524 error_setg(errp, "There already is a medium in the device");
2525 return;
2528 ret = blk_insert_bs(blk, bs, errp);
2529 if (ret < 0) {
2530 return;
2533 if (!blk_dev_has_tray(blk)) {
2534 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2535 * called at all); therefore, the medium needs to be pushed into the
2536 * slot here.
2537 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2538 * value passed here (i.e. true). */
2539 blk_dev_change_media_cb(blk, true, &local_err);
2540 if (local_err) {
2541 error_propagate(errp, local_err);
2542 blk_remove_bs(blk);
2543 return;
2548 static void blockdev_insert_medium(bool has_device, const char *device,
2549 bool has_id, const char *id,
2550 const char *node_name, Error **errp)
2552 BlockBackend *blk;
2553 BlockDriverState *bs;
2555 blk = qmp_get_blk(has_device ? device : NULL,
2556 has_id ? id : NULL,
2557 errp);
2558 if (!blk) {
2559 return;
2562 bs = bdrv_find_node(node_name);
2563 if (!bs) {
2564 error_setg(errp, "Node '%s' not found", node_name);
2565 return;
2568 if (bdrv_has_blk(bs)) {
2569 error_setg(errp, "Node '%s' is already in use", node_name);
2570 return;
2573 qmp_blockdev_insert_anon_medium(blk, bs, errp);
2576 void qmp_blockdev_insert_medium(const char *id, const char *node_name,
2577 Error **errp)
2579 blockdev_insert_medium(false, NULL, true, id, node_name, errp);
2582 void qmp_blockdev_change_medium(bool has_device, const char *device,
2583 bool has_id, const char *id,
2584 const char *filename,
2585 bool has_format, const char *format,
2586 bool has_read_only,
2587 BlockdevChangeReadOnlyMode read_only,
2588 Error **errp)
2590 BlockBackend *blk;
2591 BlockDriverState *medium_bs = NULL;
2592 int bdrv_flags;
2593 bool detect_zeroes;
2594 int rc;
2595 QDict *options = NULL;
2596 Error *err = NULL;
2598 blk = qmp_get_blk(has_device ? device : NULL,
2599 has_id ? id : NULL,
2600 errp);
2601 if (!blk) {
2602 goto fail;
2605 if (blk_bs(blk)) {
2606 blk_update_root_state(blk);
2609 bdrv_flags = blk_get_open_flags_from_root_state(blk);
2610 bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2611 BDRV_O_PROTOCOL);
2613 if (!has_read_only) {
2614 read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2617 switch (read_only) {
2618 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2619 break;
2621 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2622 bdrv_flags &= ~BDRV_O_RDWR;
2623 break;
2625 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2626 bdrv_flags |= BDRV_O_RDWR;
2627 break;
2629 default:
2630 abort();
2633 options = qdict_new();
2634 detect_zeroes = blk_get_detect_zeroes_from_root_state(blk);
2635 qdict_put_str(options, "detect-zeroes", detect_zeroes ? "on" : "off");
2637 if (has_format) {
2638 qdict_put_str(options, "driver", format);
2641 medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2642 if (!medium_bs) {
2643 goto fail;
2646 rc = do_open_tray(has_device ? device : NULL,
2647 has_id ? id : NULL,
2648 false, &err);
2649 if (rc && rc != -ENOSYS) {
2650 error_propagate(errp, err);
2651 goto fail;
2653 error_free(err);
2654 err = NULL;
2656 blockdev_remove_medium(has_device, device, has_id, id, &err);
2657 if (err) {
2658 error_propagate(errp, err);
2659 goto fail;
2662 qmp_blockdev_insert_anon_medium(blk, medium_bs, &err);
2663 if (err) {
2664 error_propagate(errp, err);
2665 goto fail;
2668 qmp_blockdev_close_tray(has_device, device, has_id, id, errp);
2670 fail:
2671 /* If the medium has been inserted, the device has its own reference, so
2672 * ours must be relinquished; and if it has not been inserted successfully,
2673 * the reference must be relinquished anyway */
2674 bdrv_unref(medium_bs);
2677 /* throttling disk I/O limits */
2678 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2680 ThrottleConfig cfg;
2681 BlockDriverState *bs;
2682 BlockBackend *blk;
2683 AioContext *aio_context;
2685 blk = qmp_get_blk(arg->has_device ? arg->device : NULL,
2686 arg->has_id ? arg->id : NULL,
2687 errp);
2688 if (!blk) {
2689 return;
2692 aio_context = blk_get_aio_context(blk);
2693 aio_context_acquire(aio_context);
2695 bs = blk_bs(blk);
2696 if (!bs) {
2697 error_setg(errp, "Device has no medium");
2698 goto out;
2701 throttle_config_init(&cfg);
2702 cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2703 cfg.buckets[THROTTLE_BPS_READ].avg = arg->bps_rd;
2704 cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2706 cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2707 cfg.buckets[THROTTLE_OPS_READ].avg = arg->iops_rd;
2708 cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2710 if (arg->has_bps_max) {
2711 cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2713 if (arg->has_bps_rd_max) {
2714 cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2716 if (arg->has_bps_wr_max) {
2717 cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2719 if (arg->has_iops_max) {
2720 cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2722 if (arg->has_iops_rd_max) {
2723 cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2725 if (arg->has_iops_wr_max) {
2726 cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2729 if (arg->has_bps_max_length) {
2730 cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2732 if (arg->has_bps_rd_max_length) {
2733 cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2735 if (arg->has_bps_wr_max_length) {
2736 cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2738 if (arg->has_iops_max_length) {
2739 cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2741 if (arg->has_iops_rd_max_length) {
2742 cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2744 if (arg->has_iops_wr_max_length) {
2745 cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2748 if (arg->has_iops_size) {
2749 cfg.op_size = arg->iops_size;
2752 if (!throttle_is_valid(&cfg, errp)) {
2753 goto out;
2756 if (throttle_enabled(&cfg)) {
2757 /* Enable I/O limits if they're not enabled yet, otherwise
2758 * just update the throttling group. */
2759 if (!blk_get_public(blk)->throttle_group_member.throttle_state) {
2760 blk_io_limits_enable(blk,
2761 arg->has_group ? arg->group :
2762 arg->has_device ? arg->device :
2763 arg->id);
2764 } else if (arg->has_group) {
2765 blk_io_limits_update_group(blk, arg->group);
2767 /* Set the new throttling configuration */
2768 blk_set_io_limits(blk, &cfg);
2769 } else if (blk_get_public(blk)->throttle_group_member.throttle_state) {
2770 /* If all throttling settings are set to 0, disable I/O limits */
2771 blk_io_limits_disable(blk);
2774 out:
2775 aio_context_release(aio_context);
2778 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2779 bool has_granularity, uint32_t granularity,
2780 bool has_persistent, bool persistent,
2781 bool has_autoload, bool autoload,
2782 bool has_disabled, bool disabled,
2783 Error **errp)
2785 BlockDriverState *bs;
2786 BdrvDirtyBitmap *bitmap;
2788 if (!name || name[0] == '\0') {
2789 error_setg(errp, "Bitmap name cannot be empty");
2790 return;
2793 bs = bdrv_lookup_bs(node, node, errp);
2794 if (!bs) {
2795 return;
2798 if (has_granularity) {
2799 if (granularity < 512 || !is_power_of_2(granularity)) {
2800 error_setg(errp, "Granularity must be power of 2 "
2801 "and at least 512");
2802 return;
2804 } else {
2805 /* Default to cluster size, if available: */
2806 granularity = bdrv_get_default_bitmap_granularity(bs);
2809 if (!has_persistent) {
2810 persistent = false;
2813 if (has_autoload) {
2814 warn_report("Autoload option is deprecated and its value is ignored");
2817 if (!has_disabled) {
2818 disabled = false;
2821 if (persistent &&
2822 !bdrv_can_store_new_dirty_bitmap(bs, name, granularity, errp))
2824 return;
2827 bitmap = bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2828 if (bitmap == NULL) {
2829 return;
2832 if (disabled) {
2833 bdrv_disable_dirty_bitmap(bitmap);
2836 bdrv_dirty_bitmap_set_persistance(bitmap, persistent);
2839 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2840 Error **errp)
2842 BlockDriverState *bs;
2843 BdrvDirtyBitmap *bitmap;
2844 Error *local_err = NULL;
2846 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2847 if (!bitmap || !bs) {
2848 return;
2851 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2852 error_setg(errp,
2853 "Bitmap '%s' is currently frozen and cannot be removed",
2854 name);
2855 return;
2856 } else if (bdrv_dirty_bitmap_qmp_locked(bitmap)) {
2857 error_setg(errp,
2858 "Bitmap '%s' is currently locked and cannot be removed",
2859 name);
2860 return;
2863 if (bdrv_dirty_bitmap_get_persistance(bitmap)) {
2864 bdrv_remove_persistent_dirty_bitmap(bs, name, &local_err);
2865 if (local_err != NULL) {
2866 error_propagate(errp, local_err);
2867 return;
2871 bdrv_release_dirty_bitmap(bs, bitmap);
2875 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2876 * immediately after a full backup operation.
2878 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2879 Error **errp)
2881 BdrvDirtyBitmap *bitmap;
2882 BlockDriverState *bs;
2884 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2885 if (!bitmap || !bs) {
2886 return;
2889 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2890 error_setg(errp,
2891 "Bitmap '%s' is currently frozen and cannot be modified",
2892 name);
2893 return;
2894 } else if (bdrv_dirty_bitmap_qmp_locked(bitmap)) {
2895 error_setg(errp,
2896 "Bitmap '%s' is currently locked and cannot be modified",
2897 name);
2898 return;
2899 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2900 error_setg(errp,
2901 "Bitmap '%s' is currently disabled and cannot be cleared",
2902 name);
2903 return;
2904 } else if (bdrv_dirty_bitmap_readonly(bitmap)) {
2905 error_setg(errp, "Bitmap '%s' is readonly and cannot be cleared", name);
2906 return;
2909 bdrv_clear_dirty_bitmap(bitmap, NULL);
2912 void qmp_x_block_dirty_bitmap_enable(const char *node, const char *name,
2913 Error **errp)
2915 BlockDriverState *bs;
2916 BdrvDirtyBitmap *bitmap;
2918 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2919 if (!bitmap) {
2920 return;
2923 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2924 error_setg(errp,
2925 "Bitmap '%s' is currently frozen and cannot be enabled",
2926 name);
2927 return;
2930 bdrv_enable_dirty_bitmap(bitmap);
2933 void qmp_x_block_dirty_bitmap_disable(const char *node, const char *name,
2934 Error **errp)
2936 BlockDriverState *bs;
2937 BdrvDirtyBitmap *bitmap;
2939 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2940 if (!bitmap) {
2941 return;
2944 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2945 error_setg(errp,
2946 "Bitmap '%s' is currently frozen and cannot be disabled",
2947 name);
2948 return;
2951 bdrv_disable_dirty_bitmap(bitmap);
2954 void qmp_x_block_dirty_bitmap_merge(const char *node, const char *dst_name,
2955 const char *src_name, Error **errp)
2957 BlockDriverState *bs;
2958 BdrvDirtyBitmap *dst, *src;
2960 dst = block_dirty_bitmap_lookup(node, dst_name, &bs, errp);
2961 if (!dst) {
2962 return;
2965 if (bdrv_dirty_bitmap_frozen(dst)) {
2966 error_setg(errp, "Bitmap '%s' is frozen and cannot be modified",
2967 dst_name);
2968 return;
2969 } else if (bdrv_dirty_bitmap_readonly(dst)) {
2970 error_setg(errp, "Bitmap '%s' is readonly and cannot be modified",
2971 dst_name);
2972 return;
2975 src = bdrv_find_dirty_bitmap(bs, src_name);
2976 if (!src) {
2977 error_setg(errp, "Dirty bitmap '%s' not found", src_name);
2978 return;
2981 bdrv_merge_dirty_bitmap(dst, src, errp);
2984 BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2985 const char *name,
2986 Error **errp)
2988 BdrvDirtyBitmap *bitmap;
2989 BlockDriverState *bs;
2990 BlockDirtyBitmapSha256 *ret = NULL;
2991 char *sha256;
2993 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2994 if (!bitmap || !bs) {
2995 return NULL;
2998 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2999 if (sha256 == NULL) {
3000 return NULL;
3003 ret = g_new(BlockDirtyBitmapSha256, 1);
3004 ret->sha256 = sha256;
3006 return ret;
3009 void hmp_drive_del(Monitor *mon, const QDict *qdict)
3011 const char *id = qdict_get_str(qdict, "id");
3012 BlockBackend *blk;
3013 BlockDriverState *bs;
3014 AioContext *aio_context;
3015 Error *local_err = NULL;
3017 bs = bdrv_find_node(id);
3018 if (bs) {
3019 qmp_blockdev_del(id, &local_err);
3020 if (local_err) {
3021 error_report_err(local_err);
3023 return;
3026 blk = blk_by_name(id);
3027 if (!blk) {
3028 error_report("Device '%s' not found", id);
3029 return;
3032 if (!blk_legacy_dinfo(blk)) {
3033 error_report("Deleting device added with blockdev-add"
3034 " is not supported");
3035 return;
3038 aio_context = blk_get_aio_context(blk);
3039 aio_context_acquire(aio_context);
3041 bs = blk_bs(blk);
3042 if (bs) {
3043 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
3044 error_report_err(local_err);
3045 aio_context_release(aio_context);
3046 return;
3049 blk_remove_bs(blk);
3052 /* Make the BlockBackend and the attached BlockDriverState anonymous */
3053 monitor_remove_blk(blk);
3055 /* If this BlockBackend has a device attached to it, its refcount will be
3056 * decremented when the device is removed; otherwise we have to do so here.
3058 if (blk_get_attached_dev(blk)) {
3059 /* Further I/O must not pause the guest */
3060 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
3061 BLOCKDEV_ON_ERROR_REPORT);
3062 } else {
3063 blk_unref(blk);
3066 aio_context_release(aio_context);
3069 void qmp_block_resize(bool has_device, const char *device,
3070 bool has_node_name, const char *node_name,
3071 int64_t size, Error **errp)
3073 Error *local_err = NULL;
3074 BlockBackend *blk = NULL;
3075 BlockDriverState *bs;
3076 AioContext *aio_context;
3077 int ret;
3079 bs = bdrv_lookup_bs(has_device ? device : NULL,
3080 has_node_name ? node_name : NULL,
3081 &local_err);
3082 if (local_err) {
3083 error_propagate(errp, local_err);
3084 return;
3087 aio_context = bdrv_get_aio_context(bs);
3088 aio_context_acquire(aio_context);
3090 if (!bdrv_is_first_non_filter(bs)) {
3091 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
3092 goto out;
3095 if (size < 0) {
3096 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
3097 goto out;
3100 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
3101 error_setg(errp, QERR_DEVICE_IN_USE, device);
3102 goto out;
3105 blk = blk_new(BLK_PERM_RESIZE, BLK_PERM_ALL);
3106 ret = blk_insert_bs(blk, bs, errp);
3107 if (ret < 0) {
3108 goto out;
3111 bdrv_drained_begin(bs);
3112 ret = blk_truncate(blk, size, PREALLOC_MODE_OFF, errp);
3113 bdrv_drained_end(bs);
3115 out:
3116 blk_unref(blk);
3117 aio_context_release(aio_context);
3120 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
3121 bool has_base, const char *base,
3122 bool has_base_node, const char *base_node,
3123 bool has_backing_file, const char *backing_file,
3124 bool has_speed, int64_t speed,
3125 bool has_on_error, BlockdevOnError on_error,
3126 bool has_auto_finalize, bool auto_finalize,
3127 bool has_auto_dismiss, bool auto_dismiss,
3128 Error **errp)
3130 BlockDriverState *bs, *iter;
3131 BlockDriverState *base_bs = NULL;
3132 AioContext *aio_context;
3133 Error *local_err = NULL;
3134 const char *base_name = NULL;
3135 int job_flags = JOB_DEFAULT;
3137 if (!has_on_error) {
3138 on_error = BLOCKDEV_ON_ERROR_REPORT;
3141 bs = bdrv_lookup_bs(device, device, errp);
3142 if (!bs) {
3143 return;
3146 aio_context = bdrv_get_aio_context(bs);
3147 aio_context_acquire(aio_context);
3149 if (has_base && has_base_node) {
3150 error_setg(errp, "'base' and 'base-node' cannot be specified "
3151 "at the same time");
3152 goto out;
3155 if (has_base) {
3156 base_bs = bdrv_find_backing_image(bs, base);
3157 if (base_bs == NULL) {
3158 error_setg(errp, QERR_BASE_NOT_FOUND, base);
3159 goto out;
3161 assert(bdrv_get_aio_context(base_bs) == aio_context);
3162 base_name = base;
3165 if (has_base_node) {
3166 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3167 if (!base_bs) {
3168 goto out;
3170 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
3171 error_setg(errp, "Node '%s' is not a backing image of '%s'",
3172 base_node, device);
3173 goto out;
3175 assert(bdrv_get_aio_context(base_bs) == aio_context);
3176 base_name = base_bs->filename;
3179 /* Check for op blockers in the whole chain between bs and base */
3180 for (iter = bs; iter && iter != base_bs; iter = backing_bs(iter)) {
3181 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
3182 goto out;
3186 /* if we are streaming the entire chain, the result will have no backing
3187 * file, and specifying one is therefore an error */
3188 if (base_bs == NULL && has_backing_file) {
3189 error_setg(errp, "backing file specified, but streaming the "
3190 "entire chain");
3191 goto out;
3194 /* backing_file string overrides base bs filename */
3195 base_name = has_backing_file ? backing_file : base_name;
3197 if (has_auto_finalize && !auto_finalize) {
3198 job_flags |= JOB_MANUAL_FINALIZE;
3200 if (has_auto_dismiss && !auto_dismiss) {
3201 job_flags |= JOB_MANUAL_DISMISS;
3204 stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
3205 job_flags, has_speed ? speed : 0, on_error, &local_err);
3206 if (local_err) {
3207 error_propagate(errp, local_err);
3208 goto out;
3211 trace_qmp_block_stream(bs, bs->job);
3213 out:
3214 aio_context_release(aio_context);
3217 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3218 bool has_base_node, const char *base_node,
3219 bool has_base, const char *base,
3220 bool has_top_node, const char *top_node,
3221 bool has_top, const char *top,
3222 bool has_backing_file, const char *backing_file,
3223 bool has_speed, int64_t speed,
3224 bool has_filter_node_name, const char *filter_node_name,
3225 bool has_auto_finalize, bool auto_finalize,
3226 bool has_auto_dismiss, bool auto_dismiss,
3227 Error **errp)
3229 BlockDriverState *bs;
3230 BlockDriverState *iter;
3231 BlockDriverState *base_bs, *top_bs;
3232 AioContext *aio_context;
3233 Error *local_err = NULL;
3234 /* This will be part of the QMP command, if/when the
3235 * BlockdevOnError change for blkmirror makes it in
3237 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3238 int job_flags = JOB_DEFAULT;
3240 if (!has_speed) {
3241 speed = 0;
3243 if (!has_filter_node_name) {
3244 filter_node_name = NULL;
3246 if (has_auto_finalize && !auto_finalize) {
3247 job_flags |= JOB_MANUAL_FINALIZE;
3249 if (has_auto_dismiss && !auto_dismiss) {
3250 job_flags |= JOB_MANUAL_DISMISS;
3253 /* Important Note:
3254 * libvirt relies on the DeviceNotFound error class in order to probe for
3255 * live commit feature versions; for this to work, we must make sure to
3256 * perform the device lookup before any generic errors that may occur in a
3257 * scenario in which all optional arguments are omitted. */
3258 bs = qmp_get_root_bs(device, &local_err);
3259 if (!bs) {
3260 bs = bdrv_lookup_bs(device, device, NULL);
3261 if (!bs) {
3262 error_free(local_err);
3263 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3264 "Device '%s' not found", device);
3265 } else {
3266 error_propagate(errp, local_err);
3268 return;
3271 aio_context = bdrv_get_aio_context(bs);
3272 aio_context_acquire(aio_context);
3274 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3275 goto out;
3278 /* default top_bs is the active layer */
3279 top_bs = bs;
3281 if (has_top_node && has_top) {
3282 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
3283 goto out;
3284 } else if (has_top_node) {
3285 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
3286 if (top_bs == NULL) {
3287 goto out;
3289 if (!bdrv_chain_contains(bs, top_bs)) {
3290 error_setg(errp, "'%s' is not in this backing file chain",
3291 top_node);
3292 goto out;
3294 } else if (has_top && top) {
3295 if (strcmp(bs->filename, top) != 0) {
3296 top_bs = bdrv_find_backing_image(bs, top);
3300 if (top_bs == NULL) {
3301 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3302 goto out;
3305 assert(bdrv_get_aio_context(top_bs) == aio_context);
3307 if (has_base_node && has_base) {
3308 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
3309 goto out;
3310 } else if (has_base_node) {
3311 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3312 if (base_bs == NULL) {
3313 goto out;
3315 if (!bdrv_chain_contains(top_bs, base_bs)) {
3316 error_setg(errp, "'%s' is not in this backing file chain",
3317 base_node);
3318 goto out;
3320 } else if (has_base && base) {
3321 base_bs = bdrv_find_backing_image(top_bs, base);
3322 } else {
3323 base_bs = bdrv_find_base(top_bs);
3326 if (base_bs == NULL) {
3327 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3328 goto out;
3331 assert(bdrv_get_aio_context(base_bs) == aio_context);
3333 for (iter = top_bs; iter != backing_bs(base_bs); iter = backing_bs(iter)) {
3334 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3335 goto out;
3339 /* Do not allow attempts to commit an image into itself */
3340 if (top_bs == base_bs) {
3341 error_setg(errp, "cannot commit an image into itself");
3342 goto out;
3345 if (top_bs == bs) {
3346 if (has_backing_file) {
3347 error_setg(errp, "'backing-file' specified,"
3348 " but 'top' is the active layer");
3349 goto out;
3351 commit_active_start(has_job_id ? job_id : NULL, bs, base_bs,
3352 job_flags, speed, on_error,
3353 filter_node_name, NULL, NULL, false, &local_err);
3354 } else {
3355 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
3356 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3357 goto out;
3359 commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
3360 speed, on_error, has_backing_file ? backing_file : NULL,
3361 filter_node_name, &local_err);
3363 if (local_err != NULL) {
3364 error_propagate(errp, local_err);
3365 goto out;
3368 out:
3369 aio_context_release(aio_context);
3372 static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
3373 Error **errp)
3375 BlockDriverState *bs;
3376 BlockDriverState *target_bs;
3377 BlockDriverState *source = NULL;
3378 BlockJob *job = NULL;
3379 BdrvDirtyBitmap *bmap = NULL;
3380 AioContext *aio_context;
3381 QDict *options = NULL;
3382 Error *local_err = NULL;
3383 int flags, job_flags = JOB_DEFAULT;
3384 int64_t size;
3385 bool set_backing_hd = false;
3387 if (!backup->has_speed) {
3388 backup->speed = 0;
3390 if (!backup->has_on_source_error) {
3391 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3393 if (!backup->has_on_target_error) {
3394 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3396 if (!backup->has_mode) {
3397 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3399 if (!backup->has_job_id) {
3400 backup->job_id = NULL;
3402 if (!backup->has_auto_finalize) {
3403 backup->auto_finalize = true;
3405 if (!backup->has_auto_dismiss) {
3406 backup->auto_dismiss = true;
3408 if (!backup->has_compress) {
3409 backup->compress = false;
3412 bs = qmp_get_root_bs(backup->device, errp);
3413 if (!bs) {
3414 return NULL;
3417 aio_context = bdrv_get_aio_context(bs);
3418 aio_context_acquire(aio_context);
3420 if (!backup->has_format) {
3421 backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
3422 NULL : (char*) bs->drv->format_name;
3425 /* Early check to avoid creating target */
3426 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3427 goto out;
3430 flags = bs->open_flags | BDRV_O_RDWR;
3432 /* See if we have a backing HD we can use to create our new image
3433 * on top of. */
3434 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3435 source = backing_bs(bs);
3436 if (!source) {
3437 backup->sync = MIRROR_SYNC_MODE_FULL;
3440 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3441 source = bs;
3442 flags |= BDRV_O_NO_BACKING;
3443 set_backing_hd = true;
3446 size = bdrv_getlength(bs);
3447 if (size < 0) {
3448 error_setg_errno(errp, -size, "bdrv_getlength failed");
3449 goto out;
3452 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
3453 assert(backup->format);
3454 if (source) {
3455 bdrv_img_create(backup->target, backup->format, source->filename,
3456 source->drv->format_name, NULL,
3457 size, flags, false, &local_err);
3458 } else {
3459 bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3460 size, flags, false, &local_err);
3464 if (local_err) {
3465 error_propagate(errp, local_err);
3466 goto out;
3469 if (backup->format) {
3470 if (!options) {
3471 options = qdict_new();
3473 qdict_put_str(options, "driver", backup->format);
3476 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
3477 if (!target_bs) {
3478 goto out;
3481 bdrv_set_aio_context(target_bs, aio_context);
3483 if (set_backing_hd) {
3484 bdrv_set_backing_hd(target_bs, source, &local_err);
3485 if (local_err) {
3486 bdrv_unref(target_bs);
3487 goto out;
3491 if (backup->has_bitmap) {
3492 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3493 if (!bmap) {
3494 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3495 bdrv_unref(target_bs);
3496 goto out;
3498 if (bdrv_dirty_bitmap_qmp_locked(bmap)) {
3499 error_setg(errp,
3500 "Bitmap '%s' is currently locked and cannot be used for "
3501 "backup", backup->bitmap);
3502 goto out;
3505 if (!backup->auto_finalize) {
3506 job_flags |= JOB_MANUAL_FINALIZE;
3508 if (!backup->auto_dismiss) {
3509 job_flags |= JOB_MANUAL_DISMISS;
3512 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3513 backup->sync, bmap, backup->compress,
3514 backup->on_source_error, backup->on_target_error,
3515 job_flags, NULL, NULL, txn, &local_err);
3516 bdrv_unref(target_bs);
3517 if (local_err != NULL) {
3518 error_propagate(errp, local_err);
3519 goto out;
3522 out:
3523 aio_context_release(aio_context);
3524 return job;
3527 void qmp_drive_backup(DriveBackup *arg, Error **errp)
3530 BlockJob *job;
3531 job = do_drive_backup(arg, NULL, errp);
3532 if (job) {
3533 job_start(&job->job);
3537 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3539 return bdrv_named_nodes_list(errp);
3542 BlockJob *do_blockdev_backup(BlockdevBackup *backup, JobTxn *txn,
3543 Error **errp)
3545 BlockDriverState *bs;
3546 BlockDriverState *target_bs;
3547 Error *local_err = NULL;
3548 AioContext *aio_context;
3549 BlockJob *job = NULL;
3550 int job_flags = JOB_DEFAULT;
3552 if (!backup->has_speed) {
3553 backup->speed = 0;
3555 if (!backup->has_on_source_error) {
3556 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3558 if (!backup->has_on_target_error) {
3559 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3561 if (!backup->has_job_id) {
3562 backup->job_id = NULL;
3564 if (!backup->has_auto_finalize) {
3565 backup->auto_finalize = true;
3567 if (!backup->has_auto_dismiss) {
3568 backup->auto_dismiss = true;
3570 if (!backup->has_compress) {
3571 backup->compress = false;
3574 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
3575 if (!bs) {
3576 return NULL;
3579 aio_context = bdrv_get_aio_context(bs);
3580 aio_context_acquire(aio_context);
3582 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
3583 if (!target_bs) {
3584 goto out;
3587 if (bdrv_get_aio_context(target_bs) != aio_context) {
3588 if (!bdrv_has_blk(target_bs)) {
3589 /* The target BDS is not attached, we can safely move it to another
3590 * AioContext. */
3591 bdrv_set_aio_context(target_bs, aio_context);
3592 } else {
3593 error_setg(errp, "Target is attached to a different thread from "
3594 "source.");
3595 goto out;
3598 if (!backup->auto_finalize) {
3599 job_flags |= JOB_MANUAL_FINALIZE;
3601 if (!backup->auto_dismiss) {
3602 job_flags |= JOB_MANUAL_DISMISS;
3604 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3605 backup->sync, NULL, backup->compress,
3606 backup->on_source_error, backup->on_target_error,
3607 job_flags, NULL, NULL, txn, &local_err);
3608 if (local_err != NULL) {
3609 error_propagate(errp, local_err);
3611 out:
3612 aio_context_release(aio_context);
3613 return job;
3616 void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
3618 BlockJob *job;
3619 job = do_blockdev_backup(arg, NULL, errp);
3620 if (job) {
3621 job_start(&job->job);
3625 /* Parameter check and block job starting for drive mirroring.
3626 * Caller should hold @device and @target's aio context (must be the same).
3628 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3629 BlockDriverState *target,
3630 bool has_replaces, const char *replaces,
3631 enum MirrorSyncMode sync,
3632 BlockMirrorBackingMode backing_mode,
3633 bool has_speed, int64_t speed,
3634 bool has_granularity, uint32_t granularity,
3635 bool has_buf_size, int64_t buf_size,
3636 bool has_on_source_error,
3637 BlockdevOnError on_source_error,
3638 bool has_on_target_error,
3639 BlockdevOnError on_target_error,
3640 bool has_unmap, bool unmap,
3641 bool has_filter_node_name,
3642 const char *filter_node_name,
3643 bool has_copy_mode, MirrorCopyMode copy_mode,
3644 bool has_auto_finalize, bool auto_finalize,
3645 bool has_auto_dismiss, bool auto_dismiss,
3646 Error **errp)
3648 int job_flags = JOB_DEFAULT;
3650 if (!has_speed) {
3651 speed = 0;
3653 if (!has_on_source_error) {
3654 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3656 if (!has_on_target_error) {
3657 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3659 if (!has_granularity) {
3660 granularity = 0;
3662 if (!has_buf_size) {
3663 buf_size = 0;
3665 if (!has_unmap) {
3666 unmap = true;
3668 if (!has_filter_node_name) {
3669 filter_node_name = NULL;
3671 if (!has_copy_mode) {
3672 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
3674 if (has_auto_finalize && !auto_finalize) {
3675 job_flags |= JOB_MANUAL_FINALIZE;
3677 if (has_auto_dismiss && !auto_dismiss) {
3678 job_flags |= JOB_MANUAL_DISMISS;
3681 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3682 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3683 "a value in range [512B, 64MB]");
3684 return;
3686 if (granularity & (granularity - 1)) {
3687 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3688 "power of 2");
3689 return;
3692 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3693 return;
3695 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3696 return;
3699 if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3700 sync = MIRROR_SYNC_MODE_FULL;
3703 /* pass the node name to replace to mirror start since it's loose coupling
3704 * and will allow to check whether the node still exist at mirror completion
3706 mirror_start(job_id, bs, target,
3707 has_replaces ? replaces : NULL, job_flags,
3708 speed, granularity, buf_size, sync, backing_mode,
3709 on_source_error, on_target_error, unmap, filter_node_name,
3710 copy_mode, errp);
3713 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3715 BlockDriverState *bs;
3716 BlockDriverState *source, *target_bs;
3717 AioContext *aio_context;
3718 BlockMirrorBackingMode backing_mode;
3719 Error *local_err = NULL;
3720 QDict *options = NULL;
3721 int flags;
3722 int64_t size;
3723 const char *format = arg->format;
3725 bs = qmp_get_root_bs(arg->device, errp);
3726 if (!bs) {
3727 return;
3730 /* Early check to avoid creating target */
3731 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3732 return;
3735 aio_context = bdrv_get_aio_context(bs);
3736 aio_context_acquire(aio_context);
3738 if (!arg->has_mode) {
3739 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3742 if (!arg->has_format) {
3743 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3744 ? NULL : bs->drv->format_name);
3747 flags = bs->open_flags | BDRV_O_RDWR;
3748 source = backing_bs(bs);
3749 if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3750 arg->sync = MIRROR_SYNC_MODE_FULL;
3752 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3753 source = bs;
3756 size = bdrv_getlength(bs);
3757 if (size < 0) {
3758 error_setg_errno(errp, -size, "bdrv_getlength failed");
3759 goto out;
3762 if (arg->has_replaces) {
3763 BlockDriverState *to_replace_bs;
3764 AioContext *replace_aio_context;
3765 int64_t replace_size;
3767 if (!arg->has_node_name) {
3768 error_setg(errp, "a node-name must be provided when replacing a"
3769 " named node of the graph");
3770 goto out;
3773 to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3775 if (!to_replace_bs) {
3776 error_propagate(errp, local_err);
3777 goto out;
3780 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3781 aio_context_acquire(replace_aio_context);
3782 replace_size = bdrv_getlength(to_replace_bs);
3783 aio_context_release(replace_aio_context);
3785 if (size != replace_size) {
3786 error_setg(errp, "cannot replace image with a mirror image of "
3787 "different size");
3788 goto out;
3792 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3793 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3794 } else {
3795 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3798 /* Don't open backing image in create() */
3799 flags |= BDRV_O_NO_BACKING;
3801 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3802 && arg->mode != NEW_IMAGE_MODE_EXISTING)
3804 /* create new image w/o backing file */
3805 assert(format);
3806 bdrv_img_create(arg->target, format,
3807 NULL, NULL, NULL, size, flags, false, &local_err);
3808 } else {
3809 switch (arg->mode) {
3810 case NEW_IMAGE_MODE_EXISTING:
3811 break;
3812 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3813 /* create new image with backing file */
3814 bdrv_img_create(arg->target, format,
3815 source->filename,
3816 source->drv->format_name,
3817 NULL, size, flags, false, &local_err);
3818 break;
3819 default:
3820 abort();
3824 if (local_err) {
3825 error_propagate(errp, local_err);
3826 goto out;
3829 options = qdict_new();
3830 if (arg->has_node_name) {
3831 qdict_put_str(options, "node-name", arg->node_name);
3833 if (format) {
3834 qdict_put_str(options, "driver", format);
3837 /* Mirroring takes care of copy-on-write using the source's backing
3838 * file.
3840 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
3841 if (!target_bs) {
3842 goto out;
3845 bdrv_set_aio_context(target_bs, aio_context);
3847 blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3848 arg->has_replaces, arg->replaces, arg->sync,
3849 backing_mode, arg->has_speed, arg->speed,
3850 arg->has_granularity, arg->granularity,
3851 arg->has_buf_size, arg->buf_size,
3852 arg->has_on_source_error, arg->on_source_error,
3853 arg->has_on_target_error, arg->on_target_error,
3854 arg->has_unmap, arg->unmap,
3855 false, NULL,
3856 arg->has_copy_mode, arg->copy_mode,
3857 arg->has_auto_finalize, arg->auto_finalize,
3858 arg->has_auto_dismiss, arg->auto_dismiss,
3859 &local_err);
3860 bdrv_unref(target_bs);
3861 error_propagate(errp, local_err);
3862 out:
3863 aio_context_release(aio_context);
3866 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3867 const char *device, const char *target,
3868 bool has_replaces, const char *replaces,
3869 MirrorSyncMode sync,
3870 bool has_speed, int64_t speed,
3871 bool has_granularity, uint32_t granularity,
3872 bool has_buf_size, int64_t buf_size,
3873 bool has_on_source_error,
3874 BlockdevOnError on_source_error,
3875 bool has_on_target_error,
3876 BlockdevOnError on_target_error,
3877 bool has_filter_node_name,
3878 const char *filter_node_name,
3879 bool has_copy_mode, MirrorCopyMode copy_mode,
3880 bool has_auto_finalize, bool auto_finalize,
3881 bool has_auto_dismiss, bool auto_dismiss,
3882 Error **errp)
3884 BlockDriverState *bs;
3885 BlockDriverState *target_bs;
3886 AioContext *aio_context;
3887 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3888 Error *local_err = NULL;
3890 bs = qmp_get_root_bs(device, errp);
3891 if (!bs) {
3892 return;
3895 target_bs = bdrv_lookup_bs(target, target, errp);
3896 if (!target_bs) {
3897 return;
3900 aio_context = bdrv_get_aio_context(bs);
3901 aio_context_acquire(aio_context);
3903 bdrv_set_aio_context(target_bs, aio_context);
3905 blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3906 has_replaces, replaces, sync, backing_mode,
3907 has_speed, speed,
3908 has_granularity, granularity,
3909 has_buf_size, buf_size,
3910 has_on_source_error, on_source_error,
3911 has_on_target_error, on_target_error,
3912 true, true,
3913 has_filter_node_name, filter_node_name,
3914 has_copy_mode, copy_mode,
3915 has_auto_finalize, auto_finalize,
3916 has_auto_dismiss, auto_dismiss,
3917 &local_err);
3918 error_propagate(errp, local_err);
3920 aio_context_release(aio_context);
3923 /* Get a block job using its ID and acquire its AioContext */
3924 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3925 Error **errp)
3927 BlockJob *job;
3929 assert(id != NULL);
3931 *aio_context = NULL;
3933 job = block_job_get(id);
3935 if (!job) {
3936 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3937 "Block job '%s' not found", id);
3938 return NULL;
3941 *aio_context = blk_get_aio_context(job->blk);
3942 aio_context_acquire(*aio_context);
3944 return job;
3947 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3949 AioContext *aio_context;
3950 BlockJob *job = find_block_job(device, &aio_context, errp);
3952 if (!job) {
3953 return;
3956 block_job_set_speed(job, speed, errp);
3957 aio_context_release(aio_context);
3960 void qmp_block_job_cancel(const char *device,
3961 bool has_force, bool force, Error **errp)
3963 AioContext *aio_context;
3964 BlockJob *job = find_block_job(device, &aio_context, errp);
3966 if (!job) {
3967 return;
3970 if (!has_force) {
3971 force = false;
3974 if (job_user_paused(&job->job) && !force) {
3975 error_setg(errp, "The block job for device '%s' is currently paused",
3976 device);
3977 goto out;
3980 trace_qmp_block_job_cancel(job);
3981 job_user_cancel(&job->job, force, errp);
3982 out:
3983 aio_context_release(aio_context);
3986 void qmp_block_job_pause(const char *device, Error **errp)
3988 AioContext *aio_context;
3989 BlockJob *job = find_block_job(device, &aio_context, errp);
3991 if (!job) {
3992 return;
3995 trace_qmp_block_job_pause(job);
3996 job_user_pause(&job->job, errp);
3997 aio_context_release(aio_context);
4000 void qmp_block_job_resume(const char *device, Error **errp)
4002 AioContext *aio_context;
4003 BlockJob *job = find_block_job(device, &aio_context, errp);
4005 if (!job) {
4006 return;
4009 trace_qmp_block_job_resume(job);
4010 job_user_resume(&job->job, errp);
4011 aio_context_release(aio_context);
4014 void qmp_block_job_complete(const char *device, Error **errp)
4016 AioContext *aio_context;
4017 BlockJob *job = find_block_job(device, &aio_context, errp);
4019 if (!job) {
4020 return;
4023 trace_qmp_block_job_complete(job);
4024 job_complete(&job->job, errp);
4025 aio_context_release(aio_context);
4028 void qmp_block_job_finalize(const char *id, Error **errp)
4030 AioContext *aio_context;
4031 BlockJob *job = find_block_job(id, &aio_context, errp);
4033 if (!job) {
4034 return;
4037 trace_qmp_block_job_finalize(job);
4038 job_finalize(&job->job, errp);
4039 aio_context_release(aio_context);
4042 void qmp_block_job_dismiss(const char *id, Error **errp)
4044 AioContext *aio_context;
4045 BlockJob *bjob = find_block_job(id, &aio_context, errp);
4046 Job *job;
4048 if (!bjob) {
4049 return;
4052 trace_qmp_block_job_dismiss(bjob);
4053 job = &bjob->job;
4054 job_dismiss(&job, errp);
4055 aio_context_release(aio_context);
4058 void qmp_change_backing_file(const char *device,
4059 const char *image_node_name,
4060 const char *backing_file,
4061 Error **errp)
4063 BlockDriverState *bs = NULL;
4064 AioContext *aio_context;
4065 BlockDriverState *image_bs = NULL;
4066 Error *local_err = NULL;
4067 bool ro;
4068 int open_flags;
4069 int ret;
4071 bs = qmp_get_root_bs(device, errp);
4072 if (!bs) {
4073 return;
4076 aio_context = bdrv_get_aio_context(bs);
4077 aio_context_acquire(aio_context);
4079 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
4080 if (local_err) {
4081 error_propagate(errp, local_err);
4082 goto out;
4085 if (!image_bs) {
4086 error_setg(errp, "image file not found");
4087 goto out;
4090 if (bdrv_find_base(image_bs) == image_bs) {
4091 error_setg(errp, "not allowing backing file change on an image "
4092 "without a backing file");
4093 goto out;
4096 /* even though we are not necessarily operating on bs, we need it to
4097 * determine if block ops are currently prohibited on the chain */
4098 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
4099 goto out;
4102 /* final sanity check */
4103 if (!bdrv_chain_contains(bs, image_bs)) {
4104 error_setg(errp, "'%s' and image file are not in the same chain",
4105 device);
4106 goto out;
4109 /* if not r/w, reopen to make r/w */
4110 open_flags = image_bs->open_flags;
4111 ro = bdrv_is_read_only(image_bs);
4113 if (ro) {
4114 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
4115 if (local_err) {
4116 error_propagate(errp, local_err);
4117 goto out;
4121 ret = bdrv_change_backing_file(image_bs, backing_file,
4122 image_bs->drv ? image_bs->drv->format_name : "");
4124 if (ret < 0) {
4125 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
4126 backing_file);
4127 /* don't exit here, so we can try to restore open flags if
4128 * appropriate */
4131 if (ro) {
4132 bdrv_reopen(image_bs, open_flags, &local_err);
4133 error_propagate(errp, local_err);
4136 out:
4137 aio_context_release(aio_context);
4140 void hmp_drive_add_node(Monitor *mon, const char *optstr)
4142 QemuOpts *opts;
4143 QDict *qdict;
4144 Error *local_err = NULL;
4146 opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
4147 if (!opts) {
4148 return;
4151 qdict = qemu_opts_to_qdict(opts, NULL);
4153 if (!qdict_get_try_str(qdict, "node-name")) {
4154 qobject_unref(qdict);
4155 error_report("'node-name' needs to be specified");
4156 goto out;
4159 BlockDriverState *bs = bds_tree_init(qdict, &local_err);
4160 if (!bs) {
4161 error_report_err(local_err);
4162 goto out;
4165 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4167 out:
4168 qemu_opts_del(opts);
4171 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
4173 BlockDriverState *bs;
4174 QObject *obj;
4175 Visitor *v = qobject_output_visitor_new(&obj);
4176 QDict *qdict;
4177 Error *local_err = NULL;
4179 visit_type_BlockdevOptions(v, NULL, &options, &local_err);
4180 if (local_err) {
4181 error_propagate(errp, local_err);
4182 goto fail;
4185 visit_complete(v, &obj);
4186 qdict = qobject_to(QDict, obj);
4188 qdict_flatten(qdict);
4190 if (!qdict_get_try_str(qdict, "node-name")) {
4191 error_setg(errp, "'node-name' must be specified for the root node");
4192 goto fail;
4195 bs = bds_tree_init(qdict, errp);
4196 if (!bs) {
4197 goto fail;
4200 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4202 fail:
4203 visit_free(v);
4206 void qmp_blockdev_del(const char *node_name, Error **errp)
4208 AioContext *aio_context;
4209 BlockDriverState *bs;
4211 bs = bdrv_find_node(node_name);
4212 if (!bs) {
4213 error_setg(errp, "Cannot find node %s", node_name);
4214 return;
4216 if (bdrv_has_blk(bs)) {
4217 error_setg(errp, "Node %s is in use", node_name);
4218 return;
4220 aio_context = bdrv_get_aio_context(bs);
4221 aio_context_acquire(aio_context);
4223 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
4224 goto out;
4227 if (!bs->monitor_list.tqe_prev) {
4228 error_setg(errp, "Node %s is not owned by the monitor",
4229 bs->node_name);
4230 goto out;
4233 if (bs->refcnt > 1) {
4234 error_setg(errp, "Block device %s is in use",
4235 bdrv_get_device_or_node_name(bs));
4236 goto out;
4239 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4240 bdrv_unref(bs);
4242 out:
4243 aio_context_release(aio_context);
4246 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
4247 const char *child_name)
4249 BdrvChild *child;
4251 QLIST_FOREACH(child, &parent_bs->children, next) {
4252 if (strcmp(child->name, child_name) == 0) {
4253 return child;
4257 return NULL;
4260 void qmp_x_blockdev_change(const char *parent, bool has_child,
4261 const char *child, bool has_node,
4262 const char *node, Error **errp)
4264 BlockDriverState *parent_bs, *new_bs = NULL;
4265 BdrvChild *p_child;
4267 parent_bs = bdrv_lookup_bs(parent, parent, errp);
4268 if (!parent_bs) {
4269 return;
4272 if (has_child == has_node) {
4273 if (has_child) {
4274 error_setg(errp, "The parameters child and node are in conflict");
4275 } else {
4276 error_setg(errp, "Either child or node must be specified");
4278 return;
4281 if (has_child) {
4282 p_child = bdrv_find_child(parent_bs, child);
4283 if (!p_child) {
4284 error_setg(errp, "Node '%s' does not have child '%s'",
4285 parent, child);
4286 return;
4288 bdrv_del_child(parent_bs, p_child, errp);
4291 if (has_node) {
4292 new_bs = bdrv_find_node(node);
4293 if (!new_bs) {
4294 error_setg(errp, "Node '%s' not found", node);
4295 return;
4297 bdrv_add_child(parent_bs, new_bs, errp);
4301 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4303 BlockJobInfoList *head = NULL, **p_next = &head;
4304 BlockJob *job;
4306 for (job = block_job_next(NULL); job; job = block_job_next(job)) {
4307 BlockJobInfoList *elem;
4308 AioContext *aio_context;
4310 if (block_job_is_internal(job)) {
4311 continue;
4313 elem = g_new0(BlockJobInfoList, 1);
4314 aio_context = blk_get_aio_context(job->blk);
4315 aio_context_acquire(aio_context);
4316 elem->value = block_job_query(job, errp);
4317 aio_context_release(aio_context);
4318 if (!elem->value) {
4319 g_free(elem);
4320 qapi_free_BlockJobInfoList(head);
4321 return NULL;
4323 *p_next = elem;
4324 p_next = &elem->next;
4327 return head;
4330 void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
4331 bool has_force, bool force, Error **errp)
4333 AioContext *old_context;
4334 AioContext *new_context;
4335 BlockDriverState *bs;
4337 bs = bdrv_find_node(node_name);
4338 if (!bs) {
4339 error_setg(errp, "Cannot find node %s", node_name);
4340 return;
4343 /* Protects against accidents. */
4344 if (!(has_force && force) && bdrv_has_blk(bs)) {
4345 error_setg(errp, "Node %s is associated with a BlockBackend and could "
4346 "be in use (use force=true to override this check)",
4347 node_name);
4348 return;
4351 if (iothread->type == QTYPE_QSTRING) {
4352 IOThread *obj = iothread_by_id(iothread->u.s);
4353 if (!obj) {
4354 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
4355 return;
4358 new_context = iothread_get_aio_context(obj);
4359 } else {
4360 new_context = qemu_get_aio_context();
4363 old_context = bdrv_get_aio_context(bs);
4364 aio_context_acquire(old_context);
4366 bdrv_set_aio_context(bs, new_context);
4368 aio_context_release(old_context);
4371 void qmp_x_block_latency_histogram_set(
4372 const char *device,
4373 bool has_boundaries, uint64List *boundaries,
4374 bool has_boundaries_read, uint64List *boundaries_read,
4375 bool has_boundaries_write, uint64List *boundaries_write,
4376 bool has_boundaries_flush, uint64List *boundaries_flush,
4377 Error **errp)
4379 BlockBackend *blk = blk_by_name(device);
4380 BlockAcctStats *stats;
4382 if (!blk) {
4383 error_setg(errp, "Device '%s' not found", device);
4384 return;
4386 stats = blk_get_stats(blk);
4388 if (!has_boundaries && !has_boundaries_read && !has_boundaries_write &&
4389 !has_boundaries_flush)
4391 block_latency_histograms_clear(stats);
4392 return;
4395 if (has_boundaries || has_boundaries_read) {
4396 block_latency_histogram_set(
4397 stats, BLOCK_ACCT_READ,
4398 has_boundaries_read ? boundaries_read : boundaries);
4401 if (has_boundaries || has_boundaries_write) {
4402 block_latency_histogram_set(
4403 stats, BLOCK_ACCT_WRITE,
4404 has_boundaries_write ? boundaries_write : boundaries);
4407 if (has_boundaries || has_boundaries_flush) {
4408 block_latency_histogram_set(
4409 stats, BLOCK_ACCT_FLUSH,
4410 has_boundaries_flush ? boundaries_flush : boundaries);
4414 QemuOptsList qemu_common_drive_opts = {
4415 .name = "drive",
4416 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4417 .desc = {
4419 .name = "snapshot",
4420 .type = QEMU_OPT_BOOL,
4421 .help = "enable/disable snapshot mode",
4423 .name = "aio",
4424 .type = QEMU_OPT_STRING,
4425 .help = "host AIO implementation (threads, native)",
4427 .name = BDRV_OPT_CACHE_WB,
4428 .type = QEMU_OPT_BOOL,
4429 .help = "Enable writeback mode",
4431 .name = "format",
4432 .type = QEMU_OPT_STRING,
4433 .help = "disk format (raw, qcow2, ...)",
4435 .name = "rerror",
4436 .type = QEMU_OPT_STRING,
4437 .help = "read error action",
4439 .name = "werror",
4440 .type = QEMU_OPT_STRING,
4441 .help = "write error action",
4443 .name = BDRV_OPT_READ_ONLY,
4444 .type = QEMU_OPT_BOOL,
4445 .help = "open drive file as read-only",
4448 THROTTLE_OPTS,
4451 .name = "throttling.group",
4452 .type = QEMU_OPT_STRING,
4453 .help = "name of the block throttling group",
4455 .name = "copy-on-read",
4456 .type = QEMU_OPT_BOOL,
4457 .help = "copy read data from backing file into image file",
4459 .name = "detect-zeroes",
4460 .type = QEMU_OPT_STRING,
4461 .help = "try to optimize zero writes (off, on, unmap)",
4463 .name = "stats-account-invalid",
4464 .type = QEMU_OPT_BOOL,
4465 .help = "whether to account for invalid I/O operations "
4466 "in the statistics",
4468 .name = "stats-account-failed",
4469 .type = QEMU_OPT_BOOL,
4470 .help = "whether to account for failed I/O operations "
4471 "in the statistics",
4473 { /* end of list */ }
4477 QemuOptsList qemu_drive_opts = {
4478 .name = "drive",
4479 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4480 .desc = {
4482 * no elements => accept any params
4483 * validation will happen later
4485 { /* end of list */ }