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

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

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

59 60
static int do_open_tray(const char *blk_name, const char *qdev_id,
                        bool force, Error **errp);
61

62 63 64 65 66 67 68 69 70 71 72 73
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",
};

74
static int if_max_devs[IF_COUNT] = {
75 76 77 78
    /*
     * Do not change these numbers!  They govern how drive option
     * index maps to unit and bus.  That mapping is ABI.
     *
W
Wei Jiangang 已提交
79
     * All controllers used to implement if=T drives need to support
80 81 82 83 84 85 86 87 88 89 90
     * 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,
91 92
};

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

    if (max_devs <= 0) {
        return;
    }

106 107
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
108 109 110 111 112 113 114 115 116 117 118
        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;
}

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

132
    if (!dinfo) {
133 134 135
        return;
    }

M
Max Reitz 已提交
136 137 138
    if (bs) {
        aio_context = bdrv_get_aio_context(bs);
        aio_context_acquire(aio_context);
139

M
Max Reitz 已提交
140 141 142
        if (bs->job) {
            block_job_cancel(bs->job);
        }
143

M
Max Reitz 已提交
144 145
        aio_context_release(aio_context);
    }
146

147
    dinfo->auto_del = 1;
148 149
}

150
void blockdev_auto_del(BlockBackend *blk)
151
{
152
    DriveInfo *dinfo = blk_legacy_dinfo(blk);
153

154
    if (dinfo && dinfo->auto_del) {
155
        monitor_remove_blk(blk);
156
        blk_unref(blk);
157 158 159
    }
}

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
/**
 * 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;
}

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

189 190
QemuOpts *drive_def(const char *optstr)
{
191
    return qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
192 193 194
}

QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
195
                    const char *optstr)
196 197 198
{
    QemuOpts *opts;

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

DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
{
216
    BlockBackend *blk;
217 218
    DriveInfo *dinfo;

219 220 221 222
    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) {
223
            return dinfo;
224
        }
225 226 227 228 229
    }

    return NULL;
}

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

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

    return rs;
}

253 254 255 256 257 258 259
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));
}

260 261 262
int drive_get_max_bus(BlockInterfaceType type)
{
    int max_bus;
263
    BlockBackend *blk;
264 265 266
    DriveInfo *dinfo;

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

276 277 278 279 280 281 282 283 284 285
/* 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]++);
}

286 287
static void bdrv_format_print(void *opaque, const char *name)
{
288
    error_printf(" %s", name);
289 290
}

291 292
typedef struct {
    QEMUBH *bh;
F
Fam Zheng 已提交
293 294
    BlockDriverState *bs;
} BDRVPutRefBH;
295

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

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
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;
}

352 353
typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;

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

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

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

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

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

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

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

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

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

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

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

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

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

486 487 488
    /* Check common options by copying from bs_opts to opts, all other options
     * stay in bs_opts for processing by bdrv_open(). */
    id = qdict_get_try_str(bs_opts, "id");
489
    opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
490
    if (error) {
491
        error_propagate(errp, error);
492
        goto err_no_opts;
493 494 495
    }

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

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

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

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

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

513 514
    id = qemu_opts_id(opts);

515 516 517 518 519 520 521 522
    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;
    }
523

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

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

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

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

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

564
    if (snapshot) {
565
        bdrv_flags |= BDRV_O_SNAPSHOT;
566 567
    }

568 569
    read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);

570
    /* init */
571
    if ((!file || !*file) && !qdict_size(bs_opts)) {
572 573
        BlockBackendRootState *blk_rs;

574
        blk = blk_new();
575 576
        blk_rs = blk_get_root_state(blk);
        blk_rs->open_flags    = bdrv_flags;
577
        blk_rs->read_only     = read_only;
578 579
        blk_rs->detect_zeroes = detect_zeroes;

580 581 582
        QDECREF(bs_opts);
    } else {
        if (file && !*file) {
583 584
            file = NULL;
        }
585

586 587 588 589 590
        /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
         * with other callers) rather than what we want as the real defaults.
         * Apply the defaults here instead. */
        qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
        qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
591 592
        qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
                              read_only ? "on" : "off");
593
        assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
594

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

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

605
        bs->detect_zeroes = detect_zeroes;
606

607 608
        if (bdrv_key_required(bs)) {
            autostart = 0;
609
        }
610 611

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

613 614 615 616
        if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
            blk_unref(blk);
            blk = NULL;
            goto err_no_bs_opts;
617
        }
618 619
    }

620 621 622
    /* disk I/O throttling */
    if (throttle_enabled(&cfg)) {
        if (!throttling_group) {
623
            throttling_group = id;
624 625 626 627 628
        }
        blk_io_limits_enable(blk, throttling_group);
        blk_set_io_limits(blk, &cfg);
    }

629
    blk_set_enable_write_cache(blk, !writethrough);
630
    blk_set_on_error(blk, on_read_error, on_write_error);
631

632
    if (!monitor_add_blk(blk, id, errp)) {
633 634 635 636 637
        blk_unref(blk);
        blk = NULL;
        goto err_no_bs_opts;
    }

638
err_no_bs_opts:
639
    qemu_opts_del(opts);
640 641
    QDECREF(interval_dict);
    QDECREF(interval_list);
642
    return blk;
643

644 645
early_err:
    qemu_opts_del(opts);
646 647
    QDECREF(interval_dict);
    QDECREF(interval_list);
648 649
err_no_opts:
    QDECREF(bs_opts);
650
    return NULL;
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 678 679 680 681
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 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;
    }

682 683 684 685 686
    /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
     * with other callers) rather than what we want as the real defaults.
     * Apply the defaults here instead. */
    qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
    qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
687
    qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
688

689 690 691 692
    if (runstate_check(RUN_STATE_INMIGRATE)) {
        bdrv_flags |= BDRV_O_INACTIVE;
    }

M
Max Reitz 已提交
693 694
    bs = bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
    if (!bs) {
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
        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;
}

710 711 712 713 714 715 716 717 718 719 720 721 722
void blockdev_close_all_bdrv_states(void)
{
    BlockDriverState *bs, *next_bs;

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

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

M
Max Reitz 已提交
723 724 725 726 727 728 729
/* Iterates over the list of monitor-owned BlockDriverStates */
BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
{
    return bs ? QTAILQ_NEXT(bs, monitor_list)
              : QTAILQ_FIRST(&monitor_bdrv_states);
}

730 731
static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
                            Error **errp)
732 733 734 735 736
{
    const char *value;

    value = qemu_opt_get(opts, from);
    if (value) {
737 738 739 740 741
        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;
        }
742 743 744 745
    }

    /* rename all items in opts */
    while ((value = qemu_opt_get(opts, from))) {
746
        qemu_opt_set(opts, to, value, &error_abort);
747 748 749 750
        qemu_opt_unset(opts, from);
    }
}

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

        /* Options that are passed on, but have special semantics with -drive */
        {
811
            .name = BDRV_OPT_READ_ONLY,
812 813
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
814 815 816 817 818 819 820 821
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
822 823 824 825 826 827
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },

828 829 830 831
        { /* end of list */ }
    },
};

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

852
    /* Change legacy command line options into QMP ones */
853 854 855 856 857 858 859
    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" },
860

861 862 863
        { "bps",            "throttling.bps-total" },
        { "bps_rd",         "throttling.bps-read" },
        { "bps_wr",         "throttling.bps-write" },
864

865 866 867
        { "iops_max",       "throttling.iops-total-max" },
        { "iops_rd_max",    "throttling.iops-read-max" },
        { "iops_wr_max",    "throttling.iops-write-max" },
868

869 870 871
        { "bps_max",        "throttling.bps-total-max" },
        { "bps_rd_max",     "throttling.bps-read-max" },
        { "bps_wr_max",     "throttling.bps-write-max" },
872

873
        { "iops_size",      "throttling.iops-size" },
874

875 876
        { "group",          "throttling.group" },

877
        { "readonly",       BDRV_OPT_READ_ONLY },
878 879 880
    };

    for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
881 882 883
        qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
                        &local_err);
        if (local_err) {
884
            error_report_err(local_err);
885 886
            return NULL;
        }
887
    }
888

K
Kevin Wolf 已提交
889 890 891
    value = qemu_opt_get(all_opts, "cache");
    if (value) {
        int flags = 0;
892
        bool writethrough;
K
Kevin Wolf 已提交
893

894
        if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
K
Kevin Wolf 已提交
895 896 897 898 899
            error_report("invalid cache option");
            return NULL;
        }

        /* Specific options take precedence */
900 901
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
902
                              !writethrough, &error_abort);
K
Kevin Wolf 已提交
903
        }
904 905
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
906
                              !!(flags & BDRV_O_NOCACHE), &error_abort);
K
Kevin Wolf 已提交
907
        }
908 909
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
910
                              !!(flags & BDRV_O_NO_FLUSH), &error_abort);
K
Kevin Wolf 已提交
911 912 913 914
        }
        qemu_opt_unset(all_opts, "cache");
    }

915 916 917 918
    /* Get a QDict for processing the options */
    bs_opts = qdict_new();
    qemu_opts_to_qdict(all_opts, bs_opts);

919 920
    legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
                                   &error_abort);
921
    qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
922
    if (local_err) {
923
        error_report_err(local_err);
924 925 926
        goto fail;
    }

927 928 929 930 931 932 933
    /* 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");
    }

934 935 936 937 938 939 940
    /* 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 已提交
941
            read_only = true;
942 943 944 945 946 947
        } else {
            error_report("'%s' invalid media", value);
            goto fail;
        }
    }

948
    /* copy-on-read is disabled with a warning for read-only devices */
949
    read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
950 951 952 953 954 955 956
    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;
    }

