io.c 97.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * Block layer I/O functions
 *
 * Copyright (c) 2003 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

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

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

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

41 42
static AioWait drain_all_aio_wait;

43
static void bdrv_parent_cb_resize(BlockDriverState *bs);
E
Eric Blake 已提交
44
static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
45
    int64_t offset, int bytes, BdrvRequestFlags flags);
46

47 48
void bdrv_parent_drained_begin(BlockDriverState *bs, BdrvChild *ignore,
                               bool ignore_bds_parents)
49
{
50
    BdrvChild *c, *next;
51

52
    QLIST_FOREACH_SAFE(c, &bs->parents, next_parent, next) {
53
        if (c == ignore || (ignore_bds_parents && c->role->parent_is_bds)) {
54 55
            continue;
        }
56
        bdrv_parent_drained_begin_single(c, false);
57 58
    }
}
59

60 61
void bdrv_parent_drained_end(BlockDriverState *bs, BdrvChild *ignore,
                             bool ignore_bds_parents)
62
{
63
    BdrvChild *c, *next;
64

65
    QLIST_FOREACH_SAFE(c, &bs->parents, next_parent, next) {
66
        if (c == ignore || (ignore_bds_parents && c->role->parent_is_bds)) {
67 68
            continue;
        }
69 70 71
        if (c->role->drained_end) {
            c->role->drained_end(c);
        }
72
    }
73 74
}

75 76 77 78 79 80 81 82
static bool bdrv_parent_drained_poll_single(BdrvChild *c)
{
    if (c->role->drained_poll) {
        return c->role->drained_poll(c);
    }
    return false;
}

83 84
static bool bdrv_parent_drained_poll(BlockDriverState *bs, BdrvChild *ignore,
                                     bool ignore_bds_parents)
85 86 87 88 89
{
    BdrvChild *c, *next;
    bool busy = false;

    QLIST_FOREACH_SAFE(c, &bs->parents, next_parent, next) {
90
        if (c == ignore || (ignore_bds_parents && c->role->parent_is_bds)) {
91 92
            continue;
        }
93
        busy |= bdrv_parent_drained_poll_single(c);
94 95 96 97 98
    }

    return busy;
}

99 100 101 102 103 104 105 106 107 108
void bdrv_parent_drained_begin_single(BdrvChild *c, bool poll)
{
    if (c->role->drained_begin) {
        c->role->drained_begin(c);
    }
    if (poll) {
        BDRV_POLL_WHILE(c->bs, bdrv_parent_drained_poll_single(c));
    }
}

109 110 111 112 113 114 115 116 117 118 119
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);
}

120 121 122 123 124 125 126 127 128 129 130
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;
    }

131
    /* Default alignment based on whether driver has byte interface */
132 133
    bs->bl.request_alignment = (drv->bdrv_co_preadv ||
                                drv->bdrv_aio_preadv) ? 1 : 512;
134

135 136
    /* Take some limits from the children as a default */
    if (bs->file) {
K
Kevin Wolf 已提交
137
        bdrv_refresh_limits(bs->file->bs, &local_err);
138 139 140 141
        if (local_err) {
            error_propagate(errp, local_err);
            return;
        }
142
        bdrv_merge_limits(&bs->bl, &bs->file->bs->bl);
143
    } else {
144
        bs->bl.min_mem_alignment = 512;
145
        bs->bl.opt_mem_alignment = getpagesize();
146 147 148

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

151 152
    if (bs->backing) {
        bdrv_refresh_limits(bs->backing->bs, &local_err);
153 154 155 156
        if (local_err) {
            error_propagate(errp, local_err);
            return;
        }
157
        bdrv_merge_limits(&bs->bl, &bs->backing->bs->bl);
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
    }

    /* 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)
{
173
    atomic_inc(&bs->copy_on_read);
174 175 176 177
}

void bdrv_disable_copy_on_read(BlockDriverState *bs)
{
178 179
    int old = atomic_fetch_dec(&bs->copy_on_read);
    assert(old >= 1);
180 181
}

182 183 184 185
typedef struct {
    Coroutine *co;
    BlockDriverState *bs;
    bool done;
186
    bool begin;
187
    bool recursive;
188
    bool poll;
189
    BdrvChild *parent;
190
    bool ignore_bds_parents;
191 192 193 194 195 196 197
} BdrvCoDrainData;

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

198
    if (data->begin) {
199
        bs->drv->bdrv_co_drain_begin(bs);
200 201 202
    } else {
        bs->drv->bdrv_co_drain_end(bs);
    }
203 204 205

    /* Set data->done before reading bs->wakeup.  */
    atomic_mb_set(&data->done, true);
206 207 208 209 210
    bdrv_dec_in_flight(bs);

    if (data->begin) {
        g_free(data);
    }
211 212
}

213
/* Recursively call BlockDriver.bdrv_co_drain_begin/end callbacks */
214
static void bdrv_drain_invoke(BlockDriverState *bs, bool begin)
215
{
216
    BdrvCoDrainData *data;
217

218
    if (!bs->drv || (begin && !bs->drv->bdrv_co_drain_begin) ||
219
            (!begin && !bs->drv->bdrv_co_drain_end)) {
220 221 222
        return;
    }

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
    data = g_new(BdrvCoDrainData, 1);
    *data = (BdrvCoDrainData) {
        .bs = bs,
        .done = false,
        .begin = begin
    };

    /* Make sure the driver callback completes during the polling phase for
     * drain_begin. */
    bdrv_inc_in_flight(bs);
    data->co = qemu_coroutine_create(bdrv_drain_invoke_entry, data);
    aio_co_schedule(bdrv_get_aio_context(bs), data->co);

    if (!begin) {
        BDRV_POLL_WHILE(bs, !data->done);
        g_free(data);
    }
240 241
}

242
/* Returns true if BDRV_POLL_WHILE() should go into a blocking aio_poll() */
243
bool bdrv_drain_poll(BlockDriverState *bs, bool recursive,
244
                     BdrvChild *ignore_parent, bool ignore_bds_parents)
245
{
246 247
    BdrvChild *child, *next;

248
    if (bdrv_parent_drained_poll(bs, ignore_parent, ignore_bds_parents)) {
249 250 251
        return true;
    }

252 253 254 255 256
    if (atomic_read(&bs->in_flight)) {
        return true;
    }

    if (recursive) {
257
        assert(!ignore_bds_parents);
258
        QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
259
            if (bdrv_drain_poll(child->bs, recursive, child, false)) {
260 261 262 263 264 265
                return true;
            }
        }
    }

    return false;
266 267
}

268
static bool bdrv_drain_poll_top_level(BlockDriverState *bs, bool recursive,
269
                                      BdrvChild *ignore_parent)
270
{
271
    return bdrv_drain_poll(bs, recursive, ignore_parent, false);
272 273
}

274
static void bdrv_do_drained_begin(BlockDriverState *bs, bool recursive,
275 276
                                  BdrvChild *parent, bool ignore_bds_parents,
                                  bool poll);
277
static void bdrv_do_drained_end(BlockDriverState *bs, bool recursive,
278
                                BdrvChild *parent, bool ignore_bds_parents);
279

F
Fam Zheng 已提交
280 281 282 283
static void bdrv_co_drain_bh_cb(void *opaque)
{
    BdrvCoDrainData *data = opaque;
    Coroutine *co = data->co;
284
    BlockDriverState *bs = data->bs;
F
Fam Zheng 已提交
285

286
    if (bs) {
287 288 289 290 291 292 293 294 295 296 297 298
        AioContext *ctx = bdrv_get_aio_context(bs);
        AioContext *co_ctx = qemu_coroutine_get_aio_context(co);

        /*
         * When the coroutine yielded, the lock for its home context was
         * released, so we need to re-acquire it here. If it explicitly
         * acquired a different context, the lock is still held and we don't
         * want to lock it a second time (or AIO_WAIT_WHILE() would hang).
         */
        if (ctx == co_ctx) {
            aio_context_acquire(ctx);
        }
299 300
        bdrv_dec_in_flight(bs);
        if (data->begin) {
301 302
            bdrv_do_drained_begin(bs, data->recursive, data->parent,
                                  data->ignore_bds_parents, data->poll);
303
        } else {
304 305
            bdrv_do_drained_end(bs, data->recursive, data->parent,
                                data->ignore_bds_parents);
306
        }
307 308 309
        if (ctx == co_ctx) {
            aio_context_release(ctx);
        }
310
    } else {
311 312
        assert(data->begin);
        bdrv_drain_all_begin();
313 314
    }

F
Fam Zheng 已提交
315
    data->done = true;
316
    aio_co_wake(co);
F
Fam Zheng 已提交
317 318
}

319
static void coroutine_fn bdrv_co_yield_to_drain(BlockDriverState *bs,
320
                                                bool begin, bool recursive,
321 322 323
                                                BdrvChild *parent,
                                                bool ignore_bds_parents,
                                                bool poll)
F
Fam Zheng 已提交
324 325 326 327
{
    BdrvCoDrainData data;

    /* Calling bdrv_drain() from a BH ensures the current coroutine yields and
328
     * other coroutines run if they were queued by aio_co_enter(). */
F
Fam Zheng 已提交
329 330 331 332 333 334

    assert(qemu_in_coroutine());
    data = (BdrvCoDrainData) {
        .co = qemu_coroutine_self(),
        .bs = bs,
        .done = false,
335
        .begin = begin,
336
        .recursive = recursive,
337
        .parent = parent,
338
        .ignore_bds_parents = ignore_bds_parents,
339
        .poll = poll,
F
Fam Zheng 已提交
340
    };
341 342 343
    if (bs) {
        bdrv_inc_in_flight(bs);
    }
P
Paolo Bonzini 已提交
344 345
    aio_bh_schedule_oneshot(bdrv_get_aio_context(bs),
                            bdrv_co_drain_bh_cb, &data);
F
Fam Zheng 已提交
346 347 348 349 350 351 352

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

353
void bdrv_do_drained_begin_quiesce(BlockDriverState *bs,
354
                                   BdrvChild *parent, bool ignore_bds_parents)
355
{
356
    assert(!qemu_in_coroutine());
357

K
Kevin Wolf 已提交
358
    /* Stop things in parent-to-child order */
359
    if (atomic_fetch_inc(&bs->quiesce_counter) == 0) {
360 361 362
        aio_disable_external(bdrv_get_aio_context(bs));
    }

363
    bdrv_parent_drained_begin(bs, parent, ignore_bds_parents);
364
    bdrv_drain_invoke(bs, true);
365 366 367
}

static void bdrv_do_drained_begin(BlockDriverState *bs, bool recursive,
368 369
                                  BdrvChild *parent, bool ignore_bds_parents,
                                  bool poll)
370 371 372 373
{
    BdrvChild *child, *next;

    if (qemu_in_coroutine()) {
374 375
        bdrv_co_yield_to_drain(bs, true, recursive, parent, ignore_bds_parents,
                               poll);
376 377 378
        return;
    }

379
    bdrv_do_drained_begin_quiesce(bs, parent, ignore_bds_parents);
K
Kevin Wolf 已提交
380

381
    if (recursive) {
382
        assert(!ignore_bds_parents);
383
        bs->recursive_quiesce_counter++;
384
        QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
385 386
            bdrv_do_drained_begin(child->bs, true, child, ignore_bds_parents,
                                  false);
387 388
        }
    }
389 390 391 392 393 394 395 396 397 398 399

    /*
     * Wait for drained requests to finish.
     *
     * Calling BDRV_POLL_WHILE() only once for the top-level node is okay: The
     * call is needed so things in this AioContext can make progress even
     * though we don't return to the main AioContext loop - this automatically
     * includes other nodes in the same AioContext and therefore all child
     * nodes.
     */
    if (poll) {
400
        assert(!ignore_bds_parents);
401 402
        BDRV_POLL_WHILE(bs, bdrv_drain_poll_top_level(bs, recursive, parent));
    }
403 404
}

