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