io.c 86.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * Block layer I/O functions
 *
 * Copyright (c) 2003 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.
 */

P
Peter Maydell 已提交
25
#include "qemu/osdep.h"
26
#include "trace.h"
27
#include "sysemu/block-backend.h"
28
#include "block/aio-wait.h"
29
#include "block/blockjob.h"
30
#include "block/blockjob_int.h"
31
#include "block/block_int.h"
32
#include "qemu/cutils.h"
33
#include "qapi/error.h"
34
#include "qemu/error-report.h"
35 36 37

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

E
Eric Blake 已提交
38 39 40
/* Maximum bounce buffer for copy-on-read and write zeroes, in bytes */
#define MAX_BOUNCE_BUFFER (32768 << BDRV_SECTOR_BITS)

E
Eric Blake 已提交
41
static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
42
    int64_t offset, int bytes, BdrvRequestFlags flags);
43

44
void bdrv_parent_drained_begin(BlockDriverState *bs, BdrvChild *ignore)
45
{
46
    BdrvChild *c, *next;
47

48
    QLIST_FOREACH_SAFE(c, &bs->parents, next_parent, next) {
49 50 51
        if (c == ignore) {
            continue;
        }
52 53 54
        if (c->role->drained_begin) {
            c->role->drained_begin(c);
        }
55 56
    }
}
57

58
void bdrv_parent_drained_end(BlockDriverState *bs, BdrvChild *ignore)
59
{
60
    BdrvChild *c, *next;
61

62
    QLIST_FOREACH_SAFE(c, &bs->parents, next_parent, next) {
63 64 65
        if (c == ignore) {
            continue;
        }
66 67 68
        if (c->role->drained_end) {
            c->role->drained_end(c);
        }
69
    }
70 71
}

72 73 74 75 76 77 78 79 80 81 82
static void bdrv_merge_limits(BlockLimits *dst, const BlockLimits *src)
{
    dst->opt_transfer = MAX(dst->opt_transfer, src->opt_transfer);
    dst->max_transfer = MIN_NON_ZERO(dst->max_transfer, src->max_transfer);
    dst->opt_mem_alignment = MAX(dst->opt_mem_alignment,
                                 src->opt_mem_alignment);
    dst->min_mem_alignment = MAX(dst->min_mem_alignment,
                                 src->min_mem_alignment);
    dst->max_iov = MIN_NON_ZERO(dst->max_iov, src->max_iov);
}

83 84 85 86 87 88 89 90 91 92 93
void bdrv_refresh_limits(BlockDriverState *bs, Error **errp)
{
    BlockDriver *drv = bs->drv;
    Error *local_err = NULL;

    memset(&bs->bl, 0, sizeof(bs->bl));

    if (!drv) {
        return;
    }

94
    /* Default alignment based on whether driver has byte interface */
95 96
    bs->bl.request_alignment = (drv->bdrv_co_preadv ||
                                drv->bdrv_aio_preadv) ? 1 : 512;
97

98 99
    /* Take some limits from the children as a default */
    if (bs->file) {
K
Kevin Wolf 已提交
100
        bdrv_refresh_limits(bs->file->bs, &local_err);
101 102 103 104
        if (local_err) {
            error_propagate(errp, local_err);
            return;
        }
105
        bdrv_merge_limits(&bs->bl, &bs->file->bs->bl);
106
    } else {
107
        bs->bl.min_mem_alignment = 512;
108
        bs->bl.opt_mem_alignment = getpagesize();
109 110 111

        /* Safe default since most protocols use readv()/writev()/etc */
        bs->bl.max_iov = IOV_MAX;
112 113
    }

114 115
    if (bs->backing) {
        bdrv_refresh_limits(bs->backing->bs, &local_err);
116 117 118 119
        if (local_err) {
            error_propagate(errp, local_err);
            return;
        }
120
        bdrv_merge_limits(&bs->bl, &bs->backing->bs->bl);
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
    }

    /* Then let the driver override it */
    if (drv->bdrv_refresh_limits) {
        drv->bdrv_refresh_limits(bs, errp);
    }
}

/**
 * The copy-on-read flag is actually a reference count so multiple users may
 * use the feature without worrying about clobbering its previous state.
 * Copy-on-read stays enabled until all users have called to disable it.
 */
void bdrv_enable_copy_on_read(BlockDriverState *bs)
{
136
    atomic_inc(&bs->copy_on_read);
137 138 139 140
}

void bdrv_disable_copy_on_read(BlockDriverState *bs)
{
141 142
    int old = atomic_fetch_dec(&bs->copy_on_read);
    assert(old >= 1);
143 144
}

145 146 147 148
typedef struct {
    Coroutine *co;
    BlockDriverState *bs;
    bool done;
149
    bool begin;
150
    bool recursive;
151
    BdrvChild *parent;
152 153 154 155 156 157 158
} BdrvCoDrainData;

static void coroutine_fn bdrv_drain_invoke_entry(void *opaque)
{
    BdrvCoDrainData *data = opaque;
    BlockDriverState *bs = data->bs;

159
    if (data->begin) {
160
        bs->drv->bdrv_co_drain_begin(bs);
161 162 163
    } else {
        bs->drv->bdrv_co_drain_end(bs);
    }
164 165 166 167 168 169

    /* Set data->done before reading bs->wakeup.  */
    atomic_mb_set(&data->done, true);
    bdrv_wakeup(bs);
}

170
/* Recursively call BlockDriver.bdrv_co_drain_begin/end callbacks */
171
static void bdrv_drain_invoke(BlockDriverState *bs, bool begin)
172
{
173
    BdrvCoDrainData data = { .bs = bs, .done = false, .begin = begin};
174

175
    if (!bs->drv || (begin && !bs->drv->bdrv_co_drain_begin) ||
176
            (!begin && !bs->drv->bdrv_co_drain_end)) {
177 178 179 180 181 182 183 184
        return;
    }

    data.co = qemu_coroutine_create(bdrv_drain_invoke_entry, &data);
    bdrv_coroutine_enter(bs, data.co);
    BDRV_POLL_WHILE(bs, !data.done);
}

185 186 187 188 189 190 191 192 193
/* Returns true if BDRV_POLL_WHILE() should go into a blocking aio_poll() */
static bool bdrv_drain_poll(BlockDriverState *bs)
{
    /* Execute pending BHs first and check everything else only after the BHs
     * have executed. */
    while (aio_poll(bs->aio_context, false));
    return atomic_read(&bs->in_flight);
}

194
static bool bdrv_drain_recurse(BlockDriverState *bs)
195
{
196
    BdrvChild *child, *tmp;
197 198
    bool waited;

199
    /* Wait for drained requests to finish */
200
    waited = BDRV_POLL_WHILE(bs, bdrv_drain_poll(bs));
201

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
    QLIST_FOREACH_SAFE(child, &bs->children, next, tmp) {
        BlockDriverState *bs = child->bs;
        bool in_main_loop =
            qemu_get_current_aio_context() == qemu_get_aio_context();
        assert(bs->refcnt > 0);
        if (in_main_loop) {
            /* In case the recursive bdrv_drain_recurse processes a
             * block_job_defer_to_main_loop BH and modifies the graph,
             * let's hold a reference to bs until we are done.
             *
             * IOThread doesn't have such a BH, and it is not safe to call
             * bdrv_unref without BQL, so skip doing it there.
             */
            bdrv_ref(bs);
        }
217
        waited |= bdrv_drain_recurse(bs);
218 219 220
        if (in_main_loop) {
            bdrv_unref(bs);
        }
221
    }
222 223

    return waited;
224 225
}

226 227 228 229
static void bdrv_do_drained_begin(BlockDriverState *bs, bool recursive,
                                  BdrvChild *parent);
static void bdrv_do_drained_end(BlockDriverState *bs, bool recursive,
                                BdrvChild *parent);
230

F
Fam Zheng 已提交
231 232 233 234
static void bdrv_co_drain_bh_cb(void *opaque)
{
    BdrvCoDrainData *data = opaque;
    Coroutine *co = data->co;
235
    BlockDriverState *bs = data->bs;
F
Fam Zheng 已提交
236

237
    bdrv_dec_in_flight(bs);
238
    if (data->begin) {
239
        bdrv_do_drained_begin(bs, data->recursive, data->parent);
240
    } else {
241
        bdrv_do_drained_end(bs, data->recursive, data->parent);
242 243
    }

F
Fam Zheng 已提交
244
    data->done = true;
245
    aio_co_wake(co);
F
Fam Zheng 已提交
246 247
}

248
static void coroutine_fn bdrv_co_yield_to_drain(BlockDriverState *bs,
249 250
                                                bool begin, bool recursive,
                                                BdrvChild *parent)
F
Fam Zheng 已提交
251 252 253 254
{
    BdrvCoDrainData data;

    /* Calling bdrv_drain() from a BH ensures the current coroutine yields and
255
     * other coroutines run if they were queued by aio_co_enter(). */
F
Fam Zheng 已提交
256 257 258 259 260 261

    assert(qemu_in_coroutine());
    data = (BdrvCoDrainData) {
        .co = qemu_coroutine_self(),
        .bs = bs,
        .done = false,
262
        .begin = begin,
263
        .recursive = recursive,
264
        .parent = parent,
F
Fam Zheng 已提交
265
    };
266
    bdrv_inc_in_flight(bs);
P
Paolo Bonzini 已提交
267 268
    aio_bh_schedule_oneshot(bdrv_get_aio_context(bs),
                            bdrv_co_drain_bh_cb, &data);
F
Fam Zheng 已提交
269 270 271 272 273 274 275

    qemu_coroutine_yield();
    /* If we are resumed from some other event (such as an aio completion or a
     * timer callback), it is a bug in the caller that should be fixed. */
    assert(data.done);
}

276 277
void bdrv_do_drained_begin(BlockDriverState *bs, bool recursive,
                           BdrvChild *parent)
278
{
279 280
    BdrvChild *child, *next;

281
    if (qemu_in_coroutine()) {
282
        bdrv_co_yield_to_drain(bs, true, recursive, parent);
283 284 285
        return;
    }

K
Kevin Wolf 已提交
286
    /* Stop things in parent-to-child order */
287
    if (atomic_fetch_inc(&bs->quiesce_counter) == 0) {
288 289 290
        aio_disable_external(bdrv_get_aio_context(bs));
    }

291
    bdrv_parent_drained_begin(bs, parent);
292
    bdrv_drain_invoke(bs, true);
293
    bdrv_drain_recurse(bs);
294 295

    if (recursive) {
296
        bs->recursive_quiesce_counter++;
297 298 299 300
        QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
            bdrv_do_drained_begin(child->bs, true, child);
        }
    }
301 302
}

303 304
void bdrv_drained_begin(BlockDriverState *bs)
{
305 306 307 308 309 310
    bdrv_do_drained_begin(bs, false, NULL);
}

void bdrv_subtree_drained_begin(BlockDriverState *bs)
{
    bdrv_do_drained_begin(bs, true, NULL);
311 312
}

313 314
void bdrv_do_drained_end(BlockDriverState *bs, bool recursive,
                         BdrvChild *parent)
315
{
316
    BdrvChild *child, *next;
317 318
    int old_quiesce_counter;

319
    if (qemu_in_coroutine()) {
320
        bdrv_co_yield_to_drain(bs, false, recursive, parent);
321 322
        return;
    }
323
    assert(bs->quiesce_counter > 0);
324
    old_quiesce_counter = atomic_fetch_dec(&bs->quiesce_counter);
325

K
Kevin Wolf 已提交
326
    /* Re-enable things in child-to-parent order */
327
    bdrv_drain_invoke(bs, false);
328
    bdrv_parent_drained_end(bs, parent);
329 330 331
    if (old_quiesce_counter == 1) {
        aio_enable_external(bdrv_get_aio_context(bs));
    }
332 333

    if (recursive) {
334
        bs->recursive_quiesce_counter--;
335 336 337 338
        QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
            bdrv_do_drained_end(child->bs, true, child);
        }
    }
339 340
}

341 342
void bdrv_drained_end(BlockDriverState *bs)
{
343 344 345 346 347 348
    bdrv_do_drained_end(bs, false, NULL);
}

void bdrv_subtree_drained_end(BlockDriverState *bs)
{
    bdrv_do_drained_end(bs, true, NULL);
349 350
}

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
void bdrv_apply_subtree_drain(BdrvChild *child, BlockDriverState *new_parent)
{
    int i;

    for (i = 0; i < new_parent->recursive_quiesce_counter; i++) {
        bdrv_do_drained_begin(child->bs, true, child);
    }
}

void bdrv_unapply_subtree_drain(BdrvChild *child, BlockDriverState *old_parent)
{
    int i;

    for (i = 0; i < old_parent->recursive_quiesce_counter; i++) {
        bdrv_do_drained_end(child->bs, true, child);
    }
}

