block-backend.c 44.6 KB
Newer Older
M
Markus Armbruster 已提交
1 2 3
/*
 * QEMU Block backends
 *
4
 * Copyright (C) 2014-2016 Red Hat, Inc.
M
Markus Armbruster 已提交
5 6 7 8 9 10 11 12
 *
 * Authors:
 *  Markus Armbruster <armbru@redhat.com>,
 *
 * This work is licensed under the terms of the GNU LGPL, version 2.1
 * or later.  See the COPYING.LIB file in the top-level directory.
 */

P
Peter Maydell 已提交
13
#include "qemu/osdep.h"
M
Markus Armbruster 已提交
14 15
#include "sysemu/block-backend.h"
#include "block/block_int.h"
16
#include "block/blockjob.h"
M
Max Reitz 已提交
17
#include "block/throttle-groups.h"
18
#include "sysemu/blockdev.h"
19
#include "sysemu/sysemu.h"
20
#include "qapi-event.h"
21
#include "qemu/id.h"
22
#include "trace.h"
23 24 25

/* Number of coroutines to reserve per attached device model */
#define COROUTINE_POOL_RESERVATION 64
M
Markus Armbruster 已提交
26

27 28
#define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */

29 30
static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb);

M
Markus Armbruster 已提交
31 32 33
struct BlockBackend {
    char *name;
    int refcnt;
34
    BdrvChild *root;
35
    DriveInfo *legacy_dinfo;    /* null unless created by drive_new() */
36
    QTAILQ_ENTRY(BlockBackend) link;         /* for block_backends */
M
Max Reitz 已提交
37
    QTAILQ_ENTRY(BlockBackend) monitor_link; /* for monitor_block_backends */
K
Kevin Wolf 已提交
38
    BlockBackendPublic public;
39 40

    void *dev;                  /* attached device model, if any */
41
    bool legacy_dev;            /* true if dev is not a DeviceState */
42 43 44
    /* TODO change to DeviceState when all users are qdevified */
    const BlockDevOps *dev_ops;
    void *dev_opaque;
45 46 47

    /* the block size for which the guest device expects atomicity */
    int guest_block_size;
48

M
Max Reitz 已提交
49 50 51 52
    /* If the BDS tree is removed, some of its options are stored here (which
     * can be used to restore those options in the new BDS on insert) */
    BlockBackendRootState root_state;

53 54
    bool enable_write_cache;

55 56
    /* I/O stats (display with "info blockstats"). */
    BlockAcctStats stats;
57 58 59 60

    BlockdevOnError on_read_error, on_write_error;
    bool iostatus_enabled;
    BlockDeviceIoStatus iostatus;
61

62 63
    bool allow_write_beyond_eof;

64
    NotifierList remove_bs_notifiers, insert_bs_notifiers;
M
Markus Armbruster 已提交
65 66
};

M
Max Reitz 已提交
67 68
typedef struct BlockBackendAIOCB {
    BlockAIOCB common;
69
    BlockBackend *blk;
M
Max Reitz 已提交
70 71 72 73
    int ret;
} BlockBackendAIOCB;

static const AIOCBInfo block_backend_aiocb_info = {
74
    .get_aio_context = blk_aiocb_get_aio_context,
M
Max Reitz 已提交
75 76 77
    .aiocb_size = sizeof(BlockBackendAIOCB),
};

78
static void drive_info_del(DriveInfo *dinfo);
K
Kevin Wolf 已提交
79
static BlockBackend *bdrv_first_blk(BlockDriverState *bs);
80

81 82 83 84
/* All BlockBackends */
static QTAILQ_HEAD(, BlockBackend) block_backends =
    QTAILQ_HEAD_INITIALIZER(block_backends);

M
Max Reitz 已提交
85 86 87 88
/* All BlockBackends referenced by the monitor and which are iterated through by
 * blk_next() */
static QTAILQ_HEAD(, BlockBackend) monitor_block_backends =
    QTAILQ_HEAD_INITIALIZER(monitor_block_backends);
M
Markus Armbruster 已提交
89

90 91 92 93 94 95
static void blk_root_inherit_options(int *child_flags, QDict *child_options,
                                     int parent_flags, QDict *parent_options)
{
    /* We're not supposed to call this function for root nodes */
    abort();
}
96 97
static void blk_root_drained_begin(BdrvChild *child);
static void blk_root_drained_end(BdrvChild *child);
98

99 100 101
static void blk_root_change_media(BdrvChild *child, bool load);
static void blk_root_resize(BdrvChild *child);

102 103 104 105 106
static const char *blk_root_get_name(BdrvChild *child)
{
    return blk_name(child->opaque);
}

107
static const BdrvChildRole child_root = {
108 109
    .inherit_options    = blk_root_inherit_options,

110 111
    .change_media       = blk_root_change_media,
    .resize             = blk_root_resize,
112
    .get_name           = blk_root_get_name,
113

114 115
    .drained_begin      = blk_root_drained_begin,
    .drained_end        = blk_root_drained_end,
116 117
};

M
Markus Armbruster 已提交
118
/*
119
 * Create a new BlockBackend with a reference count of one.
M
Markus Armbruster 已提交
120 121 122
 * Store an error through @errp on failure, unless it's null.
 * Return the new BlockBackend on success, null on failure.
 */
123
BlockBackend *blk_new(void)
M
Markus Armbruster 已提交
124 125 126 127 128
{
    BlockBackend *blk;

    blk = g_new0(BlockBackend, 1);
    blk->refcnt = 1;
129 130
    blk_set_enable_write_cache(blk, true);

131 132 133
    qemu_co_queue_init(&blk->public.throttled_reqs[0]);
    qemu_co_queue_init(&blk->public.throttled_reqs[1]);

134 135
    notifier_list_init(&blk->remove_bs_notifiers);
    notifier_list_init(&blk->insert_bs_notifiers);
136

137
    QTAILQ_INSERT_TAIL(&block_backends, blk, link);
M
Markus Armbruster 已提交
138 139 140
    return blk;
}

141
/*
M
Max Reitz 已提交
142
 * Creates a new BlockBackend, opens a new BlockDriverState, and connects both.
M
Max Reitz 已提交
143 144 145 146 147 148 149 150 151 152
 *
 * Just as with bdrv_open(), after having called this function the reference to
 * @options belongs to the block layer (even on failure).
 *
 * TODO: Remove @filename and @flags; it should be possible to specify a whole
 * BDS tree just by specifying the @options QDict (or @reference,
 * alternatively). At the time of adding this function, this is not possible,
 * though, so callers of this function have to be able to specify @filename and
 * @flags.
 */
153 154
BlockBackend *blk_new_open(const char *filename, const char *reference,
                           QDict *options, int flags, Error **errp)
M
Max Reitz 已提交
155 156
{
    BlockBackend *blk;
M
Max Reitz 已提交
157
    BlockDriverState *bs;
M
Max Reitz 已提交
158

159
    blk = blk_new();
M
Max Reitz 已提交
160 161
    bs = bdrv_open(filename, reference, options, flags, errp);
    if (!bs) {
M
Max Reitz 已提交
162 163 164 165
        blk_unref(blk);
        return NULL;
    }

166
    blk->root = bdrv_root_attach_child(bs, "root", &child_root, blk);
167

M
Max Reitz 已提交
168 169 170
    return blk;
}

