blockdev.c 124.0 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 *device, bool force, Error **errp);

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

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

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

    if (max_devs <= 0) {
        return;
    }

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

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

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

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

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

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

146
    dinfo->auto_del = 1;
147 148
}

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

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

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

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

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

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

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

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

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

    return NULL;
}

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

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

    return rs;
}

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

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

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

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

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

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

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

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

351 352
typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;

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

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

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

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

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

    if (throttle_cfg) {
395
        throttle_config_init(throttle_cfg);
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
        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);

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

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

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

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

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

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

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

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

507 508 509
    /* extract parameters */
    snapshot = qemu_opt_get_bool(opts, "snapshot", 0);

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

513 514
    writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);

515 516
    id = qemu_opts_id(opts);

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

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

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

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

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

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

566
    if (snapshot) {
567
        bdrv_flags |= BDRV_O_SNAPSHOT;
568 569
    }

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     = !(bdrv_flags & BDRV_O_RDWR);
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
        assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
592

593 594 595 596
        if (runstate_check(RUN_STATE_INMIGRATE)) {
            bdrv_flags |= BDRV_O_INACTIVE;
        }

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

603
        bs->detect_zeroes = detect_zeroes;
604

605 606
        if (bdrv_key_required(bs)) {
            autostart = 0;
607
        }
608 609

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

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

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

627
    blk_set_enable_write_cache(blk, !writethrough);
628
    blk_set_on_error(blk, on_read_error, on_write_error);
629

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

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

642 643
early_err:
    qemu_opts_del(opts);
644 645
    QDECREF(interval_dict);
    QDECREF(interval_list);
646 647
err_no_opts:
    QDECREF(bs_opts);
648
    return NULL;
649 650
}

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

680 681 682 683 684 685
    /* 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");

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

M
Max Reitz 已提交
690 691
    bs = bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
    if (!bs) {
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
        goto fail_no_bs_opts;
    }

    bs->detect_zeroes = detect_zeroes;

fail_no_bs_opts:
    qemu_opts_del(opts);
    return bs;

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

707 708 709 710 711 712 713 714 715 716 717 718 719
void blockdev_close_all_bdrv_states(void)
{
    BlockDriverState *bs, *next_bs;

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

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

M
Max Reitz 已提交
720 721 722 723 724 725 726
/* 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);
}

727 728
static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
                            Error **errp)
729 730 731 732 733
{
    const char *value;

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

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

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

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

825 826 827 828
        { /* end of list */ }
    },
};

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

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

858 859 860
        { "bps",            "throttling.bps-total" },
        { "bps_rd",         "throttling.bps-read" },
        { "bps_wr",         "throttling.bps-write" },
861

862 863 864
        { "iops_max",       "throttling.iops-total-max" },
        { "iops_rd_max",    "throttling.iops-read-max" },
        { "iops_wr_max",    "throttling.iops-write-max" },
865

866 867 868
        { "bps_max",        "throttling.bps-total-max" },
        { "bps_rd_max",     "throttling.bps-read-max" },
        { "bps_wr_max",     "throttling.bps-write-max" },
869

870
        { "iops_size",      "throttling.iops-size" },
871

872 873
        { "group",          "throttling.group" },

874 875 876 877
        { "readonly",       "read-only" },
    };

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

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

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

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

912 913 914 915
    /* Get a QDict for processing the options */
    bs_opts = qdict_new();
    qemu_opts_to_qdict(all_opts, bs_opts);

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

924 925 926 927 928 929 930
    /* 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");
    }

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

945
    /* copy-on-read is disabled with a warning for read-only devices */
F
Fam Zheng 已提交
946
    read_only |= qemu_opt_get_bool(legacy_opts, "read-only", false);
947 948 949 950 951 952 953 954 955 956 957 958
    copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);

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

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

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

974 975 976 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
    /* 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;
1006 1007 1008 1009
        } else if (!strcmp(value, "large")) {
            translation = BIOS_ATA_TRANSLATION_LARGE;
        } else if (!strcmp(value, "rechs")) {
            translation = BIOS_ATA_TRANSLATION_RECHS;
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
        } 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;
        }
    }

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
    /* 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;
    }

1064 1065 1066
    /* Serial number */
    serial = qemu_opt_get(legacy_opts, "serial");

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

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

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

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

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

1143 1144
    /* Create legacy DriveInfo */
    dinfo = g_malloc0(sizeof(*dinfo));
1145
    dinfo->opts = all_opts;
1146

1147 1148 1149 1150 1151
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

1152
    dinfo->type = type;
1153 1154
    dinfo->bus = bus_id;
    dinfo->unit = unit_id;
1155
    dinfo->devaddr = devaddr;
1156 1157
    dinfo->serial = g_strdup(serial);

1158 1159
    blk_set_legacy_dinfo(blk, dinfo);

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

1171
fail:
1172
    qemu_opts_del(legacy_opts);
1173
    QDECREF(bs_opts);
1174
    return dinfo;
1175 1176
}

1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
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;
}

1199
void hmp_commit(Monitor *mon, const QDict *qdict)
1200 1201
{
    const char *device = qdict_get_str(qdict, "device");
1202
    BlockBackend *blk;
1203
    int ret;
1204

1205
    if (!strcmp(device, "all")) {
1206
        ret = blk_commit_all();
1207
    } else {
1208 1209 1210
        BlockDriverState *bs;
        AioContext *aio_context;

1211 1212
        blk = blk_by_name(device);
        if (!blk) {
1213
            monitor_printf(mon, "Device '%s' not found\n", device);
1214
            return;
1215
        }
M
Max Reitz 已提交
1216 1217 1218 1219
        if (!blk_is_available(blk)) {
            monitor_printf(mon, "Device '%s' has no medium\n", device);
            return;
        }
1220 1221 1222 1223 1224 1225 1226 1227

        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);
1228 1229 1230 1231
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
1232 1233 1234
    }
}

1235
static void blockdev_do_action(TransactionAction *action, Error **errp)
1236
{
1237
    TransactionActionList list;
1238

1239
    list.value = action;
1240
    list.next = NULL;
J
John Snow 已提交
1241
    qmp_transaction(&list, false, NULL, errp);
1242 1243
}

1244 1245 1246 1247 1248
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,
1249
                                bool has_format, const char *format,
1250
                                bool has_mode, NewImageMode mode, Error **errp)
1251
{
1252
    BlockdevSnapshotSync snapshot = {
1253
        .has_device = has_device,
1254
        .device = (char *) device,
1255 1256
        .has_node_name = has_node_name,
        .node_name = (char *) node_name,
1257
        .snapshot_file = (char *) snapshot_file,
1258 1259
        .has_snapshot_node_name = has_snapshot_node_name,
        .snapshot_node_name = (char *) snapshot_node_name,
1260 1261 1262 1263 1264
        .has_format = has_format,
        .format = (char *) format,
        .has_mode = has_mode,
        .mode = mode,
    };
1265 1266
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1267
        .u.blockdev_snapshot_sync.data = &snapshot,
1268 1269
    };
    blockdev_do_action(&action, errp);
1270 1271
}

1272 1273 1274 1275 1276 1277 1278
void qmp_blockdev_snapshot(const char *node, const char *overlay,
                           Error **errp)
{
    BlockdevSnapshot snapshot_data = {
        .node = (char *) node,
        .overlay = (char *) overlay
    };
1279 1280
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1281
        .u.blockdev_snapshot.data = &snapshot_data,
1282 1283
    };
    blockdev_do_action(&action, errp);
1284 1285
}

1286 1287 1288 1289 1290 1291 1292 1293
void qmp_blockdev_snapshot_internal_sync(const char *device,
                                         const char *name,
                                         Error **errp)
{
    BlockdevSnapshotInternal snapshot = {
        .device = (char *) device,
        .name = (char *) name
    };
1294 1295
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1296
        .u.blockdev_snapshot_internal_sync.data = &snapshot,
1297 1298
    };
    blockdev_do_action(&action, errp);
1299 1300
}

1301 1302 1303 1304 1305 1306 1307
SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
                                                         bool has_id,
                                                         const char *id,
                                                         bool has_name,
                                                         const char *name,
                                                         Error **errp)
{
1308
    BlockDriverState *bs;
1309
    AioContext *aio_context;
1310 1311 1312 1313 1314
    QEMUSnapshotInfo sn;
    Error *local_err = NULL;
    SnapshotInfo *info = NULL;
    int ret;

1315 1316
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
1317 1318
        return NULL;
    }
1319
    aio_context = bdrv_get_aio_context(bs);
M
Max Reitz 已提交
1320
    aio_context_acquire(aio_context);
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331

    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 已提交
1332
        goto out_aio_context;
1333 1334
    }

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

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

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

1358 1359
    aio_context_release(aio_context);

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

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

