blockdev.c 129.9 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 517 518 519 520 521 522
    qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
    qdict_array_split(interval_dict, &interval_list);

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

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

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

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

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

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

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

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

572
        blk = blk_new();
573 574
        blk_rs = blk_get_root_state(blk);
        blk_rs->open_flags    = bdrv_flags;
575
        blk_rs->read_only     = !(bdrv_flags & BDRV_O_RDWR);
576 577
        blk_rs->detect_zeroes = detect_zeroes;

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

584 585 586 587 588
        /* 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");
589
        assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
590

591 592 593 594
        if (runstate_check(RUN_STATE_INMIGRATE)) {
            bdrv_flags |= BDRV_O_INACTIVE;
        }

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

601
        bs->detect_zeroes = detect_zeroes;
602

603 604
        if (bdrv_key_required(bs)) {
            autostart = 0;
605
        }
606 607

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

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

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

625
    blk_set_enable_write_cache(blk, !writethrough);
626
    blk_set_on_error(blk, on_read_error, on_write_error);
627

628 629 630 631 632 633
    if (!monitor_add_blk(blk, qemu_opts_id(opts), errp)) {
        blk_unref(blk);
        blk = NULL;
        goto err_no_bs_opts;
    }

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

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

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
static QemuOptsList qemu_root_bds_opts;

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

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

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

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

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

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

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

705 706 707 708 709 710 711 712 713 714 715 716 717
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 已提交
718 719 720 721 722 723 724
/* 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);
}

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

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

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

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

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

823 824 825 826
        { /* end of list */ }
    },
};

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

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

856 857 858
        { "bps",            "throttling.bps-total" },
        { "bps_rd",         "throttling.bps-read" },
        { "bps_wr",         "throttling.bps-write" },
859

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

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

868
        { "iops_size",      "throttling.iops-size" },
869

870 871
        { "group",          "throttling.group" },

872 873 874 875
        { "readonly",       "read-only" },
    };

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1062 1063 1064
    /* Serial number */
    serial = qemu_opt_get(legacy_opts, "serial");

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

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

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

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

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

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

1145 1146 1147 1148 1149
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

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

1156 1157
    blk_set_legacy_dinfo(blk, dinfo);

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

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

1175
void hmp_commit(Monitor *mon, const QDict *qdict)
1176 1177
{
    const char *device = qdict_get_str(qdict, "device");
1178
    BlockBackend *blk;
1179
    int ret;
1180

1181
    if (!strcmp(device, "all")) {
1182
        ret = blk_commit_all();
1183
    } else {
1184 1185 1186
        BlockDriverState *bs;
        AioContext *aio_context;

1187 1188
        blk = blk_by_name(device);
        if (!blk) {
1189
            monitor_printf(mon, "Device '%s' not found\n", device);
1190
            return;
1191
        }
M
Max Reitz 已提交
1192 1193 1194 1195
        if (!blk_is_available(blk)) {
            monitor_printf(mon, "Device '%s' has no medium\n", device);
            return;
        }
1196 1197 1198 1199 1200 1201 1202 1203

        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);
1204 1205 1206 1207
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
1208 1209 1210
    }
}

1211
static void blockdev_do_action(TransactionAction *action, Error **errp)
1212
{
1213
    TransactionActionList list;
1214

1215
    list.value = action;
1216
    list.next = NULL;
J
John Snow 已提交
1217
    qmp_transaction(&list, false, NULL, errp);
1218 1219
}

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

1248 1249 1250 1251 1252 1253 1254
void qmp_blockdev_snapshot(const char *node, const char *overlay,
                           Error **errp)
{
    BlockdevSnapshot snapshot_data = {
        .node = (char *) node,
        .overlay = (char *) overlay
    };
1255 1256
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1257
        .u.blockdev_snapshot.data = &snapshot_data,
1258 1259
    };
    blockdev_do_action(&action, errp);
1260 1261
}

1262 1263 1264 1265 1266 1267 1268 1269
void qmp_blockdev_snapshot_internal_sync(const char *device,
                                         const char *name,
                                         Error **errp)
{
    BlockdevSnapshotInternal snapshot = {
        .device = (char *) device,
        .name = (char *) name
    };
1270 1271
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1272
        .u.blockdev_snapshot_internal_sync.data = &snapshot,
1273 1274
    };
    blockdev_do_action(&action, errp);
1275 1276
}

1277 1278 1279 1280 1281 1282 1283
SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
                                                         bool has_id,
                                                         const char *id,
                                                         bool has_name,
                                                         const char *name,
                                                         Error **errp)
{
1284 1285
    BlockDriverState *bs;
    BlockBackend *blk;
1286
    AioContext *aio_context;
1287 1288 1289 1290 1291
    QEMUSnapshotInfo sn;
    Error *local_err = NULL;
    SnapshotInfo *info = NULL;
    int ret;

1292 1293
    blk = blk_by_name(device);
    if (!blk) {
1294 1295
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
1296 1297
        return NULL;
    }
M
Max Reitz 已提交
1298 1299 1300

    aio_context = blk_get_aio_context(blk);
    aio_context_acquire(aio_context);
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311

    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 已提交
1312
        goto out_aio_context;
1313 1314
    }

M
Max Reitz 已提交
1315 1316 1317 1318 1319
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out_aio_context;
    }
    bs = blk_bs(blk);
1320

1321 1322 1323 1324
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
        goto out_aio_context;
    }

1325
    ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1326
    if (local_err) {
1327
        error_propagate(errp, local_err);
1328
        goto out_aio_context;
1329 1330 1331 1332 1333 1334
    }
    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);
1335
        goto out_aio_context;
1336 1337 1338
    }

    bdrv_snapshot_delete(bs, id, name, &local_err);
1339
    if (local_err) {
1340
        error_propagate(errp, local_err);
1341
        goto out_aio_context;
1342 1343
    }

1344 1345
    aio_context_release(aio_context);

1346
    info = g_new0(SnapshotInfo, 1);
1347 1348 1349 1350 1351 1352 1353 1354 1355
    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;
1356 1357 1358 1359

out_aio_context:
    aio_context_release(aio_context);
    return NULL;
1360
}
1361

1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
/**
 * 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;
}

1424
/* New and old BlockDriverState structs for atomic group operations */
1425

1426
typedef struct BlkActionState BlkActionState;
1427

1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
/**
 * 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 {
1443
    size_t instance_size;
1444 1445 1446 1447 1448
    void (*prepare)(BlkActionState *common, Error **errp);
    void (*commit)(BlkActionState *common);
    void (*abort)(BlkActionState *common);
    void (*clean)(BlkActionState *common);
} BlkActionOps;
1449

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

1471 1472
/* internal snapshot private data */
typedef struct InternalSnapshotState {
1473
    BlkActionState common;
1474
    BlockDriverState *bs;
1475
    AioContext *aio_context;
1476
    QEMUSnapshotInfo sn;
1477
    bool created;
1478 1479
} InternalSnapshotState;

J
John Snow 已提交
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493

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

1494
static void internal_snapshot_prepare(BlkActionState *common,
1495 1496
                                      Error **errp)
{
1497
    Error *local_err = NULL;
1498 1499
    const char *device;
    const char *name;
1500
    BlockBackend *blk;
1501 1502 1503 1504 1505 1506 1507 1508
    BlockDriverState *bs;
    QEMUSnapshotInfo old_sn, *sn;
    bool ret;
    qemu_timeval tv;
    BlockdevSnapshotInternal *internal;
    InternalSnapshotState *state;
    int ret1;

1509
    g_assert(common->action->type ==
1510
             TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1511
    internal = common->action->u.blockdev_snapshot_internal_sync.data;
1512 1513 1514 1515 1516 1517 1518
    state = DO_UPCAST(InternalSnapshotState, common, common);

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

    /* 2. check for validation */
J
John Snow 已提交
1519 1520 1521 1522
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1523 1524
    blk = blk_by_name(device);
    if (!blk) {
1525 1526
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
1527 1528 1529
        return;
    }

1530
    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1531
    state->aio_context = blk_get_aio_context(blk);
1532 1533
    aio_context_acquire(state->aio_context);

M
Max Reitz 已提交
1534
    if (!blk_is_available(blk)) {
1535
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1536 1537
        return;
    }
M
Max Reitz 已提交
1538
    bs = blk_bs(blk);
1539

1540 1541 1542
    state->bs = bs;
    bdrv_drained_begin(bs);

1543 1544 1545 1546
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
        return;
    }

1547
    if (bdrv_is_read_only(bs)) {
1548
        error_setg(errp, "Device '%s' is read only", device);
1549 1550 1551 1552
        return;
    }

    if (!bdrv_can_snapshot(bs)) {
1553 1554 1555
        error_setg(errp, "Block format '%s' used by device '%s' "
                   "does not support internal snapshots",
                   bs->drv->format_name, device);
1556 1557 1558 1559 1560 1561 1562 1563 1564
        return;
    }

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

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

1597
static void internal_snapshot_abort(BlkActionState *common)
1598 1599 1600 1601 1602 1603 1604
{
    InternalSnapshotState *state =
                             DO_UPCAST(InternalSnapshotState, common, common);
    BlockDriverState *bs = state->bs;
    QEMUSnapshotInfo *sn = &state->sn;
    Error *local_error = NULL;

1605
    if (!state->created) {
1606 1607 1608 1609
        return;
    }

    if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1610 1611 1612 1613 1614
        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));
