blockdev.c 119.2 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"
46
#include "qapi/qobject-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"
51
#include "block/trace.h"
52
#include "sysemu/arch_init.h"
53
#include "sysemu/qtest.h"
54 55
#include "qemu/cutils.h"
#include "qemu/help_option.h"
56
#include "qemu/throttle-options.h"
57

58 59 60
static QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
    QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);

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

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

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

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

    if (max_devs <= 0) {
        return;
    }

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

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

134
    if (!dinfo) {
135 136 137
        return;
    }

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

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

M
Max Reitz 已提交
146 147
        aio_context_release(aio_context);
    }
148

149
    dinfo->auto_del = 1;
150 151
}

152
void blockdev_auto_del(BlockBackend *blk)
153
{
154
    DriveInfo *dinfo = blk_legacy_dinfo(blk);
155

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

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

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

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

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

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

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

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

    return NULL;
}

232
void drive_check_orphaned(void)
J
John Snow 已提交
233
{
234
    BlockBackend *blk;
J
John Snow 已提交
235
    DriveInfo *dinfo;
236
    Location loc;
237
    bool orphans = false;
J
John Snow 已提交
238

239 240
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
241
        if (!blk_get_attached_dev(blk) && !dinfo->is_default &&
J
John Snow 已提交
242
            dinfo->type != IF_NONE) {
243 244
            loc_push_none(&loc);
            qemu_opts_loc_restore(dinfo->opts);
245
            error_report("machine type does not support"
246 247 248
                         " if=%s,bus=%d,unit=%d",
                         if_name[dinfo->type], dinfo->bus, dinfo->unit);
            loc_pop(&loc);
249
            orphans = true;
J
John Snow 已提交
250 251 252
        }
    }

253 254 255
    if (orphans) {
        exit(1);
    }
J
John Snow 已提交
256 257
}

258 259 260 261 262 263 264
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));
}

265 266 267
int drive_get_max_bus(BlockInterfaceType type)
{
    int max_bus;
268
    BlockBackend *blk;
269 270 271
    DriveInfo *dinfo;

    max_bus = -1;
272 273 274
    for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
        dinfo = blk_legacy_dinfo(blk);
        if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
275
            max_bus = dinfo->bus;
276
        }
277 278 279 280
    }
    return max_bus;
}

281 282 283 284 285 286 287 288 289 290
/* 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]++);
}

291 292
static void bdrv_format_print(void *opaque, const char *name)
{
293
    error_printf(" %s", name);
294 295
}

296 297
typedef struct {
    QEMUBH *bh;
F
Fam Zheng 已提交
298 299
    BlockDriverState *bs;
} BDRVPutRefBH;
300

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

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
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;
        }

338 339 340
        case QTYPE_QNUM: {
            int64_t length = qnum_get_int(qobject_to_qnum(entry->value));

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
            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;
}

358 359
typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;

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
/* 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)
{
    Error *local_error = NULL;
    const char *aio;

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

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

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

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

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

    if (detect_zeroes) {
        *detect_zeroes =
            qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
                            qemu_opt_get(opts, "detect-zeroes"),
443
                            BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
444 445 446 447 448 449 450 451 452
                            BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
                            &local_error);
        if (local_error) {
            error_propagate(errp, local_error);
            return;
        }
    }
}

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

475 476 477
    /* 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");
478
    opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, &error);
479
    if (error) {
480
        error_propagate(errp, error);
481
        goto err_no_opts;
482 483 484
    }

    qemu_opts_absorb_qdict(opts, bs_opts, &error);
485
    if (error) {
486
        error_propagate(errp, error);
487
        goto early_err;
488 489 490 491 492 493
    }

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

494 495 496
    /* extract parameters */
    snapshot = qemu_opt_get_bool(opts, "snapshot", 0);

497 498 499
    account_invalid = qemu_opt_get_bool(opts, "stats-account-invalid", true);
    account_failed = qemu_opt_get_bool(opts, "stats-account-failed", true);

500 501
    writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);

502 503
    id = qemu_opts_id(opts);

504 505 506 507 508 509 510 511
    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;
    }
512

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

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

528 529
        if (qdict_haskey(bs_opts, "driver")) {
            error_setg(errp, "Cannot specify both 'driver' and 'format'");
530
            goto early_err;
531
        }
532
        qdict_put_str(bs_opts, "driver", buf);
533 534
    }

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

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

553
    if (snapshot) {
554
        bdrv_flags |= BDRV_O_SNAPSHOT;
555 556
    }

557 558
    read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);

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

K
Kevin Wolf 已提交
563
        blk = blk_new(0, BLK_PERM_ALL);
564 565
        blk_rs = blk_get_root_state(blk);
        blk_rs->open_flags    = bdrv_flags;
566
        blk_rs->read_only     = read_only;
567 568
        blk_rs->detect_zeroes = detect_zeroes;

569 570 571
        QDECREF(bs_opts);
    } else {
        if (file && !*file) {
572 573
            file = NULL;
        }
574

575 576 577 578 579
        /* 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");
580 581
        qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
                              read_only ? "on" : "off");
582
        assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
583

584 585 586 587
        if (runstate_check(RUN_STATE_INMIGRATE)) {
            bdrv_flags |= BDRV_O_INACTIVE;
        }

588
        blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
589 590 591 592
        if (!blk) {
            goto err_no_bs_opts;
        }
        bs = blk_bs(blk);
593

594
        bs->detect_zeroes = detect_zeroes;
595

596
        block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
597

598 599 600 601
        if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
            blk_unref(blk);
            blk = NULL;
            goto err_no_bs_opts;
602
        }
603 604
    }

605 606 607
    /* disk I/O throttling */
    if (throttle_enabled(&cfg)) {
        if (!throttling_group) {
608
            throttling_group = id;
609 610 611 612 613
        }
        blk_io_limits_enable(blk, throttling_group);
        blk_set_io_limits(blk, &cfg);
    }

614
    blk_set_enable_write_cache(blk, !writethrough);
615
    blk_set_on_error(blk, on_read_error, on_write_error);
616

617
    if (!monitor_add_blk(blk, id, errp)) {
618 619 620 621 622
        blk_unref(blk);
        blk = NULL;
        goto err_no_bs_opts;
    }

623
err_no_bs_opts:
624
    qemu_opts_del(opts);
625 626
    QDECREF(interval_dict);
    QDECREF(interval_list);
627
    return blk;
628

629 630
early_err:
    qemu_opts_del(opts);
631 632
    QDECREF(interval_dict);
    QDECREF(interval_list);
633 634
err_no_opts:
    QDECREF(bs_opts);
635
    return NULL;
636 637
}

638 639 640 641 642
/* Takes the ownership of bs_opts */
static BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
{
    int bdrv_flags = 0;

643 644 645 646 647
    /* 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");
648
    qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
649

650 651 652 653
    if (runstate_check(RUN_STATE_INMIGRATE)) {
        bdrv_flags |= BDRV_O_INACTIVE;
    }

K
Kevin Wolf 已提交
654
    return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
655 656
}

657 658 659 660 661 662 663 664 665 666 667 668 669
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 已提交
670 671 672 673 674 675 676
/* 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);
}

677 678
static void qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
                            Error **errp)
679 680 681 682 683
{
    const char *value;

    value = qemu_opt_get(opts, from);
    if (value) {
684 685 686 687 688
        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;
        }
689 690 691 692
    }

    /* rename all items in opts */
    while ((value = qemu_opt_get(opts, from))) {
693
        qemu_opt_set(opts, to, value, &error_abort);
694 695 696 697
        qemu_opt_unset(opts, from);
    }
}

698 699 700 701 702
QemuOptsList qemu_legacy_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
    .desc = {
        {
703 704 705 706 707 708 709 710 711 712 713 714
            .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",
        },{
715 716 717
            .name = "media",
            .type = QEMU_OPT_STRING,
            .help = "media type (disk, cdrom)",
718 719 720 721
        },{
            .name = "if",
            .type = QEMU_OPT_STRING,
            .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
        },{
            .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)",
738 739 740 741
        },{
            .name = "boot",
            .type = QEMU_OPT_BOOL,
            .help = "(deprecated, ignored)",
742 743 744 745
        },{
            .name = "addr",
            .type = QEMU_OPT_STRING,
            .help = "pci address (virtio only)",
746 747 748 749
        },{
            .name = "serial",
            .type = QEMU_OPT_STRING,
            .help = "disk serial number",
M
Max Reitz 已提交
750 751 752 753
        },{
            .name = "file",
            .type = QEMU_OPT_STRING,
            .help = "file name",
754
        },
755 756 757

        /* Options that are passed on, but have special semantics with -drive */
        {
758
            .name = BDRV_OPT_READ_ONLY,
759 760
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
761 762 763 764 765 766 767 768
        },{
            .name = "rerror",
            .type = QEMU_OPT_STRING,
            .help = "read error action",
        },{
            .name = "werror",
            .type = QEMU_OPT_STRING,
            .help = "write error action",
769 770 771 772 773 774
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
        },

775 776 777 778
        { /* end of list */ }
    },
};

779
DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type)
780
{
K
Kevin Wolf 已提交
781
    const char *value;
782
    BlockBackend *blk;
783
    DriveInfo *dinfo = NULL;
784
    QDict *bs_opts;
785 786
    QemuOpts *legacy_opts;
    DriveMediaType media = MEDIA_DISK;
787
    BlockInterfaceType type;
788
    int cyls, heads, secs, translation;
789
    int max_devs, bus_id, unit_id, index;
790
    const char *devaddr;
791
    const char *werror, *rerror;
F
Fam Zheng 已提交
792 793
    bool read_only = false;
    bool copy_on_read;
794
    const char *serial;
M
Max Reitz 已提交
795
    const char *filename;
796
    Error *local_err = NULL;
797
    int i;
798 799 800
    const char *deprecated[] = {
        "serial", "trans", "secs", "heads", "cyls", "addr"
    };
K
Kevin Wolf 已提交
801

802
    /* Change legacy command line options into QMP ones */
803 804 805 806 807 808 809
    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" },
810

811 812 813
        { "bps",            "throttling.bps-total" },
        { "bps_rd",         "throttling.bps-read" },
        { "bps_wr",         "throttling.bps-write" },
814

815 816 817
        { "iops_max",       "throttling.iops-total-max" },
        { "iops_rd_max",    "throttling.iops-read-max" },
        { "iops_wr_max",    "throttling.iops-write-max" },
818

819 820 821
        { "bps_max",        "throttling.bps-total-max" },
        { "bps_rd_max",     "throttling.bps-read-max" },
        { "bps_wr_max",     "throttling.bps-write-max" },
822

823
        { "iops_size",      "throttling.iops-size" },
824

825 826
        { "group",          "throttling.group" },

827
        { "readonly",       BDRV_OPT_READ_ONLY },
828 829 830
    };

    for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
831 832 833
        qemu_opt_rename(all_opts, opt_renames[i].from, opt_renames[i].to,
                        &local_err);
        if (local_err) {
834
            error_report_err(local_err);
835 836
            return NULL;
        }