1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
/**
 * 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;
}

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

1440
typedef struct BlkActionState BlkActionState;
1441

1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
/**
 * 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 {
1457
    size_t instance_size;
1458 1459 1460 1461 1462
    void (*prepare)(BlkActionState *common, Error **errp);
    void (*commit)(BlkActionState *common);
    void (*abort)(BlkActionState *common);
    void (*clean)(BlkActionState *common);
} BlkActionOps;
1463

1464 1465 1466 1467 1468 1469
/**
 * 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 已提交
1470
 * @block_job_txn: Transaction which this action belongs to.
1471 1472 1473 1474 1475
 * @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.
1476
 */
1477
struct BlkActionState {
1478
    TransactionAction *action;
1479
    const BlkActionOps *ops;
J
John Snow 已提交
1480 1481
    BlockJobTxn *block_job_txn;
    TransactionProperties *txn_props;
1482
    QSIMPLEQ_ENTRY(BlkActionState) entry;
1483 1484
};

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

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

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

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

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

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

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

1536 1537
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
1538 1539 1540
        return;
    }

1541
    /* AioContext is released in .clean() */
1542
    state->aio_context = bdrv_get_aio_context(bs);
1543 1544
    aio_context_acquire(state->aio_context);

1545 1546 1547
    state->bs = bs;
    bdrv_drained_begin(bs);

1548 1549 1550 1551
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
        return;
    }

1552
    if (bdrv_is_read_only(bs)) {
1553
        error_setg(errp, "Device '%s' is read only", device);
1554 1555 1556 1557
        return;
    }

    if (!bdrv_can_snapshot(bs)) {
1558 1559 1560
        error_setg(errp, "Block format '%s' used by device '%s' "
                   "does not support internal snapshots",
                   bs->drv->format_name, device);
1561 1562 1563 1564 1565 1566 1567 1568 1569
        return;
    }

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

    /* check whether a snapshot with name exist */
1570 1571 1572 1573
    ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
                                            &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598
        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 */
1599
    state->created = true;
1600 1601
}

1602
static void internal_snapshot_abort(BlkActionState *common)
1603 1604 1605 1606 1607 1608 1609
{
    InternalSnapshotState *state =
                             DO_UPCAST(InternalSnapshotState, common, common);
    BlockDriverState *bs = state->bs;
    QEMUSnapshotInfo *sn = &state->sn;
    Error *local_error = NULL;

1610
    if (!state->created) {
1611 1612 1613 1614
        return;
    }

    if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1615 1616 1617 1618 1619
        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));
1620 1621 1622
    }
}

1623
static void internal_snapshot_clean(BlkActionState *common)
1624 1625 1626 1627 1628
{
    InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
                                             common, common);

    if (state->aio_context) {
1629 1630 1631
        if (state->bs) {
            bdrv_drained_end(state->bs);
        }
1632 1633 1634 1635
        aio_context_release(state->aio_context);
    }
}

1636
/* external snapshot private data */
1637
typedef struct ExternalSnapshotState {
1638
    BlkActionState common;
1639 1640
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1641
    AioContext *aio_context;
1642
} ExternalSnapshotState;
1643

1644
static void external_snapshot_prepare(BlkActionState *common,
1645 1646
                                      Error **errp)
{
M
Max Reitz 已提交
1647
    int flags = 0;
1648
    QDict *options = NULL;
1649
    Error *local_err = NULL;
1650
    /* Device and node name of the image to generate the snapshot from */
1651
    const char *device;
1652
    const char *node_name;
1653 1654 1655
    /* Reference to the new image (for 'blockdev-snapshot') */
    const char *snapshot_ref;
    /* File name of the new image (for 'blockdev-snapshot-sync') */
1656
    const char *new_image_file;
1657 1658
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1659
    TransactionAction *action = common->action;
1660

1661 1662 1663 1664 1665
    /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
     * purpose but a different set of parameters */
    switch (action->type) {
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
        {
1666
            BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1667 1668 1669 1670 1671 1672 1673 1674
            device = s->node;
            node_name = s->node;
            new_image_file = NULL;
            snapshot_ref = s->overlay;
        }
        break;
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
        {
1675
            BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1676 1677 1678 1679 1680 1681 1682 1683
            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();
1684 1685 1686
    }

    /* start processing */
J
John Snow 已提交
1687 1688 1689 1690
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1691 1692
    state->old_bs = bdrv_lookup_bs(device, node_name, errp);
    if (!state->old_bs) {
1693 1694 1695
        return;
    }

1696 1697 1698
    /* 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);
1699
    bdrv_drained_begin(state->old_bs);
1700

1701
    if (!bdrv_is_inserted(state->old_bs)) {
1702
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1703 1704 1705
        return;
    }

1706 1707
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1708 1709 1710
        return;
    }

1711 1712
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1713
            error_setg(errp, QERR_IO_ERROR);
1714 1715 1716 1717
            return;
        }
    }

1718
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1719
        error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1720 1721 1722
        return;
    }

1723
    if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1724
        BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1725 1726 1727 1728
        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;
1729

1730 1731
        if (node_name && !snapshot_node_name) {
            error_setg(errp, "New snapshot node name missing");
1732 1733 1734
            return;
        }

1735 1736 1737 1738 1739 1740 1741
        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;
1742
        flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1743 1744 1745 1746

        /* create new image w/backing file */
        mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
        if (mode != NEW_IMAGE_MODE_EXISTING) {
1747 1748 1749 1750 1751
            int64_t size = bdrv_getlength(state->old_bs);
            if (size < 0) {
                error_setg_errno(errp, -size, "bdrv_getlength failed");
                return;
            }
1752 1753 1754
            bdrv_img_create(new_image_file, format,
                            state->old_bs->filename,
                            state->old_bs->drv->format_name,
1755
                            NULL, size, flags, &local_err, false);
1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
            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;
1770 1771
    }

M
Max Reitz 已提交
1772 1773
    state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
                              errp);
1774
    /* We will manually add the backing_hd field to the bs later */
M
Max Reitz 已提交
1775
    if (!state->new_bs) {
1776 1777 1778
        return;
    }

K
Kevin Wolf 已提交
1779
    if (bdrv_has_blk(state->new_bs)) {
1780
        error_setg(errp, "The snapshot is already in use by %s",
K
Kevin Wolf 已提交
1781
                   bdrv_get_parent_name(state->new_bs));
1782 1783 1784 1785 1786 1787 1788 1789 1790 1791
        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");
1792 1793 1794 1795 1796
        return;
    }

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

1800
static void external_snapshot_commit(BlkActionState *common)
1801
{
1802 1803
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1804

1805 1806
    bdrv_set_aio_context(state->new_bs, state->aio_context);

1807 1808
    /* This removes our old bs and adds the new bs */
    bdrv_append(state->new_bs, state->old_bs);
1809 1810 1811
    /* 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 */
1812 1813 1814 1815
    if (!state->old_bs->copy_on_read) {
        bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
                    NULL);
    }
1816 1817
}

1818
static void external_snapshot_abort(BlkActionState *common)
1819
{
1820 1821 1822
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
F
Fam Zheng 已提交
1823
        bdrv_unref(state->new_bs);
1824
    }
1825 1826
}

1827
static void external_snapshot_clean(BlkActionState *common)
1828 1829 1830
{
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1831
    if (state->aio_context) {
1832
        bdrv_drained_end(state->old_bs);
1833 1834
        aio_context_release(state->aio_context);
    }
1835 1836
}

1837
typedef struct DriveBackupState {
1838
    BlkActionState common;
1839
    BlockDriverState *bs;
1840
    AioContext *aio_context;
1841 1842 1843
    BlockJob *job;
} DriveBackupState;

P
Pavel Butsykin 已提交
1844 1845
static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn,
                            Error **errp);
1846

1847
static void drive_backup_prepare(BlkActionState *common, Error **errp)
1848 1849
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1850
    BlockDriverState *bs;
1851 1852 1853
    DriveBackup *backup;
    Error *local_err = NULL;

1854
    assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1855
    backup = common->action->u.drive_backup.data;
1856

1857 1858
    bs = qmp_get_root_bs(backup->device, errp);
    if (!bs) {
1859 1860 1861
        return;
    }

1862
    /* AioContext is released in .clean() */
1863
    state->aio_context = bdrv_get_aio_context(bs);
1864
    aio_context_acquire(state->aio_context);
1865 1866
    bdrv_drained_begin(bs);
    state->bs = bs;
1867

P
Pavel Butsykin 已提交
1868
    do_drive_backup(backup, common->block_job_txn, &local_err);
1869
    if (local_err) {
1870 1871 1872 1873 1874 1875 1876
        error_propagate(errp, local_err);
        return;
    }

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

1877
static void drive_backup_abort(BlkActionState *common)
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
{
    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);
    }
}

