blockdev.c 72.2 KB
Newer Older
1 2 3 4 5 6 7
/*
 * QEMU host block devices
 *
 * Copyright (c) 2003-2008 Fabrice Bellard
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or
 * later.  See the COPYING file in the top-level directory.
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright (c) 2003-2008 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
31 32
 */

33
#include "sysemu/blockdev.h"
P
Paolo Bonzini 已提交
34
#include "hw/block/block.h"
35
#include "block/blockjob.h"
36
#include "monitor/monitor.h"
37
#include "qapi/qmp/qerror.h"
38 39
#include "qemu/option.h"
#include "qemu/config-file.h"
40
#include "qapi/qmp/types.h"
K
Kevin Wolf 已提交
41 42
#include "qapi-visit.h"
#include "qapi/qmp-output-visitor.h"
43
#include "sysemu/sysemu.h"
44
#include "block/block_int.h"
L
Luiz Capitulino 已提交
45
#include "qmp-commands.h"
S
Stefan Hajnoczi 已提交
46
#include "trace.h"
47
#include "sysemu/arch_init.h"
48

49
static QTAILQ_HEAD(drivelist, DriveInfo) drives = QTAILQ_HEAD_INITIALIZER(drives);
50

51 52 53 54 55 56 57 58 59 60 61 62 63
static const char *const if_name[IF_COUNT] = {
    [IF_NONE] = "none",
    [IF_IDE] = "ide",
    [IF_SCSI] = "scsi",
    [IF_FLOPPY] = "floppy",
    [IF_PFLASH] = "pflash",
    [IF_MTD] = "mtd",
    [IF_SD] = "sd",
    [IF_VIRTIO] = "virtio",
    [IF_XEN] = "xen",
};

static const int if_max_devs[IF_COUNT] = {
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    /*
     * Do not change these numbers!  They govern how drive option
     * index maps to unit and bus.  That mapping is ABI.
     *
     * All controllers used to imlement if=T drives need to support
     * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
     * Otherwise, some index values map to "impossible" bus, unit
     * values.
     *
     * For instance, if you change [IF_SCSI] to 255, -drive
     * if=scsi,index=12 no longer means bus=1,unit=5, but
     * bus=0,unit=12.  With an lsi53c895a controller (7 units max),
     * the drive can't be set up.  Regression.
     */
    [IF_IDE] = 2,
    [IF_SCSI] = 7,
80 81
};

82 83 84 85 86 87 88 89 90 91 92
/*
 * We automatically delete the drive when a device using it gets
 * unplugged.  Questionable feature, but we can't just drop it.
 * Device models call blockdev_mark_auto_del() to schedule the
 * automatic deletion, and generic qdev code calls blockdev_auto_del()
 * when deletion is actually safe.
 */
void blockdev_mark_auto_del(BlockDriverState *bs)
{
    DriveInfo *dinfo = drive_get_by_blockdev(bs);

93 94 95 96
    if (dinfo && !dinfo->enable_auto_del) {
        return;
    }

97 98 99
    if (bs->job) {
        block_job_cancel(bs->job);
    }
100 101 102
    if (dinfo) {
        dinfo->auto_del = 1;
    }
103 104 105 106 107 108
}

void blockdev_auto_del(BlockDriverState *bs)
{
    DriveInfo *dinfo = drive_get_by_blockdev(bs);

109
    if (dinfo && dinfo->auto_del) {
110
        drive_put_ref(dinfo);
111 112 113
    }
}

114 115 116 117 118 119 120 121 122 123 124 125
static int drive_index_to_bus_id(BlockInterfaceType type, int index)
{
    int max_devs = if_max_devs[type];
    return max_devs ? index / max_devs : 0;
}

static int drive_index_to_unit_id(BlockInterfaceType type, int index)
{
    int max_devs = if_max_devs[type];
    return max_devs ? index % max_devs : index;
}

126 127 128 129 130 131
QemuOpts *drive_def(const char *optstr)
{
    return qemu_opts_parse(qemu_find_opts("drive"), optstr, 0);
}

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 139 140
    if (!opts) {
        return NULL;
    }
141 142 143 144 145 146 147
    if (type != IF_DEFAULT) {
        qemu_opt_set(opts, "if", if_name[type]);
    }
    if (index >= 0) {
        snprintf(buf, sizeof(buf), "%d", index);
        qemu_opt_set(opts, "index", buf);
    }
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
    if (file)
        qemu_opt_set(opts, "file", file);
    return opts;
}

DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
{
    DriveInfo *dinfo;

    /* seek interface, bus and unit */

    QTAILQ_FOREACH(dinfo, &drives, next) {
        if (dinfo->type == type &&
	    dinfo->bus == bus &&
	    dinfo->unit == unit)
            return dinfo;
    }

    return NULL;
}

169 170 171 172 173 174 175
DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
{
    return drive_get(type,
                     drive_index_to_bus_id(type, index),
                     drive_index_to_unit_id(type, index));
}

176 177 178 179 180 181 182 183 184 185 186 187 188 189
int drive_get_max_bus(BlockInterfaceType type)
{
    int max_bus;
    DriveInfo *dinfo;

    max_bus = -1;
    QTAILQ_FOREACH(dinfo, &drives, next) {
        if(dinfo->type == type &&
           dinfo->bus > max_bus)
            max_bus = dinfo->bus;
    }
    return max_bus;
}

190 191 192 193 194 195 196 197 198 199
/* Get a block device.  This should only be used for single-drive devices
   (e.g. SD/Floppy/MTD).  Multi-disk devices (scsi/ide) should use the
   appropriate bus.  */
DriveInfo *drive_get_next(BlockInterfaceType type)
{
    static int next_block_unit[IF_COUNT];

    return drive_get(type, 0, next_block_unit[type]++);
}

200
DriveInfo *drive_get_by_blockdev(BlockDriverState *bs)
201 202 203 204
{
    DriveInfo *dinfo;

    QTAILQ_FOREACH(dinfo, &drives, next) {
205 206 207
        if (dinfo->bdrv == bs) {
            return dinfo;
        }
208
    }
209
    return NULL;
210 211 212 213
}

static void bdrv_format_print(void *opaque, const char *name)
{
214
    error_printf(" %s", name);
215 216
}

217
static void drive_uninit(DriveInfo *dinfo)
218
{
219 220 221 222
    if (dinfo->opts) {
        qemu_opts_del(dinfo->opts);
    }

F
Fam Zheng 已提交
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 231 232 233 234 235 236 237 238 239 240 241 242
void drive_put_ref(DriveInfo *dinfo)
{
    assert(dinfo->refcount);
    if (--dinfo->refcount == 0) {
        drive_uninit(dinfo);
    }
}

void drive_get_ref(DriveInfo *dinfo)
{
    dinfo->refcount++;
}

243 244
typedef struct {
    QEMUBH *bh;
F
Fam Zheng 已提交
245 246
    BlockDriverState *bs;
} BDRVPutRefBH;
247

F
Fam Zheng 已提交
248
static void bdrv_put_ref_bh(void *opaque)
249
{
F
Fam Zheng 已提交
250
    BDRVPutRefBH *s = opaque;
251

F
Fam Zheng 已提交
252
    bdrv_unref(s->bs);
253 254 255 256 257
    qemu_bh_delete(s->bh);
    g_free(s);
}

/*
F
Fam Zheng 已提交
258
 * Release a BDS reference in a BH
259
 *
F
Fam Zheng 已提交
260 261 262
 * It is not safe to use bdrv_unref() from a callback function when the callers
 * still need the BlockDriverState.  In such cases we schedule a BH to release
 * the reference.
263
 */
F
Fam Zheng 已提交
264
static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
265
{
F
Fam Zheng 已提交
266
    BDRVPutRefBH *s;
267

F
Fam Zheng 已提交
268 269 270
    s = g_new(BDRVPutRefBH, 1);
    s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
    s->bs = bs;
271 272 273
    qemu_bh_schedule(s->bh);
}

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 286
        error_setg(errp, "'%s' invalid %s error action",
                   buf, is_read ? "read" : "write");
287 288 289 290
        return -1;
    }
}

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
static inline int parse_enum_option(const char *lookup[], const char *buf,
                                    int max, int def, Error **errp)
{
    int i;

    if (!buf) {
        return def;
    }

    for (i = 0; i < max; i++) {
        if (!strcmp(buf, lookup[i])) {
            return i;
        }
    }

    error_setg(errp, "invalid parameter value: %s", buf);
    return def;
}

310
static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
311
{
312 313 314
    if (throttle_conflicting(cfg)) {
        error_setg(errp, "bps/iops/max total values and read/write values"
                         " cannot be used at the same time");
315 316 317
        return false;
    }

318 319
    if (!throttle_is_valid(cfg)) {
        error_setg(errp, "bps/iops/maxs values must be 0 or greater");
320 321 322
        return false;
    }

323 324 325
    return true;
}

326 327
typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;

328
/* Takes the ownership of bs_opts */
M
Max Reitz 已提交
329
static DriveInfo *blockdev_init(const char *file, QDict *bs_opts,
330
                                Error **errp)
