]>
Commit | Line | Data |
---|---|---|
faf07963 PB |
1 | #ifndef BLOCK_H |
2 | #define BLOCK_H | |
3 | ||
737e150e | 4 | #include "block/aio.h" |
9af23989 | 5 | #include "qapi/qapi-types-block-core.h" |
7719f3c9 | 6 | #include "block/aio-wait.h" |
daf015ef | 7 | #include "qemu/iov.h" |
10817bf0 | 8 | #include "qemu/coroutine.h" |
5366d0c8 | 9 | #include "block/accounting.h" |
ebab2259 | 10 | #include "block/dirty-bitmap.h" |
c87621ea | 11 | #include "block/blockjob.h" |
78f9dc85 | 12 | #include "qemu/hbitmap.h" |
a76bab49 | 13 | |
faf07963 | 14 | /* block.c */ |
faf07963 | 15 | typedef struct BlockDriver BlockDriver; |
b4b059f6 | 16 | typedef struct BdrvChild BdrvChild; |
f3930ed0 | 17 | typedef struct BdrvChildRole BdrvChildRole; |
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; | |
85f49cad FZ |
30 | /* |
31 | * True if this block driver only supports compressed writes | |
32 | */ | |
33 | bool needs_compressed_writes; | |
faf07963 PB |
34 | } BlockDriverInfo; |
35 | ||
f8111c24 DXW |
36 | typedef struct BlockFragInfo { |
37 | uint64_t allocated_clusters; | |
38 | uint64_t total_clusters; | |
39 | uint64_t fragmented_clusters; | |
e6439d78 | 40 | uint64_t compressed_clusters; |
f8111c24 DXW |
41 | } BlockFragInfo; |
42 | ||
6faac15f | 43 | typedef enum { |
9568b511 WC |
44 | BDRV_REQ_COPY_ON_READ = 0x1, |
45 | BDRV_REQ_ZERO_WRITE = 0x2, | |
d32f35cb PL |
46 | /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver |
47 | * is allowed to optimize a write zeroes request by unmapping (discarding) | |
48 | * blocks if it is guaranteed that the result will read back as | |
49 | * zeroes. The flag is only passed to the driver if the block device is | |
50 | * opened with BDRV_O_UNMAP. | |
51 | */ | |
9568b511 | 52 | BDRV_REQ_MAY_UNMAP = 0x4, |
999658a0 VSO |
53 | |
54 | /* | |
55 | * The BDRV_REQ_NO_SERIALISING flag is only valid for reads and means that | |
56 | * we don't want wait_serialising_requests() during the read operation. | |
57 | * | |
58 | * This flag is used for backup copy-on-write operations, when we need to | |
59 | * read old data before write (write notifier triggered). It is okay since | |
60 | * we already waited for other serializing requests in the initiating write | |
61 | * (see bdrv_aligned_pwritev), and it is necessary if the initiating write | |
62 | * is already serializing (without the flag, the read would deadlock | |
63 | * waiting for the serialising write to complete). | |
64 | */ | |
61408b25 | 65 | BDRV_REQ_NO_SERIALISING = 0x8, |
bfd18d1e | 66 | BDRV_REQ_FUA = 0x10, |
29a298af | 67 | BDRV_REQ_WRITE_COMPRESSED = 0x20, |
fa166538 | 68 | |
c6035964 HR |
69 | /* Signifies that this write request will not change the visible disk |
70 | * content. */ | |
71 | BDRV_REQ_WRITE_UNCHANGED = 0x40, | |
72 | ||
09d2f948 VSO |
73 | /* |
74 | * BDRV_REQ_SERIALISING forces request serialisation for writes. | |
75 | * It is used to ensure that writes to the backing file of a backup process | |
76 | * target cannot race with a read of the backup target that defers to the | |
77 | * backing file. | |
78 | * | |
79 | * Note, that BDRV_REQ_SERIALISING is _not_ opposite in meaning to | |
80 | * BDRV_REQ_NO_SERIALISING. A more descriptive name for the latter might be | |
81 | * _DO_NOT_WAIT_FOR_SERIALISING, except that is too long. | |
82 | */ | |
83 | BDRV_REQ_SERIALISING = 0x80, | |
84 | ||
fa166538 | 85 | /* Mask of valid flags */ |
09d2f948 | 86 | BDRV_REQ_MASK = 0xff, |
6faac15f PL |
87 | } BdrvRequestFlags; |
88 | ||
892b7de8 ET |
89 | typedef struct BlockSizes { |
90 | uint32_t phys; | |
91 | uint32_t log; | |
92 | } BlockSizes; | |
93 | ||
94 | typedef struct HDGeometry { | |
95 | uint32_t heads; | |
96 | uint32_t sectors; | |
97 | uint32_t cylinders; | |
98 | } HDGeometry; | |
99 | ||
faf07963 | 100 | #define BDRV_O_RDWR 0x0002 |
55880601 | 101 | #define BDRV_O_RESIZE 0x0004 /* request permission for resizing the node */ |
faf07963 | 102 | #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ |
8bfea15d | 103 | #define BDRV_O_TEMPORARY 0x0010 /* delete the file after use */ |
9f7965c7 | 104 | #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ |
5c6c3a6c | 105 | #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */ |
b783e409 | 106 | #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ |
016f5cf6 | 107 | #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */ |
53fec9d3 | 108 | #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */ |
04c01a5c | 109 | #define BDRV_O_INACTIVE 0x0800 /* consistency hint for migration handoff */ |
058f8f16 | 110 | #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */ |
be028adc | 111 | #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */ |
9e8f1835 | 112 | #define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */ |
2e40134b HR |
113 | #define BDRV_O_PROTOCOL 0x8000 /* if no block driver is explicitly given: |
114 | select an appropriate protocol driver, | |
115 | ignoring the format layer */ | |
abb06c5a | 116 | #define BDRV_O_NO_IO 0x10000 /* don't initialize for I/O */ |
9f7965c7 | 117 | |
61de4c68 | 118 | #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_NO_FLUSH) |
faf07963 | 119 | |
54861b92 KW |
120 | |
121 | /* Option names of options parsed by the block layer */ | |
122 | ||
123 | #define BDRV_OPT_CACHE_WB "cache.writeback" | |
124 | #define BDRV_OPT_CACHE_DIRECT "cache.direct" | |
125 | #define BDRV_OPT_CACHE_NO_FLUSH "cache.no-flush" | |
f87a0e29 | 126 | #define BDRV_OPT_READ_ONLY "read-only" |
818584a4 | 127 | #define BDRV_OPT_DISCARD "discard" |
5a9347c6 | 128 | #define BDRV_OPT_FORCE_SHARE "force-share" |
54861b92 KW |
129 | |
130 | ||
6ea44308 | 131 | #define BDRV_SECTOR_BITS 9 |
c63782cb | 132 | #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS) |
3abbc4d9 | 133 | #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1) |
6ea44308 | 134 | |
75af1f34 PL |
135 | #define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \ |
136 | INT_MAX >> BDRV_SECTOR_BITS) | |
48265250 | 137 | #define BDRV_REQUEST_MAX_BYTES (BDRV_REQUEST_MAX_SECTORS << BDRV_SECTOR_BITS) |
75af1f34 | 138 | |
705be728 | 139 | /* |
237d78f8 | 140 | * Allocation status flags for bdrv_block_status() and friends. |
4c41cb49 EB |
141 | * |
142 | * Public flags: | |
143 | * BDRV_BLOCK_DATA: allocation for data at offset is tied to this layer | |
144 | * BDRV_BLOCK_ZERO: offset reads as zero | |
145 | * BDRV_BLOCK_OFFSET_VALID: an associated offset exists for accessing raw data | |
e88ae226 | 146 | * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this |
86a3d5c6 EB |
147 | * layer rather than any backing, set by block layer |
148 | * BDRV_BLOCK_EOF: the returned pnum covers through end of file for this | |
149 | * layer, set by block layer | |
4333bb71 | 150 | * |
4c41cb49 | 151 | * Internal flag: |
d5254033 EB |
152 | * BDRV_BLOCK_RAW: for use by passthrough drivers, such as raw, to request |
153 | * that the block layer recompute the answer from the returned | |
154 | * BDS; must be accompanied by just BDRV_BLOCK_OFFSET_VALID. | |
4333bb71 | 155 | * |
86a3d5c6 EB |
156 | * If BDRV_BLOCK_OFFSET_VALID is set, the map parameter represents the |
157 | * host offset within the returned BDS that is allocated for the | |
158 | * corresponding raw guest data. However, whether that offset | |
159 | * actually contains data also depends on BDRV_BLOCK_DATA, as follows: | |
4333bb71 PB |
160 | * |
161 | * DATA ZERO OFFSET_VALID | |
4c41cb49 EB |
162 | * t t t sectors read as zero, returned file is zero at offset |
163 | * t f t sectors read as valid from file at offset | |
164 | * f t t sectors preallocated, read as zero, returned file not | |
4333bb71 PB |
165 | * necessarily zero at offset |
166 | * f f t sectors preallocated but read from backing_hd, | |
4c41cb49 | 167 | * returned file contains garbage at offset |
4333bb71 PB |
168 | * t t f sectors preallocated, read as zero, unknown offset |
169 | * t f f sectors read from unknown file or offset | |
170 | * f t f not allocated or unknown offset, read as zero | |
171 | * f f f not allocated or unknown offset, read from backing_hd | |
172 | */ | |
e88ae226 KW |
173 | #define BDRV_BLOCK_DATA 0x01 |
174 | #define BDRV_BLOCK_ZERO 0x02 | |
175 | #define BDRV_BLOCK_OFFSET_VALID 0x04 | |
176 | #define BDRV_BLOCK_RAW 0x08 | |
177 | #define BDRV_BLOCK_ALLOCATED 0x10 | |
fb0d8654 | 178 | #define BDRV_BLOCK_EOF 0x20 |
4333bb71 PB |
179 | #define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK |
180 | ||
e971aa12 JC |
181 | typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue; |
182 | ||
183 | typedef struct BDRVReopenState { | |
184 | BlockDriverState *bs; | |
185 | int flags; | |
30450259 | 186 | uint64_t perm, shared_perm; |
4d2cb092 | 187 | QDict *options; |
145f598e | 188 | QDict *explicit_options; |
e971aa12 JC |
189 | void *opaque; |
190 | } BDRVReopenState; | |
191 | ||
8574575f FZ |
192 | /* |
193 | * Block operation types | |
194 | */ | |
195 | typedef enum BlockOpType { | |
196 | BLOCK_OP_TYPE_BACKUP_SOURCE, | |
197 | BLOCK_OP_TYPE_BACKUP_TARGET, | |
198 | BLOCK_OP_TYPE_CHANGE, | |
bb00021d FZ |
199 | BLOCK_OP_TYPE_COMMIT_SOURCE, |
200 | BLOCK_OP_TYPE_COMMIT_TARGET, | |
8574575f FZ |
201 | BLOCK_OP_TYPE_DATAPLANE, |
202 | BLOCK_OP_TYPE_DRIVE_DEL, | |
203 | BLOCK_OP_TYPE_EJECT, | |
204 | BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, | |
205 | BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, | |
206 | BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, | |
05e4d14b | 207 | BLOCK_OP_TYPE_MIRROR_SOURCE, |
e40e5027 | 208 | BLOCK_OP_TYPE_MIRROR_TARGET, |
8574575f FZ |
209 | BLOCK_OP_TYPE_RESIZE, |
210 | BLOCK_OP_TYPE_STREAM, | |
09158f00 | 211 | BLOCK_OP_TYPE_REPLACE, |
8574575f FZ |
212 | BLOCK_OP_TYPE_MAX, |
213 | } BlockOpType; | |
e971aa12 | 214 | |
7006c9a7 KW |
215 | /* Block node permission constants */ |
216 | enum { | |
217 | /** | |
218 | * A user that has the "permission" of consistent reads is guaranteed that | |
219 | * their view of the contents of the block device is complete and | |
220 | * self-consistent, representing the contents of a disk at a specific | |
221 | * point. | |
222 | * | |
223 | * For most block devices (including their backing files) this is true, but | |
224 | * the property cannot be maintained in a few situations like for | |
225 | * intermediate nodes of a commit block job. | |
226 | */ | |
227 | BLK_PERM_CONSISTENT_READ = 0x01, | |
228 | ||
229 | /** This permission is required to change the visible disk contents. */ | |
230 | BLK_PERM_WRITE = 0x02, | |
231 | ||
232 | /** | |
233 | * This permission (which is weaker than BLK_PERM_WRITE) is both enough and | |
234 | * required for writes to the block node when the caller promises that | |
235 | * the visible disk content doesn't change. | |
24b7c538 HR |
236 | * |
237 | * As the BLK_PERM_WRITE permission is strictly stronger, either is | |
238 | * sufficient to perform an unchanging write. | |
7006c9a7 KW |
239 | */ |
240 | BLK_PERM_WRITE_UNCHANGED = 0x04, | |
241 | ||
242 | /** This permission is required to change the size of a block node. */ | |
243 | BLK_PERM_RESIZE = 0x08, | |
244 | ||
245 | /** | |
246 | * This permission is required to change the node that this BdrvChild | |
247 | * points to. | |
248 | */ | |
249 | BLK_PERM_GRAPH_MOD = 0x10, | |
250 | ||
251 | BLK_PERM_ALL = 0x1f, | |
7ae9f3f6 AS |
252 | |
253 | DEFAULT_PERM_PASSTHROUGH = BLK_PERM_CONSISTENT_READ | |
254 | | BLK_PERM_WRITE | |
255 | | BLK_PERM_WRITE_UNCHANGED | |
256 | | BLK_PERM_RESIZE, | |
257 | ||
258 | DEFAULT_PERM_UNCHANGED = BLK_PERM_ALL & ~DEFAULT_PERM_PASSTHROUGH, | |
7006c9a7 KW |
259 | }; |
260 | ||
5176196c FZ |
261 | char *bdrv_perm_names(uint64_t perm); |
262 | ||
0563e191 | 263 | /* disk I/O throttling */ |
faf07963 | 264 | void bdrv_init(void); |
eb852011 | 265 | void bdrv_init_with_whitelist(void); |
e6ff69bf | 266 | bool bdrv_uses_whitelist(void); |
e8eb8637 | 267 | int bdrv_is_whitelisted(BlockDriver *drv, bool read_only); |
98289620 | 268 | BlockDriver *bdrv_find_protocol(const char *filename, |
b65a5e12 HR |
269 | bool allow_protocol_prefix, |
270 | Error **errp); | |
faf07963 | 271 | BlockDriver *bdrv_find_format(const char *format_name); |
0e7e1989 | 272 | int bdrv_create(BlockDriver *drv, const char* filename, |
c282e1fd CL |
273 | QemuOpts *opts, Error **errp); |
274 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp); | |
e4e9986b | 275 | BlockDriverState *bdrv_new(void); |
b2c2832c KW |
276 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top, |
277 | Error **errp); | |
5fe31c25 KW |
278 | void bdrv_replace_node(BlockDriverState *from, BlockDriverState *to, |
279 | Error **errp); | |
3f09bfbc | 280 | |
baf5602e | 281 | int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough); |
9e8f1835 | 282 | int bdrv_parse_discard_flags(const char *mode, int *flags); |
b4b059f6 KW |
283 | BdrvChild *bdrv_open_child(const char *filename, |
284 | QDict *options, const char *bdref_key, | |
285 | BlockDriverState* parent, | |
286 | const BdrvChildRole *child_role, | |
287 | bool allow_none, Error **errp); | |
e1d74bc6 | 288 | BlockDriverState *bdrv_open_blockdev_ref(BlockdevRef *ref, Error **errp); |
12fa4af6 KW |
289 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd, |
290 | Error **errp); | |
d9b7b057 KW |
291 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
292 | const char *bdref_key, Error **errp); | |
5b363937 HR |
293 | BlockDriverState *bdrv_open(const char *filename, const char *reference, |
294 | QDict *options, int flags, Error **errp); | |
680c7f96 KW |
295 | BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name, |
296 | int flags, Error **errp); | |
e971aa12 | 297 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
4d2cb092 KW |
298 | BlockDriverState *bs, |
299 | QDict *options, int flags); | |
720150f3 | 300 | int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp); |
e971aa12 JC |
301 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp); |
302 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, | |
303 | BlockReopenQueue *queue, Error **errp); | |
304 | void bdrv_reopen_commit(BDRVReopenState *reopen_state); | |
305 | void bdrv_reopen_abort(BDRVReopenState *reopen_state); | |
fbcbbf4e | 306 | int bdrv_read(BdrvChild *child, int64_t sector_num, |
faf07963 | 307 | uint8_t *buf, int nb_sectors); |
18d51c4b | 308 | int bdrv_write(BdrvChild *child, int64_t sector_num, |
faf07963 | 309 | const uint8_t *buf, int nb_sectors); |
720ff280 | 310 | int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset, |
f5a5ca79 | 311 | int bytes, BdrvRequestFlags flags); |
720ff280 | 312 | int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags); |
cf2ab8fc KW |
313 | int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes); |
314 | int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov); | |
d9ca2ea2 KW |
315 | int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes); |
316 | int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov); | |
317 | int bdrv_pwrite_sync(BdrvChild *child, int64_t offset, | |
318 | const void *buf, int count); | |
f08f2dda SH |
319 | /* |
320 | * Efficiently zero a region of the disk image. Note that this is a regular | |
321 | * I/O request like read or write and should have a reasonable size. This | |
322 | * function is not suitable for zeroing the entire image in a single request | |
323 | * because it may allocate memory for the entire region. | |
324 | */ | |
a03ef88f | 325 | int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset, |
f5a5ca79 | 326 | int bytes, BdrvRequestFlags flags); |
e8a6bb9c MT |
327 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, |
328 | const char *backing_file); | |
91af7014 | 329 | void bdrv_refresh_filename(BlockDriverState *bs); |
061ca8a3 KW |
330 | |
331 | int coroutine_fn bdrv_co_truncate(BdrvChild *child, int64_t offset, | |
332 | PreallocMode prealloc, Error **errp); | |
7ea37c30 HR |
333 | int bdrv_truncate(BdrvChild *child, int64_t offset, PreallocMode prealloc, |
334 | Error **errp); | |
061ca8a3 | 335 | |
65a9bb25 | 336 | int64_t bdrv_nb_sectors(BlockDriverState *bs); |
faf07963 | 337 | int64_t bdrv_getlength(BlockDriverState *bs); |
4a1d5e1f | 338 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); |
90880ff1 SH |
339 | BlockMeasureInfo *bdrv_measure(BlockDriver *drv, QemuOpts *opts, |
340 | BlockDriverState *in_bs, Error **errp); | |
96b8f136 | 341 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); |
3baca891 | 342 | void bdrv_refresh_limits(BlockDriverState *bs, Error **errp); |
faf07963 | 343 | int bdrv_commit(BlockDriverState *bs); |
756e6736 KW |
344 | int bdrv_change_backing_file(BlockDriverState *bs, |
345 | const char *backing_file, const char *backing_fmt); | |
5efa9d5a | 346 | void bdrv_register(BlockDriver *bdrv); |
bde70715 | 347 | int bdrv_drop_intermediate(BlockDriverState *top, BlockDriverState *base, |
54e26900 | 348 | const char *backing_file_str); |
6ebdcee2 JC |
349 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, |
350 | BlockDriverState *bs); | |
79fac568 | 351 | BlockDriverState *bdrv_find_base(BlockDriverState *bs); |
5efa9d5a | 352 | |
e076f338 KW |
353 | |
354 | typedef struct BdrvCheckResult { | |
355 | int corruptions; | |
356 | int leaks; | |
357 | int check_errors; | |
ccf34716 KW |
358 | int corruptions_fixed; |
359 | int leaks_fixed; | |
c6bb9ad1 | 360 | int64_t image_end_offset; |
f8111c24 | 361 | BlockFragInfo bfi; |
e076f338 KW |
362 | } BdrvCheckResult; |
363 | ||
4534ff54 KW |
364 | typedef enum { |
365 | BDRV_FIX_LEAKS = 1, | |
366 | BDRV_FIX_ERRORS = 2, | |
367 | } BdrvCheckMode; | |
368 | ||
369 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix); | |
e076f338 | 370 | |
77485434 HR |
371 | /* The units of offset and total_work_size may be chosen arbitrarily by the |
372 | * block driver; total_work_size may change during the course of the amendment | |
373 | * operation */ | |
374 | typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset, | |
8b13976d | 375 | int64_t total_work_size, void *opaque); |
77485434 | 376 | int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts, |
d1402b50 HR |
377 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque, |
378 | Error **errp); | |
6f176b48 | 379 | |
f6186f49 | 380 | /* external snapshots */ |
212a5a8f BC |
381 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
382 | BlockDriverState *candidate); | |
383 | bool bdrv_is_first_non_filter(BlockDriverState *candidate); | |
f6186f49 | 384 | |
09158f00 | 385 | /* check if a named node can be replaced when doing drive-mirror */ |
e12f3784 WC |
386 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
387 | const char *node_name, Error **errp); | |
09158f00 | 388 | |
faf07963 | 389 | /* async block I/O */ |
7c84b1b8 MA |
390 | void bdrv_aio_cancel(BlockAIOCB *acb); |
391 | void bdrv_aio_cancel_async(BlockAIOCB *acb); | |
faf07963 | 392 | |
7d780669 | 393 | /* sg packet commands */ |
48af776a | 394 | int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf); |
7d780669 | 395 | |
0f15423c | 396 | /* Invalidate any cached metadata used by image formats */ |
5a8a30db KW |
397 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp); |
398 | void bdrv_invalidate_cache_all(Error **errp); | |
76b1c7fe | 399 | int bdrv_inactivate_all(void); |
0f15423c | 400 | |
faf07963 | 401 | /* Ensure contents are flushed to disk. */ |
205ef796 | 402 | int bdrv_flush(BlockDriverState *bs); |
07f07615 | 403 | int coroutine_fn bdrv_co_flush(BlockDriverState *bs); |
4085f5c7 | 404 | int bdrv_flush_all(void); |
2bc93fed | 405 | void bdrv_close_all(void); |
5b98db0a | 406 | void bdrv_drain(BlockDriverState *bs); |
a77fd4bb | 407 | void coroutine_fn bdrv_co_drain(BlockDriverState *bs); |
c0778f66 AG |
408 | void bdrv_drain_all_begin(void); |
409 | void bdrv_drain_all_end(void); | |
922453bc | 410 | void bdrv_drain_all(void); |
c6ca28d6 | 411 | |
7719f3c9 SH |
412 | /* Returns NULL when bs == NULL */ |
413 | AioWait *bdrv_get_aio_wait(BlockDriverState *bs); | |
414 | ||
88b062c2 | 415 | #define BDRV_POLL_WHILE(bs, cond) ({ \ |
88b062c2 | 416 | BlockDriverState *bs_ = (bs); \ |
7719f3c9 SH |
417 | AIO_WAIT_WHILE(bdrv_get_aio_wait(bs_), \ |
418 | bdrv_get_aio_context(bs_), \ | |
419 | cond); }) | |
88b062c2 | 420 | |
f5a5ca79 MP |
421 | int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int bytes); |
422 | int bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes); | |
3ac21627 | 423 | int bdrv_has_zero_init_1(BlockDriverState *bs); |
f2feebbd | 424 | int bdrv_has_zero_init(BlockDriverState *bs); |
4ce78691 PL |
425 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs); |
426 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs); | |
237d78f8 EB |
427 | int bdrv_block_status(BlockDriverState *bs, int64_t offset, |
428 | int64_t bytes, int64_t *pnum, int64_t *map, | |
429 | BlockDriverState **file); | |
31826642 EB |
430 | int bdrv_block_status_above(BlockDriverState *bs, BlockDriverState *base, |
431 | int64_t offset, int64_t bytes, int64_t *pnum, | |
432 | int64_t *map, BlockDriverState **file); | |
d6a644bb EB |
433 | int bdrv_is_allocated(BlockDriverState *bs, int64_t offset, int64_t bytes, |
434 | int64_t *pnum); | |
b35b2bba | 435 | int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base, |
51b0a488 | 436 | int64_t offset, int64_t bytes, int64_t *pnum); |
faf07963 | 437 | |
54115412 | 438 | bool bdrv_is_read_only(BlockDriverState *bs); |
54a32bfe KW |
439 | int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, |
440 | bool ignore_allow_rdw, Error **errp); | |
e2b8247a | 441 | int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp); |
cc022140 | 442 | bool bdrv_is_writable(BlockDriverState *bs); |
54115412 | 443 | bool bdrv_is_sg(BlockDriverState *bs); |
e031f750 | 444 | bool bdrv_is_inserted(BlockDriverState *bs); |
025e849a | 445 | void bdrv_lock_medium(BlockDriverState *bs, bool locked); |
f36f3949 | 446 | void bdrv_eject(BlockDriverState *bs, bool eject_flag); |
f8d6bba1 | 447 | const char *bdrv_get_format_name(BlockDriverState *bs); |
dc364f4c | 448 | BlockDriverState *bdrv_find_node(const char *node_name); |
d5a8ee60 | 449 | BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp); |
12d3ba82 BC |
450 | BlockDriverState *bdrv_lookup_bs(const char *device, |
451 | const char *node_name, | |
452 | Error **errp); | |
5a6684d2 | 453 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base); |
04df765a | 454 | BlockDriverState *bdrv_next_node(BlockDriverState *bs); |
0f12264e | 455 | BlockDriverState *bdrv_next_all_states(BlockDriverState *bs); |
88be7b4b KW |
456 | |
457 | typedef struct BdrvNextIterator { | |
458 | enum { | |
459 | BDRV_NEXT_BACKEND_ROOTS, | |
460 | BDRV_NEXT_MONITOR_OWNED, | |
461 | } phase; | |
462 | BlockBackend *blk; | |
463 | BlockDriverState *bs; | |
464 | } BdrvNextIterator; | |
465 | ||
466 | BlockDriverState *bdrv_first(BdrvNextIterator *it); | |
467 | BlockDriverState *bdrv_next(BdrvNextIterator *it); | |
5e003f17 | 468 | void bdrv_next_cleanup(BdrvNextIterator *it); |
88be7b4b | 469 | |
262b4e8f | 470 | BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs); |
54115412 | 471 | bool bdrv_is_encrypted(BlockDriverState *bs); |
faf07963 PB |
472 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
473 | void *opaque); | |
20a9e77d | 474 | const char *bdrv_get_node_name(const BlockDriverState *bs); |
bfb197e0 | 475 | const char *bdrv_get_device_name(const BlockDriverState *bs); |
9b2aa84f | 476 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs); |
c8433287 | 477 | int bdrv_get_flags(BlockDriverState *bs); |
faf07963 | 478 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); |
eae041fe | 479 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs); |
343bded4 | 480 | void bdrv_round_to_clusters(BlockDriverState *bs, |
7cfd5275 | 481 | int64_t offset, int64_t bytes, |
244483e6 | 482 | int64_t *cluster_offset, |
7cfd5275 | 483 | int64_t *cluster_bytes); |
faf07963 | 484 | |
045df330 | 485 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs); |
faf07963 PB |
486 | void bdrv_get_backing_filename(BlockDriverState *bs, |
487 | char *filename, int filename_size); | |
dc5a1371 | 488 | void bdrv_get_full_backing_filename(BlockDriverState *bs, |
9f07429e | 489 | char *dest, size_t sz, Error **errp); |
0a82855a HR |
490 | void bdrv_get_full_backing_filename_from_filename(const char *backed, |
491 | const char *backing, | |
9f07429e HR |
492 | char *dest, size_t sz, |
493 | Error **errp); | |
faf07963 | 494 | |
5c98415b | 495 | int path_has_protocol(const char *path); |
faf07963 PB |
496 | int path_is_absolute(const char *path); |
497 | void path_combine(char *dest, int dest_size, | |
498 | const char *base_path, | |
499 | const char *filename); | |
500 | ||
5ddda0b8 | 501 | int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); |
cf8074b3 | 502 | int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); |
45566e9c CH |
503 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
504 | int64_t pos, int size); | |
178e08a5 | 505 | |
45566e9c CH |
506 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
507 | int64_t pos, int size); | |
178e08a5 | 508 | |
d92ada22 LC |
509 | void bdrv_img_create(const char *filename, const char *fmt, |
510 | const char *base_filename, const char *base_fmt, | |
f382d43a | 511 | char *options, uint64_t img_size, int flags, |
9217283d | 512 | bool quiet, Error **errp); |
f88e1a42 | 513 | |
339064d5 KW |
514 | /* Returns the alignment in bytes that is required so that no bounce buffer |
515 | * is required throughout the stack */ | |
4196d2f0 DL |
516 | size_t bdrv_min_mem_align(BlockDriverState *bs); |
517 | /* Returns optimal alignment in bytes for bounce buffer */ | |
339064d5 | 518 | size_t bdrv_opt_mem_align(BlockDriverState *bs); |
ba5b7ad4 | 519 | void *qemu_blockalign(BlockDriverState *bs, size_t size); |
9ebd8448 | 520 | void *qemu_blockalign0(BlockDriverState *bs, size_t size); |
7d2a35cc | 521 | void *qemu_try_blockalign(BlockDriverState *bs, size_t size); |
9ebd8448 | 522 | void *qemu_try_blockalign0(BlockDriverState *bs, size_t size); |
c53b1c51 | 523 | bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov); |
ba5b7ad4 | 524 | |
53fec9d3 SH |
525 | void bdrv_enable_copy_on_read(BlockDriverState *bs); |
526 | void bdrv_disable_copy_on_read(BlockDriverState *bs); | |
527 | ||
9fcb0251 FZ |
528 | void bdrv_ref(BlockDriverState *bs); |
529 | void bdrv_unref(BlockDriverState *bs); | |
33a60407 | 530 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child); |
98292c61 WC |
531 | BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
532 | BlockDriverState *child_bs, | |
533 | const char *child_name, | |
8b2ff529 KW |
534 | const BdrvChildRole *child_role, |
535 | Error **errp); | |
8b9b0cc2 | 536 | |
fbe40ff7 FZ |
537 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp); |
538 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason); | |
539 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason); | |
540 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason); | |
541 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason); | |
542 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs); | |
543 | ||
9a4f4c31 KW |
544 | #define BLKDBG_EVENT(child, evt) \ |
545 | do { \ | |
546 | if (child) { \ | |
547 | bdrv_debug_event(child->bs, evt); \ | |
548 | } \ | |
549 | } while (0) | |
550 | ||
a31939e6 | 551 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event); |
8b9b0cc2 | 552 | |
41c695c7 KW |
553 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
554 | const char *tag); | |
4cc70e93 | 555 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag); |
41c695c7 KW |
556 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag); |
557 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag); | |
558 | ||
db519cba FZ |
559 | /** |
560 | * bdrv_get_aio_context: | |
561 | * | |
562 | * Returns: the currently bound #AioContext | |
563 | */ | |
564 | AioContext *bdrv_get_aio_context(BlockDriverState *bs); | |
565 | ||
052a7572 FZ |
566 | /** |
567 | * Transfer control to @co in the aio context of @bs | |
568 | */ | |
569 | void bdrv_coroutine_enter(BlockDriverState *bs, Coroutine *co); | |
570 | ||
dcd04228 SH |
571 | /** |
572 | * bdrv_set_aio_context: | |
573 | * | |
574 | * Changes the #AioContext used for fd handlers, timers, and BHs by this | |
575 | * BlockDriverState and all its children. | |
576 | * | |
2e5b887c | 577 | * This function must be called with iothread lock held. |
dcd04228 SH |
578 | */ |
579 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context); | |
892b7de8 ET |
580 | int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz); |
581 | int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo); | |
dcd04228 | 582 | |
448ad91d ML |
583 | void bdrv_io_plug(BlockDriverState *bs); |
584 | void bdrv_io_unplug(BlockDriverState *bs); | |
448ad91d | 585 | |
14e9559f FZ |
586 | /** |
587 | * bdrv_parent_drained_begin: | |
588 | * | |
589 | * Begin a quiesced section of all users of @bs. This is part of | |
590 | * bdrv_drained_begin. | |
591 | */ | |
6cd5c9d7 KW |
592 | void bdrv_parent_drained_begin(BlockDriverState *bs, BdrvChild *ignore, |
593 | bool ignore_bds_parents); | |
14e9559f | 594 | |
4be6a6d1 KW |
595 | /** |
596 | * bdrv_parent_drained_begin_single: | |
597 | * | |
598 | * Begin a quiesced section for the parent of @c. If @poll is true, wait for | |
599 | * any pending activity to cease. | |
600 | */ | |
601 | void bdrv_parent_drained_begin_single(BdrvChild *c, bool poll); | |
602 | ||
14e9559f FZ |
603 | /** |
604 | * bdrv_parent_drained_end: | |
605 | * | |
606 | * End a quiesced section of all users of @bs. This is part of | |
607 | * bdrv_drained_end. | |
608 | */ | |
6cd5c9d7 KW |
609 | void bdrv_parent_drained_end(BlockDriverState *bs, BdrvChild *ignore, |
610 | bool ignore_bds_parents); | |
14e9559f | 611 | |
89bd0305 KW |
612 | /** |
613 | * bdrv_drain_poll: | |
614 | * | |
fe4f0614 | 615 | * Poll for pending requests in @bs, its parents (except for @ignore_parent), |
6cd5c9d7 KW |
616 | * and if @recursive is true its children as well (used for subtree drain). |
617 | * | |
618 | * If @ignore_bds_parents is true, parents that are BlockDriverStates must | |
619 | * ignore the drain request because they will be drained separately (used for | |
620 | * drain_all). | |
fe4f0614 KW |
621 | * |
622 | * This is part of bdrv_drained_begin. | |
89bd0305 | 623 | */ |
fe4f0614 | 624 | bool bdrv_drain_poll(BlockDriverState *bs, bool recursive, |
6cd5c9d7 | 625 | BdrvChild *ignore_parent, bool ignore_bds_parents); |
89bd0305 | 626 | |
51288d79 FZ |
627 | /** |
628 | * bdrv_drained_begin: | |
629 | * | |
630 | * Begin a quiesced section for exclusive access to the BDS, by disabling | |
631 | * external request sources including NBD server and device model. Note that | |
632 | * this doesn't block timers or coroutines from submitting more requests, which | |
633 | * means block_job_pause is still necessary. | |
634 | * | |
635 | * This function can be recursive. | |
636 | */ | |
637 | void bdrv_drained_begin(BlockDriverState *bs); | |
638 | ||
dcf94a23 KW |
639 | /** |
640 | * bdrv_do_drained_begin_quiesce: | |
641 | * | |
642 | * Quiesces a BDS like bdrv_drained_begin(), but does not wait for already | |
643 | * running requests to complete. | |
644 | */ | |
645 | void bdrv_do_drained_begin_quiesce(BlockDriverState *bs, | |
6cd5c9d7 | 646 | BdrvChild *parent, bool ignore_bds_parents); |
dcf94a23 | 647 | |
b0165585 KW |
648 | /** |
649 | * Like bdrv_drained_begin, but recursively begins a quiesced section for | |
650 | * exclusive access to all child nodes as well. | |
b0165585 KW |
651 | */ |
652 | void bdrv_subtree_drained_begin(BlockDriverState *bs); | |
653 | ||
51288d79 FZ |
654 | /** |
655 | * bdrv_drained_end: | |
656 | * | |
657 | * End a quiescent section started by bdrv_drained_begin(). | |
658 | */ | |
659 | void bdrv_drained_end(BlockDriverState *bs); | |
660 | ||
b0165585 KW |
661 | /** |
662 | * End a quiescent section started by bdrv_subtree_drained_begin(). | |
663 | */ | |
664 | void bdrv_subtree_drained_end(BlockDriverState *bs); | |
665 | ||
e06018ad WC |
666 | void bdrv_add_child(BlockDriverState *parent, BlockDriverState *child, |
667 | Error **errp); | |
668 | void bdrv_del_child(BlockDriverState *parent, BdrvChild *child, Error **errp); | |
669 | ||
67b792f5 VSO |
670 | bool bdrv_can_store_new_dirty_bitmap(BlockDriverState *bs, const char *name, |
671 | uint32_t granularity, Error **errp); | |
23d0ba93 FZ |
672 | /** |
673 | * | |
674 | * bdrv_register_buf/bdrv_unregister_buf: | |
675 | * | |
676 | * Register/unregister a buffer for I/O. For example, VFIO drivers are | |
677 | * interested to know the memory areas that would later be used for I/O, so | |
678 | * that they can prepare IOMMU mapping etc., to get better performance. | |
679 | */ | |
680 | void bdrv_register_buf(BlockDriverState *bs, void *host, size_t size); | |
681 | void bdrv_unregister_buf(BlockDriverState *bs, void *host); | |
fcc67678 FZ |
682 | |
683 | /** | |
684 | * | |
685 | * bdrv_co_copy_range: | |
686 | * | |
687 | * Do offloaded copy between two children. If the operation is not implemented | |
688 | * by the driver, or if the backend storage doesn't support it, a negative | |
689 | * error code will be returned. | |
690 | * | |
691 | * Note: block layer doesn't emulate or fallback to a bounce buffer approach | |
692 | * because usually the caller shouldn't attempt offloaded copy any more (e.g. | |
693 | * calling copy_file_range(2)) after the first error, thus it should fall back | |
694 | * to a read+write path in the caller level. | |
695 | * | |
696 | * @src: Source child to copy data from | |
697 | * @src_offset: offset in @src image to read data | |
698 | * @dst: Destination child to copy data to | |
699 | * @dst_offset: offset in @dst image to write data | |
700 | * @bytes: number of bytes to copy | |
dee12de8 | 701 | * @flags: request flags. Supported flags: |
fcc67678 FZ |
702 | * BDRV_REQ_ZERO_WRITE - treat the @src range as zero data and do zero |
703 | * write on @dst as if bdrv_co_pwrite_zeroes is | |
704 | * called. Used to simplify caller code, or | |
705 | * during BlockDriver.bdrv_co_copy_range_from() | |
706 | * recursion. | |
dee12de8 FZ |
707 | * BDRV_REQ_NO_SERIALISING - do not serialize with other overlapping |
708 | * requests currently in flight. | |
fcc67678 FZ |
709 | * |
710 | * Returns: 0 if succeeded; negative error code if failed. | |
711 | **/ | |
712 | int coroutine_fn bdrv_co_copy_range(BdrvChild *src, uint64_t src_offset, | |
713 | BdrvChild *dst, uint64_t dst_offset, | |
67b51fb9 VSO |
714 | uint64_t bytes, BdrvRequestFlags read_flags, |
715 | BdrvRequestFlags write_flags); | |
8a4bc5aa | 716 | #endif |