blockdev.c

   1 /*
   2  * QEMU host block devices
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   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.
   8  *
   9  * This file incorporates work covered by the following copyright and
  10  * permission notice:
  11  *
  12  * Copyright (c) 2003-2008 Fabrice Bellard
  13  *
  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:
  20  *
  21  * The above copyright notice and this permission notice shall be included in
  22  * all copies or substantial portions of the Software.
  23  *
  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.
  31  */
  32
  33 #include "qemu/osdep.h"
  34 #include "sysemu/block-backend.h"
  35 #include "sysemu/blockdev.h"
  36 #include "hw/block/block.h"
  37 #include "block/blockjob.h"
  38 #include "block/qdict.h"
  39 #include "block/throttle-groups.h"
  40 #include "monitor/monitor.h"
  41 #include "qemu/error-report.h"
  42 #include "qemu/option.h"
  43 #include "qemu/qemu-print.h"
  44 #include "qemu/config-file.h"
  45 #include "qapi/qapi-commands-block.h"
  46 #include "qapi/qapi-commands-transaction.h"
  47 #include "qapi/qapi-visit-block-core.h"
  48 #include "qapi/qmp/qdict.h"
  49 #include "qapi/qmp/qnum.h"
  50 #include "qapi/qmp/qstring.h"
  51 #include "qapi/error.h"
  52 #include "qapi/qmp/qerror.h"
  53 #include "qapi/qmp/qlist.h"
  54 #include "qapi/qobject-output-visitor.h"
  55 #include "sysemu/sysemu.h"
  56 #include "sysemu/iothread.h"
  57 #include "block/block_int.h"
  58 #include "block/trace.h"
  59 #include "sysemu/arch_init.h"
  60 #include "sysemu/runstate.h"
  61 #include "sysemu/replay.h"
  62 #include "qemu/cutils.h"
  63 #include "qemu/help_option.h"
  64 #include "qemu/main-loop.h"
  65 #include "qemu/throttle-options.h"
  66
  67 QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
  68     QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
  69
  70 void bdrv_set_monitor_owned(BlockDriverState *bs)
  71 {
  72     QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
  73 }
  74
  75 static const char *const if_name[IF_COUNT] = {
  76     [IF_NONE] = "none",
  77     [IF_IDE] = "ide",
  78     [IF_SCSI] = "scsi",
  79     [IF_FLOPPY] = "floppy",
  80     [IF_PFLASH] = "pflash",
  81     [IF_MTD] = "mtd",
  82     [IF_SD] = "sd",
  83     [IF_VIRTIO] = "virtio",
  84     [IF_XEN] = "xen",
  85 };
  86
  87 static int if_max_devs[IF_COUNT] = {
  88     /*
  89      * Do not change these numbers!  They govern how drive option
  90      * index maps to unit and bus.  That mapping is ABI.
  91      *
  92      * All controllers used to implement if=T drives need to support
  93      * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
  94      * Otherwise, some index values map to "impossible" bus, unit
  95      * values.
  96      *
  97      * For instance, if you change [IF_SCSI] to 255, -drive
  98      * if=scsi,index=12 no longer means bus=1,unit=5, but
  99      * bus=0,unit=12.  With an lsi53c895a controller (7 units max),
 100      * the drive can't be set up.  Regression.
 101      */
 102     [IF_IDE] = 2,
 103     [IF_SCSI] = 7,
 104 };
 105
 106 /**
 107  * Boards may call this to offer board-by-board overrides
 108  * of the default, global values.
 109  */
 110 void override_max_devs(BlockInterfaceType type, int max_devs)
 111 {
 112     BlockBackend *blk;
 113     DriveInfo *dinfo;
 114
 115     if (max_devs <= 0) {
 116         return;
 117     }
 118
 119     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 120         dinfo = blk_legacy_dinfo(blk);
 121         if (dinfo->type == type) {
 122             fprintf(stderr, "Cannot override units-per-bus property of"
 123                     " the %s interface, because a drive of that type has"
 124                     " already been added.\n", if_name[type]);
 125             g_assert_not_reached();
 126         }
 127     }
 128
 129     if_max_devs[type] = max_devs;
 130 }
 131
 132 /*
 133  * We automatically delete the drive when a device using it gets
 134  * unplugged.  Questionable feature, but we can't just drop it.
 135  * Device models call blockdev_mark_auto_del() to schedule the
 136  * automatic deletion, and generic qdev code calls blockdev_auto_del()
 137  * when deletion is actually safe.
 138  */
 139 void blockdev_mark_auto_del(BlockBackend *blk)
 140 {
 141     DriveInfo *dinfo = blk_legacy_dinfo(blk);
 142     BlockJob *job;
 143
 144     if (!dinfo) {
 145         return;
 146     }
 147
 148     for (job = block_job_next(NULL); job; job = block_job_next(job)) {
 149         if (block_job_has_bdrv(job, blk_bs(blk))) {
 150             AioContext *aio_context = job->job.aio_context;
 151             aio_context_acquire(aio_context);
 152
 153             job_cancel(&job->job, false);
 154
 155             aio_context_release(aio_context);
 156         }
 157     }
 158
 159     dinfo->auto_del = 1;
 160 }
 161
 162 void blockdev_auto_del(BlockBackend *blk)
 163 {
 164     DriveInfo *dinfo = blk_legacy_dinfo(blk);
 165
 166     if (dinfo && dinfo->auto_del) {
 167         monitor_remove_blk(blk);
 168         blk_unref(blk);
 169     }
 170 }
 171
 172 /**
 173  * Returns the current mapping of how many units per bus
 174  * a particular interface can support.
 175  *
 176  *  A positive integer indicates n units per bus.
 177  *  0 implies the mapping has not been established.
 178  * -1 indicates an invalid BlockInterfaceType was given.
 179  */
 180 int drive_get_max_devs(BlockInterfaceType type)
 181 {
 182     if (type >= IF_IDE && type < IF_COUNT) {
 183         return if_max_devs[type];
 184     }
 185
 186     return -1;
 187 }
 188
 189 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
 190 {
 191     int max_devs = if_max_devs[type];
 192     return max_devs ? index / max_devs : 0;
 193 }
 194
 195 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
 196 {
 197     int max_devs = if_max_devs[type];
 198     return max_devs ? index % max_devs : index;
 199 }
 200
 201 QemuOpts *drive_def(const char *optstr)
 202 {
 203     return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
 204 }
 205
 206 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
 207                     const char *optstr)
 208 {
 209     QemuOpts *opts;
 210
 211     opts = drive_def(optstr);
 212     if (!opts) {
 213         return NULL;
 214     }
 215     if (type != IF_DEFAULT) {
 216         qemu_opt_set(opts, "if", if_name[type], &error_abort);
 217     }
 218     if (index >= 0) {
 219         qemu_opt_set_number(opts, "index", index, &error_abort);
 220     }
 221     if (file)
 222         qemu_opt_set(opts, "file", file, &error_abort);
 223     return opts;
 224 }
 225
 226 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
 227 {
 228     BlockBackend *blk;
 229     DriveInfo *dinfo;
 230
 231     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 232         dinfo = blk_legacy_dinfo(blk);
 233         if (dinfo && dinfo->type == type
 234             && dinfo->bus == bus && dinfo->unit == unit) {
 235             return dinfo;
 236         }
 237     }
 238
 239     return NULL;
 240 }
 241
 242 /*
 243  * Check board claimed all -drive that are meant to be claimed.
 244  * Fatal error if any remain unclaimed.
 245  */
 246 void drive_check_orphaned(void)
 247 {
 248     BlockBackend *blk;
 249     DriveInfo *dinfo;
 250     Location loc;
 251     bool orphans = false;
 252
 253     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 254         dinfo = blk_legacy_dinfo(blk);
 255         /*
 256          * Ignore default drives, because we create certain default
 257          * drives unconditionally, then leave them unclaimed.  Not the
 258          * users fault.
 259          * Ignore IF_VIRTIO, because it gets desugared into -device,
 260          * so we can leave failing to -device.
 261          * Ignore IF_NONE, because leaving unclaimed IF_NONE remains
 262          * available for device_add is a feature.
 263          */
 264         if (dinfo->is_default || dinfo->type == IF_VIRTIO
 265             || dinfo->type == IF_NONE) {
 266             continue;
 267         }
 268         if (!blk_get_attached_dev(blk)) {
 269             loc_push_none(&loc);
 270             qemu_opts_loc_restore(dinfo->opts);
 271             error_report("machine type does not support"
 272                          " if=%s,bus=%d,unit=%d",
 273                          if_name[dinfo->type], dinfo->bus, dinfo->unit);
 274             loc_pop(&loc);
 275             orphans = true;
 276         }
 277     }
 278
 279     if (orphans) {
 280         exit(1);
 281     }
 282 }
 283
 284 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
 285 {
 286     return drive_get(type,
 287                      drive_index_to_bus_id(type, index),
 288                      drive_index_to_unit_id(type, index));
 289 }
 290
 291 int drive_get_max_bus(BlockInterfaceType type)
 292 {
 293     int max_bus;
 294     BlockBackend *blk;
 295     DriveInfo *dinfo;
 296
 297     max_bus = -1;
 298     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 299         dinfo = blk_legacy_dinfo(blk);
 300         if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
 301             max_bus = dinfo->bus;
 302         }
 303     }
 304     return max_bus;
 305 }
 306
 307 /* Get a block device.  This should only be used for single-drive devices
 308    (e.g. SD/Floppy/MTD).  Multi-disk devices (scsi/ide) should use the
 309    appropriate bus.  */
 310 DriveInfo *drive_get_next(BlockInterfaceType type)
 311 {
 312     static int next_block_unit[IF_COUNT];
 313
 314     return drive_get(type, 0, next_block_unit[type]++);
 315 }
 316
 317 static void bdrv_format_print(void *opaque, const char *name)
 318 {
 319     qemu_printf(" %s", name);
 320 }
 321
 322 typedef struct {
 323     QEMUBH *bh;
 324     BlockDriverState *bs;
 325 } BDRVPutRefBH;
 326
 327 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
 328 {
 329     if (!strcmp(buf, "ignore")) {
 330         return BLOCKDEV_ON_ERROR_IGNORE;
 331     } else if (!is_read && !strcmp(buf, "enospc")) {
 332         return BLOCKDEV_ON_ERROR_ENOSPC;
 333     } else if (!strcmp(buf, "stop")) {
 334         return BLOCKDEV_ON_ERROR_STOP;
 335     } else if (!strcmp(buf, "report")) {
 336         return BLOCKDEV_ON_ERROR_REPORT;
 337     } else {
 338         error_setg(errp, "'%s' invalid %s error action",
 339                    buf, is_read ? "read" : "write");
 340         return -1;
 341     }
 342 }
 343
 344 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
 345                                   Error **errp)
 346 {
 347     const QListEntry *entry;
 348     for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
 349         switch (qobject_type(entry->value)) {
 350
 351         case QTYPE_QSTRING: {
 352             unsigned long long length;
 353             const char *str = qstring_get_str(qobject_to(QString,
 354                                                          entry->value));
 355             if (parse_uint_full(str, &length, 10) == 0 &&
 356                 length > 0 && length <= UINT_MAX) {
 357                 block_acct_add_interval(stats, (unsigned) length);
 358             } else {
 359                 error_setg(errp, "Invalid interval length: %s", str);
 360                 return false;
 361             }
 362             break;
 363         }
 364
 365         case QTYPE_QNUM: {
 366             int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
 367
 368             if (length > 0 && length <= UINT_MAX) {
 369                 block_acct_add_interval(stats, (unsigned) length);
 370             } else {
 371                 error_setg(errp, "Invalid interval length: %" PRId64, length);
 372                 return false;
 373             }
 374             break;
 375         }
 376
 377         default:
 378             error_setg(errp, "The specification of stats-intervals is invalid");
 379             return false;
 380         }
 381     }
 382     return true;
 383 }
 384
 385 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
 386
 387 /* All parameters but @opts are optional and may be set to NULL. */
 388 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
 389     const char **throttling_group, ThrottleConfig *throttle_cfg,
 390     BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
 391 {
 392     Error *local_error = NULL;
 393     const char *aio;
 394
 395     if (bdrv_flags) {
 396         if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
 397             *bdrv_flags |= BDRV_O_COPY_ON_READ;
 398         }
 399
 400         if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
 401             if (bdrv_parse_aio(aio, bdrv_flags) < 0) {
 402                 error_setg(errp, "invalid aio option");
 403                 return;
 404             }
 405         }
 406     }
 407
 408     /* disk I/O throttling */
 409     if (throttling_group) {
 410         *throttling_group = qemu_opt_get(opts, "throttling.group");
 411     }
 412
 413     if (throttle_cfg) {
 414         throttle_config_init(throttle_cfg);
 415         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
 416             qemu_opt_get_number(opts, "throttling.bps-total", 0);
 417         throttle_cfg->buckets[THROTTLE_BPS_READ].avg  =
 418             qemu_opt_get_number(opts, "throttling.bps-read", 0);
 419         throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
 420             qemu_opt_get_number(opts, "throttling.bps-write", 0);
 421         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
 422             qemu_opt_get_number(opts, "throttling.iops-total", 0);
 423         throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
 424             qemu_opt_get_number(opts, "throttling.iops-read", 0);
 425         throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
 426             qemu_opt_get_number(opts, "throttling.iops-write", 0);
 427
 428         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
 429             qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
 430         throttle_cfg->buckets[THROTTLE_BPS_READ].max  =
 431             qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
 432         throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
 433             qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
 434         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
 435             qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
 436         throttle_cfg->buckets[THROTTLE_OPS_READ].max =
 437             qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
 438         throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
 439             qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
 440
 441         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
 442             qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
 443         throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length  =
 444             qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
 445         throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
 446             qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
 447         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
 448             qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
 449         throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
 450             qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
 451         throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
 452             qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
 453
 454         throttle_cfg->op_size =
 455             qemu_opt_get_number(opts, "throttling.iops-size", 0);
 456
 457         if (!throttle_is_valid(throttle_cfg, errp)) {
 458             return;
 459         }
 460     }
 461
 462     if (detect_zeroes) {
 463         *detect_zeroes =
 464             qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
 465                             qemu_opt_get(opts, "detect-zeroes"),
 466                             BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
 467                             &local_error);
 468         if (local_error) {
 469             error_propagate(errp, local_error);
 470             return;
 471         }
 472     }
 473 }
 474
 475 /* Takes the ownership of bs_opts */
 476 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
 477                                    Error **errp)
 478 {
 479     const char *buf;
 480     int bdrv_flags = 0;
 481     int on_read_error, on_write_error;
 482     bool account_invalid, account_failed;
 483     bool writethrough, read_only;
 484     BlockBackend *blk;
 485     BlockDriverState *bs;
 486     ThrottleConfig cfg;
 487     int snapshot = 0;
 488     Error *error = NULL;
 489     QemuOpts *opts;
 490     QDict *interval_dict = NULL;
 491     QList *interval_list = NULL;
 492     const char *id;
 493     BlockdevDetectZeroesOptions detect_zeroes =
 494         BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
 495     const char *throttling_group = NULL;
 496
 497     /* Check common options by copying from bs_opts to opts, all other options
 498      * stay in bs_opts for processing by bdrv_open(). */
 499     id = qdict_get_try_str(bs_opts, "id");
 500     opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, errp);
 501     if (!opts) {
 502         goto err_no_opts;
 503     }
 504
 505     if (!qemu_opts_absorb_qdict(opts, bs_opts, errp)) {
 506         goto early_err;
 507     }
 508
 509     if (id) {
 510         qdict_del(bs_opts, "id");
 511     }
 512
 513     /* extract parameters */
 514     snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
 515
 516     account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
 517     account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);
 518
 519     writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
 520
 521     id = qemu_opts_id(opts);
 522
 523     qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
 524     qdict_array_split(interval_dict, &interval_list);
 525
 526     if (qdict_size(interval_dict) != 0) {
 527         error_setg(errp, "Invalid option stats-intervals.%s",
 528                    qdict_first(interval_dict)->key);
 529         goto early_err;
 530     }
 531
 532     extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
 533                                     &detect_zeroes, &error);
 534     if (error) {
 535         error_propagate(errp, error);
 536         goto early_err;
 537     }
 538
 539     if ((buf = qemu_opt_get(opts, "format")) != NULL) {
 540         if (is_help_option(buf)) {
 541             qemu_printf("Supported formats:");
 542             bdrv_iterate_format(bdrv_format_print, NULL, false);
 543             qemu_printf("\nSupported formats (read-only):");
 544             bdrv_iterate_format(bdrv_format_print, NULL, true);
 545             qemu_printf("\n");
 546             goto early_err;
 547         }
 548
 549         if (qdict_haskey(bs_opts, "driver")) {
 550             error_setg(errp, "Cannot specify both 'driver' and 'format'");
 551             goto early_err;
 552         }
 553         qdict_put_str(bs_opts, "driver", buf);
 554     }
 555
 556     on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
 557     if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
 558         on_write_error = parse_block_error_action(buf, 0, &error);
 559         if (error) {
 560             error_propagate(errp, error);
 561             goto early_err;
 562         }
 563     }
 564
 565     on_read_error = BLOCKDEV_ON_ERROR_REPORT;
 566     if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
 567         on_read_error = parse_block_error_action(buf, 1, &error);
 568         if (error) {
 569             error_propagate(errp, error);
 570             goto early_err;
 571         }
 572     }
 573
 574     if (snapshot) {
 575         bdrv_flags |= BDRV_O_SNAPSHOT;
 576     }
 577
 578     read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
 579
 580     /* init */
 581     if ((!file || !*file) && !qdict_size(bs_opts)) {
 582         BlockBackendRootState *blk_rs;
 583
 584         blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
 585         blk_rs = blk_get_root_state(blk);
 586         blk_rs->open_flags    = bdrv_flags;
 587         blk_rs->read_only     = read_only;
 588         blk_rs->detect_zeroes = detect_zeroes;
 589
 590         qobject_unref(bs_opts);
 591     } else {
 592         if (file && !*file) {
 593             file = NULL;
 594         }
 595
 596         /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
 597          * with other callers) rather than what we want as the real defaults.
 598          * Apply the defaults here instead. */
 599         qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
 600         qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
 601         qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
 602                               read_only ? "on" : "off");
 603         qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
 604         assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
 605
 606         if (runstate_check(RUN_STATE_INMIGRATE)) {
 607             bdrv_flags |= BDRV_O_INACTIVE;
 608         }
 609
 610         blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
 611         if (!blk) {
 612             goto err_no_bs_opts;
 613         }
 614         bs = blk_bs(blk);
 615
 616         bs->detect_zeroes = detect_zeroes;
 617
 618         block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
 619
 620         if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
 621             blk_unref(blk);
 622             blk = NULL;
 623             goto err_no_bs_opts;
 624         }
 625     }
 626
 627     /* disk I/O throttling */
 628     if (throttle_enabled(&cfg)) {
 629         if (!throttling_group) {
 630             throttling_group = id;
 631         }
 632         blk_io_limits_enable(blk, throttling_group);
 633         blk_set_io_limits(blk, &cfg);
 634     }
 635
 636     blk_set_enable_write_cache(blk, !writethrough);
 637     blk_set_on_error(blk, on_read_error, on_write_error);
 638
 639     if (!monitor_add_blk(blk, id, errp)) {
 640         blk_unref(blk);
 641         blk = NULL;
 642         goto err_no_bs_opts;
 643     }
 644
 645 err_no_bs_opts:
 646     qemu_opts_del(opts);
 647     qobject_unref(interval_dict);
 648     qobject_unref(interval_list);
 649     return blk;
 650
 651 early_err:
 652     qemu_opts_del(opts);
 653     qobject_unref(interval_dict);
 654     qobject_unref(interval_list);
 655 err_no_opts:
 656     qobject_unref(bs_opts);
 657     return NULL;
 658 }
 659
 660 /* Takes the ownership of bs_opts */
 661 BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
 662 {
 663     int bdrv_flags = 0;
 664
 665     /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
 666      * with other callers) rather than what we want as the real defaults.
 667      * Apply the defaults here instead. */
 668     qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
 669     qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
 670     qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
 671
 672     if (runstate_check(RUN_STATE_INMIGRATE)) {
 673         bdrv_flags |= BDRV_O_INACTIVE;
 674     }
 675
 676     return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
 677 }
 678
 679 void blockdev_close_all_bdrv_states(void)
 680 {
 681     BlockDriverState *bs, *next_bs;
 682
 683     QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
 684         AioContext *ctx = bdrv_get_aio_context(bs);
 685
 686         aio_context_acquire(ctx);
 687         bdrv_unref(bs);
 688         aio_context_release(ctx);
 689     }
 690 }
 691
 692 /* Iterates over the list of monitor-owned BlockDriverStates */
 693 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
 694 {
 695     return bs ? QTAILQ_NEXT(bs, monitor_list)
 696               : QTAILQ_FIRST(&monitor_bdrv_states);
 697 }
 698
 699 static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
 700                             Error **errp)
 701 {
 702     const char *value;
 703
 704     value = qemu_opt_get(opts, from);
 705     if (value) {
 706         if (qemu_opt_find(opts, to)) {
 707             error_setg(errp, "'%s' and its alias '%s' can't be used at the "
 708                        "same time", to, from);
 709             return false;
 710         }
 711     }
 712
 713     /* rename all items in opts */
 714     while ((value = qemu_opt_get(opts, from))) {
 715         qemu_opt_set(opts, to, value, &error_abort);
 716         qemu_opt_unset(opts, from);
 717     }
 718     return true;
 719 }
 720
 721 QemuOptsList qemu_legacy_drive_opts = {
 722     .name = "drive",
 723     .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
 724     .desc = {
 725         {
 726             .name = "bus",
 727             .type = QEMU_OPT_NUMBER,
 728             .help = "bus number",
 729         },{
 730             .name = "unit",
 731             .type = QEMU_OPT_NUMBER,
 732             .help = "unit number (i.e. lun for scsi)",
 733         },{
 734             .name = "index",
 735             .type = QEMU_OPT_NUMBER,
 736             .help = "index number",
 737         },{
 738             .name = "media",
 739             .type = QEMU_OPT_STRING,
 740             .help = "media type (disk, cdrom)",
 741         },{
 742             .name = "if",
 743             .type = QEMU_OPT_STRING,
 744             .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
 745         },{
 746             .name = "file",
 747             .type = QEMU_OPT_STRING,
 748             .help = "file name",
 749         },
 750
 751         /* Options that are passed on, but have special semantics with -drive */
 752         {
 753             .name = BDRV_OPT_READ_ONLY,
 754             .type = QEMU_OPT_BOOL,
 755             .help = "open drive file as read-only",
 756         },{
 757             .name = "rerror",
 758             .type = QEMU_OPT_STRING,
 759             .help = "read error action",
 760         },{
 761             .name = "werror",
 762             .type = QEMU_OPT_STRING,
 763             .help = "write error action",
 764         },{
 765             .name = "copy-on-read",
 766             .type = QEMU_OPT_BOOL,
 767             .help = "copy read data from backing file into image file",
 768         },
 769
 770         { /* end of list */ }
 771     },
 772 };
 773
 774 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
 775                      Error **errp)
 776 {
 777     const char *value;
 778     BlockBackend *blk;
 779     DriveInfo *dinfo = NULL;
 780     QDict *bs_opts;
 781     QemuOpts *legacy_opts;
 782     DriveMediaType media = MEDIA_DISK;
 783     BlockInterfaceType type;
 784     int max_devs, bus_id, unit_id, index;
 785     const char *werror, *rerror;
 786     bool read_only = false;
 787     bool copy_on_read;
 788     const char *filename;
 789     int i;
 790
 791     /* Change legacy command line options into QMP ones */
 792     static const struct {
 793         const char *from;
 794         const char *to;
 795     } opt_renames[] = {
 796         { "iops",           "throttling.iops-total" },
 797         { "iops_rd",        "throttling.iops-read" },
 798         { "iops_wr",        "throttling.iops-write" },
 799
 800         { "bps",            "throttling.bps-total" },
 801         { "bps_rd",         "throttling.bps-read" },
 802         { "bps_wr",         "throttling.bps-write" },
 803
 804         { "iops_max",       "throttling.iops-total-max" },
 805         { "iops_rd_max",    "throttling.iops-read-max" },
 806         { "iops_wr_max",    "throttling.iops-write-max" },
 807
 808         { "bps_max",        "throttling.bps-total-max" },
 809         { "bps_rd_max",     "throttling.bps-read-max" },
 810         { "bps_wr_max",     "throttling.bps-write-max" },
 811
 812         { "iops_size",      "throttling.iops-size" },
 813
 814         { "group",          "throttling.group" },
 815
 816         { "readonly",       BDRV_OPT_READ_ONLY },
 817     };
 818
 819     for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
 820         if (!qemu_opt_rename(all_opts, opt_renames[i].from,
 821                              opt_renames[i].to, errp)) {
 822             return NULL;
 823         }
 824     }
 825
 826     value = qemu_opt_get(all_opts, "cache");
 827     if (value) {
 828         int flags = 0;
 829         bool writethrough;
 830
 831         if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
 832             error_setg(errp, "invalid cache option");
 833             return NULL;
 834         }
 835
 836         /* Specific options take precedence */
 837         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
 838             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
 839                               !writethrough, &error_abort);
 840         }
 841         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
 842             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
 843                               !!(flags & BDRV_O_NOCACHE), &error_abort);
 844         }
 845         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
 846             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
 847                               !!(flags & BDRV_O_NO_FLUSH), &error_abort);
 848         }
 849         qemu_opt_unset(all_opts, "cache");
 850     }
 851
 852     /* Get a QDict for processing the options */
 853     bs_opts = qdict_new();
 854     qemu_opts_to_qdict(all_opts, bs_opts);
 855
 856     legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
 857                                    &error_abort);
 858     if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
 859         goto fail;
 860     }
 861
 862     /* Media type */
 863     value = qemu_opt_get(legacy_opts, "media");
 864     if (value) {
 865         if (!strcmp(value, "disk")) {
 866             media = MEDIA_DISK;
 867         } else if (!strcmp(value, "cdrom")) {
 868             media = MEDIA_CDROM;
 869             read_only = true;
 870         } else {
 871             error_setg(errp, "'%s' invalid media", value);
 872             goto fail;
 873         }
 874     }
 875
 876     /* copy-on-read is disabled with a warning for read-only devices */
 877     read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
 878     copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
 879
 880     if (read_only && copy_on_read) {
 881         warn_report("disabling copy-on-read on read-only drive");
 882         copy_on_read = false;
 883     }
 884
 885     qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
 886     qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
 887
 888     /* Controller type */
 889     value = qemu_opt_get(legacy_opts, "if");
 890     if (value) {
 891         for (type = 0;
 892              type < IF_COUNT && strcmp(value, if_name[type]);
 893              type++) {
 894         }
 895         if (type == IF_COUNT) {
 896             error_setg(errp, "unsupported bus type '%s'", value);
 897             goto fail;
 898         }
 899     } else {
 900         type = block_default_type;
 901     }
 902
 903     /* Device address specified by bus/unit or index.
 904      * If none was specified, try to find the first free one. */
 905     bus_id  = qemu_opt_get_number(legacy_opts, "bus", 0);
 906     unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
 907     index   = qemu_opt_get_number(legacy_opts, "index", -1);
 908
 909     max_devs = if_max_devs[type];
 910
 911     if (index != -1) {
 912         if (bus_id != 0 || unit_id != -1) {
 913             error_setg(errp, "index cannot be used with bus and unit");
 914             goto fail;
 915         }
 916         bus_id = drive_index_to_bus_id(type, index);
 917         unit_id = drive_index_to_unit_id(type, index);
 918     }
 919
 920     if (unit_id == -1) {
 921        unit_id = 0;
 922        while (drive_get(type, bus_id, unit_id) != NULL) {
 923            unit_id++;
 924            if (max_devs && unit_id >= max_devs) {
 925                unit_id -= max_devs;
 926                bus_id++;
 927            }
 928        }
 929     }
 930
 931     if (max_devs && unit_id >= max_devs) {
 932         error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
 933         goto fail;
 934     }
 935
 936     if (drive_get(type, bus_id, unit_id) != NULL) {
 937         error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
 938                    bus_id, unit_id, index);
 939         goto fail;
 940     }
 941
 942     /* no id supplied -> create one */
 943     if (qemu_opts_id(all_opts) == NULL) {
 944         char *new_id;
 945         const char *mediastr = "";
 946         if (type == IF_IDE || type == IF_SCSI) {
 947             mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
 948         }
 949         if (max_devs) {
 950             new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
 951                                      mediastr, unit_id);
 952         } else {
 953             new_id = g_strdup_printf("%s%s%i", if_name[type],
 954                                      mediastr, unit_id);
 955         }
 956         qdict_put_str(bs_opts, "id", new_id);
 957         g_free(new_id);
 958     }
 959
 960     /* Add virtio block device */
 961     if (type == IF_VIRTIO) {
 962         QemuOpts *devopts;
 963         devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
 964                                    &error_abort);
 965         qemu_opt_set(devopts, "driver", "virtio-blk", &error_abort);
 966         qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
 967                      &error_abort);
 968     }
 969
 970     filename = qemu_opt_get(legacy_opts, "file");
 971
 972     /* Check werror/rerror compatibility with if=... */
 973     werror = qemu_opt_get(legacy_opts, "werror");
 974     if (werror != NULL) {
 975         if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
 976             type != IF_NONE) {
 977             error_setg(errp, "werror is not supported by this bus type");
 978             goto fail;
 979         }
 980         qdict_put_str(bs_opts, "werror", werror);
 981     }
 982
 983     rerror = qemu_opt_get(legacy_opts, "rerror");
 984     if (rerror != NULL) {
 985         if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
 986             type != IF_NONE) {
 987             error_setg(errp, "rerror is not supported by this bus type");
 988             goto fail;
 989         }
 990         qdict_put_str(bs_opts, "rerror", rerror);
 991     }
 992
 993     /* Actual block device init: Functionality shared with blockdev-add */
 994     blk = blockdev_init(filename, bs_opts, errp);
 995     bs_opts = NULL;
 996     if (!blk) {
 997         goto fail;
 998     }
 999
