1
2
3
4
5
6
7
8
9
10
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
21
22
23
24
25
26#include "block/block.h"
27
28
29typedef struct BlockDevOps {
30
31
32
33
34
35
36
37 void (*change_media_cb)(void *opaque, bool load, Error **errp);
38
39
40
41
42
43
44
45
46 void (*eject_request_cb)(void *opaque, bool force);
47
48
49
50
51 bool (*is_tray_open)(void *opaque);
52
53
54
55
56 bool (*is_medium_locked)(void *opaque);
57
58
59
60 void (*resize_cb)(void *opaque);
61
62
63
64 void (*drained_begin)(void *opaque);
65
66
67
68 void (*drained_end)(void *opaque);
69} BlockDevOps;
70
71
72
73
74
75typedef struct BlockBackendPublic {
76 ThrottleGroupMember throttle_group_member;
77} BlockBackendPublic;
78
79BlockBackend *blk_new(AioContext *ctx, uint64_t perm, uint64_t shared_perm);
80BlockBackend *blk_new_open(const char *filename, const char *reference,
81 QDict *options, int flags, Error **errp);
82int blk_get_refcnt(BlockBackend *blk);
83void blk_ref(BlockBackend *blk);
84void blk_unref(BlockBackend *blk);
85void blk_remove_all_bs(void);
86const char *blk_name(const BlockBackend *blk);
87BlockBackend *blk_by_name(const char *name);
88BlockBackend *blk_next(BlockBackend *blk);
89BlockBackend *blk_all_next(BlockBackend *blk);
90bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp);
91void monitor_remove_blk(BlockBackend *blk);
92
93BlockBackendPublic *blk_get_public(BlockBackend *blk);
94BlockBackend *blk_by_public(BlockBackendPublic *public);
95
96BlockDriverState *blk_bs(BlockBackend *blk);
97void blk_remove_bs(BlockBackend *blk);
98int blk_insert_bs(BlockBackend *blk, BlockDriverState *bs, Error **errp);
99bool bdrv_has_blk(BlockDriverState *bs);
100bool bdrv_is_root_node(BlockDriverState *bs);
101int blk_set_perm(BlockBackend *blk, uint64_t perm, uint64_t shared_perm,
102 Error **errp);
103void blk_get_perm(BlockBackend *blk, uint64_t *perm, uint64_t *shared_perm);
104
105void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow);
106void blk_set_allow_aio_context_change(BlockBackend *blk, bool allow);
107void blk_set_disable_request_queuing(BlockBackend *blk, bool disable);
108void blk_iostatus_enable(BlockBackend *blk);
109bool blk_iostatus_is_enabled(const BlockBackend *blk);
110BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk);
111void blk_iostatus_disable(BlockBackend *blk);
112void blk_iostatus_reset(BlockBackend *blk);
113void blk_iostatus_set_err(BlockBackend *blk, int error);
114int blk_attach_dev(BlockBackend *blk, DeviceState *dev);
115void blk_detach_dev(BlockBackend *blk, DeviceState *dev);
116DeviceState *blk_get_attached_dev(BlockBackend *blk);
117char *blk_get_attached_dev_id(BlockBackend *blk);
118BlockBackend *blk_by_dev(void *dev);
119BlockBackend *blk_by_qdev_id(const char *id, Error **errp);
120void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops, void *opaque);
121int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset,
122 unsigned int bytes, QEMUIOVector *qiov,
123 BdrvRequestFlags flags);
124int coroutine_fn blk_co_pwritev_part(BlockBackend *blk, int64_t offset,
125 unsigned int bytes,
126 QEMUIOVector *qiov, size_t qiov_offset,
127 BdrvRequestFlags flags);
128int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
129 unsigned int bytes, QEMUIOVector *qiov,
130 BdrvRequestFlags flags);
131
132static inline int coroutine_fn blk_co_pread(BlockBackend *blk, int64_t offset,
133 unsigned int bytes, void *buf,
134 BdrvRequestFlags flags)
135{
136 QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes);
137
138 return blk_co_preadv(blk, offset, bytes, &qiov, flags);
139}
140
141static inline int coroutine_fn blk_co_pwrite(BlockBackend *blk, int64_t offset,
142 unsigned int bytes, void *buf,
143 BdrvRequestFlags flags)
144{
145 QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes);
146
147 return blk_co_pwritev(blk, offset, bytes, &qiov, flags);
148}
149
150int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset,
151 int bytes, BdrvRequestFlags flags);
152BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
153 int bytes, BdrvRequestFlags flags,
154 BlockCompletionFunc *cb, void *opaque);
155int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags);
156int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int bytes);
157int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int bytes,
158 BdrvRequestFlags flags);
159int64_t blk_getlength(BlockBackend *blk);
160void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr);
161int64_t blk_nb_sectors(BlockBackend *blk);
162BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
163 QEMUIOVector *qiov, BdrvRequestFlags flags,
164 BlockCompletionFunc *cb, void *opaque);
165BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
166 QEMUIOVector *qiov, BdrvRequestFlags flags,
167 BlockCompletionFunc *cb, void *opaque);
168BlockAIOCB *blk_aio_flush(BlockBackend *blk,
169 BlockCompletionFunc *cb, void *opaque);
170BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk, int64_t offset, int bytes,
171 BlockCompletionFunc *cb, void *opaque);
172void blk_aio_cancel(BlockAIOCB *acb);
173void blk_aio_cancel_async(BlockAIOCB *acb);
174int blk_co_ioctl(BlockBackend *blk, unsigned long int req, void *buf);
175int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf);
176BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
177 BlockCompletionFunc *cb, void *opaque);
178int blk_co_pdiscard(BlockBackend *blk, int64_t offset, int bytes);
179int blk_co_flush(BlockBackend *blk);
180int blk_flush(BlockBackend *blk);
181int blk_commit_all(void);
182void blk_inc_in_flight(BlockBackend *blk);
183void blk_dec_in_flight(BlockBackend *blk);
184void blk_drain(BlockBackend *blk);
185void blk_drain_all(void);
186void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
187 BlockdevOnError on_write_error);
188BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read);
189BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
190 int error);
191void blk_error_action(BlockBackend *blk, BlockErrorAction action,
192 bool is_read, int error);
193bool blk_is_read_only(BlockBackend *blk);
194bool blk_is_sg(BlockBackend *blk);
195bool blk_enable_write_cache(BlockBackend *blk);
196void blk_set_enable_write_cache(BlockBackend *blk, bool wce);
197void blk_invalidate_cache(BlockBackend *blk, Error **errp);
198bool blk_is_inserted(BlockBackend *blk);
199bool blk_is_available(BlockBackend *blk);
200void blk_lock_medium(BlockBackend *blk, bool locked);
201void blk_eject(BlockBackend *blk, bool eject_flag);
202int blk_get_flags(BlockBackend *blk);
203uint32_t blk_get_request_alignment(BlockBackend *blk);
204uint32_t blk_get_max_transfer(BlockBackend *blk);
205int blk_get_max_iov(BlockBackend *blk);
206void blk_set_guest_block_size(BlockBackend *blk, int align);
207void *blk_try_blockalign(BlockBackend *blk, size_t size);
208void *blk_blockalign(BlockBackend *blk, size_t size);
209bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp);
210void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason);
211void blk_op_block_all(BlockBackend *blk, Error *reason);
212void blk_op_unblock_all(BlockBackend *blk, Error *reason);
213AioContext *blk_get_aio_context(BlockBackend *blk);
214int blk_set_aio_context(BlockBackend *blk, AioContext *new_context,
215 Error **errp);
216void blk_add_aio_context_notifier(BlockBackend *blk,
217 void (*attached_aio_context)(AioContext *new_context, void *opaque),
218 void (*detach_aio_context)(void *opaque), void *opaque);
219void blk_remove_aio_context_notifier(BlockBackend *blk,
220 void (*attached_aio_context)(AioContext *,
221 void *),
222 void (*detach_aio_context)(void *),
223 void *opaque);
224void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify);
225void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify);
226void blk_io_plug(BlockBackend *blk);
227void blk_io_unplug(BlockBackend *blk);
228BlockAcctStats *blk_get_stats(BlockBackend *blk);
229BlockBackendRootState *blk_get_root_state(BlockBackend *blk);
230void blk_update_root_state(BlockBackend *blk);
231bool blk_get_detect_zeroes_from_root_state(BlockBackend *blk);
232int blk_get_open_flags_from_root_state(BlockBackend *blk);
233
234void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
235 BlockCompletionFunc *cb, void *opaque);
236int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
237 int bytes, BdrvRequestFlags flags);
238int blk_pwrite_compressed(BlockBackend *blk, int64_t offset, const void *buf,
239 int bytes);
240int blk_truncate(BlockBackend *blk, int64_t offset, bool exact,
241 PreallocMode prealloc, Error **errp);
242int blk_pdiscard(BlockBackend *blk, int64_t offset, int bytes);
243int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
244 int64_t pos, int size);
245int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size);
246int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz);
247int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo);
248BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
249 BlockCompletionFunc *cb,
250 void *opaque, int ret);
251
252void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg);
253void blk_io_limits_disable(BlockBackend *blk);
254void blk_io_limits_enable(BlockBackend *blk, const char *group);
255void blk_io_limits_update_group(BlockBackend *blk, const char *group);
256void blk_set_force_allow_inactivate(BlockBackend *blk);
257
258void blk_register_buf(BlockBackend *blk, void *host, size_t size);
259void blk_unregister_buf(BlockBackend *blk, void *host);
260
261int coroutine_fn blk_co_copy_range(BlockBackend *blk_in, int64_t off_in,
262 BlockBackend *blk_out, int64_t off_out,
263 int bytes, BdrvRequestFlags read_flags,
264 BdrvRequestFlags write_flags);
265
266const BdrvChild *blk_root(BlockBackend *blk);
267
268#endif
269