io.c 80.1 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
{
    int64_t target_sectors, ret, nb_sectors, sector_num = 0;
720
    BlockDriverState *bs = child->bs;
721 722 723 724 725 726 727 728 729 730 731 732
    int n;

    target_sectors = bdrv_nb_sectors(bs);
    if (target_sectors < 0) {
        return target_sectors;
    }

    for (;;) {
        nb_sectors = MIN(target_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
        if (nb_sectors <= 0) {
            return 0;
        }
733
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &n, NULL);
734 735 736 737 738 739 740 741 742
        if (ret < 0) {
            error_report("error getting block status at sector %" PRId64 ": %s",
                         sector_num, strerror(-ret));
            return ret;
        }
        if (ret & BDRV_BLOCK_ZERO) {
            sector_num += n;
            continue;
        }
743
        ret = bdrv_pwrite_zeroes(child, sector_num << BDRV_SECTOR_BITS,
744
                                 n << BDRV_SECTOR_BITS, flags);
745 746 747 748 749 750 751 752 753
        if (ret < 0) {
            error_report("error writing zeroes at sector %" PRId64 ": %s",
                         sector_num, strerror(-ret));
            return ret;
        }
        sector_num += n;
    }
}

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

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

    return qiov->size;
}

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

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

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

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

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

    return qiov->size;
}

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

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

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

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

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

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

    return 0;
}

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

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

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

857 858 859 860 861 862
    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;
863 864 865 866 867

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

868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
    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;
        }
    }
885 886
}

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

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

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

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

908 909 910 911 912 913
    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,
914 915
                                        flags & bs->supported_write_flags);
        flags &= ~bs->supported_write_flags;
916
    } else if (drv->bdrv_co_writev) {
917
        assert(!bs->supported_write_flags);
918
        ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
919 920 921 922 923 924 925 926 927
    } 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) {
928
            ret = -EIO;
929 930
        } else {
            qemu_coroutine_yield();
931
            ret = co.ret;
932
        }
933 934
    }

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

    return ret;
}

943 944 945 946 947 948 949 950 951 952 953 954 955
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);
}

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

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

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

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

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

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

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

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

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

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

E
Eric Blake 已提交
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 1077
            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;
1078 1079 1080 1081 1082 1083 1084 1085

err:
    qemu_vfree(bounce_buffer);
    return ret;
}

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

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

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

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

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

    if (flags & BDRV_REQ_COPY_ON_READ) {
1128 1129 1130 1131 1132
        /* 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;
1133

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

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

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

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

1158 1159
    while (bytes_remaining) {
        int num;
1160

1161 1162
        if (max_bytes) {
            QEMUIOVector local_qiov;
1163

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

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

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

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

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

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

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

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

1217 1218
    bdrv_inc_in_flight(bs);

1219
    /* Don't do copy-on-read if we read data before write operation */
1220
    if (atomic_read(&bs->copy_on_read) && !(flags & BDRV_REQ_NO_SERIALISING)) {
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 1248
        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);
    }

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

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

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return ret;
}

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

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


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

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

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

}

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

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

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

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

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

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

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

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

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

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

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

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

fail:

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

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

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

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

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

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

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

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


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

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

1807 1808 1809 1810 1811
/*
 * 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.
 *
1812 1813 1814 1815 1816
 * 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'.
 *
1817 1818
 * If 'sector_num' is beyond the end of the disk image the return value is
 * BDRV_BLOCK_EOF and 'pnum' is set to 0.
1819 1820 1821 1822 1823 1824
 *
 * 'pnum' is set to the number of sectors (including and immediately following
 * the specified sector) that are known to be in the same
 * allocated/unallocated state.
 *
 * 'nb_sectors' is the max value 'pnum' should be set to.  If nb_sectors goes
1825 1826
 * 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.
1827
 *
1828 1829 1830
 * If returned value is positive, BDRV_BLOCK_OFFSET_VALID bit is set, and
 * 'file' is non-NULL, then '*file' points to the BDS which the sector range
 * is allocated in.
1831 1832
 */
static int64_t coroutine_fn bdrv_co_get_block_status(BlockDriverState *bs,
1833
                                                     bool want_zero,
1834
                                                     int64_t sector_num,
1835 1836
                                                     int nb_sectors, int *pnum,
                                                     BlockDriverState **file)