369
/*
370 371
 * Wait for pending requests to complete on a single BlockDriverState subtree,
 * and suspend block driver's internal I/O until next request arrives.
372 373 374 375
 *
 * Note that unlike bdrv_drain_all(), the caller must hold the BlockDriverState
 * AioContext.
 */
376
void coroutine_fn bdrv_co_drain(BlockDriverState *bs)
377
{
378 379 380
    assert(qemu_in_coroutine());
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
381
}
382

383 384
void bdrv_drain(BlockDriverState *bs)
{
385 386
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
387 388
}

389 390 391 392 393 394 395 396 397 398
static void bdrv_drain_assert_idle(BlockDriverState *bs)
{
    BdrvChild *child, *next;

    assert(atomic_read(&bs->in_flight) == 0);
    QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
        bdrv_drain_assert_idle(child->bs);
    }
}

399 400 401 402 403
/*
 * Wait for pending requests to complete across all BlockDriverStates
 *
 * This function does not flush data to disk, use bdrv_flush_all() for that
 * after calling this function.
404 405 406 407 408 409
 *
 * This pauses all block jobs and disables external clients. It must
 * be paired with bdrv_drain_all_end().
 *
 * NOTE: no new block jobs or BlockDriverStates can be created between
 * the bdrv_drain_all_begin() and bdrv_drain_all_end() calls.
410
 */
411
void bdrv_drain_all_begin(void)
412
{
K
Kevin Wolf 已提交
413
    BlockDriverState *bs;
K
Kevin Wolf 已提交
414
    BdrvNextIterator it;
415

416 417 418 419 420 421
    /* BDRV_POLL_WHILE() for a node can only be called from its own I/O thread
     * or the main loop AioContext. We potentially use BDRV_POLL_WHILE() on
     * nodes in several different AioContexts, so make sure we're in the main
     * context. */
    assert(qemu_get_current_aio_context() == qemu_get_aio_context());

K
Kevin Wolf 已提交
422
    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
423 424 425
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
426
        bdrv_do_drained_begin(bs, true, NULL);
427 428 429
        aio_context_release(aio_context);
    }

430 431
    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
        bdrv_drain_assert_idle(bs);
432
    }
433 434 435 436 437 438 439
}

void bdrv_drain_all_end(void)
{
    BlockDriverState *bs;
    BdrvNextIterator it;

K
Kevin Wolf 已提交
440
    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
441 442 443
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
444
        bdrv_do_drained_end(bs, true, NULL);
445 446 447 448
        aio_context_release(aio_context);
    }
}

449 450 451 452 453 454
void bdrv_drain_all(void)
{
    bdrv_drain_all_begin();
    bdrv_drain_all_end();
}

455 456 457 458 459 460 461 462
/**
 * Remove an active request from the tracked requests list
 *
 * This function should be called when a tracked request is completing.
 */
static void tracked_request_end(BdrvTrackedRequest *req)
{
    if (req->serialising) {
463
        atomic_dec(&req->bs->serialising_in_flight);
464 465
    }

466
    qemu_co_mutex_lock(&req->bs->reqs_lock);
467 468
    QLIST_REMOVE(req, list);
    qemu_co_queue_restart_all(&req->wait_queue);
469
    qemu_co_mutex_unlock(&req->bs->reqs_lock);
470 471 472 473 474 475 476 477
}

/**
 * Add an active request to the tracked requests list
 */
static void tracked_request_begin(BdrvTrackedRequest *req,
                                  BlockDriverState *bs,
                                  int64_t offset,
478 479
                                  unsigned int bytes,
                                  enum BdrvTrackedRequestType type)
480 481 482 483 484
{
    *req = (BdrvTrackedRequest){
        .bs = bs,
        .offset         = offset,
        .bytes          = bytes,
485
        .type           = type,
486 487 488 489 490 491 492 493
        .co             = qemu_coroutine_self(),
        .serialising    = false,
        .overlap_offset = offset,
        .overlap_bytes  = bytes,
    };

    qemu_co_queue_init(&req->wait_queue);

494
    qemu_co_mutex_lock(&bs->reqs_lock);
495
    QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
496
    qemu_co_mutex_unlock(&bs->reqs_lock);
497 498 499 500 501 502 503 504 505
}

static void mark_request_serialising(BdrvTrackedRequest *req, uint64_t align)
{
    int64_t overlap_offset = req->offset & ~(align - 1);
    unsigned int overlap_bytes = ROUND_UP(req->offset + req->bytes, align)
                               - overlap_offset;

    if (!req->serialising) {
506
        atomic_inc(&req->bs->serialising_in_flight);
507 508 509 510 511 512 513
        req->serialising = true;
    }

    req->overlap_offset = MIN(req->overlap_offset, overlap_offset);
    req->overlap_bytes = MAX(req->overlap_bytes, overlap_bytes);
}

514 515 516 517
/**
 * Round a region to cluster boundaries
 */
void bdrv_round_to_clusters(BlockDriverState *bs,
518
                            int64_t offset, int64_t bytes,
519
                            int64_t *cluster_offset,
520
                            int64_t *cluster_bytes)
521 522 523 524 525 526 527 528 529 530 531 532 533
{
    BlockDriverInfo bdi;

    if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
        *cluster_offset = offset;
        *cluster_bytes = bytes;
    } else {
        int64_t c = bdi.cluster_size;
        *cluster_offset = QEMU_ALIGN_DOWN(offset, c);
        *cluster_bytes = QEMU_ALIGN_UP(offset - *cluster_offset + bytes, c);
    }
}

534 535 536 537 538 539 540
static int bdrv_get_cluster_size(BlockDriverState *bs)
{
    BlockDriverInfo bdi;
    int ret;

    ret = bdrv_get_info(bs, &bdi);
    if (ret < 0 || bdi.cluster_size == 0) {
541
        return bs->bl.request_alignment;
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
    } else {
        return bdi.cluster_size;
    }
}

static bool tracked_request_overlaps(BdrvTrackedRequest *req,
                                     int64_t offset, unsigned int bytes)
{
    /*        aaaa   bbbb */
    if (offset >= req->overlap_offset + req->overlap_bytes) {
        return false;
    }
    /* bbbb   aaaa        */
    if (req->overlap_offset >= offset + bytes) {
        return false;
    }
    return true;
}

561 562 563 564 565
void bdrv_inc_in_flight(BlockDriverState *bs)
{
    atomic_inc(&bs->in_flight);
}

566 567
void bdrv_wakeup(BlockDriverState *bs)
{
568
    aio_wait_kick(bdrv_get_aio_wait(bs));
569 570
}

571 572 573
void bdrv_dec_in_flight(BlockDriverState *bs)
{
    atomic_dec(&bs->in_flight);
574
    bdrv_wakeup(bs);
575 576
}

577 578 579 580 581 582 583
static bool coroutine_fn wait_serialising_requests(BdrvTrackedRequest *self)
{
    BlockDriverState *bs = self->bs;
    BdrvTrackedRequest *req;
    bool retry;
    bool waited = false;

584
    if (!atomic_read(&bs->serialising_in_flight)) {
585 586 587 588 589
        return false;
    }

    do {
        retry = false;
590
        qemu_co_mutex_lock(&bs->reqs_lock);
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
        QLIST_FOREACH(req, &bs->tracked_requests, list) {
            if (req == self || (!req->serialising && !self->serialising)) {
                continue;
            }
            if (tracked_request_overlaps(req, self->overlap_offset,
                                         self->overlap_bytes))
            {
                /* Hitting this means there was a reentrant request, for
                 * example, a block driver issuing nested requests.  This must
                 * never happen since it means deadlock.
                 */
                assert(qemu_coroutine_self() != req->co);

                /* If the request is already (indirectly) waiting for us, or
                 * will wait for us as soon as it wakes up, then just go on
                 * (instead of producing a deadlock in the former case). */
                if (!req->waiting_for) {
                    self->waiting_for = req;
609
                    qemu_co_queue_wait(&req->wait_queue, &bs->reqs_lock);
610 611 612 613 614 615 616
                    self->waiting_for = NULL;
                    retry = true;
                    waited = true;
                    break;
                }
            }
        }
617
        qemu_co_mutex_unlock(&bs->reqs_lock);
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
    } while (retry);

    return waited;
}

static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
                                   size_t size)
{
    if (size > BDRV_REQUEST_MAX_SECTORS << BDRV_SECTOR_BITS) {
        return -EIO;
    }

    if (!bdrv_is_inserted(bs)) {
        return -ENOMEDIUM;
    }

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

    return 0;
}

typedef struct RwCo {
642
    BdrvChild *child;
643 644 645 646 647 648 649 650 651 652 653 654
    int64_t offset;
    QEMUIOVector *qiov;
    bool is_write;
    int ret;
    BdrvRequestFlags flags;
} RwCo;

static void coroutine_fn bdrv_rw_co_entry(void *opaque)
{
    RwCo *rwco = opaque;

    if (!rwco->is_write) {
655
        rwco->ret = bdrv_co_preadv(rwco->child, rwco->offset,
656 657
                                   rwco->qiov->size, rwco->qiov,
                                   rwco->flags);
658
    } else {
659
        rwco->ret = bdrv_co_pwritev(rwco->child, rwco->offset,
660 661
                                    rwco->qiov->size, rwco->qiov,
                                    rwco->flags);
662 663 664 665 666 667
    }
}

/*
 * Process a vectored synchronous request using coroutines
 */
668
static int bdrv_prwv_co(BdrvChild *child, int64_t offset,
669 670 671 672 673
                        QEMUIOVector *qiov, bool is_write,
                        BdrvRequestFlags flags)
{
    Coroutine *co;
    RwCo rwco = {
674
        .child = child,
675 676 677 678 679 680 681 682 683 684 685
        .offset = offset,
        .qiov = qiov,
        .is_write = is_write,
        .ret = NOT_DONE,
        .flags = flags,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
        bdrv_rw_co_entry(&rwco);
    } else {
686
        co = qemu_coroutine_create(bdrv_rw_co_entry, &rwco);
687
        bdrv_coroutine_enter(child->bs, co);
P
Paolo Bonzini 已提交
688
        BDRV_POLL_WHILE(child->bs, rwco.ret == NOT_DONE);
689 690 691 692 693 694 695
    }
    return rwco.ret;
}

/*
 * Process a synchronous request using coroutines
 */
696
static int bdrv_rw_co(BdrvChild *child, int64_t sector_num, uint8_t *buf,
697 698 699 700 701 702 703 704 705 706 707 708 709
                      int nb_sectors, bool is_write, BdrvRequestFlags flags)
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = (void *)buf,
        .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
    };

    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EINVAL;
    }

    qemu_iovec_init_external(&qiov, &iov, 1);
710
    return bdrv_prwv_co(child, sector_num << BDRV_SECTOR_BITS,
711 712 713 714
                        &qiov, is_write, flags);
}

/* return < 0 if error. See bdrv_write() for the return codes */
715
int bdrv_read(BdrvChild *child, int64_t sector_num,
716 717
              uint8_t *buf, int nb_sectors)
{
718
    return bdrv_rw_co(child, sector_num, buf, nb_sectors, false, 0);
719 720 721 722 723 724 725 726
}

/* Return < 0 if error. Important errors are:
  -EIO         generic I/O error (may happen for all errors)
  -ENOMEDIUM   No media inserted.
  -EINVAL      Invalid sector number or nb_sectors
  -EACCES      Trying to write a read-only device
*/
727
int bdrv_write(BdrvChild *child, int64_t sector_num,
728 729
               const uint8_t *buf, int nb_sectors)
{
730
    return bdrv_rw_co(child, sector_num, (uint8_t *)buf, nb_sectors, true, 0);
731 732
}

733
int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
734
                       int bytes, BdrvRequestFlags flags)
735
{
736 737 738
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = NULL,
739
        .iov_len = bytes,
740 741 742
    };

    qemu_iovec_init_external(&qiov, &iov, 1);
743
    return bdrv_prwv_co(child, offset, &qiov, true,
744
                        BDRV_REQ_ZERO_WRITE | flags);
745 746 747
}

/*
748
 * Completely zero out a block device with the help of bdrv_pwrite_zeroes.
749 750
 * The operation is sped up by checking the block status and only writing
 * zeroes to the device if they currently do not return zeroes. Optional
751
 * flags are passed through to bdrv_pwrite_zeroes (e.g. BDRV_REQ_MAY_UNMAP,
752
 * BDRV_REQ_FUA).
753 754 755
 *
 * Returns < 0 on error, 0 on success. For error codes see bdrv_write().
 */
