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