blockdev.c 126.8 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 55 56
static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
    QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);

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

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

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

    if (max_devs <= 0) {
        return;
    }

101 102
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
103 104 105 106 107 108 109 110 111 112 113
        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;
}

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

127
    if (!dinfo) {
128 129 130
        return;
    }

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

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

M
Max Reitz 已提交
139 140
        aio_context_release(aio_context);
    }
141

142
    dinfo->auto_del = 1;
143 144
}

145
void blockdev_auto_del(BlockBackend *blk)
146
{
147
    DriveInfo *dinfo = blk_legacy_dinfo(blk);
148

149
    if (dinfo && dinfo->auto_del) {
150
        blk_unref(blk);
151 152 153
    }
}

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
/**
 * 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;
}

171 172 173 174 175 176 177 178 179 180 181 182
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;
}

183 184
QemuOpts *drive_def(const char *optstr)
{
185
    return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
186 187 188
}

QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
189
                    const char *optstr)
190 191 192
{
    QemuOpts *opts;

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

DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
{
210
    BlockBackend *blk;
211 212
    DriveInfo *dinfo;

213 214 215 216
    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) {
217
            return dinfo;
218
        }
219 220 221 222 223
    }

    return NULL;
}

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

230 231
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
J
John Snow 已提交
232 233
        /* If dinfo->bdrv->dev is NULL, it has no device attached. */
        /* Unless this is a default drive, this may be an oversight. */
234
        if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
J
John Snow 已提交
235 236 237
            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 已提交
238 239
                    blk_name(blk), blk_bs(blk) ? blk_bs(blk)->filename : "",
                    if_name[dinfo->type], dinfo->bus, dinfo->unit);
J
John Snow 已提交
240 241 242 243 244 245 246
            rs = true;
        }
    }

    return rs;
}

247 248 249 250 251 252 253
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));
}

254 255 256
int drive_get_max_bus(BlockInterfaceType type)
{
    int max_bus;
257
    BlockBackend *blk;
258 259 260
    DriveInfo *dinfo;

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

270 271 272 273 274 275 276 277 278 279
/* 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]++);
}

280 281
static void bdrv_format_print(void *opaque, const char *name)
{
282
    error_printf(" %s", name);
283 284
}

285 286
typedef struct {
    QEMUBH *bh;
F
Fam Zheng 已提交
287 288
    BlockDriverState *bs;
} BDRVPutRefBH;
289

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

307 308 309 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
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;
}

346 347
typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;

348 349 350 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
/* 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) {
390
        throttle_config_init(throttle_cfg);
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
        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);

417 418 419 420 421 422 423 424 425 426 427 428 429
        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);

430 431 432
        throttle_cfg->op_size =
            qemu_opt_get_number(opts, "throttling.iops-size", 0);

433
        if (!throttle_is_valid(throttle_cfg, errp)) {
434 435 436 437 438 439 440 441
            return;
        }
    }

    if (detect_zeroes) {
        *detect_zeroes =
            qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
                            qemu_opt_get(opts, "detect-zeroes"),
442
                            BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
                            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;
        }
    }
}

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

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

    qemu_opts_absorb_qdict(opts, bs_opts, &error);
492
    if (error) {
493
        error_propagate(errp, error);
494
        goto early_err;
495 496 497 498 499 500
    }

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

501 502 503
    /* extract parameters */
    snapshot = qemu_opt_get_bool(opts, "snapshot", 0);

504 505 506
    account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
    account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);

507 508 509 510 511 512 513 514
    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;
    }
515

516 517 518 519 520
    extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
                                    &detect_zeroes, &error);
    if (error) {
        error_propagate(errp, error);
        goto early_err;
521 522 523
    }

    if ((buf = qemu_opt_get(opts, "format")) != NULL) {
524 525 526 527
        if (is_help_option(buf)) {
            error_printf("Supported formats:");
            bdrv_iterate_format(bdrv_format_print, NULL);
            error_printf("\n");
528
            goto early_err;
529
        }
530

531 532
        if (qdict_haskey(bs_opts, "driver")) {
            error_setg(errp, "Cannot specify both 'driver' and 'format'");
533
            goto early_err;
534
        }
535
        qdict_put(bs_opts, "driver", qstring_from_str(buf));
536 537
    }

538
    on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
539
    if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
540
        on_write_error = parse_block_error_action(buf, 0, &error);
541
        if (error) {
542
            error_propagate(errp, error);
543
            goto early_err;
544 545 546
        }
    }

547
    on_read_error = BLOCKDEV_ON_ERROR_REPORT;
548
    if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
549
        on_read_error = parse_block_error_action(buf, 1, &error);
550
        if (error) {
551
            error_propagate(errp, error);
552
            goto early_err;
553 554 555
        }
    }

556
    if (snapshot) {
557
        bdrv_flags |= BDRV_O_SNAPSHOT;
558 559
    }

560
    /* init */
561
    if ((!file || !*file) && !qdict_size(bs_opts)) {
562 563 564
        BlockBackendRootState *blk_rs;

        blk = blk_new(qemu_opts_id(opts), errp);
565 566 567
        if (!blk) {
            goto early_err;
        }
568

569 570
        blk_rs = blk_get_root_state(blk);
        blk_rs->open_flags    = bdrv_flags;
571
        blk_rs->read_only     = !(bdrv_flags & BDRV_O_RDWR);
572 573 574 575 576 577 578 579 580 581
        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;
        }
582

583 584 585
        QDECREF(bs_opts);
    } else {
        if (file && !*file) {
586 587
            file = NULL;
        }
588

589 590 591 592 593 594 595
        /* 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_WB, "on");
        qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
        qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");

596 597 598 599
        if (runstate_check(RUN_STATE_INMIGRATE)) {
            bdrv_flags |= BDRV_O_INACTIVE;
        }

600 601 602 603 604 605
        blk = blk_new_open(qemu_opts_id(opts), file, NULL, bs_opts, bdrv_flags,
                           errp);
        if (!blk) {
            goto err_no_bs_opts;
        }
        bs = blk_bs(blk);
606

607
        bs->detect_zeroes = detect_zeroes;
608

609 610 611 612 613 614 615 616
        /* 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);
        }
617

618 619
        if (bdrv_key_required(bs)) {
            autostart = 0;
620
        }
621 622

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

624 625 626 627
        if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
            blk_unref(blk);
            blk = NULL;
            goto err_no_bs_opts;
628
        }
629 630
    }

631
    blk_set_on_error(blk, on_read_error, on_write_error);
632

633
err_no_bs_opts:
634
    qemu_opts_del(opts);
635 636
    QDECREF(interval_dict);
    QDECREF(interval_list);
637
    return blk;
638

639 640
early_err:
    qemu_opts_del(opts);
641 642
    QDECREF(interval_dict);
    QDECREF(interval_list);
643 644
err_no_opts:
    QDECREF(bs_opts);
645
    return NULL;
646 647
}

648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
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;
    }

678 679 680 681 682 683 684
    /* 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_WB, "on");
    qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
    qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");

685 686 687 688
    if (runstate_check(RUN_STATE_INMIGRATE)) {
        bdrv_flags |= BDRV_O_INACTIVE;
    }

689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
    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;
}

707 708 709 710 711 712 713 714 715 716 717 718 719
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);
    }
}

720 721
static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
                            Error **errp)
722 723 724 725 726
{
    const char *value;

    value = qemu_opt_get(opts, from);
    if (value) {
727 728 729 730 731
        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;
        }
732 733 734 735
    }

    /* rename all items in opts */
    while ((value = qemu_opt_get(opts, from))) {
736
        qemu_opt_set(opts, to, value, &error_abort);
737 738 739 740
        qemu_opt_unset(opts, from);
    }
}

741 742 743 744 745
QemuOptsList qemu_legacy_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
    .desc = {
        {
746 747 748 749 750 751 752 753 754 755 756 757
            .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",
        },{
758 759 760
            .name = "media",
            .type = QEMU_OPT_STRING,
            .help = "media type (disk, cdrom)",
761 762 763 764
        },{
            .name = "if",
            .type = QEMU_OPT_STRING,
            .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
        },{
            .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)",
781 782 783 784
        },{
            .name = "boot",
            .type = QEMU_OPT_BOOL,
            .help = "(deprecated, ignored)",
785 786 787 788
        },{
            .name = "addr",
            .type = QEMU_OPT_STRING,
            .help = "pci address (virtio only)",
789 790 791 792
        },{
            .name = "serial",
            .type = QEMU_OPT_STRING,
            .help = "disk serial number",
M
Max Reitz 已提交
793 794 795 796
        },{
            .name = "file",
            .type = QEMU_OPT_STRING,
            .help = "file name",
797
        },
798 799 800 801 802 803

        /* 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",
804 805 806 807 808 809 810 811
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
812 813 814 815 816 817
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },

818 819 820 821
        { /* end of list */ }
    },
};

