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