957
    qdict_put(bs_opts, BDRV_OPT_READ_ONLY,
958 959 960 961
              qstring_from_str(read_only ? "on" : "off"));
    qdict_put(bs_opts, "copy-on-read",
              qstring_from_str(copy_on_read ? "on" :"off"));

962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
    /* 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;
    }

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

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 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
    /* 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;
    }

1067 1068 1069
    /* Serial number */
    serial = qemu_opt_get(legacy_opts, "serial");

1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
    /* 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);
    }

1088 1089 1090 1091 1092 1093 1094 1095 1096
    /* 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;
1097 1098
        devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
                                   &error_abort);
1099
        if (arch_type == QEMU_ARCH_S390X) {
1100
            qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1101
        } else {
1102
            qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1103
        }
1104 1105
        qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
                     &error_abort);
1106
        if (devaddr) {
1107
            qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1108 1109 1110
        }
    }

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

1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
    /* 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));
    }

1134
    /* Actual block device init: Functionality shared with blockdev-add */
1135
    blk = blockdev_init(filename, bs_opts, &local_err);
1136
    bs_opts = NULL;
1137
    if (!blk) {
1138
        if (local_err) {
1139
            error_report_err(local_err);
1140
        }
1141
        goto fail;
1142
    } else {
1143
        assert(!local_err);
1144 1145
    }

1146 1147
    /* Create legacy DriveInfo */
    dinfo = g_malloc0(sizeof(*dinfo));
1148
    dinfo->opts = all_opts;
1149

1150 1151 1152 1153 1154
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

1155
    dinfo->type = type;
1156 1157
    dinfo->bus = bus_id;
    dinfo->unit = unit_id;
1158
    dinfo->devaddr = devaddr;
1159 1160
    dinfo->serial = g_strdup(serial);

1161 1162
    blk_set_legacy_dinfo(blk, dinfo);

1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
    switch(type) {
    case IF_IDE:
    case IF_SCSI:
    case IF_XEN:
    case IF_NONE:
        dinfo->media_cd = media == MEDIA_CDROM;
        break;
    default:
        break;
    }

1174
fail:
1175
    qemu_opts_del(legacy_opts);
1176
    QDECREF(bs_opts);
1177
    return dinfo;
1178 1179
}

1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
{
    BlockDriverState *bs;

    bs = bdrv_lookup_bs(name, name, errp);
    if (bs == NULL) {
        return NULL;
    }

    if (!bdrv_is_root_node(bs)) {
        error_setg(errp, "Need a root block node");
        return NULL;
    }

    if (!bdrv_is_inserted(bs)) {
        error_setg(errp, "Device has no medium");
        return NULL;
    }

    return bs;
}

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
static BlockBackend *qmp_get_blk(const char *blk_name, const char *qdev_id,
                                 Error **errp)
{
    BlockBackend *blk;

    if (!blk_name == !qdev_id) {
        error_setg(errp, "Need exactly one of 'device' and 'id'");
        return NULL;
    }

    if (qdev_id) {
        blk = blk_by_qdev_id(qdev_id, errp);
    } else {
        blk = blk_by_name(blk_name);
        if (blk == NULL) {
            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                      "Device '%s' not found", blk_name);
        }
    }

    return blk;
}

1225
void hmp_commit(Monitor *mon, const QDict *qdict)
1226 1227
{
    const char *device = qdict_get_str(qdict, "device");
1228
    BlockBackend *blk;
1229
    int ret;
1230

1231
    if (!strcmp(device, "all")) {
1232
        ret = blk_commit_all();
1233
    } else {
1234 1235 1236
        BlockDriverState *bs;
        AioContext *aio_context;

1237 1238
        blk = blk_by_name(device);
        if (!blk) {
1239
            monitor_printf(mon, "Device '%s' not found\n", device);
1240
            return;
1241
        }
M
Max Reitz 已提交
1242 1243 1244 1245
        if (!blk_is_available(blk)) {
            monitor_printf(mon, "Device '%s' has no medium\n", device);
            return;
        }
1246 1247 1248 1249 1250 1251 1252 1253

        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);
1254 1255 1256 1257
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
1258 1259 1260
    }
}

1261
static void blockdev_do_action(TransactionAction *action, Error **errp)
1262
{
1263
    TransactionActionList list;
1264

1265
    list.value = action;
1266
    list.next = NULL;
J
John Snow 已提交
1267
    qmp_transaction(&list, false, NULL, errp);
1268 1269
}

1270 1271 1272 1273 1274
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,
1275
                                bool has_format, const char *format,
1276
                                bool has_mode, NewImageMode mode, Error **errp)
1277
{
1278
    BlockdevSnapshotSync snapshot = {
1279
        .has_device = has_device,
1280
        .device = (char *) device,
1281 1282
        .has_node_name = has_node_name,
        .node_name = (char *) node_name,
1283
        .snapshot_file = (char *) snapshot_file,
1284 1285
        .has_snapshot_node_name = has_snapshot_node_name,
        .snapshot_node_name = (char *) snapshot_node_name,
1286 1287 1288 1289 1290
        .has_format = has_format,
        .format = (char *) format,
        .has_mode = has_mode,
        .mode = mode,
    };
1291 1292
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1293
        .u.blockdev_snapshot_sync.data = &snapshot,
1294 1295
    };
    blockdev_do_action(&action, errp);
1296 1297
}

1298 1299 1300 1301 1302 1303 1304
void qmp_blockdev_snapshot(const char *node, const char *overlay,
                           Error **errp)
{
    BlockdevSnapshot snapshot_data = {
        .node = (char *) node,
        .overlay = (char *) overlay
    };
1305 1306
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1307
        .u.blockdev_snapshot.data = &snapshot_data,
1308 1309
    };
    blockdev_do_action(&action, errp);
1310 1311
}

1312 1313 1314 1315 1316 1317 1318 1319
void qmp_blockdev_snapshot_internal_sync(const char *device,
                                         const char *name,
                                         Error **errp)
{
    BlockdevSnapshotInternal snapshot = {
        .device = (char *) device,
        .name = (char *) name
    };
1320 1321
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1322
        .u.blockdev_snapshot_internal_sync.data = &snapshot,
1323 1324
    };
    blockdev_do_action(&action, errp);
1325 1326
}

1327 1328 1329 1330 1331 1332 1333
SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
                                                         bool has_id,
                                                         const char *id,
                                                         bool has_name,
                                                         const char *name,
                                                         Error **errp)
{
1334
    BlockDriverState *bs;
1335
    AioContext *aio_context;
1336 1337 1338 1339 1340
    QEMUSnapshotInfo sn;
    Error *local_err = NULL;
    SnapshotInfo *info = NULL;
    int ret;

1341 1342
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
1343 1344
        return NULL;
    }
1345
    aio_context = bdrv_get_aio_context(bs);
M
Max Reitz 已提交
1346
    aio_context_acquire(aio_context);
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357

    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 已提交
1358
        goto out_aio_context;
1359 1360
    }

1361 1362 1363 1364
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
        goto out_aio_context;
    }

1365
    ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1366
    if (local_err) {
1367
        error_propagate(errp, local_err);
1368
        goto out_aio_context;
1369 1370 1371 1372 1373 1374
    }
    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);
1375
        goto out_aio_context;
1376 1377 1378
    }

    bdrv_snapshot_delete(bs, id, name, &local_err);
1379
    if (local_err) {
1380
        error_propagate(errp, local_err);
1381
        goto out_aio_context;
1382 1383
    }

1384 1385
    aio_context_release(aio_context);

1386
    info = g_new0(SnapshotInfo, 1);
1387 1388 1389 1390 1391 1392 1393 1394 1395
    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;
1396 1397 1398 1399

out_aio_context:
    aio_context_release(aio_context);
    return NULL;
1400
}
1401

1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
/**
 * 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;
}

1464
/* New and old BlockDriverState structs for atomic group operations */
1465

1466
typedef struct BlkActionState BlkActionState;
1467

1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
/**
 * 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 {
1483
    size_t instance_size;
1484 1485 1486 1487 1488
    void (*prepare)(BlkActionState *common, Error **errp);
    void (*commit)(BlkActionState *common);
    void (*abort)(BlkActionState *common);
    void (*clean)(BlkActionState *common);
} BlkActionOps;
1489

1490 1491 1492 1493 1494 1495
/**
 * 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 已提交
1496
 * @block_job_txn: Transaction which this action belongs to.
1497 1498 1499 1500 1501
 * @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.
1502
 */
1503
struct BlkActionState {
1504
    TransactionAction *action;
1505
    const BlkActionOps *ops;
J
John Snow 已提交
1506 1507
    BlockJobTxn *block_job_txn;
    TransactionProperties *txn_props;
1508
    QSIMPLEQ_ENTRY(BlkActionState) entry;
1509 1510
};

1511 1512
/* internal snapshot private data */
typedef struct InternalSnapshotState {
1513
    BlkActionState common;
1514
    BlockDriverState *bs;
1515
    AioContext *aio_context;
1516
    QEMUSnapshotInfo sn;
1517
    bool created;
1518 1519
} InternalSnapshotState;

J
John Snow 已提交
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533

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

1534
static void internal_snapshot_prepare(BlkActionState *common,
1535 1536
                                      Error **errp)
{
1537
    Error *local_err = NULL;
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
    const char *device;
    const char *name;
    BlockDriverState *bs;
    QEMUSnapshotInfo old_sn, *sn;
    bool ret;
    qemu_timeval tv;
    BlockdevSnapshotInternal *internal;
    InternalSnapshotState *state;
    int ret1;

1548
    g_assert(common->action->type ==
1549
             TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1550
    internal = common->action->u.blockdev_snapshot_internal_sync.data;
1551 1552 1553 1554 1555 1556 1557
    state = DO_UPCAST(InternalSnapshotState, common, common);

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

    /* 2. check for validation */
J
John Snow 已提交
1558 1559 1560 1561
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1562 1563
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
1564 1565 1566
        return;
    }

1567
    /* AioContext is released in .clean() */
1568
    state->aio_context = bdrv_get_aio_context(bs);
1569 1570
    aio_context_acquire(state->aio_context);

1571 1572 1573
    state->bs = bs;
    bdrv_drained_begin(bs);

1574 1575 1576 1577
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
        return;
    }