1888
static void drive_backup_clean(BlkActionState *common)
1889 1890 1891 1892
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);

    if (state->aio_context) {
1893
        bdrv_drained_end(state->bs);
1894 1895 1896 1897
        aio_context_release(state->aio_context);
    }
}

1898
typedef struct BlockdevBackupState {
1899
    BlkActionState common;
1900 1901 1902 1903 1904
    BlockDriverState *bs;
    BlockJob *job;
    AioContext *aio_context;
} BlockdevBackupState;

1905 1906
static void do_blockdev_backup(const char *job_id, const char *device,
                               const char *target, enum MirrorSyncMode sync,
1907 1908 1909 1910 1911 1912 1913
                               bool has_speed, int64_t speed,
                               bool has_on_source_error,
                               BlockdevOnError on_source_error,
                               bool has_on_target_error,
                               BlockdevOnError on_target_error,
                               BlockJobTxn *txn, Error **errp);

1914
static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1915 1916 1917
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
    BlockdevBackup *backup;
1918
    BlockDriverState *bs, *target;
1919 1920
    Error *local_err = NULL;

1921
    assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1922
    backup = common->action->u.blockdev_backup.data;
1923

1924 1925
    bs = qmp_get_root_bs(backup->device, errp);
    if (!bs) {
1926 1927 1928
        return;
    }

1929
    target = bdrv_lookup_bs(backup->target, backup->target, errp);
M
Max Reitz 已提交
1930
    if (!target) {
1931 1932 1933 1934
        return;
    }

    /* AioContext is released in .clean() */
1935
    state->aio_context = bdrv_get_aio_context(bs);
1936
    if (state->aio_context != bdrv_get_aio_context(target)) {
1937 1938 1939 1940 1941
        state->aio_context = NULL;
        error_setg(errp, "Backup between two IO threads is not implemented");
        return;
    }
    aio_context_acquire(state->aio_context);
1942
    state->bs = bs;
1943
    bdrv_drained_begin(state->bs);
1944

1945 1946
    do_blockdev_backup(backup->has_job_id ? backup->job_id : NULL,
                       backup->device, backup->target, backup->sync,
1947 1948 1949
                       backup->has_speed, backup->speed,
                       backup->has_on_source_error, backup->on_source_error,
                       backup->has_on_target_error, backup->on_target_error,
J
John Snow 已提交
1950
                       common->block_job_txn, &local_err);
1951 1952 1953 1954 1955 1956 1957 1958
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

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

1959
static void blockdev_backup_abort(BlkActionState *common)
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
{
    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);
    }
}

1970
static void blockdev_backup_clean(BlkActionState *common)
1971 1972 1973 1974
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);

    if (state->aio_context) {
1975
        bdrv_drained_end(state->bs);
1976 1977 1978 1979
        aio_context_release(state->aio_context);
    }
}

F
Fam Zheng 已提交
1980
typedef struct BlockDirtyBitmapState {
1981
    BlkActionState common;
F
Fam Zheng 已提交
1982 1983 1984 1985 1986 1987 1988
    BdrvDirtyBitmap *bitmap;
    BlockDriverState *bs;
    AioContext *aio_context;
    HBitmap *backup;
    bool prepared;
} BlockDirtyBitmapState;

1989
static void block_dirty_bitmap_add_prepare(BlkActionState *common,
F
Fam Zheng 已提交
1990 1991 1992 1993 1994 1995 1996
                                           Error **errp)
{
    Error *local_err = NULL;
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

J
John Snow 已提交
1997 1998 1999 2000
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2001
    action = common->action->u.block_dirty_bitmap_add.data;
F
Fam Zheng 已提交
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
    /* 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);
    }
}

2014
static void block_dirty_bitmap_add_abort(BlkActionState *common)
F
Fam Zheng 已提交
2015 2016 2017 2018 2019
{
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

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

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

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

2040
    action = common->action->u.block_dirty_bitmap_clear.data;
F
Fam Zheng 已提交
2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
    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() */
}

2062
static void block_dirty_bitmap_clear_abort(BlkActionState *common)
F
Fam Zheng 已提交
2063 2064 2065 2066 2067 2068 2069
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

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

2070
static void block_dirty_bitmap_clear_commit(BlkActionState *common)
F
Fam Zheng 已提交
2071 2072 2073 2074 2075 2076 2077
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

    hbitmap_free(state->backup);
}

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

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

2088
static void abort_prepare(BlkActionState *common, Error **errp)
2089 2090 2091 2092
{
    error_setg(errp, "Transaction aborted using Abort action");
}

2093
static void abort_commit(BlkActionState *common)
2094
{
2095
    g_assert_not_reached(); /* this action never succeeds */
2096 2097
}

2098
static const BlkActionOps actions[] = {
2099 2100 2101 2102 2103
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
        .instance_size = sizeof(ExternalSnapshotState),
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2104
        .clean = external_snapshot_clean,
2105
    },
2106
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2107
        .instance_size = sizeof(ExternalSnapshotState),
2108 2109 2110
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2111
        .clean = external_snapshot_clean,
2112
    },
2113 2114 2115 2116
    [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
        .instance_size = sizeof(DriveBackupState),
        .prepare = drive_backup_prepare,
        .abort = drive_backup_abort,
2117
        .clean = drive_backup_clean,
2118
    },
2119 2120 2121 2122 2123 2124
    [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
        .instance_size = sizeof(BlockdevBackupState),
        .prepare = blockdev_backup_prepare,
        .abort = blockdev_backup_abort,
        .clean = blockdev_backup_clean,
    },
2125
    [TRANSACTION_ACTION_KIND_ABORT] = {
2126
        .instance_size = sizeof(BlkActionState),
2127 2128 2129
        .prepare = abort_prepare,
        .commit = abort_commit,
    },
2130 2131 2132 2133
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
        .instance_size = sizeof(InternalSnapshotState),
        .prepare  = internal_snapshot_prepare,
        .abort = internal_snapshot_abort,
2134
        .clean = internal_snapshot_clean,
2135
    },
F
Fam Zheng 已提交
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
    [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,
    }
2148 2149
};

J
John Snow 已提交
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
/**
 * 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;
}

2169
/*
2170 2171
 * 'Atomic' group operations.  The operations are performed as a set, and if
 * any fail then we roll back all operations in the group.
2172
 */
J
John Snow 已提交
2173 2174 2175 2176
void qmp_transaction(TransactionActionList *dev_list,
                     bool has_props,
                     struct TransactionProperties *props,
                     Error **errp)
2177
{
2178
    TransactionActionList *dev_entry = dev_list;
J
John Snow 已提交
2179
    BlockJobTxn *block_job_txn = NULL;
2180
    BlkActionState *state, *next;
2181
    Error *local_err = NULL;
2182

2183
    QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2184 2185
    QSIMPLEQ_INIT(&snap_bdrv_states);

J
John Snow 已提交
2186 2187 2188 2189 2190 2191 2192 2193
    /* 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();
    }

2194
    /* drain all i/o before any operations */
2195 2196
    bdrv_drain_all();

2197
    /* We don't do anything in this loop that commits us to the operations */
2198
    while (NULL != dev_entry) {
2199
        TransactionAction *dev_info = NULL;
2200
        const BlkActionOps *ops;
2201

2202 2203 2204
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

2205
        assert(dev_info->type < ARRAY_SIZE(actions));
2206

2207
        ops = &actions[dev_info->type];
2208 2209
        assert(ops->instance_size > 0);

2210 2211 2212
        state = g_malloc0(ops->instance_size);
        state->ops = ops;
        state->action = dev_info;
J
John Snow 已提交
2213 2214
        state->block_job_txn = block_job_txn;
        state->txn_props = props;
2215
        QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2216

2217
        state->ops->prepare(state, &local_err);
2218
        if (local_err) {
2219 2220
            error_propagate(errp, local_err);
            goto delete_and_fail;
2221 2222 2223
        }
    }

2224
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2225 2226 2227
        if (state->ops->commit) {
            state->ops->commit(state);
        }
2228 2229 2230 2231 2232 2233
    }

    /* success */
    goto exit;

delete_and_fail:
2234
    /* failure, and it is all-or-none; roll back all operations */
2235 2236 2237
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
        if (state->ops->abort) {
            state->ops->abort(state);
2238
        }
2239 2240
    }
exit:
2241 2242 2243
    QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
        if (state->ops->clean) {
            state->ops->clean(state);
2244
        }
2245
        g_free(state);
2246
    }
J
John Snow 已提交
2247 2248 2249 2250
    if (!has_props) {
        qapi_free_TransactionProperties(props);
    }
    block_job_txn_unref(block_job_txn);
2251 2252
}

