blockdev.c 127.5 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
 */

P
Peter Maydell 已提交
33
#include "qemu/osdep.h"
M
Markus Armbruster 已提交
34
#include "sysemu/block-backend.h"
35
#include "sysemu/blockdev.h"
P
Paolo Bonzini 已提交
36
#include "hw/block/block.h"
37
#include "block/blockjob.h"
38
#include "block/throttle-groups.h"
39
#include "monitor/monitor.h"
40
#include "qemu/error-report.h"
41 42
#include "qemu/option.h"
#include "qemu/config-file.h"
43
#include "qapi/qmp/types.h"
K
Kevin Wolf 已提交
44
#include "qapi-visit.h"
45
#include "qapi/qmp/qerror.h"
K
Kevin Wolf 已提交
46
#include "qapi/qmp-output-visitor.h"
47
#include "qapi/util.h"
48
#include "sysemu/sysemu.h"
49
#include "block/block_int.h"
L
Luiz Capitulino 已提交
50
#include "qmp-commands.h"
S
Stefan Hajnoczi 已提交
51
#include "trace.h"
52
#include "sysemu/arch_init.h"
53 54
#include "qemu/cutils.h"
#include "qemu/help_option.h"
55

56 57 58
static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
    QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);

59 60 61 62 63 64 65 66 67 68 69 70
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",
};

71
static int if_max_devs[IF_COUNT] = {
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
    /*
     * 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,
88 89
};

90 91 92 93 94 95
/**
 * Boards may call this to offer board-by-board overrides
 * of the default, global values.
 */
void override_max_devs(BlockInterfaceType type, int max_devs)
{
96
    BlockBackend *blk;
97 98 99 100 101 102
    DriveInfo *dinfo;

    if (max_devs <= 0) {
        return;
    }

103 104
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
105 106 107 108 109 110 111 112 113 114 115
        if (dinfo->type == type) {
            fprintf(stderr, "Cannot override units-per-bus property of"
                    " the %s interface, because a drive of that type has"
                    " already been added.\n", if_name[type]);
            g_assert_not_reached();
        }
    }

    if_max_devs[type] = max_devs;
}

116 117 118 119 120 121 122
/*
 * 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.
 */
123
void blockdev_mark_auto_del(BlockBackend *blk)
124
{
125
    DriveInfo *dinfo = blk_legacy_dinfo(blk);
126
    BlockDriverState *bs = blk_bs(blk);
127
    AioContext *aio_context;
128

129
    if (!dinfo) {
130 131 132
        return;
    }

M
Max Reitz 已提交
133 134 135
    if (bs) {
        aio_context = bdrv_get_aio_context(bs);
        aio_context_acquire(aio_context);
136

M
Max Reitz 已提交
137 138 139
        if (bs->job) {
            block_job_cancel(bs->job);
        }
140

M
Max Reitz 已提交
141 142
        aio_context_release(aio_context);
    }
143

144
    dinfo->auto_del = 1;
145 146
}

147
void blockdev_auto_del(BlockBackend *blk)
148
{
149
    DriveInfo *dinfo = blk_legacy_dinfo(blk);
150

151
    if (dinfo && dinfo->auto_del) {
152
        monitor_remove_blk(blk);
153
        blk_unref(blk);
154 155 156
    }
}

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
/**
 * Returns the current mapping of how many units per bus
 * a particular interface can support.
 *
 *  A positive integer indicates n units per bus.
 *  0 implies the mapping has not been established.
 * -1 indicates an invalid BlockInterfaceType was given.
 */
int drive_get_max_devs(BlockInterfaceType type)
{
    if (type >= IF_IDE && type < IF_COUNT) {
        return if_max_devs[type];
    }

    return -1;
}

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

186 187
QemuOpts *drive_def(const char *optstr)
{
188
    return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
189 190 191
}

QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
192
                    const char *optstr)
193 194 195
{
    QemuOpts *opts;

196
    opts = drive_def(optstr);
197 198 199
    if (!opts) {
        return NULL;
    }
200
    if (type != IF_DEFAULT) {
201
        qemu_opt_set(opts, "if", if_name[type], &error_abort);
202 203
    }
    if (index >= 0) {
204
        qemu_opt_set_number(opts, "index", index, &error_abort);
205
    }
206
    if (file)
207
        qemu_opt_set(opts, "file", file, &error_abort);
208 209 210 211 212
    return opts;
}

DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
{
213
    BlockBackend *blk;
214 215
    DriveInfo *dinfo;

216 217 218 219
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
        if (dinfo && dinfo->type == type
            && dinfo->bus == bus && dinfo->unit == unit) {
220
            return dinfo;
221
        }
222 223 224 225 226
    }

    return NULL;
}

J
John Snow 已提交
227 228
bool drive_check_orphaned(void)
{
229
    BlockBackend *blk;
J
John Snow 已提交
230 231 232
    DriveInfo *dinfo;
    bool rs = false;

233 234
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
J
John Snow 已提交
235 236
        /* If dinfo->bdrv->dev is NULL, it has no device attached. */
        /* Unless this is a default drive, this may be an oversight. */
237
        if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
J
John Snow 已提交
238 239 240
            dinfo->type != IF_NONE) {
            fprintf(stderr, "Warning: Orphaned drive without device: "
                    "id=%s,file=%s,if=%s,bus=%d,unit=%d\n",
M
Max Reitz 已提交
241 242
                    blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
                    if_name[dinfo->type], dinfo->bus, dinfo->unit);
J
John Snow 已提交
243 244 245 246 247 248 249
            rs = true;
        }
    }

    return rs;
}

250 251 252 253 254 255 256
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));
}

257 258 259
int drive_get_max_bus(BlockInterfaceType type)
{
    int max_bus;
260
    BlockBackend *blk;
261 262 263
    DriveInfo *dinfo;

    max_bus = -1;
264 265 266
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
        if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
267
            max_bus = dinfo->bus;
268
        }
269 270 271 272
    }
    return max_bus;
}

273 274 275 276 277 278 279 280 281 282
/* 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]++);
}

283 284
static void bdrv_format_print(void *opaque, const char *name)
{
285
    error_printf(" %s", name);
286 287
}

288 289
typedef struct {
    QEMUBH *bh;
F
Fam Zheng 已提交
290 291
    BlockDriverState *bs;
} BDRVPutRefBH;
292

293
static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
294 295
{
    if (!strcmp(buf, "ignore")) {
296
        return BLOCKDEV_ON_ERROR_IGNORE;
297
    } else if (!is_read && !strcmp(buf, "enospc")) {
298
        return BLOCKDEV_ON_ERROR_ENOSPC;
299
    } else if (!strcmp(buf, "stop")) {
300
        return BLOCKDEV_ON_ERROR_STOP;
301
    } else if (!strcmp(buf, "report")) {
302
        return BLOCKDEV_ON_ERROR_REPORT;
303
    } else {
304 305
        error_setg(errp, "'%s' invalid %s error action",
                   buf, is_read ? "read" : "write");
306 307 308 309
        return -1;
    }
}

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
                                  Error **errp)
{
    const QListEntry *entry;
    for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
        switch (qobject_type(entry->value)) {

        case QTYPE_QSTRING: {
            unsigned long long length;
            const char *str = qstring_get_str(qobject_to_qstring(entry->value));
            if (parse_uint_full(str, &length, 10) == 0 &&
                length > 0 && length <= UINT_MAX) {
                block_acct_add_interval(stats, (unsigned) length);
            } else {
                error_setg(errp, "Invalid interval length: %s", str);
                return false;
            }
            break;
        }

        case QTYPE_QINT: {
            int64_t length = qint_get_int(qobject_to_qint(entry->value));
            if (length > 0 && length <= UINT_MAX) {
                block_acct_add_interval(stats, (unsigned) length);
            } else {
                error_setg(errp, "Invalid interval length: %" PRId64, length);
                return false;
            }
            break;
        }

        default:
            error_setg(errp, "The specification of stats-intervals is invalid");
            return false;
        }
    }
    return true;
}

349 350
typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
/* All parameters but @opts are optional and may be set to NULL. */
static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
    const char **throttling_group, ThrottleConfig *throttle_cfg,
    BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
{
    const char *discard;
    Error *local_error = NULL;
    const char *aio;

    if (bdrv_flags) {
        if (!qemu_opt_get_bool(opts, "read-only", false)) {
            *bdrv_flags |= BDRV_O_RDWR;
        }
        if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
            *bdrv_flags |= BDRV_O_COPY_ON_READ;
        }

        if ((discard = qemu_opt_get(opts, "discard")) != NULL) {
            if (bdrv_parse_discard_flags(discard, bdrv_flags) != 0) {
                error_setg(errp, "Invalid discard option");
                return;
            }
        }

        if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
            if (!strcmp(aio, "native")) {
                *bdrv_flags |= BDRV_O_NATIVE_AIO;
            } else if (!strcmp(aio, "threads")) {
                /* this is the default */
            } else {
               error_setg(errp, "invalid aio option");
               return;
            }
        }
    }

    /* disk I/O throttling */
    if (throttling_group) {
        *throttling_group = qemu_opt_get(opts, "throttling.group");
    }

    if (throttle_cfg) {
393
        throttle_config_init(throttle_cfg);
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
        throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
            qemu_opt_get_number(opts, "throttling.bps-total", 0);
        throttle_cfg->buckets[THROTTLE_BPS_READ].avg  =
            qemu_opt_get_number(opts, "throttling.bps-read", 0);
        throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
            qemu_opt_get_number(opts, "throttling.bps-write", 0);
        throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
            qemu_opt_get_number(opts, "throttling.iops-total", 0);
        throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
            qemu_opt_get_number(opts, "throttling.iops-read", 0);
        throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
            qemu_opt_get_number(opts, "throttling.iops-write", 0);

        throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
            qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
        throttle_cfg->buckets[THROTTLE_BPS_READ].max  =
            qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
        throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
            qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
        throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
            qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
        throttle_cfg->buckets[THROTTLE_OPS_READ].max =
            qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
        throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
            qemu_opt_get_number(opts, "throttling.iops-write-max", 0);

420 421 422 423 424 425 426 427 428 429 430 431 432
        throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
            qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
        throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length  =
            qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
        throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
            qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
        throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
            qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
        throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
            qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
        throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
            qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);

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

436
        if (!throttle_is_valid(throttle_cfg, errp)) {
437 438 439 440 441 442 443 444
            return;
        }
    }

    if (detect_zeroes) {
        *detect_zeroes =
            qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
                            qemu_opt_get(opts, "detect-zeroes"),
445
                            BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
                            BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
                            &local_error);
        if (local_error) {
            error_propagate(errp, local_error);
            return;
        }

        if (bdrv_flags &&
            *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");
            return;
        }
    }
}

464
/* Takes the ownership of bs_opts */
465 466
static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
                                   Error **errp)
467 468 469 470
{
    const char *buf;
    int bdrv_flags = 0;
    int on_read_error, on_write_error;
471
    bool account_invalid, account_failed;
472
    bool writethrough;
M
Markus Armbruster 已提交
473
    BlockBackend *blk;
474
    BlockDriverState *bs;
475
    ThrottleConfig cfg;
476
    int snapshot = 0;
477
    Error *error = NULL;
478
    QemuOpts *opts;
479 480
    QDict *interval_dict = NULL;
    QList *interval_list = NULL;
481
    const char *id;
482 483 484
    BlockdevDetectZeroesOptions detect_zeroes =
        BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
    const char *throttling_group = NULL;
485

486 487 488
    /* 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");
489
    opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
490
    if (error) {
491
        error_propagate(errp, error);
492
        goto err_no_opts;
493 494 495
    }

    qemu_opts_absorb_qdict(opts, bs_opts, &error);
496
    if (error) {
497
        error_propagate(errp, error);
498
        goto early_err;
499 500 501 502 503 504
    }

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

505 506 507
    /* extract parameters */
    snapshot = qemu_opt_get_bool(opts, "snapshot", 0);

508 509 510
    account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
    account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);

511 512
    writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);

513 514 515 516 517 518 519 520
    qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
    qdict_array_split(interval_dict, &interval_list);

    if (qdict_size(interval_dict) != 0) {
        error_setg(errp, "Invalid option stats-intervals.%s",
                   qdict_first(interval_dict)->key);
        goto early_err;
    }
521

522 523 524 525 526
    extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
                                    &detect_zeroes, &error);
    if (error) {
        error_propagate(errp, error);
        goto early_err;
527 528 529
    }

    if ((buf = qemu_opt_get(opts, "format")) != NULL) {
530 531 532 533
        if (is_help_option(buf)) {
            error_printf("Supported formats:");
            bdrv_iterate_format(bdrv_format_print, NULL);
            error_printf("\n");
534
            goto early_err;
535
        }
536

537 538
        if (qdict_haskey(bs_opts, "driver")) {
            error_setg(errp, "Cannot specify both 'driver' and 'format'");
539
            goto early_err;
540
        }
541
        qdict_put(bs_opts, "driver", qstring_from_str(buf));
542 543
    }

544
    on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
545
    if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
546
        on_write_error = parse_block_error_action(buf, 0, &error);
547
        if (error) {
548
            error_propagate(errp, error);
549
            goto early_err;
550 551 552
        }
    }

553
    on_read_error = BLOCKDEV_ON_ERROR_REPORT;
554
    if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
555
        on_read_error = parse_block_error_action(buf, 1, &error);
556
        if (error) {
557
            error_propagate(errp, error);
558
            goto early_err;
559 560 561
        }
    }

562
    if (snapshot) {
563
        bdrv_flags |= BDRV_O_SNAPSHOT;
564 565
    }

566
    /* init */
567
    if ((!file || !*file) && !qdict_size(bs_opts)) {
568 569
        BlockBackendRootState *blk_rs;

570
        blk = blk_new(errp);
571 572 573
        if (!blk) {
            goto early_err;
        }
574

575 576
        blk_rs = blk_get_root_state(blk);
        blk_rs->open_flags    = bdrv_flags;
577
        blk_rs->read_only     = !(bdrv_flags & BDRV_O_RDWR);
578 579 580 581 582 583 584 585 586 587
        blk_rs->detect_zeroes = detect_zeroes;

        if (throttle_enabled(&cfg)) {
            if (!throttling_group) {
                throttling_group = blk_name(blk);
            }
            blk_rs->throttle_group = g_strdup(throttling_group);
            blk_rs->throttle_state = throttle_group_incref(throttling_group);
            blk_rs->throttle_state->cfg = cfg;
        }
588

589 590 591
        QDECREF(bs_opts);
    } else {
        if (file && !*file) {
592 593
            file = NULL;
        }
594

595 596 597 598 599
        /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
         * with other callers) rather than what we want as the real defaults.
         * Apply the defaults here instead. */
        qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
        qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