331 332 333 334 335 336 337
{
    const char *buf;
    const char *serial;
    int ro = 0;
    int bdrv_flags = 0;
    int on_read_error, on_write_error;
    DriveInfo *dinfo;
338
    ThrottleConfig cfg;
339
    int snapshot = 0;
340
    bool copy_on_read;
341
    int ret;
342
    Error *error = NULL;
343 344
    QemuOpts *opts;
    const char *id;
345
    bool has_driver_specific_opts;
346
    BlockdevDetectZeroesOptions detect_zeroes;
347
    BlockDriver *drv = NULL;
348

349 350 351
    /* Check common options by copying from bs_opts to opts, all other options
     * stay in bs_opts for processing by bdrv_open(). */
    id = qdict_get_try_str(bs_opts, "id");
352
    opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
353
    if (error) {
354
        error_propagate(errp, error);
355 356 357 358
        return NULL;
    }

    qemu_opts_absorb_qdict(opts, bs_opts, &error);
359
    if (error) {
360
        error_propagate(errp, error);
361
        goto early_err;
362 363 364 365 366 367
    }

    if (id) {
        qdict_del(bs_opts, "id");
    }

368 369
    has_driver_specific_opts = !!qdict_size(bs_opts);

370 371
    /* extract parameters */
    snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
372
    ro = qemu_opt_get_bool(opts, "read-only", 0);
373
    copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
374 375 376

    serial = qemu_opt_get(opts, "serial");

377 378
    if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
        if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
379
            error_setg(errp, "invalid discard option");
380
            goto early_err;
381 382 383
        }
    }

K
Kevin Wolf 已提交
384 385 386 387 388 389
    if (qemu_opt_get_bool(opts, "cache.writeback", true)) {
        bdrv_flags |= BDRV_O_CACHE_WB;
    }
    if (qemu_opt_get_bool(opts, "cache.direct", false)) {
        bdrv_flags |= BDRV_O_NOCACHE;
    }
390
    if (qemu_opt_get_bool(opts, "cache.no-flush", false)) {
K
Kevin Wolf 已提交
391
        bdrv_flags |= BDRV_O_NO_FLUSH;
392 393 394 395 396 397 398 399 400
    }

#ifdef CONFIG_LINUX_AIO
    if ((buf = qemu_opt_get(opts, "aio")) != NULL) {
        if (!strcmp(buf, "native")) {
            bdrv_flags |= BDRV_O_NATIVE_AIO;
        } else if (!strcmp(buf, "threads")) {
            /* this is the default */
        } else {
401
           error_setg(errp, "invalid aio option");
402
           goto early_err;
403 404 405 406 407
        }
    }
#endif

    if ((buf = qemu_opt_get(opts, "format")) != NULL) {
408 409 410 411
        if (is_help_option(buf)) {
            error_printf("Supported formats:");
            bdrv_iterate_format(bdrv_format_print, NULL);
            error_printf("\n");
412
            goto early_err;
413
        }
414

415
        drv = bdrv_find_format(buf);
416
        if (!drv) {
417
            error_setg(errp, "'%s' invalid format", buf);
418
            goto early_err;
419
        }
420 421
    }

422
    /* disk I/O throttling */
423 424
    memset(&cfg, 0, sizeof(cfg));
    cfg.buckets[THROTTLE_BPS_TOTAL].avg =
425
        qemu_opt_get_number(opts, "throttling.bps-total", 0);
426
    cfg.buckets[THROTTLE_BPS_READ].avg  =
427
        qemu_opt_get_number(opts, "throttling.bps-read", 0);
428
    cfg.buckets[THROTTLE_BPS_WRITE].avg =
429
        qemu_opt_get_number(opts, "throttling.bps-write", 0);
430
    cfg.buckets[THROTTLE_OPS_TOTAL].avg =
431
        qemu_opt_get_number(opts, "throttling.iops-total", 0);
432
    cfg.buckets[THROTTLE_OPS_READ].avg =
433
        qemu_opt_get_number(opts, "throttling.iops-read", 0);
434
    cfg.buckets[THROTTLE_OPS_WRITE].avg =
435
        qemu_opt_get_number(opts, "throttling.iops-write", 0);
436

437 438 439 440 441 442 443 444 445 446 447 448
    cfg.buckets[THROTTLE_BPS_TOTAL].max =
        qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
    cfg.buckets[THROTTLE_BPS_READ].max  =
        qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
    cfg.buckets[THROTTLE_BPS_WRITE].max =
        qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
    cfg.buckets[THROTTLE_OPS_TOTAL].max =
        qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
    cfg.buckets[THROTTLE_OPS_READ].max =
        qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
    cfg.buckets[THROTTLE_OPS_WRITE].max =
        qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
449

450
    cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
451 452

    if (!check_throttle_config(&cfg, &error)) {
453
        error_propagate(errp, error);
454
        goto early_err;
455 456
    }

457
    on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
458
    if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
459
        on_write_error = parse_block_error_action(buf, 0, &error);
460
        if (error) {
461
            error_propagate(errp, error);
462
            goto early_err;
463 464 465
        }
    }

466
    on_read_error = BLOCKDEV_ON_ERROR_REPORT;
467
    if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
468
        on_read_error = parse_block_error_action(buf, 1, &error);
469
        if (error) {
470
            error_propagate(errp, error);
471
            goto early_err;
472 473 474
        }
    }

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
    detect_zeroes =
        parse_enum_option(BlockdevDetectZeroesOptions_lookup,
                          qemu_opt_get(opts, "detect-zeroes"),
                          BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
                          BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
                          &error);
    if (error) {
        error_propagate(errp, error);
        goto early_err;
    }

    if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
        !(bdrv_flags & BDRV_O_UNMAP)) {
        error_setg(errp, "setting detect-zeroes to unmap is not allowed "
                         "without setting discard operation to unmap");
        goto early_err;
    }

493 494 495
    /* init */
    dinfo = g_malloc0(sizeof(*dinfo));
    dinfo->id = g_strdup(qemu_opts_id(opts));
K
Kevin Wolf 已提交
496 497 498 499 500
    dinfo->bdrv = bdrv_new(dinfo->id, &error);
    if (error) {
        error_propagate(errp, error);
        goto bdrv_new_err;
    }
501 502
    dinfo->bdrv->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
    dinfo->bdrv->read_only = ro;
503
    dinfo->bdrv->detect_zeroes = detect_zeroes;
504
    dinfo->refcount = 1;
505 506 507
    if (serial != NULL) {
        dinfo->serial = g_strdup(serial);
    }
508 509
    QTAILQ_INSERT_TAIL(&drives, dinfo, next);

510 511
    bdrv_set_on_error(dinfo->bdrv, on_read_error, on_write_error);

512
    /* disk I/O throttling */
513 514 515 516
    if (throttle_enabled(&cfg)) {
        bdrv_io_limits_enable(dinfo->bdrv);
        bdrv_set_io_limits(dinfo->bdrv, &cfg);
    }
517

518
    if (!file || !*file) {
519
        if (has_driver_specific_opts) {
520 521
            file = NULL;
        } else {
522 523
            QDECREF(bs_opts);
            qemu_opts_del(opts);
524 525
            return dinfo;
        }
526 527 528 529 530 531 532
    }
    if (snapshot) {
        /* always use cache=unsafe with snapshot */
        bdrv_flags &= ~BDRV_O_CACHE_MASK;
        bdrv_flags |= (BDRV_O_SNAPSHOT|BDRV_O_CACHE_WB|BDRV_O_NO_FLUSH);
    }

533 534 535 536
    if (copy_on_read) {
        bdrv_flags |= BDRV_O_COPY_ON_READ;
    }

537 538 539 540
    if (runstate_check(RUN_STATE_INMIGRATE)) {
        bdrv_flags |= BDRV_O_INCOMING;
    }

541 542
    bdrv_flags |= ro ? 0 : BDRV_O_RDWR;

543
    QINCREF(bs_opts);
544
    ret = bdrv_open(&dinfo->bdrv, file, NULL, bs_opts, bdrv_flags, drv, &error);
545

546
    if (ret < 0) {
547 548 549
        error_setg(errp, "could not open disk image %s: %s",
                   file ?: dinfo->id, error_get_pretty(error));
        error_free(error);
550
        goto err;
551 552 553 554
    }

    if (bdrv_key_required(dinfo->bdrv))
        autostart = 0;
555

556
    QDECREF(bs_opts);
557 558
    qemu_opts_del(opts);

559
    return dinfo;
560 561

err:
F
Fam Zheng 已提交
562
    bdrv_unref(dinfo->bdrv);
563
    QTAILQ_REMOVE(&drives, dinfo, next);
K
Kevin Wolf 已提交
564 565
bdrv_new_err:
    g_free(dinfo->id);
566
    g_free(dinfo);
567 568 569
early_err:
    QDECREF(bs_opts);
    qemu_opts_del(opts);
570
    return NULL;
571 572
}

573 574 575 576 577 578 579 580 581 582 583
static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to)
{
    const char *value;

    value = qemu_opt_get(opts, from);
    if (value) {
        qemu_opt_set(opts, to, value);
        qemu_opt_unset(opts, from);
    }
}