822
DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
823
{
K
Kevin Wolf 已提交
824
    const char *value;
825
    BlockBackend *blk;
826
    DriveInfo *dinfo = NULL;
827
    QDict *bs_opts;
828 829
    QemuOpts *legacy_opts;
    DriveMediaType media = MEDIA_DISK;
830
    BlockInterfaceType type;
831
    int cyls, heads, secs, translation;
832
    int max_devs, bus_id, unit_id, index;
833
    const char *devaddr;
834
    const char *werror, *rerror;
F
Fam Zheng 已提交
835 836
    bool read_only = false;
    bool copy_on_read;
837
    const char *serial;
M
Max Reitz 已提交
838
    const char *filename;
839
    Error *local_err = NULL;
840
    int i;
K
Kevin Wolf 已提交
841

842
    /* Change legacy command line options into QMP ones */
843 844 845 846 847 848 849
    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" },
850

851 852 853
        { "bps",            "throttling.bps-total" },
        { "bps_rd",         "throttling.bps-read" },
        { "bps_wr",         "throttling.bps-write" },
854

855 856 857
        { "iops_max",       "throttling.iops-total-max" },
        { "iops_rd_max",    "throttling.iops-read-max" },
        { "iops_wr_max",    "throttling.iops-write-max" },
858

859 860 861
        { "bps_max",        "throttling.bps-total-max" },
        { "bps_rd_max",     "throttling.bps-read-max" },
        { "bps_wr_max",     "throttling.bps-write-max" },
862

863
        { "iops_size",      "throttling.iops-size" },
864

865 866
        { "group",          "throttling.group" },

867 868 869 870
        { "readonly",       "read-only" },
    };

    for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
871 872 873
        qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
                        &local_err);
        if (local_err) {
874
            error_report_err(local_err);
875 876
            return NULL;
        }
877
    }
878

K
Kevin Wolf 已提交
879 880 881 882 883 884 885 886 887 888
    value = qemu_opt_get(all_opts, "cache");
    if (value) {
        int flags = 0;

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

        /* Specific options take precedence */
889 890
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
891
                              !!(flags & BDRV_O_CACHE_WB), &error_abort);
K
Kevin Wolf 已提交
892
        }
893 894
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
895
                              !!(flags & BDRV_O_NOCACHE), &error_abort);
K
Kevin Wolf 已提交
896
        }
897 898
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
899
                              !!(flags & BDRV_O_NO_FLUSH), &error_abort);
K
Kevin Wolf 已提交
900 901 902 903
        }
        qemu_opt_unset(all_opts, "cache");
    }

904 905 906 907
    /* Get a QDict for processing the options */
    bs_opts = qdict_new();
    qemu_opts_to_qdict(all_opts, bs_opts);

908 909
    legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
                                   &error_abort);
910
    qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
911
    if (local_err) {
912
        error_report_err(local_err);
913 914 915
        goto fail;
    }

916 917 918 919 920 921 922
    /* 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");
    }

923 924 925 926 927 928 929
    /* 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 已提交
930
            read_only = true;
931 932 933 934 935 936
        } else {
            error_report("'%s' invalid media", value);
            goto fail;
        }
    }

937
    /* copy-on-read is disabled with a warning for read-only devices */
F
Fam Zheng 已提交
938
    read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
939 940 941 942 943 944 945 946 947 948 949 950
    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"));

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
    /* 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;
    }

966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
    /* 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;
998 999 1000 1001
        } else if (!strcmp(value, "large")) {
            translation = BIOS_ATA_TRANSLATION_LARGE;
        } else if (!strcmp(value, "rechs")) {
            translation = BIOS_ATA_TRANSLATION_RECHS;
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
        } 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;
        }
    }

1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
    /* 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;
    }

1056 1057 1058
    /* Serial number */
    serial = qemu_opt_get(legacy_opts, "serial");

1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
    /* 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);
    }

1077 1078 1079 1080 1081 1082 1083 1084 1085
    /* 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;
1086 1087
        devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
                                   &error_abort);
1088
        if (arch_type == QEMU_ARCH_S390X) {
1089
            qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1090
        } else {
1091
            qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1092
        }
1093 1094
        qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
                     &error_abort);
1095
        if (devaddr) {
1096
            qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1097 1098 1099
        }
    }

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

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
    /* 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));
    }

1123
    /* Actual block device init: Functionality shared with blockdev-add */
1124
    blk = blockdev_init(filename, bs_opts, &local_err);
1125
    bs_opts = NULL;
1126
    if (!blk) {
1127
        if (local_err) {
1128
            error_report_err(local_err);
1129
        }
1130
        goto fail;
1131
    } else {
1132
        assert(!local_err);
1133 1134
    }

1135 1136
    /* Create legacy DriveInfo */
    dinfo = g_malloc0(sizeof(*dinfo));
1137
    dinfo->opts = all_opts;
1138

1139 1140 1141 1142 1143
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

1144
    dinfo->type = type;
1145 1146
    dinfo->bus = bus_id;
    dinfo->unit = unit_id;
1147
    dinfo->devaddr = devaddr;
1148 1149
    dinfo->serial = g_strdup(serial);

1150 1151
    blk_set_legacy_dinfo(blk, dinfo);

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
    switch(type) {
    case IF_IDE:
    case IF_SCSI:
    case IF_XEN:
    case IF_NONE:
        dinfo->media_cd = media == MEDIA_CDROM;
        break;
    default:
        break;
    }

1163
fail:
1164
    qemu_opts_del(legacy_opts);
1165
    QDECREF(bs_opts);
1166
    return dinfo;
1167 1168
}

1169
void hmp_commit(Monitor *mon, const QDict *qdict)
1170 1171
{
    const char *device = qdict_get_str(qdict, "device");
1172
    BlockBackend *blk;
1173
    int ret;
1174

1175
    if (!strcmp(device, "all")) {
1176
        ret = bdrv_commit_all();
1177
    } else {
1178 1179 1180
        BlockDriverState *bs;
        AioContext *aio_context;

1181 1182
        blk = blk_by_name(device);
        if (!blk) {
1183
            monitor_printf(mon, "Device '%s' not found\n", device);
1184
            return;
1185
        }
M
Max Reitz 已提交
1186 1187 1188 1189
        if (!blk_is_available(blk)) {
            monitor_printf(mon, "Device '%s' has no medium\n", device);
            return;
        }
1190 1191 1192 1193 1194 1195 1196 1197

        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);
1198 1199 1200 1201
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
1202 1203 1204
    }
}

1205
static void blockdev_do_action(TransactionAction *action, Error **errp)
1206
{
1207
    TransactionActionList list;
1208

1209
    list.value = action;
1210
    list.next = NULL;
J
John Snow 已提交
1211
    qmp_transaction(&list, false, NULL, errp);
1212 1213
}

1214 1215 1216 1217 1218
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,
1219
                                bool has_format, const char *format,
1220
                                bool has_mode, NewImageMode mode, Error **errp)
1221
{
1222
    BlockdevSnapshotSync snapshot = {
1223
        .has_device = has_device,
1224
        .device = (char *) device,
1225 1226
        .has_node_name = has_node_name,
        .node_name = (char *) node_name,
1227
        .snapshot_file = (char *) snapshot_file,
1228 1229
        .has_snapshot_node_name = has_snapshot_node_name,
        .snapshot_node_name = (char *) snapshot_node_name,
1230 1231 1232 1233 1234
        .has_format = has_format,
        .format = (char *) format,
        .has_mode = has_mode,
        .mode = mode,
    };
1235 1236 1237 1238 1239
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
        .u.blockdev_snapshot_sync = &snapshot,
    };
    blockdev_do_action(&action, errp);
1240 1241
}

1242 1243 1244 1245 1246 1247 1248
void qmp_blockdev_snapshot(const char *node, const char *overlay,
                           Error **errp)
{
    BlockdevSnapshot snapshot_data = {
        .node = (char *) node,
        .overlay = (char *) overlay
    };
1249 1250 1251 1252 1253
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
        .u.blockdev_snapshot = &snapshot_data,
    };
    blockdev_do_action(&action, errp);
1254 1255
}

1256 1257 1258 1259 1260 1261 1262 1263
void qmp_blockdev_snapshot_internal_sync(const char *device,
                                         const char *name,
                                         Error **errp)
{
    BlockdevSnapshotInternal snapshot = {
        .device = (char *) device,
        .name = (char *) name
    };
1264 1265 1266 1267 1268
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
        .u.blockdev_snapshot_internal_sync = &snapshot,
    };
    blockdev_do_action(&action, errp);
1269 1270
}

1271 1272 1273 1274 1275 1276 1277
SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
                                                         bool has_id,
                                                         const char *id,
                                                         bool has_name,
                                                         const char *name,
                                                         Error **errp)
{
1278 1279
    BlockDriverState *bs;
    BlockBackend *blk;
1280
    AioContext *aio_context;
1281 1282 1283 1284 1285
    QEMUSnapshotInfo sn;
    Error *local_err = NULL;
    SnapshotInfo *info = NULL;
    int ret;

1286 1287
    blk = blk_by_name(device);
    if (!blk) {
1288 1289
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
1290 1291
        return NULL;
    }
M
Max Reitz 已提交
1292 1293 1294

    aio_context = blk_get_aio_context(blk);
    aio_context_acquire(aio_context);
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305

    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 已提交
1306
        goto out_aio_context;
1307 1308
    }