600
        assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
601

602 603 604 605
        if (runstate_check(RUN_STATE_INMIGRATE)) {
            bdrv_flags |= BDRV_O_INACTIVE;
        }

606
        blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
607 608 609 610
        if (!blk) {
            goto err_no_bs_opts;
        }
        bs = blk_bs(blk);
611

612
        bs->detect_zeroes = detect_zeroes;
613

614 615 616 617 618 619 620 621
        /* disk I/O throttling */
        if (throttle_enabled(&cfg)) {
            if (!throttling_group) {
                throttling_group = blk_name(blk);
            }
            bdrv_io_limits_enable(bs, throttling_group);
            bdrv_set_io_limits(bs, &cfg);
        }
622

623 624
        if (bdrv_key_required(bs)) {
            autostart = 0;
625
        }
626 627

        block_acct_init(blk_get_stats(blk), account_invalid, account_failed);
628

629 630 631 632
        if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
            blk_unref(blk);
            blk = NULL;
            goto err_no_bs_opts;
633
        }
634 635
    }

636
    blk_set_enable_write_cache(blk, !writethrough);
637
    blk_set_on_error(blk, on_read_error, on_write_error);
638

639 640 641 642 643 644
    if (!monitor_add_blk(blk, qemu_opts_id(opts), errp)) {
        blk_unref(blk);
        blk = NULL;
        goto err_no_bs_opts;
    }

645
err_no_bs_opts:
646
    qemu_opts_del(opts);
647 648
    QDECREF(interval_dict);
    QDECREF(interval_list);
649
    return blk;
650

651 652
early_err:
    qemu_opts_del(opts);
653 654
    QDECREF(interval_dict);
    QDECREF(interval_list);
655 656
err_no_opts:
    QDECREF(bs_opts);
657
    return NULL;
658 659
}

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
static QemuOptsList qemu_root_bds_opts;

/* Takes the ownership of bs_opts */
static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
{
    BlockDriverState *bs;
    QemuOpts *opts;
    Error *local_error = NULL;
    BlockdevDetectZeroesOptions detect_zeroes;
    int ret;
    int bdrv_flags = 0;

    opts = qemu_opts_create(&qemu_root_bds_opts, NULL, 1, errp);
    if (!opts) {
        goto fail;
    }

    qemu_opts_absorb_qdict(opts, bs_opts, &local_error);
    if (local_error) {
        error_propagate(errp, local_error);
        goto fail;
    }

    extract_common_blockdev_options(opts, &bdrv_flags, NULL, NULL,
                                    &detect_zeroes, &local_error);
    if (local_error) {
        error_propagate(errp, local_error);
        goto fail;
    }

690 691 692 693 694 695
    /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
     * with other callers) rather than what we want as the real defaults.
     * Apply the defaults here instead. */
    qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
    qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");

696 697 698 699
    if (runstate_check(RUN_STATE_INMIGRATE)) {
        bdrv_flags |= BDRV_O_INACTIVE;
    }

700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
    bs = NULL;
    ret = bdrv_open(&bs, NULL, NULL, bs_opts, bdrv_flags, errp);
    if (ret < 0) {
        goto fail_no_bs_opts;
    }

    bs->detect_zeroes = detect_zeroes;

fail_no_bs_opts:
    qemu_opts_del(opts);
    return bs;

fail:
    qemu_opts_del(opts);
    QDECREF(bs_opts);
    return NULL;
}

718 719 720 721 722 723 724 725 726 727 728 729 730
void blockdev_close_all_bdrv_states(void)
{
    BlockDriverState *bs, *next_bs;

    QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
        AioContext *ctx = bdrv_get_aio_context(bs);

        aio_context_acquire(ctx);
        bdrv_unref(bs);
        aio_context_release(ctx);
    }
}

M
Max Reitz 已提交
731 732 733 734 735 736 737
/* Iterates over the list of monitor-owned BlockDriverStates */
BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
{
    return bs ? QTAILQ_NEXT(bs, monitor_list)
              : QTAILQ_FIRST(&monitor_bdrv_states);
}

738 739
static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
                            Error **errp)
740 741 742 743 744
{
    const char *value;

    value = qemu_opt_get(opts, from);
    if (value) {
745 746 747 748 749
        if (qemu_opt_find(opts, to)) {
            error_setg(errp, "'%s' and its alias '%s' can't be used at the "
                       "same time", to, from);
            return;
        }
750 751 752 753
    }

    /* rename all items in opts */
    while ((value = qemu_opt_get(opts, from))) {
754
        qemu_opt_set(opts, to, value, &error_abort);
755 756 757 758
        qemu_opt_unset(opts, from);
    }
}

759 760 761 762 763
QemuOptsList qemu_legacy_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
    .desc = {
        {
764 765 766 767 768 769 770 771 772 773 774 775
            .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",
        },{
776 777 778
            .name = "media",
            .type = QEMU_OPT_STRING,
            .help = "media type (disk, cdrom)",
779 780 781 782
        },{
            .name = "if",
            .type = QEMU_OPT_STRING,
            .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
        },{
            .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)",
799 800 801 802
        },{
            .name = "boot",
            .type = QEMU_OPT_BOOL,
            .help = "(deprecated, ignored)",
803 804 805 806
        },{
            .name = "addr",
            .type = QEMU_OPT_STRING,
            .help = "pci address (virtio only)",
807 808 809 810
        },{
            .name = "serial",
            .type = QEMU_OPT_STRING,
            .help = "disk serial number",
M
Max Reitz 已提交
811 812 813 814
        },{
            .name = "file",
            .type = QEMU_OPT_STRING,
            .help = "file name",
815
        },
816 817 818 819 820 821

        /* 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",
822 823 824 825 826 827 828 829
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
830 831 832 833 834 835
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },

836 837 838 839
        { /* end of list */ }
    },
};

840
DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
841
{
K
Kevin Wolf 已提交
842
    const char *value;
843
    BlockBackend *blk;
844
    DriveInfo *dinfo = NULL;
845
    QDict *bs_opts;
846 847
    QemuOpts *legacy_opts;
    DriveMediaType media = MEDIA_DISK;
848
    BlockInterfaceType type;
849
    int cyls, heads, secs, translation;
850
    int max_devs, bus_id, unit_id, index;
851
    const char *devaddr;
852
    const char *werror, *rerror;
F
Fam Zheng 已提交
853 854
    bool read_only = false;
    bool copy_on_read;
855
    const char *serial;
M
Max Reitz 已提交
856
    const char *filename;
857
    Error *local_err = NULL;
858
    int i;
K
Kevin Wolf 已提交
859

860
    /* Change legacy command line options into QMP ones */
861 862 863 864 865 866 867
    static const struct {
        const char *from;
        const char *to;
    } opt_renames[] = {
        { "iops",           "throttling.iops-total" },
        { "iops_rd",        "throttling.iops-read" },
        { "iops_wr",        "throttling.iops-write" },
868

869 870 871
        { "bps",            "throttling.bps-total" },
        { "bps_rd",         "throttling.bps-read" },
        { "bps_wr",         "throttling.bps-write" },
872

873 874 875
        { "iops_max",       "throttling.iops-total-max" },
        { "iops_rd_max",    "throttling.iops-read-max" },
        { "iops_wr_max",    "throttling.iops-write-max" },
876

877 878 879
        { "bps_max",        "throttling.bps-total-max" },
        { "bps_rd_max",     "throttling.bps-read-max" },
        { "bps_wr_max",     "throttling.bps-write-max" },
880

881
        { "iops_size",      "throttling.iops-size" },
882

883 884
        { "group",          "throttling.group" },

885 886 887 888
        { "readonly",       "read-only" },
    };

    for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
889 890 891
        qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
                        &local_err);
        if (local_err) {
892
            error_report_err(local_err);
893 894
            return NULL;
        }
895
    }
896

K
Kevin Wolf 已提交
897 898 899
    value = qemu_opt_get(all_opts, "cache");
    if (value) {
        int flags = 0;
900
        bool writethrough;
K
Kevin Wolf 已提交
901

902
        if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
K
Kevin Wolf 已提交
903 904 905 906 907
            error_report("invalid cache option");
            return NULL;
        }

        /* Specific options take precedence */
908 909
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
910
                              !writethrough, &error_abort);
K
Kevin Wolf 已提交
911
        }
912 913
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
914
                              !!(flags & BDRV_O_NOCACHE), &error_abort);
K
Kevin Wolf 已提交
915
        }
916 917
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
918
                              !!(flags & BDRV_O_NO_FLUSH), &error_abort);
K
Kevin Wolf 已提交
919 920 921 922
        }
        qemu_opt_unset(all_opts, "cache");
    }

923 924 925 926
    /* Get a QDict for processing the options */
    bs_opts = qdict_new();
    qemu_opts_to_qdict(all_opts, bs_opts);

927 928
    legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
                                   &error_abort);
929
    qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
930
    if (local_err) {
931
        error_report_err(local_err);
932 933 934
        goto fail;
    }

935 936 937 938 939 940 941
    /* 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");
    }

942 943 944 945 946 947 948
    /* 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 已提交
949
            read_only = true;
950 951 952 953 954 955
        } else {
            error_report("'%s' invalid media", value);
            goto fail;
        }
    }

956
    /* copy-on-read is disabled with a warning for read-only devices */
F
Fam Zheng 已提交
957
    read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
958 959 960 961 962 963 964 965 966 967 968 969
    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"));

970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
    /* 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;
    }

985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
    /* 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;
1017 1018 1019 1020
        } else if (!strcmp(value, "large")) {
            translation = BIOS_ATA_TRANSLATION_LARGE;
        } else if (!strcmp(value, "rechs")) {
            translation = BIOS_ATA_TRANSLATION_RECHS;
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
        } 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;
        }
    }

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

1075 1076 1077
    /* Serial number */
    serial = qemu_opt_get(legacy_opts, "serial");

1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
    /* 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);
    }

1096 1097 1098 1099 1100 1101 1102 1103 1104
    /* 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;
1105 1106
        devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
                                   &error_abort);
1107
        if (arch_type == QEMU_ARCH_S390X) {
1108
            qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1109
        } else {
1110
            qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1111
        }
1112 1113
        qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
                     &error_abort);
1114
        if (devaddr) {
1115
            qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1116 1117 1118
        }
    }

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

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
    /* 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));
    }

1142
    /* Actual block device init: Functionality shared with blockdev-add */
1143
    blk = blockdev_init(filename, bs_opts, &local_err);
1144
    bs_opts = NULL;
1145
    if (!blk) {
1146
        if (local_err) {
1147
            error_report_err(local_err);
1148
        }
1149
        goto fail;
1150
    } else {
1151
        assert(!local_err);
1152 1153
    }

1154 1155
    /* Create legacy DriveInfo */
    dinfo = g_malloc0(sizeof(*dinfo));
1156
    dinfo->opts = all_opts;
1157

1158 1159 1160 1161 1162
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

1163
    dinfo->type = type;
1164 1165
    dinfo->bus = bus_id;
    dinfo->unit = unit_id;
1166
    dinfo->devaddr = devaddr;
1167 1168
    dinfo->serial = g_strdup(serial);

1169 1170
    blk_set_legacy_dinfo(blk, dinfo);

1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
    switch(type) {
    case IF_IDE:
    case IF_SCSI:
    case IF_XEN:
    case IF_NONE:
        dinfo->media_cd = media == MEDIA_CDROM;
        break;
    default:
        break;
    }

1182
fail:
1183
    qemu_opts_del(legacy_opts);
1184
    QDECREF(bs_opts);
1185
    return dinfo;
1186 1187
}

1188
void hmp_commit(Monitor *mon, const QDict *qdict)
1189 1190
{
    const char *device = qdict_get_str(qdict, "device");
1191
    BlockBackend *blk;
1192
    int ret;
1193

1194
    if (!strcmp(device, "all")) {
1195
        ret = blk_commit_all();
1196
    } else {
1197 1198 1199
        BlockDriverState *bs;
        AioContext *aio_context;

1200 1201
        blk = blk_by_name(device);
        if (!blk) {
1202
            monitor_printf(mon, "Device '%s' not found\n", device);
1203
            return;
1204
        }
M
Max Reitz 已提交
1205 1206 1207 1208
        if (!blk_is_available(blk)) {
            monitor_printf(mon, "Device '%s' has no medium\n", device);
            return;
        }
1209 1210 1211 1212 1213 1214 1215 1216

        bs = blk_bs(blk);
        aio_context = bdrv_get_aio_context(bs);
        aio_context_acquire(aio_context);

        ret = bdrv_commit(bs);

        aio_context_release(aio_context);
1217 1218 1219 1220
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
1221 1222 1223
    }
}

1224
static void blockdev_do_action(TransactionAction *action, Error **errp)
1225
{
1226
    TransactionActionList list;
1227

1228
    list.value = action;
1229
    list.next = NULL;
J
John Snow 已提交
1230
    qmp_transaction(&list, false, NULL, errp);
1231 1232
}

1233 1234 1235 1236 1237
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,
1238
                                bool has_format, const char *format,
1239
                                bool has_mode, NewImageMode mode, Error **errp)
1240
{
1241
    BlockdevSnapshotSync snapshot = {
1242
        .has_device = has_device,
1243
        .device = (char *) device,
1244 1245
        .has_node_name = has_node_name,
        .node_name = (char *) node_name,
1246
        .snapshot_file = (char *) snapshot_file,
1247 1248
        .has_snapshot_node_name = has_snapshot_node_name,
        .snapshot_node_name = (char *) snapshot_node_name,
1249 1250 1251 1252 1253
        .has_format = has_format,
        .format = (char *) format,
        .has_mode = has_mode,
        .mode = mode,
    };
1254 1255
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1256
        .u.blockdev_snapshot_sync.data = &snapshot,
1257 1258
    };
    blockdev_do_action(&action, errp);