837
    }
838

K
Kevin Wolf 已提交
839 840 841
    value = qemu_opt_get(all_opts, "cache");
    if (value) {
        int flags = 0;
842
        bool writethrough;
K
Kevin Wolf 已提交
843

844
        if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
K
Kevin Wolf 已提交
845 846 847 848 849
            error_report("invalid cache option");
            return NULL;
        }

        /* Specific options take precedence */
850 851
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
852
                              !writethrough, &error_abort);
K
Kevin Wolf 已提交
853
        }
854 855
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
856
                              !!(flags & BDRV_O_NOCACHE), &error_abort);
K
Kevin Wolf 已提交
857
        }
858 859
        if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
            qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
860
                              !!(flags & BDRV_O_NO_FLUSH), &error_abort);
K
Kevin Wolf 已提交
861 862 863 864
        }
        qemu_opt_unset(all_opts, "cache");
    }

865 866 867 868
    /* Get a QDict for processing the options */
    bs_opts = qdict_new();
    qemu_opts_to_qdict(all_opts, bs_opts);

869 870
    legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
                                   &error_abort);
871
    qemu_opts_absorb_qdict(legacy_opts, bs_opts, &local_err);
872
    if (local_err) {
873
        error_report_err(local_err);
874 875 876
        goto fail;
    }

877 878 879 880 881 882 883
    /* 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");
    }

884 885 886 887 888 889 890 891 892 893
    /* Other deprecated options */
    if (!qtest_enabled()) {
        for (i = 0; i < ARRAY_SIZE(deprecated); i++) {
            if (qemu_opt_get(legacy_opts, deprecated[i]) != NULL) {
                error_report("'%s' is deprecated, please use the corresponding "
                             "option of '-device' instead", deprecated[i]);
            }
        }
    }

894 895 896 897 898 899 900
    /* 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 已提交
901
            read_only = true;
902 903 904 905 906 907
        } else {
            error_report("'%s' invalid media", value);
            goto fail;
        }
    }

908
    /* copy-on-read is disabled with a warning for read-only devices */
909
    read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
910 911 912 913 914 915 916
    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;
    }

917 918
    qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
    qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
919

920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
    /* 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;
    }

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
    /* 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;
967 968 969 970
        } else if (!strcmp(value, "large")) {
            translation = BIOS_ATA_TRANSLATION_LARGE;
        } else if (!strcmp(value, "rechs")) {
            translation = BIOS_ATA_TRANSLATION_RECHS;
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
        } 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;
        }
    }

986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
    /* 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;
    }

1025 1026 1027
    /* Serial number */
    serial = qemu_opt_get(legacy_opts, "serial");

1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
    /* 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);
        }
1042
        qdict_put_str(bs_opts, "id", new_id);
1043 1044 1045
        g_free(new_id);
    }

1046 1047 1048 1049 1050 1051 1052 1053 1054
    /* 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;
1055 1056
        devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
                                   &error_abort);
1057
        if (arch_type == QEMU_ARCH_S390X) {
1058
            qemu_opt_set(devopts, "driver", "virtio-blk-ccw", &error_abort);
1059
        } else {
1060
            qemu_opt_set(devopts, "driver", "virtio-blk-pci", &error_abort);
1061
        }
1062 1063
        qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
                     &error_abort);
1064
        if (devaddr) {
1065
            qemu_opt_set(devopts, "addr", devaddr, &error_abort);
1066 1067 1068
        }
    }

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

1071 1072 1073 1074 1075 1076 1077 1078
    /* 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;
        }
1079
        qdict_put_str(bs_opts, "werror", werror);
1080 1081 1082 1083 1084 1085 1086 1087 1088
    }

    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;
        }
1089
        qdict_put_str(bs_opts, "rerror", rerror);
1090 1091
    }

1092
    /* Actual block device init: Functionality shared with blockdev-add */
1093
    blk = blockdev_init(filename, bs_opts, &local_err);
1094
    bs_opts = NULL;
1095
    if (!blk) {
1096
        if (local_err) {
1097
            error_report_err(local_err);
1098
        }
1099
        goto fail;
1100
    } else {
1101
        assert(!local_err);
1102 1103
    }

1104 1105
    /* Create legacy DriveInfo */
    dinfo = g_malloc0(sizeof(*dinfo));
1106
    dinfo->opts = all_opts;
1107

1108 1109 1110 1111 1112
    dinfo->cyls = cyls;
    dinfo->heads = heads;
    dinfo->secs = secs;
    dinfo->trans = translation;

1113
    dinfo->type = type;
1114 1115
    dinfo->bus = bus_id;
    dinfo->unit = unit_id;
1116
    dinfo->devaddr = devaddr;
1117 1118
    dinfo->serial = g_strdup(serial);

1119 1120
    blk_set_legacy_dinfo(blk, dinfo);

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
    switch(type) {
    case IF_IDE:
    case IF_SCSI:
    case IF_XEN:
    case IF_NONE:
        dinfo->media_cd = media == MEDIA_CDROM;
        break;
    default:
        break;
    }

1132
fail:
1133
    qemu_opts_del(legacy_opts);
1134
    QDECREF(bs_opts);
1135
    return dinfo;
1136 1137
}

1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
{
    BlockDriverState *bs;

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

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

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

    return bs;
}

1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
static BlockBackend *qmp_get_blk(const char *blk_name, const char *qdev_id,
                                 Error **errp)
{
    BlockBackend *blk;

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

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

    return blk;
}

1183
void hmp_commit(Monitor *mon, const QDict *qdict)
1184 1185
{
    const char *device = qdict_get_str(qdict, "device");
1186
    BlockBackend *blk;
1187
    int ret;
1188

1189
    if (!strcmp(device, "all")) {
1190
        ret = blk_commit_all();
1191
    } else {
1192 1193 1194
        BlockDriverState *bs;
        AioContext *aio_context;

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

        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);
1212 1213 1214 1215
    }
    if (ret < 0) {
        monitor_printf(mon, "'commit' error for '%s': %s\n", device,
                       strerror(-ret));
1216 1217 1218
    }
}

1219
static void blockdev_do_action(TransactionAction *action, Error **errp)
1220
{
1221
    TransactionActionList list;
1222

1223
    list.value = action;
1224
    list.next = NULL;
J
John Snow 已提交
1225
    qmp_transaction(&list, false, NULL, errp);
1226 1227
}

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

1256 1257 1258 1259 1260 1261 1262
void qmp_blockdev_snapshot(const char *node, const char *overlay,
                           Error **errp)
{
    BlockdevSnapshot snapshot_data = {
        .node = (char *) node,
        .overlay = (char *) overlay
    };
1263 1264
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1265
        .u.blockdev_snapshot.data = &snapshot_data,
1266 1267
    };
    blockdev_do_action(&action, errp);
1268 1269
}

1270 1271 1272 1273 1274 1275 1276 1277
void qmp_blockdev_snapshot_internal_sync(const char *device,
                                         const char *name,
                                         Error **errp)
{
    BlockdevSnapshotInternal snapshot = {
        .device = (char *) device,
        .name = (char *) name
    };
1278 1279
    TransactionAction action = {
        .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1280
        .u.blockdev_snapshot_internal_sync.data = &snapshot,
1281 1282
    };
    blockdev_do_action(&action, errp);
1283 1284
}

1285 1286 1287 1288 1289 1290 1291
SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
                                                         bool has_id,
                                                         const char *id,
                                                         bool has_name,
                                                         const char *name,
                                                         Error **errp)
{
1292
    BlockDriverState *bs;
1293
    AioContext *aio_context;
1294 1295 1296 1297 1298
    QEMUSnapshotInfo sn;
    Error *local_err = NULL;
    SnapshotInfo *info = NULL;
    int ret;

1299 1300
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
1301 1302
        return NULL;
    }
1303
    aio_context = bdrv_get_aio_context(bs);
M
Max Reitz 已提交
1304
    aio_context_acquire(aio_context);
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315

    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 已提交
1316
        goto out_aio_context;
1317 1318
    }

1319 1320 1321 1322
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
        goto out_aio_context;
    }

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

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

1342 1343
    aio_context_release(aio_context);

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

out_aio_context:
    aio_context_release(aio_context);
    return NULL;
1358
}
1359

1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
/**
 * 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,
                                                  Error **errp)
{
    BlockDriverState *bs;
    BdrvDirtyBitmap *bitmap;

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

    bitmap = bdrv_find_dirty_bitmap(bs, name);
    if (!bitmap) {
        error_setg(errp, "Dirty bitmap '%s' not found", name);
1398
        return NULL;
1399 1400 1401 1402 1403 1404 1405 1406 1407
    }

    if (pbs) {
        *pbs = bs;
    }

    return bitmap;
}

1408
/* New and old BlockDriverState structs for atomic group operations */
1409

1410
typedef struct BlkActionState BlkActionState;
1411

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
/**
 * 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 {
1427
    size_t instance_size;
1428 1429 1430 1431 1432
    void (*prepare)(BlkActionState *common, Error **errp);
    void (*commit)(BlkActionState *common);
    void (*abort)(BlkActionState *common);
    void (*clean)(BlkActionState *common);
} BlkActionOps;
1433

1434 1435 1436 1437 1438 1439
/**
 * 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 已提交
1440
 * @block_job_txn: Transaction which this action belongs to.
1441 1442 1443 1444 1445
 * @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.
1446
 */
1447
struct BlkActionState {
1448
    TransactionAction *action;
1449
    const BlkActionOps *ops;
J
John Snow 已提交
1450 1451
    BlockJobTxn *block_job_txn;
    TransactionProperties *txn_props;
1452
    QSIMPLEQ_ENTRY(BlkActionState) entry;
1453 1454
};

1455 1456
/* internal snapshot private data */
typedef struct InternalSnapshotState {
1457
    BlkActionState common;
1458
    BlockDriverState *bs;
1459
    AioContext *aio_context;
1460
    QEMUSnapshotInfo sn;
1461
    bool created;
1462 1463
} InternalSnapshotState;

J
John Snow 已提交
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477

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

1478
static void internal_snapshot_prepare(BlkActionState *common,
1479 1480
                                      Error **errp)
{
1481
    Error *local_err = NULL;
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
    const char *device;
    const char *name;
    BlockDriverState *bs;
    QEMUSnapshotInfo old_sn, *sn;
    bool ret;
    qemu_timeval tv;
    BlockdevSnapshotInternal *internal;
    InternalSnapshotState *state;
    int ret1;

1492
    g_assert(common->action->type ==
1493
             TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1494
    internal = common->action->u.blockdev_snapshot_internal_sync.data;
1495 1496 1497 1498 1499 1500 1501
    state = DO_UPCAST(InternalSnapshotState, common, common);

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

    /* 2. check for validation */
J
John Snow 已提交
1502 1503 1504 1505
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1506 1507
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
1508 1509 1510
        return;
    }

1511
    /* AioContext is released in .clean() */
1512
    state->aio_context = bdrv_get_aio_context(bs);
1513 1514
    aio_context_acquire(state->aio_context);

1515 1516 1517
    state->bs = bs;
    bdrv_drained_begin(bs);

1518 1519 1520 1521
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
        return;
    }