1615 1616 1617
    }
}

1618
static void internal_snapshot_clean(BlkActionState *common)
1619 1620 1621 1622 1623
{
    InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
                                             common, common);

    if (state->aio_context) {
1624 1625 1626
        if (state->bs) {
            bdrv_drained_end(state->bs);
        }
1627 1628 1629 1630
        aio_context_release(state->aio_context);
    }
}

1631
/* external snapshot private data */
1632
typedef struct ExternalSnapshotState {
1633
    BlkActionState common;
1634 1635
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1636
    AioContext *aio_context;
1637
} ExternalSnapshotState;
1638

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

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

    /* start processing */
J
John Snow 已提交
1682 1683 1684 1685
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1686 1687
    state->old_bs = bdrv_lookup_bs(device, node_name, errp);
    if (!state->old_bs) {
1688 1689 1690
        return;
    }

1691 1692 1693
    /* 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);
1694
    bdrv_drained_begin(state->old_bs);
1695

1696
    if (!bdrv_is_inserted(state->old_bs)) {
1697
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1698 1699 1700
        return;
    }

1701 1702
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1703 1704 1705
        return;
    }

1706 1707
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1708
            error_setg(errp, QERR_IO_ERROR);
1709 1710 1711 1712
            return;
        }
    }

1713
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1714
        error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1715 1716 1717
        return;
    }

1718
    if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1719
        BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1720 1721 1722 1723
        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;
1724

1725 1726
        if (node_name && !snapshot_node_name) {
            error_setg(errp, "New snapshot node name missing");
1727 1728 1729
            return;
        }

1730 1731 1732 1733 1734 1735 1736
        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;
1737
        flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1738 1739 1740 1741

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

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

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

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

1795
static void external_snapshot_commit(BlkActionState *common)
1796
{
1797 1798
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1799

1800 1801
    bdrv_set_aio_context(state->new_bs, state->aio_context);

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

1813
static void external_snapshot_abort(BlkActionState *common)
1814
{
1815 1816 1817
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
F
Fam Zheng 已提交
1818
        bdrv_unref(state->new_bs);
1819
    }
1820 1821
}

1822
static void external_snapshot_clean(BlkActionState *common)
1823 1824 1825
{
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1826
    if (state->aio_context) {
1827
        bdrv_drained_end(state->old_bs);
1828 1829
        aio_context_release(state->aio_context);
    }
1830 1831
}

1832
typedef struct DriveBackupState {
1833
    BlkActionState common;
1834
    BlockDriverState *bs;
1835
    AioContext *aio_context;
1836 1837 1838
    BlockJob *job;
} DriveBackupState;

1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
static void do_drive_backup(const char *device, const char *target,
                            bool has_format, const char *format,
                            enum MirrorSyncMode sync,
                            bool has_mode, enum NewImageMode mode,
                            bool has_speed, int64_t speed,
                            bool has_bitmap, const char *bitmap,
                            bool has_on_source_error,
                            BlockdevOnError on_source_error,
                            bool has_on_target_error,
                            BlockdevOnError on_target_error,
                            BlockJobTxn *txn, Error **errp);

1851
static void drive_backup_prepare(BlkActionState *common, Error **errp)
1852 1853
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1854
    BlockBackend *blk;
1855 1856 1857
    DriveBackup *backup;
    Error *local_err = NULL;

1858
    assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1859
    backup = common->action->u.drive_backup.data;
1860

1861 1862
    blk = blk_by_name(backup->device);
    if (!blk) {
1863 1864
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", backup->device);
1865 1866 1867
        return;
    }

1868 1869 1870 1871 1872
    if (!blk_is_available(blk)) {
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
        return;
    }

1873
    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1874
    state->aio_context = blk_get_aio_context(blk);
1875
    aio_context_acquire(state->aio_context);
1876 1877
    bdrv_drained_begin(blk_bs(blk));
    state->bs = blk_bs(blk);
1878

1879 1880 1881 1882 1883 1884 1885 1886
    do_drive_backup(backup->device, backup->target,
                    backup->has_format, backup->format,
                    backup->sync,
                    backup->has_mode, backup->mode,
                    backup->has_speed, backup->speed,
                    backup->has_bitmap, backup->bitmap,
                    backup->has_on_source_error, backup->on_source_error,
                    backup->has_on_target_error, backup->on_target_error,
J
John Snow 已提交
1887
                    common->block_job_txn, &local_err);
1888
    if (local_err) {
1889 1890 1891 1892 1893 1894 1895
        error_propagate(errp, local_err);
        return;
    }

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

1896
static void drive_backup_abort(BlkActionState *common)
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
{
    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);
    }
}

1907
static void drive_backup_clean(BlkActionState *common)
1908 1909 1910 1911
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);

    if (state->aio_context) {
1912
        bdrv_drained_end(state->bs);
1913 1914 1915 1916
        aio_context_release(state->aio_context);
    }
}

1917
typedef struct BlockdevBackupState {
1918
    BlkActionState common;
1919 1920 1921 1922 1923
    BlockDriverState *bs;
    BlockJob *job;
    AioContext *aio_context;
} BlockdevBackupState;

1924 1925 1926 1927 1928 1929 1930 1931 1932
static void do_blockdev_backup(const char *device, const char *target,
                               enum MirrorSyncMode sync,
                               bool has_speed, int64_t speed,
                               bool has_on_source_error,
                               BlockdevOnError on_source_error,
                               bool has_on_target_error,
                               BlockdevOnError on_target_error,
                               BlockJobTxn *txn, Error **errp);

1933
static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1934 1935 1936
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
    BlockdevBackup *backup;
M
Max Reitz 已提交
1937
    BlockBackend *blk, *target;
1938 1939
    Error *local_err = NULL;

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

1943 1944
    blk = blk_by_name(backup->device);
    if (!blk) {
1945
        error_setg(errp, "Device '%s' not found", backup->device);
1946 1947 1948
        return;
    }

1949 1950 1951 1952 1953
    if (!blk_is_available(blk)) {
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, backup->device);
        return;
    }

M
Max Reitz 已提交
1954 1955
    target = blk_by_name(backup->target);
    if (!target) {
1956
        error_setg(errp, "Device '%s' not found", backup->target);
1957 1958 1959 1960
        return;
    }

    /* AioContext is released in .clean() */
M
Max Reitz 已提交
1961 1962
    state->aio_context = blk_get_aio_context(blk);
    if (state->aio_context != blk_get_aio_context(target)) {
1963 1964 1965 1966 1967
        state->aio_context = NULL;
        error_setg(errp, "Backup between two IO threads is not implemented");
        return;
    }
    aio_context_acquire(state->aio_context);
1968 1969
    state->bs = blk_bs(blk);
    bdrv_drained_begin(state->bs);
1970

1971 1972 1973 1974 1975
    do_blockdev_backup(backup->device, backup->target,
                       backup->sync,
                       backup->has_speed, backup->speed,
                       backup->has_on_source_error, backup->on_source_error,
                       backup->has_on_target_error, backup->on_target_error,
J
John Snow 已提交
1976
                       common->block_job_txn, &local_err);
1977 1978 1979 1980 1981 1982 1983 1984
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

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

1985
static void blockdev_backup_abort(BlkActionState *common)
1986 1987 1988 1989 1990 1991 1992 1993 1994 1995
{
    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);
    }
}

1996
static void blockdev_backup_clean(BlkActionState *common)
1997 1998 1999 2000
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);

    if (state->aio_context) {
2001
        bdrv_drained_end(state->bs);
2002 2003 2004 2005
        aio_context_release(state->aio_context);
    }
}

F
Fam Zheng 已提交
2006
typedef struct BlockDirtyBitmapState {
2007
    BlkActionState common;
F
Fam Zheng 已提交
2008 2009 2010 2011 2012 2013 2014
    BdrvDirtyBitmap *bitmap;
    BlockDriverState *bs;
    AioContext *aio_context;
    HBitmap *backup;
    bool prepared;
} BlockDirtyBitmapState;