584 585 586 587 588
QemuOptsList qemu_legacy_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
    .desc = {
        {
589 590 591 592 593 594 595 596 597 598 599 600
            .name = "bus",
            .type = QEMU_OPT_NUMBER,
            .help = "bus number",
        },{
            .name = "unit",
            .type = QEMU_OPT_NUMBER,
            .help = "unit number (i.e. lun for scsi)",
        },{
            .name = "index",
            .type = QEMU_OPT_NUMBER,
            .help = "index number",
        },{
601 602 603
            .name = "media",
            .type = QEMU_OPT_STRING,
            .help = "media type (disk, cdrom)",
604 605 606 607
        },{
            .name = "if",
            .type = QEMU_OPT_STRING,
            .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
        },{
            .name = "cyls",
            .type = QEMU_OPT_NUMBER,
            .help = "number of cylinders (ide disk geometry)",
        },{
            .name = "heads",
            .type = QEMU_OPT_NUMBER,
            .help = "number of heads (ide disk geometry)",
        },{
            .name = "secs",
            .type = QEMU_OPT_NUMBER,
            .help = "number of sectors (ide disk geometry)",
        },{
            .name = "trans",
            .type = QEMU_OPT_STRING,
            .help = "chs translation (auto, lba, none)",
624 625 626 627
        },{
            .name = "boot",
            .type = QEMU_OPT_BOOL,
            .help = "(deprecated, ignored)",
628 629 630 631
        },{
            .name = "addr",
            .type = QEMU_OPT_STRING,
            .help = "pci address (virtio only)",
M
Max Reitz 已提交
632 633 634 635
        },{
            .name = "file",
            .type = QEMU_OPT_STRING,
            .help = "file name",
636
        },
637 638 639 640 641 642

        /* Options that are passed on, but have special semantics with -drive */
        {
            .name = "read-only",
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
643 644 645 646 647 648 649 650
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
651 652 653 654 655 656
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },

657 658 659 660
        { /* end of list */ }
    },
};

661 662
DriveInfo *drive_init(QemuOpts *all_opts, BlockInterfaceType block_default_type)
{
K
Kevin Wolf 已提交
663
    const char *value;
664
    DriveInfo *dinfo = NULL;
665
    QDict *bs_opts;
666 667
    QemuOpts *legacy_opts;
    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;
F
Fam Zheng 已提交
673 674
    bool read_only = false;
    bool copy_on_read;
M
Max Reitz 已提交
675
    const char *filename;
676
    Error *local_err = NULL;
K
Kevin Wolf 已提交
677

678 679 680 681 682 683 684 685 686
    /* Change legacy command line options into QMP ones */
    qemu_opt_rename(all_opts, "iops", "throttling.iops-total");
    qemu_opt_rename(all_opts, "iops_rd", "throttling.iops-read");
    qemu_opt_rename(all_opts, "iops_wr", "throttling.iops-write");

    qemu_opt_rename(all_opts, "bps", "throttling.bps-total");
    qemu_opt_rename(all_opts, "bps_rd", "throttling.bps-read");
    qemu_opt_rename(all_opts, "bps_wr", "throttling.bps-write");

687 688 689 690 691 692 693 694
    qemu_opt_rename(all_opts, "iops_max", "throttling.iops-total-max");
    qemu_opt_rename(all_opts, "iops_rd_max", "throttling.iops-read-max");
    qemu_opt_rename(all_opts, "iops_wr_max", "throttling.iops-write-max");

    qemu_opt_rename(all_opts, "bps_max", "throttling.bps-total-max");
    qemu_opt_rename(all_opts, "bps_rd_max", "throttling.bps-read-max");
    qemu_opt_rename(all_opts, "bps_wr_max", "throttling.bps-write-max");

695 696 697
    qemu_opt_rename(all_opts,
                    "iops_size", "throttling.iops-size");

698 699
    qemu_opt_rename(all_opts, "readonly", "read-only");

K
Kevin Wolf 已提交
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
    value = qemu_opt_get(all_opts, "cache");
    if (value) {
        int flags = 0;

        if (bdrv_parse_cache_flags(value, &flags) != 0) {
            error_report("invalid cache option");
            return NULL;
        }

        /* Specific options take precedence */
        if (!qemu_opt_get(all_opts, "cache.writeback")) {
            qemu_opt_set_bool(all_opts, "cache.writeback",
                              !!(flags & BDRV_O_CACHE_WB));
        }
        if (!qemu_opt_get(all_opts, "cache.direct")) {
            qemu_opt_set_bool(all_opts, "cache.direct",
                              !!(flags & BDRV_O_NOCACHE));
        }
        if (!qemu_opt_get(all_opts, "cache.no-flush")) {
            qemu_opt_set_bool(all_opts, "cache.no-flush",
                              !!(flags & BDRV_O_NO_FLUSH));
        }
        qemu_opt_unset(all_opts, "cache");
    }

725 726 727 728
    /* Get a QDict for processing the options */
    bs_opts = qdict_new();
    qemu_opts_to_qdict(all_opts, bs_opts);

729 730
    legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
                                   &error_abort);
731
    qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
732
    if (local_err) {
733 734 735 736 737
        qerror_report_err(local_err);
        error_free(local_err);
        goto fail;
    }

738 739 740 741 742 743 744
    /* Deprecated option boot=[on|off] */
    if (qemu_opt_get(legacy_opts, "boot") != NULL) {
        fprintf(stderr, "qemu-kvm: boot=on|off is deprecated and will be "
                "ignored. Future versions will reject this parameter. Please "
                "update your scripts.\n");
    }

745 746 747 748 749 750 751
    /* Media type */
    value = qemu_opt_get(legacy_opts, "media");
    if (value) {
        if (!strcmp(value, "disk")) {
            media = MEDIA_DISK;
        } else if (!strcmp(value, "cdrom")) {
            media = MEDIA_CDROM;
F
Fam Zheng 已提交
752
            read_only = true;
753 754 755 756 757 758
        } else {
            error_report("'%s' invalid media", value);
            goto fail;
        }
    }

759
    /* copy-on-read is disabled with a warning for read-only devices */
F
Fam Zheng 已提交
760
    read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
761 762 763 764 765 766 767 768 769 770 771 772
    copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);

    if (read_only && copy_on_read) {
        error_report("warning: disabling copy-on-read on read-only drive");
        copy_on_read = false;
    }

    qdict_put(bs_opts, "read-only",
              qstring_from_str(read_only ? "on" : "off"));
    qdict_put(bs_opts, "copy-on-read",
              qstring_from_str(copy_on_read ? "on" :"off"));

773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
    /* Controller type */
    value = qemu_opt_get(legacy_opts, "if");
    if (value) {
        for (type = 0;
             type < IF_COUNT && strcmp(value, if_name[type]);
             type++) {
        }
        if (type == IF_COUNT) {
            error_report("unsupported bus type '%s'", value);
            goto fail;
        }
    } else {
        type = block_default_type;
    }

788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
    /* Geometry */
    cyls  = qemu_opt_get_number(legacy_opts, "cyls", 0);
    heads = qemu_opt_get_number(legacy_opts, "heads", 0);
    secs  = qemu_opt_get_number(legacy_opts, "secs", 0);

    if (cyls || heads || secs) {
        if (cyls < 1) {
            error_report("invalid physical cyls number");
            goto fail;
        }
        if (heads < 1) {
            error_report("invalid physical heads number");
            goto fail;
        }
        if (secs < 1) {
            error_report("invalid physical secs number");
            goto fail;
        }
    }

    translation = BIOS_ATA_TRANSLATION_AUTO;
    value = qemu_opt_get(legacy_opts, "trans");
    if (value != NULL) {
        if (!cyls) {
            error_report("'%s' trans must be used with cyls, heads and secs",
                         value);
            goto fail;
        }
        if (!strcmp(value, "none")) {
            translation = BIOS_ATA_TRANSLATION_NONE;
        } else if (!strcmp(value, "lba")) {
            translation = BIOS_ATA_TRANSLATION_LBA;
820 821 822 823
        } else if (!strcmp(value, "large")) {
            translation = BIOS_ATA_TRANSLATION_LARGE;
        } else if (!strcmp(value, "rechs")) {
            translation = BIOS_ATA_TRANSLATION_RECHS;
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
        } else if (!strcmp(value, "auto")) {
            translation = BIOS_ATA_TRANSLATION_AUTO;
        } else {
            error_report("'%s' invalid translation type", value);
            goto fail;
        }
    }

    if (media == MEDIA_CDROM) {
        if (cyls || secs || heads) {
            error_report("CHS can't be set with media=cdrom");
            goto fail;
        }
    }

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
    /* Device address specified by bus/unit or index.
     * If none was specified, try to find the first free one. */
    bus_id  = qemu_opt_get_number(legacy_opts, "bus", 0);
    unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
    index   = qemu_opt_get_number(legacy_opts, "index", -1);

    max_devs = if_max_devs[type];

    if (index != -1) {
        if (bus_id != 0 || unit_id != -1) {
            error_report("index cannot be used with bus and unit");
            goto fail;
        }
        bus_id = drive_index_to_bus_id(type, index);
        unit_id = drive_index_to_unit_id(type, index);
    }

    if (unit_id == -1) {
       unit_id = 0;
       while (drive_get(type, bus_id, unit_id) != NULL) {
           unit_id++;
           if (max_devs && unit_id >= max_devs) {
               unit_id -= max_devs;
               bus_id++;
           }
       }
    }

    if (max_devs && unit_id >= max_devs) {
        error_report("unit %d too big (max is %d)", unit_id, max_devs - 1);
        goto fail;
    }

    if (drive_get(type, bus_id, unit_id) != NULL) {
        error_report("drive with bus=%d, unit=%d (index=%d) exists",
                     bus_id, unit_id, index);
        goto fail;
    }

    /* no id supplied -> create one */
    if (qemu_opts_id(all_opts) == NULL) {
        char *new_id;
        const char *mediastr = "";
        if (type == IF_IDE || type == IF_SCSI) {
            mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
        }
        if (max_devs) {
            new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
                                     mediastr, unit_id);
        } else {
            new_id = g_strdup_printf("%s%s%i", if_name[type],
                                     mediastr, unit_id);
        }
        qdict_put(bs_opts, "id", qstring_from_str(new_id));
        g_free(new_id);
    }

