blockdev.c 72.4 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 38
#include "qemu/option.h"
#include "qemu/config-file.h"
39
#include "qapi/qmp/types.h"
K
Kevin Wolf 已提交
40 41
#include "qapi-visit.h"
#include "qapi/qmp-output-visitor.h"
42
#include "sysemu/sysemu.h"
43
#include "block/block_int.h"
L
Luiz Capitulino 已提交
44
#include "qmp-commands.h"
S
Stefan Hajnoczi 已提交
45
#include "trace.h"
46
#include "sysemu/arch_init.h"
47

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

50 51 52 53 54 55 56 57 58 59 60 61 62
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] = {
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
    /*
     * 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,
79 80
};

81 82 83 84 85 86 87 88 89 90 91
/*
 * 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);

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

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

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

108
    if (dinfo && dinfo->auto_del) {
109
        drive_del(dinfo);
110 111 112
    }
}

113 114 115 116 117 118 119 120 121 122 123 124
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;
}

125 126 127 128 129 130
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,
131
                    const char *optstr)
132 133
{
    QemuOpts *opts;
134
    char buf[32];
135

136
    opts = drive_def(optstr);
137 138 139
    if (!opts) {
        return NULL;
    }
140 141 142 143 144 145 146
    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);
    }
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
    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;
}

168 169 170 171 172 173 174
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));
}

175 176 177 178 179 180 181 182 183 184 185 186 187 188
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;
}

189 190 191 192 193 194 195 196 197 198
/* 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]++);
}

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

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

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

216
void drive_del(DriveInfo *dinfo)
217
{
218 219 220 221
    if (dinfo->opts) {
        qemu_opts_del(dinfo->opts);
    }

F
Fam Zheng 已提交
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 230
typedef struct {
    QEMUBH *bh;
F
Fam Zheng 已提交
231 232
    BlockDriverState *bs;
} BDRVPutRefBH;
233

F
Fam Zheng 已提交
234
static void bdrv_put_ref_bh(void *opaque)
235
{
F
Fam Zheng 已提交
236
    BDRVPutRefBH *s = opaque;
237

F
Fam Zheng 已提交
238
    bdrv_unref(s->bs);
239 240 241 242 243
    qemu_bh_delete(s->bh);
    g_free(s);
}

/*
F
Fam Zheng 已提交
244
 * Release a BDS reference in a BH
245
 *
F
Fam Zheng 已提交
246 247 248
 * 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.
249
 */
F
Fam Zheng 已提交
250
static void bdrv_put_ref_bh_schedule(BlockDriverState *bs)
251
{
F
Fam Zheng 已提交
252
    BDRVPutRefBH *s;
253

F
Fam Zheng 已提交
254 255 256
    s = g_new(BDRVPutRefBH, 1);
    s->bh = qemu_bh_new(bdrv_put_ref_bh, s);
    s->bs = bs;
257 258 259
    qemu_bh_schedule(s->bh);
}

260
static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
261 262
{
    if (!strcmp(buf, "ignore")) {
263
        return BLOCKDEV_ON_ERROR_IGNORE;
264
    } else if (!is_read && !strcmp(buf, "enospc")) {
265
        return BLOCKDEV_ON_ERROR_ENOSPC;
266
    } else if (!strcmp(buf, "stop")) {
267
        return BLOCKDEV_ON_ERROR_STOP;
268
    } else if (!strcmp(buf, "report")) {
269
        return BLOCKDEV_ON_ERROR_REPORT;
270
    } else {
271 272
        error_setg(errp, "'%s' invalid %s error action",
                   buf, is_read ? "read" : "write");
273 274 275 276
        return -1;
    }
}

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
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;
}

296
static bool check_throttle_config(ThrottleConfig *cfg, Error **errp)
297
{
298 299 300
    if (throttle_conflicting(cfg)) {
        error_setg(errp, "bps/iops/max total values and read/write values"
                         " cannot be used at the same time");
301 302 303
        return false;
    }

304 305
    if (!throttle_is_valid(cfg)) {
        error_setg(errp, "bps/iops/maxs values must be 0 or greater");
306 307 308
        return false;
    }

309 310 311
    return true;
}

312 313
typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;

314
/* Takes the ownership of bs_opts */
M
Max Reitz 已提交
315
static DriveInfo *blockdev_init(const char *file, QDict *bs_opts,
316
                                Error **errp)