M
Max Reitz 已提交
1309 1310 1311 1312 1313
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out_aio_context;
    }
    bs = blk_bs(blk);
1314

1315 1316 1317 1318
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
        goto out_aio_context;
    }

1319
    ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1320
    if (local_err) {
1321
        error_propagate(errp, local_err);
1322
        goto out_aio_context;
1323 1324 1325 1326 1327 1328
    }
    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);
1329
        goto out_aio_context;
1330 1331 1332
    }

    bdrv_snapshot_delete(bs, id, name, &local_err);
1333
    if (local_err) {
1334
        error_propagate(errp, local_err);
1335
        goto out_aio_context;
1336 1337
    }

1338 1339
    aio_context_release(aio_context);

1340
    info = g_new0(SnapshotInfo, 1);
1341 1342 1343 1344 1345 1346 1347 1348 1349
    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;
1350 1351 1352 1353

out_aio_context:
    aio_context_release(aio_context);
    return NULL;
1354
}
1355

1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 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
/**
 * 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;
}

1418
/* New and old BlockDriverState structs for atomic group operations */
1419

1420
typedef struct BlkActionState BlkActionState;
1421

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
/**
 * 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 {
1437
    size_t instance_size;
1438 1439 1440 1441 1442
    void (*prepare)(BlkActionState *common, Error **errp);
    void (*commit)(BlkActionState *common);
    void (*abort)(BlkActionState *common);
    void (*clean)(BlkActionState *common);
} BlkActionOps;
1443

1444 1445 1446 1447 1448 1449
/**
 * 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 已提交
1450
 * @block_job_txn: Transaction which this action belongs to.
1451 1452 1453 1454 1455
 * @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.
1456
 */
1457
struct BlkActionState {
1458
    TransactionAction *action;
1459
    const BlkActionOps *ops;
J
John Snow 已提交
1460 1461
    BlockJobTxn *block_job_txn;
    TransactionProperties *txn_props;
1462
    QSIMPLEQ_ENTRY(BlkActionState) entry;
1463 1464
};

1465 1466
/* internal snapshot private data */
typedef struct InternalSnapshotState {
1467
    BlkActionState common;
1468
    BlockDriverState *bs;
1469
    AioContext *aio_context;
1470
    QEMUSnapshotInfo sn;
1471
    bool created;
1472 1473
} InternalSnapshotState;

J
John Snow 已提交
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487

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

1488
static void internal_snapshot_prepare(BlkActionState *common,
1489 1490
                                      Error **errp)
{
1491
    Error *local_err = NULL;
1492 1493
    const char *device;
    const char *name;
1494
    BlockBackend *blk;
1495 1496 1497 1498 1499 1500 1501 1502
    BlockDriverState *bs;
    QEMUSnapshotInfo old_sn, *sn;
    bool ret;
    qemu_timeval tv;
    BlockdevSnapshotInternal *internal;
    InternalSnapshotState *state;
    int ret1;

1503
    g_assert(common->action->type ==
1504
             TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1505
    internal = common->action->u.blockdev_snapshot_internal_sync;
1506 1507 1508 1509 1510 1511 1512
    state = DO_UPCAST(InternalSnapshotState, common, common);

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

    /* 2. check for validation */
J
John Snow 已提交
1513 1514 1515 1516
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1517 1518
    blk = blk_by_name(device);
    if (!blk) {
1519 1520
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
1521 1522 1523
        return;
    }

1524
    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1525
    state->aio_context = blk_get_aio_context(blk);
1526 1527
    aio_context_acquire(state->aio_context);

M
Max Reitz 已提交
1528
    if (!blk_is_available(blk)) {
1529
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1530 1531
        return;
    }
M
Max Reitz 已提交
1532
    bs = blk_bs(blk);
1533

1534 1535 1536
    state->bs = bs;
    bdrv_drained_begin(bs);

1537 1538 1539 1540
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
        return;
    }

1541
    if (bdrv_is_read_only(bs)) {
1542
        error_setg(errp, "Device '%s' is read only", device);
1543 1544 1545 1546
        return;
    }

    if (!bdrv_can_snapshot(bs)) {
1547 1548 1549
        error_setg(errp, "Block format '%s' used by device '%s' "
                   "does not support internal snapshots",
                   bs->drv->format_name, device);
1550 1551 1552 1553 1554 1555 1556 1557 1558
        return;
    }

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

    /* check whether a snapshot with name exist */
1559 1560 1561 1562
    ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
                                            &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
        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 */
1588
    state->created = true;
1589 1590
}

1591
static void internal_snapshot_abort(BlkActionState *common)
1592 1593 1594 1595 1596 1597 1598
{
    InternalSnapshotState *state =
                             DO_UPCAST(InternalSnapshotState, common, common);
    BlockDriverState *bs = state->bs;
    QEMUSnapshotInfo *sn = &state->sn;
    Error *local_error = NULL;

1599
    if (!state->created) {
1600 1601 1602 1603
        return;
    }

    if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1604 1605 1606 1607 1608
        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));
1609 1610 1611
    }
}

1612
static void internal_snapshot_clean(BlkActionState *common)
1613 1614 1615 1616 1617
{
    InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
                                             common, common);

    if (state->aio_context) {
1618 1619 1620
        if (state->bs) {
            bdrv_drained_end(state->bs);
        }
1621 1622 1623 1624
        aio_context_release(state->aio_context);
    }
}

1625
/* external snapshot private data */
1626
typedef struct ExternalSnapshotState {
1627
    BlkActionState common;
1628 1629
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1630
    AioContext *aio_context;
1631
} ExternalSnapshotState;
1632

1633
static void external_snapshot_prepare(BlkActionState *common,
1634 1635
                                      Error **errp)
{
1636 1637
    int flags = 0, ret;
    QDict *options = NULL;
1638
    Error *local_err = NULL;
1639
    /* Device and node name of the image to generate the snapshot from */
1640
    const char *device;
1641
    const char *node_name;
1642 1643 1644
    /* Reference to the new image (for 'blockdev-snapshot') */
    const char *snapshot_ref;
    /* File name of the new image (for 'blockdev-snapshot-sync') */
1645
    const char *new_image_file;
1646 1647
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1648
    TransactionAction *action = common->action;
1649

1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
    /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
     * purpose but a different set of parameters */
    switch (action->type) {
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
        {
            BlockdevSnapshot *s = action->u.blockdev_snapshot;
            device = s->node;
            node_name = s->node;
            new_image_file = NULL;
            snapshot_ref = s->overlay;
        }
        break;
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
        {
            BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync;
            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();
1673 1674 1675
    }

    /* start processing */
J
John Snow 已提交
1676 1677 1678 1679
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1680 1681
    state->old_bs = bdrv_lookup_bs(device, node_name, errp);
    if (!state->old_bs) {
1682 1683 1684
        return;
    }

1685 1686 1687
    /* 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);
1688
    bdrv_drained_begin(state->old_bs);
1689

1690
    if (!bdrv_is_inserted(state->old_bs)) {
1691
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1692 1693 1694
        return;
    }

1695 1696
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1697 1698 1699
        return;
    }

1700 1701
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1702
            error_setg(errp, QERR_IO_ERROR);
1703 1704 1705 1706
            return;
        }
    }

1707
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1708
        error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1709 1710 1711
        return;
    }

1712 1713 1714 1715 1716 1717
    if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
        BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync;
        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;
1718

1719 1720
        if (node_name && !snapshot_node_name) {
            error_setg(errp, "New snapshot node name missing");
1721 1722 1723
            return;
        }

1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
        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;

        /* create new image w/backing file */
        mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
        if (mode != NEW_IMAGE_MODE_EXISTING) {
1735 1736 1737 1738 1739
            int64_t size = bdrv_getlength(state->old_bs);
            if (size < 0) {
                error_setg_errno(errp, -size, "bdrv_getlength failed");
                return;
            }
1740 1741 1742
            bdrv_img_create(new_image_file, format,
                            state->old_bs->filename,
                            state->old_bs->drv->format_name,
1743
                            NULL, size, flags, &local_err, false);
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
            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;
1758 1759
    }

1760
    assert(state->new_bs == NULL);
1761 1762
    ret = bdrv_open(&state->new_bs, new_image_file, snapshot_ref, options,
                    flags, errp);
1763
    /* We will manually add the backing_hd field to the bs later */
1764
    if (ret != 0) {
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
        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");
1781 1782 1783 1784 1785
        return;
    }

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

1789
static void external_snapshot_commit(BlkActionState *common)
1790
{
1791 1792
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1793

1794 1795
    bdrv_set_aio_context(state->new_bs, state->aio_context);

1796 1797
    /* This removes our old bs and adds the new bs */
    bdrv_append(state->new_bs, state->old_bs);
1798 1799 1800
    /* 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 */
1801
    bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
1802 1803 1804
                NULL);
}

1805
static void external_snapshot_abort(BlkActionState *common)
1806
{
1807 1808 1809
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
F
Fam Zheng 已提交
1810
        bdrv_unref(state->new_bs);
1811
    }
1812 1813
}