L
Luiz Capitulino 已提交
2253
void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2254
{
2255
    Error *local_err = NULL;
2256 2257 2258 2259 2260
    int rc;

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

2262
    rc = do_open_tray(device, force, &local_err);
2263
    if (rc && rc != -ENOSYS) {
2264
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2265
        return;
2266
    }
2267
    error_free(local_err);
2268

2269
    qmp_x_blockdev_remove_medium(device, errp);
2270 2271
}

2272 2273 2274
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
2275
{
2276
    Error *local_err = NULL;
2277
    BlockDriverState *bs;
2278
    AioContext *aio_context;
2279

2280 2281 2282
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2283
    if (local_err) {
2284
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2285
        return;
2286 2287
    }

2288 2289 2290
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2291
    bdrv_add_key(bs, password, errp);
2292 2293

    aio_context_release(aio_context);
2294 2295
}

2296 2297 2298 2299 2300 2301 2302 2303 2304 2305
/*
 * 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.
2306 2307
 */
static int do_open_tray(const char *device, bool force, Error **errp)
M
Max Reitz 已提交
2308 2309 2310 2311 2312 2313 2314 2315
{
    BlockBackend *blk;
    bool locked;

    blk = blk_by_name(device);
    if (!blk) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
2316
        return -ENODEV;
M
Max Reitz 已提交
2317 2318 2319 2320
    }

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

2324
    if (!blk_dev_has_tray(blk)) {
2325 2326
        error_setg(errp, "Device '%s' does not have a tray", device);
        return -ENOSYS;
2327 2328
    }

M
Max Reitz 已提交
2329
    if (blk_dev_is_tray_open(blk)) {
2330
        return 0;
M
Max Reitz 已提交
2331 2332 2333 2334 2335 2336 2337 2338 2339 2340
    }

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

    if (locked && !force) {
2343 2344 2345
        error_setg(errp, "Device '%s' is locked and force was not specified, "
                   "wait for tray to open and try again", device);
        return -EINPROGRESS;
2346 2347 2348 2349 2350 2351 2352 2353
    }

    return 0;
}

void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
                            Error **errp)
{
2354 2355 2356
    Error *local_err = NULL;
    int rc;

2357 2358 2359
    if (!has_force) {
        force = false;
    }
2360 2361 2362 2363 2364 2365
    rc = do_open_tray(device, force, &local_err);
    if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
        error_propagate(errp, local_err);
        return;
    }
    error_free(local_err);
M
Max Reitz 已提交
2366 2367
}

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

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

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

2384 2385 2386 2387 2388
    if (!blk_dev_has_tray(blk)) {
        /* Ignore this command on tray-less devices */
        return;
    }

M
Max Reitz 已提交
2389 2390 2391 2392 2393 2394 2395
    if (!blk_dev_is_tray_open(blk)) {
        return;
    }

    blk_dev_change_media_cb(blk, true);
}

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

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

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

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

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

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

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

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

    blk_remove_bs(blk);

2437 2438 2439 2440 2441 2442 2443 2444
    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 已提交
2445 2446 2447 2448
out:
    aio_context_release(aio_context);
}

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

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

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

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

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

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

    blk_insert_bs(blk, bs);

2482 2483 2484 2485 2486 2487 2488 2489
    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 已提交
2490 2491
}

2492 2493
void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
                                  Error **errp)
M
Max Reitz 已提交
2494 2495 2496 2497 2498 2499 2500 2501 2502
{
    BlockDriverState *bs;

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

K
Kevin Wolf 已提交
2503
    if (bdrv_has_blk(bs)) {
M
Max Reitz 已提交
2504
        error_setg(errp, "Node '%s' is already in use by '%s'", node_name,
K
Kevin Wolf 已提交
2505
                   bdrv_get_parent_name(bs));
M
Max Reitz 已提交
2506 2507 2508 2509 2510 2511
        return;
    }

    qmp_blockdev_insert_anon_medium(device, bs, errp);
}

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

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

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

    bdrv_flags = blk_get_open_flags_from_root_state(blk);
2537 2538
    bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
        BDRV_O_PROTOCOL);
2539

2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559
    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 已提交
2560
    if (has_format) {
2561 2562 2563 2564
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(format));
    }

M
Max Reitz 已提交
2565 2566
    medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
    if (!medium_bs) {
2567 2568 2569 2570 2571 2572 2573 2574 2575
        goto fail;
    }

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

2576 2577
    rc = do_open_tray(device, false, &err);
    if (rc && rc != -ENOSYS) {
2578 2579 2580
        error_propagate(errp, err);
        goto fail;
    }
2581 2582
    error_free(err);
    err = NULL;
2583

2584
    qmp_x_blockdev_remove_medium(device, &err);
2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

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

2596 2597
    blk_apply_root_state(blk, medium_bs);

2598 2599 2600 2601 2602 2603 2604 2605 2606
    qmp_blockdev_close_tray(device, errp);

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

Z
Zhi Yong Wu 已提交
2607
/* throttling disk I/O limits */
2608
void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
Z
Zhi Yong Wu 已提交
2609
{
2610
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
2611
    BlockDriverState *bs;
2612
    BlockBackend *blk;
2613
    AioContext *aio_context;
Z
Zhi Yong Wu 已提交
2614

2615
    blk = blk_by_name(arg->device);
2616
    if (!blk) {
2617
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2618
                  "Device '%s' not found", arg->device);
2619
        return;
Z
Zhi Yong Wu 已提交
2620
    }
M
Max Reitz 已提交
2621 2622 2623 2624

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

2625
    bs = blk_bs(blk);
M
Max Reitz 已提交
2626
    if (!bs) {
2627
        error_setg(errp, "Device '%s' has no medium", arg->device);
M
Max Reitz 已提交
2628 2629
        goto out;
    }
Z
Zhi Yong Wu 已提交
2630

2631
    throttle_config_init(&cfg);
2632 2633 2634
    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;
2635

2636 2637 2638
    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;
2639

2640 2641
    if (arg->has_bps_max) {
        cfg.buckets[THROTTLE_BPS_TOTAL].max = arg->bps_max;
2642
    }
2643 2644
    if (arg->has_bps_rd_max) {
        cfg.buckets[THROTTLE_BPS_READ].max = arg->bps_rd_max;
2645
    }
2646 2647
    if (arg->has_bps_wr_max) {
        cfg.buckets[THROTTLE_BPS_WRITE].max = arg->bps_wr_max;
2648
    }
2649 2650
    if (arg->has_iops_max) {
        cfg.buckets[THROTTLE_OPS_TOTAL].max = arg->iops_max;
2651
    }
2652 2653
    if (arg->has_iops_rd_max) {
        cfg.buckets[THROTTLE_OPS_READ].max = arg->iops_rd_max;
2654
    }
2655 2656
    if (arg->has_iops_wr_max) {
        cfg.buckets[THROTTLE_OPS_WRITE].max = arg->iops_wr_max;
2657
    }
Z
Zhi Yong Wu 已提交
2658

2659 2660
    if (arg->has_bps_max_length) {
        cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = arg->bps_max_length;
2661
    }
2662 2663
    if (arg->has_bps_rd_max_length) {
        cfg.buckets[THROTTLE_BPS_READ].burst_length = arg->bps_rd_max_length;
2664
    }
2665 2666
    if (arg->has_bps_wr_max_length) {
        cfg.buckets[THROTTLE_BPS_WRITE].burst_length = arg->bps_wr_max_length;
2667
    }
2668 2669
    if (arg->has_iops_max_length) {
        cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = arg->iops_max_length;
2670
    }
2671 2672
    if (arg->has_iops_rd_max_length) {
        cfg.buckets[THROTTLE_OPS_READ].burst_length = arg->iops_rd_max_length;
2673
    }
2674 2675
    if (arg->has_iops_wr_max_length) {
        cfg.buckets[THROTTLE_OPS_WRITE].burst_length = arg->iops_wr_max_length;
2676 2677
    }

2678 2679
    if (arg->has_iops_size) {
        cfg.op_size = arg->iops_size;
2680
    }
2681

2682
    if (!throttle_is_valid(&cfg, errp)) {
M
Max Reitz 已提交
2683
        goto out;
Z
Zhi Yong Wu 已提交
2684 2685
    }

2686 2687 2688
    if (throttle_enabled(&cfg)) {
        /* Enable I/O limits if they're not enabled yet, otherwise
         * just update the throttling group. */
2689
        if (!blk_get_public(blk)->throttle_state) {
2690 2691 2692 2693
            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);
2694 2695
        }
        /* Set the new throttling configuration */
2696 2697
        blk_set_io_limits(blk, &cfg);
    } else if (blk_get_public(blk)->throttle_state) {
2698
        /* If all throttling settings are set to 0, disable I/O limits */
2699
        blk_io_limits_disable(blk);
Z
Zhi Yong Wu 已提交
2700
    }
2701

M
Max Reitz 已提交
2702
out:
2703
    aio_context_release(aio_context);
Z
Zhi Yong Wu 已提交
2704 2705
}

