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

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

36
static BlockAIOCB *bdrv_co_aio_rw_vector(BdrvChild *child,
37 38 39 40 41 42 43 44
                                         int64_t sector_num,
                                         QEMUIOVector *qiov,
                                         int nb_sectors,
                                         BdrvRequestFlags flags,
                                         BlockCompletionFunc *cb,
                                         void *opaque,
                                         bool is_write);
static void coroutine_fn bdrv_co_do_rw(void *opaque);
E
Eric Blake 已提交
45 46
static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
    int64_t offset, int count, BdrvRequestFlags flags);
47

48
static void bdrv_parent_drained_begin(BlockDriverState *bs)
49
{
50
    BdrvChild *c;
51

52 53 54 55
    QLIST_FOREACH(c, &bs->parents, next_parent) {
        if (c->role->drained_begin) {
            c->role->drained_begin(c);
        }
56 57
    }
}
58

59
static void bdrv_parent_drained_end(BlockDriverState *bs)
60
{
61
    BdrvChild *c;
62

63 64 65 66
    QLIST_FOREACH(c, &bs->parents, next_parent) {
        if (c->role->drained_end) {
            c->role->drained_end(c);
        }
67
    }
68 69
}

70 71 72 73 74 75 76 77 78 79 80
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);
}

81 82 83 84 85 86 87 88 89 90 91
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;
    }

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

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

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

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

    /* 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)
{
    bs->copy_on_read++;
}

void bdrv_disable_copy_on_read(BlockDriverState *bs)
{
    assert(bs->copy_on_read > 0);
    bs->copy_on_read--;
}

/* Check if any requests are in-flight (including throttled requests) */
143
bool bdrv_requests_pending(BlockDriverState *bs)
144
{
145 146
    BdrvChild *child;

147 148 149
    if (!QLIST_EMPTY(&bs->tracked_requests)) {
        return true;
    }
150 151 152 153 154

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

157 158 159
    return false;
}

160 161 162 163 164 165 166 167 168 169 170 171
static void bdrv_drain_recurse(BlockDriverState *bs)
{
    BdrvChild *child;

    if (bs->drv && bs->drv->bdrv_drain) {
        bs->drv->bdrv_drain(bs);
    }
    QLIST_FOREACH(child, &bs->children, next) {
        bdrv_drain_recurse(child->bs);
    }
}

F
Fam Zheng 已提交
172 173 174 175 176 177 178
typedef struct {
    Coroutine *co;
    BlockDriverState *bs;
    QEMUBH *bh;
    bool done;
} BdrvCoDrainData;

179 180 181 182 183 184 185 186 187 188 189
static void bdrv_drain_poll(BlockDriverState *bs)
{
    bool busy = true;

    while (busy) {
        /* Keep iterating */
        busy = bdrv_requests_pending(bs);
        busy |= aio_poll(bdrv_get_aio_context(bs), busy);
    }
}

F
Fam Zheng 已提交
190 191 192 193 194 195
static void bdrv_co_drain_bh_cb(void *opaque)
{
    BdrvCoDrainData *data = opaque;
    Coroutine *co = data->co;

    qemu_bh_delete(data->bh);
196
    bdrv_drain_poll(data->bs);
F
Fam Zheng 已提交
197
    data->done = true;
198
    qemu_coroutine_enter(co);
F
Fam Zheng 已提交
199 200
}

201
static void coroutine_fn bdrv_co_yield_to_drain(BlockDriverState *bs)
F
Fam Zheng 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
{
    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,
        .bh = aio_bh_new(bdrv_get_aio_context(bs), bdrv_co_drain_bh_cb, &data),
    };
    qemu_bh_schedule(data.bh);

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

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
void bdrv_drained_begin(BlockDriverState *bs)
{
    if (!bs->quiesce_counter++) {
        aio_disable_external(bdrv_get_aio_context(bs));
        bdrv_parent_drained_begin(bs);
    }

    bdrv_io_unplugged_begin(bs);
    bdrv_drain_recurse(bs);
    if (qemu_in_coroutine()) {
        bdrv_co_yield_to_drain(bs);
    } else {
        bdrv_drain_poll(bs);
    }
    bdrv_io_unplugged_end(bs);
}

void bdrv_drained_end(BlockDriverState *bs)
{
    assert(bs->quiesce_counter > 0);
    if (--bs->quiesce_counter > 0) {
        return;
    }

    bdrv_parent_drained_end(bs);
    aio_enable_external(bdrv_get_aio_context(bs));
}

252
/*
253 254
 * Wait for pending requests to complete on a single BlockDriverState subtree,
 * and suspend block driver's internal I/O until next request arrives.
255 256 257
 *
 * Note that unlike bdrv_drain_all(), the caller must hold the BlockDriverState
 * AioContext.
258 259 260 261
 *
 * 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.
262
 */
263
void coroutine_fn bdrv_co_drain(BlockDriverState *bs)
264
{
265 266 267
    assert(qemu_in_coroutine());
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
268
}
269

270 271
void bdrv_drain(BlockDriverState *bs)
{
272 273
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
274 275 276 277 278 279 280 281 282 283 284 285
}

/*
 * 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.
 */
void bdrv_drain_all(void)
{
    /* Always run first iteration so any pending completion BHs run */
    bool busy = true;
K
Kevin Wolf 已提交
286
    BlockDriverState *bs;
K
Kevin Wolf 已提交
287
    BdrvNextIterator it;
288
    BlockJob *job = NULL;
289
    GSList *aio_ctxs = NULL, *ctx;
290

291 292 293 294 295 296 297 298
    while ((job = block_job_next(job))) {
        AioContext *aio_context = blk_get_aio_context(job->blk);

        aio_context_acquire(aio_context);
        block_job_pause(job);
        aio_context_release(aio_context);
    }

K
Kevin Wolf 已提交
299
    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
300 301 302
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
303
        bdrv_parent_drained_begin(bs);
304
        bdrv_io_unplugged_begin(bs);
305
        bdrv_drain_recurse(bs);
306
        aio_context_release(aio_context);
307

308
        if (!g_slist_find(aio_ctxs, aio_context)) {
309 310
            aio_ctxs = g_slist_prepend(aio_ctxs, aio_context);
        }
311 312
    }

313 314 315 316 317 318
    /* 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.
     */
319 320 321
    while (busy) {
        busy = false;

322 323
        for (ctx = aio_ctxs; ctx != NULL; ctx = ctx->next) {
            AioContext *aio_context = ctx->data;
324 325

            aio_context_acquire(aio_context);
K
Kevin Wolf 已提交
326
            for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
327 328 329 330 331 332 333 334
                if (aio_context == bdrv_get_aio_context(bs)) {
                    if (bdrv_requests_pending(bs)) {
                        busy = true;
                        aio_poll(aio_context, busy);
                    }
                }
            }
            busy |= aio_poll(aio_context, false);
335 336 337 338
            aio_context_release(aio_context);
        }
    }

K
Kevin Wolf 已提交
339
    for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
340 341 342
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
343
        bdrv_io_unplugged_end(bs);
344
        bdrv_parent_drained_end(bs);
345 346
        aio_context_release(aio_context);
    }
347
    g_slist_free(aio_ctxs);
348 349 350 351 352 353 354 355 356

    job = NULL;
    while ((job = block_job_next(job))) {
        AioContext *aio_context = blk_get_aio_context(job->blk);

        aio_context_acquire(aio_context);
        block_job_resume(job);
        aio_context_release(aio_context);
    }
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
}

/**
 * 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) {
        req->bs->serialising_in_flight--;
    }

    QLIST_REMOVE(req, list);
    qemu_co_queue_restart_all(&req->wait_queue);
}

/**
 * Add an active request to the tracked requests list
 */
static void tracked_request_begin(BdrvTrackedRequest *req,
                                  BlockDriverState *bs,
                                  int64_t offset,
380 381
                                  unsigned int bytes,
                                  enum BdrvTrackedRequestType type)