M
Markus Armbruster 已提交
171 172 173
static void blk_delete(BlockBackend *blk)
{
    assert(!blk->refcnt);
174
    assert(!blk->name);
175
    assert(!blk->dev);
176
    if (blk->root) {
177
        blk_remove_bs(blk);
178
    }
179 180
    assert(QLIST_EMPTY(&blk->remove_bs_notifiers.notifiers));
    assert(QLIST_EMPTY(&blk->insert_bs_notifiers.notifiers));
181
    QTAILQ_REMOVE(&block_backends, blk, link);
182
    drive_info_del(blk->legacy_dinfo);
183
    block_acct_cleanup(&blk->stats);
M
Markus Armbruster 已提交
184 185 186
    g_free(blk);
}

187 188 189 190 191 192 193 194 195 196
static void drive_info_del(DriveInfo *dinfo)
{
    if (!dinfo) {
        return;
    }
    qemu_opts_del(dinfo->opts);
    g_free(dinfo->serial);
    g_free(dinfo);
}

A
Alberto Garcia 已提交
197 198 199 200 201
int blk_get_refcnt(BlockBackend *blk)
{
    return blk ? blk->refcnt : 0;
}

M
Markus Armbruster 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
/*
 * Increment @blk's reference count.
 * @blk must not be null.
 */
void blk_ref(BlockBackend *blk)
{
    blk->refcnt++;
}

/*
 * Decrement @blk's reference count.
 * If this drops it to zero, destroy @blk.
 * For convenience, do nothing if @blk is null.
 */
void blk_unref(BlockBackend *blk)
{
    if (blk) {
        assert(blk->refcnt > 0);
        if (!--blk->refcnt) {
            blk_delete(blk);
        }
    }
}

226 227 228 229 230 231 232 233 234 235
/*
 * Behaves similarly to blk_next() but iterates over all BlockBackends, even the
 * ones which are hidden (i.e. are not referenced by the monitor).
 */
static BlockBackend *blk_all_next(BlockBackend *blk)
{
    return blk ? QTAILQ_NEXT(blk, link)
               : QTAILQ_FIRST(&block_backends);
}

M
Max Reitz 已提交
236 237
void blk_remove_all_bs(void)
{
238
    BlockBackend *blk = NULL;
M
Max Reitz 已提交
239

240
    while ((blk = blk_all_next(blk)) != NULL) {
M
Max Reitz 已提交
241 242 243
        AioContext *ctx = blk_get_aio_context(blk);

        aio_context_acquire(ctx);
244
        if (blk->root) {
M
Max Reitz 已提交
245 246 247 248 249 250
            blk_remove_bs(blk);
        }
        aio_context_release(ctx);
    }
}

M
Markus Armbruster 已提交
251
/*
M
Max Reitz 已提交
252
 * Return the monitor-owned BlockBackend after @blk.
M
Markus Armbruster 已提交
253 254 255 256 257 258 259 260 261 262
 * If @blk is null, return the first one.
 * Else, return @blk's next sibling, which may be null.
 *
 * To iterate over all BlockBackends, do
 * for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 *     ...
 * }
 */
BlockBackend *blk_next(BlockBackend *blk)
{
M
Max Reitz 已提交
263 264
    return blk ? QTAILQ_NEXT(blk, monitor_link)
               : QTAILQ_FIRST(&monitor_block_backends);
M
Markus Armbruster 已提交
265 266
}

K
Kevin Wolf 已提交
267 268
/* Iterates over all top-level BlockDriverStates, i.e. BDSs that are owned by
 * the monitor or attached to a BlockBackend */
K
Kevin Wolf 已提交
269
BlockDriverState *bdrv_next(BdrvNextIterator *it)
K
Kevin Wolf 已提交
270
{
K
Kevin Wolf 已提交
271
    BlockDriverState *bs;
M
Max Reitz 已提交
272

K
Kevin Wolf 已提交
273 274 275 276 277 278
    /* First, return all root nodes of BlockBackends. In order to avoid
     * returning a BDS twice when multiple BBs refer to it, we only return it
     * if the BB is the first one in the parent list of the BDS. */
    if (it->phase == BDRV_NEXT_BACKEND_ROOTS) {
        do {
            it->blk = blk_all_next(it->blk);
K
Kevin Wolf 已提交
279 280
            bs = it->blk ? blk_bs(it->blk) : NULL;
        } while (it->blk && (bs == NULL || bdrv_first_blk(bs) != it->blk));
K
Kevin Wolf 已提交
281

K
Kevin Wolf 已提交
282 283
        if (bs) {
            return bs;
K
Kevin Wolf 已提交
284 285 286 287 288 289 290
        }
        it->phase = BDRV_NEXT_MONITOR_OWNED;
    }

    /* Then return the monitor-owned BDSes without a BB attached. Ignore all
     * BDSes that are attached to a BlockBackend here; they have been handled
     * by the above block already */
M
Max Reitz 已提交
291
    do {
K
Kevin Wolf 已提交
292
        it->bs = bdrv_next_monitor_owned(it->bs);
K
Kevin Wolf 已提交
293 294 295 296 297 298 299 300 301 302 303
        bs = it->bs;
    } while (bs && bdrv_has_blk(bs));

    return bs;
}

BlockDriverState *bdrv_first(BdrvNextIterator *it)
{
    *it = (BdrvNextIterator) {
        .phase = BDRV_NEXT_BACKEND_ROOTS,
    };
M
Max Reitz 已提交
304

K
Kevin Wolf 已提交
305
    return bdrv_next(it);
M
Max Reitz 已提交
306 307
}

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
/*
 * Add a BlockBackend into the list of backends referenced by the monitor, with
 * the given @name acting as the handle for the monitor.
 * Strictly for use by blockdev.c.
 *
 * @name must not be null or empty.
 *
 * Returns true on success and false on failure. In the latter case, an Error
 * object is returned through @errp.
 */
bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp)
{
    assert(!blk->name);
    assert(name && name[0]);

    if (!id_wellformed(name)) {
        error_setg(errp, "Invalid device name");
        return false;
    }
    if (blk_by_name(name)) {
        error_setg(errp, "Device with id '%s' already exists", name);
        return false;
    }
    if (bdrv_find_node(name)) {
        error_setg(errp,
                   "Device name '%s' conflicts with an existing node name",
                   name);
        return false;
    }

    blk->name = g_strdup(name);
    QTAILQ_INSERT_TAIL(&monitor_block_backends, blk, monitor_link);
    return true;
}

/*
 * Remove a BlockBackend from the list of backends referenced by the monitor.
 * Strictly for use by blockdev.c.
 */
void monitor_remove_blk(BlockBackend *blk)
{
    if (!blk->name) {
        return;
    }

    QTAILQ_REMOVE(&monitor_block_backends, blk, monitor_link);
    g_free(blk->name);
    blk->name = NULL;
}

M
Markus Armbruster 已提交
358
/*
359
 * Return @blk's name, a non-null string.
360
 * Returns an empty string iff @blk is not referenced by the monitor.
M
Markus Armbruster 已提交
361 362 363
 */
const char *blk_name(BlockBackend *blk)
{
364
    return blk->name ?: "";
M
Markus Armbruster 已提交
365 366 367 368 369 370 371 372
}

/*
 * Return the BlockBackend with name @name if it exists, else null.
 * @name must not be null.
 */
BlockBackend *blk_by_name(const char *name)
{
373
    BlockBackend *blk = NULL;
M
Markus Armbruster 已提交
374 375

    assert(name);
376
    while ((blk = blk_next(blk)) != NULL) {
M
Markus Armbruster 已提交
377 378 379 380 381 382
        if (!strcmp(name, blk->name)) {
            return blk;
        }
    }
    return NULL;
}
383 384 385 386 387 388