2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
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 已提交
2755 2756 2757 2758 2759 2760
    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be removed",
                   name);
        goto out;
    }
2761
    bdrv_dirty_bitmap_make_anon(bitmap);
2762 2763
    bdrv_release_dirty_bitmap(bs, bitmap);

J
John Snow 已提交
2764
 out:
2765 2766 2767
    aio_context_release(aio_context);
}

J
John Snow 已提交
2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795
/**
 * 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 已提交
2796
    bdrv_clear_dirty_bitmap(bitmap, NULL);
J
John Snow 已提交
2797 2798 2799 2800 2801

 out:
    aio_context_release(aio_context);
}

2802
void hmp_drive_del(Monitor *mon, const QDict *qdict)
2803 2804
{
    const char *id = qdict_get_str(qdict, "id");
2805
    BlockBackend *blk;
2806
    BlockDriverState *bs;
2807
    AioContext *aio_context;
2808
    Error *local_err = NULL;
2809

2810 2811 2812 2813 2814 2815 2816 2817 2818
    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;
    }

2819 2820
    blk = blk_by_name(id);
    if (!blk) {
2821
        error_report("Device '%s' not found", id);
2822
        return;
2823
    }
2824

2825
    if (!blk_legacy_dinfo(blk)) {
2826 2827
        error_report("Deleting device added with blockdev-add"
                     " is not supported");
2828
        return;
2829 2830
    }

M
Max Reitz 已提交
2831
    aio_context = blk_get_aio_context(blk);
2832 2833
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
2834 2835 2836 2837 2838 2839 2840
    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;
        }
2841

2842
        blk_remove_bs(blk);
M
Max Reitz 已提交
2843
    }
2844

2845
    /* Make the BlockBackend and the attached BlockDriverState anonymous */
2846 2847
    monitor_remove_blk(blk);

2848 2849
    /* 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.
2850
     */
2851
    if (blk_get_attached_dev(blk)) {
2852
        /* Further I/O must not pause the guest */
2853 2854
        blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
                         BLOCKDEV_ON_ERROR_REPORT);
2855
    } else {
2856
        blk_unref(blk);
2857 2858
    }

2859
    aio_context_release(aio_context);
2860
}
2861

2862 2863 2864
void qmp_block_resize(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      int64_t size, Error **errp)
2865
{
2866
    Error *local_err = NULL;
2867
    BlockDriverState *bs;
2868
    AioContext *aio_context;
2869
    int ret;
2870

2871 2872 2873
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2874
    if (local_err) {
2875 2876 2877 2878
        error_propagate(errp, local_err);
        return;
    }

2879 2880 2881
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2882
    if (!bdrv_is_first_non_filter(bs)) {
2883
        error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2884
        goto out;
2885 2886 2887
    }

    if (size < 0) {
2888
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2889
        goto out;
2890 2891
    }

2892
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2893
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2894
        goto out;
2895 2896
    }

2897 2898 2899
    /* complete all in-flight operations before resizing the device */
    bdrv_drain_all();

2900 2901
    ret = bdrv_truncate(bs, size);
    switch (ret) {
2902 2903 2904
    case 0:
        break;
    case -ENOMEDIUM:
2905
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2906 2907
        break;
    case -ENOTSUP:
2908
        error_setg(errp, QERR_UNSUPPORTED);
2909 2910
        break;
    case -EACCES:
2911
        error_setg(errp, "Device '%s' is read only", device);
2912 2913
        break;
    case -EBUSY:
2914
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2915 2916
        break;
    default:
2917
        error_setg_errno(errp, -ret, "Could not resize");
2918
        break;
2919
    }
2920 2921 2922

out:
    aio_context_release(aio_context);
2923
}
S
Stefan Hajnoczi 已提交
2924

2925
static void block_job_cb(void *opaque, int ret)
S
Stefan Hajnoczi 已提交
2926
{
2927 2928 2929 2930 2931
    /* 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 已提交
2932
    BlockDriverState *bs = opaque;
2933
    const char *msg = NULL;
S
Stefan Hajnoczi 已提交
2934

2935
    trace_block_job_cb(bs, bs->job, ret);
S
Stefan Hajnoczi 已提交
2936 2937

    assert(bs->job);
2938

S
Stefan Hajnoczi 已提交
2939
    if (ret < 0) {
2940
        msg = strerror(-ret);
S
Stefan Hajnoczi 已提交
2941 2942
    }

2943
    if (block_job_is_cancelled(bs->job)) {
2944
        block_job_event_cancelled(bs->job);
2945
    } else {
2946
        block_job_event_completed(bs->job, msg);
2947
    }
S
Stefan Hajnoczi 已提交
2948 2949
}

2950
void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
2951 2952 2953
                      bool has_base, const char *base,
                      bool has_backing_file, const char *backing_file,
                      bool has_speed, int64_t speed,
P
Paolo Bonzini 已提交
2954 2955
                      bool has_on_error, BlockdevOnError on_error,
                      Error **errp)
S
Stefan Hajnoczi 已提交
2956 2957
{
    BlockDriverState *bs;
2958
    BlockDriverState *base_bs = NULL;
2959
    AioContext *aio_context;
2960
    Error *local_err = NULL;
2961
    const char *base_name = NULL;
S
Stefan Hajnoczi 已提交
2962

P
Paolo Bonzini 已提交
2963 2964 2965 2966
    if (!has_on_error) {
        on_error = BLOCKDEV_ON_ERROR_REPORT;
    }

2967 2968
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
S
Stefan Hajnoczi 已提交
2969 2970 2971
        return;
    }

2972
    aio_context = bdrv_get_aio_context(bs);
2973 2974
    aio_context_acquire(aio_context);

2975
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
2976
        goto out;
2977 2978
    }

2979
    if (has_base) {
2980 2981
        base_bs = bdrv_find_backing_image(bs, base);
        if (base_bs == NULL) {
2982
            error_setg(errp, QERR_BASE_NOT_FOUND, base);
2983
            goto out;
2984
        }
2985
        assert(bdrv_get_aio_context(base_bs) == aio_context);
2986
        base_name = base;
S
Stefan Hajnoczi 已提交
2987 2988
    }

2989 2990 2991 2992 2993
    /* 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");
2994
        goto out;
2995 2996 2997 2998 2999
    }

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

3000 3001
    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);
3002
    if (local_err) {
3003
        error_propagate(errp, local_err);
3004
        goto out;
S
Stefan Hajnoczi 已提交
3005 3006 3007
    }

    trace_qmp_block_stream(bs, bs->job);
3008 3009 3010

out:
    aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
3011
}
3012

3013
void qmp_block_commit(bool has_job_id, const char *job_id, const char *device,
3014 3015
                      bool has_base, const char *base,
                      bool has_top, const char *top,
3016
                      bool has_backing_file, const char *backing_file,
3017 3018 3019 3020 3021
                      bool has_speed, int64_t speed,
                      Error **errp)
{
    BlockDriverState *bs;
    BlockDriverState *base_bs, *top_bs;
3022
    AioContext *aio_context;
3023 3024 3025 3026
    Error *local_err = NULL;
    /* This will be part of the QMP command, if/when the
     * BlockdevOnError change for blkmirror makes it in
     */
3027
    BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3028

3029 3030 3031 3032
    if (!has_speed) {
        speed = 0;
    }

3033 3034 3035 3036 3037
    /* 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. */
3038 3039 3040 3041 3042 3043 3044 3045 3046 3047
    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);
        }
3048
        return;
3049 3050
    }

3051
    aio_context = bdrv_get_aio_context(bs);
3052 3053
    aio_context_acquire(aio_context);

3054
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3055
        goto out;
3056 3057 3058 3059 3060
    }

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

3061
    if (has_top && top) {
3062 3063 3064 3065 3066 3067 3068
        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");
3069
        goto out;
3070 3071
    }

3072 3073
    assert(bdrv_get_aio_context(top_bs) == aio_context);

3074 3075 3076 3077 3078 3079 3080
    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) {
3081
        error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3082
        goto out;
3083 3084
    }

3085 3086
    assert(bdrv_get_aio_context(base_bs) == aio_context);

3087 3088 3089 3090
    if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
        goto out;
    }

3091 3092 3093
    /* Do not allow attempts to commit an image into itself */
    if (top_bs == base_bs) {
        error_setg(errp, "cannot commit an image into itself");
3094
        goto out;
3095 3096
    }

F
Fam Zheng 已提交
3097
    if (top_bs == bs) {
3098 3099 3100
        if (has_backing_file) {
            error_setg(errp, "'backing-file' specified,"
                             " but 'top' is the active layer");
3101
            goto out;
3102
        }
3103 3104
        commit_active_start(has_job_id ? job_id : NULL, bs, base_bs, speed,
                            on_error, block_job_cb, bs, &local_err);
F
Fam Zheng 已提交
3105
    } else {
3106 3107
        commit_start(has_job_id ? job_id : NULL, bs, base_bs, top_bs, speed,
                     on_error, block_job_cb, bs,
3108
                     has_backing_file ? backing_file : NULL, &local_err);
F
Fam Zheng 已提交
3109
    }