317 318 319 320 321 322
{
    const char *buf;
    int ro = 0;
    int bdrv_flags = 0;
    int on_read_error, on_write_error;
    DriveInfo *dinfo;
323
    ThrottleConfig cfg;
324
    int snapshot = 0;
325
    bool copy_on_read;
326
    int ret;
327
    Error *error = NULL;
328 329
    QemuOpts *opts;
    const char *id;
330
    bool has_driver_specific_opts;
331
    BlockdevDetectZeroesOptions detect_zeroes;
332
    BlockDriver *drv = NULL;
333

334 335 336
    /* 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");
337
    opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
338
    if (error) {
339
        error_propagate(errp, error);
340
        goto err_no_opts;
341 342 343
    }

    qemu_opts_absorb_qdict(opts, bs_opts, &error);
344
    if (error) {
345
        error_propagate(errp, error);
346
        goto early_err;
347 348 349 350 351 352
    }

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

353 354
    has_driver_specific_opts = !!qdict_size(bs_opts);

355 356
    /* extract parameters */
    snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
357
    ro = qemu_opt_get_bool(opts, "read-only", 0);
358
    copy_on_read = qemu_opt_get_bool(opts, "copy-on-read", false);
359

360 361
    if ((buf = qemu_opt_get(opts, "discard")) != NULL) {
        if (bdrv_parse_discard_flags(buf, &bdrv_flags) != 0) {
362
            error_setg(errp, "invalid discard option");
363
            goto early_err;
364 365 366
        }
    }

K
Kevin Wolf 已提交
367 368 369 370 371 372
    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;
    }
373
    if (qemu_opt_get_bool(opts, "cache.no-flush", false)) {
K
Kevin Wolf 已提交
374
        bdrv_flags |= BDRV_O_NO_FLUSH;
375 376 377 378 379 380 381 382 383
    }

#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 {
384
           error_setg(errp, "invalid aio option");
385
           goto early_err;
386 387 388 389 390
        }
    }
#endif

    if ((buf = qemu_opt_get(opts, "format")) != NULL) {
391 392 393 394
        if (is_help_option(buf)) {
            error_printf("Supported formats:");
            bdrv_iterate_format(bdrv_format_print, NULL);
            error_printf("\n");
395
            goto early_err;
396
        }
397

398
        drv = bdrv_find_format(buf);
399
        if (!drv) {
400
            error_setg(errp, "'%s' invalid format", buf);
401
            goto early_err;
402
        }
403 404
    }

405
    /* disk I/O throttling */
406 407
    memset(&cfg, 0, sizeof(cfg));
    cfg.buckets[THROTTLE_BPS_TOTAL].avg =
408
        qemu_opt_get_number(opts, "throttling.bps-total", 0);
409
    cfg.buckets[THROTTLE_BPS_READ].avg  =
410
        qemu_opt_get_number(opts, "throttling.bps-read", 0);
411
    cfg.buckets[THROTTLE_BPS_WRITE].avg =
412
        qemu_opt_get_number(opts, "throttling.bps-write", 0);
413
    cfg.buckets[THROTTLE_OPS_TOTAL].avg =
414
        qemu_opt_get_number(opts, "throttling.iops-total", 0);
415
    cfg.buckets[THROTTLE_OPS_READ].avg =
416
        qemu_opt_get_number(opts, "throttling.iops-read", 0);
417
    cfg.buckets[THROTTLE_OPS_WRITE].avg =
418
        qemu_opt_get_number(opts, "throttling.iops-write", 0);
419

420 421 422 423 424 425 426 427 428 429 430 431
    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);
432

433
    cfg.op_size = qemu_opt_get_number(opts, "throttling.iops-size", 0);
434 435

    if (!check_throttle_config(&cfg, &error)) {
436
        error_propagate(errp, error);
437
        goto early_err;
438 439
    }

440
    on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
441
    if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
442
        on_write_error = parse_block_error_action(buf, 0, &error);
443
        if (error) {
444
            error_propagate(errp, error);
445
            goto early_err;
446 447 448
        }
    }

449
    on_read_error = BLOCKDEV_ON_ERROR_REPORT;
450
    if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
451
        on_read_error = parse_block_error_action(buf, 1, &error);
452
        if (error) {
453
            error_propagate(errp, error);
454
            goto early_err;
455 456 457
        }
    }

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
    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;
    }

476 477 478
    /* init */
    dinfo = g_malloc0(sizeof(*dinfo));
    dinfo->id = g_strdup(qemu_opts_id(opts));
K
Kevin Wolf 已提交
479 480 481 482 483
    dinfo->bdrv = bdrv_new(dinfo->id, &error);
    if (error) {
        error_propagate(errp, error);
        goto bdrv_new_err;
    }
484 485
    dinfo->bdrv->open_flags = snapshot ? BDRV_O_SNAPSHOT : 0;
    dinfo->bdrv->read_only = ro;
486
    dinfo->bdrv->detect_zeroes = detect_zeroes;
487 488
    QTAILQ_INSERT_TAIL(&drives, dinfo, next);

489 490
    bdrv_set_on_error(dinfo->bdrv, on_read_error, on_write_error);

491
    /* disk I/O throttling */
492 493 494 495
    if (throttle_enabled(&cfg)) {
        bdrv_io_limits_enable(dinfo->bdrv);
        bdrv_set_io_limits(dinfo->bdrv, &cfg);
    }
496

497
    if (!file || !*file) {
498
        if (has_driver_specific_opts) {
499 500
            file = NULL;
        } else {
501 502
            QDECREF(bs_opts);
            qemu_opts_del(opts);
503 504
            return dinfo;
        }
505 506 507 508 509 510 511
    }
    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);
    }

512 513 514 515
    if (copy_on_read) {
        bdrv_flags |= BDRV_O_COPY_ON_READ;
    }