756
int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags)
757
{
758 759
    int ret;
    int64_t target_size, bytes, offset = 0;
760
    BlockDriverState *bs = child->bs;
761

762 763 764
    target_size = bdrv_getlength(bs);
    if (target_size < 0) {
        return target_size;
765 766 767
    }

    for (;;) {
768 769
        bytes = MIN(target_size - offset, BDRV_REQUEST_MAX_BYTES);
        if (bytes <= 0) {
770 771
            return 0;
        }
772
        ret = bdrv_block_status(bs, offset, bytes, &bytes, NULL, NULL);
773
        if (ret < 0) {
774 775
            error_report("error getting block status at offset %" PRId64 ": %s",
                         offset, strerror(-ret));
776 777 778
            return ret;
        }
        if (ret & BDRV_BLOCK_ZERO) {
779
            offset += bytes;
780 781
            continue;
        }
782
        ret = bdrv_pwrite_zeroes(child, offset, bytes, flags);
783
        if (ret < 0) {
784 785
            error_report("error writing zeroes at offset %" PRId64 ": %s",
                         offset, strerror(-ret));
786 787
            return ret;
        }
788
        offset += bytes;
789 790 791
    }
}

792
int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
K
Kevin Wolf 已提交
793 794 795
{
    int ret;

796
    ret = bdrv_prwv_co(child, offset, qiov, false, 0);
K
Kevin Wolf 已提交
797 798 799 800 801 802 803
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

804
int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes)
805 806 807 808 809 810 811 812 813 814 815 816
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = (void *)buf,
        .iov_len = bytes,
    };

    if (bytes < 0) {
        return -EINVAL;
    }

    qemu_iovec_init_external(&qiov, &iov, 1);
817
    return bdrv_preadv(child, offset, &qiov);
818 819
}

820
int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
821 822 823
{
    int ret;

824
    ret = bdrv_prwv_co(child, offset, qiov, true, 0);
825 826 827 828 829 830 831
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

832
int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes)
833 834 835 836 837 838 839 840 841 842 843 844
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = (void *) buf,
        .iov_len    = bytes,
    };

    if (bytes < 0) {
        return -EINVAL;
    }

    qemu_iovec_init_external(&qiov, &iov, 1);
845
    return bdrv_pwritev(child, offset, &qiov);
846 847 848 849 850 851 852 853
}

/*
 * Writes to the file and ensures that no writes are reordered across this
 * request (acts as a barrier)
 *
 * Returns 0 on success, -errno in error cases.
 */
854 855
int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
                     const void *buf, int count)
856 857 858
{
    int ret;

859
    ret = bdrv_pwrite(child, offset, buf, count);
860 861 862 863
    if (ret < 0) {
        return ret;
    }

864
    ret = bdrv_flush(child->bs);
865 866
    if (ret < 0) {
        return ret;
867 868 869 870 871
    }

    return 0;
}

872 873 874 875 876 877 878 879 880 881
typedef struct CoroutineIOCompletion {
    Coroutine *coroutine;
    int ret;
} CoroutineIOCompletion;

static void bdrv_co_io_em_complete(void *opaque, int ret)
{
    CoroutineIOCompletion *co = opaque;

    co->ret = ret;
882
    aio_co_wake(co->coroutine);
883 884
}

885 886 887 888 889
static int coroutine_fn bdrv_driver_preadv(BlockDriverState *bs,
                                           uint64_t offset, uint64_t bytes,
                                           QEMUIOVector *qiov, int flags)
{
    BlockDriver *drv = bs->drv;
890 891 892
    int64_t sector_num;
    unsigned int nb_sectors;

893 894
    assert(!(flags & ~BDRV_REQ_MASK));

M
Max Reitz 已提交
895 896 897 898
    if (!drv) {
        return -ENOMEDIUM;
    }

899 900 901 902
    if (drv->bdrv_co_preadv) {
        return drv->bdrv_co_preadv(bs, offset, bytes, qiov, flags);
    }

903
    if (drv->bdrv_aio_preadv) {
904 905 906 907 908
        BlockAIOCB *acb;
        CoroutineIOCompletion co = {
            .coroutine = qemu_coroutine_self(),
        };

909 910
        acb = drv->bdrv_aio_preadv(bs, offset, bytes, qiov, flags,
                                   bdrv_co_io_em_complete, &co);
911 912 913 914 915 916 917
        if (acb == NULL) {
            return -EIO;
        } else {
            qemu_coroutine_yield();
            return co.ret;
        }
    }
918 919 920 921 922 923 924 925 926 927

    sector_num = offset >> BDRV_SECTOR_BITS;
    nb_sectors = bytes >> BDRV_SECTOR_BITS;

    assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
    assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
    assert((bytes >> BDRV_SECTOR_BITS) <= BDRV_REQUEST_MAX_SECTORS);
    assert(drv->bdrv_co_readv);

    return drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
928 929
}

930 931 932 933 934
static int coroutine_fn bdrv_driver_pwritev(BlockDriverState *bs,
                                            uint64_t offset, uint64_t bytes,
                                            QEMUIOVector *qiov, int flags)
{
    BlockDriver *drv = bs->drv;
935 936
    int64_t sector_num;
    unsigned int nb_sectors;
937 938
    int ret;

939 940
    assert(!(flags & ~BDRV_REQ_MASK));

M
Max Reitz 已提交
941 942 943 944
    if (!drv) {
        return -ENOMEDIUM;
    }

945
    if (drv->bdrv_co_pwritev) {
946 947 948
        ret = drv->bdrv_co_pwritev(bs, offset, bytes, qiov,
                                   flags & bs->supported_write_flags);
        flags &= ~bs->supported_write_flags;
949 950 951
        goto emulate_flags;
    }

952
    if (drv->bdrv_aio_pwritev) {
953 954 955 956 957
        BlockAIOCB *acb;
        CoroutineIOCompletion co = {
            .coroutine = qemu_coroutine_self(),
        };

958 959 960 961
        acb = drv->bdrv_aio_pwritev(bs, offset, bytes, qiov,
                                    flags & bs->supported_write_flags,
                                    bdrv_co_io_em_complete, &co);
        flags &= ~bs->supported_write_flags;
962
        if (acb == NULL) {
963
            ret = -EIO;
964 965
        } else {
            qemu_coroutine_yield();
966
            ret = co.ret;
967
        }
968 969 970 971 972 973 974 975 976 977
        goto emulate_flags;
    }

    sector_num = offset >> BDRV_SECTOR_BITS;
    nb_sectors = bytes >> BDRV_SECTOR_BITS;

    assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
    assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
    assert((bytes >> BDRV_SECTOR_BITS) <= BDRV_REQUEST_MAX_SECTORS);

978 979 980 981
    assert(drv->bdrv_co_writev);
    ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov,
                              flags & bs->supported_write_flags);
    flags &= ~bs->supported_write_flags;
982

983
emulate_flags:
984
    if (ret == 0 && (flags & BDRV_REQ_FUA)) {
985 986 987 988 989 990
        ret = bdrv_co_flush(bs);
    }

    return ret;
}

991 992 993 994 995 996
static int coroutine_fn
bdrv_driver_pwritev_compressed(BlockDriverState *bs, uint64_t offset,
                               uint64_t bytes, QEMUIOVector *qiov)
{
    BlockDriver *drv = bs->drv;

M
Max Reitz 已提交
997 998 999 1000
    if (!drv) {
        return -ENOMEDIUM;
    }

1001 1002 1003 1004 1005 1006 1007
    if (!drv->bdrv_co_pwritev_compressed) {
        return -ENOTSUP;
    }

    return drv->bdrv_co_pwritev_compressed(bs, offset, bytes, qiov);
}

1008
static int coroutine_fn bdrv_co_do_copy_on_readv(BdrvChild *child,
1009
        int64_t offset, unsigned int bytes, QEMUIOVector *qiov)
1010
{
1011 1012
    BlockDriverState *bs = child->bs;

1013 1014 1015 1016 1017 1018 1019 1020 1021
    /* Perform I/O through a temporary buffer so that users who scribble over
     * their read buffer while the operation is in progress do not end up
     * modifying the image file.  This is critical for zero-copy guest I/O
     * where anything might happen inside guest memory.
     */
    void *bounce_buffer;

    BlockDriver *drv = bs->drv;
    struct iovec iov;
E
Eric Blake 已提交
1022
    QEMUIOVector local_qiov;
1023
    int64_t cluster_offset;
1024
    int64_t cluster_bytes;
1025 1026
    size_t skip_bytes;
    int ret;
E
Eric Blake 已提交
1027 1028 1029
    int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer,
                                    BDRV_REQUEST_MAX_BYTES);
    unsigned int progress = 0;
1030

M
Max Reitz 已提交
1031 1032 1033 1034
    if (!drv) {
        return -ENOMEDIUM;
    }

1035 1036 1037
    /* FIXME We cannot require callers to have write permissions when all they
     * are doing is a read request. If we did things right, write permissions
     * would be obtained anyway, but internally by the copy-on-read code. As
E
Eric Blake 已提交
1038
     * long as it is implemented here rather than in a separate filter driver,
1039 1040 1041 1042
     * the copy-on-read code doesn't have its own BdrvChild, however, for which
     * it could request permissions. Therefore we have to bypass the permission
     * system for the moment. */
    // assert(child->perm & (BLK_PERM_WRITE_UNCHANGED | BLK_PERM_WRITE));
1043

1044
    /* Cover entire cluster so no additional backing file I/O is required when
E
Eric Blake 已提交
1045 1046 1047
     * allocating cluster in the image file.  Note that this value may exceed
     * BDRV_REQUEST_MAX_BYTES (even when the original read did not), which
     * is one reason we loop rather than doing it all at once.
1048
     */
1049
    bdrv_round_to_clusters(bs, offset, bytes, &cluster_offset, &cluster_bytes);
E
Eric Blake 已提交
1050
    skip_bytes = offset - cluster_offset;
1051

1052 1053
    trace_bdrv_co_do_copy_on_readv(bs, offset, bytes,
                                   cluster_offset, cluster_bytes);
1054

E
Eric Blake 已提交
1055 1056 1057
    bounce_buffer = qemu_try_blockalign(bs,
                                        MIN(MIN(max_transfer, cluster_bytes),
                                            MAX_BOUNCE_BUFFER));
1058 1059 1060 1061 1062
    if (bounce_buffer == NULL) {
        ret = -ENOMEM;
        goto err;
    }

E
Eric Blake 已提交
1063 1064
    while (cluster_bytes) {
        int64_t pnum;
1065

E
Eric Blake 已提交
1066 1067 1068 1069 1070 1071 1072 1073 1074
        ret = bdrv_is_allocated(bs, cluster_offset,
                                MIN(cluster_bytes, max_transfer), &pnum);
        if (ret < 0) {
            /* Safe to treat errors in querying allocation as if
             * unallocated; we'll probably fail again soon on the
             * read, but at least that will set a decent errno.
             */
            pnum = MIN(cluster_bytes, max_transfer);
        }
1075

E
Eric Blake 已提交
1076
        assert(skip_bytes < pnum);
1077

E
Eric Blake 已提交
1078 1079 1080 1081 1082
        if (ret <= 0) {
            /* Must copy-on-read; use the bounce buffer */
            iov.iov_base = bounce_buffer;
            iov.iov_len = pnum = MIN(pnum, MAX_BOUNCE_BUFFER);
            qemu_iovec_init_external(&local_qiov, &iov, 1);
1083

E
Eric Blake 已提交
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
            ret = bdrv_driver_preadv(bs, cluster_offset, pnum,
                                     &local_qiov, 0);
            if (ret < 0) {
                goto err;
            }

            bdrv_debug_event(bs, BLKDBG_COR_WRITE);
            if (drv->bdrv_co_pwrite_zeroes &&
                buffer_is_zero(bounce_buffer, pnum)) {
                /* FIXME: Should we (perhaps conditionally) be setting
                 * BDRV_REQ_MAY_UNMAP, if it will allow for a sparser copy
                 * that still correctly reads as zero? */
1096 1097
                ret = bdrv_co_do_pwrite_zeroes(bs, cluster_offset, pnum,
                                               BDRV_REQ_WRITE_UNCHANGED);
E
Eric Blake 已提交
1098 1099 1100 1101 1102
            } else {
                /* This does not change the data on the disk, it is not
                 * necessary to flush even in cache=writethrough mode.
                 */
                ret = bdrv_driver_pwritev(bs, cluster_offset, pnum,
1103 1104
                                          &local_qiov,
                                          BDRV_REQ_WRITE_UNCHANGED);
E
Eric Blake 已提交
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
            }

            if (ret < 0) {
                /* It might be okay to ignore write errors for guest
                 * requests.  If this is a deliberate copy-on-read
                 * then we don't want to ignore the error.  Simply
                 * report it in all cases.
                 */
                goto err;
            }

            qemu_iovec_from_buf(qiov, progress, bounce_buffer + skip_bytes,
                                pnum - skip_bytes);
        } else {
            /* Read directly into the destination */
            qemu_iovec_init(&local_qiov, qiov->niov);
            qemu_iovec_concat(&local_qiov, qiov, progress, pnum - skip_bytes);
            ret = bdrv_driver_preadv(bs, offset + progress, local_qiov.size,
                                     &local_qiov, 0);
            qemu_iovec_destroy(&local_qiov);
            if (ret < 0) {
                goto err;
            }
        }

        cluster_offset += pnum;
        cluster_bytes -= pnum;
        progress += pnum - skip_bytes;
        skip_bytes = 0;
    }
    ret = 0;
