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