/*
 * Return the BlockDriverState attached to @blk if any, else null.
 */
BlockDriverState *blk_bs(BlockBackend *blk)
{
389
    return blk->root ? blk->root->bs : NULL;
390 391
}

K
Kevin Wolf 已提交
392
static BlockBackend *bdrv_first_blk(BlockDriverState *bs)
K
Kevin Wolf 已提交
393 394 395 396
{
    BdrvChild *child;
    QLIST_FOREACH(child, &bs->parents, next_parent) {
        if (child->role == &child_root) {
K
Kevin Wolf 已提交
397
            return child->opaque;
K
Kevin Wolf 已提交
398 399 400
        }
    }

K
Kevin Wolf 已提交
401 402 403 404 405 406 407 408 409
    return NULL;
}

/*
 * Returns true if @bs has an associated BlockBackend.
 */
bool bdrv_has_blk(BlockDriverState *bs)
{
    return bdrv_first_blk(bs) != NULL;
K
Kevin Wolf 已提交
410 411
}

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
/*
 * Returns true if @bs has only BlockBackends as parents.
 */
bool bdrv_is_root_node(BlockDriverState *bs)
{
    BdrvChild *c;

    QLIST_FOREACH(c, &bs->parents, next_parent) {
        if (c->role != &child_root) {
            return false;
        }
    }

    return true;
}

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
/*
 * Return @blk's DriveInfo if any, else null.
 */
DriveInfo *blk_legacy_dinfo(BlockBackend *blk)
{
    return blk->legacy_dinfo;
}

/*
 * Set @blk's DriveInfo to @dinfo, and return it.
 * @blk must not have a DriveInfo set already.
 * No other BlockBackend may have the same DriveInfo set.
 */
DriveInfo *blk_set_legacy_dinfo(BlockBackend *blk, DriveInfo *dinfo)
{
    assert(!blk->legacy_dinfo);
    return blk->legacy_dinfo = dinfo;
}

/*
 * Return the BlockBackend with DriveInfo @dinfo.
 * It must exist.
 */
BlockBackend *blk_by_legacy_dinfo(DriveInfo *dinfo)
{
453
    BlockBackend *blk = NULL;
454

455
    while ((blk = blk_next(blk)) != NULL) {
456 457 458 459 460 461 462
        if (blk->legacy_dinfo == dinfo) {
            return blk;
        }
    }
    abort();
}

K
Kevin Wolf 已提交
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
/*
 * Returns a pointer to the publicly accessible fields of @blk.
 */
BlockBackendPublic *blk_get_public(BlockBackend *blk)
{
    return &blk->public;
}

/*
 * Returns a BlockBackend given the associated @public fields.
 */
BlockBackend *blk_by_public(BlockBackendPublic *public)
{
    return container_of(public, BlockBackend, public);
}

M
Max Reitz 已提交
479 480 481 482 483
/*
 * Disassociates the currently associated BlockDriverState from @blk.
 */
void blk_remove_bs(BlockBackend *blk)
{
484
    notifier_list_notify(&blk->remove_bs_notifiers, blk);
485
    if (blk->public.throttle_state) {
486
        throttle_timers_detach_aio_context(&blk->public.throttle_timers);
487
    }
M
Max Reitz 已提交
488

489 490
    blk_update_root_state(blk);

491 492
    bdrv_root_unref_child(blk->root);
    blk->root = NULL;
M
Max Reitz 已提交
493 494
}

M
Max Reitz 已提交
495 496 497 498 499 500
/*
 * Associates a new BlockDriverState with @blk.
 */
void blk_insert_bs(BlockBackend *blk, BlockDriverState *bs)
{
    bdrv_ref(bs);
501
    blk->root = bdrv_root_attach_child(bs, "root", &child_root, blk);
502 503

    notifier_list_notify(&blk->insert_bs_notifiers, blk);
504 505 506 507
    if (blk->public.throttle_state) {
        throttle_timers_attach_aio_context(
            &blk->public.throttle_timers, bdrv_get_aio_context(bs));
    }
M
Max Reitz 已提交
508 509
}

510
static int blk_do_attach_dev(BlockBackend *blk, void *dev)
511
{
512 513 514
    if (blk->dev) {
        return -EBUSY;
    }
515
    blk_ref(blk);
516
    blk->dev = dev;
517
    blk->legacy_dev = false;
518
    blk_iostatus_reset(blk);
519
    return 0;
520 521
}

522 523 524 525 526 527 528 529 530
/*
 * Attach device model @dev to @blk.
 * Return 0 on success, -EBUSY when a device model is attached already.
 */
int blk_attach_dev(BlockBackend *blk, DeviceState *dev)
{
    return blk_do_attach_dev(blk, dev);
}

531 532 533 534 535
/*
 * Attach device model @dev to @blk.
 * @blk must not have a device model attached already.
 * TODO qdevified devices don't use this, remove when devices are qdevified
 */
536
void blk_attach_dev_legacy(BlockBackend *blk, void *dev)
537
{
538
    if (blk_do_attach_dev(blk, dev) < 0) {
539 540
        abort();
    }
541
    blk->legacy_dev = true;
542 543
}

544 545 546 547
/*
 * Detach device model @dev from @blk.
 * @dev must be currently attached to @blk.
 */
548
void blk_detach_dev(BlockBackend *blk, void *dev)
549
/* TODO change to DeviceState *dev when all users are qdevified */
550
{
551 552 553 554
    assert(blk->dev == dev);
    blk->dev = NULL;
    blk->dev_ops = NULL;
    blk->dev_opaque = NULL;
555
    blk->guest_block_size = 512;
556
    blk_unref(blk);
557 558
}

559 560 561
/*
 * Return the device model attached to @blk if any, else null.
 */
562
void *blk_get_attached_dev(BlockBackend *blk)
563 564 565 566 567
/* TODO change to return DeviceState * when all users are qdevified */
{
    return blk->dev;
}

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
/* Return the qdev ID, or if no ID is assigned the QOM path, of the block
 * device attached to the BlockBackend. */
static char *blk_get_attached_dev_id(BlockBackend *blk)
{
    DeviceState *dev;

    assert(!blk->legacy_dev);
    dev = blk->dev;

    if (!dev) {
        return g_strdup("");
    } else if (dev->id) {
        return g_strdup(dev->id);
    }
    return object_get_canonical_path(OBJECT(dev));
}

K
Kevin Wolf 已提交
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
/*
 * Return the BlockBackend which has the device model @dev attached if it
 * exists, else null.
 *
 * @dev must not be null.
 */
BlockBackend *blk_by_dev(void *dev)
{
    BlockBackend *blk = NULL;

    assert(dev != NULL);
    while ((blk = blk_all_next(blk)) != NULL) {
        if (blk->dev == dev) {
            return blk;
        }
    }
    return NULL;
}

604 605 606 607 608 609 610 611
/*
 * Set @blk's device model callbacks to @ops.
 * @opaque is the opaque argument to pass to the callbacks.
 * This is for use by device models.
 */
void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops,
                     void *opaque)
{
612 613 614 615 616
    /* All drivers that use blk_set_dev_ops() are qdevified and we want to keep
     * it that way, so we can assume blk->dev is a DeviceState if blk->dev_ops
     * is set. */
    assert(!blk->legacy_dev);

617 618 619 620 621 622 623 624 625 626 627 628 629
    blk->dev_ops = ops;
    blk->dev_opaque = opaque;
}