382 383 384 385 386
{
    *req = (BdrvTrackedRequest){
        .bs = bs,
        .offset         = offset,
        .bytes          = bytes,
387
        .type           = type,
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
        .co             = qemu_coroutine_self(),
        .serialising    = false,
        .overlap_offset = offset,
        .overlap_bytes  = bytes,
    };

    qemu_co_queue_init(&req->wait_queue);

    QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
}

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) {
        req->bs->serialising_in_flight++;
        req->serialising = true;
    }

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

/**
415
 * Round a region to cluster boundaries (sector-based)
416
 */
417 418 419 420
void bdrv_round_sectors_to_clusters(BlockDriverState *bs,
                                    int64_t sector_num, int nb_sectors,
                                    int64_t *cluster_sector_num,
                                    int *cluster_nb_sectors)
421 422 423 424 425 426 427 428 429 430 431 432 433 434
{
    BlockDriverInfo bdi;

    if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
        *cluster_sector_num = sector_num;
        *cluster_nb_sectors = nb_sectors;
    } else {
        int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE;
        *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c);
        *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num +
                                            nb_sectors, c);
    }
}

435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
/**
 * Round a region to cluster boundaries
 */
void bdrv_round_to_clusters(BlockDriverState *bs,
                            int64_t offset, unsigned int bytes,
                            int64_t *cluster_offset,
                            unsigned int *cluster_bytes)
{
    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);
    }
}

455 456 457 458 459 460 461
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) {
462
        return bs->bl.request_alignment;
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
    } 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;
}

static bool coroutine_fn wait_serialising_requests(BdrvTrackedRequest *self)
{
    BlockDriverState *bs = self->bs;
    BdrvTrackedRequest *req;
    bool retry;
    bool waited = false;

    if (!bs->serialising_in_flight) {
        return false;
    }

    do {
        retry = false;
        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;
                    qemu_co_queue_wait(&req->wait_queue);
                    self->waiting_for = NULL;
                    retry = true;
                    waited = true;
                    break;
                }
            }
        }
    } 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;
}

static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
                              int nb_sectors)
{
    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EIO;
    }

    return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
                                   nb_sectors * BDRV_SECTOR_SIZE);
}

typedef struct RwCo {
556
    BdrvChild *child;
557 558 559 560 561 562 563 564 565 566 567 568
    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) {
569
        rwco->ret = bdrv_co_preadv(rwco->child, rwco->offset,
570 571
                                   rwco->qiov->size, rwco->qiov,
                                   rwco->flags);
572
    } else {
573
        rwco->ret = bdrv_co_pwritev(rwco->child, rwco->offset,
574 575
                                    rwco->qiov->size, rwco->qiov,
                                    rwco->flags);
576 577 578 579 580 581
    }
}

/*
 * Process a vectored synchronous request using coroutines
 */
582
static int bdrv_prwv_co(BdrvChild *child, int64_t offset,
583 584 585 586 587
                        QEMUIOVector *qiov, bool is_write,
                        BdrvRequestFlags flags)
{
    Coroutine *co;
    RwCo rwco = {
588
        .child = child,
589 590 591 592 593 594 595 596 597 598 599
        .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 {
600
        AioContext *aio_context = bdrv_get_aio_context(child->bs);
601

602 603
        co = qemu_coroutine_create(bdrv_rw_co_entry, &rwco);
        qemu_coroutine_enter(co);
604 605 606 607 608 609 610 611 612 613
        while (rwco.ret == NOT_DONE) {
            aio_poll(aio_context, true);
        }
    }
    return rwco.ret;
}

/*
 * Process a synchronous request using coroutines
 */
614
static int bdrv_rw_co(BdrvChild *child, int64_t sector_num, uint8_t *buf,
615 616 617 618 619 620 621 622 623 624 625 626 627
                      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);
628
    return bdrv_prwv_co(child, sector_num << BDRV_SECTOR_BITS,
629 630 631 632
                        &qiov, is_write, flags);
}

/* return < 0 if error. See bdrv_write() for the return codes */
633
int bdrv_read(BdrvChild *child, int64_t sector_num,
634 635
              uint8_t *buf, int nb_sectors)
{
636
    return bdrv_rw_co(child, sector_num, buf, nb_sectors, false, 0);
637 638 639 640 641 642 643 644
}

/* 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
*/
645
int bdrv_write(BdrvChild *child, int64_t sector_num,
646 647
               const uint8_t *buf, int nb_sectors)
{
648
    return bdrv_rw_co(child, sector_num, (uint8_t *)buf, nb_sectors, true, 0);
649 650
}

651
int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
652
                       int count, BdrvRequestFlags flags)
653
{
654 655 656 657 658 659 660
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = NULL,
        .iov_len = count,
    };

    qemu_iovec_init_external(&qiov, &iov, 1);
661
    return bdrv_prwv_co(child, offset, &qiov, true,
662
                        BDRV_REQ_ZERO_WRITE | flags);
663 664 665
}

/*
666
 * Completely zero out a block device with the help of bdrv_pwrite_zeroes.
667 668
 * 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
669
 * flags are passed through to bdrv_pwrite_zeroes (e.g. BDRV_REQ_MAY_UNMAP,
670
 * BDRV_REQ_FUA).
671 672 673
 *
 * Returns < 0 on error, 0 on success. For error codes see bdrv_write().
 */
674
int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags)
675 676
{
    int64_t target_sectors, ret, nb_sectors, sector_num = 0;
677
    BlockDriverState *bs = child->bs;
678
    BlockDriverState *file;
679 680 681 682 683 684 685 686 687 688 689 690
    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;
        }
691
        ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &n, &file);
692 693 694 695 696 697 698 699 700
        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;
        }
701
        ret = bdrv_pwrite_zeroes(child, sector_num << BDRV_SECTOR_BITS,
702
                                 n << BDRV_SECTOR_BITS, flags);
703 704 705 706 707 708 709 710 711
        if (ret < 0) {
            error_report("error writing zeroes at sector %" PRId64 ": %s",
                         sector_num, strerror(-ret));
            return ret;
        }
        sector_num += n;
    }
}

712
int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
K
Kevin Wolf 已提交
713 714 715
{
    int ret;

716
    ret = bdrv_prwv_co(child, offset, qiov, false, 0);
K
Kevin Wolf 已提交
717 718 719 720 721 722 723
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

724
int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes)
725 726 727 728 729 730 731 732 733 734 735 736
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = (void *)buf,
        .iov_len = bytes,
    };

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

    qemu_iovec_init_external(&qiov, &iov, 1);
737
    return bdrv_preadv(child, offset, &qiov);
738 739
}

740
int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
741 742 743
{
    int ret;

744
    ret = bdrv_prwv_co(child, offset, qiov, true, 0);
745 746 747 748 749 750 751
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

752
int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes)
753 754 755 756 757 758 759 760 761 762 763 764
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = (void *) buf,
        .iov_len    = bytes,
    };

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

    qemu_iovec_init_external(&qiov, &iov, 1);
765
    return bdrv_pwritev(child, offset, &qiov);
766 767 768 769 770 771 772 773
}

/*
 * 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.
 */
774 775
int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
                     const void *buf, int count)
776 777 778
{
    int ret;

779
    ret = bdrv_pwrite(child, offset, buf, count);
780 781 782 783
    if (ret < 0) {
        return ret;
    }

784
    ret = bdrv_flush(child->bs);
785 786
    if (ret < 0) {
        return ret;
787 788 789 790 791
    }

    return 0;
}

792 793 794 795 796 797 798 799 800 801
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;
802
    qemu_coroutine_enter(co->coroutine);
803 804
}

805 806 807 808 809
static int coroutine_fn bdrv_driver_preadv(BlockDriverState *bs,
                                           uint64_t offset, uint64_t bytes,
                                           QEMUIOVector *qiov, int flags)
{
    BlockDriver *drv = bs->drv;
810 811 812
    int64_t sector_num;
    unsigned int nb_sectors;

813 814
    assert(!(flags & ~BDRV_REQ_MASK));

815 816 817 818 819 820
    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;
821 822 823 824 825

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

826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
    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;
        }
    }