1259 1260
}

1261 1262 1263 1264 1265 1266 1267
void qmp_blockdev_snapshot(const char *node, const char *overlay,
                           Error **errp)
{
    BlockdevSnapshot snapshot_data = {
        .node = (char *) node,
        .overlay = (char *) overlay
    };
1268 1269
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1270
        .u.blockdev_snapshot.data = &snapshot_data,
1271 1272
    };
    blockdev_do_action(&action, errp);
1273 1274
}

1275 1276 1277 1278 1279 1280 1281 1282
void qmp_blockdev_snapshot_internal_sync(const char *device,
                                         const char *name,
                                         Error **errp)
{
    BlockdevSnapshotInternal snapshot = {
        .device = (char *) device,
        .name = (char *) name
    };
1283 1284
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1285
        .u.blockdev_snapshot_internal_sync.data = &snapshot,
1286 1287
    };
    blockdev_do_action(&action, errp);
1288 1289
}

1290 1291 1292 1293 1294 1295 1296
SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
                                                         bool has_id,
                                                         const char *id,
                                                         bool has_name,
                                                         const char *name,
                                                         Error **errp)
{
1297 1298
    BlockDriverState *bs;
    BlockBackend *blk;
1299
    AioContext *aio_context;
1300 1301 1302 1303 1304
    QEMUSnapshotInfo sn;
    Error *local_err = NULL;
    SnapshotInfo *info = NULL;
    int ret;

1305 1306
    blk = blk_by_name(device);
    if (!blk) {
1307 1308
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
1309 1310
        return NULL;
    }
M
Max Reitz 已提交
1311 1312 1313

    aio_context = blk_get_aio_context(blk);
    aio_context_acquire(aio_context);
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324

    if (!has_id) {
        id = NULL;
    }

    if (!has_name) {
        name = NULL;
    }

    if (!id && !name) {
        error_setg(errp, "Name or id must be provided");
M
Max Reitz 已提交
1325
        goto out_aio_context;
1326 1327
    }

M
Max Reitz 已提交
1328 1329 1330 1331 1332
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out_aio_context;
    }
    bs = blk_bs(blk);
1333

1334 1335 1336 1337
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
        goto out_aio_context;
    }

1338
    ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1339
    if (local_err) {
1340
        error_propagate(errp, local_err);
1341
        goto out_aio_context;
1342 1343 1344 1345 1346 1347
    }
    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);
1348
        goto out_aio_context;
1349 1350 1351
    }

    bdrv_snapshot_delete(bs, id, name, &local_err);
1352
    if (local_err) {
1353
        error_propagate(errp, local_err);
1354
        goto out_aio_context;
1355 1356
    }

1357 1358
    aio_context_release(aio_context);

1359
    info = g_new0(SnapshotInfo, 1);
1360 1361 1362 1363 1364 1365 1366 1367 1368
    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;
1369 1370 1371 1372

out_aio_context:
    aio_context_release(aio_context);
    return NULL;
1373
}
1374

1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
/**
 * block_dirty_bitmap_lookup:
 * Return a dirty bitmap (if present), after validating
 * the node reference and bitmap names.
 *
 * @node: The name of the BDS node to search for bitmaps
 * @name: The name of the bitmap to search for
 * @pbs: Output pointer for BDS lookup, if desired. Can be NULL.
 * @paio: Output pointer for aio_context acquisition, if desired. Can be NULL.
 * @errp: Output pointer for error information. Can be NULL.
 *
 * @return: A bitmap object on success, or NULL on failure.
 */
static BdrvDirtyBitmap *block_dirty_bitmap_lookup(const char *node,
                                                  const char *name,
                                                  BlockDriverState **pbs,
                                                  AioContext **paio,
                                                  Error **errp)
{
    BlockDriverState *bs;
    BdrvDirtyBitmap *bitmap;
    AioContext *aio_context;

    if (!node) {
        error_setg(errp, "Node cannot be NULL");
        return NULL;
    }
    if (!name) {
        error_setg(errp, "Bitmap name cannot be NULL");
        return NULL;
    }
    bs = bdrv_lookup_bs(node, node, NULL);
    if (!bs) {
        error_setg(errp, "Node '%s' not found", node);
        return NULL;
    }

    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

    bitmap = bdrv_find_dirty_bitmap(bs, name);
    if (!bitmap) {
        error_setg(errp, "Dirty bitmap '%s' not found", name);
        goto fail;
    }

    if (pbs) {
        *pbs = bs;
    }
    if (paio) {
        *paio = aio_context;
    } else {
        aio_context_release(aio_context);
    }

    return bitmap;

 fail:
    aio_context_release(aio_context);
    return NULL;
}

1437
/* New and old BlockDriverState structs for atomic group operations */
1438

1439
typedef struct BlkActionState BlkActionState;
1440

1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
/**
 * BlkActionOps:
 * Table of operations that define an Action.
 *
 * @instance_size: Size of state struct, in bytes.
 * @prepare: Prepare the work, must NOT be NULL.
 * @commit: Commit the changes, can be NULL.
 * @abort: Abort the changes on fail, can be NULL.
 * @clean: Clean up resources after all transaction actions have called
 *         commit() or abort(). Can be NULL.
 *
 * Only prepare() may fail. In a single transaction, only one of commit() or
 * abort() will be called. clean() will always be called if it is present.
 */
typedef struct BlkActionOps {
1456
    size_t instance_size;
1457 1458 1459 1460 1461
    void (*prepare)(BlkActionState *common, Error **errp);
    void (*commit)(BlkActionState *common);
    void (*abort)(BlkActionState *common);
    void (*clean)(BlkActionState *common);
} BlkActionOps;
1462

1463 1464 1465 1466 1467 1468
/**
 * BlkActionState:
 * Describes one Action's state within a Transaction.
 *
 * @action: QAPI-defined enum identifying which Action to perform.
 * @ops: Table of ActionOps this Action can perform.
J
John Snow 已提交
1469
 * @block_job_txn: Transaction which this action belongs to.
1470 1471 1472 1473 1474
 * @entry: List membership for all Actions in this Transaction.
 *
 * This structure must be arranged as first member in a subclassed type,
 * assuming that the compiler will also arrange it to the same offsets as the
 * base class.
1475
 */
1476
struct BlkActionState {
1477
    TransactionAction *action;
1478
    const BlkActionOps *ops;
J
John Snow 已提交
1479 1480
    BlockJobTxn *block_job_txn;
    TransactionProperties *txn_props;
1481
    QSIMPLEQ_ENTRY(BlkActionState) entry;
1482 1483
};

1484 1485
/* internal snapshot private data */
typedef struct InternalSnapshotState {
1486
    BlkActionState common;
1487
    BlockDriverState *bs;
1488
    AioContext *aio_context;
1489
    QEMUSnapshotInfo sn;
1490
    bool created;
1491 1492
} InternalSnapshotState;

J
John Snow 已提交
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506

static int action_check_completion_mode(BlkActionState *s, Error **errp)
{
    if (s->txn_props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
        error_setg(errp,
                   "Action '%s' does not support Transaction property "
                   "completion-mode = %s",
                   TransactionActionKind_lookup[s->action->type],
                   ActionCompletionMode_lookup[s->txn_props->completion_mode]);
        return -1;
    }
    return 0;
}

1507
static void internal_snapshot_prepare(BlkActionState *common,
1508 1509
                                      Error **errp)
{
1510
    Error *local_err = NULL;
1511 1512
    const char *device;
    const char *name;
1513
    BlockBackend *blk;
1514 1515 1516 1517 1518 1519 1520 1521
    BlockDriverState *bs;
    QEMUSnapshotInfo old_sn, *sn;
    bool ret;
    qemu_timeval tv;
    BlockdevSnapshotInternal *internal;
    InternalSnapshotState *state;
    int ret1;

1522
    g_assert(common->action->type ==
1523
             TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1524
    internal = common->action->u.blockdev_snapshot_internal_sync.data;
1525 1526 1527 1528 1529 1530 1531
    state = DO_UPCAST(InternalSnapshotState, common, common);

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

    /* 2. check for validation */
J
John Snow 已提交
1532 1533 1534 1535
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1536 1537
    blk = blk_by_name(device);
    if (!blk) {
1538 1539
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
1540 1541 1542
        return;
    }

1543
    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1544
    state->aio_context = blk_get_aio_context(blk);
1545 1546
    aio_context_acquire(state->aio_context);

M
Max Reitz 已提交
1547
    if (!blk_is_available(blk)) {
1548
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1549 1550
        return;
    }
M
Max Reitz 已提交
1551
    bs = blk_bs(blk);
1552

1553 1554 1555
    state->bs = bs;
    bdrv_drained_begin(bs);

1556 1557 1558 1559
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
        return;
    }

1560
    if (bdrv_is_read_only(bs)) {
1561
        error_setg(errp, "Device '%s' is read only", device);
1562 1563 1564 1565
        return;
    }

    if (!bdrv_can_snapshot(bs)) {
1566 1567 1568
        error_setg(errp, "Block format '%s' used by device '%s' "
                   "does not support internal snapshots",
                   bs->drv->format_name, device);
1569 1570 1571 1572 1573 1574 1575 1576 1577
        return;
    }

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

    /* check whether a snapshot with name exist */
1578 1579 1580 1581
    ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
                                            &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
        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 */
1607
    state->created = true;
1608 1609
}

1610
static void internal_snapshot_abort(BlkActionState *common)
1611 1612 1613 1614 1615 1616 1617
{
    InternalSnapshotState *state =
                             DO_UPCAST(InternalSnapshotState, common, common);
    BlockDriverState *bs = state->bs;
    QEMUSnapshotInfo *sn = &state->sn;
    Error *local_error = NULL;

1618
    if (!state->created) {
1619 1620 1621 1622
        return;
    }

    if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1623 1624 1625 1626 1627
        error_reportf_err(local_error,
                          "Failed to delete snapshot with id '%s' and "
                          "name '%s' on device '%s' in abort: ",
                          sn->id_str, sn->name,
                          bdrv_get_device_name(bs));
1628 1629 1630
    }
}

1631
static void internal_snapshot_clean(BlkActionState *common)
1632 1633 1634 1635 1636
{
    InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
                                             common, common);

    if (state->aio_context) {
1637 1638 1639
        if (state->bs) {
            bdrv_drained_end(state->bs);
        }
1640 1641 1642 1643
        aio_context_release(state->aio_context);
    }
}

1644
/* external snapshot private data */
1645
typedef struct ExternalSnapshotState {
1646
    BlkActionState common;
1647 1648
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1649
    AioContext *aio_context;
1650
} ExternalSnapshotState;
1651

1652
static void external_snapshot_prepare(BlkActionState *common,
1653 1654
                                      Error **errp)
{
1655 1656
    int flags = 0, ret;
    QDict *options = NULL;
1657
    Error *local_err = NULL;
1658
    /* Device and node name of the image to generate the snapshot from */
1659
    const char *device;
1660
    const char *node_name;
1661 1662 1663
    /* Reference to the new image (for 'blockdev-snapshot') */
    const char *snapshot_ref;
    /* File name of the new image (for 'blockdev-snapshot-sync') */
1664
    const char *new_image_file;
1665 1666
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1667
    TransactionAction *action = common->action;
1668

1669 1670 1671 1672 1673
    /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
     * purpose but a different set of parameters */
    switch (action->type) {
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
        {
1674
            BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1675 1676 1677 1678 1679 1680 1681 1682
            device = s->node;
            node_name = s->node;
            new_image_file = NULL;
            snapshot_ref = s->overlay;
        }
        break;
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
        {
1683
            BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1684 1685 1686 1687 1688 1689 1690 1691
            device = s->has_device ? s->device : NULL;
            node_name = s->has_node_name ? s->node_name : NULL;
            new_image_file = s->snapshot_file;
            snapshot_ref = NULL;
        }
        break;
    default:
        g_assert_not_reached();
1692 1693 1694
    }

    /* start processing */
J
John Snow 已提交
1695 1696 1697 1698
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1699 1700
    state->old_bs = bdrv_lookup_bs(device, node_name, errp);
    if (!state->old_bs) {
1701 1702 1703
        return;
    }

1704 1705 1706
    /* Acquire AioContext now so any threads operating on old_bs stop */
    state->aio_context = bdrv_get_aio_context(state->old_bs);
    aio_context_acquire(state->aio_context);
1707
    bdrv_drained_begin(state->old_bs);
1708

1709
    if (!bdrv_is_inserted(state->old_bs)) {
1710
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1711 1712 1713
        return;
    }

1714 1715
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1716 1717 1718
        return;
    }

1719 1720
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1721
            error_setg(errp, QERR_IO_ERROR);
1722 1723 1724 1725
            return;
        }
    }

1726
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1727
        error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1728 1729 1730
        return;
    }

1731
    if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1732
        BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1733 1734 1735 1736
        const char *format = s->has_format ? s->format : "qcow2";
        enum NewImageMode mode;
        const char *snapshot_node_name =
            s->has_snapshot_node_name ? s->snapshot_node_name : NULL;
1737

1738 1739
        if (node_name && !snapshot_node_name) {
            error_setg(errp, "New snapshot node name missing");
1740 1741 1742
            return;
        }

1743 1744 1745 1746 1747 1748 1749
        if (snapshot_node_name &&
            bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
            error_setg(errp, "New snapshot node name already in use");
            return;
        }

        flags = state->old_bs->open_flags;
1750
        flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1751 1752 1753 1754

        /* create new image w/backing file */
        mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
        if (mode != NEW_IMAGE_MODE_EXISTING) {
1755 1756 1757 1758 1759
            int64_t size = bdrv_getlength(state->old_bs);
            if (size < 0) {
                error_setg_errno(errp, -size, "bdrv_getlength failed");
                return;
            }
1760 1761 1762
            bdrv_img_create(new_image_file, format,
                            state->old_bs->filename,
                            state->old_bs->drv->format_name,
1763
                            NULL, size, flags, &local_err, false);
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777
            if (local_err) {
                error_propagate(errp, local_err);
                return;
            }
        }

        options = qdict_new();
        if (s->has_snapshot_node_name) {
            qdict_put(options, "node-name",
                      qstring_from_str(snapshot_node_name));
        }
        qdict_put(options, "driver", qstring_from_str(format));

        flags |= BDRV_O_NO_BACKING;