/*
 * Notify @blk's attached device model of media change.
 * If @load is true, notify of media load.
 * Else, notify of media eject.
 * Also send DEVICE_TRAY_MOVED events as appropriate.
 */
void blk_dev_change_media_cb(BlockBackend *blk, bool load)
{
    if (blk->dev_ops && blk->dev_ops->change_media_cb) {
630
        bool tray_was_open, tray_is_open;
631

632 633
        assert(!blk->legacy_dev);

634
        tray_was_open = blk_dev_is_tray_open(blk);
635
        blk->dev_ops->change_media_cb(blk->dev_opaque, load);
636 637 638
        tray_is_open = blk_dev_is_tray_open(blk);

        if (tray_was_open != tray_is_open) {
639 640
            char *id = blk_get_attached_dev_id(blk);
            qapi_event_send_device_tray_moved(blk_name(blk), id, tray_is_open,
641
                                              &error_abort);
642
            g_free(id);
643 644 645 646
        }
    }
}

647 648 649 650 651
static void blk_root_change_media(BdrvChild *child, bool load)
{
    blk_dev_change_media_cb(child->opaque, load);
}

652 653 654 655 656 657 658 659 660
/*
 * Does @blk's attached device model have removable media?
 * %true if no device model is attached.
 */
bool blk_dev_has_removable_media(BlockBackend *blk)
{
    return !blk->dev || (blk->dev_ops && blk->dev_ops->change_media_cb);
}

M
Max Reitz 已提交
661 662 663 664 665 666 667 668
/*
 * Does @blk's attached device model have a tray?
 */
bool blk_dev_has_tray(BlockBackend *blk)
{
    return blk->dev_ops && blk->dev_ops->is_tray_open;
}

669 670 671 672 673
/*
 * Notify @blk's attached device model of a media eject request.
 * If @force is true, the medium is about to be yanked out forcefully.
 */
void blk_dev_eject_request(BlockBackend *blk, bool force)
674
{
675 676 677
    if (blk->dev_ops && blk->dev_ops->eject_request_cb) {
        blk->dev_ops->eject_request_cb(blk->dev_opaque, force);
    }
678 679
}

680 681 682 683
/*
 * Does @blk's attached device model have a tray, and is it open?
 */
bool blk_dev_is_tray_open(BlockBackend *blk)
684
{
M
Max Reitz 已提交
685
    if (blk_dev_has_tray(blk)) {
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
        return blk->dev_ops->is_tray_open(blk->dev_opaque);
    }
    return false;
}

/*
 * Does @blk's attached device model have the medium locked?
 * %false if the device model has no such lock.
 */
bool blk_dev_is_medium_locked(BlockBackend *blk)
{
    if (blk->dev_ops && blk->dev_ops->is_medium_locked) {
        return blk->dev_ops->is_medium_locked(blk->dev_opaque);
    }
    return false;
}

/*
 * Notify @blk's attached device model of a backend size change.
 */
706
static void blk_root_resize(BdrvChild *child)
707
{
708 709
    BlockBackend *blk = child->opaque;

710 711 712 713 714 715 716
    if (blk->dev_ops && blk->dev_ops->resize_cb) {
        blk->dev_ops->resize_cb(blk->dev_opaque);
    }
}

void blk_iostatus_enable(BlockBackend *blk)
{
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
    blk->iostatus_enabled = true;
    blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
}

/* The I/O status is only enabled if the drive explicitly
 * enables it _and_ the VM is configured to stop on errors */
bool blk_iostatus_is_enabled(const BlockBackend *blk)
{
    return (blk->iostatus_enabled &&
           (blk->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
            blk->on_write_error == BLOCKDEV_ON_ERROR_STOP   ||
            blk->on_read_error == BLOCKDEV_ON_ERROR_STOP));
}

BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk)
{
    return blk->iostatus;
}

void blk_iostatus_disable(BlockBackend *blk)
{
    blk->iostatus_enabled = false;
}

void blk_iostatus_reset(BlockBackend *blk)
{
    if (blk_iostatus_is_enabled(blk)) {
744
        BlockDriverState *bs = blk_bs(blk);
745
        blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
746 747
        if (bs && bs->job) {
            block_job_iostatus_reset(bs->job);
748 749 750 751 752 753 754 755 756 757 758
        }
    }
}

void blk_iostatus_set_err(BlockBackend *blk, int error)
{
    assert(blk_iostatus_is_enabled(blk));
    if (blk->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
        blk->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
                                          BLOCK_DEVICE_IO_STATUS_FAILED;
    }
759 760
}

761 762 763 764 765
void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow)
{
    blk->allow_write_beyond_eof = allow;
}

M
Max Reitz 已提交
766 767 768 769 770 771 772 773 774
static int blk_check_byte_request(BlockBackend *blk, int64_t offset,
                                  size_t size)
{
    int64_t len;

    if (size > INT_MAX) {
        return -EIO;
    }

775
    if (!blk_is_available(blk)) {
M
Max Reitz 已提交
776 777 778 779 780 781 782
        return -ENOMEDIUM;
    }

    if (offset < 0) {
        return -EIO;
    }

783 784 785 786 787 788 789 790 791
    if (!blk->allow_write_beyond_eof) {
        len = blk_getlength(blk);
        if (len < 0) {
            return len;
        }

        if (offset > len || len - offset < size) {
            return -EIO;
        }
M
Max Reitz 已提交
792 793 794 795 796
    }

    return 0;
}

797 798 799
int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset,
                               unsigned int bytes, QEMUIOVector *qiov,
                               BdrvRequestFlags flags)
800
{
801
    int ret;
802
    BlockDriverState *bs = blk_bs(blk);
803

804
    trace_blk_co_preadv(blk, bs, offset, bytes, flags);
805 806

    ret = blk_check_byte_request(blk, offset, bytes);
M
Max Reitz 已提交
807 808 809 810
    if (ret < 0) {
        return ret;
    }

811 812
    bdrv_inc_in_flight(bs);

813 814 815 816 817
    /* throttling disk I/O */
    if (blk->public.throttle_state) {
        throttle_group_co_io_limits_intercept(blk, bytes, false);
    }

818 819 820
    ret = bdrv_co_preadv(blk->root, offset, bytes, qiov, flags);
    bdrv_dec_in_flight(bs);
    return ret;
821 822
}

823 824 825
int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
                                unsigned int bytes, QEMUIOVector *qiov,
                                BdrvRequestFlags flags)
826
{
827
    int ret;
828
    BlockDriverState *bs = blk_bs(blk);
829

830
    trace_blk_co_pwritev(blk, bs, offset, bytes, flags);
831

832
    ret = blk_check_byte_request(blk, offset, bytes);
833 834 835 836
    if (ret < 0) {
        return ret;
    }

837 838
    bdrv_inc_in_flight(bs);

839 840 841 842 843
    /* throttling disk I/O */
    if (blk->public.throttle_state) {
        throttle_group_co_io_limits_intercept(blk, bytes, true);
    }

844 845 846 847
    if (!blk->enable_write_cache) {
        flags |= BDRV_REQ_FUA;
    }

848 849 850
    ret = bdrv_co_pwritev(blk->root, offset, bytes, qiov, flags);
    bdrv_dec_in_flight(bs);
    return ret;
851 852
}

