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_H 14 #define BLOCK_BACKEND_H 15 16 #include "qemu/iov.h" 17 #include "block/throttle-groups.h" 18 19 /* 20 * TODO Have to include block/block.h for a bunch of block layer 21 * types. Unfortunately, this pulls in the whole BlockDriverState 22 * API, which we don't want used by many BlockBackend users. Some of 23 * the types belong here, and the rest should be split into a common 24 * header and one for the BlockDriverState API. 25 */ 26 #include "block/block.h" 27 28 /* Callbacks for block device models */ 29 typedef struct BlockDevOps { 30 /* 31 * Runs when virtual media changed (monitor commands eject, change) 32 * Argument load is true on load and false on eject. 33 * Beware: doesn't run when a host device's physical media 34 * changes. Sure would be useful if it did. 35 * Device models with removable media must implement this callback. 36 */ 37 void (*change_media_cb)(void *opaque, bool load); 38 /* 39 * Runs when an eject request is issued from the monitor, the tray 40 * is closed, and the medium is locked. 41 * Device models that do not implement is_medium_locked will not need 42 * this callback. Device models that can lock the medium or tray might 43 * want to implement the callback and unlock the tray when "force" is 44 * true, even if they do not support eject requests. 45 */ 46 void (*eject_request_cb)(void *opaque, bool force); 47 /* 48 * Is the virtual tray open? 49 * Device models implement this only when the device has a tray. 50 */ 51 bool (*is_tray_open)(void *opaque); 52 /* 53 * Is the virtual medium locked into the device? 54 * Device models implement this only when device has such a lock. 55 */ 56 bool (*is_medium_locked)(void *opaque); 57 /* 58 * Runs when the size changed (e.g. monitor command block_resize) 59 */ 60 void (*resize_cb)(void *opaque); 61 } BlockDevOps; 62 63 /* This struct is embedded in (the private) BlockBackend struct and contains 64 * fields that must be public. This is in particular for QLIST_ENTRY() and 65 * friends so that BlockBackends can be kept in lists outside block-backend.c */ 66 typedef struct BlockBackendPublic { 67 /* I/O throttling. 68 * throttle_state tells us if this BlockBackend has I/O limits configured. 69 * io_limits_disabled tells us if they are currently being enforced */ 70 CoQueue throttled_reqs[2]; 71 unsigned int io_limits_disabled; 72 73 /* The following fields are protected by the ThrottleGroup lock. 74 * See the ThrottleGroup documentation for details. */ 75 ThrottleState *throttle_state; 76 ThrottleTimers throttle_timers; 77 unsigned pending_reqs[2]; 78 QLIST_ENTRY(BlockBackendPublic) round_robin; 79 } BlockBackendPublic; 80 81 BlockBackend *blk_new(void); 82 BlockBackend *blk_new_open(const char *filename, const char *reference, 83 QDict *options, int flags, Error **errp); 84 int blk_get_refcnt(BlockBackend *blk); 85 void blk_ref(BlockBackend *blk); 86 void blk_unref(BlockBackend *blk); 87 void blk_remove_all_bs(void); 88 const char *blk_name(BlockBackend *blk); 89 BlockBackend *blk_by_name(const char *name); 90 BlockBackend *blk_next(BlockBackend *blk); 91 bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp); 92 void monitor_remove_blk(BlockBackend *blk); 93 94 BlockBackendPublic *blk_get_public(BlockBackend *blk); 95 BlockBackend *blk_by_public(BlockBackendPublic *public); 96 97 BlockDriverState *blk_bs(BlockBackend *blk); 98 void blk_remove_bs(BlockBackend *blk); 99 void blk_insert_bs(BlockBackend *blk, BlockDriverState *bs); 100 bool bdrv_has_blk(BlockDriverState *bs); 101 102 void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow); 103 void blk_iostatus_enable(BlockBackend *blk); 104 bool blk_iostatus_is_enabled(const BlockBackend *blk); 105 BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk); 106 void blk_iostatus_disable(BlockBackend *blk); 107 void blk_iostatus_reset(BlockBackend *blk); 108 void blk_iostatus_set_err(BlockBackend *blk, int error); 109 int blk_attach_dev(BlockBackend *blk, void *dev); 110 void blk_attach_dev_nofail(BlockBackend *blk, void *dev); 111 void blk_detach_dev(BlockBackend *blk, void *dev); 112 void *blk_get_attached_dev(BlockBackend *blk); 113 void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops, void *opaque); 114 int blk_pread_unthrottled(BlockBackend *blk, int64_t offset, uint8_t *buf, 115 int count); 116 int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset, 117 unsigned int bytes, QEMUIOVector *qiov, 118 BdrvRequestFlags flags); 119 int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset, 120 unsigned int bytes, QEMUIOVector *qiov, 121 BdrvRequestFlags flags); 122 int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset, 123 int count, BdrvRequestFlags flags); 124 BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset, 125 int count, BdrvRequestFlags flags, 126 BlockCompletionFunc *cb, void *opaque); 127 int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count); 128 int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count, 129 BdrvRequestFlags flags); 130 int64_t blk_getlength(BlockBackend *blk); 131 void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr); 132 int64_t blk_nb_sectors(BlockBackend *blk); 133 BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset, 134 QEMUIOVector *qiov, BdrvRequestFlags flags, 135 BlockCompletionFunc *cb, void *opaque); 136 BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset, 137 QEMUIOVector *qiov, BdrvRequestFlags flags, 138 BlockCompletionFunc *cb, void *opaque); 139 BlockAIOCB *blk_aio_flush(BlockBackend *blk, 140 BlockCompletionFunc *cb, void *opaque); 141 BlockAIOCB *blk_aio_discard(BlockBackend *blk, 142 int64_t sector_num, int nb_sectors, 143 BlockCompletionFunc *cb, void *opaque); 144 void blk_aio_cancel(BlockAIOCB *acb); 145 void blk_aio_cancel_async(BlockAIOCB *acb); 146 int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf); 147 BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf, 148 BlockCompletionFunc *cb, void *opaque); 149 int blk_co_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors); 150 int blk_co_flush(BlockBackend *blk); 151 int blk_flush(BlockBackend *blk); 152 int blk_flush_all(void); 153 int blk_commit_all(void); 154 void blk_drain(BlockBackend *blk); 155 void blk_drain_all(void); 156 void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error, 157 BlockdevOnError on_write_error); 158 BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read); 159 BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read, 160 int error); 161 void blk_error_action(BlockBackend *blk, BlockErrorAction action, 162 bool is_read, int error); 163 int blk_is_read_only(BlockBackend *blk); 164 int blk_is_sg(BlockBackend *blk); 165 int blk_enable_write_cache(BlockBackend *blk); 166 void blk_set_enable_write_cache(BlockBackend *blk, bool wce); 167 void blk_invalidate_cache(BlockBackend *blk, Error **errp); 168 bool blk_is_inserted(BlockBackend *blk); 169 bool blk_is_available(BlockBackend *blk); 170 void blk_lock_medium(BlockBackend *blk, bool locked); 171 void blk_eject(BlockBackend *blk, bool eject_flag); 172 int blk_get_flags(BlockBackend *blk); 173 int blk_get_max_transfer_length(BlockBackend *blk); 174 int blk_get_max_iov(BlockBackend *blk); 175 void blk_set_guest_block_size(BlockBackend *blk, int align); 176 void *blk_try_blockalign(BlockBackend *blk, size_t size); 177 void *blk_blockalign(BlockBackend *blk, size_t size); 178 bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp); 179 void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason); 180 void blk_op_block_all(BlockBackend *blk, Error *reason); 181 void blk_op_unblock_all(BlockBackend *blk, Error *reason); 182 AioContext *blk_get_aio_context(BlockBackend *blk); 183 void blk_set_aio_context(BlockBackend *blk, AioContext *new_context); 184 void blk_add_aio_context_notifier(BlockBackend *blk, 185 void (*attached_aio_context)(AioContext *new_context, void *opaque), 186 void (*detach_aio_context)(void *opaque), void *opaque); 187 void blk_remove_aio_context_notifier(BlockBackend *blk, 188 void (*attached_aio_context)(AioContext *, 189 void *), 190 void (*detach_aio_context)(void *), 191 void *opaque); 192 void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify); 193 void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify); 194 void blk_io_plug(BlockBackend *blk); 195 void blk_io_unplug(BlockBackend *blk); 196 BlockAcctStats *blk_get_stats(BlockBackend *blk); 197 BlockBackendRootState *blk_get_root_state(BlockBackend *blk); 198 void blk_update_root_state(BlockBackend *blk); 199 void blk_apply_root_state(BlockBackend *blk, BlockDriverState *bs); 200 int blk_get_open_flags_from_root_state(BlockBackend *blk); 201 202 void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk, 203 BlockCompletionFunc *cb, void *opaque); 204 int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset, 205 int count, BdrvRequestFlags flags); 206 int blk_write_compressed(BlockBackend *blk, int64_t sector_num, 207 const uint8_t *buf, int nb_sectors); 208 int blk_truncate(BlockBackend *blk, int64_t offset); 209 int blk_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors); 210 int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf, 211 int64_t pos, int size); 212 int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size); 213 int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz); 214 int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo); 215 BlockAIOCB *blk_abort_aio_request(BlockBackend *blk, 216 BlockCompletionFunc *cb, 217 void *opaque, int ret); 218 219 void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg); 220 void blk_io_limits_disable(BlockBackend *blk); 221 void blk_io_limits_enable(BlockBackend *blk, const char *group); 222 void blk_io_limits_update_group(BlockBackend *blk, const char *group); 223 224 #endif 225