1578
    if (bdrv_is_read_only(bs)) {
1579
        error_setg(errp, "Device '%s' is read only", device);
1580 1581 1582 1583
        return;
    }

    if (!bdrv_can_snapshot(bs)) {
1584 1585 1586
        error_setg(errp, "Block format '%s' used by device '%s' "
                   "does not support internal snapshots",
                   bs->drv->format_name, device);
1587 1588 1589 1590 1591 1592 1593 1594 1595
        return;
    }

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

    /* check whether a snapshot with name exist */
1596 1597 1598 1599
    ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
                                            &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
        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 */
1625
    state->created = true;
1626 1627
}

1628
static void internal_snapshot_abort(BlkActionState *common)
1629 1630 1631 1632 1633 1634 1635
{
    InternalSnapshotState *state =
                             DO_UPCAST(InternalSnapshotState, common, common);
    BlockDriverState *bs = state->bs;
    QEMUSnapshotInfo *sn = &state->sn;
    Error *local_error = NULL;

1636
    if (!state->created) {
1637 1638 1639 1640
        return;
    }

    if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1641 1642 1643 1644 1645
        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));
1646 1647 1648
    }
}

1649
static void internal_snapshot_clean(BlkActionState *common)
1650 1651 1652 1653 1654
{
    InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
                                             common, common);

    if (state->aio_context) {
1655 1656 1657
        if (state->bs) {
            bdrv_drained_end(state->bs);
        }
1658 1659 1660 1661
        aio_context_release(state->aio_context);
    }
}

1662
/* external snapshot private data */
1663
typedef struct ExternalSnapshotState {
1664
    BlkActionState common;
1665 1666
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1667
    AioContext *aio_context;
1668
} ExternalSnapshotState;
1669

1670
static void external_snapshot_prepare(BlkActionState *common,
1671 1672
                                      Error **errp)
{
M
Max Reitz 已提交
1673
    int flags = 0;
1674
    QDict *options = NULL;
1675
    Error *local_err = NULL;
1676
    /* Device and node name of the image to generate the snapshot from */
1677
    const char *device;
1678
    const char *node_name;
1679 1680 1681
    /* Reference to the new image (for 'blockdev-snapshot') */
    const char *snapshot_ref;
    /* File name of the new image (for 'blockdev-snapshot-sync') */
1682
    const char *new_image_file;
1683 1684
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1685
    TransactionAction *action = common->action;
1686

1687 1688 1689 1690 1691
    /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
     * purpose but a different set of parameters */
    switch (action->type) {
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
        {
1692
            BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1693 1694 1695 1696 1697 1698 1699 1700
            device = s->node;
            node_name = s->node;
            new_image_file = NULL;
            snapshot_ref = s->overlay;
        }
        break;
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
        {
1701
            BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1702 1703 1704 1705 1706 1707 1708 1709
            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();
1710 1711 1712
    }

    /* start processing */
J
John Snow 已提交
1713 1714 1715 1716
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1717 1718
    state->old_bs = bdrv_lookup_bs(device, node_name, errp);
    if (!state->old_bs) {
1719 1720 1721
        return;
    }

1722 1723 1724
    /* 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);
1725
    bdrv_drained_begin(state->old_bs);
1726

1727
    if (!bdrv_is_inserted(state->old_bs)) {
1728
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1729 1730 1731
        return;
    }

1732 1733
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1734 1735 1736
        return;
    }

1737 1738
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1739
            error_setg(errp, QERR_IO_ERROR);
1740 1741 1742 1743
            return;
        }
    }

1744
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1745
        error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1746 1747 1748
        return;
    }

1749
    if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1750
        BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1751 1752 1753 1754
        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;
1755

1756 1757
        if (node_name && !snapshot_node_name) {
            error_setg(errp, "New snapshot node name missing");
1758 1759 1760
            return;
        }

1761 1762 1763 1764 1765 1766 1767
        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;
1768
        flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1769 1770 1771 1772

        /* create new image w/backing file */
        mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
        if (mode != NEW_IMAGE_MODE_EXISTING) {
1773 1774 1775 1776 1777
            int64_t size = bdrv_getlength(state->old_bs);
            if (size < 0) {
                error_setg_errno(errp, -size, "bdrv_getlength failed");
                return;
            }
1778 1779 1780
            bdrv_img_create(new_image_file, format,
                            state->old_bs->filename,
                            state->old_bs->drv->format_name,
1781
                            NULL, size, flags, &local_err, false);
1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
            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;
1796 1797
    }

M
Max Reitz 已提交
1798 1799
    state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
                              errp);
1800
    /* We will manually add the backing_hd field to the bs later */
M
Max Reitz 已提交
1801
    if (!state->new_bs) {
1802 1803 1804
        return;
    }

K
Kevin Wolf 已提交
1805
    if (bdrv_has_blk(state->new_bs)) {
1806
        error_setg(errp, "The snapshot is already in use by %s",
K
Kevin Wolf 已提交
1807
                   bdrv_get_parent_name(state->new_bs));
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817
        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");
1818 1819 1820 1821 1822
        return;
    }

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

1826
static void external_snapshot_commit(BlkActionState *common)
1827
{
1828 1829
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1830

1831 1832
    bdrv_set_aio_context(state->new_bs, state->aio_context);

1833 1834
    /* This removes our old bs and adds the new bs */
    bdrv_append(state->new_bs, state->old_bs);
1835 1836 1837
    /* 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 */
1838 1839 1840 1841
    if (!state->old_bs->copy_on_read) {
        bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
                    NULL);
    }
1842 1843
}

1844
static void external_snapshot_abort(BlkActionState *common)
1845
{
1846 1847 1848
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
F
Fam Zheng 已提交
1849
        bdrv_unref(state->new_bs);
1850
    }
1851 1852
}

1853
static void external_snapshot_clean(BlkActionState *common)
1854 1855 1856
{
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1857
    if (state->aio_context) {
1858
        bdrv_drained_end(state->old_bs);
1859 1860
        aio_context_release(state->aio_context);
    }
1861 1862
}

1863
typedef struct DriveBackupState {
1864
    BlkActionState common;
1865
    BlockDriverState *bs;
1866
    AioContext *aio_context;
1867 1868 1869
    BlockJob *job;
} DriveBackupState;

P
Pavel Butsykin 已提交
1870 1871
static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn,
                            Error **errp);
1872

1873
static void drive_backup_prepare(BlkActionState *common, Error **errp)
1874 1875
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1876
    BlockDriverState *bs;
1877 1878 1879
    DriveBackup *backup;
    Error *local_err = NULL;

1880
    assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1881
    backup = common->action->u.drive_backup.data;
1882

1883 1884
    bs = qmp_get_root_bs(backup->device, errp);
    if (!bs) {
1885 1886 1887
        return;
    }

1888
    /* AioContext is released in .clean() */
1889
    state->aio_context = bdrv_get_aio_context(bs);
1890
    aio_context_acquire(state->aio_context);
1891 1892
    bdrv_drained_begin(bs);
    state->bs = bs;
1893

P
Pavel Butsykin 已提交
1894
    do_drive_backup(backup, common->block_job_txn, &local_err);
1895
    if (local_err) {
1896 1897 1898 1899 1900 1901 1902
        error_propagate(errp, local_err);
        return;
    }

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

1903
static void drive_backup_abort(BlkActionState *common)
1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
{
    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);
    }
}

1914
static void drive_backup_clean(BlkActionState *common)
1915 1916 1917 1918
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);

    if (state->aio_context) {
1919
        bdrv_drained_end(state->bs);
1920 1921 1922 1923
        aio_context_release(state->aio_context);
    }
}

1924
typedef struct BlockdevBackupState {
1925
    BlkActionState common;
1926 1927 1928 1929 1930
    BlockDriverState *bs;
    BlockJob *job;
    AioContext *aio_context;
} BlockdevBackupState;

P
Pavel Butsykin 已提交
1931 1932
static void do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn,
                               Error **errp);
1933

1934
static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1935 1936 1937
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
    BlockdevBackup *backup;
1938
    BlockDriverState *bs, *target;
1939 1940
    Error *local_err = NULL;

1941
    assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1942
    backup = common->action->u.blockdev_backup.data;
1943

1944 1945
    bs = qmp_get_root_bs(backup->device, errp);
    if (!bs) {
1946 1947 1948
        return;
    }

1949
    target = bdrv_lookup_bs(backup->target, backup->target, errp);
M
Max Reitz 已提交
1950
    if (!target) {
1951 1952 1953 1954
        return;
    }

    /* AioContext is released in .clean() */
1955
    state->aio_context = bdrv_get_aio_context(bs);
1956
    if (state->aio_context != bdrv_get_aio_context(target)) {
1957 1958 1959 1960 1961
        state->aio_context = NULL;
        error_setg(errp, "Backup between two IO threads is not implemented");
        return;
    }
    aio_context_acquire(state->aio_context);
1962
    state->bs = bs;
1963
    bdrv_drained_begin(state->bs);
1964

P
Pavel Butsykin 已提交
1965
    do_blockdev_backup(backup, common->block_job_txn, &local_err);
1966 1967 1968 1969 1970 1971 1972 1973
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

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

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