516 517 518 519
    if (runstate_check(RUN_STATE_INMIGRATE)) {
        bdrv_flags |= BDRV_O_INCOMING;
    }

520 521
    bdrv_flags |= ro ? 0 : BDRV_O_RDWR;

522
    QINCREF(bs_opts);
523
    ret = bdrv_open(&dinfo->bdrv, file, NULL, bs_opts, bdrv_flags, drv, &error);
524

525
    if (ret < 0) {
526 527 528
        error_setg(errp, "could not open disk image %s: %s",
                   file ?: dinfo->id, error_get_pretty(error));
        error_free(error);
529
        goto err;
530 531 532 533
    }

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

535
    QDECREF(bs_opts);
536 537
    qemu_opts_del(opts);

538
    return dinfo;
539 540

err:
F
Fam Zheng 已提交
541
    bdrv_unref(dinfo->bdrv);
542
    QTAILQ_REMOVE(&drives, dinfo, next);
K
Kevin Wolf 已提交
543 544
bdrv_new_err:
    g_free(dinfo->id);
545
    g_free(dinfo);
546 547
early_err:
    qemu_opts_del(opts);
548 549
err_no_opts:
    QDECREF(bs_opts);
550
    return NULL;
551 552
}

553 554 555 556 557 558 559 560 561 562 563
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);
    }
}

564 565 566 567 568
QemuOptsList qemu_legacy_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
    .desc = {
        {
569 570 571 572 573 574 575 576 577 578 579 580
            .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",
        },{
581 582 583
            .name = "media",
            .type = QEMU_OPT_STRING,
            .help = "media type (disk, cdrom)",
584 585 586 587
        },{
            .name = "if",
            .type = QEMU_OPT_STRING,
            .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
        },{
            .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)",
604 605 606 607
        },{
            .name = "boot",
            .type = QEMU_OPT_BOOL,
            .help = "(deprecated, ignored)",
608 609 610 611
        },{
            .name = "addr",
            .type = QEMU_OPT_STRING,
            .help = "pci address (virtio only)",
612 613 614 615
        },{
            .name = "serial",
            .type = QEMU_OPT_STRING,
            .help = "disk serial number",
M
Max Reitz 已提交
616 617 618 619
        },{
            .name = "file",
            .type = QEMU_OPT_STRING,
            .help = "file name",
620
        },
621 622 623 624 625 626

        /* 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",
627 628 629 630 631 632 633 634
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
635 636 637 638 639 640
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },

641 642 643 644
        { /* end of list */ }
    },
};

645
DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
646
{
K
Kevin Wolf 已提交
647
    const char *value;
648
    DriveInfo *dinfo = NULL;
649
    QDict *bs_opts;
650 651
    QemuOpts *legacy_opts;
    DriveMediaType media = MEDIA_DISK;
652
    BlockInterfaceType type;
653
    int cyls, heads, secs, translation;
654
    int max_devs, bus_id, unit_id, index;
655
    const char *devaddr;
656
    const char *werror, *rerror;
F
Fam Zheng 已提交
657 658
    bool read_only = false;
    bool copy_on_read;
659
    const char *serial;
M
Max Reitz 已提交
660
    const char *filename;
661
    Error *local_err = NULL;
K
Kevin Wolf 已提交
662

663 664 665 666 667 668 669 670 671
    /* 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");

672 673 674 675 676 677 678 679
    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");

680 681 682
    qemu_opt_rename(all_opts,
                    "iops_size", "throttling.iops-size");

683 684
    qemu_opt_rename(all_opts, "readonly", "read-only");

K
Kevin Wolf 已提交
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
    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");
    }

710 711 712 713
    /* Get a QDict for processing the options */
    bs_opts = qdict_new();
    qemu_opts_to_qdict(all_opts, bs_opts);

714 715
    legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
                                   &error_abort);
716
    qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
717
    if (local_err) {
718
        error_report("%s", error_get_pretty(local_err));
719 720 721 722
        error_free(local_err);
        goto fail;
    }

723 724 725 726 727 728 729
    /* 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");
    }

730 731 732 733 734 735 736
    /* 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 已提交
737
            read_only = true;
738 739 740 741 742 743
        } else {
            error_report("'%s' invalid media", value);
            goto fail;
        }
    }

744
    /* copy-on-read is disabled with a warning for read-only devices */
F
Fam Zheng 已提交
745
    read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
746 747 748 749 750 751 752 753 754 755 756 757
    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"));

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
    /* 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;
    }

773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
    /* 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;
805 806 807 808
        } else if (!strcmp(value, "large")) {
            translation = BIOS_ATA_TRANSLATION_LARGE;
        } else if (!strcmp(value, "rechs")) {
            translation = BIOS_ATA_TRANSLATION_RECHS;
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
        } 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;
        }
    }

824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
    /* 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;
    }

863 864 865
    /* Serial number */
    serial = qemu_opt_get(legacy_opts, "serial");