853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
typedef struct BlkRwCo {
    BlockBackend *blk;
    int64_t offset;
    QEMUIOVector *qiov;
    int ret;
    BdrvRequestFlags flags;
} BlkRwCo;

static void blk_read_entry(void *opaque)
{
    BlkRwCo *rwco = opaque;

    rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, rwco->qiov->size,
                              rwco->qiov, rwco->flags);
}

869 870 871 872 873 874 875 876
static void blk_write_entry(void *opaque)
{
    BlkRwCo *rwco = opaque;

    rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, rwco->qiov->size,
                               rwco->qiov, rwco->flags);
}

877 878 879
static int blk_prw(BlockBackend *blk, int64_t offset, uint8_t *buf,
                   int64_t bytes, CoroutineEntry co_entry,
                   BdrvRequestFlags flags)
880 881 882 883 884 885 886
{
    QEMUIOVector qiov;
    struct iovec iov;
    BlkRwCo rwco;

    iov = (struct iovec) {
        .iov_base = buf,
887
        .iov_len = bytes,
888 889 890 891 892
    };
    qemu_iovec_init_external(&qiov, &iov, 1);

    rwco = (BlkRwCo) {
        .blk    = blk,
893
        .offset = offset,
894
        .qiov   = &qiov,
895
        .flags  = flags,
896 897 898
        .ret    = NOT_DONE,
    };

899 900 901 902 903 904 905 906
    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
        co_entry(&rwco);
    } else {
        Coroutine *co = qemu_coroutine_create(co_entry, &rwco);
        qemu_coroutine_enter(co);
        BDRV_POLL_WHILE(blk_bs(blk), rwco.ret == NOT_DONE);
    }
907 908

    return rwco.ret;
909 910
}

911 912
int blk_pread_unthrottled(BlockBackend *blk, int64_t offset, uint8_t *buf,
                          int count)
913
{
914 915
    int ret;

916
    ret = blk_check_byte_request(blk, offset, count);
M
Max Reitz 已提交
917 918 919 920
    if (ret < 0) {
        return ret;
    }

921
    blk_root_drained_begin(blk->root);
922
    ret = blk_pread(blk, offset, buf, count);
923
    blk_root_drained_end(blk->root);
924
    return ret;
925 926
}

E
Eric Blake 已提交
927 928
int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset,
                      int count, BdrvRequestFlags flags)
929
{
930 931
    return blk_prw(blk, offset, NULL, count, blk_write_entry,
                   flags | BDRV_REQ_ZERO_WRITE);
932 933
}

934 935 936 937 938
int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags)
{
    return bdrv_make_zero(blk->root, flags);
}

M
Max Reitz 已提交
939 940 941
static void error_callback_bh(void *opaque)
{
    struct BlockBackendAIOCB *acb = opaque;
942 943

    bdrv_dec_in_flight(acb->common.bs);
M
Max Reitz 已提交
944 945 946 947
    acb->common.cb(acb->common.opaque, acb->ret);
    qemu_aio_unref(acb);
}

P
Peter Lieven 已提交
948 949 950
BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
                                  BlockCompletionFunc *cb,
                                  void *opaque, int ret)
M
Max Reitz 已提交
951 952 953
{
    struct BlockBackendAIOCB *acb;

954
    bdrv_inc_in_flight(blk_bs(blk));
M
Max Reitz 已提交
955
    acb = blk_aio_get(&block_backend_aiocb_info, blk, cb, opaque);
956
    acb->blk = blk;
M
Max Reitz 已提交
957 958
    acb->ret = ret;

P
Paolo Bonzini 已提交
959
    aio_bh_schedule_oneshot(blk_get_aio_context(blk), error_callback_bh, acb);
M
Max Reitz 已提交
960 961 962
    return &acb->common;
}

963 964 965
typedef struct BlkAioEmAIOCB {
    BlockAIOCB common;
    BlkRwCo rwco;
K
Kevin Wolf 已提交
966
    int bytes;
967 968 969 970 971 972 973 974 975 976
    bool has_returned;
} BlkAioEmAIOCB;

static const AIOCBInfo blk_aio_em_aiocb_info = {
    .aiocb_size         = sizeof(BlkAioEmAIOCB),
};

static void blk_aio_complete(BlkAioEmAIOCB *acb)
{
    if (acb->has_returned) {
977
        bdrv_dec_in_flight(acb->common.bs);
978 979 980 981 982 983 984
        acb->common.cb(acb->common.opaque, acb->rwco.ret);
        qemu_aio_unref(acb);
    }
}

static void blk_aio_complete_bh(void *opaque)
{
P
Paolo Bonzini 已提交
985 986 987
    BlkAioEmAIOCB *acb = opaque;
    assert(acb->has_returned);
    blk_aio_complete(acb);
988 989
}

K
Kevin Wolf 已提交
990
static BlockAIOCB *blk_aio_prwv(BlockBackend *blk, int64_t offset, int bytes,
991 992 993 994 995 996 997
                                QEMUIOVector *qiov, CoroutineEntry co_entry,
                                BdrvRequestFlags flags,
                                BlockCompletionFunc *cb, void *opaque)
{
    BlkAioEmAIOCB *acb;
    Coroutine *co;

998
    bdrv_inc_in_flight(blk_bs(blk));
999 1000 1001 1002 1003 1004 1005 1006
    acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
    acb->rwco = (BlkRwCo) {
        .blk    = blk,
        .offset = offset,
        .qiov   = qiov,
        .flags  = flags,
        .ret    = NOT_DONE,
    };
K
Kevin Wolf 已提交
1007
    acb->bytes = bytes;
1008 1009
    acb->has_returned = false;

1010 1011
    co = qemu_coroutine_create(co_entry, acb);
    qemu_coroutine_enter(co);
1012 1013 1014

    acb->has_returned = true;
    if (acb->rwco.ret != NOT_DONE) {
P
Paolo Bonzini 已提交
1015 1016
        aio_bh_schedule_oneshot(blk_get_aio_context(blk),
                                blk_aio_complete_bh, acb);
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
    }

    return &acb->common;
}

static void blk_aio_read_entry(void *opaque)
{
    BlkAioEmAIOCB *acb = opaque;
    BlkRwCo *rwco = &acb->rwco;

K
Kevin Wolf 已提交
1027 1028
    assert(rwco->qiov->size == acb->bytes);
    rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, acb->bytes,
1029 1030 1031 1032 1033 1034 1035 1036 1037
                              rwco->qiov, rwco->flags);
    blk_aio_complete(acb);
}

static void blk_aio_write_entry(void *opaque)
{
    BlkAioEmAIOCB *acb = opaque;
    BlkRwCo *rwco = &acb->rwco;

K
Kevin Wolf 已提交
1038 1039
    assert(!rwco->qiov || rwco->qiov->size == acb->bytes);
    rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, acb->bytes,
1040 1041 1042 1043
                               rwco->qiov, rwco->flags);
    blk_aio_complete(acb);
}

E
Eric Blake 已提交
1044 1045 1046
BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
                                  int count, BdrvRequestFlags flags,
                                  BlockCompletionFunc *cb, void *opaque)
1047
{
1048 1049
    return blk_aio_prwv(blk, offset, count, NULL, blk_aio_write_entry,
                        flags | BDRV_REQ_ZERO_WRITE, cb, opaque);
1050 1051 1052 1053
}

