]>
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" |
737e150e | 7 | #include "block/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; |
faf07963 | 15 | |
faf07963 PB |
16 | typedef struct BlockDriverInfo { |
17 | /* in bytes, 0 if irrelevant */ | |
18 | int cluster_size; | |
19 | /* offset at which the VM state can be saved (0 if not possible) */ | |
20 | int64_t vm_state_offset; | |
64c79160 | 21 | bool is_dirty; |
e1a5c4be PL |
22 | /* |
23 | * True if unallocated blocks read back as zeroes. This is equivalent | |
24 | * to the the LBPRZ flag in the SCSI logical block provisioning page. | |
25 | */ | |
26 | bool unallocated_blocks_are_zero; | |
27 | /* | |
28 | * True if the driver can optimize writing zeroes by unmapping | |
29 | * sectors. This is equivalent to the BLKDISCARDZEROES ioctl in Linux | |
30 | * with the difference that in qemu a discard is allowed to silently | |
31 | * fail. Therefore we have to use bdrv_write_zeroes with the | |
32 | * BDRV_REQ_MAY_UNMAP flag for an optimized zero write with unmapping. | |
33 | * After this call the driver has to guarantee that the contents read | |
34 | * back as zero. It is additionally required that the block device is | |
35 | * opened with BDRV_O_UNMAP flag for this to work. | |
36 | */ | |
37 | bool can_write_zeroes_with_unmap; | |
85f49cad FZ |
38 | /* |
39 | * True if this block driver only supports compressed writes | |
40 | */ | |
41 | bool needs_compressed_writes; | |
faf07963 PB |
42 | } BlockDriverInfo; |
43 | ||
f8111c24 DXW |
44 | typedef struct BlockFragInfo { |
45 | uint64_t allocated_clusters; | |
46 | uint64_t total_clusters; | |
47 | uint64_t fragmented_clusters; | |
e6439d78 | 48 | uint64_t compressed_clusters; |
f8111c24 DXW |
49 | } BlockFragInfo; |
50 | ||
145feb17 | 51 | /* Callbacks for block device models */ |
0e49de52 | 52 | typedef struct BlockDevOps { |
145feb17 MA |
53 | /* |
54 | * Runs when virtual media changed (monitor commands eject, change) | |
7d4b4ba5 | 55 | * Argument load is true on load and false on eject. |
145feb17 MA |
56 | * Beware: doesn't run when a host device's physical media |
57 | * changes. Sure would be useful if it did. | |
2c6942fa | 58 | * Device models with removable media must implement this callback. |
145feb17 | 59 | */ |
7d4b4ba5 | 60 | void (*change_media_cb)(void *opaque, bool load); |
025ccaa7 PB |
61 | /* |
62 | * Runs when an eject request is issued from the monitor, the tray | |
63 | * is closed, and the medium is locked. | |
64 | * Device models that do not implement is_medium_locked will not need | |
65 | * this callback. Device models that can lock the medium or tray might | |
66 | * want to implement the callback and unlock the tray when "force" is | |
67 | * true, even if they do not support eject requests. | |
68 | */ | |
69 | void (*eject_request_cb)(void *opaque, bool force); | |
e4def80b MA |
70 | /* |
71 | * Is the virtual tray open? | |
72 | * Device models implement this only when the device has a tray. | |
73 | */ | |
74 | bool (*is_tray_open)(void *opaque); | |
f107639a MA |
75 | /* |
76 | * Is the virtual medium locked into the device? | |
77 | * Device models implement this only when device has such a lock. | |
78 | */ | |
79 | bool (*is_medium_locked)(void *opaque); | |
145feb17 MA |
80 | /* |
81 | * Runs when the size changed (e.g. monitor command block_resize) | |
82 | */ | |
83 | void (*resize_cb)(void *opaque); | |
0e49de52 MA |
84 | } BlockDevOps; |
85 | ||
6faac15f PL |
86 | typedef enum { |
87 | BDRV_REQ_COPY_ON_READ = 0x1, | |
88 | BDRV_REQ_ZERO_WRITE = 0x2, | |
d32f35cb PL |
89 | /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver |
90 | * is allowed to optimize a write zeroes request by unmapping (discarding) | |
91 | * blocks if it is guaranteed that the result will read back as | |
92 | * zeroes. The flag is only passed to the driver if the block device is | |
93 | * opened with BDRV_O_UNMAP. | |
94 | */ | |
95 | BDRV_REQ_MAY_UNMAP = 0x4, | |
6faac15f PL |
96 | } BdrvRequestFlags; |
97 | ||
faf07963 | 98 | #define BDRV_O_RDWR 0x0002 |
faf07963 | 99 | #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ |
8bfea15d | 100 | #define BDRV_O_TEMPORARY 0x0010 /* delete the file after use */ |
9f7965c7 AL |
101 | #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ |
102 | #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */ | |
5c6c3a6c | 103 | #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */ |
b783e409 | 104 | #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ |
016f5cf6 | 105 | #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */ |
53fec9d3 | 106 | #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */ |
ccb1f4a7 | 107 | #define BDRV_O_INCOMING 0x0800 /* consistency hint for incoming migration */ |
058f8f16 | 108 | #define BDRV_O_CHECK 0x1000 /* open solely for consistency check */ |
be028adc | 109 | #define BDRV_O_ALLOW_RDWR 0x2000 /* allow reopen to change from r/o to r/w */ |
9e8f1835 | 110 | #define BDRV_O_UNMAP 0x4000 /* execute guest UNMAP/TRIM operations */ |
2e40134b HR |
111 | #define BDRV_O_PROTOCOL 0x8000 /* if no block driver is explicitly given: |
112 | select an appropriate protocol driver, | |
113 | ignoring the format layer */ | |
9f7965c7 | 114 | |
ceb25e5c | 115 | #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH) |
faf07963 | 116 | |
6ea44308 | 117 | #define BDRV_SECTOR_BITS 9 |
c63782cb | 118 | #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS) |
3abbc4d9 | 119 | #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1) |
6ea44308 | 120 | |
4333bb71 PB |
121 | /* BDRV_BLOCK_DATA: data is read from bs->file or another file |
122 | * BDRV_BLOCK_ZERO: sectors read as zero | |
123 | * BDRV_BLOCK_OFFSET_VALID: sector stored in bs->file as raw data | |
e88ae226 KW |
124 | * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this |
125 | * layer (as opposed to the backing file) | |
92bc50a5 PL |
126 | * BDRV_BLOCK_RAW: used internally to indicate that the request |
127 | * was answered by the raw driver and that one | |
128 | * should look in bs->file directly. | |
4333bb71 PB |
129 | * |
130 | * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in | |
131 | * bs->file where sector data can be read from as raw data. | |
132 | * | |
133 | * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present. | |
134 | * | |
135 | * DATA ZERO OFFSET_VALID | |
136 | * t t t sectors read as zero, bs->file is zero at offset | |
137 | * t f t sectors read as valid from bs->file at offset | |
138 | * f t t sectors preallocated, read as zero, bs->file not | |
139 | * necessarily zero at offset | |
140 | * f f t sectors preallocated but read from backing_hd, | |
141 | * bs->file contains garbage at offset | |
142 | * t t f sectors preallocated, read as zero, unknown offset | |
143 | * t f f sectors read from unknown file or offset | |
144 | * f t f not allocated or unknown offset, read as zero | |
145 | * f f f not allocated or unknown offset, read from backing_hd | |
146 | */ | |
e88ae226 KW |
147 | #define BDRV_BLOCK_DATA 0x01 |
148 | #define BDRV_BLOCK_ZERO 0x02 | |
149 | #define BDRV_BLOCK_OFFSET_VALID 0x04 | |
150 | #define BDRV_BLOCK_RAW 0x08 | |
151 | #define BDRV_BLOCK_ALLOCATED 0x10 | |
4333bb71 PB |
152 | #define BDRV_BLOCK_OFFSET_MASK BDRV_SECTOR_MASK |
153 | ||
e971aa12 JC |
154 | typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue; |
155 | ||
156 | typedef struct BDRVReopenState { | |
157 | BlockDriverState *bs; | |
158 | int flags; | |
159 | void *opaque; | |
160 | } BDRVReopenState; | |
161 | ||
8574575f FZ |
162 | /* |
163 | * Block operation types | |
164 | */ | |
165 | typedef enum BlockOpType { | |
166 | BLOCK_OP_TYPE_BACKUP_SOURCE, | |
167 | BLOCK_OP_TYPE_BACKUP_TARGET, | |
168 | BLOCK_OP_TYPE_CHANGE, | |
169 | BLOCK_OP_TYPE_COMMIT, | |
170 | BLOCK_OP_TYPE_DATAPLANE, | |
171 | BLOCK_OP_TYPE_DRIVE_DEL, | |
172 | BLOCK_OP_TYPE_EJECT, | |
173 | BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, | |
174 | BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, | |
175 | BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, | |
176 | BLOCK_OP_TYPE_MIRROR, | |
177 | BLOCK_OP_TYPE_RESIZE, | |
178 | BLOCK_OP_TYPE_STREAM, | |
09158f00 | 179 | BLOCK_OP_TYPE_REPLACE, |
8574575f FZ |
180 | BLOCK_OP_TYPE_MAX, |
181 | } BlockOpType; | |
e971aa12 | 182 | |
28a7282a LC |
183 | void bdrv_iostatus_enable(BlockDriverState *bs); |
184 | void bdrv_iostatus_reset(BlockDriverState *bs); | |
185 | void bdrv_iostatus_disable(BlockDriverState *bs); | |
186 | bool bdrv_iostatus_is_enabled(const BlockDriverState *bs); | |
187 | void bdrv_iostatus_set_err(BlockDriverState *bs, int error); | |
d15e5465 LC |
188 | void bdrv_info_print(Monitor *mon, const QObject *data); |
189 | void bdrv_info(Monitor *mon, QObject **ret_data); | |
218a536a LC |
190 | void bdrv_stats_print(Monitor *mon, const QObject *data); |
191 | void bdrv_info_stats(Monitor *mon, QObject **ret_data); | |
faf07963 | 192 | |
0563e191 ZYW |
193 | /* disk I/O throttling */ |
194 | void bdrv_io_limits_enable(BlockDriverState *bs); | |
98f90dba | 195 | void bdrv_io_limits_disable(BlockDriverState *bs); |
0563e191 | 196 | |
faf07963 | 197 | void bdrv_init(void); |
eb852011 | 198 | void bdrv_init_with_whitelist(void); |
98289620 KW |
199 | BlockDriver *bdrv_find_protocol(const char *filename, |
200 | bool allow_protocol_prefix); | |
faf07963 | 201 | BlockDriver *bdrv_find_format(const char *format_name); |
b64ec4e4 FZ |
202 | BlockDriver *bdrv_find_whitelisted_format(const char *format_name, |
203 | bool readonly); | |
0e7e1989 | 204 | int bdrv_create(BlockDriver *drv, const char* filename, |
c282e1fd CL |
205 | QemuOpts *opts, Error **errp); |
206 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp); | |
98522f63 | 207 | BlockDriverState *bdrv_new(const char *device_name, Error **errp); |
d22b2f41 | 208 | void bdrv_make_anon(BlockDriverState *bs); |
4ddc07ca | 209 | void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old); |
8802d1fd | 210 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top); |
c3993cdc | 211 | int bdrv_parse_cache_flags(const char *mode, int *flags); |
9e8f1835 | 212 | int bdrv_parse_discard_flags(const char *mode, int *flags); |
da557aac HR |
213 | int bdrv_open_image(BlockDriverState **pbs, const char *filename, |
214 | QDict *options, const char *bdref_key, int flags, | |
f7d9fd8c | 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 HR |
219 | int bdrv_open(BlockDriverState **pbs, const char *filename, |
220 | const char *reference, QDict *options, int flags, | |
221 | BlockDriver *drv, Error **errp); | |
e971aa12 JC |
222 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
223 | BlockDriverState *bs, int flags); | |
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); |
fa879d62 MA |
232 | int bdrv_attach_dev(BlockDriverState *bs, void *dev); |
233 | void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev); | |
234 | void bdrv_detach_dev(BlockDriverState *bs, void *dev); | |
235 | void *bdrv_get_attached_dev(BlockDriverState *bs); | |
0e49de52 MA |
236 | void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops, |
237 | void *opaque); | |
025ccaa7 | 238 | void bdrv_dev_eject_request(BlockDriverState *bs, bool force); |
2c6942fa | 239 | bool bdrv_dev_has_removable_media(BlockDriverState *bs); |
e4def80b | 240 | bool bdrv_dev_is_tray_open(BlockDriverState *bs); |
f107639a | 241 | bool bdrv_dev_is_medium_locked(BlockDriverState *bs); |
faf07963 PB |
242 | int bdrv_read(BlockDriverState *bs, int64_t sector_num, |
243 | uint8_t *buf, int nb_sectors); | |
07d27a44 MA |
244 | int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num, |
245 | uint8_t *buf, int nb_sectors); | |
faf07963 PB |
246 | int bdrv_write(BlockDriverState *bs, int64_t sector_num, |
247 | const uint8_t *buf, int nb_sectors); | |
4105eaaa | 248 | int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num, |
aa7bfbff | 249 | int nb_sectors, BdrvRequestFlags flags); |
d5ef94d4 PB |
250 | BlockDriverAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num, |
251 | int nb_sectors, BdrvRequestFlags flags, | |
252 | BlockDriverCompletionFunc *cb, void *opaque); | |
d75cbb5e | 253 | int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags); |
faf07963 PB |
254 | int bdrv_pread(BlockDriverState *bs, int64_t offset, |
255 | void *buf, int count); | |
256 | int bdrv_pwrite(BlockDriverState *bs, int64_t offset, | |
257 | const void *buf, int count); | |
8d3b1a2d | 258 | int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov); |
f08145fe KW |
259 | int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset, |
260 | const void *buf, int count); | |
da1fa91d KW |
261 | int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num, |
262 | int nb_sectors, QEMUIOVector *qiov); | |
470c0504 SH |
263 | int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs, |
264 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov); | |
da1fa91d KW |
265 | int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num, |
266 | int nb_sectors, QEMUIOVector *qiov); | |
f08f2dda SH |
267 | /* |
268 | * Efficiently zero a region of the disk image. Note that this is a regular | |
269 | * I/O request like read or write and should have a reasonable size. This | |
270 | * function is not suitable for zeroing the entire image in a single request | |
271 | * because it may allocate memory for the entire region. | |
272 | */ | |
273 | int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num, | |
aa7bfbff | 274 | int nb_sectors, BdrvRequestFlags flags); |
e8a6bb9c MT |
275 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, |
276 | const char *backing_file); | |
f198fd1c | 277 | int bdrv_get_backing_file_depth(BlockDriverState *bs); |
91af7014 | 278 | void bdrv_refresh_filename(BlockDriverState *bs); |
faf07963 | 279 | int bdrv_truncate(BlockDriverState *bs, int64_t offset); |
65a9bb25 | 280 | int64_t bdrv_nb_sectors(BlockDriverState *bs); |
faf07963 | 281 | int64_t bdrv_getlength(BlockDriverState *bs); |
4a1d5e1f | 282 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); |
96b8f136 | 283 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); |
3baca891 | 284 | void bdrv_refresh_limits(BlockDriverState *bs, Error **errp); |
faf07963 | 285 | int bdrv_commit(BlockDriverState *bs); |
e8877497 | 286 | int bdrv_commit_all(void); |
756e6736 KW |
287 | int bdrv_change_backing_file(BlockDriverState *bs, |
288 | const char *backing_file, const char *backing_fmt); | |
5efa9d5a | 289 | void bdrv_register(BlockDriver *bdrv); |
6ebdcee2 | 290 | int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, |
54e26900 JC |
291 | BlockDriverState *base, |
292 | const char *backing_file_str); | |
6ebdcee2 JC |
293 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, |
294 | BlockDriverState *bs); | |
79fac568 | 295 | BlockDriverState *bdrv_find_base(BlockDriverState *bs); |
5efa9d5a | 296 | |
e076f338 KW |
297 | |
298 | typedef struct BdrvCheckResult { | |
299 | int corruptions; | |
300 | int leaks; | |
301 | int check_errors; | |
ccf34716 KW |
302 | int corruptions_fixed; |
303 | int leaks_fixed; | |
c6bb9ad1 | 304 | int64_t image_end_offset; |
f8111c24 | 305 | BlockFragInfo bfi; |
e076f338 KW |
306 | } BdrvCheckResult; |
307 | ||
4534ff54 KW |
308 | typedef enum { |
309 | BDRV_FIX_LEAKS = 1, | |
310 | BDRV_FIX_ERRORS = 2, | |
311 | } BdrvCheckMode; | |
312 | ||
313 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix); | |
e076f338 | 314 | |
c282e1fd | 315 | int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts); |
6f176b48 | 316 | |
f6186f49 | 317 | /* external snapshots */ |
212a5a8f BC |
318 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
319 | BlockDriverState *candidate); | |
320 | bool bdrv_is_first_non_filter(BlockDriverState *candidate); | |
f6186f49 | 321 | |
09158f00 BC |
322 | /* check if a named node can be replaced when doing drive-mirror */ |
323 | BlockDriverState *check_to_replace_node(const char *node_name, Error **errp); | |
324 | ||
faf07963 | 325 | /* async block I/O */ |
7cd1e32a | 326 | typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector, |
39aa9a12 | 327 | int sector_num); |
3b69e4b9 AL |
328 | BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num, |
329 | QEMUIOVector *iov, int nb_sectors, | |
330 | BlockDriverCompletionFunc *cb, void *opaque); | |
331 | BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num, | |
332 | QEMUIOVector *iov, int nb_sectors, | |
333 | BlockDriverCompletionFunc *cb, void *opaque); | |
b2e12bc6 | 334 | BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs, |
39aa9a12 | 335 | BlockDriverCompletionFunc *cb, void *opaque); |
4265d620 PB |
336 | BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs, |
337 | int64_t sector_num, int nb_sectors, | |
338 | BlockDriverCompletionFunc *cb, void *opaque); | |
faf07963 PB |
339 | void bdrv_aio_cancel(BlockDriverAIOCB *acb); |
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 KW |
346 | QEMUIOVector *qiov; |
347 | BlockDriverCompletionFunc *cb; | |
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 AL |
358 | int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); |
359 | BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, | |
360 | unsigned long int req, void *buf, | |
361 | BlockDriverCompletionFunc *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 | |
07789269 BC |
367 | void bdrv_clear_incoming_migration_all(void); |
368 | ||
faf07963 | 369 | /* Ensure contents are flushed to disk. */ |
205ef796 | 370 | int bdrv_flush(BlockDriverState *bs); |
07f07615 | 371 | int coroutine_fn bdrv_co_flush(BlockDriverState *bs); |
f0f0fdfe | 372 | int bdrv_flush_all(void); |
2bc93fed | 373 | void bdrv_close_all(void); |
922453bc | 374 | void bdrv_drain_all(void); |
c6ca28d6 | 375 | |
bb8bf76f | 376 | int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); |
4265d620 | 377 | int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); |
3ac21627 | 378 | int bdrv_has_zero_init_1(BlockDriverState *bs); |
f2feebbd | 379 | int bdrv_has_zero_init(BlockDriverState *bs); |
4ce78691 PL |
380 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs); |
381 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs); | |
b6b8a333 PB |
382 | int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num, |
383 | int nb_sectors, int *pnum); | |
f58c7b35 | 384 | int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, |
39aa9a12 | 385 | int *pnum); |
b35b2bba MR |
386 | int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base, |
387 | int64_t sector_num, int nb_sectors, int *pnum); | |
faf07963 | 388 | |
ff06f5f3 PB |
389 | void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error, |
390 | BlockdevOnError on_write_error); | |
1ceee0d5 | 391 | BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read); |
3e1caa5f PB |
392 | BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error); |
393 | void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action, | |
394 | bool is_read, int error); | |
faf07963 | 395 | int bdrv_is_read_only(BlockDriverState *bs); |
985a03b0 | 396 | int bdrv_is_sg(BlockDriverState *bs); |
e900a7b7 | 397 | int bdrv_enable_write_cache(BlockDriverState *bs); |
425b0148 | 398 | void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce); |
faf07963 PB |
399 | int bdrv_is_inserted(BlockDriverState *bs); |
400 | int bdrv_media_changed(BlockDriverState *bs); | |
025e849a | 401 | void bdrv_lock_medium(BlockDriverState *bs, bool locked); |
f36f3949 | 402 | void bdrv_eject(BlockDriverState *bs, bool eject_flag); |
f8d6bba1 | 403 | const char *bdrv_get_format_name(BlockDriverState *bs); |
faf07963 | 404 | BlockDriverState *bdrv_find(const char *name); |
dc364f4c | 405 | BlockDriverState *bdrv_find_node(const char *node_name); |
c13163fb | 406 | BlockDeviceInfoList *bdrv_named_nodes_list(void); |
12d3ba82 BC |
407 | BlockDriverState *bdrv_lookup_bs(const char *device, |
408 | const char *node_name, | |
409 | Error **errp); | |
5a6684d2 | 410 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base); |
2f399b0a | 411 | BlockDriverState *bdrv_next(BlockDriverState *bs); |
51de9760 AL |
412 | void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), |
413 | void *opaque); | |
faf07963 | 414 | int bdrv_is_encrypted(BlockDriverState *bs); |
c0f4ce77 | 415 | int bdrv_key_required(BlockDriverState *bs); |
faf07963 | 416 | int bdrv_set_key(BlockDriverState *bs, const char *key); |
c0f4ce77 | 417 | int bdrv_query_missing_keys(void); |
faf07963 PB |
418 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
419 | void *opaque); | |
420 | const char *bdrv_get_device_name(BlockDriverState *bs); | |
c8433287 | 421 | int bdrv_get_flags(BlockDriverState *bs); |
faf07963 PB |
422 | int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, |
423 | const uint8_t *buf, int nb_sectors); | |
424 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); | |
eae041fe | 425 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs); |
343bded4 PB |
426 | void bdrv_round_to_clusters(BlockDriverState *bs, |
427 | int64_t sector_num, int nb_sectors, | |
428 | int64_t *cluster_sector_num, | |
429 | int *cluster_nb_sectors); | |
faf07963 | 430 | |
045df330 | 431 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs); |
faf07963 PB |
432 | void bdrv_get_backing_filename(BlockDriverState *bs, |
433 | char *filename, int filename_size); | |
dc5a1371 PB |
434 | void bdrv_get_full_backing_filename(BlockDriverState *bs, |
435 | char *dest, size_t sz); | |
199630b6 | 436 | int bdrv_is_snapshot(BlockDriverState *bs); |
faf07963 | 437 | |
faf07963 PB |
438 | int path_is_absolute(const char *path); |
439 | void path_combine(char *dest, int dest_size, | |
440 | const char *base_path, | |
441 | const char *filename); | |
442 | ||
cf8074b3 | 443 | int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos); |
45566e9c CH |
444 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
445 | int64_t pos, int size); | |
178e08a5 | 446 | |
45566e9c CH |
447 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
448 | int64_t pos, int size); | |
178e08a5 | 449 | |
d92ada22 LC |
450 | void bdrv_img_create(const char *filename, const char *fmt, |
451 | const char *base_filename, const char *base_fmt, | |
f382d43a MR |
452 | char *options, uint64_t img_size, int flags, |
453 | Error **errp, bool quiet); | |
f88e1a42 | 454 | |
339064d5 KW |
455 | /* Returns the alignment in bytes that is required so that no bounce buffer |
456 | * is required throughout the stack */ | |
457 | size_t bdrv_opt_mem_align(BlockDriverState *bs); | |
1b7fd729 | 458 | void bdrv_set_guest_block_size(BlockDriverState *bs, int align); |
ba5b7ad4 | 459 | void *qemu_blockalign(BlockDriverState *bs, size_t size); |
7d2a35cc | 460 | void *qemu_try_blockalign(BlockDriverState *bs, size_t size); |
c53b1c51 | 461 | bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov); |
ba5b7ad4 | 462 | |
8f0720ec | 463 | struct HBitmapIter; |
e4654d2d | 464 | typedef struct BdrvDirtyBitmap BdrvDirtyBitmap; |
b8afb520 FZ |
465 | BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs, int granularity, |
466 | Error **errp); | |
e4654d2d | 467 | void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap); |
21b56835 | 468 | BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs); |
e4654d2d | 469 | int bdrv_get_dirty(BlockDriverState *bs, BdrvDirtyBitmap *bitmap, int64_t sector); |
1755da16 PB |
470 | void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); |
471 | void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors); | |
e4654d2d FZ |
472 | void bdrv_dirty_iter_init(BlockDriverState *bs, |
473 | BdrvDirtyBitmap *bitmap, struct HBitmapIter *hbi); | |
474 | int64_t bdrv_get_dirty_count(BlockDriverState *bs, BdrvDirtyBitmap *bitmap); | |
8b9b0cc2 | 475 | |
53fec9d3 SH |
476 | void bdrv_enable_copy_on_read(BlockDriverState *bs); |
477 | void bdrv_disable_copy_on_read(BlockDriverState *bs); | |
478 | ||
9fcb0251 FZ |
479 | void bdrv_ref(BlockDriverState *bs); |
480 | void bdrv_unref(BlockDriverState *bs); | |
8b9b0cc2 | 481 | |
fbe40ff7 FZ |
482 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp); |
483 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason); | |
484 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason); | |
485 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason); | |
486 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason); | |
487 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs); | |
488 | ||
8b9b0cc2 | 489 | typedef enum { |
8252278a KW |
490 | BLKDBG_L1_UPDATE, |
491 | ||
492 | BLKDBG_L1_GROW_ALLOC_TABLE, | |
493 | BLKDBG_L1_GROW_WRITE_TABLE, | |
494 | BLKDBG_L1_GROW_ACTIVATE_TABLE, | |
495 | ||
496 | BLKDBG_L2_LOAD, | |
497 | BLKDBG_L2_UPDATE, | |
498 | BLKDBG_L2_UPDATE_COMPRESSED, | |
499 | BLKDBG_L2_ALLOC_COW_READ, | |
500 | BLKDBG_L2_ALLOC_WRITE, | |
501 | ||
8252278a | 502 | BLKDBG_READ_AIO, |
8252278a KW |
503 | BLKDBG_READ_BACKING_AIO, |
504 | BLKDBG_READ_COMPRESSED, | |
505 | ||
506 | BLKDBG_WRITE_AIO, | |
507 | BLKDBG_WRITE_COMPRESSED, | |
508 | ||
509 | BLKDBG_VMSTATE_LOAD, | |
510 | BLKDBG_VMSTATE_SAVE, | |
511 | ||
512 | BLKDBG_COW_READ, | |
513 | BLKDBG_COW_WRITE, | |
514 | ||
515 | BLKDBG_REFTABLE_LOAD, | |
516 | BLKDBG_REFTABLE_GROW, | |
afa50193 | 517 | BLKDBG_REFTABLE_UPDATE, |
8252278a KW |
518 | |
519 | BLKDBG_REFBLOCK_LOAD, | |
520 | BLKDBG_REFBLOCK_UPDATE, | |
521 | BLKDBG_REFBLOCK_UPDATE_PART, | |
522 | BLKDBG_REFBLOCK_ALLOC, | |
523 | BLKDBG_REFBLOCK_ALLOC_HOOKUP, | |
524 | BLKDBG_REFBLOCK_ALLOC_WRITE, | |
525 | BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS, | |
526 | BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE, | |
527 | BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE, | |
528 | ||
529 | BLKDBG_CLUSTER_ALLOC, | |
530 | BLKDBG_CLUSTER_ALLOC_BYTES, | |
531 | BLKDBG_CLUSTER_FREE, | |
532 | ||
bf736fe3 KW |
533 | BLKDBG_FLUSH_TO_OS, |
534 | BLKDBG_FLUSH_TO_DISK, | |
535 | ||
9e1cb96d KW |
536 | BLKDBG_PWRITEV_RMW_HEAD, |
537 | BLKDBG_PWRITEV_RMW_AFTER_HEAD, | |
538 | BLKDBG_PWRITEV_RMW_TAIL, | |
539 | BLKDBG_PWRITEV_RMW_AFTER_TAIL, | |
540 | BLKDBG_PWRITEV, | |
541 | BLKDBG_PWRITEV_ZERO, | |
542 | BLKDBG_PWRITEV_DONE, | |
543 | ||
8b9b0cc2 KW |
544 | BLKDBG_EVENT_MAX, |
545 | } BlkDebugEvent; | |
546 | ||
547 | #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt) | |
548 | void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event); | |
549 | ||
41c695c7 KW |
550 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
551 | const char *tag); | |
4cc70e93 | 552 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag); |
41c695c7 KW |
553 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag); |
554 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag); | |
555 | ||
db519cba FZ |
556 | /** |
557 | * bdrv_get_aio_context: | |
558 | * | |
559 | * Returns: the currently bound #AioContext | |
560 | */ | |
561 | AioContext *bdrv_get_aio_context(BlockDriverState *bs); | |
562 | ||
dcd04228 SH |
563 | /** |
564 | * bdrv_set_aio_context: | |
565 | * | |
566 | * Changes the #AioContext used for fd handlers, timers, and BHs by this | |
567 | * BlockDriverState and all its children. | |
568 | * | |
569 | * This function must be called from the old #AioContext or with a lock held so | |
570 | * the old #AioContext is not executing. | |
571 | */ | |
572 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context); | |
573 | ||
448ad91d ML |
574 | void bdrv_io_plug(BlockDriverState *bs); |
575 | void bdrv_io_unplug(BlockDriverState *bs); | |
576 | void bdrv_flush_io_queue(BlockDriverState *bs); | |
577 | ||
5366d0c8 BC |
578 | BlockAcctStats *bdrv_get_stats(BlockDriverState *bs); |
579 | ||
8a4bc5aa | 580 | #endif |