1814
static void external_snapshot_clean(BlkActionState *common)
1815 1816 1817
{
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1818
    if (state->aio_context) {
1819
        bdrv_drained_end(state->old_bs);
1820 1821
        aio_context_release(state->aio_context);
    }
1822 1823
}

1824
typedef struct DriveBackupState {
1825
    BlkActionState common;
1826
    BlockDriverState *bs;
1827
    AioContext *aio_context;
1828 1829 1830
    BlockJob *job;
} DriveBackupState;

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
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);

1843
static void drive_backup_prepare(BlkActionState *common, Error **errp)
1844 1845
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1846
    BlockBackend *blk;
1847 1848 1849
    DriveBackup *backup;
    Error *local_err = NULL;

1850 1851
    assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
    backup = common->action->u.drive_backup;
1852

1853 1854
    blk = blk_by_name(backup->device);
    if (!blk) {
1855 1856
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", backup->device);
1857 1858 1859
        return;
    }

1860 1861 1862 1863 1864
    if (!blk_is_available(blk)) {
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
        return;
    }

1865
    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1866
    state->aio_context = blk_get_aio_context(blk);
1867
    aio_context_acquire(state->aio_context);
1868 1869
    bdrv_drained_begin(blk_bs(blk));
    state->bs = blk_bs(blk);
1870

1871 1872 1873 1874 1875 1876 1877 1878
    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 已提交
1879
                    common->block_job_txn, &local_err);
1880
    if (local_err) {
1881 1882 1883 1884 1885 1886 1887
        error_propagate(errp, local_err);
        return;
    }

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

1888
static void drive_backup_abort(BlkActionState *common)
1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
{
    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);
    }
}

1899
static void drive_backup_clean(BlkActionState *common)
1900 1901 1902 1903
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);

    if (state->aio_context) {
1904
        bdrv_drained_end(state->bs);
1905 1906 1907 1908
        aio_context_release(state->aio_context);
    }
}

1909
typedef struct BlockdevBackupState {
1910
    BlkActionState common;
1911 1912 1913 1914 1915
    BlockDriverState *bs;
    BlockJob *job;
    AioContext *aio_context;
} BlockdevBackupState;

1916 1917 1918 1919 1920 1921 1922 1923 1924
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);

1925
static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1926 1927 1928
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
    BlockdevBackup *backup;
M
Max Reitz 已提交
1929
    BlockBackend *blk, *target;
1930 1931
    Error *local_err = NULL;

1932 1933
    assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
    backup = common->action->u.blockdev_backup;
1934

1935 1936
    blk = blk_by_name(backup->device);
    if (!blk) {
1937
        error_setg(errp, "Device '%s' not found", backup->device);
1938 1939 1940
        return;
    }

1941 1942 1943 1944 1945
    if (!blk_is_available(blk)) {
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
        return;
    }

M
Max Reitz 已提交
1946 1947
    target = blk_by_name(backup->target);
    if (!target) {
1948
        error_setg(errp, "Device '%s' not found", backup->target);
1949 1950 1951 1952
        return;
    }

    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1953 1954
    state->aio_context = blk_get_aio_context(blk);
    if (state->aio_context != blk_get_aio_context(target)) {
1955 1956 1957 1958 1959
        state->aio_context = NULL;
        error_setg(errp, "Backup between two IO threads is not implemented");
        return;
    }
    aio_context_acquire(state->aio_context);
1960 1961
    state->bs = blk_bs(blk);
    bdrv_drained_begin(state->bs);
1962

1963 1964 1965 1966 1967
    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 已提交
1968
                       common->block_job_txn, &local_err);
1969 1970 1971 1972 1973 1974 1975 1976
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

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

1977
static void blockdev_backup_abort(BlkActionState *common)
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
{
    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);
    }
}

1988
static void blockdev_backup_clean(BlkActionState *common)
1989 1990 1991 1992
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);

    if (state->aio_context) {
1993
        bdrv_drained_end(state->bs);
1994 1995 1996 1997
        aio_context_release(state->aio_context);
    }
}

F
Fam Zheng 已提交
1998
typedef struct BlockDirtyBitmapState {
1999
    BlkActionState common;
F
Fam Zheng 已提交
2000 2001 2002 2003 2004 2005 2006
    BdrvDirtyBitmap *bitmap;
    BlockDriverState *bs;
    AioContext *aio_context;
    HBitmap *backup;
    bool prepared;
} BlockDirtyBitmapState;

2007
static void block_dirty_bitmap_add_prepare(BlkActionState *common,
F
Fam Zheng 已提交
2008 2009 2010 2011 2012 2013 2014
                                           Error **errp)
{
    Error *local_err = NULL;
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

J
John Snow 已提交
2015 2016 2017 2018
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2019
    action = common->action->u.block_dirty_bitmap_add;
F
Fam Zheng 已提交
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031
    /* 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);
    }
}

2032
static void block_dirty_bitmap_add_abort(BlkActionState *common)
F
Fam Zheng 已提交
2033 2034 2035 2036 2037
{
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

2038
    action = common->action->u.block_dirty_bitmap_add;
F
Fam Zheng 已提交
2039 2040 2041 2042 2043 2044 2045 2046
    /* 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);
    }
}

2047
static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
F
Fam Zheng 已提交
2048 2049 2050 2051 2052 2053
                                             Error **errp)
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);
    BlockDirtyBitmap *action;

J
John Snow 已提交
2054 2055 2056 2057
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2058
    action = common->action->u.block_dirty_bitmap_clear;
F
Fam Zheng 已提交
2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
    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() */
}

2080
static void block_dirty_bitmap_clear_abort(BlkActionState *common)
F
Fam Zheng 已提交
2081 2082 2083 2084 2085 2086 2087
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

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

2088
static void block_dirty_bitmap_clear_commit(BlkActionState *common)
F
Fam Zheng 已提交
2089 2090 2091 2092 2093 2094 2095
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

    hbitmap_free(state->backup);
}

2096
static void block_dirty_bitmap_clear_clean(BlkActionState *common)
F
Fam Zheng 已提交
2097 2098 2099 2100 2101 2102 2103 2104 2105
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

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

2106
static void abort_prepare(BlkActionState *common, Error **errp)
2107 2108 2109 2110
{
    error_setg(errp, "Transaction aborted using Abort action");
}

2111
static void abort_commit(BlkActionState *common)
2112
{
2113
    g_assert_not_reached(); /* this action never succeeds */
2114 2115
}

2116
static const BlkActionOps actions[] = {
2117 2118 2119 2120 2121
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
        .instance_size = sizeof(ExternalSnapshotState),
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2122
        .clean = external_snapshot_clean,
2123
    },
2124
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2125
        .instance_size = sizeof(ExternalSnapshotState),
2126 2127 2128
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2129
        .clean = external_snapshot_clean,
2130
    },
2131 2132 2133 2134
    [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
        .instance_size = sizeof(DriveBackupState),
        .prepare = drive_backup_prepare,
        .abort = drive_backup_abort,
2135
        .clean = drive_backup_clean,
2136
    },
2137 2138 2139 2140 2141 2142
    [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
        .instance_size = sizeof(BlockdevBackupState),
        .prepare = blockdev_backup_prepare,
        .abort = blockdev_backup_abort,
        .clean = blockdev_backup_clean,
    },
2143
    [TRANSACTION_ACTION_KIND_ABORT] = {
2144
        .instance_size = sizeof(BlkActionState),
2145 2146 2147
        .prepare = abort_prepare,
        .commit = abort_commit,
    },
2148 2149 2150 2151
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
        .instance_size = sizeof(InternalSnapshotState),
        .prepare  = internal_snapshot_prepare,
        .abort = internal_snapshot_abort,
2152
        .clean = internal_snapshot_clean,
2153
    },
F
Fam Zheng 已提交
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165
    [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,
    }
2166 2167
};

J
John Snow 已提交
2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
/**
 * 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;
}

2187
/*
2188 2189
 * 'Atomic' group operations.  The operations are performed as a set, and if
 * any fail then we roll back all operations in the group.
2190
 */
J
John Snow 已提交
2191 2192 2193 2194
void qmp_transaction(TransactionActionList *dev_list,
                     bool has_props,
                     struct TransactionProperties *props,
                     Error **errp)