1522
    if (bdrv_is_read_only(bs)) {
1523
        error_setg(errp, "Device '%s' is read only", device);
1524 1525 1526 1527
        return;
    }

    if (!bdrv_can_snapshot(bs)) {
1528 1529 1530
        error_setg(errp, "Block format '%s' used by device '%s' "
                   "does not support internal snapshots",
                   bs->drv->format_name, device);
1531 1532 1533 1534 1535 1536 1537 1538 1539
        return;
    }

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

    /* check whether a snapshot with name exist */
1540 1541 1542 1543
    ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
                                            &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
        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 */
1569
    state->created = true;
1570 1571
}

1572
static void internal_snapshot_abort(BlkActionState *common)
1573 1574 1575 1576 1577 1578 1579
{
    InternalSnapshotState *state =
                             DO_UPCAST(InternalSnapshotState, common, common);
    BlockDriverState *bs = state->bs;
    QEMUSnapshotInfo *sn = &state->sn;
    Error *local_error = NULL;

1580
    if (!state->created) {
1581 1582 1583 1584
        return;
    }

    if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1585 1586 1587 1588 1589
        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));
1590 1591 1592
    }
}

1593
static void internal_snapshot_clean(BlkActionState *common)
1594 1595 1596 1597 1598
{
    InternalSnapshotState *state = DO_UPCAST(InternalSnapshotState,
                                             common, common);

    if (state->aio_context) {
1599 1600 1601
        if (state->bs) {
            bdrv_drained_end(state->bs);
        }
1602 1603 1604 1605
        aio_context_release(state->aio_context);
    }
}

1606
/* external snapshot private data */
1607
typedef struct ExternalSnapshotState {
1608
    BlkActionState common;
1609 1610
    BlockDriverState *old_bs;
    BlockDriverState *new_bs;
1611
    AioContext *aio_context;
1612
    bool overlay_appended;
1613
} ExternalSnapshotState;
1614

1615
static void external_snapshot_prepare(BlkActionState *common,
1616 1617
                                      Error **errp)
{
M
Max Reitz 已提交
1618
    int flags = 0;
1619
    QDict *options = NULL;
1620
    Error *local_err = NULL;
1621
    /* Device and node name of the image to generate the snapshot from */
1622
    const char *device;
1623
    const char *node_name;
1624 1625 1626
    /* Reference to the new image (for 'blockdev-snapshot') */
    const char *snapshot_ref;
    /* File name of the new image (for 'blockdev-snapshot-sync') */
1627
    const char *new_image_file;
1628 1629
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1630
    TransactionAction *action = common->action;
1631

1632 1633 1634 1635 1636
    /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
     * purpose but a different set of parameters */
    switch (action->type) {
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
        {
1637
            BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1638 1639 1640 1641 1642 1643 1644 1645
            device = s->node;
            node_name = s->node;
            new_image_file = NULL;
            snapshot_ref = s->overlay;
        }
        break;
    case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
        {
1646
            BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1647 1648 1649 1650 1651 1652 1653 1654
            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();
1655 1656 1657
    }

    /* start processing */
J
John Snow 已提交
1658 1659 1660 1661
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1662 1663
    state->old_bs = bdrv_lookup_bs(device, node_name, errp);
    if (!state->old_bs) {
1664 1665 1666
        return;
    }

1667 1668 1669
    /* 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);
1670
    bdrv_drained_begin(state->old_bs);
1671

1672
    if (!bdrv_is_inserted(state->old_bs)) {
1673
        error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1674 1675 1676
        return;
    }

1677 1678
    if (bdrv_op_is_blocked(state->old_bs,
                           BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1679 1680 1681
        return;
    }

1682 1683
    if (!bdrv_is_read_only(state->old_bs)) {
        if (bdrv_flush(state->old_bs)) {
1684
            error_setg(errp, QERR_IO_ERROR);
1685 1686 1687 1688
            return;
        }
    }

1689
    if (!bdrv_is_first_non_filter(state->old_bs)) {
1690
        error_setg(errp, QERR_FEATURE_DISABLED, "snapshot");
1691 1692 1693
        return;
    }

1694
    if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1695
        BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1696 1697 1698 1699
        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;
1700

1701 1702
        if (node_name && !snapshot_node_name) {
            error_setg(errp, "New snapshot node name missing");
1703 1704 1705
            return;
        }

1706 1707 1708 1709 1710 1711 1712
        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;
1713
        flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ);
1714 1715 1716 1717

        /* create new image w/backing file */
        mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
        if (mode != NEW_IMAGE_MODE_EXISTING) {
1718 1719 1720 1721 1722
            int64_t size = bdrv_getlength(state->old_bs);
            if (size < 0) {
                error_setg_errno(errp, -size, "bdrv_getlength failed");
                return;
            }
1723 1724 1725
            bdrv_img_create(new_image_file, format,
                            state->old_bs->filename,
                            state->old_bs->drv->format_name,
1726
                            NULL, size, flags, false, &local_err);
1727 1728 1729 1730 1731 1732 1733 1734
            if (local_err) {
                error_propagate(errp, local_err);
                return;
            }
        }

        options = qdict_new();
        if (s->has_snapshot_node_name) {
1735
            qdict_put_str(options, "node-name", snapshot_node_name);
1736
        }
1737
        qdict_put_str(options, "driver", format);
1738 1739

        flags |= BDRV_O_NO_BACKING;
1740 1741
    }

M
Max Reitz 已提交
1742 1743
    state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
                              errp);
1744
    /* We will manually add the backing_hd field to the bs later */
M
Max Reitz 已提交
1745
    if (!state->new_bs) {
1746 1747 1748
        return;
    }

K
Kevin Wolf 已提交
1749
    if (bdrv_has_blk(state->new_bs)) {
1750
        error_setg(errp, "The snapshot is already in use");
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
        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");
1761 1762 1763 1764 1765
        return;
    }

    if (!state->new_bs->drv->supports_backing) {
        error_setg(errp, "The snapshot does not support backing images");
1766 1767 1768
        return;
    }

1769 1770
    bdrv_set_aio_context(state->new_bs, state->aio_context);

1771 1772 1773 1774 1775 1776 1777 1778
    /* This removes our old bs and adds the new bs. This is an operation that
     * can fail, so we need to do it in .prepare; undoing it for abort is
     * always possible. */
    bdrv_ref(state->new_bs);
    bdrv_append(state->new_bs, state->old_bs, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
1779
    }
1780
    state->overlay_appended = true;
1781 1782
}

1783
static void external_snapshot_commit(BlkActionState *common)
1784
{
1785 1786
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
1787

1788 1789 1790
    /* 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 */
1791
    if (!atomic_read(&state->old_bs->copy_on_read)) {
1792 1793 1794
        bdrv_reopen(state->old_bs, state->old_bs->open_flags & ~BDRV_O_RDWR,
                    NULL);
    }
1795 1796
}

1797
static void external_snapshot_abort(BlkActionState *common)
1798
{
1799 1800 1801
    ExternalSnapshotState *state =
                             DO_UPCAST(ExternalSnapshotState, common, common);
    if (state->new_bs) {
1802
        if (state->overlay_appended) {
1803 1804 1805
            bdrv_ref(state->old_bs);   /* we can't let bdrv_set_backind_hd()
                                          close state->old_bs; we need it */
            bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
1806
            bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
1807
            bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
1808
        }
1809
    }
1810 1811
}

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

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

1830
static BlockJob *do_drive_backup(DriveBackup *backup, BlockJobTxn *txn,
P
Pavel Butsykin 已提交
1831
                            Error **errp);
1832

1833
static void drive_backup_prepare(BlkActionState *common, Error **errp)
1834 1835
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1836
    BlockDriverState *bs;
1837 1838 1839
    DriveBackup *backup;
    Error *local_err = NULL;

1840
    assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1841
    backup = common->action->u.drive_backup.data;
1842

1843 1844
    bs = qmp_get_root_bs(backup->device, errp);
    if (!bs) {
1845 1846 1847
        return;
    }

1848
    /* AioContext is released in .clean() */
1849
    state->aio_context = bdrv_get_aio_context(bs);
1850
    aio_context_acquire(state->aio_context);
1851 1852
    bdrv_drained_begin(bs);
    state->bs = bs;
1853

1854
    state->job = do_drive_backup(backup, common->block_job_txn, &local_err);
1855
    if (local_err) {
1856 1857 1858
        error_propagate(errp, local_err);
        return;
    }
1859
}
1860

1861 1862 1863 1864 1865
static void drive_backup_commit(BlkActionState *common)
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
    assert(state->job);
    block_job_start(state->job);
1866 1867
}

1868
static void drive_backup_abort(BlkActionState *common)
1869 1870 1871
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);

1872 1873
    if (state->job) {
        block_job_cancel_sync(state->job);
1874 1875 1876
    }
}

1877
static void drive_backup_clean(BlkActionState *common)
1878 1879 1880 1881
{
    DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);

    if (state->aio_context) {
1882
        bdrv_drained_end(state->bs);
1883 1884 1885 1886
        aio_context_release(state->aio_context);
    }
}

1887
typedef struct BlockdevBackupState {
1888
    BlkActionState common;
1889 1890 1891 1892 1893
    BlockDriverState *bs;
    BlockJob *job;
    AioContext *aio_context;
} BlockdevBackupState;

1894 1895
static BlockJob *do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn,
                                    Error **errp);
1896

1897
static void blockdev_backup_prepare(BlkActionState *common, Error **errp)
1898 1899 1900
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
    BlockdevBackup *backup;
1901
    BlockDriverState *bs, *target;
1902 1903
    Error *local_err = NULL;

1904
    assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1905
    backup = common->action->u.blockdev_backup.data;
1906

1907 1908
    bs = qmp_get_root_bs(backup->device, errp);
    if (!bs) {
1909 1910 1911
        return;
    }

1912
    target = bdrv_lookup_bs(backup->target, backup->target, errp);
M
Max Reitz 已提交
1913
    if (!target) {
1914 1915 1916 1917
        return;
    }

    /* AioContext is released in .clean() */
1918
    state->aio_context = bdrv_get_aio_context(bs);
1919
    if (state->aio_context != bdrv_get_aio_context(target)) {
1920 1921 1922 1923 1924
        state->aio_context = NULL;
        error_setg(errp, "Backup between two IO threads is not implemented");
        return;
    }
    aio_context_acquire(state->aio_context);
1925
    state->bs = bs;
1926
    bdrv_drained_begin(state->bs);
1927

1928
    state->job = do_blockdev_backup(backup, common->block_job_txn, &local_err);
1929 1930 1931 1932
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }
1933
}
1934

1935 1936 1937 1938 1939
static void blockdev_backup_commit(BlkActionState *common)
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
    assert(state->job);
    block_job_start(state->job);
1940 1941
}

1942
static void blockdev_backup_abort(BlkActionState *common)
1943 1944 1945
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);