3110 3111
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3112
        goto out;
3113
    }
3114 3115 3116

out:
    aio_context_release(aio_context);
3117 3118
}

P
Pavel Butsykin 已提交
3119
static void do_drive_backup(DriveBackup *backup, BlockJobTxn *txn, Error **errp)
3120 3121 3122
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
3123
    BlockDriverState *source = NULL;
3124
    BdrvDirtyBitmap *bmap = NULL;
3125
    AioContext *aio_context;
3126
    QDict *options = NULL;
3127 3128 3129 3130
    Error *local_err = NULL;
    int flags;
    int64_t size;

P
Pavel Butsykin 已提交
3131 3132
    if (!backup->has_speed) {
        backup->speed = 0;
3133
    }
P
Pavel Butsykin 已提交
3134 3135
    if (!backup->has_on_source_error) {
        backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3136
    }
P
Pavel Butsykin 已提交
3137 3138
    if (!backup->has_on_target_error) {
        backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3139
    }
P
Pavel Butsykin 已提交
3140 3141 3142 3143 3144
    if (!backup->has_mode) {
        backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
    if (!backup->has_job_id) {
        backup->job_id = NULL;
3145 3146
    }

P
Pavel Butsykin 已提交
3147
    bs = qmp_get_root_bs(backup->device, errp);
3148
    if (!bs) {
3149 3150 3151
        return;
    }

3152
    aio_context = bdrv_get_aio_context(bs);
3153 3154
    aio_context_acquire(aio_context);

P
Pavel Butsykin 已提交
3155 3156 3157
    if (!backup->has_format) {
        backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
                         NULL : (char*) bs->drv->format_name;
3158 3159
    }

F
Fam Zheng 已提交
3160
    /* Early check to avoid creating target */
3161
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3162
        goto out;
3163 3164
    }

K
Kevin Wolf 已提交
3165
    flags = bs->open_flags | BDRV_O_RDWR;
3166

3167 3168
    /* See if we have a backing HD we can use to create our new image
     * on top of. */
P
Pavel Butsykin 已提交
3169
    if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3170
        source = backing_bs(bs);
3171
        if (!source) {
P
Pavel Butsykin 已提交
3172
            backup->sync = MIRROR_SYNC_MODE_FULL;
3173 3174
        }
    }
P
Pavel Butsykin 已提交
3175
    if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3176 3177 3178
        source = bs;
    }

3179 3180 3181
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3182
        goto out;
3183 3184
    }

P
Pavel Butsykin 已提交
3185 3186
    if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
        assert(backup->format);
3187
        if (source) {
P
Pavel Butsykin 已提交
3188
            bdrv_img_create(backup->target, backup->format, source->filename,
3189 3190 3191
                            source->drv->format_name, NULL,
                            size, flags, &local_err, false);
        } else {
P
Pavel Butsykin 已提交
3192
            bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3193 3194
                            size, flags, &local_err, false);
        }
3195 3196
    }

3197
    if (local_err) {
3198
        error_propagate(errp, local_err);
3199
        goto out;
3200 3201
    }

P
Pavel Butsykin 已提交
3202
    if (backup->format) {
3203
        options = qdict_new();
P
Pavel Butsykin 已提交
3204
        qdict_put(options, "driver", qstring_from_str(backup->format));
3205 3206
    }

P
Pavel Butsykin 已提交
3207
    target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
M
Max Reitz 已提交
3208
    if (!target_bs) {
3209
        goto out;
3210 3211
    }

3212 3213
    bdrv_set_aio_context(target_bs, aio_context);

P
Pavel Butsykin 已提交
3214 3215
    if (backup->has_bitmap) {
        bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3216
        if (!bmap) {
P
Pavel Butsykin 已提交
3217
            error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3218
            bdrv_unref(target_bs);
3219 3220 3221 3222
            goto out;
        }
    }

P
Pavel Butsykin 已提交
3223 3224
    backup_start(backup->job_id, bs, target_bs, backup->speed, backup->sync,
                 bmap, backup->on_source_error, backup->on_target_error,
3225
                 block_job_cb, bs, txn, &local_err);
K
Kevin Wolf 已提交
3226
    bdrv_unref(target_bs);
3227 3228
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3229
        goto out;
3230
    }
3231 3232 3233

out:
    aio_context_release(aio_context);
3234 3235
}

P
Pavel Butsykin 已提交
3236
void qmp_drive_backup(DriveBackup *arg, Error **errp)
3237
{
P
Pavel Butsykin 已提交
3238
    return do_drive_backup(arg, NULL, errp);
3239 3240
}

3241 3242
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
3243
    return bdrv_named_nodes_list(errp);
3244 3245
}

3246 3247
void do_blockdev_backup(const char *job_id, const char *device,
                        const char *target, enum MirrorSyncMode sync,
F
Fam Zheng 已提交
3248 3249 3250 3251 3252
                         bool has_speed, int64_t speed,
                         bool has_on_source_error,
                         BlockdevOnError on_source_error,
                         bool has_on_target_error,
                         BlockdevOnError on_target_error,
3253
                         BlockJobTxn *txn, Error **errp)
F
Fam Zheng 已提交
3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
    Error *local_err = NULL;
    AioContext *aio_context;

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

3270 3271
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
F
Fam Zheng 已提交
3272 3273 3274
        return;
    }

3275
    aio_context = bdrv_get_aio_context(bs);
F
Fam Zheng 已提交
3276 3277
    aio_context_acquire(aio_context);

3278 3279
    target_bs = bdrv_lookup_bs(target, target, errp);
    if (!target_bs) {
M
Max Reitz 已提交
3280 3281
        goto out;
    }
F
Fam Zheng 已提交
3282

3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293
    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;
        }
    }
3294
    backup_start(job_id, bs, target_bs, speed, sync, NULL, on_source_error,
3295
                 on_target_error, block_job_cb, bs, txn, &local_err);
F
Fam Zheng 已提交
3296 3297 3298 3299 3300 3301 3302
    if (local_err != NULL) {
        error_propagate(errp, local_err);
    }
out:
    aio_context_release(aio_context);
}

3303 3304
void qmp_blockdev_backup(bool has_job_id, const char *job_id,
                         const char *device, const char *target,
3305 3306 3307 3308 3309 3310 3311 3312
                         enum MirrorSyncMode sync,
                         bool has_speed, int64_t speed,
                         bool has_on_source_error,
                         BlockdevOnError on_source_error,
                         bool has_on_target_error,
                         BlockdevOnError on_target_error,
                         Error **errp)
{
3313 3314
    do_blockdev_backup(has_job_id ? job_id : NULL, device, target,
                       sync, has_speed, speed,
3315 3316 3317 3318 3319
                       has_on_source_error, on_source_error,
                       has_on_target_error, on_target_error,
                       NULL, errp);
}

3320 3321 3322
/* Parameter check and block job starting for drive mirroring.
 * Caller should hold @device and @target's aio context (must be the same).
 **/
3323
static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3324 3325 3326
                                   BlockDriverState *target,
                                   bool has_replaces, const char *replaces,
                                   enum MirrorSyncMode sync,
M
Max Reitz 已提交
3327
                                   BlockMirrorBackingMode backing_mode,
3328 3329 3330 3331 3332 3333 3334 3335 3336
                                   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 已提交
3337 3338 3339 3340 3341
{

    if (!has_speed) {
        speed = 0;
    }
3342 3343 3344 3345 3346 3347
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
3348 3349 3350
    if (!has_granularity) {
        granularity = 0;
    }
3351
    if (!has_buf_size) {
W
Wen Congyang 已提交
3352
        buf_size = 0;
3353
    }
3354 3355 3356
    if (!has_unmap) {
        unmap = true;
    }
3357

3358
    if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3359 3360
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "a value in range [512B, 64MB]");
3361 3362 3363
        return;
    }
    if (granularity & (granularity - 1)) {
3364 3365
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "power of 2");
3366 3367
        return;
    }
P
Paolo Bonzini 已提交
3368

3369 3370 3371
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
        return;
    }
F
Fam Zheng 已提交
3372 3373 3374
    if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
        return;
    }
3375 3376 3377 3378 3379 3380 3381 3382

    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
     */
3383
    mirror_start(job_id, bs, target,
3384
                 has_replaces ? replaces : NULL,
M
Max Reitz 已提交
3385
                 speed, granularity, buf_size, sync, backing_mode,
3386 3387 3388 3389
                 on_source_error, on_target_error, unmap,
                 block_job_cb, bs, errp);
}