896 897 898 899 900 901 902 903 904
    /* Add virtio block device */
    devaddr = qemu_opt_get(legacy_opts, "addr");
    if (devaddr && type != IF_VIRTIO) {
        error_report("addr is not supported by this bus type");
        goto fail;
    }

    if (type == IF_VIRTIO) {
        QemuOpts *devopts;
905 906
        devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
                                   &error_abort);
907 908 909 910 911 912 913 914 915 916 917
        if (arch_type == QEMU_ARCH_S390X) {
            qemu_opt_set(devopts, "driver", "virtio-blk-s390");
        } else {
            qemu_opt_set(devopts, "driver", "virtio-blk-pci");
        }
        qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"));
        if (devaddr) {
            qemu_opt_set(devopts, "addr", devaddr);
        }
    }

M
Max Reitz 已提交
918 919
    filename = qemu_opt_get(legacy_opts, "file");

920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
    /* Check werror/rerror compatibility with if=... */
    werror = qemu_opt_get(legacy_opts, "werror");
    if (werror != NULL) {
        if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
            type != IF_NONE) {
            error_report("werror is not supported by this bus type");
            goto fail;
        }
        qdict_put(bs_opts, "werror", qstring_from_str(werror));
    }

    rerror = qemu_opt_get(legacy_opts, "rerror");
    if (rerror != NULL) {
        if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
            type != IF_NONE) {
            error_report("rerror is not supported by this bus type");
            goto fail;
        }
        qdict_put(bs_opts, "rerror", qstring_from_str(rerror));
    }

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 946 947
            qerror_report_err(local_err);
            error_free(local_err);
        }
948
        goto fail;
949
    } else {
950
        assert(!local_err);
951 952 953 954
    }

    /* Set legacy DriveInfo fields */
    dinfo->enable_auto_del = true;
955
    dinfo->opts = all_opts;
956

957 958 959 960 961
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

962
    dinfo->type = type;
963 964
    dinfo->bus = bus_id;
    dinfo->unit = unit_id;
965
    dinfo->devaddr = devaddr;
966

967 968 969 970 971 972 973 974 975 976 977
    switch(type) {
    case IF_IDE:
    case IF_SCSI:
    case IF_XEN:
    case IF_NONE:
        dinfo->media_cd = media == MEDIA_CDROM;
        break;
    default:
        break;
    }

978
fail:
979
    qemu_opts_del(legacy_opts);
980
    return dinfo;
981 982
}

983 984 985
void do_commit(Monitor *mon, const QDict *qdict)
{
    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 992
    } else {
        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 1000 1001
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
1002 1003 1004
    }
}

1005 1006
static void blockdev_do_action(int kind, void *data, Error **errp)
{
1007 1008
    TransactionAction action;
    TransactionActionList list;
1009 1010 1011 1012 1013 1014 1015 1016

    action.kind = kind;
    action.data = data;
    list.value = &action;
    list.next = NULL;
    qmp_transaction(&list, errp);
}

1017 1018 1019 1020 1021
void qmp_blockdev_snapshot_sync(bool has_device, const char *device,
                                bool has_node_name, const char *node_name,
                                const char *snapshot_file,
                                bool has_snapshot_node_name,
                                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 1029
        .has_node_name = has_node_name,
        .node_name = (char *) node_name,
1030
        .snapshot_file = (char *) snapshot_file,
1031 1032
        .has_snapshot_node_name = has_snapshot_node_name,
        .snapshot_node_name = (char *) snapshot_node_name,
1033 1034 1035 1036 1037
        .has_format = has_format,
        .format = (char *) format,
        .has_mode = has_mode,
        .mode = mode,
    };
1038 1039
    blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
                       &snapshot, errp);
1040 1041
}

1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
void qmp_blockdev_snapshot_internal_sync(const char *device,
                                         const char *name,
                                         Error **errp)
{
    BlockdevSnapshotInternal snapshot = {
        .device = (char *) device,
        .name = (char *) name
    };

    blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
                       &snapshot, errp);
}

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
                                                         bool has_id,
                                                         const char *id,
                                                         bool has_name,
                                                         const char *name,
                                                         Error **errp)
{
    BlockDriverState *bs = bdrv_find(device);
    QEMUSnapshotInfo sn;
    Error *local_err = NULL;
    SnapshotInfo *info = NULL;
    int ret;

    if (!bs) {
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return NULL;
    }

    if (!has_id) {
        id = NULL;
    }

    if (!has_name) {
        name = NULL;
    }

    if (!id && !name) {
        error_setg(errp, "Name or id must be provided");
        return NULL;
    }

    ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1087
    if (local_err) {
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
        error_propagate(errp, local_err);
        return NULL;
    }
    if (!ret) {
        error_setg(errp,
                   "Snapshot with id '%s' and name '%s' does not exist on "
                   "device '%s'",
                   STR_OR_NULL(id), STR_OR_NULL(name), device);
        return NULL;
    }

    bdrv_snapshot_delete(bs, id, name, &local_err);
1100
    if (local_err) {
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
        error_propagate(errp, local_err);
        return NULL;
    }

    info = g_malloc0(sizeof(SnapshotInfo));
    info->id = g_strdup(sn.id_str);
    info->name = g_strdup(sn.name);
    info->date_nsec = sn.date_nsec;
    info->date_sec = sn.date_sec;
    info->vm_state_size = sn.vm_state_size;
    info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
    info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;

    return info;
}
1116 1117

/* New and old BlockDriverState structs for group snapshots */
1118

1119
typedef struct BlkTransactionState BlkTransactionState;
1120 1121 1122 1123 1124 1125 1126

/* Only prepare() may fail. In a single transaction, only one of commit() or
   abort() will be called, clean() will always be called if it present. */
typedef struct BdrvActionOps {
    /* Size of state struct, in bytes. */
    size_t instance_size;
    /* 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 1135 1136 1137 1138 1139 1140
} BdrvActionOps;

/*
 * This structure must be arranged as first member in child type, assuming
 * that compiler will also arrange it to the same address with parent instance.
 * Later it will be used in free().
 */
1141
struct BlkTransactionState {
1142
    TransactionAction *action;
1143
    const BdrvActionOps *ops;
1144
    QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1145 1146
};

1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
/* internal snapshot private data */
typedef struct InternalSnapshotState {
    BlkTransactionState common;
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
} InternalSnapshotState;

static void internal_snapshot_prepare(BlkTransactionState *common,
                                      Error **errp)
{
1157
    Error *local_err = NULL;
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
    const char *device;
    const char *name;
    BlockDriverState *bs;
    QEMUSnapshotInfo old_sn, *sn;
    bool ret;
    qemu_timeval tv;
    BlockdevSnapshotInternal *internal;
    InternalSnapshotState *state;
    int ret1;

    g_assert(common->action->kind ==
             TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
    internal = common->action->blockdev_snapshot_internal_sync;
    state = DO_UPCAST(InternalSnapshotState, common, common);

    /* 1. parse input */
    device = internal->device;
    name = internal->name;

    /* 2. check for validation */
    bs = bdrv_find(device);
    if (!bs) {
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
    }

    if (!bdrv_is_inserted(bs)) {
        error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
        return;
    }

    if (bdrv_is_read_only(bs)) {
        error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
        return;
    }

    if (!bdrv_can_snapshot(bs)) {
        error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
                  bs->drv->format_name, device, "internal snapshot");
        return;
    }

    if (!strlen(name)) {
        error_setg(errp, "Name is empty");
        return;
    }

    /* check whether a snapshot with name exist */
1206 1207 1208 1209
    ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
                                            &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
        return;
    } else if (ret) {
        error_setg(errp,
                   "Snapshot with name '%s' already exists on device '%s'",
                   name, device);
        return;
    }

    /* 3. take the snapshot */
    sn = &state->sn;
    pstrcpy(sn->name, sizeof(sn->name), name);
    qemu_gettimeofday(&tv);
    sn->date_sec = tv.tv_sec;
    sn->date_nsec = tv.tv_usec * 1000;
    sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);

    ret1 = bdrv_snapshot_create(bs, sn);
    if (ret1 < 0) {
        error_setg_errno(errp, -ret1,
                         "Failed to create snapshot '%s' on device '%s'",
                         name, device);
        return;
    }

    /* 4. succeed, mark a snapshot is created */
    state->bs = bs;
}