1985
static void blockdev_backup_clean(BlkActionState *common)
1986 1987 1988 1989
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);

    if (state->aio_context) {
1990
        bdrv_drained_end(state->bs);
1991 1992 1993 1994
        aio_context_release(state->aio_context);
    }
}

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

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

J
John Snow 已提交
2012 2013 2014 2015
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

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

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

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

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

J
John Snow 已提交
2051 2052 2053 2054
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

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

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

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

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

    hbitmap_free(state->backup);
}

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

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

2103
static void abort_prepare(BlkActionState *common, Error **errp)
2104 2105 2106 2107
{
    error_setg(errp, "Transaction aborted using Abort action");
}

2108
static void abort_commit(BlkActionState *common)
2109
{
2110
    g_assert_not_reached(); /* this action never succeeds */
2111 2112
}

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

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

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

2198
    QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2199 2200
    QSIMPLEQ_INIT(&snap_bdrv_states);

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

2209
    /* drain all i/o before any operations */
2210 2211
    bdrv_drain_all();

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

2217 2218 2219
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

2220
        assert(dev_info->type < ARRAY_SIZE(actions));
2221

2222
        ops = &actions[dev_info->type];
2223 2224
        assert(ops->instance_size > 0);

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

2232
        state->ops->prepare(state, &local_err);
2233
        if (local_err) {
2234 2235
            error_propagate(errp, local_err);
            goto delete_and_fail;
2236 2237 2238
        }
    }

2239
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2240 2241 2242
        if (state->ops->commit) {
            state->ops->commit(state);
        }
2243 2244 2245 2246 2247 2248
    }

    /* success */
    goto exit;

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

2268 2269 2270
void qmp_eject(bool has_device, const char *device,
               bool has_id, const char *id,
               bool has_force, bool force, Error **errp)
2271
{
2272
    Error *local_err = NULL;
2273 2274 2275 2276 2277
    int rc;

    if (!has_force) {
        force = false;
    }
2278

2279 2280 2281
    rc = do_open_tray(has_device ? device : NULL,
                      has_id ? id : NULL,
                      force, &local_err);
2282
    if (rc && rc != -ENOSYS) {
2283
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2284
        return;
2285
    }
2286
    error_free(local_err);
2287

2288
    qmp_x_blockdev_remove_medium(has_device, device, has_id, id, errp);
2289 2290
}

2291 2292 2293
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
2294
{
2295
    Error *local_err = NULL;
2296
    BlockDriverState *bs;
2297
    AioContext *aio_context;
2298

2299 2300 2301
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2302
    if (local_err) {
2303
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2304
        return;
2305 2306
    }

2307 2308 2309
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2310
    bdrv_add_key(bs, password, errp);
2311 2312

    aio_context_release(aio_context);
2313 2314
}

2315 2316 2317 2318 2319 2320 2321 2322 2323 2324
/*
 * Attempt to open the tray of @device.
 * If @force, ignore its tray lock.
 * Else, if the tray is locked, don't open it, but ask the guest to open it.
 * On error, store an error through @errp and return -errno.
 * If @device does not exist, return -ENODEV.
 * If it has no removable media, return -ENOTSUP.
 * If it has no tray, return -ENOSYS.
 * If the guest was asked to open the tray, return -EINPROGRESS.
 * Else, return 0.
2325
 */
2326 2327
static int do_open_tray(const char *blk_name, const char *qdev_id,
                        bool force, Error **errp)
M
Max Reitz 已提交
2328 2329
{
    BlockBackend *blk;
2330
    const char *device = qdev_id ?: blk_name;
M
Max Reitz 已提交
2331 2332
    bool locked;

2333
    blk = qmp_get_blk(blk_name, qdev_id, errp);
M
Max Reitz 已提交
2334
    if (!blk) {
2335
        return -ENODEV;
M
Max Reitz 已提交
2336 2337 2338 2339
    }

    if (!blk_dev_has_removable_media(blk)) {
        error_setg(errp, "Device '%s' is not removable", device);
2340
        return -ENOTSUP;
M
Max Reitz 已提交
2341 2342
    }

2343
    if (!blk_dev_has_tray(blk)) {
2344 2345
        error_setg(errp, "Device '%s' does not have a tray", device);
        return -ENOSYS;
2346 2347
    }

M
Max Reitz 已提交
2348
    if (blk_dev_is_tray_open(blk)) {
2349
        return 0;
M
Max Reitz 已提交
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
    }

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

    if (locked && !force) {
2362 2363 2364
        error_setg(errp, "Device '%s' is locked and force was not specified, "
                   "wait for tray to open and try again", device);
        return -EINPROGRESS;
2365 2366 2367 2368 2369
    }

    return 0;
}

2370 2371 2372
void qmp_blockdev_open_tray(bool has_device, const char *device,
                            bool has_id, const char *id,
                            bool has_force, bool force,
2373 2374
                            Error **errp)
{
2375 2376 2377
    Error *local_err = NULL;
    int rc;

2378 2379 2380
    if (!has_force) {
        force = false;
    }
2381 2382 2383
    rc = do_open_tray(has_device ? device : NULL,
                      has_id ? id : NULL,
                      force, &local_err);
2384 2385 2386 2387 2388
    if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
        error_propagate(errp, local_err);
        return;
    }
    error_free(local_err);
M
Max Reitz 已提交
2389 2390
}

2391 2392 2393
void qmp_blockdev_close_tray(bool has_device, const char *device,
                             bool has_id, const char *id,
                             Error **errp)
M
Max Reitz 已提交
2394 2395 2396
{
    BlockBackend *blk;

2397 2398 2399 2400
    device = has_device ? device : NULL;
    id = has_id ? id : NULL;

    blk = qmp_get_blk(device, id, errp);
M
Max Reitz 已提交
2401 2402 2403 2404 2405
    if (!blk) {
        return;
    }

    if (!blk_dev_has_removable_media(blk)) {
2406
        error_setg(errp, "Device '%s' is not removable", device ?: id);
M
Max Reitz 已提交
2407 2408 2409
        return;
    }

2410 2411 2412 2413 2414
    if (!blk_dev_has_tray(blk)) {
        /* Ignore this command on tray-less devices */
        return;
    }

M
Max Reitz 已提交
2415 2416 2417 2418 2419 2420 2421
    if (!blk_dev_is_tray_open(blk)) {
        return;
    }

    blk_dev_change_media_cb(blk, true);
}

2422 2423
void qmp_x_blockdev_remove_medium(bool has_device, const char *device,
                                  bool has_id, const char *id, Error **errp)
M
Max Reitz 已提交
2424 2425 2426 2427
{
    BlockBackend *blk;
    BlockDriverState *bs;
    AioContext *aio_context;
2428
    bool has_attached_device;
M
Max Reitz 已提交
2429

2430 2431 2432 2433
    device = has_device ? device : NULL;
    id = has_id ? id : NULL;

    blk = qmp_get_blk(device, id, errp);
M
Max Reitz 已提交
2434 2435 2436 2437 2438
    if (!blk) {
        return;
    }

    /* For BBs without a device, we can exchange the BDS tree at will */
2439
    has_attached_device = blk_get_attached_dev(blk);
M
Max Reitz 已提交
2440

2441 2442
    if (has_attached_device && !blk_dev_has_removable_media(blk)) {
        error_setg(errp, "Device '%s' is not removable", device ?: id);
M
Max Reitz 已提交
2443 2444 2445
        return;
    }

2446 2447 2448 2449
    if (has_attached_device && blk_dev_has_tray(blk) &&
        !blk_dev_is_tray_open(blk))
    {
        error_setg(errp, "Tray of device '%s' is not open", device ?: id);
M
Max Reitz 已提交
2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466
        return;
    }

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

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

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

    blk_remove_bs(blk);

2467 2468 2469 2470 2471 2472 2473 2474
    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 已提交
2475 2476 2477 2478
out:
    aio_context_release(aio_context);
}