405 406
void bdrv_drained_begin(BlockDriverState *bs)
{
407
    bdrv_do_drained_begin(bs, false, NULL, false, true);
408 409 410 411
}

void bdrv_subtree_drained_begin(BlockDriverState *bs)
{
412
    bdrv_do_drained_begin(bs, true, NULL, false, true);
413 414
}

415 416
static void bdrv_do_drained_end(BlockDriverState *bs, bool recursive,
                                BdrvChild *parent, bool ignore_bds_parents)
417
{
418
    BdrvChild *child, *next;
419 420
    int old_quiesce_counter;

421
    if (qemu_in_coroutine()) {
422 423
        bdrv_co_yield_to_drain(bs, false, recursive, parent, ignore_bds_parents,
                               false);
424 425
        return;
    }
426
    assert(bs->quiesce_counter > 0);
427
    old_quiesce_counter = atomic_fetch_dec(&bs->quiesce_counter);
428

K
Kevin Wolf 已提交
429
    /* Re-enable things in child-to-parent order */
430
    bdrv_drain_invoke(bs, false);
431
    bdrv_parent_drained_end(bs, parent, ignore_bds_parents);
432 433 434
    if (old_quiesce_counter == 1) {
        aio_enable_external(bdrv_get_aio_context(bs));
    }
435 436

    if (recursive) {
437
        assert(!ignore_bds_parents);
438
        bs->recursive_quiesce_counter--;
439
        QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
440
            bdrv_do_drained_end(child->bs, true, child, ignore_bds_parents);
441 442
        }
    }
443 444
}

445 446
void bdrv_drained_end(BlockDriverState *bs)
{
447
    bdrv_do_drained_end(bs, false, NULL, false);
448 449 450 451
}

void bdrv_subtree_drained_end(BlockDriverState *bs)
{
452
    bdrv_do_drained_end(bs, true, NULL, false);
453 454
}

455 456 457 458 459
void bdrv_apply_subtree_drain(BdrvChild *child, BlockDriverState *new_parent)
{
    int i;

    for (i = 0; i < new_parent->recursive_quiesce_counter; i++) {
460
        bdrv_do_drained_begin(child->bs, true, child, false, true);
461 462 463 464 465 466 467 468
    }
}

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

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

473
/*
474 475
 * Wait for pending requests to complete on a single BlockDriverState subtree,
 * and suspend block driver's internal I/O until next request arrives.
476 477 478 479
 *
 * Note that unlike bdrv_drain_all(), the caller must hold the BlockDriverState
 * AioContext.
 */
480
void coroutine_fn bdrv_co_drain(BlockDriverState *bs)
481
{
482 483 484
    assert(qemu_in_coroutine());
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
485
}
486

487 488
void bdrv_drain(BlockDriverState *bs)
{
489 490
    bdrv_drained_begin(bs);
    bdrv_drained_end(bs);
491 492
}

493 494 495 496 497 498 499 500 501 502
static void bdrv_drain_assert_idle(BlockDriverState *bs)
{
    BdrvChild *child, *next;

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

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
unsigned int bdrv_drain_all_count = 0;

static bool bdrv_drain_all_poll(void)
{
    BlockDriverState *bs = NULL;
    bool result = false;

    /* bdrv_drain_poll() can't make changes to the graph and we are holding the
     * main AioContext lock, so iterating bdrv_next_all_states() is safe. */
    while ((bs = bdrv_next_all_states(bs))) {
        AioContext *aio_context = bdrv_get_aio_context(bs);
        aio_context_acquire(aio_context);
        result |= bdrv_drain_poll(bs, false, NULL, true);
        aio_context_release(aio_context);
    }

    return result;
}

522 523 524 525 526
/*
 * 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.
527 528 529 530 531 532
 *
 * This pauses all block jobs and disables external clients. It must
 * be paired with bdrv_drain_all_end().
 *
 * NOTE: no new block jobs or BlockDriverStates can be created between
 * the bdrv_drain_all_begin() and bdrv_drain_all_end() calls.
533
 */
534
void bdrv_drain_all_begin(void)
535
{
536
    BlockDriverState *bs = NULL;
537

538
    if (qemu_in_coroutine()) {
539
        bdrv_co_yield_to_drain(NULL, true, false, NULL, true, true);
540 541 542
        return;
    }

543 544
    /* AIO_WAIT_WHILE() with a NULL context can only be called from the main
     * loop AioContext, so make sure we're in the main context. */
545
    assert(qemu_get_current_aio_context() == qemu_get_aio_context());
546 547
    assert(bdrv_drain_all_count < INT_MAX);
    bdrv_drain_all_count++;
548

549 550 551
    /* Quiesce all nodes, without polling in-flight requests yet. The graph
     * cannot change during this loop. */
    while ((bs = bdrv_next_all_states(bs))) {
552 553 554
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
555
        bdrv_do_drained_begin(bs, false, NULL, true, false);
556 557 558
        aio_context_release(aio_context);
    }

559 560 561 562
    /* Now poll the in-flight requests */
    AIO_WAIT_WHILE(&drain_all_aio_wait, NULL, bdrv_drain_all_poll());

    while ((bs = bdrv_next_all_states(bs))) {
563
        bdrv_drain_assert_idle(bs);
564
    }
565 566 567 568
}

void bdrv_drain_all_end(void)
{
569
    BlockDriverState *bs = NULL;
570

571
    while ((bs = bdrv_next_all_states(bs))) {
572 573 574
        AioContext *aio_context = bdrv_get_aio_context(bs);

        aio_context_acquire(aio_context);
575
        bdrv_do_drained_end(bs, false, NULL, true);
576 577
        aio_context_release(aio_context);
    }
578 579 580

    assert(bdrv_drain_all_count > 0);
    bdrv_drain_all_count--;
581 582
}

583 584 585 586 587 588
void bdrv_drain_all(void)
{
    bdrv_drain_all_begin();
    bdrv_drain_all_end();
}

589 590 591 592 593 594 595 596
/**
 * 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) {
597
        atomic_dec(&req->bs->serialising_in_flight);
598 599
    }

600
    qemu_co_mutex_lock(&req->bs->reqs_lock);
601 602
    QLIST_REMOVE(req, list);
    qemu_co_queue_restart_all(&req->wait_queue);
603
    qemu_co_mutex_unlock(&req->bs->reqs_lock);
604 605 606 607 608 609 610 611
}

/**
 * Add an active request to the tracked requests list
 */
static void tracked_request_begin(BdrvTrackedRequest *req,
                                  BlockDriverState *bs,
                                  int64_t offset,
612
                                  uint64_t bytes,
613
                                  enum BdrvTrackedRequestType type)
614
{
615 616
    assert(bytes <= INT64_MAX && offset <= INT64_MAX - bytes);

617 618 619 620
    *req = (BdrvTrackedRequest){
        .bs = bs,
        .offset         = offset,
        .bytes          = bytes,
621
        .type           = type,
622 623 624 625 626 627 628 629
        .co             = qemu_coroutine_self(),
        .serialising    = false,
        .overlap_offset = offset,
        .overlap_bytes  = bytes,
    };

    qemu_co_queue_init(&req->wait_queue);

630
    qemu_co_mutex_lock(&bs->reqs_lock);
631
    QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
632
    qemu_co_mutex_unlock(&bs->reqs_lock);
633 634 635 636 637
}

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

    if (!req->serialising) {
642
        atomic_inc(&req->bs->serialising_in_flight);
643 644 645 646 647 648 649
        req->serialising = true;
    }

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

650 651 652 653 654 655 656 657 658 659 660 661
static bool is_request_serialising_and_aligned(BdrvTrackedRequest *req)
{
    /*
     * If the request is serialising, overlap_offset and overlap_bytes are set,
     * so we can check if the request is aligned. Otherwise, don't care and
     * return false.
     */

    return req->serialising && (req->offset == req->overlap_offset) &&
           (req->bytes == req->overlap_bytes);
}

662 663 664 665
/**
 * Round a region to cluster boundaries
 */
void bdrv_round_to_clusters(BlockDriverState *bs,
666
                            int64_t offset, int64_t bytes,
667
                            int64_t *cluster_offset,
668
                            int64_t *cluster_bytes)
669 670 671 672 673 674 675 676 677 678 679 680 681
{
    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);
    }
}

682 683 684 685 686 687 688
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) {
689
        return bs->bl.request_alignment;
690 691 692 693 694 695
    } else {
        return bdi.cluster_size;
    }
}

static bool tracked_request_overlaps(BdrvTrackedRequest *req,
696
                                     int64_t offset, uint64_t bytes)
697 698 699 700 701 702 703 704 705 706 707 708
{
    /*        aaaa   bbbb */
    if (offset >= req->overlap_offset + req->overlap_bytes) {
        return false;
    }
    /* bbbb   aaaa        */
    if (req->overlap_offset >= offset + bytes) {
        return false;
    }
    return true;
}

709 710 711 712 713
void bdrv_inc_in_flight(BlockDriverState *bs)
{
    atomic_inc(&bs->in_flight);
}

714 715
void bdrv_wakeup(BlockDriverState *bs)
{
716
    aio_wait_kick(bdrv_get_aio_wait(bs));
717
    aio_wait_kick(&drain_all_aio_wait);
718 719
}

720 721 722
void bdrv_dec_in_flight(BlockDriverState *bs)
{
    atomic_dec(&bs->in_flight);
723
    bdrv_wakeup(bs);
724 725
}

726 727 728 729 730 731 732
static bool coroutine_fn wait_serialising_requests(BdrvTrackedRequest *self)
{
    BlockDriverState *bs = self->bs;
    BdrvTrackedRequest *req;
    bool retry;
    bool waited = false;

733
    if (!atomic_read(&bs->serialising_in_flight)) {
734 735 736 737 738
        return false;
    }

    do {
        retry = false;
739
        qemu_co_mutex_lock(&bs->reqs_lock);
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
        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;
758
                    qemu_co_queue_wait(&req->wait_queue, &bs->reqs_lock);
759 760 761 762 763 764 765
                    self->waiting_for = NULL;
                    retry = true;
                    waited = true;
                    break;
                }
            }
        }
766
        qemu_co_mutex_unlock(&bs->reqs_lock);
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
    } while (retry);

    return waited;
}

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

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

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

    return 0;
}

typedef struct RwCo {
791
    BdrvChild *child;
792 793 794 795 796 797 798 799 800 801 802 803
    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) {
804
        rwco->ret = bdrv_co_preadv(rwco->child, rwco->offset,
805 806
                                   rwco->qiov->size, rwco->qiov,
                                   rwco->flags);
807
    } else {
808
        rwco->ret = bdrv_co_pwritev(rwco->child, rwco->offset,
809 810
                                    rwco->qiov->size, rwco->qiov,
                                    rwco->flags);
811 812 813 814 815 816
    }
}

/*
 * Process a vectored synchronous request using coroutines
 */
817
static int bdrv_prwv_co(BdrvChild *child, int64_t offset,
818 819 820 821 822
                        QEMUIOVector *qiov, bool is_write,
                        BdrvRequestFlags flags)
{
    Coroutine *co;
    RwCo rwco = {
823
        .child = child,
824 825 826 827 828 829 830 831 832 833 834
        .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 {
835
        co = qemu_coroutine_create(bdrv_rw_co_entry, &rwco);
836
        bdrv_coroutine_enter(child->bs, co);
P
Paolo Bonzini 已提交
837
        BDRV_POLL_WHILE(child->bs, rwco.ret == NOT_DONE);
838 839 840 841 842 843 844
    }
    return rwco.ret;
}

/*
 * Process a synchronous request using coroutines
 */
845
static int bdrv_rw_co(BdrvChild *child, int64_t sector_num, uint8_t *buf,
846 847 848 849 850 851 852 853 854 855 856 857 858
                      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);
859
    return bdrv_prwv_co(child, sector_num << BDRV_SECTOR_BITS,
860 861 862 863
                        &qiov, is_write, flags);
}

