io.c 82.0 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/blockjob.h"
29
#include "block/blockjob_int.h"
30
#include "block/block_int.h"
31
#include "qemu/cutils.h"
32
#include "qapi/error.h"
33
#include "qemu/error-report.h"
34 35 36

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

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

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

43
void bdrv_parent_drained_begin(BlockDriverState *bs)
44
{
45
    BdrvChild *c;
46

47 48 49 50
    QLIST_FOREACH(c, &bs->parents, next_parent) {
        if (c->role->drained_begin) {
            c->role->drained_begin(c);
        }
51 52
    }
}
53

54
void bdrv_parent_drained_end(BlockDriverState *bs)
55
{
56
    BdrvChild *c;
57

58 59 60 61
    QLIST_FOREACH(c, &bs->parents, next_parent) {
        if (c->role->drained_end) {
            c->role->drained_end(c);
        }
62
    }
63 64
}

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

76 77 78 79 80 81 82 83 84 85 86
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;
    }

87
    /* Default alignment based on whether driver has byte interface */
88
    bs->bl.request_alignment = drv->bdrv_co_preadv ? 1 : 512;
89

90 91
    /* Take some limits from the children as a default */
    if (bs->file) {
K
Kevin Wolf 已提交
92
        bdrv_refresh_limits(bs->file->bs, &local_err);
93 94 95 96
        if (local_err) {
            error_propagate(errp, local_err);
            return;
        }
97
        bdrv_merge_limits(&bs->bl, &bs->file->bs->bl);
98
    } else {
99
        bs->bl.min_mem_alignment = 512;
100
        bs->bl.opt_mem_alignment = getpagesize();
101 102 103

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

106 107
    if (bs->backing) {
        bdrv_refresh_limits(bs->backing->bs, &local_err);
108 109 110 111
        if (local_err) {
            error_propagate(errp, local_err);
            return;
        }
112
        bdrv_merge_limits(&bs->bl, &bs->backing->bs->bl);
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    }

    /* 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)
{
128
    atomic_inc(&bs->copy_on_read);
129 130 131 132
}

void bdrv_disable_copy_on_read(BlockDriverState *bs)
{
133 134
    int old = atomic_fetch_dec(&bs->copy_on_read);
    assert(old >= 1);
135 136 137
}

/* Check if any requests are in-flight (including throttled requests) */
138
bool bdrv_requests_pending(BlockDriverState *bs)
139
{
140 141
    BdrvChild *child;

142
    if (atomic_read(&bs->in_flight)) {
143 144
        return true;
    }
145 146 147 148 149

    QLIST_FOREACH(child, &bs->children, next) {
        if (bdrv_requests_pending(child->bs)) {
            return true;
        }
150
    }
151

152 153 154
    return false;
}

155 156 157 158
typedef struct {
    Coroutine *co;
    BlockDriverState *bs;
    bool done;
159
    bool begin;
160 161 162 163 164 165 166
} BdrvCoDrainData;

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

167
    if (data->begin) {
168
        bs->drv->bdrv_co_drain_begin(bs);
169 170 171
    } else {
        bs->drv->bdrv_co_drain_end(bs);
    }
172 173 174 175 176 177

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

178
static void bdrv_drain_invoke(BlockDriverState *bs, bool begin)
179
{
180
    BdrvCoDrainData data = { .bs = bs, .done = false, .begin = begin};
181

182
    if (!bs->drv || (begin && !bs->drv->bdrv_co_drain_begin) ||
183
            (!begin && !bs->drv->bdrv_co_drain_end)) {
184 185 186 187 188 189 190 191
        return;
    }

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

192
static bool bdrv_drain_recurse(BlockDriverState *bs, bool begin)
193
{
194
    BdrvChild *child, *tmp;
195 196
    bool waited;

197
    /* Ensure any pending metadata writes are submitted to bs->file.  */
198 199 200 201
    bdrv_drain_invoke(bs, begin);

    /* Wait for drained requests to finish */
    waited = BDRV_POLL_WHILE(bs, atomic_read(&bs->in_flight) > 0);
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
    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);
        }
218
        waited |= bdrv_drain_recurse(bs, begin);
219 220 221
        if (in_main_loop) {
            bdrv_unref(bs);
        }
222
    }
223 224

    return waited;
225 226
}

F
Fam Zheng 已提交
227 228 229 230
static void bdrv_co_drain_bh_cb(void *opaque)
{
    BdrvCoDrainData *data = opaque;
    Coroutine *co = data->co;
231
    BlockDriverState *bs = data->bs;
F
Fam Zheng 已提交
232

233
    bdrv_dec_in_flight(bs);
234 235 236 237 238 239
    if (data->begin) {
        bdrv_drained_begin(bs);
    } else {
        bdrv_drained_end(bs);
    }

F
Fam Zheng 已提交
240
    data->done = true;
241
    aio_co_wake(co);
F
Fam Zheng 已提交
242 243
}

244 245
static void coroutine_fn bdrv_co_yield_to_drain(BlockDriverState *bs,
                                                bool begin)
F
Fam Zheng 已提交
246 247 248 249 250 251 252 253 254 255 256 257
{
    BdrvCoDrainData data;

    /* Calling bdrv_drain() from a BH ensures the current coroutine yields and
     * other coroutines run if they were queued from
     * qemu_co_queue_run_restart(). */

    assert(qemu_in_coroutine());
    data = (BdrvCoDrainData) {
        .co = qemu_coroutine_self(),
        .bs = bs,
        .done = false,
258
        .begin = begin,
F
Fam Zheng 已提交
259
    };
260
    bdrv_inc_in_flight(bs);
P
Paolo Bonzini 已提交
261 262
    aio_bh_schedule_oneshot(bdrv_get_aio_context(bs),
                            bdrv_co_drain_bh_cb, &data);
F
Fam Zheng 已提交
263 264 265 266 267 268 269

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

270 271
void bdrv_drained_begin(BlockDriverState *bs)
{
272
    if (qemu_in_coroutine()) {
273
        bdrv_co_yield_to_drain(bs, true);
274 275 276
        return;
    }

277
    if (atomic_fetch_inc(&bs->quiesce_counter) == 0) {
278 279 280 281
        aio_disable_external(bdrv_get_aio_context(bs));
        bdrv_parent_drained_begin(bs);
    }

282
    bdrv_drain_recurse(bs, true);
283 284 285 286
}

void bdrv_drained_end(BlockDriverState *bs)
{
287 288 289 290
    if (qemu_in_coroutine()) {
        bdrv_co_yield_to_drain(bs, false);
        return;
    }
291
    assert(bs->quiesce_counter > 0);
292
    if (atomic_fetch_dec(&bs->quiesce_counter) > 1) {
293 294 295 296
        return;
    }

    bdrv_parent_drained_end(bs);
297
    bdrv_drain_recurse(bs, false);
298 299 300
    aio_enable_external(bdrv_get_aio_context(bs));
}

301
/*
302 303
 * Wait for pending requests to complete on a single BlockDriverState subtree,
 * and suspend block driver's internal I/O until next request arrives.
304 305 306
 *
 * Note that unlike bdrv_drain_all(), the caller must hold the BlockDriverState
 * AioContext.
307 308 309 310
 *
 * Only this BlockDriverState's AioContext is run, so in-flight requests must
 * not depend on events in other AioContexts.  In that case, use
 * bdrv_drain_all() instead.
311
 */
312
void coroutine_fn bdrv_co_drain(BlockDriverState *bs)
313
{
314 315 316
    assert(qemu_in_coroutine());
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
317
}
318

319 320
void bdrv_drain(BlockDriverState *bs)
{
321 322
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
323 324 325 326 327 328 329
}

/*
 * 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.
330 331 332 333 334 335
 *
 * 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.
336
 */
337
void bdrv_drain_all_begin(void)
338 339
{
    /* Always run first iteration so any pending completion BHs run */
340
    bool waited = true;
K
Kevin Wolf 已提交
341
    BlockDriverState *bs;
K
Kevin Wolf 已提交
342
    BdrvNextIterator it;
343
    GSList *aio_ctxs = NULL, *ctx;
344

345
    block_job_pause_all();
346

K
Kevin Wolf 已提交
347
    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
348 349 350
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
351
        bdrv_parent_drained_begin(bs);
352
        aio_disable_external(aio_context);
353
        aio_context_release(aio_context);
354

355
        if (!g_slist_find(aio_ctxs, aio_context)) {
356 357
            aio_ctxs = g_slist_prepend(aio_ctxs, aio_context);
        }
358 359
    }

360 361 362 363 364 365
    /* Note that completion of an asynchronous I/O operation can trigger any
     * number of other I/O operations on other devices---for example a
     * coroutine can submit an I/O request to another device in response to
     * request completion.  Therefore we must keep looping until there was no
     * more activity rather than simply draining each device independently.
     */
366 367
    while (waited) {
        waited = false;
368

369 370
        for (ctx = aio_ctxs; ctx != NULL; ctx = ctx->next) {
            AioContext *aio_context = ctx->data;
371 372

            aio_context_acquire(aio_context);
K
Kevin Wolf 已提交
373
            for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
374
                if (aio_context == bdrv_get_aio_context(bs)) {
375
                    waited |= bdrv_drain_recurse(bs, true);
376 377
                }
            }
378 379 380 381
            aio_context_release(aio_context);
        }
    }