2195
{
2196
    TransactionActionList *dev_entry = dev_list;
J
John Snow 已提交
2197
    BlockJobTxn *block_job_txn = NULL;
2198
    BlkActionState *state, *next;
2199
    Error *local_err = NULL;
2200

2201
    QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2202 2203
    QSIMPLEQ_INIT(&snap_bdrv_states);

J
John Snow 已提交
2204 2205 2206 2207 2208 2209 2210 2211
    /* 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();
    }

2212
    /* drain all i/o before any operations */
2213 2214
    bdrv_drain_all();

2215
    /* We don't do anything in this loop that commits us to the operations */
2216
    while (NULL != dev_entry) {
2217
        TransactionAction *dev_info = NULL;
2218
        const BlkActionOps *ops;
2219

2220 2221 2222
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

2223
        assert(dev_info->type < ARRAY_SIZE(actions));
2224

2225
        ops = &actions[dev_info->type];
2226 2227
        assert(ops->instance_size > 0);

2228 2229 2230
        state = g_malloc0(ops->instance_size);
        state->ops = ops;
        state->action = dev_info;
J
John Snow 已提交
2231 2232
        state->block_job_txn = block_job_txn;
        state->txn_props = props;
2233
        QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2234

2235
        state->ops->prepare(state, &local_err);
2236
        if (local_err) {
2237 2238
            error_propagate(errp, local_err);
            goto delete_and_fail;
2239 2240 2241
        }
    }

2242
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2243 2244 2245
        if (state->ops->commit) {
            state->ops->commit(state);
        }
2246 2247 2248 2249 2250 2251
    }

    /* success */
    goto exit;

delete_and_fail:
2252
    /* failure, and it is all-or-none; roll back all operations */
2253 2254 2255
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
        if (state->ops->abort) {
            state->ops->abort(state);
2256
        }
2257 2258
    }
exit:
2259 2260 2261
    QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
        if (state->ops->clean) {
            state->ops->clean(state);
2262
        }
2263
        g_free(state);
2264
    }
J
John Snow 已提交
2265 2266 2267 2268
    if (!has_props) {
        qapi_free_TransactionProperties(props);
    }
    block_job_txn_unref(block_job_txn);
2269 2270
}

L
Luiz Capitulino 已提交
2271
void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2272
{
2273
    Error *local_err = NULL;
2274

2275 2276 2277
    qmp_blockdev_open_tray(device, has_force, force, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2278
        return;
2279 2280
    }

2281
    qmp_x_blockdev_remove_medium(device, errp);
2282 2283
}

2284 2285 2286
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
2287
{
2288
    Error *local_err = NULL;
2289
    BlockDriverState *bs;
2290
    AioContext *aio_context;
2291

2292 2293 2294
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2295
    if (local_err) {
2296
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2297
        return;
2298 2299
    }

2300 2301 2302
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2303
    bdrv_add_key(bs, password, errp);
2304 2305

    aio_context_release(aio_context);
2306 2307
}

M
Max Reitz 已提交
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329
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;
    }

2330 2331 2332 2333 2334
    if (!blk_dev_has_tray(blk)) {
        /* Ignore this command on tray-less devices */
        return;
    }

M
Max Reitz 已提交
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
    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 已提交
2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364
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;
    }

2365 2366 2367 2368 2369
    if (!blk_dev_has_tray(blk)) {
        /* Ignore this command on tray-less devices */
        return;
    }

M
Max Reitz 已提交
2370 2371 2372 2373 2374 2375 2376
    if (!blk_dev_is_tray_open(blk)) {
        return;
    }

    blk_dev_change_media_cb(blk, true);
}

2377
void qmp_x_blockdev_remove_medium(const char *device, Error **errp)
M
Max Reitz 已提交
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
{
    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;
    }

2399
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
M
Max Reitz 已提交
2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417
        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;
    }

    /* This follows the convention established by bdrv_make_anon() */
    if (bs->device_list.tqe_prev) {
2418
        bdrv_device_remove(bs);
M
Max Reitz 已提交
2419 2420 2421 2422
    }

    blk_remove_bs(blk);

2423 2424 2425 2426 2427 2428 2429 2430
    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 已提交
2431 2432 2433 2434
out:
    aio_context_release(aio_context);
}

M
Max Reitz 已提交
2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455
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;
    }

2456
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
M
Max Reitz 已提交
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468
        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);

    QTAILQ_INSERT_TAIL(&bdrv_states, bs, device_list);
2469 2470 2471 2472 2473 2474 2475 2476 2477

    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 已提交
2478 2479
}

2480 2481
void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
                                  Error **errp)
M
Max Reitz 已提交
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499
{
    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 已提交
2500 2501
void qmp_blockdev_change_medium(const char *device, const char *filename,
                                bool has_format, const char *format,
2502 2503
                                bool has_read_only,
                                BlockdevChangeReadOnlyMode read_only,
M
Max Reitz 已提交
2504
                                Error **errp)
2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523
{
    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);
2524 2525
    bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
        BDRV_O_PROTOCOL);
2526

2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546
    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 已提交
2547
    if (has_format) {
2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571
        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;
    }

2572
    qmp_x_blockdev_remove_medium(device, &err);
2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592
    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 已提交
2593
/* throttling disk I/O limits */
2594
void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609
                               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,
2610
                               int64_t iops_wr_max,
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
                               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,
2623
                               bool has_iops_size,
2624 2625 2626
                               int64_t iops_size,
                               bool has_group,
                               const char *group, Error **errp)
Z
Zhi Yong Wu 已提交
2627
{
2628
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
2629
    BlockDriverState *bs;
2630
    BlockBackend *blk;
2631
    AioContext *aio_context;
Z
Zhi Yong Wu 已提交
2632

2633 2634
    blk = blk_by_name(device);
    if (!blk) {
2635 2636
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
2637
        return;
Z
Zhi Yong Wu 已提交
2638
    }
M
Max Reitz 已提交
2639 2640 2641 2642

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

2643
    bs = blk_bs(blk);
M
Max Reitz 已提交
2644 2645 2646 2647
    if (!bs) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
Z
Zhi Yong Wu 已提交
2648

2649
    throttle_config_init(&cfg);
2650 2651 2652 2653 2654 2655 2656 2657
    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;

2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675
    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 已提交
2676

2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695
    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;
    }

2696 2697 2698
    if (has_iops_size) {
        cfg.op_size = iops_size;
    }
2699

2700
    if (!throttle_is_valid(&cfg, errp)) {
M
Max Reitz 已提交
2701
        goto out;
Z
Zhi Yong Wu 已提交
2702 2703
    }

2704 2705 2706
    if (throttle_enabled(&cfg)) {
        /* Enable I/O limits if they're not enabled yet, otherwise
         * just update the throttling group. */
2707
        if (!bs->throttle_state) {
2708 2709 2710 2711 2712
            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 */
2713
        bdrv_set_io_limits(bs, &cfg);
2714
    } else if (bs->throttle_state) {
2715 2716
        /* If all throttling settings are set to 0, disable I/O limits */
        bdrv_io_limits_disable(bs);
Z
Zhi Yong Wu 已提交
2717
    }
2718

M
Max Reitz 已提交
2719
out:
2720
    aio_context_release(aio_context);
Z
Zhi Yong Wu 已提交
2721 2722
}

2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 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
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 已提交
2772 2773 2774 2775 2776 2777
    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be removed",
                   name);
        goto out;
    }
2778
    bdrv_dirty_bitmap_make_anon(bitmap);
2779 2780
    bdrv_release_dirty_bitmap(bs, bitmap);

J
John Snow 已提交
2781
 out:
2782 2783 2784
    aio_context_release(aio_context);
}

J
John Snow 已提交
2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
/**
 * 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 已提交
2813
    bdrv_clear_dirty_bitmap(bitmap, NULL);
J
John Snow 已提交
2814 2815 2816 2817 2818

 out:
    aio_context_release(aio_context);
}

2819
void hmp_drive_del(Monitor *mon, const QDict *qdict)
2820 2821
{
    const char *id = qdict_get_str(qdict, "id");
2822
    BlockBackend *blk;
2823
    BlockDriverState *bs;
2824
    AioContext *aio_context;
2825
    Error *local_err = NULL;
2826

2827 2828 2829 2830 2831 2832 2833 2834 2835
    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;
    }

2836 2837
    blk = blk_by_name(id);
    if (!blk) {
2838
        error_report("Device '%s' not found", id);
2839
        return;
2840
    }
2841

2842
    if (!blk_legacy_dinfo(blk)) {
2843 2844
        error_report("Deleting device added with blockdev-add"
                     " is not supported");
2845
        return;
2846 2847
    }

M
Max Reitz 已提交
2848
    aio_context = blk_get_aio_context(blk);
2849 2850
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
2851 2852 2853 2854 2855 2856 2857
    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;
        }
2858

2859
        blk_remove_bs(blk);
M
Max Reitz 已提交
2860
    }
2861

2862
    /* if we have a device attached to this BlockDriverState
2863 2864 2865 2866
     * then we need to make the drive anonymous until the device
     * can be removed.  If this is a drive with no device backing
     * then we can just get rid of the block driver state right here.
     */
2867
    if (blk_get_attached_dev(blk)) {
2868
        blk_hide_on_behalf_of_hmp_drive_del(blk);
2869
        /* Further I/O must not pause the guest */
2870 2871
        blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
                         BLOCKDEV_ON_ERROR_REPORT);
2872
    } else {
2873
        blk_unref(blk);
2874 2875
    }

2876
    aio_context_release(aio_context);
2877
}
2878