/* return < 0 if error. See bdrv_write() for the return codes */
864
int bdrv_read(BdrvChild *child, int64_t sector_num,
865 866
              uint8_t *buf, int nb_sectors)
{
867
    return bdrv_rw_co(child, sector_num, buf, nb_sectors, false, 0);
868 869 870 871 872 873 874 875
}

/* 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
*/
876
int bdrv_write(BdrvChild *child, int64_t sector_num,
877 878
               const uint8_t *buf, int nb_sectors)
{
879
    return bdrv_rw_co(child, sector_num, (uint8_t *)buf, nb_sectors, true, 0);
880 881
}

882
int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
883
                       int bytes, BdrvRequestFlags flags)
884
{
885 886 887
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = NULL,
888
        .iov_len = bytes,
889 890 891
    };

    qemu_iovec_init_external(&qiov, &iov, 1);
892
    return bdrv_prwv_co(child, offset, &qiov, true,
893
                        BDRV_REQ_ZERO_WRITE | flags);
894 895 896
}

/*
897
 * Completely zero out a block device with the help of bdrv_pwrite_zeroes.
898 899
 * 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
900
 * flags are passed through to bdrv_pwrite_zeroes (e.g. BDRV_REQ_MAY_UNMAP,
901
 * BDRV_REQ_FUA).
902 903 904
 *
 * Returns < 0 on error, 0 on success. For error codes see bdrv_write().
 */
905
int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags)
906
{
907 908
    int ret;
    int64_t target_size, bytes, offset = 0;
909
    BlockDriverState *bs = child->bs;
910

911 912 913
    target_size = bdrv_getlength(bs);
    if (target_size < 0) {
        return target_size;
914 915 916
    }

    for (;;) {
917 918
        bytes = MIN(target_size - offset, BDRV_REQUEST_MAX_BYTES);
        if (bytes <= 0) {
919 920
            return 0;
        }
921
        ret = bdrv_block_status(bs, offset, bytes, &bytes, NULL, NULL);
922
        if (ret < 0) {
923 924
            error_report("error getting block status at offset %" PRId64 ": %s",
                         offset, strerror(-ret));
925 926 927
            return ret;
        }
        if (ret & BDRV_BLOCK_ZERO) {
928
            offset += bytes;
929 930
            continue;
        }
931
        ret = bdrv_pwrite_zeroes(child, offset, bytes, flags);
932
        if (ret < 0) {
933 934
            error_report("error writing zeroes at offset %" PRId64 ": %s",
                         offset, strerror(-ret));
935 936
            return ret;
        }
937
        offset += bytes;
938 939 940
    }
}

941
int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
K
Kevin Wolf 已提交
942 943 944
{
    int ret;

945
    ret = bdrv_prwv_co(child, offset, qiov, false, 0);
K
Kevin Wolf 已提交
946 947 948 949 950 951 952
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

953
int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes)
954 955 956 957 958 959 960 961 962 963 964 965
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base = (void *)buf,
        .iov_len = bytes,
    };

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

    qemu_iovec_init_external(&qiov, &iov, 1);
966
    return bdrv_preadv(child, offset, &qiov);
967 968
}

969
int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
970 971 972
{
    int ret;

973
    ret = bdrv_prwv_co(child, offset, qiov, true, 0);
974 975 976 977 978 979 980
    if (ret < 0) {
        return ret;
    }

    return qiov->size;
}

981
int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes)
982 983 984 985 986 987 988 989 990 991 992 993
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = (void *) buf,
        .iov_len    = bytes,
    };

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

    qemu_iovec_init_external(&qiov, &iov, 1);
994
    return bdrv_pwritev(child, offset, &qiov);
995 996 997 998 999 1000 1001 1002
}

/*
 * 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.
 */
1003 1004
int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
                     const void *buf, int count)
1005 1006 1007
{
    int ret;

1008
    ret = bdrv_pwrite(child, offset, buf, count);
1009 1010 1011 1012
    if (ret < 0) {
        return ret;
    }

1013
    ret = bdrv_flush(child->bs);
1014 1015
    if (ret < 0) {
        return ret;
1016 1017 1018 1019 1020
    }

    return 0;
}

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
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;
1031
    aio_co_wake(co->coroutine);
1032 1033
}

1034 1035 1036 1037 1038
static int coroutine_fn bdrv_driver_preadv(BlockDriverState *bs,
                                           uint64_t offset, uint64_t bytes,
                                           QEMUIOVector *qiov, int flags)
{
    BlockDriver *drv = bs->drv;
1039 1040 1041
    int64_t sector_num;
    unsigned int nb_sectors;

1042 1043
    assert(!(flags & ~BDRV_REQ_MASK));

M
Max Reitz 已提交
1044 1045 1046 1047
    if (!drv) {
        return -ENOMEDIUM;
    }

1048 1049 1050 1051
    if (drv->bdrv_co_preadv) {
        return drv->bdrv_co_preadv(bs, offset, bytes, qiov, flags);
    }

1052
    if (drv->bdrv_aio_preadv) {
1053 1054 1055 1056 1057
        BlockAIOCB *acb;
        CoroutineIOCompletion co = {
            .coroutine = qemu_coroutine_self(),
        };

1058 1059
        acb = drv->bdrv_aio_preadv(bs, offset, bytes, qiov, flags,
                                   bdrv_co_io_em_complete, &co);
1060 1061 1062 1063 1064 1065 1066
        if (acb == NULL) {
            return -EIO;
        } else {
            qemu_coroutine_yield();
            return co.ret;
        }
    }
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076

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

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

    return drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
1077 1078
}

1079 1080 1081 1082 1083
static int coroutine_fn bdrv_driver_pwritev(BlockDriverState *bs,
                                            uint64_t offset, uint64_t bytes,
                                            QEMUIOVector *qiov, int flags)
{
    BlockDriver *drv = bs->drv;
1084 1085
    int64_t sector_num;
    unsigned int nb_sectors;
1086 1087
    int ret;

1088 1089
    assert(!(flags & ~BDRV_REQ_MASK));

M
Max Reitz 已提交
1090 1091 1092 1093
    if (!drv) {
        return -ENOMEDIUM;
    }

1094
    if (drv->bdrv_co_pwritev) {
1095 1096 1097
        ret = drv->bdrv_co_pwritev(bs, offset, bytes, qiov,
                                   flags & bs->supported_write_flags);
        flags &= ~bs->supported_write_flags;
1098 1099 1100
        goto emulate_flags;
    }

1101
    if (drv->bdrv_aio_pwritev) {
1102 1103 1104 1105 1106
        BlockAIOCB *acb;
        CoroutineIOCompletion co = {
            .coroutine = qemu_coroutine_self(),
        };

1107 1108 1109 1110
        acb = drv->bdrv_aio_pwritev(bs, offset, bytes, qiov,
                                    flags & bs->supported_write_flags,
                                    bdrv_co_io_em_complete, &co);
        flags &= ~bs->supported_write_flags;
1111
        if (acb == NULL) {
1112
            ret = -EIO;
1113 1114
        } else {
            qemu_coroutine_yield();
1115
            ret = co.ret;
1116
        }
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
        goto emulate_flags;
    }

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

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

1127 1128 1129 1130
    assert(drv->bdrv_co_writev);
    ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov,
                              flags & bs->supported_write_flags);
    flags &= ~bs->supported_write_flags;
1131

1132
emulate_flags:
1133
    if (ret == 0 && (flags & BDRV_REQ_FUA)) {
1134 1135 1136 1137 1138 1139
        ret = bdrv_co_flush(bs);
    }

    return ret;
}

1140 1141 1142 1143 1144 1145
static int coroutine_fn
bdrv_driver_pwritev_compressed(BlockDriverState *bs, uint64_t offset,
                               uint64_t bytes, QEMUIOVector *qiov)
{
    BlockDriver *drv = bs->drv;

M
Max Reitz 已提交
1146 1147 1148 1149
    if (!drv) {
        return -ENOMEDIUM;
    }

1150 1151 1152 1153 1154 1155 1156
    if (!drv->bdrv_co_pwritev_compressed) {
        return -ENOTSUP;
    }

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

1157
static int coroutine_fn bdrv_co_do_copy_on_readv(BdrvChild *child,
1158
        int64_t offset, unsigned int bytes, QEMUIOVector *qiov)
1159
{
1160 1161
    BlockDriverState *bs = child->bs;

1162 1163 1164 1165 1166 1167 1168 1169 1170
    /* Perform I/O through a temporary buffer so that users who scribble over
     * their read buffer while the operation is in progress do not end up
     * modifying the image file.  This is critical for zero-copy guest I/O
     * where anything might happen inside guest memory.
     */
    void *bounce_buffer;

    BlockDriver *drv = bs->drv;
    struct iovec iov;
E
Eric Blake 已提交
1171
    QEMUIOVector local_qiov;
1172
    int64_t cluster_offset;
1173
    int64_t cluster_bytes;
1174 1175
    size_t skip_bytes;
    int ret;
E
Eric Blake 已提交
1176 1177 1178
    int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer,
                                    BDRV_REQUEST_MAX_BYTES);
    unsigned int progress = 0;
1179

M
Max Reitz 已提交
1180 1181 1182 1183
    if (!drv) {
        return -ENOMEDIUM;
    }

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

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

1201 1202
    trace_bdrv_co_do_copy_on_readv(bs, offset, bytes,
                                   cluster_offset, cluster_bytes);
1203

E
Eric Blake 已提交
1204 1205 1206
    bounce_buffer = qemu_try_blockalign(bs,
                                        MIN(MIN(max_transfer, cluster_bytes),
                                            MAX_BOUNCE_BUFFER));
1207 1208 1209 1210 1211
    if (bounce_buffer == NULL) {
        ret = -ENOMEM;
        goto err;
    }

E
Eric Blake 已提交
1212 1213
    while (cluster_bytes) {
        int64_t pnum;
1214

E
Eric Blake 已提交
1215 1216 1217 1218 1219 1220 1221 1222 1223
        ret = bdrv_is_allocated(bs, cluster_offset,
                                MIN(cluster_bytes, max_transfer), &pnum);
        if (ret < 0) {
            /* Safe to treat errors in querying allocation as if
             * unallocated; we'll probably fail again soon on the
             * read, but at least that will set a decent errno.
             */
            pnum = MIN(cluster_bytes, max_transfer);
        }
1224

1225 1226 1227 1228 1229 1230
        /* Stop at EOF if the image ends in the middle of the cluster */
        if (ret == 0 && pnum == 0) {
            assert(progress >= bytes);
            break;
        }

E
Eric Blake 已提交
1231
        assert(skip_bytes < pnum);
1232

E
Eric Blake 已提交
1233 1234 1235 1236 1237
        if (ret <= 0) {
            /* Must copy-on-read; use the bounce buffer */
            iov.iov_base = bounce_buffer;
            iov.iov_len = pnum = MIN(pnum, MAX_BOUNCE_BUFFER);
            qemu_iovec_init_external(&local_qiov, &iov, 1);
1238

E
Eric Blake 已提交
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
            ret = bdrv_driver_preadv(bs, cluster_offset, pnum,
                                     &local_qiov, 0);
            if (ret < 0) {
                goto err;
            }

            bdrv_debug_event(bs, BLKDBG_COR_WRITE);
            if (drv->bdrv_co_pwrite_zeroes &&
                buffer_is_zero(bounce_buffer, pnum)) {
                /* FIXME: Should we (perhaps conditionally) be setting
                 * BDRV_REQ_MAY_UNMAP, if it will allow for a sparser copy
                 * that still correctly reads as zero? */
1251 1252
                ret = bdrv_co_do_pwrite_zeroes(bs, cluster_offset, pnum,
                                               BDRV_REQ_WRITE_UNCHANGED);
E
Eric Blake 已提交
1253 1254 1255 1256 1257
            } else {
                /* This does not change the data on the disk, it is not
                 * necessary to flush even in cache=writethrough mode.
                 */
                ret = bdrv_driver_pwritev(bs, cluster_offset, pnum,
1258 1259
                                          &local_qiov,
                                          BDRV_REQ_WRITE_UNCHANGED);
E
Eric Blake 已提交
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
            }

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

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

        cluster_offset += pnum;
        cluster_bytes -= pnum;
        progress += pnum - skip_bytes;
        skip_bytes = 0;
    }
    ret = 0;
1291 1292 1293 1294 1295 1296 1297 1298

err:
    qemu_vfree(bounce_buffer);
    return ret;
}

/*
 * Forwards an already correctly aligned request to the BlockDriver. This
1299 1300
 * handles copy on read, zeroing after EOF, and fragmentation of large
 * reads; any other features must be implemented by the caller.
1301
 */
1302
static int coroutine_fn bdrv_aligned_preadv(BdrvChild *child,
1303 1304 1305
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
    int64_t align, QEMUIOVector *qiov, int flags)
{
1306
    BlockDriverState *bs = child->bs;
K
Kevin Wolf 已提交
1307
    int64_t total_bytes, max_bytes;
1308 1309 1310
    int ret = 0;
    uint64_t bytes_remaining = bytes;
    int max_transfer;
1311

1312 1313 1314
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
1315
    assert(!qiov || bytes == qiov->size);
1316
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1317 1318
    max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
                                   align);
1319 1320 1321 1322 1323 1324

    /* 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)));
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335

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

1336 1337 1338
    /* BDRV_REQ_SERIALISING is only for write operation */
    assert(!(flags & BDRV_REQ_SERIALISING));

1339 1340 1341
    if (!(flags & BDRV_REQ_NO_SERIALISING)) {
        wait_serialising_requests(req);
    }
1342 1343

    if (flags & BDRV_REQ_COPY_ON_READ) {
1344
        int64_t pnum;
1345

1346
        ret = bdrv_is_allocated(bs, offset, bytes, &pnum);
1347 1348 1349 1350
        if (ret < 0) {
            goto out;
        }

1351
        if (!ret || pnum != bytes) {
1352
            ret = bdrv_co_do_copy_on_readv(child, offset, bytes, qiov);
1353 1354 1355 1356
            goto out;
        }
    }

1357
    /* Forward the request to the BlockDriver, possibly fragmenting it */
K
Kevin Wolf 已提交
1358 1359 1360 1361 1362
    total_bytes = bdrv_getlength(bs);
    if (total_bytes < 0) {
        ret = total_bytes;
        goto out;
    }
1363

K
Kevin Wolf 已提交
1364
    max_bytes = ROUND_UP(MAX(0, total_bytes - offset), align);
1365
    if (bytes <= max_bytes && bytes <= max_transfer) {
K
Kevin Wolf 已提交
1366
        ret = bdrv_driver_preadv(bs, offset, bytes, qiov, 0);
1367 1368
        goto out;
    }
1369

1370 1371
    while (bytes_remaining) {
        int num;
1372

1373 1374
        if (max_bytes) {
            QEMUIOVector local_qiov;
1375

1376 1377 1378 1379
            num = MIN(bytes_remaining, MIN(max_bytes, max_transfer));
            assert(num);
            qemu_iovec_init(&local_qiov, qiov->niov);
            qemu_iovec_concat(&local_qiov, qiov, bytes - bytes_remaining, num);
1380

1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
            ret = bdrv_driver_preadv(bs, offset + bytes - bytes_remaining,
                                     num, &local_qiov, 0);
            max_bytes -= num;
            qemu_iovec_destroy(&local_qiov);
        } else {
            num = bytes_remaining;
            ret = qemu_iovec_memset(qiov, bytes - bytes_remaining, 0,
                                    bytes_remaining);
        }
        if (ret < 0) {
            goto out;
        }
        bytes_remaining -= num;
1394 1395 1396
    }

out:
1397
    return ret < 0 ? ret : 0;
1398 1399 1400 1401 1402
}