382 383 384 385 386 387 388 389
    g_slist_free(aio_ctxs);
}

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

K
Kevin Wolf 已提交
390
    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
391 392 393
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
394
        aio_enable_external(aio_context);
395
        bdrv_parent_drained_end(bs);
396
        bdrv_drain_recurse(bs, false);
397 398
        aio_context_release(aio_context);
    }
399

400
    block_job_resume_all();
401 402
}

403 404 405 406 407 408
void bdrv_drain_all(void)
{
    bdrv_drain_all_begin();
    bdrv_drain_all_end();
}

409 410 411 412 413 414 415 416
/**
 * 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) {
417
        atomic_dec(&req->bs->serialising_in_flight);
418 419
    }

420
    qemu_co_mutex_lock(&req->bs->reqs_lock);
421 422
    QLIST_REMOVE(req, list);
    qemu_co_queue_restart_all(&req->wait_queue);
423
    qemu_co_mutex_unlock(&req->bs->reqs_lock);
424 425 426 427 428 429 430 431
}

/**
 * Add an active request to the tracked requests list
 */
static void tracked_request_begin(BdrvTrackedRequest *req,
                                  BlockDriverState *bs,
                                  int64_t offset,
432 433
                                  unsigned int bytes,
                                  enum BdrvTrackedRequestType type)
434 435 436 437 438
{
    *req = (BdrvTrackedRequest){
        .bs = bs,
        .offset         = offset,
        .bytes          = bytes,
439
        .type           = type,
440 441 442 443 444 445 446 447
        .co             = qemu_coroutine_self(),
        .serialising    = false,
        .overlap_offset = offset,
        .overlap_bytes  = bytes,
    };

    qemu_co_queue_init(&req->wait_queue);

448
    qemu_co_mutex_lock(&bs->reqs_lock);
449
    QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
450
    qemu_co_mutex_unlock(&bs->reqs_lock);
451 452 453 454 455 456 457 458 459
}

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) {
460
        atomic_inc(&req->bs->serialising_in_flight);
461 462 463 464 465 466 467
        req->serialising = true;
    }

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

468 469 470 471
/**
 * Round a region to cluster boundaries
 */
void bdrv_round_to_clusters(BlockDriverState *bs,
472
                            int64_t offset, int64_t bytes,
473
                            int64_t *cluster_offset,
474
                            int64_t *cluster_bytes)
475 476 477 478 479 480 481 482 483 484 485 486 487
{
    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);
    }
}

488 489 490 491 492 493 494
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) {
495
        return bs->bl.request_alignment;
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
    } 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;
}

515 516 517 518 519
void bdrv_inc_in_flight(BlockDriverState *bs)
{
    atomic_inc(&bs->in_flight);
}

520 521 522 523 524 525
static void dummy_bh_cb(void *opaque)
{
}

void bdrv_wakeup(BlockDriverState *bs)
{
526 527
    /* The barrier (or an atomic op) is in the caller.  */
    if (atomic_read(&bs->wakeup)) {
528 529 530 531
        aio_bh_schedule_oneshot(qemu_get_aio_context(), dummy_bh_cb, NULL);
    }
}

532 533 534
void bdrv_dec_in_flight(BlockDriverState *bs)
{
    atomic_dec(&bs->in_flight);
535
    bdrv_wakeup(bs);
536 537
}

538 539 540 541 542 543 544
static bool coroutine_fn wait_serialising_requests(BdrvTrackedRequest *self)
{
    BlockDriverState *bs = self->bs;
    BdrvTrackedRequest *req;
    bool retry;
    bool waited = false;

545
    if (!atomic_read(&bs->serialising_in_flight)) {
546 547 548 549 550
        return false;
    }

    do {
        retry = false;
551
        qemu_co_mutex_lock(&bs->reqs_lock);
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
        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;
570
                    qemu_co_queue_wait(&req->wait_queue, &bs->reqs_lock);
571 572 573 574 575 576 577
                    self->waiting_for = NULL;
                    retry = true;
                    waited = true;
                    break;
                }
            }
        }
578
        qemu_co_mutex_unlock(&bs->reqs_lock);
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
    } 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 {
603
    BdrvChild *child;
604 605 606 607 608 609 610 611 612 613 614 615
    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) {
616
        rwco->ret = bdrv_co_preadv(rwco->child, rwco->offset,
617 618
                                   rwco->qiov->size, rwco->qiov,
                                   rwco->flags);
619
    } else {
620
        rwco->ret = bdrv_co_pwritev(rwco->child, rwco->offset,
621 622
                                    rwco->qiov->size, rwco->qiov,
                                    rwco->flags);
623 624 625 626 627 628
    }
}

/*
 * Process a vectored synchronous request using coroutines
 */
629
static int bdrv_prwv_co(BdrvChild *child, int64_t offset,
630 631 632 633 634
                        QEMUIOVector *qiov, bool is_write,
                        BdrvRequestFlags flags)
{
    Coroutine *co;
    RwCo rwco = {
635
        .child = child,
636 637 638 639 640 641 642 643 644 645 646
        .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 {
647
        co = qemu_coroutine_create(bdrv_rw_co_entry, &rwco);
648
        bdrv_coroutine_enter(child->bs, co);
P
Paolo Bonzini 已提交
649
        BDRV_POLL_WHILE(child->bs, rwco.ret == NOT_DONE);
650 651 652 653 654 655 656
    }
    return rwco.ret;
}

/*
 * Process a synchronous request using coroutines
 */
657
static int bdrv_rw_co(BdrvChild *child, int64_t sector_num, uint8_t *buf,
658 659 660 661 662 663 664 665 666 667 668 669 670
                      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);
671
    return bdrv_prwv_co(child, sector_num << BDRV_SECTOR_BITS,
672 673 674 675
                        &qiov, is_write, flags);
}

/* return < 0 if error. See bdrv_write() for the return codes */
676
int bdrv_read(BdrvChild *child, int64_t sector_num,
677 678
              uint8_t *buf, int nb_sectors)
{
679
    return bdrv_rw_co(child, sector_num, buf, nb_sectors, false, 0);
680 681 682 683 684 685 686 687
}

/* 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
*/
688
int bdrv_write(BdrvChild *child, int64_t sector_num,
689 690
               const uint8_t *buf, int nb_sectors)
{
691
    return bdrv_rw_co(child, sector_num, (uint8_t *)buf, nb_sectors, true, 0);
692 693
}

694
int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
695
                       int bytes, BdrvRequestFlags flags)
696
{
697 698 699
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = NULL,
700
        .iov_len = bytes,
701 702 703
    };

    qemu_iovec_init_external(&qiov, &iov, 1);
704
    return bdrv_prwv_co(child, offset, &qiov, true,
705
                        BDRV_REQ_ZERO_WRITE | flags);
706 707 708
}

/*
709
 * Completely zero out a block device with the help of bdrv_pwrite_zeroes.
710 711
 * 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
712
 * flags are passed through to bdrv_pwrite_zeroes (e.g. BDRV_REQ_MAY_UNMAP,
713
 * BDRV_REQ_FUA).
714 715 716
 *
 * Returns < 0 on error, 0 on success. For error codes see bdrv_write().
 */