int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count)
{
1054
    int ret = blk_prw(blk, offset, buf, count, blk_read_entry, 0);
M
Max Reitz 已提交
1055 1056 1057
    if (ret < 0) {
        return ret;
    }
1058
    return count;
1059 1060
}

1061 1062
int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count,
               BdrvRequestFlags flags)
1063
{
1064 1065
    int ret = blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
                      flags);
M
Max Reitz 已提交
1066 1067 1068
    if (ret < 0) {
        return ret;
    }
1069
    return count;
1070 1071 1072 1073
}

int64_t blk_getlength(BlockBackend *blk)
{
1074 1075 1076 1077
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1078
    return bdrv_getlength(blk_bs(blk));
1079 1080 1081 1082
}

void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr)
{
1083
    if (!blk_bs(blk)) {
1084 1085
        *nb_sectors_ptr = 0;
    } else {
1086
        bdrv_get_geometry(blk_bs(blk), nb_sectors_ptr);
1087
    }
1088 1089
}

1090 1091
int64_t blk_nb_sectors(BlockBackend *blk)
{
1092 1093 1094 1095
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1096
    return bdrv_nb_sectors(blk_bs(blk));
1097 1098
}

1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
                           QEMUIOVector *qiov, BdrvRequestFlags flags,
                           BlockCompletionFunc *cb, void *opaque)
{
    return blk_aio_prwv(blk, offset, qiov->size, qiov,
                        blk_aio_read_entry, flags, cb, opaque);
}

BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
                            QEMUIOVector *qiov, BdrvRequestFlags flags,
                            BlockCompletionFunc *cb, void *opaque)
{
    return blk_aio_prwv(blk, offset, qiov->size, qiov,
                        blk_aio_write_entry, flags, cb, opaque);
}

1115 1116 1117 1118 1119 1120 1121 1122 1123
static void blk_aio_flush_entry(void *opaque)
{
    BlkAioEmAIOCB *acb = opaque;
    BlkRwCo *rwco = &acb->rwco;

    rwco->ret = blk_co_flush(rwco->blk);
    blk_aio_complete(acb);
}

1124 1125 1126
BlockAIOCB *blk_aio_flush(BlockBackend *blk,
                          BlockCompletionFunc *cb, void *opaque)
{
1127
    return blk_aio_prwv(blk, 0, 0, NULL, blk_aio_flush_entry, 0, cb, opaque);
1128 1129
}

1130 1131 1132 1133 1134 1135 1136 1137 1138
static void blk_aio_pdiscard_entry(void *opaque)
{
    BlkAioEmAIOCB *acb = opaque;
    BlkRwCo *rwco = &acb->rwco;

    rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, acb->bytes);
    blk_aio_complete(acb);
}

1139 1140 1141
BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk,
                             int64_t offset, int count,
                             BlockCompletionFunc *cb, void *opaque)
1142
{
1143 1144
    return blk_aio_prwv(blk, offset, count, NULL, blk_aio_pdiscard_entry, 0,
                        cb, opaque);
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
}

void blk_aio_cancel(BlockAIOCB *acb)
{
    bdrv_aio_cancel(acb);
}

void blk_aio_cancel_async(BlockAIOCB *acb)
{
    bdrv_aio_cancel_async(acb);
}

1157
int blk_co_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1158
{
1159 1160 1161 1162
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
    return bdrv_co_ioctl(blk_bs(blk), req, buf);
}

static void blk_ioctl_entry(void *opaque)
{
    BlkRwCo *rwco = opaque;
    rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
                             rwco->qiov->iov[0].iov_base);
}

int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
{
    return blk_prw(blk, req, buf, 0, blk_ioctl_entry, 0);
}

static void blk_aio_ioctl_entry(void *opaque)
{
    BlkAioEmAIOCB *acb = opaque;
    BlkRwCo *rwco = &acb->rwco;

    rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
                             rwco->qiov->iov[0].iov_base);
    blk_aio_complete(acb);
1186 1187 1188 1189 1190
}

BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
                          BlockCompletionFunc *cb, void *opaque)
{
1191 1192 1193 1194 1195 1196 1197 1198
    QEMUIOVector qiov;
    struct iovec iov;

    iov = (struct iovec) {
        .iov_base = buf,
        .iov_len = 0,
    };
    qemu_iovec_init_external(&qiov, &iov, 1);
1199

1200
    return blk_aio_prwv(blk, req, 0, &qiov, blk_aio_ioctl_entry, 0, cb, opaque);
1201 1202
}

1203
int blk_co_pdiscard(BlockBackend *blk, int64_t offset, int count)
1204
{
1205
    int ret = blk_check_byte_request(blk, offset, count);
M
Max Reitz 已提交
1206 1207 1208 1209
    if (ret < 0) {
        return ret;
    }

1210
    return bdrv_co_pdiscard(blk_bs(blk), offset, count);
1211 1212 1213 1214
}

int blk_co_flush(BlockBackend *blk)
{
1215 1216 1217 1218
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1219
    return bdrv_co_flush(blk_bs(blk));
1220 1221
}

1222
static void blk_flush_entry(void *opaque)
1223
{
1224 1225 1226
    BlkRwCo *rwco = opaque;
    rwco->ret = blk_co_flush(rwco->blk);
}
1227

1228 1229 1230
int blk_flush(BlockBackend *blk)
{
    return blk_prw(blk, 0, NULL, 0, blk_flush_entry, 0);
1231 1232
}

1233 1234
void blk_drain(BlockBackend *blk)
{
1235 1236
    if (blk_bs(blk)) {
        bdrv_drain(blk_bs(blk));
1237
    }
1238 1239
}

1240 1241 1242 1243 1244
void blk_drain_all(void)
{
    bdrv_drain_all();
}

1245 1246 1247 1248 1249 1250 1251
void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
                      BlockdevOnError on_write_error)
{
    blk->on_read_error = on_read_error;
    blk->on_write_error = on_write_error;
}

1252 1253
BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read)
{
1254
    return is_read ? blk->on_read_error : blk->on_write_error;
1255 1256 1257 1258 1259
}

BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
                                      int error)
{
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
    BlockdevOnError on_err = blk_get_on_error(blk, is_read);

    switch (on_err) {
    case BLOCKDEV_ON_ERROR_ENOSPC:
        return (error == ENOSPC) ?
               BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
    case BLOCKDEV_ON_ERROR_STOP:
        return BLOCK_ERROR_ACTION_STOP;
    case BLOCKDEV_ON_ERROR_REPORT:
        return BLOCK_ERROR_ACTION_REPORT;
    case BLOCKDEV_ON_ERROR_IGNORE:
        return BLOCK_ERROR_ACTION_IGNORE;
1272
    case BLOCKDEV_ON_ERROR_AUTO:
1273 1274 1275
    default:
        abort();
    }
1276 1277
}

1278 1279 1280 1281 1282 1283 1284
static void send_qmp_error_event(BlockBackend *blk,
                                 BlockErrorAction action,
                                 bool is_read, int error)
{
    IoOperationType optype;

    optype = is_read ? IO_OPERATION_TYPE_READ : IO_OPERATION_TYPE_WRITE;
1285 1286 1287
    qapi_event_send_block_io_error(blk_name(blk),
                                   bdrv_get_node_name(blk_bs(blk)), optype,
                                   action, blk_iostatus_is_enabled(blk),
1288 1289 1290 1291 1292 1293 1294 1295
                                   error == ENOSPC, strerror(error),
                                   &error_abort);
}

