main loop: add missing documentation links to GS/IO macros
[qemu/armbru.git] / block / coroutines.h
blob3a2bad564fef0109893476db30b5e075390241d0
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 #ifndef BLOCK_COROUTINES_H
26 #define BLOCK_COROUTINES_H
28 #include "block/block_int.h"
30 /* For blk_bs() in generated block/block-gen.c */
31 #include "sysemu/block-backend.h"
34 * I/O API functions. These functions are thread-safe.
36 * See include/block/block-io.h for more information about
37 * the I/O API.
40 int coroutine_fn bdrv_co_check(BlockDriverState *bs,
41 BdrvCheckResult *res, BdrvCheckMode fix);
42 int coroutine_fn bdrv_co_invalidate_cache(BlockDriverState *bs, Error **errp);
44 int coroutine_fn
45 bdrv_co_common_block_status_above(BlockDriverState *bs,
46 BlockDriverState *base,
47 bool include_base,
48 bool want_zero,
49 int64_t offset,
50 int64_t bytes,
51 int64_t *pnum,
52 int64_t *map,
53 BlockDriverState **file,
54 int *depth);
56 int coroutine_fn bdrv_co_readv_vmstate(BlockDriverState *bs,
57 QEMUIOVector *qiov, int64_t pos);
58 int coroutine_fn bdrv_co_writev_vmstate(BlockDriverState *bs,
59 QEMUIOVector *qiov, int64_t pos);
61 int coroutine_fn
62 nbd_co_do_establish_connection(BlockDriverState *bs, bool blocking,
63 Error **errp);
67 * "I/O or GS" API functions. These functions can run without
68 * the BQL, but only in one specific iothread/main loop.
70 * See include/block/block-io.h for more information about
71 * the "I/O or GS" API.
74 int generated_co_wrapper
75 bdrv_common_block_status_above(BlockDriverState *bs,
76 BlockDriverState *base,
77 bool include_base,
78 bool want_zero,
79 int64_t offset,
80 int64_t bytes,
81 int64_t *pnum,
82 int64_t *map,
83 BlockDriverState **file,
84 int *depth);
85 int generated_co_wrapper
86 nbd_do_establish_connection(BlockDriverState *bs, bool blocking, Error **errp);
88 #endif /* BLOCK_COROUTINES_H */