1837 1838 1839 1840
{
    int64_t total_sectors;
    int64_t n;
    int64_t ret, ret2;
1841
    BlockDriverState *local_file = NULL;
1842

1843 1844
    assert(pnum);
    *pnum = 0;
1845 1846
    total_sectors = bdrv_nb_sectors(bs);
    if (total_sectors < 0) {
1847 1848
        ret = total_sectors;
        goto early_out;
1849 1850 1851
    }

    if (sector_num >= total_sectors) {
1852 1853
        ret = BDRV_BLOCK_EOF;
        goto early_out;
1854
    }
1855
    if (!nb_sectors) {
1856 1857
        ret = 0;
        goto early_out;
1858
    }
1859 1860 1861 1862 1863 1864 1865 1866 1867

    n = total_sectors - sector_num;
    if (n < nb_sectors) {
        nb_sectors = n;
    }

    if (!bs->drv->bdrv_co_get_block_status) {
        *pnum = nb_sectors;
        ret = BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED;
1868 1869 1870
        if (sector_num + nb_sectors == total_sectors) {
            ret |= BDRV_BLOCK_EOF;
        }
1871 1872
        if (bs->drv->protocol_name) {
            ret |= BDRV_BLOCK_OFFSET_VALID | (sector_num * BDRV_SECTOR_SIZE);
1873
            local_file = bs;
1874
        }
1875
        goto early_out;
1876 1877
    }

1878
    bdrv_inc_in_flight(bs);
1879
    ret = bs->drv->bdrv_co_get_block_status(bs, sector_num, nb_sectors, pnum,
1880
                                            &local_file);
1881 1882
    if (ret < 0) {
        *pnum = 0;
1883
        goto out;
1884 1885 1886
    }

    if (ret & BDRV_BLOCK_RAW) {
1887
        assert(ret & BDRV_BLOCK_OFFSET_VALID && local_file);
1888 1889
        ret = bdrv_co_get_block_status(local_file, want_zero,
                                       ret >> BDRV_SECTOR_BITS,
1890
                                       *pnum, pnum, &local_file);
1891
        goto out;
1892 1893 1894 1895
    }

    if (ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ZERO)) {
        ret |= BDRV_BLOCK_ALLOCATED;
1896
    } else if (want_zero) {
1897 1898
        if (bdrv_unallocated_blocks_are_zero(bs)) {
            ret |= BDRV_BLOCK_ZERO;
1899 1900
        } else if (bs->backing) {
            BlockDriverState *bs2 = bs->backing->bs;
1901
            int64_t nb_sectors2 = bdrv_nb_sectors(bs2);
1902

1903 1904 1905 1906 1907 1908
            if (nb_sectors2 >= 0 && sector_num >= nb_sectors2) {
                ret |= BDRV_BLOCK_ZERO;
            }
        }
    }

1909
    if (want_zero && local_file && local_file != bs &&
1910 1911 1912 1913
        (ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO) &&
        (ret & BDRV_BLOCK_OFFSET_VALID)) {
        int file_pnum;

1914 1915
        ret2 = bdrv_co_get_block_status(local_file, want_zero,
                                        ret >> BDRV_SECTOR_BITS,
1916
                                        *pnum, &file_pnum, NULL);
1917 1918 1919 1920
        if (ret2 >= 0) {
            /* Ignore errors.  This is just providing extra information, it
             * is useful but not necessary.
             */
1921 1922 1923 1924 1925 1926 1927
            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.
                 */
1928 1929 1930 1931 1932 1933 1934 1935 1936
                ret |= BDRV_BLOCK_ZERO;
            } else {
                /* Limit request to the range reported by the protocol driver */
                *pnum = file_pnum;
                ret |= (ret2 & BDRV_BLOCK_ZERO);
            }
        }
    }

1937 1938
out:
    bdrv_dec_in_flight(bs);
1939 1940 1941
    if (ret >= 0 && sector_num + *pnum == total_sectors) {
        ret |= BDRV_BLOCK_EOF;
    }
1942 1943 1944 1945
early_out:
    if (file) {
        *file = local_file;
    }
