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