843 844
}

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

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

856
    if (drv->bdrv_co_pwritev) {
857 858 859
        ret = drv->bdrv_co_pwritev(bs, offset, bytes, qiov,
                                   flags & bs->supported_write_flags);
        flags &= ~bs->supported_write_flags;
860 861 862 863 864 865
        goto emulate_flags;
    }

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

866 867 868 869 870 871
    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,
872 873
                                        flags & bs->supported_write_flags);
        flags &= ~bs->supported_write_flags;
874
    } else if (drv->bdrv_co_writev) {
875
        assert(!bs->supported_write_flags);
876
        ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
877 878 879 880 881 882 883 884 885
    } 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) {
886
            ret = -EIO;
887 888
        } else {
            qemu_coroutine_yield();
889
            ret = co.ret;
890
        }
891 892
    }

893
emulate_flags:
894
    if (ret == 0 && (flags & BDRV_REQ_FUA)) {
895 896 897 898 899 900
        ret = bdrv_co_flush(bs);
    }

    return ret;
}

901
static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs,
902
        int64_t offset, unsigned int bytes, QEMUIOVector *qiov)
903 904 905 906 907 908 909 910 911 912 913
{
    /* 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;
    QEMUIOVector bounce_qiov;
914 915
    int64_t cluster_offset;
    unsigned int cluster_bytes;
916 917 918 919 920 921
    size_t skip_bytes;
    int ret;

    /* Cover entire cluster so no additional backing file I/O is required when
     * allocating cluster in the image file.
     */
922
    bdrv_round_to_clusters(bs, offset, bytes, &cluster_offset, &cluster_bytes);
923

924 925
    trace_bdrv_co_do_copy_on_readv(bs, offset, bytes,
                                   cluster_offset, cluster_bytes);
926

927
    iov.iov_len = cluster_bytes;
928 929 930 931 932 933 934 935
    iov.iov_base = bounce_buffer = qemu_try_blockalign(bs, iov.iov_len);
    if (bounce_buffer == NULL) {
        ret = -ENOMEM;
        goto err;
    }

    qemu_iovec_init_external(&bounce_qiov, &iov, 1);

936
    ret = bdrv_driver_preadv(bs, cluster_offset, cluster_bytes,
937
                             &bounce_qiov, 0);
938 939 940 941
    if (ret < 0) {
        goto err;
    }

E
Eric Blake 已提交
942
    if (drv->bdrv_co_pwrite_zeroes &&
943
        buffer_is_zero(bounce_buffer, iov.iov_len)) {
944 945 946
        /* 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? */
947
        ret = bdrv_co_do_pwrite_zeroes(bs, cluster_offset, cluster_bytes, 0);
948 949 950 951
    } else {
        /* This does not change the data on the disk, it is not necessary
         * to flush even in cache=writethrough mode.
         */
952
        ret = bdrv_driver_pwritev(bs, cluster_offset, cluster_bytes,
953
                                  &bounce_qiov, 0);
954 955 956 957 958 959 960 961 962 963
    }

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

964 965
    skip_bytes = offset - cluster_offset;
    qemu_iovec_from_buf(qiov, 0, bounce_buffer + skip_bytes, bytes);
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980

err:
    qemu_vfree(bounce_buffer);
    return ret;
}

/*
 * Forwards an already correctly aligned request to the BlockDriver. This
 * handles copy on read and zeroing after EOF; any other features must be
 * implemented by the caller.
 */
static int coroutine_fn bdrv_aligned_preadv(BlockDriverState *bs,
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
    int64_t align, QEMUIOVector *qiov, int flags)
{
K
Kevin Wolf 已提交
981
    int64_t total_bytes, max_bytes;
982 983
    int ret;

984 985 986
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
987
    assert(!qiov || bytes == qiov->size);
988
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
989 990 991 992 993 994

    /* 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)));
995 996 997 998 999 1000 1001 1002 1003 1004 1005

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

1006 1007 1008
    if (!(flags & BDRV_REQ_NO_SERIALISING)) {
        wait_serialising_requests(req);
    }
1009 1010

    if (flags & BDRV_REQ_COPY_ON_READ) {
1011 1012 1013
        int64_t start_sector = offset >> BDRV_SECTOR_BITS;
        int64_t end_sector = DIV_ROUND_UP(offset + bytes, BDRV_SECTOR_SIZE);
        unsigned int nb_sectors = end_sector - start_sector;
1014 1015
        int pnum;

1016
        ret = bdrv_is_allocated(bs, start_sector, nb_sectors, &pnum);
1017 1018 1019 1020 1021
        if (ret < 0) {
            goto out;
        }

        if (!ret || pnum != nb_sectors) {
1022
            ret = bdrv_co_do_copy_on_readv(bs, offset, bytes, qiov);
1023 1024 1025 1026 1027
            goto out;
        }
    }

    /* Forward the request to the BlockDriver */
K
Kevin Wolf 已提交
1028 1029 1030 1031 1032
    total_bytes = bdrv_getlength(bs);
    if (total_bytes < 0) {
        ret = total_bytes;
        goto out;
    }
1033

K
Kevin Wolf 已提交
1034
    max_bytes = ROUND_UP(MAX(0, total_bytes - offset), align);
1035
    if (bytes <= max_bytes) {
K
Kevin Wolf 已提交
1036 1037 1038
        ret = bdrv_driver_preadv(bs, offset, bytes, qiov, 0);
    } else if (max_bytes > 0) {
        QEMUIOVector local_qiov;
1039

K
Kevin Wolf 已提交
1040 1041
        qemu_iovec_init(&local_qiov, qiov->niov);
        qemu_iovec_concat(&local_qiov, qiov, 0, max_bytes);
1042

K
Kevin Wolf 已提交
1043
        ret = bdrv_driver_preadv(bs, offset, max_bytes, &local_qiov, 0);
1044

K
Kevin Wolf 已提交
1045 1046 1047 1048
        qemu_iovec_destroy(&local_qiov);
    } else {
        ret = 0;
    }
1049

K
Kevin Wolf 已提交
1050 1051 1052 1053 1054
    /* Reading beyond end of file is supposed to produce zeroes */
    if (ret == 0 && total_bytes < offset + bytes) {
        uint64_t zero_offset = MAX(0, total_bytes - offset);
        uint64_t zero_bytes = offset + bytes - zero_offset;
        qemu_iovec_memset(qiov, zero_offset, 0, zero_bytes);
1055 1056 1057 1058 1059 1060 1061 1062 1063
    }

out:
    return ret;
}

/*
 * Handle a read request in coroutine context
 */
1064
int coroutine_fn bdrv_co_preadv(BdrvChild *child,
1065 1066 1067
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1068
    BlockDriverState *bs = child->bs;
1069 1070 1071
    BlockDriver *drv = bs->drv;
    BdrvTrackedRequest req;

1072
    uint64_t align = bs->bl.request_alignment;
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

    if (!drv) {
        return -ENOMEDIUM;
    }

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

1088
    /* Don't do copy-on-read if we read data before write operation */
1089
    if (bs->copy_on_read && !(flags & BDRV_REQ_NO_SERIALISING)) {
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
        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);
    }

1118
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_READ);
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
    ret = bdrv_aligned_preadv(bs, &req, offset, bytes, align,
                              use_local_qiov ? &local_qiov : qiov,
                              flags);
    tracked_request_end(&req);

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

    return ret;
}

1133
static int coroutine_fn bdrv_co_do_readv(BdrvChild *child,
1134 1135 1136 1137 1138 1139 1140
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EINVAL;
    }

1141
    return bdrv_co_preadv(child, sector_num << BDRV_SECTOR_BITS,
1142
                          nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1143 1144
}