2879 2880 2881
void qmp_block_resize(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      int64_t size, Error **errp)
2882
{
2883
    Error *local_err = NULL;
2884
    BlockDriverState *bs;
2885
    AioContext *aio_context;
2886
    int ret;
2887

2888 2889 2890
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2891
    if (local_err) {
2892 2893 2894 2895
        error_propagate(errp, local_err);
        return;
    }

2896 2897 2898
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2899
    if (!bdrv_is_first_non_filter(bs)) {
2900
        error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2901
        goto out;
2902 2903 2904
    }

    if (size < 0) {
2905
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2906
        goto out;
2907 2908
    }

2909
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2910
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2911
        goto out;
2912 2913
    }

2914 2915 2916
    /* complete all in-flight operations before resizing the device */
    bdrv_drain_all();

2917 2918
    ret = bdrv_truncate(bs, size);
    switch (ret) {
2919 2920 2921
    case 0:
        break;
    case -ENOMEDIUM:
2922
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2923 2924
        break;
    case -ENOTSUP:
2925
        error_setg(errp, QERR_UNSUPPORTED);
2926 2927
        break;
    case -EACCES:
2928
        error_setg(errp, "Device '%s' is read only", device);
2929 2930
        break;
    case -EBUSY:
2931
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2932 2933
        break;
    default:
2934
        error_setg_errno(errp, -ret, "Could not resize");
2935
        break;
2936
    }
2937 2938 2939

out:
    aio_context_release(aio_context);
2940
}
S
Stefan Hajnoczi 已提交
2941

2942
static void block_job_cb(void *opaque, int ret)
S
Stefan Hajnoczi 已提交
2943
{
2944 2945 2946 2947 2948
    /* 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 已提交
2949
    BlockDriverState *bs = opaque;
2950
    const char *msg = NULL;
S
Stefan Hajnoczi 已提交
2951

2952
    trace_block_job_cb(bs, bs->job, ret);
S
Stefan Hajnoczi 已提交
2953 2954

    assert(bs->job);
2955

S
Stefan Hajnoczi 已提交
2956
    if (ret < 0) {
2957
        msg = strerror(-ret);
S
Stefan Hajnoczi 已提交
2958 2959
    }

2960
    if (block_job_is_cancelled(bs->job)) {
2961
        block_job_event_cancelled(bs->job);
2962
    } else {
2963
        block_job_event_completed(bs->job, msg);
2964
    }
S
Stefan Hajnoczi 已提交
2965 2966
}

2967 2968 2969 2970
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 已提交
2971 2972
                      bool has_on_error, BlockdevOnError on_error,
                      Error **errp)
S
Stefan Hajnoczi 已提交
2973
{
2974
    BlockBackend *blk;
S
Stefan Hajnoczi 已提交
2975
    BlockDriverState *bs;
2976
    BlockDriverState *base_bs = NULL;
2977
    AioContext *aio_context;
2978
    Error *local_err = NULL;
2979
    const char *base_name = NULL;
S
Stefan Hajnoczi 已提交
2980

P
Paolo Bonzini 已提交
2981 2982 2983 2984
    if (!has_on_error) {
        on_error = BLOCKDEV_ON_ERROR_REPORT;
    }

2985 2986
    blk = blk_by_name(device);
    if (!blk) {
2987 2988
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
S
Stefan Hajnoczi 已提交
2989 2990 2991
        return;
    }

M
Max Reitz 已提交
2992
    aio_context = blk_get_aio_context(blk);
2993 2994
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
2995 2996 2997 2998 2999 3000
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3001
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
3002
        goto out;
3003 3004
    }

3005
    if (has_base) {
3006 3007
        base_bs = bdrv_find_backing_image(bs, base);
        if (base_bs == NULL) {
3008
            error_setg(errp, QERR_BASE_NOT_FOUND, base);
3009
            goto out;
3010
        }
3011
        assert(bdrv_get_aio_context(base_bs) == aio_context);
3012
        base_name = base;
S
Stefan Hajnoczi 已提交
3013 3014
    }

3015 3016 3017 3018 3019
    /* 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");
3020
        goto out;
3021 3022 3023 3024 3025 3026
    }

    /* 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 已提交
3027
                 on_error, block_job_cb, bs, &local_err);
3028
    if (local_err) {
3029
        error_propagate(errp, local_err);
3030
        goto out;
S
Stefan Hajnoczi 已提交
3031 3032 3033
    }

    trace_qmp_block_stream(bs, bs->job);
3034 3035 3036

out:
    aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
3037
}
3038

3039
void qmp_block_commit(const char *device,
3040 3041
                      bool has_base, const char *base,
                      bool has_top, const char *top,
3042
                      bool has_backing_file, const char *backing_file,
3043 3044 3045
                      bool has_speed, int64_t speed,
                      Error **errp)
{
3046
    BlockBackend *blk;
3047 3048
    BlockDriverState *bs;
    BlockDriverState *base_bs, *top_bs;
3049
    AioContext *aio_context;
3050 3051 3052 3053
    Error *local_err = NULL;
    /* This will be part of the QMP command, if/when the
     * BlockdevOnError change for blkmirror makes it in
     */
3054
    BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3055

3056 3057 3058 3059
    if (!has_speed) {
        speed = 0;
    }

3060 3061 3062 3063 3064
    /* 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. */
3065 3066
    blk = blk_by_name(device);
    if (!blk) {
3067 3068
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3069
        return;
3070 3071
    }

M
Max Reitz 已提交
3072
    aio_context = blk_get_aio_context(blk);
3073 3074
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3075 3076 3077 3078 3079 3080
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3081
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3082
        goto out;
3083 3084 3085 3086 3087
    }

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

3088
    if (has_top && top) {
3089 3090 3091 3092 3093 3094 3095
        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");
3096
        goto out;
3097 3098
    }

3099 3100
    assert(bdrv_get_aio_context(top_bs) == aio_context);

3101 3102 3103 3104 3105 3106 3107
    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) {
3108
        error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3109
        goto out;
3110 3111
    }

3112 3113
    assert(bdrv_get_aio_context(base_bs) == aio_context);

3114 3115 3116 3117
    if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
        goto out;
    }

3118 3119 3120
    /* Do not allow attempts to commit an image into itself */
    if (top_bs == base_bs) {
        error_setg(errp, "cannot commit an image into itself");
3121
        goto out;
3122 3123
    }

F
Fam Zheng 已提交
3124
    if (top_bs == bs) {
3125 3126 3127
        if (has_backing_file) {
            error_setg(errp, "'backing-file' specified,"
                             " but 'top' is the active layer");
3128
            goto out;
3129
        }
F
Fam Zheng 已提交
3130 3131 3132 3133
        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,
3134
                     has_backing_file ? backing_file : NULL, &local_err);
F
Fam Zheng 已提交
3135
    }
3136 3137
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3138
        goto out;
3139
    }
3140 3141 3142

out:
    aio_context_release(aio_context);
3143 3144
}

3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
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)
3156
{
3157
    BlockBackend *blk;
3158 3159
    BlockDriverState *bs;
    BlockDriverState *target_bs;
3160
    BlockDriverState *source = NULL;
3161
    BdrvDirtyBitmap *bmap = NULL;
3162
    AioContext *aio_context;
3163
    QDict *options = NULL;
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181
    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;
    }

3182 3183
    blk = blk_by_name(device);
    if (!blk) {
3184 3185
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3186 3187 3188
        return;
    }

M
Max Reitz 已提交
3189
    aio_context = blk_get_aio_context(blk);
3190 3191
    aio_context_acquire(aio_context);

F
Fam Zheng 已提交
3192 3193
    /* Although backup_run has this check too, we need to use bs->drv below, so
     * do an early check redundantly. */
M
Max Reitz 已提交
3194
    if (!blk_is_available(blk)) {
3195
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3196
        goto out;
3197
    }
M
Max Reitz 已提交
3198
    bs = blk_bs(blk);
3199 3200 3201 3202 3203

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

F
Fam Zheng 已提交
3204
    /* Early check to avoid creating target */
3205
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3206
        goto out;
3207 3208 3209 3210
    }

    flags = bs->open_flags | BDRV_O_RDWR;

3211 3212 3213
    /* See if we have a backing HD we can use to create our new image
     * on top of. */
    if (sync == MIRROR_SYNC_MODE_TOP) {
3214
        source = backing_bs(bs);
3215 3216 3217 3218 3219 3220 3221 3222
        if (!source) {
            sync = MIRROR_SYNC_MODE_FULL;
        }
    }
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }

3223 3224 3225
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3226
        goto out;
3227 3228 3229
    }

    if (mode != NEW_IMAGE_MODE_EXISTING) {
3230
        assert(format);
3231 3232 3233 3234 3235 3236 3237 3238
        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);
        }
3239 3240
    }

3241
    if (local_err) {
3242
        error_propagate(errp, local_err);
3243
        goto out;
3244 3245
    }

3246 3247 3248 3249 3250
    if (format) {
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(format));
    }

3251
    target_bs = NULL;
3252
    ret = bdrv_open(&target_bs, target, NULL, options, flags, &local_err);
3253
    if (ret < 0) {
3254
        error_propagate(errp, local_err);
3255
        goto out;
3256 3257
    }

3258 3259
    bdrv_set_aio_context(target_bs, aio_context);