/*
 * Handle a read request in coroutine context
 */
1403
int coroutine_fn bdrv_co_preadv(BdrvChild *child,
1404 1405 1406
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1407
    BlockDriverState *bs = child->bs;
1408 1409 1410
    BlockDriver *drv = bs->drv;
    BdrvTrackedRequest req;

1411
    uint64_t align = bs->bl.request_alignment;
1412 1413 1414 1415 1416 1417
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

1418 1419
    trace_bdrv_co_preadv(child->bs, offset, bytes, flags);

1420 1421 1422 1423 1424 1425 1426 1427 1428
    if (!drv) {
        return -ENOMEDIUM;
    }

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

1429 1430
    bdrv_inc_in_flight(bs);

1431
    /* Don't do copy-on-read if we read data before write operation */
1432
    if (atomic_read(&bs->copy_on_read) && !(flags & BDRV_REQ_NO_SERIALISING)) {
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
        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);
    }

1461
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_READ);
1462
    ret = bdrv_aligned_preadv(child, &req, offset, bytes, align,
1463 1464 1465
                              use_local_qiov ? &local_qiov : qiov,
                              flags);
    tracked_request_end(&req);
1466
    bdrv_dec_in_flight(bs);
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476

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

    return ret;
}

E
Eric Blake 已提交
1477
static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
1478
    int64_t offset, int bytes, BdrvRequestFlags flags)
1479 1480 1481 1482 1483
{
    BlockDriver *drv = bs->drv;
    QEMUIOVector qiov;
    struct iovec iov = {0};
    int ret = 0;
1484
    bool need_flush = false;
1485 1486
    int head = 0;
    int tail = 0;
1487

1488
    int max_write_zeroes = MIN_NON_ZERO(bs->bl.max_pwrite_zeroes, INT_MAX);
1489 1490
    int alignment = MAX(bs->bl.pwrite_zeroes_alignment,
                        bs->bl.request_alignment);
E
Eric Blake 已提交
1491
    int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer, MAX_BOUNCE_BUFFER);
E
Eric Blake 已提交
1492

M
Max Reitz 已提交
1493 1494 1495 1496
    if (!drv) {
        return -ENOMEDIUM;
    }

1497 1498
    assert(alignment % bs->bl.request_alignment == 0);
    head = offset % alignment;
1499
    tail = (offset + bytes) % alignment;
1500 1501
    max_write_zeroes = QEMU_ALIGN_DOWN(max_write_zeroes, alignment);
    assert(max_write_zeroes >= bs->bl.request_alignment);
1502

1503 1504
    while (bytes > 0 && !ret) {
        int num = bytes;
1505 1506

        /* Align request.  Block drivers can expect the "bulk" of the request
1507 1508
         * to be aligned, and that unaligned requests do not cross cluster
         * boundaries.
1509
         */
1510
        if (head) {
1511 1512 1513
            /* Make a small request up to the first aligned sector. For
             * convenience, limit this request to max_transfer even if
             * we don't need to fall back to writes.  */
1514
            num = MIN(MIN(bytes, max_transfer), alignment - head);
1515 1516
            head = (head + num) % alignment;
            assert(num < max_write_zeroes);
E
Eric Blake 已提交
1517
        } else if (tail && num > alignment) {
1518 1519
            /* Shorten the request to the last aligned sector.  */
            num -= tail;
1520 1521 1522 1523 1524 1525 1526 1527 1528
        }

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

        ret = -ENOTSUP;
        /* First try the efficient write zeroes operation */
E
Eric Blake 已提交
1529 1530 1531 1532 1533 1534 1535
        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;
            }
1536 1537
        } else {
            assert(!bs->supported_zero_flags);
1538 1539 1540 1541
        }

        if (ret == -ENOTSUP) {
            /* Fall back to bounce buffer if write zeroes is unsupported */
1542 1543 1544 1545 1546 1547 1548 1549 1550
            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;
            }
1551
            num = MIN(num, max_transfer);
E
Eric Blake 已提交
1552
            iov.iov_len = num;
1553
            if (iov.iov_base == NULL) {
E
Eric Blake 已提交
1554
                iov.iov_base = qemu_try_blockalign(bs, num);
1555 1556 1557 1558
                if (iov.iov_base == NULL) {
                    ret = -ENOMEM;
                    goto fail;
                }
E
Eric Blake 已提交
1559
                memset(iov.iov_base, 0, num);
1560 1561 1562
            }
            qemu_iovec_init_external(&qiov, &iov, 1);

E
Eric Blake 已提交
1563
            ret = bdrv_driver_pwritev(bs, offset, num, &qiov, write_flags);
1564 1565 1566 1567

            /* Keep bounce buffer around if it is big enough for all
             * all future requests.
             */
1568
            if (num < max_transfer) {
1569 1570 1571 1572 1573
                qemu_vfree(iov.iov_base);
                iov.iov_base = NULL;
            }
        }

E
Eric Blake 已提交
1574
        offset += num;
1575
        bytes -= num;
1576 1577 1578
    }

fail:
1579 1580 1581
    if (ret == 0 && need_flush) {
        ret = bdrv_co_flush(bs);
    }
1582 1583 1584 1585
    qemu_vfree(iov.iov_base);
    return ret;
}

1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
static inline int coroutine_fn
bdrv_co_write_req_prepare(BdrvChild *child, int64_t offset, uint64_t bytes,
                          BdrvTrackedRequest *req, int flags)
{
    BlockDriverState *bs = child->bs;
    bool waited;
    int64_t end_sector = DIV_ROUND_UP(offset + bytes, BDRV_SECTOR_SIZE);

    if (bs->read_only) {
        return -EPERM;
    }

    /* BDRV_REQ_NO_SERIALISING is only for read operation */
    assert(!(flags & BDRV_REQ_NO_SERIALISING));
    assert(!(bs->open_flags & BDRV_O_INACTIVE));
    assert((bs->open_flags & BDRV_O_NO_IO) == 0);
    assert(!(flags & ~BDRV_REQ_MASK));

    if (flags & BDRV_REQ_SERIALISING) {
        mark_request_serialising(req, bdrv_get_cluster_size(bs));
    }

    waited = wait_serialising_requests(req);

    assert(!waited || !req->serialising ||
           is_request_serialising_and_aligned(req));
    assert(req->overlap_offset <= offset);
    assert(offset + bytes <= req->overlap_offset + req->overlap_bytes);
1614
    assert(end_sector <= bs->total_sectors || child->perm & BLK_PERM_RESIZE);
1615

1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
    switch (req->type) {
    case BDRV_TRACKED_WRITE:
    case BDRV_TRACKED_DISCARD:
        if (flags & BDRV_REQ_WRITE_UNCHANGED) {
            assert(child->perm & (BLK_PERM_WRITE_UNCHANGED | BLK_PERM_WRITE));
        } else {
            assert(child->perm & BLK_PERM_WRITE);
        }
        return notifier_with_return_list_notify(&bs->before_write_notifiers,
                                                req);
    case BDRV_TRACKED_TRUNCATE:
        assert(child->perm & BLK_PERM_RESIZE);
        return 0;
    default:
        abort();
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
    }
}