2015
static void block_dirty_bitmap_add_prepare(BlkActionState *common,
F
Fam Zheng 已提交
2016 2017 2018 2019 2020 2021 2022
                                           Error **errp)
{
    Error *local_err = NULL;
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

J
John Snow 已提交
2023 2024 2025 2026
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2027
    action = common->action->u.block_dirty_bitmap_add.data;
F
Fam Zheng 已提交
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039
    /* 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);
    }
}

2040
static void block_dirty_bitmap_add_abort(BlkActionState *common)
F
Fam Zheng 已提交
2041 2042 2043 2044 2045
{
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

2046
    action = common->action->u.block_dirty_bitmap_add.data;
F
Fam Zheng 已提交
2047 2048 2049 2050 2051 2052 2053 2054
    /* 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);
    }
}

2055
static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
F
Fam Zheng 已提交
2056 2057 2058 2059 2060 2061
                                             Error **errp)
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);
    BlockDirtyBitmap *action;

J
John Snow 已提交
2062 2063 2064 2065
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2066
    action = common->action->u.block_dirty_bitmap_clear.data;
F
Fam Zheng 已提交
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087
    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() */
}

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

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

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

    hbitmap_free(state->backup);
}

2104
static void block_dirty_bitmap_clear_clean(BlkActionState *common)
F
Fam Zheng 已提交
2105 2106 2107 2108 2109 2110 2111 2112 2113
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

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

2114
static void abort_prepare(BlkActionState *common, Error **errp)
2115 2116 2117 2118
{
    error_setg(errp, "Transaction aborted using Abort action");
}

2119
static void abort_commit(BlkActionState *common)
2120
{
2121
    g_assert_not_reached(); /* this action never succeeds */
2122 2123
}

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

J
John Snow 已提交
2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194
/**
 * 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;
}

2195
/*
2196 2197
 * 'Atomic' group operations.  The operations are performed as a set, and if
 * any fail then we roll back all operations in the group.
2198
 */
J
John Snow 已提交
2199 2200 2201 2202
void qmp_transaction(TransactionActionList *dev_list,
                     bool has_props,
                     struct TransactionProperties *props,
                     Error **errp)
2203
{
2204
    TransactionActionList *dev_entry = dev_list;
J
John Snow 已提交
2205
    BlockJobTxn *block_job_txn = NULL;
2206
    BlkActionState *state, *next;
2207
    Error *local_err = NULL;
2208

2209
    QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2210 2211
    QSIMPLEQ_INIT(&snap_bdrv_states);

J
John Snow 已提交
2212 2213 2214 2215 2216 2217 2218 2219
    /* 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();
    }

2220
    /* drain all i/o before any operations */
2221 2222
    bdrv_drain_all();

2223
    /* We don't do anything in this loop that commits us to the operations */
2224
    while (NULL != dev_entry) {
2225
        TransactionAction *dev_info = NULL;
2226
        const BlkActionOps *ops;
2227

2228 2229 2230
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

2231
        assert(dev_info->type < ARRAY_SIZE(actions));
2232

2233
        ops = &actions[dev_info->type];
2234 2235
        assert(ops->instance_size > 0);

2236 2237 2238
        state = g_malloc0(ops->instance_size);
        state->ops = ops;
        state->action = dev_info;
J
John Snow 已提交
2239 2240
        state->block_job_txn = block_job_txn;
        state->txn_props = props;
2241
        QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2242

2243
        state->ops->prepare(state, &local_err);
2244
        if (local_err) {
2245 2246
            error_propagate(errp, local_err);
            goto delete_and_fail;
2247 2248 2249
        }
    }

2250
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2251 2252 2253
        if (state->ops->commit) {
            state->ops->commit(state);
        }
2254 2255 2256 2257 2258 2259
    }

    /* success */
    goto exit;

delete_and_fail:
2260
    /* failure, and it is all-or-none; roll back all operations */
2261 2262 2263
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
        if (state->ops->abort) {
            state->ops->abort(state);
2264
        }
2265 2266
    }
exit:
2267 2268 2269
    QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
        if (state->ops->clean) {
            state->ops->clean(state);
2270
        }
2271
        g_free(state);
2272
    }
J
John Snow 已提交
2273 2274 2275 2276
    if (!has_props) {
        qapi_free_TransactionProperties(props);
    }
    block_job_txn_unref(block_job_txn);
2277 2278
}

L
Luiz Capitulino 已提交
2279
void qmp_eject(const char *device, bool has_force, bool force, Error **errp)
2280
{
2281
    Error *local_err = NULL;
2282 2283 2284 2285 2286
    int rc;

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

2288
    rc = do_open_tray(device, force, &local_err);
2289
    if (rc && rc != -ENOSYS) {
2290
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2291
        return;
2292
    }
2293
    error_free(local_err);
2294

2295
    qmp_x_blockdev_remove_medium(device, errp);
2296 2297
}

2298 2299 2300
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
2301
{
2302
    Error *local_err = NULL;
2303
    BlockDriverState *bs;
2304
    AioContext *aio_context;
2305

2306 2307 2308
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2309
    if (local_err) {
2310
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2311
        return;
2312 2313
    }

2314 2315 2316
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2317
    bdrv_add_key(bs, password, errp);
2318 2319

    aio_context_release(aio_context);
2320 2321
}

2322 2323 2324 2325 2326 2327 2328 2329 2330 2331
/*
 * 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.
2332 2333
 */
static int do_open_tray(const char *device, bool force, Error **errp)
M
Max Reitz 已提交
2334 2335 2336 2337 2338 2339 2340 2341
{
    BlockBackend *blk;
    bool locked;

    blk = blk_by_name(device);
    if (!blk) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
2342
        return -ENODEV;
M
Max Reitz 已提交
2343 2344 2345 2346
    }

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

2350
    if (!blk_dev_has_tray(blk)) {
2351 2352
        error_setg(errp, "Device '%s' does not have a tray", device);
        return -ENOSYS;
2353 2354
    }

M
Max Reitz 已提交
2355
    if (blk_dev_is_tray_open(blk)) {
2356
        return 0;
M
Max Reitz 已提交
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
    }

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

    if (locked && !force) {
2369 2370 2371
        error_setg(errp, "Device '%s' is locked and force was not specified, "
                   "wait for tray to open and try again", device);
        return -EINPROGRESS;
2372 2373 2374 2375 2376 2377 2378 2379
    }

    return 0;
}

void qmp_blockdev_open_tray(const char *device, bool has_force, bool force,
                            Error **errp)
{
2380 2381 2382
    Error *local_err = NULL;
    int rc;

2383 2384 2385
    if (!has_force) {
        force = false;
    }
2386 2387 2388 2389 2390 2391
    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 已提交
2392 2393
}

M
Max Reitz 已提交
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409
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;
    }

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

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

    blk_dev_change_media_cb(blk, true);
}

2422
void qmp_x_blockdev_remove_medium(const char *device, Error **errp)
M
Max Reitz 已提交
2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
{
    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;
    }

2444
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
M
Max Reitz 已提交
2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
        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);

2463 2464 2465 2466 2467 2468 2469 2470
    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 已提交
2471 2472 2473 2474
out:
    aio_context_release(aio_context);
}

M
Max Reitz 已提交
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
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;
    }

2496
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
M
Max Reitz 已提交
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
        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);

2508 2509 2510 2511 2512 2513 2514 2515
    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 已提交
2516 2517
}

2518 2519
void qmp_x_blockdev_insert_medium(const char *device, const char *node_name,
                                  Error **errp)
M
Max Reitz 已提交
2520 2521 2522 2523 2524 2525 2526 2527 2528
{
    BlockDriverState *bs;

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

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

    qmp_blockdev_insert_anon_medium(device, bs, errp);
}

M
Max Reitz 已提交
2538 2539
void qmp_blockdev_change_medium(const char *device, const char *filename,
                                bool has_format, const char *format,
2540 2541
                                bool has_read_only,
                                BlockdevChangeReadOnlyMode read_only,
M
Max Reitz 已提交
2542
                                Error **errp)
2543 2544 2545
{
    BlockBackend *blk;
    BlockDriverState *medium_bs = NULL;
M
Max Reitz 已提交
2546
    int bdrv_flags;
2547
    int rc;
2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562
    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);
2563 2564
    bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
        BDRV_O_PROTOCOL);
2565

2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585
    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 已提交
2586
    if (has_format) {
2587 2588 2589 2590
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(format));
    }

M
Max Reitz 已提交
2591 2592
    medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
    if (!medium_bs) {
2593 2594 2595 2596 2597 2598 2599 2600 2601
        goto fail;
    }

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

2602 2603
    rc = do_open_tray(device, false, &err);
    if (rc && rc != -ENOSYS) {
2604 2605 2606
        error_propagate(errp, err);
        goto fail;
    }
2607 2608
    error_free(err);
    err = NULL;