866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
    /* 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);
    }

884 885 886 887 888 889 890 891 892
    /* 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;
893 894
        devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
                                   &error_abort);
895 896 897 898 899 900 901 902 903 904 905
        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 已提交
906 907
    filename = qemu_opt_get(legacy_opts, "file");

908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
    /* 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));
    }

929
    /* Actual block device init: Functionality shared with blockdev-add */
930
    dinfo = blockdev_init(filename, bs_opts, &local_err);
931
    bs_opts = NULL;
932
    if (dinfo == NULL) {
933
        if (local_err) {
934
            error_report("%s", error_get_pretty(local_err));
935 936
            error_free(local_err);
        }
937
        goto fail;
938
    } else {
939
        assert(!local_err);
940 941 942 943
    }

    /* Set legacy DriveInfo fields */
    dinfo->enable_auto_del = true;
944
    dinfo->opts = all_opts;
945

946 947 948 949 950
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

951
    dinfo->type = type;
952 953
    dinfo->bus = bus_id;
    dinfo->unit = unit_id;
954
    dinfo->devaddr = devaddr;
955

956 957
    dinfo->serial = g_strdup(serial);

958 959 960 961 962 963 964 965 966 967 968
    switch(type) {
    case IF_IDE:
    case IF_SCSI:
    case IF_XEN:
    case IF_NONE:
        dinfo->media_cd = media == MEDIA_CDROM;
        break;
    default:
        break;
    }

969
fail:
970
    qemu_opts_del(legacy_opts);
971
    QDECREF(bs_opts);
972
    return dinfo;
973 974
}

975 976 977
void do_commit(Monitor *mon, const QDict *qdict)
{
    const char *device = qdict_get_str(qdict, "device");
978
    BlockDriverState *bs;
979
    int ret;
980

981
    if (!strcmp(device, "all")) {
982
        ret = bdrv_commit_all();
983 984
    } else {
        bs = bdrv_find(device);
985
        if (!bs) {
986
            monitor_printf(mon, "Device '%s' not found\n", device);
987
            return;
988
        }
989
        ret = bdrv_commit(bs);
990 991 992 993
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
994 995 996
    }
}

997 998
static void blockdev_do_action(int kind, void *data, Error **errp)
{
999 1000
    TransactionAction action;
    TransactionActionList list;
1001 1002 1003 1004 1005 1006 1007 1008

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

1009 1010 1011 1012 1013
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,
1014
                                bool has_format, const char *format,
1015
                                bool has_mode, NewImageMode mode, Error **errp)
1016
{
1017
    BlockdevSnapshot snapshot = {
1018
        .has_device = has_device,
1019
        .device = (char *) device,
1020 1021
        .has_node_name = has_node_name,
        .node_name = (char *) node_name,
1022
        .snapshot_file = (char *) snapshot_file,
1023 1024
        .has_snapshot_node_name = has_snapshot_node_name,
        .snapshot_node_name = (char *) snapshot_node_name,
1025 1026 1027 1028 1029
        .has_format = has_format,
        .format = (char *) format,
        .has_mode = has_mode,
        .mode = mode,
    };
1030 1031
    blockdev_do_action(TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
                       &snapshot, errp);
1032 1033
}

1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
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);
}

1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
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);
1079
    if (local_err) {
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
        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);
1092
    if (local_err) {
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
        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;
}
1108 1109

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

1111
typedef struct BlkTransactionState BlkTransactionState;
1112 1113 1114 1115 1116 1117 1118

/* 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. */
1119
    void (*prepare)(BlkTransactionState *common, Error **errp);
1120
    /* Commit the changes, can be NULL. */
1121
    void (*commit)(BlkTransactionState *common);
1122
    /* Abort the changes on fail, can be NULL. */
1123
    void (*abort)(BlkTransactionState *common);
1124
    /* Clean up resource in the end, can be NULL. */
1125
    void (*clean)(BlkTransactionState *common);
1126 1127 1128 1129 1130 1131 1132
} 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().
 */
1133
struct BlkTransactionState {
1134
    TransactionAction *action;
1135
    const BdrvActionOps *ops;
1136
    QSIMPLEQ_ENTRY(BlkTransactionState) entry;
1137 1138
};

1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
/* internal snapshot private data */
typedef struct InternalSnapshotState {
    BlkTransactionState common;
    BlockDriverState *bs;
    QEMUSnapshotInfo sn;
} InternalSnapshotState;

static void internal_snapshot_prepare(BlkTransactionState *common,
                                      Error **errp)
{
1149
    Error *local_err = NULL;
1150 1151 1152 1153 1154 1155 1156 1157 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
    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 */
1198 1199 1200 1201
    ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
                                            &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
1202 1203 1204 1205 1206 1207 1208 1209 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
        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);
    }
}

1253
/* external snapshot private data */
1254 1255
typedef struct ExternalSnapshotState {
    BlkTransactionState common;
1256 1257
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1258
} ExternalSnapshotState;
1259