1145 1146
int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num,
                               int nb_sectors, QEMUIOVector *qiov)
1147
{
1148
    trace_bdrv_co_readv(child->bs, sector_num, nb_sectors);
1149

1150
    return bdrv_co_do_readv(child, sector_num, nb_sectors, qiov, 0);
1151 1152
}

1153 1154
/* Maximum buffer for write zeroes fallback, in bytes */
#define MAX_WRITE_ZEROES_BOUNCE_BUFFER (32768 << BDRV_SECTOR_BITS)
1155

E
Eric Blake 已提交
1156 1157
static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
    int64_t offset, int count, BdrvRequestFlags flags)
1158 1159 1160 1161 1162
{
    BlockDriver *drv = bs->drv;
    QEMUIOVector qiov;
    struct iovec iov = {0};
    int ret = 0;
1163
    bool need_flush = false;
1164 1165
    int head = 0;
    int tail = 0;
1166

1167
    int max_write_zeroes = MIN_NON_ZERO(bs->bl.max_pwrite_zeroes, INT_MAX);
1168 1169
    int alignment = MAX(bs->bl.pwrite_zeroes_alignment,
                        bs->bl.request_alignment);
E
Eric Blake 已提交
1170 1171 1172 1173 1174

    assert(is_power_of_2(alignment));
    head = offset & (alignment - 1);
    tail = (offset + count) & (alignment - 1);
    max_write_zeroes &= ~(alignment - 1);
1175

E
Eric Blake 已提交
1176 1177
    while (count > 0 && !ret) {
        int num = count;
1178 1179

        /* Align request.  Block drivers can expect the "bulk" of the request
1180 1181
         * to be aligned, and that unaligned requests do not cross cluster
         * boundaries.
1182
         */
1183 1184
        if (head) {
            /* Make a small request up to the first aligned sector.  */
E
Eric Blake 已提交
1185
            num = MIN(count, alignment - head);
1186
            head = 0;
E
Eric Blake 已提交
1187
        } else if (tail && num > alignment) {
1188 1189
            /* Shorten the request to the last aligned sector.  */
            num -= tail;
1190 1191 1192 1193 1194 1195 1196 1197 1198
        }

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

        ret = -ENOTSUP;
        /* First try the efficient write zeroes operation */
E
Eric Blake 已提交
1199 1200 1201 1202 1203 1204 1205
        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;
            }
1206 1207
        } else {
            assert(!bs->supported_zero_flags);
1208 1209 1210 1211
        }

        if (ret == -ENOTSUP) {
            /* Fall back to bounce buffer if write zeroes is unsupported */
1212
            int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer,
1213
                                            MAX_WRITE_ZEROES_BOUNCE_BUFFER);
1214 1215 1216 1217 1218 1219 1220 1221 1222
            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;
            }
1223
            num = MIN(num, max_transfer);
E
Eric Blake 已提交
1224
            iov.iov_len = num;
1225
            if (iov.iov_base == NULL) {
E
Eric Blake 已提交
1226
                iov.iov_base = qemu_try_blockalign(bs, num);
1227 1228 1229 1230
                if (iov.iov_base == NULL) {
                    ret = -ENOMEM;
                    goto fail;
                }
E
Eric Blake 已提交
1231
                memset(iov.iov_base, 0, num);
1232 1233 1234
            }
            qemu_iovec_init_external(&qiov, &iov, 1);

E
Eric Blake 已提交
1235
            ret = bdrv_driver_pwritev(bs, offset, num, &qiov, write_flags);
1236 1237 1238 1239

            /* Keep bounce buffer around if it is big enough for all
             * all future requests.
             */
1240
            if (num < max_transfer) {
1241 1242 1243 1244 1245
                qemu_vfree(iov.iov_base);
                iov.iov_base = NULL;
            }
        }

E
Eric Blake 已提交
1246 1247
        offset += num;
        count -= num;
1248 1249 1250
    }

fail:
1251 1252 1253
    if (ret == 0 && need_flush) {
        ret = bdrv_co_flush(bs);
    }
1254 1255 1256 1257 1258 1259 1260 1261 1262
    qemu_vfree(iov.iov_base);
    return ret;
}

/*
 * Forwards an already correctly aligned write request to the BlockDriver.
 */
static int coroutine_fn bdrv_aligned_pwritev(BlockDriverState *bs,
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
1263
    int64_t align, QEMUIOVector *qiov, int flags)
1264 1265 1266 1267 1268
{
    BlockDriver *drv = bs->drv;
    bool waited;
    int ret;

1269 1270
    int64_t start_sector = offset >> BDRV_SECTOR_BITS;
    int64_t end_sector = DIV_ROUND_UP(offset + bytes, BDRV_SECTOR_SIZE);
1271

1272 1273 1274
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
1275
    assert(!qiov || bytes == qiov->size);
1276
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1277
    assert(!(flags & ~BDRV_REQ_MASK));
1278 1279 1280 1281 1282 1283 1284 1285 1286

    waited = wait_serialising_requests(req);
    assert(!waited || !req->serialising);
    assert(req->overlap_offset <= offset);
    assert(offset + bytes <= req->overlap_offset + req->overlap_bytes);

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

    if (!ret && bs->detect_zeroes != BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF &&
E
Eric Blake 已提交
1287
        !(flags & BDRV_REQ_ZERO_WRITE) && drv->bdrv_co_pwrite_zeroes &&
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
        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 已提交
1298
        bdrv_debug_event(bs, BLKDBG_PWRITEV_ZERO);
1299
        ret = bdrv_co_do_pwrite_zeroes(bs, offset, bytes, flags);
1300
    } else {
K
Kevin Wolf 已提交
1301
        bdrv_debug_event(bs, BLKDBG_PWRITEV);
1302
        ret = bdrv_driver_pwritev(bs, offset, bytes, qiov, flags);
1303
    }
K
Kevin Wolf 已提交
1304
    bdrv_debug_event(bs, BLKDBG_PWRITEV_DONE);
1305

1306
    ++bs->write_gen;
1307
    bdrv_set_dirty(bs, start_sector, end_sector - start_sector);
1308

1309 1310 1311
    if (bs->wr_highest_offset < offset + bytes) {
        bs->wr_highest_offset = offset + bytes;
    }
1312 1313

    if (ret >= 0) {
1314
        bs->total_sectors = MAX(bs->total_sectors, end_sector);
1315 1316 1317 1318 1319
    }

    return ret;
}