static void internal_snapshot_abort(BlkTransactionState *common)
{
    InternalSnapshotState *state =
                             DO_UPCAST(InternalSnapshotState, common, common);
    BlockDriverState *bs = state->bs;
    QEMUSnapshotInfo *sn = &state->sn;
    Error *local_error = NULL;

    if (!bs) {
        return;
    }

    if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
        error_report("Failed to delete snapshot with id '%s' and name '%s' on "
                     "device '%s' in abort: %s",
                     sn->id_str,
                     sn->name,
                     bdrv_get_device_name(bs),
                     error_get_pretty(local_error));
        error_free(local_error);
    }
}

1261
/* external snapshot private data */
1262 1263
typedef struct ExternalSnapshotState {
    BlkTransactionState common;
1264 1265
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1266
} ExternalSnapshotState;
1267

1268
static void external_snapshot_prepare(BlkTransactionState *common,
1269 1270 1271 1272
                                      Error **errp)
{
    BlockDriver *drv;
    int flags, ret;
1273
    QDict *options = NULL;
1274
    Error *local_err = NULL;
1275
    bool has_device = false;
1276
    const char *device;
1277 1278 1279 1280
    bool has_node_name = false;
    const char *node_name;
    bool has_snapshot_node_name = false;
    const char *snapshot_node_name;
1281 1282 1283
    const char *new_image_file;
    const char *format = "qcow2";
    enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1284 1285
    ExternalSnapshotState *state =
                             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 1294 1295 1296 1297 1298
    has_node_name = action->blockdev_snapshot_sync->has_node_name;
    node_name = action->blockdev_snapshot_sync->node_name;
    has_snapshot_node_name =
        action->blockdev_snapshot_sync->has_snapshot_node_name;
    snapshot_node_name = action->blockdev_snapshot_sync->snapshot_node_name;

1299 1300 1301 1302 1303 1304 1305 1306 1307
    new_image_file = action->blockdev_snapshot_sync->snapshot_file;
    if (action->blockdev_snapshot_sync->has_format) {
        format = action->blockdev_snapshot_sync->format;
    }
    if (action->blockdev_snapshot_sync->has_mode) {
        mode = action->blockdev_snapshot_sync->mode;
    }

    /* start processing */
1308 1309 1310 1311 1312 1313
    drv = bdrv_find_format(format);
    if (!drv) {
        error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
        return;
    }

1314 1315 1316
    state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
                                   has_node_name ? node_name : NULL,
                                   &local_err);
1317
    if (local_err) {
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
        error_propagate(errp, local_err);
        return;
    }

    if (has_node_name && !has_snapshot_node_name) {
        error_setg(errp, "New snapshot node name missing");
        return;
    }

    if (has_snapshot_node_name && bdrv_find_node(snapshot_node_name)) {
        error_setg(errp, "New snapshot node name already existing");
1329 1330 1331
        return;
    }

1332
    if (!bdrv_is_inserted(state->old_bs)) {
1333 1334 1335 1336
        error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
        return;
    }

1337 1338
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1339 1340 1341
        return;
    }

1342 1343
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1344 1345 1346 1347 1348
            error_set(errp, QERR_IO_ERROR);
            return;
        }
    }

1349
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1350 1351 1352 1353
        error_set(errp, QERR_FEATURE_DISABLED, "snapshot");
        return;
    }

1354
    flags = state->old_bs->open_flags;
1355 1356 1357 1358

    /* create new image w/backing file */
    if (mode != NEW_IMAGE_MODE_EXISTING) {
        bdrv_img_create(new_image_file, format,
1359 1360
                        state->old_bs->filename,
                        state->old_bs->drv->format_name,
1361
                        NULL, -1, flags, &local_err, false);
1362
        if (local_err) {
1363 1364 1365 1366 1367
            error_propagate(errp, local_err);
            return;
        }
    }

1368 1369 1370 1371 1372 1373
    if (has_snapshot_node_name) {
        options = qdict_new();
        qdict_put(options, "node-name",
                  qstring_from_str(snapshot_node_name));
    }

1374 1375
    /* TODO Inherit bs->options or only take explicit options with an
     * 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 1388
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1389

1390 1391
    /* This removes our old bs and adds the new bs */
    bdrv_append(state->new_bs, state->old_bs);
1392 1393 1394
    /* We don't need (or want) to use the transactional
     * bdrv_reopen_multiple() across all the entries at once, because we
     * 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 1397 1398
                NULL);
}

1399
static void external_snapshot_abort(BlkTransactionState *common)
1400
{
1401 1402 1403
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
F
Fam Zheng 已提交
1404
        bdrv_unref(state->new_bs);
1405 1406 1407
    }
}

1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
typedef struct DriveBackupState {
    BlkTransactionState common;
    BlockDriverState *bs;
    BlockJob *job;
} DriveBackupState;

static void drive_backup_prepare(BlkTransactionState *common, Error **errp)
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
    DriveBackup *backup;
    Error *local_err = NULL;

    assert(common->action->kind == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
    backup = common->action->drive_backup;

    qmp_drive_backup(backup->device, backup->target,
                     backup->has_format, backup->format,
1425
                     backup->sync,
1426 1427 1428 1429 1430
                     backup->has_mode, backup->mode,
                     backup->has_speed, backup->speed,
                     backup->has_on_source_error, backup->on_source_error,
                     backup->has_on_target_error, backup->on_target_error,
                     &local_err);
1431
    if (local_err) {
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
        error_propagate(errp, local_err);
        state->bs = NULL;
        state->job = NULL;
        return;
    }

    state->bs = bdrv_find(backup->device);
    state->job = state->bs->job;
}

static void drive_backup_abort(BlkTransactionState *common)
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
    BlockDriverState *bs = state->bs;

    /* Only cancel if it's the job we started */
    if (bs && bs->job && bs->job == state->job) {
        block_job_cancel_sync(bs->job);
    }
}

1453 1454 1455 1456 1457 1458 1459
static void abort_prepare(BlkTransactionState *common, Error **errp)
{
    error_setg(errp, "Transaction aborted using Abort action");
}

static void abort_commit(BlkTransactionState *common)
{
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 1467 1468 1469
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
    },
1470 1471 1472 1473 1474
    [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
        .instance_size = sizeof(DriveBackupState),
        .prepare = drive_backup_prepare,
        .abort = drive_backup_abort,
    },
1475 1476 1477 1478 1479
    [TRANSACTION_ACTION_KIND_ABORT] = {
        .instance_size = sizeof(BlkTransactionState),
        .prepare = abort_prepare,
        .commit = abort_commit,
    },
1480 1481 1482 1483 1484
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
        .instance_size = sizeof(InternalSnapshotState),
        .prepare  = internal_snapshot_prepare,
        .abort = internal_snapshot_abort,
    },
1485 1486
};

1487 1488 1489 1490 1491
/*
 * 'Atomic' group snapshots.  The snapshots are taken as a set, and if any fail
 *  then we do not pivot any of the devices in the group, and abandon the
 *  snapshots
 */
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 1500 1501 1502 1503 1504 1505
    QSIMPLEQ_INIT(&snap_bdrv_states);

    /* drain all i/o before any snapshots */
    bdrv_drain_all();

    /* We don't do anything in this loop that commits us to the snapshot */
    while (NULL != dev_entry) {
1506
        TransactionAction *dev_info = NULL;
1507
        const BdrvActionOps *ops;
1508

1509 1510 1511
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

1512 1513 1514
        assert(dev_info->kind < ARRAY_SIZE(actions));

        ops = &actions[dev_info->kind];
1515 1516
        assert(ops->instance_size > 0);

1517 1518 1519 1520
        state = g_malloc0(ops->instance_size);
        state->ops = ops;
        state->action = dev_info;
        QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1521

1522
        state->ops->prepare(state, &local_err);
1523
        if (local_err) {
1524 1525
            error_propagate(errp, local_err);
            goto delete_and_fail;
1526 1527 1528
        }
    }

1529
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1530 1531 1532
        if (state->ops->commit) {
            state->ops->commit(state);
        }
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
    }

    /* success */
    goto exit;

delete_and_fail:
    /*
    * failure, and it is all-or-none; abandon each new bs, and keep using
    * the original bs for all images
    */
1543 1544 1545
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
        if (state->ops->abort) {
            state->ops->abort(state);
1546
        }
1547 1548
    }
exit:
1549 1550 1551
    QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
        if (state->ops->clean) {
            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 1562
        return;
    }
1563
    if (!bdrv_dev_has_removable_media(bs)) {
1564 1565
        error_setg(errp, "Device '%s' is not removable",
                   bdrv_get_device_name(bs));
1566
        return;
1567
    }
1568

P
Paolo Bonzini 已提交
1569 1570 1571
    if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
        bdrv_dev_eject_request(bs, force);
        if (!force) {
1572 1573
            error_setg(errp, "Device '%s' is locked",
                       bdrv_get_device_name(bs));
1574
            return;
P
Paolo Bonzini 已提交
1575
        }
1576
    }
1577

1578
    bdrv_close(bs);
1579 1580
}

L
Luiz Capitulino 已提交
1581
void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1582 1583 1584
{
    BlockDriverState *bs;

L
Luiz Capitulino 已提交
1585
    bs = bdrv_find(device);
1586
    if (!bs) {
L
Luiz Capitulino 已提交
1587 1588
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
1589 1590
    }

L
Luiz Capitulino 已提交
1591
    eject_device(bs, force, errp);
1592 1593
}

