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