]>
Commit | Line | Data |
---|---|---|
26f54e9a MA |
1 | /* |
2 | * QEMU Block backends | |
3 | * | |
60cb2fa7 | 4 | * Copyright (C) 2014-2016 Red Hat, Inc. |
26f54e9a MA |
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 | ||
daf015ef | 16 | #include "qemu/iov.h" |
27ccdd52 | 17 | #include "block/throttle-groups.h" |
daf015ef | 18 | |
4be74634 MA |
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 | ||
a7f53e26 MA |
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 | */ | |
39829a01 | 37 | void (*change_media_cb)(void *opaque, bool load, Error **errp); |
a7f53e26 MA |
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); | |
f4d9cc88 JS |
61 | /* |
62 | * Runs when the backend receives a drain request. | |
63 | */ | |
64 | void (*drained_begin)(void *opaque); | |
65 | /* | |
66 | * Runs when the backend's last drain request ends. | |
67 | */ | |
68 | void (*drained_end)(void *opaque); | |
095cc4d0 SL |
69 | /* |
70 | * Is the device still busy? | |
71 | */ | |
72 | bool (*drained_poll)(void *opaque); | |
a7f53e26 MA |
73 | } BlockDevOps; |
74 | ||
f2cd875d KW |
75 | /* This struct is embedded in (the private) BlockBackend struct and contains |
76 | * fields that must be public. This is in particular for QLIST_ENTRY() and | |
022cdc9f MP |
77 | * friends so that BlockBackends can be kept in lists outside block-backend.c |
78 | * */ | |
f2cd875d | 79 | typedef struct BlockBackendPublic { |
022cdc9f | 80 | ThrottleGroupMember throttle_group_member; |
f2cd875d KW |
81 | } BlockBackendPublic; |
82 | ||
d861ab3a | 83 | BlockBackend *blk_new(AioContext *ctx, uint64_t perm, uint64_t shared_perm); |
a3aeeab5 EB |
84 | BlockBackend *blk_new_with_bs(BlockDriverState *bs, uint64_t perm, |
85 | uint64_t shared_perm, Error **errp); | |
efaa7c4e HR |
86 | BlockBackend *blk_new_open(const char *filename, const char *reference, |
87 | QDict *options, int flags, Error **errp); | |
f636ae85 | 88 | int blk_get_refcnt(BlockBackend *blk); |
26f54e9a MA |
89 | void blk_ref(BlockBackend *blk); |
90 | void blk_unref(BlockBackend *blk); | |
d8da3cef | 91 | void blk_remove_all_bs(void); |
0731a50f | 92 | const char *blk_name(const BlockBackend *blk); |
26f54e9a MA |
93 | BlockBackend *blk_by_name(const char *name); |
94 | BlockBackend *blk_next(BlockBackend *blk); | |
a429b9b5 | 95 | BlockBackend *blk_all_next(BlockBackend *blk); |
e5e78550 HR |
96 | bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp); |
97 | void monitor_remove_blk(BlockBackend *blk); | |
26f54e9a | 98 | |
f2cd875d KW |
99 | BlockBackendPublic *blk_get_public(BlockBackend *blk); |
100 | BlockBackend *blk_by_public(BlockBackendPublic *public); | |
101 | ||
7e7d56d9 | 102 | BlockDriverState *blk_bs(BlockBackend *blk); |
1c95f7e1 | 103 | void blk_remove_bs(BlockBackend *blk); |
d7086422 | 104 | int blk_insert_bs(BlockBackend *blk, BlockDriverState *bs, Error **errp); |
ed089506 | 105 | int blk_replace_bs(BlockBackend *blk, BlockDriverState *new_bs, Error **errp); |
dde33812 | 106 | bool bdrv_has_blk(BlockDriverState *bs); |
b6c1bae5 | 107 | bool bdrv_is_root_node(BlockDriverState *bs); |
981776b3 KW |
108 | int blk_set_perm(BlockBackend *blk, uint64_t perm, uint64_t shared_perm, |
109 | Error **errp); | |
887354bd | 110 | void blk_get_perm(BlockBackend *blk, uint64_t *perm, uint64_t *shared_perm); |
7e7d56d9 | 111 | |
c10c9d96 | 112 | void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow); |
980b0f94 | 113 | void blk_set_allow_aio_context_change(BlockBackend *blk, bool allow); |
cf312932 | 114 | void blk_set_disable_request_queuing(BlockBackend *blk, bool disable); |
4be74634 | 115 | void blk_iostatus_enable(BlockBackend *blk); |
373340b2 HR |
116 | bool blk_iostatus_is_enabled(const BlockBackend *blk); |
117 | BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk); | |
118 | void blk_iostatus_disable(BlockBackend *blk); | |
119 | void blk_iostatus_reset(BlockBackend *blk); | |
120 | void blk_iostatus_set_err(BlockBackend *blk, int error); | |
bbc8ea98 | 121 | int blk_attach_dev(BlockBackend *blk, DeviceState *dev); |
d09ea2d2 TH |
122 | void blk_detach_dev(BlockBackend *blk, DeviceState *dev); |
123 | DeviceState *blk_get_attached_dev(BlockBackend *blk); | |
77beef83 | 124 | char *blk_get_attached_dev_id(BlockBackend *blk); |
1c89e1fa | 125 | BlockBackend *blk_by_dev(void *dev); |
9680caee | 126 | BlockBackend *blk_by_qdev_id(const char *id, Error **errp); |
4be74634 | 127 | void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops, void *opaque); |
1e98fefd KW |
128 | int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset, |
129 | unsigned int bytes, QEMUIOVector *qiov, | |
130 | BdrvRequestFlags flags); | |
b3016864 VSO |
131 | int coroutine_fn blk_co_pwritev_part(BlockBackend *blk, int64_t offset, |
132 | unsigned int bytes, | |
133 | QEMUIOVector *qiov, size_t qiov_offset, | |
134 | BdrvRequestFlags flags); | |
1e98fefd KW |
135 | int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset, |
136 | unsigned int bytes, QEMUIOVector *qiov, | |
137 | BdrvRequestFlags flags); | |
371420e2 VSO |
138 | |
139 | static inline int coroutine_fn blk_co_pread(BlockBackend *blk, int64_t offset, | |
140 | unsigned int bytes, void *buf, | |
141 | BdrvRequestFlags flags) | |
142 | { | |
143 | QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes); | |
144 | ||
145 | return blk_co_preadv(blk, offset, bytes, &qiov, flags); | |
146 | } | |
147 | ||
148 | static inline int coroutine_fn blk_co_pwrite(BlockBackend *blk, int64_t offset, | |
149 | unsigned int bytes, void *buf, | |
150 | BdrvRequestFlags flags) | |
151 | { | |
152 | QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes); | |
153 | ||
154 | return blk_co_pwritev(blk, offset, bytes, &qiov, flags); | |
155 | } | |
156 | ||
d004bd52 | 157 | int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset, |
f5a5ca79 | 158 | int bytes, BdrvRequestFlags flags); |
d004bd52 | 159 | BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset, |
f5a5ca79 | 160 | int bytes, BdrvRequestFlags flags, |
d004bd52 | 161 | BlockCompletionFunc *cb, void *opaque); |
720ff280 | 162 | int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags); |
f5a5ca79 MP |
163 | int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int bytes); |
164 | int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int bytes, | |
8341f00d | 165 | BdrvRequestFlags flags); |
4be74634 MA |
166 | int64_t blk_getlength(BlockBackend *blk); |
167 | void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr); | |
1ef01253 | 168 | int64_t blk_nb_sectors(BlockBackend *blk); |
60cb2fa7 EB |
169 | BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset, |
170 | QEMUIOVector *qiov, BdrvRequestFlags flags, | |
171 | BlockCompletionFunc *cb, void *opaque); | |
60cb2fa7 EB |
172 | BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset, |
173 | QEMUIOVector *qiov, BdrvRequestFlags flags, | |
174 | BlockCompletionFunc *cb, void *opaque); | |
4be74634 MA |
175 | BlockAIOCB *blk_aio_flush(BlockBackend *blk, |
176 | BlockCompletionFunc *cb, void *opaque); | |
f5a5ca79 | 177 | BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk, int64_t offset, int bytes, |
1c6c4bb7 | 178 | BlockCompletionFunc *cb, void *opaque); |
4be74634 MA |
179 | void blk_aio_cancel(BlockAIOCB *acb); |
180 | void blk_aio_cancel_async(BlockAIOCB *acb); | |
4be74634 MA |
181 | int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf); |
182 | BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf, | |
183 | BlockCompletionFunc *cb, void *opaque); | |
f5a5ca79 | 184 | int blk_co_pdiscard(BlockBackend *blk, int64_t offset, int bytes); |
2bb0dce7 | 185 | int blk_co_flush(BlockBackend *blk); |
4be74634 | 186 | int blk_flush(BlockBackend *blk); |
1393f212 | 187 | int blk_commit_all(void); |
c90e2a9c KW |
188 | void blk_inc_in_flight(BlockBackend *blk); |
189 | void blk_dec_in_flight(BlockBackend *blk); | |
97b0385a | 190 | void blk_drain(BlockBackend *blk); |
4be74634 | 191 | void blk_drain_all(void); |
373340b2 HR |
192 | void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error, |
193 | BlockdevOnError on_write_error); | |
4be74634 MA |
194 | BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read); |
195 | BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read, | |
196 | int error); | |
197 | void blk_error_action(BlockBackend *blk, BlockErrorAction action, | |
198 | bool is_read, int error); | |
86b1cf32 KW |
199 | bool blk_supports_write_perm(BlockBackend *blk); |
200 | bool blk_is_writable(BlockBackend *blk); | |
96710565 LQ |
201 | bool blk_is_sg(BlockBackend *blk); |
202 | bool blk_enable_write_cache(BlockBackend *blk); | |
4be74634 | 203 | void blk_set_enable_write_cache(BlockBackend *blk, bool wce); |
2bb0dce7 | 204 | void blk_invalidate_cache(BlockBackend *blk, Error **errp); |
e031f750 | 205 | bool blk_is_inserted(BlockBackend *blk); |
db0284f8 | 206 | bool blk_is_available(BlockBackend *blk); |
4be74634 MA |
207 | void blk_lock_medium(BlockBackend *blk, bool locked); |
208 | void blk_eject(BlockBackend *blk, bool eject_flag); | |
209 | int blk_get_flags(BlockBackend *blk); | |
4841211e | 210 | uint32_t blk_get_request_alignment(BlockBackend *blk); |
5def6b80 | 211 | uint32_t blk_get_max_transfer(BlockBackend *blk); |
24b36e98 | 212 | uint64_t blk_get_max_hw_transfer(BlockBackend *blk); |
648296e0 | 213 | int blk_get_max_iov(BlockBackend *blk); |
4be74634 | 214 | void blk_set_guest_block_size(BlockBackend *blk, int align); |
f1c17521 | 215 | void *blk_try_blockalign(BlockBackend *blk, size_t size); |
4be74634 MA |
216 | void *blk_blockalign(BlockBackend *blk, size_t size); |
217 | bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp); | |
218 | void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason); | |
219 | void blk_op_block_all(BlockBackend *blk, Error *reason); | |
220 | void blk_op_unblock_all(BlockBackend *blk, Error *reason); | |
221 | AioContext *blk_get_aio_context(BlockBackend *blk); | |
97896a48 KW |
222 | int blk_set_aio_context(BlockBackend *blk, AioContext *new_context, |
223 | Error **errp); | |
2019ba0a HR |
224 | void blk_add_aio_context_notifier(BlockBackend *blk, |
225 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
226 | void (*detach_aio_context)(void *opaque), void *opaque); | |
227 | void blk_remove_aio_context_notifier(BlockBackend *blk, | |
228 | void (*attached_aio_context)(AioContext *, | |
229 | void *), | |
230 | void (*detach_aio_context)(void *), | |
231 | void *opaque); | |
3301f6c6 HR |
232 | void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify); |
233 | void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify); | |
4be74634 MA |
234 | void blk_io_plug(BlockBackend *blk); |
235 | void blk_io_unplug(BlockBackend *blk); | |
236 | BlockAcctStats *blk_get_stats(BlockBackend *blk); | |
281d22d8 HR |
237 | BlockBackendRootState *blk_get_root_state(BlockBackend *blk); |
238 | void blk_update_root_state(BlockBackend *blk); | |
b85114f8 | 239 | bool blk_get_detect_zeroes_from_root_state(BlockBackend *blk); |
38cb18f5 | 240 | int blk_get_open_flags_from_root_state(BlockBackend *blk); |
4be74634 MA |
241 | |
242 | void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk, | |
243 | BlockCompletionFunc *cb, void *opaque); | |
d004bd52 | 244 | int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset, |
f5a5ca79 | 245 | int bytes, BdrvRequestFlags flags); |
fe5c1355 | 246 | int blk_pwrite_compressed(BlockBackend *blk, int64_t offset, const void *buf, |
f5a5ca79 | 247 | int bytes); |
c80d8b06 | 248 | int blk_truncate(BlockBackend *blk, int64_t offset, bool exact, |
8c6242b6 | 249 | PreallocMode prealloc, BdrvRequestFlags flags, Error **errp); |
f5a5ca79 | 250 | int blk_pdiscard(BlockBackend *blk, int64_t offset, int bytes); |
1ef01253 HR |
251 | int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf, |
252 | int64_t pos, int size); | |
253 | int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size); | |
f0272c4d ET |
254 | int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz); |
255 | int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo); | |
ca78ecfa PL |
256 | BlockAIOCB *blk_abort_aio_request(BlockBackend *blk, |
257 | BlockCompletionFunc *cb, | |
258 | void *opaque, int ret); | |
4be74634 | 259 | |
97148076 KW |
260 | void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg); |
261 | void blk_io_limits_disable(BlockBackend *blk); | |
262 | void blk_io_limits_enable(BlockBackend *blk, const char *group); | |
263 | void blk_io_limits_update_group(BlockBackend *blk, const char *group); | |
ca2e2144 | 264 | void blk_set_force_allow_inactivate(BlockBackend *blk); |
97148076 | 265 | |
23d0ba93 FZ |
266 | void blk_register_buf(BlockBackend *blk, void *host, size_t size); |
267 | void blk_unregister_buf(BlockBackend *blk, void *host); | |
268 | ||
b5679fa4 FZ |
269 | int coroutine_fn blk_co_copy_range(BlockBackend *blk_in, int64_t off_in, |
270 | BlockBackend *blk_out, int64_t off_out, | |
67b51fb9 VSO |
271 | int bytes, BdrvRequestFlags read_flags, |
272 | BdrvRequestFlags write_flags); | |
b5679fa4 | 273 | |
5d3b4e99 VSO |
274 | const BdrvChild *blk_root(BlockBackend *blk); |
275 | ||
2b7bbdbd HR |
276 | int blk_make_empty(BlockBackend *blk, Error **errp); |
277 | ||
26f54e9a | 278 | #endif |