1136 1137 1138 1139 1140 1141 1142 1143

err:
    qemu_vfree(bounce_buffer);
    return ret;
}

/*
 * Forwards an already correctly aligned request to the BlockDriver. This
1144 1145
 * handles copy on read, zeroing after EOF, and fragmentation of large
 * reads; any other features must be implemented by the caller.
1146
 */
1147
static int coroutine_fn bdrv_aligned_preadv(BdrvChild *child,
1148 1149 1150
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
    int64_t align, QEMUIOVector *qiov, int flags)
{
1151
    BlockDriverState *bs = child->bs;
K
Kevin Wolf 已提交
1152
    int64_t total_bytes, max_bytes;
1153 1154 1155
    int ret = 0;
    uint64_t bytes_remaining = bytes;
    int max_transfer;
1156

1157 1158 1159
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
1160
    assert(!qiov || bytes == qiov->size);
1161
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1162 1163
    max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
                                   align);
1164 1165 1166 1167 1168 1169

    /* TODO: We would need a per-BDS .supported_read_flags and
     * potential fallback support, if we ever implement any read flags
     * to pass through to drivers.  For now, there aren't any
     * passthrough flags.  */
    assert(!(flags & ~(BDRV_REQ_NO_SERIALISING | BDRV_REQ_COPY_ON_READ)));
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180

    /* Handle Copy on Read and associated serialisation */
    if (flags & BDRV_REQ_COPY_ON_READ) {
        /* If we touch the same cluster it counts as an overlap.  This
         * guarantees that allocating writes will be serialized and not race
         * with each other for the same cluster.  For example, in copy-on-read
         * it ensures that the CoR read and write operations are atomic and
         * guest writes cannot interleave between them. */
        mark_request_serialising(req, bdrv_get_cluster_size(bs));
    }

1181 1182 1183
    if (!(flags & BDRV_REQ_NO_SERIALISING)) {
        wait_serialising_requests(req);
    }
1184 1185

    if (flags & BDRV_REQ_COPY_ON_READ) {
1186
        int64_t pnum;
1187

1188
        ret = bdrv_is_allocated(bs, offset, bytes, &pnum);
1189 1190 1191 1192
        if (ret < 0) {
            goto out;
        }

1193
        if (!ret || pnum != bytes) {
1194
            ret = bdrv_co_do_copy_on_readv(child, offset, bytes, qiov);
1195 1196 1197 1198
            goto out;
        }
    }

1199
    /* Forward the request to the BlockDriver, possibly fragmenting it */
K
Kevin Wolf 已提交
1200 1201 1202 1203 1204
    total_bytes = bdrv_getlength(bs);
    if (total_bytes < 0) {
        ret = total_bytes;
        goto out;
    }
1205

K
Kevin Wolf 已提交
1206
    max_bytes = ROUND_UP(MAX(0, total_bytes - offset), align);
1207
    if (bytes <= max_bytes && bytes <= max_transfer) {
K
Kevin Wolf 已提交
1208
        ret = bdrv_driver_preadv(bs, offset, bytes, qiov, 0);
1209 1210
        goto out;
    }
1211

1212 1213
    while (bytes_remaining) {
        int num;
1214

1215 1216
        if (max_bytes) {
            QEMUIOVector local_qiov;
1217

1218 1219 1220 1221
            num = MIN(bytes_remaining, MIN(max_bytes, max_transfer));
            assert(num);
            qemu_iovec_init(&local_qiov, qiov->niov);
            qemu_iovec_concat(&local_qiov, qiov, bytes - bytes_remaining, num);
1222

1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
            ret = bdrv_driver_preadv(bs, offset + bytes - bytes_remaining,
                                     num, &local_qiov, 0);
            max_bytes -= num;
            qemu_iovec_destroy(&local_qiov);
        } else {
            num = bytes_remaining;
            ret = qemu_iovec_memset(qiov, bytes - bytes_remaining, 0,
                                    bytes_remaining);
        }
        if (ret < 0) {
            goto out;
        }
        bytes_remaining -= num;
1236 1237 1238
    }

out:
1239
    return ret < 0 ? ret : 0;
1240 1241 1242 1243 1244
}

/*
 * Handle a read request in coroutine context
 */
1245
int coroutine_fn bdrv_co_preadv(BdrvChild *child,
1246 1247 1248
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1249
    BlockDriverState *bs = child->bs;
1250 1251 1252
    BlockDriver *drv = bs->drv;
    BdrvTrackedRequest req;

1253
    uint64_t align = bs->bl.request_alignment;
1254 1255 1256 1257 1258 1259
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

1260 1261
    trace_bdrv_co_preadv(child->bs, offset, bytes, flags);

1262 1263 1264 1265 1266 1267 1268 1269 1270
    if (!drv) {
        return -ENOMEDIUM;
    }

    ret = bdrv_check_byte_request(bs, offset, bytes);
    if (ret < 0) {
        return ret;
    }

1271 1272
    bdrv_inc_in_flight(bs);

1273
    /* Don't do copy-on-read if we read data before write operation */
1274
    if (atomic_read(&bs->copy_on_read) && !(flags & BDRV_REQ_NO_SERIALISING)) {
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
        flags |= BDRV_REQ_COPY_ON_READ;
    }

    /* Align read if necessary by padding qiov */
    if (offset & (align - 1)) {
        head_buf = qemu_blockalign(bs, align);
        qemu_iovec_init(&local_qiov, qiov->niov + 2);
        qemu_iovec_add(&local_qiov, head_buf, offset & (align - 1));
        qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
        use_local_qiov = true;

        bytes += offset & (align - 1);
        offset = offset & ~(align - 1);
    }

    if ((offset + bytes) & (align - 1)) {
        if (!use_local_qiov) {
            qemu_iovec_init(&local_qiov, qiov->niov + 1);
            qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
            use_local_qiov = true;
        }
        tail_buf = qemu_blockalign(bs, align);
        qemu_iovec_add(&local_qiov, tail_buf,
                       align - ((offset + bytes) & (align - 1)));

        bytes = ROUND_UP(bytes, align);
    }

1303
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_READ);
1304
    ret = bdrv_aligned_preadv(child, &req, offset, bytes, align,
1305 1306 1307
                              use_local_qiov ? &local_qiov : qiov,
                              flags);
    tracked_request_end(&req);
1308
    bdrv_dec_in_flight(bs);
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318

    if (use_local_qiov) {
        qemu_iovec_destroy(&local_qiov);
        qemu_vfree(head_buf);
        qemu_vfree(tail_buf);
    }

    return ret;
}

1319
static int coroutine_fn bdrv_co_do_readv(BdrvChild *child,
1320 1321 1322 1323 1324 1325 1326
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EINVAL;
    }

1327
    return bdrv_co_preadv(child, sector_num << BDRV_SECTOR_BITS,
1328
                          nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1329 1330
}

1331 1332
int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num,
                               int nb_sectors, QEMUIOVector *qiov)
1333
{
1334
    return bdrv_co_do_readv(child, sector_num, nb_sectors, qiov, 0);
1335 1336
}

E
Eric Blake 已提交
1337
static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
1338
    int64_t offset, int bytes, BdrvRequestFlags flags)
1339 1340 1341 1342 1343
{
    BlockDriver *drv = bs->drv;
    QEMUIOVector qiov;
    struct iovec iov = {0};
    int ret = 0;
1344
    bool need_flush = false;
1345 1346
    int head = 0;
    int tail = 0;
1347

1348
    int max_write_zeroes = MIN_NON_ZERO(bs->bl.max_pwrite_zeroes, INT_MAX);
1349 1350
    int alignment = MAX(bs->bl.pwrite_zeroes_alignment,
                        bs->bl.request_alignment);
E
Eric Blake 已提交
1351
    int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer, MAX_BOUNCE_BUFFER);
E
Eric Blake 已提交
1352

M
Max Reitz 已提交
1353 1354 1355 1356
    if (!drv) {
        return -ENOMEDIUM;
    }

1357 1358
    assert(alignment % bs->bl.request_alignment == 0);
    head = offset % alignment;
1359
    tail = (offset + bytes) % alignment;
1360 1361
    max_write_zeroes = QEMU_ALIGN_DOWN(max_write_zeroes, alignment);
    assert(max_write_zeroes >= bs->bl.request_alignment);
1362

1363 1364
    while (bytes > 0 && !ret) {
        int num = bytes;
1365 1366

        /* Align request.  Block drivers can expect the "bulk" of the request
1367 1368
         * to be aligned, and that unaligned requests do not cross cluster
         * boundaries.
1369
         */
1370
        if (head) {
1371 1372 1373
            /* Make a small request up to the first aligned sector. For
             * convenience, limit this request to max_transfer even if
             * we don't need to fall back to writes.  */
1374
            num = MIN(MIN(bytes, max_transfer), alignment - head);
1375 1376
            head = (head + num) % alignment;
            assert(num < max_write_zeroes);
E
Eric Blake 已提交
1377
        } else if (tail && num > alignment) {
1378 1379
            /* Shorten the request to the last aligned sector.  */
            num -= tail;
1380 1381 1382 1383 1384 1385 1386 1387 1388
        }

        /* limit request size */
        if (num > max_write_zeroes) {
            num = max_write_zeroes;
        }

        ret = -ENOTSUP;
        /* First try the efficient write zeroes operation */
E
Eric Blake 已提交
1389 1390 1391 1392 1393 1394 1395
        if (drv->bdrv_co_pwrite_zeroes) {
            ret = drv->bdrv_co_pwrite_zeroes(bs, offset, num,
                                             flags & bs->supported_zero_flags);
            if (ret != -ENOTSUP && (flags & BDRV_REQ_FUA) &&
                !(bs->supported_zero_flags & BDRV_REQ_FUA)) {
                need_flush = true;
            }
1396 1397
        } else {
            assert(!bs->supported_zero_flags);
1398 1399 1400 1401
        }

        if (ret == -ENOTSUP) {
            /* Fall back to bounce buffer if write zeroes is unsupported */
1402 1403 1404 1405 1406 1407 1408 1409 1410
            BdrvRequestFlags write_flags = flags & ~BDRV_REQ_ZERO_WRITE;

            if ((flags & BDRV_REQ_FUA) &&
                !(bs->supported_write_flags & BDRV_REQ_FUA)) {
                /* No need for bdrv_driver_pwrite() to do a fallback
                 * flush on each chunk; use just one at the end */
                write_flags &= ~BDRV_REQ_FUA;
                need_flush = true;
            }
1411
            num = MIN(num, max_transfer);
E
Eric Blake 已提交
1412
            iov.iov_len = num;
1413
            if (iov.iov_base == NULL) {
E
Eric Blake 已提交
1414
                iov.iov_base = qemu_try_blockalign(bs, num);
1415 1416 1417 1418
                if (iov.iov_base == NULL) {
                    ret = -ENOMEM;
                    goto fail;
                }
E
Eric Blake 已提交
1419
                memset(iov.iov_base, 0, num);
1420 1421 1422
            }
            qemu_iovec_init_external(&qiov, &iov, 1);

E
Eric Blake 已提交
1423
            ret = bdrv_driver_pwritev(bs, offset, num, &qiov, write_flags);
1424 1425 1426 1427

            /* Keep bounce buffer around if it is big enough for all
             * all future requests.
             */
1428
            if (num < max_transfer) {
1429 1430 1431 1432 1433
                qemu_vfree(iov.iov_base);
                iov.iov_base = NULL;
            }
        }

E
Eric Blake 已提交
1434
        offset += num;
1435
        bytes -= num;
1436 1437 1438
    }

fail:
1439 1440 1441
    if (ret == 0 && need_flush) {
        ret = bdrv_co_flush(bs);
    }
1442 1443 1444 1445 1446
    qemu_vfree(iov.iov_base);
    return ret;
}

/*
1447 1448
 * Forwards an already correctly aligned write request to the BlockDriver,
 * after possibly fragmenting it.
1449
 */
1450
static int coroutine_fn bdrv_aligned_pwritev(BdrvChild *child,
1451
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
1452
    int64_t align, QEMUIOVector *qiov, int flags)