1320 1321 1322 1323 1324 1325 1326 1327 1328
static int coroutine_fn bdrv_co_do_zero_pwritev(BlockDriverState *bs,
                                                int64_t offset,
                                                unsigned int bytes,
                                                BdrvRequestFlags flags,
                                                BdrvTrackedRequest *req)
{
    uint8_t *buf = NULL;
    QEMUIOVector local_qiov;
    struct iovec iov;
1329
    uint64_t align = bs->bl.request_alignment;
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
    unsigned int head_padding_bytes, tail_padding_bytes;
    int ret = 0;

    head_padding_bytes = offset & (align - 1);
    tail_padding_bytes = align - ((offset + bytes) & (align - 1));


    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 已提交
1352
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1353 1354 1355 1356 1357
        ret = bdrv_aligned_preadv(bs, req, offset & ~(align - 1), align,
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1358
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1359 1360 1361

        memset(buf + head_padding_bytes, 0, zero_bytes);
        ret = bdrv_aligned_pwritev(bs, req, offset & ~(align - 1), align,
1362
                                   align, &local_qiov,
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
                                   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);
1375
        ret = bdrv_aligned_pwritev(bs, req, offset, aligned_bytes, align,
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
                                   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 已提交
1390
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1391 1392 1393 1394 1395
        ret = bdrv_aligned_preadv(bs, req, offset, align,
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1396
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1397 1398

        memset(buf, 0, bytes);
1399
        ret = bdrv_aligned_pwritev(bs, req, offset, align, align,
1400 1401 1402 1403 1404 1405 1406 1407
                                   &local_qiov, flags & ~BDRV_REQ_ZERO_WRITE);
    }
fail:
    qemu_vfree(buf);
    return ret;

}

1408 1409 1410
/*
 * Handle a write request in coroutine context
 */
1411
int coroutine_fn bdrv_co_pwritev(BdrvChild *child,
1412 1413 1414
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1415
    BlockDriverState *bs = child->bs;
1416
    BdrvTrackedRequest req;
1417
    uint64_t align = bs->bl.request_alignment;
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

    if (!bs->drv) {
        return -ENOMEDIUM;
    }
    if (bs->read_only) {
1428
        return -EPERM;
1429
    }
1430
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441

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

    /*
     * 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.
     */
1442
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_WRITE);
1443

1444 1445 1446 1447 1448
    if (!qiov) {
        ret = bdrv_co_do_zero_pwritev(bs, offset, bytes, flags, &req);
        goto out;
    }

1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
    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 已提交
1463
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1464 1465 1466 1467 1468
        ret = bdrv_aligned_preadv(bs, &req, offset & ~(align - 1), align,
                                  align, &head_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1469
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1470 1471 1472 1473 1474 1475 1476 1477

        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);
1478 1479 1480 1481 1482 1483 1484 1485

        /* 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;
        }
1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
    }

    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 已提交
1505
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1506 1507 1508 1509 1510
        ret = bdrv_aligned_preadv(bs, &req, (offset + bytes) & ~(align - 1), align,
                                  align, &tail_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1511
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524

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

1525
    ret = bdrv_aligned_pwritev(bs, &req, offset, bytes, align,
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
                               use_local_qiov ? &local_qiov : qiov,
                               flags);

fail:

    if (use_local_qiov) {
        qemu_iovec_destroy(&local_qiov);
    }
    qemu_vfree(head_buf);
    qemu_vfree(tail_buf);
1536 1537
out:
    tracked_request_end(&req);
1538 1539 1540
    return ret;
}

1541
static int coroutine_fn bdrv_co_do_writev(BdrvChild *child,
1542 1543 1544 1545 1546 1547 1548
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
    if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
        return -EINVAL;
    }

1549
    return bdrv_co_pwritev(child, sector_num << BDRV_SECTOR_BITS,
1550
                           nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1551 1552
}

1553
int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num,
1554 1555
    int nb_sectors, QEMUIOVector *qiov)
{
1556
    trace_bdrv_co_writev(child->bs, sector_num, nb_sectors);
1557

1558
    return bdrv_co_do_writev(child, sector_num, nb_sectors, qiov, 0);
1559 1560
}

1561 1562
int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
                                       int count, BdrvRequestFlags flags)
1563
{
1564
    trace_bdrv_co_pwrite_zeroes(child->bs, offset, count, flags);
1565

1566
    if (!(child->bs->open_flags & BDRV_O_UNMAP)) {
1567 1568 1569
        flags &= ~BDRV_REQ_MAY_UNMAP;
    }

1570
    return bdrv_co_pwritev(child, offset, count, NULL,
1571
                           BDRV_REQ_ZERO_WRITE | flags);
1572 1573 1574 1575 1576
}

typedef struct BdrvCoGetBlockStatusData {
    BlockDriverState *bs;
    BlockDriverState *base;
1577
    BlockDriverState **file;
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598
    int64_t sector_num;
    int nb_sectors;
    int *pnum;
    int64_t ret;
    bool done;
} BdrvCoGetBlockStatusData;

/*
 * 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.
 *
 * If 'sector_num' is beyond the end of the disk image the return value is 0
 * and 'pnum' is set to 0.
 *
 * '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
 * beyond the end of the disk image it will be clamped.
1599 1600 1601
 *
 * If returned value is positive and BDRV_BLOCK_OFFSET_VALID bit is set, 'file'
 * points to the BDS which the sector range is allocated in.
1602 1603 1604
 */
static int64_t coroutine_fn bdrv_co_get_block_status(BlockDriverState *bs,
                                                     int64_t sector_num,
1605 1606
                                                     int nb_sectors, int *pnum,
                                                     BlockDriverState **file)
1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
{
    int64_t total_sectors;
    int64_t n;
    int64_t ret, ret2;

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

    if (sector_num >= total_sectors) {
        *pnum = 0;
        return 0;
    }

    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;
        if (bs->drv->protocol_name) {
            ret |= BDRV_BLOCK_OFFSET_VALID | (sector_num * BDRV_SECTOR_SIZE);
        }
        return ret;
    }

1636 1637 1638
    *file = NULL;
    ret = bs->drv->bdrv_co_get_block_status(bs, sector_num, nb_sectors, pnum,
                                            file);
1639 1640 1641 1642 1643 1644 1645
    if (ret < 0) {
        *pnum = 0;
        return ret;
    }

    if (ret & BDRV_BLOCK_RAW) {
        assert(ret & BDRV_BLOCK_OFFSET_VALID);
K
Kevin Wolf 已提交
1646
        return bdrv_get_block_status(bs->file->bs, ret >> BDRV_SECTOR_BITS,
1647
                                     *pnum, pnum, file);
1648 1649 1650 1651
    }

    if (ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ZERO)) {
        ret |= BDRV_BLOCK_ALLOCATED;
1652
    } else {
1653 1654
        if (bdrv_unallocated_blocks_are_zero(bs)) {
            ret |= BDRV_BLOCK_ZERO;
1655 1656
        } else if (bs->backing) {
            BlockDriverState *bs2 = bs->backing->bs;
1657 1658 1659 1660 1661 1662 1663
            int64_t nb_sectors2 = bdrv_nb_sectors(bs2);
            if (nb_sectors2 >= 0 && sector_num >= nb_sectors2) {
                ret |= BDRV_BLOCK_ZERO;
            }
        }
    }

1664
    if (*file && *file != bs &&
1665 1666
        (ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO) &&
        (ret & BDRV_BLOCK_OFFSET_VALID)) {
1667
        BlockDriverState *file2;
1668 1669
        int file_pnum;

1670
        ret2 = bdrv_co_get_block_status(*file, ret >> BDRV_SECTOR_BITS,
1671
                                        *pnum, &file_pnum, &file2);
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
        if (ret2 >= 0) {
            /* Ignore errors.  This is just providing extra information, it
             * is useful but not necessary.
             */
            if (!file_pnum) {
                /* !file_pnum indicates an offset at or beyond the EOF; it is
                 * perfectly valid for the format block driver to point to such
                 * offsets, so catch it and mark everything as zero */
                ret |= BDRV_BLOCK_ZERO;
            } else {
                /* Limit request to the range reported by the protocol driver */
                *pnum = file_pnum;
                ret |= (ret2 & BDRV_BLOCK_ZERO);
            }
        }
    }

    return ret;
}

1692 1693 1694 1695
static int64_t coroutine_fn bdrv_co_get_block_status_above(BlockDriverState *bs,
        BlockDriverState *base,
        int64_t sector_num,
        int nb_sectors,
1696 1697
        int *pnum,
        BlockDriverState **file)
1698 1699 1700 1701 1702
{
    BlockDriverState *p;
    int64_t ret = 0;

    assert(bs != base);
1703
    for (p = bs; p != base; p = backing_bs(p)) {
1704
        ret = bdrv_co_get_block_status(p, sector_num, nb_sectors, pnum, file);
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
        if (ret < 0 || ret & BDRV_BLOCK_ALLOCATED) {
            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);
    }
    return ret;
}

/* Coroutine wrapper for bdrv_get_block_status_above() */
static void coroutine_fn bdrv_get_block_status_above_co_entry(void *opaque)
1717 1718 1719
{
    BdrvCoGetBlockStatusData *data = opaque;

1720 1721 1722
    data->ret = bdrv_co_get_block_status_above(data->bs, data->base,
                                               data->sector_num,
                                               data->nb_sectors,
1723 1724
                                               data->pnum,
                                               data->file);
1725 1726 1727 1728
    data->done = true;
}

