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 char *blk_get_attached_dev_id(BlockBackend *blk); 36 37 BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset, 38 int64_t bytes, BdrvRequestFlags flags, 39 BlockCompletionFunc *cb, void *opaque); 40 41 BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset, 42 QEMUIOVector *qiov, BdrvRequestFlags flags, 43 BlockCompletionFunc *cb, void *opaque); 44 BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset, 45 QEMUIOVector *qiov, BdrvRequestFlags flags, 46 BlockCompletionFunc *cb, void *opaque); 47 BlockAIOCB *blk_aio_flush(BlockBackend *blk, 48 BlockCompletionFunc *cb, void *opaque); 49 BlockAIOCB *blk_aio_zone_report(BlockBackend *blk, int64_t offset, 50 unsigned int *nr_zones, 51 BlockZoneDescriptor *zones, 52 BlockCompletionFunc *cb, void *opaque); 53 BlockAIOCB *blk_aio_zone_mgmt(BlockBackend *blk, BlockZoneOp op, 54 int64_t offset, int64_t len, 55 BlockCompletionFunc *cb, void *opaque); 56 BlockAIOCB *blk_aio_zone_append(BlockBackend *blk, int64_t *offset, 57 QEMUIOVector *qiov, BdrvRequestFlags flags, 58 BlockCompletionFunc *cb, void *opaque); 59 BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk, int64_t offset, int64_t bytes, 60 BlockCompletionFunc *cb, void *opaque); 61 void blk_aio_cancel_async(BlockAIOCB *acb); 62 BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf, 63 BlockCompletionFunc *cb, void *opaque); 64 65 void blk_inc_in_flight(BlockBackend *blk); 66 void blk_dec_in_flight(BlockBackend *blk); 67 68 bool coroutine_fn GRAPH_RDLOCK blk_co_is_inserted(BlockBackend *blk); 69 bool co_wrapper_mixed_bdrv_rdlock blk_is_inserted(BlockBackend *blk); 70 71 bool coroutine_fn GRAPH_RDLOCK blk_co_is_available(BlockBackend *blk); 72 bool co_wrapper_mixed_bdrv_rdlock blk_is_available(BlockBackend *blk); 73 74 void coroutine_fn blk_co_lock_medium(BlockBackend *blk, bool locked); 75 void co_wrapper blk_lock_medium(BlockBackend *blk, bool locked); 76 77 void coroutine_fn blk_co_eject(BlockBackend *blk, bool eject_flag); 78 void co_wrapper blk_eject(BlockBackend *blk, bool eject_flag); 79 80 int64_t coroutine_fn blk_co_getlength(BlockBackend *blk); 81 int64_t co_wrapper_mixed blk_getlength(BlockBackend *blk); 82 83 void coroutine_fn blk_co_get_geometry(BlockBackend *blk, 84 uint64_t *nb_sectors_ptr); 85 void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr); 86 87 int64_t coroutine_fn blk_co_nb_sectors(BlockBackend *blk); 88 int64_t blk_nb_sectors(BlockBackend *blk); 89 90 void *blk_try_blockalign(BlockBackend *blk, size_t size); 91 void *blk_blockalign(BlockBackend *blk, size_t size); 92 bool blk_is_writable(BlockBackend *blk); 93 bool blk_enable_write_cache(BlockBackend *blk); 94 BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read); 95 BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read, 96 int error); 97 void blk_error_action(BlockBackend *blk, BlockErrorAction action, 98 bool is_read, int error); 99 void blk_iostatus_set_err(BlockBackend *blk, int error); 100 int blk_get_max_iov(BlockBackend *blk); 101 int blk_get_max_hw_iov(BlockBackend *blk); 102 103 /* 104 * blk_io_plug/unplug are thread-local operations. This means that multiple 105 * IOThreads can simultaneously call plug/unplug, but the caller must ensure 106 * that each unplug() is called in the same IOThread of the matching plug(). 107 */ 108 void coroutine_fn blk_co_io_plug(BlockBackend *blk); 109 void co_wrapper blk_io_plug(BlockBackend *blk); 110 111 void coroutine_fn blk_co_io_unplug(BlockBackend *blk); 112 void co_wrapper blk_io_unplug(BlockBackend *blk); 113 114 AioContext *blk_get_aio_context(BlockBackend *blk); 115 BlockAcctStats *blk_get_stats(BlockBackend *blk); 116 void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk, 117 BlockCompletionFunc *cb, void *opaque); 118 BlockAIOCB *blk_abort_aio_request(BlockBackend *blk, 119 BlockCompletionFunc *cb, 120 void *opaque, int ret); 121 122 uint32_t blk_get_request_alignment(BlockBackend *blk); 123 uint32_t blk_get_max_transfer(BlockBackend *blk); 124 uint64_t blk_get_max_hw_transfer(BlockBackend *blk); 125 126 int coroutine_fn blk_co_copy_range(BlockBackend *blk_in, int64_t off_in, 127 BlockBackend *blk_out, int64_t off_out, 128 int64_t bytes, BdrvRequestFlags read_flags, 129 BdrvRequestFlags write_flags); 130 131 int coroutine_fn blk_co_block_status_above(BlockBackend *blk, 132 BlockDriverState *base, 133 int64_t offset, int64_t bytes, 134 int64_t *pnum, int64_t *map, 135 BlockDriverState **file); 136 int coroutine_fn blk_co_is_allocated_above(BlockBackend *blk, 137 BlockDriverState *base, 138 bool include_base, int64_t offset, 139 int64_t bytes, int64_t *pnum); 140 141 /* 142 * "I/O or GS" API functions. These functions can run without 143 * the BQL, but only in one specific iothread/main loop. 144 * 145 * See include/block/block-io.h for more information about 146 * the "I/O or GS" API. 147 */ 148 149 int co_wrapper_mixed blk_pread(BlockBackend *blk, int64_t offset, 150 int64_t bytes, void *buf, 151 BdrvRequestFlags flags); 152 int coroutine_fn blk_co_pread(BlockBackend *blk, int64_t offset, int64_t bytes, 153 void *buf, BdrvRequestFlags flags); 154 155 int co_wrapper_mixed blk_preadv(BlockBackend *blk, int64_t offset, 156 int64_t bytes, QEMUIOVector *qiov, 157 BdrvRequestFlags flags); 158 int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset, 159 int64_t bytes, QEMUIOVector *qiov, 160 BdrvRequestFlags flags); 161 162 int co_wrapper_mixed blk_preadv_part(BlockBackend *blk, int64_t offset, 163 int64_t bytes, QEMUIOVector *qiov, 164 size_t qiov_offset, 165 BdrvRequestFlags flags); 166 int coroutine_fn blk_co_preadv_part(BlockBackend *blk, int64_t offset, 167 int64_t bytes, QEMUIOVector *qiov, 168 size_t qiov_offset, BdrvRequestFlags flags); 169 170 int co_wrapper_mixed blk_pwrite(BlockBackend *blk, int64_t offset, 171 int64_t bytes, const void *buf, 172 BdrvRequestFlags flags); 173 int coroutine_fn blk_co_pwrite(BlockBackend *blk, int64_t offset, int64_t bytes, 174 const void *buf, BdrvRequestFlags flags); 175 176 int co_wrapper_mixed blk_pwritev(BlockBackend *blk, int64_t offset, 177 int64_t bytes, QEMUIOVector *qiov, 178 BdrvRequestFlags flags); 179 int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset, 180 int64_t bytes, QEMUIOVector *qiov, 181 BdrvRequestFlags flags); 182 183 int co_wrapper_mixed blk_pwritev_part(BlockBackend *blk, int64_t offset, 184 int64_t bytes, QEMUIOVector *qiov, 185 size_t qiov_offset, 186 BdrvRequestFlags flags); 187 int coroutine_fn blk_co_pwritev_part(BlockBackend *blk, int64_t offset, 188 int64_t bytes, 189 QEMUIOVector *qiov, size_t qiov_offset, 190 BdrvRequestFlags flags); 191 192 int co_wrapper_mixed blk_pwrite_compressed(BlockBackend *blk, 193 int64_t offset, int64_t bytes, 194 const void *buf); 195 int coroutine_fn blk_co_pwrite_compressed(BlockBackend *blk, int64_t offset, 196 int64_t bytes, const void *buf); 197 198 int co_wrapper_mixed blk_pwrite_zeroes(BlockBackend *blk, int64_t offset, 199 int64_t bytes, 200 BdrvRequestFlags flags); 201 int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset, 202 int64_t bytes, BdrvRequestFlags flags); 203 204 int coroutine_fn blk_co_zone_report(BlockBackend *blk, int64_t offset, 205 unsigned int *nr_zones, 206 BlockZoneDescriptor *zones); 207 int co_wrapper_mixed blk_zone_report(BlockBackend *blk, int64_t offset, 208 unsigned int *nr_zones, 209 BlockZoneDescriptor *zones); 210 int coroutine_fn blk_co_zone_mgmt(BlockBackend *blk, BlockZoneOp op, 211 int64_t offset, int64_t len); 212 int co_wrapper_mixed blk_zone_mgmt(BlockBackend *blk, BlockZoneOp op, 213 int64_t offset, int64_t len); 214 int coroutine_fn blk_co_zone_append(BlockBackend *blk, int64_t *offset, 215 QEMUIOVector *qiov, 216 BdrvRequestFlags flags); 217 int co_wrapper_mixed blk_zone_append(BlockBackend *blk, int64_t *offset, 218 QEMUIOVector *qiov, 219 BdrvRequestFlags flags); 220 221 int co_wrapper_mixed blk_pdiscard(BlockBackend *blk, int64_t offset, 222 int64_t bytes); 223 int coroutine_fn blk_co_pdiscard(BlockBackend *blk, int64_t offset, 224 int64_t bytes); 225 226 int co_wrapper_mixed blk_flush(BlockBackend *blk); 227 int coroutine_fn blk_co_flush(BlockBackend *blk); 228 229 int co_wrapper_mixed blk_ioctl(BlockBackend *blk, unsigned long int req, 230 void *buf); 231 int coroutine_fn blk_co_ioctl(BlockBackend *blk, unsigned long int req, 232 void *buf); 233 234 int co_wrapper_mixed blk_truncate(BlockBackend *blk, int64_t offset, 235 bool exact, PreallocMode prealloc, 236 BdrvRequestFlags flags, Error **errp); 237 int coroutine_fn blk_co_truncate(BlockBackend *blk, int64_t offset, bool exact, 238 PreallocMode prealloc, BdrvRequestFlags flags, 239 Error **errp); 240 241 #endif /* BLOCK_BACKEND_IO_H */ 242