1260
static void external_snapshot_prepare(BlkTransactionState *common,
1261 1262 1263 1264
                                      Error **errp)
{
    BlockDriver *drv;
    int flags, ret;
1265
    QDict *options = NULL;
1266
    Error *local_err = NULL;
1267
    bool has_device = false;
1268
    const char *device;
1269 1270 1271 1272
    bool has_node_name = false;
    const char *node_name;
    bool has_snapshot_node_name = false;
    const char *snapshot_node_name;
1273 1274 1275
    const char *new_image_file;
    const char *format = "qcow2";
    enum NewImageMode mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1276 1277
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1278
    TransactionAction *action = common->action;
1279

1280
    /* get parameters */
1281
    g_assert(action->kind == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC);
1282

1283
    has_device = action->blockdev_snapshot_sync->has_device;
1284
    device = action->blockdev_snapshot_sync->device;
1285 1286 1287 1288 1289 1290
    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;

1291 1292 1293 1294 1295 1296 1297 1298 1299
    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 */
1300 1301 1302 1303 1304 1305
    drv = bdrv_find_format(format);
    if (!drv) {
        error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
        return;
    }

1306 1307 1308
    state->old_bs = bdrv_lookup_bs(has_device ? device : NULL,
                                   has_node_name ? node_name : NULL,
                                   &local_err);
1309
    if (local_err) {
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
        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");
1321 1322 1323
        return;
    }

1324
    if (!bdrv_is_inserted(state->old_bs)) {
1325 1326 1327 1328
        error_set(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
        return;
    }

1329 1330
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1331 1332 1333
        return;
    }

1334 1335
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1336 1337 1338 1339 1340
            error_set(errp, QERR_IO_ERROR);
            return;
        }
    }

1341
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1342 1343 1344 1345
        error_set(errp, QERR_FEATURE_DISABLED, "snapshot");
        return;
    }

1346
    flags = state->old_bs->open_flags;
1347 1348 1349 1350

    /* create new image w/backing file */
    if (mode != NEW_IMAGE_MODE_EXISTING) {
        bdrv_img_create(new_image_file, format,
1351 1352
                        state->old_bs->filename,
                        state->old_bs->drv->format_name,
1353
                        NULL, -1, flags, &local_err, false);
1354
        if (local_err) {
1355 1356 1357 1358 1359
            error_propagate(errp, local_err);
            return;
        }
    }

1360 1361 1362 1363 1364 1365
    if (has_snapshot_node_name) {
        options = qdict_new();
        qdict_put(options, "node-name",
                  qstring_from_str(snapshot_node_name));
    }

1366 1367
    /* TODO Inherit bs->options or only take explicit options with an
     * extended QMP command? */
1368
    assert(state->new_bs == NULL);
1369
    ret = bdrv_open(&state->new_bs, new_image_file, NULL, options,
1370
                    flags | BDRV_O_NO_BACKING, drv, &local_err);
1371
    /* We will manually add the backing_hd field to the bs later */
1372
    if (ret != 0) {
1373
        error_propagate(errp, local_err);
1374 1375 1376
    }
}

1377
static void external_snapshot_commit(BlkTransactionState *common)
1378
{
1379 1380
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1381

1382 1383
    /* This removes our old bs and adds the new bs */
    bdrv_append(state->new_bs, state->old_bs);
1384 1385 1386
    /* 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 */
1387
    bdrv_reopen(state->new_bs, state->new_bs->open_flags & ~BDRV_O_RDWR,
1388 1389 1390
                NULL);
}

1391
static void external_snapshot_abort(BlkTransactionState *common)
1392
{
1393 1394 1395
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
F
Fam Zheng 已提交
1396
        bdrv_unref(state->new_bs);
1397 1398 1399
    }
}

1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
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,
1417
                     backup->sync,
1418 1419 1420 1421 1422
                     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);
1423
    if (local_err) {
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
        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);
    }
}

1445 1446 1447 1448 1449 1450 1451
static void abort_prepare(BlkTransactionState *common, Error **errp)
{
    error_setg(errp, "Transaction aborted using Abort action");
}

static void abort_commit(BlkTransactionState *common)
{
1452
    g_assert_not_reached(); /* this action never succeeds */
1453 1454
}

1455
static const BdrvActionOps actions[] = {
1456
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
1457
        .instance_size = sizeof(ExternalSnapshotState),
1458 1459 1460 1461
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
    },
1462 1463 1464 1465 1466
    [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
        .instance_size = sizeof(DriveBackupState),
        .prepare = drive_backup_prepare,
        .abort = drive_backup_abort,
    },
1467 1468 1469 1470 1471
    [TRANSACTION_ACTION_KIND_ABORT] = {
        .instance_size = sizeof(BlkTransactionState),
        .prepare = abort_prepare,
        .commit = abort_commit,
    },
1472 1473 1474 1475 1476
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
        .instance_size = sizeof(InternalSnapshotState),
        .prepare  = internal_snapshot_prepare,
        .abort = internal_snapshot_abort,
    },
1477 1478
};

1479 1480 1481 1482 1483
/*
 * '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
 */
