graph-lock: TSA annotations for lock/unlock functions
[qemu.git] / blockdev.c
blobebf952cd218e44caa6c63960e1b77544afd7d0f6
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/qemu-print.h"
44 #include "qemu/config-file.h"
45 #include "qapi/qapi-commands-block.h"
46 #include "qapi/qapi-commands-transaction.h"
47 #include "qapi/qapi-visit-block-core.h"
48 #include "qapi/qmp/qdict.h"
49 #include "qapi/qmp/qnum.h"
50 #include "qapi/qmp/qstring.h"
51 #include "qapi/error.h"
52 #include "qapi/qmp/qerror.h"
53 #include "qapi/qmp/qlist.h"
54 #include "qapi/qobject-output-visitor.h"
55 #include "sysemu/sysemu.h"
56 #include "sysemu/iothread.h"
57 #include "block/block_int.h"
58 #include "block/trace.h"
59 #include "sysemu/runstate.h"
60 #include "sysemu/replay.h"
61 #include "qemu/cutils.h"
62 #include "qemu/help_option.h"
63 #include "qemu/main-loop.h"
64 #include "qemu/throttle-options.h"
66 /* Protected by BQL */
67 QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
68 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
70 void bdrv_set_monitor_owned(BlockDriverState *bs)
72 GLOBAL_STATE_CODE();
73 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
76 static const char *const if_name[IF_COUNT] = {
77 [IF_NONE] = "none",
78 [IF_IDE] = "ide",
79 [IF_SCSI] = "scsi",
80 [IF_FLOPPY] = "floppy",
81 [IF_PFLASH] = "pflash",
82 [IF_MTD] = "mtd",
83 [IF_SD] = "sd",
84 [IF_VIRTIO] = "virtio",
85 [IF_XEN] = "xen",
88 static int if_max_devs[IF_COUNT] = {
90 * Do not change these numbers! They govern how drive option
91 * index maps to unit and bus. That mapping is ABI.
93 * All controllers used to implement if=T drives need to support
94 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
95 * Otherwise, some index values map to "impossible" bus, unit
96 * values.
98 * For instance, if you change [IF_SCSI] to 255, -drive
99 * if=scsi,index=12 no longer means bus=1,unit=5, but
100 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
101 * the drive can't be set up. Regression.
103 [IF_IDE] = 2,
104 [IF_SCSI] = 7,
108 * Boards may call this to offer board-by-board overrides
109 * of the default, global values.
111 void override_max_devs(BlockInterfaceType type, int max_devs)
113 BlockBackend *blk;
114 DriveInfo *dinfo;
116 GLOBAL_STATE_CODE();
118 if (max_devs <= 0) {
119 return;
122 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
123 dinfo = blk_legacy_dinfo(blk);
124 if (dinfo->type == type) {
125 fprintf(stderr, "Cannot override units-per-bus property of"
126 " the %s interface, because a drive of that type has"
127 " already been added.\n", if_name[type]);
128 g_assert_not_reached();
132 if_max_devs[type] = max_devs;
136 * We automatically delete the drive when a device using it gets
137 * unplugged. Questionable feature, but we can't just drop it.
138 * Device models call blockdev_mark_auto_del() to schedule the
139 * automatic deletion, and generic qdev code calls blockdev_auto_del()
140 * when deletion is actually safe.
142 void blockdev_mark_auto_del(BlockBackend *blk)
144 DriveInfo *dinfo = blk_legacy_dinfo(blk);
145 BlockJob *job;
147 GLOBAL_STATE_CODE();
149 if (!dinfo) {
150 return;
153 JOB_LOCK_GUARD();
155 for (job = block_job_next_locked(NULL); job;
156 job = block_job_next_locked(job)) {
157 if (block_job_has_bdrv(job, blk_bs(blk))) {
158 job_cancel_locked(&job->job, false);
162 dinfo->auto_del = 1;
165 void blockdev_auto_del(BlockBackend *blk)
167 DriveInfo *dinfo = blk_legacy_dinfo(blk);
168 GLOBAL_STATE_CODE();
170 if (dinfo && dinfo->auto_del) {
171 monitor_remove_blk(blk);
172 blk_unref(blk);
176 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
178 int max_devs = if_max_devs[type];
179 return max_devs ? index / max_devs : 0;
182 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
184 int max_devs = if_max_devs[type];
185 return max_devs ? index % max_devs : index;
188 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
189 const char *optstr)
191 QemuOpts *opts;
193 GLOBAL_STATE_CODE();
195 opts = qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
196 if (!opts) {
197 return NULL;
199 if (type != IF_DEFAULT) {
200 qemu_opt_set(opts, "if", if_name[type], &error_abort);
202 if (index >= 0) {
203 qemu_opt_set_number(opts, "index", index, &error_abort);
205 if (file)
206 qemu_opt_set(opts, "file", file, &error_abort);
207 return opts;
210 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
212 BlockBackend *blk;
213 DriveInfo *dinfo;
215 GLOBAL_STATE_CODE();
217 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
218 dinfo = blk_legacy_dinfo(blk);
219 if (dinfo && dinfo->type == type
220 && dinfo->bus == bus && dinfo->unit == unit) {
221 return dinfo;
225 return NULL;
229 * Check board claimed all -drive that are meant to be claimed.
230 * Fatal error if any remain unclaimed.
232 void drive_check_orphaned(void)
234 BlockBackend *blk;
235 DriveInfo *dinfo;
236 Location loc;
237 bool orphans = false;
239 GLOBAL_STATE_CODE();
241 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
242 dinfo = blk_legacy_dinfo(blk);
244 * Ignore default drives, because we create certain default
245 * drives unconditionally, then leave them unclaimed. Not the
246 * users fault.
247 * Ignore IF_VIRTIO, because it gets desugared into -device,
248 * so we can leave failing to -device.
249 * Ignore IF_NONE, because leaving unclaimed IF_NONE remains
250 * available for device_add is a feature.
252 if (dinfo->is_default || dinfo->type == IF_VIRTIO
253 || dinfo->type == IF_NONE) {
254 continue;
256 if (!blk_get_attached_dev(blk)) {
257 loc_push_none(&loc);
258 qemu_opts_loc_restore(dinfo->opts);
259 error_report("machine type does not support"
260 " if=%s,bus=%d,unit=%d",
261 if_name[dinfo->type], dinfo->bus, dinfo->unit);
262 loc_pop(&loc);
263 orphans = true;
267 if (orphans) {
268 exit(1);
272 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
274 GLOBAL_STATE_CODE();
275 return drive_get(type,
276 drive_index_to_bus_id(type, index),
277 drive_index_to_unit_id(type, index));
280 int drive_get_max_bus(BlockInterfaceType type)
282 int max_bus;
283 BlockBackend *blk;
284 DriveInfo *dinfo;
286 GLOBAL_STATE_CODE();
288 max_bus = -1;
289 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
290 dinfo = blk_legacy_dinfo(blk);
291 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
292 max_bus = dinfo->bus;
295 return max_bus;
298 static void bdrv_format_print(void *opaque, const char *name)
300 qemu_printf(" %s", name);
303 typedef struct {
304 QEMUBH *bh;
305 BlockDriverState *bs;
306 } BDRVPutRefBH;
308 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
310 if (!strcmp(buf, "ignore")) {
311 return BLOCKDEV_ON_ERROR_IGNORE;
312 } else if (!is_read && !strcmp(buf, "enospc")) {
313 return BLOCKDEV_ON_ERROR_ENOSPC;
314 } else if (!strcmp(buf, "stop")) {
315 return BLOCKDEV_ON_ERROR_STOP;
316 } else if (!strcmp(buf, "report")) {
317 return BLOCKDEV_ON_ERROR_REPORT;
318 } else {
319 error_setg(errp, "'%s' invalid %s error action",
320 buf, is_read ? "read" : "write");
321 return -1;
325 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
326 Error **errp)
328 const QListEntry *entry;
329 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
330 switch (qobject_type(entry->value)) {
332 case QTYPE_QSTRING: {
333 unsigned long long length;
334 const char *str = qstring_get_str(qobject_to(QString,
335 entry->value));
336 if (parse_uint_full(str, &length, 10) == 0 &&
337 length > 0 && length <= UINT_MAX) {
338 block_acct_add_interval(stats, (unsigned) length);
339 } else {
340 error_setg(errp, "Invalid interval length: %s", str);
341 return false;
343 break;
346 case QTYPE_QNUM: {
347 int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
349 if (length > 0 && length <= UINT_MAX) {
350 block_acct_add_interval(stats, (unsigned) length);
351 } else {
352 error_setg(errp, "Invalid interval length: %" PRId64, length);
353 return false;
355 break;
358 default:
359 error_setg(errp, "The specification of stats-intervals is invalid");
360 return false;
363 return true;
366 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
368 /* All parameters but @opts are optional and may be set to NULL. */
369 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
370 const char **throttling_group, ThrottleConfig *throttle_cfg,
371 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
373 Error *local_error = NULL;
374 const char *aio;
376 if (bdrv_flags) {
377 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
378 *bdrv_flags |= BDRV_O_COPY_ON_READ;
381 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
382 if (bdrv_parse_aio(aio, bdrv_flags) < 0) {
383 error_setg(errp, "invalid aio option");
384 return;
389 /* disk I/O throttling */
390 if (throttling_group) {
391 *throttling_group = qemu_opt_get(opts, "throttling.group");
394 if (throttle_cfg) {
395 throttle_config_init(throttle_cfg);
396 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
397 qemu_opt_get_number(opts, "throttling.bps-total", 0);
398 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
399 qemu_opt_get_number(opts, "throttling.bps-read", 0);
400 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
401 qemu_opt_get_number(opts, "throttling.bps-write", 0);
402 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
403 qemu_opt_get_number(opts, "throttling.iops-total", 0);
404 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
405 qemu_opt_get_number(opts, "throttling.iops-read", 0);
406 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
407 qemu_opt_get_number(opts, "throttling.iops-write", 0);
409 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
410 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
411 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
412 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
413 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
414 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
415 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
416 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
417 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
418 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
419 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
420 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
422 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
423 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
424 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
425 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
426 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
427 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
428 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
429 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
430 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
431 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
432 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
433 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
435 throttle_cfg->op_size =
436 qemu_opt_get_number(opts, "throttling.iops-size", 0);
438 if (!throttle_is_valid(throttle_cfg, errp)) {
439 return;
443 if (detect_zeroes) {
444 *detect_zeroes =
445 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
446 qemu_opt_get(opts, "detect-zeroes"),
447 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
448 &local_error);
449 if (local_error) {
450 error_propagate(errp, local_error);
451 return;
456 static OnOffAuto account_get_opt(QemuOpts *opts, const char *name)
458 if (!qemu_opt_find(opts, name)) {
459 return ON_OFF_AUTO_AUTO;
461 if (qemu_opt_get_bool(opts, name, true)) {
462 return ON_OFF_AUTO_ON;
464 return ON_OFF_AUTO_OFF;
467 /* Takes the ownership of bs_opts */
468 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
469 Error **errp)
471 const char *buf;
472 int bdrv_flags = 0;
473 int on_read_error, on_write_error;
474 OnOffAuto account_invalid, account_failed;
475 bool writethrough, read_only;
476 BlockBackend *blk;
477 BlockDriverState *bs;
478 ThrottleConfig cfg;
479 int snapshot = 0;
480 Error *error = NULL;
481 QemuOpts *opts;
482 QDict *interval_dict = NULL;
483 QList *interval_list = NULL;
484 const char *id;
485 BlockdevDetectZeroesOptions detect_zeroes =
486 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
487 const char *throttling_group = NULL;
489 /* Check common options by copying from bs_opts to opts, all other options
490 * stay in bs_opts for processing by bdrv_open(). */
491 id = qdict_get_try_str(bs_opts, "id");
492 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, errp);
493 if (!opts) {
494 goto err_no_opts;
497 if (!qemu_opts_absorb_qdict(opts, bs_opts, errp)) {
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 = account_get_opt(opts, "stats-account-invalid");
509 account_failed = account_get_opt(opts, "stats-account-failed");
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 qemu_printf("Supported formats:");
534 bdrv_iterate_format(bdrv_format_print, NULL, false);
535 qemu_printf("\nSupported formats (read-only):");
536 bdrv_iterate_format(bdrv_format_print, NULL, true);
537 qemu_printf("\n");
538 goto early_err;
541 if (qdict_haskey(bs_opts, "driver")) {
542 error_setg(errp, "Cannot specify both 'driver' and 'format'");
543 goto early_err;
545 qdict_put_str(bs_opts, "driver", buf);
548 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
549 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
550 on_write_error = parse_block_error_action(buf, 0, &error);
551 if (error) {
552 error_propagate(errp, error);
553 goto early_err;
557 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
558 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
559 on_read_error = parse_block_error_action(buf, 1, &error);
560 if (error) {
561 error_propagate(errp, error);
562 goto early_err;
566 if (snapshot) {
567 bdrv_flags |= BDRV_O_SNAPSHOT;
570 read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
572 /* init */
573 if ((!file || !*file) && !qdict_size(bs_opts)) {
574 BlockBackendRootState *blk_rs;
576 blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
577 blk_rs = blk_get_root_state(blk);
578 blk_rs->open_flags = bdrv_flags | (read_only ? 0 : BDRV_O_RDWR);
579 blk_rs->detect_zeroes = detect_zeroes;
581 qobject_unref(bs_opts);
582 } else {
583 if (file && !*file) {
584 file = NULL;
587 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
588 * with other callers) rather than what we want as the real defaults.
589 * Apply the defaults here instead. */
590 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
591 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
592 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
593 read_only ? "on" : "off");
594 qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
595 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
597 if (runstate_check(RUN_STATE_INMIGRATE)) {
598 bdrv_flags |= BDRV_O_INACTIVE;
601 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
602 if (!blk) {
603 goto err_no_bs_opts;
605 bs = blk_bs(blk);
607 bs->detect_zeroes = detect_zeroes;
609 block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
611 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
612 blk_unref(blk);
613 blk = NULL;
614 goto err_no_bs_opts;
618 /* disk I/O throttling */
619 if (throttle_enabled(&cfg)) {
620 if (!throttling_group) {
621 throttling_group = id;
623 blk_io_limits_enable(blk, throttling_group);
624 blk_set_io_limits(blk, &cfg);
627 blk_set_enable_write_cache(blk, !writethrough);
628 blk_set_on_error(blk, on_read_error, on_write_error);
630 if (!monitor_add_blk(blk, id, errp)) {
631 blk_unref(blk);
632 blk = NULL;
633 goto err_no_bs_opts;
636 err_no_bs_opts:
637 qemu_opts_del(opts);
638 qobject_unref(interval_dict);
639 qobject_unref(interval_list);
640 return blk;
642 early_err:
643 qemu_opts_del(opts);
644 qobject_unref(interval_dict);
645 qobject_unref(interval_list);
646 err_no_opts:
647 qobject_unref(bs_opts);
648 return NULL;
651 /* Takes the ownership of bs_opts */
652 BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
654 int bdrv_flags = 0;
656 GLOBAL_STATE_CODE();
657 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
658 * with other callers) rather than what we want as the real defaults.
659 * Apply the defaults here instead. */
660 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
661 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
662 qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
664 if (runstate_check(RUN_STATE_INMIGRATE)) {
665 bdrv_flags |= BDRV_O_INACTIVE;
668 return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
671 void blockdev_close_all_bdrv_states(void)
673 BlockDriverState *bs, *next_bs;
675 GLOBAL_STATE_CODE();
676 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
677 AioContext *ctx = bdrv_get_aio_context(bs);
679 aio_context_acquire(ctx);
680 bdrv_unref(bs);
681 aio_context_release(ctx);
685 /* Iterates over the list of monitor-owned BlockDriverStates */
686 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
688 GLOBAL_STATE_CODE();
689 return bs ? QTAILQ_NEXT(bs, monitor_list)
690 : QTAILQ_FIRST(&monitor_bdrv_states);
693 static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
694 Error **errp)
696 const char *value;
698 value = qemu_opt_get(opts, from);
699 if (value) {
700 if (qemu_opt_find(opts, to)) {
701 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
702 "same time", to, from);
703 return false;
707 /* rename all items in opts */
708 while ((value = qemu_opt_get(opts, from))) {
709 qemu_opt_set(opts, to, value, &error_abort);
710 qemu_opt_unset(opts, from);
712 return true;
715 QemuOptsList qemu_legacy_drive_opts = {
716 .name = "drive",
717 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
718 .desc = {
720 .name = "bus",
721 .type = QEMU_OPT_NUMBER,
722 .help = "bus number",
724 .name = "unit",
725 .type = QEMU_OPT_NUMBER,
726 .help = "unit number (i.e. lun for scsi)",
728 .name = "index",
729 .type = QEMU_OPT_NUMBER,
730 .help = "index number",
732 .name = "media",
733 .type = QEMU_OPT_STRING,
734 .help = "media type (disk, cdrom)",
736 .name = "if",
737 .type = QEMU_OPT_STRING,
738 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
740 .name = "file",
741 .type = QEMU_OPT_STRING,
742 .help = "file name",
745 /* Options that are passed on, but have special semantics with -drive */
747 .name = BDRV_OPT_READ_ONLY,
748 .type = QEMU_OPT_BOOL,
749 .help = "open drive file as read-only",
751 .name = "rerror",
752 .type = QEMU_OPT_STRING,
753 .help = "read error action",
755 .name = "werror",
756 .type = QEMU_OPT_STRING,
757 .help = "write error action",
759 .name = "copy-on-read",
760 .type = QEMU_OPT_BOOL,
761 .help = "copy read data from backing file into image file",
764 { /* end of list */ }
768 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
769 Error **errp)
771 const char *value;
772 BlockBackend *blk;
773 DriveInfo *dinfo = NULL;
774 QDict *bs_opts;
775 QemuOpts *legacy_opts;
776 DriveMediaType media = MEDIA_DISK;
777 BlockInterfaceType type;
778 int max_devs, bus_id, unit_id, index;
779 const char *werror, *rerror;
780 bool read_only = false;
781 bool copy_on_read;
782 const char *filename;
783 int i;
785 GLOBAL_STATE_CODE();
787 /* Change legacy command line options into QMP ones */
788 static const struct {
789 const char *from;
790 const char *to;
791 } opt_renames[] = {
792 { "iops", "throttling.iops-total" },
793 { "iops_rd", "throttling.iops-read" },
794 { "iops_wr", "throttling.iops-write" },
796 { "bps", "throttling.bps-total" },
797 { "bps_rd", "throttling.bps-read" },
798 { "bps_wr", "throttling.bps-write" },
800 { "iops_max", "throttling.iops-total-max" },
801 { "iops_rd_max", "throttling.iops-read-max" },
802 { "iops_wr_max", "throttling.iops-write-max" },
804 { "bps_max", "throttling.bps-total-max" },
805 { "bps_rd_max", "throttling.bps-read-max" },
806 { "bps_wr_max", "throttling.bps-write-max" },
808 { "iops_size", "throttling.iops-size" },
810 { "group", "throttling.group" },
812 { "readonly", BDRV_OPT_READ_ONLY },
815 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
816 if (!qemu_opt_rename(all_opts, opt_renames[i].from,
817 opt_renames[i].to, errp)) {
818 return NULL;
822 value = qemu_opt_get(all_opts, "cache");
823 if (value) {
824 int flags = 0;
825 bool writethrough;
827 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
828 error_setg(errp, "invalid cache option");
829 return NULL;
832 /* Specific options take precedence */
833 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
834 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
835 !writethrough, &error_abort);
837 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
838 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
839 !!(flags & BDRV_O_NOCACHE), &error_abort);
841 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
842 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
843 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
845 qemu_opt_unset(all_opts, "cache");
848 /* Get a QDict for processing the options */
849 bs_opts = qdict_new();
850 qemu_opts_to_qdict(all_opts, bs_opts);
852 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
853 &error_abort);
854 if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
855 goto fail;
858 /* Media type */
859 value = qemu_opt_get(legacy_opts, "media");
860 if (value) {
861 if (!strcmp(value, "disk")) {
862 media = MEDIA_DISK;
863 } else if (!strcmp(value, "cdrom")) {
864 media = MEDIA_CDROM;
865 read_only = true;
866 } else {
867 error_setg(errp, "'%s' invalid media", value);
868 goto fail;
872 /* copy-on-read is disabled with a warning for read-only devices */
873 read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
874 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
876 if (read_only && copy_on_read) {
877 warn_report("disabling copy-on-read on read-only drive");
878 copy_on_read = false;
881 qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
882 qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
884 /* Controller type */
885 value = qemu_opt_get(legacy_opts, "if");
886 if (value) {
887 for (type = 0;
888 type < IF_COUNT && strcmp(value, if_name[type]);
889 type++) {
891 if (type == IF_COUNT) {
892 error_setg(errp, "unsupported bus type '%s'", value);
893 goto fail;
895 } else {
896 type = block_default_type;
899 /* Device address specified by bus/unit or index.
900 * If none was specified, try to find the first free one. */
901 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
902 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
903 index = qemu_opt_get_number(legacy_opts, "index", -1);
905 max_devs = if_max_devs[type];
907 if (index != -1) {
908 if (bus_id != 0 || unit_id != -1) {
909 error_setg(errp, "index cannot be used with bus and unit");
910 goto fail;
912 bus_id = drive_index_to_bus_id(type, index);
913 unit_id = drive_index_to_unit_id(type, index);
916 if (unit_id == -1) {
917 unit_id = 0;
918 while (drive_get(type, bus_id, unit_id) != NULL) {
919 unit_id++;
920 if (max_devs && unit_id >= max_devs) {
921 unit_id -= max_devs;
922 bus_id++;
927 if (max_devs && unit_id >= max_devs) {
928 error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
929 goto fail;
932 if (drive_get(type, bus_id, unit_id) != NULL) {
933 error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
934 bus_id, unit_id, index);
935 goto fail;
938 /* no id supplied -> create one */
939 if (qemu_opts_id(all_opts) == NULL) {
940 char *new_id;
941 const char *mediastr = "";
942 if (type == IF_IDE || type == IF_SCSI) {
943 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
945 if (max_devs) {
946 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
947 mediastr, unit_id);
948 } else {
949 new_id = g_strdup_printf("%s%s%i", if_name[type],
950 mediastr, unit_id);
952 qdict_put_str(bs_opts, "id", new_id);
953 g_free(new_id);
956 /* Add virtio block device */
957 if (type == IF_VIRTIO) {
958 QemuOpts *devopts;
959 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
960 &error_abort);
961 qemu_opt_set(devopts, "driver", "virtio-blk", &error_abort);
962 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
963 &error_abort);
966 filename = qemu_opt_get(legacy_opts, "file");
968 /* Check werror/rerror compatibility with if=... */
969 werror = qemu_opt_get(legacy_opts, "werror");
970 if (werror != NULL) {
971 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
972 type != IF_NONE) {
973 error_setg(errp, "werror is not supported by this bus type");
974 goto fail;
976 qdict_put_str(bs_opts, "werror", werror);
979 rerror = qemu_opt_get(legacy_opts, "rerror");
980 if (rerror != NULL) {
981 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
982 type != IF_NONE) {
983 error_setg(errp, "rerror is not supported by this bus type");
984 goto fail;
986 qdict_put_str(bs_opts, "rerror", rerror);
989 /* Actual block device init: Functionality shared with blockdev-add */
990 blk = blockdev_init(filename, bs_opts, errp);
991 bs_opts = NULL;
992 if (!blk) {
993 goto fail;
996 /* Create legacy DriveInfo */
997 dinfo = g_malloc0(sizeof(*dinfo));
998 dinfo->opts = all_opts;
1000 dinfo->type = type;
1001 dinfo->bus = bus_id;
1002 dinfo->unit = unit_id;
1004 blk_set_legacy_dinfo(blk, dinfo);
1006 switch(type) {
1007 case IF_IDE:
1008 case IF_SCSI:
1009 case IF_XEN:
1010 case IF_NONE:
1011 dinfo->media_cd = media == MEDIA_CDROM;
1012 break;
1013 default:
1014 break;
1017 fail:
1018 qemu_opts_del(legacy_opts);
1019 qobject_unref(bs_opts);
1020 return dinfo;
1023 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1025 BlockDriverState *bs;
1027 bs = bdrv_lookup_bs(name, name, errp);
1028 if (bs == NULL) {
1029 return NULL;
1032 if (!bdrv_is_root_node(bs)) {
1033 error_setg(errp, "Need a root block node");
1034 return NULL;
1037 if (!bdrv_is_inserted(bs)) {
1038 error_setg(errp, "Device has no medium");
1039 return NULL;
1042 return bs;
1045 static void blockdev_do_action(TransactionAction *action, Error **errp)
1047 TransactionActionList list;
1049 list.value = action;
1050 list.next = NULL;
1051 qmp_transaction(&list, NULL, errp);
1054 void qmp_blockdev_snapshot_sync(const char *device, const char *node_name,
1055 const char *snapshot_file,
1056 const char *snapshot_node_name,
1057 const char *format,
1058 bool has_mode, NewImageMode mode, Error **errp)
1060 BlockdevSnapshotSync snapshot = {
1061 .device = (char *) device,
1062 .node_name = (char *) node_name,
1063 .snapshot_file = (char *) snapshot_file,
1064 .snapshot_node_name = (char *) snapshot_node_name,
1065 .format = (char *) format,
1066 .has_mode = has_mode,
1067 .mode = mode,
1069 TransactionAction action = {
1070 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1071 .u.blockdev_snapshot_sync.data = &snapshot,
1073 blockdev_do_action(&action, errp);
1076 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1077 Error **errp)
1079 BlockdevSnapshot snapshot_data = {
1080 .node = (char *) node,
1081 .overlay = (char *) overlay
1083 TransactionAction action = {
1084 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1085 .u.blockdev_snapshot.data = &snapshot_data,
1087 blockdev_do_action(&action, errp);
1090 void qmp_blockdev_snapshot_internal_sync(const char *device,
1091 const char *name,
1092 Error **errp)
1094 BlockdevSnapshotInternal snapshot = {
1095 .device = (char *) device,
1096 .name = (char *) name
1098 TransactionAction action = {
1099 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1100 .u.blockdev_snapshot_internal_sync.data = &snapshot,
1102 blockdev_do_action(&action, errp);
1105 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1106 const char *id,
1107 const char *name,
1108 Error **errp)
1110 BlockDriverState *bs;
1111 AioContext *aio_context;
1112 QEMUSnapshotInfo sn;
1113 Error *local_err = NULL;
1114 SnapshotInfo *info = NULL;
1115 int ret;
1117 bs = qmp_get_root_bs(device, errp);
1118 if (!bs) {
1119 return NULL;
1121 aio_context = bdrv_get_aio_context(bs);
1122 aio_context_acquire(aio_context);
1124 if (!id && !name) {
1125 error_setg(errp, "Name or id must be provided");
1126 goto out_aio_context;
1129 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1130 goto out_aio_context;
1133 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1134 if (local_err) {
1135 error_propagate(errp, local_err);
1136 goto out_aio_context;
1138 if (!ret) {
1139 error_setg(errp,
1140 "Snapshot with id '%s' and name '%s' does not exist on "
1141 "device '%s'",
1142 STR_OR_NULL(id), STR_OR_NULL(name), device);
1143 goto out_aio_context;
1146 bdrv_snapshot_delete(bs, id, name, &local_err);
1147 if (local_err) {
1148 error_propagate(errp, local_err);
1149 goto out_aio_context;
1152 aio_context_release(aio_context);
1154 info = g_new0(SnapshotInfo, 1);
1155 info->id = g_strdup(sn.id_str);
1156 info->name = g_strdup(sn.name);
1157 info->date_nsec = sn.date_nsec;
1158 info->date_sec = sn.date_sec;
1159 info->vm_state_size = sn.vm_state_size;
1160 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1161 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1162 if (sn.icount != -1ULL) {
1163 info->icount = sn.icount;
1164 info->has_icount = true;
1167 return info;
1169 out_aio_context:
1170 aio_context_release(aio_context);
1171 return NULL;
1174 /* New and old BlockDriverState structs for atomic group operations */
1176 typedef struct BlkActionState BlkActionState;
1179 * BlkActionOps:
1180 * Table of operations that define an Action.
1182 * @instance_size: Size of state struct, in bytes.
1183 * @prepare: Prepare the work, must NOT be NULL.
1184 * @commit: Commit the changes, can be NULL.
1185 * @abort: Abort the changes on fail, can be NULL.
1186 * @clean: Clean up resources after all transaction actions have called
1187 * commit() or abort(). Can be NULL.
1189 * Only prepare() may fail. In a single transaction, only one of commit() or
1190 * abort() will be called. clean() will always be called if it is present.
1192 * Always run under BQL.
1194 typedef struct BlkActionOps {
1195 size_t instance_size;
1196 void (*prepare)(BlkActionState *common, Error **errp);
1197 void (*commit)(BlkActionState *common);
1198 void (*abort)(BlkActionState *common);
1199 void (*clean)(BlkActionState *common);
1200 } BlkActionOps;
1203 * BlkActionState:
1204 * Describes one Action's state within a Transaction.
1206 * @action: QAPI-defined enum identifying which Action to perform.
1207 * @ops: Table of ActionOps this Action can perform.
1208 * @block_job_txn: Transaction which this action belongs to.
1209 * @entry: List membership for all Actions in this Transaction.
1211 * This structure must be arranged as first member in a subclassed type,
1212 * assuming that the compiler will also arrange it to the same offsets as the
1213 * base class.
1215 struct BlkActionState {
1216 TransactionAction *action;
1217 const BlkActionOps *ops;
1218 JobTxn *block_job_txn;
1219 TransactionProperties *txn_props;
1220 QTAILQ_ENTRY(BlkActionState) entry;
1223 /* internal snapshot private data */
1224 typedef struct InternalSnapshotState {
1225 BlkActionState common;
1226 BlockDriverState *bs;
1227 QEMUSnapshotInfo sn;
1228 bool created;
1229 } InternalSnapshotState;
1232 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1234 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1235 error_setg(errp,
1236 "Action '%s' does not support Transaction property "
1237 "completion-mode = %s",
1238 TransactionActionKind_str(s->action->type),
1239 ActionCompletionMode_str(s->txn_props->completion_mode));
1240 return -1;
1242 return 0;
1245 static void internal_snapshot_prepare(BlkActionState *common,
1246 Error **errp)
1248 Error *local_err = NULL;
1249 const char *device;
1250 const char *name;
1251 BlockDriverState *bs;
1252 QEMUSnapshotInfo old_sn, *sn;
1253 bool ret;
1254 int64_t rt;
1255 BlockdevSnapshotInternal *internal;
1256 InternalSnapshotState *state;
1257 AioContext *aio_context;
1258 int ret1;
1260 g_assert(common->action->type ==
1261 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1262 internal = common->action->u.blockdev_snapshot_internal_sync.data;
1263 state = DO_UPCAST(InternalSnapshotState, common, common);
1265 /* 1. parse input */
1266 device = internal->device;
1267 name = internal->name;
1269 /* 2. check for validation */
1270 if (action_check_completion_mode(common, errp) < 0) {
1271 return;
1274 bs = qmp_get_root_bs(device, errp);
1275 if (!bs) {
1276 return;
1279 aio_context = bdrv_get_aio_context(bs);
1280 aio_context_acquire(aio_context);
1282 state->bs = bs;
1284 /* Paired with .clean() */
1285 bdrv_drained_begin(bs);
1287 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1288 goto out;
1291 if (bdrv_is_read_only(bs)) {
1292 error_setg(errp, "Device '%s' is read only", device);
1293 goto out;
1296 if (!bdrv_can_snapshot(bs)) {
1297 error_setg(errp, "Block format '%s' used by device '%s' "
1298 "does not support internal snapshots",
1299 bs->drv->format_name, device);
1300 goto out;
1303 if (!strlen(name)) {
1304 error_setg(errp, "Name is empty");
1305 goto out;
1308 /* check whether a snapshot with name exist */
1309 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1310 &local_err);
1311 if (local_err) {
1312 error_propagate(errp, local_err);
1313 goto out;
1314 } else if (ret) {
1315 error_setg(errp,
1316 "Snapshot with name '%s' already exists on device '%s'",
1317 name, device);
1318 goto out;
1321 /* 3. take the snapshot */
1322 sn = &state->sn;
1323 pstrcpy(sn->name, sizeof(sn->name), name);
1324 rt = g_get_real_time();
1325 sn->date_sec = rt / G_USEC_PER_SEC;
1326 sn->date_nsec = (rt % G_USEC_PER_SEC) * 1000;
1327 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1328 if (replay_mode != REPLAY_MODE_NONE) {
1329 sn->icount = replay_get_current_icount();
1330 } else {
1331 sn->icount = -1ULL;
1334 ret1 = bdrv_snapshot_create(bs, sn);
1335 if (ret1 < 0) {
1336 error_setg_errno(errp, -ret1,
1337 "Failed to create snapshot '%s' on device '%s'",
1338 name, device);
1339 goto out;
1342 /* 4. succeed, mark a snapshot is created */
1343 state->created = true;
1345 out:
1346 aio_context_release(aio_context);
1349 static void internal_snapshot_abort(BlkActionState *common)
1351 InternalSnapshotState *state =
1352 DO_UPCAST(InternalSnapshotState, common, common);
1353 BlockDriverState *bs = state->bs;
1354 QEMUSnapshotInfo *sn = &state->sn;
1355 AioContext *aio_context;
1356 Error *local_error = NULL;
1358 if (!state->created) {
1359 return;
1362 aio_context = bdrv_get_aio_context(state->bs);
1363 aio_context_acquire(aio_context);
1365 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1366 error_reportf_err(local_error,
1367 "Failed to delete snapshot with id '%s' and "
1368 "name '%s' on device '%s' in abort: ",
1369 sn->id_str, sn->name,
1370 bdrv_get_device_name(bs));
1373 aio_context_release(aio_context);
1376 static void internal_snapshot_clean(BlkActionState *common)
1378 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1379 common, common);
1380 AioContext *aio_context;
1382 if (!state->bs) {
1383 return;
1386 aio_context = bdrv_get_aio_context(state->bs);
1387 aio_context_acquire(aio_context);
1389 bdrv_drained_end(state->bs);
1391 aio_context_release(aio_context);
1394 /* external snapshot private data */
1395 typedef struct ExternalSnapshotState {
1396 BlkActionState common;
1397 BlockDriverState *old_bs;
1398 BlockDriverState *new_bs;
1399 bool overlay_appended;
1400 } ExternalSnapshotState;
1402 static void external_snapshot_prepare(BlkActionState *common,
1403 Error **errp)
1405 int ret;
1406 int flags = 0;
1407 QDict *options = NULL;
1408 Error *local_err = NULL;
1409 /* Device and node name of the image to generate the snapshot from */
1410 const char *device;
1411 const char *node_name;
1412 /* Reference to the new image (for 'blockdev-snapshot') */
1413 const char *snapshot_ref;
1414 /* File name of the new image (for 'blockdev-snapshot-sync') */
1415 const char *new_image_file;
1416 ExternalSnapshotState *state =
1417 DO_UPCAST(ExternalSnapshotState, common, common);
1418 TransactionAction *action = common->action;
1419 AioContext *aio_context;
1420 uint64_t perm, shared;
1422 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1423 * purpose but a different set of parameters */
1424 switch (action->type) {
1425 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1427 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1428 device = s->node;
1429 node_name = s->node;
1430 new_image_file = NULL;
1431 snapshot_ref = s->overlay;
1433 break;
1434 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1436 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1437 device = s->device;
1438 node_name = s->node_name;
1439 new_image_file = s->snapshot_file;
1440 snapshot_ref = NULL;
1442 break;
1443 default:
1444 g_assert_not_reached();
1447 /* start processing */
1448 if (action_check_completion_mode(common, errp) < 0) {
1449 return;
1452 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1453 if (!state->old_bs) {
1454 return;
1457 aio_context = bdrv_get_aio_context(state->old_bs);
1458 aio_context_acquire(aio_context);
1460 /* Paired with .clean() */
1461 bdrv_drained_begin(state->old_bs);
1463 if (!bdrv_is_inserted(state->old_bs)) {
1464 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1465 goto out;
1468 if (bdrv_op_is_blocked(state->old_bs,
1469 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1470 goto out;
1473 if (!bdrv_is_read_only(state->old_bs)) {
1474 if (bdrv_flush(state->old_bs)) {
1475 error_setg(errp, QERR_IO_ERROR);
1476 goto out;
1480 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1481 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1482 const char *format = s->format ?: "qcow2";
1483 enum NewImageMode mode;
1484 const char *snapshot_node_name = s->snapshot_node_name;
1486 if (node_name && !snapshot_node_name) {
1487 error_setg(errp, "New overlay node-name missing");
1488 goto out;
1491 if (snapshot_node_name &&
1492 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1493 error_setg(errp, "New overlay node-name already in use");
1494 goto out;
1497 flags = state->old_bs->open_flags;
1498 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1499 flags |= BDRV_O_NO_BACKING;
1501 /* create new image w/backing file */
1502 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1503 if (mode != NEW_IMAGE_MODE_EXISTING) {
1504 int64_t size = bdrv_getlength(state->old_bs);
1505 if (size < 0) {
1506 error_setg_errno(errp, -size, "bdrv_getlength failed");
1507 goto out;
1509 bdrv_refresh_filename(state->old_bs);
1511 aio_context_release(aio_context);
1512 bdrv_img_create(new_image_file, format,
1513 state->old_bs->filename,
1514 state->old_bs->drv->format_name,
1515 NULL, size, flags, false, &local_err);
1516 aio_context_acquire(aio_context);
1518 if (local_err) {
1519 error_propagate(errp, local_err);
1520 goto out;
1524 options = qdict_new();
1525 if (snapshot_node_name) {
1526 qdict_put_str(options, "node-name", snapshot_node_name);
1528 qdict_put_str(options, "driver", format);
1531 state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1532 errp);
1533 /* We will manually add the backing_hd field to the bs later */
1534 if (!state->new_bs) {
1535 goto out;
1539 * Allow attaching a backing file to an overlay that's already in use only
1540 * if the parents don't assume that they are already seeing a valid image.
1541 * (Specifically, allow it as a mirror target, which is write-only access.)
1543 bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1544 if (perm & BLK_PERM_CONSISTENT_READ) {
1545 error_setg(errp, "The overlay is already in use");
1546 goto out;
1549 if (state->new_bs->drv->is_filter) {
1550 error_setg(errp, "Filters cannot be used as overlays");
1551 goto out;
1554 if (bdrv_cow_child(state->new_bs)) {
1555 error_setg(errp, "The overlay already has a backing image");
1556 goto out;
1559 if (!state->new_bs->drv->supports_backing) {
1560 error_setg(errp, "The overlay does not support backing images");
1561 goto out;
1564 ret = bdrv_append(state->new_bs, state->old_bs, errp);
1565 if (ret < 0) {
1566 goto out;
1568 state->overlay_appended = true;
1570 out:
1571 aio_context_release(aio_context);
1574 static void external_snapshot_commit(BlkActionState *common)
1576 ExternalSnapshotState *state =
1577 DO_UPCAST(ExternalSnapshotState, common, common);
1578 AioContext *aio_context;
1580 aio_context = bdrv_get_aio_context(state->old_bs);
1581 aio_context_acquire(aio_context);
1583 /* We don't need (or want) to use the transactional
1584 * bdrv_reopen_multiple() across all the entries at once, because we
1585 * don't want to abort all of them if one of them fails the reopen */
1586 if (!qatomic_read(&state->old_bs->copy_on_read)) {
1587 bdrv_reopen_set_read_only(state->old_bs, true, NULL);
1590 aio_context_release(aio_context);
1593 static void external_snapshot_abort(BlkActionState *common)
1595 ExternalSnapshotState *state =
1596 DO_UPCAST(ExternalSnapshotState, common, common);
1597 if (state->new_bs) {
1598 if (state->overlay_appended) {
1599 AioContext *aio_context;
1600 AioContext *tmp_context;
1601 int ret;
1603 aio_context = bdrv_get_aio_context(state->old_bs);
1604 aio_context_acquire(aio_context);
1606 bdrv_ref(state->old_bs); /* we can't let bdrv_set_backind_hd()
1607 close state->old_bs; we need it */
1608 bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
1611 * The call to bdrv_set_backing_hd() above returns state->old_bs to
1612 * the main AioContext. As we're still going to be using it, return
1613 * it to the AioContext it was before.
1615 tmp_context = bdrv_get_aio_context(state->old_bs);
1616 if (aio_context != tmp_context) {
1617 aio_context_release(aio_context);
1618 aio_context_acquire(tmp_context);
1620 ret = bdrv_try_change_aio_context(state->old_bs,
1621 aio_context, NULL, NULL);
1622 assert(ret == 0);
1624 aio_context_release(tmp_context);
1625 aio_context_acquire(aio_context);
1628 bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
1629 bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
1631 aio_context_release(aio_context);
1636 static void external_snapshot_clean(BlkActionState *common)
1638 ExternalSnapshotState *state =
1639 DO_UPCAST(ExternalSnapshotState, common, common);
1640 AioContext *aio_context;
1642 if (!state->old_bs) {
1643 return;
1646 aio_context = bdrv_get_aio_context(state->old_bs);
1647 aio_context_acquire(aio_context);
1649 bdrv_drained_end(state->old_bs);
1650 bdrv_unref(state->new_bs);
1652 aio_context_release(aio_context);
1655 typedef struct DriveBackupState {
1656 BlkActionState common;
1657 BlockDriverState *bs;
1658 BlockJob *job;
1659 } DriveBackupState;
1661 static BlockJob *do_backup_common(BackupCommon *backup,
1662 BlockDriverState *bs,
1663 BlockDriverState *target_bs,
1664 AioContext *aio_context,
1665 JobTxn *txn, Error **errp);
1667 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1669 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1670 DriveBackup *backup;
1671 BlockDriverState *bs;
1672 BlockDriverState *target_bs;
1673 BlockDriverState *source = NULL;
1674 AioContext *aio_context;
1675 AioContext *old_context;
1676 const char *format;
1677 QDict *options;
1678 Error *local_err = NULL;
1679 int flags;
1680 int64_t size;
1681 bool set_backing_hd = false;
1682 int ret;
1684 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1685 backup = common->action->u.drive_backup.data;
1687 if (!backup->has_mode) {
1688 backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1691 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1692 if (!bs) {
1693 return;
1696 if (!bs->drv) {
1697 error_setg(errp, "Device has no medium");
1698 return;
1701 aio_context = bdrv_get_aio_context(bs);
1702 aio_context_acquire(aio_context);
1704 state->bs = bs;
1705 /* Paired with .clean() */
1706 bdrv_drained_begin(bs);
1708 format = backup->format;
1709 if (!format && backup->mode != NEW_IMAGE_MODE_EXISTING) {
1710 format = bs->drv->format_name;
1713 /* Early check to avoid creating target */
1714 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
1715 goto out;
1718 flags = bs->open_flags | BDRV_O_RDWR;
1721 * See if we have a backing HD we can use to create our new image
1722 * on top of.
1724 if (backup->sync == MIRROR_SYNC_MODE_TOP) {
1726 * Backup will not replace the source by the target, so none
1727 * of the filters skipped here will be removed (in contrast to
1728 * mirror). Therefore, we can skip all of them when looking
1729 * for the first COW relationship.
1731 source = bdrv_cow_bs(bdrv_skip_filters(bs));
1732 if (!source) {
1733 backup->sync = MIRROR_SYNC_MODE_FULL;
1736 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1737 source = bs;
1738 flags |= BDRV_O_NO_BACKING;
1739 set_backing_hd = true;
1742 size = bdrv_getlength(bs);
1743 if (size < 0) {
1744 error_setg_errno(errp, -size, "bdrv_getlength failed");
1745 goto out;
1748 if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
1749 assert(format);
1750 if (source) {
1751 /* Implicit filters should not appear in the filename */
1752 BlockDriverState *explicit_backing =
1753 bdrv_skip_implicit_filters(source);
1755 bdrv_refresh_filename(explicit_backing);
1756 bdrv_img_create(backup->target, format,
1757 explicit_backing->filename,
1758 explicit_backing->drv->format_name, NULL,
1759 size, flags, false, &local_err);
1760 } else {
1761 bdrv_img_create(backup->target, format, NULL, NULL, NULL,
1762 size, flags, false, &local_err);
1766 if (local_err) {
1767 error_propagate(errp, local_err);
1768 goto out;
1771 options = qdict_new();
1772 qdict_put_str(options, "discard", "unmap");
1773 qdict_put_str(options, "detect-zeroes", "unmap");
1774 if (format) {
1775 qdict_put_str(options, "driver", format);
1778 target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
1779 if (!target_bs) {
1780 goto out;
1783 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
1784 old_context = bdrv_get_aio_context(target_bs);
1785 aio_context_release(aio_context);
1786 aio_context_acquire(old_context);
1788 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
1789 if (ret < 0) {
1790 bdrv_unref(target_bs);
1791 aio_context_release(old_context);
1792 return;
1795 aio_context_release(old_context);
1796 aio_context_acquire(aio_context);
1798 if (set_backing_hd) {
1799 if (bdrv_set_backing_hd(target_bs, source, errp) < 0) {
1800 goto unref;
1804 state->job = do_backup_common(qapi_DriveBackup_base(backup),
1805 bs, target_bs, aio_context,
1806 common->block_job_txn, errp);
1808 unref:
1809 bdrv_unref(target_bs);
1810 out:
1811 aio_context_release(aio_context);
1814 static void drive_backup_commit(BlkActionState *common)
1816 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1817 AioContext *aio_context;
1819 aio_context = bdrv_get_aio_context(state->bs);
1820 aio_context_acquire(aio_context);
1822 assert(state->job);
1823 job_start(&state->job->job);
1825 aio_context_release(aio_context);
1828 static void drive_backup_abort(BlkActionState *common)
1830 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1832 if (state->job) {
1833 job_cancel_sync(&state->job->job, true);
1837 static void drive_backup_clean(BlkActionState *common)
1839 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1840 AioContext *aio_context;
1842 if (!state->bs) {
1843 return;
1846 aio_context = bdrv_get_aio_context(state->bs);
1847 aio_context_acquire(aio_context);
1849 bdrv_drained_end(state->bs);
1851 aio_context_release(aio_context);
1854 typedef struct BlockdevBackupState {
1855 BlkActionState common;
1856 BlockDriverState *bs;
1857 BlockJob *job;
1858 } BlockdevBackupState;
1860 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1862 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1863 BlockdevBackup *backup;
1864 BlockDriverState *bs;
1865 BlockDriverState *target_bs;
1866 AioContext *aio_context;
1867 AioContext *old_context;
1868 int ret;
1870 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1871 backup = common->action->u.blockdev_backup.data;
1873 bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1874 if (!bs) {
1875 return;
1878 target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1879 if (!target_bs) {
1880 return;
1883 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
1884 aio_context = bdrv_get_aio_context(bs);
1885 old_context = bdrv_get_aio_context(target_bs);
1886 aio_context_acquire(old_context);
1888 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
1889 if (ret < 0) {
1890 aio_context_release(old_context);
1891 return;
1894 aio_context_release(old_context);
1895 aio_context_acquire(aio_context);
1896 state->bs = bs;
1898 /* Paired with .clean() */
1899 bdrv_drained_begin(state->bs);
1901 state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1902 bs, target_bs, aio_context,
1903 common->block_job_txn, errp);
1905 aio_context_release(aio_context);
1908 static void blockdev_backup_commit(BlkActionState *common)
1910 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1911 AioContext *aio_context;
1913 aio_context = bdrv_get_aio_context(state->bs);
1914 aio_context_acquire(aio_context);
1916 assert(state->job);
1917 job_start(&state->job->job);
1919 aio_context_release(aio_context);
1922 static void blockdev_backup_abort(BlkActionState *common)
1924 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1926 if (state->job) {
1927 job_cancel_sync(&state->job->job, true);
1931 static void blockdev_backup_clean(BlkActionState *common)
1933 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1934 AioContext *aio_context;
1936 if (!state->bs) {
1937 return;
1940 aio_context = bdrv_get_aio_context(state->bs);
1941 aio_context_acquire(aio_context);
1943 bdrv_drained_end(state->bs);
1945 aio_context_release(aio_context);
1948 typedef struct BlockDirtyBitmapState {
1949 BlkActionState common;
1950 BdrvDirtyBitmap *bitmap;
1951 BlockDriverState *bs;
1952 HBitmap *backup;
1953 bool prepared;
1954 bool was_enabled;
1955 } BlockDirtyBitmapState;
1957 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
1958 Error **errp)
1960 Error *local_err = NULL;
1961 BlockDirtyBitmapAdd *action;
1962 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1963 common, common);
1965 if (action_check_completion_mode(common, errp) < 0) {
1966 return;
1969 action = common->action->u.block_dirty_bitmap_add.data;
1970 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1971 qmp_block_dirty_bitmap_add(action->node, action->name,
1972 action->has_granularity, action->granularity,
1973 action->has_persistent, action->persistent,
1974 action->has_disabled, action->disabled,
1975 &local_err);
1977 if (!local_err) {
1978 state->prepared = true;
1979 } else {
1980 error_propagate(errp, local_err);
1984 static void block_dirty_bitmap_add_abort(BlkActionState *common)
1986 BlockDirtyBitmapAdd *action;
1987 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1988 common, common);
1990 action = common->action->u.block_dirty_bitmap_add.data;
1991 /* Should not be able to fail: IF the bitmap was added via .prepare(),
1992 * then the node reference and bitmap name must have been valid.
1994 if (state->prepared) {
1995 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
1999 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
2000 Error **errp)
2002 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2003 common, common);
2004 BlockDirtyBitmap *action;
2006 if (action_check_completion_mode(common, errp) < 0) {
2007 return;
2010 action = common->action->u.block_dirty_bitmap_clear.data;
2011 state->bitmap = block_dirty_bitmap_lookup(action->node,
2012 action->name,
2013 &state->bs,
2014 errp);
2015 if (!state->bitmap) {
2016 return;
2019 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
2020 return;
2023 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2026 static void block_dirty_bitmap_restore(BlkActionState *common)
2028 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2029 common, common);
2031 if (state->backup) {
2032 bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
2036 static void block_dirty_bitmap_free_backup(BlkActionState *common)
2038 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2039 common, common);
2041 hbitmap_free(state->backup);
2044 static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2045 Error **errp)
2047 BlockDirtyBitmap *action;
2048 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2049 common, common);
2051 if (action_check_completion_mode(common, errp) < 0) {
2052 return;
2055 action = common->action->u.block_dirty_bitmap_enable.data;
2056 state->bitmap = block_dirty_bitmap_lookup(action->node,
2057 action->name,
2058 NULL,
2059 errp);
2060 if (!state->bitmap) {
2061 return;
2064 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
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.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 if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2103 return;
2106 state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2107 bdrv_disable_dirty_bitmap(state->bitmap);
2110 static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2112 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2113 common, common);
2115 if (state->was_enabled) {
2116 bdrv_enable_dirty_bitmap(state->bitmap);
2120 static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2121 Error **errp)
2123 BlockDirtyBitmapMerge *action;
2124 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2125 common, common);
2127 if (action_check_completion_mode(common, errp) < 0) {
2128 return;
2131 action = common->action->u.block_dirty_bitmap_merge.data;
2133 state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2134 action->bitmaps, &state->backup,
2135 errp);
2138 static void block_dirty_bitmap_remove_prepare(BlkActionState *common,
2139 Error **errp)
2141 BlockDirtyBitmap *action;
2142 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2143 common, common);
2145 if (action_check_completion_mode(common, errp) < 0) {
2146 return;
2149 action = common->action->u.block_dirty_bitmap_remove.data;
2151 state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2152 false, &state->bs, errp);
2153 if (state->bitmap) {
2154 bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2155 bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2159 static void block_dirty_bitmap_remove_abort(BlkActionState *common)
2161 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2162 common, common);
2164 if (state->bitmap) {
2165 bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2166 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2170 static void block_dirty_bitmap_remove_commit(BlkActionState *common)
2172 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2173 common, common);
2175 bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2176 bdrv_release_dirty_bitmap(state->bitmap);
2179 static void abort_prepare(BlkActionState *common, Error **errp)
2181 error_setg(errp, "Transaction aborted using Abort action");
2184 static void abort_commit(BlkActionState *common)
2186 g_assert_not_reached(); /* this action never succeeds */
2189 static const BlkActionOps actions[] = {
2190 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2191 .instance_size = sizeof(ExternalSnapshotState),
2192 .prepare = external_snapshot_prepare,
2193 .commit = external_snapshot_commit,
2194 .abort = external_snapshot_abort,
2195 .clean = external_snapshot_clean,
2197 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2198 .instance_size = sizeof(ExternalSnapshotState),
2199 .prepare = external_snapshot_prepare,
2200 .commit = external_snapshot_commit,
2201 .abort = external_snapshot_abort,
2202 .clean = external_snapshot_clean,
2204 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2205 .instance_size = sizeof(DriveBackupState),
2206 .prepare = drive_backup_prepare,
2207 .commit = drive_backup_commit,
2208 .abort = drive_backup_abort,
2209 .clean = drive_backup_clean,
2211 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2212 .instance_size = sizeof(BlockdevBackupState),
2213 .prepare = blockdev_backup_prepare,
2214 .commit = blockdev_backup_commit,
2215 .abort = blockdev_backup_abort,
2216 .clean = blockdev_backup_clean,
2218 [TRANSACTION_ACTION_KIND_ABORT] = {
2219 .instance_size = sizeof(BlkActionState),
2220 .prepare = abort_prepare,
2221 .commit = abort_commit,
2223 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2224 .instance_size = sizeof(InternalSnapshotState),
2225 .prepare = internal_snapshot_prepare,
2226 .abort = internal_snapshot_abort,
2227 .clean = internal_snapshot_clean,
2229 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2230 .instance_size = sizeof(BlockDirtyBitmapState),
2231 .prepare = block_dirty_bitmap_add_prepare,
2232 .abort = block_dirty_bitmap_add_abort,
2234 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2235 .instance_size = sizeof(BlockDirtyBitmapState),
2236 .prepare = block_dirty_bitmap_clear_prepare,
2237 .commit = block_dirty_bitmap_free_backup,
2238 .abort = block_dirty_bitmap_restore,
2240 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
2241 .instance_size = sizeof(BlockDirtyBitmapState),
2242 .prepare = block_dirty_bitmap_enable_prepare,
2243 .abort = block_dirty_bitmap_enable_abort,
2245 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
2246 .instance_size = sizeof(BlockDirtyBitmapState),
2247 .prepare = block_dirty_bitmap_disable_prepare,
2248 .abort = block_dirty_bitmap_disable_abort,
2250 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
2251 .instance_size = sizeof(BlockDirtyBitmapState),
2252 .prepare = block_dirty_bitmap_merge_prepare,
2253 .commit = block_dirty_bitmap_free_backup,
2254 .abort = block_dirty_bitmap_restore,
2256 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE] = {
2257 .instance_size = sizeof(BlockDirtyBitmapState),
2258 .prepare = block_dirty_bitmap_remove_prepare,
2259 .commit = block_dirty_bitmap_remove_commit,
2260 .abort = block_dirty_bitmap_remove_abort,
2262 /* Where are transactions for MIRROR, COMMIT and STREAM?
2263 * Although these blockjobs use transaction callbacks like the backup job,
2264 * these jobs do not necessarily adhere to transaction semantics.
2265 * These jobs may not fully undo all of their actions on abort, nor do they
2266 * necessarily work in transactions with more than one job in them.
2271 * Allocate a TransactionProperties structure if necessary, and fill
2272 * that structure with desired defaults if they are unset.
2274 static TransactionProperties *get_transaction_properties(
2275 TransactionProperties *props)
2277 if (!props) {
2278 props = g_new0(TransactionProperties, 1);
2281 if (!props->has_completion_mode) {
2282 props->has_completion_mode = true;
2283 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2286 return props;
2290 * 'Atomic' group operations. The operations are performed as a set, and if
2291 * any fail then we roll back all operations in the group.
2293 * Always run under BQL.
2295 void qmp_transaction(TransactionActionList *dev_list,
2296 struct TransactionProperties *props,
2297 Error **errp)
2299 TransactionActionList *dev_entry = dev_list;
2300 bool has_props = !!props;
2301 JobTxn *block_job_txn = NULL;
2302 BlkActionState *state, *next;
2303 Error *local_err = NULL;
2305 GLOBAL_STATE_CODE();
2307 QTAILQ_HEAD(, BlkActionState) snap_bdrv_states;
2308 QTAILQ_INIT(&snap_bdrv_states);
2310 /* Does this transaction get canceled as a group on failure?
2311 * If not, we don't really need to make a JobTxn.
2313 props = get_transaction_properties(props);
2314 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2315 block_job_txn = job_txn_new();
2318 /* drain all i/o before any operations */
2319 bdrv_drain_all();
2321 /* We don't do anything in this loop that commits us to the operations */
2322 while (NULL != dev_entry) {
2323 TransactionAction *dev_info = NULL;
2324 const BlkActionOps *ops;
2326 dev_info = dev_entry->value;
2327 dev_entry = dev_entry->next;
2329 assert(dev_info->type < ARRAY_SIZE(actions));
2331 ops = &actions[dev_info->type];
2332 assert(ops->instance_size > 0);
2334 state = g_malloc0(ops->instance_size);
2335 state->ops = ops;
2336 state->action = dev_info;
2337 state->block_job_txn = block_job_txn;
2338 state->txn_props = props;
2339 QTAILQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2341 state->ops->prepare(state, &local_err);
2342 if (local_err) {
2343 error_propagate(errp, local_err);
2344 goto delete_and_fail;
2348 QTAILQ_FOREACH(state, &snap_bdrv_states, entry) {
2349 if (state->ops->commit) {
2350 state->ops->commit(state);
2354 /* success */
2355 goto exit;
2357 delete_and_fail:
2358 /* failure, and it is all-or-none; roll back all operations */
2359 QTAILQ_FOREACH_REVERSE(state, &snap_bdrv_states, entry) {
2360 if (state->ops->abort) {
2361 state->ops->abort(state);
2364 exit:
2365 QTAILQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2366 if (state->ops->clean) {
2367 state->ops->clean(state);
2369 g_free(state);
2371 if (!has_props) {
2372 qapi_free_TransactionProperties(props);
2374 job_txn_unref(block_job_txn);
2377 BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2378 const char *name,
2379 Error **errp)
2381 BdrvDirtyBitmap *bitmap;
2382 BlockDriverState *bs;
2383 BlockDirtyBitmapSha256 *ret = NULL;
2384 char *sha256;
2386 bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2387 if (!bitmap || !bs) {
2388 return NULL;
2391 sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2392 if (sha256 == NULL) {
2393 return NULL;
2396 ret = g_new(BlockDirtyBitmapSha256, 1);
2397 ret->sha256 = sha256;
2399 return ret;
2402 void coroutine_fn qmp_block_resize(const char *device, const char *node_name,
2403 int64_t size, Error **errp)
2405 Error *local_err = NULL;
2406 BlockBackend *blk;
2407 BlockDriverState *bs;
2408 AioContext *old_ctx;
2410 bs = bdrv_lookup_bs(device, node_name, &local_err);
2411 if (local_err) {
2412 error_propagate(errp, local_err);
2413 return;
2416 if (size < 0) {
2417 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2418 return;
2421 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2422 error_setg(errp, QERR_DEVICE_IN_USE, device);
2423 return;
2426 blk = blk_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
2427 if (!blk) {
2428 return;
2431 bdrv_co_lock(bs);
2432 bdrv_drained_begin(bs);
2433 bdrv_co_unlock(bs);
2435 old_ctx = bdrv_co_enter(bs);
2436 blk_co_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
2437 bdrv_co_leave(bs, old_ctx);
2439 bdrv_co_lock(bs);
2440 bdrv_drained_end(bs);
2441 blk_unref(blk);
2442 bdrv_co_unlock(bs);
2445 void qmp_block_stream(const char *job_id, const char *device,
2446 const char *base,
2447 const char *base_node,
2448 const char *backing_file,
2449 const char *bottom,
2450 bool has_speed, int64_t speed,
2451 bool has_on_error, BlockdevOnError on_error,
2452 const char *filter_node_name,
2453 bool has_auto_finalize, bool auto_finalize,
2454 bool has_auto_dismiss, bool auto_dismiss,
2455 Error **errp)
2457 BlockDriverState *bs, *iter, *iter_end;
2458 BlockDriverState *base_bs = NULL;
2459 BlockDriverState *bottom_bs = NULL;
2460 AioContext *aio_context;
2461 Error *local_err = NULL;
2462 int job_flags = JOB_DEFAULT;
2464 if (base && base_node) {
2465 error_setg(errp, "'base' and 'base-node' cannot be specified "
2466 "at the same time");
2467 return;
2470 if (base && bottom) {
2471 error_setg(errp, "'base' and 'bottom' cannot be specified "
2472 "at the same time");
2473 return;
2476 if (bottom && base_node) {
2477 error_setg(errp, "'bottom' and 'base-node' cannot be specified "
2478 "at the same time");
2479 return;
2482 if (!has_on_error) {
2483 on_error = BLOCKDEV_ON_ERROR_REPORT;
2486 bs = bdrv_lookup_bs(device, device, errp);
2487 if (!bs) {
2488 return;
2491 aio_context = bdrv_get_aio_context(bs);
2492 aio_context_acquire(aio_context);
2494 if (base) {
2495 base_bs = bdrv_find_backing_image(bs, base);
2496 if (base_bs == NULL) {
2497 error_setg(errp, "Can't find '%s' in the backing chain", base);
2498 goto out;
2500 assert(bdrv_get_aio_context(base_bs) == aio_context);
2503 if (base_node) {
2504 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2505 if (!base_bs) {
2506 goto out;
2508 if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2509 error_setg(errp, "Node '%s' is not a backing image of '%s'",
2510 base_node, device);
2511 goto out;
2513 assert(bdrv_get_aio_context(base_bs) == aio_context);
2514 bdrv_refresh_filename(base_bs);
2517 if (bottom) {
2518 bottom_bs = bdrv_lookup_bs(NULL, bottom, errp);
2519 if (!bottom_bs) {
2520 goto out;
2522 if (!bottom_bs->drv) {
2523 error_setg(errp, "Node '%s' is not open", bottom);
2524 goto out;
2526 if (bottom_bs->drv->is_filter) {
2527 error_setg(errp, "Node '%s' is a filter, use a non-filter node "
2528 "as 'bottom'", bottom);
2529 goto out;
2531 if (!bdrv_chain_contains(bs, bottom_bs)) {
2532 error_setg(errp, "Node '%s' is not in a chain starting from '%s'",
2533 bottom, device);
2534 goto out;
2536 assert(bdrv_get_aio_context(bottom_bs) == aio_context);
2540 * Check for op blockers in the whole chain between bs and base (or bottom)
2542 iter_end = bottom ? bdrv_filter_or_cow_bs(bottom_bs) : base_bs;
2543 for (iter = bs; iter && iter != iter_end;
2544 iter = bdrv_filter_or_cow_bs(iter))
2546 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
2547 goto out;
2551 /* if we are streaming the entire chain, the result will have no backing
2552 * file, and specifying one is therefore an error */
2553 if (!base_bs && backing_file) {
2554 error_setg(errp, "backing file specified, but streaming the "
2555 "entire chain");
2556 goto out;
2559 if (has_auto_finalize && !auto_finalize) {
2560 job_flags |= JOB_MANUAL_FINALIZE;
2562 if (has_auto_dismiss && !auto_dismiss) {
2563 job_flags |= JOB_MANUAL_DISMISS;
2566 stream_start(job_id, bs, base_bs, backing_file,
2567 bottom_bs, job_flags, has_speed ? speed : 0, on_error,
2568 filter_node_name, &local_err);
2569 if (local_err) {
2570 error_propagate(errp, local_err);
2571 goto out;
2574 trace_qmp_block_stream(bs);
2576 out:
2577 aio_context_release(aio_context);
2580 void qmp_block_commit(const char *job_id, const char *device,
2581 const char *base_node,
2582 const char *base,
2583 const char *top_node,
2584 const char *top,
2585 const char *backing_file,
2586 bool has_speed, int64_t speed,
2587 bool has_on_error, BlockdevOnError on_error,
2588 const char *filter_node_name,
2589 bool has_auto_finalize, bool auto_finalize,
2590 bool has_auto_dismiss, bool auto_dismiss,
2591 Error **errp)
2593 BlockDriverState *bs;
2594 BlockDriverState *iter;
2595 BlockDriverState *base_bs, *top_bs;
2596 AioContext *aio_context;
2597 Error *local_err = NULL;
2598 int job_flags = JOB_DEFAULT;
2599 uint64_t top_perm, top_shared;
2601 if (!has_speed) {
2602 speed = 0;
2604 if (!has_on_error) {
2605 on_error = BLOCKDEV_ON_ERROR_REPORT;
2607 if (has_auto_finalize && !auto_finalize) {
2608 job_flags |= JOB_MANUAL_FINALIZE;
2610 if (has_auto_dismiss && !auto_dismiss) {
2611 job_flags |= JOB_MANUAL_DISMISS;
2614 /* Important Note:
2615 * libvirt relies on the DeviceNotFound error class in order to probe for
2616 * live commit feature versions; for this to work, we must make sure to
2617 * perform the device lookup before any generic errors that may occur in a
2618 * scenario in which all optional arguments are omitted. */
2619 bs = qmp_get_root_bs(device, &local_err);
2620 if (!bs) {
2621 bs = bdrv_lookup_bs(device, device, NULL);
2622 if (!bs) {
2623 error_free(local_err);
2624 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2625 "Device '%s' not found", device);
2626 } else {
2627 error_propagate(errp, local_err);
2629 return;
2632 aio_context = bdrv_get_aio_context(bs);
2633 aio_context_acquire(aio_context);
2635 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2636 goto out;
2639 /* default top_bs is the active layer */
2640 top_bs = bs;
2642 if (top_node && top) {
2643 error_setg(errp, "'top-node' and 'top' are mutually exclusive");
2644 goto out;
2645 } else if (top_node) {
2646 top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2647 if (top_bs == NULL) {
2648 goto out;
2650 if (!bdrv_chain_contains(bs, top_bs)) {
2651 error_setg(errp, "'%s' is not in this backing file chain",
2652 top_node);
2653 goto out;
2655 } else if (top) {
2656 /* This strcmp() is just a shortcut, there is no need to
2657 * refresh @bs's filename. If it mismatches,
2658 * bdrv_find_backing_image() will do the refresh and may still
2659 * return @bs. */
2660 if (strcmp(bs->filename, top) != 0) {
2661 top_bs = bdrv_find_backing_image(bs, top);
2665 if (top_bs == NULL) {
2666 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2667 goto out;
2670 assert(bdrv_get_aio_context(top_bs) == aio_context);
2672 if (base_node && base) {
2673 error_setg(errp, "'base-node' and 'base' are mutually exclusive");
2674 goto out;
2675 } else if (base_node) {
2676 base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2677 if (base_bs == NULL) {
2678 goto out;
2680 if (!bdrv_chain_contains(top_bs, base_bs)) {
2681 error_setg(errp, "'%s' is not in this backing file chain",
2682 base_node);
2683 goto out;
2685 } else if (base) {
2686 base_bs = bdrv_find_backing_image(top_bs, base);
2687 if (base_bs == NULL) {
2688 error_setg(errp, "Can't find '%s' in the backing chain", base);
2689 goto out;
2691 } else {
2692 base_bs = bdrv_find_base(top_bs);
2693 if (base_bs == NULL) {
2694 error_setg(errp, "There is no backimg image");
2695 goto out;
2699 assert(bdrv_get_aio_context(base_bs) == aio_context);
2701 for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2702 iter = bdrv_filter_or_cow_bs(iter))
2704 if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2705 goto out;
2709 /* Do not allow attempts to commit an image into itself */
2710 if (top_bs == base_bs) {
2711 error_setg(errp, "cannot commit an image into itself");
2712 goto out;
2716 * Active commit is required if and only if someone has taken a
2717 * WRITE permission on the top node. Historically, we have always
2718 * used active commit for top nodes, so continue that practice
2719 * lest we possibly break clients that rely on this behavior, e.g.
2720 * to later attach this node to a writing parent.
2721 * (Active commit is never really wrong.)
2723 bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2724 if (top_perm & BLK_PERM_WRITE ||
2725 bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2727 if (backing_file) {
2728 if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2729 error_setg(errp, "'backing-file' specified,"
2730 " but 'top' is the active layer");
2731 } else {
2732 error_setg(errp, "'backing-file' specified, but 'top' has a "
2733 "writer on it");
2735 goto out;
2737 if (!job_id) {
2739 * Emulate here what block_job_create() does, because it
2740 * is possible that @bs != @top_bs (the block job should
2741 * be named after @bs, even if @top_bs is the actual
2742 * source)
2744 job_id = bdrv_get_device_name(bs);
2746 commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
2747 filter_node_name, NULL, NULL, false, &local_err);
2748 } else {
2749 BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2750 if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2751 goto out;
2753 commit_start(job_id, bs, base_bs, top_bs, job_flags,
2754 speed, on_error, backing_file,
2755 filter_node_name, &local_err);
2757 if (local_err != NULL) {
2758 error_propagate(errp, local_err);
2759 goto out;
2762 out:
2763 aio_context_release(aio_context);
2766 /* Common QMP interface for drive-backup and blockdev-backup */
2767 static BlockJob *do_backup_common(BackupCommon *backup,
2768 BlockDriverState *bs,
2769 BlockDriverState *target_bs,
2770 AioContext *aio_context,
2771 JobTxn *txn, Error **errp)
2773 BlockJob *job = NULL;
2774 BdrvDirtyBitmap *bmap = NULL;
2775 BackupPerf perf = { .max_workers = 64 };
2776 int job_flags = JOB_DEFAULT;
2778 if (!backup->has_speed) {
2779 backup->speed = 0;
2781 if (!backup->has_on_source_error) {
2782 backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2784 if (!backup->has_on_target_error) {
2785 backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2787 if (!backup->has_auto_finalize) {
2788 backup->auto_finalize = true;
2790 if (!backup->has_auto_dismiss) {
2791 backup->auto_dismiss = true;
2793 if (!backup->has_compress) {
2794 backup->compress = false;
2797 if (backup->x_perf) {
2798 if (backup->x_perf->has_use_copy_range) {
2799 perf.use_copy_range = backup->x_perf->use_copy_range;
2801 if (backup->x_perf->has_max_workers) {
2802 perf.max_workers = backup->x_perf->max_workers;
2804 if (backup->x_perf->has_max_chunk) {
2805 perf.max_chunk = backup->x_perf->max_chunk;
2809 if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2810 (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2811 /* done before desugaring 'incremental' to print the right message */
2812 if (!backup->bitmap) {
2813 error_setg(errp, "must provide a valid bitmap name for "
2814 "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2815 return NULL;
2819 if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2820 if (backup->has_bitmap_mode &&
2821 backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2822 error_setg(errp, "Bitmap sync mode must be '%s' "
2823 "when using sync mode '%s'",
2824 BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2825 MirrorSyncMode_str(backup->sync));
2826 return NULL;
2828 backup->has_bitmap_mode = true;
2829 backup->sync = MIRROR_SYNC_MODE_BITMAP;
2830 backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2833 if (backup->bitmap) {
2834 bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2835 if (!bmap) {
2836 error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2837 return NULL;
2839 if (!backup->has_bitmap_mode) {
2840 error_setg(errp, "Bitmap sync mode must be given "
2841 "when providing a bitmap");
2842 return NULL;
2844 if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2845 return NULL;
2848 /* This does not produce a useful bitmap artifact: */
2849 if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2850 error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2851 " outputs", MirrorSyncMode_str(backup->sync));
2852 return NULL;
2855 /* If the bitmap isn't used for input or output, this is useless: */
2856 if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2857 backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2858 error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2859 " when combined with sync mode '%s'",
2860 BitmapSyncMode_str(backup->bitmap_mode),
2861 MirrorSyncMode_str(backup->sync));
2862 return NULL;
2866 if (!backup->bitmap && backup->has_bitmap_mode) {
2867 error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2868 return NULL;
2871 if (!backup->auto_finalize) {
2872 job_flags |= JOB_MANUAL_FINALIZE;
2874 if (!backup->auto_dismiss) {
2875 job_flags |= JOB_MANUAL_DISMISS;
2878 job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
2879 backup->sync, bmap, backup->bitmap_mode,
2880 backup->compress,
2881 backup->filter_node_name,
2882 &perf,
2883 backup->on_source_error,
2884 backup->on_target_error,
2885 job_flags, NULL, NULL, txn, errp);
2886 return job;
2889 void qmp_drive_backup(DriveBackup *backup, Error **errp)
2891 TransactionAction action = {
2892 .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2893 .u.drive_backup.data = backup,
2895 blockdev_do_action(&action, errp);
2898 BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2899 bool flat,
2900 Error **errp)
2902 bool return_flat = has_flat && flat;
2904 return bdrv_named_nodes_list(return_flat, errp);
2907 XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2909 return bdrv_get_xdbg_block_graph(errp);
2912 void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
2914 TransactionAction action = {
2915 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2916 .u.blockdev_backup.data = backup,
2918 blockdev_do_action(&action, errp);
2921 /* Parameter check and block job starting for drive mirroring.
2922 * Caller should hold @device and @target's aio context (must be the same).
2924 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
2925 BlockDriverState *target,
2926 const char *replaces,
2927 enum MirrorSyncMode sync,
2928 BlockMirrorBackingMode backing_mode,
2929 bool zero_target,
2930 bool has_speed, int64_t speed,
2931 bool has_granularity, uint32_t granularity,
2932 bool has_buf_size, int64_t buf_size,
2933 bool has_on_source_error,
2934 BlockdevOnError on_source_error,
2935 bool has_on_target_error,
2936 BlockdevOnError on_target_error,
2937 bool has_unmap, bool unmap,
2938 const char *filter_node_name,
2939 bool has_copy_mode, MirrorCopyMode copy_mode,
2940 bool has_auto_finalize, bool auto_finalize,
2941 bool has_auto_dismiss, bool auto_dismiss,
2942 Error **errp)
2944 BlockDriverState *unfiltered_bs;
2945 int job_flags = JOB_DEFAULT;
2947 if (!has_speed) {
2948 speed = 0;
2950 if (!has_on_source_error) {
2951 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2953 if (!has_on_target_error) {
2954 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2956 if (!has_granularity) {
2957 granularity = 0;
2959 if (!has_buf_size) {
2960 buf_size = 0;
2962 if (!has_unmap) {
2963 unmap = true;
2965 if (!has_copy_mode) {
2966 copy_mode = MIRROR_COPY_MODE_BACKGROUND;
2968 if (has_auto_finalize && !auto_finalize) {
2969 job_flags |= JOB_MANUAL_FINALIZE;
2971 if (has_auto_dismiss && !auto_dismiss) {
2972 job_flags |= JOB_MANUAL_DISMISS;
2975 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
2976 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2977 "a value in range [512B, 64MB]");
2978 return;
2980 if (granularity & (granularity - 1)) {
2981 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2982 "a power of 2");
2983 return;
2986 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
2987 return;
2989 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
2990 return;
2993 if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
2994 sync = MIRROR_SYNC_MODE_FULL;
2997 if (!replaces) {
2998 /* We want to mirror from @bs, but keep implicit filters on top */
2999 unfiltered_bs = bdrv_skip_implicit_filters(bs);
3000 if (unfiltered_bs != bs) {
3001 replaces = unfiltered_bs->node_name;
3005 if (replaces) {
3006 BlockDriverState *to_replace_bs;
3007 AioContext *replace_aio_context;
3008 int64_t bs_size, replace_size;
3010 bs_size = bdrv_getlength(bs);
3011 if (bs_size < 0) {
3012 error_setg_errno(errp, -bs_size, "Failed to query device's size");
3013 return;
3016 to_replace_bs = check_to_replace_node(bs, replaces, errp);
3017 if (!to_replace_bs) {
3018 return;
3021 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3022 aio_context_acquire(replace_aio_context);
3023 replace_size = bdrv_getlength(to_replace_bs);
3024 aio_context_release(replace_aio_context);
3026 if (replace_size < 0) {
3027 error_setg_errno(errp, -replace_size,
3028 "Failed to query the replacement node's size");
3029 return;
3031 if (bs_size != replace_size) {
3032 error_setg(errp, "cannot replace image with a mirror image of "
3033 "different size");
3034 return;
3038 /* pass the node name to replace to mirror start since it's loose coupling
3039 * and will allow to check whether the node still exist at mirror completion
3041 mirror_start(job_id, bs, target,
3042 replaces, job_flags,
3043 speed, granularity, buf_size, sync, backing_mode, zero_target,
3044 on_source_error, on_target_error, unmap, filter_node_name,
3045 copy_mode, errp);
3048 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3050 BlockDriverState *bs;
3051 BlockDriverState *target_backing_bs, *target_bs;
3052 AioContext *aio_context;
3053 AioContext *old_context;
3054 BlockMirrorBackingMode backing_mode;
3055 Error *local_err = NULL;
3056 QDict *options = NULL;
3057 int flags;
3058 int64_t size;
3059 const char *format = arg->format;
3060 bool zero_target;
3061 int ret;
3063 bs = qmp_get_root_bs(arg->device, errp);
3064 if (!bs) {
3065 return;
3068 /* Early check to avoid creating target */
3069 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3070 return;
3073 aio_context = bdrv_get_aio_context(bs);
3074 aio_context_acquire(aio_context);
3076 if (!arg->has_mode) {
3077 arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3080 if (!arg->format) {
3081 format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3082 ? NULL : bs->drv->format_name);
3085 flags = bs->open_flags | BDRV_O_RDWR;
3086 target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
3087 if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
3088 arg->sync = MIRROR_SYNC_MODE_FULL;
3090 if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3091 target_backing_bs = bs;
3094 size = bdrv_getlength(bs);
3095 if (size < 0) {
3096 error_setg_errno(errp, -size, "bdrv_getlength failed");
3097 goto out;
3100 if (arg->replaces) {
3101 if (!arg->node_name) {
3102 error_setg(errp, "a node-name must be provided when replacing a"
3103 " named node of the graph");
3104 goto out;
3108 if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3109 backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3110 } else {
3111 backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3114 /* Don't open backing image in create() */
3115 flags |= BDRV_O_NO_BACKING;
3117 if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
3118 && arg->mode != NEW_IMAGE_MODE_EXISTING)
3120 /* create new image w/o backing file */
3121 assert(format);
3122 bdrv_img_create(arg->target, format,
3123 NULL, NULL, NULL, size, flags, false, &local_err);
3124 } else {
3125 /* Implicit filters should not appear in the filename */
3126 BlockDriverState *explicit_backing =
3127 bdrv_skip_implicit_filters(target_backing_bs);
3129 switch (arg->mode) {
3130 case NEW_IMAGE_MODE_EXISTING:
3131 break;
3132 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3133 /* create new image with backing file */
3134 bdrv_refresh_filename(explicit_backing);
3135 bdrv_img_create(arg->target, format,
3136 explicit_backing->filename,
3137 explicit_backing->drv->format_name,
3138 NULL, size, flags, false, &local_err);
3139 break;
3140 default:
3141 abort();
3145 if (local_err) {
3146 error_propagate(errp, local_err);
3147 goto out;
3150 options = qdict_new();
3151 if (arg->node_name) {
3152 qdict_put_str(options, "node-name", arg->node_name);
3154 if (format) {
3155 qdict_put_str(options, "driver", format);
3158 /* Mirroring takes care of copy-on-write using the source's backing
3159 * file.
3161 target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
3162 if (!target_bs) {
3163 goto out;
3166 zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3167 (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3168 !bdrv_has_zero_init(target_bs)));
3171 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
3172 old_context = bdrv_get_aio_context(target_bs);
3173 aio_context_release(aio_context);
3174 aio_context_acquire(old_context);
3176 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
3177 if (ret < 0) {
3178 bdrv_unref(target_bs);
3179 aio_context_release(old_context);
3180 return;
3183 aio_context_release(old_context);
3184 aio_context_acquire(aio_context);
3186 blockdev_mirror_common(arg->job_id, bs, target_bs,
3187 arg->replaces, arg->sync,
3188 backing_mode, zero_target,
3189 arg->has_speed, arg->speed,
3190 arg->has_granularity, arg->granularity,
3191 arg->has_buf_size, arg->buf_size,
3192 arg->has_on_source_error, arg->on_source_error,
3193 arg->has_on_target_error, arg->on_target_error,
3194 arg->has_unmap, arg->unmap,
3195 NULL,
3196 arg->has_copy_mode, arg->copy_mode,
3197 arg->has_auto_finalize, arg->auto_finalize,
3198 arg->has_auto_dismiss, arg->auto_dismiss,
3199 errp);
3200 bdrv_unref(target_bs);
3201 out:
3202 aio_context_release(aio_context);
3205 void qmp_blockdev_mirror(const char *job_id,
3206 const char *device, const char *target,
3207 const char *replaces,
3208 MirrorSyncMode sync,
3209 bool has_speed, int64_t speed,
3210 bool has_granularity, uint32_t granularity,
3211 bool has_buf_size, int64_t buf_size,
3212 bool has_on_source_error,
3213 BlockdevOnError on_source_error,
3214 bool has_on_target_error,
3215 BlockdevOnError on_target_error,
3216 const char *filter_node_name,
3217 bool has_copy_mode, MirrorCopyMode copy_mode,
3218 bool has_auto_finalize, bool auto_finalize,
3219 bool has_auto_dismiss, bool auto_dismiss,
3220 Error **errp)
3222 BlockDriverState *bs;
3223 BlockDriverState *target_bs;
3224 AioContext *aio_context;
3225 AioContext *old_context;
3226 BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3227 bool zero_target;
3228 int ret;
3230 bs = qmp_get_root_bs(device, errp);
3231 if (!bs) {
3232 return;
3235 target_bs = bdrv_lookup_bs(target, target, errp);
3236 if (!target_bs) {
3237 return;
3240 zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3242 /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
3243 old_context = bdrv_get_aio_context(target_bs);
3244 aio_context = bdrv_get_aio_context(bs);
3245 aio_context_acquire(old_context);
3247 ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
3249 aio_context_release(old_context);
3250 aio_context_acquire(aio_context);
3252 if (ret < 0) {
3253 goto out;
3256 blockdev_mirror_common(job_id, bs, target_bs,
3257 replaces, sync, backing_mode,
3258 zero_target, has_speed, speed,
3259 has_granularity, granularity,
3260 has_buf_size, buf_size,
3261 has_on_source_error, on_source_error,
3262 has_on_target_error, on_target_error,
3263 true, true, filter_node_name,
3264 has_copy_mode, copy_mode,
3265 has_auto_finalize, auto_finalize,
3266 has_auto_dismiss, auto_dismiss,
3267 errp);
3268 out:
3269 aio_context_release(aio_context);
3273 * Get a block job using its ID. Called with job_mutex held.
3275 static BlockJob *find_block_job_locked(const char *id, Error **errp)
3277 BlockJob *job;
3279 assert(id != NULL);
3281 job = block_job_get_locked(id);
3283 if (!job) {
3284 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3285 "Block job '%s' not found", id);
3286 return NULL;
3289 return job;
3292 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3294 BlockJob *job;
3296 JOB_LOCK_GUARD();
3297 job = find_block_job_locked(device, errp);
3299 if (!job) {
3300 return;
3303 block_job_set_speed_locked(job, speed, errp);
3306 void qmp_block_job_cancel(const char *device,
3307 bool has_force, bool force, Error **errp)
3309 BlockJob *job;
3311 JOB_LOCK_GUARD();
3312 job = find_block_job_locked(device, errp);
3314 if (!job) {
3315 return;
3318 if (!has_force) {
3319 force = false;
3322 if (job_user_paused_locked(&job->job) && !force) {
3323 error_setg(errp, "The block job for device '%s' is currently paused",
3324 device);
3325 return;
3328 trace_qmp_block_job_cancel(job);
3329 job_user_cancel_locked(&job->job, force, errp);
3332 void qmp_block_job_pause(const char *device, Error **errp)
3334 BlockJob *job;
3336 JOB_LOCK_GUARD();
3337 job = find_block_job_locked(device, errp);
3339 if (!job) {
3340 return;
3343 trace_qmp_block_job_pause(job);
3344 job_user_pause_locked(&job->job, errp);
3347 void qmp_block_job_resume(const char *device, Error **errp)
3349 BlockJob *job;
3351 JOB_LOCK_GUARD();
3352 job = find_block_job_locked(device, errp);
3354 if (!job) {
3355 return;
3358 trace_qmp_block_job_resume(job);
3359 job_user_resume_locked(&job->job, errp);
3362 void qmp_block_job_complete(const char *device, Error **errp)
3364 BlockJob *job;
3366 JOB_LOCK_GUARD();
3367 job = find_block_job_locked(device, errp);
3369 if (!job) {
3370 return;
3373 trace_qmp_block_job_complete(job);
3374 job_complete_locked(&job->job, errp);
3377 void qmp_block_job_finalize(const char *id, Error **errp)
3379 BlockJob *job;
3381 JOB_LOCK_GUARD();
3382 job = find_block_job_locked(id, errp);
3384 if (!job) {
3385 return;
3388 trace_qmp_block_job_finalize(job);
3389 job_ref_locked(&job->job);
3390 job_finalize_locked(&job->job, errp);
3392 job_unref_locked(&job->job);
3395 void qmp_block_job_dismiss(const char *id, Error **errp)
3397 BlockJob *bjob;
3398 Job *job;
3400 JOB_LOCK_GUARD();
3401 bjob = find_block_job_locked(id, errp);
3403 if (!bjob) {
3404 return;
3407 trace_qmp_block_job_dismiss(bjob);
3408 job = &bjob->job;
3409 job_dismiss_locked(&job, errp);
3412 void qmp_change_backing_file(const char *device,
3413 const char *image_node_name,
3414 const char *backing_file,
3415 Error **errp)
3417 BlockDriverState *bs = NULL;
3418 AioContext *aio_context;
3419 BlockDriverState *image_bs = NULL;
3420 Error *local_err = NULL;
3421 bool ro;
3422 int ret;
3424 bs = qmp_get_root_bs(device, errp);
3425 if (!bs) {
3426 return;
3429 aio_context = bdrv_get_aio_context(bs);
3430 aio_context_acquire(aio_context);
3432 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3433 if (local_err) {
3434 error_propagate(errp, local_err);
3435 goto out;
3438 if (!image_bs) {
3439 error_setg(errp, "image file not found");
3440 goto out;
3443 if (bdrv_find_base(image_bs) == image_bs) {
3444 error_setg(errp, "not allowing backing file change on an image "
3445 "without a backing file");
3446 goto out;
3449 /* even though we are not necessarily operating on bs, we need it to
3450 * determine if block ops are currently prohibited on the chain */
3451 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3452 goto out;
3455 /* final sanity check */
3456 if (!bdrv_chain_contains(bs, image_bs)) {
3457 error_setg(errp, "'%s' and image file are not in the same chain",
3458 device);
3459 goto out;
3462 /* if not r/w, reopen to make r/w */
3463 ro = bdrv_is_read_only(image_bs);
3465 if (ro) {
3466 if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
3467 goto out;
3471 ret = bdrv_change_backing_file(image_bs, backing_file,
3472 image_bs->drv ? image_bs->drv->format_name : "",
3473 false);
3475 if (ret < 0) {
3476 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3477 backing_file);
3478 /* don't exit here, so we can try to restore open flags if
3479 * appropriate */
3482 if (ro) {
3483 bdrv_reopen_set_read_only(image_bs, true, errp);
3486 out:
3487 aio_context_release(aio_context);
3490 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3492 BlockDriverState *bs;
3493 QObject *obj;
3494 Visitor *v = qobject_output_visitor_new(&obj);
3495 QDict *qdict;
3497 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3498 visit_complete(v, &obj);
3499 qdict = qobject_to(QDict, obj);
3501 qdict_flatten(qdict);
3503 if (!qdict_get_try_str(qdict, "node-name")) {
3504 error_setg(errp, "'node-name' must be specified for the root node");
3505 goto fail;
3508 bs = bds_tree_init(qdict, errp);
3509 if (!bs) {
3510 goto fail;
3513 bdrv_set_monitor_owned(bs);
3515 fail:
3516 visit_free(v);
3519 void qmp_blockdev_reopen(BlockdevOptionsList *reopen_list, Error **errp)
3521 BlockReopenQueue *queue = NULL;
3523 /* Add each one of the BDS that we want to reopen to the queue */
3524 for (; reopen_list != NULL; reopen_list = reopen_list->next) {
3525 BlockdevOptions *options = reopen_list->value;
3526 BlockDriverState *bs;
3527 AioContext *ctx;
3528 QObject *obj;
3529 Visitor *v;
3530 QDict *qdict;
3532 /* Check for the selected node name */
3533 if (!options->node_name) {
3534 error_setg(errp, "node-name not specified");
3535 goto fail;
3538 bs = bdrv_find_node(options->node_name);
3539 if (!bs) {
3540 error_setg(errp, "Failed to find node with node-name='%s'",
3541 options->node_name);
3542 goto fail;
3545 /* Put all options in a QDict and flatten it */
3546 v = qobject_output_visitor_new(&obj);
3547 visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3548 visit_complete(v, &obj);
3549 visit_free(v);
3551 qdict = qobject_to(QDict, obj);
3553 qdict_flatten(qdict);
3555 ctx = bdrv_get_aio_context(bs);
3556 aio_context_acquire(ctx);
3558 queue = bdrv_reopen_queue(queue, bs, qdict, false);
3560 aio_context_release(ctx);
3563 /* Perform the reopen operation */
3564 bdrv_reopen_multiple(queue, errp);
3565 queue = NULL;
3567 fail:
3568 bdrv_reopen_queue_free(queue);
3571 void qmp_blockdev_del(const char *node_name, Error **errp)
3573 AioContext *aio_context;
3574 BlockDriverState *bs;
3576 GLOBAL_STATE_CODE();
3578 bs = bdrv_find_node(node_name);
3579 if (!bs) {
3580 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
3581 return;
3583 if (bdrv_has_blk(bs)) {
3584 error_setg(errp, "Node %s is in use", node_name);
3585 return;
3587 aio_context = bdrv_get_aio_context(bs);
3588 aio_context_acquire(aio_context);
3590 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3591 goto out;
3594 if (!QTAILQ_IN_USE(bs, monitor_list)) {
3595 error_setg(errp, "Node %s is not owned by the monitor",
3596 bs->node_name);
3597 goto out;
3600 if (bs->refcnt > 1) {
3601 error_setg(errp, "Block device %s is in use",
3602 bdrv_get_device_or_node_name(bs));
3603 goto out;
3606 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3607 bdrv_unref(bs);
3609 out:
3610 aio_context_release(aio_context);
3613 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3614 const char *child_name)
3616 BdrvChild *child;
3618 QLIST_FOREACH(child, &parent_bs->children, next) {
3619 if (strcmp(child->name, child_name) == 0) {
3620 return child;
3624 return NULL;
3627 void qmp_x_blockdev_change(const char *parent, const char *child,
3628 const char *node, Error **errp)
3630 BlockDriverState *parent_bs, *new_bs = NULL;
3631 BdrvChild *p_child;
3633 parent_bs = bdrv_lookup_bs(parent, parent, errp);
3634 if (!parent_bs) {
3635 return;
3638 if (!child == !node) {
3639 if (child) {
3640 error_setg(errp, "The parameters child and node are in conflict");
3641 } else {
3642 error_setg(errp, "Either child or node must be specified");
3644 return;
3647 if (child) {
3648 p_child = bdrv_find_child(parent_bs, child);
3649 if (!p_child) {
3650 error_setg(errp, "Node '%s' does not have child '%s'",
3651 parent, child);
3652 return;
3654 bdrv_del_child(parent_bs, p_child, errp);
3657 if (node) {
3658 new_bs = bdrv_find_node(node);
3659 if (!new_bs) {
3660 error_setg(errp, "Node '%s' not found", node);
3661 return;
3663 bdrv_add_child(parent_bs, new_bs, errp);
3667 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3669 BlockJobInfoList *head = NULL, **tail = &head;
3670 BlockJob *job;
3672 JOB_LOCK_GUARD();
3674 for (job = block_job_next_locked(NULL); job;
3675 job = block_job_next_locked(job)) {
3676 BlockJobInfo *value;
3678 if (block_job_is_internal(job)) {
3679 continue;
3681 value = block_job_query_locked(job, errp);
3682 if (!value) {
3683 qapi_free_BlockJobInfoList(head);
3684 return NULL;
3686 QAPI_LIST_APPEND(tail, value);
3689 return head;
3692 void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
3693 bool has_force, bool force, Error **errp)
3695 AioContext *old_context;
3696 AioContext *new_context;
3697 BlockDriverState *bs;
3699 bs = bdrv_find_node(node_name);
3700 if (!bs) {
3701 error_setg(errp, "Failed to find node with node-name='%s'", node_name);
3702 return;
3705 /* Protects against accidents. */
3706 if (!(has_force && force) && bdrv_has_blk(bs)) {
3707 error_setg(errp, "Node %s is associated with a BlockBackend and could "
3708 "be in use (use force=true to override this check)",
3709 node_name);
3710 return;
3713 if (iothread->type == QTYPE_QSTRING) {
3714 IOThread *obj = iothread_by_id(iothread->u.s);
3715 if (!obj) {
3716 error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3717 return;
3720 new_context = iothread_get_aio_context(obj);
3721 } else {
3722 new_context = qemu_get_aio_context();
3725 old_context = bdrv_get_aio_context(bs);
3726 aio_context_acquire(old_context);
3728 bdrv_try_change_aio_context(bs, new_context, NULL, errp);
3730 aio_context_release(old_context);
3733 QemuOptsList qemu_common_drive_opts = {
3734 .name = "drive",
3735 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3736 .desc = {
3738 .name = "snapshot",
3739 .type = QEMU_OPT_BOOL,
3740 .help = "enable/disable snapshot mode",
3742 .name = "aio",
3743 .type = QEMU_OPT_STRING,
3744 .help = "host AIO implementation (threads, native, io_uring)",
3746 .name = BDRV_OPT_CACHE_WB,
3747 .type = QEMU_OPT_BOOL,
3748 .help = "Enable writeback mode",
3750 .name = "format",
3751 .type = QEMU_OPT_STRING,
3752 .help = "disk format (raw, qcow2, ...)",
3754 .name = "rerror",
3755 .type = QEMU_OPT_STRING,
3756 .help = "read error action",
3758 .name = "werror",
3759 .type = QEMU_OPT_STRING,
3760 .help = "write error action",
3762 .name = BDRV_OPT_READ_ONLY,
3763 .type = QEMU_OPT_BOOL,
3764 .help = "open drive file as read-only",
3767 THROTTLE_OPTS,
3770 .name = "throttling.group",
3771 .type = QEMU_OPT_STRING,
3772 .help = "name of the block throttling group",
3774 .name = "copy-on-read",
3775 .type = QEMU_OPT_BOOL,
3776 .help = "copy read data from backing file into image file",
3778 .name = "detect-zeroes",
3779 .type = QEMU_OPT_STRING,
3780 .help = "try to optimize zero writes (off, on, unmap)",
3782 .name = "stats-account-invalid",
3783 .type = QEMU_OPT_BOOL,
3784 .help = "whether to account for invalid I/O operations "
3785 "in the statistics",
3787 .name = "stats-account-failed",
3788 .type = QEMU_OPT_BOOL,
3789 .help = "whether to account for failed I/O operations "
3790 "in the statistics",
3792 { /* end of list */ }
3796 QemuOptsList qemu_drive_opts = {
3797 .name = "drive",
3798 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3799 .desc = {
3801 * no elements => accept any params
3802 * validation will happen later
3804 { /* end of list */ }