3260 3261 3262 3263
    if (has_bitmap) {
        bmap = bdrv_find_dirty_bitmap(bs, bitmap);
        if (!bmap) {
            error_setg(errp, "Bitmap '%s' could not be found", bitmap);
3264
            bdrv_unref(target_bs);
3265 3266 3267 3268 3269 3270
            goto out;
        }
    }

    backup_start(bs, target_bs, speed, sync, bmap,
                 on_source_error, on_target_error,
3271
                 block_job_cb, bs, txn, &local_err);
3272
    if (local_err != NULL) {
F
Fam Zheng 已提交
3273
        bdrv_unref(target_bs);
3274
        error_propagate(errp, local_err);
3275
        goto out;
3276
    }
3277 3278 3279

out:
    aio_context_release(aio_context);
3280 3281
}

3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
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);
}

3300 3301
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
3302
    return bdrv_named_nodes_list(errp);
3303 3304
}

3305
void do_blockdev_backup(const char *device, const char *target,
F
Fam Zheng 已提交
3306 3307 3308 3309 3310 3311
                         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,
3312
                         BlockJobTxn *txn, Error **errp)
F
Fam Zheng 已提交
3313
{
M
Max Reitz 已提交
3314
    BlockBackend *blk, *target_blk;
F
Fam Zheng 已提交
3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329
    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;
    }

3330 3331
    blk = blk_by_name(device);
    if (!blk) {
3332
        error_setg(errp, "Device '%s' not found", device);
F
Fam Zheng 已提交
3333 3334 3335
        return;
    }

M
Max Reitz 已提交
3336
    aio_context = blk_get_aio_context(blk);
F
Fam Zheng 已提交
3337 3338
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3339 3340 3341 3342 3343 3344 3345 3346
    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) {
3347
        error_setg(errp, "Device '%s' not found", target);
F
Fam Zheng 已提交
3348 3349
        goto out;
    }
M
Max Reitz 已提交
3350 3351 3352 3353 3354 3355

    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 已提交
3356 3357 3358

    bdrv_ref(target_bs);
    bdrv_set_aio_context(target_bs, aio_context);
3359
    backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
3360
                 on_target_error, block_job_cb, bs, txn, &local_err);
F
Fam Zheng 已提交
3361 3362 3363 3364 3365 3366 3367 3368
    if (local_err != NULL) {
        bdrv_unref(target_bs);
        error_propagate(errp, local_err);
    }
out:
    aio_context_release(aio_context);
}

3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383
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);
}

3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399
/* 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 已提交
3400 3401 3402 3403 3404
{

    if (!has_speed) {
        speed = 0;
    }
3405 3406 3407 3408 3409 3410
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
3411 3412 3413
    if (!has_granularity) {
        granularity = 0;
    }
3414
    if (!has_buf_size) {
W
Wen Congyang 已提交
3415
        buf_size = 0;
3416
    }
3417 3418 3419
    if (!has_unmap) {
        unmap = true;
    }
3420

3421
    if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3422 3423
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "a value in range [512B, 64MB]");
3424 3425 3426
        return;
    }
    if (granularity & (granularity - 1)) {
3427 3428
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "power of 2");
3429 3430
        return;
    }
P
Paolo Bonzini 已提交
3431

3432 3433 3434
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
        return;
    }
F
Fam Zheng 已提交
3435 3436 3437
    if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
        return;
    }
F
Fam Zheng 已提交
3438 3439 3440 3441
    if (target->blk) {
        error_setg(errp, "Cannot mirror to an attached block device");
        return;
    }
3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480

    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;

3481 3482
    blk = blk_by_name(device);
    if (!blk) {
3483 3484
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
P
Paolo Bonzini 已提交
3485 3486 3487
        return;
    }

M
Max Reitz 已提交
3488
    aio_context = blk_get_aio_context(blk);
3489 3490
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3491
    if (!blk_is_available(blk)) {
3492
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3493
        goto out;
P
Paolo Bonzini 已提交
3494
    }
M
Max Reitz 已提交
3495
    bs = blk_bs(blk);
3496 3497 3498
    if (!has_mode) {
        mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
P
Paolo Bonzini 已提交
3499 3500 3501 3502 3503 3504

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

    flags = bs->open_flags | BDRV_O_RDWR;
3505
    source = backing_bs(bs);
P
Paolo Bonzini 已提交
3506 3507 3508
    if (!source && sync == MIRROR_SYNC_MODE_TOP) {
        sync = MIRROR_SYNC_MODE_FULL;
    }
3509 3510 3511
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }
P
Paolo Bonzini 已提交
3512

3513 3514 3515
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3516
        goto out;
3517 3518
    }

3519 3520
    if (has_replaces) {
        BlockDriverState *to_replace_bs;
3521 3522
        AioContext *replace_aio_context;
        int64_t replace_size;
3523 3524 3525 3526

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

3530
        to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
3531 3532 3533

        if (!to_replace_bs) {
            error_propagate(errp, local_err);
3534
            goto out;
3535 3536
        }

3537 3538 3539 3540 3541 3542
        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) {
3543 3544
            error_setg(errp, "cannot replace image with a mirror image of "
                             "different size");
3545
            goto out;
3546 3547 3548
        }
    }

3549 3550 3551
    if ((sync == MIRROR_SYNC_MODE_FULL || !source)
        && mode != NEW_IMAGE_MODE_EXISTING)
    {
P
Paolo Bonzini 已提交
3552
        /* create new image w/o backing file */
3553
        assert(format);
3554
        bdrv_img_create(target, format,
3555
                        NULL, NULL, NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3556 3557 3558 3559 3560 3561
    } else {
        switch (mode) {
        case NEW_IMAGE_MODE_EXISTING:
            break;
        case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
            /* create new image with backing file */
3562 3563 3564
            bdrv_img_create(target, format,
                            source->filename,
                            source->drv->format_name,
3565
                            NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3566 3567 3568 3569 3570 3571
            break;
        default:
            abort();
        }
    }

3572
    if (local_err) {
3573
        error_propagate(errp, local_err);
3574
        goto out;
P
Paolo Bonzini 已提交
3575 3576
    }

3577
    options = qdict_new();
3578 3579 3580
    if (has_node_name) {
        qdict_put(options, "node-name", qstring_from_str(node_name));
    }
3581 3582 3583
    if (format) {
        qdict_put(options, "driver", qstring_from_str(format));
    }
3584

3585 3586 3587
    /* Mirroring takes care of copy-on-write using the source's backing
     * file.
     */
3588
    target_bs = NULL;
3589
    ret = bdrv_open(&target_bs, target, NULL, options,
3590
                    flags | BDRV_O_NO_BACKING, &local_err);
P
Paolo Bonzini 已提交
3591
    if (ret < 0) {
3592
        error_propagate(errp, local_err);
3593
        goto out;
P
Paolo Bonzini 已提交
3594 3595
    }

3596 3597
    bdrv_set_aio_context(target_bs, aio_context);

3598 3599 3600 3601 3602 3603 3604 3605 3606 3607
    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 已提交
3608
        error_propagate(errp, local_err);
3609
        bdrv_unref(target_bs);
P
Paolo Bonzini 已提交
3610
    }
3611 3612
out:
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3613 3614
}

F
Fam Zheng 已提交
3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 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
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);
}

3673
/* Get the block job for a given device name and acquire its AioContext */
3674 3675
static BlockJob *find_block_job(const char *device, AioContext **aio_context,
                                Error **errp)
3676
{
3677
    BlockBackend *blk;
3678 3679
    BlockDriverState *bs;

M
Max Reitz 已提交
3680 3681
    *aio_context = NULL;

3682 3683
    blk = blk_by_name(device);
    if (!blk) {
3684 3685 3686
        goto notfound;
    }

M
Max Reitz 已提交
3687
    *aio_context = blk_get_aio_context(blk);
3688 3689
    aio_context_acquire(*aio_context);

M
Max Reitz 已提交
3690 3691 3692 3693 3694
    if (!blk_is_available(blk)) {
        goto notfound;
    }
    bs = blk_bs(blk);

3695 3696
    if (!bs->job) {
        goto notfound;
3697
    }
3698

3699
    return bs->job;
3700 3701

notfound:
3702 3703
    error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
              "No active block job on device '%s'", device);
M
Max Reitz 已提交
3704 3705 3706 3707
    if (*aio_context) {
        aio_context_release(*aio_context);
        *aio_context = NULL;
    }
3708
    return NULL;
3709 3710
}

3711
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3712
{
3713
    AioContext *aio_context;
3714
    BlockJob *job = find_block_job(device, &aio_context, errp);
3715 3716 3717 3718 3719

    if (!job) {
        return;
    }

3720
    block_job_set_speed(job, speed, errp);
3721
    aio_context_release(aio_context);
3722
}
3723

3724 3725
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
3726
{
3727
    AioContext *aio_context;
3728
    BlockJob *job = find_block_job(device, &aio_context, errp);
3729

3730 3731 3732
    if (!job) {
        return;
    }
3733 3734 3735 3736 3737

    if (!has_force) {
        force = false;
    }

F
Fam Zheng 已提交
3738
    if (job->user_paused && !force) {
3739 3740
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
3741
        goto out;
3742
    }
3743 3744 3745

    trace_qmp_block_job_cancel(job);
    block_job_cancel(job);
3746 3747
out:
    aio_context_release(aio_context);
3748
}
S
Stefan Hajnoczi 已提交
3749

