blockdev.c

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