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 "sysemu/block-backend.h"
  34 #include "sysemu/blockdev.h"
  35 #include "hw/block/block.h"
  36 #include "block/blockjob.h"
  37 #include "block/throttle-groups.h"
  38 #include "monitor/monitor.h"
  39 #include "qemu/error-report.h"
  40 #include "qemu/option.h"
  41 #include "qemu/config-file.h"
  42 #include "qapi/qmp/types.h"
  43 #include "qapi-visit.h"
  44 #include "qapi/qmp/qerror.h"
  45 #include "qapi/qmp-output-visitor.h"
  46 #include "qapi/util.h"
  47 #include "sysemu/sysemu.h"
  48 #include "block/block_int.h"
  49 #include "qmp-commands.h"
  50 #include "trace.h"
  51 #include "sysemu/arch_init.h"
  52
  53 static const char *const if_name[IF_COUNT] = {
  54     [IF_NONE] = "none",
  55     [IF_IDE] = "ide",
  56     [IF_SCSI] = "scsi",
  57     [IF_FLOPPY] = "floppy",
  58     [IF_PFLASH] = "pflash",
  59     [IF_MTD] = "mtd",
  60     [IF_SD] = "sd",
  61     [IF_VIRTIO] = "virtio",
  62     [IF_XEN] = "xen",
  63 };
  64
  65 static int if_max_devs[IF_COUNT] = {
  66     /*
  67      * Do not change these numbers!  They govern how drive option
  68      * index maps to unit and bus.  That mapping is ABI.
  69      *
  70      * All controllers used to imlement if=T drives need to support
  71      * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
  72      * Otherwise, some index values map to "impossible" bus, unit
  73      * values.
  74      *
  75      * For instance, if you change [IF_SCSI] to 255, -drive
  76      * if=scsi,index=12 no longer means bus=1,unit=5, but
  77      * bus=0,unit=12.  With an lsi53c895a controller (7 units max),
  78      * the drive can't be set up.  Regression.
  79      */
  80     [IF_IDE] = 2,
  81     [IF_SCSI] = 7,
  82 };
  83
  84 /**
  85  * Boards may call this to offer board-by-board overrides
  86  * of the default, global values.
  87  */
  88 void override_max_devs(BlockInterfaceType type, int max_devs)
  89 {
  90     BlockBackend *blk;
  91     DriveInfo *dinfo;
  92
  93     if (max_devs <= 0) {
  94         return;
  95     }
  96
  97     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
  98         dinfo = blk_legacy_dinfo(blk);
  99         if (dinfo->type == type) {
 100             fprintf(stderr, "Cannot override units-per-bus property of"
 101                     " the %s interface, because a drive of that type has"
 102                     " already been added.\n", if_name[type]);
 103             g_assert_not_reached();
 104         }
 105     }
 106
 107     if_max_devs[type] = max_devs;
 108 }
 109
 110 /*
 111  * We automatically delete the drive when a device using it gets
 112  * unplugged.  Questionable feature, but we can't just drop it.
 113  * Device models call blockdev_mark_auto_del() to schedule the
 114  * automatic deletion, and generic qdev code calls blockdev_auto_del()
 115  * when deletion is actually safe.
 116  */
 117 void blockdev_mark_auto_del(BlockBackend *blk)
 118 {
 119     DriveInfo *dinfo = blk_legacy_dinfo(blk);
 120     BlockDriverState *bs = blk_bs(blk);
 121     AioContext *aio_context;
 122
 123     if (!dinfo) {
 124         return;
 125     }
 126
 127     if (bs) {
 128         aio_context = bdrv_get_aio_context(bs);
 129         aio_context_acquire(aio_context);
 130
 131         if (bs->job) {
 132             block_job_cancel(bs->job);
 133         }
 134
 135         aio_context_release(aio_context);
 136     }
 137
 138     dinfo->auto_del = 1;
 139 }
 140
 141 void blockdev_auto_del(BlockBackend *blk)
 142 {
 143     DriveInfo *dinfo = blk_legacy_dinfo(blk);
 144
 145     if (dinfo && dinfo->auto_del) {
 146         blk_unref(blk);
 147     }
 148 }
 149
 150 /**
 151  * Returns the current mapping of how many units per bus
 152  * a particular interface can support.
 153  *
 154  *  A positive integer indicates n units per bus.
 155  *  0 implies the mapping has not been established.
 156  * -1 indicates an invalid BlockInterfaceType was given.
 157  */
 158 int drive_get_max_devs(BlockInterfaceType type)
 159 {
 160     if (type >= IF_IDE && type < IF_COUNT) {
 161         return if_max_devs[type];
 162     }
 163
 164     return -1;
 165 }
 166
 167 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
 168 {
 169     int max_devs = if_max_devs[type];
 170     return max_devs ? index / max_devs : 0;
 171 }
 172
 173 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
 174 {
 175     int max_devs = if_max_devs[type];
 176     return max_devs ? index % max_devs : index;
 177 }
 178
 179 QemuOpts *drive_def(const char *optstr)
 180 {
 181     return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
 182 }
 183
 184 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
 185                     const char *optstr)
 186 {
 187     QemuOpts *opts;
 188
 189     opts = drive_def(optstr);
 190     if (!opts) {
 191         return NULL;
 192     }
 193     if (type != IF_DEFAULT) {
 194         qemu_opt_set(opts, "if", if_name[type], &error_abort);
 195     }
 196     if (index >= 0) {
 197         qemu_opt_set_number(opts, "index", index, &error_abort);
 198     }
 199     if (file)
 200         qemu_opt_set(opts, "file", file, &error_abort);
 201     return opts;
 202 }
 203
 204 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
 205 {
 206     BlockBackend *blk;
 207     DriveInfo *dinfo;
 208
 209     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 210         dinfo = blk_legacy_dinfo(blk);
 211         if (dinfo && dinfo->type == type
 212             && dinfo->bus == bus && dinfo->unit == unit) {
 213             return dinfo;
 214         }
 215     }
 216
 217     return NULL;
 218 }
 219
 220 bool drive_check_orphaned(void)
 221 {
 222     BlockBackend *blk;
 223     DriveInfo *dinfo;
 224     bool rs = false;
 225
 226     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 227         dinfo = blk_legacy_dinfo(blk);
 228         /* If dinfo->bdrv->dev is NULL, it has no device attached. */
 229         /* Unless this is a default drive, this may be an oversight. */
 230         if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
 231             dinfo->type != IF_NONE) {
 232             fprintf(stderr, "Warning: Orphaned drive without device: "
 233                     "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
 234                     blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
 235                     if_name[dinfo->type], dinfo->bus, dinfo->unit);
 236             rs = true;
 237         }
 238     }
 239
 240     return rs;
 241 }
 242
 243 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
 244 {
 245     return drive_get(type,
 246                      drive_index_to_bus_id(type, index),
 247                      drive_index_to_unit_id(type, index));
 248 }
 249
 250 int drive_get_max_bus(BlockInterfaceType type)
 251 {
 252     int max_bus;
 253     BlockBackend *blk;
 254     DriveInfo *dinfo;
 255
 256     max_bus = -1;
 257     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 258         dinfo = blk_legacy_dinfo(blk);
 259         if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
 260             max_bus = dinfo->bus;
 261         }
 262     }
 263     return max_bus;
 264 }
 265
 266 /* Get a block device.  This should only be used for single-drive devices
 267    (e.g. SD/Floppy/MTD).  Multi-disk devices (scsi/ide) should use the
 268    appropriate bus.  */
 269 DriveInfo *drive_get_next(BlockInterfaceType type)
 270 {
 271     static int next_block_unit[IF_COUNT];
 272
 273     return drive_get(type, 0, next_block_unit[type]++);
 274 }
 275
 276 static void bdrv_format_print(void *opaque, const char *name)
 277 {
 278     error_printf(" %s", name);
 279 }
 280
 281 typedef struct {
 282     QEMUBH *bh;
 283     BlockDriverState *bs;
 284 } BDRVPutRefBH;
 285
 286 static void bdrv_put_ref_bh(void *opaque)
 287 {
 288     BDRVPutRefBH *s = opaque;
 289
 290     bdrv_unref(s->bs);
 291     qemu_bh_delete(s->bh);
 292     g_free(s);
 293 }
 294
 295 /*
 296  * Release a BDS reference in a BH
 297  *
 298  * It is not safe to use bdrv_unref() from a callback function when the callers
 299  * still need the BlockDriverState.  In such cases we schedule a BH to release
 300  * the reference.
 301  */
 302 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
 303 {
 304     BDRVPutRefBH *s;
 305
 306     s = g_new(BDRVPutRefBH, 1);
 307     s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
 308     s->bs = bs;
 309     qemu_bh_schedule(s->bh);
 310 }
 311
 312 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
 313 {
 314     if (!strcmp(buf, "ignore")) {
 315         return BLOCKDEV_ON_ERROR_IGNORE;
 316     } else if (!is_read && !strcmp(buf, "enospc")) {
 317         return BLOCKDEV_ON_ERROR_ENOSPC;
 318     } else if (!strcmp(buf, "stop")) {
 319         return BLOCKDEV_ON_ERROR_STOP;
 320     } else if (!strcmp(buf, "report")) {
 321         return BLOCKDEV_ON_ERROR_REPORT;
 322     } else {
 323         error_setg(errp, "'%s' invalid %s error action",
 324                    buf, is_read ? "read" : "write");
 325         return -1;
 326     }
 327 }
 328
 329 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
 330 {
 331     if (throttle_conflicting(cfg)) {
 332         error_setg(errp, "bps/iops/max total values and read/write values"
 333                          " cannot be used at the same time");
 334         return false;
 335     }
 336
 337     if (!throttle_is_valid(cfg)) {
 338         error_setg(errp, "bps/iops/maxs values must be 0 or greater");
 339         return false;
 340     }
 341
 342     if (throttle_max_is_missing_limit(cfg)) {
 343         error_setg(errp, "bps_max/iops_max require corresponding"
 344                          " bps/iops values");
 345         return false;
 346     }
 347
 348     return true;
 349 }
 350
 351 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
 352
 353 /* All parameters but @opts are optional and may be set to NULL. */
 354 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
 355     const char **throttling_group, ThrottleConfig *throttle_cfg,
 356     BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
 357 {
 358     const char *discard;
 359     Error *local_error = NULL;
 360     const char *aio;
 361
 362     if (bdrv_flags) {
 363         if (!qemu_opt_get_bool(opts, "read-only", false)) {
 364             *bdrv_flags |= BDRV_O_RDWR;
 365         }
 366         if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
 367             *bdrv_flags |= BDRV_O_COPY_ON_READ;
 368         }
 369
 370         if ((discard = qemu_opt_get(opts, "discard")) != NULL) {
 371             if (bdrv_parse_discard_flags(discard, bdrv_flags) != 0) {
 372                 error_setg(errp, "Invalid discard option");
 373                 return;
 374             }
 375         }
 376
 377         if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true)) {
 378             *bdrv_flags |= BDRV_O_CACHE_WB;
 379         }
 380         if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) {
 381             *bdrv_flags |= BDRV_O_NOCACHE;
 382         }
 383         if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) {
 384             *bdrv_flags |= BDRV_O_NO_FLUSH;
 385         }
 386
 387         if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
 388             if (!strcmp(aio, "native")) {
 389                 *bdrv_flags |= BDRV_O_NATIVE_AIO;
 390             } else if (!strcmp(aio, "threads")) {
 391                 /* this is the default */
 392             } else {
 393                error_setg(errp, "invalid aio option");
 394                return;
 395             }
 396         }
 397     }
 398
 399     /* disk I/O throttling */
 400     if (throttling_group) {
 401         *throttling_group = qemu_opt_get(opts, "throttling.group");
 402     }
 403
 404     if (throttle_cfg) {
 405         memset(throttle_cfg, 0, sizeof(*throttle_cfg));
 406         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
 407             qemu_opt_get_number(opts, "throttling.bps-total", 0);
 408         throttle_cfg->buckets[THROTTLE_BPS_READ].avg  =
 409             qemu_opt_get_number(opts, "throttling.bps-read", 0);
 410         throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
 411             qemu_opt_get_number(opts, "throttling.bps-write", 0);
 412         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
 413             qemu_opt_get_number(opts, "throttling.iops-total", 0);
 414         throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
 415             qemu_opt_get_number(opts, "throttling.iops-read", 0);
 416         throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
 417             qemu_opt_get_number(opts, "throttling.iops-write", 0);
 418
 419         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
 420             qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
 421         throttle_cfg->buckets[THROTTLE_BPS_READ].max  =
 422             qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
 423         throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
 424             qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
 425         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
 426             qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
 427         throttle_cfg->buckets[THROTTLE_OPS_READ].max =
 428             qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
 429         throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
 430             qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
 431
 432         throttle_cfg->op_size =
 433             qemu_opt_get_number(opts, "throttling.iops-size", 0);
 434
 435         if (!check_throttle_config(throttle_cfg, errp)) {
 436             return;
 437         }
 438     }
 439
 440     if (detect_zeroes) {
 441         *detect_zeroes =
 442             qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
 443                             qemu_opt_get(opts, "detect-zeroes"),
 444                             BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
 445                             BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
 446                             &local_error);
 447         if (local_error) {
 448             error_propagate(errp, local_error);
 449             return;
 450         }
 451
 452         if (bdrv_flags &&
 453             *detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
 454             !(*bdrv_flags & BDRV_O_UNMAP))
 455         {
 456             error_setg(errp, "setting detect-zeroes to unmap is not allowed "
 457                              "without setting discard operation to unmap");
 458             return;
 459         }
 460     }
 461 }
 462
 463 /* Takes the ownership of bs_opts */
 464 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
 465                                    Error **errp)
 466 {
 467     const char *buf;
 468     int bdrv_flags = 0;
 469     int on_read_error, on_write_error;
 470     BlockBackend *blk;
 471     BlockDriverState *bs;
 472     ThrottleConfig cfg;
 473     int snapshot = 0;
 474     Error *error = NULL;
 475     QemuOpts *opts;
 476     const char *id;
 477     bool has_driver_specific_opts;
 478     BlockdevDetectZeroesOptions detect_zeroes =
 479         BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
 480     const char *throttling_group = NULL;
 481
 482     /* Check common options by copying from bs_opts to opts, all other options
 483      * stay in bs_opts for processing by bdrv_open(). */
 484     id = qdict_get_try_str(bs_opts, "id");
 485     opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
 486     if (error) {
 487         error_propagate(errp, error);
 488         goto err_no_opts;
 489     }
 490
 491     qemu_opts_absorb_qdict(opts, bs_opts, &error);
 492     if (error) {
 493         error_propagate(errp, error);
 494         goto early_err;
 495     }
 496
 497     if (id) {
 498         qdict_del(bs_opts, "id");
 499     }
 500
 501     has_driver_specific_opts = !!qdict_size(bs_opts);
 502
 503     /* extract parameters */
 504     snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
 505
 506     extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
 507                                     &detect_zeroes, &error);
 508     if (error) {
 509         error_propagate(errp, error);
 510         goto early_err;
 511     }
 512
 513     if ((buf = qemu_opt_get(opts, "format")) != NULL) {
 514         if (is_help_option(buf)) {
 515             error_printf("Supported formats:");
 516             bdrv_iterate_format(bdrv_format_print, NULL);
 517             error_printf("\n");
 518             goto early_err;
 519         }
 520
 521         if (qdict_haskey(bs_opts, "driver")) {
 522             error_setg(errp, "Cannot specify both 'driver' and 'format'");
 523             goto early_err;
 524         }
 525         qdict_put(bs_opts, "driver", qstring_from_str(buf));
 526     }
 527
 528     on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
 529     if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
 530         on_write_error = parse_block_error_action(buf, 0, &error);
 531         if (error) {
 532             error_propagate(errp, error);
 533             goto early_err;
 534         }
 535     }
 536
 537     on_read_error = BLOCKDEV_ON_ERROR_REPORT;
 538     if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
 539         on_read_error = parse_block_error_action(buf, 1, &error);
 540         if (error) {
 541             error_propagate(errp, error);
 542             goto early_err;
 543         }
 544     }
 545
 546     if (snapshot) {
 547         /* always use cache=unsafe with snapshot */
 548         bdrv_flags &= ~BDRV_O_CACHE_MASK;
 549         bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
 550     }
 551
 552     /* init */
 553     if ((!file || !*file) && !has_driver_specific_opts) {
 554         BlockBackendRootState *blk_rs;
 555
 556         blk = blk_new(qemu_opts_id(opts), errp);
 557         if (!blk) {
 558             goto early_err;
 559         }
 560
 561         blk_rs = blk_get_root_state(blk);
 562         blk_rs->open_flags    = bdrv_flags;
 563         blk_rs->read_only     = !(bdrv_flags & BDRV_O_RDWR);
 564         blk_rs->detect_zeroes = detect_zeroes;
 565
 566         if (throttle_enabled(&cfg)) {
 567             if (!throttling_group) {
 568                 throttling_group = blk_name(blk);
 569             }
 570             blk_rs->throttle_group = g_strdup(throttling_group);
 571             blk_rs->throttle_state = throttle_group_incref(throttling_group);
 572             blk_rs->throttle_state->cfg = cfg;
 573         }
 574
 575         QDECREF(bs_opts);
 576     } else {
 577         if (file && !*file) {
 578             file = NULL;
 579         }
 580
 581         blk = blk_new_open(qemu_opts_id(opts), file, NULL, bs_opts, bdrv_flags,
 582                            errp);
 583         if (!blk) {
 584             goto err_no_bs_opts;
 585         }
 586         bs = blk_bs(blk);
 587
 588         bs->detect_zeroes = detect_zeroes;
 589
 590         /* disk I/O throttling */
 591         if (throttle_enabled(&cfg)) {
 592             if (!throttling_group) {
 593                 throttling_group = blk_name(blk);
 594             }
 595             bdrv_io_limits_enable(bs, throttling_group);
 596             bdrv_set_io_limits(bs, &cfg);
 597         }
 598
 599         if (bdrv_key_required(bs)) {
 600             autostart = 0;
 601         }
 602     }
 603
 604     blk_set_on_error(blk, on_read_error, on_write_error);
 605
 606 err_no_bs_opts:
 607     qemu_opts_del(opts);
 608     return blk;
 609
 610 early_err:
 611     qemu_opts_del(opts);
 612 err_no_opts:
 613     QDECREF(bs_opts);
 614     return NULL;
 615 }
 616
 617 static QemuOptsList qemu_root_bds_opts;
 618
 619 /* Takes the ownership of bs_opts */
 620 static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
 621 {
 622     BlockDriverState *bs;
 623     QemuOpts *opts;
 624     Error *local_error = NULL;
 625     BlockdevDetectZeroesOptions detect_zeroes;
 626     int ret;
 627     int bdrv_flags = 0;
 628
 629     opts = qemu_opts_create(&qemu_root_bds_opts, NULL, 1, errp);
 630     if (!opts) {
 631         goto fail;
 632     }
 633
 634     qemu_opts_absorb_qdict(opts, bs_opts, &local_error);
 635     if (local_error) {
 636         error_propagate(errp, local_error);
 637         goto fail;
 638     }
 639
 640     extract_common_blockdev_options(opts, &bdrv_flags, NULL, NULL,
 641                                     &detect_zeroes, &local_error);
 642     if (local_error) {
 643         error_propagate(errp, local_error);
 644         goto fail;
 645     }
 646
 647     bs = NULL;
 648     ret = bdrv_open(&bs, NULL, NULL, bs_opts, bdrv_flags, errp);
 649     if (ret < 0) {
 650         goto fail_no_bs_opts;
 651     }
 652
 653     bs->detect_zeroes = detect_zeroes;
 654
 655 fail_no_bs_opts:
 656     qemu_opts_del(opts);
 657     return bs;
 658
 659 fail:
 660     qemu_opts_del(opts);
 661     QDECREF(bs_opts);
 662     return NULL;
 663 }
 664
 665 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
 666                             Error **errp)
 667 {
 668     const char *value;
 669
 670     value = qemu_opt_get(opts, from);
 671     if (value) {
 672         if (qemu_opt_find(opts, to)) {
 673             error_setg(errp, "'%s' and its alias '%s' can't be used at the "
 674                        "same time", to, from);
 675             return;
 676         }
 677     }
 678
 679     /* rename all items in opts */
 680     while ((value = qemu_opt_get(opts, from))) {
 681         qemu_opt_set(opts, to, value, &error_abort);
 682         qemu_opt_unset(opts, from);
 683     }
 684 }
 685
 686 QemuOptsList qemu_legacy_drive_opts = {
 687     .name = "drive",
 688     .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
 689     .desc = {
 690         {
 691             .name = "bus",
 692             .type = QEMU_OPT_NUMBER,
 693             .help = "bus number",
 694         },{
 695             .name = "unit",
 696             .type = QEMU_OPT_NUMBER,
 697             .help = "unit number (i.e. lun for scsi)",
 698         },{
 699             .name = "index",
 700             .type = QEMU_OPT_NUMBER,
 701             .help = "index number",
 702         },{
 703             .name = "media",
 704             .type = QEMU_OPT_STRING,
 705             .help = "media type (disk, cdrom)",
 706         },{
 707             .name = "if",
 708             .type = QEMU_OPT_STRING,
 709             .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
 710         },{
 711             .name = "cyls",
 712             .type = QEMU_OPT_NUMBER,
 713             .help = "number of cylinders (ide disk geometry)",
 714         },{
 715             .name = "heads",
 716             .type = QEMU_OPT_NUMBER,
 717             .help = "number of heads (ide disk geometry)",
 718         },{
 719             .name = "secs",
 720             .type = QEMU_OPT_NUMBER,
 721             .help = "number of sectors (ide disk geometry)",
 722         },{
 723             .name = "trans",
 724             .type = QEMU_OPT_STRING,
 725             .help = "chs translation (auto, lba, none)",
 726         },{
 727             .name = "boot",
 728             .type = QEMU_OPT_BOOL,
 729             .help = "(deprecated, ignored)",
 730         },{
 731             .name = "addr",
 732             .type = QEMU_OPT_STRING,
 733             .help = "pci address (virtio only)",
 734         },{
 735             .name = "serial",
 736             .type = QEMU_OPT_STRING,
 737             .help = "disk serial number",
 738         },{
 739             .name = "file",
 740             .type = QEMU_OPT_STRING,
 741             .help = "file name",
 742         },
 743
 744         /* Options that are passed on, but have special semantics with -drive */
 745         {
 746             .name = "read-only",
 747             .type = QEMU_OPT_BOOL,
 748             .help = "open drive file as read-only",
 749         },{
 750             .name = "rerror",
 751             .type = QEMU_OPT_STRING,
 752             .help = "read error action",
 753         },{
 754             .name = "werror",
 755             .type = QEMU_OPT_STRING,
 756             .help = "write error action",
 757         },{
 758             .name = "copy-on-read",
 759             .type = QEMU_OPT_BOOL,
 760             .help = "copy read data from backing file into image file",
 761         },
 762
 763         { /* end of list */ }
 764     },
 765 };
 766
 767 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
 768 {
 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 cyls, heads, secs, translation;
 777     int max_devs, bus_id, unit_id, index;
 778     const char *devaddr;
 779     const char *werror, *rerror;
 780     bool read_only = false;
 781     bool copy_on_read;
 782     const char *serial;
 783     const char *filename;
 784     Error *local_err = NULL;
 785     int i;
 786
 787     /* Change legacy command line options into QMP ones */
 788     static const struct {
 789         const char *from;
 790         const char *to;
 791     } opt_renames[] = {
 792         { "iops",           "throttling.iops-total" },
 793         { "iops_rd",        "throttling.iops-read" },
 794         { "iops_wr",        "throttling.iops-write" },
 795
 796         { "bps",            "throttling.bps-total" },
 797         { "bps_rd",         "throttling.bps-read" },
 798         { "bps_wr",         "throttling.bps-write" },
 799
 800         { "iops_max",       "throttling.iops-total-max" },
 801         { "iops_rd_max",    "throttling.iops-read-max" },
 802         { "iops_wr_max",    "throttling.iops-write-max" },
 803
 804         { "bps_max",        "throttling.bps-total-max" },
 805         { "bps_rd_max",     "throttling.bps-read-max" },
 806         { "bps_wr_max",     "throttling.bps-write-max" },
 807
 808         { "iops_size",      "throttling.iops-size" },
 809
 810         { "group",          "throttling.group" },
 811
 812         { "readonly",       "read-only" },
 813     };
 814
 815     for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
 816         qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
 817                         &local_err);
 818         if (local_err) {
 819             error_report_err(local_err);
 820             return NULL;
 821         }
 822     }
 823
 824     value = qemu_opt_get(all_opts, "cache");
 825     if (value) {
 826         int flags = 0;
 827
 828         if (bdrv_parse_cache_flags(value, &flags) != 0) {
 829             error_report("invalid cache option");
 830             return NULL;
 831         }
 832
 833         /* Specific options take precedence */
 834         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
 835             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
 836                               !!(flags & BDRV_O_CACHE_WB), &error_abort);
 837         }
 838         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
 839             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
 840                               !!(flags & BDRV_O_NOCACHE), &error_abort);
 841         }
 842         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
 843             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
 844                               !!(flags & BDRV_O_NO_FLUSH), &error_abort);
 845         }
 846         qemu_opt_unset(all_opts, "cache");
 847     }
 848
 849     /* Get a QDict for processing the options */
 850     bs_opts = qdict_new();
 851     qemu_opts_to_qdict(all_opts, bs_opts);
 852
 853     legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
 854                                    &error_abort);
 855     qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
 856     if (local_err) {
 857         error_report_err(local_err);
 858         goto fail;
 859     }
 860
 861     /* Deprecated option boot=[on|off] */
 862     if (qemu_opt_get(legacy_opts, "boot") != NULL) {
 863         fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
 864                 "ignored. Future versions will reject this parameter. Please "
 865                 "update your scripts.\n");
 866     }
 867
 868     /* Media type */
 869     value = qemu_opt_get(legacy_opts, "media");
 870     if (value) {
 871         if (!strcmp(value, "disk")) {
 872             media = MEDIA_DISK;
 873         } else if (!strcmp(value, "cdrom")) {
 874             media = MEDIA_CDROM;
 875             read_only = true;
 876         } else {
 877             error_report("'%s' invalid media", value);
 878             goto fail;
 879         }
 880     }
 881
 882     /* copy-on-read is disabled with a warning for read-only devices */
 883     read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
 884     copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
 885
 886     if (read_only && copy_on_read) {
 887         error_report("warning: disabling copy-on-read on read-only drive");
 888         copy_on_read = false;
 889     }
 890
 891     qdict_put(bs_opts, "read-only",
 892               qstring_from_str(read_only ? "on" : "off"));
 893     qdict_put(bs_opts, "copy-on-read",
 894               qstring_from_str(copy_on_read ? "on" :"off"));
 895
 896     /* Controller type */
 897     value = qemu_opt_get(legacy_opts, "if");
 898     if (value) {
 899         for (type = 0;
 900              type < IF_COUNT && strcmp(value, if_name[type]);
 901              type++) {
 902         }
 903         if (type == IF_COUNT) {
 904             error_report("unsupported bus type '%s'", value);
 905             goto fail;
 906         }
 907     } else {
 908         type = block_default_type;
 909     }
 910
 911     /* Geometry */
 912     cyls  = qemu_opt_get_number(legacy_opts, "cyls", 0);
 913     heads = qemu_opt_get_number(legacy_opts, "heads", 0);
 914     secs  = qemu_opt_get_number(legacy_opts, "secs", 0);
 915
 916     if (cyls || heads || secs) {
 917         if (cyls < 1) {
 918             error_report("invalid physical cyls number");
 919             goto fail;
 920         }
 921         if (heads < 1) {
 922             error_report("invalid physical heads number");
 923             goto fail;
 924         }
 925         if (secs < 1) {
 926             error_report("invalid physical secs number");
 927             goto fail;
 928         }
 929     }
 930
 931     translation = BIOS_ATA_TRANSLATION_AUTO;
 932     value = qemu_opt_get(legacy_opts, "trans");
 933     if (value != NULL) {
 934         if (!cyls) {
 935             error_report("'%s' trans must be used with cyls, heads and secs",
 936                          value);
 937             goto fail;
 938         }
 939         if (!strcmp(value, "none")) {
 940             translation = BIOS_ATA_TRANSLATION_NONE;
 941         } else if (!strcmp(value, "lba")) {
 942             translation = BIOS_ATA_TRANSLATION_LBA;
 943         } else if (!strcmp(value, "large")) {
 944             translation = BIOS_ATA_TRANSLATION_LARGE;
 945         } else if (!strcmp(value, "rechs")) {
 946             translation = BIOS_ATA_TRANSLATION_RECHS;
 947         } else if (!strcmp(value, "auto")) {
 948             translation = BIOS_ATA_TRANSLATION_AUTO;
 949         } else {
 950             error_report("'%s' invalid translation type", value);
 951             goto fail;
 952         }
 953     }
 954
 955     if (media == MEDIA_CDROM) {
 956         if (cyls || secs || heads) {
 957             error_report("CHS can't be set with media=cdrom");
 958             goto fail;
 959         }
 960     }
 961
 962     /* Device address specified by bus/unit or index.
 963      * If none was specified, try to find the first free one. */
 964     bus_id  = qemu_opt_get_number(legacy_opts, "bus", 0);
 965     unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
 966     index   = qemu_opt_get_number(legacy_opts, "index", -1);
 967
 968     max_devs = if_max_devs[type];
 969
 970     if (index != -1) {
 971         if (bus_id != 0 || unit_id != -1) {
 972             error_report("index cannot be used with bus and unit");
 973             goto fail;
 974         }
 975         bus_id = drive_index_to_bus_id(type, index);
 976         unit_id = drive_index_to_unit_id(type, index);
 977     }
 978
 979     if (unit_id == -1) {
 980        unit_id = 0;
 981        while (drive_get(type, bus_id, unit_id) != NULL) {
 982            unit_id++;
 983            if (max_devs && unit_id >= max_devs) {
 984                unit_id -= max_devs;
 985                bus_id++;
 986            }
 987        }
 988     }
 989
 990     if (max_devs && unit_id >= max_devs) {
 991         error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
 992         goto fail;
 993     }
 994
 995     if (drive_get(type, bus_id, unit_id) != NULL) {
 996         error_report("drive with bus=%d, unit=%d (index=%d) exists",
 997                      bus_id, unit_id, index);
 998         goto fail;
 999     }