1778 1779
    }

1780
    assert(state->new_bs == NULL);
1781 1782
    ret = bdrv_open(&state->new_bs, new_image_file, snapshot_ref, options,
                    flags, errp);
1783
    /* We will manually add the backing_hd field to the bs later */
1784
    if (ret != 0) {
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800
        return;
    }

    if (state->new_bs->blk != NULL) {
        error_setg(errp, "The snapshot is already in use by %s",
                   blk_name(state->new_bs->blk));
        return;
    }

    if (bdrv_op_is_blocked(state->new_bs, BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
                           errp)) {
        return;
    }

    if (state->new_bs->backing != NULL) {
        error_setg(errp, "The snapshot already has a backing image");
1801 1802 1803 1804 1805
        return;
    }

    if (!state->new_bs->drv->supports_backing) {
        error_setg(errp, "The snapshot does not support backing images");
1806 1807 1808
    }
}

1809
static void external_snapshot_commit(BlkActionState *common)
1810
{
1811 1812
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1813

1814 1815
    bdrv_set_aio_context(state->new_bs, state->aio_context);

1816 1817
    /* This removes our old bs and adds the new bs */
    bdrv_append(state->new_bs, state->old_bs);
1818 1819 1820
    /* 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 */
1821 1822 1823 1824
    if (!state->old_bs->copy_on_read) {
        bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
                    NULL);
    }
1825 1826
}

1827
static void external_snapshot_abort(BlkActionState *common)
1828
{
1829 1830 1831
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
F
Fam Zheng 已提交
1832
        bdrv_unref(state->new_bs);
1833
    }
1834 1835
}

1836
static void external_snapshot_clean(BlkActionState *common)
1837 1838 1839
{
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1840
    if (state->aio_context) {
1841
        bdrv_drained_end(state->old_bs);
1842 1843
        aio_context_release(state->aio_context);
    }
1844 1845
}

1846
typedef struct DriveBackupState {
1847
    BlkActionState common;
1848
    BlockDriverState *bs;
1849
    AioContext *aio_context;
1850 1851 1852
    BlockJob *job;
} DriveBackupState;

1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
static void do_drive_backup(const char *device, const char *target,
                            bool has_format, const char *format,
                            enum MirrorSyncMode sync,
                            bool has_mode, enum NewImageMode mode,
                            bool has_speed, int64_t speed,
                            bool has_bitmap, const char *bitmap,
                            bool has_on_source_error,
                            BlockdevOnError on_source_error,
                            bool has_on_target_error,
                            BlockdevOnError on_target_error,
                            BlockJobTxn *txn, Error **errp);

1865
static void drive_backup_prepare(BlkActionState *common, Error **errp)
1866 1867
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1868
    BlockBackend *blk;
1869 1870 1871
    DriveBackup *backup;
    Error *local_err = NULL;

1872
    assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1873
    backup = common->action->u.drive_backup.data;
1874

1875 1876
    blk = blk_by_name(backup->device);
    if (!blk) {
1877 1878
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", backup->device);
1879 1880 1881
        return;
    }

1882 1883 1884 1885 1886
    if (!blk_is_available(blk)) {
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
        return;
    }

1887
    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1888
    state->aio_context = blk_get_aio_context(blk);
1889
    aio_context_acquire(state->aio_context);
1890 1891
    bdrv_drained_begin(blk_bs(blk));
    state->bs = blk_bs(blk);
1892

1893 1894 1895 1896 1897 1898 1899 1900
    do_drive_backup(backup->device, backup->target,
                    backup->has_format, backup->format,
                    backup->sync,
                    backup->has_mode, backup->mode,
                    backup->has_speed, backup->speed,
                    backup->has_bitmap, backup->bitmap,
                    backup->has_on_source_error, backup->on_source_error,
                    backup->has_on_target_error, backup->on_target_error,
J
John Snow 已提交
1901
                    common->block_job_txn, &local_err);
1902
    if (local_err) {
1903 1904 1905 1906 1907 1908 1909
        error_propagate(errp, local_err);
        return;
    }

    state->job = state->bs->job;
}

1910
static void drive_backup_abort(BlkActionState *common)
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
{
    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);
    }
}

1921
static void drive_backup_clean(BlkActionState *common)
1922 1923 1924 1925
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);

    if (state->aio_context) {
1926
        bdrv_drained_end(state->bs);
1927 1928 1929 1930
        aio_context_release(state->aio_context);
    }
}

1931
typedef struct BlockdevBackupState {
1932
    BlkActionState common;
1933 1934 1935 1936 1937
    BlockDriverState *bs;
    BlockJob *job;
    AioContext *aio_context;
} BlockdevBackupState;

1938 1939 1940 1941 1942 1943 1944 1945 1946
static void do_blockdev_backup(const char *device, const char *target,
                               enum MirrorSyncMode sync,
                               bool has_speed, int64_t speed,
                               bool has_on_source_error,
                               BlockdevOnError on_source_error,
                               bool has_on_target_error,
                               BlockdevOnError on_target_error,
                               BlockJobTxn *txn, Error **errp);

1947
static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1948 1949 1950
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
    BlockdevBackup *backup;
M
Max Reitz 已提交
1951
    BlockBackend *blk, *target;
1952 1953
    Error *local_err = NULL;

1954
    assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1955
    backup = common->action->u.blockdev_backup.data;
1956

1957 1958
    blk = blk_by_name(backup->device);
    if (!blk) {
1959
        error_setg(errp, "Device '%s' not found", backup->device);
1960 1961 1962
        return;
    }

1963 1964 1965 1966 1967
    if (!blk_is_available(blk)) {
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
        return;
    }

M
Max Reitz 已提交
1968 1969
    target = blk_by_name(backup->target);
    if (!target) {
1970
        error_setg(errp, "Device '%s' not found", backup->target);
1971 1972 1973 1974
        return;
    }

    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1975 1976
    state->aio_context = blk_get_aio_context(blk);
    if (state->aio_context != blk_get_aio_context(target)) {
1977 1978 1979 1980 1981
        state->aio_context = NULL;
        error_setg(errp, "Backup between two IO threads is not implemented");
        return;
    }
    aio_context_acquire(state->aio_context);
1982 1983
    state->bs = blk_bs(blk);
    bdrv_drained_begin(state->bs);
1984

1985 1986 1987 1988 1989
    do_blockdev_backup(backup->device, backup->target,
                       backup->sync,
                       backup->has_speed, backup->speed,
                       backup->has_on_source_error, backup->on_source_error,
                       backup->has_on_target_error, backup->on_target_error,
J
John Snow 已提交
1990
                       common->block_job_txn, &local_err);
1991 1992 1993 1994 1995 1996 1997 1998
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

    state->job = state->bs->job;
}

1999
static void blockdev_backup_abort(BlkActionState *common)
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, 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);
    }
}

2010
static void blockdev_backup_clean(BlkActionState *common)
2011 2012 2013 2014
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);

    if (state->aio_context) {
2015
        bdrv_drained_end(state->bs);
2016 2017 2018 2019
        aio_context_release(state->aio_context);
    }
}

F
Fam Zheng 已提交
2020
typedef struct BlockDirtyBitmapState {
2021
    BlkActionState common;
F
Fam Zheng 已提交
2022 2023 2024 2025 2026 2027 2028
    BdrvDirtyBitmap *bitmap;
    BlockDriverState *bs;
    AioContext *aio_context;
    HBitmap *backup;
    bool prepared;
} BlockDirtyBitmapState;

2029
static void block_dirty_bitmap_add_prepare(BlkActionState *common,
F
Fam Zheng 已提交
2030 2031 2032 2033 2034 2035 2036
                                           Error **errp)
{
    Error *local_err = NULL;
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

J
John Snow 已提交
2037 2038 2039 2040
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2041
    action = common->action->u.block_dirty_bitmap_add.data;
F
Fam Zheng 已提交
2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
    /* AIO context taken and released within qmp_block_dirty_bitmap_add */
    qmp_block_dirty_bitmap_add(action->node, action->name,
                               action->has_granularity, action->granularity,
                               &local_err);

    if (!local_err) {
        state->prepared = true;
    } else {
        error_propagate(errp, local_err);
    }
}

2054
static void block_dirty_bitmap_add_abort(BlkActionState *common)
F
Fam Zheng 已提交
2055 2056 2057 2058 2059
{
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

2060
    action = common->action->u.block_dirty_bitmap_add.data;
F
Fam Zheng 已提交
2061 2062 2063 2064 2065 2066 2067 2068
    /* Should not be able to fail: IF the bitmap was added via .prepare(),
     * then the node reference and bitmap name must have been valid.
     */
    if (state->prepared) {
        qmp_block_dirty_bitmap_remove(action->node, action->name, &error_abort);
    }
}

2069
static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
F
Fam Zheng 已提交
2070 2071 2072 2073 2074 2075
                                             Error **errp)
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);
    BlockDirtyBitmap *action;

J
John Snow 已提交
2076 2077 2078 2079
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2080
    action = common->action->u.block_dirty_bitmap_clear.data;
F
Fam Zheng 已提交
2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
    state->bitmap = block_dirty_bitmap_lookup(action->node,
                                              action->name,
                                              &state->bs,
                                              &state->aio_context,
                                              errp);
    if (!state->bitmap) {
        return;
    }

    if (bdrv_dirty_bitmap_frozen(state->bitmap)) {
        error_setg(errp, "Cannot modify a frozen bitmap");
        return;
    } else if (!bdrv_dirty_bitmap_enabled(state->bitmap)) {
        error_setg(errp, "Cannot clear a disabled bitmap");
        return;
    }

    bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
    /* AioContext is released in .clean() */
}

2102
static void block_dirty_bitmap_clear_abort(BlkActionState *common)
F
Fam Zheng 已提交
2103 2104 2105 2106 2107 2108 2109
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

    bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
}

2110
static void block_dirty_bitmap_clear_commit(BlkActionState *common)
F
Fam Zheng 已提交
2111 2112 2113 2114 2115 2116 2117
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

    hbitmap_free(state->backup);
}

2118
static void block_dirty_bitmap_clear_clean(BlkActionState *common)
F
Fam Zheng 已提交
2119 2120 2121 2122 2123 2124 2125 2126 2127
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

    if (state->aio_context) {
        aio_context_release(state->aio_context);
    }
}

2128
static void abort_prepare(BlkActionState *common, Error **errp)
2129 2130 2131 2132
{
    error_setg(errp, "Transaction aborted using Abort action");
}

2133
static void abort_commit(BlkActionState *common)
2134
{
2135
    g_assert_not_reached(); /* this action never succeeds */
2136 2137
}

2138
static const BlkActionOps actions[] = {
2139 2140 2141 2142 2143
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
        .instance_size = sizeof(ExternalSnapshotState),
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2144
        .clean = external_snapshot_clean,
2145
    },
2146
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2147
        .instance_size = sizeof(ExternalSnapshotState),
2148 2149 2150
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2151
        .clean = external_snapshot_clean,
2152
    },
2153 2154 2155 2156
    [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
        .instance_size = sizeof(DriveBackupState),
        .prepare = drive_backup_prepare,
        .abort = drive_backup_abort,
2157
        .clean = drive_backup_clean,
2158
    },
2159 2160 2161 2162 2163 2164
    [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
        .instance_size = sizeof(BlockdevBackupState),
        .prepare = blockdev_backup_prepare,
        .abort = blockdev_backup_abort,
        .clean = blockdev_backup_clean,
    },
2165
    [TRANSACTION_ACTION_KIND_ABORT] = {
2166
        .instance_size = sizeof(BlkActionState),
2167 2168 2169
        .prepare = abort_prepare,
        .commit = abort_commit,
    },
2170 2171 2172 2173
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
        .instance_size = sizeof(InternalSnapshotState),
        .prepare  = internal_snapshot_prepare,
        .abort = internal_snapshot_abort,
2174
        .clean = internal_snapshot_clean,
2175
    },
F
Fam Zheng 已提交
2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187
    [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
        .instance_size = sizeof(BlockDirtyBitmapState),
        .prepare = block_dirty_bitmap_add_prepare,
        .abort = block_dirty_bitmap_add_abort,
    },
    [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
        .instance_size = sizeof(BlockDirtyBitmapState),
        .prepare = block_dirty_bitmap_clear_prepare,
        .commit = block_dirty_bitmap_clear_commit,
        .abort = block_dirty_bitmap_clear_abort,
        .clean = block_dirty_bitmap_clear_clean,
    }
2188 2189
};

J
John Snow 已提交
2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208
/**
 * Allocate a TransactionProperties structure if necessary, and fill
 * that structure with desired defaults if they are unset.
 */
static TransactionProperties *get_transaction_properties(
    TransactionProperties *props)
{
    if (!props) {
        props = g_new0(TransactionProperties, 1);
    }

    if (!props->has_completion_mode) {
        props->has_completion_mode = true;
        props->completion_mode = ACTION_COMPLETION_MODE_INDIVIDUAL;
    }

    return props;
}

2209
/*
2210 2211
 * 'Atomic' group operations.  The operations are performed as a set, and if
 * any fail then we roll back all operations in the group.
2212
 */
J
John Snow 已提交
2213 2214 2215 2216
void qmp_transaction(TransactionActionList *dev_list,
                     bool has_props,
                     struct TransactionProperties *props,
                     Error **errp)