E
Eric Blake 已提交
3390
void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3391 3392 3393 3394
{
    BlockDriverState *bs;
    BlockDriverState *source, *target_bs;
    AioContext *aio_context;
M
Max Reitz 已提交
3395
    BlockMirrorBackingMode backing_mode;
3396 3397 3398 3399
    Error *local_err = NULL;
    QDict *options = NULL;
    int flags;
    int64_t size;
E
Eric Blake 已提交
3400
    const char *format = arg->format;
3401

3402 3403
    bs = qmp_get_root_bs(arg->device, errp);
    if (!bs) {
P
Paolo Bonzini 已提交
3404 3405 3406
        return;
    }

3407
    aio_context = bdrv_get_aio_context(bs);
3408 3409
    aio_context_acquire(aio_context);

E
Eric Blake 已提交
3410 3411
    if (!arg->has_mode) {
        arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3412
    }
P
Paolo Bonzini 已提交
3413

E
Eric Blake 已提交
3414 3415 3416
    if (!arg->has_format) {
        format = (arg->mode == NEW_IMAGE_MODE_EXISTING
                  ? NULL : bs->drv->format_name);
P
Paolo Bonzini 已提交
3417 3418
    }

K
Kevin Wolf 已提交
3419
    flags = bs->open_flags | BDRV_O_RDWR;
3420
    source = backing_bs(bs);
E
Eric Blake 已提交
3421 3422
    if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
        arg->sync = MIRROR_SYNC_MODE_FULL;
P
Paolo Bonzini 已提交
3423
    }
E
Eric Blake 已提交
3424
    if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3425 3426
        source = bs;
    }
P
Paolo Bonzini 已提交
3427

3428 3429 3430
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3431
        goto out;
3432 3433
    }

E
Eric Blake 已提交
3434
    if (arg->has_replaces) {
3435
        BlockDriverState *to_replace_bs;
3436 3437
        AioContext *replace_aio_context;
        int64_t replace_size;
3438

E
Eric Blake 已提交
3439
        if (!arg->has_node_name) {
3440 3441
            error_setg(errp, "a node-name must be provided when replacing a"
                             " named node of the graph");
3442
            goto out;
3443 3444
        }

E
Eric Blake 已提交
3445
        to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3446 3447 3448

        if (!to_replace_bs) {
            error_propagate(errp, local_err);
3449
            goto out;
3450 3451
        }

3452 3453 3454 3455 3456 3457
        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) {
3458 3459
            error_setg(errp, "cannot replace image with a mirror image of "
                             "different size");
3460
            goto out;
3461 3462 3463
        }
    }

E
Eric Blake 已提交
3464
    if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
M
Max Reitz 已提交
3465 3466 3467 3468 3469
        backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
    } else {
        backing_mode = MIRROR_OPEN_BACKING_CHAIN;
    }

E
Eric Blake 已提交
3470 3471
    if ((arg->sync == MIRROR_SYNC_MODE_FULL || !source)
        && arg->mode != NEW_IMAGE_MODE_EXISTING)
3472
    {
P
Paolo Bonzini 已提交
3473
        /* create new image w/o backing file */
3474
        assert(format);
E
Eric Blake 已提交
3475
        bdrv_img_create(arg->target, format,
3476
                        NULL, NULL, NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3477
    } else {
E
Eric Blake 已提交
3478
        switch (arg->mode) {
P
Paolo Bonzini 已提交
3479 3480 3481 3482
        case NEW_IMAGE_MODE_EXISTING:
            break;
        case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
            /* create new image with backing file */
E
Eric Blake 已提交
3483
            bdrv_img_create(arg->target, format,
3484 3485
                            source->filename,
                            source->drv->format_name,
3486
                            NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3487 3488 3489 3490 3491 3492
            break;
        default:
            abort();
        }
    }

3493
    if (local_err) {
3494
        error_propagate(errp, local_err);
3495
        goto out;
P
Paolo Bonzini 已提交
3496 3497
    }

3498
    options = qdict_new();
E
Eric Blake 已提交
3499 3500
    if (arg->has_node_name) {
        qdict_put(options, "node-name", qstring_from_str(arg->node_name));
3501
    }
3502 3503 3504
    if (format) {
        qdict_put(options, "driver", qstring_from_str(format));
    }
3505

3506 3507 3508
    /* Mirroring takes care of copy-on-write using the source's backing
     * file.
     */
E
Eric Blake 已提交
3509 3510
    target_bs = bdrv_open(arg->target, NULL, options,
                          flags | BDRV_O_NO_BACKING, errp);
M
Max Reitz 已提交
3511
    if (!target_bs) {
3512
        goto out;
P
Paolo Bonzini 已提交
3513 3514
    }

3515 3516
    bdrv_set_aio_context(target_bs, aio_context);

E
Eric Blake 已提交
3517 3518 3519 3520 3521 3522 3523 3524
    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,
3525
                           &local_err);
K
Kevin Wolf 已提交
3526
    bdrv_unref(target_bs);
3527
    error_propagate(errp, local_err);
3528 3529
out:
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3530 3531
}

3532 3533
void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
                         const char *device, const char *target,
F
Fam Zheng 已提交
3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547
                         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 已提交
3548
    BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
F
Fam Zheng 已提交
3549 3550
    Error *local_err = NULL;

3551
    bs = qmp_get_root_bs(device, errp);
F
Fam Zheng 已提交
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565
    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);

3566
    blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
M
Max Reitz 已提交
3567
                           has_replaces, replaces, sync, backing_mode,
F
Fam Zheng 已提交
3568 3569 3570 3571 3572 3573 3574
                           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);
3575
    error_propagate(errp, local_err);
F
Fam Zheng 已提交
3576 3577 3578 3579

    aio_context_release(aio_context);
}

3580 3581
/* Get a block job using its ID and acquire its AioContext */
static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3582
                                Error **errp)
3583
{
3584
    BlockJob *job;
3585

3586
    assert(id != NULL);
M
Max Reitz 已提交
3587

3588
    *aio_context = NULL;
3589

3590
    job = block_job_get(id);
M
Max Reitz 已提交
3591

3592 3593 3594 3595
    if (!job) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
                  "Block job '%s' not found", id);
        return NULL;
3596
    }
3597

3598 3599
    *aio_context = blk_get_aio_context(job->blk);
    aio_context_acquire(*aio_context);
3600

3601
    return job;
3602 3603
}

3604
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3605
{
3606
    AioContext *aio_context;
3607
    BlockJob *job = find_block_job(device, &aio_context, errp);
3608 3609 3610 3611 3612

    if (!job) {
        return;
    }

3613
    block_job_set_speed(job, speed, errp);
3614
    aio_context_release(aio_context);
3615
}
3616

3617 3618
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
3619
{
3620
    AioContext *aio_context;
3621
    BlockJob *job = find_block_job(device, &aio_context, errp);
3622

3623 3624 3625
    if (!job) {
        return;
    }
3626 3627 3628 3629 3630

    if (!has_force) {
        force = false;
    }

F
Fam Zheng 已提交
3631
    if (job->user_paused && !force) {
3632 3633
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
3634
        goto out;
3635
    }
3636 3637 3638

    trace_qmp_block_job_cancel(job);
    block_job_cancel(job);
3639 3640
out:
    aio_context_release(aio_context);
3641
}
S
Stefan Hajnoczi 已提交
3642

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

F
Fam Zheng 已提交
3648
    if (!job || job->user_paused) {
3649 3650 3651
        return;
    }

F
Fam Zheng 已提交
3652
    job->user_paused = true;
3653 3654
    trace_qmp_block_job_pause(job);
    block_job_pause(job);
3655
    aio_context_release(aio_context);
3656 3657 3658 3659
}

void qmp_block_job_resume(const char *device, Error **errp)
{
3660
    AioContext *aio_context;
3661
    BlockJob *job = find_block_job(device, &aio_context, errp);
3662

F
Fam Zheng 已提交
3663
    if (!job || !job->user_paused) {
3664 3665 3666
        return;
    }

F
Fam Zheng 已提交
3667
    job->user_paused = false;
3668
    trace_qmp_block_job_resume(job);
3669
    block_job_iostatus_reset(job);
3670
    block_job_resume(job);
3671
    aio_context_release(aio_context);
3672 3673
}

P
Paolo Bonzini 已提交
3674 3675
void qmp_block_job_complete(const char *device, Error **errp)
{
3676
    AioContext *aio_context;
3677
    BlockJob *job = find_block_job(device, &aio_context, errp);
P
Paolo Bonzini 已提交
3678 3679 3680 3681 3682 3683 3684

    if (!job) {
        return;
    }

    trace_qmp_block_job_complete(job);
    block_job_complete(job, errp);
3685
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3686 3687
}