1946 1947 1948
    return ret;
}

1949 1950
static int64_t coroutine_fn bdrv_co_get_block_status_above(BlockDriverState *bs,
        BlockDriverState *base,
1951
        bool want_zero,
1952 1953
        int64_t sector_num,
        int nb_sectors,
1954 1955
        int *pnum,
        BlockDriverState **file)
1956 1957 1958
{
    BlockDriverState *p;
    int64_t ret = 0;
1959
    bool first = true;
1960 1961

    assert(bs != base);
1962
    for (p = bs; p != base; p = backing_bs(p)) {
1963 1964
        ret = bdrv_co_get_block_status(p, want_zero, sector_num, nb_sectors,
                                       pnum, file);
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
        if (ret < 0) {
            break;
        }
        if (ret & BDRV_BLOCK_ZERO && ret & BDRV_BLOCK_EOF && !first) {
            /*
             * Reading beyond the end of the file continues to read
             * zeroes, but we can only widen the result to the
             * unallocated length we learned from an earlier
             * iteration.
             */
            *pnum = nb_sectors;
        }
        if (ret & (BDRV_BLOCK_ZERO | BDRV_BLOCK_DATA)) {
1978 1979 1980 1981 1982
            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);
1983
        first = false;
1984 1985 1986 1987 1988 1989
    }
    return ret;
}

/* Coroutine wrapper for bdrv_get_block_status_above() */
static void coroutine_fn bdrv_get_block_status_above_co_entry(void *opaque)
1990 1991 1992
{
    BdrvCoGetBlockStatusData *data = opaque;

1993
    data->ret = bdrv_co_get_block_status_above(data->bs, data->base,
1994
                                               data->want_zero,
1995 1996
                                               data->sector_num,
                                               data->nb_sectors,
1997 1998
                                               data->pnum,
                                               data->file);
1999 2000 2001 2002
    data->done = true;
}

/*
2003
 * Synchronous wrapper around bdrv_co_get_block_status_above().
2004
 *
2005
 * See bdrv_co_get_block_status_above() for details.
2006
 */
2007 2008 2009 2010 2011 2012
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)
2013 2014 2015 2016
{
    Coroutine *co;
    BdrvCoGetBlockStatusData data = {
        .bs = bs,
2017
        .base = base,
2018
        .want_zero = want_zero,
2019 2020 2021
        .sector_num = sector_num,
        .nb_sectors = nb_sectors,
        .pnum = pnum,
2022
        .file = file,
2023 2024 2025 2026 2027
        .done = false,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2028
        bdrv_get_block_status_above_co_entry(&data);
2029
    } else {
2030 2031
        co = qemu_coroutine_create(bdrv_get_block_status_above_co_entry,
                                   &data);
2032
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2033
        BDRV_POLL_WHILE(bs, !data.done);
2034 2035 2036 2037
    }
    return data.ret;
}

2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
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);
}

2048 2049
int64_t bdrv_get_block_status(BlockDriverState *bs,
                              int64_t sector_num,
2050 2051
                              int nb_sectors, int *pnum,
                              BlockDriverState **file)
2052
{
2053
    return bdrv_get_block_status_above(bs, backing_bs(bs),
2054
                                       sector_num, nb_sectors, pnum, file);
2055 2056
}

2057 2058
int coroutine_fn bdrv_is_allocated(BlockDriverState *bs, int64_t offset,
                                   int64_t bytes, int64_t *pnum)
2059
{
2060 2061 2062 2063 2064
    int64_t ret;
    int psectors;

    assert(QEMU_IS_ALIGNED(offset, BDRV_SECTOR_SIZE));
    assert(QEMU_IS_ALIGNED(bytes, BDRV_SECTOR_SIZE) && bytes < INT_MAX);
2065 2066 2067 2068
    ret = bdrv_common_block_status_above(bs, backing_bs(bs), false,
                                         offset >> BDRV_SECTOR_BITS,
                                         bytes >> BDRV_SECTOR_BITS, &psectors,
                                         NULL);
2069 2070 2071
    if (ret < 0) {
        return ret;
    }
2072 2073 2074
    if (pnum) {
        *pnum = psectors * BDRV_SECTOR_SIZE;
    }
2075 2076 2077 2078 2079 2080
    return !!(ret & BDRV_BLOCK_ALLOCATED);
}