1594 1595 1596
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
1597
{
1598
    Error *local_err = NULL;
1599 1600 1601
    BlockDriverState *bs;
    int err;

1602 1603 1604
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
1605
    if (local_err) {
1606
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
1607
        return;
1608 1609
    }

L
Luiz Capitulino 已提交
1610
    err = bdrv_set_key(bs, password);
1611
    if (err == -EINVAL) {
L
Luiz Capitulino 已提交
1612 1613
        error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
        return;
1614
    } else if (err < 0) {
L
Luiz Capitulino 已提交
1615 1616
        error_set(errp, QERR_INVALID_PASSWORD);
        return;
1617 1618 1619
    }
}

L
Luiz Capitulino 已提交
1620 1621 1622 1623
static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
                                    int bdrv_flags, BlockDriver *drv,
                                    const char *password, Error **errp)
{
1624
    Error *local_err = NULL;
1625 1626
    int ret;

1627
    ret = bdrv_open(&bs, filename, NULL, NULL, bdrv_flags, drv, &local_err);
1628
    if (ret < 0) {
1629
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
        return;
    }

    if (bdrv_key_required(bs)) {
        if (password) {
            if (bdrv_set_key(bs, password) < 0) {
                error_set(errp, QERR_INVALID_PASSWORD);
            }
        } else {
            error_set(errp, QERR_DEVICE_ENCRYPTED, bdrv_get_device_name(bs),
                      bdrv_get_encrypted_filename(bs));
        }
    } else if (password) {
        error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
    }
}

void qmp_change_blockdev(const char *device, const char *filename,
1648
                         const char *format, Error **errp)
1649 1650 1651 1652
{
    BlockDriverState *bs;
    BlockDriver *drv = NULL;
    int bdrv_flags;
1653
    Error *err = NULL;
1654 1655 1656

    bs = bdrv_find(device);
    if (!bs) {
L
Luiz Capitulino 已提交
1657 1658
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
1659
    }
L
Luiz Capitulino 已提交
1660 1661

    if (format) {
1662
        drv = bdrv_find_whitelisted_format(format, bs->read_only);
1663
        if (!drv) {
L
Luiz Capitulino 已提交
1664 1665
            error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
            return;
1666 1667
        }
    }
L
Luiz Capitulino 已提交
1668

1669
    eject_device(bs, 0, &err);
1670
    if (err) {
L
Luiz Capitulino 已提交
1671 1672
        error_propagate(errp, err);
        return;
1673
    }
L
Luiz Capitulino 已提交
1674

1675
    bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1676
    bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
L
Luiz Capitulino 已提交
1677 1678

    qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1679
}
1680

Z
Zhi Yong Wu 已提交
1681
/* throttling disk I/O limits */
1682
void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
                               int64_t bps_wr,
                               int64_t iops,
                               int64_t iops_rd,
                               int64_t iops_wr,
                               bool has_bps_max,
                               int64_t bps_max,
                               bool has_bps_rd_max,
                               int64_t bps_rd_max,
                               bool has_bps_wr_max,
                               int64_t bps_wr_max,
                               bool has_iops_max,
                               int64_t iops_max,
                               bool has_iops_rd_max,
                               int64_t iops_rd_max,
                               bool has_iops_wr_max,
1698 1699 1700
                               int64_t iops_wr_max,
                               bool has_iops_size,
                               int64_t iops_size, Error **errp)
Z
Zhi Yong Wu 已提交
1701
{
1702
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
1703 1704
    BlockDriverState *bs;

1705
    bs = bdrv_find(device);
Z
Zhi Yong Wu 已提交
1706
    if (!bs) {
1707 1708
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
Z
Zhi Yong Wu 已提交
1709 1710
    }

1711 1712 1713 1714 1715 1716 1717 1718 1719
    memset(&cfg, 0, sizeof(cfg));
    cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
    cfg.buckets[THROTTLE_BPS_READ].avg  = bps_rd;
    cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;

    cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
    cfg.buckets[THROTTLE_OPS_READ].avg  = iops_rd;
    cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;

1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
    if (has_bps_max) {
        cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
    }
    if (has_bps_rd_max) {
        cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
    }
    if (has_bps_wr_max) {
        cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
    }
    if (has_iops_max) {
        cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
    }
    if (has_iops_rd_max) {
        cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
    }
    if (has_iops_wr_max) {
        cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
    }
Z
Zhi Yong Wu 已提交
1738

1739 1740 1741
    if (has_iops_size) {
        cfg.op_size = iops_size;
    }
1742 1743

    if (!check_throttle_config(&cfg, errp)) {
1744
        return;
Z
Zhi Yong Wu 已提交
1745 1746
    }

1747
    if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
Z
Zhi Yong Wu 已提交
1748
        bdrv_io_limits_enable(bs);
1749
    } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
Z
Zhi Yong Wu 已提交
1750
        bdrv_io_limits_disable(bs);
1751 1752 1753 1754
    }

    if (bs->io_limits_enabled) {
        bdrv_set_io_limits(bs, &cfg);
Z
Zhi Yong Wu 已提交
1755 1756 1757
    }
}

1758 1759 1760 1761
int do_drive_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
{
    const char *id = qdict_get_str(qdict, "id");
    BlockDriverState *bs;
1762
    Error *local_err = NULL;
1763 1764 1765 1766 1767 1768

    bs = bdrv_find(id);
    if (!bs) {
        qerror_report(QERR_DEVICE_NOT_FOUND, id);
        return -1;
    }
1769 1770 1771
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
        error_report("%s", error_get_pretty(local_err));
        error_free(local_err);
M
Marcelo Tosatti 已提交
1772 1773
        return -1;
    }
1774 1775

    /* quiesce block driver; prevent further io */
1776
    bdrv_drain_all();
1777 1778 1779
    bdrv_flush(bs);
    bdrv_close(bs);

1780
    /* if we have a device attached to this BlockDriverState
1781 1782 1783 1784
     * then we need to make the drive anonymous until the device
     * can be removed.  If this is a drive with no device backing
     * then we can just get rid of the block driver state right here.
     */
1785
    if (bdrv_get_attached_dev(bs)) {
1786
        bdrv_make_anon(bs);
1787 1788 1789 1790

        /* Further I/O must not pause the guest */
        bdrv_set_on_error(bs, BLOCKDEV_ON_ERROR_REPORT,
                          BLOCKDEV_ON_ERROR_REPORT);
1791 1792
    } else {
        drive_uninit(drive_get_by_blockdev(bs));
1793 1794 1795 1796
    }

    return 0;
}
1797