2479
static void qmp_blockdev_insert_anon_medium(BlockBackend *blk,
M
Max Reitz 已提交
2480 2481 2482 2483 2484 2485 2486 2487
                                            BlockDriverState *bs, Error **errp)
{
    bool has_device;

    /* 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)) {
2488
        error_setg(errp, "Device is not removable");
M
Max Reitz 已提交
2489 2490 2491
        return;
    }

2492
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2493
        error_setg(errp, "Tray of the device is not open");
M
Max Reitz 已提交
2494 2495 2496 2497
        return;
    }

    if (blk_bs(blk)) {
2498
        error_setg(errp, "There already is a medium in the device");
M
Max Reitz 已提交
2499 2500 2501 2502 2503
        return;
    }

    blk_insert_bs(blk, bs);

2504 2505 2506 2507 2508 2509 2510 2511
    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 已提交
2512 2513
}

2514 2515 2516
void qmp_x_blockdev_insert_medium(bool has_device, const char *device,
                                  bool has_id, const char *id,
                                  const char *node_name, Error **errp)
M
Max Reitz 已提交
2517
{
2518
    BlockBackend *blk;
M
Max Reitz 已提交
2519 2520
    BlockDriverState *bs;

2521 2522 2523 2524 2525 2526 2527
    blk = qmp_get_blk(has_device ? device : NULL,
                      has_id ? id : NULL,
                      errp);
    if (!blk) {
        return;
    }

M
Max Reitz 已提交
2528 2529 2530 2531 2532 2533
    bs = bdrv_find_node(node_name);
    if (!bs) {
        error_setg(errp, "Node '%s' not found", node_name);
        return;
    }

K
Kevin Wolf 已提交
2534
    if (bdrv_has_blk(bs)) {
M
Max Reitz 已提交
2535
        error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
K
Kevin Wolf 已提交
2536
                   bdrv_get_parent_name(bs));
M
Max Reitz 已提交
2537 2538 2539
        return;
    }

2540
    qmp_blockdev_insert_anon_medium(blk, bs, errp);
M
Max Reitz 已提交
2541 2542
}

2543 2544 2545
void qmp_blockdev_change_medium(bool has_device, const char *device,
                                bool has_id, const char *id,
                                const char *filename,
M
Max Reitz 已提交
2546
                                bool has_format, const char *format,
2547 2548
                                bool has_read_only,
                                BlockdevChangeReadOnlyMode read_only,
M
Max Reitz 已提交
2549
                                Error **errp)
2550 2551 2552
{
    BlockBackend *blk;
    BlockDriverState *medium_bs = NULL;
M
Max Reitz 已提交
2553
    int bdrv_flags;
2554
    int rc;
2555 2556 2557
    QDict *options = NULL;
    Error *err = NULL;

2558 2559 2560
    blk = qmp_get_blk(has_device ? device : NULL,
                      has_id ? id : NULL,
                      errp);
2561 2562 2563 2564 2565 2566 2567 2568 2569
    if (!blk) {
        goto fail;
    }

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

    bdrv_flags = blk_get_open_flags_from_root_state(blk);
2570 2571
    bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
        BDRV_O_PROTOCOL);
2572

2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592
    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 已提交
2593
    if (has_format) {
2594 2595 2596 2597
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(format));
    }

M
Max Reitz 已提交
2598 2599
    medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
    if (!medium_bs) {
2600 2601 2602 2603 2604 2605 2606 2607 2608
        goto fail;
    }

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

2609 2610 2611
    rc = do_open_tray(has_device ? device : NULL,
                      has_id ? id : NULL,
                      false, &err);
2612
    if (rc && rc != -ENOSYS) {
2613 2614 2615
        error_propagate(errp, err);
        goto fail;
    }
2616 2617
    error_free(err);
    err = NULL;
2618

2619
    qmp_x_blockdev_remove_medium(has_device, device, has_id, id, errp);
2620 2621 2622 2623 2624
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

2625
    qmp_blockdev_insert_anon_medium(blk, medium_bs, &err);
2626 2627 2628 2629 2630
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

2631 2632
    blk_apply_root_state(blk, medium_bs);

2633
    qmp_blockdev_close_tray(has_device, device, has_id, id, errp);
2634 2635 2636 2637 2638 2639 2640 2641

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 已提交
2642
/* throttling disk I/O limits */
2643
void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
Z
Zhi Yong Wu 已提交
2644
{
2645
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
2646
    BlockDriverState *bs;
2647
    BlockBackend *blk;
2648
    AioContext *aio_context;
Z
Zhi Yong Wu 已提交
2649

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

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

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

2666
    throttle_config_init(&cfg);
2667 2668 2669
    cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
    cfg.buckets[THROTTLE_BPS_READ].avg  = arg->bps_rd;
    cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2670

2671 2672 2673
    cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
    cfg.buckets[THROTTLE_OPS_READ].avg  = arg->iops_rd;
    cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2674

2675 2676
    if (arg->has_bps_max) {
        cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2677
    }
2678 2679
    if (arg->has_bps_rd_max) {
        cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2680
    }
2681 2682
    if (arg->has_bps_wr_max) {
        cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2683
    }
2684 2685
    if (arg->has_iops_max) {
        cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2686
    }
2687 2688
    if (arg->has_iops_rd_max) {
        cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2689
    }
2690 2691
    if (arg->has_iops_wr_max) {
        cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2692
    }
Z
Zhi Yong Wu 已提交
2693

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

2713 2714
    if (arg->has_iops_size) {
        cfg.op_size = arg->iops_size;
2715
    }
2716

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

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

M
Max Reitz 已提交
2737
out:
2738
    aio_context_release(aio_context);
Z
Zhi Yong Wu 已提交
2739 2740
}

2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789
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 已提交
2790 2791 2792 2793 2794 2795
    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be removed",
                   name);
        goto out;
    }
2796
    bdrv_dirty_bitmap_make_anon(bitmap);
2797 2798
    bdrv_release_dirty_bitmap(bs, bitmap);

J
John Snow 已提交
2799
 out:
2800 2801 2802
    aio_context_release(aio_context);
}

J
John Snow 已提交
2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
/**
 * 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 已提交
2831
    bdrv_clear_dirty_bitmap(bitmap, NULL);
J
John Snow 已提交
2832 2833 2834 2835 2836

 out:
    aio_context_release(aio_context);
}

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

2845 2846 2847 2848 2849 2850 2851 2852 2853
    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;
    }

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

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

M
Max Reitz 已提交
2866
    aio_context = blk_get_aio_context(blk);
2867 2868
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
2869 2870 2871 2872 2873 2874 2875
    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;
        }
2876

2877
        blk_remove_bs(blk);
M
Max Reitz 已提交
2878
    }
2879

2880
    /* Make the BlockBackend and the attached BlockDriverState anonymous */
2881 2882
    monitor_remove_blk(blk);

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

2894
    aio_context_release(aio_context);
2895
}
2896

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

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

2914 2915 2916
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2917
    if (!bdrv_is_first_non_filter(bs)) {
2918
        error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2919
        goto out;
2920 2921 2922
    }

    if (size < 0) {
2923
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2924
        goto out;
2925 2926
    }

2927
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2928
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2929
        goto out;
2930 2931
    }

2932 2933 2934
    /* complete all in-flight operations before resizing the device */
    bdrv_drain_all();

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

out:
    aio_context_release(aio_context);
2958
}
S
Stefan Hajnoczi 已提交
2959

2960
static void block_job_cb(void *opaque, int ret)
S
Stefan Hajnoczi 已提交
2961
{
2962 2963 2964 2965 2966
    /* 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 已提交
2967
    BlockDriverState *bs = opaque;
2968
    const char *msg = NULL;
S
Stefan Hajnoczi 已提交
2969

2970
    trace_block_job_cb(bs, bs->job, ret);
S
Stefan Hajnoczi 已提交
2971 2972

    assert(bs->job);
2973

S
Stefan Hajnoczi 已提交
2974
    if (ret < 0) {
2975
        msg = strerror(-ret);
S
Stefan Hajnoczi 已提交
2976 2977
    }

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

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

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

3002 3003
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
S
Stefan Hajnoczi 已提交
3004 3005 3006
        return;
    }

3007
    aio_context = bdrv_get_aio_context(bs);
3008 3009
    aio_context_acquire(aio_context);

3010
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
3011
        goto out;
3012 3013
    }

3014
    if (has_base) {
3015 3016
        base_bs = bdrv_find_backing_image(bs, base);
        if (base_bs == NULL) {
3017
            error_setg(errp, QERR_BASE_NOT_FOUND, base);
3018
            goto out;
3019
        }
3020
        assert(bdrv_get_aio_context(base_bs) == aio_context);
3021
        base_name = base;
S
Stefan Hajnoczi 已提交
3022 3023
    }

3024 3025 3026 3027 3028
    /* 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");
3029
        goto out;
3030 3031 3032 3033 3034
    }

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

3035 3036
    stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
                 has_speed ? speed : 0, on_error, block_job_cb, bs, &local_err);
3037
    if (local_err) {
3038
        error_propagate(errp, local_err);
3039
        goto out;
S
Stefan Hajnoczi 已提交
3040 3041 3042
    }

    trace_qmp_block_stream(bs, bs->job);
3043 3044 3045

out:
    aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
3046
}
3047

3048
void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3049 3050
                      bool has_base, const char *base,
                      bool has_top, const char *top,
3051
                      bool has_backing_file, const char *backing_file,
3052 3053 3054 3055 3056
                      bool has_speed, int64_t speed,
                      Error **errp)
{
    BlockDriverState *bs;
    BlockDriverState *base_bs, *top_bs;
3057
    AioContext *aio_context;
3058 3059 3060 3061
    Error *local_err = NULL;
    /* This will be part of the QMP command, if/when the
     * BlockdevOnError change for blkmirror makes it in
     */
3062
    BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3063

3064 3065 3066 3067
    if (!has_speed) {
        speed = 0;
    }

3068 3069 3070 3071 3072
    /* 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. */
3073 3074 3075 3076 3077 3078 3079 3080 3081 3082
    bs = qmp_get_root_bs(device, &local_err);
    if (!bs) {
        bs = bdrv_lookup_bs(device, device, NULL);
        if (!bs) {
            error_free(local_err);
            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                      "Device '%s' not found", device);
        } else {
            error_propagate(errp, local_err);
        }
3083
        return;
3084 3085
    }

3086
    aio_context = bdrv_get_aio_context(bs);
3087 3088
    aio_context_acquire(aio_context);

3089
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3090
        goto out;
3091 3092 3093 3094 3095
    }

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

3096
    if (has_top && top) {
3097 3098 3099 3100 3101 3102 3103
        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");
3104
        goto out;
3105 3106
    }

3107 3108
    assert(bdrv_get_aio_context(top_bs) == aio_context);

3109 3110 3111 3112 3113 3114 3115
    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) {
3116
        error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3117
        goto out;
3118 3119
    }

3120 3121
    assert(bdrv_get_aio_context(base_bs) == aio_context);

3122 3123 3124 3125
    if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
        goto out;
    }

3126 3127 3128
    /* Do not allow attempts to commit an image into itself */
    if (top_bs == base_bs) {
        error_setg(errp, "cannot commit an image into itself");
3129
        goto out;
3130 3131
    }