3688 3689 3690 3691 3692 3693
void qmp_change_backing_file(const char *device,
                             const char *image_node_name,
                             const char *backing_file,
                             Error **errp)
{
    BlockDriverState *bs = NULL;
3694
    AioContext *aio_context;
3695 3696 3697 3698 3699 3700
    BlockDriverState *image_bs = NULL;
    Error *local_err = NULL;
    bool ro;
    int open_flags;
    int ret;

3701 3702
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
3703 3704 3705
        return;
    }

3706
    aio_context = bdrv_get_aio_context(bs);
3707 3708
    aio_context_acquire(aio_context);

3709 3710 3711
    image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
3712
        goto out;
3713 3714 3715 3716
    }

    if (!image_bs) {
        error_setg(errp, "image file not found");
3717
        goto out;
3718 3719 3720 3721 3722
    }

    if (bdrv_find_base(image_bs) == image_bs) {
        error_setg(errp, "not allowing backing file change on an image "
                         "without a backing file");
3723
        goto out;
3724 3725 3726 3727 3728
    }

    /* 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)) {
3729
        goto out;
3730 3731 3732 3733 3734 3735
    }

    /* final sanity check */
    if (!bdrv_chain_contains(bs, image_bs)) {
        error_setg(errp, "'%s' and image file are not in the same chain",
                   device);
3736
        goto out;
3737 3738 3739 3740 3741 3742 3743 3744 3745 3746
    }

    /* 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);
3747
            goto out;
3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762
        }
    }

    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);
3763
        error_propagate(errp, local_err);
3764
    }
3765 3766 3767

out:
    aio_context_release(aio_context);
3768 3769
}

3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783
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")) {
3784
        QDECREF(qdict);
3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800
        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 已提交
3801 3802
void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
{
3803 3804
    BlockDriverState *bs;
    BlockBackend *blk = NULL;
K
Kevin Wolf 已提交
3805
    QObject *obj;
3806
    Visitor *v = qmp_output_visitor_new(&obj);
K
Kevin Wolf 已提交
3807 3808 3809
    QDict *qdict;
    Error *local_err = NULL;

3810
    /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
K
Kevin Wolf 已提交
3811
     * cache.direct=false instead of silently switching to aio=threads, except
3812
     * when called from drive_new().
K
Kevin Wolf 已提交
3813 3814 3815
     *
     * For now, simply forbidding the combination for all drivers will do. */
    if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3816 3817 3818 3819
        bool direct = options->has_cache &&
                      options->cache->has_direct &&
                      options->cache->direct;
        if (!direct) {
K
Kevin Wolf 已提交
3820 3821 3822 3823 3824
            error_setg(errp, "aio=native requires cache.direct=true");
            goto fail;
        }
    }

3825
    visit_type_BlockdevOptions(v, NULL, &options, &local_err);
3826
    if (local_err) {
K
Kevin Wolf 已提交
3827 3828 3829 3830
        error_propagate(errp, local_err);
        goto fail;
    }

3831
    visit_complete(v, &obj);
K
Kevin Wolf 已提交
3832 3833 3834 3835
    qdict = qobject_to_qdict(obj);

    qdict_flatten(qdict);

3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850
    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;
        }

3851 3852
        bs = bds_tree_init(qdict, errp);
        if (!bs) {
3853 3854
            goto fail;
        }
3855 3856

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

3859 3860
    if (bs && bdrv_key_required(bs)) {
        if (blk) {
3861
            monitor_remove_blk(blk);
3862 3863
            blk_unref(blk);
        } else {
3864
            QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3865 3866
            bdrv_unref(bs);
        }
3867 3868 3869 3870
        error_setg(errp, "blockdev-add doesn't support encrypted devices");
        goto fail;
    }

K
Kevin Wolf 已提交
3871
fail:
3872
    visit_free(v);
K
Kevin Wolf 已提交
3873 3874
}

3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890
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) {
3891
        /* blk_by_name() never returns a BB that is not owned by the monitor */
3892 3893 3894 3895 3896
        blk = blk_by_name(id);
        if (!blk) {
            error_setg(errp, "Cannot find block backend %s", id);
            return;
        }
3897 3898 3899 3900 3901
        if (blk_legacy_dinfo(blk)) {
            error_setg(errp, "Deleting block backend added with drive-add"
                       " is not supported");
            return;
        }
3902 3903 3904 3905 3906 3907 3908
        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 已提交
3909
        blk = NULL;
3910 3911 3912 3913 3914
        bs = bdrv_find_node(node_name);
        if (!bs) {
            error_setg(errp, "Cannot find node %s", node_name);
            return;
        }
K
Kevin Wolf 已提交
3915
        if (bdrv_has_blk(bs)) {
3916
            error_setg(errp, "Node %s is in use by %s",
K
Kevin Wolf 已提交
3917
                       node_name, bdrv_get_parent_name(bs));
3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929
            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;
        }

3930 3931 3932 3933 3934 3935 3936
        if (!blk && !bs->monitor_list.tqe_prev) {
            error_setg(errp, "Node %s is not owned by the monitor",
                       bs->node_name);
            goto out;
        }

        if (bs->refcnt > 1) {
3937 3938 3939 3940 3941 3942 3943
            error_setg(errp, "Block device %s is in use",
                       bdrv_get_device_or_node_name(bs));
            goto out;
        }
    }

    if (blk) {
3944
        monitor_remove_blk(blk);
3945 3946
        blk_unref(blk);
    } else {
3947
        QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3948 3949 3950 3951 3952 3953 3954
        bdrv_unref(bs);
    }

out:
    aio_context_release(aio_context);
}

3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 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
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);
    }
}

4010
BlockJobInfoList *qmp_query_block_jobs(Error **errp)
S
Stefan Hajnoczi 已提交
4011
{
4012
    BlockJobInfoList *head = NULL, **p_next = &head;
4013
    BlockJob *job;
S
Stefan Hajnoczi 已提交
4014

4015 4016 4017
    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);
4018 4019

        aio_context_acquire(aio_context);
4020
        elem->value = block_job_query(job);
4021
        aio_context_release(aio_context);
4022 4023 4024

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

4027
    return head;
S
Stefan Hajnoczi 已提交
4028
}
4029

4030
QemuOptsList qemu_common_drive_opts = {
4031
    .name = "drive",
4032
    .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4033 4034 4035 4036 4037
    .desc = {
        {
            .name = "snapshot",
            .type = QEMU_OPT_BOOL,
            .help = "enable/disable snapshot mode",
4038 4039 4040 4041
        },{
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
4042 4043 4044 4045
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
4046 4047 4048 4049
        },{
            .name = BDRV_OPT_CACHE_WB,
            .type = QEMU_OPT_BOOL,
            .help = "Enable writeback mode",
4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062
        },{
            .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",
        },{
4063
            .name = "read-only",
4064 4065 4066
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
4067
            .name = "throttling.iops-total",
4068 4069 4070
            .type = QEMU_OPT_NUMBER,
            .help = "limit total I/O operations per second",
        },{
4071
            .name = "throttling.iops-read",
4072 4073 4074
            .type = QEMU_OPT_NUMBER,
            .help = "limit read operations per second",
        },{
4075
            .name = "throttling.iops-write",
4076 4077 4078
            .type = QEMU_OPT_NUMBER,
            .help = "limit write operations per second",
        },{
4079
            .name = "throttling.bps-total",
4080 4081 4082
            .type = QEMU_OPT_NUMBER,
            .help = "limit total bytes per second",
        },{
4083
            .name = "throttling.bps-read",
4084 4085 4086
            .type = QEMU_OPT_NUMBER,
            .help = "limit read bytes per second",
        },{
4087
            .name = "throttling.bps-write",
4088 4089
            .type = QEMU_OPT_NUMBER,
            .help = "limit write bytes per second",
4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113
        },{
            .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",
4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137
        },{
            .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",
4138 4139 4140 4141
        },{
            .name = "throttling.iops-size",
            .type = QEMU_OPT_NUMBER,
            .help = "when limiting by iops max size of an I/O in bytes",
4142 4143 4144 4145
        },{
            .name = "throttling.group",
            .type = QEMU_OPT_STRING,
            .help = "name of the block throttling group",
4146 4147 4148 4149
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
4150 4151 4152 4153
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
4154 4155 4156 4157 4158 4159 4160 4161 4162 4163
        },{
            .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",
4164 4165 4166 4167
        },
        { /* end of list */ }
    },
};
4168

4169 4170
static QemuOptsList qemu_root_bds_opts = {
    .name = "root-bds",
4171
    .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197
    .desc = {
        {
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
        },{
            .name = "read-only",
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
        },
        { /* end of list */ }
    },
};

4198 4199 4200 4201
QemuOptsList qemu_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
    .desc = {
4202 4203 4204 4205
        /*
         * no elements => accept any params
         * validation will happen later
         */
4206 4207 4208
        { /* end of list */ }
    },
};