1000
1001     /* Serial number */
1002     serial = qemu_opt_get(legacy_opts, "serial");
1003
1004     /* no id supplied -> create one */
1005     if (qemu_opts_id(all_opts) == NULL) {
1006         char *new_id;
1007         const char *mediastr = "";
1008         if (type == IF_IDE || type == IF_SCSI) {
1009             mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
1010         }
1011         if (max_devs) {
1012             new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
1013                                      mediastr, unit_id);
1014         } else {
1015             new_id = g_strdup_printf("%s%s%i", if_name[type],
1016                                      mediastr, unit_id);
1017         }
1018         qdict_put(bs_opts, "id", qstring_from_str(new_id));
1019         g_free(new_id);
1020     }
1021
1022     /* Add virtio block device */
1023     devaddr = qemu_opt_get(legacy_opts, "addr");
1024     if (devaddr && type != IF_VIRTIO) {
1025         error_report("addr is not supported by this bus type");
1026         goto fail;
1027     }
1028
1029     if (type == IF_VIRTIO) {
1030         QemuOpts *devopts;
1031         devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
1032                                    &error_abort);
1033         if (arch_type == QEMU_ARCH_S390X) {
1034             qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1035         } else {
1036             qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1037         }
1038         qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
1039                      &error_abort);
1040         if (devaddr) {
1041             qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1042         }
1043     }
1044
1045     filename = qemu_opt_get(legacy_opts, "file");
1046
1047     /* Check werror/rerror compatibility with if=... */
1048     werror = qemu_opt_get(legacy_opts, "werror");
1049     if (werror != NULL) {
1050         if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
1051             type != IF_NONE) {
1052             error_report("werror is not supported by this bus type");
1053             goto fail;
1054         }
1055         qdict_put(bs_opts, "werror", qstring_from_str(werror));
1056     }
1057
1058     rerror = qemu_opt_get(legacy_opts, "rerror");
1059     if (rerror != NULL) {
1060         if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
1061             type != IF_NONE) {
1062             error_report("rerror is not supported by this bus type");
1063             goto fail;
1064         }
1065         qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
1066     }
1067
1068     /* Actual block device init: Functionality shared with blockdev-add */
1069     blk = blockdev_init(filename, bs_opts, &local_err);
1070     bs_opts = NULL;
1071     if (!blk) {
1072         if (local_err) {
1073             error_report_err(local_err);
1074         }
1075         goto fail;
1076     } else {
1077         assert(!local_err);
1078     }
1079
1080     /* Create legacy DriveInfo */
1081     dinfo = g_malloc0(sizeof(*dinfo));
1082     dinfo->opts = all_opts;
1083
1084     dinfo->cyls = cyls;
1085     dinfo->heads = heads;
1086     dinfo->secs = secs;
1087     dinfo->trans = translation;
1088
1089     dinfo->type = type;
1090     dinfo->bus = bus_id;
1091     dinfo->unit = unit_id;
1092     dinfo->devaddr = devaddr;
1093     dinfo->serial = g_strdup(serial);
1094
1095     blk_set_legacy_dinfo(blk, dinfo);
1096
1097     switch(type) {
1098     case IF_IDE:
1099     case IF_SCSI:
1100     case IF_XEN:
1101     case IF_NONE:
1102         dinfo->media_cd = media == MEDIA_CDROM;
1103         break;
1104     default:
1105         break;
1106     }
1107
1108 fail:
1109     qemu_opts_del(legacy_opts);
1110     QDECREF(bs_opts);
1111     return dinfo;
1112 }
1113
1114 void hmp_commit(Monitor *mon, const QDict *qdict)
1115 {
1116     const char *device = qdict_get_str(qdict, "device");
1117     BlockBackend *blk;
1118     int ret;
1119
1120     if (!strcmp(device, "all")) {
1121         ret = bdrv_commit_all();
1122     } else {
1123         BlockDriverState *bs;
1124         AioContext *aio_context;
1125
1126         blk = blk_by_name(device);
1127         if (!blk) {
1128             monitor_printf(mon, "Device '%s' not found\n", device);
1129             return;
1130         }
1131         if (!blk_is_available(blk)) {
1132             monitor_printf(mon, "Device '%s' has no medium\n", device);
1133             return;
1134         }
1135
1136         bs = blk_bs(blk);
1137         aio_context = bdrv_get_aio_context(bs);
1138         aio_context_acquire(aio_context);
1139
1140         ret = bdrv_commit(bs);
1141
1142         aio_context_release(aio_context);
1143     }
1144     if (ret < 0) {
1145         monitor_printf(mon, "'commit' error for '%s': %s\n", device,
1146                        strerror(-ret));
1147     }
1148 }
1149
1150 static void blockdev_do_action(TransactionActionKind type, void *data,
1151                                Error **errp)
1152 {
1153     TransactionAction action;
1154     TransactionActionList list;
1155
1156     action.type = type;
1157     action.u.data = data;
1158     list.value = &action;
1159     list.next = NULL;
1160     qmp_transaction(&list, errp);
1161 }
1162
1163 void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
1164                                 bool has_node_name, const char *node_name,
1165                                 const char *snapshot_file,
1166                                 bool has_snapshot_node_name,
1167                                 const char *snapshot_node_name,
1168                                 bool has_format, const char *format,
1169                                 bool has_mode, NewImageMode mode, Error **errp)
1170 {
1171     BlockdevSnapshot snapshot = {
1172         .has_device = has_device,
1173         .device = (char *) device,
1174         .has_node_name = has_node_name,
1175         .node_name = (char *) node_name,
1176         .snapshot_file = (char *) snapshot_file,
1177         .has_snapshot_node_name = has_snapshot_node_name,
1178         .snapshot_node_name = (char *) snapshot_node_name,
1179         .has_format = has_format,
1180         .format = (char *) format,
1181         .has_mode = has_mode,
1182         .mode = mode,
1183     };
1184     blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1185                        &snapshot, errp);
1186 }
1187
1188 void qmp_blockdev_snapshot_internal_sync(const char *device,
1189                                          const char *name,
1190                                          Error **errp)
1191 {
1192     BlockdevSnapshotInternal snapshot = {
1193         .device = (char *) device,
1194         .name = (char *) name
1195     };
1196
1197     blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1198                        &snapshot, errp);
1199 }
1200
1201 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1202                                                          bool has_id,
1203                                                          const char *id,
1204                                                          bool has_name,
1205                                                          const char *name,
1206                                                          Error **errp)
1207 {
1208     BlockDriverState *bs;
1209     BlockBackend *blk;
1210     AioContext *aio_context;
1211     QEMUSnapshotInfo sn;
1212     Error *local_err = NULL;
1213     SnapshotInfo *info = NULL;
1214     int ret;
1215
1216     blk = blk_by_name(device);
1217     if (!blk) {
1218         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1219                   "Device '%s' not found", device);
1220         return NULL;
1221     }
1222
1223     aio_context = blk_get_aio_context(blk);
1224     aio_context_acquire(aio_context);
1225
1226     if (!has_id) {
1227         id = NULL;
1228     }
1229
1230     if (!has_name) {
1231         name = NULL;
1232     }
1233
1234     if (!id && !name) {
1235         error_setg(errp, "Name or id must be provided");
1236         goto out_aio_context;
1237     }
1238
1239     if (!blk_is_available(blk)) {
1240         error_setg(errp, "Device '%s' has no medium", device);
1241         goto out_aio_context;
1242     }
1243     bs = blk_bs(blk);
1244
1245     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1246         goto out_aio_context;
1247     }
1248
1249     ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1250     if (local_err) {
1251         error_propagate(errp, local_err);
1252         goto out_aio_context;
1253     }
1254     if (!ret) {
1255         error_setg(errp,
1256                    "Snapshot with id '%s' and name '%s' does not exist on "
1257                    "device '%s'",
1258                    STR_OR_NULL(id), STR_OR_NULL(name), device);
1259         goto out_aio_context;
1260     }
1261
1262     bdrv_snapshot_delete(bs, id, name, &local_err);
1263     if (local_err) {
1264         error_propagate(errp, local_err);
1265         goto out_aio_context;
1266     }
1267
1268     aio_context_release(aio_context);
1269
1270     info = g_new0(SnapshotInfo, 1);
1271     info->id = g_strdup(sn.id_str);
1272     info->name = g_strdup(sn.name);
1273     info->date_nsec = sn.date_nsec;
1274     info->date_sec = sn.date_sec;
1275     info->vm_state_size = sn.vm_state_size;
1276     info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1277     info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1278
1279     return info;
1280
1281 out_aio_context:
1282     aio_context_release(aio_context);
1283     return NULL;
1284 }
1285
1286 /**
1287  * block_dirty_bitmap_lookup:
1288  * Return a dirty bitmap (if present), after validating
1289  * the node reference and bitmap names.
1290  *
1291  * @node: The name of the BDS node to search for bitmaps
1292  * @name: The name of the bitmap to search for
1293  * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
1294  * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
1295  * @errp: Output pointer for error information. Can be NULL.
1296  *
1297  * @return: A bitmap object on success, or NULL on failure.
1298  */
1299 static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
1300                                                   const char *name,
1301                                                   BlockDriverState **pbs,
1302                                                   AioContext **paio,
1303                                                   Error **errp)
1304 {
1305     BlockDriverState *bs;
1306     BdrvDirtyBitmap *bitmap;
1307     AioContext *aio_context;
1308
1309     if (!node) {
1310         error_setg(errp, "Node cannot be NULL");
1311         return NULL;
1312     }
1313     if (!name) {
1314         error_setg(errp, "Bitmap name cannot be NULL");
1315         return NULL;
1316     }
1317     bs = bdrv_lookup_bs(node, node, NULL);
1318     if (!bs) {
1319         error_setg(errp, "Node '%s' not found", node);
1320         return NULL;
1321     }
1322
1323     aio_context = bdrv_get_aio_context(bs);
1324     aio_context_acquire(aio_context);
1325
1326     bitmap = bdrv_find_dirty_bitmap(bs, name);
1327     if (!bitmap) {
1328         error_setg(errp, "Dirty bitmap '%s' not found", name);
1329         goto fail;
1330     }
1331
1332     if (pbs) {
1333         *pbs = bs;
1334     }
1335     if (paio) {
1336         *paio = aio_context;
1337     } else {
1338         aio_context_release(aio_context);
1339     }
1340
1341     return bitmap;
1342
1343  fail:
1344     aio_context_release(aio_context);
1345     return NULL;
1346 }
1347
1348 /* New and old BlockDriverState structs for atomic group operations */
1349
1350 typedef struct BlkTransactionState BlkTransactionState;
1351
1352 /* Only prepare() may fail. In a single transaction, only one of commit() or
1353    abort() will be called, clean() will always be called if it present. */
1354 typedef struct BdrvActionOps {
1355     /* Size of state struct, in bytes. */
1356     size_t instance_size;
1357     /* Prepare the work, must NOT be NULL. */
1358     void (*prepare)(BlkTransactionState *common, Error **errp);
1359     /* Commit the changes, can be NULL. */
1360     void (*commit)(BlkTransactionState *common);
1361     /* Abort the changes on fail, can be NULL. */
1362     void (*abort)(BlkTransactionState *common);
1363     /* Clean up resource in the end, can be NULL. */
1364     void (*clean)(BlkTransactionState *common);
1365 } BdrvActionOps;
1366
1367 /*
1368  * This structure must be arranged as first member in child type, assuming
1369  * that compiler will also arrange it to the same address with parent instance.
1370  * Later it will be used in free().
1371  */
1372 struct BlkTransactionState {
1373     TransactionAction *action;
1374     const BdrvActionOps *ops;
1375     QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1376 };
1377
1378 /* internal snapshot private data */
1379 typedef struct InternalSnapshotState {
1380     BlkTransactionState common;
1381     BlockDriverState *bs;
1382     AioContext *aio_context;
1383     QEMUSnapshotInfo sn;
1384     bool created;
1385 } InternalSnapshotState;
1386
1387 static void internal_snapshot_prepare(BlkTransactionState *common,
1388                                       Error **errp)
1389 {
1390     Error *local_err = NULL;
1391     const char *device;
1392     const char *name;
1393     BlockBackend *blk;
1394     BlockDriverState *bs;
1395     QEMUSnapshotInfo old_sn, *sn;
1396     bool ret;
1397     qemu_timeval tv;
1398     BlockdevSnapshotInternal *internal;
1399     InternalSnapshotState *state;
1400     int ret1;
1401
1402     g_assert(common->action->type ==
1403              TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1404     internal = common->action->u.blockdev_snapshot_internal_sync;
1405     state = DO_UPCAST(InternalSnapshotState, common, common);
1406
1407     /* 1. parse input */
1408     device = internal->device;
1409     name = internal->name;
1410
1411     /* 2. check for validation */
1412     blk = blk_by_name(device);
1413     if (!blk) {
1414         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1415                   "Device '%s' not found", device);
1416         return;
1417     }
1418
1419     /* AioContext is released in .clean() */
1420     state->aio_context = blk_get_aio_context(blk);
1421     aio_context_acquire(state->aio_context);
1422
1423     if (!blk_is_available(blk)) {
1424         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1425         return;
1426     }
1427     bs = blk_bs(blk);
1428
1429     state->bs = bs;
1430     bdrv_drained_begin(bs);
1431
1432     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1433         return;
1434     }
1435
1436     if (bdrv_is_read_only(bs)) {
1437         error_setg(errp, "Device '%s' is read only", device);
1438         return;
1439     }
1440
1441     if (!bdrv_can_snapshot(bs)) {
1442         error_setg(errp, "Block format '%s' used by device '%s' "
1443                    "does not support internal snapshots",
1444                    bs->drv->format_name, device);
1445         return;
1446     }
1447
1448     if (!strlen(name)) {
1449         error_setg(errp, "Name is empty");
1450         return;
1451     }
1452
1453     /* check whether a snapshot with name exist */
1454     ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1455                                             &local_err);
1456     if (local_err) {
1457         error_propagate(errp, local_err);
1458         return;
1459     } else if (ret) {
1460         error_setg(errp,
1461                    "Snapshot with name '%s' already exists on device '%s'",
1462                    name, device);
1463         return;
1464     }
1465
1466     /* 3. take the snapshot */
1467     sn = &state->sn;
1468     pstrcpy(sn->name, sizeof(sn->name), name);
1469     qemu_gettimeofday(&tv);
1470     sn->date_sec = tv.tv_sec;
1471     sn->date_nsec = tv.tv_usec * 1000;
1472     sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1473
1474     ret1 = bdrv_snapshot_create(bs, sn);
1475     if (ret1 < 0) {
1476         error_setg_errno(errp, -ret1,
1477                          "Failed to create snapshot '%s' on device '%s'",
1478                          name, device);
1479         return;
1480     }
1481
1482     /* 4. succeed, mark a snapshot is created */
1483     state->created = true;
1484 }
1485
1486 static void internal_snapshot_abort(BlkTransactionState *common)
1487 {
1488     InternalSnapshotState *state =
1489                              DO_UPCAST(InternalSnapshotState, common, common);
1490     BlockDriverState *bs = state->bs;
1491     QEMUSnapshotInfo *sn = &state->sn;
1492     Error *local_error = NULL;
1493
1494     if (!state->created) {
1495         return;
1496     }
1497
1498     if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1499         error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1500                      "device '%s' in abort: %s",
1501                      sn->id_str,
1502                      sn->name,
1503                      bdrv_get_device_name(bs),
1504                      error_get_pretty(local_error));
1505         error_free(local_error);
1506     }
1507 }
1508
1509 static void internal_snapshot_clean(BlkTransactionState *common)
1510 {
1511     InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
1512                                              common, common);
1513
1514     if (state->aio_context) {
1515         if (state->bs) {
1516             bdrv_drained_end(state->bs);
1517         }
1518         aio_context_release(state->aio_context);
1519     }
1520 }
1521
1522 /* external snapshot private data */
1523 typedef struct ExternalSnapshotState {
1524     BlkTransactionState common;
1525     BlockDriverState *old_bs;
1526     BlockDriverState *new_bs;
1527     AioContext *aio_context;
1528 } ExternalSnapshotState;
1529
1530 static void external_snapshot_prepare(BlkTransactionState *common,
1531                                       Error **errp)
1532 {
1533     int flags, ret;
1534     QDict *options;
1535     Error *local_err = NULL;
1536     bool has_device = false;
1537     const char *device;
1538     bool has_node_name = false;
1539     const char *node_name;
1540     bool has_snapshot_node_name = false;
1541     const char *snapshot_node_name;
1542     const char *new_image_file;
1543     const char *format = "qcow2";
1544     enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1545     ExternalSnapshotState *state =
1546                              DO_UPCAST(ExternalSnapshotState, common, common);
1547     TransactionAction *action = common->action;
1548
1549     /* get parameters */
1550     g_assert(action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1551
1552     has_device = action->u.blockdev_snapshot_sync->has_device;
1553     device = action->u.blockdev_snapshot_sync->device;
1554     has_node_name = action->u.blockdev_snapshot_sync->has_node_name;
1555     node_name = action->u.blockdev_snapshot_sync->node_name;
1556     has_snapshot_node_name =
1557         action->u.blockdev_snapshot_sync->has_snapshot_node_name;
1558     snapshot_node_name = action->u.blockdev_snapshot_sync->snapshot_node_name;
1559
1560     new_image_file = action->u.blockdev_snapshot_sync->snapshot_file;
1561     if (action->u.blockdev_snapshot_sync->has_format) {
1562         format = action->u.blockdev_snapshot_sync->format;
1563     }
1564     if (action->u.blockdev_snapshot_sync->has_mode) {
1565         mode = action->u.blockdev_snapshot_sync->mode;
1566     }
1567
1568     /* start processing */
1569     state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
1570                                    has_node_name ? node_name : NULL,
1571                                    &local_err);
1572     if (local_err) {
1573         error_propagate(errp, local_err);
1574         return;
1575     }
1576
1577     if (has_node_name && !has_snapshot_node_name) {
1578         error_setg(errp, "New snapshot node name missing");
1579         return;
1580     }
1581
1582     if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
1583         error_setg(errp, "New snapshot node name already existing");
1584         return;
1585     }
1586
1587     /* Acquire AioContext now so any threads operating on old_bs stop */
1588     state->aio_context = bdrv_get_aio_context(state->old_bs);
1589     aio_context_acquire(state->aio_context);
1590     bdrv_drained_begin(state->old_bs);
1591
1592     if (!bdrv_is_inserted(state->old_bs)) {
1593         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1594         return;
1595     }
1596
1597     if (bdrv_op_is_blocked(state->old_bs,
1598                            BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1599         return;
1600     }
1601
1602     if (!bdrv_is_read_only(state->old_bs)) {
1603         if (bdrv_flush(state->old_bs)) {
1604             error_setg(errp, QERR_IO_ERROR);
1605             return;
1606         }
1607     }
1608
1609     if (!bdrv_is_first_non_filter(state->old_bs)) {
1610         error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1611         return;
1612     }
1613
1614     flags = state->old_bs->open_flags;
1615
1616     /* create new image w/backing file */
1617     if (mode != NEW_IMAGE_MODE_EXISTING) {
1618         bdrv_img_create(new_image_file, format,
1619                         state->old_bs->filename,
1620                         state->old_bs->drv->format_name,
1621                         NULL, -1, flags, &local_err, false);
1622         if (local_err) {
1623             error_propagate(errp, local_err);
1624             return;
1625         }
1626     }
1627
1628     options = qdict_new();
1629     if (has_snapshot_node_name) {
1630         qdict_put(options, "node-name",
1631                   qstring_from_str(snapshot_node_name));
1632     }
1633     qdict_put(options, "driver", qstring_from_str(format));
1634
1635     /* TODO Inherit bs->options or only take explicit options with an
1636      * extended QMP command? */
1637     assert(state->new_bs == NULL);
1638     ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
1639                     flags | BDRV_O_NO_BACKING, &local_err);
1640     /* We will manually add the backing_hd field to the bs later */
1641     if (ret != 0) {
1642         error_propagate(errp, local_err);
1643     }
1644 }
1645
1646 static void external_snapshot_commit(BlkTransactionState *common)
1647 {
1648     ExternalSnapshotState *state =
1649                              DO_UPCAST(ExternalSnapshotState, common, common);
1650
1651     bdrv_set_aio_context(state->new_bs, state->aio_context);
1652
1653     /* This removes our old bs and adds the new bs */
1654     bdrv_append(state->new_bs, state->old_bs);
1655     /* We don't need (or want) to use the transactional
1656      * bdrv_reopen_multiple() across all the entries at once, because we
1657      * don't want to abort all of them if one of them fails the reopen */
1658     bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1659                 NULL);
1660 }
1661
1662 static void external_snapshot_abort(BlkTransactionState *common)
1663 {
1664     ExternalSnapshotState *state =
1665                              DO_UPCAST(ExternalSnapshotState, common, common);
1666     if (state->new_bs) {
1667         bdrv_unref(state->new_bs);
1668     }
1669 }
1670
1671 static void external_snapshot_clean(BlkTransactionState *common)
1672 {
1673     ExternalSnapshotState *state =
1674                              DO_UPCAST(ExternalSnapshotState, common, common);
1675     if (state->aio_context) {
1676         bdrv_drained_end(state->old_bs);
1677         aio_context_release(state->aio_context);
1678     }
1679 }
1680
1681 typedef struct DriveBackupState {
1682     BlkTransactionState common;
1683     BlockDriverState *bs;
1684     AioContext *aio_context;
1685     BlockJob *job;
1686 } DriveBackupState;
1687
1688 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1689 {
1690     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1691     BlockBackend *blk;
1692     DriveBackup *backup;
1693     Error *local_err = NULL;
1694
1695     assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1696     backup = common->action->u.drive_backup;
1697
1698     blk = blk_by_name(backup->device);
1699     if (!blk) {
1700         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1701                   "Device '%s' not found", backup->device);
1702         return;
1703     }
1704
1705     if (!blk_is_available(blk)) {
1706         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1707         return;
1708     }
1709
1710     /* AioContext is released in .clean() */
1711     state->aio_context = blk_get_aio_context(blk);
1712     aio_context_acquire(state->aio_context);
1713     bdrv_drained_begin(blk_bs(blk));
1714     state->bs = blk_bs(blk);
1715
1716     qmp_drive_backup(backup->device, backup->target,
1717                      backup->has_format, backup->format,
1718                      backup->sync,
1719                      backup->has_mode, backup->mode,
1720                      backup->has_speed, backup->speed,
1721                      backup->has_bitmap, backup->bitmap,
1722                      backup->has_on_source_error, backup->on_source_error,
1723                      backup->has_on_target_error, backup->on_target_error,
1724                      &local_err);
1725     if (local_err) {
1726         error_propagate(errp, local_err);
1727         return;
1728     }
1729
1730     state->job = state->bs->job;
1731 }
1732
1733 static void drive_backup_abort(BlkTransactionState *common)
1734 {
1735     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1736     BlockDriverState *bs = state->bs;
1737
1738     /* Only cancel if it's the job we started */
1739     if (bs && bs->job && bs->job == state->job) {
1740         block_job_cancel_sync(bs->job);
1741     }
1742 }
1743
1744 static void drive_backup_clean(BlkTransactionState *common)
1745 {
1746     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1747
1748     if (state->aio_context) {
1749         bdrv_drained_end(state->bs);
1750         aio_context_release(state->aio_context);
1751     }
1752 }
1753
1754 typedef struct BlockdevBackupState {
1755     BlkTransactionState common;
1756     BlockDriverState *bs;
1757     BlockJob *job;
1758     AioContext *aio_context;
1759 } BlockdevBackupState;
1760
1761 static void blockdev_backup_prepare(BlkTransactionState *common, Error **errp)
1762 {
1763     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1764     BlockdevBackup *backup;
1765     BlockBackend *blk, *target;
1766     Error *local_err = NULL;
1767
1768     assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1769     backup = common->action->u.blockdev_backup;
1770
1771     blk = blk_by_name(backup->device);
1772     if (!blk) {
1773         error_setg(errp, "Device '%s' not found", backup->device);
1774         return;
1775     }
1776
1777     if (!blk_is_available(blk)) {
1778         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
1779         return;
1780     }
1781
1782     target = blk_by_name(backup->target);
1783     if (!target) {
1784         error_setg(errp, "Device '%s' not found", backup->target);
1785         return;
1786     }
1787
1788     /* AioContext is released in .clean() */
1789     state->aio_context = blk_get_aio_context(blk);
1790     if (state->aio_context != blk_get_aio_context(target)) {
1791         state->aio_context = NULL;
1792         error_setg(errp, "Backup between two IO threads is not implemented");
1793         return;
1794     }
1795     aio_context_acquire(state->aio_context);
1796     state->bs = blk_bs(blk);
1797     bdrv_drained_begin(state->bs);
1798
1799     qmp_blockdev_backup(backup->device, backup->target,
1800                         backup->sync,
1801                         backup->has_speed, backup->speed,
1802                         backup->has_on_source_error, backup->on_source_error,
1803                         backup->has_on_target_error, backup->on_target_error,
1804                         &local_err);
1805     if (local_err) {
1806         error_propagate(errp, local_err);
1807         return;
1808     }
1809
1810     state->job = state->bs->job;
1811 }
1812
1813 static void blockdev_backup_abort(BlkTransactionState *common)
1814 {
1815     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1816     BlockDriverState *bs = state->bs;
1817
1818     /* Only cancel if it's the job we started */
1819     if (bs && bs->job && bs->job == state->job) {
1820         block_job_cancel_sync(bs->job);
1821     }
1822 }
1823
1824 static void blockdev_backup_clean(BlkTransactionState *common)
1825 {
1826     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1827
1828     if (state->aio_context) {
1829         bdrv_drained_end(state->bs);
1830         aio_context_release(state->aio_context);
1831     }
1832 }
1833
1834 static void abort_prepare(BlkTransactionState *common, Error **errp)
1835 {
1836     error_setg(errp, "Transaction aborted using Abort action");
1837 }
1838
1839 static void abort_commit(BlkTransactionState *common)
1840 {
1841     g_assert_not_reached(); /* this action never succeeds */
1842 }
1843
1844 static const BdrvActionOps actions[] = {
1845     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1846         .instance_size = sizeof(ExternalSnapshotState),
1847         .prepare  = external_snapshot_prepare,
1848         .commit   = external_snapshot_commit,
1849         .abort = external_snapshot_abort,
1850         .clean = external_snapshot_clean,
1851     },
1852     [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1853         .instance_size = sizeof(DriveBackupState),
1854         .prepare = drive_backup_prepare,
1855         .abort = drive_backup_abort,
1856         .clean = drive_backup_clean,
1857     },
1858     [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
1859         .instance_size = sizeof(BlockdevBackupState),
1860         .prepare = blockdev_backup_prepare,
1861         .abort = blockdev_backup_abort,
1862         .clean = blockdev_backup_clean,
1863     },
1864     [TRANSACTION_ACTION_KIND_ABORT] = {
1865         .instance_size = sizeof(BlkTransactionState),
1866         .prepare = abort_prepare,
1867         .commit = abort_commit,
1868     },
1869     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1870         .instance_size = sizeof(InternalSnapshotState),
1871         .prepare  = internal_snapshot_prepare,
1872         .abort = internal_snapshot_abort,
1873         .clean = internal_snapshot_clean,
1874     },
1875 };
1876
1877 /*
1878  * 'Atomic' group operations.  The operations are performed as a set, and if
1879  * any fail then we roll back all operations in the group.
1880  */
1881 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1882 {
1883     TransactionActionList *dev_entry = dev_list;
1884     BlkTransactionState *state, *next;
1885     Error *local_err = NULL;
1886
1887     QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1888     QSIMPLEQ_INIT(&snap_bdrv_states);
1889
1890     /* drain all i/o before any operations */
1891     bdrv_drain_all();
1892
1893     /* We don't do anything in this loop that commits us to the operations */
1894     while (NULL != dev_entry) {
1895         TransactionAction *dev_info = NULL;
1896         const BdrvActionOps *ops;
1897
1898         dev_info = dev_entry->value;
1899         dev_entry = dev_entry->next;
1900
1901         assert(dev_info->type < ARRAY_SIZE(actions));
1902
1903         ops = &actions[dev_info->type];
1904         assert(ops->instance_size > 0);
1905
1906         state = g_malloc0(ops->instance_size);
1907         state->ops = ops;
1908         state->action = dev_info;
1909         QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1910
1911         state->ops->prepare(state, &local_err);
1912         if (local_err) {
1913             error_propagate(errp, local_err);
1914             goto delete_and_fail;
1915         }
1916     }
1917
1918     QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1919         if (state->ops->commit) {
1920             state->ops->commit(state);
1921         }
1922     }
1923
1924     /* success */
1925     goto exit;
1926
1927 delete_and_fail:
1928     /* failure, and it is all-or-none; roll back all operations */
1929     QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1930         if (state->ops->abort) {
1931             state->ops->abort(state);
1932         }
1933     }
1934 exit:
1935     QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1936         if (state->ops->clean) {
1937             state->ops->clean(state);
1938         }
1939         g_free(state);
1940     }
1941 }
1942
1943
1944 static void eject_device(BlockBackend *blk, int force, Error **errp)
1945 {
1946     BlockDriverState *bs = blk_bs(blk);
1947     AioContext *aio_context;
1948
1949     if (!bs) {
1950         /* No medium inserted, so there is nothing to do */
1951         return;
1952     }
1953
1954     aio_context = bdrv_get_aio_context(bs);
1955     aio_context_acquire(aio_context);
1956
1957     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1958         goto out;
1959     }
1960     if (!blk_dev_has_removable_media(blk)) {
1961         error_setg(errp, "Device '%s' is not removable",
1962                    bdrv_get_device_name(bs));
1963         goto out;
1964     }
1965
1966     if (blk_dev_is_medium_locked(blk) && !blk_dev_is_tray_open(blk)) {
1967         blk_dev_eject_request(blk, force);
1968         if (!force) {
1969             error_setg(errp, "Device '%s' is locked",
1970                        bdrv_get_device_name(bs));
1971             goto out;
1972         }
1973     }
1974
1975     bdrv_close(bs);
1976
1977 out:
1978     aio_context_release(aio_context);
1979 }
1980
1981 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1982 {
1983     BlockBackend *blk;
1984
1985     blk = blk_by_name(device);
1986     if (!blk) {
1987         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1988                   "Device '%s' not found", device);
1989         return;
1990     }
1991
1992     eject_device(blk, force, errp);
1993 }
1994
1995 void qmp_block_passwd(bool has_device, const char *device,
1996                       bool has_node_name, const char *node_name,
1997                       const char *password, Error **errp)
1998 {
1999     Error *local_err = NULL;
2000     BlockDriverState *bs;
2001     AioContext *aio_context;
2002
2003     bs = bdrv_lookup_bs(has_device ? device : NULL,
2004                         has_node_name ? node_name : NULL,
2005                         &local_err);
2006     if (local_err) {
2007         error_propagate(errp, local_err);
2008         return;
2009     }
2010
2011     aio_context = bdrv_get_aio_context(bs);
2012     aio_context_acquire(aio_context);
2013
2014     bdrv_add_key(bs, password, errp);
2015
2016     aio_context_release(aio_context);
2017 }
2018
2019 /* Assumes AioContext is held */
2020 static void qmp_bdrv_open_encrypted(BlockDriverState **pbs,
2021                                     const char *filename,
2022                                     int bdrv_flags, const char *format,
2023                                     const char *password, Error **errp)
2024 {
2025     Error *local_err = NULL;
2026     QDict *options = NULL;
2027     int ret;
2028
2029     if (format) {
2030         options = qdict_new();
2031         qdict_put(options, "driver", qstring_from_str(format));
2032     }
2033
2034     ret = bdrv_open(pbs, filename, NULL, options, bdrv_flags, &local_err);
2035     if (ret < 0) {
2036         error_propagate(errp, local_err);
2037         return;
2038     }
2039
2040     bdrv_add_key(*pbs, password, errp);
2041 }
2042
2043 void qmp_change_blockdev(const char *device, const char *filename,
2044                          const char *format, Error **errp)
2045 {
2046     BlockBackend *blk;
2047     BlockDriverState *bs;
2048     AioContext *aio_context;
2049     int bdrv_flags;
2050     bool new_bs;
2051     Error *err = NULL;
2052
2053     blk = blk_by_name(device);
2054     if (!blk) {
2055         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2056                   "Device '%s' not found", device);
2057         return;
2058     }
2059     bs = blk_bs(blk);
2060     new_bs = !bs;
2061
2062     aio_context = blk_get_aio_context(blk);
2063     aio_context_acquire(aio_context);
2064
2065     eject_device(blk, 0, &err);
2066     if (err) {
2067         error_propagate(errp, err);
2068         goto out;
2069     }
2070
2071     bdrv_flags = blk_is_read_only(blk) ? 0 : BDRV_O_RDWR;
2072     bdrv_flags |= blk_get_root_state(blk)->open_flags & ~BDRV_O_RDWR;
2073
2074     qmp_bdrv_open_encrypted(&bs, filename, bdrv_flags, format, NULL, &err);
2075     if (err) {
2076         error_propagate(errp, err);
2077         goto out;
2078     }
2079
2080     if (new_bs) {
2081         blk_insert_bs(blk, bs);
2082         /* Has been sent automatically by bdrv_open() if blk_bs(blk) was not
2083          * NULL */
2084         blk_dev_change_media_cb(blk, true);
2085     }
2086
2087 out:
2088     aio_context_release(aio_context);
2089 }
2090
2091 void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
2092                             Error **errp)
2093 {
2094     BlockBackend *blk;
2095     bool locked;
2096
2097     if (!has_force) {
2098         force = false;
2099     }
2100
2101     blk = blk_by_name(device);
2102     if (!blk) {
2103         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2104                   "Device '%s' not found", device);
2105         return;
2106     }
2107
2108     if (!blk_dev_has_removable_media(blk)) {
2109         error_setg(errp, "Device '%s' is not removable", device);
2110         return;
2111     }
2112
2113     if (blk_dev_is_tray_open(blk)) {
2114         return;
2115     }
2116
2117     locked = blk_dev_is_medium_locked(blk);
2118     if (locked) {
2119         blk_dev_eject_request(blk, force);
2120     }
2121
2122     if (!locked || force) {
2123         blk_dev_change_media_cb(blk, false);
2124     }
2125 }
2126
2127 void qmp_blockdev_close_tray(const char *device, Error **errp)
2128 {
2129     BlockBackend *blk;
2130
2131     blk = blk_by_name(device);
2132     if (!blk) {
2133         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2134                   "Device '%s' not found", device);
2135         return;
2136     }
2137
2138     if (!blk_dev_has_removable_media(blk)) {
2139         error_setg(errp, "Device '%s' is not removable", device);
2140         return;
2141     }
2142
2143     if (!blk_dev_is_tray_open(blk)) {
2144         return;
2145     }
2146
2147     blk_dev_change_media_cb(blk, true);
2148 }
2149
2150 void qmp_blockdev_remove_medium(const char *device, Error **errp)
2151 {
2152     BlockBackend *blk;
2153     BlockDriverState *bs;
2154     AioContext *aio_context;
2155     bool has_device;
2156
2157     blk = blk_by_name(device);
2158     if (!blk) {
2159         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2160                   "Device '%s' not found", device);
2161         return;
2162     }
2163
2164     /* For BBs without a device, we can exchange the BDS tree at will */
2165     has_device = blk_get_attached_dev(blk);
2166
2167     if (has_device && !blk_dev_has_removable_media(blk)) {
2168         error_setg(errp, "Device '%s' is not removable", device);
2169         return;
2170     }
2171
2172     if (has_device && !blk_dev_is_tray_open(blk)) {
2173         error_setg(errp, "Tray of device '%s' is not open", device);
2174         return;
2175     }
2176
2177     bs = blk_bs(blk);
2178     if (!bs) {
2179         return;
2180     }
2181
2182     aio_context = bdrv_get_aio_context(bs);
2183     aio_context_acquire(aio_context);
2184
2185     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
2186         goto out;
2187     }
2188
2189     /* This follows the convention established by bdrv_make_anon() */
2190     if (bs->device_list.tqe_prev) {
2191         QTAILQ_REMOVE(&bdrv_states, bs, device_list);
2192         bs->device_list.tqe_prev = NULL;
2193     }
2194
2195     blk_remove_bs(blk);
2196
2197 out:
2198     aio_context_release(aio_context);
2199 }
2200
2201 static void qmp_blockdev_insert_anon_medium(const char *device,
2202                                             BlockDriverState *bs, Error **errp)
2203 {
2204     BlockBackend *blk;
2205     bool has_device;
2206
2207     blk = blk_by_name(device);
2208     if (!blk) {
2209         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2210                   "Device '%s' not found", device);
2211         return;
2212     }
2213
2214     /* For BBs without a device, we can exchange the BDS tree at will */
2215     has_device = blk_get_attached_dev(blk);
2216
2217     if (has_device && !blk_dev_has_removable_media(blk)) {
2218         error_setg(errp, "Device '%s' is not removable", device);
2219         return;
2220     }
2221
2222     if (has_device && !blk_dev_is_tray_open(blk)) {
2223         error_setg(errp, "Tray of device '%s' is not open", device);
2224         return;
2225     }
2226
2227     if (blk_bs(blk)) {
2228         error_setg(errp, "There already is a medium in device '%s'", device);
2229         return;
2230     }
2231
2232     blk_insert_bs(blk, bs);
2233
2234     QTAILQ_INSERT_TAIL(&bdrv_states, bs, device_list);
2235 }
2236
2237 void qmp_blockdev_insert_medium(const char *device, const char *node_name,
2238                                 Error **errp)
2239 {
2240     BlockDriverState *bs;
2241
2242     bs = bdrv_find_node(node_name);
2243     if (!bs) {
2244         error_setg(errp, "Node '%s' not found", node_name);
2245         return;
2246     }
2247
2248     if (bs->blk) {
2249         error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
2250                    blk_name(bs->blk));
2251         return;
2252     }
2253
2254     qmp_blockdev_insert_anon_medium(device, bs, errp);
2255 }
2256
2257 /* throttling disk I/O limits */
2258 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2259                                int64_t bps_wr,
2260                                int64_t iops,
2261                                int64_t iops_rd,
2262                                int64_t iops_wr,
2263                                bool has_bps_max,
2264                                int64_t bps_max,
2265                                bool has_bps_rd_max,
2266                                int64_t bps_rd_max,
2267                                bool has_bps_wr_max,
2268                                int64_t bps_wr_max,
2269                                bool has_iops_max,
2270                                int64_t iops_max,
2271                                bool has_iops_rd_max,
2272                                int64_t iops_rd_max,
2273                                bool has_iops_wr_max,
2274                                int64_t iops_wr_max,
2275                                bool has_iops_size,
2276                                int64_t iops_size,
2277                                bool has_group,
2278                                const char *group, Error **errp)
2279 {
2280     ThrottleConfig cfg;
2281     BlockDriverState *bs;
2282     BlockBackend *blk;
2283     AioContext *aio_context;
2284
2285     blk = blk_by_name(device);
2286     if (!blk) {
2287         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2288                   "Device '%s' not found", device);
2289         return;
2290     }
2291
2292     aio_context = blk_get_aio_context(blk);
2293     aio_context_acquire(aio_context);
2294
2295     bs = blk_bs(blk);
2296     if (!bs) {
2297         error_setg(errp, "Device '%s' has no medium", device);
2298         goto out;
2299     }
2300
2301     memset(&cfg, 0, sizeof(cfg));
2302     cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
2303     cfg.buckets[THROTTLE_BPS_READ].avg  = bps_rd;
2304     cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
2305
2306     cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
2307     cfg.buckets[THROTTLE_OPS_READ].avg  = iops_rd;
2308     cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
2309
2310     if (has_bps_max) {
2311         cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
2312     }
2313     if (has_bps_rd_max) {
2314         cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
2315     }
2316     if (has_bps_wr_max) {
2317         cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
2318     }
2319     if (has_iops_max) {
2320         cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
2321     }
2322     if (has_iops_rd_max) {
2323         cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
2324     }
2325     if (has_iops_wr_max) {
2326         cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
2327     }
2328
2329     if (has_iops_size) {
2330         cfg.op_size = iops_size;
2331     }
2332
2333     if (!check_throttle_config(&cfg, errp)) {
2334         goto out;
2335     }
2336
2337     if (throttle_enabled(&cfg)) {
2338         /* Enable I/O limits if they're not enabled yet, otherwise
2339          * just update the throttling group. */
2340         if (!bs->io_limits_enabled) {
2341             bdrv_io_limits_enable(bs, has_group ? group : device);
2342         } else if (has_group) {
2343             bdrv_io_limits_update_group(bs, group);
2344         }
2345         /* Set the new throttling configuration */
2346         bdrv_set_io_limits(bs, &cfg);
2347     } else if (bs->io_limits_enabled) {
2348         /* If all throttling settings are set to 0, disable I/O limits */
2349         bdrv_io_limits_disable(bs);
2350     }
2351
2352 out:
2353     aio_context_release(aio_context);
2354 }
2355
2356 void qmp_block_dirty_bitmap_add(const char *node, const char *name,
2357                                 bool has_granularity, uint32_t granularity,
2358                                 Error **errp)
2359 {
2360     AioContext *aio_context;
2361     BlockDriverState *bs;
2362
2363     if (!name || name[0] == '\0') {
2364         error_setg(errp, "Bitmap name cannot be empty");
2365         return;
2366     }
2367
2368     bs = bdrv_lookup_bs(node, node, errp);
2369     if (!bs) {
2370         return;
2371     }
2372
2373     aio_context = bdrv_get_aio_context(bs);
2374     aio_context_acquire(aio_context);
2375
2376     if (has_granularity) {
2377         if (granularity < 512 || !is_power_of_2(granularity)) {
2378             error_setg(errp, "Granularity must be power of 2 "
2379                              "and at least 512");
2380             goto out;
2381         }
2382     } else {
2383         /* Default to cluster size, if available: */
2384         granularity = bdrv_get_default_bitmap_granularity(bs);
2385     }
2386
2387     bdrv_create_dirty_bitmap(bs, granularity, name, errp);
2388
2389  out:
2390     aio_context_release(aio_context);
2391 }
2392
2393 void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
2394                                    Error **errp)
2395 {
2396     AioContext *aio_context;
2397     BlockDriverState *bs;
2398     BdrvDirtyBitmap *bitmap;
2399
2400     bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2401     if (!bitmap || !bs) {
2402         return;
2403     }
2404
2405     if (bdrv_dirty_bitmap_frozen(bitmap)) {
2406         error_setg(errp,
2407                    "Bitmap '%s' is currently frozen and cannot be removed",
2408                    name);
2409         goto out;
2410     }
2411     bdrv_dirty_bitmap_make_anon(bitmap);
2412     bdrv_release_dirty_bitmap(bs, bitmap);
2413
2414  out:
2415     aio_context_release(aio_context);
2416 }
2417
2418 /**
2419  * Completely clear a bitmap, for the purposes of synchronizing a bitmap
2420  * immediately after a full backup operation.
2421  */
2422 void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
2423                                   Error **errp)
2424 {
2425     AioContext *aio_context;
2426     BdrvDirtyBitmap *bitmap;
2427     BlockDriverState *bs;
2428
2429     bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
2430     if (!bitmap || !bs) {
2431         return;
2432     }
2433
2434     if (bdrv_dirty_bitmap_frozen(bitmap)) {
2435         error_setg(errp,
2436                    "Bitmap '%s' is currently frozen and cannot be modified",
2437                    name);
2438         goto out;
2439     } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
2440         error_setg(errp,
2441                    "Bitmap '%s' is currently disabled and cannot be cleared",
2442                    name);
2443         goto out;
2444     }
2445
2446     bdrv_clear_dirty_bitmap(bitmap);
2447
2448  out:
2449     aio_context_release(aio_context);
2450 }
2451
2452 void hmp_drive_del(Monitor *mon, const QDict *qdict)
2453 {
2454     const char *id = qdict_get_str(qdict, "id");
2455     BlockBackend *blk;
2456     BlockDriverState *bs;
2457     AioContext *aio_context;
2458     Error *local_err = NULL;
2459
2460     blk = blk_by_name(id);
2461     if (!blk) {
2462         error_report("Device '%s' not found", id);
2463         return;
2464     }
2465
2466     if (!blk_legacy_dinfo(blk)) {
2467         error_report("Deleting device added with blockdev-add"
2468                      " is not supported");
2469         return;
2470     }
2471
2472     aio_context = blk_get_aio_context(blk);
2473     aio_context_acquire(aio_context);
2474
2475     bs = blk_bs(blk);
2476     if (bs) {
2477         if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
2478             error_report_err(local_err);
2479             aio_context_release(aio_context);
2480             return;
2481         }
2482
2483         bdrv_close(bs);
2484     }
2485
2486     /* if we have a device attached to this BlockDriverState
2487      * then we need to make the drive anonymous until the device
2488      * can be removed.  If this is a drive with no device backing
2489      * then we can just get rid of the block driver state right here.
2490      */
2491     if (blk_get_attached_dev(blk)) {
2492         blk_hide_on_behalf_of_hmp_drive_del(blk);
2493         /* Further I/O must not pause the guest */
2494         blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
2495                          BLOCKDEV_ON_ERROR_REPORT);
2496     } else {
2497         blk_unref(blk);
2498     }
2499
2500     aio_context_release(aio_context);
2501 }
2502
2503 void qmp_block_resize(bool has_device, const char *device,
2504                       bool has_node_name, const char *node_name,
2505                       int64_t size, Error **errp)
2506 {
2507     Error *local_err = NULL;
2508     BlockDriverState *bs;
2509     AioContext *aio_context;
2510     int ret;
2511
2512     bs = bdrv_lookup_bs(has_device ? device : NULL,
2513                         has_node_name ? node_name : NULL,
2514                         &local_err);
2515     if (local_err) {
2516         error_propagate(errp, local_err);
2517         return;
2518     }
2519
2520     aio_context = bdrv_get_aio_context(bs);
2521     aio_context_acquire(aio_context);
2522
2523     if (!bdrv_is_first_non_filter(bs)) {
2524         error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2525         goto out;
2526     }
2527
2528     if (size < 0) {
2529         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2530         goto out;
2531     }
2532
2533     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2534         error_setg(errp, QERR_DEVICE_IN_USE, device);
2535         goto out;
2536     }
2537
2538     /* complete all in-flight operations before resizing the device */
2539     bdrv_drain_all();
2540
2541     ret = bdrv_truncate(bs, size);
2542     switch (ret) {
2543     case 0:
2544         break;
2545     case -ENOMEDIUM:
2546         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2547         break;
2548     case -ENOTSUP:
2549         error_setg(errp, QERR_UNSUPPORTED);
2550         break;
2551     case -EACCES:
2552         error_setg(errp, "Device '%s' is read only", device);
2553         break;
2554     case -EBUSY:
2555         error_setg(errp, QERR_DEVICE_IN_USE, device);
2556         break;
2557     default:
2558         error_setg_errno(errp, -ret, "Could not resize");
2559         break;
2560     }
2561
2562 out:
2563     aio_context_release(aio_context);
2564 }
2565
2566 static void block_job_cb(void *opaque, int ret)
2567 {
2568     /* Note that this function may be executed from another AioContext besides
2569      * the QEMU main loop.  If you need to access anything that assumes the
2570      * QEMU global mutex, use a BH or introduce a mutex.
2571      */
2572
2573     BlockDriverState *bs = opaque;
2574     const char *msg = NULL;
2575
2576     trace_block_job_cb(bs, bs->job, ret);
2577
2578     assert(bs->job);
2579
2580     if (ret < 0) {
2581         msg = strerror(-ret);
2582     }
2583
2584     if (block_job_is_cancelled(bs->job)) {
2585         block_job_event_cancelled(bs->job);
2586     } else {
2587         block_job_event_completed(bs->job, msg);
2588     }
2589
2590     bdrv_put_ref_bh_schedule(bs);
2591 }
2592
2593 void qmp_block_stream(const char *device,
2594                       bool has_base, const char *base,
2595                       bool has_backing_file, const char *backing_file,
2596                       bool has_speed, int64_t speed,
2597                       bool has_on_error, BlockdevOnError on_error,
2598                       Error **errp)
2599 {
2600     BlockBackend *blk;
2601     BlockDriverState *bs;
2602     BlockDriverState *base_bs = NULL;
2603     AioContext *aio_context;
2604     Error *local_err = NULL;
2605     const char *base_name = NULL;
2606
2607     if (!has_on_error) {
2608         on_error = BLOCKDEV_ON_ERROR_REPORT;
2609     }
2610
2611     blk = blk_by_name(device);
2612     if (!blk) {
2613         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2614                   "Device '%s' not found", device);
2615         return;
2616     }
2617
2618     aio_context = blk_get_aio_context(blk);
2619     aio_context_acquire(aio_context);
2620
2621     if (!blk_is_available(blk)) {
2622         error_setg(errp, "Device '%s' has no medium", device);
2623         goto out;
2624     }
2625     bs = blk_bs(blk);
2626
2627     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2628         goto out;
2629     }
2630
2631     if (has_base) {
2632         base_bs = bdrv_find_backing_image(bs, base);
2633         if (base_bs == NULL) {
2634             error_setg(errp, QERR_BASE_NOT_FOUND, base);
2635             goto out;
2636         }
2637         assert(bdrv_get_aio_context(base_bs) == aio_context);
2638         base_name = base;
2639     }
2640
2641     /* if we are streaming the entire chain, the result will have no backing
2642      * file, and specifying one is therefore an error */
2643     if (base_bs == NULL && has_backing_file) {
2644         error_setg(errp, "backing file specified, but streaming the "
2645                          "entire chain");
2646         goto out;
2647     }
2648
2649     /* backing_file string overrides base bs filename */
2650     base_name = has_backing_file ? backing_file : base_name;
2651
2652     stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
2653                  on_error, block_job_cb, bs, &local_err);
2654     if (local_err) {
2655         error_propagate(errp, local_err);
2656         goto out;
2657     }
2658
2659     trace_qmp_block_stream(bs, bs->job);
2660
2661 out:
2662     aio_context_release(aio_context);
2663 }
2664
2665 void qmp_block_commit(const char *device,
2666                       bool has_base, const char *base,
2667                       bool has_top, const char *top,
2668                       bool has_backing_file, const char *backing_file,
2669                       bool has_speed, int64_t speed,
2670                       Error **errp)
2671 {
2672     BlockBackend *blk;
2673     BlockDriverState *bs;
2674     BlockDriverState *base_bs, *top_bs;
2675     AioContext *aio_context;
2676     Error *local_err = NULL;
2677     /* This will be part of the QMP command, if/when the
2678      * BlockdevOnError change for blkmirror makes it in
2679      */
2680     BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
2681
2682     if (!has_speed) {
2683         speed = 0;
2684     }
2685
2686     /* Important Note:
2687      *  libvirt relies on the DeviceNotFound error class in order to probe for
2688      *  live commit feature versions; for this to work, we must make sure to
2689      *  perform the device lookup before any generic errors that may occur in a
2690      *  scenario in which all optional arguments are omitted. */
2691     blk = blk_by_name(device);
2692     if (!blk) {
2693         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2694                   "Device '%s' not found", device);
2695         return;
2696     }
2697
2698     aio_context = blk_get_aio_context(blk);
2699     aio_context_acquire(aio_context);
2700
2701     if (!blk_is_available(blk)) {
2702         error_setg(errp, "Device '%s' has no medium", device);
2703         goto out;
2704     }
2705     bs = blk_bs(blk);
2706
2707     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2708         goto out;
2709     }
2710
2711     /* default top_bs is the active layer */
2712     top_bs = bs;
2713
2714     if (has_top && top) {
2715         if (strcmp(bs->filename, top) != 0) {
2716             top_bs = bdrv_find_backing_image(bs, top);
2717         }
2718     }
2719
2720     if (top_bs == NULL) {
2721         error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2722         goto out;
2723     }
2724
2725     assert(bdrv_get_aio_context(top_bs) == aio_context);
2726
2727     if (has_base && base) {
2728         base_bs = bdrv_find_backing_image(top_bs, base);
2729     } else {
2730         base_bs = bdrv_find_base(top_bs);
2731     }
2732
2733     if (base_bs == NULL) {
2734         error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
2735         goto out;
2736     }
2737
2738     assert(bdrv_get_aio_context(base_bs) == aio_context);
2739
2740     if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2741         goto out;
2742     }
2743
2744     /* Do not allow attempts to commit an image into itself */
2745     if (top_bs == base_bs) {
2746         error_setg(errp, "cannot commit an image into itself");
2747         goto out;
2748     }
2749
2750     if (top_bs == bs) {
2751         if (has_backing_file) {
2752             error_setg(errp, "'backing-file' specified,"
2753                              " but 'top' is the active layer");
2754             goto out;
2755         }
2756         commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
2757                             bs, &local_err);
2758     } else {
2759         commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
2760                      has_backing_file ? backing_file : NULL, &local_err);
2761     }
2762     if (local_err != NULL) {
2763         error_propagate(errp, local_err);
2764         goto out;
2765     }
2766
2767 out:
2768     aio_context_release(aio_context);
2769 }
2770
2771 void qmp_drive_backup(const char *device, const char *target,
2772                       bool has_format, const char *format,
2773                       enum MirrorSyncMode sync,
2774                       bool has_mode, enum NewImageMode mode,
2775                       bool has_speed, int64_t speed,
2776                       bool has_bitmap, const char *bitmap,
2777                       bool has_on_source_error, BlockdevOnError on_source_error,
2778                       bool has_on_target_error, BlockdevOnError on_target_error,
2779                       Error **errp)
2780 {
2781     BlockBackend *blk;
2782     BlockDriverState *bs;
2783     BlockDriverState *target_bs;
2784     BlockDriverState *source = NULL;
2785     BdrvDirtyBitmap *bmap = NULL;
2786     AioContext *aio_context;
2787     QDict *options = NULL;
2788     Error *local_err = NULL;
2789     int flags;
2790     int64_t size;
2791     int ret;
2792
2793     if (!has_speed) {
2794         speed = 0;
2795     }
2796     if (!has_on_source_error) {
2797         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2798     }
2799     if (!has_on_target_error) {
2800         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2801     }
2802     if (!has_mode) {
2803         mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
2804     }
2805
2806     blk = blk_by_name(device);
2807     if (!blk) {
2808         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2809                   "Device '%s' not found", device);
2810         return;
2811     }
2812
2813     aio_context = blk_get_aio_context(blk);
2814     aio_context_acquire(aio_context);
2815
2816     /* Although backup_run has this check too, we need to use bs->drv below, so
2817      * do an early check redundantly. */
2818     if (!blk_is_available(blk)) {
2819         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2820         goto out;
2821     }
2822     bs = blk_bs(blk);
2823
2824     if (!has_format) {
2825         format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2826     }
2827
2828     /* Early check to avoid creating target */
2829     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2830         goto out;
2831     }
2832
2833     flags = bs->open_flags | BDRV_O_RDWR;
2834
2835     /* See if we have a backing HD we can use to create our new image
2836      * on top of. */
2837     if (sync == MIRROR_SYNC_MODE_TOP) {
2838         source = backing_bs(bs);
2839         if (!source) {
2840             sync = MIRROR_SYNC_MODE_FULL;
2841         }
2842     }
2843     if (sync == MIRROR_SYNC_MODE_NONE) {
2844         source = bs;
2845     }
2846
2847     size = bdrv_getlength(bs);
2848     if (size < 0) {
2849         error_setg_errno(errp, -size, "bdrv_getlength failed");
2850         goto out;
2851     }
2852
2853     if (mode != NEW_IMAGE_MODE_EXISTING) {
2854         assert(format);
2855         if (source) {
2856             bdrv_img_create(target, format, source->filename,
2857                             source->drv->format_name, NULL,
2858                             size, flags, &local_err, false);
2859         } else {
2860             bdrv_img_create(target, format, NULL, NULL, NULL,
2861                             size, flags, &local_err, false);
2862         }
2863     }
2864
2865     if (local_err) {
2866         error_propagate(errp, local_err);
2867         goto out;
2868     }
2869
2870     if (format) {
2871         options = qdict_new();
2872         qdict_put(options, "driver", qstring_from_str(format));
2873     }
2874
2875     target_bs = NULL;
2876     ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
2877     if (ret < 0) {
2878         error_propagate(errp, local_err);
2879         goto out;
2880     }
2881
2882     bdrv_set_aio_context(target_bs, aio_context);
2883
2884     if (has_bitmap) {
2885         bmap = bdrv_find_dirty_bitmap(bs, bitmap);
2886         if (!bmap) {
2887             error_setg(errp, "Bitmap '%s' could not be found", bitmap);
2888             goto out;
2889         }
2890     }
2891
2892     backup_start(bs, target_bs, speed, sync, bmap,
2893                  on_source_error, on_target_error,
2894                  block_job_cb, bs, &local_err);
2895     if (local_err != NULL) {
2896         bdrv_unref(target_bs);
2897         error_propagate(errp, local_err);
2898         goto out;
2899     }
2900
2901 out:
2902     aio_context_release(aio_context);
2903 }
2904
2905 BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
2906 {
2907     return bdrv_named_nodes_list(errp);
2908 }
2909
2910 void qmp_blockdev_backup(const char *device, const char *target,
2911                          enum MirrorSyncMode sync,
2912                          bool has_speed, int64_t speed,
2913                          bool has_on_source_error,
2914                          BlockdevOnError on_source_error,
2915                          bool has_on_target_error,
2916                          BlockdevOnError on_target_error,
2917                          Error **errp)
2918 {
2919     BlockBackend *blk, *target_blk;
2920     BlockDriverState *bs;
2921     BlockDriverState *target_bs;
2922     Error *local_err = NULL;
2923     AioContext *aio_context;
2924
2925     if (!has_speed) {
2926         speed = 0;
2927     }
2928     if (!has_on_source_error) {
2929         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2930     }
2931     if (!has_on_target_error) {
2932         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2933     }
2934
2935     blk = blk_by_name(device);
2936     if (!blk) {
2937         error_setg(errp, "Device '%s' not found", device);
2938         return;
2939     }
2940
2941     aio_context = blk_get_aio_context(blk);
2942     aio_context_acquire(aio_context);
2943
2944     if (!blk_is_available(blk)) {
2945         error_setg(errp, "Device '%s' has no medium", device);
2946         goto out;
2947     }
2948     bs = blk_bs(blk);
2949
2950     target_blk = blk_by_name(target);
2951     if (!target_blk) {
2952         error_setg(errp, "Device '%s' not found", target);
2953         goto out;
2954     }
2955
2956     if (!blk_is_available(target_blk)) {
2957         error_setg(errp, "Device '%s' has no medium", target);
2958         goto out;
2959     }
2960     target_bs = blk_bs(target_blk);
2961
2962     bdrv_ref(target_bs);
2963     bdrv_set_aio_context(target_bs, aio_context);
2964     backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
2965                  on_target_error, block_job_cb, bs, &local_err);
2966     if (local_err != NULL) {
2967         bdrv_unref(target_bs);
2968         error_propagate(errp, local_err);
2969     }
2970 out:
2971     aio_context_release(aio_context);
2972 }
2973
2974 void qmp_drive_mirror(const char *device, const char *target,
2975                       bool has_format, const char *format,
2976                       bool has_node_name, const char *node_name,
2977                       bool has_replaces, const char *replaces,
2978                       enum MirrorSyncMode sync,
2979                       bool has_mode, enum NewImageMode mode,
2980                       bool has_speed, int64_t speed,
2981                       bool has_granularity, uint32_t granularity,
2982                       bool has_buf_size, int64_t buf_size,
2983                       bool has_on_source_error, BlockdevOnError on_source_error,
2984                       bool has_on_target_error, BlockdevOnError on_target_error,
2985                       bool has_unmap, bool unmap,
2986                       Error **errp)
2987 {
2988     BlockBackend *blk;
2989     BlockDriverState *bs;
2990     BlockDriverState *source, *target_bs;
2991     AioContext *aio_context;
2992     Error *local_err = NULL;
2993     QDict *options;
2994     int flags;
2995     int64_t size;
2996     int ret;
2997
2998     if (!has_speed) {
2999         speed = 0;
3000     }
3001     if (!has_on_source_error) {
3002         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3003     }
3004     if (!has_on_target_error) {
3005         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3006     }
3007     if (!has_mode) {
3008         mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3009     }
3010     if (!has_granularity) {
3011         granularity = 0;
3012     }
3013     if (!has_buf_size) {
3014         buf_size = 0;
3015     }
3016     if (!has_unmap) {
3017         unmap = true;
3018     }
3019
3020     if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3021         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3022                    "a value in range [512B, 64MB]");
3023         return;
3024     }
3025     if (granularity & (granularity - 1)) {
3026         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
3027                    "power of 2");
3028         return;
3029     }
3030
3031     blk = blk_by_name(device);
3032     if (!blk) {
3033         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3034                   "Device '%s' not found", device);
3035         return;
3036     }
3037
3038     aio_context = blk_get_aio_context(blk);
3039     aio_context_acquire(aio_context);
3040
3041     if (!blk_is_available(blk)) {
3042         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3043         goto out;
3044     }
3045     bs = blk_bs(blk);
3046
3047     if (!has_format) {
3048         format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
3049     }
3050
3051     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
3052         goto out;
3053     }
3054
3055     flags = bs->open_flags | BDRV_O_RDWR;
3056     source = backing_bs(bs);
3057     if (!source && sync == MIRROR_SYNC_MODE_TOP) {
3058         sync = MIRROR_SYNC_MODE_FULL;
3059     }
3060     if (sync == MIRROR_SYNC_MODE_NONE) {
3061         source = bs;
3062     }
3063
3064     size = bdrv_getlength(bs);
3065     if (size < 0) {
3066         error_setg_errno(errp, -size, "bdrv_getlength failed");
3067         goto out;
3068     }
3069
3070     if (has_replaces) {
3071         BlockDriverState *to_replace_bs;
3072         AioContext *replace_aio_context;
3073         int64_t replace_size;
3074
3075         if (!has_node_name) {
3076             error_setg(errp, "a node-name must be provided when replacing a"
3077                              " named node of the graph");
3078             goto out;
3079         }
3080
3081         to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
3082
3083         if (!to_replace_bs) {
3084             error_propagate(errp, local_err);
3085             goto out;
3086         }
3087
3088         replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3089         aio_context_acquire(replace_aio_context);
3090         replace_size = bdrv_getlength(to_replace_bs);
3091         aio_context_release(replace_aio_context);
3092
3093         if (size != replace_size) {
3094             error_setg(errp, "cannot replace image with a mirror image of "
3095                              "different size");
3096             goto out;
3097         }
3098     }
3099
3100     if ((sync == MIRROR_SYNC_MODE_FULL || !source)
3101         && mode != NEW_IMAGE_MODE_EXISTING)
3102     {
3103         /* create new image w/o backing file */
3104         assert(format);
3105         bdrv_img_create(target, format,
3106                         NULL, NULL, NULL, size, flags, &local_err, false);
3107     } else {
3108         switch (mode) {
3109         case NEW_IMAGE_MODE_EXISTING:
3110             break;
3111         case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3112             /* create new image with backing file */
3113             bdrv_img_create(target, format,
3114                             source->filename,
3115                             source->drv->format_name,
3116                             NULL, size, flags, &local_err, false);
3117             break;
3118         default:
3119             abort();
3120         }
3121     }
3122
3123     if (local_err) {
3124         error_propagate(errp, local_err);
3125         goto out;
3126     }
3127
3128     options = qdict_new();
3129     if (has_node_name) {
3130         qdict_put(options, "node-name", qstring_from_str(node_name));
3131     }
3132     if (format) {
3133         qdict_put(options, "driver", qstring_from_str(format));
3134     }
3135
3136     /* Mirroring takes care of copy-on-write using the source's backing
3137      * file.
3138      */
3139     target_bs = NULL;
3140     ret = bdrv_open(&target_bs, target, NULL, options,
3141                     flags | BDRV_O_NO_BACKING, &local_err);
3142     if (ret < 0) {
3143         error_propagate(errp, local_err);
3144         goto out;
3145     }
3146
3147     bdrv_set_aio_context(target_bs, aio_context);
3148
3149     /* pass the node name to replace to mirror start since it's loose coupling
3150      * and will allow to check whether the node still exist at mirror completion
3151      */
3152     mirror_start(bs, target_bs,
3153                  has_replaces ? replaces : NULL,
3154                  speed, granularity, buf_size, sync,
3155                  on_source_error, on_target_error,
3156                  unmap,
3157                  block_job_cb, bs, &local_err);
3158     if (local_err != NULL) {
3159         bdrv_unref(target_bs);
3160         error_propagate(errp, local_err);
3161         goto out;
3162     }
3163
3164 out:
3165     aio_context_release(aio_context);
3166 }
3167
3168 /* Get the block job for a given device name and acquire its AioContext */
3169 static BlockJob *find_block_job(const char *device, AioContext **aio_context,
3170                                 Error **errp)
3171 {
3172     BlockBackend *blk;
3173     BlockDriverState *bs;
3174
3175     *aio_context = NULL;
3176
3177     blk = blk_by_name(device);
3178     if (!blk) {
3179         goto notfound;
3180     }
3181
3182     *aio_context = blk_get_aio_context(blk);
3183     aio_context_acquire(*aio_context);
3184
3185     if (!blk_is_available(blk)) {
3186         goto notfound;
3187     }
3188     bs = blk_bs(blk);
3189
3190     if (!bs->job) {
3191         goto notfound;
3192     }
3193
3194     return bs->job;
3195
3196 notfound:
3197     error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3198               "No active block job on device '%s'", device);
3199     if (*aio_context) {
3200         aio_context_release(*aio_context);
3201         *aio_context = NULL;
3202     }
3203     return NULL;
3204 }
3205
3206 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3207 {
3208     AioContext *aio_context;
3209     BlockJob *job = find_block_job(device, &aio_context, errp);
3210
3211     if (!job) {
3212         return;
3213     }
3214
3215     block_job_set_speed(job, speed, errp);
3216     aio_context_release(aio_context);
3217 }
3218
3219 void qmp_block_job_cancel(const char *device,
3220                           bool has_force, bool force, Error **errp)
3221 {
3222     AioContext *aio_context;
3223     BlockJob *job = find_block_job(device, &aio_context, errp);
3224
3225     if (!job) {
3226         return;
3227     }
3228
3229     if (!has_force) {
3230         force = false;
3231     }
3232
3233     if (job->user_paused && !force) {
3234         error_setg(errp, "The block job for device '%s' is currently paused",
3235                    device);
3236         goto out;
3237     }
3238
3239     trace_qmp_block_job_cancel(job);
3240     block_job_cancel(job);
3241 out:
3242     aio_context_release(aio_context);
3243 }
3244
3245 void qmp_block_job_pause(const char *device, Error **errp)
3246 {
3247     AioContext *aio_context;
3248     BlockJob *job = find_block_job(device, &aio_context, errp);
3249
3250     if (!job || job->user_paused) {
3251         return;
3252     }
3253
3254     job->user_paused = true;
3255     trace_qmp_block_job_pause(job);
3256     block_job_pause(job);
3257     aio_context_release(aio_context);
3258 }
3259
3260 void qmp_block_job_resume(const char *device, Error **errp)
3261 {
3262     AioContext *aio_context;
3263     BlockJob *job = find_block_job(device, &aio_context, errp);
3264
3265     if (!job || !job->user_paused) {
3266         return;
3267     }
3268
3269     job->user_paused = false;
3270     trace_qmp_block_job_resume(job);
3271     block_job_resume(job);
3272     aio_context_release(aio_context);
3273 }
3274
3275 void qmp_block_job_complete(const char *device, Error **errp)
3276 {
3277     AioContext *aio_context;
3278     BlockJob *job = find_block_job(device, &aio_context, errp);
3279
3280     if (!job) {
3281         return;
3282     }
3283
3284     trace_qmp_block_job_complete(job);
3285     block_job_complete(job, errp);
3286     aio_context_release(aio_context);
3287 }
3288
3289 void qmp_change_backing_file(const char *device,
3290                              const char *image_node_name,
3291                              const char *backing_file,
3292                              Error **errp)
3293 {
3294     BlockBackend *blk;
3295     BlockDriverState *bs = NULL;
3296     AioContext *aio_context;
3297     BlockDriverState *image_bs = NULL;
3298     Error *local_err = NULL;
3299     bool ro;
3300     int open_flags;
3301     int ret;
3302
3303     blk = blk_by_name(device);
3304     if (!blk) {
3305         error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
3306                   "Device '%s' not found", device);
3307         return;
3308     }
3309
3310     aio_context = blk_get_aio_context(blk);
3311     aio_context_acquire(aio_context);
3312
3313     if (!blk_is_available(blk)) {
3314         error_setg(errp, "Device '%s' has no medium", device);
3315         goto out;
3316     }
3317     bs = blk_bs(blk);
3318
3319     image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3320     if (local_err) {
3321         error_propagate(errp, local_err);
3322         goto out;
3323     }
3324
3325     if (!image_bs) {
3326         error_setg(errp, "image file not found");
3327         goto out;
3328     }
3329
3330     if (bdrv_find_base(image_bs) == image_bs) {
3331         error_setg(errp, "not allowing backing file change on an image "
3332                          "without a backing file");
3333         goto out;
3334     }
3335
3336     /* even though we are not necessarily operating on bs, we need it to
3337      * determine if block ops are currently prohibited on the chain */
3338     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3339         goto out;
3340     }
3341
3342     /* final sanity check */
3343     if (!bdrv_chain_contains(bs, image_bs)) {
3344         error_setg(errp, "'%s' and image file are not in the same chain",
3345                    device);
3346         goto out;
3347     }
3348
3349     /* if not r/w, reopen to make r/w */
3350     open_flags = image_bs->open_flags;
3351     ro = bdrv_is_read_only(image_bs);
3352
3353     if (ro) {
3354         bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
3355         if (local_err) {
3356             error_propagate(errp, local_err);
3357             goto out;
3358         }
3359     }
3360
3361     ret = bdrv_change_backing_file(image_bs, backing_file,
3362                                image_bs->drv ? image_bs->drv->format_name : "");
3363
3364     if (ret < 0) {
3365         error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3366                          backing_file);
3367         /* don't exit here, so we can try to restore open flags if
3368          * appropriate */
3369     }
3370
3371     if (ro) {
3372         bdrv_reopen(image_bs, open_flags, &local_err);
3373         if (local_err) {
3374             error_propagate(errp, local_err); /* will preserve prior errp */
3375         }
3376     }
3377
3378 out:
3379     aio_context_release(aio_context);
3380 }
3381
3382 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3383 {
3384     QmpOutputVisitor *ov = qmp_output_visitor_new();
3385     BlockDriverState *bs;
3386     BlockBackend *blk = NULL;
3387     QObject *obj;
3388     QDict *qdict;
3389     Error *local_err = NULL;
3390
3391     /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
3392      * cache.direct=false instead of silently switching to aio=threads, except
3393      * when called from drive_new().
3394      *
3395      * For now, simply forbidding the combination for all drivers will do. */
3396     if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3397         bool direct = options->has_cache &&
3398                       options->cache->has_direct &&
3399                       options->cache->direct;
3400         if (!direct) {
3401             error_setg(errp, "aio=native requires cache.direct=true");
3402             goto fail;
3403         }
3404     }
3405
3406     visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
3407                                &options, NULL, &local_err);
3408     if (local_err) {
3409         error_propagate(errp, local_err);
3410         goto fail;
3411     }
3412
3413     obj = qmp_output_get_qobject(ov);
3414     qdict = qobject_to_qdict(obj);
3415
3416     qdict_flatten(qdict);
3417
3418     if (options->has_id) {
3419         blk = blockdev_init(NULL, qdict, &local_err);
3420         if (local_err) {
3421             error_propagate(errp, local_err);
3422             goto fail;
3423         }
3424
3425         bs = blk_bs(blk);
3426     } else {
3427         if (!qdict_get_try_str(qdict, "node-name")) {
3428             error_setg(errp, "'id' and/or 'node-name' need to be specified for "
3429                        "the root node");
3430             goto fail;
3431         }
3432
3433         bs = bds_tree_init(qdict, errp);
3434         if (!bs) {
3435             goto fail;
3436         }
3437     }
3438
3439     if (bs && bdrv_key_required(bs)) {
3440         if (blk) {
3441             blk_unref(blk);
3442         } else {
3443             bdrv_unref(bs);
3444         }
3445         error_setg(errp, "blockdev-add doesn't support encrypted devices");
3446         goto fail;
3447     }
3448
3449 fail:
3450     qmp_output_visitor_cleanup(ov);
3451 }
3452
3453 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3454 {
3455     BlockJobInfoList *head = NULL, **p_next = &head;
3456     BlockDriverState *bs;
3457
3458     for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
3459         AioContext *aio_context = bdrv_get_aio_context(bs);
3460
3461         aio_context_acquire(aio_context);
3462
3463         if (bs->job) {
3464             BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
3465             elem->value = block_job_query(bs->job);
3466             *p_next = elem;
3467             p_next = &elem->next;
3468         }
3469
3470         aio_context_release(aio_context);
3471     }
3472
3473     return head;
3474 }
3475
3476 QemuOptsList qemu_common_drive_opts = {
3477     .name = "drive",
3478     .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3479     .desc = {
3480         {
3481             .name = "snapshot",
3482             .type = QEMU_OPT_BOOL,
3483             .help = "enable/disable snapshot mode",
3484         },{
3485             .name = "discard",
3486             .type = QEMU_OPT_STRING,
3487             .help = "discard operation (ignore/off, unmap/on)",
3488         },{
3489             .name = BDRV_OPT_CACHE_WB,
3490             .type = QEMU_OPT_BOOL,
3491             .help = "enables writeback mode for any caches",
3492         },{
3493             .name = BDRV_OPT_CACHE_DIRECT,
3494             .type = QEMU_OPT_BOOL,
3495             .help = "enables use of O_DIRECT (bypass the host page cache)",
3496         },{
3497             .name = BDRV_OPT_CACHE_NO_FLUSH,
3498             .type = QEMU_OPT_BOOL,
3499             .help = "ignore any flush requests for the device",
3500         },{
3501             .name = "aio",
3502             .type = QEMU_OPT_STRING,
3503             .help = "host AIO implementation (threads, native)",
3504         },{
3505             .name = "format",
3506             .type = QEMU_OPT_STRING,
3507             .help = "disk format (raw, qcow2, ...)",
3508         },{
3509             .name = "rerror",
3510             .type = QEMU_OPT_STRING,
3511             .help = "read error action",
3512         },{
3513             .name = "werror",
3514             .type = QEMU_OPT_STRING,
3515             .help = "write error action",
3516         },{
3517             .name = "read-only",
3518             .type = QEMU_OPT_BOOL,
3519             .help = "open drive file as read-only",
3520         },{
3521             .name = "throttling.iops-total",
3522             .type = QEMU_OPT_NUMBER,
3523             .help = "limit total I/O operations per second",
3524         },{
3525             .name = "throttling.iops-read",
3526             .type = QEMU_OPT_NUMBER,
3527             .help = "limit read operations per second",
3528         },{
3529             .name = "throttling.iops-write",
3530             .type = QEMU_OPT_NUMBER,
3531             .help = "limit write operations per second",
3532         },{
3533             .name = "throttling.bps-total",
3534             .type = QEMU_OPT_NUMBER,
3535             .help = "limit total bytes per second",
3536         },{
3537             .name = "throttling.bps-read",
3538             .type = QEMU_OPT_NUMBER,
3539             .help = "limit read bytes per second",
3540         },{
3541             .name = "throttling.bps-write",
3542             .type = QEMU_OPT_NUMBER,
3543             .help = "limit write bytes per second",
3544         },{
3545             .name = "throttling.iops-total-max",
3546             .type = QEMU_OPT_NUMBER,
3547             .help = "I/O operations burst",
3548         },{
3549             .name = "throttling.iops-read-max",
3550             .type = QEMU_OPT_NUMBER,
3551             .help = "I/O operations read burst",
3552         },{
3553             .name = "throttling.iops-write-max",
3554             .type = QEMU_OPT_NUMBER,
3555             .help = "I/O operations write burst",
3556         },{
3557             .name = "throttling.bps-total-max",
3558             .type = QEMU_OPT_NUMBER,
3559             .help = "total bytes burst",
3560         },{
3561             .name = "throttling.bps-read-max",
3562             .type = QEMU_OPT_NUMBER,
3563             .help = "total bytes read burst",
3564         },{
3565             .name = "throttling.bps-write-max",
3566             .type = QEMU_OPT_NUMBER,
3567             .help = "total bytes write burst",
3568         },{
3569             .name = "throttling.iops-size",
3570             .type = QEMU_OPT_NUMBER,
3571             .help = "when limiting by iops max size of an I/O in bytes",
3572         },{
3573             .name = "throttling.group",
3574             .type = QEMU_OPT_STRING,
3575             .help = "name of the block throttling group",
3576         },{
3577             .name = "copy-on-read",
3578             .type = QEMU_OPT_BOOL,
3579             .help = "copy read data from backing file into image file",
3580         },{
3581             .name = "detect-zeroes",
3582             .type = QEMU_OPT_STRING,
3583             .help = "try to optimize zero writes (off, on, unmap)",
3584         },
3585         { /* end of list */ }
3586     },
3587 };
3588
3589 static QemuOptsList qemu_root_bds_opts = {
3590     .name = "root-bds",
3591     .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3592     .desc = {
3593         {
3594             .name = "discard",
3595             .type = QEMU_OPT_STRING,
3596             .help = "discard operation (ignore/off, unmap/on)",
3597         },{
3598             .name = "cache.writeback",
3599             .type = QEMU_OPT_BOOL,
3600             .help = "enables writeback mode for any caches",
3601         },{
3602             .name = "cache.direct",
3603             .type = QEMU_OPT_BOOL,
3604             .help = "enables use of O_DIRECT (bypass the host page cache)",
3605         },{
3606             .name = "cache.no-flush",
3607             .type = QEMU_OPT_BOOL,
3608             .help = "ignore any flush requests for the device",
3609         },{
3610             .name = "aio",
3611             .type = QEMU_OPT_STRING,
3612             .help = "host AIO implementation (threads, native)",
3613         },{
3614             .name = "read-only",
3615             .type = QEMU_OPT_BOOL,
3616             .help = "open drive file as read-only",
3617         },{
3618             .name = "copy-on-read",
3619             .type = QEMU_OPT_BOOL,
3620             .help = "copy read data from backing file into image file",
3621         },{
3622             .name = "detect-zeroes",
3623             .type = QEMU_OPT_STRING,
3624             .help = "try to optimize zero writes (off, on, unmap)",
3625         },
3626         { /* end of list */ }
3627     },
3628 };
3629
3630 QemuOptsList qemu_drive_opts = {
3631     .name = "drive",
3632     .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3633     .desc = {
3634         /*
3635          * no elements => accept any params
3636          * validation will happen later
3637          */
3638         { /* end of list */ }
3639     },
3640 };