static inline void coroutine_fn
bdrv_co_write_req_finish(BdrvChild *child, int64_t offset, uint64_t bytes,
                         BdrvTrackedRequest *req, int ret)
{
    int64_t end_sector = DIV_ROUND_UP(offset + bytes, BDRV_SECTOR_SIZE);
    BlockDriverState *bs = child->bs;

    atomic_inc(&bs->write_gen);

1643 1644 1645 1646 1647 1648 1649
    /*
     * Discard cannot extend the image, but in error handling cases, such as
     * when reverting a qcow2 cluster allocation, the discarded range can pass
     * the end of image file, so we cannot assert about BDRV_TRACKED_DISCARD
     * here. Instead, just skip it, since semantically a discard request
     * beyond EOF cannot expand the image anyway.
     */
1650
    if (ret == 0 &&
1651 1652 1653
        (req->type == BDRV_TRACKED_TRUNCATE ||
         end_sector > bs->total_sectors) &&
        req->type != BDRV_TRACKED_DISCARD) {
1654 1655 1656
        bs->total_sectors = end_sector;
        bdrv_parent_cb_resize(bs);
        bdrv_dirty_bitmap_truncate(bs, end_sector << BDRV_SECTOR_BITS);
1657
    }
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669
    if (req->bytes) {
        switch (req->type) {
        case BDRV_TRACKED_WRITE:
            stat64_max(&bs->wr_highest_offset, offset + bytes);
            /* fall through, to set dirty bits */
        case BDRV_TRACKED_DISCARD:
            bdrv_set_dirty(bs, offset, bytes);
            break;
        default:
            break;
        }
    }
1670 1671
}

1672
/*
1673 1674
 * Forwards an already correctly aligned write request to the BlockDriver,
 * after possibly fragmenting it.
1675
 */
1676
static int coroutine_fn bdrv_aligned_pwritev(BdrvChild *child,
1677
    BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
1678
    int64_t align, QEMUIOVector *qiov, int flags)
1679
{
1680
    BlockDriverState *bs = child->bs;
1681 1682 1683
    BlockDriver *drv = bs->drv;
    int ret;

1684 1685
    uint64_t bytes_remaining = bytes;
    int max_transfer;
1686

M
Max Reitz 已提交
1687 1688 1689 1690
    if (!drv) {
        return -ENOMEDIUM;
    }

1691 1692 1693 1694
    if (bdrv_has_readonly_bitmaps(bs)) {
        return -EPERM;
    }

1695 1696 1697
    assert(is_power_of_2(align));
    assert((offset & (align - 1)) == 0);
    assert((bytes & (align - 1)) == 0);
1698
    assert(!qiov || bytes == qiov->size);
1699 1700
    max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
                                   align);
1701

1702
    ret = bdrv_co_write_req_prepare(child, offset, bytes, req, flags);