2609

2610
    qmp_x_blockdev_remove_medium(device, &err);
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621
    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;
    }

2622 2623
    blk_apply_root_state(blk, medium_bs);

2624 2625 2626 2627 2628 2629 2630 2631 2632
    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 已提交
2633
/* throttling disk I/O limits */
2634
void qmp_block_set_io_throttle(const char *device, int64_t bps, int64_t bps_rd,
2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649
                               int64_t bps_wr,
                               int64_t iops,
                               int64_t iops_rd,
                               int64_t iops_wr,
                               bool has_bps_max,
                               int64_t bps_max,
                               bool has_bps_rd_max,
                               int64_t bps_rd_max,
                               bool has_bps_wr_max,
                               int64_t bps_wr_max,
                               bool has_iops_max,
                               int64_t iops_max,
                               bool has_iops_rd_max,
                               int64_t iops_rd_max,
                               bool has_iops_wr_max,
2650
                               int64_t iops_wr_max,
2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662
                               bool has_bps_max_length,
                               int64_t bps_max_length,
                               bool has_bps_rd_max_length,
                               int64_t bps_rd_max_length,
                               bool has_bps_wr_max_length,
                               int64_t bps_wr_max_length,
                               bool has_iops_max_length,
                               int64_t iops_max_length,
                               bool has_iops_rd_max_length,
                               int64_t iops_rd_max_length,
                               bool has_iops_wr_max_length,
                               int64_t iops_wr_max_length,
2663
                               bool has_iops_size,
2664 2665 2666
                               int64_t iops_size,
                               bool has_group,
                               const char *group, Error **errp)
Z
Zhi Yong Wu 已提交
2667
{
2668
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
2669
    BlockDriverState *bs;
2670
    BlockBackend *blk;
2671
    AioContext *aio_context;
Z
Zhi Yong Wu 已提交
2672

2673 2674
    blk = blk_by_name(device);
    if (!blk) {
2675 2676
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
2677
        return;
Z
Zhi Yong Wu 已提交
2678
    }
M
Max Reitz 已提交
2679 2680 2681 2682

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

2683
    bs = blk_bs(blk);
M
Max Reitz 已提交
2684 2685 2686 2687
    if (!bs) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
Z
Zhi Yong Wu 已提交
2688

2689
    throttle_config_init(&cfg);
2690 2691 2692 2693 2694 2695 2696 2697
    cfg.buckets[THROTTLE_BPS_TOTAL].avg = bps;
    cfg.buckets[THROTTLE_BPS_READ].avg  = bps_rd;
    cfg.buckets[THROTTLE_BPS_WRITE].avg = bps_wr;

    cfg.buckets[THROTTLE_OPS_TOTAL].avg = iops;
    cfg.buckets[THROTTLE_OPS_READ].avg  = iops_rd;
    cfg.buckets[THROTTLE_OPS_WRITE].avg = iops_wr;

2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715
    if (has_bps_max) {
        cfg.buckets[THROTTLE_BPS_TOTAL].max = bps_max;
    }
    if (has_bps_rd_max) {
        cfg.buckets[THROTTLE_BPS_READ].max = bps_rd_max;
    }
    if (has_bps_wr_max) {
        cfg.buckets[THROTTLE_BPS_WRITE].max = bps_wr_max;
    }
    if (has_iops_max) {
        cfg.buckets[THROTTLE_OPS_TOTAL].max = iops_max;
    }
    if (has_iops_rd_max) {
        cfg.buckets[THROTTLE_OPS_READ].max = iops_rd_max;
    }
    if (has_iops_wr_max) {
        cfg.buckets[THROTTLE_OPS_WRITE].max = iops_wr_max;
    }
Z
Zhi Yong Wu 已提交
2716

2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735
    if (has_bps_max_length) {
        cfg.buckets[THROTTLE_BPS_TOTAL].burst_length = bps_max_length;
    }
    if (has_bps_rd_max_length) {
        cfg.buckets[THROTTLE_BPS_READ].burst_length = bps_rd_max_length;
    }
    if (has_bps_wr_max_length) {
        cfg.buckets[THROTTLE_BPS_WRITE].burst_length = bps_wr_max_length;
    }
    if (has_iops_max_length) {
        cfg.buckets[THROTTLE_OPS_TOTAL].burst_length = iops_max_length;
    }
    if (has_iops_rd_max_length) {
        cfg.buckets[THROTTLE_OPS_READ].burst_length = iops_rd_max_length;
    }
    if (has_iops_wr_max_length) {
        cfg.buckets[THROTTLE_OPS_WRITE].burst_length = iops_wr_max_length;
    }

2736 2737 2738
    if (has_iops_size) {
        cfg.op_size = iops_size;
    }
2739

2740
    if (!throttle_is_valid(&cfg, errp)) {
M
Max Reitz 已提交
2741
        goto out;
Z
Zhi Yong Wu 已提交
2742 2743
    }

2744 2745 2746
    if (throttle_enabled(&cfg)) {
        /* Enable I/O limits if they're not enabled yet, otherwise
         * just update the throttling group. */
2747 2748
        if (!blk_get_public(blk)->throttle_state) {
            blk_io_limits_enable(blk, has_group ? group : device);
2749
        } else if (has_group) {
2750
            blk_io_limits_update_group(blk, group);
2751 2752
        }
        /* Set the new throttling configuration */
2753 2754
        blk_set_io_limits(blk, &cfg);
    } else if (blk_get_public(blk)->throttle_state) {
2755
        /* If all throttling settings are set to 0, disable I/O limits */
2756
        blk_io_limits_disable(blk);
Z
Zhi Yong Wu 已提交
2757
    }
2758

M
Max Reitz 已提交
2759
out:
2760
    aio_context_release(aio_context);
Z
Zhi Yong Wu 已提交
2761 2762
}

2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
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 已提交
2812 2813 2814 2815 2816 2817
    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be removed",
                   name);
        goto out;
    }
2818
    bdrv_dirty_bitmap_make_anon(bitmap);
2819 2820
    bdrv_release_dirty_bitmap(bs, bitmap);

J
John Snow 已提交
2821
 out:
2822 2823 2824
    aio_context_release(aio_context);
}

J
John Snow 已提交
2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852
/**
 * 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 已提交
2853
    bdrv_clear_dirty_bitmap(bitmap, NULL);
J
John Snow 已提交
2854 2855 2856 2857 2858

 out:
    aio_context_release(aio_context);
}

2859
void hmp_drive_del(Monitor *mon, const QDict *qdict)
2860 2861
{
    const char *id = qdict_get_str(qdict, "id");
2862
    BlockBackend *blk;
2863
    BlockDriverState *bs;
2864
    AioContext *aio_context;
2865
    Error *local_err = NULL;
2866

2867 2868 2869 2870 2871 2872 2873 2874 2875
    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;
    }

2876 2877
    blk = blk_by_name(id);
    if (!blk) {
2878
        error_report("Device '%s' not found", id);
2879
        return;
2880
    }
2881

2882
    if (!blk_legacy_dinfo(blk)) {
2883 2884
        error_report("Deleting device added with blockdev-add"
                     " is not supported");
2885
        return;
2886 2887
    }

M
Max Reitz 已提交
2888
    aio_context = blk_get_aio_context(blk);
2889 2890
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
2891 2892 2893 2894 2895 2896 2897
    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;
        }
2898

2899
        blk_remove_bs(blk);
M
Max Reitz 已提交
2900
    }
2901

2902
    /* Make the BlockBackend and the attached BlockDriverState anonymous */
2903 2904
    monitor_remove_blk(blk);

2905 2906
    /* 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.
2907
     */
2908
    if (blk_get_attached_dev(blk)) {
2909
        /* Further I/O must not pause the guest */
2910 2911
        blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
                         BLOCKDEV_ON_ERROR_REPORT);
2912
    } else {
2913
        blk_unref(blk);
2914 2915
    }

2916
    aio_context_release(aio_context);
2917
}
2918

2919 2920 2921
void qmp_block_resize(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      int64_t size, Error **errp)
2922
{
2923
    Error *local_err = NULL;
2924
    BlockDriverState *bs;
2925
    AioContext *aio_context;
2926
    int ret;
2927

2928 2929 2930
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2931
    if (local_err) {
2932 2933 2934 2935
        error_propagate(errp, local_err);
        return;
    }

2936 2937 2938
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2939
    if (!bdrv_is_first_non_filter(bs)) {
2940
        error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2941
        goto out;
2942 2943 2944
    }

    if (size < 0) {
2945
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2946
        goto out;
2947 2948
    }

2949
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2950
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2951
        goto out;
2952 2953
    }

2954 2955 2956
    /* complete all in-flight operations before resizing the device */
    bdrv_drain_all();