1484
void qmp_transaction(TransactionActionList *dev_list, Error **errp)
1485
{
1486
    TransactionActionList *dev_entry = dev_list;
1487
    BlkTransactionState *state, *next;
1488
    Error *local_err = NULL;
1489

1490
    QSIMPLEQ_HEAD(snap_bdrv_states, BlkTransactionState) snap_bdrv_states;
1491 1492 1493 1494 1495 1496 1497
    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) {
1498
        TransactionAction *dev_info = NULL;
1499
        const BdrvActionOps *ops;
1500

1501 1502 1503
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

1504 1505 1506
        assert(dev_info->kind < ARRAY_SIZE(actions));

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

1509 1510 1511 1512
        state = g_malloc0(ops->instance_size);
        state->ops = ops;
        state->action = dev_info;
        QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
1513

1514
        state->ops->prepare(state, &local_err);
1515
        if (local_err) {
1516 1517
            error_propagate(errp, local_err);
            goto delete_and_fail;
1518 1519 1520
        }
    }

1521
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
1522 1523 1524
        if (state->ops->commit) {
            state->ops->commit(state);
        }
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
    }

    /* 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
    */
1535 1536 1537
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
        if (state->ops->abort) {
            state->ops->abort(state);
1538
        }
1539 1540
    }
exit:
1541 1542 1543
    QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
        if (state->ops->clean) {
            state->ops->clean(state);
1544
        }
1545
        g_free(state);
1546 1547 1548 1549
    }
}


1550
static void eject_device(BlockDriverState *bs, int force, Error **errp)
1551
{
1552
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
1553 1554
        return;
    }
1555
    if (!bdrv_dev_has_removable_media(bs)) {
1556 1557
        error_setg(errp, "Device '%s' is not removable",
                   bdrv_get_device_name(bs));
1558
        return;
1559
    }
1560

P
Paolo Bonzini 已提交
1561 1562 1563
    if (bdrv_dev_is_medium_locked(bs) && !bdrv_dev_is_tray_open(bs)) {
        bdrv_dev_eject_request(bs, force);
        if (!force) {
1564 1565
            error_setg(errp, "Device '%s' is locked",
                       bdrv_get_device_name(bs));
1566
            return;
P
Paolo Bonzini 已提交
1567
        }
1568
    }
1569

1570
    bdrv_close(bs);
1571 1572
}

L
Luiz Capitulino 已提交
1573
void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
1574 1575 1576
{
    BlockDriverState *bs;

L
Luiz Capitulino 已提交
1577
    bs = bdrv_find(device);
1578
    if (!bs) {
L
Luiz Capitulino 已提交
1579 1580
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
1581 1582
    }

L
Luiz Capitulino 已提交
1583
    eject_device(bs, force, errp);
1584 1585
}

1586 1587 1588
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
1589
{
1590
    Error *local_err = NULL;
1591 1592 1593
    BlockDriverState *bs;
    int err;

1594 1595 1596
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
1597
    if (local_err) {
1598
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
1599
        return;
1600 1601
    }

L
Luiz Capitulino 已提交
1602
    err = bdrv_set_key(bs, password);
1603
    if (err == -EINVAL) {
L
Luiz Capitulino 已提交
1604 1605
        error_set(errp, QERR_DEVICE_NOT_ENCRYPTED, bdrv_get_device_name(bs));
        return;
1606
    } else if (err < 0) {
L
Luiz Capitulino 已提交
1607 1608
        error_set(errp, QERR_INVALID_PASSWORD);
        return;
1609 1610 1611
    }
}

L
Luiz Capitulino 已提交
1612 1613 1614 1615
static void qmp_bdrv_open_encrypted(BlockDriverState *bs, const char *filename,
                                    int bdrv_flags, BlockDriver *drv,
                                    const char *password, Error **errp)
{
1616
    Error *local_err = NULL;
1617 1618
    int ret;

1619
    ret = bdrv_open(&bs, filename, NULL, NULL, bdrv_flags, drv, &local_err);
1620
    if (ret < 0) {
1621
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
        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,
1640
                         const char *format, Error **errp)
1641 1642 1643 1644
{
    BlockDriverState *bs;
    BlockDriver *drv = NULL;
    int bdrv_flags;
1645
    Error *err = NULL;
1646 1647 1648

    bs = bdrv_find(device);
    if (!bs) {
L
Luiz Capitulino 已提交
1649 1650
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
1651
    }
L
Luiz Capitulino 已提交
1652 1653

    if (format) {
1654
        drv = bdrv_find_whitelisted_format(format, bs->read_only);
1655
        if (!drv) {
L
Luiz Capitulino 已提交
1656 1657
            error_set(errp, QERR_INVALID_BLOCK_FORMAT, format);
            return;
1658 1659
        }
    }
L
Luiz Capitulino 已提交
1660

1661
    eject_device(bs, 0, &err);
1662
    if (err) {
L
Luiz Capitulino 已提交
1663 1664
        error_propagate(errp, err);
        return;
1665
    }
L
Luiz Capitulino 已提交
1666

1667
    bdrv_flags = bdrv_is_read_only(bs) ? 0 : BDRV_O_RDWR;
1668
    bdrv_flags |= bdrv_is_snapshot(bs) ? BDRV_O_SNAPSHOT : 0;
L
Luiz Capitulino 已提交
1669 1670

    qmp_bdrv_open_encrypted(bs, filename, bdrv_flags, drv, NULL, errp);
1671
}
1672

Z
Zhi Yong Wu 已提交
1673
/* throttling disk I/O limits */
1674
void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
                               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,
1690 1691 1692
                               int64_t iops_wr_max,
                               bool has_iops_size,
                               int64_t iops_size, Error **errp)
