]>
Commit | Line | Data |
---|---|---|
26f54e9a MA |
1 | /* |
2 | * QEMU Block backends | |
3 | * | |
4 | * Copyright (C) 2014 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/typedefs.h" | |
26f54e9a | 17 | |
4be74634 MA |
18 | /* |
19 | * TODO Have to include block/block.h for a bunch of block layer | |
20 | * types. Unfortunately, this pulls in the whole BlockDriverState | |
21 | * API, which we don't want used by many BlockBackend users. Some of | |
22 | * the types belong here, and the rest should be split into a common | |
23 | * header and one for the BlockDriverState API. | |
24 | */ | |
25 | #include "block/block.h" | |
26 | ||
a7f53e26 MA |
27 | /* Callbacks for block device models */ |
28 | typedef struct BlockDevOps { | |
29 | /* | |
30 | * Runs when virtual media changed (monitor commands eject, change) | |
31 | * Argument load is true on load and false on eject. | |
32 | * Beware: doesn't run when a host device's physical media | |
33 | * changes. Sure would be useful if it did. | |
34 | * Device models with removable media must implement this callback. | |
35 | */ | |
36 | void (*change_media_cb)(void *opaque, bool load); | |
37 | /* | |
38 | * Runs when an eject request is issued from the monitor, the tray | |
39 | * is closed, and the medium is locked. | |
40 | * Device models that do not implement is_medium_locked will not need | |
41 | * this callback. Device models that can lock the medium or tray might | |
42 | * want to implement the callback and unlock the tray when "force" is | |
43 | * true, even if they do not support eject requests. | |
44 | */ | |
45 | void (*eject_request_cb)(void *opaque, bool force); | |
46 | /* | |
47 | * Is the virtual tray open? | |
48 | * Device models implement this only when the device has a tray. | |
49 | */ | |
50 | bool (*is_tray_open)(void *opaque); | |
51 | /* | |
52 | * Is the virtual medium locked into the device? | |
53 | * Device models implement this only when device has such a lock. | |
54 | */ | |
55 | bool (*is_medium_locked)(void *opaque); | |
56 | /* | |
57 | * Runs when the size changed (e.g. monitor command block_resize) | |
58 | */ | |
59 | void (*resize_cb)(void *opaque); | |
60 | } BlockDevOps; | |
61 | ||
26f54e9a | 62 | BlockBackend *blk_new(const char *name, Error **errp); |
7e7d56d9 | 63 | BlockBackend *blk_new_with_bs(const char *name, Error **errp); |
ca49a4fd HR |
64 | BlockBackend *blk_new_open(const char *name, const char *filename, |
65 | const char *reference, QDict *options, int flags, | |
66 | Error **errp); | |
f636ae85 | 67 | int blk_get_refcnt(BlockBackend *blk); |
26f54e9a MA |
68 | void blk_ref(BlockBackend *blk); |
69 | void blk_unref(BlockBackend *blk); | |
d8da3cef | 70 | void blk_remove_all_bs(void); |
26f54e9a MA |
71 | const char *blk_name(BlockBackend *blk); |
72 | BlockBackend *blk_by_name(const char *name); | |
73 | BlockBackend *blk_next(BlockBackend *blk); | |
74 | ||
7e7d56d9 | 75 | BlockDriverState *blk_bs(BlockBackend *blk); |
1c95f7e1 | 76 | void blk_remove_bs(BlockBackend *blk); |
0c3c36d6 | 77 | void blk_insert_bs(BlockBackend *blk, BlockDriverState *bs); |
7e7d56d9 | 78 | |
3e5a50d6 | 79 | void blk_hide_on_behalf_of_hmp_drive_del(BlockBackend *blk); |
7e7d56d9 | 80 | |
4be74634 | 81 | void blk_iostatus_enable(BlockBackend *blk); |
373340b2 HR |
82 | bool blk_iostatus_is_enabled(const BlockBackend *blk); |
83 | BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk); | |
84 | void blk_iostatus_disable(BlockBackend *blk); | |
85 | void blk_iostatus_reset(BlockBackend *blk); | |
86 | void blk_iostatus_set_err(BlockBackend *blk, int error); | |
4be74634 MA |
87 | int blk_attach_dev(BlockBackend *blk, void *dev); |
88 | void blk_attach_dev_nofail(BlockBackend *blk, void *dev); | |
89 | void blk_detach_dev(BlockBackend *blk, void *dev); | |
90 | void *blk_get_attached_dev(BlockBackend *blk); | |
91 | void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops, void *opaque); | |
92 | int blk_read(BlockBackend *blk, int64_t sector_num, uint8_t *buf, | |
93 | int nb_sectors); | |
94 | int blk_read_unthrottled(BlockBackend *blk, int64_t sector_num, uint8_t *buf, | |
95 | int nb_sectors); | |
96 | int blk_write(BlockBackend *blk, int64_t sector_num, const uint8_t *buf, | |
97 | int nb_sectors); | |
0df89e8e KW |
98 | int blk_write_zeroes(BlockBackend *blk, int64_t sector_num, |
99 | int nb_sectors, BdrvRequestFlags flags); | |
4be74634 MA |
100 | BlockAIOCB *blk_aio_write_zeroes(BlockBackend *blk, int64_t sector_num, |
101 | int nb_sectors, BdrvRequestFlags flags, | |
102 | BlockCompletionFunc *cb, void *opaque); | |
103 | int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count); | |
104 | int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count); | |
105 | int64_t blk_getlength(BlockBackend *blk); | |
106 | void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr); | |
1ef01253 | 107 | int64_t blk_nb_sectors(BlockBackend *blk); |
4be74634 MA |
108 | BlockAIOCB *blk_aio_readv(BlockBackend *blk, int64_t sector_num, |
109 | QEMUIOVector *iov, int nb_sectors, | |
110 | BlockCompletionFunc *cb, void *opaque); | |
111 | BlockAIOCB *blk_aio_writev(BlockBackend *blk, int64_t sector_num, | |
112 | QEMUIOVector *iov, int nb_sectors, | |
113 | BlockCompletionFunc *cb, void *opaque); | |
114 | BlockAIOCB *blk_aio_flush(BlockBackend *blk, | |
115 | BlockCompletionFunc *cb, void *opaque); | |
116 | BlockAIOCB *blk_aio_discard(BlockBackend *blk, | |
117 | int64_t sector_num, int nb_sectors, | |
118 | BlockCompletionFunc *cb, void *opaque); | |
119 | void blk_aio_cancel(BlockAIOCB *acb); | |
120 | void blk_aio_cancel_async(BlockAIOCB *acb); | |
121 | int blk_aio_multiwrite(BlockBackend *blk, BlockRequest *reqs, int num_reqs); | |
122 | int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf); | |
123 | BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf, | |
124 | BlockCompletionFunc *cb, void *opaque); | |
2bb0dce7 HR |
125 | int blk_co_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors); |
126 | int blk_co_flush(BlockBackend *blk); | |
4be74634 MA |
127 | int blk_flush(BlockBackend *blk); |
128 | int blk_flush_all(void); | |
97b0385a | 129 | void blk_drain(BlockBackend *blk); |
4be74634 | 130 | void blk_drain_all(void); |
373340b2 HR |
131 | void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error, |
132 | BlockdevOnError on_write_error); | |
4be74634 MA |
133 | BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read); |
134 | BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read, | |
135 | int error); | |
136 | void blk_error_action(BlockBackend *blk, BlockErrorAction action, | |
137 | bool is_read, int error); | |
138 | int blk_is_read_only(BlockBackend *blk); | |
139 | int blk_is_sg(BlockBackend *blk); | |
140 | int blk_enable_write_cache(BlockBackend *blk); | |
141 | void blk_set_enable_write_cache(BlockBackend *blk, bool wce); | |
2bb0dce7 | 142 | void blk_invalidate_cache(BlockBackend *blk, Error **errp); |
e031f750 | 143 | bool blk_is_inserted(BlockBackend *blk); |
db0284f8 | 144 | bool blk_is_available(BlockBackend *blk); |
4be74634 MA |
145 | void blk_lock_medium(BlockBackend *blk, bool locked); |
146 | void blk_eject(BlockBackend *blk, bool eject_flag); | |
147 | int blk_get_flags(BlockBackend *blk); | |
454057b7 | 148 | int blk_get_max_transfer_length(BlockBackend *blk); |
648296e0 | 149 | int blk_get_max_iov(BlockBackend *blk); |
4be74634 | 150 | void blk_set_guest_block_size(BlockBackend *blk, int align); |
f1c17521 | 151 | void *blk_try_blockalign(BlockBackend *blk, size_t size); |
4be74634 MA |
152 | void *blk_blockalign(BlockBackend *blk, size_t size); |
153 | bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp); | |
154 | void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason); | |
155 | void blk_op_block_all(BlockBackend *blk, Error *reason); | |
156 | void blk_op_unblock_all(BlockBackend *blk, Error *reason); | |
157 | AioContext *blk_get_aio_context(BlockBackend *blk); | |
158 | void blk_set_aio_context(BlockBackend *blk, AioContext *new_context); | |
2019ba0a HR |
159 | void blk_add_aio_context_notifier(BlockBackend *blk, |
160 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
161 | void (*detach_aio_context)(void *opaque), void *opaque); | |
162 | void blk_remove_aio_context_notifier(BlockBackend *blk, | |
163 | void (*attached_aio_context)(AioContext *, | |
164 | void *), | |
165 | void (*detach_aio_context)(void *), | |
166 | void *opaque); | |
3301f6c6 HR |
167 | void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify); |
168 | void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify); | |
4be74634 MA |
169 | void blk_io_plug(BlockBackend *blk); |
170 | void blk_io_unplug(BlockBackend *blk); | |
171 | BlockAcctStats *blk_get_stats(BlockBackend *blk); | |
281d22d8 HR |
172 | BlockBackendRootState *blk_get_root_state(BlockBackend *blk); |
173 | void blk_update_root_state(BlockBackend *blk); | |
38cb18f5 HR |
174 | void blk_apply_root_state(BlockBackend *blk, BlockDriverState *bs); |
175 | int blk_get_open_flags_from_root_state(BlockBackend *blk); | |
4be74634 MA |
176 | |
177 | void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk, | |
178 | BlockCompletionFunc *cb, void *opaque); | |
1ef01253 HR |
179 | int coroutine_fn blk_co_write_zeroes(BlockBackend *blk, int64_t sector_num, |
180 | int nb_sectors, BdrvRequestFlags flags); | |
181 | int blk_write_compressed(BlockBackend *blk, int64_t sector_num, | |
182 | const uint8_t *buf, int nb_sectors); | |
183 | int blk_truncate(BlockBackend *blk, int64_t offset); | |
184 | int blk_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors); | |
185 | int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf, | |
186 | int64_t pos, int size); | |
187 | int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size); | |
f0272c4d ET |
188 | int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz); |
189 | int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo); | |
ca78ecfa PL |
190 | BlockAIOCB *blk_abort_aio_request(BlockBackend *blk, |
191 | BlockCompletionFunc *cb, | |
192 | void *opaque, int ret); | |
4be74634 | 193 | |
26f54e9a | 194 | #endif |