/*
1729
 * Synchronous wrapper around bdrv_co_get_block_status_above().
1730
 *
1731
 * See bdrv_co_get_block_status_above() for details.
1732
 */
1733 1734 1735
int64_t bdrv_get_block_status_above(BlockDriverState *bs,
                                    BlockDriverState *base,
                                    int64_t sector_num,
1736 1737
                                    int nb_sectors, int *pnum,
                                    BlockDriverState **file)
1738 1739 1740 1741
{
    Coroutine *co;
    BdrvCoGetBlockStatusData data = {
        .bs = bs,
1742
        .base = base,
1743
        .file = file,
1744 1745 1746 1747 1748 1749 1750 1751
        .sector_num = sector_num,
        .nb_sectors = nb_sectors,
        .pnum = pnum,
        .done = false,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
1752
        bdrv_get_block_status_above_co_entry(&data);
1753 1754 1755
    } else {
        AioContext *aio_context = bdrv_get_aio_context(bs);

1756 1757 1758
        co = qemu_coroutine_create(bdrv_get_block_status_above_co_entry,
                                   &data);
        qemu_coroutine_enter(co);
1759 1760 1761 1762 1763 1764 1765
        while (!data.done) {
            aio_poll(aio_context, true);
        }
    }
    return data.ret;
}

1766 1767
int64_t bdrv_get_block_status(BlockDriverState *bs,
                              int64_t sector_num,
1768 1769
                              int nb_sectors, int *pnum,
                              BlockDriverState **file)
1770
{
1771
    return bdrv_get_block_status_above(bs, backing_bs(bs),
1772
                                       sector_num, nb_sectors, pnum, file);
1773 1774
}

1775 1776 1777
int coroutine_fn bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num,
                                   int nb_sectors, int *pnum)
{
1778 1779 1780
    BlockDriverState *file;
    int64_t ret = bdrv_get_block_status(bs, sector_num, nb_sectors, pnum,
                                        &file);
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 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
    if (ret < 0) {
        return ret;
    }
    return !!(ret & BDRV_BLOCK_ALLOCATED);
}

/*
 * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
 *
 * Return true if the given sector is allocated in any image between
 * BASE and TOP (inclusive).  BASE can be NULL to check if the given
 * sector is allocated in any image of the chain.  Return false otherwise.
 *
 * '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.
 *
 */
int bdrv_is_allocated_above(BlockDriverState *top,
                            BlockDriverState *base,
                            int64_t sector_num,
                            int nb_sectors, int *pnum)
{
    BlockDriverState *intermediate;
    int ret, n = nb_sectors;

    intermediate = top;
    while (intermediate && intermediate != base) {
        int pnum_inter;
        ret = bdrv_is_allocated(intermediate, sector_num, nb_sectors,
                                &pnum_inter);
        if (ret < 0) {
            return ret;
        } else if (ret) {
            *pnum = pnum_inter;
            return 1;
        }

        /*
         * [sector_num, nb_sectors] is unallocated on top but intermediate
         * might have
         *
         * [sector_num+x, nr_sectors] allocated.
         */
        if (n > pnum_inter &&
            (intermediate == top ||
             sector_num + pnum_inter < intermediate->total_sectors)) {
            n = pnum_inter;
        }

1831
        intermediate = backing_bs(intermediate);
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
    }

    *pnum = n;
    return 0;
}

int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
                          const uint8_t *buf, int nb_sectors)
{
    BlockDriver *drv = bs->drv;
    int ret;

    if (!drv) {
        return -ENOMEDIUM;
    }
    if (!drv->bdrv_write_compressed) {
        return -ENOTSUP;
    }
    ret = bdrv_check_request(bs, sector_num, nb_sectors);
    if (ret < 0) {
        return ret;
    }

    assert(QLIST_EMPTY(&bs->dirty_bitmaps));

    return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
}

1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
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;

    if (!drv) {
        return -ENOMEDIUM;
    } else if (drv->bdrv_load_vmstate) {
        return is_read ? drv->bdrv_load_vmstate(bs, qiov, pos)
                       : drv->bdrv_save_vmstate(bs, qiov, pos);
    } else if (bs->file) {
        return bdrv_co_rw_vmstate(bs->file->bs, qiov, pos, is_read);
    }

    return -ENOTSUP;
}

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

1908
        qemu_coroutine_enter(co);
1909 1910 1911 1912 1913 1914 1915
        while (data.ret == -EINPROGRESS) {
            aio_poll(bdrv_get_aio_context(bs), true);
        }
        return data.ret;
    }
}

1916 1917 1918 1919 1920 1921 1922 1923
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,
    };
1924
    int ret;
1925 1926

    qemu_iovec_init_external(&qiov, &iov, 1);
1927 1928 1929 1930 1931 1932 1933

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

    return size;
1934 1935 1936 1937
}

int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
{
1938
    return bdrv_rw_vmstate(bs, qiov, pos, false);
1939 1940 1941 1942
}

int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size)
1943 1944 1945 1946 1947 1948
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = buf,
        .iov_len    = size,
    };
1949
    int ret;
1950 1951

    qemu_iovec_init_external(&qiov, &iov, 1);
1952 1953 1954 1955 1956 1957
    ret = bdrv_readv_vmstate(bs, &qiov, pos);
    if (ret < 0) {
        return ret;
    }

    return size;
1958 1959 1960
}

int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
1961
{
1962
    return bdrv_rw_vmstate(bs, qiov, pos, true);
1963 1964 1965 1966 1967
}

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

1968
BlockAIOCB *bdrv_aio_readv(BdrvChild *child, int64_t sector_num,
1969 1970 1971
                           QEMUIOVector *qiov, int nb_sectors,
                           BlockCompletionFunc *cb, void *opaque)
{
1972
    trace_bdrv_aio_readv(child->bs, sector_num, nb_sectors, opaque);
1973

1974
    return bdrv_co_aio_rw_vector(child, sector_num, qiov, nb_sectors, 0,
1975 1976 1977
                                 cb, opaque, false);
}

1978
BlockAIOCB *bdrv_aio_writev(BdrvChild *child, int64_t sector_num,
1979 1980 1981
                            QEMUIOVector *qiov, int nb_sectors,
                            BlockCompletionFunc *cb, void *opaque)
{
1982
    trace_bdrv_aio_writev(child->bs, sector_num, nb_sectors, opaque);
1983

1984
    return bdrv_co_aio_rw_vector(child, sector_num, qiov, nb_sectors, 0,
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
                                 cb, opaque, true);
}

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

/**************************************************************/
/* async block device emulation */

2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
typedef struct BlockRequest {
    union {
        /* Used during read, write, trim */
        struct {
            int64_t sector;
            int nb_sectors;
            int flags;
            QEMUIOVector *qiov;
        };
        /* Used during ioctl */
        struct {
            int req;
            void *buf;
        };
    };
    BlockCompletionFunc *cb;
    void *opaque;

    int error;
} BlockRequest;

2038 2039
typedef struct BlockAIOCBCoroutine {
    BlockAIOCB common;
2040
    BdrvChild *child;
2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
    BlockRequest req;
    bool is_write;
    bool need_bh;
    bool *done;
    QEMUBH* bh;
} BlockAIOCBCoroutine;

static const AIOCBInfo bdrv_em_co_aiocb_info = {
    .aiocb_size         = sizeof(BlockAIOCBCoroutine),
};

static void bdrv_co_complete(BlockAIOCBCoroutine *acb)
{
    if (!acb->need_bh) {
        acb->common.cb(acb->common.opaque, acb->req.error);
        qemu_aio_unref(acb);
    }
}

static void bdrv_co_em_bh(void *opaque)
{
    BlockAIOCBCoroutine *acb = opaque;

    assert(!acb->need_bh);
    qemu_bh_delete(acb->bh);
    bdrv_co_complete(acb);
}