/* This is done by device models because, while the block layer knows
 * about the error, it does not know whether an operation comes from
 * the device or the block layer (from a job, for example).
 */
1296 1297 1298
void blk_error_action(BlockBackend *blk, BlockErrorAction action,
                      bool is_read, int error)
{
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
    assert(error >= 0);

    if (action == BLOCK_ERROR_ACTION_STOP) {
        /* First set the iostatus, so that "info block" returns an iostatus
         * that matches the events raised so far (an additional error iostatus
         * is fine, but not a lost one).
         */
        blk_iostatus_set_err(blk, error);

        /* Then raise the request to stop the VM and the event.
         * qemu_system_vmstop_request_prepare has two effects.  First,
         * it ensures that the STOP event always comes after the
         * BLOCK_IO_ERROR event.  Second, it ensures that even if management
         * can observe the STOP event and do a "cont" before the STOP
         * event is issued, the VM will not stop.  In this case, vm_start()
         * also ensures that the STOP/RESUME pair of events is emitted.
         */
        qemu_system_vmstop_request_prepare();
        send_qmp_error_event(blk, action, is_read, error);
        qemu_system_vmstop_request(RUN_STATE_IO_ERROR);
    } else {
        send_qmp_error_event(blk, action, is_read, error);
    }
1322 1323 1324 1325
}

int blk_is_read_only(BlockBackend *blk)
{
1326 1327 1328 1329
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        return bdrv_is_read_only(bs);
1330 1331 1332
    } else {
        return blk->root_state.read_only;
    }
1333 1334 1335 1336
}

int blk_is_sg(BlockBackend *blk)
{
1337 1338 1339
    BlockDriverState *bs = blk_bs(blk);

    if (!bs) {
1340 1341 1342
        return 0;
    }

1343
    return bdrv_is_sg(bs);
1344 1345 1346 1347
}

int blk_enable_write_cache(BlockBackend *blk)
{
1348
    return blk->enable_write_cache;
1349 1350 1351 1352
}

void blk_set_enable_write_cache(BlockBackend *blk, bool wce)
{
1353
    blk->enable_write_cache = wce;
1354 1355
}

1356 1357
void blk_invalidate_cache(BlockBackend *blk, Error **errp)
{
1358 1359 1360
    BlockDriverState *bs = blk_bs(blk);

    if (!bs) {
1361 1362 1363 1364
        error_setg(errp, "Device '%s' has no medium", blk->name);
        return;
    }

1365
    bdrv_invalidate_cache(bs, errp);
1366 1367
}

1368
bool blk_is_inserted(BlockBackend *blk)
1369
{
1370 1371 1372
    BlockDriverState *bs = blk_bs(blk);

    return bs && bdrv_is_inserted(bs);
M
Max Reitz 已提交
1373 1374 1375 1376 1377
}

bool blk_is_available(BlockBackend *blk)
{
    return blk_is_inserted(blk) && !blk_dev_is_tray_open(blk);
1378 1379 1380 1381
}

void blk_lock_medium(BlockBackend *blk, bool locked)
{
1382 1383 1384 1385
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_lock_medium(bs, locked);
1386
    }
1387 1388 1389 1390
}

void blk_eject(BlockBackend *blk, bool eject_flag)
{
1391
    BlockDriverState *bs = blk_bs(blk);
1392 1393 1394 1395
    char *id;

    /* blk_eject is only called by qdevified devices */
    assert(!blk->legacy_dev);
1396 1397 1398

    if (bs) {
        bdrv_eject(bs, eject_flag);
1399
    }
1400 1401 1402 1403 1404 1405 1406

    /* Whether or not we ejected on the backend,
     * the frontend experienced a tray event. */
    id = blk_get_attached_dev_id(blk);
    qapi_event_send_device_tray_moved(blk_name(blk), id,
                                      eject_flag, &error_abort);
    g_free(id);
1407 1408 1409 1410
}

int blk_get_flags(BlockBackend *blk)
{
1411 1412 1413 1414
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        return bdrv_get_flags(bs);
1415 1416 1417
    } else {
        return blk->root_state.open_flags;
    }
1418 1419
}

1420 1421
/* Returns the maximum transfer length, in bytes; guaranteed nonzero */
uint32_t blk_get_max_transfer(BlockBackend *blk)
1422
{
1423
    BlockDriverState *bs = blk_bs(blk);
1424
    uint32_t max = 0;
1425 1426

    if (bs) {
1427
        max = bs->bl.max_transfer;
1428
    }
1429
    return MIN_NON_ZERO(max, INT_MAX);
1430 1431
}

1432 1433
int blk_get_max_iov(BlockBackend *blk)
{
1434
    return blk->root->bs->bl.max_iov;
1435 1436
}

1437 1438
void blk_set_guest_block_size(BlockBackend *blk, int align)
{
1439
    blk->guest_block_size = align;
1440 1441
}

1442 1443
void *blk_try_blockalign(BlockBackend *blk, size_t size)
{
1444
    return qemu_try_blockalign(blk ? blk_bs(blk) : NULL, size);
1445 1446
}

1447 1448
void *blk_blockalign(BlockBackend *blk, size_t size)
{
1449
    return qemu_blockalign(blk ? blk_bs(blk) : NULL, size);
1450 1451 1452 1453
}

bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp)
{
1454 1455 1456
    BlockDriverState *bs = blk_bs(blk);

    if (!bs) {
1457 1458 1459
        return false;
    }

1460
    return bdrv_op_is_blocked(bs, op, errp);
1461 1462 1463 1464
}

void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason)
{
1465 1466 1467 1468
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_op_unblock(bs, op, reason);
1469
    }
1470 1471 1472 1473
}

void blk_op_block_all(BlockBackend *blk, Error *reason)
{
1474 1475 1476 1477
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_op_block_all(bs, reason);
1478
    }
1479 1480 1481 1482
}

void blk_op_unblock_all(BlockBackend *blk, Error *reason)
{
1483 1484 1485 1486
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_op_unblock_all(bs, reason);
1487
    }
1488 1489 1490 1491
}

AioContext *blk_get_aio_context(BlockBackend *blk)
{
1492 1493 1494 1495
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        return bdrv_get_aio_context(bs);
1496 1497 1498 1499 1500 1501 1502 1503 1504
    } else {
        return qemu_get_aio_context();
    }
}

static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb)
{
    BlockBackendAIOCB *blk_acb = DO_UPCAST(BlockBackendAIOCB, common, acb);
    return blk_get_aio_context(blk_acb->blk);
1505 1506 1507 1508
}

void blk_set_aio_context(BlockBackend *blk, AioContext *new_context)
{
1509 1510 1511
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
1512 1513 1514
        if (blk->public.throttle_state) {
            throttle_timers_detach_aio_context(&blk->public.throttle_timers);
        }
1515
        bdrv_set_aio_context(bs, new_context);
1516 1517 1518 1519
        if (blk->public.throttle_state) {
            throttle_timers_attach_aio_context(&blk->public.throttle_timers,
                                               new_context);
        }
1520
    }
1521 1522
}

1523 1524 1525 1526
void blk_add_aio_context_notifier(BlockBackend *blk,
        void (*attached_aio_context)(AioContext *new_context, void *opaque),
        void (*detach_aio_context)(void *opaque), void *opaque)
{
1527 1528 1529 1530
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_add_aio_context_notifier(bs, attached_aio_context,
1531 1532
                                      detach_aio_context, opaque);
    }
1533 1534 1535 1536 1537 1538 1539 1540
}