1946 1947
    if (state->job) {
        block_job_cancel_sync(state->job);
1948 1949 1950
    }
}

1951
static void blockdev_backup_clean(BlkActionState *common)
1952 1953 1954 1955
{
    BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);

    if (state->aio_context) {
1956
        bdrv_drained_end(state->bs);
1957 1958 1959 1960
        aio_context_release(state->aio_context);
    }
}

F
Fam Zheng 已提交
1961
typedef struct BlockDirtyBitmapState {
1962
    BlkActionState common;
F
Fam Zheng 已提交
1963 1964 1965 1966 1967 1968 1969
    BdrvDirtyBitmap *bitmap;
    BlockDriverState *bs;
    AioContext *aio_context;
    HBitmap *backup;
    bool prepared;
} BlockDirtyBitmapState;

1970
static void block_dirty_bitmap_add_prepare(BlkActionState *common,
F
Fam Zheng 已提交
1971 1972 1973 1974 1975 1976 1977
                                           Error **errp)
{
    Error *local_err = NULL;
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

J
John Snow 已提交
1978 1979 1980 1981
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

1982
    action = common->action->u.block_dirty_bitmap_add.data;
F
Fam Zheng 已提交
1983 1984 1985
    /* 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,
1986
                               action->has_persistent, action->persistent,
F
Fam Zheng 已提交
1987 1988 1989 1990 1991 1992 1993 1994 1995
                               &local_err);

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

1996
static void block_dirty_bitmap_add_abort(BlkActionState *common)
F
Fam Zheng 已提交
1997 1998 1999 2000 2001
{
    BlockDirtyBitmapAdd *action;
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

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

2011
static void block_dirty_bitmap_clear_prepare(BlkActionState *common,
F
Fam Zheng 已提交
2012 2013 2014 2015 2016 2017
                                             Error **errp)
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);
    BlockDirtyBitmap *action;

J
John Snow 已提交
2018 2019 2020 2021
    if (action_check_completion_mode(common, errp) < 0) {
        return;
    }

2022
    action = common->action->u.block_dirty_bitmap_clear.data;
F
Fam Zheng 已提交
2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
    state->bitmap = block_dirty_bitmap_lookup(action->node,
                                              action->name,
                                              &state->bs,
                                              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;
2037 2038 2039
    } else if (bdrv_dirty_bitmap_readonly(state->bitmap)) {
        error_setg(errp, "Cannot clear a readonly bitmap");
        return;
F
Fam Zheng 已提交
2040 2041 2042 2043 2044 2045
    }

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

2046
static void block_dirty_bitmap_clear_abort(BlkActionState *common)
F
Fam Zheng 已提交
2047 2048 2049 2050
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

J
John Snow 已提交
2051 2052 2053
    if (state->backup) {
        bdrv_undo_clear_dirty_bitmap(state->bitmap, state->backup);
    }
F
Fam Zheng 已提交
2054 2055
}

2056
static void block_dirty_bitmap_clear_commit(BlkActionState *common)
F
Fam Zheng 已提交
2057 2058 2059 2060 2061 2062 2063
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

    hbitmap_free(state->backup);
}

2064
static void block_dirty_bitmap_clear_clean(BlkActionState *common)
F
Fam Zheng 已提交
2065 2066 2067 2068 2069 2070 2071 2072 2073
{
    BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
                                             common, common);

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

2074
static void abort_prepare(BlkActionState *common, Error **errp)
2075 2076 2077 2078
{
    error_setg(errp, "Transaction aborted using Abort action");
}

2079
static void abort_commit(BlkActionState *common)
2080
{
2081
    g_assert_not_reached(); /* this action never succeeds */
2082 2083
}

2084
static const BlkActionOps actions[] = {
2085 2086 2087 2088 2089
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
        .instance_size = sizeof(ExternalSnapshotState),
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2090
        .clean = external_snapshot_clean,
2091
    },
2092
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2093
        .instance_size = sizeof(ExternalSnapshotState),
2094 2095 2096
        .prepare  = external_snapshot_prepare,
        .commit   = external_snapshot_commit,
        .abort = external_snapshot_abort,
2097
        .clean = external_snapshot_clean,
2098
    },
2099 2100 2101
    [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
        .instance_size = sizeof(DriveBackupState),
        .prepare = drive_backup_prepare,
2102
        .commit = drive_backup_commit,
2103
        .abort = drive_backup_abort,
2104
        .clean = drive_backup_clean,
2105
    },
2106 2107 2108
    [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
        .instance_size = sizeof(BlockdevBackupState),
        .prepare = blockdev_backup_prepare,
2109
        .commit = blockdev_backup_commit,
2110 2111 2112
        .abort = blockdev_backup_abort,
        .clean = blockdev_backup_clean,
    },
2113
    [TRANSACTION_ACTION_KIND_ABORT] = {
2114
        .instance_size = sizeof(BlkActionState),
2115 2116 2117
        .prepare = abort_prepare,
        .commit = abort_commit,
    },
2118 2119 2120 2121
    [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
        .instance_size = sizeof(InternalSnapshotState),
        .prepare  = internal_snapshot_prepare,
        .abort = internal_snapshot_abort,
2122
        .clean = internal_snapshot_clean,
2123
    },
F
Fam Zheng 已提交
2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
    [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,
    }
2136 2137
};

J
John Snow 已提交
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156
/**
 * 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;
}

2157
/*
2158 2159
 * 'Atomic' group operations.  The operations are performed as a set, and if
 * any fail then we roll back all operations in the group.
2160
 */
J
John Snow 已提交
2161 2162 2163 2164
void qmp_transaction(TransactionActionList *dev_list,
                     bool has_props,
                     struct TransactionProperties *props,
                     Error **errp)
2165
{
2166
    TransactionActionList *dev_entry = dev_list;
J
John Snow 已提交
2167
    BlockJobTxn *block_job_txn = NULL;
2168
    BlkActionState *state, *next;
2169
    Error *local_err = NULL;
2170

2171
    QSIMPLEQ_HEAD(snap_bdrv_states, BlkActionState) snap_bdrv_states;
2172 2173
    QSIMPLEQ_INIT(&snap_bdrv_states);

J
John Snow 已提交
2174 2175 2176 2177 2178 2179 2180 2181
    /* 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();
    }

2182
    /* drain all i/o before any operations */
2183 2184
    bdrv_drain_all();

2185
    /* We don't do anything in this loop that commits us to the operations */
2186
    while (NULL != dev_entry) {
2187
        TransactionAction *dev_info = NULL;
2188
        const BlkActionOps *ops;
2189

2190 2191 2192
        dev_info = dev_entry->value;
        dev_entry = dev_entry->next;

2193
        assert(dev_info->type < ARRAY_SIZE(actions));
2194

2195
        ops = &actions[dev_info->type];
2196 2197
        assert(ops->instance_size > 0);

2198 2199 2200
        state = g_malloc0(ops->instance_size);
        state->ops = ops;
        state->action = dev_info;
J
John Snow 已提交
2201 2202
        state->block_job_txn = block_job_txn;
        state->txn_props = props;
2203
        QSIMPLEQ_INSERT_TAIL(&snap_bdrv_states, state, entry);
2204

2205
        state->ops->prepare(state, &local_err);
2206
        if (local_err) {
2207 2208
            error_propagate(errp, local_err);
            goto delete_and_fail;
2209 2210 2211
        }
    }

2212
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
2213 2214 2215
        if (state->ops->commit) {
            state->ops->commit(state);
        }
2216 2217 2218 2219 2220 2221
    }

    /* success */
    goto exit;

delete_and_fail:
2222
    /* failure, and it is all-or-none; roll back all operations */
2223 2224 2225
    QSIMPLEQ_FOREACH(state, &snap_bdrv_states, entry) {
        if (state->ops->abort) {
            state->ops->abort(state);
2226
        }
2227 2228
    }
exit:
2229 2230 2231
    QSIMPLEQ_FOREACH_SAFE(state, &snap_bdrv_states, entry, next) {
        if (state->ops->clean) {
            state->ops->clean(state);
2232
        }
2233
        g_free(state);
2234
    }
J
John Snow 已提交
2235 2236 2237 2238
    if (!has_props) {
        qapi_free_TransactionProperties(props);
    }
    block_job_txn_unref(block_job_txn);
2239 2240
}

2241 2242 2243
void qmp_eject(bool has_device, const char *device,
               bool has_id, const char *id,
               bool has_force, bool force, Error **errp)
2244
{
2245
    Error *local_err = NULL;
2246 2247 2248 2249 2250
    int rc;

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

2252 2253 2254
    rc = do_open_tray(has_device ? device : NULL,
                      has_id ? id : NULL,
                      force, &local_err);
2255
    if (rc && rc != -ENOSYS) {
2256
        error_propagate(errp, local_err);
L
Luiz Capitulino 已提交
2257
        return;
2258
    }
2259
    error_free(local_err);
2260

2261
    qmp_x_blockdev_remove_medium(has_device, device, has_id, id, errp);
2262 2263
}

2264 2265 2266
void qmp_block_passwd(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      const char *password, Error **errp)
2267
{
2268 2269
    error_setg(errp,
               "Setting block passwords directly is no longer supported");
2270 2271
}

2272 2273 2274 2275 2276 2277 2278 2279 2280 2281
/*
 * 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.
2282
 */
2283 2284
static int do_open_tray(const char *blk_name, const char *qdev_id,
                        bool force, Error **errp)
M
Max Reitz 已提交
2285 2286
{
    BlockBackend *blk;
2287
    const char *device = qdev_id ?: blk_name;
M
Max Reitz 已提交
2288 2289
    bool locked;

2290
    blk = qmp_get_blk(blk_name, qdev_id, errp);
M
Max Reitz 已提交
2291
    if (!blk) {
2292
        return -ENODEV;
M
Max Reitz 已提交
2293 2294 2295 2296
    }

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

2300
    if (!blk_dev_has_tray(blk)) {
2301 2302
        error_setg(errp, "Device '%s' does not have a tray", device);
        return -ENOSYS;
2303 2304
    }

M
Max Reitz 已提交
2305
    if (blk_dev_is_tray_open(blk)) {
2306
        return 0;
M
Max Reitz 已提交
2307 2308 2309 2310 2311 2312 2313 2314
    }

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

    if (!locked || force) {
2315
        blk_dev_change_media_cb(blk, false, &error_abort);
M
Max Reitz 已提交
2316
    }
2317 2318

    if (locked && !force) {
2319 2320 2321
        error_setg(errp, "Device '%s' is locked and force was not specified, "
                   "wait for tray to open and try again", device);
        return -EINPROGRESS;
2322 2323 2324 2325 2326
    }

    return 0;
}

2327 2328 2329
void qmp_blockdev_open_tray(bool has_device, const char *device,
                            bool has_id, const char *id,
                            bool has_force, bool force,
2330 2331
                            Error **errp)
{
2332 2333 2334
    Error *local_err = NULL;
    int rc;

2335 2336 2337
    if (!has_force) {
        force = false;
    }
2338 2339 2340
    rc = do_open_tray(has_device ? device : NULL,
                      has_id ? id : NULL,
                      force, &local_err);
2341 2342 2343 2344 2345
    if (rc && rc != -ENOSYS && rc != -EINPROGRESS) {
        error_propagate(errp, local_err);
        return;
    }
    error_free(local_err);
M
Max Reitz 已提交
2346 2347
}