static void bdrv_co_maybe_schedule_bh(BlockAIOCBCoroutine *acb)
{
    acb->need_bh = false;
    if (acb->req.error != -EINPROGRESS) {
        BlockDriverState *bs = acb->common.bs;

        acb->bh = aio_bh_new(bdrv_get_aio_context(bs), bdrv_co_em_bh, acb);
        qemu_bh_schedule(acb->bh);
    }
}

/* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
static void coroutine_fn bdrv_co_do_rw(void *opaque)
{
    BlockAIOCBCoroutine *acb = opaque;

    if (!acb->is_write) {
2086
        acb->req.error = bdrv_co_do_readv(acb->child, acb->req.sector,
2087 2088
            acb->req.nb_sectors, acb->req.qiov, acb->req.flags);
    } else {
2089
        acb->req.error = bdrv_co_do_writev(acb->child, acb->req.sector,
2090 2091 2092 2093 2094 2095
            acb->req.nb_sectors, acb->req.qiov, acb->req.flags);
    }

    bdrv_co_complete(acb);
}

2096
static BlockAIOCB *bdrv_co_aio_rw_vector(BdrvChild *child,
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
                                         int64_t sector_num,
                                         QEMUIOVector *qiov,
                                         int nb_sectors,
                                         BdrvRequestFlags flags,
                                         BlockCompletionFunc *cb,
                                         void *opaque,
                                         bool is_write)
{
    Coroutine *co;
    BlockAIOCBCoroutine *acb;

2108 2109
    acb = qemu_aio_get(&bdrv_em_co_aiocb_info, child->bs, cb, opaque);
    acb->child = child;
2110 2111 2112 2113 2114 2115 2116 2117
    acb->need_bh = true;
    acb->req.error = -EINPROGRESS;
    acb->req.sector = sector_num;
    acb->req.nb_sectors = nb_sectors;
    acb->req.qiov = qiov;
    acb->req.flags = flags;
    acb->is_write = is_write;

2118 2119
    co = qemu_coroutine_create(bdrv_co_do_rw, acb);
    qemu_coroutine_enter(co);
2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145

    bdrv_co_maybe_schedule_bh(acb);
    return &acb->common;
}

static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque)
{
    BlockAIOCBCoroutine *acb = opaque;
    BlockDriverState *bs = acb->common.bs;

    acb->req.error = bdrv_co_flush(bs);
    bdrv_co_complete(acb);
}

BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
        BlockCompletionFunc *cb, void *opaque)
{
    trace_bdrv_aio_flush(bs, opaque);

    Coroutine *co;
    BlockAIOCBCoroutine *acb;

    acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
    acb->need_bh = true;
    acb->req.error = -EINPROGRESS;

2146 2147
    co = qemu_coroutine_create(bdrv_aio_flush_co_entry, acb);
    qemu_coroutine_enter(co);
2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175

    bdrv_co_maybe_schedule_bh(acb);
    return &acb->common;
}

static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque)
{
    BlockAIOCBCoroutine *acb = opaque;
    BlockDriverState *bs = acb->common.bs;

    acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors);
    bdrv_co_complete(acb);
}

BlockAIOCB *bdrv_aio_discard(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors,
        BlockCompletionFunc *cb, void *opaque)
{
    Coroutine *co;
    BlockAIOCBCoroutine *acb;

    trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque);

    acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
    acb->need_bh = true;
    acb->req.error = -EINPROGRESS;
    acb->req.sector = sector_num;
    acb->req.nb_sectors = nb_sectors;
2176 2177
    co = qemu_coroutine_create(bdrv_aio_discard_co_entry, acb);
    qemu_coroutine_enter(co);
2178 2179 2180 2181 2182 2183 2184 2185 2186 2187

    bdrv_co_maybe_schedule_bh(acb);
    return &acb->common;
}

void *qemu_aio_get(const AIOCBInfo *aiocb_info, BlockDriverState *bs,
                   BlockCompletionFunc *cb, void *opaque)
{
    BlockAIOCB *acb;

2188
    acb = g_malloc(aiocb_info->aiocb_size);
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
    acb->aiocb_info = aiocb_info;
    acb->bs = bs;
    acb->cb = cb;
    acb->opaque = opaque;
    acb->refcnt = 1;
    return acb;
}

void qemu_aio_ref(void *p)
{
    BlockAIOCB *acb = p;
    acb->refcnt++;
}

void qemu_aio_unref(void *p)
{
    BlockAIOCB *acb = p;
    assert(acb->refcnt > 0);
    if (--acb->refcnt == 0) {
2208
        g_free(acb);
2209 2210 2211 2212 2213 2214
    }
}

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

2215 2216 2217 2218 2219 2220
typedef struct FlushCo {
    BlockDriverState *bs;
    int ret;
} FlushCo;


2221 2222
static void coroutine_fn bdrv_flush_co_entry(void *opaque)
{
2223
    FlushCo *rwco = opaque;
2224 2225 2226 2227 2228 2229 2230

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

int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
{
    int ret;
F
Fam Zheng 已提交
2231
    BdrvTrackedRequest req;
2232

2233 2234
    if (!bs || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs) ||
        bdrv_is_sg(bs)) {
2235 2236 2237
        return 0;
    }

F
Fam Zheng 已提交
2238
    tracked_request_begin(&req, bs, 0, 0, BDRV_TRACKED_FLUSH);
P
Pavel Dovgalyuk 已提交
2239

2240 2241 2242 2243 2244 2245 2246 2247 2248
    int current_gen = bs->write_gen;

    /* Wait until any previous flushes are completed */
    while (bs->flush_started_gen != bs->flushed_gen) {
        qemu_co_queue_wait(&bs->flush_queue);
    }

    bs->flush_started_gen = current_gen;

P
Pavel Dovgalyuk 已提交
2249 2250 2251 2252 2253 2254
    /* Write back all layers by calling one driver function */
    if (bs->drv->bdrv_co_flush) {
        ret = bs->drv->bdrv_co_flush(bs);
        goto out;
    }

2255 2256 2257 2258 2259
    /* 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 已提交
2260
            goto out;
2261 2262 2263 2264 2265 2266 2267 2268
        }
    }

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

2269 2270 2271 2272 2273
    /* Check if we really need to flush anything */
    if (bs->flushed_gen == current_gen) {
        goto flush_parent;
    }

2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303
    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;
    }
2304

2305
    if (ret < 0) {
F
Fam Zheng 已提交
2306
        goto out;
2307 2308 2309 2310 2311 2312
    }

    /* 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 已提交
2313 2314
    ret = bs->file ? bdrv_co_flush(bs->file->bs) : 0;
out:
2315 2316 2317 2318
    /* Notify any pending flushes that we have completed */
    bs->flushed_gen = current_gen;
    qemu_co_queue_restart_all(&bs->flush_queue);

F
Fam Zheng 已提交
2319 2320
    tracked_request_end(&req);
    return ret;
2321 2322 2323 2324 2325
}

int bdrv_flush(BlockDriverState *bs)
{
    Coroutine *co;
2326
    FlushCo flush_co = {
2327 2328 2329 2330 2331 2332
        .bs = bs,
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2333
        bdrv_flush_co_entry(&flush_co);
2334 2335 2336
    } else {
        AioContext *aio_context = bdrv_get_aio_context(bs);

2337 2338
        co = qemu_coroutine_create(bdrv_flush_co_entry, &flush_co);
        qemu_coroutine_enter(co);
2339
        while (flush_co.ret == NOT_DONE) {
2340 2341 2342 2343
            aio_poll(aio_context, true);
        }
    }

2344
    return flush_co.ret;
2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362
}

typedef struct DiscardCo {
    BlockDriverState *bs;
    int64_t sector_num;
    int nb_sectors;
    int ret;
} DiscardCo;
static void coroutine_fn bdrv_discard_co_entry(void *opaque)
{
    DiscardCo *rwco = opaque;

    rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors);
}