2957 2958
    ret = bdrv_truncate(bs, size);
    switch (ret) {
2959 2960 2961
    case 0:
        break;
    case -ENOMEDIUM:
2962
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
2963 2964
        break;
    case -ENOTSUP:
2965
        error_setg(errp, QERR_UNSUPPORTED);
2966 2967
        break;
    case -EACCES:
2968
        error_setg(errp, "Device '%s' is read only", device);
2969 2970
        break;
    case -EBUSY:
2971
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2972 2973
        break;
    default:
2974
        error_setg_errno(errp, -ret, "Could not resize");
2975
        break;
2976
    }
2977 2978 2979

out:
    aio_context_release(aio_context);
2980
}
S
Stefan Hajnoczi 已提交
2981

2982
static void block_job_cb(void *opaque, int ret)
S
Stefan Hajnoczi 已提交
2983
{
2984 2985 2986 2987 2988
    /* 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 已提交
2989
    BlockDriverState *bs = opaque;
2990
    const char *msg = NULL;
S
Stefan Hajnoczi 已提交
2991

2992
    trace_block_job_cb(bs, bs->job, ret);
S
Stefan Hajnoczi 已提交
2993 2994

    assert(bs->job);
2995

S
Stefan Hajnoczi 已提交
2996
    if (ret < 0) {
2997
        msg = strerror(-ret);
S
Stefan Hajnoczi 已提交
2998 2999
    }

3000
    if (block_job_is_cancelled(bs->job)) {
3001
        block_job_event_cancelled(bs->job);
3002
    } else {
3003
        block_job_event_completed(bs->job, msg);
3004
    }
S
Stefan Hajnoczi 已提交
3005 3006
}

3007 3008 3009 3010
void qmp_block_stream(const char *device,
                      bool has_base, const char *base,
                      bool has_backing_file, const char *backing_file,
                      bool has_speed, int64_t speed,
P
Paolo Bonzini 已提交
3011 3012
                      bool has_on_error, BlockdevOnError on_error,
                      Error **errp)
S
Stefan Hajnoczi 已提交
3013
{
3014
    BlockBackend *blk;
S
Stefan Hajnoczi 已提交
3015
    BlockDriverState *bs;
3016
    BlockDriverState *base_bs = NULL;
3017
    AioContext *aio_context;
3018
    Error *local_err = NULL;
3019
    const char *base_name = NULL;
S
Stefan Hajnoczi 已提交
3020

P
Paolo Bonzini 已提交
3021 3022 3023 3024
    if (!has_on_error) {
        on_error = BLOCKDEV_ON_ERROR_REPORT;
    }

3025 3026
    blk = blk_by_name(device);
    if (!blk) {
3027 3028
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
S
Stefan Hajnoczi 已提交
3029 3030 3031
        return;
    }

M
Max Reitz 已提交
3032
    aio_context = blk_get_aio_context(blk);
3033 3034
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3035 3036 3037 3038 3039 3040
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3041
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_STREAM, errp)) {
3042
        goto out;
3043 3044
    }

3045
    if (has_base) {
3046 3047
        base_bs = bdrv_find_backing_image(bs, base);
        if (base_bs == NULL) {
3048
            error_setg(errp, QERR_BASE_NOT_FOUND, base);
3049
            goto out;
3050
        }
3051
        assert(bdrv_get_aio_context(base_bs) == aio_context);
3052
        base_name = base;
S
Stefan Hajnoczi 已提交
3053 3054
    }

3055 3056 3057 3058 3059
    /* 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");
3060
        goto out;
3061 3062 3063 3064 3065 3066
    }

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

    stream_start(bs, base_bs, base_name, has_speed ? speed : 0,
P
Paolo Bonzini 已提交
3067
                 on_error, block_job_cb, bs, &local_err);
3068
    if (local_err) {
3069
        error_propagate(errp, local_err);
3070
        goto out;
S
Stefan Hajnoczi 已提交
3071 3072 3073
    }

    trace_qmp_block_stream(bs, bs->job);
3074 3075 3076

out:
    aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
3077
}
3078

3079
void qmp_block_commit(const char *device,
3080 3081
                      bool has_base, const char *base,
                      bool has_top, const char *top,
3082
                      bool has_backing_file, const char *backing_file,
3083 3084 3085
                      bool has_speed, int64_t speed,
                      Error **errp)
{
3086
    BlockBackend *blk;
3087 3088
    BlockDriverState *bs;
    BlockDriverState *base_bs, *top_bs;
3089
    AioContext *aio_context;
3090 3091 3092 3093
    Error *local_err = NULL;
    /* This will be part of the QMP command, if/when the
     * BlockdevOnError change for blkmirror makes it in
     */
3094
    BlockdevOnError on_error = BLOCKDEV_ON_ERROR_REPORT;
3095

3096 3097 3098 3099
    if (!has_speed) {
        speed = 0;
    }

3100 3101 3102 3103 3104
    /* 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. */
3105 3106
    blk = blk_by_name(device);
    if (!blk) {
3107 3108
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3109
        return;
3110 3111
    }

M
Max Reitz 已提交
3112
    aio_context = blk_get_aio_context(blk);
3113 3114
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3115 3116 3117 3118 3119 3120
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3121
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
3122
        goto out;
3123 3124 3125 3126 3127
    }

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

3128
    if (has_top && top) {
3129 3130 3131 3132 3133 3134 3135
        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");
3136
        goto out;
3137 3138
    }

3139 3140
    assert(bdrv_get_aio_context(top_bs) == aio_context);

3141 3142 3143 3144 3145 3146 3147
    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) {
3148
        error_setg(errp, QERR_BASE_NOT_FOUND, base ? base : "NULL");
3149
        goto out;
3150 3151
    }

3152 3153
    assert(bdrv_get_aio_context(base_bs) == aio_context);

3154 3155 3156 3157
    if (bdrv_op_is_blocked(base_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
        goto out;
    }

3158 3159 3160
    /* Do not allow attempts to commit an image into itself */
    if (top_bs == base_bs) {
        error_setg(errp, "cannot commit an image into itself");
3161
        goto out;
3162 3163
    }

F
Fam Zheng 已提交
3164
    if (top_bs == bs) {
3165 3166 3167
        if (has_backing_file) {
            error_setg(errp, "'backing-file' specified,"
                             " but 'top' is the active layer");
3168
            goto out;
3169
        }
F
Fam Zheng 已提交
3170 3171 3172 3173
        commit_active_start(bs, base_bs, speed, on_error, block_job_cb,
                            bs, &local_err);
    } else {
        commit_start(bs, base_bs, top_bs, speed, on_error, block_job_cb, bs,
3174
                     has_backing_file ? backing_file : NULL, &local_err);
F
Fam Zheng 已提交
3175
    }
3176 3177
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3178
        goto out;
3179
    }
3180 3181 3182

out:
    aio_context_release(aio_context);
3183 3184
}

3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195
static void do_drive_backup(const char *device, const char *target,
                            bool has_format, const char *format,
                            enum MirrorSyncMode sync,
                            bool has_mode, enum NewImageMode mode,
                            bool has_speed, int64_t speed,
                            bool has_bitmap, const char *bitmap,
                            bool has_on_source_error,
                            BlockdevOnError on_source_error,
                            bool has_on_target_error,
                            BlockdevOnError on_target_error,
                            BlockJobTxn *txn, Error **errp)
3196
{
3197
    BlockBackend *blk;
3198 3199
    BlockDriverState *bs;
    BlockDriverState *target_bs;
3200
    BlockDriverState *source = NULL;
3201
    BdrvDirtyBitmap *bmap = NULL;
3202
    AioContext *aio_context;
3203
    QDict *options = NULL;
3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220
    Error *local_err = NULL;
    int flags;
    int64_t size;

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

3221 3222
    blk = blk_by_name(device);
    if (!blk) {
3223 3224
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3225 3226 3227
        return;
    }

M
Max Reitz 已提交
3228
    aio_context = blk_get_aio_context(blk);
3229 3230
    aio_context_acquire(aio_context);

F
Fam Zheng 已提交
3231 3232
    /* Although backup_run has this check too, we need to use bs->drv below, so
     * do an early check redundantly. */
M
Max Reitz 已提交
3233
    if (!blk_is_available(blk)) {
3234
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3235
        goto out;
3236
    }
M
Max Reitz 已提交
3237
    bs = blk_bs(blk);
3238 3239 3240 3241 3242

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

F
Fam Zheng 已提交
3243
    /* Early check to avoid creating target */
3244
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3245
        goto out;
3246 3247
    }

K
Kevin Wolf 已提交
3248
    flags = bs->open_flags | BDRV_O_RDWR;
3249