1000     /* Create legacy DriveInfo */
1001     dinfo = g_malloc0(sizeof(*dinfo));
1002     dinfo->opts = all_opts;
1003
1004     dinfo->type = type;
1005     dinfo->bus = bus_id;
1006     dinfo->unit = unit_id;
1007
1008     blk_set_legacy_dinfo(blk, dinfo);
1009
1010     switch(type) {
1011     case IF_IDE:
1012     case IF_SCSI:
1013     case IF_XEN:
1014     case IF_NONE:
1015         dinfo->media_cd = media == MEDIA_CDROM;
1016         break;
1017     default:
1018         break;
1019     }
1020
1021 fail:
1022     qemu_opts_del(legacy_opts);
1023     qobject_unref(bs_opts);
1024     return dinfo;
1025 }
1026
1027 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1028 {
1029     BlockDriverState *bs;
1030
1031     bs = bdrv_lookup_bs(name, name, errp);
1032     if (bs == NULL) {
1033         return NULL;
1034     }
1035
1036     if (!bdrv_is_root_node(bs)) {
1037         error_setg(errp, "Need a root block node");
1038         return NULL;
1039     }
1040
1041     if (!bdrv_is_inserted(bs)) {
1042         error_setg(errp, "Device has no medium");
1043         return NULL;
1044     }
1045
1046     return bs;
1047 }
1048
1049 static void blockdev_do_action(TransactionAction *action, Error **errp)
1050 {
1051     TransactionActionList list;
1052
1053     list.value = action;
1054     list.next = NULL;
1055     qmp_transaction(&list, false, NULL, errp);
1056 }
1057
1058 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1059                                 bool has_node_name, const char *node_name,
1060                                 const char *snapshot_file,
1061                                 bool has_snapshot_node_name,
1062                                 const char *snapshot_node_name,
1063                                 bool has_format, const char *format,
1064                                 bool has_mode, NewImageMode mode, Error **errp)
1065 {
1066     BlockdevSnapshotSync snapshot = {
1067         .has_device = has_device,
1068         .device = (char *) device,
1069         .has_node_name = has_node_name,
1070         .node_name = (char *) node_name,
1071         .snapshot_file = (char *) snapshot_file,
1072         .has_snapshot_node_name = has_snapshot_node_name,
1073         .snapshot_node_name = (char *) snapshot_node_name,
1074         .has_format = has_format,
1075         .format = (char *) format,
1076         .has_mode = has_mode,
1077         .mode = mode,
1078     };
1079     TransactionAction action = {
1080         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1081         .u.blockdev_snapshot_sync.data = &snapshot,
1082     };
1083     blockdev_do_action(&action, errp);
1084 }
1085
1086 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1087                            Error **errp)
1088 {
1089     BlockdevSnapshot snapshot_data = {
1090         .node = (char *) node,
1091         .overlay = (char *) overlay
1092     };
1093     TransactionAction action = {
1094         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1095         .u.blockdev_snapshot.data = &snapshot_data,
1096     };
1097     blockdev_do_action(&action, errp);
1098 }
1099
1100 void qmp_blockdev_snapshot_internal_sync(const char *device,
1101                                          const char *name,
1102                                          Error **errp)
1103 {
1104     BlockdevSnapshotInternal snapshot = {
1105         .device = (char *) device,
1106         .name = (char *) name
1107     };
1108     TransactionAction action = {
1109         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1110         .u.blockdev_snapshot_internal_sync.data = &snapshot,
1111     };
1112     blockdev_do_action(&action, errp);
1113 }
1114
1115 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1116                                                          bool has_id,
1117                                                          const char *id,
1118                                                          bool has_name,
1119                                                          const char *name,
1120                                                          Error **errp)
1121 {
1122     BlockDriverState *bs;
1123     AioContext *aio_context;
1124     QEMUSnapshotInfo sn;
1125     Error *local_err = NULL;
1126     SnapshotInfo *info = NULL;
1127     int ret;
1128
1129     bs = qmp_get_root_bs(device, errp);
1130     if (!bs) {
1131         return NULL;
1132     }
1133     aio_context = bdrv_get_aio_context(bs);
1134     aio_context_acquire(aio_context);
1135
1136     if (!has_id) {
1137         id = NULL;
1138     }
1139
1140     if (!has_name) {
1141         name = NULL;
1142     }
1143
1144     if (!id && !name) {
1145         error_setg(errp, "Name or id must be provided");
1146         goto out_aio_context;
1147     }
1148
1149     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1150         goto out_aio_context;
1151     }
1152
1153     ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1154     if (local_err) {
1155         error_propagate(errp, local_err);
1156         goto out_aio_context;
1157     }
1158     if (!ret) {
1159         error_setg(errp,
1160                    "Snapshot with id '%s' and name '%s' does not exist on "
1161                    "device '%s'",
1162                    STR_OR_NULL(id), STR_OR_NULL(name), device);
1163         goto out_aio_context;
1164     }
1165
1166     bdrv_snapshot_delete(bs, id, name, &local_err);
1167     if (local_err) {
1168         error_propagate(errp, local_err);
1169         goto out_aio_context;
1170     }
1171
1172     aio_context_release(aio_context);
1173
1174     info = g_new0(SnapshotInfo, 1);
1175     info->id = g_strdup(sn.id_str);
1176     info->name = g_strdup(sn.name);
1177     info->date_nsec = sn.date_nsec;
1178     info->date_sec = sn.date_sec;
1179     info->vm_state_size = sn.vm_state_size;
1180     info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1181     info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1182     if (sn.icount != -1ULL) {
1183         info->icount = sn.icount;
1184         info->has_icount = true;
1185     }
1186
1187     return info;
1188
1189 out_aio_context:
1190     aio_context_release(aio_context);
1191     return NULL;
1192 }
1193
1194 /* New and old BlockDriverState structs for atomic group operations */
1195
1196 typedef struct BlkActionState BlkActionState;
1197
1198 /**
1199  * BlkActionOps:
1200  * Table of operations that define an Action.
1201  *
1202  * @instance_size: Size of state struct, in bytes.
1203  * @prepare: Prepare the work, must NOT be NULL.
1204  * @commit: Commit the changes, can be NULL.
1205  * @abort: Abort the changes on fail, can be NULL.
1206  * @clean: Clean up resources after all transaction actions have called
1207  *         commit() or abort(). Can be NULL.
1208  *
1209  * Only prepare() may fail. In a single transaction, only one of commit() or
1210  * abort() will be called. clean() will always be called if it is present.
1211  */
1212 typedef struct BlkActionOps {
1213     size_t instance_size;
1214     void (*prepare)(BlkActionState *common, Error **errp);
1215     void (*commit)(BlkActionState *common);
1216     void (*abort)(BlkActionState *common);
1217     void (*clean)(BlkActionState *common);
1218 } BlkActionOps;
1219
1220 /**
1221  * BlkActionState:
1222  * Describes one Action's state within a Transaction.
1223  *
1224  * @action: QAPI-defined enum identifying which Action to perform.
1225  * @ops: Table of ActionOps this Action can perform.
1226  * @block_job_txn: Transaction which this action belongs to.
1227  * @entry: List membership for all Actions in this Transaction.
1228  *
1229  * This structure must be arranged as first member in a subclassed type,
1230  * assuming that the compiler will also arrange it to the same offsets as the
1231  * base class.
1232  */
1233 struct BlkActionState {
1234     TransactionAction *action;
1235     const BlkActionOps *ops;
1236     JobTxn *block_job_txn;
1237     TransactionProperties *txn_props;
1238     QTAILQ_ENTRY(BlkActionState) entry;
1239 };
1240
1241 /* internal snapshot private data */
1242 typedef struct InternalSnapshotState {
1243     BlkActionState common;
1244     BlockDriverState *bs;
1245     QEMUSnapshotInfo sn;
1246     bool created;
1247 } InternalSnapshotState;
1248
1249
1250 static int action_check_completion_mode(BlkActionState *s, Error **errp)
1251 {
1252     if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
1253         error_setg(errp,
1254                    "Action '%s' does not support Transaction property "
1255                    "completion-mode = %s",
1256                    TransactionActionKind_str(s->action->type),
1257                    ActionCompletionMode_str(s->txn_props->completion_mode));
1258         return -1;
1259     }
1260     return 0;
1261 }
1262
1263 static void internal_snapshot_prepare(BlkActionState *common,
1264                                       Error **errp)
1265 {
1266     Error *local_err = NULL;
1267     const char *device;
1268     const char *name;
1269     BlockDriverState *bs;
1270     QEMUSnapshotInfo old_sn, *sn;
1271     bool ret;
1272     qemu_timeval tv;
1273     BlockdevSnapshotInternal *internal;
1274     InternalSnapshotState *state;
1275     AioContext *aio_context;
1276     int ret1;
1277
1278     g_assert(common->action->type ==
1279              TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1280     internal = common->action->u.blockdev_snapshot_internal_sync.data;
1281     state = DO_UPCAST(InternalSnapshotState, common, common);
1282
1283     /* 1. parse input */
1284     device = internal->device;
1285     name = internal->name;
1286
1287     /* 2. check for validation */
1288     if (action_check_completion_mode(common, errp) < 0) {
1289         return;
1290     }
1291
1292     bs = qmp_get_root_bs(device, errp);
1293     if (!bs) {
1294         return;
1295     }
1296
1297     aio_context = bdrv_get_aio_context(bs);
1298     aio_context_acquire(aio_context);
1299
1300     state->bs = bs;
1301
1302     /* Paired with .clean() */
1303     bdrv_drained_begin(bs);
1304
1305     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1306         goto out;
1307     }
1308
1309     if (bdrv_is_read_only(bs)) {
1310         error_setg(errp, "Device '%s' is read only", device);
1311         goto out;
1312     }
1313
1314     if (!bdrv_can_snapshot(bs)) {
1315         error_setg(errp, "Block format '%s' used by device '%s' "
1316                    "does not support internal snapshots",
1317                    bs->drv->format_name, device);
1318         goto out;
1319     }
1320
1321     if (!strlen(name)) {
1322         error_setg(errp, "Name is empty");
1323         goto out;
1324     }
1325
1326     /* check whether a snapshot with name exist */
1327     ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1328                                             &local_err);
1329     if (local_err) {
1330         error_propagate(errp, local_err);
1331         goto out;
1332     } else if (ret) {
1333         error_setg(errp,
1334                    "Snapshot with name '%s' already exists on device '%s'",
1335                    name, device);
1336         goto out;
1337     }
1338
1339     /* 3. take the snapshot */
1340     sn = &state->sn;
1341     pstrcpy(sn->name, sizeof(sn->name), name);
1342     qemu_gettimeofday(&tv);
1343     sn->date_sec = tv.tv_sec;
1344     sn->date_nsec = tv.tv_usec * 1000;
1345     sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1346     if (replay_mode != REPLAY_MODE_NONE) {
1347         sn->icount = replay_get_current_icount();
1348     } else {
1349         sn->icount = -1ULL;
1350     }
1351
1352     ret1 = bdrv_snapshot_create(bs, sn);
1353     if (ret1 < 0) {
1354         error_setg_errno(errp, -ret1,
1355                          "Failed to create snapshot '%s' on device '%s'",
1356                          name, device);
1357         goto out;
1358     }
1359
1360     /* 4. succeed, mark a snapshot is created */
1361     state->created = true;
1362
1363 out:
1364     aio_context_release(aio_context);
1365 }
1366
1367 static void internal_snapshot_abort(BlkActionState *common)
1368 {
1369     InternalSnapshotState *state =
1370                              DO_UPCAST(InternalSnapshotState, common, common);
1371     BlockDriverState *bs = state->bs;
1372     QEMUSnapshotInfo *sn = &state->sn;
1373     AioContext *aio_context;
1374     Error *local_error = NULL;
1375
1376     if (!state->created) {
1377         return;
1378     }
1379
1380     aio_context = bdrv_get_aio_context(state->bs);
1381     aio_context_acquire(aio_context);
1382
1383     if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1384         error_reportf_err(local_error,
1385                           "Failed to delete snapshot with id '%s' and "
1386                           "name '%s' on device '%s' in abort: ",
1387                           sn->id_str, sn->name,
1388                           bdrv_get_device_name(bs));
1389     }
1390
1391     aio_context_release(aio_context);
1392 }
1393
1394 static void internal_snapshot_clean(BlkActionState *common)
1395 {
1396     InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1397                                              common, common);
1398     AioContext *aio_context;
1399
1400     if (!state->bs) {
1401         return;
1402     }
1403
1404     aio_context = bdrv_get_aio_context(state->bs);
1405     aio_context_acquire(aio_context);
1406
1407     bdrv_drained_end(state->bs);
1408
1409     aio_context_release(aio_context);
1410 }
1411
1412 /* external snapshot private data */
1413 typedef struct ExternalSnapshotState {
1414     BlkActionState common;
1415     BlockDriverState *old_bs;
1416     BlockDriverState *new_bs;
1417     bool overlay_appended;
1418 } ExternalSnapshotState;
1419
1420 static void external_snapshot_prepare(BlkActionState *common,
1421                                       Error **errp)
1422 {
1423     int ret;
1424     int flags = 0;
1425     QDict *options = NULL;
1426     Error *local_err = NULL;
1427     /* Device and node name of the image to generate the snapshot from */
1428     const char *device;
1429     const char *node_name;
1430     /* Reference to the new image (for 'blockdev-snapshot') */
1431     const char *snapshot_ref;
1432     /* File name of the new image (for 'blockdev-snapshot-sync') */
1433     const char *new_image_file;
1434     ExternalSnapshotState *state =
1435                              DO_UPCAST(ExternalSnapshotState, common, common);
1436     TransactionAction *action = common->action;
1437     AioContext *aio_context;
1438     uint64_t perm, shared;
1439
1440     /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1441      * purpose but a different set of parameters */
1442     switch (action->type) {
1443     case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1444         {
1445             BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1446             device = s->node;
1447             node_name = s->node;
1448             new_image_file = NULL;
1449             snapshot_ref = s->overlay;
1450         }
1451         break;
1452     case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1453         {
1454             BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1455             device = s->has_device ? s->device : NULL;
1456             node_name = s->has_node_name ? s->node_name : NULL;
1457             new_image_file = s->snapshot_file;
1458             snapshot_ref = NULL;
1459         }
1460         break;
1461     default:
1462         g_assert_not_reached();
1463     }
1464
1465     /* start processing */
1466     if (action_check_completion_mode(common, errp) < 0) {
1467         return;
1468     }
1469
1470     state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1471     if (!state->old_bs) {
1472         return;
1473     }
1474
1475     aio_context = bdrv_get_aio_context(state->old_bs);
1476     aio_context_acquire(aio_context);
1477
1478     /* Paired with .clean() */
1479     bdrv_drained_begin(state->old_bs);
1480
1481     if (!bdrv_is_inserted(state->old_bs)) {
1482         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1483         goto out;
1484     }
1485
1486     if (bdrv_op_is_blocked(state->old_bs,
1487                            BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1488         goto out;
1489     }
1490
1491     if (!bdrv_is_read_only(state->old_bs)) {
1492         if (bdrv_flush(state->old_bs)) {
1493             error_setg(errp, QERR_IO_ERROR);
1494             goto out;
1495         }
1496     }
1497
1498     if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1499         BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1500         const char *format = s->has_format ? s->format : "qcow2";
1501         enum NewImageMode mode;
1502         const char *snapshot_node_name =
1503             s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1504
1505         if (node_name && !snapshot_node_name) {
1506             error_setg(errp, "New overlay node-name missing");
1507             goto out;
1508         }
1509
1510         if (snapshot_node_name &&
1511             bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1512             error_setg(errp, "New overlay node-name already in use");
1513             goto out;
1514         }
1515
1516         flags = state->old_bs->open_flags;
1517         flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1518         flags |= BDRV_O_NO_BACKING;
1519
1520         /* create new image w/backing file */
1521         mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1522         if (mode != NEW_IMAGE_MODE_EXISTING) {
1523             int64_t size = bdrv_getlength(state->old_bs);
1524             if (size < 0) {
1525                 error_setg_errno(errp, -size, "bdrv_getlength failed");
1526                 goto out;
1527             }
1528             bdrv_refresh_filename(state->old_bs);
1529             bdrv_img_create(new_image_file, format,
1530                             state->old_bs->filename,
1531                             state->old_bs->drv->format_name,
1532                             NULL, size, flags, false, &local_err);
1533             if (local_err) {
1534                 error_propagate(errp, local_err);
1535                 goto out;
1536             }
1537         }
1538
1539         options = qdict_new();
1540         if (snapshot_node_name) {
1541             qdict_put_str(options, "node-name", snapshot_node_name);
1542         }
1543         qdict_put_str(options, "driver", format);
1544     }
1545
1546     state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1547                               errp);
1548     /* We will manually add the backing_hd field to the bs later */
1549     if (!state->new_bs) {
1550         goto out;
1551     }
1552
1553     /*
1554      * Allow attaching a backing file to an overlay that's already in use only
1555      * if the parents don't assume that they are already seeing a valid image.
1556      * (Specifically, allow it as a mirror target, which is write-only access.)
1557      */
1558     bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1559     if (perm & BLK_PERM_CONSISTENT_READ) {
1560         error_setg(errp, "The overlay is already in use");
1561         goto out;
1562     }
1563
1564     if (state->new_bs->drv->is_filter) {
1565         error_setg(errp, "Filters cannot be used as overlays");
1566         goto out;
1567     }
1568
1569     if (bdrv_cow_child(state->new_bs)) {
1570         error_setg(errp, "The overlay already has a backing image");
1571         goto out;
1572     }
1573
1574     if (!state->new_bs->drv->supports_backing) {
1575         error_setg(errp, "The overlay does not support backing images");
1576         goto out;
1577     }
1578
1579     /* This removes our old bs and adds the new bs. This is an operation that
1580      * can fail, so we need to do it in .prepare; undoing it for abort is
1581      * always possible. */
1582     bdrv_ref(state->new_bs);
1583     ret = bdrv_append(state->new_bs, state->old_bs, errp);
1584     if (ret < 0) {
1585         goto out;
1586     }
1587     state->overlay_appended = true;
1588
1589 out:
1590     aio_context_release(aio_context);
1591 }
1592
1593 static void external_snapshot_commit(BlkActionState *common)
1594 {
1595     ExternalSnapshotState *state =
1596                              DO_UPCAST(ExternalSnapshotState, common, common);
1597     AioContext *aio_context;
1598
1599     aio_context = bdrv_get_aio_context(state->old_bs);
1600     aio_context_acquire(aio_context);
1601
1602     /* We don't need (or want) to use the transactional
1603      * bdrv_reopen_multiple() across all the entries at once, because we
1604      * don't want to abort all of them if one of them fails the reopen */
1605     if (!qatomic_read(&state->old_bs->copy_on_read)) {
1606         bdrv_reopen_set_read_only(state->old_bs, true, NULL);
1607     }
1608
1609     aio_context_release(aio_context);
1610 }
1611
1612 static void external_snapshot_abort(BlkActionState *common)
1613 {
1614     ExternalSnapshotState *state =
1615                              DO_UPCAST(ExternalSnapshotState, common, common);
1616     if (state->new_bs) {
1617         if (state->overlay_appended) {
1618             AioContext *aio_context;
1619             AioContext *tmp_context;
1620             int ret;
1621
1622             aio_context = bdrv_get_aio_context(state->old_bs);
1623             aio_context_acquire(aio_context);
1624
1625             bdrv_ref(state->old_bs);   /* we can't let bdrv_set_backind_hd()
1626                                           close state->old_bs; we need it */
1627             bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
1628
1629             /*
1630              * The call to bdrv_set_backing_hd() above returns state->old_bs to
1631              * the main AioContext. As we're still going to be using it, return
1632              * it to the AioContext it was before.
1633              */
1634             tmp_context = bdrv_get_aio_context(state->old_bs);
1635             if (aio_context != tmp_context) {
1636                 aio_context_release(aio_context);
1637                 aio_context_acquire(tmp_context);
1638
1639                 ret = bdrv_try_set_aio_context(state->old_bs,
1640                                                aio_context, NULL);
1641                 assert(ret == 0);
1642
1643                 aio_context_release(tmp_context);
1644                 aio_context_acquire(aio_context);
1645             }
1646
1647             bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
1648             bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
1649
1650             aio_context_release(aio_context);
1651         }
1652     }
1653 }
1654
1655 static void external_snapshot_clean(BlkActionState *common)
1656 {
1657     ExternalSnapshotState *state =
1658                              DO_UPCAST(ExternalSnapshotState, common, common);
1659     AioContext *aio_context;
1660
1661     if (!state->old_bs) {
1662         return;
1663     }
1664
1665     aio_context = bdrv_get_aio_context(state->old_bs);
1666     aio_context_acquire(aio_context);
1667
1668     bdrv_drained_end(state->old_bs);
1669     bdrv_unref(state->new_bs);
1670
1671     aio_context_release(aio_context);
1672 }
1673
1674 typedef struct DriveBackupState {
1675     BlkActionState common;
1676     BlockDriverState *bs;
1677     BlockJob *job;
1678 } DriveBackupState;
1679
1680 static BlockJob *do_backup_common(BackupCommon *backup,
1681                                   BlockDriverState *bs,
1682                                   BlockDriverState *target_bs,
1683                                   AioContext *aio_context,
1684                                   JobTxn *txn, Error **errp);
1685
1686 static void drive_backup_prepare(BlkActionState *common, Error **errp)
1687 {
1688     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1689     DriveBackup *backup;
1690     BlockDriverState *bs;
1691     BlockDriverState *target_bs;
1692     BlockDriverState *source = NULL;
1693     AioContext *aio_context;
1694     AioContext *old_context;
1695     QDict *options;
1696     Error *local_err = NULL;
1697     int flags;
1698     int64_t size;
1699     bool set_backing_hd = false;
1700     int ret;
1701
1702     assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1703     backup = common->action->u.drive_backup.data;
1704
1705     if (!backup->has_mode) {
1706         backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1707     }
1708
1709     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1710     if (!bs) {
1711         return;
1712     }
1713
1714     if (!bs->drv) {
1715         error_setg(errp, "Device has no medium");
1716         return;
1717     }
1718
1719     aio_context = bdrv_get_aio_context(bs);
1720     aio_context_acquire(aio_context);
1721
1722     /* Paired with .clean() */
1723     bdrv_drained_begin(bs);
1724
1725     if (!backup->has_format) {
1726         backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
1727                          NULL : (char *) bs->drv->format_name;
1728     }
1729
1730     /* Early check to avoid creating target */
1731     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
1732         goto out;
1733     }
1734
1735     flags = bs->open_flags | BDRV_O_RDWR;
1736
1737     /*
1738      * See if we have a backing HD we can use to create our new image
1739      * on top of.
1740      */
1741     if (backup->sync == MIRROR_SYNC_MODE_TOP) {
1742         /*
1743          * Backup will not replace the source by the target, so none
1744          * of the filters skipped here will be removed (in contrast to
1745          * mirror).  Therefore, we can skip all of them when looking
1746          * for the first COW relationship.
1747          */
1748         source = bdrv_cow_bs(bdrv_skip_filters(bs));
1749         if (!source) {
1750             backup->sync = MIRROR_SYNC_MODE_FULL;
1751         }
1752     }
1753     if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1754         source = bs;
1755         flags |= BDRV_O_NO_BACKING;
1756         set_backing_hd = true;
1757     }
1758
1759     size = bdrv_getlength(bs);
1760     if (size < 0) {
1761         error_setg_errno(errp, -size, "bdrv_getlength failed");
1762         goto out;
1763     }
1764
1765     if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
1766         assert(backup->format);
1767         if (source) {
1768             /* Implicit filters should not appear in the filename */
1769             BlockDriverState *explicit_backing =
1770                 bdrv_skip_implicit_filters(source);
1771
1772             bdrv_refresh_filename(explicit_backing);
1773             bdrv_img_create(backup->target, backup->format,
1774                             explicit_backing->filename,
1775                             explicit_backing->drv->format_name, NULL,
1776                             size, flags, false, &local_err);
1777         } else {
1778             bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
1779                             size, flags, false, &local_err);
1780         }
1781     }
1782
1783     if (local_err) {
1784         error_propagate(errp, local_err);
1785         goto out;
1786     }
1787
1788     options = qdict_new();
1789     qdict_put_str(options, "discard", "unmap");
1790     qdict_put_str(options, "detect-zeroes", "unmap");
1791     if (backup->format) {
1792         qdict_put_str(options, "driver", backup->format);
1793     }
1794
1795     target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
1796     if (!target_bs) {
1797         goto out;
1798     }
1799
1800     /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
1801     old_context = bdrv_get_aio_context(target_bs);
1802     aio_context_release(aio_context);
1803     aio_context_acquire(old_context);
1804
1805     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1806     if (ret < 0) {
1807         bdrv_unref(target_bs);
1808         aio_context_release(old_context);
1809         return;
1810     }
1811
1812     aio_context_release(old_context);
1813     aio_context_acquire(aio_context);
1814
1815     if (set_backing_hd) {
1816         if (bdrv_set_backing_hd(target_bs, source, errp) < 0) {
1817             goto unref;
1818         }
1819     }
1820
1821     state->bs = bs;
1822
1823     state->job = do_backup_common(qapi_DriveBackup_base(backup),
1824                                   bs, target_bs, aio_context,
1825                                   common->block_job_txn, errp);
1826
1827 unref:
1828     bdrv_unref(target_bs);
1829 out:
1830     aio_context_release(aio_context);
1831 }
1832
1833 static void drive_backup_commit(BlkActionState *common)
1834 {
1835     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1836     AioContext *aio_context;
1837
1838     aio_context = bdrv_get_aio_context(state->bs);
1839     aio_context_acquire(aio_context);
1840
1841     assert(state->job);
1842     job_start(&state->job->job);
1843
1844     aio_context_release(aio_context);
1845 }
1846
1847 static void drive_backup_abort(BlkActionState *common)
1848 {
1849     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1850
1851     if (state->job) {
1852         AioContext *aio_context;
1853
1854         aio_context = bdrv_get_aio_context(state->bs);
1855         aio_context_acquire(aio_context);
1856
1857         job_cancel_sync(&state->job->job);
1858
1859         aio_context_release(aio_context);
1860     }
1861 }
1862
1863 static void drive_backup_clean(BlkActionState *common)
1864 {
1865     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1866     AioContext *aio_context;
1867
1868     if (!state->bs) {
1869         return;
1870     }
1871
1872     aio_context = bdrv_get_aio_context(state->bs);
1873     aio_context_acquire(aio_context);
1874
1875     bdrv_drained_end(state->bs);
1876
1877     aio_context_release(aio_context);
1878 }
1879
1880 typedef struct BlockdevBackupState {
1881     BlkActionState common;
1882     BlockDriverState *bs;
1883     BlockJob *job;
1884 } BlockdevBackupState;
1885
1886 static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1887 {
1888     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1889     BlockdevBackup *backup;
1890     BlockDriverState *bs;
1891     BlockDriverState *target_bs;
1892     AioContext *aio_context;
1893     AioContext *old_context;
1894     int ret;
1895
1896     assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1897     backup = common->action->u.blockdev_backup.data;
1898
1899     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1900     if (!bs) {
1901         return;
1902     }
1903
1904     target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1905     if (!target_bs) {
1906         return;
1907     }
1908
1909     /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
1910     aio_context = bdrv_get_aio_context(bs);
1911     old_context = bdrv_get_aio_context(target_bs);
1912     aio_context_acquire(old_context);
1913
1914     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
1915     if (ret < 0) {
1916         aio_context_release(old_context);
1917         return;
1918     }
1919
1920     aio_context_release(old_context);
1921     aio_context_acquire(aio_context);
1922     state->bs = bs;
1923
1924     /* Paired with .clean() */
1925     bdrv_drained_begin(state->bs);
1926
1927     state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1928                                   bs, target_bs, aio_context,
1929                                   common->block_job_txn, errp);
1930
1931     aio_context_release(aio_context);
1932 }
1933
1934 static void blockdev_backup_commit(BlkActionState *common)
1935 {
1936     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1937     AioContext *aio_context;
1938
1939     aio_context = bdrv_get_aio_context(state->bs);
1940     aio_context_acquire(aio_context);
1941
1942     assert(state->job);
1943     job_start(&state->job->job);
1944
1945     aio_context_release(aio_context);
1946 }
1947
1948 static void blockdev_backup_abort(BlkActionState *common)
1949 {
1950     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1951
1952     if (state->job) {
1953         AioContext *aio_context;
1954
1955         aio_context = bdrv_get_aio_context(state->bs);
1956         aio_context_acquire(aio_context);
1957
1958         job_cancel_sync(&state->job->job);
1959
1960         aio_context_release(aio_context);
1961     }
1962 }
1963
1964 static void blockdev_backup_clean(BlkActionState *common)
1965 {
1966     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1967     AioContext *aio_context;
1968
1969     if (!state->bs) {
1970         return;
1971     }
1972
1973     aio_context = bdrv_get_aio_context(state->bs);
1974     aio_context_acquire(aio_context);
1975
1976     bdrv_drained_end(state->bs);
1977
1978     aio_context_release(aio_context);
1979 }
1980
1981 typedef struct BlockDirtyBitmapState {
1982     BlkActionState common;
1983     BdrvDirtyBitmap *bitmap;
1984     BlockDriverState *bs;
1985     HBitmap *backup;
1986     bool prepared;
1987     bool was_enabled;
1988 } BlockDirtyBitmapState;
1989
1990 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
1991                                            Error **errp)
1992 {
1993     Error *local_err = NULL;
1994     BlockDirtyBitmapAdd *action;
1995     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1996                                              common, common);
1997
1998     if (action_check_completion_mode(common, errp) < 0) {
1999         return;
2000     }
2001
2002     action = common->action->u.block_dirty_bitmap_add.data;
2003     /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2004     qmp_block_dirty_bitmap_add(action->node, action->name,
2005                                action->has_granularity, action->granularity,
2006                                action->has_persistent, action->persistent,
2007                                action->has_disabled, action->disabled,
2008                                &local_err);
2009
2010     if (!local_err) {
2011         state->prepared = true;
2012     } else {
2013         error_propagate(errp, local_err);
2014     }
2015 }
2016
2017 static void block_dirty_bitmap_add_abort(BlkActionState *common)
2018 {
2019     BlockDirtyBitmapAdd *action;
2020     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2021                                              common, common);
2022
2023     action = common->action->u.block_dirty_bitmap_add.data;
2024     /* Should not be able to fail: IF the bitmap was added via .prepare(),
2025      * then the node reference and bitmap name must have been valid.
2026      */
2027     if (state->prepared) {
2028         qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
2029     }
2030 }
2031
2032 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
2033                                              Error **errp)
2034 {
2035     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2036                                              common, common);
2037     BlockDirtyBitmap *action;
2038
2039     if (action_check_completion_mode(common, errp) < 0) {
2040         return;
2041     }
2042
2043     action = common->action->u.block_dirty_bitmap_clear.data;
2044     state->bitmap = block_dirty_bitmap_lookup(action->node,
2045                                               action->name,
2046                                               &state->bs,
2047                                               errp);
2048     if (!state->bitmap) {
2049         return;
2050     }
2051
2052     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
2053         return;
2054     }
2055
2056     bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2057 }
2058
2059 static void block_dirty_bitmap_restore(BlkActionState *common)
2060 {
2061     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2062                                              common, common);
2063
2064     if (state->backup) {
2065         bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
2066     }
2067 }
2068
2069 static void block_dirty_bitmap_free_backup(BlkActionState *common)
2070 {
2071     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2072                                              common, common);
2073
2074     hbitmap_free(state->backup);
2075 }
2076
2077 static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2078                                               Error **errp)
2079 {
2080     BlockDirtyBitmap *action;
2081     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2082                                              common, common);
2083
2084     if (action_check_completion_mode(common, errp) < 0) {
2085         return;
2086     }
2087
2088     action = common->action->u.block_dirty_bitmap_enable.data;
2089     state->bitmap = block_dirty_bitmap_lookup(action->node,
2090                                               action->name,
2091                                               NULL,
2092                                               errp);
2093     if (!state->bitmap) {
2094         return;
2095     }
2096
2097     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2098         return;
2099     }
2100
2101     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2102     bdrv_enable_dirty_bitmap(state->bitmap);
2103 }
2104
2105 static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2106 {
2107     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2108                                              common, common);
2109
2110     if (!state->was_enabled) {
2111         bdrv_disable_dirty_bitmap(state->bitmap);
2112     }
2113 }
2114
2115 static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2116                                                Error **errp)
2117 {
2118     BlockDirtyBitmap *action;
2119     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2120                                              common, common);
2121
2122     if (action_check_completion_mode(common, errp) < 0) {
2123         return;
2124     }
2125
2126     action = common->action->u.block_dirty_bitmap_disable.data;
2127     state->bitmap = block_dirty_bitmap_lookup(action->node,
2128                                               action->name,
2129                                               NULL,
2130                                               errp);
2131     if (!state->bitmap) {
2132         return;
2133     }
2134
2135     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2136         return;
2137     }
2138
2139     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2140     bdrv_disable_dirty_bitmap(state->bitmap);
2141 }
2142
2143 static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2144 {
2145     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2146                                              common, common);
2147
2148     if (state->was_enabled) {
2149         bdrv_enable_dirty_bitmap(state->bitmap);
2150     }
2151 }
2152
2153 static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2154                                              Error **errp)
2155 {
2156     BlockDirtyBitmapMerge *action;
2157     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2158                                              common, common);
2159
2160     if (action_check_completion_mode(common, errp) < 0) {
2161         return;
2162     }
2163
2164     action = common->action->u.block_dirty_bitmap_merge.data;
2165
2166     state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2167                                              action->bitmaps, &state->backup,
2168                                              errp);
2169 }
2170
2171 static void block_dirty_bitmap_remove_prepare(BlkActionState *common,
2172                                               Error **errp)
2173 {
2174     BlockDirtyBitmap *action;
2175     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2176                                              common, common);
2177
2178     if (action_check_completion_mode(common, errp) < 0) {
2179         return;
2180     }
2181
2182     action = common->action->u.block_dirty_bitmap_remove.data;
2183
2184     state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2185                                               false, &state->bs, errp);
2186     if (state->bitmap) {
2187         bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2188         bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2189     }
2190 }
2191
2192 static void block_dirty_bitmap_remove_abort(BlkActionState *common)
2193 {
2194     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2195                                              common, common);
2196
2197     if (state->bitmap) {
2198         bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2199         bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2200     }
2201 }
2202
2203 static void block_dirty_bitmap_remove_commit(BlkActionState *common)
2204 {
2205     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2206                                              common, common);
2207
2208     bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2209     bdrv_release_dirty_bitmap(state->bitmap);
2210 }
2211
2212 static void abort_prepare(BlkActionState *common, Error **errp)
2213 {
2214     error_setg(errp, "Transaction aborted using Abort action");
2215 }
2216
2217 static void abort_commit(BlkActionState *common)
2218 {
2219     g_assert_not_reached(); /* this action never succeeds */
2220 }
2221
2222 static const BlkActionOps actions[] = {
2223     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2224         .instance_size = sizeof(ExternalSnapshotState),
2225         .prepare  = external_snapshot_prepare,
2226         .commit   = external_snapshot_commit,
2227         .abort = external_snapshot_abort,
2228         .clean = external_snapshot_clean,
2229     },
2230     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2231         .instance_size = sizeof(ExternalSnapshotState),
2232         .prepare  = external_snapshot_prepare,
2233         .commit   = external_snapshot_commit,
2234         .abort = external_snapshot_abort,
2235         .clean = external_snapshot_clean,
2236     },
2237     [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2238         .instance_size = sizeof(DriveBackupState),
2239         .prepare = drive_backup_prepare,
2240         .commit = drive_backup_commit,
2241         .abort = drive_backup_abort,
2242         .clean = drive_backup_clean,
2243     },
2244     [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2245         .instance_size = sizeof(BlockdevBackupState),
2246         .prepare = blockdev_backup_prepare,
2247         .commit = blockdev_backup_commit,
2248         .abort = blockdev_backup_abort,
2249         .clean = blockdev_backup_clean,
2250     },
2251     [TRANSACTION_ACTION_KIND_ABORT] = {
2252         .instance_size = sizeof(BlkActionState),
2253         .prepare = abort_prepare,
2254         .commit = abort_commit,
2255     },
2256     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2257         .instance_size = sizeof(InternalSnapshotState),
2258         .prepare  = internal_snapshot_prepare,
2259         .abort = internal_snapshot_abort,
2260         .clean = internal_snapshot_clean,
2261     },
2262     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2263         .instance_size = sizeof(BlockDirtyBitmapState),
2264         .prepare = block_dirty_bitmap_add_prepare,
2265         .abort = block_dirty_bitmap_add_abort,
2266     },
2267     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2268         .instance_size = sizeof(BlockDirtyBitmapState),
2269         .prepare = block_dirty_bitmap_clear_prepare,
2270         .commit = block_dirty_bitmap_free_backup,
2271         .abort = block_dirty_bitmap_restore,
2272     },
2273     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
2274         .instance_size = sizeof(BlockDirtyBitmapState),
2275         .prepare = block_dirty_bitmap_enable_prepare,
2276         .abort = block_dirty_bitmap_enable_abort,
2277     },
2278     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
2279         .instance_size = sizeof(BlockDirtyBitmapState),
2280         .prepare = block_dirty_bitmap_disable_prepare,
2281         .abort = block_dirty_bitmap_disable_abort,
2282     },
2283     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
2284         .instance_size = sizeof(BlockDirtyBitmapState),
2285         .prepare = block_dirty_bitmap_merge_prepare,
2286         .commit = block_dirty_bitmap_free_backup,
2287         .abort = block_dirty_bitmap_restore,
2288     },
2289     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE] = {
2290         .instance_size = sizeof(BlockDirtyBitmapState),
2291         .prepare = block_dirty_bitmap_remove_prepare,
2292         .commit = block_dirty_bitmap_remove_commit,
2293         .abort = block_dirty_bitmap_remove_abort,
2294     },
2295     /* Where are transactions for MIRROR, COMMIT and STREAM?
2296      * Although these blockjobs use transaction callbacks like the backup job,
2297      * these jobs do not necessarily adhere to transaction semantics.
2298      * These jobs may not fully undo all of their actions on abort, nor do they
2299      * necessarily work in transactions with more than one job in them.
2300      */
2301 };
2302
2303 /**
2304  * Allocate a TransactionProperties structure if necessary, and fill
2305  * that structure with desired defaults if they are unset.
2306  */
2307 static TransactionProperties *get_transaction_properties(
2308     TransactionProperties *props)
2309 {
2310     if (!props) {
2311         props = g_new0(TransactionProperties, 1);
2312     }
2313
2314     if (!props->has_completion_mode) {
2315         props->has_completion_mode = true;
2316         props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2317     }
2318
2319     return props;
2320 }
2321
2322 /*
2323  * 'Atomic' group operations.  The operations are performed as a set, and if
2324  * any fail then we roll back all operations in the group.
2325  */
2326 void qmp_transaction(TransactionActionList *dev_list,
2327                      bool has_props,
2328                      struct TransactionProperties *props,
2329                      Error **errp)
2330 {
2331     TransactionActionList *dev_entry = dev_list;
2332     JobTxn *block_job_txn = NULL;
2333     BlkActionState *state, *next;
2334     Error *local_err = NULL;
2335
2336     QTAILQ_HEAD(, BlkActionState) snap_bdrv_states;
2337     QTAILQ_INIT(&snap_bdrv_states);
2338
2339     /* Does this transaction get canceled as a group on failure?
2340      * If not, we don't really need to make a JobTxn.
2341      */
2342     props = get_transaction_properties(props);
2343     if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2344         block_job_txn = job_txn_new();
2345     }
2346
2347     /* drain all i/o before any operations */
2348     bdrv_drain_all();
2349
2350     /* We don't do anything in this loop that commits us to the operations */
2351     while (NULL != dev_entry) {
2352         TransactionAction *dev_info = NULL;
2353         const BlkActionOps *ops;
2354
2355         dev_info = dev_entry->value;
2356         dev_entry = dev_entry->next;
2357
2358         assert(dev_info->type < ARRAY_SIZE(actions));
2359
2360         ops = &actions[dev_info->type];
2361         assert(ops->instance_size > 0);
2362
2363         state = g_malloc0(ops->instance_size);
2364         state->ops = ops;
2365         state->action = dev_info;
2366         state->block_job_txn = block_job_txn;
2367         state->txn_props = props;
2368         QTAILQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2369
2370         state->ops->prepare(state, &local_err);
2371         if (local_err) {
2372             error_propagate(errp, local_err);
2373             goto delete_and_fail;
2374         }
2375     }
2376
2377     QTAILQ_FOREACH(state, &snap_bdrv_states, entry) {
2378         if (state->ops->commit) {
2379             state->ops->commit(state);
2380         }
2381     }
2382
2383     /* success */
2384     goto exit;
2385
2386 delete_and_fail:
2387     /* failure, and it is all-or-none; roll back all operations */
2388     QTAILQ_FOREACH_REVERSE(state, &snap_bdrv_states, entry) {
2389         if (state->ops->abort) {
2390             state->ops->abort(state);
2391         }
2392     }
2393 exit:
2394     QTAILQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2395         if (state->ops->clean) {
2396             state->ops->clean(state);
2397         }
2398         g_free(state);
2399     }
2400     if (!has_props) {
2401         qapi_free_TransactionProperties(props);
2402     }
2403     job_txn_unref(block_job_txn);
2404 }
2405
2406 BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2407                                                               const char *name,
2408                                                               Error **errp)
2409 {
2410     BdrvDirtyBitmap *bitmap;
2411     BlockDriverState *bs;
2412     BlockDirtyBitmapSha256 *ret = NULL;
2413     char *sha256;
2414
2415     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2416     if (!bitmap || !bs) {
2417         return NULL;
2418     }
2419
2420     sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2421     if (sha256 == NULL) {
2422         return NULL;
2423     }
2424
2425     ret = g_new(BlockDirtyBitmapSha256, 1);
2426     ret->sha256 = sha256;
2427
2428     return ret;
2429 }
2430
2431 void coroutine_fn qmp_block_resize(bool has_device, const char *device,
2432                                    bool has_node_name, const char *node_name,
2433                                    int64_t size, Error **errp)
2434 {
2435     Error *local_err = NULL;
2436     BlockBackend *blk;
2437     BlockDriverState *bs;
2438     AioContext *old_ctx;
2439
2440     bs = bdrv_lookup_bs(has_device ? device : NULL,
2441                         has_node_name ? node_name : NULL,
2442                         &local_err);
2443     if (local_err) {
2444         error_propagate(errp, local_err);
2445         return;
2446     }
2447
2448     if (size < 0) {
2449         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2450         return;
2451     }
2452
2453     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2454         error_setg(errp, QERR_DEVICE_IN_USE, device);
2455         return;
2456     }
2457
2458     blk = blk_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
2459     if (!blk) {
2460         return;
2461     }
2462
2463     bdrv_co_lock(bs);
2464     bdrv_drained_begin(bs);
2465     bdrv_co_unlock(bs);
2466
2467     old_ctx = bdrv_co_enter(bs);
2468     blk_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
2469     bdrv_co_leave(bs, old_ctx);
2470
2471     bdrv_co_lock(bs);
2472     bdrv_drained_end(bs);
2473     blk_unref(blk);
2474     bdrv_co_unlock(bs);
2475 }
2476
2477 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
2478                       bool has_base, const char *base,
2479                       bool has_base_node, const char *base_node,
2480                       bool has_backing_file, const char *backing_file,
2481                       bool has_bottom, const char *bottom,
2482                       bool has_speed, int64_t speed,
2483                       bool has_on_error, BlockdevOnError on_error,
2484                       bool has_filter_node_name, const char *filter_node_name,
2485                       bool has_auto_finalize, bool auto_finalize,
2486                       bool has_auto_dismiss, bool auto_dismiss,
2487                       Error **errp)
2488 {
2489     BlockDriverState *bs, *iter, *iter_end;
2490     BlockDriverState *base_bs = NULL;
2491     BlockDriverState *bottom_bs = NULL;
2492     AioContext *aio_context;
2493     Error *local_err = NULL;
2494     int job_flags = JOB_DEFAULT;
2495
2496     if (has_base && has_base_node) {
2497         error_setg(errp, "'base' and 'base-node' cannot be specified "
2498                    "at the same time");
2499         return;
2500     }
2501
2502     if (has_base && has_bottom) {
2503         error_setg(errp, "'base' and 'bottom' cannot be specified "
2504                    "at the same time");
2505         return;
2506     }
2507
2508     if (has_bottom && has_base_node) {
2509         error_setg(errp, "'bottom' and 'base-node' cannot be specified "
2510                    "at the same time");
2511         return;
2512     }
2513
2514     if (!has_on_error) {
2515         on_error = BLOCKDEV_ON_ERROR_REPORT;
2516     }
2517
2518     bs = bdrv_lookup_bs(device, device, errp);
2519     if (!bs) {
2520         return;
2521     }
2522
2523     aio_context = bdrv_get_aio_context(bs);
2524     aio_context_acquire(aio_context);
2525
2526     if (has_base) {
2527         base_bs = bdrv_find_backing_image(bs, base);
2528         if (base_bs == NULL) {
2529             error_setg(errp, "Can't find '%s' in the backing chain", base);
2530             goto out;
2531         }
2532         assert(bdrv_get_aio_context(base_bs) == aio_context);
2533     }
2534
2535     if (has_base_node) {
2536         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2537         if (!base_bs) {
2538             goto out;
2539         }
2540         if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2541             error_setg(errp, "Node '%s' is not a backing image of '%s'",
2542                        base_node, device);
2543             goto out;
2544         }
2545         assert(bdrv_get_aio_context(base_bs) == aio_context);
2546         bdrv_refresh_filename(base_bs);
2547     }
2548
2549     if (has_bottom) {
2550         bottom_bs = bdrv_lookup_bs(NULL, bottom, errp);
2551         if (!bottom_bs) {
2552             goto out;
2553         }
2554         if (!bottom_bs->drv) {
2555             error_setg(errp, "Node '%s' is not open", bottom);
2556             goto out;
2557         }
2558         if (bottom_bs->drv->is_filter) {
2559             error_setg(errp, "Node '%s' is a filter, use a non-filter node "
2560                        "as 'bottom'", bottom);
2561             goto out;
2562         }
2563         if (!bdrv_chain_contains(bs, bottom_bs)) {
2564             error_setg(errp, "Node '%s' is not in a chain starting from '%s'",
2565                        bottom, device);
2566             goto out;
2567         }
2568         assert(bdrv_get_aio_context(bottom_bs) == aio_context);
2569     }
2570
2571     /*
2572      * Check for op blockers in the whole chain between bs and base (or bottom)
2573      */
2574     iter_end = has_bottom ? bdrv_filter_or_cow_bs(bottom_bs) : base_bs;
2575     for (iter = bs; iter && iter != iter_end;
2576          iter = bdrv_filter_or_cow_bs(iter))
2577     {
2578         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
2579             goto out;
2580         }
2581     }
2582
2583     /* if we are streaming the entire chain, the result will have no backing
2584      * file, and specifying one is therefore an error */
2585     if (base_bs == NULL && has_backing_file) {
2586         error_setg(errp, "backing file specified, but streaming the "
2587                          "entire chain");
2588         goto out;
2589     }
2590
2591     if (has_auto_finalize && !auto_finalize) {
2592         job_flags |= JOB_MANUAL_FINALIZE;
2593     }
2594     if (has_auto_dismiss && !auto_dismiss) {
2595         job_flags |= JOB_MANUAL_DISMISS;
2596     }
2597
2598     stream_start(has_job_id ? job_id : NULL, bs, base_bs, backing_file,
2599                  bottom_bs, job_flags, has_speed ? speed : 0, on_error,
2600                  filter_node_name, &local_err);
2601     if (local_err) {
2602         error_propagate(errp, local_err);
2603         goto out;
2604     }
2605
2606     trace_qmp_block_stream(bs);
2607
2608 out:
2609     aio_context_release(aio_context);
2610 }
2611
2612 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
2613                       bool has_base_node, const char *base_node,
2614                       bool has_base, const char *base,
2615                       bool has_top_node, const char *top_node,
2616                       bool has_top, const char *top,
2617                       bool has_backing_file, const char *backing_file,
2618                       bool has_speed, int64_t speed,
2619                       bool has_on_error, BlockdevOnError on_error,
2620                       bool has_filter_node_name, const char *filter_node_name,
2621                       bool has_auto_finalize, bool auto_finalize,
2622                       bool has_auto_dismiss, bool auto_dismiss,
2623                       Error **errp)
2624 {
2625     BlockDriverState *bs;
2626     BlockDriverState *iter;
2627     BlockDriverState *base_bs, *top_bs;
2628     AioContext *aio_context;
2629     Error *local_err = NULL;
2630     int job_flags = JOB_DEFAULT;
2631     uint64_t top_perm, top_shared;
2632
2633     if (!has_speed) {
2634         speed = 0;
2635     }
2636     if (!has_on_error) {
2637         on_error = BLOCKDEV_ON_ERROR_REPORT;
2638     }
2639     if (!has_filter_node_name) {
2640         filter_node_name = NULL;
2641     }
2642     if (has_auto_finalize && !auto_finalize) {
2643         job_flags |= JOB_MANUAL_FINALIZE;
2644     }
2645     if (has_auto_dismiss && !auto_dismiss) {
2646         job_flags |= JOB_MANUAL_DISMISS;
2647     }
2648
2649     /* Important Note:
2650      *  libvirt relies on the DeviceNotFound error class in order to probe for
2651      *  live commit feature versions; for this to work, we must make sure to
2652      *  perform the device lookup before any generic errors that may occur in a
2653      *  scenario in which all optional arguments are omitted. */
2654     bs = qmp_get_root_bs(device, &local_err);
2655     if (!bs) {
2656         bs = bdrv_lookup_bs(device, device, NULL);
2657         if (!bs) {
2658             error_free(local_err);
2659             error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2660                       "Device '%s' not found", device);
2661         } else {
2662             error_propagate(errp, local_err);
2663         }
2664         return;
2665     }
2666
2667     aio_context = bdrv_get_aio_context(bs);
2668     aio_context_acquire(aio_context);
2669
2670     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2671         goto out;
2672     }
2673
2674     /* default top_bs is the active layer */
2675     top_bs = bs;
2676
2677     if (has_top_node && has_top) {
2678         error_setg(errp, "'top-node' and 'top' are mutually exclusive");
2679         goto out;
2680     } else if (has_top_node) {
2681         top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2682         if (top_bs == NULL) {
2683             goto out;
2684         }
2685         if (!bdrv_chain_contains(bs, top_bs)) {
2686             error_setg(errp, "'%s' is not in this backing file chain",
2687                        top_node);
2688             goto out;
2689         }
2690     } else if (has_top && top) {
2691         /* This strcmp() is just a shortcut, there is no need to
2692          * refresh @bs's filename.  If it mismatches,
2693          * bdrv_find_backing_image() will do the refresh and may still
2694          * return @bs. */
2695         if (strcmp(bs->filename, top) != 0) {
2696             top_bs = bdrv_find_backing_image(bs, top);
2697         }
2698     }
2699
2700     if (top_bs == NULL) {
2701         error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2702         goto out;
2703     }
2704
2705     assert(bdrv_get_aio_context(top_bs) == aio_context);
2706
2707     if (has_base_node && has_base) {
2708         error_setg(errp, "'base-node' and 'base' are mutually exclusive");
2709         goto out;
2710     } else if (has_base_node) {
2711         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2712         if (base_bs == NULL) {
2713             goto out;
2714         }
2715         if (!bdrv_chain_contains(top_bs, base_bs)) {
2716             error_setg(errp, "'%s' is not in this backing file chain",
2717                        base_node);
2718             goto out;
2719         }
2720     } else if (has_base && base) {
2721         base_bs = bdrv_find_backing_image(top_bs, base);
2722         if (base_bs == NULL) {
2723             error_setg(errp, "Can't find '%s' in the backing chain", base);
2724             goto out;
2725         }
2726     } else {
2727         base_bs = bdrv_find_base(top_bs);
2728         if (base_bs == NULL) {
2729             error_setg(errp, "There is no backimg image");
2730             goto out;
2731         }
2732     }
2733
2734     assert(bdrv_get_aio_context(base_bs) == aio_context);
2735
2736     for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2737          iter = bdrv_filter_or_cow_bs(iter))
2738     {
2739         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2740             goto out;
2741         }
2742     }
2743
2744     /* Do not allow attempts to commit an image into itself */
2745     if (top_bs == base_bs) {
2746         error_setg(errp, "cannot commit an image into itself");
2747         goto out;
2748     }
2749
2750     /*
2751      * Active commit is required if and only if someone has taken a
2752      * WRITE permission on the top node.  Historically, we have always
2753      * used active commit for top nodes, so continue that practice
2754      * lest we possibly break clients that rely on this behavior, e.g.
2755      * to later attach this node to a writing parent.
2756      * (Active commit is never really wrong.)
2757      */
2758     bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2759     if (top_perm & BLK_PERM_WRITE ||
2760         bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2761     {
2762         if (has_backing_file) {
2763             if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2764                 error_setg(errp, "'backing-file' specified,"
2765                                  " but 'top' is the active layer");
2766             } else {
2767                 error_setg(errp, "'backing-file' specified, but 'top' has a "
2768                                  "writer on it");
2769             }
2770             goto out;
2771         }
2772         if (!has_job_id) {
2773             /*
2774              * Emulate here what block_job_create() does, because it
2775              * is possible that @bs != @top_bs (the block job should
2776              * be named after @bs, even if @top_bs is the actual
2777              * source)
2778              */
2779             job_id = bdrv_get_device_name(bs);
2780         }
2781         commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
2782                             filter_node_name, NULL, NULL, false, &local_err);
2783     } else {
2784         BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2785         if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2786             goto out;
2787         }
2788         commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
2789                      speed, on_error, has_backing_file ? backing_file : NULL,
2790                      filter_node_name, &local_err);
2791     }
2792     if (local_err != NULL) {
2793         error_propagate(errp, local_err);
2794         goto out;
2795     }
2796
2797 out:
2798     aio_context_release(aio_context);
2799 }
2800
2801 /* Common QMP interface for drive-backup and blockdev-backup */
2802 static BlockJob *do_backup_common(BackupCommon *backup,
2803                                   BlockDriverState *bs,
2804                                   BlockDriverState *target_bs,
2805                                   AioContext *aio_context,
2806                                   JobTxn *txn, Error **errp)
2807 {
2808     BlockJob *job = NULL;
2809     BdrvDirtyBitmap *bmap = NULL;
2810     BackupPerf perf = { .max_workers = 64 };
2811     int job_flags = JOB_DEFAULT;
2812
2813     if (!backup->has_speed) {
2814         backup->speed = 0;
2815     }
2816     if (!backup->has_on_source_error) {
2817         backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2818     }
2819     if (!backup->has_on_target_error) {
2820         backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2821     }
2822     if (!backup->has_job_id) {
2823         backup->job_id = NULL;
2824     }
2825     if (!backup->has_auto_finalize) {
2826         backup->auto_finalize = true;
2827     }
2828     if (!backup->has_auto_dismiss) {
2829         backup->auto_dismiss = true;
2830     }
2831     if (!backup->has_compress) {
2832         backup->compress = false;
2833     }
2834
2835     if (backup->x_perf) {
2836         if (backup->x_perf->has_use_copy_range) {
2837             perf.use_copy_range = backup->x_perf->use_copy_range;
2838         }
2839         if (backup->x_perf->has_max_workers) {
2840             perf.max_workers = backup->x_perf->max_workers;
2841         }
2842         if (backup->x_perf->has_max_chunk) {
2843             perf.max_chunk = backup->x_perf->max_chunk;
2844         }
2845     }
2846
2847     if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2848         (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2849         /* done before desugaring 'incremental' to print the right message */
2850         if (!backup->has_bitmap) {
2851             error_setg(errp, "must provide a valid bitmap name for "
2852                        "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2853             return NULL;
2854         }
2855     }
2856
2857     if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2858         if (backup->has_bitmap_mode &&
2859             backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2860             error_setg(errp, "Bitmap sync mode must be '%s' "
2861                        "when using sync mode '%s'",
2862                        BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2863                        MirrorSyncMode_str(backup->sync));
2864             return NULL;
2865         }
2866         backup->has_bitmap_mode = true;
2867         backup->sync = MIRROR_SYNC_MODE_BITMAP;
2868         backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2869     }
2870
2871     if (backup->has_bitmap) {
2872         bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2873         if (!bmap) {
2874             error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2875             return NULL;
2876         }
2877         if (!backup->has_bitmap_mode) {
2878             error_setg(errp, "Bitmap sync mode must be given "
2879                        "when providing a bitmap");
2880             return NULL;
2881         }
2882         if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2883             return NULL;
2884         }
2885
2886         /* This does not produce a useful bitmap artifact: */
2887         if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2888             error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2889                        " outputs", MirrorSyncMode_str(backup->sync));
2890             return NULL;
2891         }
2892
2893         /* If the bitmap isn't used for input or output, this is useless: */
2894         if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2895             backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2896             error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2897                        " when combined with sync mode '%s'",
2898                        BitmapSyncMode_str(backup->bitmap_mode),
2899                        MirrorSyncMode_str(backup->sync));
2900             return NULL;
2901         }
2902     }
2903
2904     if (!backup->has_bitmap && backup->has_bitmap_mode) {
2905         error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2906         return NULL;
2907     }
2908
2909     if (!backup->auto_finalize) {
2910         job_flags |= JOB_MANUAL_FINALIZE;
2911     }
2912     if (!backup->auto_dismiss) {
2913         job_flags |= JOB_MANUAL_DISMISS;
2914     }
2915
2916     job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
2917                             backup->sync, bmap, backup->bitmap_mode,
2918                             backup->compress,
2919                             backup->filter_node_name,
2920                             &perf,
2921                             backup->on_source_error,
2922                             backup->on_target_error,
2923                             job_flags, NULL, NULL, txn, errp);
2924     return job;
2925 }
2926
2927 void qmp_drive_backup(DriveBackup *backup, Error **errp)
2928 {
2929     TransactionAction action = {
2930         .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2931         .u.drive_backup.data = backup,
2932     };
2933     blockdev_do_action(&action, errp);
2934 }
2935
2936 BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2937                                                  bool flat,
2938                                                  Error **errp)
2939 {
2940     bool return_flat = has_flat && flat;
2941
2942     return bdrv_named_nodes_list(return_flat, errp);
2943 }
2944
2945 XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2946 {
2947     return bdrv_get_xdbg_block_graph(errp);
2948 }
2949
2950 void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
2951 {
2952     TransactionAction action = {
2953         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2954         .u.blockdev_backup.data = backup,
2955     };
2956     blockdev_do_action(&action, errp);
2957 }
2958
2959 /* Parameter check and block job starting for drive mirroring.
2960  * Caller should hold @device and @target's aio context (must be the same).
2961  **/
2962 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
2963                                    BlockDriverState *target,
2964                                    bool has_replaces, const char *replaces,
2965                                    enum MirrorSyncMode sync,
2966                                    BlockMirrorBackingMode backing_mode,
2967                                    bool zero_target,
2968                                    bool has_speed, int64_t speed,
2969                                    bool has_granularity, uint32_t granularity,
2970                                    bool has_buf_size, int64_t buf_size,
2971                                    bool has_on_source_error,
2972                                    BlockdevOnError on_source_error,
2973                                    bool has_on_target_error,
2974                                    BlockdevOnError on_target_error,
2975                                    bool has_unmap, bool unmap,
2976                                    bool has_filter_node_name,
2977                                    const char *filter_node_name,
2978                                    bool has_copy_mode, MirrorCopyMode copy_mode,
2979                                    bool has_auto_finalize, bool auto_finalize,
2980                                    bool has_auto_dismiss, bool auto_dismiss,
2981                                    Error **errp)
2982 {
2983     BlockDriverState *unfiltered_bs;
2984     int job_flags = JOB_DEFAULT;
2985
2986     if (!has_speed) {
2987         speed = 0;
2988     }
2989     if (!has_on_source_error) {
2990         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2991     }
2992     if (!has_on_target_error) {
2993         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2994     }
2995     if (!has_granularity) {
2996         granularity = 0;
2997     }
2998     if (!has_buf_size) {
2999         buf_size = 0;
3000     }
3001     if (!has_unmap) {
3002         unmap = true;
3003     }
3004     if (!has_filter_node_name) {
3005         filter_node_name = NULL;
3006     }
3007     if (!has_copy_mode) {
3008         copy_mode = MIRROR_COPY_MODE_BACKGROUND;
3009     }
3010     if (has_auto_finalize && !auto_finalize) {
3011         job_flags |= JOB_MANUAL_FINALIZE;
3012     }
3013     if (has_auto_dismiss && !auto_dismiss) {
3014         job_flags |= JOB_MANUAL_DISMISS;
3015     }
3016
3017     if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3018         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3019                    "a value in range [512B, 64MB]");
3020         return;
3021     }
3022     if (granularity & (granularity - 1)) {
3023         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3024                    "a power of 2");
3025         return;
3026     }
3027
3028     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3029         return;
3030     }
3031     if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3032         return;
3033     }
3034
3035     if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
3036         sync = MIRROR_SYNC_MODE_FULL;
3037     }
3038
3039     if (!has_replaces) {
3040         /* We want to mirror from @bs, but keep implicit filters on top */
3041         unfiltered_bs = bdrv_skip_implicit_filters(bs);
3042         if (unfiltered_bs != bs) {
3043             replaces = unfiltered_bs->node_name;
3044             has_replaces = true;
3045         }
3046     }
3047
3048     if (has_replaces) {
3049         BlockDriverState *to_replace_bs;
3050         AioContext *replace_aio_context;
3051         int64_t bs_size, replace_size;
3052
3053         bs_size = bdrv_getlength(bs);
3054         if (bs_size < 0) {
3055             error_setg_errno(errp, -bs_size, "Failed to query device's size");
3056             return;
3057         }
3058
3059         to_replace_bs = check_to_replace_node(bs, replaces, errp);
3060         if (!to_replace_bs) {
3061             return;
3062         }
3063
3064         replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3065         aio_context_acquire(replace_aio_context);
3066         replace_size = bdrv_getlength(to_replace_bs);
3067         aio_context_release(replace_aio_context);
3068
3069         if (replace_size < 0) {
3070             error_setg_errno(errp, -replace_size,
3071                              "Failed to query the replacement node's size");
3072             return;
3073         }
3074         if (bs_size != replace_size) {
3075             error_setg(errp, "cannot replace image with a mirror image of "
3076                              "different size");
3077             return;
3078         }
3079     }
3080
3081     /* pass the node name to replace to mirror start since it's loose coupling
3082      * and will allow to check whether the node still exist at mirror completion
3083      */
3084     mirror_start(job_id, bs, target,
3085                  has_replaces ? replaces : NULL, job_flags,
3086                  speed, granularity, buf_size, sync, backing_mode, zero_target,
3087                  on_source_error, on_target_error, unmap, filter_node_name,
3088                  copy_mode, errp);
3089 }
3090
3091 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3092 {
3093     BlockDriverState *bs;
3094     BlockDriverState *target_backing_bs, *target_bs;
3095     AioContext *aio_context;
3096     AioContext *old_context;
3097     BlockMirrorBackingMode backing_mode;
3098     Error *local_err = NULL;
3099     QDict *options = NULL;
3100     int flags;
3101     int64_t size;
3102     const char *format = arg->format;
3103     bool zero_target;
3104     int ret;
3105
3106     bs = qmp_get_root_bs(arg->device, errp);
3107     if (!bs) {
3108         return;
3109     }
3110
3111     /* Early check to avoid creating target */
3112     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3113         return;
3114     }
3115
3116     aio_context = bdrv_get_aio_context(bs);
3117     aio_context_acquire(aio_context);
3118
3119     if (!arg->has_mode) {
3120         arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3121     }
3122
3123     if (!arg->has_format) {
3124         format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3125                   ? NULL : bs->drv->format_name);
3126     }
3127
3128     flags = bs->open_flags | BDRV_O_RDWR;
3129     target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
3130     if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
3131         arg->sync = MIRROR_SYNC_MODE_FULL;
3132     }
3133     if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3134         target_backing_bs = bs;
3135     }
3136
3137     size = bdrv_getlength(bs);
3138     if (size < 0) {
3139         error_setg_errno(errp, -size, "bdrv_getlength failed");
3140         goto out;
3141     }
3142
3143     if (arg->has_replaces) {
3144         if (!arg->has_node_name) {
3145             error_setg(errp, "a node-name must be provided when replacing a"
3146                              " named node of the graph");
3147             goto out;
3148         }
3149     }
3150
3151     if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3152         backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3153     } else {
3154         backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3155     }
3156
3157     /* Don't open backing image in create() */
3158     flags |= BDRV_O_NO_BACKING;
3159
3160     if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
3161         && arg->mode != NEW_IMAGE_MODE_EXISTING)
3162     {
3163         /* create new image w/o backing file */
3164         assert(format);
3165         bdrv_img_create(arg->target, format,
3166                         NULL, NULL, NULL, size, flags, false, &local_err);
3167     } else {
3168         /* Implicit filters should not appear in the filename */
3169         BlockDriverState *explicit_backing =
3170             bdrv_skip_implicit_filters(target_backing_bs);
3171
3172         switch (arg->mode) {
3173         case NEW_IMAGE_MODE_EXISTING:
3174             break;
3175         case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3176             /* create new image with backing file */
3177             bdrv_refresh_filename(explicit_backing);
3178             bdrv_img_create(arg->target, format,
3179                             explicit_backing->filename,
3180                             explicit_backing->drv->format_name,
3181                             NULL, size, flags, false, &local_err);
3182             break;
3183         default:
3184             abort();
3185         }
3186     }
3187
3188     if (local_err) {
3189         error_propagate(errp, local_err);
3190         goto out;
3191     }
3192
3193     options = qdict_new();
3194     if (arg->has_node_name) {
3195         qdict_put_str(options, "node-name", arg->node_name);
3196     }
3197     if (format) {
3198         qdict_put_str(options, "driver", format);
3199     }
3200
3201     /* Mirroring takes care of copy-on-write using the source's backing
3202      * file.
3203      */
3204     target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
3205     if (!target_bs) {
3206         goto out;
3207     }
3208
3209     zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3210                    (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3211                     !bdrv_has_zero_init(target_bs)));
3212
3213
3214     /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3215     old_context = bdrv_get_aio_context(target_bs);
3216     aio_context_release(aio_context);
3217     aio_context_acquire(old_context);
3218
3219     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3220     if (ret < 0) {
3221         bdrv_unref(target_bs);
3222         aio_context_release(old_context);
3223         return;
3224     }
3225
3226     aio_context_release(old_context);
3227     aio_context_acquire(aio_context);
3228
3229     blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3230                            arg->has_replaces, arg->replaces, arg->sync,
3231                            backing_mode, zero_target,
3232                            arg->has_speed, arg->speed,
3233                            arg->has_granularity, arg->granularity,
3234                            arg->has_buf_size, arg->buf_size,
3235                            arg->has_on_source_error, arg->on_source_error,
3236                            arg->has_on_target_error, arg->on_target_error,
3237                            arg->has_unmap, arg->unmap,
3238                            false, NULL,
3239                            arg->has_copy_mode, arg->copy_mode,
3240                            arg->has_auto_finalize, arg->auto_finalize,
3241                            arg->has_auto_dismiss, arg->auto_dismiss,
3242                            errp);
3243     bdrv_unref(target_bs);
3244 out:
3245     aio_context_release(aio_context);
3246 }
3247
3248 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3249                          const char *device, const char *target,
3250                          bool has_replaces, const char *replaces,
3251                          MirrorSyncMode sync,
3252                          bool has_speed, int64_t speed,
3253                          bool has_granularity, uint32_t granularity,
3254                          bool has_buf_size, int64_t buf_size,
3255                          bool has_on_source_error,
3256                          BlockdevOnError on_source_error,
3257                          bool has_on_target_error,
3258                          BlockdevOnError on_target_error,
3259                          bool has_filter_node_name,
3260                          const char *filter_node_name,
3261                          bool has_copy_mode, MirrorCopyMode copy_mode,
3262                          bool has_auto_finalize, bool auto_finalize,
3263                          bool has_auto_dismiss, bool auto_dismiss,
3264                          Error **errp)
3265 {
3266     BlockDriverState *bs;
3267     BlockDriverState *target_bs;
3268     AioContext *aio_context;
3269     AioContext *old_context;
3270     BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3271     bool zero_target;
3272     int ret;
3273
3274     bs = qmp_get_root_bs(device, errp);
3275     if (!bs) {
3276         return;
3277     }
3278
3279     target_bs = bdrv_lookup_bs(target, target, errp);
3280     if (!target_bs) {
3281         return;
3282     }
3283
3284     zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3285
3286     /* Honor bdrv_try_set_aio_context() context acquisition requirements. */
3287     old_context = bdrv_get_aio_context(target_bs);
3288     aio_context = bdrv_get_aio_context(bs);
3289     aio_context_acquire(old_context);
3290
3291     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3292
3293     aio_context_release(old_context);
3294     aio_context_acquire(aio_context);
3295
3296     if (ret < 0) {
3297         goto out;
3298     }
3299
3300     blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
3301                            has_replaces, replaces, sync, backing_mode,
3302                            zero_target, has_speed, speed,
3303                            has_granularity, granularity,
3304                            has_buf_size, buf_size,
3305                            has_on_source_error, on_source_error,
3306                            has_on_target_error, on_target_error,
3307                            true, true,
3308                            has_filter_node_name, filter_node_name,
3309                            has_copy_mode, copy_mode,
3310                            has_auto_finalize, auto_finalize,
3311                            has_auto_dismiss, auto_dismiss,
3312                            errp);
3313 out:
3314     aio_context_release(aio_context);
3315 }
3316
3317 /* Get a block job using its ID and acquire its AioContext */
3318 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3319                                 Error **errp)
3320 {
3321     BlockJob *job;
3322
3323     assert(id != NULL);
3324
3325     *aio_context = NULL;
3326
3327     job = block_job_get(id);
3328
3329     if (!job) {
3330         error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3331                   "Block job '%s' not found", id);
3332         return NULL;
3333     }
3334
3335     *aio_context = blk_get_aio_context(job->blk);
3336     aio_context_acquire(*aio_context);
3337
3338     return job;
3339 }
3340
3341 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3342 {
3343     AioContext *aio_context;
3344     BlockJob *job = find_block_job(device, &aio_context, errp);
3345
3346     if (!job) {
3347         return;
3348     }
3349
3350     block_job_set_speed(job, speed, errp);
3351     aio_context_release(aio_context);
3352 }
3353
3354 void qmp_block_job_cancel(const char *device,
3355                           bool has_force, bool force, Error **errp)
3356 {
3357     AioContext *aio_context;
3358     BlockJob *job = find_block_job(device, &aio_context, errp);
3359
3360     if (!job) {
3361         return;
3362     }
3363
3364     if (!has_force) {
3365         force = false;
3366     }
3367
3368     if (job_user_paused(&job->job) && !force) {
3369         error_setg(errp, "The block job for device '%s' is currently paused",
3370                    device);
3371         goto out;
3372     }
3373
3374     trace_qmp_block_job_cancel(job);
3375     job_user_cancel(&job->job, force, errp);
3376 out:
3377     aio_context_release(aio_context);
3378 }
3379
3380 void qmp_block_job_pause(const char *device, Error **errp)
3381 {
3382     AioContext *aio_context;
3383     BlockJob *job = find_block_job(device, &aio_context, errp);
3384
3385     if (!job) {
3386         return;
3387     }
3388
3389     trace_qmp_block_job_pause(job);
3390     job_user_pause(&job->job, errp);
3391     aio_context_release(aio_context);
3392 }
3393
3394 void qmp_block_job_resume(const char *device, Error **errp)
3395 {
3396     AioContext *aio_context;
3397     BlockJob *job = find_block_job(device, &aio_context, errp);
3398
3399     if (!job) {
3400         return;
3401     }
3402
3403     trace_qmp_block_job_resume(job);
3404     job_user_resume(&job->job, errp);
3405     aio_context_release(aio_context);
3406 }
3407
3408 void qmp_block_job_complete(const char *device, Error **errp)
3409 {
3410     AioContext *aio_context;
3411     BlockJob *job = find_block_job(device, &aio_context, errp);
3412
3413     if (!job) {
3414         return;
3415     }
3416
3417     trace_qmp_block_job_complete(job);
3418     job_complete(&job->job, errp);
3419     aio_context_release(aio_context);
3420 }
3421
3422 void qmp_block_job_finalize(const char *id, Error **errp)
3423 {
3424     AioContext *aio_context;
3425     BlockJob *job = find_block_job(id, &aio_context, errp);
3426
3427     if (!job) {
3428         return;
3429     }
3430
3431     trace_qmp_block_job_finalize(job);
3432     job_ref(&job->job);
3433     job_finalize(&job->job, errp);
3434
3435     /*
3436      * Job's context might have changed via job_finalize (and job_txn_apply
3437      * automatically acquires the new one), so make sure we release the correct
3438      * one.
3439      */
3440     aio_context = blk_get_aio_context(job->blk);
3441     job_unref(&job->job);
3442     aio_context_release(aio_context);
3443 }
3444
3445 void qmp_block_job_dismiss(const char *id, Error **errp)
3446 {
3447     AioContext *aio_context;
3448     BlockJob *bjob = find_block_job(id, &aio_context, errp);
3449     Job *job;
3450
3451     if (!bjob) {
3452         return;
3453     }
3454
3455     trace_qmp_block_job_dismiss(bjob);
3456     job = &bjob->job;
3457     job_dismiss(&job, errp);
3458     aio_context_release(aio_context);
3459 }
3460
3461 void qmp_change_backing_file(const char *device,
3462                              const char *image_node_name,
3463                              const char *backing_file,
3464                              Error **errp)
3465 {
3466     BlockDriverState *bs = NULL;
3467     AioContext *aio_context;
3468     BlockDriverState *image_bs = NULL;
3469     Error *local_err = NULL;
3470     bool ro;
3471     int ret;
3472
3473     bs = qmp_get_root_bs(device, errp);
3474     if (!bs) {
3475         return;
3476     }
3477
3478     aio_context = bdrv_get_aio_context(bs);
3479     aio_context_acquire(aio_context);
3480
3481     image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3482     if (local_err) {
3483         error_propagate(errp, local_err);
3484         goto out;
3485     }
3486
3487     if (!image_bs) {
3488         error_setg(errp, "image file not found");
3489         goto out;
3490     }
3491
3492     if (bdrv_find_base(image_bs) == image_bs) {
3493         error_setg(errp, "not allowing backing file change on an image "
3494                          "without a backing file");
3495         goto out;
3496     }
3497
3498     /* even though we are not necessarily operating on bs, we need it to
3499      * determine if block ops are currently prohibited on the chain */
3500     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3501         goto out;
3502     }
3503
3504     /* final sanity check */
3505     if (!bdrv_chain_contains(bs, image_bs)) {
3506         error_setg(errp, "'%s' and image file are not in the same chain",
3507                    device);
3508         goto out;
3509     }
3510
3511     /* if not r/w, reopen to make r/w */
3512     ro = bdrv_is_read_only(image_bs);
3513
3514     if (ro) {
3515         if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
3516             goto out;
3517         }
3518     }
3519
3520     ret = bdrv_change_backing_file(image_bs, backing_file,
3521                                    image_bs->drv ? image_bs->drv->format_name : "",
3522                                    false);
3523
3524     if (ret < 0) {
3525         error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3526                          backing_file);
3527         /* don't exit here, so we can try to restore open flags if
3528          * appropriate */
3529     }
3530
3531     if (ro) {
3532         bdrv_reopen_set_read_only(image_bs, true, errp);
3533     }
3534
3535 out:
3536     aio_context_release(aio_context);
3537 }
3538
3539 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3540 {
3541     BlockDriverState *bs;
3542     QObject *obj;
3543     Visitor *v = qobject_output_visitor_new(&obj);
3544     QDict *qdict;
3545
3546     visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3547     visit_complete(v, &obj);
3548     qdict = qobject_to(QDict, obj);
3549
3550     qdict_flatten(qdict);
3551
3552     if (!qdict_get_try_str(qdict, "node-name")) {
3553         error_setg(errp, "'node-name' must be specified for the root node");
3554         goto fail;
3555     }
3556
3557     bs = bds_tree_init(qdict, errp);
3558     if (!bs) {
3559         goto fail;
3560     }
3561
3562     bdrv_set_monitor_owned(bs);
3563
3564 fail:
3565     visit_free(v);
3566 }
3567
3568 void qmp_x_blockdev_reopen(BlockdevOptions *options, Error **errp)
3569 {
3570     BlockDriverState *bs;
3571     AioContext *ctx;
3572     QObject *obj;
3573     Visitor *v = qobject_output_visitor_new(&obj);
3574     BlockReopenQueue *queue;
3575     QDict *qdict;
3576
3577     /* Check for the selected node name */
3578     if (!options->has_node_name) {
3579         error_setg(errp, "node-name not specified");
3580         goto fail;
3581     }
3582
3583     bs = bdrv_find_node(options->node_name);
3584     if (!bs) {
3585         error_setg(errp, "Failed to find node with node-name='%s'",
3586                    options->node_name);
3587         goto fail;
3588     }
3589
3590     /* Put all options in a QDict and flatten it */
3591     visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3592     visit_complete(v, &obj);
3593     qdict = qobject_to(QDict, obj);
3594
3595     qdict_flatten(qdict);
3596
3597     /* Perform the reopen operation */
3598     ctx = bdrv_get_aio_context(bs);
3599     aio_context_acquire(ctx);
3600     bdrv_subtree_drained_begin(bs);
3601     queue = bdrv_reopen_queue(NULL, bs, qdict, false);
3602     bdrv_reopen_multiple(queue, errp);
3603     bdrv_subtree_drained_end(bs);
3604     aio_context_release(ctx);
3605
3606 fail:
3607     visit_free(v);
3608 }
3609
3610 void qmp_blockdev_del(const char *node_name, Error **errp)
3611 {
3612     AioContext *aio_context;
3613     BlockDriverState *bs;
3614
3615     bs = bdrv_find_node(node_name);
3616     if (!bs) {
3617         error_setg(errp, "Failed to find node with node-name='%s'", node_name);
3618         return;
3619     }
3620     if (bdrv_has_blk(bs)) {
3621         error_setg(errp, "Node %s is in use", node_name);
3622         return;
3623     }
3624     aio_context = bdrv_get_aio_context(bs);
3625     aio_context_acquire(aio_context);
3626
3627     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3628         goto out;
3629     }
3630
3631     if (!QTAILQ_IN_USE(bs, monitor_list)) {
3632         error_setg(errp, "Node %s is not owned by the monitor",
3633                    bs->node_name);
3634         goto out;
3635     }
3636
3637     if (bs->refcnt > 1) {
3638         error_setg(errp, "Block device %s is in use",
3639                    bdrv_get_device_or_node_name(bs));
3640         goto out;
3641     }
3642
3643     QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3644     bdrv_unref(bs);
3645
3646 out:
3647     aio_context_release(aio_context);
3648 }
3649
3650 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3651                                   const char *child_name)
3652 {
3653     BdrvChild *child;
3654
3655     QLIST_FOREACH(child, &parent_bs->children, next) {
3656         if (strcmp(child->name, child_name) == 0) {
3657             return child;
3658         }
3659     }
3660
3661     return NULL;
3662 }
3663
3664 void qmp_x_blockdev_change(const char *parent, bool has_child,
3665                            const char *child, bool has_node,
3666                            const char *node, Error **errp)
3667 {
3668     BlockDriverState *parent_bs, *new_bs = NULL;
3669     BdrvChild *p_child;
3670
3671     parent_bs = bdrv_lookup_bs(parent, parent, errp);
3672     if (!parent_bs) {
3673         return;
3674     }
3675
3676     if (has_child == has_node) {
3677         if (has_child) {
3678             error_setg(errp, "The parameters child and node are in conflict");
3679         } else {
3680             error_setg(errp, "Either child or node must be specified");
3681         }
3682         return;
3683     }
3684
3685     if (has_child) {
3686         p_child = bdrv_find_child(parent_bs, child);
3687         if (!p_child) {
3688             error_setg(errp, "Node '%s' does not have child '%s'",
3689                        parent, child);
3690             return;
3691         }
3692         bdrv_del_child(parent_bs, p_child, errp);
3693     }
3694
3695     if (has_node) {
3696         new_bs = bdrv_find_node(node);
3697         if (!new_bs) {
3698             error_setg(errp, "Node '%s' not found", node);
3699             return;
3700         }
3701         bdrv_add_child(parent_bs, new_bs, errp);
3702     }
3703 }
3704
3705 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3706 {
3707     BlockJobInfoList *head = NULL, **tail = &head;
3708     BlockJob *job;
3709
3710     for (job = block_job_next(NULL); job; job = block_job_next(job)) {
3711         BlockJobInfo *value;
3712         AioContext *aio_context;
3713
3714         if (block_job_is_internal(job)) {
3715             continue;
3716         }
3717         aio_context = blk_get_aio_context(job->blk);
3718         aio_context_acquire(aio_context);
3719         value = block_job_query(job, errp);
3720         aio_context_release(aio_context);
3721         if (!value) {
3722             qapi_free_BlockJobInfoList(head);
3723             return NULL;
3724         }
3725         QAPI_LIST_APPEND(tail, value);
3726     }
3727
3728     return head;
3729 }
3730
3731 void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
3732                                  bool has_force, bool force, Error **errp)
3733 {
3734     AioContext *old_context;
3735     AioContext *new_context;
3736     BlockDriverState *bs;
3737
3738     bs = bdrv_find_node(node_name);
3739     if (!bs) {
3740         error_setg(errp, "Failed to find node with node-name='%s'", node_name);
3741         return;
3742     }
3743
3744     /* Protects against accidents. */
3745     if (!(has_force && force) && bdrv_has_blk(bs)) {
3746         error_setg(errp, "Node %s is associated with a BlockBackend and could "
3747                          "be in use (use force=true to override this check)",
3748                          node_name);
3749         return;
3750     }
3751
3752     if (iothread->type == QTYPE_QSTRING) {
3753         IOThread *obj = iothread_by_id(iothread->u.s);
3754         if (!obj) {
3755             error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3756             return;
3757         }
3758
3759         new_context = iothread_get_aio_context(obj);
3760     } else {
3761         new_context = qemu_get_aio_context();
3762     }
3763
3764     old_context = bdrv_get_aio_context(bs);
3765     aio_context_acquire(old_context);
3766
3767     bdrv_try_set_aio_context(bs, new_context, errp);
3768
3769     aio_context_release(old_context);
3770 }
3771
3772 QemuOptsList qemu_common_drive_opts = {
3773     .name = "drive",
3774     .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3775     .desc = {
3776         {
3777             .name = "snapshot",
3778             .type = QEMU_OPT_BOOL,
3779             .help = "enable/disable snapshot mode",
3780         },{
3781             .name = "aio",
3782             .type = QEMU_OPT_STRING,
3783             .help = "host AIO implementation (threads, native, io_uring)",
3784         },{
3785             .name = BDRV_OPT_CACHE_WB,
3786             .type = QEMU_OPT_BOOL,
3787             .help = "Enable writeback mode",
3788         },{
3789             .name = "format",
3790             .type = QEMU_OPT_STRING,
3791             .help = "disk format (raw, qcow2, ...)",
3792         },{
3793             .name = "rerror",
3794             .type = QEMU_OPT_STRING,
3795             .help = "read error action",
3796         },{
3797             .name = "werror",
3798             .type = QEMU_OPT_STRING,
3799             .help = "write error action",
3800         },{
3801             .name = BDRV_OPT_READ_ONLY,
3802             .type = QEMU_OPT_BOOL,
3803             .help = "open drive file as read-only",
3804         },
3805
3806         THROTTLE_OPTS,
3807
3808         {
3809             .name = "throttling.group",
3810             .type = QEMU_OPT_STRING,
3811             .help = "name of the block throttling group",
3812         },{
3813             .name = "copy-on-read",
3814             .type = QEMU_OPT_BOOL,
3815             .help = "copy read data from backing file into image file",
3816         },{
3817             .name = "detect-zeroes",
3818             .type = QEMU_OPT_STRING,
3819             .help = "try to optimize zero writes (off, on, unmap)",
3820         },{
3821             .name = "stats-account-invalid",
3822             .type = QEMU_OPT_BOOL,
3823             .help = "whether to account for invalid I/O operations "
3824                     "in the statistics",
3825         },{
3826             .name = "stats-account-failed",
3827             .type = QEMU_OPT_BOOL,
3828             .help = "whether to account for failed I/O operations "
3829                     "in the statistics",
3830         },
3831         { /* end of list */ }
3832     },
3833 };
3834
3835 QemuOptsList qemu_drive_opts = {
3836     .name = "drive",
3837     .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3838     .desc = {
3839         /*
3840          * no elements => accept any params
3841          * validation will happen later
3842          */
3843         { /* end of list */ }
3844     },
3845 };