2348 2349 2350
void qmp_blockdev_close_tray(bool has_device, const char *device,
                             bool has_id, const char *id,
                             Error **errp)
M
Max Reitz 已提交
2351 2352
{
    BlockBackend *blk;
2353
    Error *local_err = NULL;
M
Max Reitz 已提交
2354

2355 2356 2357 2358
    device = has_device ? device : NULL;
    id = has_id ? id : NULL;

    blk = qmp_get_blk(device, id, errp);
M
Max Reitz 已提交
2359 2360 2361 2362 2363
    if (!blk) {
        return;
    }

    if (!blk_dev_has_removable_media(blk)) {
2364
        error_setg(errp, "Device '%s' is not removable", device ?: id);
M
Max Reitz 已提交
2365 2366 2367
        return;
    }

2368 2369 2370 2371 2372
    if (!blk_dev_has_tray(blk)) {
        /* Ignore this command on tray-less devices */
        return;
    }

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

2377 2378 2379 2380 2381
    blk_dev_change_media_cb(blk, true, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }
M
Max Reitz 已提交
2382 2383
}

2384 2385
void qmp_x_blockdev_remove_medium(bool has_device, const char *device,
                                  bool has_id, const char *id, Error **errp)
M
Max Reitz 已提交
2386 2387 2388 2389
{
    BlockBackend *blk;
    BlockDriverState *bs;
    AioContext *aio_context;
2390
    bool has_attached_device;
M
Max Reitz 已提交
2391

2392 2393 2394 2395
    device = has_device ? device : NULL;
    id = has_id ? id : NULL;

    blk = qmp_get_blk(device, id, errp);
M
Max Reitz 已提交
2396 2397 2398 2399 2400
    if (!blk) {
        return;
    }

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

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

2408 2409 2410 2411
    if (has_attached_device && blk_dev_has_tray(blk) &&
        !blk_dev_is_tray_open(blk))
    {
        error_setg(errp, "Tray of device '%s' is not open", device ?: id);
M
Max Reitz 已提交
2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
        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);

2429 2430 2431 2432 2433
    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). */
2434
        blk_dev_change_media_cb(blk, false, &error_abort);
2435 2436
    }

M
Max Reitz 已提交
2437 2438 2439 2440
out:
    aio_context_release(aio_context);
}

2441
static void qmp_blockdev_insert_anon_medium(BlockBackend *blk,
M
Max Reitz 已提交
2442 2443
                                            BlockDriverState *bs, Error **errp)
{
2444
    Error *local_err = NULL;
M
Max Reitz 已提交
2445
    bool has_device;
2446
    int ret;
M
Max Reitz 已提交
2447 2448 2449 2450 2451

    /* 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)) {
2452
        error_setg(errp, "Device is not removable");
M
Max Reitz 已提交
2453 2454 2455
        return;
    }

2456
    if (has_device && blk_dev_has_tray(blk) && !blk_dev_is_tray_open(blk)) {
2457
        error_setg(errp, "Tray of the device is not open");
M
Max Reitz 已提交
2458 2459 2460 2461
        return;
    }

    if (blk_bs(blk)) {
2462
        error_setg(errp, "There already is a medium in the device");
M
Max Reitz 已提交
2463 2464 2465
        return;
    }

2466 2467 2468 2469
    ret = blk_insert_bs(blk, bs, errp);
    if (ret < 0) {
        return;
    }
M
Max Reitz 已提交
2470

2471 2472 2473 2474 2475 2476
    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). */
2477 2478 2479 2480 2481 2482
        blk_dev_change_media_cb(blk, true, &local_err);
        if (local_err) {
            error_propagate(errp, local_err);
            blk_remove_bs(blk);
            return;
        }
2483
    }
M
Max Reitz 已提交
2484 2485
}

2486 2487 2488
void qmp_x_blockdev_insert_medium(bool has_device, const char *device,
                                  bool has_id, const char *id,
                                  const char *node_name, Error **errp)
M
Max Reitz 已提交
2489
{
2490
    BlockBackend *blk;
M
Max Reitz 已提交
2491 2492
    BlockDriverState *bs;

2493 2494 2495 2496 2497 2498 2499
    blk = qmp_get_blk(has_device ? device : NULL,
                      has_id ? id : NULL,
                      errp);
    if (!blk) {
        return;
    }

M
Max Reitz 已提交
2500 2501 2502 2503 2504 2505
    bs = bdrv_find_node(node_name);
    if (!bs) {
        error_setg(errp, "Node '%s' not found", node_name);
        return;
    }

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

2511
    qmp_blockdev_insert_anon_medium(blk, bs, errp);
M
Max Reitz 已提交
2512 2513
}

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

2530 2531 2532
    blk = qmp_get_blk(has_device ? device : NULL,
                      has_id ? id : NULL,
                      errp);
2533 2534 2535 2536 2537 2538 2539 2540 2541
    if (!blk) {
        goto fail;
    }

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

    bdrv_flags = blk_get_open_flags_from_root_state(blk);
2542 2543
    bdrv_flags &= ~(BDRV_O_TEMPORARY | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING |
        BDRV_O_PROTOCOL);
2544

2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
    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();
    }

2565 2566
    options = qdict_new();
    detect_zeroes = blk_get_detect_zeroes_from_root_state(blk);
2567
    qdict_put_str(options, "detect-zeroes", detect_zeroes ? "on" : "off");
2568

M
Max Reitz 已提交
2569
    if (has_format) {
2570
        qdict_put_str(options, "driver", format);
2571 2572
    }

M
Max Reitz 已提交
2573 2574
    medium_bs = bdrv_open(filename, NULL, options, bdrv_flags, errp);
    if (!medium_bs) {
2575 2576 2577
        goto fail;
    }

2578 2579 2580
    rc = do_open_tray(has_device ? device : NULL,
                      has_id ? id : NULL,
                      false, &err);
2581
    if (rc && rc != -ENOSYS) {
2582 2583 2584
        error_propagate(errp, err);
        goto fail;
    }
2585 2586
    error_free(err);
    err = NULL;
2587

2588
    qmp_x_blockdev_remove_medium(has_device, device, has_id, id, &err);
2589 2590 2591 2592 2593
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

2594
    qmp_blockdev_insert_anon_medium(blk, medium_bs, &err);
2595 2596 2597 2598 2599
    if (err) {
        error_propagate(errp, err);
        goto fail;
    }

2600
    qmp_blockdev_close_tray(has_device, device, has_id, id, errp);
2601 2602 2603 2604 2605 2606 2607 2608

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 已提交
2609
/* throttling disk I/O limits */
2610
void qmp_block_set_io_throttle(BlockIOThrottle *arg, Error **errp)
Z
Zhi Yong Wu 已提交
2611
{
2612
    ThrottleConfig cfg;
Z
Zhi Yong Wu 已提交
2613
    BlockDriverState *bs;
2614
    BlockBackend *blk;
2615
    AioContext *aio_context;
Z
Zhi Yong Wu 已提交
2616

2617 2618 2619
    blk = qmp_get_blk(arg->has_device ? arg->device : NULL,
                      arg->has_id ? arg->id : NULL,
                      errp);
2620
    if (!blk) {
2621
        return;
Z
Zhi Yong Wu 已提交
2622
    }
M
Max Reitz 已提交
2623 2624 2625 2626

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

2627
    bs = blk_bs(blk);
M
Max Reitz 已提交
2628
    if (!bs) {
2629
        error_setg(errp, "Device has no medium");
M
Max Reitz 已提交
2630 2631
        goto out;
    }
Z
Zhi Yong Wu 已提交
2632

2633
    throttle_config_init(&cfg);
2634 2635 2636
    cfg.buckets[THROTTLE_BPS_TOTAL].avg = arg->bps;
    cfg.buckets[THROTTLE_BPS_READ].avg  = arg->bps_rd;
    cfg.buckets[THROTTLE_BPS_WRITE].avg = arg->bps_wr;
2637

2638 2639 2640
    cfg.buckets[THROTTLE_OPS_TOTAL].avg = arg->iops;
    cfg.buckets[THROTTLE_OPS_READ].avg  = arg->iops_rd;
    cfg.buckets[THROTTLE_OPS_WRITE].avg = arg->iops_wr;
2641

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

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

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

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

2688 2689 2690
    if (throttle_enabled(&cfg)) {
        /* Enable I/O limits if they're not enabled yet, otherwise
         * just update the throttling group. */
2691
        if (!blk_get_public(blk)->throttle_state) {
2692
            blk_io_limits_enable(blk,
2693 2694 2695
                                 arg->has_group ? arg->group :
                                 arg->has_device ? arg->device :
                                 arg->id);
2696 2697
        } else if (arg->has_group) {
            blk_io_limits_update_group(blk, arg->group);
2698 2699
        }
        /* Set the new throttling configuration */
2700 2701
        blk_set_io_limits(blk, &cfg);
    } else if (blk_get_public(blk)->throttle_state) {
2702
        /* If all throttling settings are set to 0, disable I/O limits */
2703
        blk_io_limits_disable(blk);
Z
Zhi Yong Wu 已提交
2704
    }
2705

M
Max Reitz 已提交
2706
out:
2707
    aio_context_release(aio_context);
Z
Zhi Yong Wu 已提交
2708 2709
}

2710 2711
void qmp_block_dirty_bitmap_add(const char *node, const char *name,
                                bool has_granularity, uint32_t granularity,
2712
                                bool has_persistent, bool persistent,
2713 2714 2715
                                Error **errp)
{
    BlockDriverState *bs;
2716
    BdrvDirtyBitmap *bitmap;
2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731

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

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

    if (has_granularity) {
        if (granularity < 512 || !is_power_of_2(granularity)) {
            error_setg(errp, "Granularity must be power of 2 "
                             "and at least 512");
2732
            return;
2733 2734 2735 2736 2737 2738
        }
    } else {
        /* Default to cluster size, if available: */
        granularity = bdrv_get_default_bitmap_granularity(bs);
    }

2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752
    if (!has_persistent) {
        persistent = false;
    }

    if (persistent &&
        !bdrv_can_store_new_dirty_bitmap(bs, name, granularity, errp))
    {
        return;
    }

    bitmap = bdrv_create_dirty_bitmap(bs, granularity, name, errp);
    if (bitmap != NULL) {
        bdrv_dirty_bitmap_set_persistance(bitmap, persistent);
    }
2753 2754 2755 2756 2757 2758 2759 2760
}

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

2761
    bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2762 2763 2764 2765
    if (!bitmap || !bs) {
        return;
    }

J
John Snow 已提交
2766 2767 2768 2769
    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be removed",
                   name);
2770
        return;
J
John Snow 已提交
2771
    }
2772
    bdrv_dirty_bitmap_make_anon(bitmap);