/*
 * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
 *
2081 2082 2083
 * 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,
2084
 * or negative errno on failure.
2085
 *
2086 2087 2088 2089 2090 2091
 * '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.
2092 2093 2094 2095
 *
 */
int bdrv_is_allocated_above(BlockDriverState *top,
                            BlockDriverState *base,
2096
                            int64_t offset, int64_t bytes, int64_t *pnum)
2097 2098
{
    BlockDriverState *intermediate;
2099 2100
    int ret;
    int64_t n = bytes;
2101 2102 2103

    intermediate = top;
    while (intermediate && intermediate != base) {
2104
        int64_t pnum_inter;
2105
        int64_t size_inter;
2106

2107
        ret = bdrv_is_allocated(intermediate, offset, bytes, &pnum_inter);
2108 2109
        if (ret < 0) {
            return ret;
2110 2111
        }
        if (ret) {
2112
            *pnum = pnum_inter;
2113 2114 2115
            return 1;
        }

2116
        size_inter = bdrv_getlength(intermediate);
2117 2118 2119
        if (size_inter < 0) {
            return size_inter;
        }
2120 2121 2122
        if (n > pnum_inter &&
            (intermediate == top || offset + pnum_inter < size_inter)) {
            n = pnum_inter;
2123 2124
        }

2125
        intermediate = backing_bs(intermediate);
2126 2127 2128 2129 2130 2131
    }

    *pnum = n;
    return 0;
}

2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
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;
2145 2146 2147
    int ret = -ENOTSUP;

    bdrv_inc_in_flight(bs);
2148 2149

    if (!drv) {
2150
        ret = -ENOMEDIUM;
2151
    } else if (drv->bdrv_load_vmstate) {
2152 2153 2154 2155 2156
        if (is_read) {
            ret = drv->bdrv_load_vmstate(bs, qiov, pos);
        } else {
            ret = drv->bdrv_save_vmstate(bs, qiov, pos);
        }
2157
    } else if (bs->file) {
2158
        ret = bdrv_co_rw_vmstate(bs->file->bs, qiov, pos, is_read);
2159 2160
    }

2161 2162
    bdrv_dec_in_flight(bs);
    return ret;
2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184
}

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

2187
        bdrv_coroutine_enter(bs, co);
2188
        BDRV_POLL_WHILE(bs, data.ret == -EINPROGRESS);
2189 2190 2191 2192
        return data.ret;
    }
}

2193 2194 2195 2196 2197 2198 2199 2200
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,
    };
2201
    int ret;
2202 2203

    qemu_iovec_init_external(&qiov, &iov, 1);
2204 2205 2206 2207 2208 2209 2210

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

    return size;
2211 2212 2213 2214
}

int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
{
2215
    return bdrv_rw_vmstate(bs, qiov, pos, false);
2216 2217 2218 2219
}

int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size)
2220 2221 2222 2223 2224 2225
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = buf,
        .iov_len    = size,
    };
2226
    int ret;
2227 2228

    qemu_iovec_init_external(&qiov, &iov, 1);
2229 2230 2231 2232 2233 2234
    ret = bdrv_readv_vmstate(bs, &qiov, pos);
    if (ret < 0) {
        return ret;
    }

    return size;
2235 2236 2237
}

int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
2238
{
2239
    return bdrv_rw_vmstate(bs, qiov, pos, true);
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252
}

/**************************************************************/
/* 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) {
2253 2254 2255 2256 2257
            /* 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());
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278
            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 */

2279 2280 2281 2282 2283 2284
typedef struct FlushCo {
    BlockDriverState *bs;
    int ret;
} FlushCo;


2285 2286
static void coroutine_fn bdrv_flush_co_entry(void *opaque)
{
2287
    FlushCo *rwco = opaque;
2288 2289 2290 2291 2292 2293

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

int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
{
2294 2295 2296 2297
    int current_gen;
    int ret = 0;

    bdrv_inc_in_flight(bs);
2298

2299
    if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs) ||
2300
        bdrv_is_sg(bs)) {
2301
        goto early_exit;
2302 2303
    }