void blk_remove_aio_context_notifier(BlockBackend *blk,
                                     void (*attached_aio_context)(AioContext *,
                                                                  void *),
                                     void (*detach_aio_context)(void *),
                                     void *opaque)
{
1541 1542 1543 1544
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_remove_aio_context_notifier(bs, attached_aio_context,
1545 1546
                                         detach_aio_context, opaque);
    }
1547 1548
}

1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify)
{
    notifier_list_add(&blk->remove_bs_notifiers, notify);
}

void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify)
{
    notifier_list_add(&blk->insert_bs_notifiers, notify);
}

1559 1560
void blk_io_plug(BlockBackend *blk)
{
1561 1562 1563 1564
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_io_plug(bs);
1565
    }
1566 1567 1568 1569
}

void blk_io_unplug(BlockBackend *blk)
{
1570 1571 1572 1573
    BlockDriverState *bs = blk_bs(blk);

    if (bs) {
        bdrv_io_unplug(bs);
1574
    }
1575 1576 1577 1578
}

BlockAcctStats *blk_get_stats(BlockBackend *blk)
{
1579
    return &blk->stats;
1580 1581 1582 1583 1584 1585 1586
}

void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
                  BlockCompletionFunc *cb, void *opaque)
{
    return qemu_aio_get(aiocb_info, blk_bs(blk), cb, opaque);
}
1587

E
Eric Blake 已提交
1588 1589
int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
                                      int count, BdrvRequestFlags flags)
1590
{
1591
    return blk_co_pwritev(blk, offset, count, NULL,
1592
                          flags | BDRV_REQ_ZERO_WRITE);
1593 1594
}

1595 1596
int blk_pwrite_compressed(BlockBackend *blk, int64_t offset, const void *buf,
                          int count)
1597
{
1598 1599
    return blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
                   BDRV_REQ_WRITE_COMPRESSED);
1600 1601 1602 1603
}

int blk_truncate(BlockBackend *blk, int64_t offset)
{
1604 1605 1606 1607
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1608
    return bdrv_truncate(blk_bs(blk), offset);
1609 1610
}

1611
static void blk_pdiscard_entry(void *opaque)
1612
{
1613 1614 1615
    BlkRwCo *rwco = opaque;
    rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, rwco->qiov->size);
}
M
Max Reitz 已提交
1616

1617 1618 1619
int blk_pdiscard(BlockBackend *blk, int64_t offset, int count)
{
    return blk_prw(blk, offset, NULL, count, blk_pdiscard_entry, 0);
1620 1621 1622 1623 1624
}

int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
                     int64_t pos, int size)
{
1625 1626
    int ret;

1627 1628 1629 1630
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
    ret = bdrv_save_vmstate(blk_bs(blk), buf, pos, size);
    if (ret < 0) {
        return ret;
    }

    if (ret == size && !blk->enable_write_cache) {
        ret = bdrv_flush(blk_bs(blk));
    }

    return ret < 0 ? ret : size;
1641 1642 1643 1644
}

int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size)
{
1645 1646 1647 1648
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1649
    return bdrv_load_vmstate(blk_bs(blk), buf, pos, size);
1650
}
1651 1652 1653

int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz)
{
1654 1655 1656 1657
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1658
    return bdrv_probe_blocksizes(blk_bs(blk), bsz);
1659 1660 1661 1662
}

int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo)
{
1663 1664 1665 1666
    if (!blk_is_available(blk)) {
        return -ENOMEDIUM;
    }

1667
    return bdrv_probe_geometry(blk_bs(blk), geo);
1668
}
M
Max Reitz 已提交
1669 1670 1671 1672 1673 1674 1675

/*
 * Updates the BlockBackendRootState object with data from the currently
 * attached BlockDriverState.
 */
void blk_update_root_state(BlockBackend *blk)
{
1676
    assert(blk->root);
M
Max Reitz 已提交
1677

1678 1679 1680
    blk->root_state.open_flags    = blk->root->bs->open_flags;
    blk->root_state.read_only     = blk->root->bs->read_only;
    blk->root_state.detect_zeroes = blk->root->bs->detect_zeroes;
M
Max Reitz 已提交
1681 1682
}

1683
/*
1684 1685
 * Returns the detect-zeroes setting to be used for bdrv_open() of a
 * BlockDriverState which is supposed to inherit the root state.
1686
 */
1687
bool blk_get_detect_zeroes_from_root_state(BlockBackend *blk)
1688
{
1689
    return blk->root_state.detect_zeroes;
1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705
}

/*
 * Returns the flags to be used for bdrv_open() of a BlockDriverState which is
 * supposed to inherit the root state.
 */
int blk_get_open_flags_from_root_state(BlockBackend *blk)
{
    int bs_flags;

    bs_flags = blk->root_state.read_only ? 0 : BDRV_O_RDWR;
    bs_flags |= blk->root_state.open_flags & ~BDRV_O_RDWR;

    return bs_flags;
}

M
Max Reitz 已提交
1706 1707 1708 1709
BlockBackendRootState *blk_get_root_state(BlockBackend *blk)
{
    return &blk->root_state;
}
M
Max Reitz 已提交
1710 1711 1712

int blk_commit_all(void)
{
1713 1714 1715 1716 1717 1718
    BlockBackend *blk = NULL;

    while ((blk = blk_all_next(blk)) != NULL) {
        AioContext *aio_context = blk_get_aio_context(blk);

        aio_context_acquire(aio_context);
1719 1720
        if (blk_is_inserted(blk) && blk->root->bs->backing) {
            int ret = bdrv_commit(blk->root->bs);
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
            if (ret < 0) {
                aio_context_release(aio_context);
                return ret;
            }
        }
        aio_context_release(aio_context);
    }
    return 0;
}

1731 1732 1733 1734 1735 1736 1737 1738 1739 1740

/* throttling disk I/O limits */
void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg)
{
    throttle_group_config(blk, cfg);
}

void blk_io_limits_disable(BlockBackend *blk)
{
    assert(blk->public.throttle_state);
1741
    bdrv_drained_begin(blk_bs(blk));
1742
    throttle_group_unregister_blk(blk);
1743
    bdrv_drained_end(blk_bs(blk));
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
}

/* should be called before blk_set_io_limits if a limit is set */
void blk_io_limits_enable(BlockBackend *blk, const char *group)
{
    assert(!blk->public.throttle_state);
    throttle_group_register_blk(blk, group);
}

void blk_io_limits_update_group(BlockBackend *blk, const char *group)
{
    /* this BB is not part of any group */
    if (!blk->public.throttle_state) {
        return;
    }

    /* this BB is a part of the same group than the one we want */
    if (!g_strcmp0(throttle_group_get_name(blk), group)) {
        return;
    }

    /* need to change the group this bs belong to */
    blk_io_limits_disable(blk);
    blk_io_limits_enable(blk, group);
}
1769 1770 1771 1772 1773

static void blk_root_drained_begin(BdrvChild *child)
{
    BlockBackend *blk = child->opaque;

1774 1775 1776
    /* Note that blk->root may not be accessible here yet if we are just
     * attaching to a BlockDriverState that is drained. Use child instead. */

1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788
    if (blk->public.io_limits_disabled++ == 0) {
        throttle_group_restart_blk(blk);
    }
}

static void blk_root_drained_end(BdrvChild *child)
{
    BlockBackend *blk = child->opaque;

    assert(blk->public.io_limits_disabled);
    --blk->public.io_limits_disabled;
}