1453
{
1454
    BlockDriverState *bs = child->bs;
1455 1456 1457 1458
    BlockDriver *drv = bs->drv;
    bool waited;
    int ret;

1459
    int64_t end_sector = DIV_ROUND_UP(offset + bytes, BDRV_SECTOR_SIZE);
1460 1461
    uint64_t bytes_remaining = bytes;
    int max_transfer;
1462

M
Max Reitz 已提交
1463 1464 1465 1466
    if (!drv) {
        return -ENOMEDIUM;
    }

1467 1468 1469 1470
    if (bdrv_has_readonly_bitmaps(bs)) {
        return -EPERM;
    }

1471 1472 1473
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
1474
    assert(!qiov || bytes == qiov->size);
1475
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1476
    assert(!(flags & ~BDRV_REQ_MASK));
1477 1478
    max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
                                   align);
1479 1480 1481 1482 1483

    waited = wait_serialising_requests(req);
    assert(!waited || !req->serialising);
    assert(req->overlap_offset <= offset);
    assert(offset + bytes <= req->overlap_offset + req->overlap_bytes);
1484 1485 1486 1487 1488
    if (flags & BDRV_REQ_WRITE_UNCHANGED) {
        assert(child->perm & (BLK_PERM_WRITE_UNCHANGED | BLK_PERM_WRITE));
    } else {
        assert(child->perm & BLK_PERM_WRITE);
    }
1489
    assert(end_sector <= bs->total_sectors || child->perm & BLK_PERM_RESIZE);
1490 1491 1492 1493

    ret = notifier_with_return_list_notify(&bs->before_write_notifiers, req);

    if (!ret && bs->detect_zeroes != BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF &&
E
Eric Blake 已提交
1494
        !(flags & BDRV_REQ_ZERO_WRITE) && drv->bdrv_co_pwrite_zeroes &&
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
        qemu_iovec_is_zero(qiov)) {
        flags |= BDRV_REQ_ZERO_WRITE;
        if (bs->detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP) {
            flags |= BDRV_REQ_MAY_UNMAP;
        }
    }

    if (ret < 0) {
        /* Do nothing, write notifier decided to fail this request */
    } else if (flags & BDRV_REQ_ZERO_WRITE) {
K
Kevin Wolf 已提交
1505
        bdrv_debug_event(bs, BLKDBG_PWRITEV_ZERO);
1506
        ret = bdrv_co_do_pwrite_zeroes(bs, offset, bytes, flags);
1507 1508
    } else if (flags & BDRV_REQ_WRITE_COMPRESSED) {
        ret = bdrv_driver_pwritev_compressed(bs, offset, bytes, qiov);
1509
    } else if (bytes <= max_transfer) {
K
Kevin Wolf 已提交
1510
        bdrv_debug_event(bs, BLKDBG_PWRITEV);
1511
        ret = bdrv_driver_pwritev(bs, offset, bytes, qiov, flags);
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
    } else {
        bdrv_debug_event(bs, BLKDBG_PWRITEV);
        while (bytes_remaining) {
            int num = MIN(bytes_remaining, max_transfer);
            QEMUIOVector local_qiov;
            int local_flags = flags;

            assert(num);
            if (num < bytes_remaining && (flags & BDRV_REQ_FUA) &&
                !(bs->supported_write_flags & BDRV_REQ_FUA)) {
                /* If FUA is going to be emulated by flush, we only
                 * need to flush on the last iteration */
                local_flags &= ~BDRV_REQ_FUA;
            }
            qemu_iovec_init(&local_qiov, qiov->niov);
            qemu_iovec_concat(&local_qiov, qiov, bytes - bytes_remaining, num);

            ret = bdrv_driver_pwritev(bs, offset + bytes - bytes_remaining,
                                      num, &local_qiov, local_flags);
            qemu_iovec_destroy(&local_qiov);
            if (ret < 0) {
                break;
            }
            bytes_remaining -= num;
        }
1537
    }
K
Kevin Wolf 已提交
1538
    bdrv_debug_event(bs, BLKDBG_PWRITEV_DONE);
1539

1540
    atomic_inc(&bs->write_gen);
1541
    bdrv_set_dirty(bs, offset, bytes);
1542

1543
    stat64_max(&bs->wr_highest_offset, offset + bytes);
1544 1545

    if (ret >= 0) {
1546
        bs->total_sectors = MAX(bs->total_sectors, end_sector);
1547
        ret = 0;
1548 1549 1550 1551 1552
    }

    return ret;
}

1553
static int coroutine_fn bdrv_co_do_zero_pwritev(BdrvChild *child,
1554 1555 1556 1557 1558
                                                int64_t offset,
                                                unsigned int bytes,
                                                BdrvRequestFlags flags,
                                                BdrvTrackedRequest *req)
{
1559
    BlockDriverState *bs = child->bs;
1560 1561 1562
    uint8_t *buf = NULL;
    QEMUIOVector local_qiov;
    struct iovec iov;
1563
    uint64_t align = bs->bl.request_alignment;
1564 1565 1566 1567
    unsigned int head_padding_bytes, tail_padding_bytes;
    int ret = 0;

    head_padding_bytes = offset & (align - 1);
1568
    tail_padding_bytes = (align - (offset + bytes)) & (align - 1);
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585


    assert(flags & BDRV_REQ_ZERO_WRITE);
    if (head_padding_bytes || tail_padding_bytes) {
        buf = qemu_blockalign(bs, align);
        iov = (struct iovec) {
            .iov_base   = buf,
            .iov_len    = align,
        };
        qemu_iovec_init_external(&local_qiov, &iov, 1);
    }
    if (head_padding_bytes) {
        uint64_t zero_bytes = MIN(bytes, align - head_padding_bytes);

        /* RMW the unaligned part before head. */
        mark_request_serialising(req, align);
        wait_serialising_requests(req);
K
Kevin Wolf 已提交
1586
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1587
        ret = bdrv_aligned_preadv(child, req, offset & ~(align - 1), align,
1588 1589 1590 1591
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1592
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1593 1594

        memset(buf + head_padding_bytes, 0, zero_bytes);
1595
        ret = bdrv_aligned_pwritev(child, req, offset & ~(align - 1), align,
1596
                                   align, &local_qiov,
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
                                   flags & ~BDRV_REQ_ZERO_WRITE);
        if (ret < 0) {
            goto fail;
        }
        offset += zero_bytes;
        bytes -= zero_bytes;
    }

    assert(!bytes || (offset & (align - 1)) == 0);
    if (bytes >= align) {
        /* Write the aligned part in the middle. */
        uint64_t aligned_bytes = bytes & ~(align - 1);
1609
        ret = bdrv_aligned_pwritev(child, req, offset, aligned_bytes, align,
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
                                   NULL, flags);
        if (ret < 0) {
            goto fail;
        }
        bytes -= aligned_bytes;
        offset += aligned_bytes;
    }

    assert(!bytes || (offset & (align - 1)) == 0);
    if (bytes) {
        assert(align == tail_padding_bytes + bytes);
        /* RMW the unaligned part after tail. */
        mark_request_serialising(req, align);
        wait_serialising_requests(req);
K
Kevin Wolf 已提交
1624
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1625
        ret = bdrv_aligned_preadv(child, req, offset, align,
1626 1627 1628 1629
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1630
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1631 1632

        memset(buf, 0, bytes);
1633
        ret = bdrv_aligned_pwritev(child, req, offset, align, align,
1634 1635 1636 1637 1638 1639 1640 1641
                                   &local_qiov, flags & ~BDRV_REQ_ZERO_WRITE);
    }
fail:
    qemu_vfree(buf);
    return ret;

}

1642 1643 1644
/*
 * Handle a write request in coroutine context
 */
1645
int coroutine_fn bdrv_co_pwritev(BdrvChild *child,
1646 1647 1648
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1649
    BlockDriverState *bs = child->bs;
1650
    BdrvTrackedRequest req;
1651
    uint64_t align = bs->bl.request_alignment;
1652 1653 1654 1655 1656 1657
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

1658 1659
    trace_bdrv_co_pwritev(child->bs, offset, bytes, flags);

1660 1661 1662 1663
    if (!bs->drv) {
        return -ENOMEDIUM;
    }
    if (bs->read_only) {
1664
        return -EPERM;
1665
    }
1666
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
1667 1668 1669 1670 1671 1672

    ret = bdrv_check_byte_request(bs, offset, bytes);
    if (ret < 0) {
        return ret;
    }

1673
    bdrv_inc_in_flight(bs);
1674 1675 1676 1677 1678
    /*
     * Align write if necessary by performing a read-modify-write cycle.
     * Pad qiov with the read parts and be sure to have a tracked request not
     * only for bdrv_aligned_pwritev, but also for the reads of the RMW cycle.
     */
1679
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_WRITE);
1680

1681
    if (flags & BDRV_REQ_ZERO_WRITE) {
1682
        ret = bdrv_co_do_zero_pwritev(child, offset, bytes, flags, &req);
1683 1684 1685
        goto out;
    }

1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
    if (offset & (align - 1)) {
        QEMUIOVector head_qiov;
        struct iovec head_iov;

        mark_request_serialising(&req, align);
        wait_serialising_requests(&req);

        head_buf = qemu_blockalign(bs, align);
        head_iov = (struct iovec) {
            .iov_base   = head_buf,
            .iov_len    = align,
        };
        qemu_iovec_init_external(&head_qiov, &head_iov, 1);

K
Kevin Wolf 已提交
1700
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1701
        ret = bdrv_aligned_preadv(child, &req, offset & ~(align - 1), align,
1702 1703 1704 1705
                                  align, &head_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1706
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1707 1708 1709 1710 1711 1712 1713 1714

        qemu_iovec_init(&local_qiov, qiov->niov + 2);
        qemu_iovec_add(&local_qiov, head_buf, offset & (align - 1));
        qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
        use_local_qiov = true;

        bytes += offset & (align - 1);
        offset = offset & ~(align - 1);
1715 1716 1717 1718 1719 1720 1721 1722

        /* We have read the tail already if the request is smaller
         * than one aligned block.
         */
        if (bytes < align) {
            qemu_iovec_add(&local_qiov, head_buf + bytes, align - bytes);
            bytes = align;
        }
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
    }

    if ((offset + bytes) & (align - 1)) {
        QEMUIOVector tail_qiov;
        struct iovec tail_iov;
        size_t tail_bytes;
        bool waited;

        mark_request_serialising(&req, align);
        waited = wait_serialising_requests(&req);
        assert(!waited || !use_local_qiov);

        tail_buf = qemu_blockalign(bs, align);
        tail_iov = (struct iovec) {
            .iov_base   = tail_buf,
            .iov_len    = align,
        };
        qemu_iovec_init_external(&tail_qiov, &tail_iov, 1);

K
Kevin Wolf 已提交
1742
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1743 1744
        ret = bdrv_aligned_preadv(child, &req, (offset + bytes) & ~(align - 1),
                                  align, align, &tail_qiov, 0);
1745 1746 1747
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1748
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761

        if (!use_local_qiov) {
            qemu_iovec_init(&local_qiov, qiov->niov + 1);
            qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
            use_local_qiov = true;
        }

        tail_bytes = (offset + bytes) & (align - 1);
        qemu_iovec_add(&local_qiov, tail_buf + tail_bytes, align - tail_bytes);

        bytes = ROUND_UP(bytes, align);
    }

1762
    ret = bdrv_aligned_pwritev(child, &req, offset, bytes, align,
1763 1764
                               use_local_qiov ? &local_qiov : qiov,
                               flags);
1765 1766 1767 1768 1769 1770 1771 1772

fail:

    if (use_local_qiov) {
        qemu_iovec_destroy(&local_qiov);
    }
    qemu_vfree(head_buf);
    qemu_vfree(tail_buf);
1773 1774
out:
    tracked_request_end(&req);
1775
    bdrv_dec_in_flight(bs);
1776 1777 1778
    return ret;
}

1779
static int coroutine_fn bdrv_co_do_writev(BdrvChild *child,
1780 1781 1782 1783 1784 1785 1786
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EINVAL;
    }

1787
    return bdrv_co_pwritev(child, sector_num << BDRV_SECTOR_BITS,
1788
                           nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1789 1790
}

1791
int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num,
1792 1793
    int nb_sectors, QEMUIOVector *qiov)
{
1794
    return bdrv_co_do_writev(child, sector_num, nb_sectors, qiov, 0);
1795 1796
}

1797
int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
1798
                                       int bytes, BdrvRequestFlags flags)
1799
{
1800
    trace_bdrv_co_pwrite_zeroes(child->bs, offset, bytes, flags);
1801

1802
    if (!(child->bs->open_flags & BDRV_O_UNMAP)) {
1803 1804 1805
        flags &= ~BDRV_REQ_MAY_UNMAP;
    }

1806
    return bdrv_co_pwritev(child, offset, bytes, NULL,
1807
                           BDRV_REQ_ZERO_WRITE | flags);
1808 1809
}

J
John Snow 已提交
1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
/*
 * Flush ALL BDSes regardless of if they are reachable via a BlkBackend or not.
 */