Z
Zhi Yong Wu 已提交
1693
{
1694
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
1695
    BlockDriverState *bs;
1696
    AioContext *aio_context;
Z
Zhi Yong Wu 已提交
1697

1698
    bs = bdrv_find(device);
Z
Zhi Yong Wu 已提交
1699
    if (!bs) {
1700 1701
        error_set(errp, QERR_DEVICE_NOT_FOUND, device);
        return;
Z
Zhi Yong Wu 已提交
1702 1703
    }

1704 1705 1706 1707 1708 1709 1710 1711 1712
    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;

1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
    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 已提交
1731

1732 1733 1734
    if (has_iops_size) {
        cfg.op_size = iops_size;
    }
1735 1736

    if (!check_throttle_config(&cfg, errp)) {
1737
        return;
Z
Zhi Yong Wu 已提交
1738 1739
    }

1740 1741 1742
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

1743
    if (!bs->io_limits_enabled && throttle_enabled(&cfg)) {
Z
Zhi Yong Wu 已提交
1744
        bdrv_io_limits_enable(bs);
1745
    } else if (bs->io_limits_enabled && !throttle_enabled(&cfg)) {
Z
Zhi Yong Wu 已提交
1746
        bdrv_io_limits_disable(bs);
1747 1748 1749 1750
    }

    if (bs->io_limits_enabled) {
        bdrv_set_io_limits(bs, &cfg);
Z
Zhi Yong Wu 已提交
1751
    }
1752 1753

    aio_context_release(aio_context);
Z
Zhi Yong Wu 已提交
1754 1755
}

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

    bs = bdrv_find(id);
    if (!bs) {
1764
        error_report("Device '%s' not found", id);
1765 1766
        return -1;
    }
1767 1768 1769
    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 已提交
1770 1771
        return -1;
    }
1772 1773

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

1778
    /* if we have a device attached to this BlockDriverState
1779 1780 1781 1782
     * 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.
     */
1783
    if (bdrv_get_attached_dev(bs)) {
1784
        bdrv_make_anon(bs);
1785 1786 1787 1788

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

    return 0;
}
1795

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

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

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

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

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

1825 1826
    ret = bdrv_truncate(bs, size);
    switch (ret) {
1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
    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:
1842
        error_setg_errno(errp, -ret, "Could not resize");
1843
        break;
1844 1845
    }
}
S
Stefan Hajnoczi 已提交
1846

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

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

    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)));
    }

1861 1862 1863 1864 1865
    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 已提交
1866
    qobject_decref(obj);
1867

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

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

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

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

1890 1891 1892 1893
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
        return;
    }

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

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

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

1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922
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
     */
1923
    BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
1924

1925 1926 1927 1928
    if (!has_speed) {
        speed = 0;
    }