3250 3251 3252
    /* See if we have a backing HD we can use to create our new image
     * on top of. */
    if (sync == MIRROR_SYNC_MODE_TOP) {
3253
        source = backing_bs(bs);
3254 3255 3256 3257 3258 3259 3260 3261
        if (!source) {
            sync = MIRROR_SYNC_MODE_FULL;
        }
    }
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }

3262 3263 3264
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3265
        goto out;
3266 3267 3268
    }

    if (mode != NEW_IMAGE_MODE_EXISTING) {
3269
        assert(format);
3270 3271 3272 3273 3274 3275 3276 3277
        if (source) {
            bdrv_img_create(target, format, source->filename,
                            source->drv->format_name, NULL,
                            size, flags, &local_err, false);
        } else {
            bdrv_img_create(target, format, NULL, NULL, NULL,
                            size, flags, &local_err, false);
        }
3278 3279
    }

3280
    if (local_err) {
3281
        error_propagate(errp, local_err);
3282
        goto out;
3283 3284
    }

3285 3286 3287 3288 3289
    if (format) {
        options = qdict_new();
        qdict_put(options, "driver", qstring_from_str(format));
    }

M
Max Reitz 已提交
3290 3291
    target_bs = bdrv_open(target, NULL, options, flags, errp);
    if (!target_bs) {
3292
        goto out;
3293 3294
    }

3295 3296
    bdrv_set_aio_context(target_bs, aio_context);

3297 3298 3299 3300
    if (has_bitmap) {
        bmap = bdrv_find_dirty_bitmap(bs, bitmap);
        if (!bmap) {
            error_setg(errp, "Bitmap '%s' could not be found", bitmap);
3301
            bdrv_unref(target_bs);
3302 3303 3304 3305 3306 3307
            goto out;
        }
    }

    backup_start(bs, target_bs, speed, sync, bmap,
                 on_source_error, on_target_error,
3308
                 block_job_cb, bs, txn, &local_err);
K
Kevin Wolf 已提交
3309
    bdrv_unref(target_bs);
3310 3311
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3312
        goto out;
3313
    }
3314 3315 3316

out:
    aio_context_release(aio_context);
3317 3318
}

3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336
void qmp_drive_backup(const char *device, const char *target,
                      bool has_format, const char *format,
                      enum MirrorSyncMode sync,
                      bool has_mode, enum NewImageMode mode,
                      bool has_speed, int64_t speed,
                      bool has_bitmap, const char *bitmap,
                      bool has_on_source_error, BlockdevOnError on_source_error,
                      bool has_on_target_error, BlockdevOnError on_target_error,
                      Error **errp)
{
    return do_drive_backup(device, target, has_format, format, sync,
                           has_mode, mode, has_speed, speed,
                           has_bitmap, bitmap,
                           has_on_source_error, on_source_error,
                           has_on_target_error, on_target_error,
                           NULL, errp);
}

3337 3338
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
3339
    return bdrv_named_nodes_list(errp);
3340 3341
}

3342
void do_blockdev_backup(const char *device, const char *target,
F
Fam Zheng 已提交
3343 3344 3345 3346 3347 3348
                         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,
3349
                         BlockJobTxn *txn, Error **errp)
F
Fam Zheng 已提交
3350
{
3351
    BlockBackend *blk;
F
Fam Zheng 已提交
3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366
    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;
    }

3367 3368
    blk = blk_by_name(device);
    if (!blk) {
3369
        error_setg(errp, "Device '%s' not found", device);
F
Fam Zheng 已提交
3370 3371 3372
        return;
    }

M
Max Reitz 已提交
3373
    aio_context = blk_get_aio_context(blk);
F
Fam Zheng 已提交
3374 3375
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3376 3377 3378 3379 3380 3381
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3382 3383
    target_bs = bdrv_lookup_bs(target, target, errp);
    if (!target_bs) {
M
Max Reitz 已提交
3384 3385
        goto out;
    }
F
Fam Zheng 已提交
3386

3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397
    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;
        }
    }
3398
    backup_start(bs, target_bs, speed, sync, NULL, on_source_error,
3399
                 on_target_error, block_job_cb, bs, txn, &local_err);
F
Fam Zheng 已提交
3400 3401 3402 3403 3404 3405 3406
    if (local_err != NULL) {
        error_propagate(errp, local_err);
    }
out:
    aio_context_release(aio_context);
}

3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421
void qmp_blockdev_backup(const char *device, const char *target,
                         enum MirrorSyncMode sync,
                         bool has_speed, int64_t speed,
                         bool has_on_source_error,
                         BlockdevOnError on_source_error,
                         bool has_on_target_error,
                         BlockdevOnError on_target_error,
                         Error **errp)
{
    do_blockdev_backup(device, target, sync, has_speed, speed,
                       has_on_source_error, on_source_error,
                       has_on_target_error, on_target_error,
                       NULL, errp);
}

3422 3423 3424 3425 3426 3427 3428
/* Parameter check and block job starting for drive mirroring.
 * Caller should hold @device and @target's aio context (must be the same).
 **/
static void blockdev_mirror_common(BlockDriverState *bs,
                                   BlockDriverState *target,
                                   bool has_replaces, const char *replaces,
                                   enum MirrorSyncMode sync,
M
Max Reitz 已提交
3429
                                   BlockMirrorBackingMode backing_mode,
3430 3431 3432 3433 3434 3435 3436 3437 3438
                                   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 已提交
3439 3440 3441 3442 3443
{

    if (!has_speed) {
        speed = 0;
    }
3444 3445 3446 3447 3448 3449
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
3450 3451 3452
    if (!has_granularity) {
        granularity = 0;
    }
3453
    if (!has_buf_size) {
W
Wen Congyang 已提交
3454
        buf_size = 0;
3455
    }
3456 3457 3458
    if (!has_unmap) {
        unmap = true;
    }
3459

3460
    if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
3461 3462
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "a value in range [512B, 64MB]");
3463 3464 3465
        return;
    }
    if (granularity & (granularity - 1)) {
3466 3467
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
                   "power of 2");
3468 3469
        return;
    }
P
Paolo Bonzini 已提交
3470

3471 3472 3473
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
        return;
    }
F
Fam Zheng 已提交
3474 3475 3476
    if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
        return;
    }
3477 3478 3479 3480 3481 3482 3483 3484 3485 3486

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

    /* pass the node name to replace to mirror start since it's loose coupling
     * and will allow to check whether the node still exist at mirror completion
     */
    mirror_start(bs, target,
                 has_replaces ? replaces : NULL,
M
Max Reitz 已提交
3487
                 speed, granularity, buf_size, sync, backing_mode,
3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509
                 on_source_error, on_target_error, unmap,
                 block_job_cb, bs, errp);
}

void qmp_drive_mirror(const char *device, const char *target,
                      bool has_format, const char *format,
                      bool has_node_name, const char *node_name,
                      bool has_replaces, const char *replaces,
                      enum MirrorSyncMode sync,
                      bool has_mode, enum NewImageMode mode,
                      bool has_speed, int64_t speed,
                      bool has_granularity, uint32_t granularity,
                      bool has_buf_size, int64_t buf_size,
                      bool has_on_source_error, BlockdevOnError on_source_error,
                      bool has_on_target_error, BlockdevOnError on_target_error,
                      bool has_unmap, bool unmap,
                      Error **errp)
{
    BlockDriverState *bs;
    BlockBackend *blk;
    BlockDriverState *source, *target_bs;
    AioContext *aio_context;
M
Max Reitz 已提交
3510
    BlockMirrorBackingMode backing_mode;
3511 3512 3513 3514 3515
    Error *local_err = NULL;
    QDict *options = NULL;
    int flags;
    int64_t size;

3516 3517
    blk = blk_by_name(device);
    if (!blk) {
3518 3519
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
P
Paolo Bonzini 已提交
3520 3521 3522
        return;
    }

M
Max Reitz 已提交
3523
    aio_context = blk_get_aio_context(blk);
3524 3525
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3526
    if (!blk_is_available(blk)) {
3527
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
3528
        goto out;
P
Paolo Bonzini 已提交
3529
    }
M
Max Reitz 已提交
3530
    bs = blk_bs(blk);
3531 3532 3533
    if (!has_mode) {
        mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
P
Paolo Bonzini 已提交
3534 3535 3536 3537 3538

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

K
Kevin Wolf 已提交
3539
    flags = bs->open_flags | BDRV_O_RDWR;
3540
    source = backing_bs(bs);
P
Paolo Bonzini 已提交
3541 3542 3543
    if (!source && sync == MIRROR_SYNC_MODE_TOP) {
        sync = MIRROR_SYNC_MODE_FULL;
    }
3544 3545 3546
    if (sync == MIRROR_SYNC_MODE_NONE) {
        source = bs;
    }
P
Paolo Bonzini 已提交
3547

3548 3549 3550
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3551
        goto out;
3552 3553
    }

3554 3555
    if (has_replaces) {
        BlockDriverState *to_replace_bs;
3556 3557
        AioContext *replace_aio_context;
        int64_t replace_size;
3558 3559 3560 3561

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

3565
        to_replace_bs = check_to_replace_node(bs, replaces, &local_err);
3566 3567 3568

        if (!to_replace_bs) {
            error_propagate(errp, local_err);
3569
            goto out;
3570 3571
        }

3572 3573 3574 3575 3576 3577
        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) {
3578 3579
            error_setg(errp, "cannot replace image with a mirror image of "
                             "different size");
3580
            goto out;
3581 3582 3583
        }
    }

