]>
Commit | Line | Data |
---|---|---|
faf07963 PB |
1 | #ifndef BLOCK_H |
2 | #define BLOCK_H | |
3 | ||
737e150e | 4 | #include "block/aio.h" |
daf015ef | 5 | #include "qemu/iov.h" |
1de7afc9 | 6 | #include "qemu/option.h" |
10817bf0 | 7 | #include "qemu/coroutine.h" |
5366d0c8 | 8 | #include "block/accounting.h" |
ebab2259 | 9 | #include "block/dirty-bitmap.h" |
7b1b5d19 | 10 | #include "qapi/qmp/qobject.h" |
2f0c9fe6 | 11 | #include "qapi-types.h" |
78f9dc85 | 12 | #include "qemu/hbitmap.h" |
a76bab49 | 13 | |
faf07963 | 14 | /* block.c */ |
faf07963 | 15 | typedef struct BlockDriver BlockDriver; |
2f0c9fe6 | 16 | typedef struct BlockJob BlockJob; |
b4b059f6 | 17 | typedef struct BdrvChild BdrvChild; |
f3930ed0 | 18 | typedef struct BdrvChildRole BdrvChildRole; |
c55a832f | 19 | typedef struct BlockJobTxn BlockJobTxn; |
faf07963 | 20 | |
faf07963 PB |
21 | typedef struct BlockDriverInfo { |
22 | /* in bytes, 0 if irrelevant */ | |
23 | int cluster_size; | |
24 | /* offset at which the VM state can be saved (0 if not possible) */ | |
25 | int64_t vm_state_offset; | |
64c79160 | 26 | bool is_dirty; |
e1a5c4be PL |
27 | /* |
28 | * True if unallocated blocks read back as zeroes. This is equivalent | |
b6af0975 | 29 | * to the LBPRZ flag in the SCSI logical block provisioning page. |
e1a5c4be PL |
30 | */ |
31 | bool unallocated_blocks_are_zero; | |
32 | /* | |
33 | * True if the driver can optimize writing zeroes by unmapping | |
34 | * sectors. This is equivalent to the BLKDISCARDZEROES ioctl in Linux | |
35 | * with the difference that in qemu a discard is allowed to silently | |
74021bc4 | 36 | * fail. Therefore we have to use bdrv_pwrite_zeroes with the |
e1a5c4be PL |
37 | * BDRV_REQ_MAY_UNMAP flag for an optimized zero write with unmapping. |
38 | * After this call the driver has to guarantee that the contents read | |
39 | * back as zero. It is additionally required that the block device is | |
40 | * opened with BDRV_O_UNMAP flag for this to work. | |
41 | */ | |
42 | bool can_write_zeroes_with_unmap; | |
85f49cad FZ |
43 | /* |
44 | * True if this block driver only supports compressed writes | |
45 | */ | |
46 | bool needs_compressed_writes; | |
faf07963 PB |
47 | } BlockDriverInfo; |
48 | ||
f8111c24 DXW |
49 | typedef struct BlockFragInfo { |
50 | uint64_t allocated_clusters; | |
51 | uint64_t total_clusters; | |
52 | uint64_t fragmented_clusters; | |
e6439d78 | 53 | uint64_t compressed_clusters; |
f8111c24 DXW |
54 | } BlockFragInfo; |
55 | ||
6faac15f | 56 | typedef enum { |
9568b511 WC |
57 | BDRV_REQ_COPY_ON_READ = 0x1, |
58 | BDRV_REQ_ZERO_WRITE = 0x2, | |
d32f35cb PL |
59 | /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver |
60 | * is allowed to optimize a write zeroes request by unmapping (discarding) | |
61 | * blocks if it is guaranteed that the result will read back as | |
62 | * zeroes. The flag is only passed to the driver if the block device is | |
63 | * opened with BDRV_O_UNMAP. | |
64 | */ | |
9568b511 | 65 | BDRV_REQ_MAY_UNMAP = 0x4, |
61408b25 | 66 | BDRV_REQ_NO_SERIALISING = 0x8, |
bfd18d1e | 67 | BDRV_REQ_FUA = 0x10, |
29a298af | 68 | BDRV_REQ_WRITE_COMPRESSED = 0x20, |
fa166538 EB |
69 | |
70 | /* Mask of valid flags */ | |
29a298af | 71 | BDRV_REQ_MASK = 0x3f, |
6faac15f PL |
72 | } BdrvRequestFlags; |
73 | ||
892b7de8 ET |
74 | typedef struct BlockSizes { |
75 | uint32_t phys; | |
76 | uint32_t log; | |
77 | } BlockSizes; | |
78 | ||
79 | typedef struct HDGeometry { | |
80 | uint32_t heads; | |
81 | uint32_t sectors; | |
82 | uint32_t cylinders; | |
83 | } HDGeometry; | |
84 | ||
faf07963 | 85 | #define BDRV_O_RDWR 0x0002 |
faf07963 | 86 | #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ |
8bfea15d | 87 | #define BDRV_O_TEMPORARY 0x0010 /* delete the file after use */ |
9f7965c7 | 88 | #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ |
5c6c3a6c | 89 | #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */ |
b783e409 | 90 | #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ |
016f5cf6 | 91 | #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */ |
53fec9d3 | 92 | #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */ |
04c01a5c | 93 | #define BDRV_O_INACTIVE 0x0800 /* consistency hint for migration handoff */ |
058f8f16 | 94 | #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */ |
be028adc | 95 | #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */ |
9e8f1835 | 96 | #define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */ |
2e40134b HR |
97 | #define BDRV_O_PROTOCOL 0x8000 /* if no block driver is explicitly given: |
98 | select an appropriate protocol driver, | |
99 | ignoring the format layer */ | |
abb06c5a | 100 | #define BDRV_O_NO_IO 0x10000 /* don't initialize for I/O */ |
9f7965c7 | 101 | |
61de4c68 | 102 | #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_NO_FLUSH) |
faf07963 | 103 | |
54861b92 KW |
104 | |
105 | /* Option names of options parsed by the block layer */ | |
106 | ||
107 | #define BDRV_OPT_CACHE_WB "cache.writeback" | |
108 | #define BDRV_OPT_CACHE_DIRECT "cache.direct" | |
109 | #define BDRV_OPT_CACHE_NO_FLUSH "cache.no-flush" | |
110 | ||
111 | ||
6ea44308 | 112 | #define BDRV_SECTOR_BITS 9 |
c63782cb | 113 | #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS) |
3abbc4d9 | 114 | #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1) |
6ea44308 | 115 | |
75af1f34 PL |
116 | #define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \ |
117 | INT_MAX >> BDRV_SECTOR_BITS) | |
118 | ||
705be728 FZ |
119 | /* |
120 | * Allocation status flags | |
67a0fd2a | 121 | * BDRV_BLOCK_DATA: data is read from a file returned by bdrv_get_block_status. |
4333bb71 | 122 | * BDRV_BLOCK_ZERO: sectors read as zero |
67a0fd2a FZ |
123 | * BDRV_BLOCK_OFFSET_VALID: sector stored as raw data in a file returned by |
124 | * bdrv_get_block_status. | |
e88ae226 KW |
125 | * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this |
126 | * layer (as opposed to the backing file) | |
92bc50a5 PL |
127 | * BDRV_BLOCK_RAW: used internally to indicate that the request |
128 | * was answered by the raw driver and that one | |
129 | * should look in bs->file directly. | |
4333bb71 PB |
130 | * |
131 | * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in | |
132 | * bs->file where sector data can be read from as raw data. | |
133 | * | |
134 | * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present. | |
135 | * | |
136 | * DATA ZERO OFFSET_VALID | |
137 | * t t t sectors read as zero, bs->file is zero at offset | |
138 | * t f t sectors read as valid from bs->file at offset | |
139 | * f t t sectors preallocated, read as zero, bs->file not | |
140 | * necessarily zero at offset | |
141 | * f f t sectors preallocated but read from backing_hd, | |
142 | * bs->file contains garbage at offset | |
143 | * t t f sectors preallocated, read as zero, unknown offset | |
144 | * t f f sectors read from unknown file or offset | |
145 | * f t f not allocated or unknown offset, read as zero | |
146 | * f f f not allocated or unknown offset, read from backing_hd | |
147 | */ | |
e88ae226 KW |
148 | #define BDRV_BLOCK_DATA 0x01 |
149 | #define BDRV_BLOCK_ZERO 0x02 | |
150 | #define BDRV_BLOCK_OFFSET_VALID 0x04 | |
151 | #define BDRV_BLOCK_RAW 0x08 | |
152 | #define BDRV_BLOCK_ALLOCATED 0x10 | |
4333bb71 PB |
153 | #define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK |
154 | ||
e971aa12 JC |
155 | typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue; |
156 | ||
157 | typedef struct BDRVReopenState { | |
158 | BlockDriverState *bs; | |
159 | int flags; | |
4d2cb092 | 160 | QDict *options; |
145f598e | 161 | QDict *explicit_options; |
e971aa12 JC |
162 | void *opaque; |
163 | } BDRVReopenState; | |
164 | ||
8574575f FZ |
165 | /* |
166 | * Block operation types | |
167 | */ | |
168 | typedef enum BlockOpType { | |
169 | BLOCK_OP_TYPE_BACKUP_SOURCE, | |
170 | BLOCK_OP_TYPE_BACKUP_TARGET, | |
171 | BLOCK_OP_TYPE_CHANGE, | |
bb00021d FZ |
172 | BLOCK_OP_TYPE_COMMIT_SOURCE, |
173 | BLOCK_OP_TYPE_COMMIT_TARGET, | |
8574575f FZ |
174 | BLOCK_OP_TYPE_DATAPLANE, |
175 | BLOCK_OP_TYPE_DRIVE_DEL, | |
176 | BLOCK_OP_TYPE_EJECT, | |
177 | BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, | |
178 | BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, | |
179 | BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, | |
05e4d14b | 180 | BLOCK_OP_TYPE_MIRROR_SOURCE, |
e40e5027 | 181 | BLOCK_OP_TYPE_MIRROR_TARGET, |
8574575f FZ |
182 | BLOCK_OP_TYPE_RESIZE, |
183 | BLOCK_OP_TYPE_STREAM, | |
09158f00 | 184 | BLOCK_OP_TYPE_REPLACE, |
8574575f FZ |
185 | BLOCK_OP_TYPE_MAX, |
186 | } BlockOpType; | |
e971aa12 | 187 | |
d15e5465 LC |
188 | void bdrv_info_print(Monitor *mon, const QObject *data); |
189 | void bdrv_info(Monitor *mon, QObject **ret_data); | |
218a536a LC |
190 | void bdrv_stats_print(Monitor *mon, const QObject *data); |
191 | void bdrv_info_stats(Monitor *mon, QObject **ret_data); | |
faf07963 | 192 | |
0563e191 | 193 | /* disk I/O throttling */ |
faf07963 | 194 | void bdrv_init(void); |
eb852011 | 195 | void bdrv_init_with_whitelist(void); |
e6ff69bf | 196 | bool bdrv_uses_whitelist(void); |
98289620 | 197 | BlockDriver *bdrv_find_protocol(const char *filename, |
b65a5e12 HR |
198 | bool allow_protocol_prefix, |
199 | Error **errp); | |
faf07963 | 200 | BlockDriver *bdrv_find_format(const char *format_name); |
0e7e1989 | 201 | int bdrv_create(BlockDriver *drv, const char* filename, |
c282e1fd CL |
202 | QemuOpts *opts, Error **errp); |
203 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp); | |
e4e9986b | 204 | BlockDriverState *bdrv_new(void); |
8802d1fd | 205 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top); |
3f09bfbc KW |
206 | void bdrv_replace_in_backing_chain(BlockDriverState *old, |
207 | BlockDriverState *new); | |
208 | ||
baf5602e | 209 | int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough); |
9e8f1835 | 210 | int bdrv_parse_discard_flags(const char *mode, int *flags); |
b4b059f6 KW |
211 | BdrvChild *bdrv_open_child(const char *filename, |
212 | QDict *options, const char *bdref_key, | |
213 | BlockDriverState* parent, | |
214 | const BdrvChildRole *child_role, | |
215 | bool allow_none, Error **errp); | |
8d24cce1 | 216 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd); |
d9b7b057 KW |
217 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
218 | const char *bdref_key, Error **errp); | |
5b363937 HR |
219 | BlockDriverState *bdrv_open(const char *filename, const char *reference, |
220 | QDict *options, int flags, Error **errp); | |
e971aa12 | 221 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
4d2cb092 KW |
222 | BlockDriverState *bs, |
223 | QDict *options, int flags); | |
e971aa12 JC |
224 | int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp); |
225 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp); | |
226 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, | |
227 | BlockReopenQueue *queue, Error **errp); | |
228 | void bdrv_reopen_commit(BDRVReopenState *reopen_state); | |
229 | void bdrv_reopen_abort(BDRVReopenState *reopen_state); | |
fbcbbf4e | 230 | int bdrv_read(BdrvChild *child, int64_t sector_num, |
faf07963 | 231 | uint8_t *buf, int nb_sectors); |
18d51c4b | 232 | int bdrv_write(BdrvChild *child, int64_t sector_num, |
faf07963 | 233 | const uint8_t *buf, int nb_sectors); |
720ff280 | 234 | int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset, |
74021bc4 | 235 | int count, BdrvRequestFlags flags); |
720ff280 | 236 | int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags); |
cf2ab8fc KW |
237 | int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes); |
238 | int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov); | |
d9ca2ea2 KW |
239 | int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes); |
240 | int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov); | |
241 | int bdrv_pwrite_sync(BdrvChild *child, int64_t offset, | |
242 | const void *buf, int count); | |
28b04a8f KW |
243 | int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num, |
244 | int nb_sectors, QEMUIOVector *qiov); | |
25ec177d KW |
245 | int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num, |
246 | int nb_sectors, QEMUIOVector *qiov); | |
f08f2dda SH |
247 | /* |
248 | * Efficiently zero a region of the disk image. Note that this is a regular | |
249 | * I/O request like read or write and should have a reasonable size. This | |
250 | * function is not suitable for zeroing the entire image in a single request | |
251 | * because it may allocate memory for the entire region. | |
252 | */ | |
a03ef88f KW |
253 | int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset, |
254 | int count, BdrvRequestFlags flags); | |
e8a6bb9c MT |
255 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, |
256 | const char *backing_file); | |
f198fd1c | 257 | int bdrv_get_backing_file_depth(BlockDriverState *bs); |
91af7014 | 258 | void bdrv_refresh_filename(BlockDriverState *bs); |
faf07963 | 259 | int bdrv_truncate(BlockDriverState *bs, int64_t offset); |
65a9bb25 | 260 | int64_t bdrv_nb_sectors(BlockDriverState *bs); |
faf07963 | 261 | int64_t bdrv_getlength(BlockDriverState *bs); |
4a1d5e1f | 262 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); |
96b8f136 | 263 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); |
3baca891 | 264 | void bdrv_refresh_limits(BlockDriverState *bs, Error **errp); |
faf07963 | 265 | int bdrv_commit(BlockDriverState *bs); |
756e6736 KW |
266 | int bdrv_change_backing_file(BlockDriverState *bs, |
267 | const char *backing_file, const char *backing_fmt); | |
5efa9d5a | 268 | void bdrv_register(BlockDriver *bdrv); |
6ebdcee2 | 269 | int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, |
54e26900 JC |
270 | BlockDriverState *base, |
271 | const char *backing_file_str); | |
6ebdcee2 JC |
272 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, |
273 | BlockDriverState *bs); | |
79fac568 | 274 | BlockDriverState *bdrv_find_base(BlockDriverState *bs); |
5efa9d5a | 275 | |
e076f338 KW |
276 | |
277 | typedef struct BdrvCheckResult { | |
278 | int corruptions; | |
279 | int leaks; | |
280 | int check_errors; | |
ccf34716 KW |
281 | int corruptions_fixed; |
282 | int leaks_fixed; | |
c6bb9ad1 | 283 | int64_t image_end_offset; |
f8111c24 | 284 | BlockFragInfo bfi; |
e076f338 KW |
285 | } BdrvCheckResult; |
286 | ||
4534ff54 KW |
287 | typedef enum { |
288 | BDRV_FIX_LEAKS = 1, | |
289 | BDRV_FIX_ERRORS = 2, | |
290 | } BdrvCheckMode; | |
291 | ||
292 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix); | |
e076f338 | 293 | |
77485434 HR |
294 | /* The units of offset and total_work_size may be chosen arbitrarily by the |
295 | * block driver; total_work_size may change during the course of the amendment | |
296 | * operation */ | |
297 | typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset, | |
8b13976d | 298 | int64_t total_work_size, void *opaque); |
77485434 | 299 | int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts, |
8b13976d | 300 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque); |
6f176b48 | 301 | |
f6186f49 | 302 | /* external snapshots */ |
212a5a8f BC |
303 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
304 | BlockDriverState *candidate); | |
305 | bool bdrv_is_first_non_filter(BlockDriverState *candidate); | |
f6186f49 | 306 | |
09158f00 | 307 | /* check if a named node can be replaced when doing drive-mirror */ |
e12f3784 WC |
308 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
309 | const char *node_name, Error **errp); | |
09158f00 | 310 | |
faf07963 | 311 | /* async block I/O */ |
ebb7af21 | 312 | BlockAIOCB *bdrv_aio_readv(BdrvChild *child, int64_t sector_num, |
7c84b1b8 | 313 | QEMUIOVector *iov, int nb_sectors, |
097310b5 | 314 | BlockCompletionFunc *cb, void *opaque); |
0d1049c7 | 315 | BlockAIOCB *bdrv_aio_writev(BdrvChild *child, int64_t sector_num, |
7c84b1b8 | 316 | QEMUIOVector *iov, int nb_sectors, |
097310b5 | 317 | BlockCompletionFunc *cb, void *opaque); |
7c84b1b8 | 318 | BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs, |
097310b5 | 319 | BlockCompletionFunc *cb, void *opaque); |
60ebac16 EB |
320 | BlockAIOCB *bdrv_aio_pdiscard(BlockDriverState *bs, |
321 | int64_t offset, int count, | |
322 | BlockCompletionFunc *cb, void *opaque); | |
7c84b1b8 MA |
323 | void bdrv_aio_cancel(BlockAIOCB *acb); |
324 | void bdrv_aio_cancel_async(BlockAIOCB *acb); | |
faf07963 | 325 | |
7d780669 | 326 | /* sg packet commands */ |
221f715d | 327 | int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); |
7c84b1b8 | 328 | BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, |
221f715d | 329 | unsigned long int req, void *buf, |
097310b5 | 330 | BlockCompletionFunc *cb, void *opaque); |
7d780669 | 331 | |
0f15423c | 332 | /* Invalidate any cached metadata used by image formats */ |
5a8a30db KW |
333 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp); |
334 | void bdrv_invalidate_cache_all(Error **errp); | |
76b1c7fe | 335 | int bdrv_inactivate_all(void); |
0f15423c | 336 | |
faf07963 | 337 | /* Ensure contents are flushed to disk. */ |
205ef796 | 338 | int bdrv_flush(BlockDriverState *bs); |
07f07615 | 339 | int coroutine_fn bdrv_co_flush(BlockDriverState *bs); |
2bc93fed | 340 | void bdrv_close_all(void); |
5b98db0a | 341 | void bdrv_drain(BlockDriverState *bs); |
a77fd4bb | 342 | void coroutine_fn bdrv_co_drain(BlockDriverState *bs); |
922453bc | 343 | void bdrv_drain_all(void); |
c6ca28d6 | 344 | |
0c51a893 | 345 | int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int count); |
9f1963b3 | 346 | int bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset, int count); |
3ac21627 | 347 | int bdrv_has_zero_init_1(BlockDriverState *bs); |
f2feebbd | 348 | int bdrv_has_zero_init(BlockDriverState *bs); |
4ce78691 PL |
349 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs); |
350 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs); | |
b6b8a333 | 351 | int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num, |
67a0fd2a FZ |
352 | int nb_sectors, int *pnum, |
353 | BlockDriverState **file); | |
ba3f0e25 FZ |
354 | int64_t bdrv_get_block_status_above(BlockDriverState *bs, |
355 | BlockDriverState *base, | |
356 | int64_t sector_num, | |
67a0fd2a FZ |
357 | int nb_sectors, int *pnum, |
358 | BlockDriverState **file); | |
f58c7b35 | 359 | int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, |
39aa9a12 | 360 | int *pnum); |
b35b2bba MR |
361 | int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base, |
362 | int64_t sector_num, int nb_sectors, int *pnum); | |
faf07963 | 363 | |
54115412 EB |
364 | bool bdrv_is_read_only(BlockDriverState *bs); |
365 | bool bdrv_is_sg(BlockDriverState *bs); | |
e031f750 | 366 | bool bdrv_is_inserted(BlockDriverState *bs); |
faf07963 | 367 | int bdrv_media_changed(BlockDriverState *bs); |
025e849a | 368 | void bdrv_lock_medium(BlockDriverState *bs, bool locked); |
f36f3949 | 369 | void bdrv_eject(BlockDriverState *bs, bool eject_flag); |
f8d6bba1 | 370 | const char *bdrv_get_format_name(BlockDriverState *bs); |
dc364f4c | 371 | BlockDriverState *bdrv_find_node(const char *node_name); |
d5a8ee60 | 372 | BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp); |
12d3ba82 BC |
373 | BlockDriverState *bdrv_lookup_bs(const char *device, |
374 | const char *node_name, | |
375 | Error **errp); | |
5a6684d2 | 376 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base); |
04df765a | 377 | BlockDriverState *bdrv_next_node(BlockDriverState *bs); |
88be7b4b KW |
378 | |
379 | typedef struct BdrvNextIterator { | |
380 | enum { | |
381 | BDRV_NEXT_BACKEND_ROOTS, | |
382 | BDRV_NEXT_MONITOR_OWNED, | |
383 | } phase; | |
384 | BlockBackend *blk; | |
385 | BlockDriverState *bs; | |
386 | } BdrvNextIterator; | |
387 | ||
388 | BlockDriverState *bdrv_first(BdrvNextIterator *it); | |
389 | BlockDriverState *bdrv_next(BdrvNextIterator *it); | |
390 | ||
262b4e8f | 391 | BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs); |
54115412 EB |
392 | bool bdrv_is_encrypted(BlockDriverState *bs); |
393 | bool bdrv_key_required(BlockDriverState *bs); | |
faf07963 | 394 | int bdrv_set_key(BlockDriverState *bs, const char *key); |
4d2855a3 | 395 | void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp); |
c0f4ce77 | 396 | int bdrv_query_missing_keys(void); |
faf07963 PB |
397 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
398 | void *opaque); | |
20a9e77d | 399 | const char *bdrv_get_node_name(const BlockDriverState *bs); |
bfb197e0 | 400 | const char *bdrv_get_device_name(const BlockDriverState *bs); |
9b2aa84f | 401 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs); |
c8433287 | 402 | int bdrv_get_flags(BlockDriverState *bs); |
faf07963 | 403 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); |
eae041fe | 404 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs); |
244483e6 KW |
405 | void bdrv_round_sectors_to_clusters(BlockDriverState *bs, |
406 | int64_t sector_num, int nb_sectors, | |
407 | int64_t *cluster_sector_num, | |
408 | int *cluster_nb_sectors); | |
343bded4 | 409 | void bdrv_round_to_clusters(BlockDriverState *bs, |
244483e6 KW |
410 | int64_t offset, unsigned int bytes, |
411 | int64_t *cluster_offset, | |
412 | unsigned int *cluster_bytes); | |
faf07963 | 413 | |
045df330 | 414 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs); |
faf07963 PB |
415 | void bdrv_get_backing_filename(BlockDriverState *bs, |
416 | char *filename, int filename_size); | |
dc5a1371 | 417 | void bdrv_get_full_backing_filename(BlockDriverState *bs, |
9f07429e | 418 | char *dest, size_t sz, Error **errp); |
0a82855a HR |
419 | void bdrv_get_full_backing_filename_from_filename(const char *backed, |
420 | const char *backing, | |
9f07429e HR |
421 | char *dest, size_t sz, |
422 | Error **errp); | |
199630b6 | 423 | int bdrv_is_snapshot(BlockDriverState *bs); |
faf07963 | 424 | |
5c98415b | 425 | int path_has_protocol(const char *path); |
faf07963 PB |
426 | int path_is_absolute(const char *path); |
427 | void path_combine(char *dest, int dest_size, | |
428 | const char *base_path, | |
429 | const char *filename); | |
430 | ||
5ddda0b8 | 431 | int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); |
cf8074b3 | 432 | int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); |
45566e9c CH |
433 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
434 | int64_t pos, int size); | |
178e08a5 | 435 | |
45566e9c CH |
436 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
437 | int64_t pos, int size); | |
178e08a5 | 438 | |
d92ada22 LC |
439 | void bdrv_img_create(const char *filename, const char *fmt, |
440 | const char *base_filename, const char *base_fmt, | |
f382d43a MR |
441 | char *options, uint64_t img_size, int flags, |
442 | Error **errp, bool quiet); | |
f88e1a42 | 443 | |
339064d5 KW |
444 | /* Returns the alignment in bytes that is required so that no bounce buffer |
445 | * is required throughout the stack */ | |
4196d2f0 DL |
446 | size_t bdrv_min_mem_align(BlockDriverState *bs); |
447 | /* Returns optimal alignment in bytes for bounce buffer */ | |
339064d5 | 448 | size_t bdrv_opt_mem_align(BlockDriverState *bs); |
ba5b7ad4 | 449 | void *qemu_blockalign(BlockDriverState *bs, size_t size); |
9ebd8448 | 450 | void *qemu_blockalign0(BlockDriverState *bs, size_t size); |
7d2a35cc | 451 | void *qemu_try_blockalign(BlockDriverState *bs, size_t size); |
9ebd8448 | 452 | void *qemu_try_blockalign0(BlockDriverState *bs, size_t size); |
c53b1c51 | 453 | bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov); |
ba5b7ad4 | 454 | |
53fec9d3 SH |
455 | void bdrv_enable_copy_on_read(BlockDriverState *bs); |
456 | void bdrv_disable_copy_on_read(BlockDriverState *bs); | |
457 | ||
9fcb0251 FZ |
458 | void bdrv_ref(BlockDriverState *bs); |
459 | void bdrv_unref(BlockDriverState *bs); | |
33a60407 | 460 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child); |
98292c61 WC |
461 | BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
462 | BlockDriverState *child_bs, | |
463 | const char *child_name, | |
464 | const BdrvChildRole *child_role); | |
8b9b0cc2 | 465 | |
fbe40ff7 FZ |
466 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp); |
467 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason); | |
468 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason); | |
469 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason); | |
470 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason); | |
471 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs); | |
472 | ||
9a4f4c31 KW |
473 | #define BLKDBG_EVENT(child, evt) \ |
474 | do { \ | |
475 | if (child) { \ | |
476 | bdrv_debug_event(child->bs, evt); \ | |
477 | } \ | |
478 | } while (0) | |
479 | ||
a31939e6 | 480 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event); |
8b9b0cc2 | 481 | |
41c695c7 KW |
482 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
483 | const char *tag); | |
4cc70e93 | 484 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag); |
41c695c7 KW |
485 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag); |
486 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag); | |
487 | ||
db519cba FZ |
488 | /** |
489 | * bdrv_get_aio_context: | |
490 | * | |
491 | * Returns: the currently bound #AioContext | |
492 | */ | |
493 | AioContext *bdrv_get_aio_context(BlockDriverState *bs); | |
494 | ||
dcd04228 SH |
495 | /** |
496 | * bdrv_set_aio_context: | |
497 | * | |
498 | * Changes the #AioContext used for fd handlers, timers, and BHs by this | |
499 | * BlockDriverState and all its children. | |
500 | * | |
2e5b887c | 501 | * This function must be called with iothread lock held. |
dcd04228 SH |
502 | */ |
503 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context); | |
892b7de8 ET |
504 | int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz); |
505 | int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo); | |
dcd04228 | 506 | |
448ad91d ML |
507 | void bdrv_io_plug(BlockDriverState *bs); |
508 | void bdrv_io_unplug(BlockDriverState *bs); | |
6b98bd64 PB |
509 | void bdrv_io_unplugged_begin(BlockDriverState *bs); |
510 | void bdrv_io_unplugged_end(BlockDriverState *bs); | |
448ad91d | 511 | |
51288d79 FZ |
512 | /** |
513 | * bdrv_drained_begin: | |
514 | * | |
515 | * Begin a quiesced section for exclusive access to the BDS, by disabling | |
516 | * external request sources including NBD server and device model. Note that | |
517 | * this doesn't block timers or coroutines from submitting more requests, which | |
518 | * means block_job_pause is still necessary. | |
519 | * | |
520 | * This function can be recursive. | |
521 | */ | |
522 | void bdrv_drained_begin(BlockDriverState *bs); | |
523 | ||
524 | /** | |
525 | * bdrv_drained_end: | |
526 | * | |
527 | * End a quiescent section started by bdrv_drained_begin(). | |
528 | */ | |
529 | void bdrv_drained_end(BlockDriverState *bs); | |
530 | ||
e06018ad WC |
531 | void bdrv_add_child(BlockDriverState *parent, BlockDriverState *child, |
532 | Error **errp); | |
533 | void bdrv_del_child(BlockDriverState *parent, BdrvChild *child, Error **errp); | |
534 | ||
8a4bc5aa | 535 | #endif |