1703 1704

    if (!ret && bs->detect_zeroes != BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF &&
E
Eric Blake 已提交
1705
        !(flags & BDRV_REQ_ZERO_WRITE) && drv->bdrv_co_pwrite_zeroes &&
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
        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 已提交
1716
        bdrv_debug_event(bs, BLKDBG_PWRITEV_ZERO);
1717
        ret = bdrv_co_do_pwrite_zeroes(bs, offset, bytes, flags);
1718 1719
    } else if (flags & BDRV_REQ_WRITE_COMPRESSED) {
        ret = bdrv_driver_pwritev_compressed(bs, offset, bytes, qiov);
1720
    } else if (bytes <= max_transfer) {
K
Kevin Wolf 已提交
1721
        bdrv_debug_event(bs, BLKDBG_PWRITEV);
1722
        ret = bdrv_driver_pwritev(bs, offset, bytes, qiov, flags);
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
    } else {
        bdrv_debug_event(bs, BLKDBG_PWRITEV);
        while (bytes_remaining) {
            int num = MIN(bytes_remaining, max_transfer);
            QEMUIOVector local_qiov;
            int local_flags = flags;

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

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

    if (ret >= 0) {
1752
        ret = 0;
1753
    }
1754
    bdrv_co_write_req_finish(child, offset, bytes, req, ret);
1755 1756 1757 1758

    return ret;
}

1759
static int coroutine_fn bdrv_co_do_zero_pwritev(BdrvChild *child,
1760 1761 1762 1763 1764
                                                int64_t offset,
                                                unsigned int bytes,
                                                BdrvRequestFlags flags,
                                                BdrvTrackedRequest *req)
{
1765
    BlockDriverState *bs = child->bs;
1766 1767 1768
    uint8_t *buf = NULL;
    QEMUIOVector local_qiov;
    struct iovec iov;
1769
    uint64_t align = bs->bl.request_alignment;
1770 1771 1772 1773
    unsigned int head_padding_bytes, tail_padding_bytes;
    int ret = 0;

    head_padding_bytes = offset & (align - 1);
1774
    tail_padding_bytes = (align - (offset + bytes)) & (align - 1);
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791


    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 已提交
1792
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1793
        ret = bdrv_aligned_preadv(child, req, offset & ~(align - 1), align,
1794 1795 1796 1797
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1798
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1799 1800

        memset(buf + head_padding_bytes, 0, zero_bytes);
1801
        ret = bdrv_aligned_pwritev(child, req, offset & ~(align - 1), align,
1802
                                   align, &local_qiov,
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
                                   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);
1815
        ret = bdrv_aligned_pwritev(child, req, offset, aligned_bytes, align,
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829
                                   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 已提交
1830
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1831
        ret = bdrv_aligned_preadv(child, req, offset, align,
1832 1833 1834 1835
                                  align, &local_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1836
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1837 1838

        memset(buf, 0, bytes);
1839
        ret = bdrv_aligned_pwritev(child, req, offset, align, align,
1840 1841 1842 1843 1844 1845 1846 1847
                                   &local_qiov, flags & ~BDRV_REQ_ZERO_WRITE);
    }
fail:
    qemu_vfree(buf);
    return ret;

}

1848 1849 1850
/*
 * Handle a write request in coroutine context
 */
1851
int coroutine_fn bdrv_co_pwritev(BdrvChild *child,
1852 1853 1854
    int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
    BdrvRequestFlags flags)
{
1855
    BlockDriverState *bs = child->bs;
1856
    BdrvTrackedRequest req;
1857
    uint64_t align = bs->bl.request_alignment;
1858 1859 1860 1861 1862 1863
    uint8_t *head_buf = NULL;
    uint8_t *tail_buf = NULL;
    QEMUIOVector local_qiov;
    bool use_local_qiov = false;
    int ret;

1864 1865
    trace_bdrv_co_pwritev(child->bs, offset, bytes, flags);

1866 1867 1868 1869 1870 1871 1872 1873 1874
    if (!bs->drv) {
        return -ENOMEDIUM;
    }

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

1875
    bdrv_inc_in_flight(bs);
1876 1877 1878 1879 1880
    /*
     * 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.
     */
1881
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_WRITE);
1882

1883
    if (flags & BDRV_REQ_ZERO_WRITE) {
1884
        ret = bdrv_co_do_zero_pwritev(child, offset, bytes, flags, &req);
1885 1886 1887
        goto out;
    }

1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
    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 已提交
1902
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1903
        ret = bdrv_aligned_preadv(child, &req, offset & ~(align - 1), align,
1904 1905 1906 1907
                                  align, &head_qiov, 0);
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1908
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1909 1910 1911 1912 1913 1914 1915 1916

        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);
1917 1918 1919 1920 1921 1922 1923 1924

        /* 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;
        }
1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
    }

    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 已提交
1944
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1945 1946
        ret = bdrv_aligned_preadv(child, &req, (offset + bytes) & ~(align - 1),
                                  align, align, &tail_qiov, 0);
1947 1948 1949
        if (ret < 0) {
            goto fail;
        }
K
Kevin Wolf 已提交
1950
        bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963

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

1964
    ret = bdrv_aligned_pwritev(child, &req, offset, bytes, align,
1965 1966
                               use_local_qiov ? &local_qiov : qiov,
                               flags);
1967 1968 1969 1970 1971 1972 1973 1974

fail:

    if (use_local_qiov) {
        qemu_iovec_destroy(&local_qiov);
    }
    qemu_vfree(head_buf);
    qemu_vfree(tail_buf);
1975 1976
out:
    tracked_request_end(&req);
1977
    bdrv_dec_in_flight(bs);
1978 1979 1980
    return ret;
}

1981
int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
1982
                                       int bytes, BdrvRequestFlags flags)
1983
{
1984
    trace_bdrv_co_pwrite_zeroes(child->bs, offset, bytes, flags);
1985

1986
    if (!(child->bs->open_flags & BDRV_O_UNMAP)) {
1987 1988 1989
        flags &= ~BDRV_REQ_MAY_UNMAP;
    }

1990
    return bdrv_co_pwritev(child, offset, bytes, NULL,
1991
                           BDRV_REQ_ZERO_WRITE | flags);
1992 1993
}

J
John Snow 已提交
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018
/*
 * Flush ALL BDSes regardless of if they are reachable via a BlkBackend or not.
 */
int bdrv_flush_all(void)
{
    BdrvNextIterator it;
    BlockDriverState *bs = NULL;
    int result = 0;

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

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

    return result;
}


2019
typedef struct BdrvCoBlockStatusData {
2020 2021
    BlockDriverState *bs;
    BlockDriverState *base;
2022
    bool want_zero;
2023 2024 2025 2026
    int64_t offset;
    int64_t bytes;
    int64_t *pnum;
    int64_t *map;
2027
    BlockDriverState **file;
2028
    int ret;
2029
    bool done;
2030
} BdrvCoBlockStatusData;
2031

2032 2033 2034 2035 2036 2037 2038
int coroutine_fn bdrv_co_block_status_from_file(BlockDriverState *bs,
                                                bool want_zero,
                                                int64_t offset,
                                                int64_t bytes,
                                                int64_t *pnum,
                                                int64_t *map,
                                                BlockDriverState **file)
2039 2040
{
    assert(bs->file && bs->file->bs);
2041 2042
    *pnum = bytes;
    *map = offset;
2043
    *file = bs->file->bs;
2044
    return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID;
2045 2046
}

2047 2048 2049 2050 2051 2052 2053
int coroutine_fn bdrv_co_block_status_from_backing(BlockDriverState *bs,
                                                   bool want_zero,
                                                   int64_t offset,
                                                   int64_t bytes,
                                                   int64_t *pnum,
                                                   int64_t *map,
                                                   BlockDriverState **file)
2054 2055
{
    assert(bs->backing && bs->backing->bs);
2056 2057
    *pnum = bytes;
    *map = offset;
2058
    *file = bs->backing->bs;
2059
    return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID;
2060 2061
}

2062 2063 2064 2065 2066
/*
 * 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.
 *
2067 2068 2069 2070
 * If 'want_zero' is true, the caller is querying for mapping
 * purposes, with a focus on valid BDRV_BLOCK_OFFSET_VALID, _DATA, and
 * _ZERO where possible; otherwise, the result favors larger 'pnum',
 * with a focus on accurate BDRV_BLOCK_ALLOCATED.
2071
 *
2072
 * If 'offset' is beyond the end of the disk image the return value is
2073
 * BDRV_BLOCK_EOF and 'pnum' is set to 0.
2074
 *
2075
 * 'bytes' is the max value 'pnum' should be set to.  If bytes goes
2076 2077
 * beyond the end of the disk image it will be clamped; if 'pnum' is set to
 * the end of the image, then the returned value will include BDRV_BLOCK_EOF.
2078
 *
2079 2080 2081 2082 2083 2084 2085 2086 2087
 * 'pnum' is set to the number of bytes (including and immediately
 * following the specified offset) that are easily known to be in the
 * same allocated/unallocated state.  Note that a second call starting
 * at the original offset plus returned pnum may have the same status.
 * The returned value is non-zero on success except at end-of-file.
 *
 * Returns negative errno on failure.  Otherwise, if the
 * BDRV_BLOCK_OFFSET_VALID bit is set, 'map' and 'file' (if non-NULL) are
 * set to the host mapping and BDS corresponding to the guest offset.
2088
 */
2089 2090 2091 2092 2093 2094 2095 2096
static int coroutine_fn bdrv_co_block_status(BlockDriverState *bs,
                                             bool want_zero,
                                             int64_t offset, int64_t bytes,
                                             int64_t *pnum, int64_t *map,
                                             BlockDriverState **file)
{
    int64_t total_size;
    int64_t n; /* bytes */
E
Eric Blake 已提交
2097
    int ret;
2098
    int64_t local_map = 0;
2099
    BlockDriverState *local_file = NULL;
E
Eric Blake 已提交
2100 2101
    int64_t aligned_offset, aligned_bytes;
    uint32_t align;
2102

2103 2104
    assert(pnum);
    *pnum = 0;
2105 2106 2107
    total_size = bdrv_getlength(bs);
    if (total_size < 0) {
        ret = total_size;
2108
        goto early_out;
2109 2110
    }

2111
    if (offset >= total_size) {
2112 2113
        ret = BDRV_BLOCK_EOF;
        goto early_out;
2114
    }
2115
    if (!bytes) {
2116 2117
        ret = 0;
        goto early_out;
2118
    }
2119

2120 2121 2122
    n = total_size - offset;
    if (n < bytes) {
        bytes = n;
2123 2124
    }

M
Max Reitz 已提交
2125 2126
    /* Must be non-NULL or bdrv_getlength() would have failed */
    assert(bs->drv);
2127
    if (!bs->drv->bdrv_co_block_status) {
2128
        *pnum = bytes;
2129
        ret = BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED;
2130
        if (offset + bytes == total_size) {
2131 2132
            ret |= BDRV_BLOCK_EOF;
        }
2133
        if (bs->drv->protocol_name) {
2134 2135
            ret |= BDRV_BLOCK_OFFSET_VALID;
            local_map = offset;
2136
            local_file = bs;
2137
        }
2138
        goto early_out;
2139 2140
    }

2141
    bdrv_inc_in_flight(bs);
E
Eric Blake 已提交
2142 2143

    /* Round out to request_alignment boundaries */
2144
    align = bs->bl.request_alignment;
E
Eric Blake 已提交
2145 2146 2147
    aligned_offset = QEMU_ALIGN_DOWN(offset, align);
    aligned_bytes = ROUND_UP(offset + bytes, align) - aligned_offset;

2148 2149 2150 2151 2152 2153
    ret = bs->drv->bdrv_co_block_status(bs, want_zero, aligned_offset,
                                        aligned_bytes, pnum, &local_map,
                                        &local_file);
    if (ret < 0) {
        *pnum = 0;
        goto out;
E
Eric Blake 已提交
2154 2155
    }

2156
    /*
2157
     * The driver's result must be a non-zero multiple of request_alignment.
E
Eric Blake 已提交
2158
     * Clamp pnum and adjust map to original request.
2159
     */
2160 2161
    assert(*pnum && QEMU_IS_ALIGNED(*pnum, align) &&
           align > offset - aligned_offset);
E
Eric Blake 已提交
2162 2163 2164
    *pnum -= offset - aligned_offset;
    if (*pnum > bytes) {
        *pnum = bytes;
2165
    }
2166
    if (ret & BDRV_BLOCK_OFFSET_VALID) {
E
Eric Blake 已提交
2167
        local_map += offset - aligned_offset;
2168
    }
2169 2170

    if (ret & BDRV_BLOCK_RAW) {
2171
        assert(ret & BDRV_BLOCK_OFFSET_VALID && local_file);
2172 2173
        ret = bdrv_co_block_status(local_file, want_zero, local_map,
                                   *pnum, pnum, &local_map, &local_file);
2174
        goto out;
2175 2176 2177 2178
    }

    if (ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ZERO)) {
        ret |= BDRV_BLOCK_ALLOCATED;
2179
    } else if (want_zero) {
2180 2181
        if (bdrv_unallocated_blocks_are_zero(bs)) {
            ret |= BDRV_BLOCK_ZERO;
2182 2183
        } else if (bs->backing) {
            BlockDriverState *bs2 = bs->backing->bs;
2184
            int64_t size2 = bdrv_getlength(bs2);
2185

2186
            if (size2 >= 0 && offset >= size2) {
2187 2188 2189 2190 2191
                ret |= BDRV_BLOCK_ZERO;
            }
        }
    }

2192
    if (want_zero && local_file && local_file != bs &&
2193 2194
        (ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO) &&
        (ret & BDRV_BLOCK_OFFSET_VALID)) {
2195 2196
        int64_t file_pnum;
        int ret2;
2197

2198 2199
        ret2 = bdrv_co_block_status(local_file, want_zero, local_map,
                                    *pnum, &file_pnum, NULL, NULL);
2200 2201 2202 2203
        if (ret2 >= 0) {
            /* Ignore errors.  This is just providing extra information, it
             * is useful but not necessary.
             */
2204 2205 2206 2207 2208 2209 2210
            if (ret2 & BDRV_BLOCK_EOF &&
                (!file_pnum || ret2 & BDRV_BLOCK_ZERO)) {
                /*
                 * It is valid for the format block driver to read
                 * beyond the end of the underlying file's current
                 * size; such areas read as zero.
                 */
2211 2212 2213 2214 2215 2216 2217 2218 2219
                ret |= BDRV_BLOCK_ZERO;
            } else {
                /* Limit request to the range reported by the protocol driver */
                *pnum = file_pnum;
                ret |= (ret2 & BDRV_BLOCK_ZERO);
            }
        }
    }

2220 2221
out:
    bdrv_dec_in_flight(bs);
2222
    if (ret >= 0 && offset + *pnum == total_size) {
2223 2224
        ret |= BDRV_BLOCK_EOF;
    }
2225 2226 2227 2228
early_out:
    if (file) {
        *file = local_file;
    }
2229 2230 2231
    if (map) {
        *map = local_map;
    }
2232 2233 2234
    return ret;
}

2235 2236 2237 2238 2239 2240 2241 2242
static int coroutine_fn bdrv_co_block_status_above(BlockDriverState *bs,
                                                   BlockDriverState *base,
                                                   bool want_zero,
                                                   int64_t offset,
                                                   int64_t bytes,
                                                   int64_t *pnum,
                                                   int64_t *map,
                                                   BlockDriverState **file)
2243 2244
{
    BlockDriverState *p;
2245
    int ret = 0;
2246
    bool first = true;
2247 2248

    assert(bs != base);
2249
    for (p = bs; p != base; p = backing_bs(p)) {
2250 2251
        ret = bdrv_co_block_status(p, want_zero, offset, bytes, pnum, map,
                                   file);
2252 2253 2254 2255 2256 2257 2258 2259 2260 2261
        if (ret < 0) {
            break;
        }
        if (ret & BDRV_BLOCK_ZERO && ret & BDRV_BLOCK_EOF && !first) {
            /*
             * Reading beyond the end of the file continues to read
             * zeroes, but we can only widen the result to the
             * unallocated length we learned from an earlier
             * iteration.
             */
2262
            *pnum = bytes;
2263 2264
        }
        if (ret & (BDRV_BLOCK_ZERO | BDRV_BLOCK_DATA)) {
2265 2266
            break;
        }
2267 2268 2269
        /* [offset, pnum] unallocated on this layer, which could be only
         * the first part of [offset, bytes].  */
        bytes = MIN(bytes, *pnum);
2270
        first = false;
2271 2272 2273 2274
    }
    return ret;
}

2275
/* Coroutine wrapper for bdrv_block_status_above() */
2276
static void coroutine_fn bdrv_block_status_above_co_entry(void *opaque)
2277
{
2278
    BdrvCoBlockStatusData *data = opaque;
2279

2280 2281 2282 2283
    data->ret = bdrv_co_block_status_above(data->bs, data->base,
                                           data->want_zero,
                                           data->offset, data->bytes,
                                           data->pnum, data->map, data->file);
2284 2285 2286 2287
    data->done = true;
}

/*
2288
 * Synchronous wrapper around bdrv_co_block_status_above().
2289
 *
2290
 * See bdrv_co_block_status_above() for details.
2291
 */
2292 2293 2294 2295 2296 2297
static int bdrv_common_block_status_above(BlockDriverState *bs,
                                          BlockDriverState *base,
                                          bool want_zero, int64_t offset,
                                          int64_t bytes, int64_t *pnum,
                                          int64_t *map,
                                          BlockDriverState **file)
2298 2299
{
    Coroutine *co;
2300
    BdrvCoBlockStatusData data = {
2301
        .bs = bs,
2302
        .base = base,
2303
        .want_zero = want_zero,
2304 2305 2306 2307
        .offset = offset,
        .bytes = bytes,
        .pnum = pnum,
        .map = map,
2308
        .file = file,
2309 2310 2311 2312 2313
        .done = false,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2314
        bdrv_block_status_above_co_entry(&data);
2315
    } else {
2316
        co = qemu_coroutine_create(bdrv_block_status_above_co_entry, &data);
2317
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2318
        BDRV_POLL_WHILE(bs, !data.done);
2319
    }
2320
    return data.ret;
2321 2322
}

2323 2324 2325
int bdrv_block_status_above(BlockDriverState *bs, BlockDriverState *base,
                            int64_t offset, int64_t bytes, int64_t *pnum,
                            int64_t *map, BlockDriverState **file)
2326
{
2327 2328
    return bdrv_common_block_status_above(bs, base, true, offset, bytes,
                                          pnum, map, file);
2329 2330
}

2331 2332
int bdrv_block_status(BlockDriverState *bs, int64_t offset, int64_t bytes,
                      int64_t *pnum, int64_t *map, BlockDriverState **file)
2333
{
2334 2335
    return bdrv_block_status_above(bs, backing_bs(bs),
                                   offset, bytes, pnum, map, file);
2336 2337
}

2338 2339
int coroutine_fn bdrv_is_allocated(BlockDriverState *bs, int64_t offset,
                                   int64_t bytes, int64_t *pnum)
2340
{
2341 2342
    int ret;
    int64_t dummy;
2343

2344 2345
    ret = bdrv_common_block_status_above(bs, backing_bs(bs), false, offset,
                                         bytes, pnum ? pnum : &dummy, NULL,
2346
                                         NULL);
2347 2348 2349 2350 2351 2352 2353 2354 2355
    if (ret < 0) {
        return ret;
    }
    return !!(ret & BDRV_BLOCK_ALLOCATED);
}

/*
 * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
 *
2356 2357 2358
 * Return true if (a prefix of) the given range is allocated in any image
 * between BASE and TOP (inclusive).  BASE can be NULL to check if the given
 * offset is allocated in any image of the chain.  Return false otherwise,
2359
 * or negative errno on failure.
2360
 *
2361 2362 2363 2364 2365 2366
 * 'pnum' is set to the number of bytes (including and immediately
 * following the specified offset) that are known to be in the same
 * allocated/unallocated state.  Note that a subsequent call starting
 * at 'offset + *pnum' may return the same allocation status (in other
 * words, the result is not necessarily the maximum possible range);
 * but 'pnum' will only be 0 when end of file is reached.
2367 2368 2369 2370
 *
 */
int bdrv_is_allocated_above(BlockDriverState *top,
                            BlockDriverState *base,
2371
                            int64_t offset, int64_t bytes, int64_t *pnum)
2372 2373
{
    BlockDriverState *intermediate;
2374 2375
    int ret;
    int64_t n = bytes;
2376 2377 2378

    intermediate = top;
    while (intermediate && intermediate != base) {
2379
        int64_t pnum_inter;
2380
        int64_t size_inter;
2381

2382
        ret = bdrv_is_allocated(intermediate, offset, bytes, &pnum_inter);
2383 2384
        if (ret < 0) {
            return ret;
2385 2386
        }
        if (ret) {
2387
            *pnum = pnum_inter;
2388 2389 2390
            return 1;
        }

2391
        size_inter = bdrv_getlength(intermediate);
2392 2393 2394
        if (size_inter < 0) {
            return size_inter;
        }
2395 2396 2397
        if (n > pnum_inter &&
            (intermediate == top || offset + pnum_inter < size_inter)) {
            n = pnum_inter;
2398 2399
        }

2400
        intermediate = backing_bs(intermediate);
2401 2402 2403 2404 2405 2406
    }

    *pnum = n;
    return 0;
}

2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419
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;
2420 2421 2422
    int ret = -ENOTSUP;

    bdrv_inc_in_flight(bs);
2423 2424

    if (!drv) {
2425
        ret = -ENOMEDIUM;
2426
    } else if (drv->bdrv_load_vmstate) {
2427 2428 2429 2430 2431
        if (is_read) {
            ret = drv->bdrv_load_vmstate(bs, qiov, pos);
        } else {
            ret = drv->bdrv_save_vmstate(bs, qiov, pos);
        }
2432
    } else if (bs->file) {
2433
        ret = bdrv_co_rw_vmstate(bs->file->bs, qiov, pos, is_read);
2434 2435
    }

2436 2437
    bdrv_dec_in_flight(bs);
    return ret;
2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459
}

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