2773 2774 2775
    bdrv_release_dirty_bitmap(bs, bitmap);
}

J
John Snow 已提交
2776 2777 2778 2779 2780 2781 2782 2783 2784 2785
/**
 * 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)
{
    BdrvDirtyBitmap *bitmap;
    BlockDriverState *bs;

2786
    bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
J
John Snow 已提交
2787 2788 2789 2790 2791 2792 2793 2794
    if (!bitmap || !bs) {
        return;
    }

    if (bdrv_dirty_bitmap_frozen(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently frozen and cannot be modified",
                   name);
2795
        return;
J
John Snow 已提交
2796 2797 2798 2799
    } else if (!bdrv_dirty_bitmap_enabled(bitmap)) {
        error_setg(errp,
                   "Bitmap '%s' is currently disabled and cannot be cleared",
                   name);
2800
        return;
2801 2802 2803
    } else if (bdrv_dirty_bitmap_readonly(bitmap)) {
        error_setg(errp, "Bitmap '%s' is readonly and cannot be cleared", name);
        return;
J
John Snow 已提交
2804 2805
    }

F
Fam Zheng 已提交
2806
    bdrv_clear_dirty_bitmap(bitmap, NULL);
J
John Snow 已提交
2807 2808
}

2809
void hmp_drive_del(Monitor *mon, const QDict *qdict)
2810 2811
{
    const char *id = qdict_get_str(qdict, "id");
2812
    BlockBackend *blk;
2813
    BlockDriverState *bs;
2814
    AioContext *aio_context;
2815
    Error *local_err = NULL;
2816

2817 2818
    bs = bdrv_find_node(id);
    if (bs) {
2819
        qmp_blockdev_del(id, &local_err);
2820 2821 2822 2823 2824 2825
        if (local_err) {
            error_report_err(local_err);
        }
        return;
    }

2826 2827
    blk = blk_by_name(id);
    if (!blk) {
2828
        error_report("Device '%s' not found", id);
2829
        return;
2830
    }
2831

2832
    if (!blk_legacy_dinfo(blk)) {
2833 2834
        error_report("Deleting device added with blockdev-add"
                     " is not supported");
2835
        return;
2836 2837
    }

M
Max Reitz 已提交
2838
    aio_context = blk_get_aio_context(blk);
2839 2840
    aio_context_acquire(aio_context);

M
Max Reitz 已提交
2841 2842 2843 2844 2845 2846 2847
    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;
        }
2848

2849
        blk_remove_bs(blk);
M
Max Reitz 已提交
2850
    }
2851

2852
    /* Make the BlockBackend and the attached BlockDriverState anonymous */
2853 2854
    monitor_remove_blk(blk);

2855 2856
    /* 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.
2857
     */
2858
    if (blk_get_attached_dev(blk)) {
2859
        /* Further I/O must not pause the guest */
2860 2861
        blk_set_on_error(blk, BLOCKDEV_ON_ERROR_REPORT,
                         BLOCKDEV_ON_ERROR_REPORT);
2862
    } else {
2863
        blk_unref(blk);
2864 2865
    }

2866
    aio_context_release(aio_context);
2867
}
2868

2869 2870 2871
void qmp_block_resize(bool has_device, const char *device,
                      bool has_node_name, const char *node_name,
                      int64_t size, Error **errp)
2872
{
2873
    Error *local_err = NULL;
2874
    BlockBackend *blk = NULL;
2875
    BlockDriverState *bs;
2876
    AioContext *aio_context;
2877
    int ret;
2878

2879 2880 2881
    bs = bdrv_lookup_bs(has_device ? device : NULL,
                        has_node_name ? node_name : NULL,
                        &local_err);
2882
    if (local_err) {
2883 2884 2885 2886
        error_propagate(errp, local_err);
        return;
    }

2887 2888 2889
    aio_context = bdrv_get_aio_context(bs);
    aio_context_acquire(aio_context);

2890
    if (!bdrv_is_first_non_filter(bs)) {
2891
        error_setg(errp, QERR_FEATURE_DISABLED, "resize");
2892
        goto out;
2893 2894 2895
    }

    if (size < 0) {
2896
        error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2897
        goto out;
2898 2899
    }

2900
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2901
        error_setg(errp, QERR_DEVICE_IN_USE, device);
2902
        goto out;
2903 2904
    }

K
Kevin Wolf 已提交
2905
    blk = blk_new(BLK_PERM_RESIZE, BLK_PERM_ALL);
2906 2907 2908 2909
    ret = blk_insert_bs(blk, bs, errp);
    if (ret < 0) {
        goto out;
    }
2910

2911
    bdrv_drained_begin(bs);
2912
    ret = blk_truncate(blk, size, errp);
2913
    bdrv_drained_end(bs);
2914 2915

out:
2916
    blk_unref(blk);
2917
    aio_context_release(aio_context);
2918
}
S
Stefan Hajnoczi 已提交
2919

2920
void qmp_block_stream(bool has_job_id, const char *job_id, const char *device,
2921
                      bool has_base, const char *base,
2922
                      bool has_base_node, const char *base_node,
2923 2924
                      bool has_backing_file, const char *backing_file,
                      bool has_speed, int64_t speed,
P
Paolo Bonzini 已提交
2925 2926
                      bool has_on_error, BlockdevOnError on_error,
                      Error **errp)
S
Stefan Hajnoczi 已提交
2927
{
2928
    BlockDriverState *bs, *iter;
2929
    BlockDriverState *base_bs = NULL;
2930
    AioContext *aio_context;
2931
    Error *local_err = NULL;
2932
    const char *base_name = NULL;
S
Stefan Hajnoczi 已提交
2933

P
Paolo Bonzini 已提交
2934 2935 2936 2937
    if (!has_on_error) {
        on_error = BLOCKDEV_ON_ERROR_REPORT;
    }

2938
    bs = bdrv_lookup_bs(device, device, errp);
2939
    if (!bs) {
S
Stefan Hajnoczi 已提交
2940 2941 2942
        return;
    }

2943
    aio_context = bdrv_get_aio_context(bs);
2944 2945
    aio_context_acquire(aio_context);

2946 2947 2948 2949 2950 2951
    if (has_base && has_base_node) {
        error_setg(errp, "'base' and 'base-node' cannot be specified "
                   "at the same time");
        goto out;
    }

2952
    if (has_base) {
2953 2954
        base_bs = bdrv_find_backing_image(bs, base);
        if (base_bs == NULL) {
2955
            error_setg(errp, QERR_BASE_NOT_FOUND, base);
2956
            goto out;
2957
        }
2958
        assert(bdrv_get_aio_context(base_bs) == aio_context);
2959
        base_name = base;
S
Stefan Hajnoczi 已提交
2960 2961
    }

2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975
    if (has_base_node) {
        base_bs = bdrv_lookup_bs(NULL, base_node, errp);
        if (!base_bs) {
            goto out;
        }
        if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
            error_setg(errp, "Node '%s' is not a backing image of '%s'",
                       base_node, device);
            goto out;
        }
        assert(bdrv_get_aio_context(base_bs) == aio_context);
        base_name = base_bs->filename;
    }

2976 2977 2978 2979 2980 2981 2982
    /* Check for op blockers in the whole chain between bs and base */
    for (iter = bs; iter && iter != base_bs; iter = backing_bs(iter)) {
        if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
            goto out;
        }
    }

2983 2984 2985 2986 2987
    /* 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");
2988
        goto out;
2989 2990 2991 2992 2993
    }

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

2994
    stream_start(has_job_id ? job_id : NULL, bs, base_bs, base_name,
2995
                 has_speed ? speed : 0, on_error, &local_err);
2996
    if (local_err) {
2997
        error_propagate(errp, local_err);
2998
        goto out;
S
Stefan Hajnoczi 已提交
2999 3000 3001
    }

    trace_qmp_block_stream(bs, bs->job);
3002 3003 3004

out:
    aio_context_release(aio_context);
S
Stefan Hajnoczi 已提交
3005
}
3006

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

3025 3026 3027
    if (!has_speed) {
        speed = 0;
    }
3028 3029 3030
    if (!has_filter_node_name) {
        filter_node_name = NULL;
    }
3031

3032 3033 3034 3035 3036
    /* 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. */
3037 3038 3039 3040 3041 3042 3043 3044 3045 3046
    bs = qmp_get_root_bs(device, &local_err);
    if (!bs) {
        bs = bdrv_lookup_bs(device, device, NULL);
        if (!bs) {
            error_free(local_err);
            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                      "Device '%s' not found", device);
        } else {
            error_propagate(errp, local_err);
        }
3047
        return;
3048 3049
    }

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

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

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

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

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

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

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

3086 3087 3088 3089
    for (iter = top_bs; iter != backing_bs(base_bs); iter = backing_bs(iter)) {
        if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
            goto out;
        }
3090 3091
    }

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

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

out:
    aio_context_release(aio_context);
3123 3124
}

3125 3126
static BlockJob *do_drive_backup(DriveBackup *backup, BlockJobTxn *txn,
                                 Error **errp)
3127 3128 3129
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
3130
    BlockDriverState *source = NULL;
3131
    BlockJob *job = NULL;
3132
    BdrvDirtyBitmap *bmap = NULL;
3133
    AioContext *aio_context;
3134
    QDict *options = NULL;
3135 3136 3137
    Error *local_err = NULL;
    int flags;
    int64_t size;
3138
    bool set_backing_hd = false;
3139

P
Pavel Butsykin 已提交
3140 3141
    if (!backup->has_speed) {
        backup->speed = 0;
3142
    }
P
Pavel Butsykin 已提交
3143 3144
    if (!backup->has_on_source_error) {
        backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
3145
    }
P
Pavel Butsykin 已提交
3146 3147
    if (!backup->has_on_target_error) {
        backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
3148
    }
P
Pavel Butsykin 已提交
3149 3150 3151 3152 3153
    if (!backup->has_mode) {
        backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
    }
    if (!backup->has_job_id) {
        backup->job_id = NULL;
3154
    }
3155 3156 3157
    if (!backup->has_compress) {
        backup->compress = false;
    }
3158

P
Pavel Butsykin 已提交
3159
    bs = qmp_get_root_bs(backup->device, errp);
3160
    if (!bs) {
3161
        return NULL;
3162 3163
    }

3164
    aio_context = bdrv_get_aio_context(bs);
3165 3166
    aio_context_acquire(aio_context);

P
Pavel Butsykin 已提交
3167 3168 3169
    if (!backup->has_format) {
        backup->format = backup->mode == NEW_IMAGE_MODE_EXISTING ?
                         NULL : (char*) bs->drv->format_name;
3170 3171
    }

F
Fam Zheng 已提交
3172
    /* Early check to avoid creating target */
3173
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
3174
        goto out;
3175 3176
    }

K
Kevin Wolf 已提交
3177
    flags = bs->open_flags | BDRV_O_RDWR;
3178

3179 3180
    /* See if we have a backing HD we can use to create our new image
     * on top of. */