717
int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags)
718
{
719 720
    int ret;
    int64_t target_size, bytes, offset = 0;
721
    BlockDriverState *bs = child->bs;
722

723 724 725
    target_size = bdrv_getlength(bs);
    if (target_size < 0) {
        return target_size;
726 727 728
    }

    for (;;) {
729 730
        bytes = MIN(target_size - offset, BDRV_REQUEST_MAX_BYTES);
        if (bytes <= 0) {
731 732
            return 0;
        }
733
        ret = bdrv_block_status(bs, offset, bytes, &bytes, NULL, NULL);
734
        if (ret < 0) {
735 736
            error_report("error getting block status at offset %" PRId64 ": %s",
                         offset, strerror(-ret));
737 738 739
            return ret;
        }
        if (ret & BDRV_BLOCK_ZERO) {
740
            offset += bytes;
741 742
            continue;
        }
743
        ret = bdrv_pwrite_zeroes(child, offset, bytes, flags);
744
        if (ret < 0) {
745 746
            error_report("error writing zeroes at offset %" PRId64 ": %s",
                         offset, strerror(-ret));
747 748
            return ret;
        }
749
        offset += bytes;
750 751 752
    }
}

753
int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
K
Kevin Wolf 已提交
754 755 756
{
    int ret;

757
    ret = bdrv_prwv_co(child, offset, qiov, false, 0);
K
Kevin Wolf 已提交
758 759 760 761 762 763 764
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

765
int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes)
766 767 768 769 770 771 772 773 774 775 776 777
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = (void *)buf,
        .iov_len = bytes,
    };

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

    qemu_iovec_init_external(&qiov, &iov, 1);
778
    return bdrv_preadv(child, offset, &qiov);
779 780
}

781
int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
782 783 784
{
    int ret;

785
    ret = bdrv_prwv_co(child, offset, qiov, true, 0);
786 787 788 789 790 791 792
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

793
int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes)
794 795 796 797 798 799 800 801 802 803 804 805
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = (void *) buf,
        .iov_len    = bytes,
    };

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

    qemu_iovec_init_external(&qiov, &iov, 1);
806
    return bdrv_pwritev(child, offset, &qiov);
807 808 809 810 811 812 813 814
}

/*
 * 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.
 */
815 816
int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
                     const void *buf, int count)
817 818 819
{
    int ret;

820
    ret = bdrv_pwrite(child, offset, buf, count);
821 822 823 824
    if (ret < 0) {
        return ret;
    }

825
    ret = bdrv_flush(child->bs);
826 827
    if (ret < 0) {
        return ret;
828 829 830 831 832
    }

    return 0;
}

833 834 835 836 837 838 839 840 841 842
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;
843
    aio_co_wake(co->coroutine);
844 845
}

846 847 848 849 850
static int coroutine_fn bdrv_driver_preadv(BlockDriverState *bs,
                                           uint64_t offset, uint64_t bytes,
                                           QEMUIOVector *qiov, int flags)
{
    BlockDriver *drv = bs->drv;
851 852 853
    int64_t sector_num;
    unsigned int nb_sectors;

854 855
    assert(!(flags & ~BDRV_REQ_MASK));

856 857 858 859 860 861
    if (drv->bdrv_co_preadv) {
        return drv->bdrv_co_preadv(bs, offset, bytes, qiov, flags);
    }

    sector_num = offset >> BDRV_SECTOR_BITS;
    nb_sectors = bytes >> BDRV_SECTOR_BITS;
862 863 864 865 866

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

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
    if (drv->bdrv_co_readv) {
        return drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
    } else {
        BlockAIOCB *acb;
        CoroutineIOCompletion co = {
            .coroutine = qemu_coroutine_self(),
        };

        acb = bs->drv->bdrv_aio_readv(bs, sector_num, qiov, nb_sectors,
                                      bdrv_co_io_em_complete, &co);
        if (acb == NULL) {
            return -EIO;
        } else {
            qemu_coroutine_yield();
            return co.ret;
        }
    }
884 885
}

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

895 896
    assert(!(flags & ~BDRV_REQ_MASK));

897
    if (drv->bdrv_co_pwritev) {
898 899 900
        ret = drv->bdrv_co_pwritev(bs, offset, bytes, qiov,
                                   flags & bs->supported_write_flags);
        flags &= ~bs->supported_write_flags;
901 902 903 904 905 906
        goto emulate_flags;
    }

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

907 908 909 910 911 912
    assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
    assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
    assert((bytes >> BDRV_SECTOR_BITS) <= BDRV_REQUEST_MAX_SECTORS);

    if (drv->bdrv_co_writev_flags) {
        ret = drv->bdrv_co_writev_flags(bs, sector_num, nb_sectors, qiov,
913 914
                                        flags & bs->supported_write_flags);
        flags &= ~bs->supported_write_flags;
915
    } else if (drv->bdrv_co_writev) {
916
        assert(!bs->supported_write_flags);
917
        ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
918 919 920 921 922 923 924 925 926
    } else {
        BlockAIOCB *acb;
        CoroutineIOCompletion co = {
            .coroutine = qemu_coroutine_self(),
        };

        acb = bs->drv->bdrv_aio_writev(bs, sector_num, qiov, nb_sectors,
                                       bdrv_co_io_em_complete, &co);
        if (acb == NULL) {
927
            ret = -EIO;
928 929
        } else {
            qemu_coroutine_yield();
930
            ret = co.ret;
931
        }
932 933
    }

934
emulate_flags:
935
    if (ret == 0 && (flags & BDRV_REQ_FUA)) {
936 937 938 939 940 941
        ret = bdrv_co_flush(bs);
    }

    return ret;
}

942 943 944 945 946 947 948 949 950 951 952 953 954
static int coroutine_fn
bdrv_driver_pwritev_compressed(BlockDriverState *bs, uint64_t offset,
                               uint64_t bytes, QEMUIOVector *qiov)
{
    BlockDriver *drv = bs->drv;

    if (!drv->bdrv_co_pwritev_compressed) {
        return -ENOTSUP;
    }

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

955
static int coroutine_fn bdrv_co_do_copy_on_readv(BdrvChild *child,
956
        int64_t offset, unsigned int bytes, QEMUIOVector *qiov)
957
{
958 959
    BlockDriverState *bs = child->bs;

960 961 962 963 964 965 966 967 968
    /* 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 已提交
969
    QEMUIOVector local_qiov;
970
    int64_t cluster_offset;
971
    int64_t cluster_bytes;
972 973
    size_t skip_bytes;
    int ret;
E
Eric Blake 已提交
974 975 976
    int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer,
                                    BDRV_REQUEST_MAX_BYTES);
    unsigned int progress = 0;
977

978 979 980
    /* 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 已提交
981
     * long as it is implemented here rather than in a separate filter driver,
982 983 984 985
     * 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));
986

987
    /* Cover entire cluster so no additional backing file I/O is required when
E
Eric Blake 已提交
988 989 990
     * 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.
991
     */
992
    bdrv_round_to_clusters(bs, offset, bytes, &cluster_offset, &cluster_bytes);
E
Eric Blake 已提交
993
    skip_bytes = offset - cluster_offset;
994

995 996
    trace_bdrv_co_do_copy_on_readv(bs, offset, bytes,
                                   cluster_offset, cluster_bytes);
997

E
Eric Blake 已提交
998 999 1000
    bounce_buffer = qemu_try_blockalign(bs,
                                        MIN(MIN(max_transfer, cluster_bytes),
                                            MAX_BOUNCE_BUFFER));
1001 1002 1003 1004 1005
    if (bounce_buffer == NULL) {
        ret = -ENOMEM;
        goto err;
    }

E
Eric Blake 已提交
1006 1007
    while (cluster_bytes) {
        int64_t pnum;
1008

E
Eric Blake 已提交
1009 1010 1011 1012 1013 1014 1015 1016 1017
        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);
        }
1018

E
Eric Blake 已提交
1019
        assert(skip_bytes < pnum);
1020

E
Eric Blake 已提交
1021 1022 1023 1024 1025
        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);
1026

E
Eric Blake 已提交
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
            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? */
                ret = bdrv_co_do_pwrite_zeroes(bs, cluster_offset, pnum, 0);
            } 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,
                                          &local_qiov, 0);
            }

            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;
1077 1078 1079 1080 1081 1082 1083 1084

err:
    qemu_vfree(bounce_buffer);
    return ret;
}

/*
 * Forwards an already correctly aligned request to the BlockDriver. This
1085 1086
 * handles copy on read, zeroing after EOF, and fragmentation of large
 * reads; any other features must be implemented by the caller.
1087
 */