2462
        bdrv_coroutine_enter(bs, co);
2463
        BDRV_POLL_WHILE(bs, data.ret == -EINPROGRESS);
2464 2465 2466 2467
        return data.ret;
    }
}

2468 2469 2470 2471 2472 2473 2474 2475
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,
    };
2476
    int ret;
2477 2478

    qemu_iovec_init_external(&qiov, &iov, 1);
2479 2480 2481 2482 2483 2484 2485

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

    return size;
2486 2487 2488 2489
}

int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
{
2490
    return bdrv_rw_vmstate(bs, qiov, pos, false);
2491 2492 2493 2494
}

int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size)
2495 2496 2497 2498 2499 2500
{
    QEMUIOVector qiov;
    struct iovec iov = {
        .iov_base   = buf,
        .iov_len    = size,
    };
2501
    int ret;
2502 2503

    qemu_iovec_init_external(&qiov, &iov, 1);
2504 2505 2506 2507 2508 2509
    ret = bdrv_readv_vmstate(bs, &qiov, pos);
    if (ret < 0) {
        return ret;
    }

    return size;
2510 2511 2512
}

int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
2513
{
2514
    return bdrv_rw_vmstate(bs, qiov, pos, true);
2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527
}

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

void bdrv_aio_cancel(BlockAIOCB *acb)
{
    qemu_aio_ref(acb);
    bdrv_aio_cancel_async(acb);
    while (acb->refcnt > 1) {
        if (acb->aiocb_info->get_aio_context) {
            aio_poll(acb->aiocb_info->get_aio_context(acb), true);
        } else if (acb->bs) {
2528 2529 2530 2531 2532
            /* qemu_aio_ref and qemu_aio_unref are not thread-safe, so
             * assert that we're not using an I/O thread.  Thread-safe
             * code should use bdrv_aio_cancel_async exclusively.
             */
            assert(bdrv_get_aio_context(acb->bs) == qemu_get_aio_context());
2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553
            aio_poll(bdrv_get_aio_context(acb->bs), true);
        } else {
            abort();
        }
    }
    qemu_aio_unref(acb);
}

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

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

2554 2555 2556 2557 2558 2559
typedef struct FlushCo {
    BlockDriverState *bs;
    int ret;
} FlushCo;


2560 2561
static void coroutine_fn bdrv_flush_co_entry(void *opaque)
{
2562
    FlushCo *rwco = opaque;
2563 2564 2565 2566 2567 2568

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

int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
{
2569 2570 2571 2572
    int current_gen;
    int ret = 0;

    bdrv_inc_in_flight(bs);
2573

2574
    if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs) ||
2575
        bdrv_is_sg(bs)) {
2576
        goto early_exit;
2577 2578
    }

2579
    qemu_co_mutex_lock(&bs->reqs_lock);
2580
    current_gen = atomic_read(&bs->write_gen);
2581 2582

    /* Wait until any previous flushes are completed */
2583
    while (bs->active_flush_req) {
2584
        qemu_co_queue_wait(&bs->flush_queue, &bs->reqs_lock);
2585 2586
    }

2587
    /* Flushes reach this point in nondecreasing current_gen order.  */
2588
    bs->active_flush_req = true;
2589
    qemu_co_mutex_unlock(&bs->reqs_lock);
2590

P
Pavel Dovgalyuk 已提交
2591 2592 2593 2594 2595 2596
    /* Write back all layers by calling one driver function */
    if (bs->drv->bdrv_co_flush) {
        ret = bs->drv->bdrv_co_flush(bs);
        goto out;
    }

2597 2598 2599 2600 2601
    /* 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 已提交
2602
            goto out;
2603 2604 2605 2606 2607 2608 2609 2610
        }
    }

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

2611 2612 2613 2614 2615
    /* Check if we really need to flush anything */
    if (bs->flushed_gen == current_gen) {
        goto flush_parent;
    }

2616
    BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_DISK);
M
Max Reitz 已提交
2617 2618 2619 2620 2621 2622
    if (!bs->drv) {
        /* bs->drv->bdrv_co_flush() might have ejected the BDS
         * (even in case of apparent success) */
        ret = -ENOMEDIUM;
        goto out;
    }
2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651
    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;
    }
2652

2653
    if (ret < 0) {
F
Fam Zheng 已提交
2654
        goto out;
2655 2656 2657 2658 2659 2660
    }

    /* 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 已提交
2661 2662
    ret = bs->file ? bdrv_co_flush(bs->file->bs) : 0;
out:
2663
    /* Notify any pending flushes that we have completed */
2664 2665 2666
    if (ret == 0) {
        bs->flushed_gen = current_gen;
    }
2667 2668

    qemu_co_mutex_lock(&bs->reqs_lock);
2669
    bs->active_flush_req = false;
2670 2671
    /* Return value is ignored - it's ok if wait queue is empty */
    qemu_co_queue_next(&bs->flush_queue);
2672
    qemu_co_mutex_unlock(&bs->reqs_lock);
2673

2674
early_exit:
2675
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2676
    return ret;
2677 2678 2679 2680 2681
}

int bdrv_flush(BlockDriverState *bs)
{
    Coroutine *co;
2682
    FlushCo flush_co = {
2683 2684 2685 2686 2687 2688
        .bs = bs,
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2689
        bdrv_flush_co_entry(&flush_co);
2690
    } else {
2691
        co = qemu_coroutine_create(bdrv_flush_co_entry, &flush_co);
2692
        bdrv_coroutine_enter(bs, co);
P
Paolo Bonzini 已提交
2693
        BDRV_POLL_WHILE(bs, flush_co.ret == NOT_DONE);
2694 2695
    }

2696
    return flush_co.ret;
2697 2698 2699
}

typedef struct DiscardCo {
F
Fam Zheng 已提交
2700
    BdrvChild *child;
2701
    int64_t offset;
2702
    int bytes;
2703 2704
    int ret;
} DiscardCo;
2705
static void coroutine_fn bdrv_pdiscard_co_entry(void *opaque)
2706 2707 2708
{
    DiscardCo *rwco = opaque;

F
Fam Zheng 已提交
2709
    rwco->ret = bdrv_co_pdiscard(rwco->child, rwco->offset, rwco->bytes);
2710 2711
}

F
Fam Zheng 已提交
2712
int coroutine_fn bdrv_co_pdiscard(BdrvChild *child, int64_t offset, int bytes)
2713
{
F
Fam Zheng 已提交
2714
    BdrvTrackedRequest req;
2715
    int max_pdiscard, ret;
2716
    int head, tail, align;
F
Fam Zheng 已提交
2717
    BlockDriverState *bs = child->bs;
2718

F
Fam Zheng 已提交
2719
    if (!bs || !bs->drv) {
2720 2721 2722
        return -ENOMEDIUM;
    }

2723 2724 2725 2726
    if (bdrv_has_readonly_bitmaps(bs)) {
        return -EPERM;
    }

2727
    ret = bdrv_check_byte_request(bs, offset, bytes);
2728 2729 2730 2731 2732 2733 2734 2735 2736
    if (ret < 0) {
        return ret;
    }

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

E
Eric Blake 已提交
2737
    if (!bs->drv->bdrv_co_pdiscard && !bs->drv->bdrv_aio_pdiscard) {
2738 2739 2740
        return 0;
    }

2741 2742 2743 2744 2745
    /* Discard is advisory, but some devices track and coalesce
     * unaligned requests, so we must pass everything down rather than
     * round here.  Still, most devices will just silently ignore
     * unaligned requests (by returning -ENOTSUP), so we must fragment
     * the request accordingly.  */
E
Eric Blake 已提交
2746
    align = MAX(bs->bl.pdiscard_alignment, bs->bl.request_alignment);
2747 2748
    assert(align % bs->bl.request_alignment == 0);
    head = offset % align;
2749
    tail = (offset + bytes) % align;
2750

2751
    bdrv_inc_in_flight(bs);
2752
    tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_DISCARD);
2753

2754
    ret = bdrv_co_write_req_prepare(child, offset, bytes, &req, 0);
2755 2756 2757 2758
    if (ret < 0) {
        goto out;
    }

2759 2760
    max_pdiscard = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_pdiscard, INT_MAX),
                                   align);
2761
    assert(max_pdiscard >= bs->bl.request_alignment);
2762

2763 2764
    while (bytes > 0) {
        int num = bytes;
2765 2766 2767

        if (head) {
            /* Make small requests to get to alignment boundaries. */
2768
            num = MIN(bytes, align - head);
2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787
            if (!QEMU_IS_ALIGNED(num, bs->bl.request_alignment)) {
                num %= bs->bl.request_alignment;
            }
            head = (head + num) % align;
            assert(num < max_pdiscard);
        } else if (tail) {
            if (num > align) {
                /* Shorten the request to the last aligned cluster.  */
                num -= tail;
            } else if (!QEMU_IS_ALIGNED(tail, bs->bl.request_alignment) &&
                       tail > bs->bl.request_alignment) {
                tail %= bs->bl.request_alignment;
                num -= tail;
            }
        }
        /* limit request size */
        if (num > max_pdiscard) {
            num = max_pdiscard;
        }
2788

M
Max Reitz 已提交
2789 2790 2791 2792
        if (!bs->drv) {
            ret = -ENOMEDIUM;
            goto out;
        }
2793 2794
        if (bs->drv->bdrv_co_pdiscard) {
            ret = bs->drv->bdrv_co_pdiscard(bs, offset, num);
2795 2796 2797 2798 2799 2800
        } else {
            BlockAIOCB *acb;
            CoroutineIOCompletion co = {
                .coroutine = qemu_coroutine_self(),
            };

2801 2802
            acb = bs->drv->bdrv_aio_pdiscard(bs, offset, num,
                                             bdrv_co_io_em_complete, &co);
2803
            if (acb == NULL) {
F
Fam Zheng 已提交
2804 2805
                ret = -EIO;
                goto out;
2806 2807 2808 2809 2810 2811
            } else {
                qemu_coroutine_yield();
                ret = co.ret;
            }
        }
        if (ret && ret != -ENOTSUP) {
F
Fam Zheng 已提交
2812
            goto out;
2813 2814
        }

2815
        offset += num;
2816
        bytes -= num;
2817
    }
F
Fam Zheng 已提交
2818 2819
    ret = 0;
out:
2820
    bdrv_co_write_req_finish(child, req.offset, req.bytes, &req, ret);
F
Fam Zheng 已提交
2821
    tracked_request_end(&req);
2822
    bdrv_dec_in_flight(bs);
F
Fam Zheng 已提交
2823
    return ret;
2824 2825
}

F
Fam Zheng 已提交
2826
int bdrv_pdiscard(BdrvChild *child, int64_t offset, int bytes)
2827 2828 2829
{
    Coroutine *co;
    DiscardCo rwco = {
F
Fam Zheng 已提交
2830
        .child = child,
2831
        .offset = offset,
2832
        .bytes = bytes,
2833 2834 2835 2836 2837
        .ret = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
2838
        bdrv_pdiscard_co_entry(&rwco);
2839
    } else {
2840
        co = qemu_coroutine_create(bdrv_pdiscard_co_entry, &rwco);
F
Fam Zheng 已提交
2841 2842
        bdrv_coroutine_enter(child->bs, co);
        BDRV_POLL_WHILE(child->bs, rwco.ret == NOT_DONE);
2843 2844 2845 2846 2847
    }

    return rwco.ret;
}

