| 1 | /* |
| 2 | * QEMU Block backends |
| 3 | * |
| 4 | * Copyright (C) 2014-2016 Red Hat, Inc. |
| 5 | * |
| 6 | * Authors: |
| 7 | * Markus Armbruster <armbru@redhat.com>, |
| 8 | * |
| 9 | * This work is licensed under the terms of the GNU LGPL, version 2.1 |
| 10 | * or later. See the COPYING.LIB file in the top-level directory. |
| 11 | */ |
| 12 | |
| 13 | #ifndef BLOCK_BACKEND_IO_H |
| 14 | #define BLOCK_BACKEND_IO_H |
| 15 | |
| 16 | #include "block-backend-common.h" |
| 17 | #include "block/accounting.h" |
| 18 | |
| 19 | /* |
| 20 | * I/O API functions. These functions are thread-safe. |
| 21 | * |
| 22 | * See include/block/block-io.h for more information about |
| 23 | * the I/O API. |
| 24 | */ |
| 25 | |
| 26 | const char *blk_name(const BlockBackend *blk); |
| 27 | |
| 28 | BlockDriverState *blk_bs(BlockBackend *blk); |
| 29 | |
| 30 | void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow); |
| 31 | void blk_set_allow_aio_context_change(BlockBackend *blk, bool allow); |
| 32 | void blk_set_disable_request_queuing(BlockBackend *blk, bool disable); |
| 33 | bool blk_iostatus_is_enabled(const BlockBackend *blk); |
| 34 | |
| 35 | /* |
| 36 | * Return the qdev ID, or if no ID is assigned the QOM path, |
| 37 | * of the block device attached to the BlockBackend. |
| 38 | * |
| 39 | * The caller is responsible for releasing the value returned |
| 40 | * with g_free() after use. |
| 41 | */ |
| 42 | char *blk_get_attached_dev_id(BlockBackend *blk); |
| 43 | |
| 44 | BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset, |
| 45 | int64_t bytes, BdrvRequestFlags flags, |
| 46 | BlockCompletionFunc *cb, void *opaque); |
| 47 | |
| 48 | BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset, |
| 49 | QEMUIOVector *qiov, BdrvRequestFlags flags, |
| 50 | BlockCompletionFunc *cb, void *opaque); |
| 51 | BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset, |
| 52 | QEMUIOVector *qiov, BdrvRequestFlags flags, |
| 53 | BlockCompletionFunc *cb, void *opaque); |
| 54 | BlockAIOCB *blk_aio_flush(BlockBackend *blk, |
| 55 | BlockCompletionFunc *cb, void *opaque); |
| 56 | BlockAIOCB *blk_aio_zone_report(BlockBackend *blk, int64_t offset, |
| 57 | unsigned int *nr_zones, |
| 58 | BlockZoneDescriptor *zones, |
| 59 | BlockCompletionFunc *cb, void *opaque); |
| 60 | BlockAIOCB *blk_aio_zone_mgmt(BlockBackend *blk, BlockZoneOp op, |
| 61 | int64_t offset, int64_t len, |
| 62 | BlockCompletionFunc *cb, void *opaque); |
| 63 | BlockAIOCB *blk_aio_zone_append(BlockBackend *blk, int64_t *offset, |
| 64 | QEMUIOVector *qiov, BdrvRequestFlags flags, |
| 65 | BlockCompletionFunc *cb, void *opaque); |
| 66 | BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk, int64_t offset, int64_t bytes, |
| 67 | BlockCompletionFunc *cb, void *opaque); |
| 68 | void blk_aio_cancel_async(BlockAIOCB *acb); |
| 69 | BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf, |
| 70 | BlockCompletionFunc *cb, void *opaque); |
| 71 | |
| 72 | void blk_inc_in_flight(BlockBackend *blk); |
| 73 | void blk_dec_in_flight(BlockBackend *blk); |
| 74 | void coroutine_fn blk_co_start_request(BlockBackend *blk); |
| 75 | void blk_end_request(BlockBackend *blk); |
| 76 | |
| 77 | bool coroutine_fn GRAPH_RDLOCK blk_co_is_inserted(BlockBackend *blk); |
| 78 | bool co_wrapper_mixed_bdrv_rdlock blk_is_inserted(BlockBackend *blk); |
| 79 | |
| 80 | bool coroutine_fn GRAPH_RDLOCK blk_co_is_available(BlockBackend *blk); |
| 81 | bool co_wrapper_mixed_bdrv_rdlock blk_is_available(BlockBackend *blk); |
| 82 | |
| 83 | void coroutine_fn blk_co_lock_medium(BlockBackend *blk, bool locked); |
| 84 | void co_wrapper blk_lock_medium(BlockBackend *blk, bool locked); |
| 85 | |
| 86 | void coroutine_fn blk_co_eject(BlockBackend *blk, bool eject_flag); |
| 87 | void co_wrapper blk_eject(BlockBackend *blk, bool eject_flag); |
| 88 | |
| 89 | int64_t coroutine_fn blk_co_getlength(BlockBackend *blk); |
| 90 | int64_t co_wrapper_mixed blk_getlength(BlockBackend *blk); |
| 91 | |
| 92 | void coroutine_fn blk_co_get_geometry(BlockBackend *blk, |
| 93 | uint64_t *nb_sectors_ptr); |
| 94 | void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr); |
| 95 | |
| 96 | int64_t coroutine_fn blk_co_nb_sectors(BlockBackend *blk); |
| 97 | int64_t blk_nb_sectors(BlockBackend *blk); |
| 98 | |
| 99 | void *blk_try_blockalign(BlockBackend *blk, size_t size); |
| 100 | void *blk_blockalign(BlockBackend *blk, size_t size); |
| 101 | bool blk_is_writable(BlockBackend *blk); |
| 102 | bool blk_enable_write_cache(BlockBackend *blk); |
| 103 | BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read); |
| 104 | BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read, |
| 105 | int error); |
| 106 | void blk_error_action(BlockBackend *blk, BlockErrorAction action, |
| 107 | bool is_read, int error); |
| 108 | void blk_iostatus_set_err(BlockBackend *blk, int error); |
| 109 | int blk_get_max_iov(BlockBackend *blk); |
| 110 | int blk_get_max_hw_iov(BlockBackend *blk); |
| 111 | |
| 112 | AioContext *blk_get_aio_context(BlockBackend *blk); |
| 113 | BlockAcctStats *blk_get_stats(BlockBackend *blk); |
| 114 | void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk, |
| 115 | BlockCompletionFunc *cb, void *opaque); |
| 116 | BlockAIOCB *blk_abort_aio_request(BlockBackend *blk, |
| 117 | BlockCompletionFunc *cb, |
| 118 | void *opaque, int ret); |
| 119 | |
| 120 | uint32_t blk_get_request_alignment(BlockBackend *blk); |
| 121 | uint32_t blk_get_pwrite_zeroes_alignment(BlockBackend *blk); |
| 122 | uint32_t blk_get_max_transfer(BlockBackend *blk); |
| 123 | uint64_t blk_get_max_hw_transfer(BlockBackend *blk); |
| 124 | |
| 125 | int coroutine_fn blk_co_copy_range(BlockBackend *blk_in, int64_t off_in, |
| 126 | BlockBackend *blk_out, int64_t off_out, |
| 127 | int64_t bytes, BdrvRequestFlags read_flags, |
| 128 | BdrvRequestFlags write_flags); |
| 129 | |
| 130 | int coroutine_fn blk_co_block_status_above(BlockBackend *blk, |
| 131 | BlockDriverState *base, |
| 132 | int64_t offset, int64_t bytes, |
| 133 | int64_t *pnum, int64_t *map, |
| 134 | BlockDriverState **file); |
| 135 | int coroutine_fn blk_co_is_allocated_above(BlockBackend *blk, |
| 136 | BlockDriverState *base, |
| 137 | bool include_base, int64_t offset, |
| 138 | int64_t bytes, int64_t *pnum); |
| 139 | |
| 140 | /* |
| 141 | * "I/O or GS" API functions. These functions can run without |
| 142 | * the BQL, but only in one specific iothread/main loop. |
| 143 | * |
| 144 | * See include/block/block-io.h for more information about |
| 145 | * the "I/O or GS" API. |
| 146 | */ |
| 147 | |
| 148 | int co_wrapper_mixed blk_pread(BlockBackend *blk, int64_t offset, |
| 149 | int64_t bytes, void *buf, |
| 150 | BdrvRequestFlags flags); |
| 151 | int coroutine_fn blk_co_pread(BlockBackend *blk, int64_t offset, int64_t bytes, |
| 152 | void *buf, BdrvRequestFlags flags); |
| 153 | |
| 154 | int co_wrapper_mixed blk_preadv(BlockBackend *blk, int64_t offset, |
| 155 | int64_t bytes, QEMUIOVector *qiov, |
| 156 | BdrvRequestFlags flags); |
| 157 | int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset, |
| 158 | int64_t bytes, QEMUIOVector *qiov, |
| 159 | BdrvRequestFlags flags); |
| 160 | |
| 161 | int co_wrapper_mixed blk_preadv_part(BlockBackend *blk, int64_t offset, |
| 162 | int64_t bytes, QEMUIOVector *qiov, |
| 163 | size_t qiov_offset, |
| 164 | BdrvRequestFlags flags); |
| 165 | int coroutine_fn blk_co_preadv_part(BlockBackend *blk, int64_t offset, |
| 166 | int64_t bytes, QEMUIOVector *qiov, |
| 167 | size_t qiov_offset, BdrvRequestFlags flags); |
| 168 | |
| 169 | int co_wrapper_mixed blk_pwrite(BlockBackend *blk, int64_t offset, |
| 170 | int64_t bytes, const void *buf, |
| 171 | BdrvRequestFlags flags); |
| 172 | int coroutine_fn blk_co_pwrite(BlockBackend *blk, int64_t offset, int64_t bytes, |
| 173 | const void *buf, BdrvRequestFlags flags); |
| 174 | |
| 175 | int co_wrapper_mixed blk_pwritev(BlockBackend *blk, int64_t offset, |
| 176 | int64_t bytes, QEMUIOVector *qiov, |
| 177 | BdrvRequestFlags flags); |
| 178 | int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset, |
| 179 | int64_t bytes, QEMUIOVector *qiov, |
| 180 | BdrvRequestFlags flags); |
| 181 | |
| 182 | int co_wrapper_mixed blk_pwritev_part(BlockBackend *blk, int64_t offset, |
| 183 | int64_t bytes, QEMUIOVector *qiov, |
| 184 | size_t qiov_offset, |
| 185 | BdrvRequestFlags flags); |
| 186 | int coroutine_fn blk_co_pwritev_part(BlockBackend *blk, int64_t offset, |
| 187 | int64_t bytes, |
| 188 | QEMUIOVector *qiov, size_t qiov_offset, |
| 189 | BdrvRequestFlags flags); |
| 190 | |
| 191 | int co_wrapper_mixed blk_pwrite_compressed(BlockBackend *blk, |
| 192 | int64_t offset, int64_t bytes, |
| 193 | const void *buf); |
| 194 | int coroutine_fn blk_co_pwrite_compressed(BlockBackend *blk, int64_t offset, |
| 195 | int64_t bytes, const void *buf); |
| 196 | |
| 197 | int co_wrapper_mixed blk_pwrite_zeroes(BlockBackend *blk, int64_t offset, |
| 198 | int64_t bytes, |
| 199 | BdrvRequestFlags flags); |
| 200 | int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset, |
| 201 | int64_t bytes, BdrvRequestFlags flags); |
| 202 | |
| 203 | int coroutine_fn blk_co_zone_report(BlockBackend *blk, int64_t offset, |
| 204 | unsigned int *nr_zones, |
| 205 | BlockZoneDescriptor *zones); |
| 206 | int co_wrapper_mixed blk_zone_report(BlockBackend *blk, int64_t offset, |
| 207 | unsigned int *nr_zones, |
| 208 | BlockZoneDescriptor *zones); |
| 209 | int coroutine_fn blk_co_zone_mgmt(BlockBackend *blk, BlockZoneOp op, |
| 210 | int64_t offset, int64_t len); |
| 211 | int co_wrapper_mixed blk_zone_mgmt(BlockBackend *blk, BlockZoneOp op, |
| 212 | int64_t offset, int64_t len); |
| 213 | int coroutine_fn blk_co_zone_append(BlockBackend *blk, int64_t *offset, |
| 214 | QEMUIOVector *qiov, |
| 215 | BdrvRequestFlags flags); |
| 216 | int co_wrapper_mixed blk_zone_append(BlockBackend *blk, int64_t *offset, |
| 217 | QEMUIOVector *qiov, |
| 218 | BdrvRequestFlags flags); |
| 219 | |
| 220 | int co_wrapper_mixed blk_pdiscard(BlockBackend *blk, int64_t offset, |
| 221 | int64_t bytes, BdrvRequestFlags flags); |
| 222 | int coroutine_fn blk_co_pdiscard(BlockBackend *blk, int64_t offset, |
| 223 | int64_t bytes, BdrvRequestFlags flags); |
| 224 | |
| 225 | int co_wrapper_mixed blk_flush(BlockBackend *blk); |
| 226 | int coroutine_fn blk_co_flush(BlockBackend *blk); |
| 227 | |
| 228 | int co_wrapper_mixed blk_ioctl(BlockBackend *blk, unsigned long int req, |
| 229 | void *buf); |
| 230 | int coroutine_fn blk_co_ioctl(BlockBackend *blk, unsigned long int req, |
| 231 | void *buf); |
| 232 | |
| 233 | int co_wrapper_mixed blk_truncate(BlockBackend *blk, int64_t offset, |
| 234 | bool exact, PreallocMode prealloc, |
| 235 | BdrvRequestFlags flags, Error **errp); |
| 236 | int coroutine_fn blk_co_truncate(BlockBackend *blk, int64_t offset, bool exact, |
| 237 | PreallocMode prealloc, BdrvRequestFlags flags, |
| 238 | Error **errp); |
| 239 | |
| 240 | #endif /* BLOCK_BACKEND_IO_H */ |