1088
static int coroutine_fn bdrv_aligned_preadv(BdrvChild *child,
1089 1090 1091
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
    int64_t align, QEMUIOVector *qiov, int flags)
{
1092
    BlockDriverState *bs = child->bs;
K
Kevin Wolf 已提交
1093
    int64_t total_bytes, max_bytes;
1094 1095 1096
    int ret = 0;
    uint64_t bytes_remaining = bytes;
    int max_transfer;
1097

1098 1099 1100
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
1101
    assert(!qiov || bytes == qiov->size);
1102
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1103 1104
    max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
                                   align);
1105 1106 1107 1108 1109 1110

    /* 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)));
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121

    /* 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));
    }

1122 1123 1124
    if (!(flags & BDRV_REQ_NO_SERIALISING)) {
        wait_serialising_requests(req);
    }
1125 1126

    if (flags & BDRV_REQ_COPY_ON_READ) {
1127 1128 1129 1130 1131
        /* TODO: Simplify further once bdrv_is_allocated no longer
         * requires sector alignment */
        int64_t start = QEMU_ALIGN_DOWN(offset, BDRV_SECTOR_SIZE);
        int64_t end = QEMU_ALIGN_UP(offset + bytes, BDRV_SECTOR_SIZE);
        int64_t pnum;
1132

1133
        ret = bdrv_is_allocated(bs, start, end - start, &pnum);
1134 1135 1136 1137
        if (ret < 0) {
            goto out;
        }

1138
        if (!ret || pnum != end - start) {
1139
            ret = bdrv_co_do_copy_on_readv(child, offset, bytes, qiov);
1140 1141 1142 1143
            goto out;
        }
    }

1144
    /* Forward the request to the BlockDriver, possibly fragmenting it */
K
Kevin Wolf 已提交
1145 1146 1147 1148 1149
    total_bytes = bdrv_getlength(bs);
    if (total_bytes < 0) {
        ret = total_bytes;
        goto out;
    }
1150

K
Kevin Wolf 已提交
1151
    max_bytes = ROUND_UP(MAX(0, total_bytes - offset), align);
1152
    if (bytes <= max_bytes && bytes <= max_transfer) {
K
Kevin Wolf 已提交
1153
        ret = bdrv_driver_preadv(bs, offset, bytes, qiov, 0);
1154 1155
        goto out;
    }
1156

1157 1158
    while (bytes_remaining) {
        int num;
1159

1160 1161
        if (max_bytes) {
            QEMUIOVector local_qiov;
1162

1163 1164 1165 1166
            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);
1167

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
            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;
1181 1182 1183
    }

out:
1184
    return ret < 0 ? ret : 0;
1185 1186 1187 1188 1189
}

/*
 * Handle a read request in coroutine context
 */
1190
int coroutine_fn bdrv_co_preadv(BdrvChild *child,
1191 1192 1193
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1194
    BlockDriverState *bs = child->bs;
1195 1196 1197
    BlockDriver *drv = bs->drv;
    BdrvTrackedRequest req;

1198
    uint64_t align = bs->bl.request_alignment;
1199 1200 1201 1202 1203 1204
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

1205 1206
    trace_bdrv_co_preadv(child->bs, offset, bytes, flags);

1207 1208 1209 1210 1211 1212 1213 1214 1215
    if (!drv) {
        return -ENOMEDIUM;
    }

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

1216 1217
    bdrv_inc_in_flight(bs);

1218
    /* Don't do copy-on-read if we read data before write operation */
1219
    if (atomic_read(&bs->copy_on_read) && !(flags & BDRV_REQ_NO_SERIALISING)) {
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
        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);
    }

1248
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_READ);
1249
    ret = bdrv_aligned_preadv(child, &req, offset, bytes, align,
1250 1251 1252
                              use_local_qiov ? &local_qiov : qiov,
                              flags);
    tracked_request_end(&req);
1253
    bdrv_dec_in_flight(bs);
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263

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

    return ret;
}

1264
static int coroutine_fn bdrv_co_do_readv(BdrvChild *child,
1265 1266 1267 1268 1269 1270 1271
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EINVAL;
    }

1272
    return bdrv_co_preadv(child, sector_num << BDRV_SECTOR_BITS,
1273
                          nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1274 1275
}

1276 1277
int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num,
                               int nb_sectors, QEMUIOVector *qiov)
1278
{
1279
    return bdrv_co_do_readv(child, sector_num, nb_sectors, qiov, 0);
1280 1281
}

E
Eric Blake 已提交
1282
static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
1283
    int64_t offset, int bytes, BdrvRequestFlags flags)
1284 1285 1286 1287 1288
{
    BlockDriver *drv = bs->drv;
    QEMUIOVector qiov;
    struct iovec iov = {0};
    int ret = 0;
1289
    bool need_flush = false;
1290 1291
    int head = 0;
    int tail = 0;
1292

1293
    int max_write_zeroes = MIN_NON_ZERO(bs->bl.max_pwrite_zeroes, INT_MAX);
1294 1295
    int alignment = MAX(bs->bl.pwrite_zeroes_alignment,
                        bs->bl.request_alignment);
E
Eric Blake 已提交
1296
    int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer, MAX_BOUNCE_BUFFER);
E
Eric Blake 已提交
1297

1298 1299
    assert(alignment % bs->bl.request_alignment == 0);
    head = offset % alignment;
1300
    tail = (offset + bytes) % alignment;
1301 1302
    max_write_zeroes = QEMU_ALIGN_DOWN(max_write_zeroes, alignment);
    assert(max_write_zeroes >= bs->bl.request_alignment);
1303

1304 1305
    while (bytes > 0 && !ret) {
        int num = bytes;
1306 1307

        /* Align request.  Block drivers can expect the "bulk" of the request
1308 1309
         * to be aligned, and that unaligned requests do not cross cluster
         * boundaries.
1310
         */
1311
        if (head) {
1312 1313 1314
            /* 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.  */
1315
            num = MIN(MIN(bytes, max_transfer), alignment - head);
1316 1317
            head = (head + num) % alignment;
            assert(num < max_write_zeroes);
E
Eric Blake 已提交
1318
        } else if (tail && num > alignment) {
1319 1320
            /* Shorten the request to the last aligned sector.  */
            num -= tail;
1321 1322 1323 1324 1325 1326 1327 1328 1329
        }

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

        ret = -ENOTSUP;
        /* First try the efficient write zeroes operation */
E
Eric Blake 已提交
1330 1331 1332 1333 1334 1335 1336
        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;
            }
1337 1338
        } else {
            assert(!bs->supported_zero_flags);
1339 1340 1341 1342
        }

        if (ret == -ENOTSUP) {
            /* Fall back to bounce buffer if write zeroes is unsupported */
1343 1344 1345 1346 1347 1348 1349 1350 1351
            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;
            }
1352
            num = MIN(num, max_transfer);
E
Eric Blake 已提交
1353
            iov.iov_len = num;
1354
            if (iov.iov_base == NULL) {
E
Eric Blake 已提交
1355
                iov.iov_base = qemu_try_blockalign(bs, num);
1356 1357 1358 1359
                if (iov.iov_base == NULL) {
                    ret = -ENOMEM;
                    goto fail;
                }
E
Eric Blake 已提交
1360
                memset(iov.iov_base, 0, num);
1361 1362 1363
            }
            qemu_iovec_init_external(&qiov, &iov, 1);

E
Eric Blake 已提交
1364
            ret = bdrv_driver_pwritev(bs, offset, num, &qiov, write_flags);
1365 1366 1367 1368

            /* Keep bounce buffer around if it is big enough for all
             * all future requests.
             */
1369
            if (num < max_transfer) {
1370 1371 1372 1373 1374
                qemu_vfree(iov.iov_base);
                iov.iov_base = NULL;
            }
        }

E
Eric Blake 已提交
1375
        offset += num;
1376
        bytes -= num;
1377 1378 1379
    }

fail:
1380 1381 1382
    if (ret == 0 && need_flush) {
        ret = bdrv_co_flush(bs);
    }
1383 1384 1385 1386 1387
    qemu_vfree(iov.iov_base);
    return ret;
}

/*
1388 1389
 * Forwards an already correctly aligned write request to the BlockDriver,
 * after possibly fragmenting it.
1390
 */