2217
{
2218
    TransactionActionList *dev_entry = dev_list;
J
John Snow 已提交
2219
    BlockJobTxn *block_job_txn = NULL;
2220
    BlkActionState *state, *next;
2221
    Error *local_err = NULL;
2222

2223
    QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2224 2225
    QSIMPLEQ_INIT(&snap_bdrv_states);

J
John Snow 已提交
2226 2227 2228 2229 2230 2231 2232 2233
    /* Does this transaction get canceled as a group on failure?
     * If not, we don't really need to make a BlockJobTxn.
     */
    props = get_transaction_properties(props);
    if (props->completion_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
        block_job_txn = block_job_txn_new();
    }

2234
    /* drain all i/o before any operations */
2235 2236
    bdrv_drain_all();

2237
    /* We don't do anything in this loop that commits us to the operations */
2238
    while (NULL != dev_entry) {
2239
        TransactionAction *dev_info = NULL;
2240
        const BlkActionOps *ops;
2241

2242 2243 2244
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

2245
        assert(dev_info->type < ARRAY_SIZE(actions));
2246

2247
        ops = &actions[dev_info->type];
2248 2249
        assert(ops->instance_size > 0);

2250 2251 2252
        state = g_malloc0(ops->instance_size);
        state->ops = ops;
        state->action = dev_info;
J
John Snow 已提交
2253 2254
        state->block_job_txn = block_job_txn;
        state->txn_props = props;
2255
        QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2256

2257
        state->ops->prepare(state, &local_err);
2258
        if (local_err) {
2259 2260
            error_propagate(errp, local_err);
            goto delete_and_fail;
2261 2262 2263
        }
    }

2264
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2265 2266 2267
        if (state->ops->commit) {
            state->ops->commit(state);
        }
2268 2269 2270 2271 2272 2273
    }

    /* success */
    goto exit;

delete_and_fail:
2274
    /* failure, and it is all-or-none; roll back all operations */
2275 2276 2277
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
        if (state->ops->abort) {
            state->ops->abort(state);
2278
        }
2279 2280
    }
exit:
2281 2282 2283
    QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
        if (state->ops->clean) {
            state->ops->clean(state);
2284
        }
2285
        g_free(state);
2286
    }
J
John Snow 已提交
2287 2288 2289 2290
    if (!has_props) {
        qapi_free_TransactionProperties(props);
    }
    block_job_txn_unref(block_job_txn);
2291 2292
}

L
Luiz Capitulino 已提交
2293
void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2294
{
2295
    Error *local_err = NULL;
2296

2297 2298 2299
    qmp_blockdev_open_tray(device, has_force, force, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2300
        return;
2301 2302
    }

2303
    qmp_x_blockdev_remove_medium(device, errp);
2304 2305
}

2306 2307 2308
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
2309
{
2310
    Error *local_err = NULL;
2311
    BlockDriverState *bs;
2312
    AioContext *aio_context;
2313

2314 2315 2316
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2317
    if (local_err) {
2318
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2319
        return;
2320 2321
    }

2322 2323 2324
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2325
    bdrv_add_key(bs, password, errp);
2326 2327

    aio_context_release(aio_context);
2328 2329
}

M
Max Reitz 已提交
2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
                            Error **errp)
{
    BlockBackend *blk;
    bool locked;

    if (!has_force) {
        force = false;
    }

    blk = blk_by_name(device);
    if (!blk) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
        return;
    }

    if (!blk_dev_has_removable_media(blk)) {
        error_setg(errp, "Device '%s' is not removable", device);
        return;
    }

2352 2353 2354 2355 2356
    if (!blk_dev_has_tray(blk)) {
        /* Ignore this command on tray-less devices */
        return;
    }

M
Max Reitz 已提交
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370
    if (blk_dev_is_tray_open(blk)) {
        return;
    }

    locked = blk_dev_is_medium_locked(blk);
    if (locked) {
        blk_dev_eject_request(blk, force);
    }

    if (!locked || force) {
        blk_dev_change_media_cb(blk, false);
    }
}

M
Max Reitz 已提交
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
void qmp_blockdev_close_tray(const char *device, Error **errp)
{
    BlockBackend *blk;

    blk = blk_by_name(device);
    if (!blk) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
        return;
    }

    if (!blk_dev_has_removable_media(blk)) {
        error_setg(errp, "Device '%s' is not removable", device);
        return;
    }

2387 2388 2389 2390 2391
    if (!blk_dev_has_tray(blk)) {
        /* Ignore this command on tray-less devices */
        return;
    }

M
Max Reitz 已提交
2392 2393 2394 2395 2396 2397 2398
    if (!blk_dev_is_tray_open(blk)) {
        return;
    }

    blk_dev_change_media_cb(blk, true);
}

2399
void qmp_x_blockdev_remove_medium(const char *device, Error **errp)
M
Max Reitz 已提交
2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420
{
    BlockBackend *blk;
    BlockDriverState *bs;
    AioContext *aio_context;
    bool has_device;

    blk = blk_by_name(device);
    if (!blk) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
        return;
    }

    /* For BBs without a device, we can exchange the BDS tree at will */
    has_device = blk_get_attached_dev(blk);

    if (has_device && !blk_dev_has_removable_media(blk)) {
        error_setg(errp, "Device '%s' is not removable", device);
        return;
    }

2421
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
M
Max Reitz 已提交
2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
        error_setg(errp, "Tray of device '%s' is not open", device);
        return;
    }

    bs = blk_bs(blk);
    if (!bs) {
        return;
    }

    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_EJECT, errp)) {
        goto out;
    }

    blk_remove_bs(blk);

2440 2441 2442 2443 2444 2445 2446 2447
    if (!blk_dev_has_tray(blk)) {
        /* For tray-less devices, blockdev-open-tray is a no-op (or may not be
         * called at all); therefore, the medium needs to be ejected here.
         * Do it after blk_remove_bs() so blk_is_inserted(blk) returns the @load
         * value passed here (i.e. false). */
        blk_dev_change_media_cb(blk, false);
    }

M
Max Reitz 已提交
2448 2449 2450 2451
out:
    aio_context_release(aio_context);
}

M
Max Reitz 已提交
2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
static void qmp_blockdev_insert_anon_medium(const char *device,
                                            BlockDriverState *bs, Error **errp)
{
    BlockBackend *blk;
    bool has_device;

    blk = blk_by_name(device);
    if (!blk) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
        return;
    }

    /* For BBs without a device, we can exchange the BDS tree at will */
    has_device = blk_get_attached_dev(blk);

    if (has_device && !blk_dev_has_removable_media(blk)) {
        error_setg(errp, "Device '%s' is not removable", device);
        return;
    }

2473
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
M
Max Reitz 已提交
2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
        error_setg(errp, "Tray of device '%s' is not open", device);
        return;
    }

    if (blk_bs(blk)) {
        error_setg(errp, "There already is a medium in device '%s'", device);
        return;
    }

    blk_insert_bs(blk, bs);

2485 2486 2487 2488 2489 2490 2491 2492
    if (!blk_dev_has_tray(blk)) {
        /* For tray-less devices, blockdev-close-tray is a no-op (or may not be
         * called at all); therefore, the medium needs to be pushed into the
         * slot here.
         * Do it after blk_insert_bs() so blk_is_inserted(blk) returns the @load
         * value passed here (i.e. true). */
        blk_dev_change_media_cb(blk, true);
    }
M
Max Reitz 已提交
2493 2494
}

2495 2496
void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
                                  Error **errp)
M
Max Reitz 已提交
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514
{
    BlockDriverState *bs;

    bs = bdrv_find_node(node_name);
    if (!bs) {
        error_setg(errp, "Node '%s' not found", node_name);
        return;
    }

    if (bs->blk) {
        error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
                   blk_name(bs->blk));
        return;
    }

    qmp_blockdev_insert_anon_medium(device, bs, errp);
}

M
Max Reitz 已提交
2515 2516
void qmp_blockdev_change_medium(const char *device, const char *filename,
                                bool has_format, const char *format,
2517 2518
                                bool has_read_only,
                                BlockdevChangeReadOnlyMode read_only,
M
Max Reitz 已提交
2519
                                Error **errp)
2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538
{
    BlockBackend *blk;
    BlockDriverState *medium_bs = NULL;
    int bdrv_flags, ret;
    QDict *options = NULL;
    Error *err = NULL;

    blk = blk_by_name(device);
    if (!blk) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
        goto fail;
    }

    if (blk_bs(blk)) {
        blk_update_root_state(blk);
    }

    bdrv_flags = blk_get_open_flags_from_root_state(blk);
2539 2540
    bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
        BDRV_O_PROTOCOL);
2541

2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561
    if (!has_read_only) {
        read_only = BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN;
    }

    switch (read_only) {
    case BLOCKDEV_CHANGE_READ_ONLY_MODE_RETAIN:
        break;

    case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_ONLY:
        bdrv_flags &= ~BDRV_O_RDWR;
        break;

    case BLOCKDEV_CHANGE_READ_ONLY_MODE_READ_WRITE:
        bdrv_flags |= BDRV_O_RDWR;
        break;

    default:
        abort();
    }

M
Max Reitz 已提交
2562
    if (has_format) {
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(format));
    }

    assert(!medium_bs);
    ret = bdrv_open(&medium_bs, filename, NULL, options, bdrv_flags, errp);
    if (ret < 0) {
        goto fail;
    }

    blk_apply_root_state(blk, medium_bs);

    bdrv_add_key(medium_bs, NULL, &err);
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

    qmp_blockdev_open_tray(device, false, false, &err);
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

2587
    qmp_x_blockdev_remove_medium(device, &err);
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

    qmp_blockdev_insert_anon_medium(device, medium_bs, &err);
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

    qmp_blockdev_close_tray(device, errp);

fail:
    /* If the medium has been inserted, the device has its own reference, so
     * ours must be relinquished; and if it has not been inserted successfully,
     * the reference must be relinquished anyway */
    bdrv_unref(medium_bs);
}

Z
Zhi Yong Wu 已提交
2608
/* throttling disk I/O limits */
2609
void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624
                               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,
2625
                               int64_t iops_wr_max,
2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637
                               bool has_bps_max_length,
                               int64_t bps_max_length,
                               bool has_bps_rd_max_length,
                               int64_t bps_rd_max_length,
                               bool has_bps_wr_max_length,
                               int64_t bps_wr_max_length,
                               bool has_iops_max_length,
                               int64_t iops_max_length,
                               bool has_iops_rd_max_length,
                               int64_t iops_rd_max_length,
                               bool has_iops_wr_max_length,
                               int64_t iops_wr_max_length,
2638
                               bool has_iops_size,
2639 2640 2641
                               int64_t iops_size,
                               bool has_group,
                               const char *group, Error **errp)
Z
Zhi Yong Wu 已提交
2642
{
2643
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
2644
    BlockDriverState *bs;
2645
    BlockBackend *blk;
2646
    AioContext *aio_context;
Z
Zhi Yong Wu 已提交
2647

2648 2649
    blk = blk_by_name(device);
    if (!blk) {
2650 2651
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
2652
        return;
Z
Zhi Yong Wu 已提交
2653
    }
M
Max Reitz 已提交
2654 2655 2656 2657

    aio_context = blk_get_aio_context(blk);
    aio_context_acquire(aio_context);

2658
    bs = blk_bs(blk);
M
Max Reitz 已提交
2659 2660 2661 2662
    if (!bs) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
Z
Zhi Yong Wu 已提交
2663

2664
    throttle_config_init(&cfg);
2665 2666 2667 2668 2669 2670 2671 2672
    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;

2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690
    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 已提交
2691

2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710
    if (has_bps_max_length) {
        cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = bps_max_length;
    }
    if (has_bps_rd_max_length) {
        cfg.buckets[THROTTLE_BPS_READ].burst_length = bps_rd_max_length;
    }
    if (has_bps_wr_max_length) {
        cfg.buckets[THROTTLE_BPS_WRITE].burst_length = bps_wr_max_length;
    }
    if (has_iops_max_length) {
        cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = iops_max_length;
    }
    if (has_iops_rd_max_length) {
        cfg.buckets[THROTTLE_OPS_READ].burst_length = iops_rd_max_length;
    }
    if (has_iops_wr_max_length) {
        cfg.buckets[THROTTLE_OPS_WRITE].burst_length = iops_wr_max_length;
    }

2711 2712 2713
    if (has_iops_size) {
        cfg.op_size = iops_size;
    }
2714

2715
    if (!throttle_is_valid(&cfg, errp)) {
M
Max Reitz 已提交
2716
        goto out;
Z
Zhi Yong Wu 已提交
2717 2718
    }

2719 2720 2721
    if (throttle_enabled(&cfg)) {
        /* Enable I/O limits if they're not enabled yet, otherwise
         * just update the throttling group. */
2722
        if (!bs->throttle_state) {
2723 2724 2725 2726 2727
            bdrv_io_limits_enable(bs, has_group ? group : device);
        } else if (has_group) {
            bdrv_io_limits_update_group(bs, group);
        }
        /* Set the new throttling configuration */
2728
        bdrv_set_io_limits(bs, &cfg);
2729
    } else if (bs->throttle_state) {
2730 2731
        /* If all throttling settings are set to 0, disable I/O limits */
        bdrv_io_limits_disable(bs);
Z
Zhi Yong Wu 已提交
2732
    }
2733

M
Max Reitz 已提交
2734
out:
2735
    aio_context_release(aio_context);
Z
Zhi Yong Wu 已提交
2736 2737
}

2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786
void qmp_block_dirty_bitmap_add(const char *node, const char *name,
                                bool has_granularity, uint32_t granularity,
                                Error **errp)
{
    AioContext *aio_context;
    BlockDriverState *bs;

    if (!name || name[0] == '\0') {
        error_setg(errp, "Bitmap name cannot be empty");
        return;
    }

    bs = bdrv_lookup_bs(node, node, errp);
    if (!bs) {
        return;
    }

    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

    if (has_granularity) {
        if (granularity < 512 || !is_power_of_2(granularity)) {
            error_setg(errp, "Granularity must be power of 2 "
                             "and at least 512");
            goto out;
        }
    } else {
        /* Default to cluster size, if available: */
        granularity = bdrv_get_default_bitmap_granularity(bs);
    }

    bdrv_create_dirty_bitmap(bs, granularity, name, errp);

 out:
    aio_context_release(aio_context);
}

void qmp_block_dirty_bitmap_remove(const char *node, const char *name,
                                   Error **errp)
{
    AioContext *aio_context;
    BlockDriverState *bs;
    BdrvDirtyBitmap *bitmap;

    bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
    if (!bitmap || !bs) {
        return;
    }

J
John Snow 已提交
2787 2788 2789 2790 2791 2792
    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be removed",
                   name);
        goto out;
    }
2793
    bdrv_dirty_bitmap_make_anon(bitmap);
2794 2795
    bdrv_release_dirty_bitmap(bs, bitmap);

J
John Snow 已提交
2796
 out:
2797 2798 2799
    aio_context_release(aio_context);
}

