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