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