J
John Snow 已提交
2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827
/**
 * Completely clear a bitmap, for the purposes of synchronizing a bitmap
 * immediately after a full backup operation.
 */
void qmp_block_dirty_bitmap_clear(const char *node, const char *name,
                                  Error **errp)
{
    AioContext *aio_context;
    BdrvDirtyBitmap *bitmap;
    BlockDriverState *bs;

    bitmap = block_dirty_bitmap_lookup(node, name, &bs, &aio_context, errp);
    if (!bitmap || !bs) {
        return;
    }

    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be modified",
                   name);
        goto out;
    } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently disabled and cannot be cleared",
                   name);
        goto out;
    }

F
Fam Zheng 已提交
2828
    bdrv_clear_dirty_bitmap(bitmap, NULL);
J
John Snow 已提交
2829 2830 2831 2832 2833

 out:
    aio_context_release(aio_context);
}

2834
void hmp_drive_del(Monitor *mon, const QDict *qdict)
2835 2836
{
    const char *id = qdict_get_str(qdict, "id");
2837
    BlockBackend *blk;
2838
    BlockDriverState *bs;
2839
    AioContext *aio_context;
2840
    Error *local_err = NULL;
2841

2842 2843 2844 2845 2846 2847 2848 2849 2850
    bs = bdrv_find_node(id);
    if (bs) {
        qmp_x_blockdev_del(false, NULL, true, id, &local_err);
        if (local_err) {
            error_report_err(local_err);
        }
        return;
    }

2851 2852
    blk = blk_by_name(id);
    if (!blk) {
2853
        error_report("Device '%s' not found", id);
2854
        return;
2855
    }
2856

2857
    if (!blk_legacy_dinfo(blk)) {
2858 2859
        error_report("Deleting device added with blockdev-add"
                     " is not supported");
2860
        return;
2861 2862
    }

M
Max Reitz 已提交
2863
    aio_context = blk_get_aio_context(blk);
2864 2865
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
2866 2867 2868 2869 2870 2871 2872
    bs = blk_bs(blk);
    if (bs) {
        if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, &local_err)) {
            error_report_err(local_err);
            aio_context_release(aio_context);
            return;
        }
2873

2874
        blk_remove_bs(blk);
M
Max Reitz 已提交
2875
    }
2876

2877
    /* Make the BlockBackend and the attached BlockDriverState anonymous */
2878 2879
    monitor_remove_blk(blk);

2880 2881
    /* If this BlockBackend has a device attached to it, its refcount will be
     * decremented when the device is removed; otherwise we have to do so here.
2882
     */
2883
    if (blk_get_attached_dev(blk)) {
2884
        /* Further I/O must not pause the guest */
2885 2886
        blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
                         BLOCKDEV_ON_ERROR_REPORT);
2887
    } else {
2888
        blk_unref(blk);
2889 2890
    }

2891
    aio_context_release(aio_context);
2892
}
2893

2894 2895 2896
void qmp_block_resize(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      int64_t size, Error **errp)
2897
{
2898
    Error *local_err = NULL;
2899
    BlockDriverState *bs;
2900
    AioContext *aio_context;
2901
    int ret;
2902

2903 2904 2905
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2906
    if (local_err) {
2907 2908 2909 2910
        error_propagate(errp, local_err);
        return;
    }

2911 2912 2913
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2914
    if (!bdrv_is_first_non_filter(bs)) {
2915
        error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2916
        goto out;
2917 2918 2919
    }

    if (size < 0) {
2920
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2921
        goto out;
2922 2923
    }

2924
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2925
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2926
        goto out;
2927 2928
    }

2929 2930 2931
    /* complete all in-flight operations before resizing the device */
    bdrv_drain_all();

2932 2933
    ret = bdrv_truncate(bs, size);
    switch (ret) {
2934 2935 2936
    case 0:
        break;
    case -ENOMEDIUM:
2937
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2938 2939
        break;
    case -ENOTSUP:
2940
        error_setg(errp, QERR_UNSUPPORTED);
2941 2942
        break;
    case -EACCES:
2943
        error_setg(errp, "Device '%s' is read only", device);
2944 2945
        break;
    case -EBUSY:
2946
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2947 2948
        break;
    default:
2949
        error_setg_errno(errp, -ret, "Could not resize");
2950
        break;
2951
    }
2952 2953 2954

out:
    aio_context_release(aio_context);
2955
}
S
Stefan Hajnoczi 已提交
2956

2957
static void block_job_cb(void *opaque, int ret)
S
Stefan Hajnoczi 已提交
2958
{
2959 2960 2961 2962 2963
    /* Note that this function may be executed from another AioContext besides
     * the QEMU main loop.  If you need to access anything that assumes the
     * QEMU global mutex, use a BH or introduce a mutex.
     */

S
Stefan Hajnoczi 已提交
2964
    BlockDriverState *bs = opaque;
2965
    const char *msg = NULL;
S
Stefan Hajnoczi 已提交
2966

2967
    trace_block_job_cb(bs, bs->job, ret);
S
Stefan Hajnoczi 已提交
2968 2969

    assert(bs->job);
2970

S
Stefan Hajnoczi 已提交
2971
    if (ret < 0) {
2972
        msg = strerror(-ret);
S
Stefan Hajnoczi 已提交
2973 2974
    }

2975
    if (block_job_is_cancelled(bs->job)) {
2976
        block_job_event_cancelled(bs->job);
2977
    } else {
2978
        block_job_event_completed(bs->job, msg);
2979
    }
S
Stefan Hajnoczi 已提交
2980 2981
}

2982 2983 2984 2985
void qmp_block_stream(const char *device,
                      bool has_base, const char *base,
                      bool has_backing_file, const char *backing_file,
                      bool has_speed, int64_t speed,
P
Paolo Bonzini 已提交
2986 2987
                      bool has_on_error, BlockdevOnError on_error,
                      Error **errp)
S
Stefan Hajnoczi 已提交
2988
{
2989
    BlockBackend *blk;
S
Stefan Hajnoczi 已提交
2990
    BlockDriverState *bs;
2991
    BlockDriverState *base_bs = NULL;
2992
    AioContext *aio_context;
2993
    Error *local_err = NULL;
2994
    const char *base_name = NULL;
S
Stefan Hajnoczi 已提交
2995

P
Paolo Bonzini 已提交
2996 2997 2998 2999
    if (!has_on_error) {
        on_error = BLOCKDEV_ON_ERROR_REPORT;
    }

3000 3001
    blk = blk_by_name(device);
    if (!blk) {
3002 3003
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
S
Stefan Hajnoczi 已提交
3004 3005 3006
        return;
    }

M
Max Reitz 已提交
3007
    aio_context = blk_get_aio_context(blk);
3008 3009
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3010 3011 3012 3013 3014 3015
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3016
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
3017
        goto out;
3018 3019
    }

3020
    if (has_base) {
3021 3022
        base_bs = bdrv_find_backing_image(bs, base);
        if (base_bs == NULL) {
3023
            error_setg(errp, QERR_BASE_NOT_FOUND, base);
3024
            goto out;
3025
        }
3026
        assert(bdrv_get_aio_context(base_bs) == aio_context);
3027
        base_name = base;
S
Stefan Hajnoczi 已提交
3028 3029
    }

3030 3031 3032 3033 3034
    /* if we are streaming the entire chain, the result will have no backing
     * file, and specifying one is therefore an error */
    if (base_bs == NULL && has_backing_file) {
        error_setg(errp, "backing file specified, but streaming the "
                         "entire chain");
3035
        goto out;
3036 3037 3038 3039 3040 3041
    }

    /* backing_file string overrides base bs filename */
    base_name = has_backing_file ? backing_file : base_name;

    stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
P
Paolo Bonzini 已提交
3042
                 on_error, block_job_cb, bs, &local_err);
3043
    if (local_err) {
3044
        error_propagate(errp, local_err);
3045
        goto out;
S
Stefan Hajnoczi 已提交
3046 3047 3048
    }

    trace_qmp_block_stream(bs, bs->job);
3049 3050 3051

out:
    aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
3052
}
3053

3054
void qmp_block_commit(const char *device,
3055 3056
                      bool has_base, const char *base,
                      bool has_top, const char *top,
3057
                      bool has_backing_file, const char *backing_file,
3058 3059 3060
                      bool has_speed, int64_t speed,
                      Error **errp)
{
3061
    BlockBackend *blk;
3062 3063
    BlockDriverState *bs;
    BlockDriverState *base_bs, *top_bs;
3064
    AioContext *aio_context;
3065 3066 3067 3068
    Error *local_err = NULL;
    /* This will be part of the QMP command, if/when the
     * BlockdevOnError change for blkmirror makes it in
     */
3069
    BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3070

3071 3072 3073 3074
    if (!has_speed) {
        speed = 0;
    }

3075 3076 3077 3078 3079
    /* Important Note:
     *  libvirt relies on the DeviceNotFound error class in order to probe for
     *  live commit feature versions; for this to work, we must make sure to
     *  perform the device lookup before any generic errors that may occur in a
     *  scenario in which all optional arguments are omitted. */
3080 3081
    blk = blk_by_name(device);
    if (!blk) {
3082 3083
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3084
        return;
3085 3086
    }

M
Max Reitz 已提交
3087
    aio_context = blk_get_aio_context(blk);
3088 3089
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3090 3091 3092 3093 3094 3095
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3096
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3097
        goto out;
3098 3099 3100 3101 3102
    }

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

3103
    if (has_top && top) {
3104 3105 3106 3107 3108 3109 3110
        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");
3111
        goto out;
3112 3113
    }

3114 3115
    assert(bdrv_get_aio_context(top_bs) == aio_context);

3116 3117 3118 3119 3120 3121 3122
    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) {
3123
        error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3124
        goto out;
3125 3126
    }

3127 3128
    assert(bdrv_get_aio_context(base_bs) == aio_context);

3129 3130 3131 3132
    if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
        goto out;
    }

3133 3134 3135
    /* Do not allow attempts to commit an image into itself */
    if (top_bs == base_bs) {
        error_setg(errp, "cannot commit an image into itself");
3136
        goto out;
3137 3138
    }

F
Fam Zheng 已提交
3139
    if (top_bs == bs) {
3140 3141 3142
        if (has_backing_file) {
            error_setg(errp, "'backing-file' specified,"
                             " but 'top' is the active layer");
3143
            goto out;
3144
        }
F
Fam Zheng 已提交
3145 3146 3147 3148
        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,
3149
                     has_backing_file ? backing_file : NULL, &local_err);
F
Fam Zheng 已提交
3150
    }
3151 3152
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3153
        goto out;
3154
    }
3155 3156 3157

out:
    aio_context_release(aio_context);
3158 3159
}

3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170
static void do_drive_backup(const char *device, const char *target,
                            bool has_format, const char *format,
                            enum MirrorSyncMode sync,
                            bool has_mode, enum NewImageMode mode,
                            bool has_speed, int64_t speed,
                            bool has_bitmap, const char *bitmap,
                            bool has_on_source_error,
                            BlockdevOnError on_source_error,
                            bool has_on_target_error,
                            BlockdevOnError on_target_error,
                            BlockJobTxn *txn, Error **errp)
3171
{
3172
    BlockBackend *blk;
3173 3174
    BlockDriverState *bs;
    BlockDriverState *target_bs;
3175
    BlockDriverState *source = NULL;
3176
    BdrvDirtyBitmap *bmap = NULL;
3177
    AioContext *aio_context;
3178
    QDict *options = NULL;
3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196
    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;
    }

3197 3198
    blk = blk_by_name(device);
    if (!blk) {
3199 3200
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3201 3202 3203
        return;
    }

M
Max Reitz 已提交
3204
    aio_context = blk_get_aio_context(blk);
3205 3206
    aio_context_acquire(aio_context);

F
Fam Zheng 已提交
3207 3208
    /* Although backup_run has this check too, we need to use bs->drv below, so
     * do an early check redundantly. */
M
Max Reitz 已提交
3209
    if (!blk_is_available(blk)) {
3210
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3211
        goto out;
3212
    }
M
Max Reitz 已提交
3213
    bs = blk_bs(blk);
3214 3215 3216 3217 3218

    if (!has_format) {
        format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
    }

F
Fam Zheng 已提交
3219
    /* Early check to avoid creating target */
3220
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3221
        goto out;
3222 3223
    }

K
Kevin Wolf 已提交
3224
    flags = bs->open_flags | BDRV_O_RDWR;
3225

3226 3227 3228
    /* See if we have a backing HD we can use to create our new image
     * on top of. */
    if (sync == MIRROR_SYNC_MODE_TOP) {
3229
        source = backing_bs(bs);
3230 3231 3232 3233 3234 3235 3236 3237
        if (!source) {
            sync = MIRROR_SYNC_MODE_FULL;
        }
    }
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }

3238 3239 3240
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3241
        goto out;
3242 3243 3244
    }

    if (mode != NEW_IMAGE_MODE_EXISTING) {
3245
        assert(format);
3246 3247 3248 3249 3250 3251 3252 3253
        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);
        }
3254 3255
    }

3256
    if (local_err) {
3257
        error_propagate(errp, local_err);
3258
        goto out;
3259 3260
    }

3261 3262 3263 3264 3265
    if (format) {
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(format));
    }

3266
    target_bs = NULL;
3267
    ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
3268
    if (ret < 0) {
3269
        error_propagate(errp, local_err);
3270
        goto out;
3271 3272
    }

3273 3274
    bdrv_set_aio_context(target_bs, aio_context);

3275 3276 3277 3278
    if (has_bitmap) {
        bmap = bdrv_find_dirty_bitmap(bs, bitmap);
        if (!bmap) {
            error_setg(errp, "Bitmap '%s' could not be found", bitmap);
3279
            bdrv_unref(target_bs);
3280 3281 3282 3283 3284 3285
            goto out;
        }
    }

    backup_start(bs, target_bs, speed, sync, bmap,
                 on_source_error, on_target_error,
3286
                 block_job_cb, bs, txn, &local_err);
3287
    if (local_err != NULL) {
F
Fam Zheng 已提交
3288
        bdrv_unref(target_bs);
3289
        error_propagate(errp, local_err);
3290
        goto out;
3291
    }
3292 3293 3294

out:
    aio_context_release(aio_context);