F
Fam Zheng 已提交
3132
    if (top_bs == bs) {
3133 3134 3135
        if (has_backing_file) {
            error_setg(errp, "'backing-file' specified,"
                             " but 'top' is the active layer");
3136
            goto out;
3137
        }
3138
        commit_active_start(has_job_id ? job_id : NULL, bs, base_bs, speed,
3139
                            on_error, block_job_cb, bs, &local_err, false);
F
Fam Zheng 已提交
3140
    } else {
3141 3142
        commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, speed,
                     on_error, block_job_cb, bs,
3143
                     has_backing_file ? backing_file : NULL, &local_err);
F
Fam Zheng 已提交
3144
    }
3145 3146
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3147
        goto out;
3148
    }
3149 3150 3151

out:
    aio_context_release(aio_context);
3152 3153
}

P
Pavel Butsykin 已提交
3154
static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn, Error **errp)
3155 3156 3157
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
3158
    BlockDriverState *source = NULL;
3159
    BdrvDirtyBitmap *bmap = NULL;
3160
    AioContext *aio_context;
3161
    QDict *options = NULL;
3162 3163 3164 3165
    Error *local_err = NULL;
    int flags;
    int64_t size;

P
Pavel Butsykin 已提交
3166 3167
    if (!backup->has_speed) {
        backup->speed = 0;
3168
    }
P
Pavel Butsykin 已提交
3169 3170
    if (!backup->has_on_source_error) {
        backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3171
    }
P
Pavel Butsykin 已提交
3172 3173
    if (!backup->has_on_target_error) {
        backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3174
    }
P
Pavel Butsykin 已提交
3175 3176 3177 3178 3179
    if (!backup->has_mode) {
        backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
    if (!backup->has_job_id) {
        backup->job_id = NULL;
3180
    }
3181 3182 3183
    if (!backup->has_compress) {
        backup->compress = false;
    }
3184

P
Pavel Butsykin 已提交
3185
    bs = qmp_get_root_bs(backup->device, errp);
3186
    if (!bs) {
3187 3188 3189
        return;
    }

3190
    aio_context = bdrv_get_aio_context(bs);
3191 3192
    aio_context_acquire(aio_context);

P
Pavel Butsykin 已提交
3193 3194 3195
    if (!backup->has_format) {
        backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
                         NULL : (char*) bs->drv->format_name;
3196 3197
    }

F
Fam Zheng 已提交
3198
    /* Early check to avoid creating target */
3199
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3200
        goto out;
3201 3202
    }

K
Kevin Wolf 已提交
3203
    flags = bs->open_flags | BDRV_O_RDWR;
3204

3205 3206
    /* See if we have a backing HD we can use to create our new image
     * on top of. */
P
Pavel Butsykin 已提交
3207
    if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3208
        source = backing_bs(bs);
3209
        if (!source) {
P
Pavel Butsykin 已提交
3210
            backup->sync = MIRROR_SYNC_MODE_FULL;
3211 3212
        }
    }
P
Pavel Butsykin 已提交
3213
    if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3214 3215 3216
        source = bs;
    }

3217 3218 3219
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3220
        goto out;
3221 3222
    }

P
Pavel Butsykin 已提交
3223 3224
    if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
        assert(backup->format);
3225
        if (source) {
P
Pavel Butsykin 已提交
3226
            bdrv_img_create(backup->target, backup->format, source->filename,
3227 3228 3229
                            source->drv->format_name, NULL,
                            size, flags, &local_err, false);
        } else {
P
Pavel Butsykin 已提交
3230
            bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3231 3232
                            size, flags, &local_err, false);
        }
3233 3234
    }

3235
    if (local_err) {
3236
        error_propagate(errp, local_err);
3237
        goto out;
3238 3239
    }

P
Pavel Butsykin 已提交
3240
    if (backup->format) {
3241
        options = qdict_new();
P
Pavel Butsykin 已提交
3242
        qdict_put(options, "driver", qstring_from_str(backup->format));
3243 3244
    }

P
Pavel Butsykin 已提交
3245
    target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
M
Max Reitz 已提交
3246
    if (!target_bs) {
3247
        goto out;
3248 3249
    }

3250 3251
    bdrv_set_aio_context(target_bs, aio_context);

P
Pavel Butsykin 已提交
3252 3253
    if (backup->has_bitmap) {
        bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3254
        if (!bmap) {
P
Pavel Butsykin 已提交
3255
            error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3256
            bdrv_unref(target_bs);
3257 3258 3259 3260
            goto out;
        }
    }

P
Pavel Butsykin 已提交
3261
    backup_start(backup->job_id, bs, target_bs, backup->speed, backup->sync,
3262 3263
                 bmap, backup->compress, backup->on_source_error,
                 backup->on_target_error, block_job_cb, bs, txn, &local_err);
K
Kevin Wolf 已提交
3264
    bdrv_unref(target_bs);
3265 3266
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3267
        goto out;
3268
    }
3269 3270 3271

out:
    aio_context_release(aio_context);
3272 3273
}

P
Pavel Butsykin 已提交
3274
void qmp_drive_backup(DriveBackup *arg, Error **errp)
3275
{
P
Pavel Butsykin 已提交
3276
    return do_drive_backup(arg, NULL, errp);
3277 3278
}

3279 3280
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
3281
    return bdrv_named_nodes_list(errp);
3282 3283
}

P
Pavel Butsykin 已提交
3284
void do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn, Error **errp)
F
Fam Zheng 已提交
3285 3286 3287 3288 3289 3290
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
    Error *local_err = NULL;
    AioContext *aio_context;

P
Pavel Butsykin 已提交
3291 3292
    if (!backup->has_speed) {
        backup->speed = 0;
F
Fam Zheng 已提交
3293
    }
P
Pavel Butsykin 已提交
3294 3295 3296 3297 3298
    if (!backup->has_on_source_error) {
        backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!backup->has_on_target_error) {
        backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
F
Fam Zheng 已提交
3299
    }
P
Pavel Butsykin 已提交
3300 3301
    if (!backup->has_job_id) {
        backup->job_id = NULL;
F
Fam Zheng 已提交
3302
    }
3303 3304 3305
    if (!backup->has_compress) {
        backup->compress = false;
    }
F
Fam Zheng 已提交
3306

P
Pavel Butsykin 已提交
3307
    bs = qmp_get_root_bs(backup->device, errp);
3308
    if (!bs) {
F
Fam Zheng 已提交
3309 3310 3311
        return;
    }

3312
    aio_context = bdrv_get_aio_context(bs);
F
Fam Zheng 已提交
3313 3314
    aio_context_acquire(aio_context);

P
Pavel Butsykin 已提交
3315
    target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
3316
    if (!target_bs) {
M
Max Reitz 已提交
3317 3318
        goto out;
    }
F
Fam Zheng 已提交
3319

3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330
    if (bdrv_get_aio_context(target_bs) != aio_context) {
        if (!bdrv_has_blk(target_bs)) {
            /* The target BDS is not attached, we can safely move it to another
             * AioContext. */
            bdrv_set_aio_context(target_bs, aio_context);
        } else {
            error_setg(errp, "Target is attached to a different thread from "
                             "source.");
            goto out;
        }
    }
P
Pavel Butsykin 已提交
3331
    backup_start(backup->job_id, bs, target_bs, backup->speed, backup->sync,
3332 3333
                 NULL, backup->compress, backup->on_source_error,
                 backup->on_target_error, block_job_cb, bs, txn, &local_err);
F
Fam Zheng 已提交
3334 3335 3336 3337 3338 3339 3340
    if (local_err != NULL) {
        error_propagate(errp, local_err);
    }
out:
    aio_context_release(aio_context);
}

P
Pavel Butsykin 已提交
3341 3342 3343
void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
{
    do_blockdev_backup(arg, NULL, errp);
3344 3345
}

3346 3347 3348
/* Parameter check and block job starting for drive mirroring.
 * Caller should hold @device and @target's aio context (must be the same).
 **/
3349
static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3350 3351 3352
                                   BlockDriverState *target,
                                   bool has_replaces, const char *replaces,
                                   enum MirrorSyncMode sync,
M
Max Reitz 已提交
3353
                                   BlockMirrorBackingMode backing_mode,
3354 3355 3356 3357 3358 3359 3360 3361 3362
                                   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 已提交
3363 3364 3365 3366 3367
{

    if (!has_speed) {
        speed = 0;
    }
3368 3369 3370 3371 3372 3373
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
3374 3375 3376
    if (!has_granularity) {
        granularity = 0;
    }
3377
    if (!has_buf_size) {
W
Wen Congyang 已提交
3378
        buf_size = 0;
3379
    }
3380 3381 3382
    if (!has_unmap) {
        unmap = true;
    }
3383

3384
    if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3385 3386
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "a value in range [512B, 64MB]");
3387 3388 3389
        return;
    }
    if (granularity & (granularity - 1)) {
3390 3391
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "power of 2");
3392 3393
        return;
    }
P
Paolo Bonzini 已提交
3394

3395 3396 3397
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
        return;
    }
F
Fam Zheng 已提交
3398 3399 3400
    if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
        return;
    }
3401 3402 3403 3404 3405 3406 3407 3408

    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
     */
3409
    mirror_start(job_id, bs, target,
3410
                 has_replaces ? replaces : NULL,
M
Max Reitz 已提交
3411
                 speed, granularity, buf_size, sync, backing_mode,
3412 3413 3414 3415
                 on_source_error, on_target_error, unmap,
                 block_job_cb, bs, errp);
}