1929 1930 1931 1932 1933 1934 1935
    /* drain all i/o before commits */
    bdrv_drain_all();

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

    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT, errp)) {
        return;
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
    }

    /* 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;
    }

1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
    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 已提交
1967 1968 1969 1970 1971 1972 1973
    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);
    }
1974 1975 1976 1977 1978 1979
    if (local_err != NULL) {
        error_propagate(errp, local_err);
        return;
    }
}

1980 1981
void qmp_drive_backup(const char *device, const char *target,
                      bool has_format, const char *format,
1982
                      enum MirrorSyncMode sync,
1983 1984 1985 1986 1987 1988 1989 1990
                      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;
1991
    BlockDriverState *source = NULL;
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 2027 2028 2029 2030 2031 2032
    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;
        }
    }

2033
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
2034 2035 2036 2037 2038
        return;
    }

    flags = bs->open_flags | BDRV_O_RDWR;

2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
    /* 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;
    }

2051 2052 2053 2054 2055 2056 2057 2058
    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);
2059 2060 2061 2062 2063 2064 2065 2066
        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);
        }
2067 2068
    }

2069
    if (local_err) {
2070 2071 2072 2073
        error_propagate(errp, local_err);
        return;
    }

2074
    target_bs = NULL;
2075
    ret = bdrv_open(&target_bs, target, NULL, NULL, flags, drv, &local_err);
2076
    if (ret < 0) {
2077
        error_propagate(errp, local_err);
2078 2079 2080
        return;
    }

2081
    backup_start(bs, target_bs, speed, sync, on_source_error, on_target_error,
2082 2083
                 block_job_cb, bs, &local_err);
    if (local_err != NULL) {
F
Fam Zheng 已提交
2084
        bdrv_unref(target_bs);
2085 2086 2087 2088 2089
        error_propagate(errp, local_err);
        return;
    }
}

2090 2091 2092 2093 2094
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
    return bdrv_named_nodes_list();
}

2095 2096
#define DEFAULT_MIRROR_BUF_SIZE   (10 << 20)

P
Paolo Bonzini 已提交
2097 2098 2099 2100
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,
2101
                      bool has_speed, int64_t speed,
2102
                      bool has_granularity, uint32_t granularity,
2103
                      bool has_buf_size, int64_t buf_size,
2104 2105 2106
                      bool has_on_source_error, BlockdevOnError on_source_error,
                      bool has_on_target_error, BlockdevOnError on_target_error,
                      Error **errp)
P
Paolo Bonzini 已提交
2107 2108 2109 2110 2111 2112
{
    BlockDriverState *bs;
    BlockDriverState *source, *target_bs;
    BlockDriver *drv = NULL;
    Error *local_err = NULL;
    int flags;
2113
    int64_t size;
P
Paolo Bonzini 已提交
2114 2115 2116 2117 2118
    int ret;

    if (!has_speed) {
        speed = 0;
    }
2119 2120 2121 2122 2123 2124
    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 已提交
2125 2126 2127
    if (!has_mode) {
        mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
2128 2129 2130
    if (!has_granularity) {
        granularity = 0;
    }
2131 2132 2133 2134
    if (!has_buf_size) {
        buf_size = DEFAULT_MIRROR_BUF_SIZE;
    }

2135 2136 2137 2138 2139 2140 2141 2142
    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 已提交
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165

    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;
        }
    }

2166
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR, errp)) {
P
Paolo Bonzini 已提交
2167 2168 2169 2170 2171 2172 2173 2174
        return;
    }

    flags = bs->open_flags | BDRV_O_RDWR;
    source = bs->backing_hd;
    if (!source && sync == MIRROR_SYNC_MODE_TOP) {
        sync = MIRROR_SYNC_MODE_FULL;
    }
2175 2176 2177
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }
P
Paolo Bonzini 已提交
2178

2179 2180 2181 2182 2183 2184
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
        return;
    }

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

2208
    if (local_err) {
2209
        error_propagate(errp, local_err);
P
Paolo Bonzini 已提交
2210 2211 2212
        return;
    }

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

2224
    mirror_start(bs, target_bs, speed, granularity, buf_size, sync,
2225
                 on_source_error, on_target_error,
2226
                 block_job_cb, bs, &local_err);
P
Paolo Bonzini 已提交
2227
    if (local_err != NULL) {
F
Fam Zheng 已提交
2228
        bdrv_unref(target_bs);
P
Paolo Bonzini 已提交
2229 2230 2231 2232 2233
        error_propagate(errp, local_err);
        return;
    }
}

2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
static BlockJob *find_block_job(const char *device)
{
    BlockDriverState *bs;

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

2245
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
2246 2247 2248 2249
{
    BlockJob *job = find_block_job(device);

    if (!job) {
2250
        error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2251 2252 2253
        return;
    }

2254
    block_job_set_speed(job, speed, errp);
2255
}
2256

2257 2258
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
2259 2260 2261
{
    BlockJob *job = find_block_job(device);

2262 2263 2264 2265
    if (!has_force) {
        force = false;
    }

2266
    if (!job) {
2267
        error_set(errp, QERR_BLOCK_JOB_NOT_ACTIVE, device);
2268 2269
        return;
    }
2270
    if (job->paused && !force) {
2271 2272
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
2273 2274
        return;
    }
2275 2276 2277 2278

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

2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305
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 已提交
2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
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 已提交
2319 2320 2321
void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
{
    QmpOutputVisitor *ov = qmp_output_visitor_new();
2322
    DriveInfo *dinfo;
K
Kevin Wolf 已提交
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;
    }

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

    visit_type_BlockdevOptions(qmp_output_get_visitor(ov),
                               &options, NULL, &local_err);
2350
    if (local_err) {
K
Kevin Wolf 已提交
2351 2352 2353 2354 2355 2356 2357 2358 2359
        error_propagate(errp, local_err);
        goto fail;
    }

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

    qdict_flatten(qdict);

2360
    dinfo = blockdev_init(NULL, qdict, &local_err);
2361
    if (local_err) {
2362
        error_propagate(errp, local_err);
K
Kevin Wolf 已提交
2363 2364 2365
        goto fail;
    }

2366
    if (bdrv_key_required(dinfo->bdrv)) {
2367
        drive_del(dinfo);
2368 2369 2370 2371
        error_setg(errp, "blockdev-add doesn't support encrypted devices");
        goto fail;
    }

K
Kevin Wolf 已提交
2372 2373 2374 2375
fail:
    qmp_output_visitor_cleanup(ov);
}

S
Stefan Hajnoczi 已提交
2376 2377 2378 2379 2380 2381
static void do_qmp_query_block_jobs_one(void *opaque, BlockDriverState *bs)
{
    BlockJobInfoList **prev = opaque;
    BlockJob *job = bs->job;

    if (job) {
P
Paolo Bonzini 已提交
2382 2383
        BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
        elem->value = block_job_query(bs->job);
S
Stefan Hajnoczi 已提交
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
        (*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;
}
2397

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

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