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