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