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/main-loop.h"
  64 #include "qemu/throttle-options.h"
  65
  66 static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
  67     QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
  68
  69 static int do_open_tray(const char *blk_name, const char *qdev_id,
  70                         bool force, Error **errp);
  71 static void blockdev_remove_medium(bool has_device, const char *device,
  72                                    bool has_id, const char *id, Error **errp);
  73 static void blockdev_insert_medium(bool has_device, const char *device,
  74                                    bool has_id, const char *id,
  75                                    const char *node_name, Error **errp);
  76
  77 static const char *const if_name[IF_COUNT] = {
  78     [IF_NONE] = "none",
  79     [IF_IDE] = "ide",
  80     [IF_SCSI] = "scsi",
  81     [IF_FLOPPY] = "floppy",
  82     [IF_PFLASH] = "pflash",
  83     [IF_MTD] = "mtd",
  84     [IF_SD] = "sd",
  85     [IF_VIRTIO] = "virtio",
  86     [IF_XEN] = "xen",
  87 };
  88
  89 static int if_max_devs[IF_COUNT] = {
  90     /*
  91      * Do not change these numbers!  They govern how drive option
  92      * index maps to unit and bus.  That mapping is ABI.
  93      *
  94      * All controllers used to implement if=T drives need to support
  95      * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
  96      * Otherwise, some index values map to "impossible" bus, unit
  97      * values.
  98      *
  99      * For instance, if you change [IF_SCSI] to 255, -drive
 100      * if=scsi,index=12 no longer means bus=1,unit=5, but
 101      * bus=0,unit=12.  With an lsi53c895a controller (7 units max),
 102      * the drive can't be set up.  Regression.
 103      */
 104     [IF_IDE] = 2,
 105     [IF_SCSI] = 7,
 106 };
 107
 108 /**
 109  * Boards may call this to offer board-by-board overrides
 110  * of the default, global values.
 111  */
 112 void override_max_devs(BlockInterfaceType type, int max_devs)
 113 {
 114     BlockBackend *blk;
 115     DriveInfo *dinfo;
 116
 117     if (max_devs <= 0) {
 118         return;
 119     }
 120
 121     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 122         dinfo = blk_legacy_dinfo(blk);
 123         if (dinfo->type == type) {
 124             fprintf(stderr, "Cannot override units-per-bus property of"
 125                     " the %s interface, because a drive of that type has"
 126                     " already been added.\n", if_name[type]);
 127             g_assert_not_reached();
 128         }
 129     }
 130
 131     if_max_devs[type] = max_devs;
 132 }
 133
 134 /*
 135  * We automatically delete the drive when a device using it gets
 136  * unplugged.  Questionable feature, but we can't just drop it.
 137  * Device models call blockdev_mark_auto_del() to schedule the
 138  * automatic deletion, and generic qdev code calls blockdev_auto_del()
 139  * when deletion is actually safe.
 140  */
 141 void blockdev_mark_auto_del(BlockBackend *blk)
 142 {
 143     DriveInfo *dinfo = blk_legacy_dinfo(blk);
 144     BlockJob *job;
 145
 146     if (!dinfo) {
 147         return;
 148     }
 149
 150     for (job = block_job_next(NULL); job; job = block_job_next(job)) {
 151         if (block_job_has_bdrv(job, blk_bs(blk))) {
 152             AioContext *aio_context = job->job.aio_context;
 153             aio_context_acquire(aio_context);
 154
 155             job_cancel(&job->job, false);
 156
 157             aio_context_release(aio_context);
 158         }
 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 overlay 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 overlay 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 overlay 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 overlay already has a backing image");
1670         goto out;
1671     }
1672
1673     if (!state->new_bs->drv->supports_backing) {
1674         error_setg(errp, "The overlay 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 = bdrv_lookup_bs(backup->device, 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     aio_context_acquire(aio_context);
1880     state->bs = bs;
1881
1882     /* Paired with .clean() */
1883     bdrv_drained_begin(state->bs);
1884
1885     state->job = do_blockdev_backup(backup, common->block_job_txn, &local_err);
1886     if (local_err) {
1887         error_propagate(errp, local_err);
1888         goto out;
1889     }
1890
1891 out:
1892     aio_context_release(aio_context);
1893 }
1894
1895 static void blockdev_backup_commit(BlkActionState *common)
1896 {
1897     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1898     AioContext *aio_context;
1899
1900     aio_context = bdrv_get_aio_context(state->bs);
1901     aio_context_acquire(aio_context);
1902
1903     assert(state->job);
1904     job_start(&state->job->job);
1905
1906     aio_context_release(aio_context);
1907 }
1908
1909 static void blockdev_backup_abort(BlkActionState *common)
1910 {
1911     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1912
1913     if (state->job) {
1914         AioContext *aio_context;
1915
1916         aio_context = bdrv_get_aio_context(state->bs);
1917         aio_context_acquire(aio_context);
1918
1919         job_cancel_sync(&state->job->job);
1920
1921         aio_context_release(aio_context);
1922     }
1923 }
1924
1925 static void blockdev_backup_clean(BlkActionState *common)
1926 {
1927     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1928     AioContext *aio_context;
1929
1930     if (!state->bs) {
1931         return;
1932     }
1933
1934     aio_context = bdrv_get_aio_context(state->bs);
1935     aio_context_acquire(aio_context);
1936
1937     bdrv_drained_end(state->bs);
1938
1939     aio_context_release(aio_context);
1940 }
1941
1942 typedef struct BlockDirtyBitmapState {
1943     BlkActionState common;
1944     BdrvDirtyBitmap *bitmap;
1945     BlockDriverState *bs;
1946     HBitmap *backup;
1947     bool prepared;
1948     bool was_enabled;
1949 } BlockDirtyBitmapState;
1950
1951 static void block_dirty_bitmap_add_prepare(BlkActionState *common,
1952                                            Error **errp)
1953 {
1954     Error *local_err = NULL;
1955     BlockDirtyBitmapAdd *action;
1956     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1957                                              common, common);
1958
1959     if (action_check_completion_mode(common, errp) < 0) {
1960         return;
1961     }
1962
1963     action = common->action->u.block_dirty_bitmap_add.data;
1964     /* AIO context taken and released within qmp_block_dirty_bitmap_add */
1965     qmp_block_dirty_bitmap_add(action->node, action->name,
1966                                action->has_granularity, action->granularity,
1967                                action->has_persistent, action->persistent,
1968                                action->has_autoload, action->autoload,
1969                                action->has_disabled, action->disabled,
1970                                &local_err);
1971
1972     if (!local_err) {
1973         state->prepared = true;
1974     } else {
1975         error_propagate(errp, local_err);
1976     }
1977 }
1978
1979 static void block_dirty_bitmap_add_abort(BlkActionState *common)
1980 {
1981     BlockDirtyBitmapAdd *action;
1982     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1983                                              common, common);
1984
1985     action = common->action->u.block_dirty_bitmap_add.data;
1986     /* Should not be able to fail: IF the bitmap was added via .prepare(),
1987      * then the node reference and bitmap name must have been valid.
1988      */
1989     if (state->prepared) {
1990         qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
1991     }
1992 }
1993
1994 static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
1995                                              Error **errp)
1996 {
1997     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1998                                              common, common);
1999     BlockDirtyBitmap *action;
2000
2001     if (action_check_completion_mode(common, errp) < 0) {
2002         return;
2003     }
2004
2005     action = common->action->u.block_dirty_bitmap_clear.data;
2006     state->bitmap = block_dirty_bitmap_lookup(action->node,
2007                                               action->name,
2008                                               &state->bs,
2009                                               errp);
2010     if (!state->bitmap) {
2011         return;
2012     }
2013
2014     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
2015         return;
2016     }
2017
2018     bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2019 }
2020
2021 static void block_dirty_bitmap_restore(BlkActionState *common)
2022 {
2023     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2024                                              common, common);
2025
2026     if (state->backup) {
2027         bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
2028     }
2029 }
2030
2031 static void block_dirty_bitmap_free_backup(BlkActionState *common)
2032 {
2033     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2034                                              common, common);
2035
2036     hbitmap_free(state->backup);
2037 }
2038
2039 static void block_dirty_bitmap_enable_prepare(BlkActionState *common,
2040                                               Error **errp)
2041 {
2042     BlockDirtyBitmap *action;
2043     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2044                                              common, common);
2045
2046     if (action_check_completion_mode(common, errp) < 0) {
2047         return;
2048     }
2049
2050     action = common->action->u.block_dirty_bitmap_enable.data;
2051     state->bitmap = block_dirty_bitmap_lookup(action->node,
2052                                               action->name,
2053                                               NULL,
2054                                               errp);
2055     if (!state->bitmap) {
2056         return;
2057     }
2058
2059     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2060         return;
2061     }
2062
2063     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2064     bdrv_enable_dirty_bitmap(state->bitmap);
2065 }
2066
2067 static void block_dirty_bitmap_enable_abort(BlkActionState *common)
2068 {
2069     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2070                                              common, common);
2071
2072     if (!state->was_enabled) {
2073         bdrv_disable_dirty_bitmap(state->bitmap);
2074     }
2075 }
2076
2077 static void block_dirty_bitmap_disable_prepare(BlkActionState *common,
2078                                                Error **errp)
2079 {
2080     BlockDirtyBitmap *action;
2081     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2082                                              common, common);
2083
2084     if (action_check_completion_mode(common, errp) < 0) {
2085         return;
2086     }
2087
2088     action = common->action->u.block_dirty_bitmap_disable.data;
2089     state->bitmap = block_dirty_bitmap_lookup(action->node,
2090                                               action->name,
2091                                               NULL,
2092                                               errp);
2093     if (!state->bitmap) {
2094         return;
2095     }
2096
2097     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2098         return;
2099     }
2100
2101     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2102     bdrv_disable_dirty_bitmap(state->bitmap);
2103 }
2104
2105 static void block_dirty_bitmap_disable_abort(BlkActionState *common)
2106 {
2107     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2108                                              common, common);
2109
2110     if (state->was_enabled) {
2111         bdrv_enable_dirty_bitmap(state->bitmap);
2112     }
2113 }
2114
2115 static BdrvDirtyBitmap *do_block_dirty_bitmap_merge(
2116         const char *node, const char *target,
2117         BlockDirtyBitmapMergeSourceList *bitmaps,
2118         HBitmap **backup, Error **errp);
2119
2120 static void block_dirty_bitmap_merge_prepare(BlkActionState *common,
2121                                              Error **errp)
2122 {
2123     BlockDirtyBitmapMerge *action;
2124     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2125                                              common, common);
2126
2127     if (action_check_completion_mode(common, errp) < 0) {
2128         return;
2129     }
2130
2131     action = common->action->u.block_dirty_bitmap_merge.data;
2132
2133     state->bitmap = do_block_dirty_bitmap_merge(action->node, action->target,
2134                                                 action->bitmaps, &state->backup,
2135                                                 errp);
2136 }
2137
2138 static void abort_prepare(BlkActionState *common, Error **errp)
2139 {
2140     error_setg(errp, "Transaction aborted using Abort action");
2141 }
2142
2143 static void abort_commit(BlkActionState *common)
2144 {
2145     g_assert_not_reached(); /* this action never succeeds */
2146 }
2147
2148 static const BlkActionOps actions[] = {
2149     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2150         .instance_size = sizeof(ExternalSnapshotState),
2151         .prepare  = external_snapshot_prepare,
2152         .commit   = external_snapshot_commit,
2153         .abort = external_snapshot_abort,
2154         .clean = external_snapshot_clean,
2155     },
2156     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2157         .instance_size = sizeof(ExternalSnapshotState),
2158         .prepare  = external_snapshot_prepare,
2159         .commit   = external_snapshot_commit,
2160         .abort = external_snapshot_abort,
2161         .clean = external_snapshot_clean,
2162     },
2163     [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2164         .instance_size = sizeof(DriveBackupState),
2165         .prepare = drive_backup_prepare,
2166         .commit = drive_backup_commit,
2167         .abort = drive_backup_abort,
2168         .clean = drive_backup_clean,
2169     },
2170     [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2171         .instance_size = sizeof(BlockdevBackupState),
2172         .prepare = blockdev_backup_prepare,
2173         .commit = blockdev_backup_commit,
2174         .abort = blockdev_backup_abort,
2175         .clean = blockdev_backup_clean,
2176     },
2177     [TRANSACTION_ACTION_KIND_ABORT] = {
2178         .instance_size = sizeof(BlkActionState),
2179         .prepare = abort_prepare,
2180         .commit = abort_commit,
2181     },
2182     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2183         .instance_size = sizeof(InternalSnapshotState),
2184         .prepare  = internal_snapshot_prepare,
2185         .abort = internal_snapshot_abort,
2186         .clean = internal_snapshot_clean,
2187     },
2188     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2189         .instance_size = sizeof(BlockDirtyBitmapState),
2190         .prepare = block_dirty_bitmap_add_prepare,
2191         .abort = block_dirty_bitmap_add_abort,
2192     },
2193     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2194         .instance_size = sizeof(BlockDirtyBitmapState),
2195         .prepare = block_dirty_bitmap_clear_prepare,
2196         .commit = block_dirty_bitmap_free_backup,
2197         .abort = block_dirty_bitmap_restore,
2198     },
2199     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
2200         .instance_size = sizeof(BlockDirtyBitmapState),
2201         .prepare = block_dirty_bitmap_enable_prepare,
2202         .abort = block_dirty_bitmap_enable_abort,
2203     },
2204     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
2205         .instance_size = sizeof(BlockDirtyBitmapState),
2206         .prepare = block_dirty_bitmap_disable_prepare,
2207         .abort = block_dirty_bitmap_disable_abort,
2208     },
2209     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
2210         .instance_size = sizeof(BlockDirtyBitmapState),
2211         .prepare = block_dirty_bitmap_merge_prepare,
2212         .commit = block_dirty_bitmap_free_backup,
2213         .abort = block_dirty_bitmap_restore,
2214     },
2215     /* Where are transactions for MIRROR, COMMIT and STREAM?
2216      * Although these blockjobs use transaction callbacks like the backup job,
2217      * these jobs do not necessarily adhere to transaction semantics.
2218      * These jobs may not fully undo all of their actions on abort, nor do they
2219      * necessarily work in transactions with more than one job in them.
2220      */
2221 };
2222
2223 /**
2224  * Allocate a TransactionProperties structure if necessary, and fill
2225  * that structure with desired defaults if they are unset.
2226  */
2227 static TransactionProperties *get_transaction_properties(
2228     TransactionProperties *props)
2229 {
2230     if (!props) {
2231         props = g_new0(TransactionProperties, 1);
2232     }
2233
2234     if (!props->has_completion_mode) {
2235         props->has_completion_mode = true;
2236         props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
2237     }
2238
2239     return props;
2240 }
2241
2242 /*
2243  * 'Atomic' group operations.  The operations are performed as a set, and if
2244  * any fail then we roll back all operations in the group.
2245  */
2246 void qmp_transaction(TransactionActionList *dev_list,
2247                      bool has_props,
2248                      struct TransactionProperties *props,
2249                      Error **errp)
2250 {
2251     TransactionActionList *dev_entry = dev_list;
2252     JobTxn *block_job_txn = NULL;
2253     BlkActionState *state, *next;
2254     Error *local_err = NULL;
2255
2256     QTAILQ_HEAD(, BlkActionState) snap_bdrv_states;
2257     QTAILQ_INIT(&snap_bdrv_states);
2258
2259     /* Does this transaction get canceled as a group on failure?
2260      * If not, we don't really need to make a JobTxn.
2261      */
2262     props = get_transaction_properties(props);
2263     if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2264         block_job_txn = job_txn_new();
2265     }
2266
2267     /* drain all i/o before any operations */
2268     bdrv_drain_all();
2269
2270     /* We don't do anything in this loop that commits us to the operations */
2271     while (NULL != dev_entry) {
2272         TransactionAction *dev_info = NULL;
2273         const BlkActionOps *ops;
2274
2275         dev_info = dev_entry->value;
2276         dev_entry = dev_entry->next;
2277
2278         assert(dev_info->type < ARRAY_SIZE(actions));
2279
2280         ops = &actions[dev_info->type];
2281         assert(ops->instance_size > 0);
2282
2283         state = g_malloc0(ops->instance_size);
2284         state->ops = ops;
2285         state->action = dev_info;
2286         state->block_job_txn = block_job_txn;
2287         state->txn_props = props;
2288         QTAILQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2289
2290         state->ops->prepare(state, &local_err);
2291         if (local_err) {
2292             error_propagate(errp, local_err);
2293             goto delete_and_fail;
2294         }
2295     }
2296
2297     QTAILQ_FOREACH(state, &snap_bdrv_states, entry) {
2298         if (state->ops->commit) {
2299             state->ops->commit(state);
2300         }
2301     }
2302
2303     /* success */
2304     goto exit;
2305
2306 delete_and_fail:
2307     /* failure, and it is all-or-none; roll back all operations */
2308     QTAILQ_FOREACH_REVERSE(state, &snap_bdrv_states, entry) {
2309         if (state->ops->abort) {
2310             state->ops->abort(state);
2311         }
2312     }
2313 exit:
2314     QTAILQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
2315         if (state->ops->clean) {
2316             state->ops->clean(state);
2317         }
2318         g_free(state);
2319     }
2320     if (!has_props) {
2321         qapi_free_TransactionProperties(props);
2322     }
2323     job_txn_unref(block_job_txn);
2324 }
2325
2326 void qmp_eject(bool has_device, const char *device,
2327                bool has_id, const char *id,
2328                bool has_force, bool force, Error **errp)
2329 {
2330     Error *local_err = NULL;
2331     int rc;
2332
2333     if (!has_force) {
2334         force = false;
2335     }
2336
2337     rc = do_open_tray(has_device ? device : NULL,
2338                       has_id ? id : NULL,
2339                       force, &local_err);
2340     if (rc && rc != -ENOSYS) {
2341         error_propagate(errp, local_err);
2342         return;
2343     }
2344     error_free(local_err);
2345
2346     blockdev_remove_medium(has_device, device, has_id, id, errp);
2347 }
2348
2349 void qmp_block_passwd(bool has_device, const char *device,
2350                       bool has_node_name, const char *node_name,
2351                       const char *password, Error **errp)
2352 {
2353     error_setg(errp,
2354                "Setting block passwords directly is no longer supported");
2355 }
2356
2357 /*
2358  * Attempt to open the tray of @device.
2359  * If @force, ignore its tray lock.
2360  * Else, if the tray is locked, don't open it, but ask the guest to open it.
2361  * On error, store an error through @errp and return -errno.
2362  * If @device does not exist, return -ENODEV.
2363  * If it has no removable media, return -ENOTSUP.
2364  * If it has no tray, return -ENOSYS.
2365  * If the guest was asked to open the tray, return -EINPROGRESS.
2366  * Else, return 0.
2367  */
2368 static int do_open_tray(const char *blk_name, const char *qdev_id,
2369                         bool force, Error **errp)
2370 {
2371     BlockBackend *blk;
2372     const char *device = qdev_id ?: blk_name;
2373     bool locked;
2374
2375     blk = qmp_get_blk(blk_name, qdev_id, errp);
2376     if (!blk) {
2377         return -ENODEV;
2378     }
2379
2380     if (!blk_dev_has_removable_media(blk)) {
2381         error_setg(errp, "Device '%s' is not removable", device);
2382         return -ENOTSUP;
2383     }
2384
2385     if (!blk_dev_has_tray(blk)) {
2386         error_setg(errp, "Device '%s' does not have a tray", device);
2387         return -ENOSYS;
2388     }
2389
2390     if (blk_dev_is_tray_open(blk)) {
2391         return 0;
2392     }
2393
2394     locked = blk_dev_is_medium_locked(blk);
2395     if (locked) {
2396         blk_dev_eject_request(blk, force);
2397     }
2398
2399     if (!locked || force) {
2400         blk_dev_change_media_cb(blk, false, &error_abort);
2401     }
2402
2403     if (locked && !force) {
2404         error_setg(errp, "Device '%s' is locked and force was not specified, "
2405                    "wait for tray to open and try again", device);
2406         return -EINPROGRESS;
2407     }
2408
2409     return 0;
2410 }
2411
2412 void qmp_blockdev_open_tray(bool has_device, const char *device,
2413                             bool has_id, const char *id,
2414                             bool has_force, bool force,
2415                             Error **errp)
2416 {
2417     Error *local_err = NULL;
2418     int rc;
2419
2420     if (!has_force) {
2421         force = false;
2422     }
2423     rc = do_open_tray(has_device ? device : NULL,
2424                       has_id ? id : NULL,
2425                       force, &local_err);
2426     if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
2427         error_propagate(errp, local_err);
2428         return;
2429     }
2430     error_free(local_err);
2431 }
2432
2433 void qmp_blockdev_close_tray(bool has_device, const char *device,
2434                              bool has_id, const char *id,
2435                              Error **errp)
2436 {
2437     BlockBackend *blk;
2438     Error *local_err = NULL;
2439
2440     device = has_device ? device : NULL;
2441     id = has_id ? id : NULL;
2442
2443     blk = qmp_get_blk(device, id, errp);
2444     if (!blk) {
2445         return;
2446     }
2447
2448     if (!blk_dev_has_removable_media(blk)) {
2449         error_setg(errp, "Device '%s' is not removable", device ?: id);
2450         return;
2451     }
2452
2453     if (!blk_dev_has_tray(blk)) {
2454         /* Ignore this command on tray-less devices */
2455         return;
2456     }
2457
2458     if (!blk_dev_is_tray_open(blk)) {
2459         return;
2460     }
2461
2462     blk_dev_change_media_cb(blk, true, &local_err);
2463     if (local_err) {
2464         error_propagate(errp, local_err);
2465         return;
2466     }
2467 }
2468
2469 static void blockdev_remove_medium(bool has_device, const char *device,
2470                                    bool has_id, const char *id, Error **errp)
2471 {
2472     BlockBackend *blk;
2473     BlockDriverState *bs;
2474     AioContext *aio_context;
2475     bool has_attached_device;
2476
2477     device = has_device ? device : NULL;
2478     id = has_id ? id : NULL;
2479
2480     blk = qmp_get_blk(device, id, errp);
2481     if (!blk) {
2482         return;
2483     }
2484
2485     /* For BBs without a device, we can exchange the BDS tree at will */
2486     has_attached_device = blk_get_attached_dev(blk);
2487
2488     if (has_attached_device && !blk_dev_has_removable_media(blk)) {
2489         error_setg(errp, "Device '%s' is not removable", device ?: id);
2490         return;
2491     }
2492
2493     if (has_attached_device && blk_dev_has_tray(blk) &&
2494         !blk_dev_is_tray_open(blk))
2495     {
2496         error_setg(errp, "Tray of device '%s' is not open", device ?: id);
2497         return;
2498     }
2499
2500     bs = blk_bs(blk);
2501     if (!bs) {
2502         return;
2503     }
2504
2505     aio_context = bdrv_get_aio_context(bs);
2506     aio_context_acquire(aio_context);
2507
2508     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2509         goto out;
2510     }
2511
2512     blk_remove_bs(blk);
2513
2514     if (!blk_dev_has_tray(blk)) {
2515         /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
2516          * called at all); therefore, the medium needs to be ejected here.
2517          * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
2518          * value passed here (i.e. false). */
2519         blk_dev_change_media_cb(blk, false, &error_abort);
2520     }
2521
2522 out:
2523     aio_context_release(aio_context);
2524 }
2525
2526 void qmp_blockdev_remove_medium(const char *id, Error **errp)
2527 {
2528     blockdev_remove_medium(false, NULL, true, id, errp);
2529 }
2530
2531 static void qmp_blockdev_insert_anon_medium(BlockBackend *blk,
2532                                             BlockDriverState *bs, Error **errp)
2533 {
2534     Error *local_err = NULL;
2535     bool has_device;
2536     int ret;
2537
2538     /* For BBs without a device, we can exchange the BDS tree at will */
2539     has_device = blk_get_attached_dev(blk);
2540
2541     if (has_device && !blk_dev_has_removable_media(blk)) {
2542         error_setg(errp, "Device is not removable");
2543         return;
2544     }
2545
2546     if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2547         error_setg(errp, "Tray of the device is not open");
2548         return;
2549     }
2550
2551     if (blk_bs(blk)) {
2552         error_setg(errp, "There already is a medium in the device");
2553         return;
2554     }
2555
2556     ret = blk_insert_bs(blk, bs, errp);
2557     if (ret < 0) {
2558         return;
2559     }
2560
2561     if (!blk_dev_has_tray(blk)) {
2562         /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
2563          * called at all); therefore, the medium needs to be pushed into the
2564          * slot here.
2565          * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
2566          * value passed here (i.e. true). */
2567         blk_dev_change_media_cb(blk, true, &local_err);
2568         if (local_err) {
2569             error_propagate(errp, local_err);
2570             blk_remove_bs(blk);
2571             return;
2572         }
2573     }
2574 }
2575
2576 static void blockdev_insert_medium(bool has_device, const char *device,
2577                                    bool has_id, const char *id,
2578                                    const char *node_name, Error **errp)
2579 {
2580     BlockBackend *blk;
2581     BlockDriverState *bs;
2582
2583     blk = qmp_get_blk(has_device ? device : NULL,
2584                       has_id ? id : NULL,
2585                       errp);
2586     if (!blk) {
2587         return;
2588     }
2589
2590     bs = bdrv_find_node(node_name);
2591     if (!bs) {
2592         error_setg(errp, "Node '%s' not found", node_name);
2593         return;
2594     }
2595
2596     if (bdrv_has_blk(bs)) {
2597         error_setg(errp, "Node '%s' is already in use", node_name);
2598         return;
2599     }
2600
2601     qmp_blockdev_insert_anon_medium(blk, bs, errp);
2602 }
2603
2604 void qmp_blockdev_insert_medium(const char *id, const char *node_name,
2605                                 Error **errp)
2606 {
2607     blockdev_insert_medium(false, NULL, true, id, node_name, errp);
2608 }
2609
2610 void qmp_blockdev_change_medium(bool has_device, const char *device,
2611                                 bool has_id, const char *id,
2612                                 const char *filename,
2613                                 bool has_format, const char *format,
2614                                 bool has_read_only,
2615                                 BlockdevChangeReadOnlyMode read_only,
2616                                 Error **errp)
2617 {
2618     BlockBackend *blk;
2619     BlockDriverState *medium_bs = NULL;
2620     int bdrv_flags;
2621     bool detect_zeroes;
2622     int rc;
2623     QDict *options = NULL;
2624     Error *err = NULL;
2625
2626     blk = qmp_get_blk(has_device ? device : NULL,
2627                       has_id ? id : NULL,
2628                       errp);
2629     if (!blk) {
2630         goto fail;
2631     }
2632
2633     if (blk_bs(blk)) {
2634         blk_update_root_state(blk);
2635     }
2636
2637     bdrv_flags = blk_get_open_flags_from_root_state(blk);
2638     bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
2639         BDRV_O_PROTOCOL | BDRV_O_AUTO_RDONLY);
2640
2641     if (!has_read_only) {
2642         read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
2643     }
2644
2645     switch (read_only) {
2646     case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
2647         break;
2648
2649     case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
2650         bdrv_flags &= ~BDRV_O_RDWR;
2651         break;
2652
2653     case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
2654         bdrv_flags |= BDRV_O_RDWR;
2655         break;
2656
2657     default:
2658         abort();
2659     }
2660
2661     options = qdict_new();
2662     detect_zeroes = blk_get_detect_zeroes_from_root_state(blk);
2663     qdict_put_str(options, "detect-zeroes", detect_zeroes ? "on" : "off");
2664
2665     if (has_format) {
2666         qdict_put_str(options, "driver", format);
2667     }
2668
2669     medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
2670     if (!medium_bs) {
2671         goto fail;
2672     }
2673
2674     rc = do_open_tray(has_device ? device : NULL,
2675                       has_id ? id : NULL,
2676                       false, &err);
2677     if (rc && rc != -ENOSYS) {
2678         error_propagate(errp, err);
2679         goto fail;
2680     }
2681     error_free(err);
2682     err = NULL;
2683
2684     blockdev_remove_medium(has_device, device, has_id, id, &err);
2685     if (err) {
2686         error_propagate(errp, err);
2687         goto fail;
2688     }
2689
2690     qmp_blockdev_insert_anon_medium(blk, medium_bs, &err);
2691     if (err) {
2692         error_propagate(errp, err);
2693         goto fail;
2694     }
2695
2696     qmp_blockdev_close_tray(has_device, device, has_id, id, errp);
2697
2698 fail:
2699     /* If the medium has been inserted, the device has its own reference, so
2700      * ours must be relinquished; and if it has not been inserted successfully,
2701      * the reference must be relinquished anyway */
2702     bdrv_unref(medium_bs);
2703 }
2704
2705 /* throttling disk I/O limits */
2706 void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
2707 {
2708     ThrottleConfig cfg;
2709     BlockDriverState *bs;
2710     BlockBackend *blk;
2711     AioContext *aio_context;
2712
2713     blk = qmp_get_blk(arg->has_device ? arg->device : NULL,
2714                       arg->has_id ? arg->id : NULL,
2715                       errp);
2716     if (!blk) {
2717         return;
2718     }
2719
2720     aio_context = blk_get_aio_context(blk);
2721     aio_context_acquire(aio_context);
2722
2723     bs = blk_bs(blk);
2724     if (!bs) {
2725         error_setg(errp, "Device has no medium");
2726         goto out;
2727     }
2728
2729     throttle_config_init(&cfg);
2730     cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
2731     cfg.buckets[THROTTLE_BPS_READ].avg  = arg->bps_rd;
2732     cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2733
2734     cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
2735     cfg.buckets[THROTTLE_OPS_READ].avg  = arg->iops_rd;
2736     cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2737
2738     if (arg->has_bps_max) {
2739         cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2740     }
2741     if (arg->has_bps_rd_max) {
2742         cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2743     }
2744     if (arg->has_bps_wr_max) {
2745         cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2746     }
2747     if (arg->has_iops_max) {
2748         cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2749     }
2750     if (arg->has_iops_rd_max) {
2751         cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2752     }
2753     if (arg->has_iops_wr_max) {
2754         cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2755     }
2756
2757     if (arg->has_bps_max_length) {
2758         cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2759     }
2760     if (arg->has_bps_rd_max_length) {
2761         cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2762     }
2763     if (arg->has_bps_wr_max_length) {
2764         cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2765     }
2766     if (arg->has_iops_max_length) {
2767         cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2768     }
2769     if (arg->has_iops_rd_max_length) {
2770         cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2771     }
2772     if (arg->has_iops_wr_max_length) {
2773         cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2774     }
2775
2776     if (arg->has_iops_size) {
2777         cfg.op_size = arg->iops_size;
2778     }
2779
2780     if (!throttle_is_valid(&cfg, errp)) {
2781         goto out;
2782     }
2783
2784     if (throttle_enabled(&cfg)) {
2785         /* Enable I/O limits if they're not enabled yet, otherwise
2786          * just update the throttling group. */
2787         if (!blk_get_public(blk)->throttle_group_member.throttle_state) {
2788             blk_io_limits_enable(blk,
2789                                  arg->has_group ? arg->group :
2790                                  arg->has_device ? arg->device :
2791                                  arg->id);
2792         } else if (arg->has_group) {
2793             blk_io_limits_update_group(blk, arg->group);
2794         }
2795         /* Set the new throttling configuration */
2796         blk_set_io_limits(blk, &cfg);
2797     } else if (blk_get_public(blk)->throttle_group_member.throttle_state) {
2798         /* If all throttling settings are set to 0, disable I/O limits */
2799         blk_io_limits_disable(blk);
2800     }
2801
2802 out:
2803     aio_context_release(aio_context);
2804 }
2805
2806 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2807                                 bool has_granularity, uint32_t granularity,
2808                                 bool has_persistent, bool persistent,
2809                                 bool has_autoload, bool autoload,
2810                                 bool has_disabled, bool disabled,
2811                                 Error **errp)
2812 {
2813     BlockDriverState *bs;
2814     BdrvDirtyBitmap *bitmap;
2815     AioContext *aio_context = NULL;
2816
2817     if (!name || name[0] == '\0') {
2818         error_setg(errp, "Bitmap name cannot be empty");
2819         return;
2820     }
2821
2822     bs = bdrv_lookup_bs(node, node, errp);
2823     if (!bs) {
2824         return;
2825     }
2826
2827     if (has_granularity) {
2828         if (granularity < 512 || !is_power_of_2(granularity)) {
2829             error_setg(errp, "Granularity must be power of 2 "
2830                              "and at least 512");
2831             return;
2832         }
2833     } else {
2834         /* Default to cluster size, if available: */
2835         granularity = bdrv_get_default_bitmap_granularity(bs);
2836     }
2837
2838     if (!has_persistent) {
2839         persistent = false;
2840     }
2841
2842     if (has_autoload) {
2843         warn_report("Autoload option is deprecated and its value is ignored");
2844     }
2845
2846     if (!has_disabled) {
2847         disabled = false;
2848     }
2849
2850     if (persistent) {
2851         aio_context = bdrv_get_aio_context(bs);
2852         aio_context_acquire(aio_context);
2853         if (!bdrv_can_store_new_dirty_bitmap(bs, name, granularity, errp)) {
2854             goto out;
2855         }
2856     }
2857
2858     bitmap = bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2859     if (bitmap == NULL) {
2860         goto out;
2861     }
2862
2863     if (disabled) {
2864         bdrv_disable_dirty_bitmap(bitmap);
2865     }
2866
2867     bdrv_dirty_bitmap_set_persistence(bitmap, persistent);
2868  out:
2869     if (aio_context) {
2870         aio_context_release(aio_context);
2871     }
2872 }
2873
2874 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2875                                    Error **errp)
2876 {
2877     BlockDriverState *bs;
2878     BdrvDirtyBitmap *bitmap;
2879     Error *local_err = NULL;
2880     AioContext *aio_context = NULL;
2881
2882     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2883     if (!bitmap || !bs) {
2884         return;
2885     }
2886
2887     if (bdrv_dirty_bitmap_check(bitmap, BDRV_BITMAP_BUSY | BDRV_BITMAP_RO,
2888                                 errp)) {
2889         return;
2890     }
2891
2892     if (bdrv_dirty_bitmap_get_persistence(bitmap)) {
2893         aio_context = bdrv_get_aio_context(bs);
2894         aio_context_acquire(aio_context);
2895         bdrv_remove_persistent_dirty_bitmap(bs, name, &local_err);
2896         if (local_err != NULL) {
2897             error_propagate(errp, local_err);
2898             goto out;
2899         }
2900     }
2901
2902     bdrv_release_dirty_bitmap(bs, bitmap);
2903  out:
2904     if (aio_context) {
2905         aio_context_release(aio_context);
2906     }
2907 }
2908
2909 /**
2910  * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2911  * immediately after a full backup operation.
2912  */
2913 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2914                                   Error **errp)
2915 {
2916     BdrvDirtyBitmap *bitmap;
2917     BlockDriverState *bs;
2918
2919     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2920     if (!bitmap || !bs) {
2921         return;
2922     }
2923
2924     if (bdrv_dirty_bitmap_check(bitmap, BDRV_BITMAP_DEFAULT, errp)) {
2925         return;
2926     }
2927
2928     bdrv_clear_dirty_bitmap(bitmap, NULL);
2929 }
2930
2931 void qmp_block_dirty_bitmap_enable(const char *node, const char *name,
2932                                    Error **errp)
2933 {
2934     BlockDriverState *bs;
2935     BdrvDirtyBitmap *bitmap;
2936
2937     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2938     if (!bitmap) {
2939         return;
2940     }
2941
2942     if (bdrv_dirty_bitmap_check(bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2943         return;
2944     }
2945
2946     bdrv_enable_dirty_bitmap(bitmap);
2947 }
2948
2949 void qmp_block_dirty_bitmap_disable(const char *node, const char *name,
2950                                     Error **errp)
2951 {
2952     BlockDriverState *bs;
2953     BdrvDirtyBitmap *bitmap;
2954
2955     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2956     if (!bitmap) {
2957         return;
2958     }
2959
2960     if (bdrv_dirty_bitmap_check(bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2961         return;
2962     }
2963
2964     bdrv_disable_dirty_bitmap(bitmap);
2965 }
2966
2967 static BdrvDirtyBitmap *do_block_dirty_bitmap_merge(
2968         const char *node, const char *target,
2969         BlockDirtyBitmapMergeSourceList *bitmaps,
2970         HBitmap **backup, Error **errp)
2971 {
2972     BlockDriverState *bs;
2973     BdrvDirtyBitmap *dst, *src, *anon;
2974     BlockDirtyBitmapMergeSourceList *lst;
2975     Error *local_err = NULL;
2976
2977     dst = block_dirty_bitmap_lookup(node, target, &bs, errp);
2978     if (!dst) {
2979         return NULL;
2980     }
2981
2982     anon = bdrv_create_dirty_bitmap(bs, bdrv_dirty_bitmap_granularity(dst),
2983                                     NULL, errp);
2984     if (!anon) {
2985         return NULL;
2986     }
2987
2988     for (lst = bitmaps; lst; lst = lst->next) {
2989         switch (lst->value->type) {
2990             const char *name, *node;
2991         case QTYPE_QSTRING:
2992             name = lst->value->u.local;
2993             src = bdrv_find_dirty_bitmap(bs, name);
2994             if (!src) {
2995                 error_setg(errp, "Dirty bitmap '%s' not found", name);
2996                 dst = NULL;
2997                 goto out;
2998             }
2999             break;
3000         case QTYPE_QDICT:
3001             node = lst->value->u.external.node;
3002             name = lst->value->u.external.name;
3003             src = block_dirty_bitmap_lookup(node, name, NULL, errp);
3004             if (!src) {
3005                 dst = NULL;
3006                 goto out;
3007             }
3008             break;
3009         default:
3010             abort();
3011         }
3012
3013         bdrv_merge_dirty_bitmap(anon, src, NULL, &local_err);
3014         if (local_err) {
3015             error_propagate(errp, local_err);
3016             dst = NULL;
3017             goto out;
3018         }
3019     }
3020
3021     /* Merge into dst; dst is unchanged on failure. */
3022     bdrv_merge_dirty_bitmap(dst, anon, backup, errp);
3023
3024  out:
3025     bdrv_release_dirty_bitmap(bs, anon);
3026     return dst;
3027 }
3028
3029 void qmp_block_dirty_bitmap_merge(const char *node, const char *target,
3030                                   BlockDirtyBitmapMergeSourceList *bitmaps,
3031                                   Error **errp)
3032 {
3033     do_block_dirty_bitmap_merge(node, target, bitmaps, NULL, errp);
3034 }
3035
3036 BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
3037                                                               const char *name,
3038                                                               Error **errp)
3039 {
3040     BdrvDirtyBitmap *bitmap;
3041     BlockDriverState *bs;
3042     BlockDirtyBitmapSha256 *ret = NULL;
3043     char *sha256;
3044
3045     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
3046     if (!bitmap || !bs) {
3047         return NULL;
3048     }
3049
3050     sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
3051     if (sha256 == NULL) {
3052         return NULL;
3053     }
3054
3055     ret = g_new(BlockDirtyBitmapSha256, 1);
3056     ret->sha256 = sha256;
3057
3058     return ret;
3059 }
3060
3061 void hmp_drive_del(Monitor *mon, const QDict *qdict)
3062 {
3063     const char *id = qdict_get_str(qdict, "id");
3064     BlockBackend *blk;
3065     BlockDriverState *bs;
3066     AioContext *aio_context;
3067     Error *local_err = NULL;
3068
3069     bs = bdrv_find_node(id);
3070     if (bs) {
3071         qmp_blockdev_del(id, &local_err);
3072         if (local_err) {
3073             error_report_err(local_err);
3074         }
3075         return;
3076     }
3077
3078     blk = blk_by_name(id);
3079     if (!blk) {
3080         error_report("Device '%s' not found", id);
3081         return;
3082     }
3083
3084     if (!blk_legacy_dinfo(blk)) {
3085         error_report("Deleting device added with blockdev-add"
3086                      " is not supported");
3087         return;
3088     }
3089
3090     aio_context = blk_get_aio_context(blk);
3091     aio_context_acquire(aio_context);
3092
3093     bs = blk_bs(blk);
3094     if (bs) {
3095         if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
3096             error_report_err(local_err);
3097             aio_context_release(aio_context);
3098             return;
3099         }
3100
3101         blk_remove_bs(blk);
3102     }
3103
3104     /* Make the BlockBackend and the attached BlockDriverState anonymous */
3105     monitor_remove_blk(blk);
3106
3107     /* If this BlockBackend has a device attached to it, its refcount will be
3108      * decremented when the device is removed; otherwise we have to do so here.
3109      */
3110     if (blk_get_attached_dev(blk)) {
3111         /* Further I/O must not pause the guest */
3112         blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
3113                          BLOCKDEV_ON_ERROR_REPORT);
3114     } else {
3115         blk_unref(blk);
3116     }
3117
3118     aio_context_release(aio_context);
3119 }
3120
3121 void qmp_block_resize(bool has_device, const char *device,
3122                       bool has_node_name, const char *node_name,
3123                       int64_t size, Error **errp)
3124 {
3125     Error *local_err = NULL;
3126     BlockBackend *blk = NULL;
3127     BlockDriverState *bs;
3128     AioContext *aio_context;
3129     int ret;
3130
3131     bs = bdrv_lookup_bs(has_device ? device : NULL,
3132                         has_node_name ? node_name : NULL,
3133                         &local_err);
3134     if (local_err) {
3135         error_propagate(errp, local_err);
3136         return;
3137     }
3138
3139     aio_context = bdrv_get_aio_context(bs);
3140     aio_context_acquire(aio_context);
3141
3142     if (!bdrv_is_first_non_filter(bs)) {
3143         error_setg(errp, QERR_FEATURE_DISABLED, "resize");
3144         goto out;
3145     }
3146
3147     if (size < 0) {
3148         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
3149         goto out;
3150     }
3151
3152     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
3153         error_setg(errp, QERR_DEVICE_IN_USE, device);
3154         goto out;
3155     }
3156
3157     blk = blk_new(bdrv_get_aio_context(bs), BLK_PERM_RESIZE, BLK_PERM_ALL);
3158     ret = blk_insert_bs(blk, bs, errp);
3159     if (ret < 0) {
3160         goto out;
3161     }
3162
3163     bdrv_drained_begin(bs);
3164     ret = blk_truncate(blk, size, PREALLOC_MODE_OFF, errp);
3165     bdrv_drained_end(bs);
3166
3167 out:
3168     blk_unref(blk);
3169     aio_context_release(aio_context);
3170 }
3171
3172 void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
3173                       bool has_base, const char *base,
3174                       bool has_base_node, const char *base_node,
3175                       bool has_backing_file, const char *backing_file,
3176                       bool has_speed, int64_t speed,
3177                       bool has_on_error, BlockdevOnError on_error,
3178                       bool has_auto_finalize, bool auto_finalize,
3179                       bool has_auto_dismiss, bool auto_dismiss,
3180                       Error **errp)
3181 {
3182     BlockDriverState *bs, *iter;
3183     BlockDriverState *base_bs = NULL;
3184     AioContext *aio_context;
3185     Error *local_err = NULL;
3186     const char *base_name = NULL;
3187     int job_flags = JOB_DEFAULT;
3188
3189     if (!has_on_error) {
3190         on_error = BLOCKDEV_ON_ERROR_REPORT;
3191     }
3192
3193     bs = bdrv_lookup_bs(device, device, errp);
3194     if (!bs) {
3195         return;
3196     }
3197
3198     aio_context = bdrv_get_aio_context(bs);
3199     aio_context_acquire(aio_context);
3200
3201     if (has_base && has_base_node) {
3202         error_setg(errp, "'base' and 'base-node' cannot be specified "
3203                    "at the same time");
3204         goto out;
3205     }
3206
3207     if (has_base) {
3208         base_bs = bdrv_find_backing_image(bs, base);
3209         if (base_bs == NULL) {
3210             error_setg(errp, QERR_BASE_NOT_FOUND, base);
3211             goto out;
3212         }
3213         assert(bdrv_get_aio_context(base_bs) == aio_context);
3214         base_name = base;
3215     }
3216
3217     if (has_base_node) {
3218         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3219         if (!base_bs) {
3220             goto out;
3221         }
3222         if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
3223             error_setg(errp, "Node '%s' is not a backing image of '%s'",
3224                        base_node, device);
3225             goto out;
3226         }
3227         assert(bdrv_get_aio_context(base_bs) == aio_context);
3228         bdrv_refresh_filename(base_bs);
3229         base_name = base_bs->filename;
3230     }
3231
3232     /* Check for op blockers in the whole chain between bs and base */
3233     for (iter = bs; iter && iter != base_bs; iter = backing_bs(iter)) {
3234         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
3235             goto out;
3236         }
3237     }
3238
3239     /* if we are streaming the entire chain, the result will have no backing
3240      * file, and specifying one is therefore an error */
3241     if (base_bs == NULL && has_backing_file) {
3242         error_setg(errp, "backing file specified, but streaming the "
3243                          "entire chain");
3244         goto out;
3245     }
3246
3247     /* backing_file string overrides base bs filename */
3248     base_name = has_backing_file ? backing_file : base_name;
3249
3250     if (has_auto_finalize && !auto_finalize) {
3251         job_flags |= JOB_MANUAL_FINALIZE;
3252     }
3253     if (has_auto_dismiss && !auto_dismiss) {
3254         job_flags |= JOB_MANUAL_DISMISS;
3255     }
3256
3257     stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
3258                  job_flags, has_speed ? speed : 0, on_error, &local_err);
3259     if (local_err) {
3260         error_propagate(errp, local_err);
3261         goto out;
3262     }
3263
3264     trace_qmp_block_stream(bs);
3265
3266 out:
3267     aio_context_release(aio_context);
3268 }
3269
3270 void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3271                       bool has_base_node, const char *base_node,
3272                       bool has_base, const char *base,
3273                       bool has_top_node, const char *top_node,
3274                       bool has_top, const char *top,
3275                       bool has_backing_file, const char *backing_file,
3276                       bool has_speed, int64_t speed,
3277                       bool has_filter_node_name, const char *filter_node_name,
3278                       bool has_auto_finalize, bool auto_finalize,
3279                       bool has_auto_dismiss, bool auto_dismiss,
3280                       Error **errp)
3281 {
3282     BlockDriverState *bs;
3283     BlockDriverState *iter;
3284     BlockDriverState *base_bs, *top_bs;
3285     AioContext *aio_context;
3286     Error *local_err = NULL;
3287     /* This will be part of the QMP command, if/when the
3288      * BlockdevOnError change for blkmirror makes it in
3289      */
3290     BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3291     int job_flags = JOB_DEFAULT;
3292
3293     if (!has_speed) {
3294         speed = 0;
3295     }
3296     if (!has_filter_node_name) {
3297         filter_node_name = NULL;
3298     }
3299     if (has_auto_finalize && !auto_finalize) {
3300         job_flags |= JOB_MANUAL_FINALIZE;
3301     }
3302     if (has_auto_dismiss && !auto_dismiss) {
3303         job_flags |= JOB_MANUAL_DISMISS;
3304     }
3305
3306     /* Important Note:
3307      *  libvirt relies on the DeviceNotFound error class in order to probe for
3308      *  live commit feature versions; for this to work, we must make sure to
3309      *  perform the device lookup before any generic errors that may occur in a
3310      *  scenario in which all optional arguments are omitted. */
3311     bs = qmp_get_root_bs(device, &local_err);
3312     if (!bs) {
3313         bs = bdrv_lookup_bs(device, device, NULL);
3314         if (!bs) {
3315             error_free(local_err);
3316             error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3317                       "Device '%s' not found", device);
3318         } else {
3319             error_propagate(errp, local_err);
3320         }
3321         return;
3322     }
3323
3324     aio_context = bdrv_get_aio_context(bs);
3325     aio_context_acquire(aio_context);
3326
3327     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3328         goto out;
3329     }
3330
3331     /* default top_bs is the active layer */
3332     top_bs = bs;
3333
3334     if (has_top_node && has_top) {
3335         error_setg(errp, "'top-node' and 'top' are mutually exclusive");
3336         goto out;
3337     } else if (has_top_node) {
3338         top_bs = bdrv_lookup_bs(NULL, top_node, errp);
3339         if (top_bs == NULL) {
3340             goto out;
3341         }
3342         if (!bdrv_chain_contains(bs, top_bs)) {
3343             error_setg(errp, "'%s' is not in this backing file chain",
3344                        top_node);
3345             goto out;
3346         }
3347     } else if (has_top && top) {
3348         /* This strcmp() is just a shortcut, there is no need to
3349          * refresh @bs's filename.  If it mismatches,
3350          * bdrv_find_backing_image() will do the refresh and may still
3351          * return @bs. */
3352         if (strcmp(bs->filename, top) != 0) {
3353             top_bs = bdrv_find_backing_image(bs, top);
3354         }
3355     }
3356
3357     if (top_bs == NULL) {
3358         error_setg(errp, "Top image file %s not found", top ? top : "NULL");
3359         goto out;
3360     }
3361
3362     assert(bdrv_get_aio_context(top_bs) == aio_context);
3363
3364     if (has_base_node && has_base) {
3365         error_setg(errp, "'base-node' and 'base' are mutually exclusive");
3366         goto out;
3367     } else if (has_base_node) {
3368         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
3369         if (base_bs == NULL) {
3370             goto out;
3371         }
3372         if (!bdrv_chain_contains(top_bs, base_bs)) {
3373             error_setg(errp, "'%s' is not in this backing file chain",
3374                        base_node);
3375             goto out;
3376         }
3377     } else if (has_base && base) {
3378         base_bs = bdrv_find_backing_image(top_bs, base);
3379     } else {
3380         base_bs = bdrv_find_base(top_bs);
3381     }
3382
3383     if (base_bs == NULL) {
3384         error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3385         goto out;
3386     }
3387
3388     assert(bdrv_get_aio_context(base_bs) == aio_context);
3389
3390     for (iter = top_bs; iter != backing_bs(base_bs); iter = backing_bs(iter)) {
3391         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3392             goto out;
3393         }
3394     }
3395
3396     /* Do not allow attempts to commit an image into itself */
3397     if (top_bs == base_bs) {
3398         error_setg(errp, "cannot commit an image into itself");
3399         goto out;
3400     }
3401
3402     if (top_bs == bs) {
3403         if (has_backing_file) {
3404             error_setg(errp, "'backing-file' specified,"
3405                              " but 'top' is the active layer");
3406             goto out;
3407         }
3408         commit_active_start(has_job_id ? job_id : NULL, bs, base_bs,
3409                             job_flags, speed, on_error,
3410                             filter_node_name, NULL, NULL, false, &local_err);
3411     } else {
3412         BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
3413         if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
3414             goto out;
3415         }
3416         commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, job_flags,
3417                      speed, on_error, has_backing_file ? backing_file : NULL,
3418                      filter_node_name, &local_err);
3419     }
3420     if (local_err != NULL) {
3421         error_propagate(errp, local_err);
3422         goto out;
3423     }
3424
3425 out:
3426     aio_context_release(aio_context);
3427 }
3428
3429 static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
3430                                  Error **errp)
3431 {
3432     BlockDriverState *bs;
3433     BlockDriverState *target_bs;
3434     BlockDriverState *source = NULL;
3435     BlockJob *job = NULL;
3436     BdrvDirtyBitmap *bmap = NULL;
3437     AioContext *aio_context;
3438     QDict *options = NULL;
3439     Error *local_err = NULL;
3440     int flags, job_flags = JOB_DEFAULT;
3441     int64_t size;
3442     bool set_backing_hd = false;
3443     int ret;
3444
3445     if (!backup->has_speed) {
3446         backup->speed = 0;
3447     }
3448     if (!backup->has_on_source_error) {
3449         backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3450     }
3451     if (!backup->has_on_target_error) {
3452         backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3453     }
3454     if (!backup->has_mode) {
3455         backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3456     }
3457     if (!backup->has_job_id) {
3458         backup->job_id = NULL;
3459     }
3460     if (!backup->has_auto_finalize) {
3461         backup->auto_finalize = true;
3462     }
3463     if (!backup->has_auto_dismiss) {
3464         backup->auto_dismiss = true;
3465     }
3466     if (!backup->has_compress) {
3467         backup->compress = false;
3468     }
3469
3470     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
3471     if (!bs) {
3472         return NULL;
3473     }
3474
3475     if (!bs->drv) {
3476         error_setg(errp, "Device has no medium");
3477         return NULL;
3478     }
3479
3480     aio_context = bdrv_get_aio_context(bs);
3481     aio_context_acquire(aio_context);
3482
3483     if (!backup->has_format) {
3484         backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
3485                          NULL : (char*) bs->drv->format_name;
3486     }
3487
3488     /* Early check to avoid creating target */
3489     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3490         goto out;
3491     }
3492
3493     flags = bs->open_flags | BDRV_O_RDWR;
3494
3495     /* See if we have a backing HD we can use to create our new image
3496      * on top of. */
3497     if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3498         source = backing_bs(bs);
3499         if (!source) {
3500             backup->sync = MIRROR_SYNC_MODE_FULL;
3501         }
3502     }
3503     if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3504         source = bs;
3505         flags |= BDRV_O_NO_BACKING;
3506         set_backing_hd = true;
3507     }
3508
3509     size = bdrv_getlength(bs);
3510     if (size < 0) {
3511         error_setg_errno(errp, -size, "bdrv_getlength failed");
3512         goto out;
3513     }
3514
3515     if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
3516         assert(backup->format);
3517         if (source) {
3518             bdrv_refresh_filename(source);
3519             bdrv_img_create(backup->target, backup->format, source->filename,
3520                             source->drv->format_name, NULL,
3521                             size, flags, false, &local_err);
3522         } else {
3523             bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3524                             size, flags, false, &local_err);
3525         }
3526     }
3527
3528     if (local_err) {
3529         error_propagate(errp, local_err);
3530         goto out;
3531     }
3532
3533     if (backup->format) {
3534         if (!options) {
3535             options = qdict_new();
3536         }
3537         qdict_put_str(options, "driver", backup->format);
3538     }
3539
3540     target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
3541     if (!target_bs) {
3542         goto out;
3543     }
3544
3545     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3546     if (ret < 0) {
3547         bdrv_unref(target_bs);
3548         goto out;
3549     }
3550
3551     if (set_backing_hd) {
3552         bdrv_set_backing_hd(target_bs, source, &local_err);
3553         if (local_err) {
3554             goto unref;
3555         }
3556     }
3557
3558     if (backup->has_bitmap) {
3559         bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3560         if (!bmap) {
3561             error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3562             goto unref;
3563         }
3564         if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_DEFAULT, errp)) {
3565             goto unref;
3566         }
3567     }
3568     if (!backup->auto_finalize) {
3569         job_flags |= JOB_MANUAL_FINALIZE;
3570     }
3571     if (!backup->auto_dismiss) {
3572         job_flags |= JOB_MANUAL_DISMISS;
3573     }
3574
3575     job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3576                             backup->sync, bmap, backup->compress,
3577                             backup->on_source_error, backup->on_target_error,
3578                             job_flags, NULL, NULL, txn, &local_err);
3579     if (local_err != NULL) {
3580         error_propagate(errp, local_err);
3581         goto unref;
3582     }
3583
3584 unref:
3585     bdrv_unref(target_bs);
3586 out:
3587     aio_context_release(aio_context);
3588     return job;
3589 }
3590
3591 void qmp_drive_backup(DriveBackup *arg, Error **errp)
3592 {
3593
3594     BlockJob *job;
3595     job = do_drive_backup(arg, NULL, errp);
3596     if (job) {
3597         job_start(&job->job);
3598     }
3599 }
3600
3601 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
3602 {
3603     return bdrv_named_nodes_list(errp);
3604 }
3605
3606 XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
3607 {
3608     return bdrv_get_xdbg_block_graph(errp);
3609 }
3610
3611 BlockJob *do_blockdev_backup(BlockdevBackup *backup, JobTxn *txn,
3612                              Error **errp)
3613 {
3614     BlockDriverState *bs;
3615     BlockDriverState *target_bs;
3616     Error *local_err = NULL;
3617     BdrvDirtyBitmap *bmap = NULL;
3618     AioContext *aio_context;
3619     BlockJob *job = NULL;
3620     int job_flags = JOB_DEFAULT;
3621     int ret;
3622
3623     if (!backup->has_speed) {
3624         backup->speed = 0;
3625     }
3626     if (!backup->has_on_source_error) {
3627         backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3628     }
3629     if (!backup->has_on_target_error) {
3630         backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3631     }
3632     if (!backup->has_job_id) {
3633         backup->job_id = NULL;
3634     }
3635     if (!backup->has_auto_finalize) {
3636         backup->auto_finalize = true;
3637     }
3638     if (!backup->has_auto_dismiss) {
3639         backup->auto_dismiss = true;
3640     }
3641     if (!backup->has_compress) {
3642         backup->compress = false;
3643     }
3644
3645     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
3646     if (!bs) {
3647         return NULL;
3648     }
3649
3650     aio_context = bdrv_get_aio_context(bs);
3651     aio_context_acquire(aio_context);
3652
3653     target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
3654     if (!target_bs) {
3655         goto out;
3656     }
3657
3658     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3659     if (ret < 0) {
3660         goto out;
3661     }
3662
3663     if (backup->has_bitmap) {
3664         bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3665         if (!bmap) {
3666             error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3667             goto out;
3668         }
3669         if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_DEFAULT, errp)) {
3670             goto out;
3671         }
3672     }
3673
3674     if (!backup->auto_finalize) {
3675         job_flags |= JOB_MANUAL_FINALIZE;
3676     }
3677     if (!backup->auto_dismiss) {
3678         job_flags |= JOB_MANUAL_DISMISS;
3679     }
3680     job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
3681                             backup->sync, bmap, backup->compress,
3682                             backup->on_source_error, backup->on_target_error,
3683                             job_flags, NULL, NULL, txn, &local_err);
3684     if (local_err != NULL) {
3685         error_propagate(errp, local_err);
3686     }
3687 out:
3688     aio_context_release(aio_context);
3689     return job;
3690 }
3691
3692 void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
3693 {
3694     BlockJob *job;
3695     job = do_blockdev_backup(arg, NULL, errp);
3696     if (job) {
3697         job_start(&job->job);
3698     }
3699 }
3700
3701 /* Parameter check and block job starting for drive mirroring.
3702  * Caller should hold @device and @target's aio context (must be the same).
3703  **/
3704 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3705                                    BlockDriverState *target,
3706                                    bool has_replaces, const char *replaces,
3707                                    enum MirrorSyncMode sync,
3708                                    BlockMirrorBackingMode backing_mode,
3709                                    bool has_speed, int64_t speed,
3710                                    bool has_granularity, uint32_t granularity,
3711                                    bool has_buf_size, int64_t buf_size,
3712                                    bool has_on_source_error,
3713                                    BlockdevOnError on_source_error,
3714                                    bool has_on_target_error,
3715                                    BlockdevOnError on_target_error,
3716                                    bool has_unmap, bool unmap,
3717                                    bool has_filter_node_name,
3718                                    const char *filter_node_name,
3719                                    bool has_copy_mode, MirrorCopyMode copy_mode,
3720                                    bool has_auto_finalize, bool auto_finalize,
3721                                    bool has_auto_dismiss, bool auto_dismiss,
3722                                    Error **errp)
3723 {
3724     int job_flags = JOB_DEFAULT;
3725
3726     if (!has_speed) {
3727         speed = 0;
3728     }
3729     if (!has_on_source_error) {
3730         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3731     }
3732     if (!has_on_target_error) {
3733         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3734     }
3735     if (!has_granularity) {
3736         granularity = 0;
3737     }
3738     if (!has_buf_size) {
3739         buf_size = 0;
3740     }
3741     if (!has_unmap) {
3742         unmap = true;
3743     }
3744     if (!has_filter_node_name) {
3745         filter_node_name = NULL;
3746     }
3747     if (!has_copy_mode) {
3748         copy_mode = MIRROR_COPY_MODE_BACKGROUND;
3749     }
3750     if (has_auto_finalize && !auto_finalize) {
3751         job_flags |= JOB_MANUAL_FINALIZE;
3752     }
3753     if (has_auto_dismiss && !auto_dismiss) {
3754         job_flags |= JOB_MANUAL_DISMISS;
3755     }
3756
3757     if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3758         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3759                    "a value in range [512B, 64MB]");
3760         return;
3761     }
3762     if (granularity & (granularity - 1)) {
3763         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3764                    "power of 2");
3765         return;
3766     }
3767
3768     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3769         return;
3770     }
3771     if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
3772         return;
3773     }
3774
3775     if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
3776         sync = MIRROR_SYNC_MODE_FULL;
3777     }
3778
3779     if (has_replaces) {
3780         BlockDriverState *to_replace_bs;
3781         AioContext *replace_aio_context;
3782         int64_t bs_size, replace_size;
3783
3784         bs_size = bdrv_getlength(bs);
3785         if (bs_size < 0) {
3786             error_setg_errno(errp, -bs_size, "Failed to query device's size");
3787             return;
3788         }
3789
3790         to_replace_bs = check_to_replace_node(bs, replaces, errp);
3791         if (!to_replace_bs) {
3792             return;
3793         }
3794
3795         replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3796         aio_context_acquire(replace_aio_context);
3797         replace_size = bdrv_getlength(to_replace_bs);
3798         aio_context_release(replace_aio_context);
3799
3800         if (replace_size < 0) {
3801             error_setg_errno(errp, -replace_size,
3802                              "Failed to query the replacement node's size");
3803             return;
3804         }
3805         if (bs_size != replace_size) {
3806             error_setg(errp, "cannot replace image with a mirror image of "
3807                              "different size");
3808             return;
3809         }
3810     }
3811
3812     /* pass the node name to replace to mirror start since it's loose coupling
3813      * and will allow to check whether the node still exist at mirror completion
3814      */
3815     mirror_start(job_id, bs, target,
3816                  has_replaces ? replaces : NULL, job_flags,
3817                  speed, granularity, buf_size, sync, backing_mode,
3818                  on_source_error, on_target_error, unmap, filter_node_name,
3819                  copy_mode, errp);
3820 }
3821
3822 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3823 {
3824     BlockDriverState *bs;
3825     BlockDriverState *source, *target_bs;
3826     AioContext *aio_context;
3827     BlockMirrorBackingMode backing_mode;
3828     Error *local_err = NULL;
3829     QDict *options = NULL;
3830     int flags;
3831     int64_t size;
3832     const char *format = arg->format;
3833     int ret;
3834
3835     bs = qmp_get_root_bs(arg->device, errp);
3836     if (!bs) {
3837         return;
3838     }
3839
3840     /* Early check to avoid creating target */
3841     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3842         return;
3843     }
3844
3845     aio_context = bdrv_get_aio_context(bs);
3846     aio_context_acquire(aio_context);
3847
3848     if (!arg->has_mode) {
3849         arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3850     }
3851
3852     if (!arg->has_format) {
3853         format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3854                   ? NULL : bs->drv->format_name);
3855     }
3856
3857     flags = bs->open_flags | BDRV_O_RDWR;
3858     source = backing_bs(bs);
3859     if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
3860         arg->sync = MIRROR_SYNC_MODE_FULL;
3861     }
3862     if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3863         source = bs;
3864     }
3865
3866     size = bdrv_getlength(bs);
3867     if (size < 0) {
3868         error_setg_errno(errp, -size, "bdrv_getlength failed");
3869         goto out;
3870     }
3871
3872     if (arg->has_replaces) {
3873         if (!arg->has_node_name) {
3874             error_setg(errp, "a node-name must be provided when replacing a"
3875                              " named node of the graph");
3876             goto out;
3877         }
3878     }
3879
3880     if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3881         backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3882     } else {
3883         backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3884     }
3885
3886     /* Don't open backing image in create() */
3887     flags |= BDRV_O_NO_BACKING;
3888
3889     if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
3890         && arg->mode != NEW_IMAGE_MODE_EXISTING)
3891     {
3892         /* create new image w/o backing file */
3893         assert(format);
3894         bdrv_img_create(arg->target, format,
3895                         NULL, NULL, NULL, size, flags, false, &local_err);
3896     } else {
3897         switch (arg->mode) {
3898         case NEW_IMAGE_MODE_EXISTING:
3899             break;
3900         case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3901             /* create new image with backing file */
3902             bdrv_refresh_filename(source);
3903             bdrv_img_create(arg->target, format,
3904                             source->filename,
3905                             source->drv->format_name,
3906                             NULL, size, flags, false, &local_err);
3907             break;
3908         default:
3909             abort();
3910         }
3911     }
3912
3913     if (local_err) {
3914         error_propagate(errp, local_err);
3915         goto out;
3916     }
3917
3918     options = qdict_new();
3919     if (arg->has_node_name) {
3920         qdict_put_str(options, "node-name", arg->node_name);
3921     }
3922     if (format) {
3923         qdict_put_str(options, "driver", format);
3924     }
3925
3926     /* Mirroring takes care of copy-on-write using the source's backing
3927      * file.
3928      */
3929     target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
3930     if (!target_bs) {
3931         goto out;
3932     }
3933
3934     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3935     if (ret < 0) {
3936         bdrv_unref(target_bs);
3937         goto out;
3938     }
3939
3940     blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
3941                            arg->has_replaces, arg->replaces, arg->sync,
3942                            backing_mode, arg->has_speed, arg->speed,
3943                            arg->has_granularity, arg->granularity,
3944                            arg->has_buf_size, arg->buf_size,
3945                            arg->has_on_source_error, arg->on_source_error,
3946                            arg->has_on_target_error, arg->on_target_error,
3947                            arg->has_unmap, arg->unmap,
3948                            false, NULL,
3949                            arg->has_copy_mode, arg->copy_mode,
3950                            arg->has_auto_finalize, arg->auto_finalize,
3951                            arg->has_auto_dismiss, arg->auto_dismiss,
3952                            &local_err);
3953     bdrv_unref(target_bs);
3954     error_propagate(errp, local_err);
3955 out:
3956     aio_context_release(aio_context);
3957 }
3958
3959 void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
3960                          const char *device, const char *target,
3961                          bool has_replaces, const char *replaces,
3962                          MirrorSyncMode sync,
3963                          bool has_speed, int64_t speed,
3964                          bool has_granularity, uint32_t granularity,
3965                          bool has_buf_size, int64_t buf_size,
3966                          bool has_on_source_error,
3967                          BlockdevOnError on_source_error,
3968                          bool has_on_target_error,
3969                          BlockdevOnError on_target_error,
3970                          bool has_filter_node_name,
3971                          const char *filter_node_name,
3972                          bool has_copy_mode, MirrorCopyMode copy_mode,
3973                          bool has_auto_finalize, bool auto_finalize,
3974                          bool has_auto_dismiss, bool auto_dismiss,
3975                          Error **errp)
3976 {
3977     BlockDriverState *bs;
3978     BlockDriverState *target_bs;
3979     AioContext *aio_context;
3980     BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3981     Error *local_err = NULL;
3982     int ret;
3983
3984     bs = qmp_get_root_bs(device, errp);
3985     if (!bs) {
3986         return;
3987     }
3988
3989     target_bs = bdrv_lookup_bs(target, target, errp);
3990     if (!target_bs) {
3991         return;
3992     }
3993
3994     aio_context = bdrv_get_aio_context(bs);
3995     aio_context_acquire(aio_context);
3996
3997     ret = bdrv_try_set_aio_context(target_bs, aio_context, errp);
3998     if (ret < 0) {
3999         goto out;
4000     }
4001
4002     blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
4003                            has_replaces, replaces, sync, backing_mode,
4004                            has_speed, speed,
4005                            has_granularity, granularity,
4006                            has_buf_size, buf_size,
4007                            has_on_source_error, on_source_error,
4008                            has_on_target_error, on_target_error,
4009                            true, true,
4010                            has_filter_node_name, filter_node_name,
4011                            has_copy_mode, copy_mode,
4012                            has_auto_finalize, auto_finalize,
4013                            has_auto_dismiss, auto_dismiss,
4014                            &local_err);
4015     error_propagate(errp, local_err);
4016 out:
4017     aio_context_release(aio_context);
4018 }
4019
4020 /* Get a block job using its ID and acquire its AioContext */
4021 static BlockJob *find_block_job(const char *id, AioContext **aio_context,
4022                                 Error **errp)
4023 {
4024     BlockJob *job;
4025
4026     assert(id != NULL);
4027
4028     *aio_context = NULL;
4029
4030     job = block_job_get(id);
4031
4032     if (!job) {
4033         error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
4034                   "Block job '%s' not found", id);
4035         return NULL;
4036     }
4037
4038     *aio_context = blk_get_aio_context(job->blk);
4039     aio_context_acquire(*aio_context);
4040
4041     return job;
4042 }
4043
4044 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
4045 {
4046     AioContext *aio_context;
4047     BlockJob *job = find_block_job(device, &aio_context, errp);
4048
4049     if (!job) {
4050         return;
4051     }
4052
4053     block_job_set_speed(job, speed, errp);
4054     aio_context_release(aio_context);
4055 }
4056
4057 void qmp_block_job_cancel(const char *device,
4058                           bool has_force, bool force, Error **errp)
4059 {
4060     AioContext *aio_context;
4061     BlockJob *job = find_block_job(device, &aio_context, errp);
4062
4063     if (!job) {
4064         return;
4065     }
4066
4067     if (!has_force) {
4068         force = false;
4069     }
4070
4071     if (job_user_paused(&job->job) && !force) {
4072         error_setg(errp, "The block job for device '%s' is currently paused",
4073                    device);
4074         goto out;
4075     }
4076
4077     trace_qmp_block_job_cancel(job);
4078     job_user_cancel(&job->job, force, errp);
4079 out:
4080     aio_context_release(aio_context);
4081 }
4082
4083 void qmp_block_job_pause(const char *device, Error **errp)
4084 {
4085     AioContext *aio_context;
4086     BlockJob *job = find_block_job(device, &aio_context, errp);
4087
4088     if (!job) {
4089         return;
4090     }
4091
4092     trace_qmp_block_job_pause(job);
4093     job_user_pause(&job->job, errp);
4094     aio_context_release(aio_context);
4095 }
4096
4097 void qmp_block_job_resume(const char *device, Error **errp)
4098 {
4099     AioContext *aio_context;
4100     BlockJob *job = find_block_job(device, &aio_context, errp);
4101
4102     if (!job) {
4103         return;
4104     }
4105
4106     trace_qmp_block_job_resume(job);
4107     job_user_resume(&job->job, errp);
4108     aio_context_release(aio_context);
4109 }
4110
4111 void qmp_block_job_complete(const char *device, Error **errp)
4112 {
4113     AioContext *aio_context;
4114     BlockJob *job = find_block_job(device, &aio_context, errp);
4115
4116     if (!job) {
4117         return;
4118     }
4119
4120     trace_qmp_block_job_complete(job);
4121     job_complete(&job->job, errp);
4122     aio_context_release(aio_context);
4123 }
4124
4125 void qmp_block_job_finalize(const char *id, Error **errp)
4126 {
4127     AioContext *aio_context;
4128     BlockJob *job = find_block_job(id, &aio_context, errp);
4129
4130     if (!job) {
4131         return;
4132     }
4133
4134     trace_qmp_block_job_finalize(job);
4135     job_finalize(&job->job, errp);
4136     aio_context_release(aio_context);
4137 }
4138
4139 void qmp_block_job_dismiss(const char *id, Error **errp)
4140 {
4141     AioContext *aio_context;
4142     BlockJob *bjob = find_block_job(id, &aio_context, errp);
4143     Job *job;
4144
4145     if (!bjob) {
4146         return;
4147     }
4148
4149     trace_qmp_block_job_dismiss(bjob);
4150     job = &bjob->job;
4151     job_dismiss(&job, errp);
4152     aio_context_release(aio_context);
4153 }
4154
4155 void qmp_change_backing_file(const char *device,
4156                              const char *image_node_name,
4157                              const char *backing_file,
4158                              Error **errp)
4159 {
4160     BlockDriverState *bs = NULL;
4161     AioContext *aio_context;
4162     BlockDriverState *image_bs = NULL;
4163     Error *local_err = NULL;
4164     bool ro;
4165     int ret;
4166
4167     bs = qmp_get_root_bs(device, errp);
4168     if (!bs) {
4169         return;
4170     }
4171
4172     aio_context = bdrv_get_aio_context(bs);
4173     aio_context_acquire(aio_context);
4174
4175     image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
4176     if (local_err) {
4177         error_propagate(errp, local_err);
4178         goto out;
4179     }
4180
4181     if (!image_bs) {
4182         error_setg(errp, "image file not found");
4183         goto out;
4184     }
4185
4186     if (bdrv_find_base(image_bs) == image_bs) {
4187         error_setg(errp, "not allowing backing file change on an image "
4188                          "without a backing file");
4189         goto out;
4190     }
4191
4192     /* even though we are not necessarily operating on bs, we need it to
4193      * determine if block ops are currently prohibited on the chain */
4194     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
4195         goto out;
4196     }
4197
4198     /* final sanity check */
4199     if (!bdrv_chain_contains(bs, image_bs)) {
4200         error_setg(errp, "'%s' and image file are not in the same chain",
4201                    device);
4202         goto out;
4203     }
4204
4205     /* if not r/w, reopen to make r/w */
4206     ro = bdrv_is_read_only(image_bs);
4207
4208     if (ro) {
4209         if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
4210             goto out;
4211         }
4212     }
4213
4214     ret = bdrv_change_backing_file(image_bs, backing_file,
4215                                image_bs->drv ? image_bs->drv->format_name : "");
4216
4217     if (ret < 0) {
4218         error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
4219                          backing_file);
4220         /* don't exit here, so we can try to restore open flags if
4221          * appropriate */
4222     }
4223
4224     if (ro) {
4225         bdrv_reopen_set_read_only(image_bs, true, &local_err);
4226         error_propagate(errp, local_err);
4227     }
4228
4229 out:
4230     aio_context_release(aio_context);
4231 }
4232
4233 void hmp_drive_add_node(Monitor *mon, const char *optstr)
4234 {
4235     QemuOpts *opts;
4236     QDict *qdict;
4237     Error *local_err = NULL;
4238
4239     opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
4240     if (!opts) {
4241         return;
4242     }
4243
4244     qdict = qemu_opts_to_qdict(opts, NULL);
4245
4246     if (!qdict_get_try_str(qdict, "node-name")) {
4247         qobject_unref(qdict);
4248         error_report("'node-name' needs to be specified");
4249         goto out;
4250     }
4251
4252     BlockDriverState *bs = bds_tree_init(qdict, &local_err);
4253     if (!bs) {
4254         error_report_err(local_err);
4255         goto out;
4256     }
4257
4258     QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4259
4260 out:
4261     qemu_opts_del(opts);
4262 }
4263
4264 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
4265 {
4266     BlockDriverState *bs;
4267     QObject *obj;
4268     Visitor *v = qobject_output_visitor_new(&obj);
4269     QDict *qdict;
4270     Error *local_err = NULL;
4271
4272     visit_type_BlockdevOptions(v, NULL, &options, &local_err);
4273     if (local_err) {
4274         error_propagate(errp, local_err);
4275         goto fail;
4276     }
4277
4278     visit_complete(v, &obj);
4279     qdict = qobject_to(QDict, obj);
4280
4281     qdict_flatten(qdict);
4282
4283     if (!qdict_get_try_str(qdict, "node-name")) {
4284         error_setg(errp, "'node-name' must be specified for the root node");
4285         goto fail;
4286     }
4287
4288     bs = bds_tree_init(qdict, errp);
4289     if (!bs) {
4290         goto fail;
4291     }
4292
4293     QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
4294
4295 fail:
4296     visit_free(v);
4297 }
4298
4299 void qmp_x_blockdev_reopen(BlockdevOptions *options, Error **errp)
4300 {
4301     BlockDriverState *bs;
4302     AioContext *ctx;
4303     QObject *obj;
4304     Visitor *v = qobject_output_visitor_new(&obj);
4305     Error *local_err = NULL;
4306     BlockReopenQueue *queue;
4307     QDict *qdict;
4308
4309     /* Check for the selected node name */
4310     if (!options->has_node_name) {
4311         error_setg(errp, "Node name not specified");
4312         goto fail;
4313     }
4314
4315     bs = bdrv_find_node(options->node_name);
4316     if (!bs) {
4317         error_setg(errp, "Cannot find node named '%s'", options->node_name);
4318         goto fail;
4319     }
4320
4321     /* Put all options in a QDict and flatten it */
4322     visit_type_BlockdevOptions(v, NULL, &options, &local_err);
4323     if (local_err) {
4324         error_propagate(errp, local_err);
4325         goto fail;
4326     }
4327
4328     visit_complete(v, &obj);
4329     qdict = qobject_to(QDict, obj);
4330
4331     qdict_flatten(qdict);
4332
4333     /* Perform the reopen operation */
4334     ctx = bdrv_get_aio_context(bs);
4335     aio_context_acquire(ctx);
4336     bdrv_subtree_drained_begin(bs);
4337     queue = bdrv_reopen_queue(NULL, bs, qdict, false);
4338     bdrv_reopen_multiple(queue, errp);
4339     bdrv_subtree_drained_end(bs);
4340     aio_context_release(ctx);
4341
4342 fail:
4343     visit_free(v);
4344 }
4345
4346 void qmp_blockdev_del(const char *node_name, Error **errp)
4347 {
4348     AioContext *aio_context;
4349     BlockDriverState *bs;
4350
4351     bs = bdrv_find_node(node_name);
4352     if (!bs) {
4353         error_setg(errp, "Cannot find node %s", node_name);
4354         return;
4355     }
4356     if (bdrv_has_blk(bs)) {
4357         error_setg(errp, "Node %s is in use", node_name);
4358         return;
4359     }
4360     aio_context = bdrv_get_aio_context(bs);
4361     aio_context_acquire(aio_context);
4362
4363     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
4364         goto out;
4365     }
4366
4367     if (!QTAILQ_IN_USE(bs, monitor_list)) {
4368         error_setg(errp, "Node %s is not owned by the monitor",
4369                    bs->node_name);
4370         goto out;
4371     }
4372
4373     if (bs->refcnt > 1) {
4374         error_setg(errp, "Block device %s is in use",
4375                    bdrv_get_device_or_node_name(bs));
4376         goto out;
4377     }
4378
4379     QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4380     bdrv_unref(bs);
4381
4382 out:
4383     aio_context_release(aio_context);
4384 }
4385
4386 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
4387                                   const char *child_name)
4388 {
4389     BdrvChild *child;
4390
4391     QLIST_FOREACH(child, &parent_bs->children, next) {
4392         if (strcmp(child->name, child_name) == 0) {
4393             return child;
4394         }
4395     }
4396
4397     return NULL;
4398 }
4399
4400 void qmp_x_blockdev_change(const char *parent, bool has_child,
4401                            const char *child, bool has_node,
4402                            const char *node, Error **errp)
4403 {
4404     BlockDriverState *parent_bs, *new_bs = NULL;
4405     BdrvChild *p_child;
4406
4407     parent_bs = bdrv_lookup_bs(parent, parent, errp);
4408     if (!parent_bs) {
4409         return;
4410     }
4411
4412     if (has_child == has_node) {
4413         if (has_child) {
4414             error_setg(errp, "The parameters child and node are in conflict");
4415         } else {
4416             error_setg(errp, "Either child or node must be specified");
4417         }
4418         return;
4419     }
4420
4421     if (has_child) {
4422         p_child = bdrv_find_child(parent_bs, child);
4423         if (!p_child) {
4424             error_setg(errp, "Node '%s' does not have child '%s'",
4425                        parent, child);
4426             return;
4427         }
4428         bdrv_del_child(parent_bs, p_child, errp);
4429     }
4430
4431     if (has_node) {
4432         new_bs = bdrv_find_node(node);
4433         if (!new_bs) {
4434             error_setg(errp, "Node '%s' not found", node);
4435             return;
4436         }
4437         bdrv_add_child(parent_bs, new_bs, errp);
4438     }
4439 }
4440
4441 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
4442 {
4443     BlockJobInfoList *head = NULL, **p_next = &head;
4444     BlockJob *job;
4445
4446     for (job = block_job_next(NULL); job; job = block_job_next(job)) {
4447         BlockJobInfoList *elem;
4448         AioContext *aio_context;
4449
4450         if (block_job_is_internal(job)) {
4451             continue;
4452         }
4453         elem = g_new0(BlockJobInfoList, 1);
4454         aio_context = blk_get_aio_context(job->blk);
4455         aio_context_acquire(aio_context);
4456         elem->value = block_job_query(job, errp);
4457         aio_context_release(aio_context);
4458         if (!elem->value) {
4459             g_free(elem);
4460             qapi_free_BlockJobInfoList(head);
4461             return NULL;
4462         }
4463         *p_next = elem;
4464         p_next = &elem->next;
4465     }
4466
4467     return head;
4468 }
4469
4470 void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
4471                                  bool has_force, bool force, Error **errp)
4472 {
4473     AioContext *old_context;
4474     AioContext *new_context;
4475     BlockDriverState *bs;
4476
4477     bs = bdrv_find_node(node_name);
4478     if (!bs) {
4479         error_setg(errp, "Cannot find node %s", node_name);
4480         return;
4481     }
4482
4483     /* Protects against accidents. */
4484     if (!(has_force && force) && bdrv_has_blk(bs)) {
4485         error_setg(errp, "Node %s is associated with a BlockBackend and could "
4486                          "be in use (use force=true to override this check)",
4487                          node_name);
4488         return;
4489     }
4490
4491     if (iothread->type == QTYPE_QSTRING) {
4492         IOThread *obj = iothread_by_id(iothread->u.s);
4493         if (!obj) {
4494             error_setg(errp, "Cannot find iothread %s", iothread->u.s);
4495             return;
4496         }
4497
4498         new_context = iothread_get_aio_context(obj);
4499     } else {
4500         new_context = qemu_get_aio_context();
4501     }
4502
4503     old_context = bdrv_get_aio_context(bs);
4504     aio_context_acquire(old_context);
4505
4506     bdrv_try_set_aio_context(bs, new_context, errp);
4507
4508     aio_context_release(old_context);
4509 }
4510
4511 void qmp_block_latency_histogram_set(
4512     const char *id,
4513     bool has_boundaries, uint64List *boundaries,
4514     bool has_boundaries_read, uint64List *boundaries_read,
4515     bool has_boundaries_write, uint64List *boundaries_write,
4516     bool has_boundaries_flush, uint64List *boundaries_flush,
4517     Error **errp)
4518 {
4519     BlockBackend *blk = qmp_get_blk(NULL, id, errp);
4520     BlockAcctStats *stats;
4521     int ret;
4522
4523     if (!blk) {
4524         return;
4525     }
4526
4527     stats = blk_get_stats(blk);
4528
4529     if (!has_boundaries && !has_boundaries_read && !has_boundaries_write &&
4530         !has_boundaries_flush)
4531     {
4532         block_latency_histograms_clear(stats);
4533         return;
4534     }
4535
4536     if (has_boundaries || has_boundaries_read) {
4537         ret = block_latency_histogram_set(
4538             stats, BLOCK_ACCT_READ,
4539             has_boundaries_read ? boundaries_read : boundaries);
4540         if (ret) {
4541             error_setg(errp, "Device '%s' set read boundaries fail", id);
4542             return;
4543         }
4544     }
4545
4546     if (has_boundaries || has_boundaries_write) {
4547         ret = block_latency_histogram_set(
4548             stats, BLOCK_ACCT_WRITE,
4549             has_boundaries_write ? boundaries_write : boundaries);
4550         if (ret) {
4551             error_setg(errp, "Device '%s' set write boundaries fail", id);
4552             return;
4553         }
4554     }
4555
4556     if (has_boundaries || has_boundaries_flush) {
4557         ret = block_latency_histogram_set(
4558             stats, BLOCK_ACCT_FLUSH,
4559             has_boundaries_flush ? boundaries_flush : boundaries);
4560         if (ret) {
4561             error_setg(errp, "Device '%s' set flush boundaries fail", id);
4562             return;
4563         }
4564     }
4565 }
4566
4567 QemuOptsList qemu_common_drive_opts = {
4568     .name = "drive",
4569     .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4570     .desc = {
4571         {
4572             .name = "snapshot",
4573             .type = QEMU_OPT_BOOL,
4574             .help = "enable/disable snapshot mode",
4575         },{
4576             .name = "aio",
4577             .type = QEMU_OPT_STRING,
4578             .help = "host AIO implementation (threads, native)",
4579         },{
4580             .name = BDRV_OPT_CACHE_WB,
4581             .type = QEMU_OPT_BOOL,
4582             .help = "Enable writeback mode",
4583         },{
4584             .name = "format",
4585             .type = QEMU_OPT_STRING,
4586             .help = "disk format (raw, qcow2, ...)",
4587         },{
4588             .name = "rerror",
4589             .type = QEMU_OPT_STRING,
4590             .help = "read error action",
4591         },{
4592             .name = "werror",
4593             .type = QEMU_OPT_STRING,
4594             .help = "write error action",
4595         },{
4596             .name = BDRV_OPT_READ_ONLY,
4597             .type = QEMU_OPT_BOOL,
4598             .help = "open drive file as read-only",
4599         },
4600
4601         THROTTLE_OPTS,
4602
4603         {
4604             .name = "throttling.group",
4605             .type = QEMU_OPT_STRING,
4606             .help = "name of the block throttling group",
4607         },{
4608             .name = "copy-on-read",
4609             .type = QEMU_OPT_BOOL,
4610             .help = "copy read data from backing file into image file",
4611         },{
4612             .name = "detect-zeroes",
4613             .type = QEMU_OPT_STRING,
4614             .help = "try to optimize zero writes (off, on, unmap)",
4615         },{
4616             .name = "stats-account-invalid",
4617             .type = QEMU_OPT_BOOL,
4618             .help = "whether to account for invalid I/O operations "
4619                     "in the statistics",
4620         },{
4621             .name = "stats-account-failed",
4622             .type = QEMU_OPT_BOOL,
4623             .help = "whether to account for failed I/O operations "
4624                     "in the statistics",
4625         },
4626         { /* end of list */ }
4627     },
4628 };
4629
4630 QemuOptsList qemu_drive_opts = {
4631     .name = "drive",
4632     .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
4633     .desc = {
4634         /*
4635          * no elements => accept any params
4636          * validation will happen later
4637          */
4638         { /* end of list */ }
4639     },
4640 };