i386: kvmvapic: initialise imm32 variable
[qemu/ar7.git] / blockdev.c
blob40e4e6fc6ff62405fb65aa27ea4faaaac90f6bdd
1 /*
2 * QEMU host block devices
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * This work is licensed under the terms of the GNU GPL, version 2 or
7 * later. See the COPYING file in the top-level directory.
9 * This file incorporates work covered by the following copyright and
10 * permission notice:
12 * Copyright (c) 2003-2008 Fabrice Bellard
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
30 * THE SOFTWARE.
33 #include "qemu/osdep.h"
34 #include "sysemu/block-backend.h"
35 #include "sysemu/blockdev.h"
36 #include "hw/block/block.h"
37 #include "block/blockjob.h"
38 #include "block/throttle-groups.h"
39 #include "monitor/monitor.h"
40 #include "qemu/error-report.h"
41 #include "qemu/option.h"
42 #include "qemu/config-file.h"
43 #include "qapi/qmp/types.h"
44 #include "qapi-visit.h"
45 #include "qapi/qmp/qerror.h"
46 #include "qapi/qmp-output-visitor.h"
47 #include "qapi/util.h"
48 #include "sysemu/sysemu.h"
49 #include "block/block_int.h"
50 #include "qmp-commands.h"
51 #include "trace.h"
52 #include "sysemu/arch_init.h"
53 #include "qemu/cutils.h"
54 #include "qemu/help_option.h"
56 static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
57 QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
59 static const char *const if_name[IF_COUNT] = {
60 [IF_NONE] = "none",
61 [IF_IDE] = "ide",
62 [IF_SCSI] = "scsi",
63 [IF_FLOPPY] = "floppy",
64 [IF_PFLASH] = "pflash",
65 [IF_MTD] = "mtd",
66 [IF_SD] = "sd",
67 [IF_VIRTIO] = "virtio",
68 [IF_XEN] = "xen",
71 static int if_max_devs[IF_COUNT] = {
73 * Do not change these numbers! They govern how drive option
74 * index maps to unit and bus. That mapping is ABI.
76 * All controllers used to implement if=T drives need to support
77 * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
78 * Otherwise, some index values map to "impossible" bus, unit
79 * values.
81 * For instance, if you change [IF_SCSI] to 255, -drive
82 * if=scsi,index=12 no longer means bus=1,unit=5, but
83 * bus=0,unit=12. With an lsi53c895a controller (7 units max),
84 * the drive can't be set up. Regression.
86 [IF_IDE] = 2,
87 [IF_SCSI] = 7,
90 /**
91 * Boards may call this to offer board-by-board overrides
92 * of the default, global values.
94 void override_max_devs(BlockInterfaceType type, int max_devs)
96 BlockBackend *blk;
97 DriveInfo *dinfo;
99 if (max_devs <= 0) {
100 return;
103 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
104 dinfo = blk_legacy_dinfo(blk);
105 if (dinfo->type == type) {
106 fprintf(stderr, "Cannot override units-per-bus property of"
107 " the %s interface, because a drive of that type has"
108 " already been added.\n", if_name[type]);
109 g_assert_not_reached();
113 if_max_devs[type] = max_devs;
117 * We automatically delete the drive when a device using it gets
118 * unplugged. Questionable feature, but we can't just drop it.
119 * Device models call blockdev_mark_auto_del() to schedule the
120 * automatic deletion, and generic qdev code calls blockdev_auto_del()
121 * when deletion is actually safe.
123 void blockdev_mark_auto_del(BlockBackend *blk)
125 DriveInfo *dinfo = blk_legacy_dinfo(blk);
126 BlockDriverState *bs = blk_bs(blk);
127 AioContext *aio_context;
129 if (!dinfo) {
130 return;
133 if (bs) {
134 aio_context = bdrv_get_aio_context(bs);
135 aio_context_acquire(aio_context);
137 if (bs->job) {
138 block_job_cancel(bs->job);
141 aio_context_release(aio_context);
144 dinfo->auto_del = 1;
147 void blockdev_auto_del(BlockBackend *blk)
149 DriveInfo *dinfo = blk_legacy_dinfo(blk);
151 if (dinfo && dinfo->auto_del) {
152 monitor_remove_blk(blk);
153 blk_unref(blk);
158 * Returns the current mapping of how many units per bus
159 * a particular interface can support.
161 * A positive integer indicates n units per bus.
162 * 0 implies the mapping has not been established.
163 * -1 indicates an invalid BlockInterfaceType was given.
165 int drive_get_max_devs(BlockInterfaceType type)
167 if (type >= IF_IDE && type < IF_COUNT) {
168 return if_max_devs[type];
171 return -1;
174 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
176 int max_devs = if_max_devs[type];
177 return max_devs ? index / max_devs : 0;
180 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
182 int max_devs = if_max_devs[type];
183 return max_devs ? index % max_devs : index;
186 QemuOpts *drive_def(const char *optstr)
188 return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
191 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
192 const char *optstr)
194 QemuOpts *opts;
196 opts = drive_def(optstr);
197 if (!opts) {
198 return NULL;
200 if (type != IF_DEFAULT) {
201 qemu_opt_set(opts, "if", if_name[type], &error_abort);
203 if (index >= 0) {
204 qemu_opt_set_number(opts, "index", index, &error_abort);
206 if (file)
207 qemu_opt_set(opts, "file", file, &error_abort);
208 return opts;
211 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
213 BlockBackend *blk;
214 DriveInfo *dinfo;
216 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
217 dinfo = blk_legacy_dinfo(blk);
218 if (dinfo && dinfo->type == type
219 && dinfo->bus == bus && dinfo->unit == unit) {
220 return dinfo;
224 return NULL;
227 bool drive_check_orphaned(void)
229 BlockBackend *blk;
230 DriveInfo *dinfo;
231 bool rs = false;
233 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
234 dinfo = blk_legacy_dinfo(blk);
235 /* If dinfo->bdrv->dev is NULL, it has no device attached. */
236 /* Unless this is a default drive, this may be an oversight. */
237 if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
238 dinfo->type != IF_NONE) {
239 fprintf(stderr, "Warning: Orphaned drive without device: "
240 "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
241 blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
242 if_name[dinfo->type], dinfo->bus, dinfo->unit);
243 rs = true;
247 return rs;
250 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
252 return drive_get(type,
253 drive_index_to_bus_id(type, index),
254 drive_index_to_unit_id(type, index));
257 int drive_get_max_bus(BlockInterfaceType type)
259 int max_bus;
260 BlockBackend *blk;
261 DriveInfo *dinfo;
263 max_bus = -1;
264 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
265 dinfo = blk_legacy_dinfo(blk);
266 if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
267 max_bus = dinfo->bus;
270 return max_bus;
273 /* Get a block device. This should only be used for single-drive devices
274 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
275 appropriate bus. */
276 DriveInfo *drive_get_next(BlockInterfaceType type)
278 static int next_block_unit[IF_COUNT];
280 return drive_get(type, 0, next_block_unit[type]++);
283 static void bdrv_format_print(void *opaque, const char *name)
285 error_printf(" %s", name);
288 typedef struct {
289 QEMUBH *bh;
290 BlockDriverState *bs;
291 } BDRVPutRefBH;
293 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
295 if (!strcmp(buf, "ignore")) {
296 return BLOCKDEV_ON_ERROR_IGNORE;
297 } else if (!is_read && !strcmp(buf, "enospc")) {
298 return BLOCKDEV_ON_ERROR_ENOSPC;
299 } else if (!strcmp(buf, "stop")) {
300 return BLOCKDEV_ON_ERROR_STOP;
301 } else if (!strcmp(buf, "report")) {
302 return BLOCKDEV_ON_ERROR_REPORT;
303 } else {
304 error_setg(errp, "'%s' invalid %s error action",
305 buf, is_read ? "read" : "write");
306 return -1;
310 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
311 Error **errp)
313 const QListEntry *entry;
314 for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
315 switch (qobject_type(entry->value)) {
317 case QTYPE_QSTRING: {
318 unsigned long long length;
319 const char *str = qstring_get_str(qobject_to_qstring(entry->value));
320 if (parse_uint_full(str, &length, 10) == 0 &&
321 length > 0 && length <= UINT_MAX) {
322 block_acct_add_interval(stats, (unsigned) length);
323 } else {
324 error_setg(errp, "Invalid interval length: %s", str);
325 return false;
327 break;
330 case QTYPE_QINT: {
331 int64_t length = qint_get_int(qobject_to_qint(entry->value));
332 if (length > 0 && length <= UINT_MAX) {
333 block_acct_add_interval(stats, (unsigned) length);
334 } else {
335 error_setg(errp, "Invalid interval length: %" PRId64, length);
336 return false;
338 break;
341 default:
342 error_setg(errp, "The specification of stats-intervals is invalid");
343 return false;
346 return true;
349 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
351 /* All parameters but @opts are optional and may be set to NULL. */
352 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
353 const char **throttling_group, ThrottleConfig *throttle_cfg,
354 BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
356 const char *discard;
357 Error *local_error = NULL;
358 const char *aio;
360 if (bdrv_flags) {
361 if (!qemu_opt_get_bool(opts, "read-only", false)) {
362 *bdrv_flags |= BDRV_O_RDWR;
364 if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
365 *bdrv_flags |= BDRV_O_COPY_ON_READ;
368 if ((discard = qemu_opt_get(opts, "discard")) != NULL) {
369 if (bdrv_parse_discard_flags(discard, bdrv_flags) != 0) {
370 error_setg(errp, "Invalid discard option");
371 return;
375 if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
376 if (!strcmp(aio, "native")) {
377 *bdrv_flags |= BDRV_O_NATIVE_AIO;
378 } else if (!strcmp(aio, "threads")) {
379 /* this is the default */
380 } else {
381 error_setg(errp, "invalid aio option");
382 return;
387 /* disk I/O throttling */
388 if (throttling_group) {
389 *throttling_group = qemu_opt_get(opts, "throttling.group");
392 if (throttle_cfg) {
393 throttle_config_init(throttle_cfg);
394 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
395 qemu_opt_get_number(opts, "throttling.bps-total", 0);
396 throttle_cfg->buckets[THROTTLE_BPS_READ].avg =
397 qemu_opt_get_number(opts, "throttling.bps-read", 0);
398 throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
399 qemu_opt_get_number(opts, "throttling.bps-write", 0);
400 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
401 qemu_opt_get_number(opts, "throttling.iops-total", 0);
402 throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
403 qemu_opt_get_number(opts, "throttling.iops-read", 0);
404 throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
405 qemu_opt_get_number(opts, "throttling.iops-write", 0);
407 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
408 qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
409 throttle_cfg->buckets[THROTTLE_BPS_READ].max =
410 qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
411 throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
412 qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
413 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
414 qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
415 throttle_cfg->buckets[THROTTLE_OPS_READ].max =
416 qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
417 throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
418 qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
420 throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
421 qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
422 throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length =
423 qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
424 throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
425 qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
426 throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
427 qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
428 throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
429 qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
430 throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
431 qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
433 throttle_cfg->op_size =
434 qemu_opt_get_number(opts, "throttling.iops-size", 0);
436 if (!throttle_is_valid(throttle_cfg, errp)) {
437 return;
441 if (detect_zeroes) {
442 *detect_zeroes =
443 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
444 qemu_opt_get(opts, "detect-zeroes"),
445 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
446 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
447 &local_error);
448 if (local_error) {
449 error_propagate(errp, local_error);
450 return;
453 if (bdrv_flags &&
454 *detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
455 !(*bdrv_flags & BDRV_O_UNMAP))
457 error_setg(errp, "setting detect-zeroes to unmap is not allowed "
458 "without setting discard operation to unmap");
459 return;
464 /* Takes the ownership of bs_opts */
465 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
466 Error **errp)
468 const char *buf;
469 int bdrv_flags = 0;
470 int on_read_error, on_write_error;
471 bool account_invalid, account_failed;
472 bool writethrough;
473 BlockBackend *blk;
474 BlockDriverState *bs;
475 ThrottleConfig cfg;
476 int snapshot = 0;
477 Error *error = NULL;
478 QemuOpts *opts;
479 QDict *interval_dict = NULL;
480 QList *interval_list = NULL;
481 const char *id;
482 BlockdevDetectZeroesOptions detect_zeroes =
483 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
484 const char *throttling_group = NULL;
486 /* Check common options by copying from bs_opts to opts, all other options
487 * stay in bs_opts for processing by bdrv_open(). */
488 id = qdict_get_try_str(bs_opts, "id");
489 opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
490 if (error) {
491 error_propagate(errp, error);
492 goto err_no_opts;
495 qemu_opts_absorb_qdict(opts, bs_opts, &error);
496 if (error) {
497 error_propagate(errp, error);
498 goto early_err;
501 if (id) {
502 qdict_del(bs_opts, "id");
505 /* extract parameters */
506 snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
508 account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
509 account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
511 writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
513 qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
514 qdict_array_split(interval_dict, &interval_list);
516 if (qdict_size(interval_dict) != 0) {
517 error_setg(errp, "Invalid option stats-intervals.%s",
518 qdict_first(interval_dict)->key);
519 goto early_err;
522 extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
523 &detect_zeroes, &error);
524 if (error) {
525 error_propagate(errp, error);
526 goto early_err;
529 if ((buf = qemu_opt_get(opts, "format")) != NULL) {
530 if (is_help_option(buf)) {
531 error_printf("Supported formats:");
532 bdrv_iterate_format(bdrv_format_print, NULL);
533 error_printf("\n");
534 goto early_err;
537 if (qdict_haskey(bs_opts, "driver")) {
538 error_setg(errp, "Cannot specify both 'driver' and 'format'");
539 goto early_err;
541 qdict_put(bs_opts, "driver", qstring_from_str(buf));
544 on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
545 if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
546 on_write_error = parse_block_error_action(buf, 0, &error);
547 if (error) {
548 error_propagate(errp, error);
549 goto early_err;
553 on_read_error = BLOCKDEV_ON_ERROR_REPORT;
554 if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
555 on_read_error = parse_block_error_action(buf, 1, &error);
556 if (error) {
557 error_propagate(errp, error);
558 goto early_err;
562 if (snapshot) {
563 bdrv_flags |= BDRV_O_SNAPSHOT;
566 /* init */
567 if ((!file || !*file) && !qdict_size(bs_opts)) {
568 BlockBackendRootState *blk_rs;
570 blk = blk_new(errp);
571 if (!blk) {
572 goto early_err;
575 blk_rs = blk_get_root_state(blk);
576 blk_rs->open_flags = bdrv_flags;
577 blk_rs->read_only = !(bdrv_flags & BDRV_O_RDWR);
578 blk_rs->detect_zeroes = detect_zeroes;
580 QDECREF(bs_opts);
581 } else {
582 if (file && !*file) {
583 file = NULL;
586 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
587 * with other callers) rather than what we want as the real defaults.
588 * Apply the defaults here instead. */
589 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
590 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
591 assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
593 if (runstate_check(RUN_STATE_INMIGRATE)) {
594 bdrv_flags |= BDRV_O_INACTIVE;
597 blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
598 if (!blk) {
599 goto err_no_bs_opts;
601 bs = blk_bs(blk);
603 bs->detect_zeroes = detect_zeroes;
605 if (bdrv_key_required(bs)) {
606 autostart = 0;
609 block_acct_init(blk_get_stats(blk), account_invalid, account_failed);
611 if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
612 blk_unref(blk);
613 blk = NULL;
614 goto err_no_bs_opts;
618 /* disk I/O throttling */
619 if (throttle_enabled(&cfg)) {
620 if (!throttling_group) {
621 throttling_group = blk_name(blk);
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, qemu_opts_id(opts), errp)) {
631 blk_unref(blk);
632 blk = NULL;
633 goto err_no_bs_opts;
636 err_no_bs_opts:
637 qemu_opts_del(opts);
638 QDECREF(interval_dict);
639 QDECREF(interval_list);
640 return blk;
642 early_err:
643 qemu_opts_del(opts);
644 QDECREF(interval_dict);
645 QDECREF(interval_list);
646 err_no_opts:
647 QDECREF(bs_opts);
648 return NULL;
651 static QemuOptsList qemu_root_bds_opts;
653 /* Takes the ownership of bs_opts */
654 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
656 BlockDriverState *bs;
657 QemuOpts *opts;
658 Error *local_error = NULL;
659 BlockdevDetectZeroesOptions detect_zeroes;
660 int ret;
661 int bdrv_flags = 0;
663 opts = qemu_opts_create(&qemu_root_bds_opts, NULL, 1, errp);
664 if (!opts) {
665 goto fail;
668 qemu_opts_absorb_qdict(opts, bs_opts, &local_error);
669 if (local_error) {
670 error_propagate(errp, local_error);
671 goto fail;
674 extract_common_blockdev_options(opts, &bdrv_flags, NULL, NULL,
675 &detect_zeroes, &local_error);
676 if (local_error) {
677 error_propagate(errp, local_error);
678 goto fail;
681 /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
682 * with other callers) rather than what we want as the real defaults.
683 * Apply the defaults here instead. */
684 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
685 qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
687 if (runstate_check(RUN_STATE_INMIGRATE)) {
688 bdrv_flags |= BDRV_O_INACTIVE;
691 bs = NULL;
692 ret = bdrv_open(&bs, NULL, NULL, bs_opts, bdrv_flags, errp);
693 if (ret < 0) {
694 goto fail_no_bs_opts;
697 bs->detect_zeroes = detect_zeroes;
699 fail_no_bs_opts:
700 qemu_opts_del(opts);
701 return bs;
703 fail:
704 qemu_opts_del(opts);
705 QDECREF(bs_opts);
706 return NULL;
709 void blockdev_close_all_bdrv_states(void)
711 BlockDriverState *bs, *next_bs;
713 QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
714 AioContext *ctx = bdrv_get_aio_context(bs);
716 aio_context_acquire(ctx);
717 bdrv_unref(bs);
718 aio_context_release(ctx);
722 /* Iterates over the list of monitor-owned BlockDriverStates */
723 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
725 return bs ? QTAILQ_NEXT(bs, monitor_list)
726 : QTAILQ_FIRST(&monitor_bdrv_states);
729 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
730 Error **errp)
732 const char *value;
734 value = qemu_opt_get(opts, from);
735 if (value) {
736 if (qemu_opt_find(opts, to)) {
737 error_setg(errp, "'%s' and its alias '%s' can't be used at the "
738 "same time", to, from);
739 return;
743 /* rename all items in opts */
744 while ((value = qemu_opt_get(opts, from))) {
745 qemu_opt_set(opts, to, value, &error_abort);
746 qemu_opt_unset(opts, from);
750 QemuOptsList qemu_legacy_drive_opts = {
751 .name = "drive",
752 .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
753 .desc = {
755 .name = "bus",
756 .type = QEMU_OPT_NUMBER,
757 .help = "bus number",
759 .name = "unit",
760 .type = QEMU_OPT_NUMBER,
761 .help = "unit number (i.e. lun for scsi)",
763 .name = "index",
764 .type = QEMU_OPT_NUMBER,
765 .help = "index number",
767 .name = "media",
768 .type = QEMU_OPT_STRING,
769 .help = "media type (disk, cdrom)",
771 .name = "if",
772 .type = QEMU_OPT_STRING,
773 .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
775 .name = "cyls",
776 .type = QEMU_OPT_NUMBER,
777 .help = "number of cylinders (ide disk geometry)",
779 .name = "heads",
780 .type = QEMU_OPT_NUMBER,
781 .help = "number of heads (ide disk geometry)",
783 .name = "secs",
784 .type = QEMU_OPT_NUMBER,
785 .help = "number of sectors (ide disk geometry)",
787 .name = "trans",
788 .type = QEMU_OPT_STRING,
789 .help = "chs translation (auto, lba, none)",
791 .name = "boot",
792 .type = QEMU_OPT_BOOL,
793 .help = "(deprecated, ignored)",
795 .name = "addr",
796 .type = QEMU_OPT_STRING,
797 .help = "pci address (virtio only)",
799 .name = "serial",
800 .type = QEMU_OPT_STRING,
801 .help = "disk serial number",
803 .name = "file",
804 .type = QEMU_OPT_STRING,
805 .help = "file name",
808 /* Options that are passed on, but have special semantics with -drive */
810 .name = "read-only",
811 .type = QEMU_OPT_BOOL,
812 .help = "open drive file as read-only",
814 .name = "rerror",
815 .type = QEMU_OPT_STRING,
816 .help = "read error action",
818 .name = "werror",
819 .type = QEMU_OPT_STRING,
820 .help = "write error action",
822 .name = "copy-on-read",
823 .type = QEMU_OPT_BOOL,
824 .help = "copy read data from backing file into image file",
827 { /* end of list */ }
831 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
833 const char *value;
834 BlockBackend *blk;
835 DriveInfo *dinfo = NULL;
836 QDict *bs_opts;
837 QemuOpts *legacy_opts;
838 DriveMediaType media = MEDIA_DISK;
839 BlockInterfaceType type;
840 int cyls, heads, secs, translation;
841 int max_devs, bus_id, unit_id, index;
842 const char *devaddr;
843 const char *werror, *rerror;
844 bool read_only = false;
845 bool copy_on_read;
846 const char *serial;
847 const char *filename;
848 Error *local_err = NULL;
849 int i;
851 /* Change legacy command line options into QMP ones */
852 static const struct {
853 const char *from;
854 const char *to;
855 } opt_renames[] = {
856 { "iops", "throttling.iops-total" },
857 { "iops_rd", "throttling.iops-read" },
858 { "iops_wr", "throttling.iops-write" },
860 { "bps", "throttling.bps-total" },
861 { "bps_rd", "throttling.bps-read" },
862 { "bps_wr", "throttling.bps-write" },
864 { "iops_max", "throttling.iops-total-max" },
865 { "iops_rd_max", "throttling.iops-read-max" },
866 { "iops_wr_max", "throttling.iops-write-max" },
868 { "bps_max", "throttling.bps-total-max" },
869 { "bps_rd_max", "throttling.bps-read-max" },
870 { "bps_wr_max", "throttling.bps-write-max" },
872 { "iops_size", "throttling.iops-size" },
874 { "group", "throttling.group" },
876 { "readonly", "read-only" },
879 for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
880 qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
881 &local_err);
882 if (local_err) {
883 error_report_err(local_err);
884 return NULL;
888 value = qemu_opt_get(all_opts, "cache");
889 if (value) {
890 int flags = 0;
891 bool writethrough;
893 if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
894 error_report("invalid cache option");
895 return NULL;
898 /* Specific options take precedence */
899 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
900 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
901 !writethrough, &error_abort);
903 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
904 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
905 !!(flags & BDRV_O_NOCACHE), &error_abort);
907 if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
908 qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
909 !!(flags & BDRV_O_NO_FLUSH), &error_abort);
911 qemu_opt_unset(all_opts, "cache");
914 /* Get a QDict for processing the options */
915 bs_opts = qdict_new();
916 qemu_opts_to_qdict(all_opts, bs_opts);
918 legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
919 &error_abort);
920 qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
921 if (local_err) {
922 error_report_err(local_err);
923 goto fail;
926 /* Deprecated option boot=[on|off] */
927 if (qemu_opt_get(legacy_opts, "boot") != NULL) {
928 fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
929 "ignored. Future versions will reject this parameter. Please "
930 "update your scripts.\n");
933 /* Media type */
934 value = qemu_opt_get(legacy_opts, "media");
935 if (value) {
936 if (!strcmp(value, "disk")) {
937 media = MEDIA_DISK;
938 } else if (!strcmp(value, "cdrom")) {
939 media = MEDIA_CDROM;
940 read_only = true;
941 } else {
942 error_report("'%s' invalid media", value);
943 goto fail;
947 /* copy-on-read is disabled with a warning for read-only devices */
948 read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
949 copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
951 if (read_only && copy_on_read) {
952 error_report("warning: disabling copy-on-read on read-only drive");
953 copy_on_read = false;
956 qdict_put(bs_opts, "read-only",
957 qstring_from_str(read_only ? "on" : "off"));
958 qdict_put(bs_opts, "copy-on-read",
959 qstring_from_str(copy_on_read ? "on" :"off"));
961 /* Controller type */
962 value = qemu_opt_get(legacy_opts, "if");
963 if (value) {
964 for (type = 0;
965 type < IF_COUNT && strcmp(value, if_name[type]);
966 type++) {
968 if (type == IF_COUNT) {
969 error_report("unsupported bus type '%s'", value);
970 goto fail;
972 } else {
973 type = block_default_type;
976 /* Geometry */
977 cyls = qemu_opt_get_number(legacy_opts, "cyls", 0);
978 heads = qemu_opt_get_number(legacy_opts, "heads", 0);
979 secs = qemu_opt_get_number(legacy_opts, "secs", 0);
981 if (cyls || heads || secs) {
982 if (cyls < 1) {
983 error_report("invalid physical cyls number");
984 goto fail;
986 if (heads < 1) {
987 error_report("invalid physical heads number");
988 goto fail;
990 if (secs < 1) {
991 error_report("invalid physical secs number");
992 goto fail;
996 translation = BIOS_ATA_TRANSLATION_AUTO;
997 value = qemu_opt_get(legacy_opts, "trans");
998 if (value != NULL) {
999 if (!cyls) {
1000 error_report("'%s' trans must be used with cyls, heads and secs",
1001 value);
1002 goto fail;
1004 if (!strcmp(value, "none")) {
1005 translation = BIOS_ATA_TRANSLATION_NONE;
1006 } else if (!strcmp(value, "lba")) {
1007 translation = BIOS_ATA_TRANSLATION_LBA;
1008 } else if (!strcmp(value, "large")) {
1009 translation = BIOS_ATA_TRANSLATION_LARGE;
1010 } else if (!strcmp(value, "rechs")) {
1011 translation = BIOS_ATA_TRANSLATION_RECHS;
1012 } else if (!strcmp(value, "auto")) {
1013 translation = BIOS_ATA_TRANSLATION_AUTO;
1014 } else {
1015 error_report("'%s' invalid translation type", value);
1016 goto fail;
1020 if (media == MEDIA_CDROM) {
1021 if (cyls || secs || heads) {
1022 error_report("CHS can't be set with media=cdrom");
1023 goto fail;
1027 /* Device address specified by bus/unit or index.
1028 * If none was specified, try to find the first free one. */
1029 bus_id = qemu_opt_get_number(legacy_opts, "bus", 0);
1030 unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
1031 index = qemu_opt_get_number(legacy_opts, "index", -1);
1033 max_devs = if_max_devs[type];
1035 if (index != -1) {
1036 if (bus_id != 0 || unit_id != -1) {
1037 error_report("index cannot be used with bus and unit");
1038 goto fail;
1040 bus_id = drive_index_to_bus_id(type, index);
1041 unit_id = drive_index_to_unit_id(type, index);
1044 if (unit_id == -1) {
1045 unit_id = 0;
1046 while (drive_get(type, bus_id, unit_id) != NULL) {
1047 unit_id++;
1048 if (max_devs && unit_id >= max_devs) {
1049 unit_id -= max_devs;
1050 bus_id++;
1055 if (max_devs && unit_id >= max_devs) {
1056 error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
1057 goto fail;
1060 if (drive_get(type, bus_id, unit_id) != NULL) {
1061 error_report("drive with bus=%d, unit=%d (index=%d) exists",
1062 bus_id, unit_id, index);
1063 goto fail;
1066 /* Serial number */
1067 serial = qemu_opt_get(legacy_opts, "serial");
1069 /* no id supplied -> create one */
1070 if (qemu_opts_id(all_opts) == NULL) {
1071 char *new_id;
1072 const char *mediastr = "";
1073 if (type == IF_IDE || type == IF_SCSI) {
1074 mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
1076 if (max_devs) {
1077 new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
1078 mediastr, unit_id);
1079 } else {
1080 new_id = g_strdup_printf("%s%s%i", if_name[type],
1081 mediastr, unit_id);
1083 qdict_put(bs_opts, "id", qstring_from_str(new_id));
1084 g_free(new_id);
1087 /* Add virtio block device */
1088 devaddr = qemu_opt_get(legacy_opts, "addr");
1089 if (devaddr && type != IF_VIRTIO) {
1090 error_report("addr is not supported by this bus type");
1091 goto fail;
1094 if (type == IF_VIRTIO) {
1095 QemuOpts *devopts;
1096 devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
1097 &error_abort);
1098 if (arch_type == QEMU_ARCH_S390X) {
1099 qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1100 } else {
1101 qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1103 qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
1104 &error_abort);
1105 if (devaddr) {
1106 qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1110 filename = qemu_opt_get(legacy_opts, "file");
1112 /* Check werror/rerror compatibility with if=... */
1113 werror = qemu_opt_get(legacy_opts, "werror");
1114 if (werror != NULL) {
1115 if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
1116 type != IF_NONE) {
1117 error_report("werror is not supported by this bus type");
1118 goto fail;
1120 qdict_put(bs_opts, "werror", qstring_from_str(werror));
1123 rerror = qemu_opt_get(legacy_opts, "rerror");
1124 if (rerror != NULL) {
1125 if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
1126 type != IF_NONE) {
1127 error_report("rerror is not supported by this bus type");
1128 goto fail;
1130 qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
1133 /* Actual block device init: Functionality shared with blockdev-add */
1134 blk = blockdev_init(filename, bs_opts, &local_err);
1135 bs_opts = NULL;
1136 if (!blk) {
1137 if (local_err) {
1138 error_report_err(local_err);
1140 goto fail;
1141 } else {
1142 assert(!local_err);
1145 /* Create legacy DriveInfo */
1146 dinfo = g_malloc0(sizeof(*dinfo));
1147 dinfo->opts = all_opts;
1149 dinfo->cyls = cyls;
1150 dinfo->heads = heads;
1151 dinfo->secs = secs;
1152 dinfo->trans = translation;
1154 dinfo->type = type;
1155 dinfo->bus = bus_id;
1156 dinfo->unit = unit_id;
1157 dinfo->devaddr = devaddr;
1158 dinfo->serial = g_strdup(serial);
1160 blk_set_legacy_dinfo(blk, dinfo);
1162 switch(type) {
1163 case IF_IDE:
1164 case IF_SCSI:
1165 case IF_XEN:
1166 case IF_NONE:
1167 dinfo->media_cd = media == MEDIA_CDROM;
1168 break;
1169 default:
1170 break;
1173 fail:
1174 qemu_opts_del(legacy_opts);
1175 QDECREF(bs_opts);
1176 return dinfo;
1179 void hmp_commit(Monitor *mon, const QDict *qdict)
1181 const char *device = qdict_get_str(qdict, "device");
1182 BlockBackend *blk;
1183 int ret;
1185 if (!strcmp(device, "all")) {
1186 ret = blk_commit_all();
1187 } else {
1188 BlockDriverState *bs;
1189 AioContext *aio_context;
1191 blk = blk_by_name(device);
1192 if (!blk) {
1193 monitor_printf(mon, "Device '%s' not found\n", device);
1194 return;
1196 if (!blk_is_available(blk)) {
1197 monitor_printf(mon, "Device '%s' has no medium\n", device);
1198 return;
1201 bs = blk_bs(blk);
1202 aio_context = bdrv_get_aio_context(bs);
1203 aio_context_acquire(aio_context);
1205 ret = bdrv_commit(bs);
1207 aio_context_release(aio_context);
1209 if (ret < 0) {
1210 monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1211 strerror(-ret));
1215 static void blockdev_do_action(TransactionAction *action, Error **errp)
1217 TransactionActionList list;
1219 list.value = action;
1220 list.next = NULL;
1221 qmp_transaction(&list, false, NULL, errp);
1224 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1225 bool has_node_name, const char *node_name,
1226 const char *snapshot_file,
1227 bool has_snapshot_node_name,
1228 const char *snapshot_node_name,
1229 bool has_format, const char *format,
1230 bool has_mode, NewImageMode mode, Error **errp)
1232 BlockdevSnapshotSync snapshot = {
1233 .has_device = has_device,
1234 .device = (char *) device,
1235 .has_node_name = has_node_name,
1236 .node_name = (char *) node_name,
1237 .snapshot_file = (char *) snapshot_file,
1238 .has_snapshot_node_name = has_snapshot_node_name,
1239 .snapshot_node_name = (char *) snapshot_node_name,
1240 .has_format = has_format,
1241 .format = (char *) format,
1242 .has_mode = has_mode,
1243 .mode = mode,
1245 TransactionAction action = {
1246 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1247 .u.blockdev_snapshot_sync.data = &snapshot,
1249 blockdev_do_action(&action, errp);
1252 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1253 Error **errp)
1255 BlockdevSnapshot snapshot_data = {
1256 .node = (char *) node,
1257 .overlay = (char *) overlay
1259 TransactionAction action = {
1260 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1261 .u.blockdev_snapshot.data = &snapshot_data,
1263 blockdev_do_action(&action, errp);
1266 void qmp_blockdev_snapshot_internal_sync(const char *device,
1267 const char *name,
1268 Error **errp)
1270 BlockdevSnapshotInternal snapshot = {
1271 .device = (char *) device,
1272 .name = (char *) name
1274 TransactionAction action = {
1275 .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1276 .u.blockdev_snapshot_internal_sync.data = &snapshot,
1278 blockdev_do_action(&action, errp);
1281 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1282 bool has_id,
1283 const char *id,
1284 bool has_name,
1285 const char *name,
1286 Error **errp)
1288 BlockDriverState *bs;
1289 BlockBackend *blk;
1290 AioContext *aio_context;
1291 QEMUSnapshotInfo sn;
1292 Error *local_err = NULL;
1293 SnapshotInfo *info = NULL;
1294 int ret;
1296 blk = blk_by_name(device);
1297 if (!blk) {
1298 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1299 "Device '%s' not found", device);
1300 return NULL;
1303 aio_context = blk_get_aio_context(blk);
1304 aio_context_acquire(aio_context);
1306 if (!has_id) {
1307 id = NULL;
1310 if (!has_name) {
1311 name = NULL;
1314 if (!id && !name) {
1315 error_setg(errp, "Name or id must be provided");
1316 goto out_aio_context;
1319 if (!blk_is_available(blk)) {
1320 error_setg(errp, "Device '%s' has no medium", device);
1321 goto out_aio_context;
1323 bs = blk_bs(blk);
1325 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1326 goto out_aio_context;
1329 ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1330 if (local_err) {
1331 error_propagate(errp, local_err);
1332 goto out_aio_context;
1334 if (!ret) {
1335 error_setg(errp,
1336 "Snapshot with id '%s' and name '%s' does not exist on "
1337 "device '%s'",
1338 STR_OR_NULL(id), STR_OR_NULL(name), device);
1339 goto out_aio_context;
1342 bdrv_snapshot_delete(bs, id, name, &local_err);
1343 if (local_err) {
1344 error_propagate(errp, local_err);
1345 goto out_aio_context;
1348 aio_context_release(aio_context);
1350 info = g_new0(SnapshotInfo, 1);
1351 info->id = g_strdup(sn.id_str);
1352 info->name = g_strdup(sn.name);
1353 info->date_nsec = sn.date_nsec;
1354 info->date_sec = sn.date_sec;
1355 info->vm_state_size = sn.vm_state_size;
1356 info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1357 info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1359 return info;
1361 out_aio_context:
1362 aio_context_release(aio_context);
1363 return NULL;
1367 * block_dirty_bitmap_lookup:
1368 * Return a dirty bitmap (if present), after validating
1369 * the node reference and bitmap names.
1371 * @node: The name of the BDS node to search for bitmaps
1372 * @name: The name of the bitmap to search for
1373 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1374 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1375 * @errp: Output pointer for error information. Can be NULL.
1377 * @return: A bitmap object on success, or NULL on failure.
1379 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1380 const char *name,
1381 BlockDriverState **pbs,
1382 AioContext **paio,
1383 Error **errp)
1385 BlockDriverState *bs;
1386 BdrvDirtyBitmap *bitmap;
1387 AioContext *aio_context;
1389 if (!node) {
1390 error_setg(errp, "Node cannot be NULL");
1391 return NULL;
1393 if (!name) {
1394 error_setg(errp, "Bitmap name cannot be NULL");
1395 return NULL;
1397 bs = bdrv_lookup_bs(node, node, NULL);
1398 if (!bs) {
1399 error_setg(errp, "Node '%s' not found", node);
1400 return NULL;
1403 aio_context = bdrv_get_aio_context(bs);
1404 aio_context_acquire(aio_context);
1406 bitmap = bdrv_find_dirty_bitmap(bs, name);
1407 if (!bitmap) {
1408 error_setg(errp, "Dirty bitmap '%s' not found", name);
1409 goto fail;
1412 if (pbs) {
1413 *pbs = bs;
1415 if (paio) {
1416 *paio = aio_context;
1417 } else {
1418 aio_context_release(aio_context);
1421 return bitmap;
1423 fail:
1424 aio_context_release(aio_context);
1425 return NULL;
1428 /* New and old BlockDriverState structs for atomic group operations */
1430 typedef struct BlkActionState BlkActionState;
1433 * BlkActionOps:
1434 * Table of operations that define an Action.
1436 * @instance_size: Size of state struct, in bytes.
1437 * @prepare: Prepare the work, must NOT be NULL.
1438 * @commit: Commit the changes, can be NULL.
1439 * @abort: Abort the changes on fail, can be NULL.
1440 * @clean: Clean up resources after all transaction actions have called
1441 * commit() or abort(). Can be NULL.
1443 * Only prepare() may fail. In a single transaction, only one of commit() or
1444 * abort() will be called. clean() will always be called if it is present.
1446 typedef struct BlkActionOps {
1447 size_t instance_size;
1448 void (*prepare)(BlkActionState *common, Error **errp);
1449 void (*commit)(BlkActionState *common);
1450 void (*abort)(BlkActionState *common);
1451 void (*clean)(BlkActionState *common);
1452 } BlkActionOps;
1455 * BlkActionState:
1456 * Describes one Action's state within a Transaction.
1458 * @action: QAPI-defined enum identifying which Action to perform.
1459 * @ops: Table of ActionOps this Action can perform.
1460 * @block_job_txn: Transaction which this action belongs to.
1461 * @entry: List membership for all Actions in this Transaction.
1463 * This structure must be arranged as first member in a subclassed type,
1464 * assuming that the compiler will also arrange it to the same offsets as the
1465 * base class.
1467 struct BlkActionState {
1468 TransactionAction *action;
1469 const BlkActionOps *ops;
1470 BlockJobTxn *block_job_txn;
1471 TransactionProperties *txn_props;
1472 QSIMPLEQ_ENTRY(BlkActionState) entry;
1475 /* internal snapshot private data */
1476 typedef struct InternalSnapshotState {
1477 BlkActionState common;
1478 BlockDriverState *bs;
1479 AioContext *aio_context;
1480 QEMUSnapshotInfo sn;
1481 bool created;
1482 } InternalSnapshotState;
1485 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1487 if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1488 error_setg(errp,
1489 "Action '%s' does not support Transaction property "
1490 "completion-mode = %s",
1491 TransactionActionKind_lookup[s->action->type],
1492 ActionCompletionMode_lookup[s->txn_props->completion_mode]);
1493 return -1;
1495 return 0;
1498 static void internal_snapshot_prepare(BlkActionState *common,
1499 Error **errp)
1501 Error *local_err = NULL;
1502 const char *device;
1503 const char *name;
1504 BlockBackend *blk;
1505 BlockDriverState *bs;
1506 QEMUSnapshotInfo old_sn, *sn;
1507 bool ret;
1508 qemu_timeval tv;
1509 BlockdevSnapshotInternal *internal;
1510 InternalSnapshotState *state;
1511 int ret1;
1513 g_assert(common->action->type ==
1514 TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1515 internal = common->action->u.blockdev_snapshot_internal_sync.data;
1516 state = DO_UPCAST(InternalSnapshotState, common, common);
1518 /* 1. parse input */
1519 device = internal->device;
1520 name = internal->name;
1522 /* 2. check for validation */
1523 if (action_check_completion_mode(common, errp) < 0) {
1524 return;
1527 blk = blk_by_name(device);
1528 if (!blk) {
1529 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1530 "Device '%s' not found", device);
1531 return;
1534 /* AioContext is released in .clean() */
1535 state->aio_context = blk_get_aio_context(blk);
1536 aio_context_acquire(state->aio_context);
1538 if (!blk_is_available(blk)) {
1539 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1540 return;
1542 bs = blk_bs(blk);
1544 state->bs = bs;
1545 bdrv_drained_begin(bs);
1547 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1548 return;
1551 if (bdrv_is_read_only(bs)) {
1552 error_setg(errp, "Device '%s' is read only", device);
1553 return;
1556 if (!bdrv_can_snapshot(bs)) {
1557 error_setg(errp, "Block format '%s' used by device '%s' "
1558 "does not support internal snapshots",
1559 bs->drv->format_name, device);
1560 return;
1563 if (!strlen(name)) {
1564 error_setg(errp, "Name is empty");
1565 return;
1568 /* check whether a snapshot with name exist */
1569 ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1570 &local_err);
1571 if (local_err) {
1572 error_propagate(errp, local_err);
1573 return;
1574 } else if (ret) {
1575 error_setg(errp,
1576 "Snapshot with name '%s' already exists on device '%s'",
1577 name, device);
1578 return;
1581 /* 3. take the snapshot */
1582 sn = &state->sn;
1583 pstrcpy(sn->name, sizeof(sn->name), name);
1584 qemu_gettimeofday(&tv);
1585 sn->date_sec = tv.tv_sec;
1586 sn->date_nsec = tv.tv_usec * 1000;
1587 sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1589 ret1 = bdrv_snapshot_create(bs, sn);
1590 if (ret1 < 0) {
1591 error_setg_errno(errp, -ret1,
1592 "Failed to create snapshot '%s' on device '%s'",
1593 name, device);
1594 return;
1597 /* 4. succeed, mark a snapshot is created */
1598 state->created = true;
1601 static void internal_snapshot_abort(BlkActionState *common)
1603 InternalSnapshotState *state =
1604 DO_UPCAST(InternalSnapshotState, common, common);
1605 BlockDriverState *bs = state->bs;
1606 QEMUSnapshotInfo *sn = &state->sn;
1607 Error *local_error = NULL;
1609 if (!state->created) {
1610 return;
1613 if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1614 error_reportf_err(local_error,
1615 "Failed to delete snapshot with id '%s' and "
1616 "name '%s' on device '%s' in abort: ",
1617 sn->id_str, sn->name,
1618 bdrv_get_device_name(bs));
1622 static void internal_snapshot_clean(BlkActionState *common)
1624 InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1625 common, common);
1627 if (state->aio_context) {
1628 if (state->bs) {
1629 bdrv_drained_end(state->bs);
1631 aio_context_release(state->aio_context);
1635 /* external snapshot private data */
1636 typedef struct ExternalSnapshotState {
1637 BlkActionState common;
1638 BlockDriverState *old_bs;
1639 BlockDriverState *new_bs;
1640 AioContext *aio_context;
1641 } ExternalSnapshotState;
1643 static void external_snapshot_prepare(BlkActionState *common,
1644 Error **errp)
1646 int flags = 0, ret;
1647 QDict *options = NULL;
1648 Error *local_err = NULL;
1649 /* Device and node name of the image to generate the snapshot from */
1650 const char *device;
1651 const char *node_name;
1652 /* Reference to the new image (for 'blockdev-snapshot') */
1653 const char *snapshot_ref;
1654 /* File name of the new image (for 'blockdev-snapshot-sync') */
1655 const char *new_image_file;
1656 ExternalSnapshotState *state =
1657 DO_UPCAST(ExternalSnapshotState, common, common);
1658 TransactionAction *action = common->action;
1660 /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1661 * purpose but a different set of parameters */
1662 switch (action->type) {
1663 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1665 BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1666 device = s->node;
1667 node_name = s->node;
1668 new_image_file = NULL;
1669 snapshot_ref = s->overlay;
1671 break;
1672 case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1674 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1675 device = s->has_device ? s->device : NULL;
1676 node_name = s->has_node_name ? s->node_name : NULL;
1677 new_image_file = s->snapshot_file;
1678 snapshot_ref = NULL;
1680 break;
1681 default:
1682 g_assert_not_reached();
1685 /* start processing */
1686 if (action_check_completion_mode(common, errp) < 0) {
1687 return;
1690 state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1691 if (!state->old_bs) {
1692 return;
1695 /* Acquire AioContext now so any threads operating on old_bs stop */
1696 state->aio_context = bdrv_get_aio_context(state->old_bs);
1697 aio_context_acquire(state->aio_context);
1698 bdrv_drained_begin(state->old_bs);
1700 if (!bdrv_is_inserted(state->old_bs)) {
1701 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1702 return;
1705 if (bdrv_op_is_blocked(state->old_bs,
1706 BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1707 return;
1710 if (!bdrv_is_read_only(state->old_bs)) {
1711 if (bdrv_flush(state->old_bs)) {
1712 error_setg(errp, QERR_IO_ERROR);
1713 return;
1717 if (!bdrv_is_first_non_filter(state->old_bs)) {
1718 error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1719 return;
1722 if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1723 BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1724 const char *format = s->has_format ? s->format : "qcow2";
1725 enum NewImageMode mode;
1726 const char *snapshot_node_name =
1727 s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1729 if (node_name && !snapshot_node_name) {
1730 error_setg(errp, "New snapshot node name missing");
1731 return;
1734 if (snapshot_node_name &&
1735 bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1736 error_setg(errp, "New snapshot node name already in use");
1737 return;
1740 flags = state->old_bs->open_flags;
1741 flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1743 /* create new image w/backing file */
1744 mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1745 if (mode != NEW_IMAGE_MODE_EXISTING) {
1746 int64_t size = bdrv_getlength(state->old_bs);
1747 if (size < 0) {
1748 error_setg_errno(errp, -size, "bdrv_getlength failed");
1749 return;
1751 bdrv_img_create(new_image_file, format,
1752 state->old_bs->filename,
1753 state->old_bs->drv->format_name,
1754 NULL, size, flags, &local_err, false);
1755 if (local_err) {
1756 error_propagate(errp, local_err);
1757 return;
1761 options = qdict_new();
1762 if (s->has_snapshot_node_name) {
1763 qdict_put(options, "node-name",
1764 qstring_from_str(snapshot_node_name));
1766 qdict_put(options, "driver", qstring_from_str(format));
1768 flags |= BDRV_O_NO_BACKING;
1771 assert(state->new_bs == NULL);
1772 ret = bdrv_open(&state->new_bs, new_image_file, snapshot_ref, options,
1773 flags, errp);
1774 /* We will manually add the backing_hd field to the bs later */
1775 if (ret != 0) {
1776 return;
1779 if (bdrv_has_blk(state->new_bs)) {
1780 error_setg(errp, "The snapshot is already in use by %s",
1781 bdrv_get_parent_name(state->new_bs));
1782 return;
1785 if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
1786 errp)) {
1787 return;
1790 if (state->new_bs->backing != NULL) {
1791 error_setg(errp, "The snapshot already has a backing image");
1792 return;
1795 if (!state->new_bs->drv->supports_backing) {
1796 error_setg(errp, "The snapshot does not support backing images");
1800 static void external_snapshot_commit(BlkActionState *common)
1802 ExternalSnapshotState *state =
1803 DO_UPCAST(ExternalSnapshotState, common, common);
1805 bdrv_set_aio_context(state->new_bs, state->aio_context);
1807 /* This removes our old bs and adds the new bs */
1808 bdrv_append(state->new_bs, state->old_bs);
1809 /* We don't need (or want) to use the transactional
1810 * bdrv_reopen_multiple() across all the entries at once, because we
1811 * don't want to abort all of them if one of them fails the reopen */
1812 if (!state->old_bs->copy_on_read) {
1813 bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1814 NULL);
1818 static void external_snapshot_abort(BlkActionState *common)
1820 ExternalSnapshotState *state =
1821 DO_UPCAST(ExternalSnapshotState, common, common);
1822 if (state->new_bs) {
1823 bdrv_unref(state->new_bs);
1827 static void external_snapshot_clean(BlkActionState *common)
1829 ExternalSnapshotState *state =
1830 DO_UPCAST(ExternalSnapshotState, common, common);
1831 if (state->aio_context) {
1832 bdrv_drained_end(state->old_bs);
1833 aio_context_release(state->aio_context);
1837 typedef struct DriveBackupState {
1838 BlkActionState common;
1839 BlockDriverState *bs;
1840 AioContext *aio_context;
1841 BlockJob *job;
1842 } DriveBackupState;
1844 static void do_drive_backup(const char *device, const char *target,
1845 bool has_format, const char *format,
1846 enum MirrorSyncMode sync,
1847 bool has_mode, enum NewImageMode mode,
1848 bool has_speed, int64_t speed,
1849 bool has_bitmap, const char *bitmap,
1850 bool has_on_source_error,
1851 BlockdevOnError on_source_error,
1852 bool has_on_target_error,
1853 BlockdevOnError on_target_error,
1854 BlockJobTxn *txn, Error **errp);
1856 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1858 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1859 BlockBackend *blk;
1860 DriveBackup *backup;
1861 Error *local_err = NULL;
1863 assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1864 backup = common->action->u.drive_backup.data;
1866 blk = blk_by_name(backup->device);
1867 if (!blk) {
1868 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1869 "Device '%s' not found", backup->device);
1870 return;
1873 if (!blk_is_available(blk)) {
1874 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1875 return;
1878 /* AioContext is released in .clean() */
1879 state->aio_context = blk_get_aio_context(blk);
1880 aio_context_acquire(state->aio_context);
1881 bdrv_drained_begin(blk_bs(blk));
1882 state->bs = blk_bs(blk);
1884 do_drive_backup(backup->device, backup->target,
1885 backup->has_format, backup->format,
1886 backup->sync,
1887 backup->has_mode, backup->mode,
1888 backup->has_speed, backup->speed,
1889 backup->has_bitmap, backup->bitmap,
1890 backup->has_on_source_error, backup->on_source_error,
1891 backup->has_on_target_error, backup->on_target_error,
1892 common->block_job_txn, &local_err);
1893 if (local_err) {
1894 error_propagate(errp, local_err);
1895 return;
1898 state->job = state->bs->job;
1901 static void drive_backup_abort(BlkActionState *common)
1903 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1904 BlockDriverState *bs = state->bs;
1906 /* Only cancel if it's the job we started */
1907 if (bs && bs->job && bs->job == state->job) {
1908 block_job_cancel_sync(bs->job);
1912 static void drive_backup_clean(BlkActionState *common)
1914 DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1916 if (state->aio_context) {
1917 bdrv_drained_end(state->bs);
1918 aio_context_release(state->aio_context);
1922 typedef struct BlockdevBackupState {
1923 BlkActionState common;
1924 BlockDriverState *bs;
1925 BlockJob *job;
1926 AioContext *aio_context;
1927 } BlockdevBackupState;
1929 static void do_blockdev_backup(const char *device, const char *target,
1930 enum MirrorSyncMode sync,
1931 bool has_speed, int64_t speed,
1932 bool has_on_source_error,
1933 BlockdevOnError on_source_error,
1934 bool has_on_target_error,
1935 BlockdevOnError on_target_error,
1936 BlockJobTxn *txn, Error **errp);
1938 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1940 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1941 BlockdevBackup *backup;
1942 BlockBackend *blk, *target;
1943 Error *local_err = NULL;
1945 assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1946 backup = common->action->u.blockdev_backup.data;
1948 blk = blk_by_name(backup->device);
1949 if (!blk) {
1950 error_setg(errp, "Device '%s' not found", backup->device);
1951 return;
1954 if (!blk_is_available(blk)) {
1955 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1956 return;
1959 target = blk_by_name(backup->target);
1960 if (!target) {
1961 error_setg(errp, "Device '%s' not found", backup->target);
1962 return;
1965 /* AioContext is released in .clean() */
1966 state->aio_context = blk_get_aio_context(blk);
1967 if (state->aio_context != blk_get_aio_context(target)) {
1968 state->aio_context = NULL;
1969 error_setg(errp, "Backup between two IO threads is not implemented");
1970 return;
1972 aio_context_acquire(state->aio_context);
1973 state->bs = blk_bs(blk);
1974 bdrv_drained_begin(state->bs);
1976 do_blockdev_backup(backup->device, backup->target,
1977 backup->sync,
1978 backup->has_speed, backup->speed,
1979 backup->has_on_source_error, backup->on_source_error,
1980 backup->has_on_target_error, backup->on_target_error,
1981 common->block_job_txn, &local_err);
1982 if (local_err) {
1983 error_propagate(errp, local_err);
1984 return;
1987 state->job = state->bs->job;
1990 static void blockdev_backup_abort(BlkActionState *common)
1992 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1993 BlockDriverState *bs = state->bs;
1995 /* Only cancel if it's the job we started */
1996 if (bs && bs->job && bs->job == state->job) {
1997 block_job_cancel_sync(bs->job);
2001 static void blockdev_backup_clean(BlkActionState *common)
2003 BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
2005 if (state->aio_context) {
2006 bdrv_drained_end(state->bs);
2007 aio_context_release(state->aio_context);
2011 typedef struct BlockDirtyBitmapState {
2012 BlkActionState common;
2013 BdrvDirtyBitmap *bitmap;
2014 BlockDriverState *bs;
2015 AioContext *aio_context;
2016 HBitmap *backup;
2017 bool prepared;
2018 } BlockDirtyBitmapState;
2020 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
2021 Error **errp)
2023 Error *local_err = NULL;
2024 BlockDirtyBitmapAdd *action;
2025 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2026 common, common);
2028 if (action_check_completion_mode(common, errp) < 0) {
2029 return;
2032 action = common->action->u.block_dirty_bitmap_add.data;
2033 /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2034 qmp_block_dirty_bitmap_add(action->node, action->name,
2035 action->has_granularity, action->granularity,
2036 &local_err);
2038 if (!local_err) {
2039 state->prepared = true;
2040 } else {
2041 error_propagate(errp, local_err);
2045 static void block_dirty_bitmap_add_abort(BlkActionState *common)
2047 BlockDirtyBitmapAdd *action;
2048 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2049 common, common);
2051 action = common->action->u.block_dirty_bitmap_add.data;
2052 /* Should not be able to fail: IF the bitmap was added via .prepare(),
2053 * then the node reference and bitmap name must have been valid.
2055 if (state->prepared) {
2056 qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2060 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
2061 Error **errp)
2063 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2064 common, common);
2065 BlockDirtyBitmap *action;
2067 if (action_check_completion_mode(common, errp) < 0) {
2068 return;
2071 action = common->action->u.block_dirty_bitmap_clear.data;
2072 state->bitmap = block_dirty_bitmap_lookup(action->node,
2073 action->name,
2074 &state->bs,
2075 &state->aio_context,
2076 errp);
2077 if (!state->bitmap) {
2078 return;
2081 if (bdrv_dirty_bitmap_frozen(state->bitmap)) {
2082 error_setg(errp, "Cannot modify a frozen bitmap");
2083 return;
2084 } else if (!bdrv_dirty_bitmap_enabled(state->bitmap)) {
2085 error_setg(errp, "Cannot clear a disabled bitmap");
2086 return;
2089 bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2090 /* AioContext is released in .clean() */
2093 static void block_dirty_bitmap_clear_abort(BlkActionState *common)
2095 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2096 common, common);
2098 bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
2101 static void block_dirty_bitmap_clear_commit(BlkActionState *common)
2103 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2104 common, common);
2106 hbitmap_free(state->backup);
2109 static void block_dirty_bitmap_clear_clean(BlkActionState *common)
2111 BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2112 common, common);
2114 if (state->aio_context) {
2115 aio_context_release(state->aio_context);
2119 static void abort_prepare(BlkActionState *common, Error **errp)
2121 error_setg(errp, "Transaction aborted using Abort action");
2124 static void abort_commit(BlkActionState *common)
2126 g_assert_not_reached(); /* this action never succeeds */
2129 static const BlkActionOps actions[] = {
2130 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2131 .instance_size = sizeof(ExternalSnapshotState),
2132 .prepare = external_snapshot_prepare,
2133 .commit = external_snapshot_commit,
2134 .abort = external_snapshot_abort,
2135 .clean = external_snapshot_clean,
2137 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2138 .instance_size = sizeof(ExternalSnapshotState),
2139 .prepare = external_snapshot_prepare,
2140 .commit = external_snapshot_commit,
2141 .abort = external_snapshot_abort,
2142 .clean = external_snapshot_clean,
2144 [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2145 .instance_size = sizeof(DriveBackupState),
2146 .prepare = drive_backup_prepare,
2147 .abort = drive_backup_abort,
2148 .clean = drive_backup_clean,
2150 [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2151 .instance_size = sizeof(BlockdevBackupState),
2152 .prepare = blockdev_backup_prepare,
2153 .abort = blockdev_backup_abort,
2154 .clean = blockdev_backup_clean,
2156 [TRANSACTION_ACTION_KIND_ABORT] = {
2157 .instance_size = sizeof(BlkActionState),
2158 .prepare = abort_prepare,
2159 .commit = abort_commit,
2161 [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2162 .instance_size = sizeof(InternalSnapshotState),
2163 .prepare = internal_snapshot_prepare,
2164 .abort = internal_snapshot_abort,
2165 .clean = internal_snapshot_clean,
2167 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2168 .instance_size = sizeof(BlockDirtyBitmapState),
2169 .prepare = block_dirty_bitmap_add_prepare,
2170 .abort = block_dirty_bitmap_add_abort,
2172 [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2173 .instance_size = sizeof(BlockDirtyBitmapState),
2174 .prepare = block_dirty_bitmap_clear_prepare,
2175 .commit = block_dirty_bitmap_clear_commit,
2176 .abort = block_dirty_bitmap_clear_abort,
2177 .clean = block_dirty_bitmap_clear_clean,
2182 * Allocate a TransactionProperties structure if necessary, and fill
2183 * that structure with desired defaults if they are unset.
2185 static TransactionProperties *get_transaction_properties(
2186 TransactionProperties *props)
2188 if (!props) {
2189 props = g_new0(TransactionProperties, 1);
2192 if (!props->has_completion_mode) {
2193 props->has_completion_mode = true;
2194 props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2197 return props;
2201 * 'Atomic' group operations. The operations are performed as a set, and if
2202 * any fail then we roll back all operations in the group.
2204 void qmp_transaction(TransactionActionList *dev_list,
2205 bool has_props,
2206 struct TransactionProperties *props,
2207 Error **errp)
2209 TransactionActionList *dev_entry = dev_list;
2210 BlockJobTxn *block_job_txn = NULL;
2211 BlkActionState *state, *next;
2212 Error *local_err = NULL;
2214 QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2215 QSIMPLEQ_INIT(&snap_bdrv_states);
2217 /* Does this transaction get canceled as a group on failure?
2218 * If not, we don't really need to make a BlockJobTxn.
2220 props = get_transaction_properties(props);
2221 if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2222 block_job_txn = block_job_txn_new();
2225 /* drain all i/o before any operations */
2226 bdrv_drain_all();
2228 /* We don't do anything in this loop that commits us to the operations */
2229 while (NULL != dev_entry) {
2230 TransactionAction *dev_info = NULL;
2231 const BlkActionOps *ops;
2233 dev_info = dev_entry->value;
2234 dev_entry = dev_entry->next;
2236 assert(dev_info->type < ARRAY_SIZE(actions));
2238 ops = &actions[dev_info->type];
2239 assert(ops->instance_size > 0);
2241 state = g_malloc0(ops->instance_size);
2242 state->ops = ops;
2243 state->action = dev_info;
2244 state->block_job_txn = block_job_txn;
2245 state->txn_props = props;
2246 QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2248 state->ops->prepare(state, &local_err);
2249 if (local_err) {
2250 error_propagate(errp, local_err);
2251 goto delete_and_fail;
2255 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2256 if (state->ops->commit) {
2257 state->ops->commit(state);
2261 /* success */
2262 goto exit;
2264 delete_and_fail:
2265 /* failure, and it is all-or-none; roll back all operations */
2266 QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2267 if (state->ops->abort) {
2268 state->ops->abort(state);
2271 exit:
2272 QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2273 if (state->ops->clean) {
2274 state->ops->clean(state);
2276 g_free(state);
2278 if (!has_props) {
2279 qapi_free_TransactionProperties(props);
2281 block_job_txn_unref(block_job_txn);
2284 static int do_open_tray(const char *device, bool force, Error **errp);
2286 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2288 Error *local_err = NULL;
2289 int rc;
2291 if (!has_force) {
2292 force = false;
2295 rc = do_open_tray(device, force, &local_err);
2296 if (local_err) {
2297 error_propagate(errp, local_err);
2298 return;
2301 if (rc == EINPROGRESS) {
2302 error_setg(errp, "Device '%s' is locked and force was not specified, "
2303 "wait for tray to open and try again", device);
2304 return;
2307 qmp_x_blockdev_remove_medium(device, errp);
2310 void qmp_block_passwd(bool has_device, const char *device,
2311 bool has_node_name, const char *node_name,
2312 const char *password, Error **errp)
2314 Error *local_err = NULL;
2315 BlockDriverState *bs;
2316 AioContext *aio_context;
2318 bs = bdrv_lookup_bs(has_device ? device : NULL,
2319 has_node_name ? node_name : NULL,
2320 &local_err);
2321 if (local_err) {
2322 error_propagate(errp, local_err);
2323 return;
2326 aio_context = bdrv_get_aio_context(bs);
2327 aio_context_acquire(aio_context);
2329 bdrv_add_key(bs, password, errp);
2331 aio_context_release(aio_context);
2335 * returns -errno on fatal error, +errno for non-fatal situations.
2336 * errp will always be set when the return code is negative.
2337 * May return +ENOSYS if the device has no tray,
2338 * or +EINPROGRESS if the tray is locked and the guest has been notified.
2340 static int do_open_tray(const char *device, bool force, Error **errp)
2342 BlockBackend *blk;
2343 bool locked;
2345 blk = blk_by_name(device);
2346 if (!blk) {
2347 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2348 "Device '%s' not found", device);
2349 return -ENODEV;
2352 if (!blk_dev_has_removable_media(blk)) {
2353 error_setg(errp, "Device '%s' is not removable", device);
2354 return -ENOTSUP;
2357 if (!blk_dev_has_tray(blk)) {
2358 /* Ignore this command on tray-less devices */
2359 return ENOSYS;
2362 if (blk_dev_is_tray_open(blk)) {
2363 return 0;
2366 locked = blk_dev_is_medium_locked(blk);
2367 if (locked) {
2368 blk_dev_eject_request(blk, force);
2371 if (!locked || force) {
2372 blk_dev_change_media_cb(blk, false);
2375 if (locked && !force) {
2376 return EINPROGRESS;
2379 return 0;
2382 void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
2383 Error **errp)
2385 if (!has_force) {
2386 force = false;
2388 do_open_tray(device, force, errp);
2391 void qmp_blockdev_close_tray(const char *device, Error **errp)
2393 BlockBackend *blk;
2395 blk = blk_by_name(device);
2396 if (!blk) {
2397 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2398 "Device '%s' not found", device);
2399 return;
2402 if (!blk_dev_has_removable_media(blk)) {
2403 error_setg(errp, "Device '%s' is not removable", device);
2404 return;
2407 if (!blk_dev_has_tray(blk)) {
2408 /* Ignore this command on tray-less devices */
2409 return;
2412 if (!blk_dev_is_tray_open(blk)) {
2413 return;
2416 blk_dev_change_media_cb(blk, true);
2419 void qmp_x_blockdev_remove_medium(const char *device, Error **errp)
2421 BlockBackend *blk;
2422 BlockDriverState *bs;
2423 AioContext *aio_context;
2424 bool has_device;
2426 blk = blk_by_name(device);
2427 if (!blk) {
2428 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2429 "Device '%s' not found", device);
2430 return;
2433 /* For BBs without a device, we can exchange the BDS tree at will */
2434 has_device = blk_get_attached_dev(blk);
2436 if (has_device && !blk_dev_has_removable_media(blk)) {
2437 error_setg(errp, "Device '%s' is not removable", device);
2438 return;
2441 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2442 error_setg(errp, "Tray of device '%s' is not open", device);
2443 return;
2446 bs = blk_bs(blk);
2447 if (!bs) {
2448 return;
2451 aio_context = bdrv_get_aio_context(bs);
2452 aio_context_acquire(aio_context);
2454 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2455 goto out;
2458 blk_remove_bs(blk);
2460 if (!blk_dev_has_tray(blk)) {
2461 /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2462 * called at all); therefore, the medium needs to be ejected here.
2463 * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2464 * value passed here (i.e. false). */
2465 blk_dev_change_media_cb(blk, false);
2468 out:
2469 aio_context_release(aio_context);
2472 static void qmp_blockdev_insert_anon_medium(const char *device,
2473 BlockDriverState *bs, Error **errp)
2475 BlockBackend *blk;
2476 bool has_device;
2478 blk = blk_by_name(device);
2479 if (!blk) {
2480 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2481 "Device '%s' not found", device);
2482 return;
2485 /* For BBs without a device, we can exchange the BDS tree at will */
2486 has_device = blk_get_attached_dev(blk);
2488 if (has_device && !blk_dev_has_removable_media(blk)) {
2489 error_setg(errp, "Device '%s' is not removable", device);
2490 return;
2493 if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2494 error_setg(errp, "Tray of device '%s' is not open", device);
2495 return;
2498 if (blk_bs(blk)) {
2499 error_setg(errp, "There already is a medium in device '%s'", device);
2500 return;
2503 blk_insert_bs(blk, bs);
2505 if (!blk_dev_has_tray(blk)) {
2506 /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2507 * called at all); therefore, the medium needs to be pushed into the
2508 * slot here.
2509 * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2510 * value passed here (i.e. true). */
2511 blk_dev_change_media_cb(blk, true);
2515 void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
2516 Error **errp)
2518 BlockDriverState *bs;
2520 bs = bdrv_find_node(node_name);
2521 if (!bs) {
2522 error_setg(errp, "Node '%s' not found", node_name);
2523 return;
2526 if (bdrv_has_blk(bs)) {
2527 error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
2528 bdrv_get_parent_name(bs));
2529 return;
2532 qmp_blockdev_insert_anon_medium(device, bs, errp);
2535 void qmp_blockdev_change_medium(const char *device, const char *filename,
2536 bool has_format, const char *format,
2537 bool has_read_only,
2538 BlockdevChangeReadOnlyMode read_only,
2539 Error **errp)
2541 BlockBackend *blk;
2542 BlockDriverState *medium_bs = NULL;
2543 int bdrv_flags, ret;
2544 QDict *options = NULL;
2545 Error *err = NULL;
2547 blk = blk_by_name(device);
2548 if (!blk) {
2549 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2550 "Device '%s' not found", device);
2551 goto fail;
2554 if (blk_bs(blk)) {
2555 blk_update_root_state(blk);
2558 bdrv_flags = blk_get_open_flags_from_root_state(blk);
2559 bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2560 BDRV_O_PROTOCOL);
2562 if (!has_read_only) {
2563 read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2566 switch (read_only) {
2567 case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2568 break;
2570 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2571 bdrv_flags &= ~BDRV_O_RDWR;
2572 break;
2574 case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2575 bdrv_flags |= BDRV_O_RDWR;
2576 break;
2578 default:
2579 abort();
2582 if (has_format) {
2583 options = qdict_new();
2584 qdict_put(options, "driver", qstring_from_str(format));
2587 assert(!medium_bs);
2588 ret = bdrv_open(&medium_bs, filename, NULL, options, bdrv_flags, errp);
2589 if (ret < 0) {
2590 goto fail;
2593 bdrv_add_key(medium_bs, NULL, &err);
2594 if (err) {
2595 error_propagate(errp, err);
2596 goto fail;
2599 qmp_blockdev_open_tray(device, false, false, &err);
2600 if (err) {
2601 error_propagate(errp, err);
2602 goto fail;
2605 qmp_x_blockdev_remove_medium(device, &err);
2606 if (err) {
2607 error_propagate(errp, err);
2608 goto fail;
2611 qmp_blockdev_insert_anon_medium(device, medium_bs, &err);
2612 if (err) {
2613 error_propagate(errp, err);
2614 goto fail;
2617 blk_apply_root_state(blk, medium_bs);
2619 qmp_blockdev_close_tray(device, errp);
2621 fail:
2622 /* If the medium has been inserted, the device has its own reference, so
2623 * ours must be relinquished; and if it has not been inserted successfully,
2624 * the reference must be relinquished anyway */
2625 bdrv_unref(medium_bs);
2628 /* throttling disk I/O limits */
2629 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2630 int64_t bps_wr,
2631 int64_t iops,
2632 int64_t iops_rd,
2633 int64_t iops_wr,
2634 bool has_bps_max,
2635 int64_t bps_max,
2636 bool has_bps_rd_max,
2637 int64_t bps_rd_max,
2638 bool has_bps_wr_max,
2639 int64_t bps_wr_max,
2640 bool has_iops_max,
2641 int64_t iops_max,
2642 bool has_iops_rd_max,
2643 int64_t iops_rd_max,
2644 bool has_iops_wr_max,
2645 int64_t iops_wr_max,
2646 bool has_bps_max_length,
2647 int64_t bps_max_length,
2648 bool has_bps_rd_max_length,
2649 int64_t bps_rd_max_length,
2650 bool has_bps_wr_max_length,
2651 int64_t bps_wr_max_length,
2652 bool has_iops_max_length,
2653 int64_t iops_max_length,
2654 bool has_iops_rd_max_length,
2655 int64_t iops_rd_max_length,
2656 bool has_iops_wr_max_length,
2657 int64_t iops_wr_max_length,
2658 bool has_iops_size,
2659 int64_t iops_size,
2660 bool has_group,
2661 const char *group, Error **errp)
2663 ThrottleConfig cfg;
2664 BlockDriverState *bs;
2665 BlockBackend *blk;
2666 AioContext *aio_context;
2668 blk = blk_by_name(device);
2669 if (!blk) {
2670 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2671 "Device '%s' not found", device);
2672 return;
2675 aio_context = blk_get_aio_context(blk);
2676 aio_context_acquire(aio_context);
2678 bs = blk_bs(blk);
2679 if (!bs) {
2680 error_setg(errp, "Device '%s' has no medium", device);
2681 goto out;
2684 throttle_config_init(&cfg);
2685 cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
2686 cfg.buckets[THROTTLE_BPS_READ].avg = bps_rd;
2687 cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
2689 cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
2690 cfg.buckets[THROTTLE_OPS_READ].avg = iops_rd;
2691 cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
2693 if (has_bps_max) {
2694 cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
2696 if (has_bps_rd_max) {
2697 cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
2699 if (has_bps_wr_max) {
2700 cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
2702 if (has_iops_max) {
2703 cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
2705 if (has_iops_rd_max) {
2706 cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
2708 if (has_iops_wr_max) {
2709 cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
2712 if (has_bps_max_length) {
2713 cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = bps_max_length;
2715 if (has_bps_rd_max_length) {
2716 cfg.buckets[THROTTLE_BPS_READ].burst_length = bps_rd_max_length;
2718 if (has_bps_wr_max_length) {
2719 cfg.buckets[THROTTLE_BPS_WRITE].burst_length = bps_wr_max_length;
2721 if (has_iops_max_length) {
2722 cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = iops_max_length;
2724 if (has_iops_rd_max_length) {
2725 cfg.buckets[THROTTLE_OPS_READ].burst_length = iops_rd_max_length;
2727 if (has_iops_wr_max_length) {
2728 cfg.buckets[THROTTLE_OPS_WRITE].burst_length = iops_wr_max_length;
2731 if (has_iops_size) {
2732 cfg.op_size = iops_size;
2735 if (!throttle_is_valid(&cfg, errp)) {
2736 goto out;
2739 if (throttle_enabled(&cfg)) {
2740 /* Enable I/O limits if they're not enabled yet, otherwise
2741 * just update the throttling group. */
2742 if (!blk_get_public(blk)->throttle_state) {
2743 blk_io_limits_enable(blk, has_group ? group : device);
2744 } else if (has_group) {
2745 blk_io_limits_update_group(blk, group);
2747 /* Set the new throttling configuration */
2748 blk_set_io_limits(blk, &cfg);
2749 } else if (blk_get_public(blk)->throttle_state) {
2750 /* If all throttling settings are set to 0, disable I/O limits */
2751 blk_io_limits_disable(blk);
2754 out:
2755 aio_context_release(aio_context);
2758 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2759 bool has_granularity, uint32_t granularity,
2760 Error **errp)
2762 AioContext *aio_context;
2763 BlockDriverState *bs;
2765 if (!name || name[0] == '\0') {
2766 error_setg(errp, "Bitmap name cannot be empty");
2767 return;
2770 bs = bdrv_lookup_bs(node, node, errp);
2771 if (!bs) {
2772 return;
2775 aio_context = bdrv_get_aio_context(bs);
2776 aio_context_acquire(aio_context);
2778 if (has_granularity) {
2779 if (granularity < 512 || !is_power_of_2(granularity)) {
2780 error_setg(errp, "Granularity must be power of 2 "
2781 "and at least 512");
2782 goto out;
2784 } else {
2785 /* Default to cluster size, if available: */
2786 granularity = bdrv_get_default_bitmap_granularity(bs);
2789 bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2791 out:
2792 aio_context_release(aio_context);
2795 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2796 Error **errp)
2798 AioContext *aio_context;
2799 BlockDriverState *bs;
2800 BdrvDirtyBitmap *bitmap;
2802 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2803 if (!bitmap || !bs) {
2804 return;
2807 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2808 error_setg(errp,
2809 "Bitmap '%s' is currently frozen and cannot be removed",
2810 name);
2811 goto out;
2813 bdrv_dirty_bitmap_make_anon(bitmap);
2814 bdrv_release_dirty_bitmap(bs, bitmap);
2816 out:
2817 aio_context_release(aio_context);
2821 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2822 * immediately after a full backup operation.
2824 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2825 Error **errp)
2827 AioContext *aio_context;
2828 BdrvDirtyBitmap *bitmap;
2829 BlockDriverState *bs;
2831 bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2832 if (!bitmap || !bs) {
2833 return;
2836 if (bdrv_dirty_bitmap_frozen(bitmap)) {
2837 error_setg(errp,
2838 "Bitmap '%s' is currently frozen and cannot be modified",
2839 name);
2840 goto out;
2841 } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2842 error_setg(errp,
2843 "Bitmap '%s' is currently disabled and cannot be cleared",
2844 name);
2845 goto out;
2848 bdrv_clear_dirty_bitmap(bitmap, NULL);
2850 out:
2851 aio_context_release(aio_context);
2854 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2856 const char *id = qdict_get_str(qdict, "id");
2857 BlockBackend *blk;
2858 BlockDriverState *bs;
2859 AioContext *aio_context;
2860 Error *local_err = NULL;
2862 bs = bdrv_find_node(id);
2863 if (bs) {
2864 qmp_x_blockdev_del(false, NULL, true, id, &local_err);
2865 if (local_err) {
2866 error_report_err(local_err);
2868 return;
2871 blk = blk_by_name(id);
2872 if (!blk) {
2873 error_report("Device '%s' not found", id);
2874 return;
2877 if (!blk_legacy_dinfo(blk)) {
2878 error_report("Deleting device added with blockdev-add"
2879 " is not supported");
2880 return;
2883 aio_context = blk_get_aio_context(blk);
2884 aio_context_acquire(aio_context);
2886 bs = blk_bs(blk);
2887 if (bs) {
2888 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2889 error_report_err(local_err);
2890 aio_context_release(aio_context);
2891 return;
2894 blk_remove_bs(blk);
2897 /* Make the BlockBackend and the attached BlockDriverState anonymous */
2898 monitor_remove_blk(blk);
2900 /* If this BlockBackend has a device attached to it, its refcount will be
2901 * decremented when the device is removed; otherwise we have to do so here.
2903 if (blk_get_attached_dev(blk)) {
2904 /* Further I/O must not pause the guest */
2905 blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2906 BLOCKDEV_ON_ERROR_REPORT);
2907 } else {
2908 blk_unref(blk);
2911 aio_context_release(aio_context);
2914 void qmp_block_resize(bool has_device, const char *device,
2915 bool has_node_name, const char *node_name,
2916 int64_t size, Error **errp)
2918 Error *local_err = NULL;
2919 BlockDriverState *bs;
2920 AioContext *aio_context;
2921 int ret;
2923 bs = bdrv_lookup_bs(has_device ? device : NULL,
2924 has_node_name ? node_name : NULL,
2925 &local_err);
2926 if (local_err) {
2927 error_propagate(errp, local_err);
2928 return;
2931 aio_context = bdrv_get_aio_context(bs);
2932 aio_context_acquire(aio_context);
2934 if (!bdrv_is_first_non_filter(bs)) {
2935 error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2936 goto out;
2939 if (size < 0) {
2940 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2941 goto out;
2944 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2945 error_setg(errp, QERR_DEVICE_IN_USE, device);
2946 goto out;
2949 /* complete all in-flight operations before resizing the device */
2950 bdrv_drain_all();
2952 ret = bdrv_truncate(bs, size);
2953 switch (ret) {
2954 case 0:
2955 break;
2956 case -ENOMEDIUM:
2957 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2958 break;
2959 case -ENOTSUP:
2960 error_setg(errp, QERR_UNSUPPORTED);
2961 break;
2962 case -EACCES:
2963 error_setg(errp, "Device '%s' is read only", device);
2964 break;
2965 case -EBUSY:
2966 error_setg(errp, QERR_DEVICE_IN_USE, device);
2967 break;
2968 default:
2969 error_setg_errno(errp, -ret, "Could not resize");
2970 break;
2973 out:
2974 aio_context_release(aio_context);
2977 static void block_job_cb(void *opaque, int ret)
2979 /* Note that this function may be executed from another AioContext besides
2980 * the QEMU main loop. If you need to access anything that assumes the
2981 * QEMU global mutex, use a BH or introduce a mutex.
2984 BlockDriverState *bs = opaque;
2985 const char *msg = NULL;
2987 trace_block_job_cb(bs, bs->job, ret);
2989 assert(bs->job);
2991 if (ret < 0) {
2992 msg = strerror(-ret);
2995 if (block_job_is_cancelled(bs->job)) {
2996 block_job_event_cancelled(bs->job);
2997 } else {
2998 block_job_event_completed(bs->job, msg);
3002 void qmp_block_stream(const char *device,
3003 bool has_base, const char *base,
3004 bool has_backing_file, const char *backing_file,
3005 bool has_speed, int64_t speed,
3006 bool has_on_error, BlockdevOnError on_error,
3007 Error **errp)
3009 BlockBackend *blk;
3010 BlockDriverState *bs;
3011 BlockDriverState *base_bs = NULL;
3012 AioContext *aio_context;
3013 Error *local_err = NULL;
3014 const char *base_name = NULL;
3016 if (!has_on_error) {
3017 on_error = BLOCKDEV_ON_ERROR_REPORT;
3020 blk = blk_by_name(device);
3021 if (!blk) {
3022 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3023 "Device '%s' not found", device);
3024 return;
3027 aio_context = blk_get_aio_context(blk);
3028 aio_context_acquire(aio_context);
3030 if (!blk_is_available(blk)) {
3031 error_setg(errp, "Device '%s' has no medium", device);
3032 goto out;
3034 bs = blk_bs(blk);
3036 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
3037 goto out;
3040 if (has_base) {
3041 base_bs = bdrv_find_backing_image(bs, base);
3042 if (base_bs == NULL) {
3043 error_setg(errp, QERR_BASE_NOT_FOUND, base);
3044 goto out;
3046 assert(bdrv_get_aio_context(base_bs) == aio_context);
3047 base_name = base;
3050 /* if we are streaming the entire chain, the result will have no backing
3051 * file, and specifying one is therefore an error */
3052 if (base_bs == NULL && has_backing_file) {
3053 error_setg(errp, "backing file specified, but streaming the "
3054 "entire chain");
3055 goto out;
3058 /* backing_file string overrides base bs filename */
3059 base_name = has_backing_file ? backing_file : base_name;
3061 stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
3062 on_error, block_job_cb, bs, &local_err);
3063 if (local_err) {
3064 error_propagate(errp, local_err);
3065 goto out;
3068 trace_qmp_block_stream(bs, bs->job);
3070 out:
3071 aio_context_release(aio_context);
3074 void qmp_block_commit(const char *device,
3075 bool has_base, const char *base,
3076 bool has_top, const char *top,
3077 bool has_backing_file, const char *backing_file,
3078 bool has_speed, int64_t speed,
3079 Error **errp)
3081 BlockBackend *blk;
3082 BlockDriverState *bs;
3083 BlockDriverState *base_bs, *top_bs;
3084 AioContext *aio_context;
3085 Error *local_err = NULL;
3086 /* This will be part of the QMP command, if/when the
3087 * BlockdevOnError change for blkmirror makes it in
3089 BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3091 if (!has_speed) {
3092 speed = 0;
3095 /* Important Note:
3096 * libvirt relies on the DeviceNotFound error class in order to probe for
3097 * live commit feature versions; for this to work, we must make sure to
3098 * perform the device lookup before any generic errors that may occur in a
3099 * scenario in which all optional arguments are omitted. */
3100 blk = blk_by_name(device);
3101 if (!blk) {
3102 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3103 "Device '%s' not found", device);
3104 return;
3107 aio_context = blk_get_aio_context(blk);
3108 aio_context_acquire(aio_context);
3110 if (!blk_is_available(blk)) {
3111 error_setg(errp, "Device '%s' has no medium", device);
3112 goto out;
3114 bs = blk_bs(blk);
3116 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3117 goto out;
3120 /* default top_bs is the active layer */
3121 top_bs = bs;
3123 if (has_top && top) {
3124 if (strcmp(bs->filename, top) != 0) {
3125 top_bs = bdrv_find_backing_image(bs, top);
3129 if (top_bs == NULL) {
3130 error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3131 goto out;
3134 assert(bdrv_get_aio_context(top_bs) == aio_context);
3136 if (has_base && base) {
3137 base_bs = bdrv_find_backing_image(top_bs, base);
3138 } else {
3139 base_bs = bdrv_find_base(top_bs);
3142 if (base_bs == NULL) {
3143 error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3144 goto out;
3147 assert(bdrv_get_aio_context(base_bs) == aio_context);
3149 if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3150 goto out;
3153 /* Do not allow attempts to commit an image into itself */
3154 if (top_bs == base_bs) {
3155 error_setg(errp, "cannot commit an image into itself");
3156 goto out;
3159 if (top_bs == bs) {
3160 if (has_backing_file) {
3161 error_setg(errp, "'backing-file' specified,"
3162 " but 'top' is the active layer");
3163 goto out;
3165 commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
3166 bs, &local_err);
3167 } else {
3168 commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
3169 has_backing_file ? backing_file : NULL, &local_err);
3171 if (local_err != NULL) {
3172 error_propagate(errp, local_err);
3173 goto out;
3176 out:
3177 aio_context_release(aio_context);
3180 static void do_drive_backup(const char *device, const char *target,
3181 bool has_format, const char *format,
3182 enum MirrorSyncMode sync,
3183 bool has_mode, enum NewImageMode mode,
3184 bool has_speed, int64_t speed,
3185 bool has_bitmap, const char *bitmap,
3186 bool has_on_source_error,
3187 BlockdevOnError on_source_error,
3188 bool has_on_target_error,
3189 BlockdevOnError on_target_error,
3190 BlockJobTxn *txn, Error **errp)
3192 BlockBackend *blk;
3193 BlockDriverState *bs;
3194 BlockDriverState *target_bs;
3195 BlockDriverState *source = NULL;
3196 BdrvDirtyBitmap *bmap = NULL;
3197 AioContext *aio_context;
3198 QDict *options = NULL;
3199 Error *local_err = NULL;
3200 int flags;
3201 int64_t size;
3202 int ret;
3204 if (!has_speed) {
3205 speed = 0;
3207 if (!has_on_source_error) {
3208 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3210 if (!has_on_target_error) {
3211 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3213 if (!has_mode) {
3214 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3217 blk = blk_by_name(device);
3218 if (!blk) {
3219 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3220 "Device '%s' not found", device);
3221 return;
3224 aio_context = blk_get_aio_context(blk);
3225 aio_context_acquire(aio_context);
3227 /* Although backup_run has this check too, we need to use bs->drv below, so
3228 * do an early check redundantly. */
3229 if (!blk_is_available(blk)) {
3230 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3231 goto out;
3233 bs = blk_bs(blk);
3235 if (!has_format) {
3236 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
3239 /* Early check to avoid creating target */
3240 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3241 goto out;
3244 flags = bs->open_flags | BDRV_O_RDWR;
3246 /* See if we have a backing HD we can use to create our new image
3247 * on top of. */
3248 if (sync == MIRROR_SYNC_MODE_TOP) {
3249 source = backing_bs(bs);
3250 if (!source) {
3251 sync = MIRROR_SYNC_MODE_FULL;
3254 if (sync == MIRROR_SYNC_MODE_NONE) {
3255 source = bs;
3258 size = bdrv_getlength(bs);
3259 if (size < 0) {
3260 error_setg_errno(errp, -size, "bdrv_getlength failed");
3261 goto out;
3264 if (mode != NEW_IMAGE_MODE_EXISTING) {
3265 assert(format);
3266 if (source) {
3267 bdrv_img_create(target, format, source->filename,
3268 source->drv->format_name, NULL,
3269 size, flags, &local_err, false);
3270 } else {
3271 bdrv_img_create(target, format, NULL, NULL, NULL,
3272 size, flags, &local_err, false);
3276 if (local_err) {
3277 error_propagate(errp, local_err);
3278 goto out;
3281 if (format) {
3282 options = qdict_new();
3283 qdict_put(options, "driver", qstring_from_str(format));
3286 target_bs = NULL;
3287 ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
3288 if (ret < 0) {
3289 error_propagate(errp, local_err);
3290 goto out;
3293 bdrv_set_aio_context(target_bs, aio_context);
3295 if (has_bitmap) {
3296 bmap = bdrv_find_dirty_bitmap(bs, bitmap);
3297 if (!bmap) {
3298 error_setg(errp, "Bitmap '%s' could not be found", bitmap);
3299 bdrv_unref(target_bs);
3300 goto out;
3304 backup_start(bs, target_bs, speed, sync, bmap,
3305 on_source_error, on_target_error,
3306 block_job_cb, bs, txn, &local_err);
3307 if (local_err != NULL) {
3308 bdrv_unref(target_bs);
3309 error_propagate(errp, local_err);
3310 goto out;
3313 out:
3314 aio_context_release(aio_context);
3317 void qmp_drive_backup(const char *device, const char *target,
3318 bool has_format, const char *format,
3319 enum MirrorSyncMode sync,
3320 bool has_mode, enum NewImageMode mode,
3321 bool has_speed, int64_t speed,
3322 bool has_bitmap, const char *bitmap,
3323 bool has_on_source_error, BlockdevOnError on_source_error,
3324 bool has_on_target_error, BlockdevOnError on_target_error,
3325 Error **errp)
3327 return do_drive_backup(device, target, has_format, format, sync,
3328 has_mode, mode, has_speed, speed,
3329 has_bitmap, bitmap,
3330 has_on_source_error, on_source_error,
3331 has_on_target_error, on_target_error,
3332 NULL, errp);
3335 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3337 return bdrv_named_nodes_list(errp);
3340 void do_blockdev_backup(const char *device, const char *target,
3341 enum MirrorSyncMode sync,
3342 bool has_speed, int64_t speed,
3343 bool has_on_source_error,
3344 BlockdevOnError on_source_error,
3345 bool has_on_target_error,
3346 BlockdevOnError on_target_error,
3347 BlockJobTxn *txn, Error **errp)
3349 BlockBackend *blk, *target_blk;
3350 BlockDriverState *bs;
3351 BlockDriverState *target_bs;
3352 Error *local_err = NULL;
3353 AioContext *aio_context;
3355 if (!has_speed) {
3356 speed = 0;
3358 if (!has_on_source_error) {
3359 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3361 if (!has_on_target_error) {
3362 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3365 blk = blk_by_name(device);
3366 if (!blk) {
3367 error_setg(errp, "Device '%s' not found", device);
3368 return;
3371 aio_context = blk_get_aio_context(blk);
3372 aio_context_acquire(aio_context);
3374 if (!blk_is_available(blk)) {
3375 error_setg(errp, "Device '%s' has no medium", device);
3376 goto out;
3378 bs = blk_bs(blk);
3380 target_blk = blk_by_name(target);
3381 if (!target_blk) {
3382 error_setg(errp, "Device '%s' not found", target);
3383 goto out;
3386 if (!blk_is_available(target_blk)) {
3387 error_setg(errp, "Device '%s' has no medium", target);
3388 goto out;
3390 target_bs = blk_bs(target_blk);
3392 bdrv_ref(target_bs);
3393 bdrv_set_aio_context(target_bs, aio_context);
3394 backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
3395 on_target_error, block_job_cb, bs, txn, &local_err);
3396 if (local_err != NULL) {
3397 bdrv_unref(target_bs);
3398 error_propagate(errp, local_err);
3400 out:
3401 aio_context_release(aio_context);
3404 void qmp_blockdev_backup(const char *device, const char *target,
3405 enum MirrorSyncMode sync,
3406 bool has_speed, int64_t speed,
3407 bool has_on_source_error,
3408 BlockdevOnError on_source_error,
3409 bool has_on_target_error,
3410 BlockdevOnError on_target_error,
3411 Error **errp)
3413 do_blockdev_backup(device, target, sync, has_speed, speed,
3414 has_on_source_error, on_source_error,
3415 has_on_target_error, on_target_error,
3416 NULL, errp);
3419 /* Parameter check and block job starting for drive mirroring.
3420 * Caller should hold @device and @target's aio context (must be the same).
3422 static void blockdev_mirror_common(BlockDriverState *bs,
3423 BlockDriverState *target,
3424 bool has_replaces, const char *replaces,
3425 enum MirrorSyncMode sync,
3426 bool has_speed, int64_t speed,
3427 bool has_granularity, uint32_t granularity,
3428 bool has_buf_size, int64_t buf_size,
3429 bool has_on_source_error,
3430 BlockdevOnError on_source_error,
3431 bool has_on_target_error,
3432 BlockdevOnError on_target_error,
3433 bool has_unmap, bool unmap,
3434 Error **errp)
3437 if (!has_speed) {
3438 speed = 0;
3440 if (!has_on_source_error) {
3441 on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3443 if (!has_on_target_error) {
3444 on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3446 if (!has_granularity) {
3447 granularity = 0;
3449 if (!has_buf_size) {
3450 buf_size = 0;
3452 if (!has_unmap) {
3453 unmap = true;
3456 if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3457 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3458 "a value in range [512B, 64MB]");
3459 return;
3461 if (granularity & (granularity - 1)) {
3462 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3463 "power of 2");
3464 return;
3467 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3468 return;
3470 if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3471 return;
3473 if (bdrv_has_blk(target)) {
3474 error_setg(errp, "Cannot mirror to an attached block device");
3475 return;
3478 if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3479 sync = MIRROR_SYNC_MODE_FULL;
3482 /* pass the node name to replace to mirror start since it's loose coupling
3483 * and will allow to check whether the node still exist at mirror completion
3485 mirror_start(bs, target,
3486 has_replaces ? replaces : NULL,
3487 speed, granularity, buf_size, sync,
3488 on_source_error, on_target_error, unmap,
3489 block_job_cb, bs, errp);
3492 void qmp_drive_mirror(const char *device, const char *target,
3493 bool has_format, const char *format,
3494 bool has_node_name, const char *node_name,
3495 bool has_replaces, const char *replaces,
3496 enum MirrorSyncMode sync,
3497 bool has_mode, enum NewImageMode mode,
3498 bool has_speed, int64_t speed,
3499 bool has_granularity, uint32_t granularity,
3500 bool has_buf_size, int64_t buf_size,
3501 bool has_on_source_error, BlockdevOnError on_source_error,
3502 bool has_on_target_error, BlockdevOnError on_target_error,
3503 bool has_unmap, bool unmap,
3504 Error **errp)
3506 BlockDriverState *bs;
3507 BlockBackend *blk;
3508 BlockDriverState *source, *target_bs;
3509 AioContext *aio_context;
3510 Error *local_err = NULL;
3511 QDict *options = NULL;
3512 int flags;
3513 int64_t size;
3514 int ret;
3516 blk = blk_by_name(device);
3517 if (!blk) {
3518 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3519 "Device '%s' not found", device);
3520 return;
3523 aio_context = blk_get_aio_context(blk);
3524 aio_context_acquire(aio_context);
3526 if (!blk_is_available(blk)) {
3527 error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3528 goto out;
3530 bs = blk_bs(blk);
3531 if (!has_mode) {
3532 mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3535 if (!has_format) {
3536 format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
3539 flags = bs->open_flags | BDRV_O_RDWR;
3540 source = backing_bs(bs);
3541 if (!source && sync == MIRROR_SYNC_MODE_TOP) {
3542 sync = MIRROR_SYNC_MODE_FULL;
3544 if (sync == MIRROR_SYNC_MODE_NONE) {
3545 source = bs;
3548 size = bdrv_getlength(bs);
3549 if (size < 0) {
3550 error_setg_errno(errp, -size, "bdrv_getlength failed");
3551 goto out;
3554 if (has_replaces) {
3555 BlockDriverState *to_replace_bs;
3556 AioContext *replace_aio_context;
3557 int64_t replace_size;
3559 if (!has_node_name) {
3560 error_setg(errp, "a node-name must be provided when replacing a"
3561 " named node of the graph");
3562 goto out;
3565 to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
3567 if (!to_replace_bs) {
3568 error_propagate(errp, local_err);
3569 goto out;
3572 replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3573 aio_context_acquire(replace_aio_context);
3574 replace_size = bdrv_getlength(to_replace_bs);
3575 aio_context_release(replace_aio_context);
3577 if (size != replace_size) {
3578 error_setg(errp, "cannot replace image with a mirror image of "
3579 "different size");
3580 goto out;
3584 if ((sync == MIRROR_SYNC_MODE_FULL || !source)
3585 && mode != NEW_IMAGE_MODE_EXISTING)
3587 /* create new image w/o backing file */
3588 assert(format);
3589 bdrv_img_create(target, format,
3590 NULL, NULL, NULL, size, flags, &local_err, false);
3591 } else {
3592 switch (mode) {
3593 case NEW_IMAGE_MODE_EXISTING:
3594 break;
3595 case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3596 /* create new image with backing file */
3597 bdrv_img_create(target, format,
3598 source->filename,
3599 source->drv->format_name,
3600 NULL, size, flags, &local_err, false);
3601 break;
3602 default:
3603 abort();
3607 if (local_err) {
3608 error_propagate(errp, local_err);
3609 goto out;
3612 options = qdict_new();
3613 if (has_node_name) {
3614 qdict_put(options, "node-name", qstring_from_str(node_name));
3616 if (format) {
3617 qdict_put(options, "driver", qstring_from_str(format));
3620 /* Mirroring takes care of copy-on-write using the source's backing
3621 * file.
3623 target_bs = NULL;
3624 ret = bdrv_open(&target_bs, target, NULL, options,
3625 flags | BDRV_O_NO_BACKING, &local_err);
3626 if (ret < 0) {
3627 error_propagate(errp, local_err);
3628 goto out;
3631 bdrv_set_aio_context(target_bs, aio_context);
3633 blockdev_mirror_common(bs, target_bs,
3634 has_replaces, replaces, sync,
3635 has_speed, speed,
3636 has_granularity, granularity,
3637 has_buf_size, buf_size,
3638 has_on_source_error, on_source_error,
3639 has_on_target_error, on_target_error,
3640 has_unmap, unmap,
3641 &local_err);
3642 if (local_err) {
3643 error_propagate(errp, local_err);
3644 bdrv_unref(target_bs);
3646 out:
3647 aio_context_release(aio_context);
3650 void qmp_blockdev_mirror(const char *device, const char *target,
3651 bool has_replaces, const char *replaces,
3652 MirrorSyncMode sync,
3653 bool has_speed, int64_t speed,
3654 bool has_granularity, uint32_t granularity,
3655 bool has_buf_size, int64_t buf_size,
3656 bool has_on_source_error,
3657 BlockdevOnError on_source_error,
3658 bool has_on_target_error,
3659 BlockdevOnError on_target_error,
3660 Error **errp)
3662 BlockDriverState *bs;
3663 BlockBackend *blk;
3664 BlockDriverState *target_bs;
3665 AioContext *aio_context;
3666 Error *local_err = NULL;
3668 blk = blk_by_name(device);
3669 if (!blk) {
3670 error_setg(errp, "Device '%s' not found", device);
3671 return;
3673 bs = blk_bs(blk);
3675 if (!bs) {
3676 error_setg(errp, "Device '%s' has no media", device);
3677 return;
3680 target_bs = bdrv_lookup_bs(target, target, errp);
3681 if (!target_bs) {
3682 return;
3685 aio_context = bdrv_get_aio_context(bs);
3686 aio_context_acquire(aio_context);
3688 bdrv_ref(target_bs);
3689 bdrv_set_aio_context(target_bs, aio_context);
3691 blockdev_mirror_common(bs, target_bs,
3692 has_replaces, replaces, sync,
3693 has_speed, speed,
3694 has_granularity, granularity,
3695 has_buf_size, buf_size,
3696 has_on_source_error, on_source_error,
3697 has_on_target_error, on_target_error,
3698 true, true,
3699 &local_err);
3700 if (local_err) {
3701 error_propagate(errp, local_err);
3702 bdrv_unref(target_bs);
3705 aio_context_release(aio_context);
3708 /* Get the block job for a given device name and acquire its AioContext */
3709 static BlockJob *find_block_job(const char *device, AioContext **aio_context,
3710 Error **errp)
3712 BlockBackend *blk;
3713 BlockDriverState *bs;
3715 *aio_context = NULL;
3717 blk = blk_by_name(device);
3718 if (!blk) {
3719 goto notfound;
3722 *aio_context = blk_get_aio_context(blk);
3723 aio_context_acquire(*aio_context);
3725 if (!blk_is_available(blk)) {
3726 goto notfound;
3728 bs = blk_bs(blk);
3730 if (!bs->job) {
3731 goto notfound;
3734 return bs->job;
3736 notfound:
3737 error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3738 "No active block job on device '%s'", device);
3739 if (*aio_context) {
3740 aio_context_release(*aio_context);
3741 *aio_context = NULL;
3743 return NULL;
3746 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3748 AioContext *aio_context;
3749 BlockJob *job = find_block_job(device, &aio_context, errp);
3751 if (!job) {
3752 return;
3755 block_job_set_speed(job, speed, errp);
3756 aio_context_release(aio_context);
3759 void qmp_block_job_cancel(const char *device,
3760 bool has_force, bool force, Error **errp)
3762 AioContext *aio_context;
3763 BlockJob *job = find_block_job(device, &aio_context, errp);
3765 if (!job) {
3766 return;
3769 if (!has_force) {
3770 force = false;
3773 if (job->user_paused && !force) {
3774 error_setg(errp, "The block job for device '%s' is currently paused",
3775 device);
3776 goto out;
3779 trace_qmp_block_job_cancel(job);
3780 block_job_cancel(job);
3781 out:
3782 aio_context_release(aio_context);
3785 void qmp_block_job_pause(const char *device, Error **errp)
3787 AioContext *aio_context;
3788 BlockJob *job = find_block_job(device, &aio_context, errp);
3790 if (!job || job->user_paused) {
3791 return;
3794 job->user_paused = true;
3795 trace_qmp_block_job_pause(job);
3796 block_job_pause(job);
3797 aio_context_release(aio_context);
3800 void qmp_block_job_resume(const char *device, Error **errp)
3802 AioContext *aio_context;
3803 BlockJob *job = find_block_job(device, &aio_context, errp);
3805 if (!job || !job->user_paused) {
3806 return;
3809 job->user_paused = false;
3810 trace_qmp_block_job_resume(job);
3811 block_job_resume(job);
3812 aio_context_release(aio_context);
3815 void qmp_block_job_complete(const char *device, Error **errp)
3817 AioContext *aio_context;
3818 BlockJob *job = find_block_job(device, &aio_context, errp);
3820 if (!job) {
3821 return;
3824 trace_qmp_block_job_complete(job);
3825 block_job_complete(job, errp);
3826 aio_context_release(aio_context);
3829 void qmp_change_backing_file(const char *device,
3830 const char *image_node_name,
3831 const char *backing_file,
3832 Error **errp)
3834 BlockBackend *blk;
3835 BlockDriverState *bs = NULL;
3836 AioContext *aio_context;
3837 BlockDriverState *image_bs = NULL;
3838 Error *local_err = NULL;
3839 bool ro;
3840 int open_flags;
3841 int ret;
3843 blk = blk_by_name(device);
3844 if (!blk) {
3845 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3846 "Device '%s' not found", device);
3847 return;
3850 aio_context = blk_get_aio_context(blk);
3851 aio_context_acquire(aio_context);
3853 if (!blk_is_available(blk)) {
3854 error_setg(errp, "Device '%s' has no medium", device);
3855 goto out;
3857 bs = blk_bs(blk);
3859 image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3860 if (local_err) {
3861 error_propagate(errp, local_err);
3862 goto out;
3865 if (!image_bs) {
3866 error_setg(errp, "image file not found");
3867 goto out;
3870 if (bdrv_find_base(image_bs) == image_bs) {
3871 error_setg(errp, "not allowing backing file change on an image "
3872 "without a backing file");
3873 goto out;
3876 /* even though we are not necessarily operating on bs, we need it to
3877 * determine if block ops are currently prohibited on the chain */
3878 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3879 goto out;
3882 /* final sanity check */
3883 if (!bdrv_chain_contains(bs, image_bs)) {
3884 error_setg(errp, "'%s' and image file are not in the same chain",
3885 device);
3886 goto out;
3889 /* if not r/w, reopen to make r/w */
3890 open_flags = image_bs->open_flags;
3891 ro = bdrv_is_read_only(image_bs);
3893 if (ro) {
3894 bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3895 if (local_err) {
3896 error_propagate(errp, local_err);
3897 goto out;
3901 ret = bdrv_change_backing_file(image_bs, backing_file,
3902 image_bs->drv ? image_bs->drv->format_name : "");
3904 if (ret < 0) {
3905 error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3906 backing_file);
3907 /* don't exit here, so we can try to restore open flags if
3908 * appropriate */
3911 if (ro) {
3912 bdrv_reopen(image_bs, open_flags, &local_err);
3913 if (local_err) {
3914 error_propagate(errp, local_err); /* will preserve prior errp */
3918 out:
3919 aio_context_release(aio_context);
3922 void hmp_drive_add_node(Monitor *mon, const char *optstr)
3924 QemuOpts *opts;
3925 QDict *qdict;
3926 Error *local_err = NULL;
3928 opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
3929 if (!opts) {
3930 return;
3933 qdict = qemu_opts_to_qdict(opts, NULL);
3935 if (!qdict_get_try_str(qdict, "node-name")) {
3936 QDECREF(qdict);
3937 error_report("'node-name' needs to be specified");
3938 goto out;
3941 BlockDriverState *bs = bds_tree_init(qdict, &local_err);
3942 if (!bs) {
3943 error_report_err(local_err);
3944 goto out;
3947 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
3949 out:
3950 qemu_opts_del(opts);
3953 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3955 QmpOutputVisitor *ov = qmp_output_visitor_new();
3956 BlockDriverState *bs;
3957 BlockBackend *blk = NULL;
3958 QObject *obj;
3959 QDict *qdict;
3960 Error *local_err = NULL;
3962 /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3963 * cache.direct=false instead of silently switching to aio=threads, except
3964 * when called from drive_new().
3966 * For now, simply forbidding the combination for all drivers will do. */
3967 if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3968 bool direct = options->has_cache &&
3969 options->cache->has_direct &&
3970 options->cache->direct;
3971 if (!direct) {
3972 error_setg(errp, "aio=native requires cache.direct=true");
3973 goto fail;
3977 visit_type_BlockdevOptions(qmp_output_get_visitor(ov), NULL, &options,
3978 &local_err);
3979 if (local_err) {
3980 error_propagate(errp, local_err);
3981 goto fail;
3984 obj = qmp_output_get_qobject(ov);
3985 qdict = qobject_to_qdict(obj);
3987 qdict_flatten(qdict);
3989 if (options->has_id) {
3990 blk = blockdev_init(NULL, qdict, &local_err);
3991 if (local_err) {
3992 error_propagate(errp, local_err);
3993 goto fail;
3996 bs = blk_bs(blk);
3997 } else {
3998 if (!qdict_get_try_str(qdict, "node-name")) {
3999 error_setg(errp, "'id' and/or 'node-name' need to be specified for "
4000 "the root node");
4001 goto fail;
4004 bs = bds_tree_init(qdict, errp);
4005 if (!bs) {
4006 goto fail;
4009 QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4012 if (bs && bdrv_key_required(bs)) {
4013 if (blk) {
4014 monitor_remove_blk(blk);
4015 blk_unref(blk);
4016 } else {
4017 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4018 bdrv_unref(bs);
4020 error_setg(errp, "blockdev-add doesn't support encrypted devices");
4021 goto fail;
4024 fail:
4025 qmp_output_visitor_cleanup(ov);
4028 void qmp_x_blockdev_del(bool has_id, const char *id,
4029 bool has_node_name, const char *node_name, Error **errp)
4031 AioContext *aio_context;
4032 BlockBackend *blk;
4033 BlockDriverState *bs;
4035 if (has_id && has_node_name) {
4036 error_setg(errp, "Only one of id and node-name must be specified");
4037 return;
4038 } else if (!has_id && !has_node_name) {
4039 error_setg(errp, "No block device specified");
4040 return;
4043 if (has_id) {
4044 /* blk_by_name() never returns a BB that is not owned by the monitor */
4045 blk = blk_by_name(id);
4046 if (!blk) {
4047 error_setg(errp, "Cannot find block backend %s", id);
4048 return;
4050 if (blk_legacy_dinfo(blk)) {
4051 error_setg(errp, "Deleting block backend added with drive-add"
4052 " is not supported");
4053 return;
4055 if (blk_get_refcnt(blk) > 1) {
4056 error_setg(errp, "Block backend %s is in use", id);
4057 return;
4059 bs = blk_bs(blk);
4060 aio_context = blk_get_aio_context(blk);
4061 } else {
4062 blk = NULL;
4063 bs = bdrv_find_node(node_name);
4064 if (!bs) {
4065 error_setg(errp, "Cannot find node %s", node_name);
4066 return;
4068 if (bdrv_has_blk(bs)) {
4069 error_setg(errp, "Node %s is in use by %s",
4070 node_name, bdrv_get_parent_name(bs));
4071 return;
4073 aio_context = bdrv_get_aio_context(bs);
4076 aio_context_acquire(aio_context);
4078 if (bs) {
4079 if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
4080 goto out;
4083 if (!blk && !bs->monitor_list.tqe_prev) {
4084 error_setg(errp, "Node %s is not owned by the monitor",
4085 bs->node_name);
4086 goto out;
4089 if (bs->refcnt > 1) {
4090 error_setg(errp, "Block device %s is in use",
4091 bdrv_get_device_or_node_name(bs));
4092 goto out;
4096 if (blk) {
4097 monitor_remove_blk(blk);
4098 blk_unref(blk);
4099 } else {
4100 QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4101 bdrv_unref(bs);
4104 out:
4105 aio_context_release(aio_context);
4108 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
4109 const char *child_name)
4111 BdrvChild *child;
4113 QLIST_FOREACH(child, &parent_bs->children, next) {
4114 if (strcmp(child->name, child_name) == 0) {
4115 return child;
4119 return NULL;
4122 void qmp_x_blockdev_change(const char *parent, bool has_child,
4123 const char *child, bool has_node,
4124 const char *node, Error **errp)
4126 BlockDriverState *parent_bs, *new_bs = NULL;
4127 BdrvChild *p_child;
4129 parent_bs = bdrv_lookup_bs(parent, parent, errp);
4130 if (!parent_bs) {
4131 return;
4134 if (has_child == has_node) {
4135 if (has_child) {
4136 error_setg(errp, "The parameters child and node are in conflict");
4137 } else {
4138 error_setg(errp, "Either child or node must be specified");
4140 return;
4143 if (has_child) {
4144 p_child = bdrv_find_child(parent_bs, child);
4145 if (!p_child) {
4146 error_setg(errp, "Node '%s' does not have child '%s'",
4147 parent, child);
4148 return;
4150 bdrv_del_child(parent_bs, p_child, errp);
4153 if (has_node) {
4154 new_bs = bdrv_find_node(node);
4155 if (!new_bs) {
4156 error_setg(errp, "Node '%s' not found", node);
4157 return;
4159 bdrv_add_child(parent_bs, new_bs, errp);
4163 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4165 BlockJobInfoList *head = NULL, **p_next = &head;
4166 BlockDriverState *bs;
4167 BdrvNextIterator *it = NULL;
4169 while ((it = bdrv_next(it, &bs))) {
4170 AioContext *aio_context = bdrv_get_aio_context(bs);
4172 aio_context_acquire(aio_context);
4174 if (bs->job) {
4175 BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
4176 elem->value = block_job_query(bs->job);
4177 *p_next = elem;
4178 p_next = &elem->next;
4181 aio_context_release(aio_context);
4184 return head;
4187 QemuOptsList qemu_common_drive_opts = {
4188 .name = "drive",
4189 .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4190 .desc = {
4192 .name = "snapshot",
4193 .type = QEMU_OPT_BOOL,
4194 .help = "enable/disable snapshot mode",
4196 .name = "discard",
4197 .type = QEMU_OPT_STRING,
4198 .help = "discard operation (ignore/off, unmap/on)",
4200 .name = "aio",
4201 .type = QEMU_OPT_STRING,
4202 .help = "host AIO implementation (threads, native)",
4204 .name = BDRV_OPT_CACHE_WB,
4205 .type = QEMU_OPT_BOOL,
4206 .help = "Enable writeback mode",
4208 .name = "format",
4209 .type = QEMU_OPT_STRING,
4210 .help = "disk format (raw, qcow2, ...)",
4212 .name = "rerror",
4213 .type = QEMU_OPT_STRING,
4214 .help = "read error action",
4216 .name = "werror",
4217 .type = QEMU_OPT_STRING,
4218 .help = "write error action",
4220 .name = "read-only",
4221 .type = QEMU_OPT_BOOL,
4222 .help = "open drive file as read-only",
4224 .name = "throttling.iops-total",
4225 .type = QEMU_OPT_NUMBER,
4226 .help = "limit total I/O operations per second",
4228 .name = "throttling.iops-read",
4229 .type = QEMU_OPT_NUMBER,
4230 .help = "limit read operations per second",
4232 .name = "throttling.iops-write",
4233 .type = QEMU_OPT_NUMBER,
4234 .help = "limit write operations per second",
4236 .name = "throttling.bps-total",
4237 .type = QEMU_OPT_NUMBER,
4238 .help = "limit total bytes per second",
4240 .name = "throttling.bps-read",
4241 .type = QEMU_OPT_NUMBER,
4242 .help = "limit read bytes per second",
4244 .name = "throttling.bps-write",
4245 .type = QEMU_OPT_NUMBER,
4246 .help = "limit write bytes per second",
4248 .name = "throttling.iops-total-max",
4249 .type = QEMU_OPT_NUMBER,
4250 .help = "I/O operations burst",
4252 .name = "throttling.iops-read-max",
4253 .type = QEMU_OPT_NUMBER,
4254 .help = "I/O operations read burst",
4256 .name = "throttling.iops-write-max",
4257 .type = QEMU_OPT_NUMBER,
4258 .help = "I/O operations write burst",
4260 .name = "throttling.bps-total-max",
4261 .type = QEMU_OPT_NUMBER,
4262 .help = "total bytes burst",
4264 .name = "throttling.bps-read-max",
4265 .type = QEMU_OPT_NUMBER,
4266 .help = "total bytes read burst",
4268 .name = "throttling.bps-write-max",
4269 .type = QEMU_OPT_NUMBER,
4270 .help = "total bytes write burst",
4272 .name = "throttling.iops-total-max-length",
4273 .type = QEMU_OPT_NUMBER,
4274 .help = "length of the iops-total-max burst period, in seconds",
4276 .name = "throttling.iops-read-max-length",
4277 .type = QEMU_OPT_NUMBER,
4278 .help = "length of the iops-read-max burst period, in seconds",
4280 .name = "throttling.iops-write-max-length",
4281 .type = QEMU_OPT_NUMBER,
4282 .help = "length of the iops-write-max burst period, in seconds",
4284 .name = "throttling.bps-total-max-length",
4285 .type = QEMU_OPT_NUMBER,
4286 .help = "length of the bps-total-max burst period, in seconds",
4288 .name = "throttling.bps-read-max-length",
4289 .type = QEMU_OPT_NUMBER,
4290 .help = "length of the bps-read-max burst period, in seconds",
4292 .name = "throttling.bps-write-max-length",
4293 .type = QEMU_OPT_NUMBER,
4294 .help = "length of the bps-write-max burst period, in seconds",
4296 .name = "throttling.iops-size",
4297 .type = QEMU_OPT_NUMBER,
4298 .help = "when limiting by iops max size of an I/O in bytes",
4300 .name = "throttling.group",
4301 .type = QEMU_OPT_STRING,
4302 .help = "name of the block throttling group",
4304 .name = "copy-on-read",
4305 .type = QEMU_OPT_BOOL,
4306 .help = "copy read data from backing file into image file",
4308 .name = "detect-zeroes",
4309 .type = QEMU_OPT_STRING,
4310 .help = "try to optimize zero writes (off, on, unmap)",
4312 .name = "stats-account-invalid",
4313 .type = QEMU_OPT_BOOL,
4314 .help = "whether to account for invalid I/O operations "
4315 "in the statistics",
4317 .name = "stats-account-failed",
4318 .type = QEMU_OPT_BOOL,
4319 .help = "whether to account for failed I/O operations "
4320 "in the statistics",
4322 { /* end of list */ }
4326 static QemuOptsList qemu_root_bds_opts = {
4327 .name = "root-bds",
4328 .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4329 .desc = {
4331 .name = "discard",
4332 .type = QEMU_OPT_STRING,
4333 .help = "discard operation (ignore/off, unmap/on)",
4335 .name = "aio",
4336 .type = QEMU_OPT_STRING,
4337 .help = "host AIO implementation (threads, native)",
4339 .name = "read-only",
4340 .type = QEMU_OPT_BOOL,
4341 .help = "open drive file as read-only",
4343 .name = "copy-on-read",
4344 .type = QEMU_OPT_BOOL,
4345 .help = "copy read data from backing file into image file",
4347 .name = "detect-zeroes",
4348 .type = QEMU_OPT_STRING,
4349 .help = "try to optimize zero writes (off, on, unmap)",
4351 { /* end of list */ }
4355 QemuOptsList qemu_drive_opts = {
4356 .name = "drive",
4357 .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4358 .desc = {
4360 * no elements => accept any params
4361 * validation will happen later
4363 { /* end of list */ }