1391
static int coroutine_fn bdrv_aligned_pwritev(BdrvChild *child,
1392
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
1393
    int64_t align, QEMUIOVector *qiov, int flags)
1394
{
1395
    BlockDriverState *bs = child->bs;
1396 1397 1398 1399
    BlockDriver *drv = bs->drv;
    bool waited;
    int ret;

1400
    int64_t end_sector = DIV_ROUND_UP(offset + bytes, BDRV_SECTOR_SIZE);
1401 1402
    uint64_t bytes_remaining = bytes;
    int max_transfer;
1403

1404 1405 1406 1407
    if (bdrv_has_readonly_bitmaps(bs)) {
        return -EPERM;
    }

1408 1409 1410
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
1411
    assert(!qiov || bytes == qiov->size);
1412
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1413
    assert(!(flags & ~BDRV_REQ_MASK));
1414 1415
    max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
                                   align);
1416 1417 1418 1419 1420

    waited = wait_serialising_requests(req);
    assert(!waited || !req->serialising);
    assert(req->overlap_offset <= offset);
    assert(offset + bytes <= req->overlap_offset + req->overlap_bytes);
1421 1422
    assert(child->perm & BLK_PERM_WRITE);
    assert(end_sector <= bs->total_sectors || child->perm & BLK_PERM_RESIZE);
1423 1424 1425 1426

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

    if (!ret && bs->detect_zeroes != BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF &&
E
Eric Blake 已提交
1427
        !(flags & BDRV_REQ_ZERO_WRITE) && drv->bdrv_co_pwrite_zeroes &&
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
        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 已提交
1438
        bdrv_debug_event(bs, BLKDBG_PWRITEV_ZERO);
1439
        ret = bdrv_co_do_pwrite_zeroes(bs, offset, bytes, flags);
1440 1441
    } else if (flags & BDRV_REQ_WRITE_COMPRESSED) {
        ret = bdrv_driver_pwritev_compressed(bs, offset, bytes, qiov);
1442
    } else if (bytes <= max_transfer) {
K
Kevin Wolf 已提交
1443
        bdrv_debug_event(bs, BLKDBG_PWRITEV);
1444
        ret = bdrv_driver_pwritev(bs, offset, bytes, qiov, flags);
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
    } 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;
        }
1470
    }
K
Kevin Wolf 已提交
1471
    bdrv_debug_event(bs, BLKDBG_PWRITEV_DONE);
1472

1473
    atomic_inc(&bs->write_gen);
1474
    bdrv_set_dirty(bs, offset, bytes);
1475

1476
    stat64_max(&bs->wr_highest_offset, offset + bytes);
1477 1478

    if (ret >= 0) {
1479
        bs->total_sectors = MAX(bs->total_sectors, end_sector);
1480
        ret = 0;
1481 1482 1483 1484 1485
    }

    return ret;
}