M
Max Reitz 已提交
3584 3585 3586 3587 3588 3589
    if (mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
        backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
    } else {
        backing_mode = MIRROR_OPEN_BACKING_CHAIN;
    }

3590 3591 3592
    if ((sync == MIRROR_SYNC_MODE_FULL || !source)
        && mode != NEW_IMAGE_MODE_EXISTING)
    {
P
Paolo Bonzini 已提交
3593
        /* create new image w/o backing file */
3594
        assert(format);
3595
        bdrv_img_create(target, format,
3596
                        NULL, NULL, NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3597 3598 3599 3600 3601 3602
    } else {
        switch (mode) {
        case NEW_IMAGE_MODE_EXISTING:
            break;
        case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
            /* create new image with backing file */
3603 3604 3605
            bdrv_img_create(target, format,
                            source->filename,
                            source->drv->format_name,
3606
                            NULL, size, flags, &local_err, false);
P
Paolo Bonzini 已提交
3607 3608 3609 3610 3611 3612
            break;
        default:
            abort();
        }
    }

3613
    if (local_err) {
3614
        error_propagate(errp, local_err);
3615
        goto out;
P
Paolo Bonzini 已提交
3616 3617
    }

3618
    options = qdict_new();
3619 3620 3621
    if (has_node_name) {
        qdict_put(options, "node-name", qstring_from_str(node_name));
    }
3622 3623 3624
    if (format) {
        qdict_put(options, "driver", qstring_from_str(format));
    }
3625

3626 3627 3628
    /* Mirroring takes care of copy-on-write using the source's backing
     * file.
     */
M
Max Reitz 已提交
3629 3630 3631
    target_bs = bdrv_open(target, NULL, options, flags | BDRV_O_NO_BACKING,
                          errp);
    if (!target_bs) {
3632
        goto out;
P
Paolo Bonzini 已提交
3633 3634
    }

3635 3636
    bdrv_set_aio_context(target_bs, aio_context);

3637
    blockdev_mirror_common(bs, target_bs,
M
Max Reitz 已提交
3638
                           has_replaces, replaces, sync, backing_mode,
3639 3640 3641 3642 3643 3644 3645
                           has_speed, speed,
                           has_granularity, granularity,
                           has_buf_size, buf_size,
                           has_on_source_error, on_source_error,
                           has_on_target_error, on_target_error,
                           has_unmap, unmap,
                           &local_err);
K
Kevin Wolf 已提交
3646
    bdrv_unref(target_bs);
3647
    error_propagate(errp, local_err);
3648 3649
out:
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3650 3651
}

F
Fam Zheng 已提交
3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667
void qmp_blockdev_mirror(const char *device, const char *target,
                         bool has_replaces, const char *replaces,
                         MirrorSyncMode sync,
                         bool has_speed, int64_t speed,
                         bool has_granularity, uint32_t granularity,
                         bool has_buf_size, int64_t buf_size,
                         bool has_on_source_error,
                         BlockdevOnError on_source_error,
                         bool has_on_target_error,
                         BlockdevOnError on_target_error,
                         Error **errp)
{
    BlockDriverState *bs;
    BlockBackend *blk;
    BlockDriverState *target_bs;
    AioContext *aio_context;
M
Max Reitz 已提交
3668
    BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
F
Fam Zheng 已提交
3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693
    Error *local_err = NULL;

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

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

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

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

    bdrv_set_aio_context(target_bs, aio_context);

    blockdev_mirror_common(bs, target_bs,
M
Max Reitz 已提交
3694
                           has_replaces, replaces, sync, backing_mode,
F
Fam Zheng 已提交
3695 3696 3697 3698 3699 3700 3701
                           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);
3702
    error_propagate(errp, local_err);
F
Fam Zheng 已提交
3703 3704 3705 3706

    aio_context_release(aio_context);
}

3707
/* Get the block job for a given device name and acquire its AioContext */
3708 3709
static BlockJob *find_block_job(const char *device, AioContext **aio_context,
                                Error **errp)
3710
{
3711
    BlockBackend *blk;
3712 3713
    BlockDriverState *bs;

M
Max Reitz 已提交
3714 3715
    *aio_context = NULL;

3716 3717
    blk = blk_by_name(device);
    if (!blk) {
3718 3719 3720
        goto notfound;
    }

M
Max Reitz 已提交
3721
    *aio_context = blk_get_aio_context(blk);
3722 3723
    aio_context_acquire(*aio_context);

M
Max Reitz 已提交
3724 3725 3726 3727 3728
    if (!blk_is_available(blk)) {
        goto notfound;
    }
    bs = blk_bs(blk);

3729 3730
    if (!bs->job) {
        goto notfound;
3731
    }
3732

3733
    return bs->job;
3734 3735

notfound:
3736 3737
    error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
              "No active block job on device '%s'", device);
M
Max Reitz 已提交
3738 3739 3740 3741
    if (*aio_context) {
        aio_context_release(*aio_context);
        *aio_context = NULL;
    }
3742
    return NULL;
3743 3744
}

3745
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3746
{
3747
    AioContext *aio_context;
3748
    BlockJob *job = find_block_job(device, &aio_context, errp);
3749 3750 3751 3752 3753

    if (!job) {
        return;
    }

3754
    block_job_set_speed(job, speed, errp);
3755
    aio_context_release(aio_context);
3756
}
3757

3758 3759
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
3760
{
3761
    AioContext *aio_context;
3762
    BlockJob *job = find_block_job(device, &aio_context, errp);
3763

3764 3765 3766
    if (!job) {
        return;
    }
3767 3768 3769 3770 3771

    if (!has_force) {
        force = false;
    }

F
Fam Zheng 已提交
3772
    if (job->user_paused && !force) {
3773 3774
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
3775
        goto out;
3776
    }
3777 3778 3779

    trace_qmp_block_job_cancel(job);
    block_job_cancel(job);
3780 3781
out:
    aio_context_release(aio_context);
3782
}
S
Stefan Hajnoczi 已提交
3783

3784 3785
void qmp_block_job_pause(const char *device, Error **errp)
{
3786
    AioContext *aio_context;
3787
    BlockJob *job = find_block_job(device, &aio_context, errp);
3788

F
Fam Zheng 已提交
3789
    if (!job || job->user_paused) {
3790 3791 3792
        return;
    }

F
Fam Zheng 已提交
3793
    job->user_paused = true;
3794 3795
    trace_qmp_block_job_pause(job);
    block_job_pause(job);
3796
    aio_context_release(aio_context);
3797 3798 3799 3800
}

void qmp_block_job_resume(const char *device, Error **errp)
{
3801
    AioContext *aio_context;
3802
    BlockJob *job = find_block_job(device, &aio_context, errp);
3803

F
Fam Zheng 已提交
3804
    if (!job || !job->user_paused) {
3805 3806 3807
        return;
    }

F
Fam Zheng 已提交
3808
    job->user_paused = false;
3809
    trace_qmp_block_job_resume(job);
3810
    block_job_iostatus_reset(job);
3811
    block_job_resume(job);
3812
    aio_context_release(aio_context);
3813 3814
}

P
Paolo Bonzini 已提交
3815 3816
void qmp_block_job_complete(const char *device, Error **errp)
{
3817
    AioContext *aio_context;
3818
    BlockJob *job = find_block_job(device, &aio_context, errp);
P
Paolo Bonzini 已提交
3819 3820 3821 3822 3823 3824 3825

    if (!job) {
        return;
    }

    trace_qmp_block_job_complete(job);
    block_job_complete(job, errp);
3826
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3827 3828
}

3829 3830 3831 3832 3833
void qmp_change_backing_file(const char *device,
                             const char *image_node_name,
                             const char *backing_file,
                             Error **errp)
{
3834
    BlockBackend *blk;
3835
    BlockDriverState *bs = NULL;
3836
    AioContext *aio_context;
3837 3838 3839 3840 3841 3842
    BlockDriverState *image_bs = NULL;
    Error *local_err = NULL;
    bool ro;
    int open_flags;
    int ret;

3843 3844
    blk = blk_by_name(device);
    if (!blk) {
3845 3846
        error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                  "Device '%s' not found", device);
3847 3848 3849
        return;
    }