P
Pavel Butsykin 已提交
3181
    if (backup->sync == MIRROR_SYNC_MODE_TOP) {
3182
        source = backing_bs(bs);
3183
        if (!source) {
P
Pavel Butsykin 已提交
3184
            backup->sync = MIRROR_SYNC_MODE_FULL;
3185 3186
        }
    }
P
Pavel Butsykin 已提交
3187
    if (backup->sync == MIRROR_SYNC_MODE_NONE) {
3188
        source = bs;
3189 3190
        flags |= BDRV_O_NO_BACKING;
        set_backing_hd = true;
3191 3192
    }

3193 3194 3195
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3196
        goto out;
3197 3198
    }

P
Pavel Butsykin 已提交
3199 3200
    if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
        assert(backup->format);
3201
        if (source) {
P
Pavel Butsykin 已提交
3202
            bdrv_img_create(backup->target, backup->format, source->filename,
3203
                            source->drv->format_name, NULL,
3204
                            size, flags, false, &local_err);
3205
        } else {
P
Pavel Butsykin 已提交
3206
            bdrv_img_create(backup->target, backup->format, NULL, NULL, NULL,
3207
                            size, flags, false, &local_err);
3208
        }
3209 3210
    }

3211
    if (local_err) {
3212
        error_propagate(errp, local_err);
3213
        goto out;
3214 3215
    }

P
Pavel Butsykin 已提交
3216
    if (backup->format) {
3217 3218 3219
        if (!options) {
            options = qdict_new();
        }
3220
        qdict_put_str(options, "driver", backup->format);
3221 3222
    }

P
Pavel Butsykin 已提交
3223
    target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
M
Max Reitz 已提交
3224
    if (!target_bs) {
3225
        goto out;
3226 3227
    }

3228 3229
    bdrv_set_aio_context(target_bs, aio_context);

3230 3231 3232 3233 3234 3235 3236 3237
    if (set_backing_hd) {
        bdrv_set_backing_hd(target_bs, source, &local_err);
        if (local_err) {
            bdrv_unref(target_bs);
            goto out;
        }
    }

P
Pavel Butsykin 已提交
3238 3239
    if (backup->has_bitmap) {
        bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
3240
        if (!bmap) {
P
Pavel Butsykin 已提交
3241
            error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
3242
            bdrv_unref(target_bs);
3243 3244 3245 3246
            goto out;
        }
    }

3247 3248 3249 3250
    job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
                            backup->sync, bmap, backup->compress,
                            backup->on_source_error, backup->on_target_error,
                            BLOCK_JOB_DEFAULT, NULL, NULL, txn, &local_err);
K
Kevin Wolf 已提交
3251
    bdrv_unref(target_bs);
3252 3253
    if (local_err != NULL) {
        error_propagate(errp, local_err);
3254
        goto out;
3255
    }
3256 3257 3258

out:
    aio_context_release(aio_context);
3259
    return job;
3260 3261
}

P
Pavel Butsykin 已提交
3262
void qmp_drive_backup(DriveBackup *arg, Error **errp)
3263
{
3264 3265 3266 3267 3268 3269

    BlockJob *job;
    job = do_drive_backup(arg, NULL, errp);
    if (job) {
        block_job_start(job);
    }
3270 3271
}

3272 3273
BlockDeviceInfoList *qmp_query_named_block_nodes(Error **errp)
{
3274
    return bdrv_named_nodes_list(errp);
3275 3276
}

3277 3278
BlockJob *do_blockdev_backup(BlockdevBackup *backup, BlockJobTxn *txn,
                             Error **errp)
F
Fam Zheng 已提交
3279 3280 3281 3282 3283
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
    Error *local_err = NULL;
    AioContext *aio_context;
3284
    BlockJob *job = NULL;
F
Fam Zheng 已提交
3285

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

P
Pavel Butsykin 已提交
3302
    bs = qmp_get_root_bs(backup->device, errp);
3303
    if (!bs) {
3304
        return NULL;
F
Fam Zheng 已提交
3305 3306
    }

3307
    aio_context = bdrv_get_aio_context(bs);
F
Fam Zheng 已提交
3308 3309
    aio_context_acquire(aio_context);

P
Pavel Butsykin 已提交
3310
    target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
3311
    if (!target_bs) {
M
Max Reitz 已提交
3312 3313
        goto out;
    }
F
Fam Zheng 已提交
3314

3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
    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;
        }
    }
3326 3327 3328 3329
    job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
                            backup->sync, NULL, backup->compress,
                            backup->on_source_error, backup->on_target_error,
                            BLOCK_JOB_DEFAULT, NULL, NULL, txn, &local_err);
F
Fam Zheng 已提交
3330 3331 3332 3333 3334
    if (local_err != NULL) {
        error_propagate(errp, local_err);
    }
out:
    aio_context_release(aio_context);
3335
    return job;
F
Fam Zheng 已提交
3336 3337
}

P
Pavel Butsykin 已提交
3338 3339
void qmp_blockdev_backup(BlockdevBackup *arg, Error **errp)
{
3340 3341 3342 3343 3344
    BlockJob *job;
    job = do_blockdev_backup(arg, NULL, errp);
    if (job) {
        block_job_start(job);
    }
3345 3346
}

3347 3348 3349
/* Parameter check and block job starting for drive mirroring.
 * Caller should hold @device and @target's aio context (must be the same).
 **/
3350
static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
3351 3352 3353
                                   BlockDriverState *target,
                                   bool has_replaces, const char *replaces,
                                   enum MirrorSyncMode sync,
M
Max Reitz 已提交
3354
                                   BlockMirrorBackingMode backing_mode,
3355 3356 3357 3358 3359 3360 3361 3362
                                   bool has_speed, int64_t speed,
                                   bool has_granularity, uint32_t granularity,
                                   bool has_buf_size, int64_t buf_size,
                                   bool has_on_source_error,
                                   BlockdevOnError on_source_error,
                                   bool has_on_target_error,
                                   BlockdevOnError on_target_error,
                                   bool has_unmap, bool unmap,
3363 3364
                                   bool has_filter_node_name,
                                   const char *filter_node_name,
3365
                                   Error **errp)
P
Paolo Bonzini 已提交
3366 3367 3368 3369 3370
{

    if (!has_speed) {
        speed = 0;
    }
3371 3372 3373 3374 3375 3376
    if (!has_on_source_error) {
        on_source_error = BLOCKDEV_ON_ERROR_REPORT;
    }
    if (!has_on_target_error) {
        on_target_error = BLOCKDEV_ON_ERROR_REPORT;
    }
3377 3378 3379
    if (!has_granularity) {
        granularity = 0;
    }
3380
    if (!has_buf_size) {
W
Wen Congyang 已提交
3381
        buf_size = 0;
3382
    }
3383 3384 3385
    if (!has_unmap) {
        unmap = true;
    }
3386 3387 3388
    if (!has_filter_node_name) {
        filter_node_name = NULL;
    }
3389

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

3401 3402 3403
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
        return;
    }
F
Fam Zheng 已提交
3404 3405 3406
    if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
        return;
    }
3407 3408 3409 3410 3411 3412 3413 3414

    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
     */
3415
    mirror_start(job_id, bs, target,
3416
                 has_replaces ? replaces : NULL,
M
Max Reitz 已提交
3417
                 speed, granularity, buf_size, sync, backing_mode,
3418 3419
                 on_source_error, on_target_error, unmap, filter_node_name,
                 errp);
3420 3421
}

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

3434 3435
    bs = qmp_get_root_bs(arg->device, errp);
    if (!bs) {
P
Paolo Bonzini 已提交
3436 3437 3438
        return;
    }

3439
    aio_context = bdrv_get_aio_context(bs);
3440 3441
    aio_context_acquire(aio_context);

E
Eric Blake 已提交
3442 3443
    if (!arg->has_mode) {
        arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3444
    }
P
Paolo Bonzini 已提交
3445

E
Eric Blake 已提交
3446 3447 3448
    if (!arg->has_format) {
        format = (arg->mode == NEW_IMAGE_MODE_EXISTING
                  ? NULL : bs->drv->format_name);
P
Paolo Bonzini 已提交
3449 3450
    }

K
Kevin Wolf 已提交
3451
    flags = bs->open_flags | BDRV_O_RDWR;
3452
    source = backing_bs(bs);
E
Eric Blake 已提交
3453 3454
    if (!source && arg->sync == MIRROR_SYNC_MODE_TOP) {
        arg->sync = MIRROR_SYNC_MODE_FULL;
P
Paolo Bonzini 已提交
3455
    }
E
Eric Blake 已提交
3456
    if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3457 3458
        source = bs;
    }
P
Paolo Bonzini 已提交
3459

3460 3461 3462
    size = bdrv_getlength(bs);
    if (size < 0) {
        error_setg_errno(errp, -size, "bdrv_getlength failed");
3463
        goto out;
3464 3465
    }

E
Eric Blake 已提交
3466
    if (arg->has_replaces) {
3467
        BlockDriverState *to_replace_bs;
3468 3469
        AioContext *replace_aio_context;
        int64_t replace_size;
3470

E
Eric Blake 已提交
3471
        if (!arg->has_node_name) {
3472 3473
            error_setg(errp, "a node-name must be provided when replacing a"
                             " named node of the graph");
3474
            goto out;
3475 3476
        }

E
Eric Blake 已提交
3477
        to_replace_bs = check_to_replace_node(bs, arg->replaces, &local_err);
3478 3479 3480

        if (!to_replace_bs) {
            error_propagate(errp, local_err);
3481
            goto out;
3482 3483
        }

3484 3485 3486 3487 3488 3489
        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) {
3490 3491
            error_setg(errp, "cannot replace image with a mirror image of "
                             "different size");
3492
            goto out;
3493 3494 3495
        }
    }

E
Eric Blake 已提交
3496
    if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
M
Max Reitz 已提交
3497 3498 3499 3500 3501
        backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
    } else {
        backing_mode = MIRROR_OPEN_BACKING_CHAIN;
    }

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

3525
    if (local_err) {
3526
        error_propagate(errp, local_err);
3527
        goto out;
P
Paolo Bonzini 已提交
3528 3529
    }

3530
    options = qdict_new();
E
Eric Blake 已提交
3531
    if (arg->has_node_name) {
3532
        qdict_put_str(options, "node-name", arg->node_name);
3533
    }
3534
    if (format) {
3535
        qdict_put_str(options, "driver", format);
3536
    }
3537

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

3547 3548
    bdrv_set_aio_context(target_bs, aio_context);

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