2848
int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf)
2849 2850
{
    BlockDriver *drv = bs->drv;
2851 2852 2853 2854
    CoroutineIOCompletion co = {
        .coroutine = qemu_coroutine_self(),
    };
    BlockAIOCB *acb;
2855

2856
    bdrv_inc_in_flight(bs);
2857
    if (!drv || (!drv->bdrv_aio_ioctl && !drv->bdrv_co_ioctl)) {
2858 2859 2860 2861
        co.ret = -ENOTSUP;
        goto out;
    }

2862 2863 2864 2865 2866 2867 2868 2869 2870
    if (drv->bdrv_co_ioctl) {
        co.ret = drv->bdrv_co_ioctl(bs, req, buf);
    } else {
        acb = drv->bdrv_aio_ioctl(bs, req, buf, bdrv_co_io_em_complete, &co);
        if (!acb) {
            co.ret = -ENOTSUP;
            goto out;
        }
        qemu_coroutine_yield();
2871 2872
    }
out:
2873
    bdrv_dec_in_flight(bs);
2874 2875 2876
    return co.ret;
}

2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916
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;
2917
    size_t alignment = bdrv_min_mem_align(bs);
2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938

    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)
{
2939 2940 2941 2942 2943 2944
    BdrvChild *child;

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

2945
    if (atomic_fetch_inc(&bs->io_plugged) == 0) {
2946 2947 2948 2949
        BlockDriver *drv = bs->drv;
        if (drv && drv->bdrv_io_plug) {
            drv->bdrv_io_plug(bs);
        }
2950 2951 2952 2953 2954
    }
}

void bdrv_io_unplug(BlockDriverState *bs)
{
2955 2956 2957
    BdrvChild *child;

    assert(bs->io_plugged);
2958
    if (atomic_fetch_dec(&bs->io_plugged) == 1) {
2959 2960 2961 2962 2963 2964 2965 2966
        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);
2967 2968
    }
}
F
Fam Zheng 已提交
2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992

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

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

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

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

2994 2995 2996 2997 2998
static int coroutine_fn bdrv_co_copy_range_internal(
        BdrvChild *src, uint64_t src_offset, BdrvChild *dst,
        uint64_t dst_offset, uint64_t bytes,
        BdrvRequestFlags read_flags, BdrvRequestFlags write_flags,
        bool recurse_src)
2999
{
3000
    BdrvTrackedRequest req;
3001 3002
    int ret;

3003
    if (!dst || !dst->bs) {
3004 3005 3006 3007 3008 3009
        return -ENOMEDIUM;
    }
    ret = bdrv_check_byte_request(dst->bs, dst_offset, bytes);
    if (ret) {
        return ret;
    }
3010 3011
    if (write_flags & BDRV_REQ_ZERO_WRITE) {
        return bdrv_co_pwrite_zeroes(dst, dst_offset, bytes, write_flags);
3012 3013
    }

3014 3015 3016 3017 3018 3019 3020 3021
    if (!src || !src->bs) {
        return -ENOMEDIUM;
    }
    ret = bdrv_check_byte_request(src->bs, src_offset, bytes);
    if (ret) {
        return ret;
    }

3022 3023 3024 3025 3026
    if (!src->bs->drv->bdrv_co_copy_range_from
        || !dst->bs->drv->bdrv_co_copy_range_to
        || src->bs->encrypted || dst->bs->encrypted) {
        return -ENOTSUP;
    }
3027

3028
    if (recurse_src) {
3029 3030 3031 3032
        bdrv_inc_in_flight(src->bs);
        tracked_request_begin(&req, src->bs, src_offset, bytes,
                              BDRV_TRACKED_READ);

3033 3034
        /* BDRV_REQ_SERIALISING is only for write operation */
        assert(!(read_flags & BDRV_REQ_SERIALISING));
3035
        if (!(read_flags & BDRV_REQ_NO_SERIALISING)) {
3036 3037 3038
            wait_serialising_requests(&req);
        }

3039 3040 3041
        ret = src->bs->drv->bdrv_co_copy_range_from(src->bs,
                                                    src, src_offset,
                                                    dst, dst_offset,
3042 3043
                                                    bytes,
                                                    read_flags, write_flags);
3044 3045 3046

        tracked_request_end(&req);
        bdrv_dec_in_flight(src->bs);
3047
    } else {
3048 3049 3050
        bdrv_inc_in_flight(dst->bs);
        tracked_request_begin(&req, dst->bs, dst_offset, bytes,
                              BDRV_TRACKED_WRITE);
3051 3052 3053 3054 3055 3056 3057 3058 3059 3060
        ret = bdrv_co_write_req_prepare(dst, dst_offset, bytes, &req,
                                        write_flags);
        if (!ret) {
            ret = dst->bs->drv->bdrv_co_copy_range_to(dst->bs,
                                                      src, src_offset,
                                                      dst, dst_offset,
                                                      bytes,
                                                      read_flags, write_flags);
        }
        bdrv_co_write_req_finish(dst, dst_offset, bytes, &req, ret);
3061 3062
        tracked_request_end(&req);
        bdrv_dec_in_flight(dst->bs);
3063
    }
3064

3065
    return ret;
3066 3067 3068 3069 3070 3071 3072 3073
}

/* Copy range from @src to @dst.
 *
 * See the comment of bdrv_co_copy_range for the parameter and return value
 * semantics. */
int coroutine_fn bdrv_co_copy_range_from(BdrvChild *src, uint64_t src_offset,
                                         BdrvChild *dst, uint64_t dst_offset,
3074 3075 3076
                                         uint64_t bytes,
                                         BdrvRequestFlags read_flags,
                                         BdrvRequestFlags write_flags)
3077
{
3078 3079
    trace_bdrv_co_copy_range_from(src, src_offset, dst, dst_offset, bytes,
                                  read_flags, write_flags);
3080
    return bdrv_co_copy_range_internal(src, src_offset, dst, dst_offset,
3081
                                       bytes, read_flags, write_flags, true);
3082 3083 3084 3085 3086 3087 3088 3089
}

/* Copy range from @src to @dst.
 *
 * See the comment of bdrv_co_copy_range for the parameter and return value
 * semantics. */
int coroutine_fn bdrv_co_copy_range_to(BdrvChild *src, uint64_t src_offset,
                                       BdrvChild *dst, uint64_t dst_offset,
3090 3091 3092
                                       uint64_t bytes,
                                       BdrvRequestFlags read_flags,
                                       BdrvRequestFlags write_flags)
3093
{
3094 3095
    trace_bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
                                read_flags, write_flags);
3096
    return bdrv_co_copy_range_internal(src, src_offset, dst, dst_offset,
3097
                                       bytes, read_flags, write_flags, false);
3098 3099 3100 3101
}

int coroutine_fn bdrv_co_copy_range(BdrvChild *src, uint64_t src_offset,
                                    BdrvChild *dst, uint64_t dst_offset,
3102 3103
                                    uint64_t bytes, BdrvRequestFlags read_flags,
                                    BdrvRequestFlags write_flags)
3104
{
3105 3106
    return bdrv_co_copy_range_from(src, src_offset,
                                   dst, dst_offset,
3107
                                   bytes, read_flags, write_flags);
3108
}
3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127

static void bdrv_parent_cb_resize(BlockDriverState *bs)
{
    BdrvChild *c;
    QLIST_FOREACH(c, &bs->parents, next_parent) {
        if (c->role->resize) {
            c->role->resize(c);
        }
    }
}

/**
 * Truncate file to 'offset' bytes (needed only for file protocols)
 */
int coroutine_fn bdrv_co_truncate(BdrvChild *child, int64_t offset,
                                  PreallocMode prealloc, Error **errp)
{
    BlockDriverState *bs = child->bs;
    BlockDriver *drv = bs->drv;
3128 3129
    BdrvTrackedRequest req;
    int64_t old_size, new_bytes;
3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
    int ret;


    /* if bs->drv == NULL, bs is closed, so there's nothing to do here */
    if (!drv) {
        error_setg(errp, "No medium inserted");
        return -ENOMEDIUM;
    }
    if (offset < 0) {
        error_setg(errp, "Image size cannot be negative");
        return -EINVAL;
    }

3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154
    old_size = bdrv_getlength(bs);
    if (old_size < 0) {
        error_setg_errno(errp, -old_size, "Failed to get old image size");
        return old_size;
    }

    if (offset > old_size) {
        new_bytes = offset - old_size;
    } else {
        new_bytes = 0;
    }

3155
    bdrv_inc_in_flight(bs);
3156 3157
    tracked_request_begin(&req, bs, offset - new_bytes, new_bytes,
                          BDRV_TRACKED_TRUNCATE);
3158 3159 3160 3161 3162 3163

    /* If we are growing the image and potentially using preallocation for the
     * new area, we need to make sure that no write requests are made to it
     * concurrently or they might be overwritten by preallocation. */
    if (new_bytes) {
        mark_request_serialising(&req, 1);
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175
    }
    if (bs->read_only) {
        error_setg(errp, "Image is read-only");
        ret = -EACCES;
        goto out;
    }
    ret = bdrv_co_write_req_prepare(child, offset - new_bytes, new_bytes, &req,
                                    0);
    if (ret < 0) {
        error_setg_errno(errp, -ret,
                         "Failed to prepare request for truncation");
        goto out;
3176
    }
3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197

    if (!drv->bdrv_co_truncate) {
        if (bs->file && drv->is_filter) {
            ret = bdrv_co_truncate(bs->file, offset, prealloc, errp);
            goto out;
        }
        error_setg(errp, "Image format driver does not support resize");
        ret = -ENOTSUP;
        goto out;
    }

    ret = drv->bdrv_co_truncate(bs, offset, prealloc, errp);
    if (ret < 0) {
        goto out;
    }
    ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
    if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not refresh total sector count");
    } else {
        offset = bs->total_sectors * BDRV_SECTOR_SIZE;
    }
3198 3199 3200 3201
    /* It's possible that truncation succeeded but refresh_total_sectors
     * failed, but the latter doesn't affect how we should finish the request.
     * Pass 0 as the last parameter so that dirty bitmaps etc. are handled. */
    bdrv_co_write_req_finish(child, offset - new_bytes, new_bytes, &req, 0);
3202 3203

out:
3204
    tracked_request_end(&req);
3205
    bdrv_dec_in_flight(bs);
3206

3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247
    return ret;
}

typedef struct TruncateCo {
    BdrvChild *child;
    int64_t offset;
    PreallocMode prealloc;
    Error **errp;
    int ret;
} TruncateCo;

static void coroutine_fn bdrv_truncate_co_entry(void *opaque)
{
    TruncateCo *tco = opaque;
    tco->ret = bdrv_co_truncate(tco->child, tco->offset, tco->prealloc,
                                tco->errp);
}

int bdrv_truncate(BdrvChild *child, int64_t offset, PreallocMode prealloc,
                  Error **errp)
{
    Coroutine *co;
    TruncateCo tco = {
        .child      = child,
        .offset     = offset,
        .prealloc   = prealloc,
        .errp       = errp,
        .ret        = NOT_DONE,
    };

    if (qemu_in_coroutine()) {
        /* Fast-path if already in coroutine context */
        bdrv_truncate_co_entry(&tco);
    } else {
        co = qemu_coroutine_create(bdrv_truncate_co_entry, &tco);
        qemu_coroutine_enter(co);
        BDRV_POLL_WHILE(child->bs, tco.ret == NOT_DONE);
    }

    return tco.ret;
}