block: Switch BdrvCoGetBlockStatusData to byte-based
[qemu/ericb.git] / block / io.c
blob71d5f18d0464017d8bbd8bbadf1c7a4354755e59
1 /*
2 * Block layer I/O functions
4 * Copyright (c) 2003 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
25 #include "qemu/osdep.h"
26 #include "trace.h"
27 #include "sysemu/block-backend.h"
28 #include "block/blockjob.h"
29 #include "block/blockjob_int.h"
30 #include "block/block_int.h"
31 #include "qemu/cutils.h"
32 #include "qapi/error.h"
33 #include "qemu/error-report.h"
35 #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
37 /* Maximum bounce buffer for copy-on-read and write zeroes, in bytes */
38 #define MAX_BOUNCE_BUFFER (32768 << BDRV_SECTOR_BITS)
40 static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
41 int64_t offset, int bytes, BdrvRequestFlags flags);
43 void bdrv_parent_drained_begin(BlockDriverState *bs)
45 BdrvChild *c;
47 QLIST_FOREACH(c, &bs->parents, next_parent) {
48 if (c->role->drained_begin) {
49 c->role->drained_begin(c);
54 void bdrv_parent_drained_end(BlockDriverState *bs)
56 BdrvChild *c;
58 QLIST_FOREACH(c, &bs->parents, next_parent) {
59 if (c->role->drained_end) {
60 c->role->drained_end(c);
65 static void bdrv_merge_limits(BlockLimits *dst, const BlockLimits *src)
67 dst->opt_transfer = MAX(dst->opt_transfer, src->opt_transfer);
68 dst->max_transfer = MIN_NON_ZERO(dst->max_transfer, src->max_transfer);
69 dst->opt_mem_alignment = MAX(dst->opt_mem_alignment,
70 src->opt_mem_alignment);
71 dst->min_mem_alignment = MAX(dst->min_mem_alignment,
72 src->min_mem_alignment);
73 dst->max_iov = MIN_NON_ZERO(dst->max_iov, src->max_iov);
76 void bdrv_refresh_limits(BlockDriverState *bs, Error **errp)
78 BlockDriver *drv = bs->drv;
79 Error *local_err = NULL;
81 memset(&bs->bl, 0, sizeof(bs->bl));
83 if (!drv) {
84 return;
87 /* Default alignment based on whether driver has byte interface */
88 bs->bl.request_alignment = drv->bdrv_co_preadv ? 1 : 512;
90 /* Take some limits from the children as a default */
91 if (bs->file) {
92 bdrv_refresh_limits(bs->file->bs, &local_err);
93 if (local_err) {
94 error_propagate(errp, local_err);
95 return;
97 bdrv_merge_limits(&bs->bl, &bs->file->bs->bl);
98 } else {
99 bs->bl.min_mem_alignment = 512;
100 bs->bl.opt_mem_alignment = getpagesize();
102 /* Safe default since most protocols use readv()/writev()/etc */
103 bs->bl.max_iov = IOV_MAX;
106 if (bs->backing) {
107 bdrv_refresh_limits(bs->backing->bs, &local_err);
108 if (local_err) {
109 error_propagate(errp, local_err);
110 return;
112 bdrv_merge_limits(&bs->bl, &bs->backing->bs->bl);
115 /* Then let the driver override it */
116 if (drv->bdrv_refresh_limits) {
117 drv->bdrv_refresh_limits(bs, errp);
122 * The copy-on-read flag is actually a reference count so multiple users may
123 * use the feature without worrying about clobbering its previous state.
124 * Copy-on-read stays enabled until all users have called to disable it.
126 void bdrv_enable_copy_on_read(BlockDriverState *bs)
128 atomic_inc(&bs->copy_on_read);
131 void bdrv_disable_copy_on_read(BlockDriverState *bs)
133 int old = atomic_fetch_dec(&bs->copy_on_read);
134 assert(old >= 1);
137 /* Check if any requests are in-flight (including throttled requests) */
138 bool bdrv_requests_pending(BlockDriverState *bs)
140 BdrvChild *child;
142 if (atomic_read(&bs->in_flight)) {
143 return true;
146 QLIST_FOREACH(child, &bs->children, next) {
147 if (bdrv_requests_pending(child->bs)) {
148 return true;
152 return false;
155 typedef struct {
156 Coroutine *co;
157 BlockDriverState *bs;
158 bool done;
159 bool begin;
160 } BdrvCoDrainData;
162 static void coroutine_fn bdrv_drain_invoke_entry(void *opaque)
164 BdrvCoDrainData *data = opaque;
165 BlockDriverState *bs = data->bs;
167 if (data->begin) {
168 bs->drv->bdrv_co_drain_begin(bs);
169 } else {
170 bs->drv->bdrv_co_drain_end(bs);
173 /* Set data->done before reading bs->wakeup. */
174 atomic_mb_set(&data->done, true);
175 bdrv_wakeup(bs);
178 static void bdrv_drain_invoke(BlockDriverState *bs, bool begin)
180 BdrvCoDrainData data = { .bs = bs, .done = false, .begin = begin};
182 if (!bs->drv || (begin && !bs->drv->bdrv_co_drain_begin) ||
183 (!begin && !bs->drv->bdrv_co_drain_end)) {
184 return;
187 data.co = qemu_coroutine_create(bdrv_drain_invoke_entry, &data);
188 bdrv_coroutine_enter(bs, data.co);
189 BDRV_POLL_WHILE(bs, !data.done);
192 static bool bdrv_drain_recurse(BlockDriverState *bs, bool begin)
194 BdrvChild *child, *tmp;
195 bool waited;
197 /* Ensure any pending metadata writes are submitted to bs->file. */
198 bdrv_drain_invoke(bs, begin);
200 /* Wait for drained requests to finish */
201 waited = BDRV_POLL_WHILE(bs, atomic_read(&bs->in_flight) > 0);
203 QLIST_FOREACH_SAFE(child, &bs->children, next, tmp) {
204 BlockDriverState *bs = child->bs;
205 bool in_main_loop =
206 qemu_get_current_aio_context() == qemu_get_aio_context();
207 assert(bs->refcnt > 0);
208 if (in_main_loop) {
209 /* In case the recursive bdrv_drain_recurse processes a
210 * block_job_defer_to_main_loop BH and modifies the graph,
211 * let's hold a reference to bs until we are done.
213 * IOThread doesn't have such a BH, and it is not safe to call
214 * bdrv_unref without BQL, so skip doing it there.
216 bdrv_ref(bs);
218 waited |= bdrv_drain_recurse(bs, begin);
219 if (in_main_loop) {
220 bdrv_unref(bs);
224 return waited;
227 static void bdrv_co_drain_bh_cb(void *opaque)
229 BdrvCoDrainData *data = opaque;
230 Coroutine *co = data->co;
231 BlockDriverState *bs = data->bs;
233 bdrv_dec_in_flight(bs);
234 if (data->begin) {
235 bdrv_drained_begin(bs);
236 } else {
237 bdrv_drained_end(bs);
240 data->done = true;
241 aio_co_wake(co);
244 static void coroutine_fn bdrv_co_yield_to_drain(BlockDriverState *bs,
245 bool begin)
247 BdrvCoDrainData data;
249 /* Calling bdrv_drain() from a BH ensures the current coroutine yields and
250 * other coroutines run if they were queued from
251 * qemu_co_queue_run_restart(). */
253 assert(qemu_in_coroutine());
254 data = (BdrvCoDrainData) {
255 .co = qemu_coroutine_self(),
256 .bs = bs,
257 .done = false,
258 .begin = begin,
260 bdrv_inc_in_flight(bs);
261 aio_bh_schedule_oneshot(bdrv_get_aio_context(bs),
262 bdrv_co_drain_bh_cb, &data);
264 qemu_coroutine_yield();
265 /* If we are resumed from some other event (such as an aio completion or a
266 * timer callback), it is a bug in the caller that should be fixed. */
267 assert(data.done);
270 void bdrv_drained_begin(BlockDriverState *bs)
272 if (qemu_in_coroutine()) {
273 bdrv_co_yield_to_drain(bs, true);
274 return;
277 if (atomic_fetch_inc(&bs->quiesce_counter) == 0) {
278 aio_disable_external(bdrv_get_aio_context(bs));
279 bdrv_parent_drained_begin(bs);
282 bdrv_drain_recurse(bs, true);
285 void bdrv_drained_end(BlockDriverState *bs)
287 if (qemu_in_coroutine()) {
288 bdrv_co_yield_to_drain(bs, false);
289 return;
291 assert(bs->quiesce_counter > 0);
292 if (atomic_fetch_dec(&bs->quiesce_counter) > 1) {
293 return;
296 bdrv_parent_drained_end(bs);
297 bdrv_drain_recurse(bs, false);
298 aio_enable_external(bdrv_get_aio_context(bs));
302 * Wait for pending requests to complete on a single BlockDriverState subtree,
303 * and suspend block driver's internal I/O until next request arrives.
305 * Note that unlike bdrv_drain_all(), the caller must hold the BlockDriverState
306 * AioContext.
308 * Only this BlockDriverState's AioContext is run, so in-flight requests must
309 * not depend on events in other AioContexts. In that case, use
310 * bdrv_drain_all() instead.
312 void coroutine_fn bdrv_co_drain(BlockDriverState *bs)
314 assert(qemu_in_coroutine());
315 bdrv_drained_begin(bs);
316 bdrv_drained_end(bs);
319 void bdrv_drain(BlockDriverState *bs)
321 bdrv_drained_begin(bs);
322 bdrv_drained_end(bs);
326 * Wait for pending requests to complete across all BlockDriverStates
328 * This function does not flush data to disk, use bdrv_flush_all() for that
329 * after calling this function.
331 * This pauses all block jobs and disables external clients. It must
332 * be paired with bdrv_drain_all_end().
334 * NOTE: no new block jobs or BlockDriverStates can be created between
335 * the bdrv_drain_all_begin() and bdrv_drain_all_end() calls.
337 void bdrv_drain_all_begin(void)
339 /* Always run first iteration so any pending completion BHs run */
340 bool waited = true;
341 BlockDriverState *bs;
342 BdrvNextIterator it;
343 GSList *aio_ctxs = NULL, *ctx;
345 block_job_pause_all();
347 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
348 AioContext *aio_context = bdrv_get_aio_context(bs);
350 aio_context_acquire(aio_context);
351 bdrv_parent_drained_begin(bs);
352 aio_disable_external(aio_context);
353 aio_context_release(aio_context);
355 if (!g_slist_find(aio_ctxs, aio_context)) {
356 aio_ctxs = g_slist_prepend(aio_ctxs, aio_context);
360 /* Note that completion of an asynchronous I/O operation can trigger any
361 * number of other I/O operations on other devices---for example a
362 * coroutine can submit an I/O request to another device in response to
363 * request completion. Therefore we must keep looping until there was no
364 * more activity rather than simply draining each device independently.
366 while (waited) {
367 waited = false;
369 for (ctx = aio_ctxs; ctx != NULL; ctx = ctx->next) {
370 AioContext *aio_context = ctx->data;
372 aio_context_acquire(aio_context);
373 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
374 if (aio_context == bdrv_get_aio_context(bs)) {
375 waited |= bdrv_drain_recurse(bs, true);
378 aio_context_release(aio_context);
382 g_slist_free(aio_ctxs);
385 void bdrv_drain_all_end(void)
387 BlockDriverState *bs;
388 BdrvNextIterator it;
390 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
391 AioContext *aio_context = bdrv_get_aio_context(bs);
393 aio_context_acquire(aio_context);
394 aio_enable_external(aio_context);
395 bdrv_parent_drained_end(bs);
396 bdrv_drain_recurse(bs, false);
397 aio_context_release(aio_context);
400 block_job_resume_all();
403 void bdrv_drain_all(void)
405 bdrv_drain_all_begin();
406 bdrv_drain_all_end();
410 * Remove an active request from the tracked requests list
412 * This function should be called when a tracked request is completing.
414 static void tracked_request_end(BdrvTrackedRequest *req)
416 if (req->serialising) {
417 atomic_dec(&req->bs->serialising_in_flight);
420 qemu_co_mutex_lock(&req->bs->reqs_lock);
421 QLIST_REMOVE(req, list);
422 qemu_co_queue_restart_all(&req->wait_queue);
423 qemu_co_mutex_unlock(&req->bs->reqs_lock);
427 * Add an active request to the tracked requests list
429 static void tracked_request_begin(BdrvTrackedRequest *req,
430 BlockDriverState *bs,
431 int64_t offset,
432 unsigned int bytes,
433 enum BdrvTrackedRequestType type)
435 *req = (BdrvTrackedRequest){
436 .bs = bs,
437 .offset = offset,
438 .bytes = bytes,
439 .type = type,
440 .co = qemu_coroutine_self(),
441 .serialising = false,
442 .overlap_offset = offset,
443 .overlap_bytes = bytes,
446 qemu_co_queue_init(&req->wait_queue);
448 qemu_co_mutex_lock(&bs->reqs_lock);
449 QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
450 qemu_co_mutex_unlock(&bs->reqs_lock);
453 static void mark_request_serialising(BdrvTrackedRequest *req, uint64_t align)
455 int64_t overlap_offset = req->offset & ~(align - 1);
456 unsigned int overlap_bytes = ROUND_UP(req->offset + req->bytes, align)
457 - overlap_offset;
459 if (!req->serialising) {
460 atomic_inc(&req->bs->serialising_in_flight);
461 req->serialising = true;
464 req->overlap_offset = MIN(req->overlap_offset, overlap_offset);
465 req->overlap_bytes = MAX(req->overlap_bytes, overlap_bytes);
469 * Round a region to cluster boundaries
471 void bdrv_round_to_clusters(BlockDriverState *bs,
472 int64_t offset, int64_t bytes,
473 int64_t *cluster_offset,
474 int64_t *cluster_bytes)
476 BlockDriverInfo bdi;
478 if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
479 *cluster_offset = offset;
480 *cluster_bytes = bytes;
481 } else {
482 int64_t c = bdi.cluster_size;
483 *cluster_offset = QEMU_ALIGN_DOWN(offset, c);
484 *cluster_bytes = QEMU_ALIGN_UP(offset - *cluster_offset + bytes, c);
488 static int bdrv_get_cluster_size(BlockDriverState *bs)
490 BlockDriverInfo bdi;
491 int ret;
493 ret = bdrv_get_info(bs, &bdi);
494 if (ret < 0 || bdi.cluster_size == 0) {
495 return bs->bl.request_alignment;
496 } else {
497 return bdi.cluster_size;
501 static bool tracked_request_overlaps(BdrvTrackedRequest *req,
502 int64_t offset, unsigned int bytes)
504 /* aaaa bbbb */
505 if (offset >= req->overlap_offset + req->overlap_bytes) {
506 return false;
508 /* bbbb aaaa */
509 if (req->overlap_offset >= offset + bytes) {
510 return false;
512 return true;
515 void bdrv_inc_in_flight(BlockDriverState *bs)
517 atomic_inc(&bs->in_flight);
520 static void dummy_bh_cb(void *opaque)
524 void bdrv_wakeup(BlockDriverState *bs)
526 /* The barrier (or an atomic op) is in the caller. */
527 if (atomic_read(&bs->wakeup)) {
528 aio_bh_schedule_oneshot(qemu_get_aio_context(), dummy_bh_cb, NULL);
532 void bdrv_dec_in_flight(BlockDriverState *bs)
534 atomic_dec(&bs->in_flight);
535 bdrv_wakeup(bs);
538 static bool coroutine_fn wait_serialising_requests(BdrvTrackedRequest *self)
540 BlockDriverState *bs = self->bs;
541 BdrvTrackedRequest *req;
542 bool retry;
543 bool waited = false;
545 if (!atomic_read(&bs->serialising_in_flight)) {
546 return false;
549 do {
550 retry = false;
551 qemu_co_mutex_lock(&bs->reqs_lock);
552 QLIST_FOREACH(req, &bs->tracked_requests, list) {
553 if (req == self || (!req->serialising && !self->serialising)) {
554 continue;
556 if (tracked_request_overlaps(req, self->overlap_offset,
557 self->overlap_bytes))
559 /* Hitting this means there was a reentrant request, for
560 * example, a block driver issuing nested requests. This must
561 * never happen since it means deadlock.
563 assert(qemu_coroutine_self() != req->co);
565 /* If the request is already (indirectly) waiting for us, or
566 * will wait for us as soon as it wakes up, then just go on
567 * (instead of producing a deadlock in the former case). */
568 if (!req->waiting_for) {
569 self->waiting_for = req;
570 qemu_co_queue_wait(&req->wait_queue, &bs->reqs_lock);
571 self->waiting_for = NULL;
572 retry = true;
573 waited = true;
574 break;
578 qemu_co_mutex_unlock(&bs->reqs_lock);
579 } while (retry);
581 return waited;
584 static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
585 size_t size)
587 if (size > BDRV_REQUEST_MAX_SECTORS << BDRV_SECTOR_BITS) {
588 return -EIO;
591 if (!bdrv_is_inserted(bs)) {
592 return -ENOMEDIUM;
595 if (offset < 0) {
596 return -EIO;
599 return 0;
602 typedef struct RwCo {
603 BdrvChild *child;
604 int64_t offset;
605 QEMUIOVector *qiov;
606 bool is_write;
607 int ret;
608 BdrvRequestFlags flags;
609 } RwCo;
611 static void coroutine_fn bdrv_rw_co_entry(void *opaque)
613 RwCo *rwco = opaque;
615 if (!rwco->is_write) {
616 rwco->ret = bdrv_co_preadv(rwco->child, rwco->offset,
617 rwco->qiov->size, rwco->qiov,
618 rwco->flags);
619 } else {
620 rwco->ret = bdrv_co_pwritev(rwco->child, rwco->offset,
621 rwco->qiov->size, rwco->qiov,
622 rwco->flags);
627 * Process a vectored synchronous request using coroutines
629 static int bdrv_prwv_co(BdrvChild *child, int64_t offset,
630 QEMUIOVector *qiov, bool is_write,
631 BdrvRequestFlags flags)
633 Coroutine *co;
634 RwCo rwco = {
635 .child = child,
636 .offset = offset,
637 .qiov = qiov,
638 .is_write = is_write,
639 .ret = NOT_DONE,
640 .flags = flags,
643 if (qemu_in_coroutine()) {
644 /* Fast-path if already in coroutine context */
645 bdrv_rw_co_entry(&rwco);
646 } else {
647 co = qemu_coroutine_create(bdrv_rw_co_entry, &rwco);
648 bdrv_coroutine_enter(child->bs, co);
649 BDRV_POLL_WHILE(child->bs, rwco.ret == NOT_DONE);
651 return rwco.ret;
655 * Process a synchronous request using coroutines
657 static int bdrv_rw_co(BdrvChild *child, int64_t sector_num, uint8_t *buf,
658 int nb_sectors, bool is_write, BdrvRequestFlags flags)
660 QEMUIOVector qiov;
661 struct iovec iov = {
662 .iov_base = (void *)buf,
663 .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
666 if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
667 return -EINVAL;
670 qemu_iovec_init_external(&qiov, &iov, 1);
671 return bdrv_prwv_co(child, sector_num << BDRV_SECTOR_BITS,
672 &qiov, is_write, flags);
675 /* return < 0 if error. See bdrv_write() for the return codes */
676 int bdrv_read(BdrvChild *child, int64_t sector_num,
677 uint8_t *buf, int nb_sectors)
679 return bdrv_rw_co(child, sector_num, buf, nb_sectors, false, 0);
682 /* Return < 0 if error. Important errors are:
683 -EIO generic I/O error (may happen for all errors)
684 -ENOMEDIUM No media inserted.
685 -EINVAL Invalid sector number or nb_sectors
686 -EACCES Trying to write a read-only device
688 int bdrv_write(BdrvChild *child, int64_t sector_num,
689 const uint8_t *buf, int nb_sectors)
691 return bdrv_rw_co(child, sector_num, (uint8_t *)buf, nb_sectors, true, 0);
694 int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
695 int bytes, BdrvRequestFlags flags)
697 QEMUIOVector qiov;
698 struct iovec iov = {
699 .iov_base = NULL,
700 .iov_len = bytes,
703 qemu_iovec_init_external(&qiov, &iov, 1);
704 return bdrv_prwv_co(child, offset, &qiov, true,
705 BDRV_REQ_ZERO_WRITE | flags);
709 * Completely zero out a block device with the help of bdrv_pwrite_zeroes.
710 * The operation is sped up by checking the block status and only writing
711 * zeroes to the device if they currently do not return zeroes. Optional
712 * flags are passed through to bdrv_pwrite_zeroes (e.g. BDRV_REQ_MAY_UNMAP,
713 * BDRV_REQ_FUA).
715 * Returns < 0 on error, 0 on success. For error codes see bdrv_write().
717 int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags)
719 int ret;
720 int64_t target_size, bytes, offset = 0;
721 BlockDriverState *bs = child->bs;
723 target_size = bdrv_getlength(bs);
724 if (target_size < 0) {
725 return target_size;
728 for (;;) {
729 bytes = MIN(target_size - offset, BDRV_REQUEST_MAX_BYTES);
730 if (bytes <= 0) {
731 return 0;
733 ret = bdrv_block_status(bs, offset, bytes, &bytes, NULL, NULL);
734 if (ret < 0) {
735 error_report("error getting block status at offset %" PRId64 ": %s",
736 offset, strerror(-ret));
737 return ret;
739 if (ret & BDRV_BLOCK_ZERO) {
740 offset += bytes;
741 continue;
743 ret = bdrv_pwrite_zeroes(child, offset, bytes, flags);
744 if (ret < 0) {
745 error_report("error writing zeroes at offset %" PRId64 ": %s",
746 offset, strerror(-ret));
747 return ret;
749 offset += bytes;
753 int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
755 int ret;
757 ret = bdrv_prwv_co(child, offset, qiov, false, 0);
758 if (ret < 0) {
759 return ret;
762 return qiov->size;
765 int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes)
767 QEMUIOVector qiov;
768 struct iovec iov = {
769 .iov_base = (void *)buf,
770 .iov_len = bytes,
773 if (bytes < 0) {
774 return -EINVAL;
777 qemu_iovec_init_external(&qiov, &iov, 1);
778 return bdrv_preadv(child, offset, &qiov);
781 int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov)
783 int ret;
785 ret = bdrv_prwv_co(child, offset, qiov, true, 0);
786 if (ret < 0) {
787 return ret;
790 return qiov->size;
793 int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes)
795 QEMUIOVector qiov;
796 struct iovec iov = {
797 .iov_base = (void *) buf,
798 .iov_len = bytes,
801 if (bytes < 0) {
802 return -EINVAL;
805 qemu_iovec_init_external(&qiov, &iov, 1);
806 return bdrv_pwritev(child, offset, &qiov);
810 * Writes to the file and ensures that no writes are reordered across this
811 * request (acts as a barrier)
813 * Returns 0 on success, -errno in error cases.
815 int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
816 const void *buf, int count)
818 int ret;
820 ret = bdrv_pwrite(child, offset, buf, count);
821 if (ret < 0) {
822 return ret;
825 ret = bdrv_flush(child->bs);
826 if (ret < 0) {
827 return ret;
830 return 0;
833 typedef struct CoroutineIOCompletion {
834 Coroutine *coroutine;
835 int ret;
836 } CoroutineIOCompletion;
838 static void bdrv_co_io_em_complete(void *opaque, int ret)
840 CoroutineIOCompletion *co = opaque;
842 co->ret = ret;
843 aio_co_wake(co->coroutine);
846 static int coroutine_fn bdrv_driver_preadv(BlockDriverState *bs,
847 uint64_t offset, uint64_t bytes,
848 QEMUIOVector *qiov, int flags)
850 BlockDriver *drv = bs->drv;
851 int64_t sector_num;
852 unsigned int nb_sectors;
854 assert(!(flags & ~BDRV_REQ_MASK));
856 if (drv->bdrv_co_preadv) {
857 return drv->bdrv_co_preadv(bs, offset, bytes, qiov, flags);
860 sector_num = offset >> BDRV_SECTOR_BITS;
861 nb_sectors = bytes >> BDRV_SECTOR_BITS;
863 assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
864 assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
865 assert((bytes >> BDRV_SECTOR_BITS) <= BDRV_REQUEST_MAX_SECTORS);
867 if (drv->bdrv_co_readv) {
868 return drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
869 } else {
870 BlockAIOCB *acb;
871 CoroutineIOCompletion co = {
872 .coroutine = qemu_coroutine_self(),
875 acb = bs->drv->bdrv_aio_readv(bs, sector_num, qiov, nb_sectors,
876 bdrv_co_io_em_complete, &co);
877 if (acb == NULL) {
878 return -EIO;
879 } else {
880 qemu_coroutine_yield();
881 return co.ret;
886 static int coroutine_fn bdrv_driver_pwritev(BlockDriverState *bs,
887 uint64_t offset, uint64_t bytes,
888 QEMUIOVector *qiov, int flags)
890 BlockDriver *drv = bs->drv;
891 int64_t sector_num;
892 unsigned int nb_sectors;
893 int ret;
895 assert(!(flags & ~BDRV_REQ_MASK));
897 if (drv->bdrv_co_pwritev) {
898 ret = drv->bdrv_co_pwritev(bs, offset, bytes, qiov,
899 flags & bs->supported_write_flags);
900 flags &= ~bs->supported_write_flags;
901 goto emulate_flags;
904 sector_num = offset >> BDRV_SECTOR_BITS;
905 nb_sectors = bytes >> BDRV_SECTOR_BITS;
907 assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
908 assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
909 assert((bytes >> BDRV_SECTOR_BITS) <= BDRV_REQUEST_MAX_SECTORS);
911 if (drv->bdrv_co_writev_flags) {
912 ret = drv->bdrv_co_writev_flags(bs, sector_num, nb_sectors, qiov,
913 flags & bs->supported_write_flags);
914 flags &= ~bs->supported_write_flags;
915 } else if (drv->bdrv_co_writev) {
916 assert(!bs->supported_write_flags);
917 ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
918 } else {
919 BlockAIOCB *acb;
920 CoroutineIOCompletion co = {
921 .coroutine = qemu_coroutine_self(),
924 acb = bs->drv->bdrv_aio_writev(bs, sector_num, qiov, nb_sectors,
925 bdrv_co_io_em_complete, &co);
926 if (acb == NULL) {
927 ret = -EIO;
928 } else {
929 qemu_coroutine_yield();
930 ret = co.ret;
934 emulate_flags:
935 if (ret == 0 && (flags & BDRV_REQ_FUA)) {
936 ret = bdrv_co_flush(bs);
939 return ret;
942 static int coroutine_fn
943 bdrv_driver_pwritev_compressed(BlockDriverState *bs, uint64_t offset,
944 uint64_t bytes, QEMUIOVector *qiov)
946 BlockDriver *drv = bs->drv;
948 if (!drv->bdrv_co_pwritev_compressed) {
949 return -ENOTSUP;
952 return drv->bdrv_co_pwritev_compressed(bs, offset, bytes, qiov);
955 static int coroutine_fn bdrv_co_do_copy_on_readv(BdrvChild *child,
956 int64_t offset, unsigned int bytes, QEMUIOVector *qiov)
958 BlockDriverState *bs = child->bs;
960 /* Perform I/O through a temporary buffer so that users who scribble over
961 * their read buffer while the operation is in progress do not end up
962 * modifying the image file. This is critical for zero-copy guest I/O
963 * where anything might happen inside guest memory.
965 void *bounce_buffer;
967 BlockDriver *drv = bs->drv;
968 struct iovec iov;
969 QEMUIOVector local_qiov;
970 int64_t cluster_offset;
971 int64_t cluster_bytes;
972 size_t skip_bytes;
973 int ret;
974 int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer,
975 BDRV_REQUEST_MAX_BYTES);
976 unsigned int progress = 0;
978 /* FIXME We cannot require callers to have write permissions when all they
979 * are doing is a read request. If we did things right, write permissions
980 * would be obtained anyway, but internally by the copy-on-read code. As
981 * long as it is implemented here rather than in a separate filter driver,
982 * the copy-on-read code doesn't have its own BdrvChild, however, for which
983 * it could request permissions. Therefore we have to bypass the permission
984 * system for the moment. */
985 // assert(child->perm & (BLK_PERM_WRITE_UNCHANGED | BLK_PERM_WRITE));
987 /* Cover entire cluster so no additional backing file I/O is required when
988 * allocating cluster in the image file. Note that this value may exceed
989 * BDRV_REQUEST_MAX_BYTES (even when the original read did not), which
990 * is one reason we loop rather than doing it all at once.
992 bdrv_round_to_clusters(bs, offset, bytes, &cluster_offset, &cluster_bytes);
993 skip_bytes = offset - cluster_offset;
995 trace_bdrv_co_do_copy_on_readv(bs, offset, bytes,
996 cluster_offset, cluster_bytes);
998 bounce_buffer = qemu_try_blockalign(bs,
999 MIN(MIN(max_transfer, cluster_bytes),
1000 MAX_BOUNCE_BUFFER));
1001 if (bounce_buffer == NULL) {
1002 ret = -ENOMEM;
1003 goto err;
1006 while (cluster_bytes) {
1007 int64_t pnum;
1009 ret = bdrv_is_allocated(bs, cluster_offset,
1010 MIN(cluster_bytes, max_transfer), &pnum);
1011 if (ret < 0) {
1012 /* Safe to treat errors in querying allocation as if
1013 * unallocated; we'll probably fail again soon on the
1014 * read, but at least that will set a decent errno.
1016 pnum = MIN(cluster_bytes, max_transfer);
1019 assert(skip_bytes < pnum);
1021 if (ret <= 0) {
1022 /* Must copy-on-read; use the bounce buffer */
1023 iov.iov_base = bounce_buffer;
1024 iov.iov_len = pnum = MIN(pnum, MAX_BOUNCE_BUFFER);
1025 qemu_iovec_init_external(&local_qiov, &iov, 1);
1027 ret = bdrv_driver_preadv(bs, cluster_offset, pnum,
1028 &local_qiov, 0);
1029 if (ret < 0) {
1030 goto err;
1033 bdrv_debug_event(bs, BLKDBG_COR_WRITE);
1034 if (drv->bdrv_co_pwrite_zeroes &&
1035 buffer_is_zero(bounce_buffer, pnum)) {
1036 /* FIXME: Should we (perhaps conditionally) be setting
1037 * BDRV_REQ_MAY_UNMAP, if it will allow for a sparser copy
1038 * that still correctly reads as zero? */
1039 ret = bdrv_co_do_pwrite_zeroes(bs, cluster_offset, pnum, 0);
1040 } else {
1041 /* This does not change the data on the disk, it is not
1042 * necessary to flush even in cache=writethrough mode.
1044 ret = bdrv_driver_pwritev(bs, cluster_offset, pnum,
1045 &local_qiov, 0);
1048 if (ret < 0) {
1049 /* It might be okay to ignore write errors for guest
1050 * requests. If this is a deliberate copy-on-read
1051 * then we don't want to ignore the error. Simply
1052 * report it in all cases.
1054 goto err;
1057 qemu_iovec_from_buf(qiov, progress, bounce_buffer + skip_bytes,
1058 pnum - skip_bytes);
1059 } else {
1060 /* Read directly into the destination */
1061 qemu_iovec_init(&local_qiov, qiov->niov);
1062 qemu_iovec_concat(&local_qiov, qiov, progress, pnum - skip_bytes);
1063 ret = bdrv_driver_preadv(bs, offset + progress, local_qiov.size,
1064 &local_qiov, 0);
1065 qemu_iovec_destroy(&local_qiov);
1066 if (ret < 0) {
1067 goto err;
1071 cluster_offset += pnum;
1072 cluster_bytes -= pnum;
1073 progress += pnum - skip_bytes;
1074 skip_bytes = 0;
1076 ret = 0;
1078 err:
1079 qemu_vfree(bounce_buffer);
1080 return ret;
1084 * Forwards an already correctly aligned request to the BlockDriver. This
1085 * handles copy on read, zeroing after EOF, and fragmentation of large
1086 * reads; any other features must be implemented by the caller.
1088 static int coroutine_fn bdrv_aligned_preadv(BdrvChild *child,
1089 BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
1090 int64_t align, QEMUIOVector *qiov, int flags)
1092 BlockDriverState *bs = child->bs;
1093 int64_t total_bytes, max_bytes;
1094 int ret = 0;
1095 uint64_t bytes_remaining = bytes;
1096 int max_transfer;
1098 assert(is_power_of_2(align));
1099 assert((offset & (align - 1)) == 0);
1100 assert((bytes & (align - 1)) == 0);
1101 assert(!qiov || bytes == qiov->size);
1102 assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1103 max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
1104 align);
1106 /* TODO: We would need a per-BDS .supported_read_flags and
1107 * potential fallback support, if we ever implement any read flags
1108 * to pass through to drivers. For now, there aren't any
1109 * passthrough flags. */
1110 assert(!(flags & ~(BDRV_REQ_NO_SERIALISING | BDRV_REQ_COPY_ON_READ)));
1112 /* Handle Copy on Read and associated serialisation */
1113 if (flags & BDRV_REQ_COPY_ON_READ) {
1114 /* If we touch the same cluster it counts as an overlap. This
1115 * guarantees that allocating writes will be serialized and not race
1116 * with each other for the same cluster. For example, in copy-on-read
1117 * it ensures that the CoR read and write operations are atomic and
1118 * guest writes cannot interleave between them. */
1119 mark_request_serialising(req, bdrv_get_cluster_size(bs));
1122 if (!(flags & BDRV_REQ_NO_SERIALISING)) {
1123 wait_serialising_requests(req);
1126 if (flags & BDRV_REQ_COPY_ON_READ) {
1127 /* TODO: Simplify further once bdrv_is_allocated no longer
1128 * requires sector alignment */
1129 int64_t start = QEMU_ALIGN_DOWN(offset, BDRV_SECTOR_SIZE);
1130 int64_t end = QEMU_ALIGN_UP(offset + bytes, BDRV_SECTOR_SIZE);
1131 int64_t pnum;
1133 ret = bdrv_is_allocated(bs, start, end - start, &pnum);
1134 if (ret < 0) {
1135 goto out;
1138 if (!ret || pnum != end - start) {
1139 ret = bdrv_co_do_copy_on_readv(child, offset, bytes, qiov);
1140 goto out;
1144 /* Forward the request to the BlockDriver, possibly fragmenting it */
1145 total_bytes = bdrv_getlength(bs);
1146 if (total_bytes < 0) {
1147 ret = total_bytes;
1148 goto out;
1151 max_bytes = ROUND_UP(MAX(0, total_bytes - offset), align);
1152 if (bytes <= max_bytes && bytes <= max_transfer) {
1153 ret = bdrv_driver_preadv(bs, offset, bytes, qiov, 0);
1154 goto out;
1157 while (bytes_remaining) {
1158 int num;
1160 if (max_bytes) {
1161 QEMUIOVector local_qiov;
1163 num = MIN(bytes_remaining, MIN(max_bytes, max_transfer));
1164 assert(num);
1165 qemu_iovec_init(&local_qiov, qiov->niov);
1166 qemu_iovec_concat(&local_qiov, qiov, bytes - bytes_remaining, num);
1168 ret = bdrv_driver_preadv(bs, offset + bytes - bytes_remaining,
1169 num, &local_qiov, 0);
1170 max_bytes -= num;
1171 qemu_iovec_destroy(&local_qiov);
1172 } else {
1173 num = bytes_remaining;
1174 ret = qemu_iovec_memset(qiov, bytes - bytes_remaining, 0,
1175 bytes_remaining);
1177 if (ret < 0) {
1178 goto out;
1180 bytes_remaining -= num;
1183 out:
1184 return ret < 0 ? ret : 0;
1188 * Handle a read request in coroutine context
1190 int coroutine_fn bdrv_co_preadv(BdrvChild *child,
1191 int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
1192 BdrvRequestFlags flags)
1194 BlockDriverState *bs = child->bs;
1195 BlockDriver *drv = bs->drv;
1196 BdrvTrackedRequest req;
1198 uint64_t align = bs->bl.request_alignment;
1199 uint8_t *head_buf = NULL;
1200 uint8_t *tail_buf = NULL;
1201 QEMUIOVector local_qiov;
1202 bool use_local_qiov = false;
1203 int ret;
1205 trace_bdrv_co_preadv(child->bs, offset, bytes, flags);
1207 if (!drv) {
1208 return -ENOMEDIUM;
1211 ret = bdrv_check_byte_request(bs, offset, bytes);
1212 if (ret < 0) {
1213 return ret;
1216 bdrv_inc_in_flight(bs);
1218 /* Don't do copy-on-read if we read data before write operation */
1219 if (atomic_read(&bs->copy_on_read) && !(flags & BDRV_REQ_NO_SERIALISING)) {
1220 flags |= BDRV_REQ_COPY_ON_READ;
1223 /* Align read if necessary by padding qiov */
1224 if (offset & (align - 1)) {
1225 head_buf = qemu_blockalign(bs, align);
1226 qemu_iovec_init(&local_qiov, qiov->niov + 2);
1227 qemu_iovec_add(&local_qiov, head_buf, offset & (align - 1));
1228 qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
1229 use_local_qiov = true;
1231 bytes += offset & (align - 1);
1232 offset = offset & ~(align - 1);
1235 if ((offset + bytes) & (align - 1)) {
1236 if (!use_local_qiov) {
1237 qemu_iovec_init(&local_qiov, qiov->niov + 1);
1238 qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
1239 use_local_qiov = true;
1241 tail_buf = qemu_blockalign(bs, align);
1242 qemu_iovec_add(&local_qiov, tail_buf,
1243 align - ((offset + bytes) & (align - 1)));
1245 bytes = ROUND_UP(bytes, align);
1248 tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_READ);
1249 ret = bdrv_aligned_preadv(child, &req, offset, bytes, align,
1250 use_local_qiov ? &local_qiov : qiov,
1251 flags);
1252 tracked_request_end(&req);
1253 bdrv_dec_in_flight(bs);
1255 if (use_local_qiov) {
1256 qemu_iovec_destroy(&local_qiov);
1257 qemu_vfree(head_buf);
1258 qemu_vfree(tail_buf);
1261 return ret;
1264 static int coroutine_fn bdrv_co_do_readv(BdrvChild *child,
1265 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
1266 BdrvRequestFlags flags)
1268 if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
1269 return -EINVAL;
1272 return bdrv_co_preadv(child, sector_num << BDRV_SECTOR_BITS,
1273 nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1276 int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num,
1277 int nb_sectors, QEMUIOVector *qiov)
1279 return bdrv_co_do_readv(child, sector_num, nb_sectors, qiov, 0);
1282 static int coroutine_fn bdrv_co_do_pwrite_zeroes(BlockDriverState *bs,
1283 int64_t offset, int bytes, BdrvRequestFlags flags)
1285 BlockDriver *drv = bs->drv;
1286 QEMUIOVector qiov;
1287 struct iovec iov = {0};
1288 int ret = 0;
1289 bool need_flush = false;
1290 int head = 0;
1291 int tail = 0;
1293 int max_write_zeroes = MIN_NON_ZERO(bs->bl.max_pwrite_zeroes, INT_MAX);
1294 int alignment = MAX(bs->bl.pwrite_zeroes_alignment,
1295 bs->bl.request_alignment);
1296 int max_transfer = MIN_NON_ZERO(bs->bl.max_transfer, MAX_BOUNCE_BUFFER);
1298 assert(alignment % bs->bl.request_alignment == 0);
1299 head = offset % alignment;
1300 tail = (offset + bytes) % alignment;
1301 max_write_zeroes = QEMU_ALIGN_DOWN(max_write_zeroes, alignment);
1302 assert(max_write_zeroes >= bs->bl.request_alignment);
1304 while (bytes > 0 && !ret) {
1305 int num = bytes;
1307 /* Align request. Block drivers can expect the "bulk" of the request
1308 * to be aligned, and that unaligned requests do not cross cluster
1309 * boundaries.
1311 if (head) {
1312 /* Make a small request up to the first aligned sector. For
1313 * convenience, limit this request to max_transfer even if
1314 * we don't need to fall back to writes. */
1315 num = MIN(MIN(bytes, max_transfer), alignment - head);
1316 head = (head + num) % alignment;
1317 assert(num < max_write_zeroes);
1318 } else if (tail && num > alignment) {
1319 /* Shorten the request to the last aligned sector. */
1320 num -= tail;
1323 /* limit request size */
1324 if (num > max_write_zeroes) {
1325 num = max_write_zeroes;
1328 ret = -ENOTSUP;
1329 /* First try the efficient write zeroes operation */
1330 if (drv->bdrv_co_pwrite_zeroes) {
1331 ret = drv->bdrv_co_pwrite_zeroes(bs, offset, num,
1332 flags & bs->supported_zero_flags);
1333 if (ret != -ENOTSUP && (flags & BDRV_REQ_FUA) &&
1334 !(bs->supported_zero_flags & BDRV_REQ_FUA)) {
1335 need_flush = true;
1337 } else {
1338 assert(!bs->supported_zero_flags);
1341 if (ret == -ENOTSUP) {
1342 /* Fall back to bounce buffer if write zeroes is unsupported */
1343 BdrvRequestFlags write_flags = flags & ~BDRV_REQ_ZERO_WRITE;
1345 if ((flags & BDRV_REQ_FUA) &&
1346 !(bs->supported_write_flags & BDRV_REQ_FUA)) {
1347 /* No need for bdrv_driver_pwrite() to do a fallback
1348 * flush on each chunk; use just one at the end */
1349 write_flags &= ~BDRV_REQ_FUA;
1350 need_flush = true;
1352 num = MIN(num, max_transfer);
1353 iov.iov_len = num;
1354 if (iov.iov_base == NULL) {
1355 iov.iov_base = qemu_try_blockalign(bs, num);
1356 if (iov.iov_base == NULL) {
1357 ret = -ENOMEM;
1358 goto fail;
1360 memset(iov.iov_base, 0, num);
1362 qemu_iovec_init_external(&qiov, &iov, 1);
1364 ret = bdrv_driver_pwritev(bs, offset, num, &qiov, write_flags);
1366 /* Keep bounce buffer around if it is big enough for all
1367 * all future requests.
1369 if (num < max_transfer) {
1370 qemu_vfree(iov.iov_base);
1371 iov.iov_base = NULL;
1375 offset += num;
1376 bytes -= num;
1379 fail:
1380 if (ret == 0 && need_flush) {
1381 ret = bdrv_co_flush(bs);
1383 qemu_vfree(iov.iov_base);
1384 return ret;
1388 * Forwards an already correctly aligned write request to the BlockDriver,
1389 * after possibly fragmenting it.
1391 static int coroutine_fn bdrv_aligned_pwritev(BdrvChild *child,
1392 BdrvTrackedRequest *req, int64_t offset, unsigned int bytes,
1393 int64_t align, QEMUIOVector *qiov, int flags)
1395 BlockDriverState *bs = child->bs;
1396 BlockDriver *drv = bs->drv;
1397 bool waited;
1398 int ret;
1400 int64_t end_sector = DIV_ROUND_UP(offset + bytes, BDRV_SECTOR_SIZE);
1401 uint64_t bytes_remaining = bytes;
1402 int max_transfer;
1404 if (bdrv_has_readonly_bitmaps(bs)) {
1405 return -EPERM;
1408 assert(is_power_of_2(align));
1409 assert((offset & (align - 1)) == 0);
1410 assert((bytes & (align - 1)) == 0);
1411 assert(!qiov || bytes == qiov->size);
1412 assert((bs->open_flags & BDRV_O_NO_IO) == 0);
1413 assert(!(flags & ~BDRV_REQ_MASK));
1414 max_transfer = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_transfer, INT_MAX),
1415 align);
1417 waited = wait_serialising_requests(req);
1418 assert(!waited || !req->serialising);
1419 assert(req->overlap_offset <= offset);
1420 assert(offset + bytes <= req->overlap_offset + req->overlap_bytes);
1421 assert(child->perm & BLK_PERM_WRITE);
1422 assert(end_sector <= bs->total_sectors || child->perm & BLK_PERM_RESIZE);
1424 ret = notifier_with_return_list_notify(&bs->before_write_notifiers, req);
1426 if (!ret && bs->detect_zeroes != BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF &&
1427 !(flags & BDRV_REQ_ZERO_WRITE) && drv->bdrv_co_pwrite_zeroes &&
1428 qemu_iovec_is_zero(qiov)) {
1429 flags |= BDRV_REQ_ZERO_WRITE;
1430 if (bs->detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP) {
1431 flags |= BDRV_REQ_MAY_UNMAP;
1435 if (ret < 0) {
1436 /* Do nothing, write notifier decided to fail this request */
1437 } else if (flags & BDRV_REQ_ZERO_WRITE) {
1438 bdrv_debug_event(bs, BLKDBG_PWRITEV_ZERO);
1439 ret = bdrv_co_do_pwrite_zeroes(bs, offset, bytes, flags);
1440 } else if (flags & BDRV_REQ_WRITE_COMPRESSED) {
1441 ret = bdrv_driver_pwritev_compressed(bs, offset, bytes, qiov);
1442 } else if (bytes <= max_transfer) {
1443 bdrv_debug_event(bs, BLKDBG_PWRITEV);
1444 ret = bdrv_driver_pwritev(bs, offset, bytes, qiov, flags);
1445 } else {
1446 bdrv_debug_event(bs, BLKDBG_PWRITEV);
1447 while (bytes_remaining) {
1448 int num = MIN(bytes_remaining, max_transfer);
1449 QEMUIOVector local_qiov;
1450 int local_flags = flags;
1452 assert(num);
1453 if (num < bytes_remaining && (flags & BDRV_REQ_FUA) &&
1454 !(bs->supported_write_flags & BDRV_REQ_FUA)) {
1455 /* If FUA is going to be emulated by flush, we only
1456 * need to flush on the last iteration */
1457 local_flags &= ~BDRV_REQ_FUA;
1459 qemu_iovec_init(&local_qiov, qiov->niov);
1460 qemu_iovec_concat(&local_qiov, qiov, bytes - bytes_remaining, num);
1462 ret = bdrv_driver_pwritev(bs, offset + bytes - bytes_remaining,
1463 num, &local_qiov, local_flags);
1464 qemu_iovec_destroy(&local_qiov);
1465 if (ret < 0) {
1466 break;
1468 bytes_remaining -= num;
1471 bdrv_debug_event(bs, BLKDBG_PWRITEV_DONE);
1473 atomic_inc(&bs->write_gen);
1474 bdrv_set_dirty(bs, offset, bytes);
1476 stat64_max(&bs->wr_highest_offset, offset + bytes);
1478 if (ret >= 0) {
1479 bs->total_sectors = MAX(bs->total_sectors, end_sector);
1480 ret = 0;
1483 return ret;
1486 static int coroutine_fn bdrv_co_do_zero_pwritev(BdrvChild *child,
1487 int64_t offset,
1488 unsigned int bytes,
1489 BdrvRequestFlags flags,
1490 BdrvTrackedRequest *req)
1492 BlockDriverState *bs = child->bs;
1493 uint8_t *buf = NULL;
1494 QEMUIOVector local_qiov;
1495 struct iovec iov;
1496 uint64_t align = bs->bl.request_alignment;
1497 unsigned int head_padding_bytes, tail_padding_bytes;
1498 int ret = 0;
1500 head_padding_bytes = offset & (align - 1);
1501 tail_padding_bytes = (align - (offset + bytes)) & (align - 1);
1504 assert(flags & BDRV_REQ_ZERO_WRITE);
1505 if (head_padding_bytes || tail_padding_bytes) {
1506 buf = qemu_blockalign(bs, align);
1507 iov = (struct iovec) {
1508 .iov_base = buf,
1509 .iov_len = align,
1511 qemu_iovec_init_external(&local_qiov, &iov, 1);
1513 if (head_padding_bytes) {
1514 uint64_t zero_bytes = MIN(bytes, align - head_padding_bytes);
1516 /* RMW the unaligned part before head. */
1517 mark_request_serialising(req, align);
1518 wait_serialising_requests(req);
1519 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1520 ret = bdrv_aligned_preadv(child, req, offset & ~(align - 1), align,
1521 align, &local_qiov, 0);
1522 if (ret < 0) {
1523 goto fail;
1525 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1527 memset(buf + head_padding_bytes, 0, zero_bytes);
1528 ret = bdrv_aligned_pwritev(child, req, offset & ~(align - 1), align,
1529 align, &local_qiov,
1530 flags & ~BDRV_REQ_ZERO_WRITE);
1531 if (ret < 0) {
1532 goto fail;
1534 offset += zero_bytes;
1535 bytes -= zero_bytes;
1538 assert(!bytes || (offset & (align - 1)) == 0);
1539 if (bytes >= align) {
1540 /* Write the aligned part in the middle. */
1541 uint64_t aligned_bytes = bytes & ~(align - 1);
1542 ret = bdrv_aligned_pwritev(child, req, offset, aligned_bytes, align,
1543 NULL, flags);
1544 if (ret < 0) {
1545 goto fail;
1547 bytes -= aligned_bytes;
1548 offset += aligned_bytes;
1551 assert(!bytes || (offset & (align - 1)) == 0);
1552 if (bytes) {
1553 assert(align == tail_padding_bytes + bytes);
1554 /* RMW the unaligned part after tail. */
1555 mark_request_serialising(req, align);
1556 wait_serialising_requests(req);
1557 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1558 ret = bdrv_aligned_preadv(child, req, offset, align,
1559 align, &local_qiov, 0);
1560 if (ret < 0) {
1561 goto fail;
1563 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1565 memset(buf, 0, bytes);
1566 ret = bdrv_aligned_pwritev(child, req, offset, align, align,
1567 &local_qiov, flags & ~BDRV_REQ_ZERO_WRITE);
1569 fail:
1570 qemu_vfree(buf);
1571 return ret;
1576 * Handle a write request in coroutine context
1578 int coroutine_fn bdrv_co_pwritev(BdrvChild *child,
1579 int64_t offset, unsigned int bytes, QEMUIOVector *qiov,
1580 BdrvRequestFlags flags)
1582 BlockDriverState *bs = child->bs;
1583 BdrvTrackedRequest req;
1584 uint64_t align = bs->bl.request_alignment;
1585 uint8_t *head_buf = NULL;
1586 uint8_t *tail_buf = NULL;
1587 QEMUIOVector local_qiov;
1588 bool use_local_qiov = false;
1589 int ret;
1591 trace_bdrv_co_pwritev(child->bs, offset, bytes, flags);
1593 if (!bs->drv) {
1594 return -ENOMEDIUM;
1596 if (bs->read_only) {
1597 return -EPERM;
1599 assert(!(bs->open_flags & BDRV_O_INACTIVE));
1601 ret = bdrv_check_byte_request(bs, offset, bytes);
1602 if (ret < 0) {
1603 return ret;
1606 bdrv_inc_in_flight(bs);
1608 * Align write if necessary by performing a read-modify-write cycle.
1609 * Pad qiov with the read parts and be sure to have a tracked request not
1610 * only for bdrv_aligned_pwritev, but also for the reads of the RMW cycle.
1612 tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_WRITE);
1614 if (!qiov) {
1615 ret = bdrv_co_do_zero_pwritev(child, offset, bytes, flags, &req);
1616 goto out;
1619 if (offset & (align - 1)) {
1620 QEMUIOVector head_qiov;
1621 struct iovec head_iov;
1623 mark_request_serialising(&req, align);
1624 wait_serialising_requests(&req);
1626 head_buf = qemu_blockalign(bs, align);
1627 head_iov = (struct iovec) {
1628 .iov_base = head_buf,
1629 .iov_len = align,
1631 qemu_iovec_init_external(&head_qiov, &head_iov, 1);
1633 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_HEAD);
1634 ret = bdrv_aligned_preadv(child, &req, offset & ~(align - 1), align,
1635 align, &head_qiov, 0);
1636 if (ret < 0) {
1637 goto fail;
1639 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD);
1641 qemu_iovec_init(&local_qiov, qiov->niov + 2);
1642 qemu_iovec_add(&local_qiov, head_buf, offset & (align - 1));
1643 qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
1644 use_local_qiov = true;
1646 bytes += offset & (align - 1);
1647 offset = offset & ~(align - 1);
1649 /* We have read the tail already if the request is smaller
1650 * than one aligned block.
1652 if (bytes < align) {
1653 qemu_iovec_add(&local_qiov, head_buf + bytes, align - bytes);
1654 bytes = align;
1658 if ((offset + bytes) & (align - 1)) {
1659 QEMUIOVector tail_qiov;
1660 struct iovec tail_iov;
1661 size_t tail_bytes;
1662 bool waited;
1664 mark_request_serialising(&req, align);
1665 waited = wait_serialising_requests(&req);
1666 assert(!waited || !use_local_qiov);
1668 tail_buf = qemu_blockalign(bs, align);
1669 tail_iov = (struct iovec) {
1670 .iov_base = tail_buf,
1671 .iov_len = align,
1673 qemu_iovec_init_external(&tail_qiov, &tail_iov, 1);
1675 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_TAIL);
1676 ret = bdrv_aligned_preadv(child, &req, (offset + bytes) & ~(align - 1),
1677 align, align, &tail_qiov, 0);
1678 if (ret < 0) {
1679 goto fail;
1681 bdrv_debug_event(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL);
1683 if (!use_local_qiov) {
1684 qemu_iovec_init(&local_qiov, qiov->niov + 1);
1685 qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size);
1686 use_local_qiov = true;
1689 tail_bytes = (offset + bytes) & (align - 1);
1690 qemu_iovec_add(&local_qiov, tail_buf + tail_bytes, align - tail_bytes);
1692 bytes = ROUND_UP(bytes, align);
1695 ret = bdrv_aligned_pwritev(child, &req, offset, bytes, align,
1696 use_local_qiov ? &local_qiov : qiov,
1697 flags);
1699 fail:
1701 if (use_local_qiov) {
1702 qemu_iovec_destroy(&local_qiov);
1704 qemu_vfree(head_buf);
1705 qemu_vfree(tail_buf);
1706 out:
1707 tracked_request_end(&req);
1708 bdrv_dec_in_flight(bs);
1709 return ret;
1712 static int coroutine_fn bdrv_co_do_writev(BdrvChild *child,
1713 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
1714 BdrvRequestFlags flags)
1716 if (nb_sectors < 0 || nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
1717 return -EINVAL;
1720 return bdrv_co_pwritev(child, sector_num << BDRV_SECTOR_BITS,
1721 nb_sectors << BDRV_SECTOR_BITS, qiov, flags);
1724 int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num,
1725 int nb_sectors, QEMUIOVector *qiov)
1727 return bdrv_co_do_writev(child, sector_num, nb_sectors, qiov, 0);
1730 int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
1731 int bytes, BdrvRequestFlags flags)
1733 trace_bdrv_co_pwrite_zeroes(child->bs, offset, bytes, flags);
1735 if (!(child->bs->open_flags & BDRV_O_UNMAP)) {
1736 flags &= ~BDRV_REQ_MAY_UNMAP;
1739 return bdrv_co_pwritev(child, offset, bytes, NULL,
1740 BDRV_REQ_ZERO_WRITE | flags);
1744 * Flush ALL BDSes regardless of if they are reachable via a BlkBackend or not.
1746 int bdrv_flush_all(void)
1748 BdrvNextIterator it;
1749 BlockDriverState *bs = NULL;
1750 int result = 0;
1752 for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
1753 AioContext *aio_context = bdrv_get_aio_context(bs);
1754 int ret;
1756 aio_context_acquire(aio_context);
1757 ret = bdrv_flush(bs);
1758 if (ret < 0 && !result) {
1759 result = ret;
1761 aio_context_release(aio_context);
1764 return result;
1768 typedef struct BdrvCoBlockStatusData {
1769 BlockDriverState *bs;
1770 BlockDriverState *base;
1771 bool want_zero;
1772 int64_t offset;
1773 int64_t bytes;
1774 int64_t *pnum;
1775 int64_t *map;
1776 BlockDriverState **file;
1777 int ret;
1778 bool done;
1779 } BdrvCoBlockStatusData;
1781 int64_t coroutine_fn bdrv_co_get_block_status_from_file(BlockDriverState *bs,
1782 int64_t sector_num,
1783 int nb_sectors,
1784 int *pnum,
1785 BlockDriverState **file)
1787 assert(bs->file && bs->file->bs);
1788 *pnum = nb_sectors;
1789 *file = bs->file->bs;
1790 return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID |
1791 (sector_num << BDRV_SECTOR_BITS);
1794 int64_t coroutine_fn bdrv_co_get_block_status_from_backing(BlockDriverState *bs,
1795 int64_t sector_num,
1796 int nb_sectors,
1797 int *pnum,
1798 BlockDriverState **file)
1800 assert(bs->backing && bs->backing->bs);
1801 *pnum = nb_sectors;
1802 *file = bs->backing->bs;
1803 return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID |
1804 (sector_num << BDRV_SECTOR_BITS);
1808 * Returns the allocation status of the specified sectors.
1809 * Drivers not implementing the functionality are assumed to not support
1810 * backing files, hence all their sectors are reported as allocated.
1812 * If 'want_zero' is true, the caller is querying for mapping purposes,
1813 * and the result should include BDRV_BLOCK_OFFSET_VALID and
1814 * BDRV_BLOCK_ZERO where possible; otherwise, the result may omit those
1815 * bits particularly if it allows for a larger value in 'pnum'.
1817 * If 'offset' is beyond the end of the disk image the return value is
1818 * BDRV_BLOCK_EOF and 'pnum' is set to 0.
1820 * 'bytes' is the max value 'pnum' should be set to. If bytes goes
1821 * beyond the end of the disk image it will be clamped; if 'pnum' is set to
1822 * the end of the image, then the returned value will include BDRV_BLOCK_EOF.
1824 * 'pnum' is set to the number of bytes (including and immediately
1825 * following the specified offset) that are easily known to be in the
1826 * same allocated/unallocated state. Note that a second call starting
1827 * at the original offset plus returned pnum may have the same status.
1828 * The returned value is non-zero on success except at end-of-file.
1830 * Returns negative errno on failure. Otherwise, if the
1831 * BDRV_BLOCK_OFFSET_VALID bit is set, 'map' and 'file' (if non-NULL) are
1832 * set to the host mapping and BDS corresponding to the guest offset.
1834 static int coroutine_fn bdrv_co_block_status(BlockDriverState *bs,
1835 bool want_zero,
1836 int64_t offset, int64_t bytes,
1837 int64_t *pnum, int64_t *map,
1838 BlockDriverState **file)
1840 int64_t total_size;
1841 int64_t n; /* bytes */
1842 int64_t ret;
1843 int64_t local_map = 0;
1844 BlockDriverState *local_file = NULL;
1845 int count; /* sectors */
1847 assert(pnum);
1848 *pnum = 0;
1849 total_size = bdrv_getlength(bs);
1850 if (total_size < 0) {
1851 ret = total_size;
1852 goto early_out;
1855 if (offset >= total_size) {
1856 ret = BDRV_BLOCK_EOF;
1857 goto early_out;
1859 if (!bytes) {
1860 ret = 0;
1861 goto early_out;
1864 n = total_size - offset;
1865 if (n < bytes) {
1866 bytes = n;
1869 if (!bs->drv->bdrv_co_get_block_status) {
1870 *pnum = bytes;
1871 ret = BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED;
1872 if (offset + bytes == total_size) {
1873 ret |= BDRV_BLOCK_EOF;
1875 if (bs->drv->protocol_name) {
1876 ret |= BDRV_BLOCK_OFFSET_VALID;
1877 local_map = offset;
1878 local_file = bs;
1880 goto early_out;
1883 bdrv_inc_in_flight(bs);
1885 * TODO: Rather than require aligned offsets, we could instead
1886 * round to the driver's request_alignment here, then touch up
1887 * count afterwards back to the caller's expectations.
1889 assert(QEMU_IS_ALIGNED(offset | bytes, BDRV_SECTOR_SIZE));
1891 * The contract allows us to return pnum smaller than bytes, even
1892 * if the next query would see the same status; we truncate the
1893 * request to avoid overflowing the driver's 32-bit interface.
1895 bytes = MIN(bytes, BDRV_REQUEST_MAX_BYTES);
1896 ret = bs->drv->bdrv_co_get_block_status(bs, offset >> BDRV_SECTOR_BITS,
1897 bytes >> BDRV_SECTOR_BITS, &count,
1898 &local_file);
1899 if (ret < 0) {
1900 goto out;
1902 if (ret & BDRV_BLOCK_OFFSET_VALID) {
1903 local_map = ret & BDRV_BLOCK_OFFSET_MASK;
1905 *pnum = count * BDRV_SECTOR_SIZE;
1907 if (ret & BDRV_BLOCK_RAW) {
1908 assert(ret & BDRV_BLOCK_OFFSET_VALID && local_file);
1909 ret = bdrv_co_block_status(local_file, want_zero, local_map,
1910 *pnum, pnum, &local_map, &local_file);
1911 assert(ret < 0 ||
1912 QEMU_IS_ALIGNED(*pnum | local_map, BDRV_SECTOR_SIZE));
1913 goto out;
1916 if (ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ZERO)) {
1917 ret |= BDRV_BLOCK_ALLOCATED;
1918 } else if (want_zero) {
1919 if (bdrv_unallocated_blocks_are_zero(bs)) {
1920 ret |= BDRV_BLOCK_ZERO;
1921 } else if (bs->backing) {
1922 BlockDriverState *bs2 = bs->backing->bs;
1923 int64_t size2 = bdrv_getlength(bs2);
1925 if (size2 >= 0 && offset >= size2) {
1926 ret |= BDRV_BLOCK_ZERO;
1931 if (want_zero && local_file && local_file != bs &&
1932 (ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO) &&
1933 (ret & BDRV_BLOCK_OFFSET_VALID)) {
1934 int64_t file_pnum;
1935 int ret2;
1937 ret2 = bdrv_co_block_status(local_file, want_zero, local_map,
1938 *pnum, &file_pnum, NULL, NULL);
1939 if (ret2 >= 0) {
1940 /* Ignore errors. This is just providing extra information, it
1941 * is useful but not necessary.
1943 if (ret2 & BDRV_BLOCK_EOF &&
1944 (!file_pnum || ret2 & BDRV_BLOCK_ZERO)) {
1946 * It is valid for the format block driver to read
1947 * beyond the end of the underlying file's current
1948 * size; such areas read as zero.
1950 ret |= BDRV_BLOCK_ZERO;
1951 } else {
1952 /* Limit request to the range reported by the protocol driver */
1953 *pnum = file_pnum;
1954 ret |= (ret2 & BDRV_BLOCK_ZERO);
1959 out:
1960 bdrv_dec_in_flight(bs);
1961 if (ret >= 0 && offset + *pnum == total_size) {
1962 ret |= BDRV_BLOCK_EOF;
1964 early_out:
1965 if (file) {
1966 *file = local_file;
1968 if (map) {
1969 *map = local_map;
1971 if (ret >= 0) {
1972 ret &= ~BDRV_BLOCK_OFFSET_MASK;
1973 } else {
1974 assert(INT_MIN <= ret);
1976 return ret;
1979 static int64_t coroutine_fn bdrv_co_get_block_status_above(BlockDriverState *bs,
1980 BlockDriverState *base,
1981 bool want_zero,
1982 int64_t sector_num,
1983 int nb_sectors,
1984 int *pnum,
1985 BlockDriverState **file)
1987 BlockDriverState *p;
1988 int64_t ret = 0;
1989 bool first = true;
1990 int64_t map = 0;
1992 assert(bs != base);
1993 for (p = bs; p != base; p = backing_bs(p)) {
1994 int64_t count;
1996 ret = bdrv_co_block_status(p, want_zero,
1997 sector_num * BDRV_SECTOR_SIZE,
1998 nb_sectors * BDRV_SECTOR_SIZE, &count,
1999 &map, file);
2000 if (ret < 0) {
2001 break;
2003 assert(QEMU_IS_ALIGNED(count | map, BDRV_SECTOR_SIZE));
2004 ret |= map;
2005 *pnum = count >> BDRV_SECTOR_BITS;
2006 if (ret & BDRV_BLOCK_ZERO && ret & BDRV_BLOCK_EOF && !first) {
2008 * Reading beyond the end of the file continues to read
2009 * zeroes, but we can only widen the result to the
2010 * unallocated length we learned from an earlier
2011 * iteration.
2013 *pnum = nb_sectors;
2015 if (ret & (BDRV_BLOCK_ZERO | BDRV_BLOCK_DATA)) {
2016 break;
2018 /* [sector_num, pnum] unallocated on this layer, which could be only
2019 * the first part of [sector_num, nb_sectors]. */
2020 nb_sectors = MIN(nb_sectors, *pnum);
2021 first = false;
2023 return ret;
2026 /* Coroutine wrapper for bdrv_get_block_status_above() */
2027 static void coroutine_fn bdrv_get_block_status_above_co_entry(void *opaque)
2029 BdrvCoBlockStatusData *data = opaque;
2030 int n = 0;
2031 int64_t ret;
2033 ret = bdrv_co_get_block_status_above(data->bs, data->base,
2034 data->want_zero,
2035 data->offset >> BDRV_SECTOR_BITS,
2036 data->bytes >> BDRV_SECTOR_BITS,
2038 data->file);
2039 if (ret < 0) {
2040 assert(INT_MIN <= ret);
2041 data->ret = ret;
2042 } else {
2043 *data->pnum = n * BDRV_SECTOR_SIZE;
2044 *data->map = ret & BDRV_BLOCK_OFFSET_MASK;
2045 data->ret = ret & ~BDRV_BLOCK_OFFSET_MASK;
2047 data->done = true;
2051 * Synchronous wrapper around bdrv_co_get_block_status_above().
2053 * See bdrv_co_get_block_status_above() for details.
2055 static int64_t bdrv_common_block_status_above(BlockDriverState *bs,
2056 BlockDriverState *base,
2057 bool want_zero,
2058 int64_t sector_num,
2059 int nb_sectors, int *pnum,
2060 BlockDriverState **file)
2062 Coroutine *co;
2063 int64_t n;
2064 int64_t map;
2065 BdrvCoBlockStatusData data = {
2066 .bs = bs,
2067 .base = base,
2068 .want_zero = want_zero,
2069 .offset = sector_num * BDRV_SECTOR_SIZE,
2070 .bytes = nb_sectors * BDRV_SECTOR_SIZE,
2071 .pnum = &n,
2072 .map = &map,
2073 .file = file,
2074 .done = false,
2077 if (qemu_in_coroutine()) {
2078 /* Fast-path if already in coroutine context */
2079 bdrv_get_block_status_above_co_entry(&data);
2080 } else {
2081 co = qemu_coroutine_create(bdrv_get_block_status_above_co_entry,
2082 &data);
2083 bdrv_coroutine_enter(bs, co);
2084 BDRV_POLL_WHILE(bs, !data.done);
2086 if (data.ret < 0) {
2087 *pnum = 0;
2088 return data.ret;
2090 assert(QEMU_IS_ALIGNED(n | map, BDRV_SECTOR_SIZE));
2091 *pnum = n >> BDRV_SECTOR_BITS;
2092 return data.ret | map;
2095 int64_t bdrv_get_block_status_above(BlockDriverState *bs,
2096 BlockDriverState *base,
2097 int64_t sector_num,
2098 int nb_sectors, int *pnum,
2099 BlockDriverState **file)
2101 return bdrv_common_block_status_above(bs, base, true, sector_num,
2102 nb_sectors, pnum, file);
2105 int bdrv_block_status(BlockDriverState *bs, int64_t offset, int64_t bytes,
2106 int64_t *pnum, int64_t *map, BlockDriverState **file)
2108 int64_t ret;
2109 int n;
2111 assert(QEMU_IS_ALIGNED(offset | bytes, BDRV_SECTOR_SIZE));
2112 assert(pnum);
2114 * The contract allows us to return pnum smaller than bytes, even
2115 * if the next query would see the same status; we truncate the
2116 * request to avoid overflowing the driver's 32-bit interface.
2118 bytes = MIN(bytes, BDRV_REQUEST_MAX_BYTES);
2119 ret = bdrv_get_block_status_above(bs, backing_bs(bs),
2120 offset >> BDRV_SECTOR_BITS,
2121 bytes >> BDRV_SECTOR_BITS, &n, file);
2122 if (ret < 0) {
2123 assert(INT_MIN <= ret);
2124 *pnum = 0;
2125 return ret;
2127 *pnum = n * BDRV_SECTOR_SIZE;
2128 if (map) {
2129 *map = ret & BDRV_BLOCK_OFFSET_MASK;
2130 } else {
2131 ret &= ~BDRV_BLOCK_OFFSET_VALID;
2133 return ret & ~BDRV_BLOCK_OFFSET_MASK;
2136 int coroutine_fn bdrv_is_allocated(BlockDriverState *bs, int64_t offset,
2137 int64_t bytes, int64_t *pnum)
2139 int64_t ret;
2140 int psectors;
2142 assert(QEMU_IS_ALIGNED(offset, BDRV_SECTOR_SIZE));
2143 assert(QEMU_IS_ALIGNED(bytes, BDRV_SECTOR_SIZE) && bytes < INT_MAX);
2144 ret = bdrv_common_block_status_above(bs, backing_bs(bs), false,
2145 offset >> BDRV_SECTOR_BITS,
2146 bytes >> BDRV_SECTOR_BITS, &psectors,
2147 NULL);
2148 if (ret < 0) {
2149 return ret;
2151 if (pnum) {
2152 *pnum = psectors * BDRV_SECTOR_SIZE;
2154 return !!(ret & BDRV_BLOCK_ALLOCATED);
2158 * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
2160 * Return true if (a prefix of) the given range is allocated in any image
2161 * between BASE and TOP (inclusive). BASE can be NULL to check if the given
2162 * offset is allocated in any image of the chain. Return false otherwise,
2163 * or negative errno on failure.
2165 * 'pnum' is set to the number of bytes (including and immediately
2166 * following the specified offset) that are known to be in the same
2167 * allocated/unallocated state. Note that a subsequent call starting
2168 * at 'offset + *pnum' may return the same allocation status (in other
2169 * words, the result is not necessarily the maximum possible range);
2170 * but 'pnum' will only be 0 when end of file is reached.
2173 int bdrv_is_allocated_above(BlockDriverState *top,
2174 BlockDriverState *base,
2175 int64_t offset, int64_t bytes, int64_t *pnum)
2177 BlockDriverState *intermediate;
2178 int ret;
2179 int64_t n = bytes;
2181 intermediate = top;
2182 while (intermediate && intermediate != base) {
2183 int64_t pnum_inter;
2184 int64_t size_inter;
2186 ret = bdrv_is_allocated(intermediate, offset, bytes, &pnum_inter);
2187 if (ret < 0) {
2188 return ret;
2190 if (ret) {
2191 *pnum = pnum_inter;
2192 return 1;
2195 size_inter = bdrv_getlength(intermediate);
2196 if (size_inter < 0) {
2197 return size_inter;
2199 if (n > pnum_inter &&
2200 (intermediate == top || offset + pnum_inter < size_inter)) {
2201 n = pnum_inter;
2204 intermediate = backing_bs(intermediate);
2207 *pnum = n;
2208 return 0;
2211 typedef struct BdrvVmstateCo {
2212 BlockDriverState *bs;
2213 QEMUIOVector *qiov;
2214 int64_t pos;
2215 bool is_read;
2216 int ret;
2217 } BdrvVmstateCo;
2219 static int coroutine_fn
2220 bdrv_co_rw_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos,
2221 bool is_read)
2223 BlockDriver *drv = bs->drv;
2224 int ret = -ENOTSUP;
2226 bdrv_inc_in_flight(bs);
2228 if (!drv) {
2229 ret = -ENOMEDIUM;
2230 } else if (drv->bdrv_load_vmstate) {
2231 if (is_read) {
2232 ret = drv->bdrv_load_vmstate(bs, qiov, pos);
2233 } else {
2234 ret = drv->bdrv_save_vmstate(bs, qiov, pos);
2236 } else if (bs->file) {
2237 ret = bdrv_co_rw_vmstate(bs->file->bs, qiov, pos, is_read);
2240 bdrv_dec_in_flight(bs);
2241 return ret;
2244 static void coroutine_fn bdrv_co_rw_vmstate_entry(void *opaque)
2246 BdrvVmstateCo *co = opaque;
2247 co->ret = bdrv_co_rw_vmstate(co->bs, co->qiov, co->pos, co->is_read);
2250 static inline int
2251 bdrv_rw_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos,
2252 bool is_read)
2254 if (qemu_in_coroutine()) {
2255 return bdrv_co_rw_vmstate(bs, qiov, pos, is_read);
2256 } else {
2257 BdrvVmstateCo data = {
2258 .bs = bs,
2259 .qiov = qiov,
2260 .pos = pos,
2261 .is_read = is_read,
2262 .ret = -EINPROGRESS,
2264 Coroutine *co = qemu_coroutine_create(bdrv_co_rw_vmstate_entry, &data);
2266 bdrv_coroutine_enter(bs, co);
2267 BDRV_POLL_WHILE(bs, data.ret == -EINPROGRESS);
2268 return data.ret;
2272 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
2273 int64_t pos, int size)
2275 QEMUIOVector qiov;
2276 struct iovec iov = {
2277 .iov_base = (void *) buf,
2278 .iov_len = size,
2280 int ret;
2282 qemu_iovec_init_external(&qiov, &iov, 1);
2284 ret = bdrv_writev_vmstate(bs, &qiov, pos);
2285 if (ret < 0) {
2286 return ret;
2289 return size;
2292 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
2294 return bdrv_rw_vmstate(bs, qiov, pos, false);
2297 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
2298 int64_t pos, int size)
2300 QEMUIOVector qiov;
2301 struct iovec iov = {
2302 .iov_base = buf,
2303 .iov_len = size,
2305 int ret;
2307 qemu_iovec_init_external(&qiov, &iov, 1);
2308 ret = bdrv_readv_vmstate(bs, &qiov, pos);
2309 if (ret < 0) {
2310 return ret;
2313 return size;
2316 int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
2318 return bdrv_rw_vmstate(bs, qiov, pos, true);
2321 /**************************************************************/
2322 /* async I/Os */
2324 void bdrv_aio_cancel(BlockAIOCB *acb)
2326 qemu_aio_ref(acb);
2327 bdrv_aio_cancel_async(acb);
2328 while (acb->refcnt > 1) {
2329 if (acb->aiocb_info->get_aio_context) {
2330 aio_poll(acb->aiocb_info->get_aio_context(acb), true);
2331 } else if (acb->bs) {
2332 /* qemu_aio_ref and qemu_aio_unref are not thread-safe, so
2333 * assert that we're not using an I/O thread. Thread-safe
2334 * code should use bdrv_aio_cancel_async exclusively.
2336 assert(bdrv_get_aio_context(acb->bs) == qemu_get_aio_context());
2337 aio_poll(bdrv_get_aio_context(acb->bs), true);
2338 } else {
2339 abort();
2342 qemu_aio_unref(acb);
2345 /* Async version of aio cancel. The caller is not blocked if the acb implements
2346 * cancel_async, otherwise we do nothing and let the request normally complete.
2347 * In either case the completion callback must be called. */
2348 void bdrv_aio_cancel_async(BlockAIOCB *acb)
2350 if (acb->aiocb_info->cancel_async) {
2351 acb->aiocb_info->cancel_async(acb);
2355 /**************************************************************/
2356 /* Coroutine block device emulation */
2358 typedef struct FlushCo {
2359 BlockDriverState *bs;
2360 int ret;
2361 } FlushCo;
2364 static void coroutine_fn bdrv_flush_co_entry(void *opaque)
2366 FlushCo *rwco = opaque;
2368 rwco->ret = bdrv_co_flush(rwco->bs);
2371 int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
2373 int current_gen;
2374 int ret = 0;
2376 bdrv_inc_in_flight(bs);
2378 if (!bdrv_is_inserted(bs) || bdrv_is_read_only(bs) ||
2379 bdrv_is_sg(bs)) {
2380 goto early_exit;
2383 qemu_co_mutex_lock(&bs->reqs_lock);
2384 current_gen = atomic_read(&bs->write_gen);
2386 /* Wait until any previous flushes are completed */
2387 while (bs->active_flush_req) {
2388 qemu_co_queue_wait(&bs->flush_queue, &bs->reqs_lock);
2391 /* Flushes reach this point in nondecreasing current_gen order. */
2392 bs->active_flush_req = true;
2393 qemu_co_mutex_unlock(&bs->reqs_lock);
2395 /* Write back all layers by calling one driver function */
2396 if (bs->drv->bdrv_co_flush) {
2397 ret = bs->drv->bdrv_co_flush(bs);
2398 goto out;
2401 /* Write back cached data to the OS even with cache=unsafe */
2402 BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_OS);
2403 if (bs->drv->bdrv_co_flush_to_os) {
2404 ret = bs->drv->bdrv_co_flush_to_os(bs);
2405 if (ret < 0) {
2406 goto out;
2410 /* But don't actually force it to the disk with cache=unsafe */
2411 if (bs->open_flags & BDRV_O_NO_FLUSH) {
2412 goto flush_parent;
2415 /* Check if we really need to flush anything */
2416 if (bs->flushed_gen == current_gen) {
2417 goto flush_parent;
2420 BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_DISK);
2421 if (bs->drv->bdrv_co_flush_to_disk) {
2422 ret = bs->drv->bdrv_co_flush_to_disk(bs);
2423 } else if (bs->drv->bdrv_aio_flush) {
2424 BlockAIOCB *acb;
2425 CoroutineIOCompletion co = {
2426 .coroutine = qemu_coroutine_self(),
2429 acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
2430 if (acb == NULL) {
2431 ret = -EIO;
2432 } else {
2433 qemu_coroutine_yield();
2434 ret = co.ret;
2436 } else {
2438 * Some block drivers always operate in either writethrough or unsafe
2439 * mode and don't support bdrv_flush therefore. Usually qemu doesn't
2440 * know how the server works (because the behaviour is hardcoded or
2441 * depends on server-side configuration), so we can't ensure that
2442 * everything is safe on disk. Returning an error doesn't work because
2443 * that would break guests even if the server operates in writethrough
2444 * mode.
2446 * Let's hope the user knows what he's doing.
2448 ret = 0;
2451 if (ret < 0) {
2452 goto out;
2455 /* Now flush the underlying protocol. It will also have BDRV_O_NO_FLUSH
2456 * in the case of cache=unsafe, so there are no useless flushes.
2458 flush_parent:
2459 ret = bs->file ? bdrv_co_flush(bs->file->bs) : 0;
2460 out:
2461 /* Notify any pending flushes that we have completed */
2462 if (ret == 0) {
2463 bs->flushed_gen = current_gen;
2466 qemu_co_mutex_lock(&bs->reqs_lock);
2467 bs->active_flush_req = false;
2468 /* Return value is ignored - it's ok if wait queue is empty */
2469 qemu_co_queue_next(&bs->flush_queue);
2470 qemu_co_mutex_unlock(&bs->reqs_lock);
2472 early_exit:
2473 bdrv_dec_in_flight(bs);
2474 return ret;
2477 int bdrv_flush(BlockDriverState *bs)
2479 Coroutine *co;
2480 FlushCo flush_co = {
2481 .bs = bs,
2482 .ret = NOT_DONE,
2485 if (qemu_in_coroutine()) {
2486 /* Fast-path if already in coroutine context */
2487 bdrv_flush_co_entry(&flush_co);
2488 } else {
2489 co = qemu_coroutine_create(bdrv_flush_co_entry, &flush_co);
2490 bdrv_coroutine_enter(bs, co);
2491 BDRV_POLL_WHILE(bs, flush_co.ret == NOT_DONE);
2494 return flush_co.ret;
2497 typedef struct DiscardCo {
2498 BlockDriverState *bs;
2499 int64_t offset;
2500 int bytes;
2501 int ret;
2502 } DiscardCo;
2503 static void coroutine_fn bdrv_pdiscard_co_entry(void *opaque)
2505 DiscardCo *rwco = opaque;
2507 rwco->ret = bdrv_co_pdiscard(rwco->bs, rwco->offset, rwco->bytes);
2510 int coroutine_fn bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset,
2511 int bytes)
2513 BdrvTrackedRequest req;
2514 int max_pdiscard, ret;
2515 int head, tail, align;
2517 if (!bs->drv) {
2518 return -ENOMEDIUM;
2521 if (bdrv_has_readonly_bitmaps(bs)) {
2522 return -EPERM;
2525 ret = bdrv_check_byte_request(bs, offset, bytes);
2526 if (ret < 0) {
2527 return ret;
2528 } else if (bs->read_only) {
2529 return -EPERM;
2531 assert(!(bs->open_flags & BDRV_O_INACTIVE));
2533 /* Do nothing if disabled. */
2534 if (!(bs->open_flags & BDRV_O_UNMAP)) {
2535 return 0;
2538 if (!bs->drv->bdrv_co_pdiscard && !bs->drv->bdrv_aio_pdiscard) {
2539 return 0;
2542 /* Discard is advisory, but some devices track and coalesce
2543 * unaligned requests, so we must pass everything down rather than
2544 * round here. Still, most devices will just silently ignore
2545 * unaligned requests (by returning -ENOTSUP), so we must fragment
2546 * the request accordingly. */
2547 align = MAX(bs->bl.pdiscard_alignment, bs->bl.request_alignment);
2548 assert(align % bs->bl.request_alignment == 0);
2549 head = offset % align;
2550 tail = (offset + bytes) % align;
2552 bdrv_inc_in_flight(bs);
2553 tracked_request_begin(&req, bs, offset, bytes, BDRV_TRACKED_DISCARD);
2555 ret = notifier_with_return_list_notify(&bs->before_write_notifiers, &req);
2556 if (ret < 0) {
2557 goto out;
2560 max_pdiscard = QEMU_ALIGN_DOWN(MIN_NON_ZERO(bs->bl.max_pdiscard, INT_MAX),
2561 align);
2562 assert(max_pdiscard >= bs->bl.request_alignment);
2564 while (bytes > 0) {
2565 int num = bytes;
2567 if (head) {
2568 /* Make small requests to get to alignment boundaries. */
2569 num = MIN(bytes, align - head);
2570 if (!QEMU_IS_ALIGNED(num, bs->bl.request_alignment)) {
2571 num %= bs->bl.request_alignment;
2573 head = (head + num) % align;
2574 assert(num < max_pdiscard);
2575 } else if (tail) {
2576 if (num > align) {
2577 /* Shorten the request to the last aligned cluster. */
2578 num -= tail;
2579 } else if (!QEMU_IS_ALIGNED(tail, bs->bl.request_alignment) &&
2580 tail > bs->bl.request_alignment) {
2581 tail %= bs->bl.request_alignment;
2582 num -= tail;
2585 /* limit request size */
2586 if (num > max_pdiscard) {
2587 num = max_pdiscard;
2590 if (bs->drv->bdrv_co_pdiscard) {
2591 ret = bs->drv->bdrv_co_pdiscard(bs, offset, num);
2592 } else {
2593 BlockAIOCB *acb;
2594 CoroutineIOCompletion co = {
2595 .coroutine = qemu_coroutine_self(),
2598 acb = bs->drv->bdrv_aio_pdiscard(bs, offset, num,
2599 bdrv_co_io_em_complete, &co);
2600 if (acb == NULL) {
2601 ret = -EIO;
2602 goto out;
2603 } else {
2604 qemu_coroutine_yield();
2605 ret = co.ret;
2608 if (ret && ret != -ENOTSUP) {
2609 goto out;
2612 offset += num;
2613 bytes -= num;
2615 ret = 0;
2616 out:
2617 atomic_inc(&bs->write_gen);
2618 bdrv_set_dirty(bs, req.offset, req.bytes);
2619 tracked_request_end(&req);
2620 bdrv_dec_in_flight(bs);
2621 return ret;
2624 int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2626 Coroutine *co;
2627 DiscardCo rwco = {
2628 .bs = bs,
2629 .offset = offset,
2630 .bytes = bytes,
2631 .ret = NOT_DONE,
2634 if (qemu_in_coroutine()) {
2635 /* Fast-path if already in coroutine context */
2636 bdrv_pdiscard_co_entry(&rwco);
2637 } else {
2638 co = qemu_coroutine_create(bdrv_pdiscard_co_entry, &rwco);
2639 bdrv_coroutine_enter(bs, co);
2640 BDRV_POLL_WHILE(bs, rwco.ret == NOT_DONE);
2643 return rwco.ret;
2646 int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf)
2648 BlockDriver *drv = bs->drv;
2649 CoroutineIOCompletion co = {
2650 .coroutine = qemu_coroutine_self(),
2652 BlockAIOCB *acb;
2654 bdrv_inc_in_flight(bs);
2655 if (!drv || (!drv->bdrv_aio_ioctl && !drv->bdrv_co_ioctl)) {
2656 co.ret = -ENOTSUP;
2657 goto out;
2660 if (drv->bdrv_co_ioctl) {
2661 co.ret = drv->bdrv_co_ioctl(bs, req, buf);
2662 } else {
2663 acb = drv->bdrv_aio_ioctl(bs, req, buf, bdrv_co_io_em_complete, &co);
2664 if (!acb) {
2665 co.ret = -ENOTSUP;
2666 goto out;
2668 qemu_coroutine_yield();
2670 out:
2671 bdrv_dec_in_flight(bs);
2672 return co.ret;
2675 void *qemu_blockalign(BlockDriverState *bs, size_t size)
2677 return qemu_memalign(bdrv_opt_mem_align(bs), size);
2680 void *qemu_blockalign0(BlockDriverState *bs, size_t size)
2682 return memset(qemu_blockalign(bs, size), 0, size);
2685 void *qemu_try_blockalign(BlockDriverState *bs, size_t size)
2687 size_t align = bdrv_opt_mem_align(bs);
2689 /* Ensure that NULL is never returned on success */
2690 assert(align > 0);
2691 if (size == 0) {
2692 size = align;
2695 return qemu_try_memalign(align, size);
2698 void *qemu_try_blockalign0(BlockDriverState *bs, size_t size)
2700 void *mem = qemu_try_blockalign(bs, size);
2702 if (mem) {
2703 memset(mem, 0, size);
2706 return mem;
2710 * Check if all memory in this vector is sector aligned.
2712 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov)
2714 int i;
2715 size_t alignment = bdrv_min_mem_align(bs);
2717 for (i = 0; i < qiov->niov; i++) {
2718 if ((uintptr_t) qiov->iov[i].iov_base % alignment) {
2719 return false;
2721 if (qiov->iov[i].iov_len % alignment) {
2722 return false;
2726 return true;
2729 void bdrv_add_before_write_notifier(BlockDriverState *bs,
2730 NotifierWithReturn *notifier)
2732 notifier_with_return_list_add(&bs->before_write_notifiers, notifier);
2735 void bdrv_io_plug(BlockDriverState *bs)
2737 BdrvChild *child;
2739 QLIST_FOREACH(child, &bs->children, next) {
2740 bdrv_io_plug(child->bs);
2743 if (atomic_fetch_inc(&bs->io_plugged) == 0) {
2744 BlockDriver *drv = bs->drv;
2745 if (drv && drv->bdrv_io_plug) {
2746 drv->bdrv_io_plug(bs);
2751 void bdrv_io_unplug(BlockDriverState *bs)
2753 BdrvChild *child;
2755 assert(bs->io_plugged);
2756 if (atomic_fetch_dec(&bs->io_plugged) == 1) {
2757 BlockDriver *drv = bs->drv;
2758 if (drv && drv->bdrv_io_unplug) {
2759 drv->bdrv_io_unplug(bs);
2763 QLIST_FOREACH(child, &bs->children, next) {
2764 bdrv_io_unplug(child->bs);