int bdrv_flush_all(void)
{
    BdrvNextIterator it;
    BlockDriverState *bs = NULL;
    int result = 0;

    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
        AioContext *aio_context = bdrv_get_aio_context(bs);
        int ret;

        aio_context_acquire(aio_context);
        ret = bdrv_flush(bs);
        if (ret < 0 && !result) {
            result = ret;
        }
        aio_context_release(aio_context);
    }

    return result;
}


1835
typedef struct BdrvCoBlockStatusData {
1836 1837
    BlockDriverState *bs;
    BlockDriverState *base;
1838
    bool want_zero;
1839 1840 1841 1842
    int64_t offset;
    int64_t bytes;
    int64_t *pnum;
    int64_t *map;
1843
    BlockDriverState **file;
1844
    int ret;
1845
    bool done;
1846
} BdrvCoBlockStatusData;
1847

1848 1849 1850 1851 1852 1853 1854
int coroutine_fn bdrv_co_block_status_from_file(BlockDriverState *bs,
                                                bool want_zero,
                                                int64_t offset,
                                                int64_t bytes,
                                                int64_t *pnum,
                                                int64_t *map,
                                                BlockDriverState **file)
1855 1856
{
    assert(bs->file && bs->file->bs);
1857 1858
    *pnum = bytes;
    *map = offset;
1859
    *file = bs->file->bs;
1860
    return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID;
1861 1862
}

1863 1864 1865 1866 1867 1868 1869
int coroutine_fn bdrv_co_block_status_from_backing(BlockDriverState *bs,
                                                   bool want_zero,
                                                   int64_t offset,
                                                   int64_t bytes,
                                                   int64_t *pnum,
                                                   int64_t *map,
                                                   BlockDriverState **file)
1870 1871
{
    assert(bs->backing && bs->backing->bs);
1872 1873
    *pnum = bytes;
    *map = offset;
1874
    *file = bs->backing->bs;
1875
    return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID;
1876 1877
}

1878 1879 1880 1881 1882
/*
 * Returns the allocation status of the specified sectors.
 * Drivers not implementing the functionality are assumed to not support
 * backing files, hence all their sectors are reported as allocated.
 *
1883 1884 1885 1886
 * If 'want_zero' is true, the caller is querying for mapping
 * purposes, with a focus on valid BDRV_BLOCK_OFFSET_VALID, _DATA, and
 * _ZERO where possible; otherwise, the result favors larger 'pnum',
 * with a focus on accurate BDRV_BLOCK_ALLOCATED.
1887
 *
1888
 * If 'offset' is beyond the end of the disk image the return value is
1889
 * BDRV_BLOCK_EOF and 'pnum' is set to 0.
1890
 *
1891
 * 'bytes' is the max value 'pnum' should be set to.  If bytes goes
1892 1893
 * beyond the end of the disk image it will be clamped; if 'pnum' is set to
 * the end of the image, then the returned value will include BDRV_BLOCK_EOF.
1894
 *
1895 1896 1897 1898 1899 1900 1901 1902 1903
 * 'pnum' is set to the number of bytes (including and immediately
 * following the specified offset) that are easily known to be in the
 * same allocated/unallocated state.  Note that a second call starting
 * at the original offset plus returned pnum may have the same status.
 * The returned value is non-zero on success except at end-of-file.
 *
 * Returns negative errno on failure.  Otherwise, if the
 * BDRV_BLOCK_OFFSET_VALID bit is set, 'map' and 'file' (if non-NULL) are
 * set to the host mapping and BDS corresponding to the guest offset.
1904
 */
1905 1906 1907 1908 1909 1910 1911 1912
static int coroutine_fn bdrv_co_block_status(BlockDriverState *bs,
                                             bool want_zero,
                                             int64_t offset, int64_t bytes,
                                             int64_t *pnum, int64_t *map,
                                             BlockDriverState **file)
{
    int64_t total_size;
    int64_t n; /* bytes */
E
Eric Blake 已提交
1913
    int ret;
1914
    int64_t local_map = 0;
1915
    BlockDriverState *local_file = NULL;
E
Eric Blake 已提交
1916 1917
    int64_t aligned_offset, aligned_bytes;
    uint32_t align;
1918

1919 1920
    assert(pnum);
    *pnum = 0;
1921 1922 1923
    total_size = bdrv_getlength(bs);
    if (total_size < 0) {
        ret = total_size;
1924
        goto early_out;
1925 1926
    }

1927
    if (offset >= total_size) {
1928 1929
        ret = BDRV_BLOCK_EOF;
        goto early_out;
1930
    }
1931
    if (!bytes) {
1932 1933
        ret = 0;
        goto early_out;
1934
    }
1935

1936 1937 1938
    n = total_size - offset;
    if (n < bytes) {
        bytes = n;
1939 1940
    }

M
Max Reitz 已提交
1941 1942
    /* Must be non-NULL or bdrv_getlength() would have failed */
    assert(bs->drv);
1943
    if (!bs->drv->bdrv_co_block_status) {
1944
        *pnum = bytes;
1945
        ret = BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED;
1946
        if (offset + bytes == total_size) {
1947 1948
            ret |= BDRV_BLOCK_EOF;
        }
1949
        if (bs->drv->protocol_name) {
1950 1951
            ret |= BDRV_BLOCK_OFFSET_VALID;
            local_map = offset;
1952
            local_file = bs;
1953
        }
1954
        goto early_out;
1955 1956
    }

1957
    bdrv_inc_in_flight(bs);
E
Eric Blake 已提交
1958 1959

    /* Round out to request_alignment boundaries */
1960
    align = bs->bl.request_alignment;
E
Eric Blake 已提交
1961 1962 1963
    aligned_offset = QEMU_ALIGN_DOWN(offset, align);
    aligned_bytes = ROUND_UP(offset + bytes, align) - aligned_offset;

1964 1965 1966 1967 1968 1969
    ret = bs->drv->bdrv_co_block_status(bs, want_zero, aligned_offset,
                                        aligned_bytes, pnum, &local_map,
                                        &local_file);
    if (ret < 0) {
        *pnum = 0;
        goto out;
E
Eric Blake 已提交
1970 1971
    }

1972
    /*
1973
     * The driver's result must be a non-zero multiple of request_alignment.
E
Eric Blake 已提交
1974
     * Clamp pnum and adjust map to original request.
1975
     */
1976 1977
    assert(*pnum && QEMU_IS_ALIGNED(*pnum, align) &&
           align > offset - aligned_offset);
E
Eric Blake 已提交
1978 1979 1980
    *pnum -= offset - aligned_offset;
    if (*pnum > bytes) {
        *pnum = bytes;
1981
    }
1982
    if (ret & BDRV_BLOCK_OFFSET_VALID) {
E
Eric Blake 已提交
1983
        local_map += offset - aligned_offset;
1984
    }
1985 1986

    if (ret & BDRV_BLOCK_RAW) {
1987
        assert(ret & BDRV_BLOCK_OFFSET_VALID && local_file);
1988 1989
        ret = bdrv_co_block_status(local_file, want_zero, local_map,
                                   *pnum, pnum, &local_map, &local_file);
1990
        goto out;
1991 1992 1993 1994
    }

    if (ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ZERO)) {
        ret |= BDRV_BLOCK_ALLOCATED;
1995
    } else if (want_zero) {
1996 1997
        if (bdrv_unallocated_blocks_are_zero(bs)) {
            ret |= BDRV_BLOCK_ZERO;
1998 1999
        } else if (bs->backing) {
            BlockDriverState *bs2 = bs->backing->bs;
2000
            int64_t size2 = bdrv_getlength(bs2);
2001

2002
            if (size2 >= 0 && offset >= size2) {
2003 2004 2005 2006 2007
                ret |= BDRV_BLOCK_ZERO;
            }
        }
    }

2008
    if (want_zero && local_file && local_file != bs &&
2009 2010
        (ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO) &&
        (ret & BDRV_BLOCK_OFFSET_VALID)) {
2011 2012
        int64_t file_pnum;
        int ret2;
2013

2014 2015
        ret2 = bdrv_co_block_status(local_file, want_zero, local_map,
                                    *pnum, &file_pnum, NULL, NULL);
2016 2017 2018 2019
        if (ret2 >= 0) {
            /* Ignore errors.  This is just providing extra information, it
             * is useful but not necessary.
             */
2020 2021 2022 2023 2024 2025 2026
            if (ret2 & BDRV_BLOCK_EOF &&
                (!file_pnum || ret2 & BDRV_BLOCK_ZERO)) {
                /*
                 * It is valid for the format block driver to read
                 * beyond the end of the underlying file's current
                 * size; such areas read as zero.
                 */
2027 2028 2029 2030 2031 2032 2033 2034 2035
                ret |= BDRV_BLOCK_ZERO;
            } else {
                /* Limit request to the range reported by the protocol driver */
                *pnum = file_pnum;
                ret |= (ret2 & BDRV_BLOCK_ZERO);
            }
        }
    }

2036 2037
out:
    bdrv_dec_in_flight(bs);
2038
    if (ret >= 0 && offset + *pnum == total_size) {
2039 2040
        ret |= BDRV_BLOCK_EOF;
    }
2041 2042 2043 2044
early_out:
    if (file) {
        *file = local_file;
    }
2045 2046 2047
    if (map) {
        *map = local_map;
    }
2048 2049 2050
    return ret;
}

2051 2052 2053 2054 2055 2056 2057 2058
static int coroutine_fn bdrv_co_block_status_above(BlockDriverState *bs,
                                                   BlockDriverState *base,
                                                   bool want_zero,
                                                   int64_t offset,
                                                   int64_t bytes,
                                                   int64_t *pnum,
                                                   int64_t *map,
                                                   BlockDriverState **file)
2059 2060
{
    BlockDriverState *p;
2061
    int ret = 0;
2062
    bool first = true;
2063 2064

    assert(bs != base);
2065
    for (p = bs; p != base; p = backing_bs(p)) {
2066 2067
        ret = bdrv_co_block_status(p, want_zero, offset, bytes, pnum, map,
                                   file);
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077
        if (ret < 0) {
            break;
        }
        if (ret & BDRV_BLOCK_ZERO && ret & BDRV_BLOCK_EOF && !first) {
            /*
             * Reading beyond the end of the file continues to read
             * zeroes, but we can only widen the result to the
             * unallocated length we learned from an earlier
             * iteration.
             */
2078
            *pnum = bytes;
2079 2080
        }
        if (ret & (BDRV_BLOCK_ZERO | BDRV_BLOCK_DATA)) {
2081 2082
            break;
        }
2083 2084 2085
        /* [offset, pnum] unallocated on this layer, which could be only
         * the first part of [offset, bytes].  */
        bytes = MIN(bytes, *pnum);
2086
        first = false;
2087 2088 2089 2090
    }
    return ret;
}

2091
/* Coroutine wrapper for bdrv_block_status_above() */
2092
static void coroutine_fn bdrv_block_status_above_co_entry(void *opaque)
2093
{
2094
    BdrvCoBlockStatusData *data = opaque;
2095

2096 2097 2098 2099
    data->ret = bdrv_co_block_status_above(data->bs, data->base,
                                           data->want_zero,
                                           data->offset, data->bytes,
                                           data->pnum, data->map, data->file);
2100 2101 2102 2103
    data->done = true;
}

/*
2104
 * Synchronous wrapper around bdrv_co_block_status_above().
2105
 *
2106
 * See bdrv_co_block_status_above() for details.
2107
 */
2108 2109 2110 2111 2112 2113
static int bdrv_common_block_status_above(BlockDriverState *bs,
                                          BlockDriverState *base,
                                          bool want_zero, int64_t offset,
                                          int64_t bytes, int64_t *pnum,
                                          int64_t *map,
                                          BlockDriverState **file)
2114 2115
{
    Coroutine *co;
2116
    BdrvCoBlockStatusData data = {
2117
        .bs = bs,
2118
        .base = base,
2119
        .want_zero = want_zero,
2120 2121 2122 2123
        .offset = offset,
        .bytes = bytes,
        .pnum = pnum,
        .map = map,
2124
        .file = file,
2125 2126 2127 2128 2129
        .done = false,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2130
        bdrv_block_status_above_co_entry(&data);
2131
    } else {
2132
        co = qemu_coroutine_create(bdrv_block_status_above_co_entry, &data);
2133
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2134
        BDRV_POLL_WHILE(bs, !data.done);
2135
    }
2136
    return data.ret;
2137 2138
}

2139 2140 2141
int bdrv_block_status_above(BlockDriverState *bs, BlockDriverState *base,
                            int64_t offset, int64_t bytes, int64_t *pnum,
                            int64_t *map, BlockDriverState **file)
2142
{
2143 2144
    return bdrv_common_block_status_above(bs, base, true, offset, bytes,
                                          pnum, map, file);
2145 2146
}