E
Eric Blake 已提交
3416
void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3417 3418 3419 3420
{
    BlockDriverState *bs;
    BlockDriverState *source, *target_bs;
    AioContext *aio_context;
M
Max Reitz 已提交
3421
    BlockMirrorBackingMode backing_mode;
3422 3423 3424 3425
    Error *local_err = NULL;
    QDict *options = NULL;
    int flags;
    int64_t size;
E
Eric Blake 已提交
3426
    const char *format = arg->format;
3427

3428 3429
    bs = qmp_get_root_bs(arg->device, errp);
    if (!bs) {
P
Paolo Bonzini 已提交
3430 3431 3432
        return;
    }

3433
    aio_context = bdrv_get_aio_context(bs);
3434 3435
    aio_context_acquire(aio_context);

E
Eric Blake 已提交
3436 3437
    if (!arg->has_mode) {
        arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3438
    }
P
Paolo Bonzini 已提交
3439

E
Eric Blake 已提交
3440 3441 3442
    if (!arg->has_format) {
        format = (arg->mode == NEW_IMAGE_MODE_EXISTING
                  ? NULL : bs->drv->format_name);
P
Paolo Bonzini 已提交
3443 3444
    }

K
Kevin Wolf 已提交
3445
    flags = bs->open_flags | BDRV_O_RDWR;
3446
    source = backing_bs(bs);
E
Eric Blake 已提交
3447 3448
    if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
        arg->sync = MIRROR_SYNC_MODE_FULL;
P
Paolo Bonzini 已提交
3449
    }
E
Eric Blake 已提交
3450
    if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3451 3452
        source = bs;
    }
P
Paolo Bonzini 已提交
3453

3454 3455 3456
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3457
        goto out;
3458 3459
    }

E
Eric Blake 已提交
3460
    if (arg->has_replaces) {
3461
        BlockDriverState *to_replace_bs;
3462 3463
        AioContext *replace_aio_context;
        int64_t replace_size;
3464

E
Eric Blake 已提交
3465
        if (!arg->has_node_name) {
3466 3467
            error_setg(errp, "a node-name must be provided when replacing a"
                             " named node of the graph");
3468
            goto out;
3469 3470
        }

E
Eric Blake 已提交
3471
        to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3472 3473 3474

        if (!to_replace_bs) {
            error_propagate(errp, local_err);
3475
            goto out;
3476 3477
        }

3478 3479 3480 3481 3482 3483
        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) {
3484 3485
            error_setg(errp, "cannot replace image with a mirror image of "
                             "different size");
3486
            goto out;
3487 3488 3489
        }
    }

E
Eric Blake 已提交
3490
    if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
M
Max Reitz 已提交
3491 3492 3493 3494 3495
        backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
    } else {
        backing_mode = MIRROR_OPEN_BACKING_CHAIN;
    }

E
Eric Blake 已提交
3496 3497
    if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
        && arg->mode != NEW_IMAGE_MODE_EXISTING)
3498
    {
P
Paolo Bonzini 已提交
3499
        /* create new image w/o backing file */
3500
        assert(format);
E
Eric Blake 已提交
3501
        bdrv_img_create(arg->target, format,
3502
                        NULL, NULL, NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3503
    } else {
E
Eric Blake 已提交
3504
        switch (arg->mode) {
P
Paolo Bonzini 已提交
3505 3506 3507 3508
        case NEW_IMAGE_MODE_EXISTING:
            break;
        case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
            /* create new image with backing file */
E
Eric Blake 已提交
3509
            bdrv_img_create(arg->target, format,
3510 3511
                            source->filename,
                            source->drv->format_name,
3512
                            NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3513 3514 3515 3516 3517 3518
            break;
        default:
            abort();
        }
    }

3519
    if (local_err) {
3520
        error_propagate(errp, local_err);
3521
        goto out;
P
Paolo Bonzini 已提交
3522 3523
    }

3524
    options = qdict_new();
E
Eric Blake 已提交
3525 3526
    if (arg->has_node_name) {
        qdict_put(options, "node-name", qstring_from_str(arg->node_name));
3527
    }
3528 3529 3530
    if (format) {
        qdict_put(options, "driver", qstring_from_str(format));
    }
3531

3532 3533 3534
    /* Mirroring takes care of copy-on-write using the source's backing
     * file.
     */
E
Eric Blake 已提交
3535 3536
    target_bs = bdrv_open(arg->target, NULL, options,
                          flags | BDRV_O_NO_BACKING, errp);
M
Max Reitz 已提交
3537
    if (!target_bs) {
3538
        goto out;
P
Paolo Bonzini 已提交
3539 3540
    }

3541 3542
    bdrv_set_aio_context(target_bs, aio_context);

E
Eric Blake 已提交
3543 3544 3545 3546 3547 3548 3549 3550
    blockdev_mirror_common(arg->has_job_id ? arg->job_id : NULL, bs, target_bs,
                           arg->has_replaces, arg->replaces, arg->sync,
                           backing_mode, arg->has_speed, arg->speed,
                           arg->has_granularity, arg->granularity,
                           arg->has_buf_size, arg->buf_size,
                           arg->has_on_source_error, arg->on_source_error,
                           arg->has_on_target_error, arg->on_target_error,
                           arg->has_unmap, arg->unmap,
3551
                           &local_err);
K
Kevin Wolf 已提交
3552
    bdrv_unref(target_bs);
3553
    error_propagate(errp, local_err);
3554 3555
out:
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3556 3557
}

3558 3559
void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
                         const char *device, const char *target,
F
Fam Zheng 已提交
3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573
                         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;
    BlockDriverState *target_bs;
    AioContext *aio_context;
M
Max Reitz 已提交
3574
    BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
F
Fam Zheng 已提交
3575 3576
    Error *local_err = NULL;

3577
    bs = qmp_get_root_bs(device, errp);
F
Fam Zheng 已提交
3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591
    if (!bs) {
        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_set_aio_context(target_bs, aio_context);

3592
    blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
M
Max Reitz 已提交
3593
                           has_replaces, replaces, sync, backing_mode,
F
Fam Zheng 已提交
3594 3595 3596 3597 3598 3599 3600
                           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);
3601
    error_propagate(errp, local_err);
F
Fam Zheng 已提交
3602 3603 3604 3605

    aio_context_release(aio_context);
}

3606 3607
/* Get a block job using its ID and acquire its AioContext */
static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3608
                                Error **errp)
3609
{
3610
    BlockJob *job;
3611

3612
    assert(id != NULL);
M
Max Reitz 已提交
3613

3614
    *aio_context = NULL;
3615

3616
    job = block_job_get(id);
M
Max Reitz 已提交
3617

3618 3619 3620 3621
    if (!job) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
                  "Block job '%s' not found", id);
        return NULL;
3622
    }
3623

3624 3625
    *aio_context = blk_get_aio_context(job->blk);
    aio_context_acquire(*aio_context);
3626

3627
    return job;
3628 3629
}

3630
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3631
{
3632
    AioContext *aio_context;
3633
    BlockJob *job = find_block_job(device, &aio_context, errp);
3634 3635 3636 3637 3638

    if (!job) {
        return;
    }

3639
    block_job_set_speed(job, speed, errp);
3640
    aio_context_release(aio_context);
3641
}
3642

3643 3644
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
3645
{
3646
    AioContext *aio_context;
3647
    BlockJob *job = find_block_job(device, &aio_context, errp);
3648

3649 3650 3651
    if (!job) {
        return;
    }
3652 3653 3654 3655 3656

    if (!has_force) {
        force = false;
    }

F
Fam Zheng 已提交
3657
    if (job->user_paused && !force) {
3658 3659
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
3660
        goto out;
3661
    }
3662 3663 3664

    trace_qmp_block_job_cancel(job);
    block_job_cancel(job);
3665 3666
out:
    aio_context_release(aio_context);
3667
}
S
Stefan Hajnoczi 已提交
3668

3669 3670
void qmp_block_job_pause(const char *device, Error **errp)
{
3671
    AioContext *aio_context;
3672
    BlockJob *job = find_block_job(device, &aio_context, errp);
3673

F
Fam Zheng 已提交
3674
    if (!job || job->user_paused) {
3675 3676 3677
        return;
    }

F
Fam Zheng 已提交
3678
    job->user_paused = true;
3679 3680
    trace_qmp_block_job_pause(job);
    block_job_pause(job);
3681
    aio_context_release(aio_context);
3682 3683 3684 3685
}

void qmp_block_job_resume(const char *device, Error **errp)
{
3686
    AioContext *aio_context;
3687
    BlockJob *job = find_block_job(device, &aio_context, errp);
3688

F
Fam Zheng 已提交
3689
    if (!job || !job->user_paused) {
3690 3691 3692
        return;
    }

F
Fam Zheng 已提交
3693
    job->user_paused = false;
3694
    trace_qmp_block_job_resume(job);
3695
    block_job_iostatus_reset(job);
3696
    block_job_resume(job);
3697
    aio_context_release(aio_context);
3698 3699
}

P
Paolo Bonzini 已提交
3700 3701
void qmp_block_job_complete(const char *device, Error **errp)
{
3702
    AioContext *aio_context;
3703
    BlockJob *job = find_block_job(device, &aio_context, errp);
P
Paolo Bonzini 已提交
3704 3705 3706 3707 3708 3709 3710

    if (!job) {
        return;
    }

    trace_qmp_block_job_complete(job);
    block_job_complete(job, errp);
3711
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3712 3713
}

3714 3715 3716 3717 3718 3719
void qmp_change_backing_file(const char *device,
                             const char *image_node_name,
                             const char *backing_file,
                             Error **errp)
{
    BlockDriverState *bs = NULL;
3720
    AioContext *aio_context;
3721 3722 3723 3724 3725 3726
    BlockDriverState *image_bs = NULL;
    Error *local_err = NULL;
    bool ro;
    int open_flags;
    int ret;

3727 3728
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
3729 3730 3731
        return;
    }

3732
    aio_context = bdrv_get_aio_context(bs);
3733 3734
    aio_context_acquire(aio_context);

3735 3736 3737
    image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
3738
        goto out;
