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