2304
    qemu_co_mutex_lock(&bs->reqs_lock);
2305
    current_gen = atomic_read(&bs->write_gen);
2306 2307

    /* Wait until any previous flushes are completed */
2308
    while (bs->active_flush_req) {
2309
        qemu_co_queue_wait(&bs->flush_queue, &bs->reqs_lock);
2310 2311
    }

2312
    /* Flushes reach this point in nondecreasing current_gen order.  */
2313
    bs->active_flush_req = true;
2314
    qemu_co_mutex_unlock(&bs->reqs_lock);
2315

P
Pavel Dovgalyuk 已提交
2316 2317 2318 2319 2320 2321
    /* Write back all layers by calling one driver function */
    if (bs->drv->bdrv_co_flush) {
        ret = bs->drv->bdrv_co_flush(bs);
        goto out;
    }

2322 2323 2324 2325 2326
    /* 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 已提交
2327
            goto out;
2328 2329 2330 2331 2332 2333 2334 2335
        }
    }

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

2336 2337 2338 2339 2340
    /* Check if we really need to flush anything */
    if (bs->flushed_gen == current_gen) {
        goto flush_parent;
    }

2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370
    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;
    }
2371

2372
    if (ret < 0) {
F
Fam Zheng 已提交
2373
        goto out;
2374 2375 2376 2377 2378 2379
    }

    /* 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 已提交
2380 2381
    ret = bs->file ? bdrv_co_flush(bs->file->bs) : 0;
out:
2382
    /* Notify any pending flushes that we have completed */
2383 2384 2385
    if (ret == 0) {
        bs->flushed_gen = current_gen;
    }
2386 2387

    qemu_co_mutex_lock(&bs->reqs_lock);
2388
    bs->active_flush_req = false;
2389 2390
    /* Return value is ignored - it's ok if wait queue is empty */
    qemu_co_queue_next(&bs->flush_queue);
2391
    qemu_co_mutex_unlock(&bs->reqs_lock);
2392

2393
early_exit:
2394
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2395
    return ret;
2396 2397 2398 2399 2400
}

int bdrv_flush(BlockDriverState *bs)
{
    Coroutine *co;
2401
    FlushCo flush_co = {
2402 2403 2404 2405 2406 2407
        .bs = bs,
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2408
        bdrv_flush_co_entry(&flush_co);
2409
    } else {
2410
        co = qemu_coroutine_create(bdrv_flush_co_entry, &flush_co);
2411
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2412
        BDRV_POLL_WHILE(bs, flush_co.ret == NOT_DONE);
2413 2414
    }

2415
    return flush_co.ret;
2416 2417 2418 2419
}

typedef struct DiscardCo {
    BlockDriverState *bs;
2420
    int64_t offset;
2421
    int bytes;
2422 2423
    int ret;
} DiscardCo;
2424
static void coroutine_fn bdrv_pdiscard_co_entry(void *opaque)
2425 2426 2427
{
    DiscardCo *rwco = opaque;

2428
    rwco->ret = bdrv_co_pdiscard(rwco->bs, rwco->offset, rwco->bytes);
2429 2430
}

2431
int coroutine_fn bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset,
2432
                                  int bytes)
2433
{
F
Fam Zheng 已提交
2434
    BdrvTrackedRequest req;
2435
    int max_pdiscard, ret;
2436
    int head, tail, align;
2437 2438 2439 2440 2441

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

2442 2443 2444 2445
    if (bdrv_has_readonly_bitmaps(bs)) {
        return -EPERM;
    }

2446
    ret = bdrv_check_byte_request(bs, offset, bytes);
2447 2448 2449
    if (ret < 0) {
        return ret;
    } else if (bs->read_only) {
2450
        return -EPERM;
2451
    }
2452
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
2453 2454 2455 2456 2457 2458

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

E
Eric Blake 已提交
2459
    if (!bs->drv->bdrv_co_pdiscard && !bs->drv->bdrv_aio_pdiscard) {
2460 2461 2462
        return 0;
    }

2463 2464 2465 2466 2467
    /* 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 已提交
2468
    align = MAX(bs->bl.pdiscard_alignment, bs->bl.request_alignment);
2469 2470
    assert(align % bs->bl.request_alignment == 0);
    head = offset % align;
2471
    tail = (offset + bytes) % align;
2472

2473
    bdrv_inc_in_flight(bs);
2474
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_DISCARD);
2475

2476 2477 2478 2479 2480
    ret = notifier_with_return_list_notify(&bs->before_write_notifiers, &req);
    if (ret < 0) {
        goto out;
    }

2481 2482
    max_pdiscard = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_pdiscard, INT_MAX),
                                   align);
2483
    assert(max_pdiscard >= bs->bl.request_alignment);
2484

2485 2486
    while (bytes > 0) {
        int num = bytes;
2487 2488 2489

        if (head) {
            /* Make small requests to get to alignment boundaries. */
2490
            num = MIN(bytes, align - head);
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509
            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;
        }