M
Max Reitz 已提交
3850
    aio_context = blk_get_aio_context(blk);
3851 3852
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
3853 3854 3855 3856 3857 3858
    if (!blk_is_available(blk)) {
        error_setg(errp, "Device '%s' has no medium", device);
        goto out;
    }
    bs = blk_bs(blk);

3859 3860 3861
    image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
3862
        goto out;
3863 3864 3865 3866
    }

    if (!image_bs) {
        error_setg(errp, "image file not found");
3867
        goto out;
3868 3869 3870 3871 3872
    }

    if (bdrv_find_base(image_bs) == image_bs) {
        error_setg(errp, "not allowing backing file change on an image "
                         "without a backing file");
3873
        goto out;
3874 3875 3876 3877 3878
    }

    /* 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)) {
3879
        goto out;
3880 3881 3882 3883 3884 3885
    }

    /* final sanity check */
    if (!bdrv_chain_contains(bs, image_bs)) {
        error_setg(errp, "'%s' and image file are not in the same chain",
                   device);
3886
        goto out;
3887 3888 3889 3890 3891 3892 3893 3894 3895 3896
    }

    /* 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);
3897
            goto out;
3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912
        }
    }

    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);
3913
        error_propagate(errp, local_err);
3914
    }
3915 3916 3917

out:
    aio_context_release(aio_context);
3918 3919
}

3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933
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")) {
3934
        QDECREF(qdict);
3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950
        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 已提交
3951 3952 3953
void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
{
    QmpOutputVisitor *ov = qmp_output_visitor_new();
3954 3955
    BlockDriverState *bs;
    BlockBackend *blk = NULL;
K
Kevin Wolf 已提交
3956 3957 3958 3959
    QObject *obj;
    QDict *qdict;
    Error *local_err = NULL;

3960
    /* TODO Sort it out in raw-posix and drive_new(): Reject aio=native with
K
Kevin Wolf 已提交
3961
     * cache.direct=false instead of silently switching to aio=threads, except
3962
     * when called from drive_new().
K
Kevin Wolf 已提交
3963 3964 3965
     *
     * For now, simply forbidding the combination for all drivers will do. */
    if (options->has_aio && options->aio == BLOCKDEV_AIO_OPTIONS_NATIVE) {
3966 3967 3968 3969
        bool direct = options->has_cache &&
                      options->cache->has_direct &&
                      options->cache->direct;
        if (!direct) {
K
Kevin Wolf 已提交
3970 3971 3972 3973 3974
            error_setg(errp, "aio=native requires cache.direct=true");
            goto fail;
        }
    }

3975 3976
    visit_type_BlockdevOptions(qmp_output_get_visitor(ov), NULL, &options,
                               &local_err);
3977
    if (local_err) {
K
Kevin Wolf 已提交
3978 3979 3980 3981 3982 3983 3984 3985 3986
        error_propagate(errp, local_err);
        goto fail;
    }

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

    qdict_flatten(qdict);

3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001
    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;
        }

4002 4003
        bs = bds_tree_init(qdict, errp);
        if (!bs) {
4004 4005
            goto fail;
        }
4006 4007

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

4010 4011
    if (bs && bdrv_key_required(bs)) {
        if (blk) {
4012
            monitor_remove_blk(blk);
4013 4014
            blk_unref(blk);
        } else {
4015
            QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4016 4017
            bdrv_unref(bs);
        }
4018 4019 4020 4021
        error_setg(errp, "blockdev-add doesn't support encrypted devices");
        goto fail;
    }

K
Kevin Wolf 已提交
4022
fail:
4023
    visit_free(qmp_output_get_visitor(ov));
K
Kevin Wolf 已提交
4024 4025
}

4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041
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) {
4042
        /* blk_by_name() never returns a BB that is not owned by the monitor */
4043 4044 4045 4046 4047
        blk = blk_by_name(id);
        if (!blk) {
            error_setg(errp, "Cannot find block backend %s", id);
            return;
        }
4048 4049 4050 4051 4052
        if (blk_legacy_dinfo(blk)) {
            error_setg(errp, "Deleting block backend added with drive-add"
                       " is not supported");
            return;
        }
4053 4054 4055 4056 4057 4058 4059
        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 已提交
4060
        blk = NULL;
4061 4062 4063 4064 4065
        bs = bdrv_find_node(node_name);
        if (!bs) {
            error_setg(errp, "Cannot find node %s", node_name);
            return;
        }
K
Kevin Wolf 已提交
4066
        if (bdrv_has_blk(bs)) {
4067
            error_setg(errp, "Node %s is in use by %s",
K
Kevin Wolf 已提交
4068
                       node_name, bdrv_get_parent_name(bs));
4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
            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;
        }

4081 4082 4083 4084 4085 4086 4087
        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) {
4088 4089 4090 4091 4092 4093 4094
            error_setg(errp, "Block device %s is in use",
                       bdrv_get_device_or_node_name(bs));
            goto out;
        }
    }

    if (blk) {
4095
        monitor_remove_blk(blk);
4096 4097
        blk_unref(blk);
    } else {
4098
        QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
4099 4100 4101 4102 4103 4104 4105
        bdrv_unref(bs);
    }

out:
    aio_context_release(aio_context);
}

4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160
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);
    }
}

4161
BlockJobInfoList *qmp_query_block_jobs(Error **errp)
S
Stefan Hajnoczi 已提交
4162
{
4163
    BlockJobInfoList *head = NULL, **p_next = &head;
4164
    BlockJob *job;
S
Stefan Hajnoczi 已提交
4165

4166 4167 4168
    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);
4169 4170

        aio_context_acquire(aio_context);
4171
        elem->value = block_job_query(job);
4172
        aio_context_release(aio_context);
4173 4174 4175

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

4178
    return head;
S
Stefan Hajnoczi 已提交
4179
}
4180

4181
QemuOptsList qemu_common_drive_opts = {
4182
    .name = "drive",
4183
    .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
4184 4185 4186 4187 4188
    .desc = {
        {
            .name = "snapshot",
            .type = QEMU_OPT_BOOL,
            .help = "enable/disable snapshot mode",
4189 4190 4191 4192
        },{
            .name = "discard",
            .type = QEMU_OPT_STRING,
            .help = "discard operation (ignore/off, unmap/on)",
4193 4194 4195 4196
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
4197 4198 4199 4200
        },{
            .name = BDRV_OPT_CACHE_WB,
            .type = QEMU_OPT_BOOL,
            .help = "Enable writeback mode",
4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213
        },{
            .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",
        },{
4214
            .name = "read-only",
4215 4216 4217
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
        },{
4218
            .name = "throttling.iops-total",
4219 4220 4221
            .type = QEMU_OPT_NUMBER,
            .help = "limit total I/O operations per second",
        },{
4222
            .name = "throttling.iops-read",
4223 4224 4225
            .type = QEMU_OPT_NUMBER,
            .help = "limit read operations per second",
        },{
4226
            .name = "throttling.iops-write",
4227 4228 4229
            .type = QEMU_OPT_NUMBER,
            .help = "limit write operations per second",
        },{
4230
            .name = "throttling.bps-total",
4231 4232 4233
            .type = QEMU_OPT_NUMBER,
            .help = "limit total bytes per second",
        },{
4234
            .name = "throttling.bps-read",
4235 4236 4237
            .type = QEMU_OPT_NUMBER,
            .help = "limit read bytes per second",
        },{
4238
            .name = "throttling.bps-write",
4239 4240
            .type = QEMU_OPT_NUMBER,
            .help = "limit write bytes per second",
4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264
        },{
            .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",
4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288
        },{
            .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",
4289 4290 4291 4292
        },{
            .name = "throttling.iops-size",
            .type = QEMU_OPT_NUMBER,
            .help = "when limiting by iops max size of an I/O in bytes",
4293 4294 4295 4296
        },{
            .name = "throttling.group",
            .type = QEMU_OPT_STRING,
            .help = "name of the block throttling group",
4297 4298 4299 4300
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
4301 4302 4303 4304
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
4305 4306 4307 4308 4309 4310 4311 4312 4313 4314
        },{
            .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",
4315 4316 4317 4318
        },
        { /* end of list */ }
    },
};
4319

4320 4321
static QemuOptsList qemu_root_bds_opts = {
    .name = "root-bds",
4322
    .head = QTAILQ_HEAD_INITIALIZER(qemu_root_bds_opts.head),
4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348
    .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 */ }
    },
};

4349 4350 4351 4352
QemuOptsList qemu_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
    .desc = {
4353 4354 4355 4356
        /*
         * no elements => accept any params
         * validation will happen later
         */
4357 4358 4359
        { /* end of list */ }
    },
};