3295 3296
}

3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314
void qmp_drive_backup(const char *device, const char *target,
                      bool has_format, const char *format,
                      enum MirrorSyncMode sync,
                      bool has_mode, enum NewImageMode mode,
                      bool has_speed, int64_t speed,
                      bool has_bitmap, const char *bitmap,
                      bool has_on_source_error, BlockdevOnError on_source_error,
                      bool has_on_target_error, BlockdevOnError on_target_error,
                      Error **errp)
{
    return do_drive_backup(device, target, has_format, format, sync,
                           has_mode, mode, has_speed, speed,
                           has_bitmap, bitmap,
                           has_on_source_error, on_source_error,
                           has_on_target_error, on_target_error,
                           NULL, errp);
}

3315 3316
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
3317
    return bdrv_named_nodes_list(errp);
3318 3319
}

3320
void do_blockdev_backup(const char *device, const char *target,
F
Fam Zheng 已提交
3321 3322 3323 3324 3325 3326
                         enum MirrorSyncMode sync,
                         bool has_speed, int64_t speed,
                         bool has_on_source_error,
                         BlockdevOnError on_source_error,
                         bool has_on_target_error,
                         BlockdevOnError on_target_error,
3327
                         BlockJobTxn *txn, Error **errp)
F
Fam Zheng 已提交
3328
{
M
Max Reitz 已提交
3329
    BlockBackend *blk, *target_blk;
F
Fam Zheng 已提交
3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344
    BlockDriverState *bs;
    BlockDriverState *target_bs;
    Error *local_err = NULL;
    AioContext *aio_context;

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

3345 3346
    blk = blk_by_name(device);
    if (!blk) {
3347
        error_setg(errp, "Device '%s' not found", device);
F
Fam Zheng 已提交
3348 3349 3350
        return;
    }

M
Max Reitz 已提交
3351
    aio_context = blk_get_aio_context(blk);
F
Fam Zheng 已提交
3352 3353
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3354 3355 3356 3357 3358 3359 3360 3361
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

    target_blk = blk_by_name(target);
    if (!target_blk) {
3362
        error_setg(errp, "Device '%s' not found", target);
F
Fam Zheng 已提交
3363 3364
        goto out;
    }
M
Max Reitz 已提交
3365 3366 3367 3368 3369 3370

    if (!blk_is_available(target_blk)) {
        error_setg(errp, "Device '%s' has no medium", target);
        goto out;
    }
    target_bs = blk_bs(target_blk);
F
Fam Zheng 已提交
3371 3372 3373

    bdrv_ref(target_bs);
    bdrv_set_aio_context(target_bs, aio_context);
3374
    backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
3375
                 on_target_error, block_job_cb, bs, txn, &local_err);
F
Fam Zheng 已提交
3376 3377 3378 3379 3380 3381 3382 3383
    if (local_err != NULL) {
        bdrv_unref(target_bs);
        error_propagate(errp, local_err);
    }
out:
    aio_context_release(aio_context);
}

3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398
void qmp_blockdev_backup(const char *device, const char *target,
                         enum MirrorSyncMode sync,
                         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)
{
    do_blockdev_backup(device, target, sync, has_speed, speed,
                       has_on_source_error, on_source_error,
                       has_on_target_error, on_target_error,
                       NULL, errp);
}

3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414
/* Parameter check and block job starting for drive mirroring.
 * Caller should hold @device and @target's aio context (must be the same).
 **/
static void blockdev_mirror_common(BlockDriverState *bs,
                                   BlockDriverState *target,
                                   bool has_replaces, const char *replaces,
                                   enum MirrorSyncMode sync,
                                   bool has_speed, int64_t speed,
                                   bool has_granularity, uint32_t granularity,
                                   bool has_buf_size, int64_t buf_size,
                                   bool has_on_source_error,
                                   BlockdevOnError on_source_error,
                                   bool has_on_target_error,
                                   BlockdevOnError on_target_error,
                                   bool has_unmap, bool unmap,
                                   Error **errp)
P
Paolo Bonzini 已提交
3415 3416 3417 3418 3419
{

    if (!has_speed) {
        speed = 0;
    }
3420 3421 3422 3423 3424 3425
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
3426 3427 3428
    if (!has_granularity) {
        granularity = 0;
    }
3429
    if (!has_buf_size) {
W
Wen Congyang 已提交
3430
        buf_size = 0;
3431
    }
3432 3433 3434
    if (!has_unmap) {
        unmap = true;
    }
3435

3436
    if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3437 3438
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "a value in range [512B, 64MB]");
3439 3440 3441
        return;
    }
    if (granularity & (granularity - 1)) {
3442 3443
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "power of 2");
3444 3445
        return;
    }
P
Paolo Bonzini 已提交
3446

3447 3448 3449
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
        return;
    }
F
Fam Zheng 已提交
3450 3451 3452
    if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
        return;
    }
F
Fam Zheng 已提交
3453 3454 3455 3456
    if (target->blk) {
        error_setg(errp, "Cannot mirror to an attached block device");
        return;
    }
3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495

    if (!bs->backing && sync == MIRROR_SYNC_MODE_TOP) {
        sync = MIRROR_SYNC_MODE_FULL;
    }

    /* pass the node name to replace to mirror start since it's loose coupling
     * and will allow to check whether the node still exist at mirror completion
     */
    mirror_start(bs, target,
                 has_replaces ? replaces : NULL,
                 speed, granularity, buf_size, sync,
                 on_source_error, on_target_error, unmap,
                 block_job_cb, bs, errp);
}

void qmp_drive_mirror(const char *device, const char *target,
                      bool has_format, const char *format,
                      bool has_node_name, const char *node_name,
                      bool has_replaces, const char *replaces,
                      enum MirrorSyncMode sync,
                      bool has_mode, enum NewImageMode mode,
                      bool has_speed, int64_t speed,
                      bool has_granularity, uint32_t granularity,
                      bool has_buf_size, int64_t buf_size,
                      bool has_on_source_error, BlockdevOnError on_source_error,
                      bool has_on_target_error, BlockdevOnError on_target_error,
                      bool has_unmap, bool unmap,
                      Error **errp)
{
    BlockDriverState *bs;
    BlockBackend *blk;
    BlockDriverState *source, *target_bs;
    AioContext *aio_context;
    Error *local_err = NULL;
    QDict *options = NULL;
    int flags;
    int64_t size;
    int ret;

3496 3497
    blk = blk_by_name(device);
    if (!blk) {
3498 3499
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
P
Paolo Bonzini 已提交
3500 3501 3502
        return;
    }

M
Max Reitz 已提交
3503
    aio_context = blk_get_aio_context(blk);
3504 3505
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3506
    if (!blk_is_available(blk)) {
3507
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3508
        goto out;
P
Paolo Bonzini 已提交
3509
    }
M
Max Reitz 已提交
3510
    bs = blk_bs(blk);
3511 3512 3513
    if (!has_mode) {
        mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
P
Paolo Bonzini 已提交
3514 3515 3516 3517 3518

    if (!has_format) {
        format = mode == NEW_IMAGE_MODE_EXISTING ? NULL : bs->drv->format_name;
    }

K
Kevin Wolf 已提交
3519
    flags = bs->open_flags | BDRV_O_RDWR;
3520
    source = backing_bs(bs);
P
Paolo Bonzini 已提交
3521 3522 3523
    if (!source && sync == MIRROR_SYNC_MODE_TOP) {
        sync = MIRROR_SYNC_MODE_FULL;
    }
3524 3525 3526
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }
P
Paolo Bonzini 已提交
3527

3528 3529 3530
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3531
        goto out;
3532 3533
    }

3534 3535
    if (has_replaces) {
        BlockDriverState *to_replace_bs;
3536 3537
        AioContext *replace_aio_context;
        int64_t replace_size;
3538 3539 3540 3541

        if (!has_node_name) {
            error_setg(errp, "a node-name must be provided when replacing a"
                             " named node of the graph");
3542
            goto out;
3543 3544
        }

3545
        to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
3546 3547 3548

        if (!to_replace_bs) {
            error_propagate(errp, local_err);
3549
            goto out;
3550 3551
        }

3552 3553 3554 3555 3556 3557
        replace_aio_context = bdrv_get_aio_context(to_replace_bs);
        aio_context_acquire(replace_aio_context);
        replace_size = bdrv_getlength(to_replace_bs);
        aio_context_release(replace_aio_context);

        if (size != replace_size) {
3558 3559
            error_setg(errp, "cannot replace image with a mirror image of "
                             "different size");
3560
            goto out;
3561 3562 3563
        }
    }

3564 3565 3566
    if ((sync == MIRROR_SYNC_MODE_FULL || !source)
        && mode != NEW_IMAGE_MODE_EXISTING)
    {
P
Paolo Bonzini 已提交
3567
        /* create new image w/o backing file */
3568
        assert(format);
3569
        bdrv_img_create(target, format,
3570
                        NULL, NULL, NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3571 3572 3573 3574 3575 3576
    } else {
        switch (mode) {
        case NEW_IMAGE_MODE_EXISTING:
            break;
        case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
            /* create new image with backing file */
3577 3578 3579
            bdrv_img_create(target, format,
                            source->filename,
                            source->drv->format_name,
3580
                            NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3581 3582 3583 3584 3585 3586
            break;
        default:
            abort();
        }
    }

3587
    if (local_err) {
3588
        error_propagate(errp, local_err);
3589
        goto out;
P
Paolo Bonzini 已提交
3590 3591
    }

3592
    options = qdict_new();
3593 3594 3595
    if (has_node_name) {
        qdict_put(options, "node-name", qstring_from_str(node_name));
    }
3596 3597 3598
    if (format) {
        qdict_put(options, "driver", qstring_from_str(format));
    }
3599

3600 3601 3602
    /* Mirroring takes care of copy-on-write using the source's backing
     * file.
     */
3603
    target_bs = NULL;
3604
    ret = bdrv_open(&target_bs, target, NULL, options,
3605
                    flags | BDRV_O_NO_BACKING, &local_err);
P
Paolo Bonzini 已提交
3606
    if (ret < 0) {
3607
        error_propagate(errp, local_err);
3608
        goto out;
P
Paolo Bonzini 已提交
3609 3610
    }

3611 3612
    bdrv_set_aio_context(target_bs, aio_context);

3613 3614 3615 3616 3617 3618 3619 3620 3621 3622
    blockdev_mirror_common(bs, target_bs,
                           has_replaces, replaces, sync,
                           has_speed, speed,
                           has_granularity, granularity,
                           has_buf_size, buf_size,
                           has_on_source_error, on_source_error,
                           has_on_target_error, on_target_error,
                           has_unmap, unmap,
                           &local_err);
    if (local_err) {
P
Paolo Bonzini 已提交
3623
        error_propagate(errp, local_err);
3624
        bdrv_unref(target_bs);
P
Paolo Bonzini 已提交
3625
    }
3626 3627
out:
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3628 3629
}

F
Fam Zheng 已提交
3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687
void qmp_blockdev_mirror(const char *device, const char *target,
                         bool has_replaces, const char *replaces,
                         MirrorSyncMode sync,
                         bool has_speed, int64_t speed,
                         bool has_granularity, uint32_t granularity,
                         bool has_buf_size, int64_t buf_size,
                         bool has_on_source_error,
                         BlockdevOnError on_source_error,
                         bool has_on_target_error,
                         BlockdevOnError on_target_error,
                         Error **errp)
{
    BlockDriverState *bs;
    BlockBackend *blk;
    BlockDriverState *target_bs;
    AioContext *aio_context;
    Error *local_err = NULL;

    blk = blk_by_name(device);
    if (!blk) {
        error_setg(errp, "Device '%s' not found", device);
        return;
    }
    bs = blk_bs(blk);

    if (!bs) {
        error_setg(errp, "Device '%s' has no media", device);
        return;
    }

    target_bs = bdrv_lookup_bs(target, target, errp);
    if (!target_bs) {
        return;
    }

    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

    bdrv_ref(target_bs);
    bdrv_set_aio_context(target_bs, aio_context);

    blockdev_mirror_common(bs, target_bs,
                           has_replaces, replaces, sync,
                           has_speed, speed,
                           has_granularity, granularity,
                           has_buf_size, buf_size,
                           has_on_source_error, on_source_error,
                           has_on_target_error, on_target_error,
                           true, true,
                           &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        bdrv_unref(target_bs);
    }

    aio_context_release(aio_context);
}

3688
/* Get the block job for a given device name and acquire its AioContext */
3689 3690
static BlockJob *find_block_job(const char *device, AioContext **aio_context,
                                Error **errp)
3691
{
3692
    BlockBackend *blk;
3693 3694
    BlockDriverState *bs;

M
Max Reitz 已提交
3695 3696
    *aio_context = NULL;

3697 3698
    blk = blk_by_name(device);
    if (!blk) {
3699 3700 3701
        goto notfound;
    }

M
Max Reitz 已提交
3702
    *aio_context = blk_get_aio_context(blk);
3703 3704
    aio_context_acquire(*aio_context);

M
Max Reitz 已提交
3705 3706 3707 3708 3709
    if (!blk_is_available(blk)) {
        goto notfound;
    }
    bs = blk_bs(blk);

3710 3711
    if (!bs->job) {
        goto notfound;
3712
    }
3713

3714
    return bs->job;
3715 3716

notfound:
3717 3718
    error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
              "No active block job on device '%s'", device);
M
Max Reitz 已提交
3719 3720 3721 3722
    if (*aio_context) {
        aio_context_release(*aio_context);
        *aio_context = NULL;
    }
3723
    return NULL;
3724 3725
}

3726
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3727
{
3728
    AioContext *aio_context;
3729
    BlockJob *job = find_block_job(device, &aio_context, errp);
3730 3731 3732 3733 3734

    if (!job) {
        return;
    }

3735
    block_job_set_speed(job, speed, errp);
3736
    aio_context_release(aio_context);
3737
}
3738

3739 3740
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
3741
{
3742
    AioContext *aio_context;
3743
    BlockJob *job = find_block_job(device, &aio_context, errp);
3744

3745 3746 3747
    if (!job) {
        return;
    }
3748 3749 3750 3751 3752

    if (!has_force) {
        force = false;
    }

F
Fam Zheng 已提交
3753
    if (job->user_paused && !force) {
3754 3755
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
3756
        goto out;
3757
    }
3758 3759 3760

    trace_qmp_block_job_cancel(job);
    block_job_cancel(job);
3761 3762
out:
    aio_context_release(aio_context);
3763
}
S
Stefan Hajnoczi 已提交
3764