3739 3740 3741 3742
    }

    if (!image_bs) {
        error_setg(errp, "image file not found");
3743
        goto out;
3744 3745 3746 3747 3748
    }

    if (bdrv_find_base(image_bs) == image_bs) {
        error_setg(errp, "not allowing backing file change on an image "
                         "without a backing file");
3749
        goto out;
3750 3751 3752 3753 3754
    }

    /* 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)) {
3755
        goto out;
3756 3757 3758 3759 3760 3761
    }

    /* final sanity check */
    if (!bdrv_chain_contains(bs, image_bs)) {
        error_setg(errp, "'%s' and image file are not in the same chain",
                   device);
3762
        goto out;
3763 3764 3765 3766 3767 3768 3769 3770 3771 3772
    }

    /* 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);
3773
            goto out;
3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788
        }
    }

    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);
3789
        error_propagate(errp, local_err);
3790
    }
3791 3792 3793

out:
    aio_context_release(aio_context);
3794 3795
}

3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809
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")) {
3810
        QDECREF(qdict);
3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826
        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 已提交
3827 3828
void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
{
3829 3830
    BlockDriverState *bs;
    BlockBackend *blk = NULL;
K
Kevin Wolf 已提交
3831
    QObject *obj;
3832
    Visitor *v = qmp_output_visitor_new(&obj);
K
Kevin Wolf 已提交
3833 3834 3835
    QDict *qdict;
    Error *local_err = NULL;

3836
    /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
K
Kevin Wolf 已提交
3837
     * cache.direct=false instead of silently switching to aio=threads, except
3838
     * when called from drive_new().
K
Kevin Wolf 已提交
3839 3840 3841
     *
     * For now, simply forbidding the combination for all drivers will do. */
    if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3842 3843 3844 3845
        bool direct = options->has_cache &&
                      options->cache->has_direct &&
                      options->cache->direct;
        if (!direct) {
K
Kevin Wolf 已提交
3846 3847 3848 3849 3850
            error_setg(errp, "aio=native requires cache.direct=true");
            goto fail;
        }
    }

3851
    visit_type_BlockdevOptions(v, NULL, &options, &local_err);
3852
    if (local_err) {
K
Kevin Wolf 已提交
3853 3854 3855 3856
        error_propagate(errp, local_err);
        goto fail;
    }

3857
    visit_complete(v, &obj);
K
Kevin Wolf 已提交
3858 3859 3860 3861
    qdict = qobject_to_qdict(obj);

    qdict_flatten(qdict);

3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876
    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;
        }

3877 3878
        bs = bds_tree_init(qdict, errp);
        if (!bs) {
3879 3880
            goto fail;
        }
3881 3882

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

3885 3886
    if (bs && bdrv_key_required(bs)) {
        if (blk) {
3887
            monitor_remove_blk(blk);
3888 3889
            blk_unref(blk);
        } else {
3890
            QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3891 3892
            bdrv_unref(bs);
        }
3893 3894 3895 3896
        error_setg(errp, "blockdev-add doesn't support encrypted devices");
        goto fail;
    }

K
Kevin Wolf 已提交
3897
fail:
3898
    visit_free(v);
K
Kevin Wolf 已提交
3899 3900
}

3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916
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) {
3917
        /* blk_by_name() never returns a BB that is not owned by the monitor */
3918 3919 3920 3921 3922
        blk = blk_by_name(id);
        if (!blk) {
            error_setg(errp, "Cannot find block backend %s", id);
            return;
        }
3923 3924 3925 3926 3927
        if (blk_legacy_dinfo(blk)) {
            error_setg(errp, "Deleting block backend added with drive-add"
                       " is not supported");
            return;
        }
3928 3929 3930 3931 3932 3933 3934
        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 {
K
Kevin Wolf 已提交
3935
        blk = NULL;
3936 3937 3938 3939 3940
        bs = bdrv_find_node(node_name);
        if (!bs) {
            error_setg(errp, "Cannot find node %s", node_name);
            return;
        }
K
Kevin Wolf 已提交
3941
        if (bdrv_has_blk(bs)) {
3942
            error_setg(errp, "Node %s is in use by %s",
K
Kevin Wolf 已提交
3943
                       node_name, bdrv_get_parent_name(bs));
3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955
            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;
        }

3956
        if (!blk && !QTAILQ_IN_USE(bs, monitor_list)) {
3957 3958 3959 3960 3961 3962
            error_setg(errp, "Node %s is not owned by the monitor",
                       bs->node_name);
            goto out;
        }

        if (bs->refcnt > 1) {
3963 3964 3965 3966 3967 3968 3969
            error_setg(errp, "Block device %s is in use",
                       bdrv_get_device_or_node_name(bs));
            goto out;
        }
    }

    if (blk) {
3970
        monitor_remove_blk(blk);
3971 3972
        blk_unref(blk);
    } else {
3973
        QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3974 3975 3976 3977 3978 3979 3980
        bdrv_unref(bs);
    }

out:
    aio_context_release(aio_context);
}

3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 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
static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
                                  const char *child_name)
{
    BdrvChild *child;

    QLIST_FOREACH(child, &parent_bs->children, next) {
        if (strcmp(child->name, child_name) == 0) {
            return child;
        }
    }

    return NULL;
}

void qmp_x_blockdev_change(const char *parent, bool has_child,
                           const char *child, bool has_node,
                           const char *node, Error **errp)
{
    BlockDriverState *parent_bs, *new_bs = NULL;
    BdrvChild *p_child;

    parent_bs = bdrv_lookup_bs(parent, parent, errp);
    if (!parent_bs) {
        return;
    }

    if (has_child == has_node) {
        if (has_child) {
            error_setg(errp, "The parameters child and node are in conflict");
        } else {
            error_setg(errp, "Either child or node must be specified");
        }
        return;
    }

    if (has_child) {
        p_child = bdrv_find_child(parent_bs, child);
        if (!p_child) {
            error_setg(errp, "Node '%s' does not have child '%s'",
                       parent, child);
            return;
        }
        bdrv_del_child(parent_bs, p_child, errp);
    }

    if (has_node) {
        new_bs = bdrv_find_node(node);
        if (!new_bs) {
            error_setg(errp, "Node '%s' not found", node);
            return;
        }
        bdrv_add_child(parent_bs, new_bs, errp);
    }
}

4036
BlockJobInfoList *qmp_query_block_jobs(Error **errp)
S
Stefan Hajnoczi 已提交
4037
{
4038
    BlockJobInfoList *head = NULL, **p_next = &head;
4039
    BlockJob *job;
S
Stefan Hajnoczi 已提交
4040

4041 4042 4043
    for (job = block_job_next(NULL); job; job = block_job_next(job)) {
        BlockJobInfoList *elem = g_new0(BlockJobInfoList, 1);
        AioContext *aio_context = blk_get_aio_context(job->blk);
4044 4045

        aio_context_acquire(aio_context);
4046
        elem->value = block_job_query(job);
4047
        aio_context_release(aio_context);
4048 4049 4050

        *p_next = elem;
        p_next = &elem->next;
S
Stefan Hajnoczi 已提交
4051 4052
    }

4053
    return head;
S
Stefan Hajnoczi 已提交
4054
}
4055

4056
QemuOptsList qemu_common_drive_opts = {
4057
    .name = "drive",
4058
    .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4059 4060 4061 4062 4063
    .desc = {
        {
            .name = "snapshot",
            .type = QEMU_OPT_BOOL,
            .help = "enable/disable snapshot mode",
4064 4065 4066 4067
        },{
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
4068 4069 4070 4071
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
4072 4073 4074 4075
        },{
            .name = BDRV_OPT_CACHE_WB,
            .type = QEMU_OPT_BOOL,
            .help = "Enable writeback mode",
4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088
        },{
            .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",
        },{
4089
            .name = BDRV_OPT_READ_ONLY,
4090 4091 4092
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
4093
            .name = "throttling.iops-total",
4094 4095 4096
            .type = QEMU_OPT_NUMBER,
            .help = "limit total I/O operations per second",
        },{
4097
            .name = "throttling.iops-read",
4098 4099 4100
            .type = QEMU_OPT_NUMBER,
            .help = "limit read operations per second",
        },{
4101
            .name = "throttling.iops-write",
4102 4103 4104
            .type = QEMU_OPT_NUMBER,
            .help = "limit write operations per second",
        },{
4105
            .name = "throttling.bps-total",
4106 4107 4108
            .type = QEMU_OPT_NUMBER,
            .help = "limit total bytes per second",
        },{
4109
            .name = "throttling.bps-read",
4110 4111 4112
            .type = QEMU_OPT_NUMBER,
            .help = "limit read bytes per second",
        },{
4113
            .name = "throttling.bps-write",
4114 4115
            .type = QEMU_OPT_NUMBER,
            .help = "limit write bytes per second",
4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139
        },{
            .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",
4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163
        },{
            .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",
4164 4165 4166 4167
        },{
            .name = "throttling.iops-size",
            .type = QEMU_OPT_NUMBER,
            .help = "when limiting by iops max size of an I/O in bytes",
4168 4169 4170 4171
        },{
            .name = "throttling.group",
            .type = QEMU_OPT_STRING,
            .help = "name of the block throttling group",
4172 4173 4174 4175
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
4176 4177 4178 4179
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
4180 4181 4182 4183 4184 4185 4186 4187 4188 4189
        },{
            .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",
4190 4191 4192 4193
        },
        { /* end of list */ }
    },
};
4194

4195 4196
static QemuOptsList qemu_root_bds_opts = {
    .name = "root-bds",
4197
    .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219
    .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 = "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 */ }
    },
};

4220 4221 4222 4223
QemuOptsList qemu_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
    .desc = {
4224 4225 4226 4227
        /*
         * no elements => accept any params
         * validation will happen later
         */
4228 4229 4230
        { /* end of list */ }
    },
};