2147 2148
int bdrv_block_status(BlockDriverState *bs, int64_t offset, int64_t bytes,
                      int64_t *pnum, int64_t *map, BlockDriverState **file)
2149
{
2150 2151
    return bdrv_block_status_above(bs, backing_bs(bs),
                                   offset, bytes, pnum, map, file);
2152 2153
}

2154 2155
int coroutine_fn bdrv_is_allocated(BlockDriverState *bs, int64_t offset,
                                   int64_t bytes, int64_t *pnum)
2156
{
2157 2158
    int ret;
    int64_t dummy;
2159

2160 2161
    ret = bdrv_common_block_status_above(bs, backing_bs(bs), false, offset,
                                         bytes, pnum ? pnum : &dummy, NULL,
2162
                                         NULL);
2163 2164 2165 2166 2167 2168 2169 2170 2171
    if (ret < 0) {
        return ret;
    }
    return !!(ret & BDRV_BLOCK_ALLOCATED);
}

/*
 * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
 *
2172 2173 2174
 * Return true if (a prefix of) the given range is allocated in any image
 * between BASE and TOP (inclusive).  BASE can be NULL to check if the given
 * offset is allocated in any image of the chain.  Return false otherwise,
2175
 * or negative errno on failure.
2176
 *
2177 2178 2179 2180 2181 2182
 * 'pnum' is set to the number of bytes (including and immediately
 * following the specified offset) that are known to be in the same
 * allocated/unallocated state.  Note that a subsequent call starting
 * at 'offset + *pnum' may return the same allocation status (in other
 * words, the result is not necessarily the maximum possible range);
 * but 'pnum' will only be 0 when end of file is reached.
2183 2184 2185 2186
 *
 */
int bdrv_is_allocated_above(BlockDriverState *top,
                            BlockDriverState *base,
2187
                            int64_t offset, int64_t bytes, int64_t *pnum)
2188 2189
{
    BlockDriverState *intermediate;
2190 2191
    int ret;
    int64_t n = bytes;
2192 2193 2194

    intermediate = top;
    while (intermediate && intermediate != base) {
2195
        int64_t pnum_inter;
2196
        int64_t size_inter;
2197

2198
        ret = bdrv_is_allocated(intermediate, offset, bytes, &pnum_inter);
2199 2200
        if (ret < 0) {
            return ret;
2201 2202
        }
        if (ret) {
2203
            *pnum = pnum_inter;
2204 2205 2206
            return 1;
        }

2207
        size_inter = bdrv_getlength(intermediate);
2208 2209 2210
        if (size_inter < 0) {
            return size_inter;
        }
2211 2212 2213
        if (n > pnum_inter &&
            (intermediate == top || offset + pnum_inter < size_inter)) {
            n = pnum_inter;
2214 2215
        }

2216
        intermediate = backing_bs(intermediate);
2217 2218 2219 2220 2221 2222
    }

    *pnum = n;
    return 0;
}

2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235
typedef struct BdrvVmstateCo {
    BlockDriverState    *bs;
    QEMUIOVector        *qiov;
    int64_t             pos;
    bool                is_read;
    int                 ret;
} BdrvVmstateCo;

static int coroutine_fn
bdrv_co_rw_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos,
                   bool is_read)
{
    BlockDriver *drv = bs->drv;
2236 2237 2238
    int ret = -ENOTSUP;

    bdrv_inc_in_flight(bs);
2239 2240

    if (!drv) {
2241
        ret = -ENOMEDIUM;
2242
    } else if (drv->bdrv_load_vmstate) {
2243 2244 2245 2246 2247
        if (is_read) {
            ret = drv->bdrv_load_vmstate(bs, qiov, pos);
        } else {
            ret = drv->bdrv_save_vmstate(bs, qiov, pos);
        }
2248
    } else if (bs->file) {
2249
        ret = bdrv_co_rw_vmstate(bs->file->bs, qiov, pos, is_read);
2250 2251
    }

2252 2253
    bdrv_dec_in_flight(bs);
    return ret;
2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275
}

static void coroutine_fn bdrv_co_rw_vmstate_entry(void *opaque)
{
    BdrvVmstateCo *co = opaque;
    co->ret = bdrv_co_rw_vmstate(co->bs, co->qiov, co->pos, co->is_read);
}

static inline int
bdrv_rw_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos,
                bool is_read)
{
    if (qemu_in_coroutine()) {
        return bdrv_co_rw_vmstate(bs, qiov, pos, is_read);
    } else {
        BdrvVmstateCo data = {
            .bs         = bs,
            .qiov       = qiov,
            .pos        = pos,
            .is_read    = is_read,
            .ret        = -EINPROGRESS,
        };
2276
        Coroutine *co = qemu_coroutine_create(bdrv_co_rw_vmstate_entry, &data);
2277

2278
        bdrv_coroutine_enter(bs, co);
2279
        BDRV_POLL_WHILE(bs, data.ret == -EINPROGRESS);
2280 2281 2282 2283
        return data.ret;
    }
}

2284 2285 2286 2287 2288 2289 2290 2291
int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
                      int64_t pos, int size)
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = (void *) buf,
        .iov_len    = size,
    };
2292
    int ret;
2293 2294

    qemu_iovec_init_external(&qiov, &iov, 1);
2295 2296 2297 2298 2299 2300 2301

    ret = bdrv_writev_vmstate(bs, &qiov, pos);
    if (ret < 0) {
        return ret;
    }

    return size;
2302 2303 2304 2305
}

int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
{
2306
    return bdrv_rw_vmstate(bs, qiov, pos, false);
2307 2308 2309 2310
}

int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size)
2311 2312 2313 2314 2315 2316
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = buf,
        .iov_len    = size,
    };
2317
    int ret;
2318 2319

    qemu_iovec_init_external(&qiov, &iov, 1);
2320 2321 2322 2323 2324 2325
    ret = bdrv_readv_vmstate(bs, &qiov, pos);
    if (ret < 0) {
        return ret;
    }

    return size;
2326 2327 2328
}

int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
2329
{
2330
    return bdrv_rw_vmstate(bs, qiov, pos, true);
2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343
}

/**************************************************************/
/* async I/Os */

void bdrv_aio_cancel(BlockAIOCB *acb)
{
    qemu_aio_ref(acb);
    bdrv_aio_cancel_async(acb);
    while (acb->refcnt > 1) {
        if (acb->aiocb_info->get_aio_context) {
            aio_poll(acb->aiocb_info->get_aio_context(acb), true);
        } else if (acb->bs) {
2344 2345 2346 2347 2348
            /* qemu_aio_ref and qemu_aio_unref are not thread-safe, so
             * assert that we're not using an I/O thread.  Thread-safe
             * code should use bdrv_aio_cancel_async exclusively.
             */
            assert(bdrv_get_aio_context(acb->bs) == qemu_get_aio_context());
2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369
            aio_poll(bdrv_get_aio_context(acb->bs), true);
        } else {
            abort();
        }
    }
    qemu_aio_unref(acb);
}

/* Async version of aio cancel. The caller is not blocked if the acb implements
 * cancel_async, otherwise we do nothing and let the request normally complete.
 * In either case the completion callback must be called. */
void bdrv_aio_cancel_async(BlockAIOCB *acb)
{
    if (acb->aiocb_info->cancel_async) {
        acb->aiocb_info->cancel_async(acb);
    }
}

/**************************************************************/
/* Coroutine block device emulation */

2370 2371 2372 2373 2374 2375
typedef struct FlushCo {
    BlockDriverState *bs;
    int ret;
} FlushCo;


2376 2377
static void coroutine_fn bdrv_flush_co_entry(void *opaque)
{
2378
    FlushCo *rwco = opaque;
2379 2380 2381 2382 2383 2384

    rwco->ret = bdrv_co_flush(rwco->bs);
}

int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
{
2385 2386 2387 2388
    int current_gen;
    int ret = 0;

    bdrv_inc_in_flight(bs);
2389

2390
    if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs) ||
2391
        bdrv_is_sg(bs)) {
2392
        goto early_exit;
2393 2394
    }

2395
    qemu_co_mutex_lock(&bs->reqs_lock);
2396
    current_gen = atomic_read(&bs->write_gen);
2397 2398

    /* Wait until any previous flushes are completed */
2399
    while (bs->active_flush_req) {
2400
        qemu_co_queue_wait(&bs->flush_queue, &bs->reqs_lock);
2401 2402
    }

2403
    /* Flushes reach this point in nondecreasing current_gen order.  */
2404
    bs->active_flush_req = true;
2405
    qemu_co_mutex_unlock(&bs->reqs_lock);
2406

P
Pavel Dovgalyuk 已提交
2407 2408 2409 2410 2411 2412
    /* Write back all layers by calling one driver function */
    if (bs->drv->bdrv_co_flush) {
        ret = bs->drv->bdrv_co_flush(bs);
        goto out;
    }

2413 2414 2415 2416 2417
    /* Write back cached data to the OS even with cache=unsafe */
    BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_OS);
    if (bs->drv->bdrv_co_flush_to_os) {
        ret = bs->drv->bdrv_co_flush_to_os(bs);
        if (ret < 0) {
F
Fam Zheng 已提交
2418
            goto out;
2419 2420 2421 2422 2423 2424 2425 2426
        }
    }

    /* But don't actually force it to the disk with cache=unsafe */
    if (bs->open_flags & BDRV_O_NO_FLUSH) {
        goto flush_parent;
    }

2427 2428 2429 2430 2431
    /* Check if we really need to flush anything */
    if (bs->flushed_gen == current_gen) {
        goto flush_parent;
    }

2432
    BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_DISK);
M
Max Reitz 已提交
2433 2434 2435 2436 2437 2438
    if (!bs->drv) {
        /* bs->drv->bdrv_co_flush() might have ejected the BDS
         * (even in case of apparent success) */
        ret = -ENOMEDIUM;
        goto out;
    }
2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467
    if (bs->drv->bdrv_co_flush_to_disk) {
        ret = bs->drv->bdrv_co_flush_to_disk(bs);
    } else if (bs->drv->bdrv_aio_flush) {
        BlockAIOCB *acb;
        CoroutineIOCompletion co = {
            .coroutine = qemu_coroutine_self(),
        };

        acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
        if (acb == NULL) {
            ret = -EIO;
        } else {
            qemu_coroutine_yield();
            ret = co.ret;
        }
    } else {
        /*
         * Some block drivers always operate in either writethrough or unsafe
         * mode and don't support bdrv_flush therefore. Usually qemu doesn't
         * know how the server works (because the behaviour is hardcoded or
         * depends on server-side configuration), so we can't ensure that
         * everything is safe on disk. Returning an error doesn't work because
         * that would break guests even if the server operates in writethrough
         * mode.
         *
         * Let's hope the user knows what he's doing.
         */
        ret = 0;
    }
2468

2469
    if (ret < 0) {
F
Fam Zheng 已提交
2470
        goto out;
2471 2472 2473 2474 2475 2476
    }

    /* Now flush the underlying protocol.  It will also have BDRV_O_NO_FLUSH
     * in the case of cache=unsafe, so there are no useless flushes.
     */
flush_parent:
F
Fam Zheng 已提交
2477 2478
    ret = bs->file ? bdrv_co_flush(bs->file->bs) : 0;
out:
2479
    /* Notify any pending flushes that we have completed */
2480 2481 2482
    if (ret == 0) {
        bs->flushed_gen = current_gen;
    }
2483 2484

    qemu_co_mutex_lock(&bs->reqs_lock);
2485
    bs->active_flush_req = false;
2486 2487
    /* Return value is ignored - it's ok if wait queue is empty */
    qemu_co_queue_next(&bs->flush_queue);
2488
    qemu_co_mutex_unlock(&bs->reqs_lock);
2489

2490
early_exit:
2491
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2492
    return ret;
2493 2494 2495 2496 2497
}

int bdrv_flush(BlockDriverState *bs)
{
    Coroutine *co;
2498
    FlushCo flush_co = {
2499 2500 2501 2502 2503 2504
        .bs = bs,
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2505
        bdrv_flush_co_entry(&flush_co);
2506
    } else {
2507
        co = qemu_coroutine_create(bdrv_flush_co_entry, &flush_co);
2508
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2509
        BDRV_POLL_WHILE(bs, flush_co.ret == NOT_DONE);
2510 2511
    }

2512
    return flush_co.ret;
2513 2514 2515 2516
}

typedef struct DiscardCo {
    BlockDriverState *bs;
2517
    int64_t offset;
2518
    int bytes;
2519 2520
    int ret;
} DiscardCo;
2521
static void coroutine_fn bdrv_pdiscard_co_entry(void *opaque)
2522 2523 2524
{
    DiscardCo *rwco = opaque;

2525
    rwco->ret = bdrv_co_pdiscard(rwco->bs, rwco->offset, rwco->bytes);
2526 2527
}