3750 3751
void qmp_block_job_pause(const char *device, Error **errp)
{
3752
    AioContext *aio_context;
3753
    BlockJob *job = find_block_job(device, &aio_context, errp);
3754

F
Fam Zheng 已提交
3755
    if (!job || job->user_paused) {
3756 3757 3758
        return;
    }

F
Fam Zheng 已提交
3759
    job->user_paused = true;
3760 3761
    trace_qmp_block_job_pause(job);
    block_job_pause(job);
3762
    aio_context_release(aio_context);
3763 3764 3765 3766
}

void qmp_block_job_resume(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 = false;
3775 3776
    trace_qmp_block_job_resume(job);
    block_job_resume(job);
3777
    aio_context_release(aio_context);
3778 3779
}

P
Paolo Bonzini 已提交
3780 3781
void qmp_block_job_complete(const char *device, Error **errp)
{
3782
    AioContext *aio_context;
3783
    BlockJob *job = find_block_job(device, &aio_context, errp);
P
Paolo Bonzini 已提交
3784 3785 3786 3787 3788 3789 3790

    if (!job) {
        return;
    }

    trace_qmp_block_job_complete(job);
    block_job_complete(job, errp);
3791
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3792 3793
}

3794 3795 3796 3797 3798
void qmp_change_backing_file(const char *device,
                             const char *image_node_name,
                             const char *backing_file,
                             Error **errp)
{
3799
    BlockBackend *blk;
3800
    BlockDriverState *bs = NULL;
3801
    AioContext *aio_context;
3802 3803 3804 3805 3806 3807
    BlockDriverState *image_bs = NULL;
    Error *local_err = NULL;
    bool ro;
    int open_flags;
    int ret;

3808 3809
    blk = blk_by_name(device);
    if (!blk) {
3810 3811
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3812 3813 3814
        return;
    }

M
Max Reitz 已提交
3815
    aio_context = blk_get_aio_context(blk);
3816 3817
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3818 3819 3820 3821 3822 3823
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3824 3825 3826
    image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
3827
        goto out;
3828 3829 3830 3831
    }

    if (!image_bs) {
        error_setg(errp, "image file not found");
3832
        goto out;
3833 3834 3835 3836 3837
    }

    if (bdrv_find_base(image_bs) == image_bs) {
        error_setg(errp, "not allowing backing file change on an image "
                         "without a backing file");
3838
        goto out;
3839 3840 3841 3842 3843
    }

    /* 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)) {
3844
        goto out;
3845 3846 3847 3848 3849 3850
    }

    /* final sanity check */
    if (!bdrv_chain_contains(bs, image_bs)) {
        error_setg(errp, "'%s' and image file are not in the same chain",
                   device);
3851
        goto out;
3852 3853 3854 3855 3856 3857 3858 3859 3860 3861
    }

    /* 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);
3862
            goto out;
3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881
        }
    }

    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 */
        }
    }
3882 3883 3884

out:
    aio_context_release(aio_context);
3885 3886
}

3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900
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")) {
3901
        QDECREF(qdict);
3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917
        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 已提交
3918 3919 3920
void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
{
    QmpOutputVisitor *ov = qmp_output_visitor_new();
3921 3922
    BlockDriverState *bs;
    BlockBackend *blk = NULL;
K
Kevin Wolf 已提交
3923 3924 3925 3926
    QObject *obj;
    QDict *qdict;
    Error *local_err = NULL;

3927
    /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
K
Kevin Wolf 已提交
3928
     * cache.direct=false instead of silently switching to aio=threads, except
3929
     * when called from drive_new().
K
Kevin Wolf 已提交
3930 3931 3932
     *
     * For now, simply forbidding the combination for all drivers will do. */
    if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3933 3934 3935 3936
        bool direct = options->has_cache &&
                      options->cache->has_direct &&
                      options->cache->direct;
        if (!direct) {
K
Kevin Wolf 已提交
3937 3938 3939 3940 3941
            error_setg(errp, "aio=native requires cache.direct=true");
            goto fail;
        }
    }

3942 3943
    visit_type_BlockdevOptions(qmp_output_get_visitor(ov), NULL, &options,
                               &local_err);
3944
    if (local_err) {
K
Kevin Wolf 已提交
3945 3946 3947 3948 3949 3950 3951 3952 3953
        error_propagate(errp, local_err);
        goto fail;
    }

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

    qdict_flatten(qdict);

3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968
    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;
        }

3969 3970
        bs = bds_tree_init(qdict, errp);
        if (!bs) {
3971 3972
            goto fail;
        }
3973 3974

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

3977 3978 3979 3980
    if (bs && bdrv_key_required(bs)) {
        if (blk) {
            blk_unref(blk);
        } else {
3981
            QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3982 3983
            bdrv_unref(bs);
        }
3984 3985 3986 3987
        error_setg(errp, "blockdev-add doesn't support encrypted devices");
        goto fail;
    }

K
Kevin Wolf 已提交
3988 3989 3990 3991
fail:
    qmp_output_visitor_cleanup(ov);
}

3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040
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) {
        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;
        }

4041 4042 4043 4044 4045 4046 4047
        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) {
4048 4049 4050 4051 4052 4053 4054 4055 4056
            error_setg(errp, "Block device %s is in use",
                       bdrv_get_device_or_node_name(bs));
            goto out;
        }
    }

    if (blk) {
        blk_unref(blk);
    } else {
4057
        QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4058 4059 4060 4061 4062 4063 4064
        bdrv_unref(bs);
    }

out:
    aio_context_release(aio_context);
}

4065
BlockJobInfoList *qmp_query_block_jobs(Error **errp)
S
Stefan Hajnoczi 已提交
4066
{
4067 4068
    BlockJobInfoList *head = NULL, **p_next = &head;
    BlockDriverState *bs;
S
Stefan Hajnoczi 已提交
4069

4070
    for (bs = bdrv_next(NULL); bs; bs = bdrv_next(bs)) {
4071 4072 4073 4074
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);

4075 4076 4077 4078 4079 4080
        if (bs->job) {
            BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
            elem->value = block_job_query(bs->job);
            *p_next = elem;
            p_next = &elem->next;
        }
4081 4082

        aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
4083 4084
    }

4085
    return head;
S
Stefan Hajnoczi 已提交
4086
}
4087

4088
QemuOptsList qemu_common_drive_opts = {
4089
    .name = "drive",
4090
    .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4091 4092 4093 4094 4095
    .desc = {
        {
            .name = "snapshot",
            .type = QEMU_OPT_BOOL,
            .help = "enable/disable snapshot mode",
4096 4097 4098 4099
        },{
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
        },{
            .name = "format",
            .type = QEMU_OPT_STRING,
            .help = "disk format (raw, qcow2, ...)",
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
        },{
4117
            .name = "read-only",
4118 4119 4120
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
4121
            .name = "throttling.iops-total",
4122 4123 4124
            .type = QEMU_OPT_NUMBER,
            .help = "limit total I/O operations per second",
        },{
4125
            .name = "throttling.iops-read",
4126 4127 4128
            .type = QEMU_OPT_NUMBER,
            .help = "limit read operations per second",
        },{
4129
            .name = "throttling.iops-write",
4130 4131 4132
            .type = QEMU_OPT_NUMBER,
            .help = "limit write operations per second",
        },{
4133
            .name = "throttling.bps-total",
4134 4135 4136
            .type = QEMU_OPT_NUMBER,
            .help = "limit total bytes per second",
        },{
4137
            .name = "throttling.bps-read",
4138 4139 4140
            .type = QEMU_OPT_NUMBER,
            .help = "limit read bytes per second",
        },{
4141
            .name = "throttling.bps-write",
4142 4143
            .type = QEMU_OPT_NUMBER,
            .help = "limit write bytes per second",
4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167
        },{
            .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",
4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191
        },{
            .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",
4192 4193 4194 4195
        },{
            .name = "throttling.iops-size",
            .type = QEMU_OPT_NUMBER,
            .help = "when limiting by iops max size of an I/O in bytes",
4196 4197 4198 4199
        },{
            .name = "throttling.group",
            .type = QEMU_OPT_STRING,
            .help = "name of the block throttling group",
4200 4201 4202 4203
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
4204 4205 4206 4207
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
4208 4209 4210 4211 4212 4213 4214 4215 4216 4217
        },{
            .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",
4218 4219 4220 4221
        },
        { /* end of list */ }
    },
};
4222

4223 4224
static QemuOptsList qemu_root_bds_opts = {
    .name = "root-bds",
4225
    .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251
    .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 */ }
    },
};

4252 4253 4254 4255
QemuOptsList qemu_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
    .desc = {
4256 4257 4258 4259
        /*
         * no elements => accept any params
         * validation will happen later
         */
4260 4261 4262
        { /* end of list */ }
    },
};