3565 3566
void qmp_blockdev_mirror(bool has_job_id, const char *job_id,
                         const char *device, const char *target,
F
Fam Zheng 已提交
3567 3568 3569 3570 3571 3572 3573 3574 3575
                         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,
3576 3577
                         bool has_filter_node_name,
                         const char *filter_node_name,
F
Fam Zheng 已提交
3578 3579 3580 3581 3582
                         Error **errp)
{
    BlockDriverState *bs;
    BlockDriverState *target_bs;
    AioContext *aio_context;
M
Max Reitz 已提交
3583
    BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
F
Fam Zheng 已提交
3584 3585
    Error *local_err = NULL;

3586
    bs = qmp_get_root_bs(device, errp);
F
Fam Zheng 已提交
3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600
    if (!bs) {
        return;
    }

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

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

    bdrv_set_aio_context(target_bs, aio_context);

3601
    blockdev_mirror_common(has_job_id ? job_id : NULL, bs, target_bs,
M
Max Reitz 已提交
3602
                           has_replaces, replaces, sync, backing_mode,
F
Fam Zheng 已提交
3603 3604 3605 3606 3607 3608
                           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,
3609
                           has_filter_node_name, filter_node_name,
F
Fam Zheng 已提交
3610
                           &local_err);
3611
    error_propagate(errp, local_err);
F
Fam Zheng 已提交
3612 3613 3614 3615

    aio_context_release(aio_context);
}

3616 3617
/* Get a block job using its ID and acquire its AioContext */
static BlockJob *find_block_job(const char *id, AioContext **aio_context,
3618
                                Error **errp)
3619
{
3620
    BlockJob *job;
3621

3622
    assert(id != NULL);
M
Max Reitz 已提交
3623

3624
    *aio_context = NULL;
3625

3626
    job = block_job_get(id);
M
Max Reitz 已提交
3627

3628 3629 3630 3631
    if (!job) {
        error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
                  "Block job '%s' not found", id);
        return NULL;
3632
    }
3633

3634 3635
    *aio_context = blk_get_aio_context(job->blk);
    aio_context_acquire(*aio_context);
3636

3637
    return job;
3638 3639
}

3640
void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3641
{
3642
    AioContext *aio_context;
3643
    BlockJob *job = find_block_job(device, &aio_context, errp);
3644 3645 3646 3647 3648

    if (!job) {
        return;
    }

3649
    block_job_set_speed(job, speed, errp);
3650
    aio_context_release(aio_context);
3651
}
3652

3653 3654
void qmp_block_job_cancel(const char *device,
                          bool has_force, bool force, Error **errp)
3655
{
3656
    AioContext *aio_context;
3657
    BlockJob *job = find_block_job(device, &aio_context, errp);
3658

3659 3660 3661
    if (!job) {
        return;
    }
3662 3663 3664 3665 3666

    if (!has_force) {
        force = false;
    }

3667
    if (block_job_user_paused(job) && !force) {
3668 3669
        error_setg(errp, "The block job for device '%s' is currently paused",
                   device);
3670
        goto out;
3671
    }
3672 3673 3674

    trace_qmp_block_job_cancel(job);
    block_job_cancel(job);
3675 3676
out:
    aio_context_release(aio_context);
3677
}
S
Stefan Hajnoczi 已提交
3678

3679 3680
void qmp_block_job_pause(const char *device, Error **errp)
{
3681
    AioContext *aio_context;
3682
    BlockJob *job = find_block_job(device, &aio_context, errp);
3683

3684
    if (!job || block_job_user_paused(job)) {
3685 3686 3687 3688
        return;
    }

    trace_qmp_block_job_pause(job);
3689
    block_job_user_pause(job);
3690
    aio_context_release(aio_context);
3691 3692 3693 3694
}

void qmp_block_job_resume(const char *device, Error **errp)
{
3695
    AioContext *aio_context;
3696
    BlockJob *job = find_block_job(device, &aio_context, errp);
3697

3698
    if (!job || !block_job_user_paused(job)) {
3699 3700 3701 3702
        return;
    }

    trace_qmp_block_job_resume(job);
3703
    block_job_user_resume(job);
3704
    aio_context_release(aio_context);
3705 3706
}

P
Paolo Bonzini 已提交
3707 3708
void qmp_block_job_complete(const char *device, Error **errp)
{
3709
    AioContext *aio_context;
3710
    BlockJob *job = find_block_job(device, &aio_context, errp);
P
Paolo Bonzini 已提交
3711 3712 3713 3714 3715 3716 3717

    if (!job) {
        return;
    }

    trace_qmp_block_job_complete(job);
    block_job_complete(job, errp);
3718
    aio_context_release(aio_context);
P
Paolo Bonzini 已提交
3719 3720
}

3721 3722 3723 3724 3725 3726
void qmp_change_backing_file(const char *device,
                             const char *image_node_name,
                             const char *backing_file,
                             Error **errp)
{
    BlockDriverState *bs = NULL;
3727
    AioContext *aio_context;
3728 3729 3730 3731 3732 3733
    BlockDriverState *image_bs = NULL;
    Error *local_err = NULL;
    bool ro;
    int open_flags;
    int ret;

3734 3735
    bs = qmp_get_root_bs(device, errp);
    if (!bs) {
3736 3737 3738
        return;
    }

3739
    aio_context = bdrv_get_aio_context(bs);
3740 3741
    aio_context_acquire(aio_context);

3742 3743 3744
    image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
3745
        goto out;
3746 3747 3748 3749
    }

    if (!image_bs) {
        error_setg(errp, "image file not found");
3750
        goto out;
3751 3752 3753 3754 3755
    }

    if (bdrv_find_base(image_bs) == image_bs) {
        error_setg(errp, "not allowing backing file change on an image "
                         "without a backing file");
3756
        goto out;
3757 3758 3759 3760 3761
    }

    /* 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)) {
3762
        goto out;
3763 3764 3765 3766 3767 3768
    }

    /* final sanity check */
    if (!bdrv_chain_contains(bs, image_bs)) {
        error_setg(errp, "'%s' and image file are not in the same chain",
                   device);
3769
        goto out;
3770 3771 3772 3773 3774 3775 3776 3777 3778 3779
    }

    /* 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);
3780
            goto out;
3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
        }
    }

    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);
3796
        error_propagate(errp, local_err);
3797
    }
3798 3799 3800

out:
    aio_context_release(aio_context);
3801 3802
}

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

3842
    visit_type_BlockdevOptions(v, NULL, &options, &local_err);
3843
    if (local_err) {
K
Kevin Wolf 已提交
3844 3845 3846 3847
        error_propagate(errp, local_err);
        goto fail;
    }

3848
    visit_complete(v, &obj);
K
Kevin Wolf 已提交
3849 3850 3851 3852
    qdict = qobject_to_qdict(obj);

    qdict_flatten(qdict);

3853 3854 3855 3856
    if (!qdict_get_try_str(qdict, "node-name")) {
        error_setg(errp, "'node-name' must be specified for the root node");
        goto fail;
    }
3857

3858 3859 3860
    bs = bds_tree_init(qdict, errp);
    if (!bs) {
        goto fail;
K
Kevin Wolf 已提交
3861 3862
    }

3863 3864
    QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);

K
Kevin Wolf 已提交
3865
fail:
3866
    visit_free(v);
K
Kevin Wolf 已提交
3867 3868
}

3869
void qmp_blockdev_del(const char *node_name, Error **errp)
3870 3871 3872 3873
{
    AioContext *aio_context;
    BlockDriverState *bs;

3874 3875 3876
    bs = bdrv_find_node(node_name);
    if (!bs) {
        error_setg(errp, "Cannot find node %s", node_name);
3877 3878
        return;
    }
3879 3880 3881
    if (bdrv_has_blk(bs)) {
        error_setg(errp, "Node %s is in use", node_name);
        return;
3882
    }
3883
    aio_context = bdrv_get_aio_context(bs);
3884 3885
    aio_context_acquire(aio_context);

3886 3887 3888
    if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
        goto out;
    }
3889

3890 3891 3892 3893
    if (!bs->monitor_list.tqe_prev) {
        error_setg(errp, "Node %s is not owned by the monitor",
                   bs->node_name);
        goto out;
3894 3895
    }

3896 3897 3898 3899
    if (bs->refcnt > 1) {
        error_setg(errp, "Block device %s is in use",
                   bdrv_get_device_or_node_name(bs));
        goto out;
3900 3901
    }

3902 3903 3904
    QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
    bdrv_unref(bs);

3905 3906 3907 3908
out:
    aio_context_release(aio_context);
}

3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963
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);
    }
}

3964
BlockJobInfoList *qmp_query_block_jobs(Error **errp)
S
Stefan Hajnoczi 已提交
3965
{
3966
    BlockJobInfoList *head = NULL, **p_next = &head;
3967
    BlockJob *job;
S
Stefan Hajnoczi 已提交
3968

3969
    for (job = block_job_next(NULL); job; job = block_job_next(job)) {
3970 3971
        BlockJobInfoList *elem;
        AioContext *aio_context;
3972

3973 3974 3975 3976 3977
        if (block_job_is_internal(job)) {
            continue;
        }
        elem = g_new0(BlockJobInfoList, 1);
        aio_context = blk_get_aio_context(job->blk);
3978
        aio_context_acquire(aio_context);
3979
        elem->value = block_job_query(job, errp);
3980
        aio_context_release(aio_context);
3981 3982 3983 3984 3985
        if (!elem->value) {
            g_free(elem);
            qapi_free_BlockJobInfoList(head);
            return NULL;
        }
3986 3987
        *p_next = elem;
        p_next = &elem->next;
S
Stefan Hajnoczi 已提交
3988 3989
    }

3990
    return head;
S
Stefan Hajnoczi 已提交
3991
}
3992

3993
QemuOptsList qemu_common_drive_opts = {
3994
    .name = "drive",
3995
    .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3996 3997 3998 3999 4000 4001 4002 4003 4004
    .desc = {
        {
            .name = "snapshot",
            .type = QEMU_OPT_BOOL,
            .help = "enable/disable snapshot mode",
        },{
            .name = "aio",
            .type = QEMU_OPT_STRING,
            .help = "host AIO implementation (threads, native)",
4005 4006 4007 4008
        },{
            .name = BDRV_OPT_CACHE_WB,
            .type = QEMU_OPT_BOOL,
            .help = "Enable writeback mode",
4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
        },{
            .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",
        },{
4022
            .name = BDRV_OPT_READ_ONLY,
4023 4024
            .type = QEMU_OPT_BOOL,
            .help = "open drive file as read-only",
4025 4026 4027 4028 4029
        },

        THROTTLE_OPTS,

        {
4030 4031 4032
            .name = "throttling.group",
            .type = QEMU_OPT_STRING,
            .help = "name of the block throttling group",
4033 4034 4035 4036
        },{
            .name = "copy-on-read",
            .type = QEMU_OPT_BOOL,
            .help = "copy read data from backing file into image file",
4037 4038 4039 4040
        },{
            .name = "detect-zeroes",
            .type = QEMU_OPT_STRING,
            .help = "try to optimize zero writes (off, on, unmap)",
4041 4042 4043 4044 4045 4046 4047 4048 4049 4050
        },{
            .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",
4051 4052 4053 4054
        },
        { /* end of list */ }
    },
};
4055 4056 4057 4058 4059

QemuOptsList qemu_drive_opts = {
    .name = "drive",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
    .desc = {
4060 4061 4062 4063
        /*
         * no elements => accept any params
         * validation will happen later
         */
4064 4065 4066
        { /* end of list */ }
    },
};