2528
int coroutine_fn bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset,
2529
                                  int bytes)
2530
{
F
Fam Zheng 已提交
2531
    BdrvTrackedRequest req;
2532
    int max_pdiscard, ret;
2533
    int head, tail, align;
2534 2535 2536 2537 2538

    if (!bs->drv) {
        return -ENOMEDIUM;
    }

2539 2540 2541 2542
    if (bdrv_has_readonly_bitmaps(bs)) {
        return -EPERM;
    }

2543
    ret = bdrv_check_byte_request(bs, offset, bytes);
2544 2545 2546
    if (ret < 0) {
        return ret;
    } else if (bs->read_only) {
2547
        return -EPERM;
2548
    }
2549
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
2550 2551 2552 2553 2554 2555

    /* Do nothing if disabled.  */
    if (!(bs->open_flags & BDRV_O_UNMAP)) {
        return 0;
    }

E
Eric Blake 已提交
2556
    if (!bs->drv->bdrv_co_pdiscard && !bs->drv->bdrv_aio_pdiscard) {
2557 2558 2559
        return 0;
    }

2560 2561 2562 2563 2564
    /* Discard is advisory, but some devices track and coalesce
     * unaligned requests, so we must pass everything down rather than
     * round here.  Still, most devices will just silently ignore
     * unaligned requests (by returning -ENOTSUP), so we must fragment
     * the request accordingly.  */
E
Eric Blake 已提交
2565
    align = MAX(bs->bl.pdiscard_alignment, bs->bl.request_alignment);
2566 2567
    assert(align % bs->bl.request_alignment == 0);
    head = offset % align;
2568
    tail = (offset + bytes) % align;
2569

2570
    bdrv_inc_in_flight(bs);
2571
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_DISCARD);
2572

2573 2574 2575 2576 2577
    ret = notifier_with_return_list_notify(&bs->before_write_notifiers, &req);
    if (ret < 0) {
        goto out;
    }

2578 2579
    max_pdiscard = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_pdiscard, INT_MAX),
                                   align);
2580
    assert(max_pdiscard >= bs->bl.request_alignment);
2581

2582 2583
    while (bytes > 0) {
        int num = bytes;
2584 2585 2586

        if (head) {
            /* Make small requests to get to alignment boundaries. */
2587
            num = MIN(bytes, align - head);
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
            if (!QEMU_IS_ALIGNED(num, bs->bl.request_alignment)) {
                num %= bs->bl.request_alignment;
            }
            head = (head + num) % align;
            assert(num < max_pdiscard);
        } else if (tail) {
            if (num > align) {
                /* Shorten the request to the last aligned cluster.  */
                num -= tail;
            } else if (!QEMU_IS_ALIGNED(tail, bs->bl.request_alignment) &&
                       tail > bs->bl.request_alignment) {
                tail %= bs->bl.request_alignment;
                num -= tail;
            }
        }
        /* limit request size */
        if (num > max_pdiscard) {
            num = max_pdiscard;
        }
2607

M
Max Reitz 已提交
2608 2609 2610 2611
        if (!bs->drv) {
            ret = -ENOMEDIUM;
            goto out;
        }
2612 2613
        if (bs->drv->bdrv_co_pdiscard) {
            ret = bs->drv->bdrv_co_pdiscard(bs, offset, num);
2614 2615 2616 2617 2618 2619
        } else {
            BlockAIOCB *acb;
            CoroutineIOCompletion co = {
                .coroutine = qemu_coroutine_self(),
            };

2620 2621
            acb = bs->drv->bdrv_aio_pdiscard(bs, offset, num,
                                             bdrv_co_io_em_complete, &co);
2622
            if (acb == NULL) {
F
Fam Zheng 已提交
2623 2624
                ret = -EIO;
                goto out;
2625 2626 2627 2628 2629 2630
            } else {
                qemu_coroutine_yield();
                ret = co.ret;
            }
        }
        if (ret && ret != -ENOTSUP) {
F
Fam Zheng 已提交
2631
            goto out;
2632 2633
        }

2634
        offset += num;
2635
        bytes -= num;
2636
    }
F
Fam Zheng 已提交
2637 2638
    ret = 0;
out:
2639
    atomic_inc(&bs->write_gen);
2640
    bdrv_set_dirty(bs, req.offset, req.bytes);
F
Fam Zheng 已提交
2641
    tracked_request_end(&req);
2642
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2643
    return ret;
2644 2645
}

2646
int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2647 2648 2649 2650
{
    Coroutine *co;
    DiscardCo rwco = {
        .bs = bs,
2651
        .offset = offset,
2652
        .bytes = bytes,
2653 2654 2655 2656 2657
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2658
        bdrv_pdiscard_co_entry(&rwco);
2659
    } else {
2660
        co = qemu_coroutine_create(bdrv_pdiscard_co_entry, &rwco);
2661
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2662
        BDRV_POLL_WHILE(bs, rwco.ret == NOT_DONE);
2663 2664 2665 2666 2667
    }

    return rwco.ret;
}

2668
int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf)
2669 2670
{
    BlockDriver *drv = bs->drv;
2671 2672 2673 2674
    CoroutineIOCompletion co = {
        .coroutine = qemu_coroutine_self(),
    };
    BlockAIOCB *acb;
2675

2676
    bdrv_inc_in_flight(bs);
2677
    if (!drv || (!drv->bdrv_aio_ioctl && !drv->bdrv_co_ioctl)) {
2678 2679 2680 2681
        co.ret = -ENOTSUP;
        goto out;
    }

2682 2683 2684 2685 2686 2687 2688 2689 2690
    if (drv->bdrv_co_ioctl) {
        co.ret = drv->bdrv_co_ioctl(bs, req, buf);
    } else {
        acb = drv->bdrv_aio_ioctl(bs, req, buf, bdrv_co_io_em_complete, &co);
        if (!acb) {
            co.ret = -ENOTSUP;
            goto out;
        }
        qemu_coroutine_yield();
2691 2692
    }
out:
2693
    bdrv_dec_in_flight(bs);
2694 2695 2696
    return co.ret;
}

2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736
void *qemu_blockalign(BlockDriverState *bs, size_t size)
{
    return qemu_memalign(bdrv_opt_mem_align(bs), size);
}

void *qemu_blockalign0(BlockDriverState *bs, size_t size)
{
    return memset(qemu_blockalign(bs, size), 0, size);
}

void *qemu_try_blockalign(BlockDriverState *bs, size_t size)
{
    size_t align = bdrv_opt_mem_align(bs);

    /* Ensure that NULL is never returned on success */
    assert(align > 0);
    if (size == 0) {
        size = align;
    }

    return qemu_try_memalign(align, size);
}

void *qemu_try_blockalign0(BlockDriverState *bs, size_t size)
{
    void *mem = qemu_try_blockalign(bs, size);

    if (mem) {
        memset(mem, 0, size);
    }

    return mem;
}

/*
 * Check if all memory in this vector is sector aligned.
 */
bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov)
{
    int i;
2737
    size_t alignment = bdrv_min_mem_align(bs);
2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758

    for (i = 0; i < qiov->niov; i++) {
        if ((uintptr_t) qiov->iov[i].iov_base % alignment) {
            return false;
        }
        if (qiov->iov[i].iov_len % alignment) {
            return false;
        }
    }

    return true;
}

void bdrv_add_before_write_notifier(BlockDriverState *bs,
                                    NotifierWithReturn *notifier)
{
    notifier_with_return_list_add(&bs->before_write_notifiers, notifier);
}

void bdrv_io_plug(BlockDriverState *bs)
{
2759 2760 2761 2762 2763 2764
    BdrvChild *child;

    QLIST_FOREACH(child, &bs->children, next) {
        bdrv_io_plug(child->bs);
    }

2765
    if (atomic_fetch_inc(&bs->io_plugged) == 0) {
2766 2767 2768 2769
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_plug) {
            drv->bdrv_io_plug(bs);
        }
2770 2771 2772 2773 2774
    }
}

void bdrv_io_unplug(BlockDriverState *bs)
{
2775 2776 2777
    BdrvChild *child;

    assert(bs->io_plugged);
2778
    if (atomic_fetch_dec(&bs->io_plugged) == 1) {
2779 2780 2781 2782 2783 2784 2785 2786
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_unplug) {
            drv->bdrv_io_unplug(bs);
        }
    }

    QLIST_FOREACH(child, &bs->children, next) {
        bdrv_io_unplug(child->bs);
2787 2788
    }
}
F
Fam Zheng 已提交
2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812

void bdrv_register_buf(BlockDriverState *bs, void *host, size_t size)
{
    BdrvChild *child;

    if (bs->drv && bs->drv->bdrv_register_buf) {
        bs->drv->bdrv_register_buf(bs, host, size);
    }
    QLIST_FOREACH(child, &bs->children, next) {
        bdrv_register_buf(child->bs, host, size);
    }
}

void bdrv_unregister_buf(BlockDriverState *bs, void *host)
{
    BdrvChild *child;

    if (bs->drv && bs->drv->bdrv_unregister_buf) {
        bs->drv->bdrv_unregister_buf(bs, host);
    }
    QLIST_FOREACH(child, &bs->children, next) {
        bdrv_unregister_buf(child->bs, host);
    }
}
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909

static int coroutine_fn bdrv_co_copy_range_internal(BdrvChild *src,
                                                    uint64_t src_offset,
                                                    BdrvChild *dst,
                                                    uint64_t dst_offset,
                                                    uint64_t bytes,
                                                    BdrvRequestFlags flags,
                                                    bool recurse_src)
{
    int ret;

    if (!src || !dst || !src->bs || !dst->bs) {
        return -ENOMEDIUM;
    }
    ret = bdrv_check_byte_request(src->bs, src_offset, bytes);
    if (ret) {
        return ret;
    }

    ret = bdrv_check_byte_request(dst->bs, dst_offset, bytes);
    if (ret) {
        return ret;
    }
    if (flags & BDRV_REQ_ZERO_WRITE) {
        return bdrv_co_pwrite_zeroes(dst, dst_offset, bytes, flags);
    }

    if (!src->bs->drv->bdrv_co_copy_range_from
        || !dst->bs->drv->bdrv_co_copy_range_to
        || src->bs->encrypted || dst->bs->encrypted) {
        return -ENOTSUP;
    }
    if (recurse_src) {
        return src->bs->drv->bdrv_co_copy_range_from(src->bs,
                                                     src, src_offset,
                                                     dst, dst_offset,
                                                     bytes, flags);
    } else {
        return dst->bs->drv->bdrv_co_copy_range_to(dst->bs,
                                                   src, src_offset,
                                                   dst, dst_offset,
                                                   bytes, flags);
    }
}

/* Copy range from @src to @dst.
 *
 * See the comment of bdrv_co_copy_range for the parameter and return value
 * semantics. */
int coroutine_fn bdrv_co_copy_range_from(BdrvChild *src, uint64_t src_offset,
                                         BdrvChild *dst, uint64_t dst_offset,
                                         uint64_t bytes, BdrvRequestFlags flags)
{
    return bdrv_co_copy_range_internal(src, src_offset, dst, dst_offset,
                                       bytes, flags, true);
}

/* Copy range from @src to @dst.
 *
 * See the comment of bdrv_co_copy_range for the parameter and return value
 * semantics. */
int coroutine_fn bdrv_co_copy_range_to(BdrvChild *src, uint64_t src_offset,
                                       BdrvChild *dst, uint64_t dst_offset,
                                       uint64_t bytes, BdrvRequestFlags flags)
{
    return bdrv_co_copy_range_internal(src, src_offset, dst, dst_offset,
                                       bytes, flags, false);
}

int coroutine_fn bdrv_co_copy_range(BdrvChild *src, uint64_t src_offset,
                                    BdrvChild *dst, uint64_t dst_offset,
                                    uint64_t bytes, BdrvRequestFlags flags)
{
    BdrvTrackedRequest src_req, dst_req;
    BlockDriverState *src_bs = src->bs;
    BlockDriverState *dst_bs = dst->bs;
    int ret;

    bdrv_inc_in_flight(src_bs);
    bdrv_inc_in_flight(dst_bs);
    tracked_request_begin(&src_req, src_bs, src_offset,
                          bytes, BDRV_TRACKED_READ);
    tracked_request_begin(&dst_req, dst_bs, dst_offset,
                          bytes, BDRV_TRACKED_WRITE);

    wait_serialising_requests(&src_req);
    wait_serialising_requests(&dst_req);
    ret = bdrv_co_copy_range_from(src, src_offset,
                                  dst, dst_offset,
                                  bytes, flags);

    tracked_request_end(&src_req);
    tracked_request_end(&dst_req);
    bdrv_dec_in_flight(src_bs);
    bdrv_dec_in_flight(dst_bs);
    return ret;
}