2510

2511 2512
        if (bs->drv->bdrv_co_pdiscard) {
            ret = bs->drv->bdrv_co_pdiscard(bs, offset, num);
2513 2514 2515 2516 2517 2518
        } else {
            BlockAIOCB *acb;
            CoroutineIOCompletion co = {
                .coroutine = qemu_coroutine_self(),
            };

2519 2520
            acb = bs->drv->bdrv_aio_pdiscard(bs, offset, num,
                                             bdrv_co_io_em_complete, &co);
2521
            if (acb == NULL) {
F
Fam Zheng 已提交
2522 2523
                ret = -EIO;
                goto out;
2524 2525 2526 2527 2528 2529
            } else {
                qemu_coroutine_yield();
                ret = co.ret;
            }
        }
        if (ret && ret != -ENOTSUP) {
F
Fam Zheng 已提交
2530
            goto out;
2531 2532
        }

2533
        offset += num;
2534
        bytes -= num;
2535
    }
F
Fam Zheng 已提交
2536 2537
    ret = 0;
out:
2538
    atomic_inc(&bs->write_gen);
2539
    bdrv_set_dirty(bs, req.offset, req.bytes);
F
Fam Zheng 已提交
2540
    tracked_request_end(&req);
2541
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2542
    return ret;
2543 2544
}

2545
int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2546 2547 2548 2549
{
    Coroutine *co;
    DiscardCo rwco = {
        .bs = bs,
2550
        .offset = offset,
2551
        .bytes = bytes,
2552 2553 2554 2555 2556
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2557
        bdrv_pdiscard_co_entry(&rwco);
2558
    } else {
2559
        co = qemu_coroutine_create(bdrv_pdiscard_co_entry, &rwco);
2560
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2561
        BDRV_POLL_WHILE(bs, rwco.ret == NOT_DONE);
2562 2563 2564 2565 2566
    }

    return rwco.ret;
}

2567
int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf)
2568 2569
{
    BlockDriver *drv = bs->drv;
2570 2571 2572 2573
    CoroutineIOCompletion co = {
        .coroutine = qemu_coroutine_self(),
    };
    BlockAIOCB *acb;
2574

2575
    bdrv_inc_in_flight(bs);
2576
    if (!drv || (!drv->bdrv_aio_ioctl && !drv->bdrv_co_ioctl)) {
2577 2578 2579 2580
        co.ret = -ENOTSUP;
        goto out;
    }

2581 2582 2583 2584 2585 2586 2587 2588 2589
    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();
2590 2591
    }
out:
2592
    bdrv_dec_in_flight(bs);
2593 2594 2595
    return co.ret;
}

2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635
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;
2636
    size_t alignment = bdrv_min_mem_align(bs);
2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657

    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)
{
2658 2659 2660 2661 2662 2663
    BdrvChild *child;

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

2664
    if (atomic_fetch_inc(&bs->io_plugged) == 0) {
2665 2666 2667 2668
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_plug) {
            drv->bdrv_io_plug(bs);
        }
2669 2670 2671 2672 2673
    }
}

void bdrv_io_unplug(BlockDriverState *bs)
{
2674 2675 2676
    BdrvChild *child;

    assert(bs->io_plugged);
2677
    if (atomic_fetch_dec(&bs->io_plugged) == 1) {
2678 2679 2680 2681 2682 2683 2684 2685
        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);
2686 2687
    }
}