1798 1799 1800
void qmp_block_resize(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      int64_t size, Error **errp)
1801
{
1802
    Error *local_err = NULL;
1803
    BlockDriverState *bs;
1804
    int ret;
1805

1806 1807 1808
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
1809
    if (local_err) {
1810 1811 1812 1813 1814 1815
        error_propagate(errp, local_err);
        return;
    }

    if (!bdrv_is_first_non_filter(bs)) {
        error_set(errp, QERR_FEATURE_DISABLED, "resize");
L
Luiz Capitulino 已提交
1816
        return;
1817 1818 1819
    }

    if (size < 0) {
1820
        error_set(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
L
Luiz Capitulino 已提交
1821
        return;
1822 1823
    }

1824 1825 1826
    /* complete all in-flight operations before resizing the device */
    bdrv_drain_all();

1827 1828
    ret = bdrv_truncate(bs, size);
    switch (ret) {
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843
    case 0:
        break;
    case -ENOMEDIUM:
        error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
        break;
    case -ENOTSUP:
        error_set(errp, QERR_UNSUPPORTED);
        break;
    case -EACCES:
        error_set(errp, QERR_DEVICE_IS_READ_ONLY, device);
        break;
    case -EBUSY:
        error_set(errp, QERR_DEVICE_IN_USE, device);
        break;
    default:
1844
        error_setg_errno(errp, -ret, "Could not resize");
1845
        break;
1846 1847
    }
}
S
Stefan Hajnoczi 已提交
1848

1849
static void block_job_cb(void *opaque, int ret)
S
Stefan Hajnoczi 已提交
1850 1851 1852 1853
{
    BlockDriverState *bs = opaque;
    QObject *obj;

1854
    trace_block_job_cb(bs, bs->job, ret);
S
Stefan Hajnoczi 已提交
1855 1856 1857 1858 1859 1860 1861 1862

    assert(bs->job);
    obj = qobject_from_block_job(bs->job);
    if (ret < 0) {
        QDict *dict = qobject_to_qdict(obj);
        qdict_put(dict, "error", qstring_from_str(strerror(-ret)));
    }

1863 1864 1865 1866 1867
    if (block_job_is_cancelled(bs->job)) {
        monitor_protocol_event(QEVENT_BLOCK_JOB_CANCELLED, obj);
    } else {
        monitor_protocol_event(QEVENT_BLOCK_JOB_COMPLETED, obj);
    }
S
Stefan Hajnoczi 已提交
1868
    qobject_decref(obj);
1869

F
Fam Zheng 已提交
1870
    bdrv_put_ref_bh_schedule(bs);
S
Stefan Hajnoczi 已提交
1871 1872 1873
}

void qmp_block_stream(const char *device, bool has_base,
P
Paolo Bonzini 已提交
1874 1875 1876
                      const char *base, bool has_speed, int64_t speed,
                      bool has_on_error, BlockdevOnError on_error,
                      Error **errp)
S
Stefan Hajnoczi 已提交
1877 1878
{
    BlockDriverState *bs;
1879
    BlockDriverState *base_bs = NULL;
1880
    Error *local_err = NULL;
S
Stefan Hajnoczi 已提交
1881

P
Paolo Bonzini 已提交
1882 1883 1884 1885
    if (!has_on_error) {
        on_error = BLOCKDEV_ON_ERROR_REPORT;
    }

S
Stefan Hajnoczi 已提交
1886 1887 1888 1889 1890 1891 1892
    bs = bdrv_find(device);
    if (!bs) {
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
    }

    if (base) {
1893 1894 1895 1896 1897
        base_bs = bdrv_find_backing_image(bs, base);
        if (base_bs == NULL) {
            error_set(errp, QERR_BASE_NOT_FOUND, base);
            return;
        }
S
Stefan Hajnoczi 已提交
1898 1899
    }

1900
    stream_start(bs, base_bs, base, has_speed ? speed : 0,
P
Paolo Bonzini 已提交
1901
                 on_error, block_job_cb, bs, &local_err);
1902
    if (local_err) {
1903 1904
        error_propagate(errp, local_err);
        return;
S
Stefan Hajnoczi 已提交
1905 1906 1907 1908
    }

    trace_qmp_block_stream(bs, bs->job);
}
1909

1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
void qmp_block_commit(const char *device,
                      bool has_base, const char *base, const char *top,
                      bool has_speed, int64_t speed,
                      Error **errp)
{
    BlockDriverState *bs;
    BlockDriverState *base_bs, *top_bs;
    Error *local_err = NULL;
    /* This will be part of the QMP command, if/when the
     * BlockdevOnError change for blkmirror makes it in
     */
1921
    BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
1922

1923 1924 1925 1926
    if (!has_speed) {
        speed = 0;
    }

1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
    /* drain all i/o before commits */
    bdrv_drain_all();

    bs = bdrv_find(device);
    if (!bs) {
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
    }

    /* default top_bs is the active layer */
    top_bs = bs;

    if (top) {
        if (strcmp(bs->filename, top) != 0) {
            top_bs = bdrv_find_backing_image(bs, top);
        }
    }

    if (top_bs == NULL) {
        error_setg(errp, "Top image file %s not found", top ? top : "NULL");
        return;
    }

1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
    if (has_base && base) {
        base_bs = bdrv_find_backing_image(top_bs, base);
    } else {
        base_bs = bdrv_find_base(top_bs);
    }

    if (base_bs == NULL) {
        error_set(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
        return;
    }

F
Fam Zheng 已提交
1961 1962 1963 1964 1965 1966 1967
    if (top_bs == bs) {
        commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
                            bs, &local_err);
    } else {
        commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
                    &local_err);
    }
1968 1969 1970 1971 1972 1973
    if (local_err != NULL) {
        error_propagate(errp, local_err);
        return;
    }
}

1974 1975
void qmp_drive_backup(const char *device, const char *target,
                      bool has_format, const char *format,
1976
                      enum MirrorSyncMode sync,
1977 1978 1979 1980 1981 1982 1983 1984
                      bool has_mode, enum NewImageMode mode,
                      bool has_speed, int64_t speed,
                      bool has_on_source_error, BlockdevOnError on_source_error,
                      bool has_on_target_error, BlockdevOnError on_target_error,
                      Error **errp)
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
1985
    BlockDriverState *source = NULL;
1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
    BlockDriver *drv = NULL;
    Error *local_err = NULL;
    int flags;
    int64_t size;
    int ret;

    if (!has_speed) {
        speed = 0;
    }
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_mode) {
        mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }

    bs = bdrv_find(device);
    if (!bs) {
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
    }

    if (!bdrv_is_inserted(bs)) {
        error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
        return;
    }

    if (!has_format) {
        format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
    }
    if (format) {
        drv = bdrv_find_format(format);
        if (!drv) {
            error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
            return;
        }
    }

2027
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2028 2029 2030 2031 2032
        return;
    }

    flags = bs->open_flags | BDRV_O_RDWR;

2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
    /* See if we have a backing HD we can use to create our new image
     * on top of. */
    if (sync == MIRROR_SYNC_MODE_TOP) {
        source = bs->backing_hd;
        if (!source) {
            sync = MIRROR_SYNC_MODE_FULL;
        }
    }
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }

2045 2046 2047 2048 2049 2050 2051 2052
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
        return;
    }

    if (mode != NEW_IMAGE_MODE_EXISTING) {
        assert(format && drv);
2053 2054 2055 2056 2057 2058 2059 2060
        if (source) {
            bdrv_img_create(target, format, source->filename,
                            source->drv->format_name, NULL,
                            size, flags, &local_err, false);
        } else {
            bdrv_img_create(target, format, NULL, NULL, NULL,
                            size, flags, &local_err, false);
        }
2061 2062
    }

2063
    if (local_err) {
2064 2065 2066 2067
        error_propagate(errp, local_err);
        return;
    }

2068
    target_bs = NULL;
2069
    ret = bdrv_open(&target_bs, target, NULL, NULL, flags, drv, &local_err);
2070
    if (ret < 0) {
2071
        error_propagate(errp, local_err);
2072 2073 2074
        return;
    }

2075
    backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
2076 2077
                 block_job_cb, bs, &local_err);
    if (local_err != NULL) {
F
Fam Zheng 已提交
2078
        bdrv_unref(target_bs);
2079 2080 2081 2082 2083
        error_propagate(errp, local_err);
        return;
    }
}

2084 2085 2086 2087 2088
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
    return bdrv_named_nodes_list();
}

2089 2090
#define DEFAULT_MIRROR_BUF_SIZE   (10 << 20)

P
Paolo Bonzini 已提交
2091 2092 2093 2094
void qmp_drive_mirror(const char *device, const char *target,
                      bool has_format, const char *format,
                      enum MirrorSyncMode sync,
                      bool has_mode, enum NewImageMode mode,
2095
                      bool has_speed, int64_t speed,
2096
                      bool has_granularity, uint32_t granularity,
2097
                      bool has_buf_size, int64_t buf_size,
2098 2099 2100
                      bool has_on_source_error, BlockdevOnError on_source_error,
                      bool has_on_target_error, BlockdevOnError on_target_error,
                      Error **errp)
P
Paolo Bonzini 已提交
2101 2102 2103 2104 2105 2106
{
    BlockDriverState *bs;
    BlockDriverState *source, *target_bs;
    BlockDriver *drv = NULL;
    Error *local_err = NULL;
    int flags;
2107
    int64_t size;
P
Paolo Bonzini 已提交
2108 2109 2110 2111 2112
    int ret;

    if (!has_speed) {
        speed = 0;
    }
2113 2114 2115 2116 2117 2118
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
P
Paolo Bonzini 已提交
2119 2120 2121
    if (!has_mode) {
        mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
2122 2123 2124
    if (!has_granularity) {
        granularity = 0;
    }
2125 2126 2127 2128
    if (!has_buf_size) {
        buf_size = DEFAULT_MIRROR_BUF_SIZE;
    }

2129 2130 2131 2132 2133 2134 2135 2136
    if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
        error_set(errp, QERR_INVALID_PARAMETER, device);
        return;
    }
    if (granularity & (granularity - 1)) {
        error_set(errp, QERR_INVALID_PARAMETER, device);
        return;
    }
P
Paolo Bonzini 已提交
2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159

    bs = bdrv_find(device);
    if (!bs) {
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
    }

    if (!bdrv_is_inserted(bs)) {
        error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
        return;
    }

    if (!has_format) {
        format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
    }
    if (format) {
        drv = bdrv_find_format(format);
        if (!drv) {
            error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
            return;
        }
    }

2160
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
P
Paolo Bonzini 已提交
2161 2162 2163 2164 2165 2166 2167 2168
        return;
    }

    flags = bs->open_flags | BDRV_O_RDWR;
    source = bs->backing_hd;
    if (!source && sync == MIRROR_SYNC_MODE_TOP) {
        sync = MIRROR_SYNC_MODE_FULL;
    }
2169 2170 2171
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }
P
Paolo Bonzini 已提交
2172

2173 2174 2175 2176 2177 2178
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
        return;
    }