1486
static int coroutine_fn bdrv_co_do_zero_pwritev(BdrvChild *child,
1487 1488 1489 1490 1491
                                                int64_t offset,
                                                unsigned int bytes,
                                                BdrvRequestFlags flags,
                                                BdrvTrackedRequest *req)
{
1492
    BlockDriverState *bs = child->bs;
1493 1494 1495
    uint8_t *buf = NULL;
    QEMUIOVector local_qiov;
    struct iovec iov;
1496
    uint64_t align = bs->bl.request_alignment;
1497 1498 1499 1500
    unsigned int head_padding_bytes, tail_padding_bytes;
    int ret = 0;

    head_padding_bytes = offset & (align - 1);
1501
    tail_padding_bytes = (align - (offset + bytes)) & (align - 1);
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518


    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 已提交
1519
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1520
        ret = bdrv_aligned_preadv(child, req, offset & ~(align - 1), align,
1521 1522 1523 1524
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1525
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1526 1527

        memset(buf + head_padding_bytes, 0, zero_bytes);
1528
        ret = bdrv_aligned_pwritev(child, req, offset & ~(align - 1), align,
1529
                                   align, &local_qiov,
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
                                   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);
1542
        ret = bdrv_aligned_pwritev(child, req, offset, aligned_bytes, align,
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
                                   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 已提交
1557
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1558
        ret = bdrv_aligned_preadv(child, req, offset, align,
1559 1560 1561 1562
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1563
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1564 1565

        memset(buf, 0, bytes);
1566
        ret = bdrv_aligned_pwritev(child, req, offset, align, align,
1567 1568 1569 1570 1571 1572 1573 1574
                                   &local_qiov, flags & ~BDRV_REQ_ZERO_WRITE);
    }
fail:
    qemu_vfree(buf);
    return ret;

}

1575 1576 1577
/*
 * Handle a write request in coroutine context
 */
1578
int coroutine_fn bdrv_co_pwritev(BdrvChild *child,
1579 1580 1581
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1582
    BlockDriverState *bs = child->bs;
1583
    BdrvTrackedRequest req;
1584
    uint64_t align = bs->bl.request_alignment;
1585 1586 1587 1588 1589 1590
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

1591 1592
    trace_bdrv_co_pwritev(child->bs, offset, bytes, flags);

1593 1594 1595 1596
    if (!bs->drv) {
        return -ENOMEDIUM;
    }
    if (bs->read_only) {
1597
        return -EPERM;
1598
    }
1599
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
1600 1601 1602 1603 1604 1605

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

1606
    bdrv_inc_in_flight(bs);
1607 1608 1609 1610 1611
    /*
     * 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.
     */
1612
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_WRITE);
1613

1614
    if (!qiov) {
1615
        ret = bdrv_co_do_zero_pwritev(child, offset, bytes, flags, &req);
1616 1617 1618
        goto out;
    }

1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
    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 已提交
1633
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1634
        ret = bdrv_aligned_preadv(child, &req, offset & ~(align - 1), align,
1635 1636 1637 1638
                                  align, &head_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1639
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1640 1641 1642 1643 1644 1645 1646 1647

        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);
1648 1649 1650 1651 1652 1653 1654 1655

        /* 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;
        }
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
    }

    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 已提交
1675
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1676 1677
        ret = bdrv_aligned_preadv(child, &req, (offset + bytes) & ~(align - 1),
                                  align, align, &tail_qiov, 0);
1678 1679 1680
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1681
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694

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

1695
    ret = bdrv_aligned_pwritev(child, &req, offset, bytes, align,
1696 1697
                               use_local_qiov ? &local_qiov : qiov,
                               flags);
1698 1699 1700 1701 1702 1703 1704 1705

fail:

    if (use_local_qiov) {
        qemu_iovec_destroy(&local_qiov);
    }
    qemu_vfree(head_buf);
    qemu_vfree(tail_buf);
1706 1707
out:
    tracked_request_end(&req);
1708
    bdrv_dec_in_flight(bs);
1709 1710 1711
    return ret;
}

1712
static int coroutine_fn bdrv_co_do_writev(BdrvChild *child,
1713 1714 1715 1716 1717 1718 1719
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EINVAL;
    }

1720
    return bdrv_co_pwritev(child, sector_num << BDRV_SECTOR_BITS,
1721
                           nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1722 1723
}

1724
int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num,
1725 1726
    int nb_sectors, QEMUIOVector *qiov)
{
1727
    return bdrv_co_do_writev(child, sector_num, nb_sectors, qiov, 0);
1728 1729
}

1730
int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
1731
                                       int bytes, BdrvRequestFlags flags)
1732
{
1733
    trace_bdrv_co_pwrite_zeroes(child->bs, offset, bytes, flags);
1734

1735
    if (!(child->bs->open_flags & BDRV_O_UNMAP)) {
1736 1737 1738
        flags &= ~BDRV_REQ_MAY_UNMAP;
    }

1739
    return bdrv_co_pwritev(child, offset, bytes, NULL,
1740
                           BDRV_REQ_ZERO_WRITE | flags);
1741 1742
}

J
John Snow 已提交
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
/*
 * 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;
}


1768 1769 1770
typedef struct BdrvCoGetBlockStatusData {
    BlockDriverState *bs;
    BlockDriverState *base;
1771
    bool want_zero;
1772 1773 1774
    int64_t sector_num;
    int nb_sectors;
    int *pnum;
1775
    BlockDriverState **file;
1776 1777 1778 1779
    int64_t ret;
    bool done;
} BdrvCoGetBlockStatusData;

1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
int64_t coroutine_fn bdrv_co_get_block_status_from_file(BlockDriverState *bs,
                                                        int64_t sector_num,
                                                        int nb_sectors,
                                                        int *pnum,
                                                        BlockDriverState **file)
{
    assert(bs->file && bs->file->bs);
    *pnum = nb_sectors;
    *file = bs->file->bs;
    return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID |
           (sector_num << BDRV_SECTOR_BITS);
}

int64_t coroutine_fn bdrv_co_get_block_status_from_backing(BlockDriverState *bs,
                                                           int64_t sector_num,
                                                           int nb_sectors,
                                                           int *pnum,
                                                           BlockDriverState **file)
{
    assert(bs->backing && bs->backing->bs);
    *pnum = nb_sectors;
    *file = bs->backing->bs;
    return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID |
           (sector_num << BDRV_SECTOR_BITS);
}

1806 1807 1808 1809 1810
/*
 * 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.
 *
1811 1812 1813 1814 1815
 * If 'want_zero' is true, the caller is querying for mapping purposes,
 * and the result should include BDRV_BLOCK_OFFSET_VALID and
 * BDRV_BLOCK_ZERO where possible; otherwise, the result may omit those
 * bits particularly if it allows for a larger value in 'pnum'.
 *
1816
 * If 'offset' is beyond the end of the disk image the return value is
1817
 * BDRV_BLOCK_EOF and 'pnum' is set to 0.
1818
 *
1819
 * 'bytes' is the max value 'pnum' should be set to.  If bytes goes
1820 1821
 * 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.
1822
 *
1823 1824 1825 1826 1827 1828 1829 1830 1831
 * '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.
1832
 */
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
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 */
    int64_t ret;
    int64_t local_map = 0;
1843
    BlockDriverState *local_file = NULL;
1844
    int count; /* sectors */
1845

1846 1847
    assert(pnum);
    *pnum = 0;
1848 1849 1850
    total_size = bdrv_getlength(bs);
    if (total_size < 0) {
        ret = total_size;
1851
        goto early_out;
1852 1853
    }

1854
    if (offset >= total_size) {
1855 1856
        ret = BDRV_BLOCK_EOF;
        goto early_out;
1857
    }
1858
    if (!bytes) {
1859 1860
        ret = 0;
        goto early_out;
1861
    }
1862

1863 1864 1865
    n = total_size - offset;
    if (n < bytes) {
        bytes = n;
1866 1867 1868
    }

    if (!bs->drv->bdrv_co_get_block_status) {
1869
        *pnum = bytes;
1870
        ret = BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED;
1871
        if (offset + bytes == total_size) {
1872 1873
            ret |= BDRV_BLOCK_EOF;
        }
1874
        if (bs->drv->protocol_name) {
1875 1876
            ret |= BDRV_BLOCK_OFFSET_VALID;
            local_map = offset;
1877
            local_file = bs;
1878
        }
1879
        goto early_out;
1880 1881
    }

1882
    bdrv_inc_in_flight(bs);
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896
    /*
     * TODO: Rather than require aligned offsets, we could instead
     * round to the driver's request_alignment here, then touch up
     * count afterwards back to the caller's expectations.
     */
    assert(QEMU_IS_ALIGNED(offset | bytes, BDRV_SECTOR_SIZE));
    /*
     * The contract allows us to return pnum smaller than bytes, even
     * if the next query would see the same status; we truncate the
     * request to avoid overflowing the driver's 32-bit interface.
     */
    bytes = MIN(bytes, BDRV_REQUEST_MAX_BYTES);
    ret = bs->drv->bdrv_co_get_block_status(bs, offset >> BDRV_SECTOR_BITS,
                                            bytes >> BDRV_SECTOR_BITS, &count,
1897
                                            &local_file);
1898
    if (ret < 0) {
1899
        goto out;
1900
    }
1901 1902 1903 1904
    if (ret & BDRV_BLOCK_OFFSET_VALID) {
        local_map = ret & BDRV_BLOCK_OFFSET_MASK;
    }
    *pnum = count * BDRV_SECTOR_SIZE;
1905 1906

    if (ret & BDRV_BLOCK_RAW) {
1907
        assert(ret & BDRV_BLOCK_OFFSET_VALID && local_file);
1908 1909 1910 1911
        ret = bdrv_co_block_status(local_file, want_zero, local_map,
                                   *pnum, pnum, &local_map, &local_file);
        assert(ret < 0 ||
               QEMU_IS_ALIGNED(*pnum | local_map, BDRV_SECTOR_SIZE));
1912
        goto out;
1913 1914 1915 1916
    }

    if (ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ZERO)) {
        ret |= BDRV_BLOCK_ALLOCATED;
1917
    } else if (want_zero) {
1918 1919
        if (bdrv_unallocated_blocks_are_zero(bs)) {
            ret |= BDRV_BLOCK_ZERO;
1920 1921
        } else if (bs->backing) {
            BlockDriverState *bs2 = bs->backing->bs;
1922
            int64_t size2 = bdrv_getlength(bs2);
1923

1924
            if (size2 >= 0 && offset >= size2) {
1925 1926 1927 1928 1929
                ret |= BDRV_BLOCK_ZERO;
            }
        }
    }

1930
    if (want_zero && local_file && local_file != bs &&
1931 1932
        (ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO) &&
        (ret & BDRV_BLOCK_OFFSET_VALID)) {
1933 1934
        int64_t file_pnum;
        int ret2;
1935

1936 1937
        ret2 = bdrv_co_block_status(local_file, want_zero, local_map,
                                    *pnum, &file_pnum, NULL, NULL);
1938 1939 1940 1941
        if (ret2 >= 0) {
            /* Ignore errors.  This is just providing extra information, it
             * is useful but not necessary.
             */
1942 1943 1944 1945 1946 1947 1948
            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.
                 */
1949 1950 1951 1952 1953 1954 1955 1956 1957
                ret |= BDRV_BLOCK_ZERO;
            } else {
                /* Limit request to the range reported by the protocol driver */
                *pnum = file_pnum;
                ret |= (ret2 & BDRV_BLOCK_ZERO);
            }
        }
    }

1958 1959
out:
    bdrv_dec_in_flight(bs);
1960
    if (ret >= 0 && offset + *pnum == total_size) {
1961 1962
        ret |= BDRV_BLOCK_EOF;
    }
1963 1964 1965 1966
early_out:
    if (file) {
        *file = local_file;
    }
1967 1968 1969 1970 1971 1972 1973 1974
    if (map) {
        *map = local_map;
    }
    if (ret >= 0) {
        ret &= ~BDRV_BLOCK_OFFSET_MASK;
    } else {
        assert(INT_MIN <= ret);
    }
1975 1976 1977
    return ret;
}

1978 1979
static int64_t coroutine_fn bdrv_co_get_block_status_above(BlockDriverState *bs,
        BlockDriverState *base,
1980
        bool want_zero,
1981 1982
        int64_t sector_num,
        int nb_sectors,
1983 1984
        int *pnum,
        BlockDriverState **file)
1985 1986 1987
{
    BlockDriverState *p;
    int64_t ret = 0;
1988
    bool first = true;
1989
    int64_t map = 0;
1990 1991

    assert(bs != base);
1992
    for (p = bs; p != base; p = backing_bs(p)) {
1993 1994 1995 1996 1997 1998
        int64_t count;

        ret = bdrv_co_block_status(p, want_zero,
                                   sector_num * BDRV_SECTOR_SIZE,
                                   nb_sectors * BDRV_SECTOR_SIZE, &count,
                                   &map, file);
1999 2000 2001
        if (ret < 0) {
            break;
        }
2002 2003 2004
        assert(QEMU_IS_ALIGNED(count | map, BDRV_SECTOR_SIZE));
        ret |= map;
        *pnum = count >> BDRV_SECTOR_BITS;
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014
        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.
             */
            *pnum = nb_sectors;
        }
        if (ret & (BDRV_BLOCK_ZERO | BDRV_BLOCK_DATA)) {
2015 2016 2017 2018 2019
            break;
        }
        /* [sector_num, pnum] unallocated on this layer, which could be only
         * the first part of [sector_num, nb_sectors].  */
        nb_sectors = MIN(nb_sectors, *pnum);
2020
        first = false;
2021 2022 2023 2024 2025 2026
    }
    return ret;
}

