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/blockdev.h"
  34 #include "hw/block/block.h"
  35 #include "block/blockjob.h"
  36 #include "monitor/monitor.h"
  37 #include "qapi/qmp/qerror.h"
  38 #include "qemu/option.h"
  39 #include "qemu/config-file.h"
  40 #include "qapi/qmp/types.h"
  41 #include "qapi-visit.h"
  42 #include "qapi/qmp-output-visitor.h"
  43 #include "sysemu/sysemu.h"
  44 #include "block/block_int.h"
  45 #include "qmp-commands.h"
  46 #include "trace.h"
  47 #include "sysemu/arch_init.h"
  48
  49 static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
  50
  51 static const char *const if_name[IF_COUNT] = {
  52     [IF_NONE] = "none",
  53     [IF_IDE] = "ide",
  54     [IF_SCSI] = "scsi",
  55     [IF_FLOPPY] = "floppy",
  56     [IF_PFLASH] = "pflash",
  57     [IF_MTD] = "mtd",
  58     [IF_SD] = "sd",
  59     [IF_VIRTIO] = "virtio",
  60     [IF_XEN] = "xen",
  61 };
  62
  63 static const int if_max_devs[IF_COUNT] = {
  64     /*
  65      * Do not change these numbers!  They govern how drive option
  66      * index maps to unit and bus.  That mapping is ABI.
  67      *
  68      * All controllers used to imlement if=T drives need to support
  69      * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
  70      * Otherwise, some index values map to "impossible" bus, unit
  71      * values.
  72      *
  73      * For instance, if you change [IF_SCSI] to 255, -drive
  74      * if=scsi,index=12 no longer means bus=1,unit=5, but
  75      * bus=0,unit=12.  With an lsi53c895a controller (7 units max),
  76      * the drive can't be set up.  Regression.
  77      */
  78     [IF_IDE] = 2,
  79     [IF_SCSI] = 7,
  80 };
  81
  82 /*
  83  * We automatically delete the drive when a device using it gets
  84  * unplugged.  Questionable feature, but we can't just drop it.
  85  * Device models call blockdev_mark_auto_del() to schedule the
  86  * automatic deletion, and generic qdev code calls blockdev_auto_del()
  87  * when deletion is actually safe.
  88  */
  89 void blockdev_mark_auto_del(BlockDriverState *bs)
  90 {
  91     DriveInfo *dinfo = drive_get_by_blockdev(bs);
  92
  93     if (dinfo && !dinfo->enable_auto_del) {
  94         return;
  95     }
  96
  97     if (bs->job) {
  98         block_job_cancel(bs->job);
  99     }
 100     if (dinfo) {
 101         dinfo->auto_del = 1;
 102     }
 103 }
 104
 105 void blockdev_auto_del(BlockDriverState *bs)
 106 {
 107     DriveInfo *dinfo = drive_get_by_blockdev(bs);
 108
 109     if (dinfo && dinfo->auto_del) {
 110         drive_put_ref(dinfo);
 111     }
 112 }
 113
 114 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
 115 {
 116     int max_devs = if_max_devs[type];
 117     return max_devs ? index / max_devs : 0;
 118 }
 119
 120 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
 121 {
 122     int max_devs = if_max_devs[type];
 123     return max_devs ? index % max_devs : index;
 124 }
 125
 126 QemuOpts *drive_def(const char *optstr)
 127 {
 128     return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
 129 }
 130
 131 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
 132                     const char *optstr)
 133 {
 134     QemuOpts *opts;
 135     char buf[32];
 136
 137     opts = drive_def(optstr);
 138     if (!opts) {
 139         return NULL;
 140     }
 141     if (type != IF_DEFAULT) {
 142         qemu_opt_set(opts, "if", if_name[type]);
 143     }
 144     if (index >= 0) {
 145         snprintf(buf, sizeof(buf), "%d", index);
 146         qemu_opt_set(opts, "index", buf);
 147     }
 148     if (file)
 149         qemu_opt_set(opts, "file", file);
 150     return opts;
 151 }
 152
 153 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
 154 {
 155     DriveInfo *dinfo;
 156
 157     /* seek interface, bus and unit */
 158
 159     QTAILQ_FOREACH(dinfo, &drives, next) {
 160         if (dinfo->type == type &&
 161             dinfo->bus == bus &&
 162             dinfo->unit == unit)
 163             return dinfo;
 164     }
 165
 166     return NULL;
 167 }
 168
 169 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
 170 {
 171     return drive_get(type,
 172                      drive_index_to_bus_id(type, index),
 173                      drive_index_to_unit_id(type, index));
 174 }
 175
 176 int drive_get_max_bus(BlockInterfaceType type)
 177 {
 178     int max_bus;
 179     DriveInfo *dinfo;
 180
 181     max_bus = -1;
 182     QTAILQ_FOREACH(dinfo, &drives, next) {
 183         if(dinfo->type == type &&
 184            dinfo->bus > max_bus)
 185             max_bus = dinfo->bus;
 186     }
 187     return max_bus;
 188 }
 189
 190 /* Get a block device.  This should only be used for single-drive devices
 191    (e.g. SD/Floppy/MTD).  Multi-disk devices (scsi/ide) should use the
 192    appropriate bus.  */
 193 DriveInfo *drive_get_next(BlockInterfaceType type)
 194 {
 195     static int next_block_unit[IF_COUNT];
 196
 197     return drive_get(type, 0, next_block_unit[type]++);
 198 }
 199
 200 DriveInfo *drive_get_by_blockdev(BlockDriverState *bs)
 201 {
 202     DriveInfo *dinfo;
 203
 204     QTAILQ_FOREACH(dinfo, &drives, next) {
 205         if (dinfo->bdrv == bs) {
 206             return dinfo;
 207         }
 208     }
 209     return NULL;
 210 }
 211
 212 static void bdrv_format_print(void *opaque, const char *name)
 213 {
 214     error_printf(" %s", name);
 215 }
 216
 217 static void drive_uninit(DriveInfo *dinfo)
 218 {
 219     if (dinfo->opts) {
 220         qemu_opts_del(dinfo->opts);
 221     }
 222
 223     bdrv_unref(dinfo->bdrv);
 224     g_free(dinfo->id);
 225     QTAILQ_REMOVE(&drives, dinfo, next);
 226     g_free(dinfo->serial);
 227     g_free(dinfo);
 228 }
 229
 230 void drive_put_ref(DriveInfo *dinfo)
 231 {
 232     assert(dinfo->refcount);
 233     if (--dinfo->refcount == 0) {
 234         drive_uninit(dinfo);
 235     }
 236 }
 237
 238 void drive_get_ref(DriveInfo *dinfo)
 239 {
 240     dinfo->refcount++;
 241 }
 242
 243 typedef struct {
 244     QEMUBH *bh;
 245     BlockDriverState *bs;
 246 } BDRVPutRefBH;
 247
 248 static void bdrv_put_ref_bh(void *opaque)
 249 {
 250     BDRVPutRefBH *s = opaque;
 251
 252     bdrv_unref(s->bs);
 253     qemu_bh_delete(s->bh);
 254     g_free(s);
 255 }
 256
 257 /*
 258  * Release a BDS reference in a BH
 259  *
 260  * It is not safe to use bdrv_unref() from a callback function when the callers
 261  * still need the BlockDriverState.  In such cases we schedule a BH to release
 262  * the reference.
 263  */
 264 static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
 265 {
 266     BDRVPutRefBH *s;
 267
 268     s = g_new(BDRVPutRefBH, 1);
 269     s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
 270     s->bs = bs;
 271     qemu_bh_schedule(s->bh);
 272 }
 273
 274 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
 275 {
 276     if (!strcmp(buf, "ignore")) {
 277         return BLOCKDEV_ON_ERROR_IGNORE;
 278     } else if (!is_read && !strcmp(buf, "enospc")) {
 279         return BLOCKDEV_ON_ERROR_ENOSPC;
 280     } else if (!strcmp(buf, "stop")) {
 281         return BLOCKDEV_ON_ERROR_STOP;
 282     } else if (!strcmp(buf, "report")) {
 283         return BLOCKDEV_ON_ERROR_REPORT;
 284     } else {
 285         error_setg(errp, "'%s' invalid %s error action",
 286                    buf, is_read ? "read" : "write");
 287         return -1;
 288     }
 289 }
 290
 291 static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
 292 {
 293     if (throttle_conflicting(cfg)) {
 294         error_setg(errp, "bps/iops/max total values and read/write values"
 295                          " cannot be used at the same time");
 296         return false;
 297     }
 298
 299     if (!throttle_is_valid(cfg)) {
 300         error_setg(errp, "bps/iops/maxs values must be 0 or greater");
 301         return false;
 302     }
 303
 304     return true;
 305 }
 306
 307 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
 308
 309 /* Takes the ownership of bs_opts */
 310 static DriveInfo *blockdev_init(QDict *bs_opts,
 311                                 BlockInterfaceType type,
 312                                 Error **errp)
 313 {
 314     const char *buf;
 315     const char *file = NULL;
 316     const char *serial;
 317     int ro = 0;
 318     int bdrv_flags = 0;
 319     int on_read_error, on_write_error;
 320     DriveInfo *dinfo;
 321     ThrottleConfig cfg;
 322     int snapshot = 0;
 323     bool copy_on_read;
 324     int ret;
 325     Error *error = NULL;
 326     QemuOpts *opts;
 327     const char *id;
 328     bool has_driver_specific_opts;
 329     BlockDriver *drv = NULL;
 330
 331     /* Check common options by copying from bs_opts to opts, all other options
 332      * stay in bs_opts for processing by bdrv_open(). */
 333     id = qdict_get_try_str(bs_opts, "id");
 334     opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
 335     if (error_is_set(&error)) {
 336         error_propagate(errp, error);
 337         goto err_no_opts;
 338     }
 339
 340     qemu_opts_absorb_qdict(opts, bs_opts, &error);
 341     if (error_is_set(&error)) {
 342         error_propagate(errp, error);
 343         goto early_err;
 344     }
 345
 346     if (id) {
 347         qdict_del(bs_opts, "id");
 348     }
 349
 350     has_driver_specific_opts = !!qdict_size(bs_opts);
 351
 352     /* extract parameters */
 353     snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
 354     ro = qemu_opt_get_bool(opts, "read-only", 0);
 355     copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
 356
 357     file = qemu_opt_get(opts, "file");
 358     serial = qemu_opt_get(opts, "serial");
 359
 360     if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
 361         if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
 362             error_setg(errp, "invalid discard option");
 363             goto early_err;
 364         }
 365     }
 366
 367     if (qemu_opt_get_bool(opts, "cache.writeback", true)) {
 368         bdrv_flags |= BDRV_O_CACHE_WB;
 369     }
 370     if (qemu_opt_get_bool(opts, "cache.direct", false)) {
 371         bdrv_flags |= BDRV_O_NOCACHE;
 372     }
 373     if (qemu_opt_get_bool(opts, "cache.no-flush", false)) {
 374         bdrv_flags |= BDRV_O_NO_FLUSH;
 375     }
 376
 377 #ifdef CONFIG_LINUX_AIO
 378     if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
 379         if (!strcmp(buf, "native")) {
 380             bdrv_flags |= BDRV_O_NATIVE_AIO;
 381         } else if (!strcmp(buf, "threads")) {
 382             /* this is the default */
 383         } else {
 384            error_setg(errp, "invalid aio option");
 385            goto early_err;
 386         }
 387     }
 388 #endif
 389
 390     if ((buf = qemu_opt_get(opts, "format")) != NULL) {
 391         if (is_help_option(buf)) {
 392             error_printf("Supported formats:");
 393             bdrv_iterate_format(bdrv_format_print, NULL);
 394             error_printf("\n");
 395             goto early_err;
 396         }
 397
 398         drv = bdrv_find_format(buf);
 399         if (!drv) {
 400             error_setg(errp, "'%s' invalid format", buf);
 401             goto early_err;
 402         }
 403     }
 404
 405     /* disk I/O throttling */
 406     memset(&cfg, 0, sizeof(cfg));
 407     cfg.buckets[THROTTLE_BPS_TOTAL].avg =
 408         qemu_opt_get_number(opts, "throttling.bps-total", 0);
 409     cfg.buckets[THROTTLE_BPS_READ].avg  =
 410         qemu_opt_get_number(opts, "throttling.bps-read", 0);
 411     cfg.buckets[THROTTLE_BPS_WRITE].avg =
 412         qemu_opt_get_number(opts, "throttling.bps-write", 0);
 413     cfg.buckets[THROTTLE_OPS_TOTAL].avg =
 414         qemu_opt_get_number(opts, "throttling.iops-total", 0);
 415     cfg.buckets[THROTTLE_OPS_READ].avg =
 416         qemu_opt_get_number(opts, "throttling.iops-read", 0);
 417     cfg.buckets[THROTTLE_OPS_WRITE].avg =
 418         qemu_opt_get_number(opts, "throttling.iops-write", 0);
 419
 420     cfg.buckets[THROTTLE_BPS_TOTAL].max =
 421         qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
 422     cfg.buckets[THROTTLE_BPS_READ].max  =
 423         qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
 424     cfg.buckets[THROTTLE_BPS_WRITE].max =
 425         qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
 426     cfg.buckets[THROTTLE_OPS_TOTAL].max =
 427         qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
 428     cfg.buckets[THROTTLE_OPS_READ].max =
 429         qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
 430     cfg.buckets[THROTTLE_OPS_WRITE].max =
 431         qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
 432
 433     cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
 434
 435     if (!check_throttle_config(&cfg, &error)) {
 436         error_propagate(errp, error);
 437         goto early_err;
 438     }
 439
 440     on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
 441     if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
 442         if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO && type != IF_NONE) {
 443             error_setg(errp, "werror is not supported by this bus type");
 444             goto early_err;
 445         }
 446
 447         on_write_error = parse_block_error_action(buf, 0, &error);
 448         if (error_is_set(&error)) {
 449             error_propagate(errp, error);
 450             goto early_err;
 451         }
 452     }
 453
 454     on_read_error = BLOCKDEV_ON_ERROR_REPORT;
 455     if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
 456         if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI && type != IF_NONE) {
 457             error_report("rerror is not supported by this bus type");
 458             goto early_err;
 459         }
 460
 461         on_read_error = parse_block_error_action(buf, 1, &error);
 462         if (error_is_set(&error)) {
 463             error_propagate(errp, error);
 464             goto early_err;
 465         }
 466     }
 467
 468     /* init */
 469     dinfo = g_malloc0(sizeof(*dinfo));
 470     dinfo->id = g_strdup(qemu_opts_id(opts));
 471     dinfo->bdrv = bdrv_new(dinfo->id);
 472     dinfo->bdrv->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
 473     dinfo->bdrv->read_only = ro;
 474     dinfo->type = type;
 475     dinfo->refcount = 1;
 476     if (serial != NULL) {
 477         dinfo->serial = g_strdup(serial);
 478     }
 479     QTAILQ_INSERT_TAIL(&drives, dinfo, next);
 480
 481     bdrv_set_on_error(dinfo->bdrv, on_read_error, on_write_error);
 482
 483     /* disk I/O throttling */
 484     if (throttle_enabled(&cfg)) {
 485         bdrv_io_limits_enable(dinfo->bdrv);
 486         bdrv_set_io_limits(dinfo->bdrv, &cfg);
 487     }
 488
 489     if (!file || !*file) {
 490         if (has_driver_specific_opts) {
 491             file = NULL;
 492         } else {
 493             QDECREF(bs_opts);
 494             qemu_opts_del(opts);
 495             return dinfo;
 496         }
 497     }
 498     if (snapshot) {
 499         /* always use cache=unsafe with snapshot */
 500         bdrv_flags &= ~BDRV_O_CACHE_MASK;
 501         bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
 502     }
 503
 504     if (copy_on_read) {
 505         bdrv_flags |= BDRV_O_COPY_ON_READ;
 506     }
 507
 508     if (runstate_check(RUN_STATE_INMIGRATE)) {
 509         bdrv_flags |= BDRV_O_INCOMING;
 510     }
 511
 512     bdrv_flags |= ro ? 0 : BDRV_O_RDWR;
 513
 514     QINCREF(bs_opts);
 515     ret = bdrv_open(dinfo->bdrv, file, bs_opts, bdrv_flags, drv, &error);
 516
 517     if (ret < 0) {
 518         error_setg(errp, "could not open disk image %s: %s",
 519                    file ?: dinfo->id, error_get_pretty(error));
 520         error_free(error);
 521         goto err;
 522     }
 523
 524     if (bdrv_key_required(dinfo->bdrv))
 525         autostart = 0;
 526
 527     QDECREF(bs_opts);
 528     qemu_opts_del(opts);
 529
 530     return dinfo;
 531
 532 err:
 533     bdrv_unref(dinfo->bdrv);
 534     g_free(dinfo->id);
 535     QTAILQ_REMOVE(&drives, dinfo, next);
 536     g_free(dinfo);
 537 early_err:
 538     qemu_opts_del(opts);
 539 err_no_opts:
 540     QDECREF(bs_opts);
 541     return NULL;
 542 }
 543
 544 static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to)
 545 {
 546     const char *value;
 547
 548     value = qemu_opt_get(opts, from);
 549     if (value) {
 550         qemu_opt_set(opts, to, value);
 551         qemu_opt_unset(opts, from);
 552     }
 553 }
 554
 555 QemuOptsList qemu_legacy_drive_opts = {
 556     .name = "drive",
 557     .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
 558     .desc = {
 559         {
 560             .name = "bus",
 561             .type = QEMU_OPT_NUMBER,
 562             .help = "bus number",
 563         },{
 564             .name = "unit",
 565             .type = QEMU_OPT_NUMBER,
 566             .help = "unit number (i.e. lun for scsi)",
 567         },{
 568             .name = "index",
 569             .type = QEMU_OPT_NUMBER,
 570             .help = "index number",
 571         },{
 572             .name = "media",
 573             .type = QEMU_OPT_STRING,
 574             .help = "media type (disk, cdrom)",
 575         },{
 576             .name = "if",
 577             .type = QEMU_OPT_STRING,
 578             .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
 579         },{
 580             .name = "cyls",
 581             .type = QEMU_OPT_NUMBER,
 582             .help = "number of cylinders (ide disk geometry)",
 583         },{
 584             .name = "heads",
 585             .type = QEMU_OPT_NUMBER,
 586             .help = "number of heads (ide disk geometry)",
 587         },{
 588             .name = "secs",
 589             .type = QEMU_OPT_NUMBER,
 590             .help = "number of sectors (ide disk geometry)",
 591         },{
 592             .name = "trans",
 593             .type = QEMU_OPT_STRING,
 594             .help = "chs translation (auto, lba, none)",
 595         },{
 596             .name = "boot",
 597             .type = QEMU_OPT_BOOL,
 598             .help = "(deprecated, ignored)",
 599         },{
 600             .name = "addr",
 601             .type = QEMU_OPT_STRING,
 602             .help = "pci address (virtio only)",
 603         },
 604
 605         /* Options that are passed on, but have special semantics with -drive */
 606         {
 607             .name = "read-only",
 608             .type = QEMU_OPT_BOOL,
 609             .help = "open drive file as read-only",
 610         },{
 611             .name = "copy-on-read",
 612             .type = QEMU_OPT_BOOL,
 613             .help = "copy read data from backing file into image file",
 614         },
 615
 616         { /* end of list */ }
 617     },
 618 };
 619
 620 DriveInfo *drive_init(QemuOpts *all_opts, BlockInterfaceType block_default_type)
 621 {
 622     const char *value;
 623     DriveInfo *dinfo = NULL;
 624     QDict *bs_opts;
 625     QemuOpts *legacy_opts;
 626     DriveMediaType media = MEDIA_DISK;
 627     BlockInterfaceType type;
 628     int cyls, heads, secs, translation;
 629     int max_devs, bus_id, unit_id, index;
 630     const char *devaddr;
 631     bool read_only = false;
 632     bool copy_on_read;
 633     Error *local_err = NULL;
 634
 635     /* Change legacy command line options into QMP ones */
 636     qemu_opt_rename(all_opts, "iops", "throttling.iops-total");
 637     qemu_opt_rename(all_opts, "iops_rd", "throttling.iops-read");
 638     qemu_opt_rename(all_opts, "iops_wr", "throttling.iops-write");
 639
 640     qemu_opt_rename(all_opts, "bps", "throttling.bps-total");
 641     qemu_opt_rename(all_opts, "bps_rd", "throttling.bps-read");
 642     qemu_opt_rename(all_opts, "bps_wr", "throttling.bps-write");
 643
 644     qemu_opt_rename(all_opts, "iops_max", "throttling.iops-total-max");
 645     qemu_opt_rename(all_opts, "iops_rd_max", "throttling.iops-read-max");
 646     qemu_opt_rename(all_opts, "iops_wr_max", "throttling.iops-write-max");
 647
 648     qemu_opt_rename(all_opts, "bps_max", "throttling.bps-total-max");
 649     qemu_opt_rename(all_opts, "bps_rd_max", "throttling.bps-read-max");
 650     qemu_opt_rename(all_opts, "bps_wr_max", "throttling.bps-write-max");
 651
 652     qemu_opt_rename(all_opts,
 653                     "iops_size", "throttling.iops-size");
 654
 655     qemu_opt_rename(all_opts, "readonly", "read-only");
 656
 657     value = qemu_opt_get(all_opts, "cache");
 658     if (value) {
 659         int flags = 0;
 660
 661         if (bdrv_parse_cache_flags(value, &flags) != 0) {
 662             error_report("invalid cache option");
 663             return NULL;
 664         }
 665
 666         /* Specific options take precedence */
 667         if (!qemu_opt_get(all_opts, "cache.writeback")) {
 668             qemu_opt_set_bool(all_opts, "cache.writeback",
 669                               !!(flags & BDRV_O_CACHE_WB));
 670         }
 671         if (!qemu_opt_get(all_opts, "cache.direct")) {
 672             qemu_opt_set_bool(all_opts, "cache.direct",
 673                               !!(flags & BDRV_O_NOCACHE));
 674         }
 675         if (!qemu_opt_get(all_opts, "cache.no-flush")) {
 676             qemu_opt_set_bool(all_opts, "cache.no-flush",
 677                               !!(flags & BDRV_O_NO_FLUSH));
 678         }
 679         qemu_opt_unset(all_opts, "cache");
 680     }
 681
 682     /* Get a QDict for processing the options */
 683     bs_opts = qdict_new();
 684     qemu_opts_to_qdict(all_opts, bs_opts);
 685
 686     legacy_opts = qemu_opts_create_nofail(&qemu_legacy_drive_opts);
 687     qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
 688     if (error_is_set(&local_err)) {
 689         qerror_report_err(local_err);
 690         error_free(local_err);
 691         goto fail;
 692     }
 693
 694     /* Deprecated option boot=[on|off] */
 695     if (qemu_opt_get(legacy_opts, "boot") != NULL) {
 696         fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
 697                 "ignored. Future versions will reject this parameter. Please "
 698                 "update your scripts.\n");
 699     }
 700
 701     /* Media type */
 702     value = qemu_opt_get(legacy_opts, "media");
 703     if (value) {
 704         if (!strcmp(value, "disk")) {
 705             media = MEDIA_DISK;
 706         } else if (!strcmp(value, "cdrom")) {
 707             media = MEDIA_CDROM;
 708             read_only = true;
 709         } else {
 710             error_report("'%s' invalid media", value);
 711             goto fail;
 712         }
 713     }
 714
 715     /* copy-on-read is disabled with a warning for read-only devices */
 716     read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
 717     copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
 718
 719     if (read_only && copy_on_read) {
 720         error_report("warning: disabling copy-on-read on read-only drive");
 721         copy_on_read = false;
 722     }
 723
 724     qdict_put(bs_opts, "read-only",
 725               qstring_from_str(read_only ? "on" : "off"));
 726     qdict_put(bs_opts, "copy-on-read",
 727               qstring_from_str(copy_on_read ? "on" :"off"));
 728
 729     /* Controller type */
 730     value = qemu_opt_get(legacy_opts, "if");
 731     if (value) {
 732         for (type = 0;
 733              type < IF_COUNT && strcmp(value, if_name[type]);
 734              type++) {
 735         }
 736         if (type == IF_COUNT) {
 737             error_report("unsupported bus type '%s'", value);
 738             goto fail;
 739         }
 740     } else {
 741         type = block_default_type;
 742     }
 743
 744     /* Geometry */
 745     cyls  = qemu_opt_get_number(legacy_opts, "cyls", 0);
 746     heads = qemu_opt_get_number(legacy_opts, "heads", 0);
 747     secs  = qemu_opt_get_number(legacy_opts, "secs", 0);
 748
 749     if (cyls || heads || secs) {
 750         if (cyls < 1) {
 751             error_report("invalid physical cyls number");
 752             goto fail;
 753         }
 754         if (heads < 1) {
 755             error_report("invalid physical heads number");
 756             goto fail;
 757         }
 758         if (secs < 1) {
 759             error_report("invalid physical secs number");
 760             goto fail;
 761         }
 762     }
 763
 764     translation = BIOS_ATA_TRANSLATION_AUTO;
 765     value = qemu_opt_get(legacy_opts, "trans");
 766     if (value != NULL) {
 767         if (!cyls) {
 768             error_report("'%s' trans must be used with cyls, heads and secs",
 769                          value);
 770             goto fail;
 771         }
 772         if (!strcmp(value, "none")) {
 773             translation = BIOS_ATA_TRANSLATION_NONE;
 774         } else if (!strcmp(value, "lba")) {
 775             translation = BIOS_ATA_TRANSLATION_LBA;
 776         } else if (!strcmp(value, "auto")) {
 777             translation = BIOS_ATA_TRANSLATION_AUTO;
 778         } else {
 779             error_report("'%s' invalid translation type", value);
 780             goto fail;
 781         }
 782     }
 783
 784     if (media == MEDIA_CDROM) {
 785         if (cyls || secs || heads) {
 786             error_report("CHS can't be set with media=cdrom");
 787             goto fail;
 788         }
 789     }
 790
 791     /* Device address specified by bus/unit or index.
 792      * If none was specified, try to find the first free one. */
 793     bus_id  = qemu_opt_get_number(legacy_opts, "bus", 0);
 794     unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
 795     index   = qemu_opt_get_number(legacy_opts, "index", -1);
 796
 797     max_devs = if_max_devs[type];
 798
 799     if (index != -1) {
 800         if (bus_id != 0 || unit_id != -1) {
 801             error_report("index cannot be used with bus and unit");
 802             goto fail;
 803         }
 804         bus_id = drive_index_to_bus_id(type, index);
 805         unit_id = drive_index_to_unit_id(type, index);
 806     }
 807
 808     if (unit_id == -1) {
 809        unit_id = 0;
 810        while (drive_get(type, bus_id, unit_id) != NULL) {
 811            unit_id++;
 812            if (max_devs && unit_id >= max_devs) {
 813                unit_id -= max_devs;
 814                bus_id++;
 815            }
 816        }
 817     }
 818
 819     if (max_devs && unit_id >= max_devs) {
 820         error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
 821         goto fail;
 822     }
 823
 824     if (drive_get(type, bus_id, unit_id) != NULL) {
 825         error_report("drive with bus=%d, unit=%d (index=%d) exists",
 826                      bus_id, unit_id, index);
 827         goto fail;
 828     }
 829
 830     /* no id supplied -> create one */
 831     if (qemu_opts_id(all_opts) == NULL) {
 832         char *new_id;
 833         const char *mediastr = "";
 834         if (type == IF_IDE || type == IF_SCSI) {
 835             mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
 836         }
 837         if (max_devs) {
 838             new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
 839                                      mediastr, unit_id);
 840         } else {
 841             new_id = g_strdup_printf("%s%s%i", if_name[type],
 842                                      mediastr, unit_id);
 843         }
 844         qdict_put(bs_opts, "id", qstring_from_str(new_id));
 845         g_free(new_id);
 846     }
 847
 848     /* Add virtio block device */
 849     devaddr = qemu_opt_get(legacy_opts, "addr");
 850     if (devaddr && type != IF_VIRTIO) {
 851         error_report("addr is not supported by this bus type");
 852         goto fail;
 853     }
 854
 855     if (type == IF_VIRTIO) {
 856         QemuOpts *devopts;
 857         devopts = qemu_opts_create_nofail(qemu_find_opts("device"));
 858         if (arch_type == QEMU_ARCH_S390X) {
 859             qemu_opt_set(devopts, "driver", "virtio-blk-s390");
 860         } else {
 861             qemu_opt_set(devopts, "driver", "virtio-blk-pci");
 862         }
 863         qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"));
 864         if (devaddr) {
 865             qemu_opt_set(devopts, "addr", devaddr);
 866         }
 867     }
 868
 869     /* Actual block device init: Functionality shared with blockdev-add */
 870     dinfo = blockdev_init(bs_opts, type, &local_err);
 871     bs_opts = NULL;
 872     if (dinfo == NULL) {
 873         if (error_is_set(&local_err)) {
 874             qerror_report_err(local_err);
 875             error_free(local_err);
 876         }
 877         goto fail;
 878     } else {
 879         assert(!error_is_set(&local_err));
 880     }
 881
 882     /* Set legacy DriveInfo fields */
 883     dinfo->enable_auto_del = true;
 884     dinfo->opts = all_opts;
 885
 886     dinfo->cyls = cyls;
 887     dinfo->heads = heads;
 888     dinfo->secs = secs;
 889     dinfo->trans = translation;
 890
 891     dinfo->bus = bus_id;
 892     dinfo->unit = unit_id;
 893     dinfo->devaddr = devaddr;
 894
 895     switch(type) {
 896     case IF_IDE:
 897     case IF_SCSI:
 898     case IF_XEN:
 899     case IF_NONE:
 900         dinfo->media_cd = media == MEDIA_CDROM;
 901         break;
 902     default:
 903         break;
 904     }
 905
 906 fail:
 907     qemu_opts_del(legacy_opts);
 908     QDECREF(bs_opts);
 909     return dinfo;
 910 }
 911
 912 void do_commit(Monitor *mon, const QDict *qdict)
 913 {
 914     const char *device = qdict_get_str(qdict, "device");
 915     BlockDriverState *bs;
 916     int ret;
 917
 918     if (!strcmp(device, "all")) {
 919         ret = bdrv_commit_all();
 920     } else {
 921         bs = bdrv_find(device);
 922         if (!bs) {
 923             monitor_printf(mon, "Device '%s' not found\n", device);
 924             return;
 925         }
 926         ret = bdrv_commit(bs);
 927     }
 928     if (ret < 0) {
 929         monitor_printf(mon, "'commit' error for '%s': %s\n", device,
 930                        strerror(-ret));
 931     }
 932 }
 933
 934 static void blockdev_do_action(int kind, void *data, Error **errp)
 935 {
 936     TransactionAction action;
 937     TransactionActionList list;
 938
 939     action.kind = kind;
 940     action.data = data;
 941     list.value = &action;
 942     list.next = NULL;
 943     qmp_transaction(&list, errp);
 944 }
 945
 946 void qmp_blockdev_snapshot_sync(const char *device, const char *snapshot_file,
 947                                 bool has_format, const char *format,
 948                                 bool has_mode, enum NewImageMode mode,
 949                                 Error **errp)
 950 {
 951     BlockdevSnapshot snapshot = {
 952         .device = (char *) device,
 953         .snapshot_file = (char *) snapshot_file,
 954         .has_format = has_format,
 955         .format = (char *) format,
 956         .has_mode = has_mode,
 957         .mode = mode,
 958     };
 959     blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
 960                        &snapshot, errp);
 961 }
 962
 963 void qmp_blockdev_snapshot_internal_sync(const char *device,
 964                                          const char *name,
 965                                          Error **errp)
 966 {
 967     BlockdevSnapshotInternal snapshot = {
 968         .device = (char *) device,
 969         .name = (char *) name
 970     };
 971
 972     blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
 973                        &snapshot, errp);
 974 }
 975
 976 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
 977                                                          bool has_id,
 978                                                          const char *id,
 979                                                          bool has_name,
 980                                                          const char *name,
 981                                                          Error **errp)
 982 {
 983     BlockDriverState *bs = bdrv_find(device);
 984     QEMUSnapshotInfo sn;
 985     Error *local_err = NULL;
 986     SnapshotInfo *info = NULL;
 987     int ret;
 988
 989     if (!bs) {
 990         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
 991         return NULL;
 992     }
 993
 994     if (!has_id) {
 995         id = NULL;
 996     }
 997
 998     if (!has_name) {
 999         name = NULL;
1000     }
1001
1002     if (!id && !name) {
1003         error_setg(errp, "Name or id must be provided");
1004         return NULL;
1005     }
1006
1007     ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1008     if (error_is_set(&local_err)) {
1009         error_propagate(errp, local_err);
1010         return NULL;
1011     }
1012     if (!ret) {
1013         error_setg(errp,
1014                    "Snapshot with id '%s' and name '%s' does not exist on "
1015                    "device '%s'",
1016                    STR_OR_NULL(id), STR_OR_NULL(name), device);
1017         return NULL;
1018     }
1019
1020     bdrv_snapshot_delete(bs, id, name, &local_err);
1021     if (error_is_set(&local_err)) {
1022         error_propagate(errp, local_err);
1023         return NULL;
1024     }
1025
1026     info = g_malloc0(sizeof(SnapshotInfo));
1027     info->id = g_strdup(sn.id_str);
1028     info->name = g_strdup(sn.name);
1029     info->date_nsec = sn.date_nsec;
1030     info->date_sec = sn.date_sec;
1031     info->vm_state_size = sn.vm_state_size;
1032     info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1033     info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1034
1035     return info;
1036 }
1037
1038 /* New and old BlockDriverState structs for group snapshots */
1039
1040 typedef struct BlkTransactionState BlkTransactionState;
1041
1042 /* Only prepare() may fail. In a single transaction, only one of commit() or
1043    abort() will be called, clean() will always be called if it present. */
1044 typedef struct BdrvActionOps {
1045     /* Size of state struct, in bytes. */
1046     size_t instance_size;
1047     /* Prepare the work, must NOT be NULL. */
1048     void (*prepare)(BlkTransactionState *common, Error **errp);
1049     /* Commit the changes, can be NULL. */
1050     void (*commit)(BlkTransactionState *common);
1051     /* Abort the changes on fail, can be NULL. */
1052     void (*abort)(BlkTransactionState *common);
1053     /* Clean up resource in the end, can be NULL. */
1054     void (*clean)(BlkTransactionState *common);
1055 } BdrvActionOps;
1056
1057 /*
1058  * This structure must be arranged as first member in child type, assuming
1059  * that compiler will also arrange it to the same address with parent instance.
1060  * Later it will be used in free().
1061  */
1062 struct BlkTransactionState {
1063     TransactionAction *action;
1064     const BdrvActionOps *ops;
1065     QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1066 };
1067
1068 /* internal snapshot private data */
1069 typedef struct InternalSnapshotState {
1070     BlkTransactionState common;
1071     BlockDriverState *bs;
1072     QEMUSnapshotInfo sn;
1073 } InternalSnapshotState;
1074
1075 static void internal_snapshot_prepare(BlkTransactionState *common,
1076                                       Error **errp)
1077 {
1078     const char *device;
1079     const char *name;
1080     BlockDriverState *bs;
1081     QEMUSnapshotInfo old_sn, *sn;
1082     bool ret;
1083     qemu_timeval tv;
1084     BlockdevSnapshotInternal *internal;
1085     InternalSnapshotState *state;
1086     int ret1;
1087
1088     g_assert(common->action->kind ==
1089              TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1090     internal = common->action->blockdev_snapshot_internal_sync;
1091     state = DO_UPCAST(InternalSnapshotState, common, common);
1092
1093     /* 1. parse input */
1094     device = internal->device;
1095     name = internal->name;
1096
1097     /* 2. check for validation */
1098     bs = bdrv_find(device);
1099     if (!bs) {
1100         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1101         return;
1102     }
1103
1104     if (!bdrv_is_inserted(bs)) {
1105         error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1106         return;
1107     }
1108
1109     if (bdrv_is_read_only(bs)) {
1110         error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1111         return;
1112     }
1113
1114     if (!bdrv_can_snapshot(bs)) {
1115         error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1116                   bs->drv->format_name, device, "internal snapshot");
1117         return;
1118     }
1119
1120     if (!strlen(name)) {
1121         error_setg(errp, "Name is empty");
1122         return;
1123     }
1124
1125     /* check whether a snapshot with name exist */
1126     ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn, errp);
1127     if (error_is_set(errp)) {
1128         return;
1129     } else if (ret) {
1130         error_setg(errp,
1131                    "Snapshot with name '%s' already exists on device '%s'",
1132                    name, device);
1133         return;
1134     }
1135
1136     /* 3. take the snapshot */
1137     sn = &state->sn;
1138     pstrcpy(sn->name, sizeof(sn->name), name);
1139     qemu_gettimeofday(&tv);
1140     sn->date_sec = tv.tv_sec;
1141     sn->date_nsec = tv.tv_usec * 1000;
1142     sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1143
1144     ret1 = bdrv_snapshot_create(bs, sn);
1145     if (ret1 < 0) {
1146         error_setg_errno(errp, -ret1,
1147                          "Failed to create snapshot '%s' on device '%s'",
1148                          name, device);
1149         return;
1150     }
1151
1152     /* 4. succeed, mark a snapshot is created */
1153     state->bs = bs;
1154 }
1155
1156 static void internal_snapshot_abort(BlkTransactionState *common)
1157 {
1158     InternalSnapshotState *state =
1159                              DO_UPCAST(InternalSnapshotState, common, common);
1160     BlockDriverState *bs = state->bs;
1161     QEMUSnapshotInfo *sn = &state->sn;
1162     Error *local_error = NULL;
1163
1164     if (!bs) {
1165         return;
1166     }
1167
1168     if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1169         error_report("Failed to delete snapshot with id '%s' and name '%s' on "
1170                      "device '%s' in abort: %s",
1171                      sn->id_str,
1172                      sn->name,
1173                      bdrv_get_device_name(bs),
1174                      error_get_pretty(local_error));
1175         error_free(local_error);
1176     }
1177 }
1178
1179 /* external snapshot private data */
1180 typedef struct ExternalSnapshotState {
1181     BlkTransactionState common;
1182     BlockDriverState *old_bs;
1183     BlockDriverState *new_bs;
1184 } ExternalSnapshotState;
1185
1186 static void external_snapshot_prepare(BlkTransactionState *common,
1187                                       Error **errp)
1188 {
1189     BlockDriver *drv;
1190     int flags, ret;
1191     Error *local_err = NULL;
1192     const char *device;
1193     const char *new_image_file;
1194     const char *format = "qcow2";
1195     enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1196     ExternalSnapshotState *state =
1197                              DO_UPCAST(ExternalSnapshotState, common, common);
1198     TransactionAction *action = common->action;
1199
1200     /* get parameters */
1201     g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1202
1203     device = action->blockdev_snapshot_sync->device;
1204     new_image_file = action->blockdev_snapshot_sync->snapshot_file;
1205     if (action->blockdev_snapshot_sync->has_format) {
1206         format = action->blockdev_snapshot_sync->format;
1207     }
1208     if (action->blockdev_snapshot_sync->has_mode) {
1209         mode = action->blockdev_snapshot_sync->mode;
1210     }
1211
1212     /* start processing */
1213     drv = bdrv_find_format(format);
1214     if (!drv) {
1215         error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1216         return;
1217     }
1218
1219     state->old_bs = bdrv_find(device);
1220     if (!state->old_bs) {
1221         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1222         return;
1223     }
1224
1225     if (!bdrv_is_inserted(state->old_bs)) {
1226         error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1227         return;
1228     }
1229
1230     if (bdrv_in_use(state->old_bs)) {
1231         error_set(errp, QERR_DEVICE_IN_USE, device);
1232         return;
1233     }
1234
1235     if (!bdrv_is_read_only(state->old_bs)) {
1236         if (bdrv_flush(state->old_bs)) {
1237             error_set(errp, QERR_IO_ERROR);
1238             return;
1239         }
1240     }
1241
1242     if (bdrv_check_ext_snapshot(state->old_bs) != EXT_SNAPSHOT_ALLOWED) {
1243         error_set(errp, QERR_FEATURE_DISABLED, "snapshot");
1244         return;
1245     }
1246
1247     flags = state->old_bs->open_flags;
1248
1249     /* create new image w/backing file */
1250     if (mode != NEW_IMAGE_MODE_EXISTING) {
1251         bdrv_img_create(new_image_file, format,
1252                         state->old_bs->filename,
1253                         state->old_bs->drv->format_name,
1254                         NULL, -1, flags, &local_err, false);
1255         if (error_is_set(&local_err)) {
1256             error_propagate(errp, local_err);
1257             return;
1258         }
1259     }
1260
1261     /* We will manually add the backing_hd field to the bs later */
1262     state->new_bs = bdrv_new("");
1263     /* TODO Inherit bs->options or only take explicit options with an
1264      * extended QMP command? */
1265     ret = bdrv_open(state->new_bs, new_image_file, NULL,
1266                     flags | BDRV_O_NO_BACKING, drv, &local_err);
1267     if (ret != 0) {
1268         error_propagate(errp, local_err);
1269     }
1270 }
1271
1272 static void external_snapshot_commit(BlkTransactionState *common)
1273 {
1274     ExternalSnapshotState *state =
1275                              DO_UPCAST(ExternalSnapshotState, common, common);
1276
1277     /* This removes our old bs and adds the new bs */
1278     bdrv_append(state->new_bs, state->old_bs);
1279     /* We don't need (or want) to use the transactional
1280      * bdrv_reopen_multiple() across all the entries at once, because we
1281      * don't want to abort all of them if one of them fails the reopen */
1282     bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1283                 NULL);
1284 }
1285
1286 static void external_snapshot_abort(BlkTransactionState *common)
1287 {
1288     ExternalSnapshotState *state =
1289                              DO_UPCAST(ExternalSnapshotState, common, common);
1290     if (state->new_bs) {
1291         bdrv_unref(state->new_bs);
1292     }
1293 }
1294
1295 typedef struct DriveBackupState {
1296     BlkTransactionState common;
1297     BlockDriverState *bs;
1298     BlockJob *job;
1299 } DriveBackupState;
1300
1301 static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
1302 {
1303     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1304     DriveBackup *backup;
1305     Error *local_err = NULL;
1306
1307     assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1308     backup = common->action->drive_backup;
1309
1310     qmp_drive_backup(backup->device, backup->target,
1311                      backup->has_format, backup->format,
1312                      backup->sync,
1313                      backup->has_mode, backup->mode,
1314                      backup->has_speed, backup->speed,
1315                      backup->has_on_source_error, backup->on_source_error,
1316                      backup->has_on_target_error, backup->on_target_error,
1317                      &local_err);
1318     if (error_is_set(&local_err)) {
1319         error_propagate(errp, local_err);
1320         state->bs = NULL;
1321         state->job = NULL;
1322         return;
1323     }
1324
1325     state->bs = bdrv_find(backup->device);
1326     state->job = state->bs->job;
1327 }
1328
1329 static void drive_backup_abort(BlkTransactionState *common)
1330 {
1331     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1332     BlockDriverState *bs = state->bs;
1333
1334     /* Only cancel if it's the job we started */
1335     if (bs && bs->job && bs->job == state->job) {
1336         block_job_cancel_sync(bs->job);
1337     }
1338 }
1339
1340 static void abort_prepare(BlkTransactionState *common, Error **errp)
1341 {
1342     error_setg(errp, "Transaction aborted using Abort action");
1343 }
1344
1345 static void abort_commit(BlkTransactionState *common)
1346 {
1347     g_assert_not_reached(); /* this action never succeeds */
1348 }
1349
1350 static const BdrvActionOps actions[] = {
1351     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1352         .instance_size = sizeof(ExternalSnapshotState),
1353         .prepare  = external_snapshot_prepare,
1354         .commit   = external_snapshot_commit,
1355         .abort = external_snapshot_abort,
1356     },
1357     [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
1358         .instance_size = sizeof(DriveBackupState),
1359         .prepare = drive_backup_prepare,
1360         .abort = drive_backup_abort,
1361     },
1362     [TRANSACTION_ACTION_KIND_ABORT] = {
1363         .instance_size = sizeof(BlkTransactionState),
1364         .prepare = abort_prepare,
1365         .commit = abort_commit,
1366     },
1367     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
1368         .instance_size = sizeof(InternalSnapshotState),
1369         .prepare  = internal_snapshot_prepare,
1370         .abort = internal_snapshot_abort,
1371     },
1372 };
1373
1374 /*
1375  * 'Atomic' group snapshots.  The snapshots are taken as a set, and if any fail
1376  *  then we do not pivot any of the devices in the group, and abandon the
1377  *  snapshots
1378  */
1379 void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1380 {
1381     TransactionActionList *dev_entry = dev_list;
1382     BlkTransactionState *state, *next;
1383     Error *local_err = NULL;
1384
1385     QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1386     QSIMPLEQ_INIT(&snap_bdrv_states);
1387
1388     /* drain all i/o before any snapshots */
1389     bdrv_drain_all();
1390
1391     /* We don't do anything in this loop that commits us to the snapshot */
1392     while (NULL != dev_entry) {
1393         TransactionAction *dev_info = NULL;
1394         const BdrvActionOps *ops;
1395
1396         dev_info = dev_entry->value;
1397         dev_entry = dev_entry->next;
1398
1399         assert(dev_info->kind < ARRAY_SIZE(actions));
1400
1401         ops = &actions[dev_info->kind];
1402         assert(ops->instance_size > 0);
1403
1404         state = g_malloc0(ops->instance_size);
1405         state->ops = ops;
1406         state->action = dev_info;
1407         QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1408
1409         state->ops->prepare(state, &local_err);
1410         if (error_is_set(&local_err)) {
1411             error_propagate(errp, local_err);
1412             goto delete_and_fail;
1413         }
1414     }
1415
1416     QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1417         if (state->ops->commit) {
1418             state->ops->commit(state);
1419         }
1420     }
1421
1422     /* success */
1423     goto exit;
1424
1425 delete_and_fail:
1426     /*
1427     * failure, and it is all-or-none; abandon each new bs, and keep using
1428     * the original bs for all images
1429     */
1430     QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1431         if (state->ops->abort) {
1432             state->ops->abort(state);
1433         }
1434     }
1435 exit:
1436     QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
1437         if (state->ops->clean) {
1438             state->ops->clean(state);
1439         }
1440         g_free(state);
1441     }
1442 }
1443
1444
1445 static void eject_device(BlockDriverState *bs, int force, Error **errp)
1446 {
1447     if (bdrv_in_use(bs)) {
1448         error_set(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
1449         return;
1450     }
1451     if (!bdrv_dev_has_removable_media(bs)) {
1452         error_set(errp, QERR_DEVICE_NOT_REMOVABLE, bdrv_get_device_name(bs));
1453         return;
1454     }
1455
1456     if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
1457         bdrv_dev_eject_request(bs, force);
1458         if (!force) {
1459             error_set(errp, QERR_DEVICE_LOCKED, bdrv_get_device_name(bs));
1460             return;
1461         }
1462     }
1463
1464     bdrv_close(bs);
1465 }
1466
1467 void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1468 {
1469     BlockDriverState *bs;
1470
1471     bs = bdrv_find(device);
1472     if (!bs) {
1473         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1474         return;
1475     }
1476
1477     eject_device(bs, force, errp);
1478 }
1479
1480 void qmp_block_passwd(const char *device, const char *password, Error **errp)
1481 {
1482     BlockDriverState *bs;
1483     int err;
1484
1485     bs = bdrv_find(device);
1486     if (!bs) {
1487         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1488         return;
1489     }
1490
1491     err = bdrv_set_key(bs, password);
1492     if (err == -EINVAL) {
1493         error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1494         return;
1495     } else if (err < 0) {
1496         error_set(errp, QERR_INVALID_PASSWORD);
1497         return;
1498     }
1499 }
1500
1501 static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
1502                                     int bdrv_flags, BlockDriver *drv,
1503                                     const char *password, Error **errp)
1504 {
1505     Error *local_err = NULL;
1506     int ret;
1507
1508     ret = bdrv_open(bs, filename, NULL, bdrv_flags, drv, &local_err);
1509     if (ret < 0) {
1510         error_propagate(errp, local_err);
1511         return;
1512     }
1513
1514     if (bdrv_key_required(bs)) {
1515         if (password) {
1516             if (bdrv_set_key(bs, password) < 0) {
1517                 error_set(errp, QERR_INVALID_PASSWORD);
1518             }
1519         } else {
1520             error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
1521                       bdrv_get_encrypted_filename(bs));
1522         }
1523     } else if (password) {
1524         error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
1525     }
1526 }
1527
1528 void qmp_change_blockdev(const char *device, const char *filename,
1529                          bool has_format, const char *format, Error **errp)
1530 {
1531     BlockDriverState *bs;
1532     BlockDriver *drv = NULL;
1533     int bdrv_flags;
1534     Error *err = NULL;
1535
1536     bs = bdrv_find(device);
1537     if (!bs) {
1538         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1539         return;
1540     }
1541
1542     if (format) {
1543         drv = bdrv_find_whitelisted_format(format, bs->read_only);
1544         if (!drv) {
1545             error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1546             return;
1547         }
1548     }
1549
1550     eject_device(bs, 0, &err);
1551     if (error_is_set(&err)) {
1552         error_propagate(errp, err);
1553         return;
1554     }
1555
1556     bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1557     bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
1558
1559     qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1560 }
1561
1562 /* throttling disk I/O limits */
1563 void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1564                                int64_t bps_wr,
1565                                int64_t iops,
1566                                int64_t iops_rd,
1567                                int64_t iops_wr,
1568                                bool has_bps_max,
1569                                int64_t bps_max,
1570                                bool has_bps_rd_max,
1571                                int64_t bps_rd_max,
1572                                bool has_bps_wr_max,
1573                                int64_t bps_wr_max,
1574                                bool has_iops_max,
1575                                int64_t iops_max,
1576                                bool has_iops_rd_max,
1577                                int64_t iops_rd_max,
1578                                bool has_iops_wr_max,
1579                                int64_t iops_wr_max,
1580                                bool has_iops_size,
1581                                int64_t iops_size, Error **errp)
1582 {
1583     ThrottleConfig cfg;
1584     BlockDriverState *bs;
1585
1586     bs = bdrv_find(device);
1587     if (!bs) {
1588         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1589         return;
1590     }
1591
1592     memset(&cfg, 0, sizeof(cfg));
1593     cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
1594     cfg.buckets[THROTTLE_BPS_READ].avg  = bps_rd;
1595     cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;
1596
1597     cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
1598     cfg.buckets[THROTTLE_OPS_READ].avg  = iops_rd;
1599     cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;
1600
1601     if (has_bps_max) {
1602         cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
1603     }
1604     if (has_bps_rd_max) {
1605         cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
1606     }
1607     if (has_bps_wr_max) {
1608         cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
1609     }
1610     if (has_iops_max) {
1611         cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
1612     }
1613     if (has_iops_rd_max) {
1614         cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
1615     }
1616     if (has_iops_wr_max) {
1617         cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
1618     }
1619
1620     if (has_iops_size) {
1621         cfg.op_size = iops_size;
1622     }
1623
1624     if (!check_throttle_config(&cfg, errp)) {
1625         return;
1626     }
1627
1628     if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
1629         bdrv_io_limits_enable(bs);
1630     } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
1631         bdrv_io_limits_disable(bs);
1632     }
1633
1634     if (bs->io_limits_enabled) {
1635         bdrv_set_io_limits(bs, &cfg);
1636     }
1637 }
1638
1639 int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
1640 {
1641     const char *id = qdict_get_str(qdict, "id");
1642     BlockDriverState *bs;
1643
1644     bs = bdrv_find(id);
1645     if (!bs) {
1646         qerror_report(QERR_DEVICE_NOT_FOUND, id);
1647         return -1;
1648     }
1649     if (bdrv_in_use(bs)) {
1650         qerror_report(QERR_DEVICE_IN_USE, id);
1651         return -1;
1652     }
1653
1654     /* quiesce block driver; prevent further io */
1655     bdrv_drain_all();
1656     bdrv_flush(bs);
1657     bdrv_close(bs);
1658
1659     /* if we have a device attached to this BlockDriverState
1660      * then we need to make the drive anonymous until the device
1661      * can be removed.  If this is a drive with no device backing
1662      * then we can just get rid of the block driver state right here.
1663      */
1664     if (bdrv_get_attached_dev(bs)) {
1665         bdrv_make_anon(bs);
1666
1667         /* Further I/O must not pause the guest */
1668         bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
1669                           BLOCKDEV_ON_ERROR_REPORT);
1670     } else {
1671         drive_uninit(drive_get_by_blockdev(bs));
1672     }
1673
1674     return 0;
1675 }
1676
1677 void qmp_block_resize(const char *device, int64_t size, Error **errp)
1678 {
1679     BlockDriverState *bs;
1680     int ret;
1681
1682     bs = bdrv_find(device);
1683     if (!bs) {
1684         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1685         return;
1686     }
1687
1688     if (size < 0) {
1689         error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
1690         return;
1691     }
1692
1693     /* complete all in-flight operations before resizing the device */
1694     bdrv_drain_all();
1695
1696     ret = bdrv_truncate(bs, size);
1697     switch (ret) {
1698     case 0:
1699         break;
1700     case -ENOMEDIUM:
1701         error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1702         break;
1703     case -ENOTSUP:
1704         error_set(errp, QERR_UNSUPPORTED);
1705         break;
1706     case -EACCES:
1707         error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
1708         break;
1709     case -EBUSY:
1710         error_set(errp, QERR_DEVICE_IN_USE, device);
1711         break;
1712     default:
1713         error_setg_errno(errp, -ret, "Could not resize");
1714         break;
1715     }
1716 }
1717
1718 static void block_job_cb(void *opaque, int ret)
1719 {
1720     BlockDriverState *bs = opaque;
1721     QObject *obj;
1722
1723     trace_block_job_cb(bs, bs->job, ret);
1724
1725     assert(bs->job);
1726     obj = qobject_from_block_job(bs->job);
1727     if (ret < 0) {
1728         QDict *dict = qobject_to_qdict(obj);
1729         qdict_put(dict, "error", qstring_from_str(strerror(-ret)));
1730     }
1731
1732     if (block_job_is_cancelled(bs->job)) {
1733         monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED, obj);
1734     } else {
1735         monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED, obj);
1736     }
1737     qobject_decref(obj);
1738
1739     bdrv_put_ref_bh_schedule(bs);
1740 }
1741
1742 void qmp_block_stream(const char *device, bool has_base,
1743                       const char *base, bool has_speed, int64_t speed,
1744                       bool has_on_error, BlockdevOnError on_error,
1745                       Error **errp)
1746 {
1747     BlockDriverState *bs;
1748     BlockDriverState *base_bs = NULL;
1749     Error *local_err = NULL;
1750
1751     if (!has_on_error) {
1752         on_error = BLOCKDEV_ON_ERROR_REPORT;
1753     }
1754
1755     bs = bdrv_find(device);
1756     if (!bs) {
1757         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1758         return;
1759     }
1760
1761     if (base) {
1762         base_bs = bdrv_find_backing_image(bs, base);
1763         if (base_bs == NULL) {
1764             error_set(errp, QERR_BASE_NOT_FOUND, base);
1765             return;
1766         }
1767     }
1768
1769     stream_start(bs, base_bs, base, has_speed ? speed : 0,
1770                  on_error, block_job_cb, bs, &local_err);
1771     if (error_is_set(&local_err)) {
1772         error_propagate(errp, local_err);
1773         return;
1774     }
1775
1776     trace_qmp_block_stream(bs, bs->job);
1777 }
1778
1779 void qmp_block_commit(const char *device,
1780                       bool has_base, const char *base, const char *top,
1781                       bool has_speed, int64_t speed,
1782                       Error **errp)
1783 {
1784     BlockDriverState *bs;
1785     BlockDriverState *base_bs, *top_bs;
1786     Error *local_err = NULL;
1787     /* This will be part of the QMP command, if/when the
1788      * BlockdevOnError change for blkmirror makes it in
1789      */
1790     BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
1791
1792     if (!has_speed) {
1793         speed = 0;
1794     }
1795
1796     /* drain all i/o before commits */
1797     bdrv_drain_all();
1798
1799     bs = bdrv_find(device);
1800     if (!bs) {
1801         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1802         return;
1803     }
1804
1805     /* default top_bs is the active layer */
1806     top_bs = bs;
1807
1808     if (top) {
1809         if (strcmp(bs->filename, top) != 0) {
1810             top_bs = bdrv_find_backing_image(bs, top);
1811         }
1812     }
1813
1814     if (top_bs == NULL) {
1815         error_setg(errp, "Top image file %s not found", top ? top : "NULL");
1816         return;
1817     }
1818
1819     if (has_base && base) {
1820         base_bs = bdrv_find_backing_image(top_bs, base);
1821     } else {
1822         base_bs = bdrv_find_base(top_bs);
1823     }
1824
1825     if (base_bs == NULL) {
1826         error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
1827         return;
1828     }
1829
1830     commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
1831                 &local_err);
1832     if (local_err != NULL) {
1833         error_propagate(errp, local_err);
1834         return;
1835     }
1836 }
1837
1838 void qmp_drive_backup(const char *device, const char *target,
1839                       bool has_format, const char *format,
1840                       enum MirrorSyncMode sync,
1841                       bool has_mode, enum NewImageMode mode,
1842                       bool has_speed, int64_t speed,
1843                       bool has_on_source_error, BlockdevOnError on_source_error,
1844                       bool has_on_target_error, BlockdevOnError on_target_error,
1845                       Error **errp)
1846 {
1847     BlockDriverState *bs;
1848     BlockDriverState *target_bs;
1849     BlockDriverState *source = NULL;
1850     BlockDriver *drv = NULL;
1851     Error *local_err = NULL;
1852     int flags;
1853     int64_t size;
1854     int ret;
1855
1856     if (!has_speed) {
1857         speed = 0;
1858     }
1859     if (!has_on_source_error) {
1860         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1861     }
1862     if (!has_on_target_error) {
1863         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1864     }
1865     if (!has_mode) {
1866         mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1867     }
1868
1869     bs = bdrv_find(device);
1870     if (!bs) {
1871         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
1872         return;
1873     }
1874
1875     if (!bdrv_is_inserted(bs)) {
1876         error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1877         return;
1878     }
1879
1880     if (!has_format) {
1881         format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
1882     }
1883     if (format) {
1884         drv = bdrv_find_format(format);
1885         if (!drv) {
1886             error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
1887             return;
1888         }
1889     }
1890
1891     if (bdrv_in_use(bs)) {
1892         error_set(errp, QERR_DEVICE_IN_USE, device);
1893         return;
1894     }
1895
1896     flags = bs->open_flags | BDRV_O_RDWR;
1897
1898     /* See if we have a backing HD we can use to create our new image
1899      * on top of. */
1900     if (sync == MIRROR_SYNC_MODE_TOP) {
1901         source = bs->backing_hd;
1902         if (!source) {
1903             sync = MIRROR_SYNC_MODE_FULL;
1904         }
1905     }
1906     if (sync == MIRROR_SYNC_MODE_NONE) {
1907         source = bs;
1908     }
1909
1910     size = bdrv_getlength(bs);
1911     if (size < 0) {
1912         error_setg_errno(errp, -size, "bdrv_getlength failed");
1913         return;
1914     }
1915
1916     if (mode != NEW_IMAGE_MODE_EXISTING) {
1917         assert(format && drv);
1918         if (source) {
1919             bdrv_img_create(target, format, source->filename,
1920                             source->drv->format_name, NULL,
1921                             size, flags, &local_err, false);
1922         } else {
1923             bdrv_img_create(target, format, NULL, NULL, NULL,
1924                             size, flags, &local_err, false);
1925         }
1926     }
1927
1928     if (error_is_set(&local_err)) {
1929         error_propagate(errp, local_err);
1930         return;
1931     }
1932
1933     target_bs = bdrv_new("");
1934     ret = bdrv_open(target_bs, target, NULL, flags, drv, &local_err);
1935     if (ret < 0) {
1936         bdrv_unref(target_bs);
1937         error_propagate(errp, local_err);
1938         return;
1939     }
1940
1941     backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
1942                  block_job_cb, bs, &local_err);
1943     if (local_err != NULL) {
1944         bdrv_unref(target_bs);
1945         error_propagate(errp, local_err);
1946         return;
1947     }
1948 }
1949
1950 #define DEFAULT_MIRROR_BUF_SIZE   (10 << 20)
1951
1952 void qmp_drive_mirror(const char *device, const char *target,
1953                       bool has_format, const char *format,
1954                       enum MirrorSyncMode sync,
1955                       bool has_mode, enum NewImageMode mode,
1956                       bool has_speed, int64_t speed,
1957                       bool has_granularity, uint32_t granularity,
1958                       bool has_buf_size, int64_t buf_size,
1959                       bool has_on_source_error, BlockdevOnError on_source_error,
1960                       bool has_on_target_error, BlockdevOnError on_target_error,
1961                       Error **errp)
1962 {
1963     BlockDriverState *bs;
1964     BlockDriverState *source, *target_bs;
1965     BlockDriver *drv = NULL;
1966     Error *local_err = NULL;
1967     int flags;
1968     int64_t size;
1969     int ret;
1970
1971     if (!has_speed) {
1972         speed = 0;
1973     }
1974     if (!has_on_source_error) {
1975         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
1976     }
1977     if (!has_on_target_error) {
1978         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
1979     }
1980     if (!has_mode) {
1981         mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1982     }
1983     if (!has_granularity) {
1984         granularity = 0;
1985     }
1986     if (!has_buf_size) {
1987         buf_size = DEFAULT_MIRROR_BUF_SIZE;
1988     }
1989
1990     if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
1991         error_set(errp, QERR_INVALID_PARAMETER, device);
1992         return;
1993     }
1994     if (granularity & (granularity - 1)) {
1995         error_set(errp, QERR_INVALID_PARAMETER, device);
1996         return;
1997     }
1998
1999     bs = bdrv_find(device);
2000     if (!bs) {
2001         error_set(errp, QERR_DEVICE_NOT_FOUND, device);
2002         return;
2003     }
2004
2005     if (!bdrv_is_inserted(bs)) {
2006         error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2007         return;
2008     }
2009
2010     if (!has_format) {
2011         format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
2012     }
2013     if (format) {
2014         drv = bdrv_find_format(format);
2015         if (!drv) {
2016             error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
2017             return;
2018         }
2019     }
2020
2021     if (bdrv_in_use(bs)) {
2022         error_set(errp, QERR_DEVICE_IN_USE, device);
2023         return;
2024     }
2025
2026     flags = bs->open_flags | BDRV_O_RDWR;
2027     source = bs->backing_hd;
2028     if (!source && sync == MIRROR_SYNC_MODE_TOP) {
2029         sync = MIRROR_SYNC_MODE_FULL;
2030     }
2031     if (sync == MIRROR_SYNC_MODE_NONE) {
2032         source = bs;
2033     }
2034
2035     size = bdrv_getlength(bs);
2036     if (size < 0) {
2037         error_setg_errno(errp, -size, "bdrv_getlength failed");
2038         return;
2039     }
2040
2041     if ((sync == MIRROR_SYNC_MODE_FULL || !source)
2042         && mode != NEW_IMAGE_MODE_EXISTING)
2043     {
2044         /* create new image w/o backing file */
2045         assert(format && drv);
2046         bdrv_img_create(target, format,
2047                         NULL, NULL, NULL, size, flags, &local_err, false);
2048     } else {
2049         switch (mode) {
2050         case NEW_IMAGE_MODE_EXISTING:
2051             break;
2052         case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
2053             /* create new image with backing file */
2054             bdrv_img_create(target, format,
2055                             source->filename,
2056                             source->drv->format_name,
2057                             NULL, size, flags, &local_err, false);
2058             break;
2059         default:
2060             abort();
2061         }
2062     }
2063
2064     if (error_is_set(&local_err)) {
2065         error_propagate(errp, local_err);
2066         return;
2067     }
2068
2069     /* Mirroring takes care of copy-on-write using the source's backing
2070      * file.
2071      */
2072     target_bs = bdrv_new("");
2073     ret = bdrv_open(target_bs, target, NULL, flags | BDRV_O_NO_BACKING, drv,
2074                     &local_err);
2075     if (ret < 0) {
2076         bdrv_unref(target_bs);
2077         error_propagate(errp, local_err);
2078         return;
2079     }
2080
2081     mirror_start(bs, target_bs, speed, granularity, buf_size, sync,
2082                  on_source_error, on_target_error,
2083                  block_job_cb, bs, &local_err);
2084     if (local_err != NULL) {
2085         bdrv_unref(target_bs);
2086         error_propagate(errp, local_err);
2087         return;
2088     }
2089 }
2090
2091 static BlockJob *find_block_job(const char *device)
2092 {
2093     BlockDriverState *bs;
2094
2095     bs = bdrv_find(device);
2096     if (!bs || !bs->job) {
2097         return NULL;
2098     }
2099     return bs->job;
2100 }
2101
2102 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
2103 {
2104     BlockJob *job = find_block_job(device);
2105
2106     if (!job) {
2107         error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2108         return;
2109     }
2110
2111     block_job_set_speed(job, speed, errp);
2112 }
2113
2114 void qmp_block_job_cancel(const char *device,
2115                           bool has_force, bool force, Error **errp)
2116 {
2117     BlockJob *job = find_block_job(device);
2118
2119     if (!has_force) {
2120         force = false;
2121     }
2122
2123     if (!job) {
2124         error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2125         return;
2126     }
2127     if (job->paused && !force) {
2128         error_set(errp, QERR_BLOCK_JOB_PAUSED, device);
2129         return;
2130     }
2131
2132     trace_qmp_block_job_cancel(job);
2133     block_job_cancel(job);
2134 }
2135
2136 void qmp_block_job_pause(const char *device, Error **errp)
2137 {
2138     BlockJob *job = find_block_job(device);
2139
2140     if (!job) {
2141         error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2142         return;
2143     }
2144
2145     trace_qmp_block_job_pause(job);
2146     block_job_pause(job);
2147 }
2148
2149 void qmp_block_job_resume(const char *device, Error **errp)
2150 {
2151     BlockJob *job = find_block_job(device);
2152
2153     if (!job) {
2154         error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2155         return;
2156     }
2157
2158     trace_qmp_block_job_resume(job);
2159     block_job_resume(job);
2160 }
2161
2162 void qmp_block_job_complete(const char *device, Error **errp)
2163 {
2164     BlockJob *job = find_block_job(device);
2165
2166     if (!job) {
2167         error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2168         return;
2169     }
2170
2171     trace_qmp_block_job_complete(job);
2172     block_job_complete(job, errp);
2173 }
2174
2175 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
2176 {
2177     QmpOutputVisitor *ov = qmp_output_visitor_new();
2178     QObject *obj;
2179     QDict *qdict;
2180     Error *local_err = NULL;
2181
2182     /* Require an ID in the top level */
2183     if (!options->has_id) {
2184         error_setg(errp, "Block device needs an ID");
2185         goto fail;
2186     }
2187
2188     /* TODO Sort it out in raw-posix and drive_init: Reject aio=native with
2189      * cache.direct=false instead of silently switching to aio=threads, except
2190      * if called from drive_init.
2191      *
2192      * For now, simply forbidding the combination for all drivers will do. */
2193     if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
2194         bool direct = options->cache->has_direct && options->cache->direct;
2195         if (!options->has_cache && !direct) {
2196             error_setg(errp, "aio=native requires cache.direct=true");
2197             goto fail;
2198         }
2199     }
2200
2201     visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
2202                                &options, NULL, &local_err);
2203     if (error_is_set(&local_err)) {
2204         error_propagate(errp, local_err);
2205         goto fail;
2206     }
2207
2208     obj = qmp_output_get_qobject(ov);
2209     qdict = qobject_to_qdict(obj);
2210
2211     qdict_flatten(qdict);
2212
2213     blockdev_init(qdict, IF_NONE, &local_err);
2214     if (error_is_set(&local_err)) {
2215         error_propagate(errp, local_err);
2216         goto fail;
2217     }
2218
2219 fail:
2220     qmp_output_visitor_cleanup(ov);
2221 }
2222
2223 static void do_qmp_query_block_jobs_one(void *opaque, BlockDriverState *bs)
2224 {
2225     BlockJobInfoList **prev = opaque;
2226     BlockJob *job = bs->job;
2227
2228     if (job) {
2229         BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
2230         elem->value = block_job_query(bs->job);
2231         (*prev)->next = elem;
2232         *prev = elem;
2233     }
2234 }
2235
2236 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
2237 {
2238     /* Dummy is a fake list element for holding the head pointer */
2239     BlockJobInfoList dummy = {};
2240     BlockJobInfoList *prev = &dummy;
2241     bdrv_iterate(do_qmp_query_block_jobs_one, &prev);
2242     return dummy.next;
2243 }
2244
2245 QemuOptsList qemu_common_drive_opts = {
2246     .name = "drive",
2247     .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
2248     .desc = {
2249         {
2250             .name = "snapshot",
2251             .type = QEMU_OPT_BOOL,
2252             .help = "enable/disable snapshot mode",
2253         },{
2254             .name = "file",
2255             .type = QEMU_OPT_STRING,
2256             .help = "disk image",
2257         },{
2258             .name = "discard",
2259             .type = QEMU_OPT_STRING,
2260             .help = "discard operation (ignore/off, unmap/on)",
2261         },{
2262             .name = "cache.writeback",
2263             .type = QEMU_OPT_BOOL,
2264             .help = "enables writeback mode for any caches",
2265         },{
2266             .name = "cache.direct",
2267             .type = QEMU_OPT_BOOL,
2268             .help = "enables use of O_DIRECT (bypass the host page cache)",
2269         },{
2270             .name = "cache.no-flush",
2271             .type = QEMU_OPT_BOOL,
2272             .help = "ignore any flush requests for the device",
2273         },{
2274             .name = "aio",
2275             .type = QEMU_OPT_STRING,
2276             .help = "host AIO implementation (threads, native)",
2277         },{
2278             .name = "format",
2279             .type = QEMU_OPT_STRING,
2280             .help = "disk format (raw, qcow2, ...)",
2281         },{
2282             .name = "serial",
2283             .type = QEMU_OPT_STRING,
2284             .help = "disk serial number",
2285         },{
2286             .name = "rerror",
2287             .type = QEMU_OPT_STRING,
2288             .help = "read error action",
2289         },{
2290             .name = "werror",
2291             .type = QEMU_OPT_STRING,
2292             .help = "write error action",
2293         },{
2294             .name = "read-only",
2295             .type = QEMU_OPT_BOOL,
2296             .help = "open drive file as read-only",
2297         },{
2298             .name = "throttling.iops-total",
2299             .type = QEMU_OPT_NUMBER,
2300             .help = "limit total I/O operations per second",
2301         },{
2302             .name = "throttling.iops-read",
2303             .type = QEMU_OPT_NUMBER,
2304             .help = "limit read operations per second",
2305         },{
2306             .name = "throttling.iops-write",
2307             .type = QEMU_OPT_NUMBER,
2308             .help = "limit write operations per second",
2309         },{
2310             .name = "throttling.bps-total",
2311             .type = QEMU_OPT_NUMBER,
2312             .help = "limit total bytes per second",
2313         },{
2314             .name = "throttling.bps-read",
2315             .type = QEMU_OPT_NUMBER,
2316             .help = "limit read bytes per second",
2317         },{
2318             .name = "throttling.bps-write",
2319             .type = QEMU_OPT_NUMBER,
2320             .help = "limit write bytes per second",
2321         },{
2322             .name = "throttling.iops-total-max",
2323             .type = QEMU_OPT_NUMBER,
2324             .help = "I/O operations burst",
2325         },{
2326             .name = "throttling.iops-read-max",
2327             .type = QEMU_OPT_NUMBER,
2328             .help = "I/O operations read burst",
2329         },{
2330             .name = "throttling.iops-write-max",
2331             .type = QEMU_OPT_NUMBER,
2332             .help = "I/O operations write burst",
2333         },{
2334             .name = "throttling.bps-total-max",
2335             .type = QEMU_OPT_NUMBER,
2336             .help = "total bytes burst",
2337         },{
2338             .name = "throttling.bps-read-max",
2339             .type = QEMU_OPT_NUMBER,
2340             .help = "total bytes read burst",
2341         },{
2342             .name = "throttling.bps-write-max",
2343             .type = QEMU_OPT_NUMBER,
2344             .help = "total bytes write burst",
2345         },{
2346             .name = "throttling.iops-size",
2347             .type = QEMU_OPT_NUMBER,
2348             .help = "when limiting by iops max size of an I/O in bytes",
2349         },{
2350             .name = "copy-on-read",
2351             .type = QEMU_OPT_BOOL,
2352             .help = "copy read data from backing file into image file",
2353         },
2354         { /* end of list */ }
2355     },
2356 };
2357
2358 QemuOptsList qemu_drive_opts = {
2359     .name = "drive",
2360     .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
2361     .desc = {
2362         /*
2363          * no elements => accept any params
2364          * validation will happen later
2365          */
2366         { /* end of list */ }
2367     },
2368 };