2179 2180 2181
    if ((sync == MIRROR_SYNC_MODE_FULL || !source)
        && mode != NEW_IMAGE_MODE_EXISTING)
    {
P
Paolo Bonzini 已提交
2182 2183
        /* create new image w/o backing file */
        assert(format && drv);
2184
        bdrv_img_create(target, format,
2185
                        NULL, NULL, NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
2186 2187 2188 2189 2190 2191
    } else {
        switch (mode) {
        case NEW_IMAGE_MODE_EXISTING:
            break;
        case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
            /* create new image with backing file */
2192 2193 2194
            bdrv_img_create(target, format,
                            source->filename,
                            source->drv->format_name,
2195
                            NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
2196 2197 2198 2199 2200 2201
            break;
        default:
            abort();
        }
    }

2202
    if (local_err) {
2203
        error_propagate(errp, local_err);
P
Paolo Bonzini 已提交
2204 2205 2206
        return;
    }

2207 2208 2209
    /* Mirroring takes care of copy-on-write using the source's backing
     * file.
     */
2210
    target_bs = NULL;
2211 2212
    ret = bdrv_open(&target_bs, target, NULL, NULL, flags | BDRV_O_NO_BACKING,
                    drv, &local_err);
P
Paolo Bonzini 已提交
2213
    if (ret < 0) {
2214
        error_propagate(errp, local_err);
P
Paolo Bonzini 已提交
2215 2216 2217
        return;
    }

2218
    mirror_start(bs, target_bs, speed, granularity, buf_size, sync,
2219
                 on_source_error, on_target_error,
2220
                 block_job_cb, bs, &local_err);
P
Paolo Bonzini 已提交
2221
    if (local_err != NULL) {
F
Fam Zheng 已提交
2222
        bdrv_unref(target_bs);
P
Paolo Bonzini 已提交
2223 2224 2225 2226 2227
        error_propagate(errp, local_err);
        return;
    }
}

2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238
static BlockJob *find_block_job(const char *device)
{
    BlockDriverState *bs;

    bs = bdrv_find(device);
    if (!bs || !bs->job) {
        return NULL;
    }
    return bs->job;
}

2239
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
2240 2241 2242 2243
{
    BlockJob *job = find_block_job(device);

    if (!job) {
2244
        error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2245 2246 2247
        return;
    }

2248
    block_job_set_speed(job, speed, errp);
2249
}
2250

2251 2252
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
2253 2254 2255
{
    BlockJob *job = find_block_job(device);

2256 2257 2258 2259
    if (!has_force) {
        force = false;
    }

2260
    if (!job) {
2261
        error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2262 2263
        return;
    }
2264
    if (job->paused && !force) {
2265 2266
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
2267 2268
        return;
    }
2269 2270 2271 2272

    trace_qmp_block_job_cancel(job);
    block_job_cancel(job);
}
S
Stefan Hajnoczi 已提交
2273

2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
void qmp_block_job_pause(const char *device, Error **errp)
{
    BlockJob *job = find_block_job(device);

    if (!job) {
        error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
        return;
    }

    trace_qmp_block_job_pause(job);
    block_job_pause(job);
}

void qmp_block_job_resume(const char *device, Error **errp)
{
    BlockJob *job = find_block_job(device);

    if (!job) {
        error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
        return;
    }

    trace_qmp_block_job_resume(job);
    block_job_resume(job);
}

P
Paolo Bonzini 已提交
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312
void qmp_block_job_complete(const char *device, Error **errp)
{
    BlockJob *job = find_block_job(device);

    if (!job) {
        error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
        return;
    }

    trace_qmp_block_job_complete(job);
    block_job_complete(job, errp);
}

K
Kevin Wolf 已提交
2313 2314 2315
void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
{
    QmpOutputVisitor *ov = qmp_output_visitor_new();
2316
    DriveInfo *dinfo;
K
Kevin Wolf 已提交
2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332
    QObject *obj;
    QDict *qdict;
    Error *local_err = NULL;

    /* Require an ID in the top level */
    if (!options->has_id) {
        error_setg(errp, "Block device needs an ID");
        goto fail;
    }

    /* TODO Sort it out in raw-posix and drive_init: Reject aio=native with
     * cache.direct=false instead of silently switching to aio=threads, except
     * if called from drive_init.
     *
     * For now, simply forbidding the combination for all drivers will do. */
    if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
2333 2334 2335 2336
        bool direct = options->has_cache &&
                      options->cache->has_direct &&
                      options->cache->direct;
        if (!direct) {
K
Kevin Wolf 已提交
2337 2338 2339 2340 2341 2342 2343
            error_setg(errp, "aio=native requires cache.direct=true");
            goto fail;
        }
    }

    visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
                               &options, NULL, &local_err);
2344
    if (local_err) {
K
Kevin Wolf 已提交
2345 2346 2347 2348 2349 2350 2351 2352 2353
        error_propagate(errp, local_err);
        goto fail;
    }

    obj = qmp_output_get_qobject(ov);
    qdict = qobject_to_qdict(obj);

    qdict_flatten(qdict);

2354
    dinfo = blockdev_init(NULL, qdict, &local_err);
2355
    if (local_err) {
2356
        error_propagate(errp, local_err);
K
Kevin Wolf 已提交
2357 2358 2359
        goto fail;
    }

2360 2361 2362 2363 2364 2365
    if (bdrv_key_required(dinfo->bdrv)) {
        drive_uninit(dinfo);
        error_setg(errp, "blockdev-add doesn't support encrypted devices");
        goto fail;
    }

K
Kevin Wolf 已提交
2366 2367 2368 2369
fail:
    qmp_output_visitor_cleanup(ov);
}

S
Stefan Hajnoczi 已提交
2370 2371 2372 2373 2374 2375
static void do_qmp_query_block_jobs_one(void *opaque, BlockDriverState *bs)
{
    BlockJobInfoList **prev = opaque;
    BlockJob *job = bs->job;

    if (job) {
P
Paolo Bonzini 已提交
2376 2377
        BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
        elem->value = block_job_query(bs->job);
S
Stefan Hajnoczi 已提交
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
        (*prev)->next = elem;
        *prev = elem;
    }
}

BlockJobInfoList *qmp_query_block_jobs(Error **errp)
{
    /* Dummy is a fake list element for holding the head pointer */
    BlockJobInfoList dummy = {};
    BlockJobInfoList *prev = &dummy;
    bdrv_iterate(do_qmp_query_block_jobs_one, &prev);
    return dummy.next;
}
2391

2392
QemuOptsList qemu_common_drive_opts = {
2393
    .name = "drive",
2394
    .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
2395 2396 2397 2398 2399
    .desc = {
        {
            .name = "snapshot",
            .type = QEMU_OPT_BOOL,
            .help = "enable/disable snapshot mode",
2400 2401 2402 2403
        },{
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
2404
        },{
K
Kevin Wolf 已提交
2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415
            .name = "cache.writeback",
            .type = QEMU_OPT_BOOL,
            .help = "enables writeback mode for any caches",
        },{
            .name = "cache.direct",
            .type = QEMU_OPT_BOOL,
            .help = "enables use of O_DIRECT (bypass the host page cache)",
        },{
            .name = "cache.no-flush",
            .type = QEMU_OPT_BOOL,
            .help = "ignore any flush requests for the device",
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
        },{
            .name = "format",
            .type = QEMU_OPT_STRING,
            .help = "disk format (raw, qcow2, ...)",
        },{
            .name = "serial",
            .type = QEMU_OPT_STRING,
            .help = "disk serial number",
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
        },{
2437
            .name = "read-only",
2438 2439 2440
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
2441
            .name = "throttling.iops-total",
2442 2443 2444
            .type = QEMU_OPT_NUMBER,
            .help = "limit total I/O operations per second",
        },{
2445
            .name = "throttling.iops-read",
2446 2447 2448
            .type = QEMU_OPT_NUMBER,
            .help = "limit read operations per second",
        },{
2449
            .name = "throttling.iops-write",
2450 2451 2452
            .type = QEMU_OPT_NUMBER,
            .help = "limit write operations per second",
        },{
2453
            .name = "throttling.bps-total",
2454 2455 2456
            .type = QEMU_OPT_NUMBER,
            .help = "limit total bytes per second",
        },{
2457
            .name = "throttling.bps-read",
2458 2459 2460
            .type = QEMU_OPT_NUMBER,
            .help = "limit read bytes per second",
        },{
2461
            .name = "throttling.bps-write",
2462 2463
            .type = QEMU_OPT_NUMBER,
            .help = "limit write bytes per second",
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487
        },{
            .name = "throttling.iops-total-max",
            .type = QEMU_OPT_NUMBER,
            .help = "I/O operations burst",
        },{
            .name = "throttling.iops-read-max",
            .type = QEMU_OPT_NUMBER,
            .help = "I/O operations read burst",
        },{
            .name = "throttling.iops-write-max",
            .type = QEMU_OPT_NUMBER,
            .help = "I/O operations write burst",
        },{
            .name = "throttling.bps-total-max",
            .type = QEMU_OPT_NUMBER,
            .help = "total bytes burst",
        },{
            .name = "throttling.bps-read-max",
            .type = QEMU_OPT_NUMBER,
            .help = "total bytes read burst",
        },{
            .name = "throttling.bps-write-max",
            .type = QEMU_OPT_NUMBER,
            .help = "total bytes write burst",
2488 2489 2490 2491
        },{
            .name = "throttling.iops-size",
            .type = QEMU_OPT_NUMBER,
            .help = "when limiting by iops max size of an I/O in bytes",
2492 2493 2494 2495
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
2496 2497 2498 2499
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
2500 2501 2502 2503
        },
        { /* end of list */ }
    },
};
2504 2505 2506 2507 2508

QemuOptsList qemu_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
    .desc = {
2509 2510 2511 2512
        /*
         * no elements => accept any params
         * validation will happen later
         */
2513 2514 2515
        { /* end of list */ }
    },
};