/* Coroutine wrapper for bdrv_get_block_status_above() */
static void coroutine_fn bdrv_get_block_status_above_co_entry(void *opaque)
2027 2028 2029
{
    BdrvCoGetBlockStatusData *data = opaque;

2030
    data->ret = bdrv_co_get_block_status_above(data->bs, data->base,
2031
                                               data->want_zero,
2032 2033
                                               data->sector_num,
                                               data->nb_sectors,
2034 2035
                                               data->pnum,
                                               data->file);
2036 2037 2038 2039
    data->done = true;
}

/*
2040
 * Synchronous wrapper around bdrv_co_get_block_status_above().
2041
 *
2042
 * See bdrv_co_get_block_status_above() for details.
2043
 */
2044 2045 2046 2047 2048 2049
static int64_t bdrv_common_block_status_above(BlockDriverState *bs,
                                              BlockDriverState *base,
                                              bool want_zero,
                                              int64_t sector_num,
                                              int nb_sectors, int *pnum,
                                              BlockDriverState **file)
2050 2051 2052 2053
{
    Coroutine *co;
    BdrvCoGetBlockStatusData data = {
        .bs = bs,
2054
        .base = base,
2055
        .want_zero = want_zero,
2056 2057 2058
        .sector_num = sector_num,
        .nb_sectors = nb_sectors,
        .pnum = pnum,
2059
        .file = file,
2060 2061 2062 2063 2064
        .done = false,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2065
        bdrv_get_block_status_above_co_entry(&data);
2066
    } else {
2067 2068
        co = qemu_coroutine_create(bdrv_get_block_status_above_co_entry,
                                   &data);
2069
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2070
        BDRV_POLL_WHILE(bs, !data.done);
2071 2072 2073 2074
    }
    return data.ret;
}

2075 2076 2077 2078 2079 2080 2081 2082 2083 2084
int64_t bdrv_get_block_status_above(BlockDriverState *bs,
                                    BlockDriverState *base,
                                    int64_t sector_num,
                                    int nb_sectors, int *pnum,
                                    BlockDriverState **file)
{
    return bdrv_common_block_status_above(bs, base, true, sector_num,
                                          nb_sectors, pnum, file);
}

2085 2086
int bdrv_block_status(BlockDriverState *bs, int64_t offset, int64_t bytes,
                      int64_t *pnum, int64_t *map, BlockDriverState **file)
2087
{
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113
    int64_t ret;
    int n;

    assert(QEMU_IS_ALIGNED(offset | bytes, BDRV_SECTOR_SIZE));
    assert(pnum);
    /*
     * The contract allows us to return pnum smaller than bytes, even
     * if the next query would see the same status; we truncate the
     * request to avoid overflowing the driver's 32-bit interface.
     */
    bytes = MIN(bytes, BDRV_REQUEST_MAX_BYTES);
    ret = bdrv_get_block_status_above(bs, backing_bs(bs),
                                      offset >> BDRV_SECTOR_BITS,
                                      bytes >> BDRV_SECTOR_BITS, &n, file);
    if (ret < 0) {
        assert(INT_MIN <= ret);
        *pnum = 0;
        return ret;
    }
    *pnum = n * BDRV_SECTOR_SIZE;
    if (map) {
        *map = ret & BDRV_BLOCK_OFFSET_MASK;
    } else {
        ret &= ~BDRV_BLOCK_OFFSET_VALID;
    }
    return ret & ~BDRV_BLOCK_OFFSET_MASK;
2114 2115
}

2116 2117
int coroutine_fn bdrv_is_allocated(BlockDriverState *bs, int64_t offset,
                                   int64_t bytes, int64_t *pnum)
2118
{
2119 2120 2121 2122 2123
    int64_t ret;
    int psectors;

    assert(QEMU_IS_ALIGNED(offset, BDRV_SECTOR_SIZE));
    assert(QEMU_IS_ALIGNED(bytes, BDRV_SECTOR_SIZE) && bytes < INT_MAX);
2124 2125 2126 2127
    ret = bdrv_common_block_status_above(bs, backing_bs(bs), false,
                                         offset >> BDRV_SECTOR_BITS,
                                         bytes >> BDRV_SECTOR_BITS, &psectors,
                                         NULL);
2128 2129 2130
    if (ret < 0) {
        return ret;
    }
2131 2132 2133
    if (pnum) {
        *pnum = psectors * BDRV_SECTOR_SIZE;
    }
2134 2135 2136 2137 2138 2139
    return !!(ret & BDRV_BLOCK_ALLOCATED);
}

/*
 * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
 *
2140 2141 2142
 * 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,
2143
 * or negative errno on failure.
2144
 *
2145 2146 2147 2148 2149 2150
 * '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.
2151 2152 2153 2154
 *
 */
int bdrv_is_allocated_above(BlockDriverState *top,
                            BlockDriverState *base,
2155
                            int64_t offset, int64_t bytes, int64_t *pnum)
2156 2157
{
    BlockDriverState *intermediate;
2158 2159
    int ret;
    int64_t n = bytes;
2160 2161 2162

    intermediate = top;
    while (intermediate && intermediate != base) {
2163
        int64_t pnum_inter;
2164
        int64_t size_inter;
2165

2166
        ret = bdrv_is_allocated(intermediate, offset, bytes, &pnum_inter);
2167 2168
        if (ret < 0) {
            return ret;
2169 2170
        }
        if (ret) {
2171
            *pnum = pnum_inter;
2172 2173 2174
            return 1;
        }

2175
        size_inter = bdrv_getlength(intermediate);
2176 2177 2178
        if (size_inter < 0) {
            return size_inter;
        }
2179 2180 2181
        if (n > pnum_inter &&
            (intermediate == top || offset + pnum_inter < size_inter)) {
            n = pnum_inter;
2182 2183
        }

2184
        intermediate = backing_bs(intermediate);
2185 2186 2187 2188 2189 2190
    }

    *pnum = n;
    return 0;
}

2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203
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;
2204 2205 2206
    int ret = -ENOTSUP;

    bdrv_inc_in_flight(bs);
2207 2208

    if (!drv) {
2209
        ret = -ENOMEDIUM;
2210
    } else if (drv->bdrv_load_vmstate) {
2211 2212 2213 2214 2215
        if (is_read) {
            ret = drv->bdrv_load_vmstate(bs, qiov, pos);
        } else {
            ret = drv->bdrv_save_vmstate(bs, qiov, pos);
        }
2216
    } else if (bs->file) {
2217
        ret = bdrv_co_rw_vmstate(bs->file->bs, qiov, pos, is_read);
2218 2219
    }

2220 2221
    bdrv_dec_in_flight(bs);
    return ret;
2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243
}

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,
        };
2244
        Coroutine *co = qemu_coroutine_create(bdrv_co_rw_vmstate_entry, &data);
2245

2246
        bdrv_coroutine_enter(bs, co);
2247
        BDRV_POLL_WHILE(bs, data.ret == -EINPROGRESS);
2248 2249 2250 2251
        return data.ret;
    }
}

2252 2253 2254 2255 2256 2257 2258 2259
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,
    };
2260
    int ret;
2261 2262

    qemu_iovec_init_external(&qiov, &iov, 1);
2263 2264 2265 2266 2267 2268 2269

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

    return size;
2270 2271 2272 2273
}

int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
{
2274
    return bdrv_rw_vmstate(bs, qiov, pos, false);
2275 2276 2277 2278
}

int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size)
2279 2280 2281 2282 2283 2284
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = buf,
        .iov_len    = size,
    };
2285
    int ret;
2286 2287

    qemu_iovec_init_external(&qiov, &iov, 1);
2288 2289 2290 2291 2292 2293
    ret = bdrv_readv_vmstate(bs, &qiov, pos);
    if (ret < 0) {
        return ret;
    }

    return size;
2294 2295 2296
}

int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
2297
{
2298
    return bdrv_rw_vmstate(bs, qiov, pos, true);
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
}

/**************************************************************/
/* 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) {
2312 2313 2314 2315 2316
            /* 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());
2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
            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 */

2338 2339 2340 2341 2342 2343
typedef struct FlushCo {
    BlockDriverState *bs;
    int ret;
} FlushCo;


2344 2345
static void coroutine_fn bdrv_flush_co_entry(void *opaque)
{
2346
    FlushCo *rwco = opaque;
2347 2348 2349 2350 2351 2352

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

int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
{
2353 2354 2355 2356
    int current_gen;
    int ret = 0;

    bdrv_inc_in_flight(bs);
2357

2358
    if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs) ||
2359
        bdrv_is_sg(bs)) {
2360
        goto early_exit;
2361 2362
    }

