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