3765 3766
void qmp_block_job_pause(const char *device, Error **errp)
{
3767
    AioContext *aio_context;
3768
    BlockJob *job = find_block_job(device, &aio_context, errp);
3769

F
Fam Zheng 已提交
3770
    if (!job || job->user_paused) {
3771 3772 3773
        return;
    }

F
Fam Zheng 已提交
3774
    job->user_paused = true;
3775 3776
    trace_qmp_block_job_pause(job);
    block_job_pause(job);
3777
    aio_context_release(aio_context);
3778 3779 3780 3781
}

void qmp_block_job_resume(const char *device, Error **errp)
{
3782
    AioContext *aio_context;
3783
    BlockJob *job = find_block_job(device, &aio_context, errp);
3784

F
Fam Zheng 已提交
3785
    if (!job || !job->user_paused) {
3786 3787 3788
        return;
    }

F
Fam Zheng 已提交
3789
    job->user_paused = false;
3790 3791
    trace_qmp_block_job_resume(job);
    block_job_resume(job);
3792
    aio_context_release(aio_context);
3793 3794
}

P
Paolo Bonzini 已提交
3795 3796
void qmp_block_job_complete(const char *device, Error **errp)
{
3797
    AioContext *aio_context;
3798
    BlockJob *job = find_block_job(device, &aio_context, errp);
P
Paolo Bonzini 已提交
3799 3800 3801 3802 3803 3804 3805

    if (!job) {
        return;
    }

    trace_qmp_block_job_complete(job);
    block_job_complete(job, errp);
3806
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3807 3808
}

3809 3810 3811 3812 3813
void qmp_change_backing_file(const char *device,
                             const char *image_node_name,
                             const char *backing_file,
                             Error **errp)
{
3814
    BlockBackend *blk;
3815
    BlockDriverState *bs = NULL;
3816
    AioContext *aio_context;
3817 3818 3819 3820 3821 3822
    BlockDriverState *image_bs = NULL;
    Error *local_err = NULL;
    bool ro;
    int open_flags;
    int ret;

3823 3824
    blk = blk_by_name(device);
    if (!blk) {
3825 3826
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3827 3828 3829
        return;
    }

M
Max Reitz 已提交
3830
    aio_context = blk_get_aio_context(blk);
3831 3832
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3833 3834 3835 3836 3837 3838
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3839 3840 3841
    image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
3842
        goto out;
3843 3844 3845 3846
    }

    if (!image_bs) {
        error_setg(errp, "image file not found");
3847
        goto out;
3848 3849 3850 3851 3852
    }

    if (bdrv_find_base(image_bs) == image_bs) {
        error_setg(errp, "not allowing backing file change on an image "
                         "without a backing file");
3853
        goto out;
3854 3855 3856 3857 3858
    }

    /* even though we are not necessarily operating on bs, we need it to
     * determine if block ops are currently prohibited on the chain */
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3859
        goto out;
3860 3861 3862 3863 3864 3865
    }

    /* final sanity check */
    if (!bdrv_chain_contains(bs, image_bs)) {
        error_setg(errp, "'%s' and image file are not in the same chain",
                   device);
3866
        goto out;
3867 3868 3869 3870 3871 3872 3873 3874 3875 3876
    }

    /* if not r/w, reopen to make r/w */
    open_flags = image_bs->open_flags;
    ro = bdrv_is_read_only(image_bs);

    if (ro) {
        bdrv_reopen(image_bs, open_flags | BDRV_O_RDWR, &local_err);
        if (local_err) {
            error_propagate(errp, local_err);
3877
            goto out;
3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896
        }
    }

    ret = bdrv_change_backing_file(image_bs, backing_file,
                               image_bs->drv ? image_bs->drv->format_name : "");

    if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
                         backing_file);
        /* don't exit here, so we can try to restore open flags if
         * appropriate */
    }

    if (ro) {
        bdrv_reopen(image_bs, open_flags, &local_err);
        if (local_err) {
            error_propagate(errp, local_err); /* will preserve prior errp */
        }
    }
3897 3898 3899

out:
    aio_context_release(aio_context);
3900 3901
}

3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915
void hmp_drive_add_node(Monitor *mon, const char *optstr)
{
    QemuOpts *opts;
    QDict *qdict;
    Error *local_err = NULL;

    opts = qemu_opts_parse_noisily(&qemu_drive_opts, optstr, false);
    if (!opts) {
        return;
    }

    qdict = qemu_opts_to_qdict(opts, NULL);

    if (!qdict_get_try_str(qdict, "node-name")) {
3916
        QDECREF(qdict);
3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932
        error_report("'node-name' needs to be specified");
        goto out;
    }

    BlockDriverState *bs = bds_tree_init(qdict, &local_err);
    if (!bs) {
        error_report_err(local_err);
        goto out;
    }

    QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);

out:
    qemu_opts_del(opts);
}

K
Kevin Wolf 已提交
3933 3934 3935
void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
{
    QmpOutputVisitor *ov = qmp_output_visitor_new();
3936 3937
    BlockDriverState *bs;
    BlockBackend *blk = NULL;
K
Kevin Wolf 已提交
3938 3939 3940 3941
    QObject *obj;
    QDict *qdict;
    Error *local_err = NULL;

3942
    /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
K
Kevin Wolf 已提交
3943
     * cache.direct=false instead of silently switching to aio=threads, except
3944
     * when called from drive_new().
K
Kevin Wolf 已提交
3945 3946 3947
     *
     * For now, simply forbidding the combination for all drivers will do. */
    if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3948 3949 3950 3951
        bool direct = options->has_cache &&
                      options->cache->has_direct &&
                      options->cache->direct;
        if (!direct) {
K
Kevin Wolf 已提交
3952 3953 3954 3955 3956
            error_setg(errp, "aio=native requires cache.direct=true");
            goto fail;
        }
    }

3957 3958
    visit_type_BlockdevOptions(qmp_output_get_visitor(ov), NULL, &options,
                               &local_err);
3959
    if (local_err) {
K
Kevin Wolf 已提交
3960 3961 3962 3963 3964 3965 3966 3967 3968
        error_propagate(errp, local_err);
        goto fail;
    }

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

    qdict_flatten(qdict);

3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983
    if (options->has_id) {
        blk = blockdev_init(NULL, qdict, &local_err);
        if (local_err) {
            error_propagate(errp, local_err);
            goto fail;
        }

        bs = blk_bs(blk);
    } else {
        if (!qdict_get_try_str(qdict, "node-name")) {
            error_setg(errp, "'id' and/or 'node-name' need to be specified for "
                       "the root node");
            goto fail;
        }

3984 3985
        bs = bds_tree_init(qdict, errp);
        if (!bs) {
3986 3987
            goto fail;
        }
3988 3989

        QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
K
Kevin Wolf 已提交
3990 3991
    }

3992 3993
    if (bs && bdrv_key_required(bs)) {
        if (blk) {
3994
            monitor_remove_blk(blk);
3995 3996
            blk_unref(blk);
        } else {
3997
            QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3998 3999
            bdrv_unref(bs);
        }
4000 4001 4002 4003
        error_setg(errp, "blockdev-add doesn't support encrypted devices");
        goto fail;
    }

K
Kevin Wolf 已提交
4004 4005 4006 4007
fail:
    qmp_output_visitor_cleanup(ov);
}

4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023
void qmp_x_blockdev_del(bool has_id, const char *id,
                        bool has_node_name, const char *node_name, Error **errp)
{
    AioContext *aio_context;
    BlockBackend *blk;
    BlockDriverState *bs;

    if (has_id && has_node_name) {
        error_setg(errp, "Only one of id and node-name must be specified");
        return;
    } else if (!has_id && !has_node_name) {
        error_setg(errp, "No block device specified");
        return;
    }

    if (has_id) {
4024
        /* blk_by_name() never returns a BB that is not owned by the monitor */
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057
        blk = blk_by_name(id);
        if (!blk) {
            error_setg(errp, "Cannot find block backend %s", id);
            return;
        }
        if (blk_get_refcnt(blk) > 1) {
            error_setg(errp, "Block backend %s is in use", id);
            return;
        }
        bs = blk_bs(blk);
        aio_context = blk_get_aio_context(blk);
    } else {
        bs = bdrv_find_node(node_name);
        if (!bs) {
            error_setg(errp, "Cannot find node %s", node_name);
            return;
        }
        blk = bs->blk;
        if (blk) {
            error_setg(errp, "Node %s is in use by %s",
                       node_name, blk_name(blk));
            return;
        }
        aio_context = bdrv_get_aio_context(bs);
    }

    aio_context_acquire(aio_context);

    if (bs) {
        if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
            goto out;
        }

4058 4059 4060 4061 4062 4063 4064
        if (!blk && !bs->monitor_list.tqe_prev) {
            error_setg(errp, "Node %s is not owned by the monitor",
                       bs->node_name);
            goto out;
        }

        if (bs->refcnt > 1) {
4065 4066 4067 4068 4069 4070 4071
            error_setg(errp, "Block device %s is in use",
                       bdrv_get_device_or_node_name(bs));
            goto out;
        }
    }

    if (blk) {
4072
        monitor_remove_blk(blk);
4073 4074
        blk_unref(blk);
    } else {
4075
        QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4076 4077 4078 4079 4080 4081 4082
        bdrv_unref(bs);
    }

out:
    aio_context_release(aio_context);
}

4083
BlockJobInfoList *qmp_query_block_jobs(Error **errp)
S
Stefan Hajnoczi 已提交
4084
{
4085 4086
    BlockJobInfoList *head = NULL, **p_next = &head;
    BlockDriverState *bs;
S
Stefan Hajnoczi 已提交
4087

4088
    for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
4089 4090 4091 4092
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);

4093 4094 4095 4096 4097 4098
        if (bs->job) {
            BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
            elem->value = block_job_query(bs->job);
            *p_next = elem;
            p_next = &elem->next;
        }
4099 4100

        aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
4101 4102
    }

4103
    return head;
S
Stefan Hajnoczi 已提交
4104
}
4105

4106
QemuOptsList qemu_common_drive_opts = {
4107
    .name = "drive",
4108
    .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4109 4110 4111 4112 4113
    .desc = {
        {
            .name = "snapshot",
            .type = QEMU_OPT_BOOL,
            .help = "enable/disable snapshot mode",
4114 4115 4116 4117
        },{
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
4118 4119 4120 4121
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
4122 4123 4124 4125
        },{
            .name = BDRV_OPT_CACHE_WB,
            .type = QEMU_OPT_BOOL,
            .help = "Enable writeback mode",
4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138
        },{
            .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",
        },{
4139
            .name = "read-only",
4140 4141 4142
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
4143
            .name = "throttling.iops-total",
4144 4145 4146
            .type = QEMU_OPT_NUMBER,
            .help = "limit total I/O operations per second",
        },{
4147
            .name = "throttling.iops-read",
4148 4149 4150
            .type = QEMU_OPT_NUMBER,
            .help = "limit read operations per second",
        },{
4151
            .name = "throttling.iops-write",
4152 4153 4154
            .type = QEMU_OPT_NUMBER,
            .help = "limit write operations per second",
        },{
4155
            .name = "throttling.bps-total",
4156 4157 4158
            .type = QEMU_OPT_NUMBER,
            .help = "limit total bytes per second",
        },{
4159
            .name = "throttling.bps-read",
4160 4161 4162
            .type = QEMU_OPT_NUMBER,
            .help = "limit read bytes per second",
        },{
4163
            .name = "throttling.bps-write",
4164 4165
            .type = QEMU_OPT_NUMBER,
            .help = "limit write bytes per second",
4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189
        },{
            .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",
4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213
        },{
            .name = "throttling.iops-total-max-length",
            .type = QEMU_OPT_NUMBER,
            .help = "length of the iops-total-max burst period, in seconds",
        },{
            .name = "throttling.iops-read-max-length",
            .type = QEMU_OPT_NUMBER,
            .help = "length of the iops-read-max burst period, in seconds",
        },{
            .name = "throttling.iops-write-max-length",
            .type = QEMU_OPT_NUMBER,
            .help = "length of the iops-write-max burst period, in seconds",
        },{
            .name = "throttling.bps-total-max-length",
            .type = QEMU_OPT_NUMBER,
            .help = "length of the bps-total-max burst period, in seconds",
        },{
            .name = "throttling.bps-read-max-length",
            .type = QEMU_OPT_NUMBER,
            .help = "length of the bps-read-max burst period, in seconds",
        },{
            .name = "throttling.bps-write-max-length",
            .type = QEMU_OPT_NUMBER,
            .help = "length of the bps-write-max burst period, in seconds",
4214 4215 4216 4217
        },{
            .name = "throttling.iops-size",
            .type = QEMU_OPT_NUMBER,
            .help = "when limiting by iops max size of an I/O in bytes",
4218 4219 4220 4221
        },{
            .name = "throttling.group",
            .type = QEMU_OPT_STRING,
            .help = "name of the block throttling group",
4222 4223 4224 4225
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
4226 4227 4228 4229
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
4230 4231 4232 4233 4234 4235 4236 4237 4238 4239
        },{
            .name = "stats-account-invalid",
            .type = QEMU_OPT_BOOL,
            .help = "whether to account for invalid I/O operations "
                    "in the statistics",
        },{
            .name = "stats-account-failed",
            .type = QEMU_OPT_BOOL,
            .help = "whether to account for failed I/O operations "
                    "in the statistics",
4240 4241 4242 4243
        },
        { /* end of list */ }
    },
};
4244

4245 4246
static QemuOptsList qemu_root_bds_opts = {
    .name = "root-bds",
4247
    .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273
    .desc = {
        {
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
        },{
            .name = "read-only",
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
        },
        { /* end of list */ }
    },
};

4274 4275 4276 4277
QemuOptsList qemu_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
    .desc = {
4278 4279 4280 4281
        /*
         * no elements => accept any params
         * validation will happen later
         */
4282 4283 4284
        { /* end of list */ }
    },
};