2363
    qemu_co_mutex_lock(&bs->reqs_lock);
2364
    current_gen = atomic_read(&bs->write_gen);
2365 2366

    /* Wait until any previous flushes are completed */
2367
    while (bs->active_flush_req) {
2368
        qemu_co_queue_wait(&bs->flush_queue, &bs->reqs_lock);
2369 2370
    }

2371
    /* Flushes reach this point in nondecreasing current_gen order.  */
2372
    bs->active_flush_req = true;
2373
    qemu_co_mutex_unlock(&bs->reqs_lock);
2374

P
Pavel Dovgalyuk 已提交
2375 2376 2377 2378 2379 2380
    /* Write back all layers by calling one driver function */
    if (bs->drv->bdrv_co_flush) {
        ret = bs->drv->bdrv_co_flush(bs);
        goto out;
    }

2381 2382 2383 2384 2385
    /* 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 已提交
2386
            goto out;
2387 2388 2389 2390 2391 2392 2393 2394
        }
    }

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

2395 2396 2397 2398 2399
    /* Check if we really need to flush anything */
    if (bs->flushed_gen == current_gen) {
        goto flush_parent;
    }

2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429
    BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_DISK);
    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;
    }
2430

2431
    if (ret < 0) {
F
Fam Zheng 已提交
2432
        goto out;
2433 2434 2435 2436 2437 2438
    }

    /* 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 已提交
2439 2440
    ret = bs->file ? bdrv_co_flush(bs->file->bs) : 0;
out:
2441
    /* Notify any pending flushes that we have completed */
2442 2443 2444
    if (ret == 0) {
        bs->flushed_gen = current_gen;
    }
2445 2446

    qemu_co_mutex_lock(&bs->reqs_lock);
2447
    bs->active_flush_req = false;
2448 2449
    /* Return value is ignored - it's ok if wait queue is empty */
    qemu_co_queue_next(&bs->flush_queue);
2450
    qemu_co_mutex_unlock(&bs->reqs_lock);
2451

2452
early_exit:
2453
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2454
    return ret;
2455 2456 2457 2458 2459
}

int bdrv_flush(BlockDriverState *bs)
{
    Coroutine *co;
2460
    FlushCo flush_co = {
2461 2462 2463 2464 2465 2466
        .bs = bs,
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2467
        bdrv_flush_co_entry(&flush_co);
2468
    } else {
2469
        co = qemu_coroutine_create(bdrv_flush_co_entry, &flush_co);
2470
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2471
        BDRV_POLL_WHILE(bs, flush_co.ret == NOT_DONE);
2472 2473
    }

2474
    return flush_co.ret;
2475 2476 2477 2478
}

typedef struct DiscardCo {
    BlockDriverState *bs;
2479
    int64_t offset;
2480
    int bytes;
2481 2482
    int ret;
} DiscardCo;
2483
static void coroutine_fn bdrv_pdiscard_co_entry(void *opaque)
2484 2485 2486
{
    DiscardCo *rwco = opaque;

2487
    rwco->ret = bdrv_co_pdiscard(rwco->bs, rwco->offset, rwco->bytes);
2488 2489
}

2490
int coroutine_fn bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset,
2491
                                  int bytes)
2492
{
F
Fam Zheng 已提交
2493
    BdrvTrackedRequest req;
2494
    int max_pdiscard, ret;
2495
    int head, tail, align;
2496 2497 2498 2499 2500

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

2501 2502 2503 2504
    if (bdrv_has_readonly_bitmaps(bs)) {
        return -EPERM;
    }

2505
    ret = bdrv_check_byte_request(bs, offset, bytes);
2506 2507 2508
    if (ret < 0) {
        return ret;
    } else if (bs->read_only) {
2509
        return -EPERM;
2510
    }
2511
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
2512 2513 2514 2515 2516 2517

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

E
Eric Blake 已提交
2518
    if (!bs->drv->bdrv_co_pdiscard && !bs->drv->bdrv_aio_pdiscard) {
2519 2520 2521
        return 0;
    }

2522 2523 2524 2525 2526
    /* 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 已提交
2527
    align = MAX(bs->bl.pdiscard_alignment, bs->bl.request_alignment);
2528 2529
    assert(align % bs->bl.request_alignment == 0);
    head = offset % align;
2530
    tail = (offset + bytes) % align;
2531

2532
    bdrv_inc_in_flight(bs);
2533
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_DISCARD);
2534

2535 2536 2537 2538 2539
    ret = notifier_with_return_list_notify(&bs->before_write_notifiers, &req);
    if (ret < 0) {
        goto out;
    }

2540 2541
    max_pdiscard = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_pdiscard, INT_MAX),
                                   align);
2542
    assert(max_pdiscard >= bs->bl.request_alignment);
2543

2544 2545
    while (bytes > 0) {
        int num = bytes;
2546 2547 2548

        if (head) {
            /* Make small requests to get to alignment boundaries. */
2549
            num = MIN(bytes, align - head);
2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
            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;
        }
2569

2570 2571
        if (bs->drv->bdrv_co_pdiscard) {
            ret = bs->drv->bdrv_co_pdiscard(bs, offset, num);
2572 2573 2574 2575 2576 2577
        } else {
            BlockAIOCB *acb;
            CoroutineIOCompletion co = {
                .coroutine = qemu_coroutine_self(),
            };

2578 2579
            acb = bs->drv->bdrv_aio_pdiscard(bs, offset, num,
                                             bdrv_co_io_em_complete, &co);
2580
            if (acb == NULL) {
F
Fam Zheng 已提交
2581 2582
                ret = -EIO;
                goto out;
2583 2584 2585 2586 2587 2588
            } else {
                qemu_coroutine_yield();
                ret = co.ret;
            }
        }
        if (ret && ret != -ENOTSUP) {
F
Fam Zheng 已提交
2589
            goto out;
2590 2591
        }

2592
        offset += num;
2593
        bytes -= num;
2594
    }
F
Fam Zheng 已提交
2595 2596
    ret = 0;
out:
2597
    atomic_inc(&bs->write_gen);
2598
    bdrv_set_dirty(bs, req.offset, req.bytes);
F
Fam Zheng 已提交
2599
    tracked_request_end(&req);
2600
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2601
    return ret;
2602 2603
}

2604
int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2605 2606 2607 2608
{
    Coroutine *co;
    DiscardCo rwco = {
        .bs = bs,
2609
        .offset = offset,
2610
        .bytes = bytes,
2611 2612 2613 2614 2615
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2616
        bdrv_pdiscard_co_entry(&rwco);
2617
    } else {
2618
        co = qemu_coroutine_create(bdrv_pdiscard_co_entry, &rwco);
2619
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2620
        BDRV_POLL_WHILE(bs, rwco.ret == NOT_DONE);
2621 2622 2623 2624 2625
    }

    return rwco.ret;
}

2626
int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf)
2627 2628
{
    BlockDriver *drv = bs->drv;
2629 2630 2631 2632
    CoroutineIOCompletion co = {
        .coroutine = qemu_coroutine_self(),
    };
    BlockAIOCB *acb;
2633

2634
    bdrv_inc_in_flight(bs);
2635
    if (!drv || (!drv->bdrv_aio_ioctl && !drv->bdrv_co_ioctl)) {
2636 2637 2638 2639
        co.ret = -ENOTSUP;
        goto out;
    }

2640 2641 2642 2643 2644 2645 2646 2647 2648
    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();
2649 2650
    }
out:
2651
    bdrv_dec_in_flight(bs);
2652 2653 2654
    return co.ret;
}

2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694
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;
2695
    size_t alignment = bdrv_min_mem_align(bs);
2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716

    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)
{
2717 2718 2719 2720 2721 2722
    BdrvChild *child;

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

2723
    if (atomic_fetch_inc(&bs->io_plugged) == 0) {
2724 2725 2726 2727
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_plug) {
            drv->bdrv_io_plug(bs);
        }
2728 2729 2730 2731 2732
    }
}

void bdrv_io_unplug(BlockDriverState *bs)
{
2733 2734 2735
    BdrvChild *child;

    assert(bs->io_plugged);
2736
    if (atomic_fetch_dec(&bs->io_plugged) == 1) {
2737 2738 2739 2740 2741 2742 2743 2744
        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);
2745 2746
    }
}