int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num,
                                 int nb_sectors)
{
F
Fam Zheng 已提交
2363
    BdrvTrackedRequest req;
2364 2365 2366 2367 2368 2369 2370 2371 2372 2373
    int max_discard, ret;

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

    ret = bdrv_check_request(bs, sector_num, nb_sectors);
    if (ret < 0) {
        return ret;
    } else if (bs->read_only) {
2374
        return -EPERM;
2375
    }
2376
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386

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

    if (!bs->drv->bdrv_co_discard && !bs->drv->bdrv_aio_discard) {
        return 0;
    }

2387 2388
    tracked_request_begin(&req, bs, sector_num << BDRV_SECTOR_BITS,
                          nb_sectors << BDRV_SECTOR_BITS, BDRV_TRACKED_DISCARD);
2389

2390 2391 2392 2393 2394
    ret = notifier_with_return_list_notify(&bs->before_write_notifiers, &req);
    if (ret < 0) {
        goto out;
    }

2395 2396
    max_discard = MIN_NON_ZERO(bs->bl.max_pdiscard >> BDRV_SECTOR_BITS,
                               BDRV_REQUEST_MAX_SECTORS);
2397 2398 2399
    while (nb_sectors > 0) {
        int ret;
        int num = nb_sectors;
2400
        int discard_alignment = bs->bl.pdiscard_alignment >> BDRV_SECTOR_BITS;
2401 2402

        /* align request */
2403 2404 2405 2406 2407
        if (discard_alignment &&
            num >= discard_alignment &&
            sector_num % discard_alignment) {
            if (num > discard_alignment) {
                num = discard_alignment;
2408
            }
2409
            num -= sector_num % discard_alignment;
2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
        }

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

        if (bs->drv->bdrv_co_discard) {
            ret = bs->drv->bdrv_co_discard(bs, sector_num, num);
        } else {
            BlockAIOCB *acb;
            CoroutineIOCompletion co = {
                .coroutine = qemu_coroutine_self(),
            };

            acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors,
                                            bdrv_co_io_em_complete, &co);
            if (acb == NULL) {
F
Fam Zheng 已提交
2428 2429
                ret = -EIO;
                goto out;
2430 2431 2432 2433 2434 2435
            } else {
                qemu_coroutine_yield();
                ret = co.ret;
            }
        }
        if (ret && ret != -ENOTSUP) {
F
Fam Zheng 已提交
2436
            goto out;
2437 2438 2439 2440 2441
        }

        sector_num += num;
        nb_sectors -= num;
    }
F
Fam Zheng 已提交
2442 2443
    ret = 0;
out:
2444
    ++bs->write_gen;
2445 2446
    bdrv_set_dirty(bs, req.offset >> BDRV_SECTOR_BITS,
                   req.bytes >> BDRV_SECTOR_BITS);
F
Fam Zheng 已提交
2447 2448
    tracked_request_end(&req);
    return ret;
2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466
}

int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
{
    Coroutine *co;
    DiscardCo rwco = {
        .bs = bs,
        .sector_num = sector_num,
        .nb_sectors = nb_sectors,
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
        bdrv_discard_co_entry(&rwco);
    } else {
        AioContext *aio_context = bdrv_get_aio_context(bs);

2467 2468
        co = qemu_coroutine_create(bdrv_discard_co_entry, &rwco);
        qemu_coroutine_enter(co);
2469 2470 2471 2472 2473 2474 2475 2476
        while (rwco.ret == NOT_DONE) {
            aio_poll(aio_context, true);
        }
    }

    return rwco.ret;
}

2477
static int bdrv_co_do_ioctl(BlockDriverState *bs, int req, void *buf)
2478 2479
{
    BlockDriver *drv = bs->drv;
2480 2481 2482 2483 2484
    BdrvTrackedRequest tracked_req;
    CoroutineIOCompletion co = {
        .coroutine = qemu_coroutine_self(),
    };
    BlockAIOCB *acb;
2485

2486 2487 2488 2489 2490 2491 2492 2493
    tracked_request_begin(&tracked_req, bs, 0, 0, BDRV_TRACKED_IOCTL);
    if (!drv || !drv->bdrv_aio_ioctl) {
        co.ret = -ENOTSUP;
        goto out;
    }

    acb = drv->bdrv_aio_ioctl(bs, req, buf, bdrv_co_io_em_complete, &co);
    if (!acb) {
F
Fam Zheng 已提交
2494 2495
        co.ret = -ENOTSUP;
        goto out;
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529
    }
    qemu_coroutine_yield();
out:
    tracked_request_end(&tracked_req);
    return co.ret;
}

typedef struct {
    BlockDriverState *bs;
    int req;
    void *buf;
    int ret;
} BdrvIoctlCoData;

static void coroutine_fn bdrv_co_ioctl_entry(void *opaque)
{
    BdrvIoctlCoData *data = opaque;
    data->ret = bdrv_co_do_ioctl(data->bs, data->req, data->buf);
}

/* needed for generic scsi interface */
int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
{
    BdrvIoctlCoData data = {
        .bs = bs,
        .req = req,
        .buf = buf,
        .ret = -EINPROGRESS,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
        bdrv_co_ioctl_entry(&data);
    } else {
2530
        Coroutine *co = qemu_coroutine_create(bdrv_co_ioctl_entry, &data);
2531

2532
        qemu_coroutine_enter(co);
2533 2534 2535
        while (data.ret == -EINPROGRESS) {
            aio_poll(bdrv_get_aio_context(bs), true);
        }
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545
    }
    return data.ret;
}

static void coroutine_fn bdrv_co_aio_ioctl_entry(void *opaque)
{
    BlockAIOCBCoroutine *acb = opaque;
    acb->req.error = bdrv_co_do_ioctl(acb->common.bs,
                                      acb->req.req, acb->req.buf);
    bdrv_co_complete(acb);
2546 2547 2548 2549 2550 2551
}

BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
        unsigned long int req, void *buf,
        BlockCompletionFunc *cb, void *opaque)
{
2552 2553 2554
    BlockAIOCBCoroutine *acb = qemu_aio_get(&bdrv_em_co_aiocb_info,
                                            bs, cb, opaque);
    Coroutine *co;
2555

2556 2557 2558 2559
    acb->need_bh = true;
    acb->req.error = -EINPROGRESS;
    acb->req.req = req;
    acb->req.buf = buf;
2560 2561
    co = qemu_coroutine_create(bdrv_co_aio_ioctl_entry, acb);
    qemu_coroutine_enter(co);
2562 2563 2564

    bdrv_co_maybe_schedule_bh(acb);
    return &acb->common;
2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
}

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;
2607
    size_t alignment = bdrv_min_mem_align(bs);
2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628

    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)
{
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639
    BdrvChild *child;

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

    if (bs->io_plugged++ == 0 && bs->io_plug_disabled == 0) {
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_plug) {
            drv->bdrv_io_plug(bs);
        }
2640 2641 2642 2643 2644
    }
}

void bdrv_io_unplug(BlockDriverState *bs)
{
2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656
    BdrvChild *child;

    assert(bs->io_plugged);
    if (--bs->io_plugged == 0 && bs->io_plug_disabled == 0) {
        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);
2657 2658 2659
    }
}

2660
void bdrv_io_unplugged_begin(BlockDriverState *bs)
2661
{
2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
    BdrvChild *child;

    if (bs->io_plug_disabled++ == 0 && bs->io_plugged > 0) {
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_unplug) {
            drv->bdrv_io_unplug(bs);
        }
    }

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

void bdrv_io_unplugged_end(BlockDriverState *bs)
{
    BdrvChild *child;

    assert(bs->io_plug_disabled);
    QLIST_FOREACH(child, &bs->children, next) {
        bdrv_io_unplugged_end(child->bs);
    }

    if (--bs->io_plug_disabled == 0 && bs->io_plugged > 0) {
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_plug) {
            drv->bdrv_io_plug(bs);
        }
2690 2691
    }
}