xref: /openbmc/qemu/include/block/block.h (revision 0b7e89b1)
1 #ifndef BLOCK_H
2 #define BLOCK_H
3 
4 #include "block/aio.h"
5 #include "qemu-common.h"
6 #include "qemu/option.h"
7 #include "block/coroutine.h"
8 #include "block/accounting.h"
9 #include "qapi/qmp/qobject.h"
10 #include "qapi-types.h"
11 
12 /* block.c */
13 typedef struct BlockDriver BlockDriver;
14 typedef struct BlockJob BlockJob;
15 
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;
21     bool is_dirty;
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;
38     /*
39      * True if this block driver only supports compressed writes
40      */
41     bool needs_compressed_writes;
42 } BlockDriverInfo;
43 
44 typedef struct BlockFragInfo {
45     uint64_t allocated_clusters;
46     uint64_t total_clusters;
47     uint64_t fragmented_clusters;
48     uint64_t compressed_clusters;
49 } BlockFragInfo;
50 
51 typedef enum {
52     BDRV_REQ_COPY_ON_READ = 0x1,
53     BDRV_REQ_ZERO_WRITE   = 0x2,
54     /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver
55      * is allowed to optimize a write zeroes request by unmapping (discarding)
56      * blocks if it is guaranteed that the result will read back as
57      * zeroes. The flag is only passed to the driver if the block device is
58      * opened with BDRV_O_UNMAP.
59      */
60     BDRV_REQ_MAY_UNMAP    = 0x4,
61 } BdrvRequestFlags;
62 
63 #define BDRV_O_RDWR        0x0002
64 #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
65 #define BDRV_O_TEMPORARY   0x0010 /* delete the file after use */
66 #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
67 #define BDRV_O_CACHE_WB    0x0040 /* use write-back caching */
68 #define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */
69 #define BDRV_O_NO_BACKING  0x0100 /* don't open the backing file */
70 #define BDRV_O_NO_FLUSH    0x0200 /* disable flushing on this disk */
71 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
72 #define BDRV_O_INCOMING    0x0800  /* consistency hint for incoming migration */
73 #define BDRV_O_CHECK       0x1000  /* open solely for consistency check */
74 #define BDRV_O_ALLOW_RDWR  0x2000  /* allow reopen to change from r/o to r/w */
75 #define BDRV_O_UNMAP       0x4000  /* execute guest UNMAP/TRIM operations */
76 #define BDRV_O_PROTOCOL    0x8000  /* if no block driver is explicitly given:
77                                       select an appropriate protocol driver,
78                                       ignoring the format layer */
79 
80 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
81 
82 #define BDRV_SECTOR_BITS   9
83 #define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
84 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
85 
86 #define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \
87                                      INT_MAX >> BDRV_SECTOR_BITS)
88 
89 /*
90  * Allocation status flags
91  * BDRV_BLOCK_DATA: data is read from bs->file or another file
92  * BDRV_BLOCK_ZERO: sectors read as zero
93  * BDRV_BLOCK_OFFSET_VALID: sector stored in bs->file as raw data
94  * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this
95  *                       layer (as opposed to the backing file)
96  * BDRV_BLOCK_RAW: used internally to indicate that the request
97  *                 was answered by the raw driver and that one
98  *                 should look in bs->file directly.
99  *
100  * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
101  * bs->file where sector data can be read from as raw data.
102  *
103  * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
104  *
105  * DATA ZERO OFFSET_VALID
106  *  t    t        t       sectors read as zero, bs->file is zero at offset
107  *  t    f        t       sectors read as valid from bs->file at offset
108  *  f    t        t       sectors preallocated, read as zero, bs->file not
109  *                        necessarily zero at offset
110  *  f    f        t       sectors preallocated but read from backing_hd,
111  *                        bs->file contains garbage at offset
112  *  t    t        f       sectors preallocated, read as zero, unknown offset
113  *  t    f        f       sectors read from unknown file or offset
114  *  f    t        f       not allocated or unknown offset, read as zero
115  *  f    f        f       not allocated or unknown offset, read from backing_hd
116  */
117 #define BDRV_BLOCK_DATA         0x01
118 #define BDRV_BLOCK_ZERO         0x02
119 #define BDRV_BLOCK_OFFSET_VALID 0x04
120 #define BDRV_BLOCK_RAW          0x08
121 #define BDRV_BLOCK_ALLOCATED    0x10
122 #define BDRV_BLOCK_OFFSET_MASK  BDRV_SECTOR_MASK
123 
124 typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
125 
126 typedef struct BDRVReopenState {
127     BlockDriverState *bs;
128     int flags;
129     void *opaque;
130 } BDRVReopenState;
131 
132 /*
133  * Block operation types
134  */
135 typedef enum BlockOpType {
136     BLOCK_OP_TYPE_BACKUP_SOURCE,
137     BLOCK_OP_TYPE_BACKUP_TARGET,
138     BLOCK_OP_TYPE_CHANGE,
139     BLOCK_OP_TYPE_COMMIT_SOURCE,
140     BLOCK_OP_TYPE_COMMIT_TARGET,
141     BLOCK_OP_TYPE_DATAPLANE,
142     BLOCK_OP_TYPE_DRIVE_DEL,
143     BLOCK_OP_TYPE_EJECT,
144     BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
145     BLOCK_OP_TYPE_INTERNAL_SNAPSHOT,
146     BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE,
147     BLOCK_OP_TYPE_MIRROR,
148     BLOCK_OP_TYPE_RESIZE,
149     BLOCK_OP_TYPE_STREAM,
150     BLOCK_OP_TYPE_REPLACE,
151     BLOCK_OP_TYPE_MAX,
152 } BlockOpType;
153 
154 void bdrv_iostatus_enable(BlockDriverState *bs);
155 void bdrv_iostatus_reset(BlockDriverState *bs);
156 void bdrv_iostatus_disable(BlockDriverState *bs);
157 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
158 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
159 void bdrv_info_print(Monitor *mon, const QObject *data);
160 void bdrv_info(Monitor *mon, QObject **ret_data);
161 void bdrv_stats_print(Monitor *mon, const QObject *data);
162 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
163 
164 /* disk I/O throttling */
165 void bdrv_io_limits_enable(BlockDriverState *bs);
166 void bdrv_io_limits_disable(BlockDriverState *bs);
167 
168 void bdrv_init(void);
169 void bdrv_init_with_whitelist(void);
170 BlockDriver *bdrv_find_protocol(const char *filename,
171                                 bool allow_protocol_prefix,
172                                 Error **errp);
173 BlockDriver *bdrv_find_format(const char *format_name);
174 BlockDriver *bdrv_find_whitelisted_format(const char *format_name,
175                                           bool readonly);
176 int bdrv_create(BlockDriver *drv, const char* filename,
177                 QemuOpts *opts, Error **errp);
178 int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
179 BlockDriverState *bdrv_new_root(void);
180 BlockDriverState *bdrv_new(void);
181 void bdrv_make_anon(BlockDriverState *bs);
182 void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
183 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
184 int bdrv_parse_cache_flags(const char *mode, int *flags);
185 int bdrv_parse_discard_flags(const char *mode, int *flags);
186 int bdrv_open_image(BlockDriverState **pbs, const char *filename,
187                     QDict *options, const char *bdref_key, int flags,
188                     bool allow_none, Error **errp);
189 void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
190 int bdrv_open_backing_file(BlockDriverState *bs, QDict *options, Error **errp);
191 int bdrv_append_temp_snapshot(BlockDriverState *bs, int flags, Error **errp);
192 int bdrv_open(BlockDriverState **pbs, const char *filename,
193               const char *reference, QDict *options, int flags,
194               BlockDriver *drv, Error **errp);
195 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
196                                     BlockDriverState *bs, int flags);
197 int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
198 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
199 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
200                         BlockReopenQueue *queue, Error **errp);
201 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
202 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
203 void bdrv_close(BlockDriverState *bs);
204 void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
205 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
206               uint8_t *buf, int nb_sectors);
207 int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
208                           uint8_t *buf, int nb_sectors);
209 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
210                const uint8_t *buf, int nb_sectors);
211 int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
212                int nb_sectors, BdrvRequestFlags flags);
213 BlockAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num,
214                                   int nb_sectors, BdrvRequestFlags flags,
215                                   BlockCompletionFunc *cb, void *opaque);
216 int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
217 int bdrv_pread(BlockDriverState *bs, int64_t offset,
218                void *buf, int count);
219 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
220                 const void *buf, int count);
221 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
222 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
223     const void *buf, int count);
224 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
225     int nb_sectors, QEMUIOVector *qiov);
226 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
227     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
228 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
229     int nb_sectors, QEMUIOVector *qiov);
230 /*
231  * Efficiently zero a region of the disk image.  Note that this is a regular
232  * I/O request like read or write and should have a reasonable size.  This
233  * function is not suitable for zeroing the entire image in a single request
234  * because it may allocate memory for the entire region.
235  */
236 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
237     int nb_sectors, BdrvRequestFlags flags);
238 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
239     const char *backing_file);
240 int bdrv_get_backing_file_depth(BlockDriverState *bs);
241 void bdrv_refresh_filename(BlockDriverState *bs);
242 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
243 int64_t bdrv_nb_sectors(BlockDriverState *bs);
244 int64_t bdrv_getlength(BlockDriverState *bs);
245 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
246 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
247 void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
248 int bdrv_commit(BlockDriverState *bs);
249 int bdrv_commit_all(void);
250 int bdrv_change_backing_file(BlockDriverState *bs,
251     const char *backing_file, const char *backing_fmt);
252 void bdrv_register(BlockDriver *bdrv);
253 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
254                            BlockDriverState *base,
255                            const char *backing_file_str);
256 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
257                                     BlockDriverState *bs);
258 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
259 
260 
261 typedef struct BdrvCheckResult {
262     int corruptions;
263     int leaks;
264     int check_errors;
265     int corruptions_fixed;
266     int leaks_fixed;
267     int64_t image_end_offset;
268     BlockFragInfo bfi;
269 } BdrvCheckResult;
270 
271 typedef enum {
272     BDRV_FIX_LEAKS    = 1,
273     BDRV_FIX_ERRORS   = 2,
274 } BdrvCheckMode;
275 
276 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
277 
278 /* The units of offset and total_work_size may be chosen arbitrarily by the
279  * block driver; total_work_size may change during the course of the amendment
280  * operation */
281 typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset,
282                                       int64_t total_work_size);
283 int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
284                        BlockDriverAmendStatusCB *status_cb);
285 
286 /* external snapshots */
287 bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
288                                       BlockDriverState *candidate);
289 bool bdrv_is_first_non_filter(BlockDriverState *candidate);
290 
291 /* check if a named node can be replaced when doing drive-mirror */
292 BlockDriverState *check_to_replace_node(const char *node_name, Error **errp);
293 
294 /* async block I/O */
295 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
296                                      int sector_num);
297 BlockAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
298                            QEMUIOVector *iov, int nb_sectors,
299                            BlockCompletionFunc *cb, void *opaque);
300 BlockAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
301                             QEMUIOVector *iov, int nb_sectors,
302                             BlockCompletionFunc *cb, void *opaque);
303 BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
304                            BlockCompletionFunc *cb, void *opaque);
305 BlockAIOCB *bdrv_aio_discard(BlockDriverState *bs,
306                              int64_t sector_num, int nb_sectors,
307                              BlockCompletionFunc *cb, void *opaque);
308 void bdrv_aio_cancel(BlockAIOCB *acb);
309 void bdrv_aio_cancel_async(BlockAIOCB *acb);
310 
311 typedef struct BlockRequest {
312     /* Fields to be filled by multiwrite caller */
313     int64_t sector;
314     int nb_sectors;
315     int flags;
316     QEMUIOVector *qiov;
317     BlockCompletionFunc *cb;
318     void *opaque;
319 
320     /* Filled by multiwrite implementation */
321     int error;
322 } BlockRequest;
323 
324 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
325     int num_reqs);
326 
327 /* sg packet commands */
328 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
329 BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
330         unsigned long int req, void *buf,
331         BlockCompletionFunc *cb, void *opaque);
332 
333 /* Invalidate any cached metadata used by image formats */
334 void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
335 void bdrv_invalidate_cache_all(Error **errp);
336 
337 /* Ensure contents are flushed to disk.  */
338 int bdrv_flush(BlockDriverState *bs);
339 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
340 int bdrv_flush_all(void);
341 void bdrv_close_all(void);
342 void bdrv_drain(BlockDriverState *bs);
343 void bdrv_drain_all(void);
344 
345 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
346 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
347 int bdrv_has_zero_init_1(BlockDriverState *bs);
348 int bdrv_has_zero_init(BlockDriverState *bs);
349 bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
350 bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
351 int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
352                               int nb_sectors, int *pnum);
353 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
354                       int *pnum);
355 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
356                             int64_t sector_num, int nb_sectors, int *pnum);
357 
358 void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
359                        BlockdevOnError on_write_error);
360 BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
361 BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
362 void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
363                        bool is_read, int error);
364 int bdrv_is_read_only(BlockDriverState *bs);
365 int bdrv_is_sg(BlockDriverState *bs);
366 int bdrv_enable_write_cache(BlockDriverState *bs);
367 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
368 int bdrv_is_inserted(BlockDriverState *bs);
369 int bdrv_media_changed(BlockDriverState *bs);
370 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
371 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
372 const char *bdrv_get_format_name(BlockDriverState *bs);
373 BlockDriverState *bdrv_find(const char *name);
374 BlockDriverState *bdrv_find_node(const char *node_name);
375 BlockDeviceInfoList *bdrv_named_nodes_list(void);
376 BlockDriverState *bdrv_lookup_bs(const char *device,
377                                  const char *node_name,
378                                  Error **errp);
379 bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
380 BlockDriverState *bdrv_next_node(BlockDriverState *bs);
381 BlockDriverState *bdrv_next(BlockDriverState *bs);
382 int bdrv_is_encrypted(BlockDriverState *bs);
383 int bdrv_key_required(BlockDriverState *bs);
384 int bdrv_set_key(BlockDriverState *bs, const char *key);
385 void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp);
386 int bdrv_query_missing_keys(void);
387 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
388                          void *opaque);
389 const char *bdrv_get_node_name(const BlockDriverState *bs);
390 const char *bdrv_get_device_name(const BlockDriverState *bs);
391 int bdrv_get_flags(BlockDriverState *bs);
392 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
393                           const uint8_t *buf, int nb_sectors);
394 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
395 ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
396 void bdrv_round_to_clusters(BlockDriverState *bs,
397                             int64_t sector_num, int nb_sectors,
398                             int64_t *cluster_sector_num,
399                             int *cluster_nb_sectors);
400 
401 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
402 void bdrv_get_backing_filename(BlockDriverState *bs,
403                                char *filename, int filename_size);
404 void bdrv_get_full_backing_filename(BlockDriverState *bs,
405                                     char *dest, size_t sz, Error **errp);
406 void bdrv_get_full_backing_filename_from_filename(const char *backed,
407                                                   const char *backing,
408                                                   char *dest, size_t sz,
409                                                   Error **errp);
410 int bdrv_is_snapshot(BlockDriverState *bs);
411 
412 int path_has_protocol(const char *path);
413 int path_is_absolute(const char *path);
414 void path_combine(char *dest, int dest_size,
415                   const char *base_path,
416                   const char *filename);
417 
418 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
419 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
420                       int64_t pos, int size);
421 
422 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
423                       int64_t pos, int size);
424 
425 void bdrv_img_create(const char *filename, const char *fmt,
426                      const char *base_filename, const char *base_fmt,
427                      char *options, uint64_t img_size, int flags,
428                      Error **errp, bool quiet);
429 
430 /* Returns the alignment in bytes that is required so that no bounce buffer
431  * is required throughout the stack */
432 size_t bdrv_opt_mem_align(BlockDriverState *bs);
433 void bdrv_set_guest_block_size(BlockDriverState *bs, int align);
434 void *qemu_blockalign(BlockDriverState *bs, size_t size);
435 void *qemu_blockalign0(BlockDriverState *bs, size_t size);
436 void *qemu_try_blockalign(BlockDriverState *bs, size_t size);
437 void *qemu_try_blockalign0(BlockDriverState *bs, size_t size);
438 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
439 
440 struct HBitmapIter;
441 typedef struct BdrvDirtyBitmap BdrvDirtyBitmap;
442 BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs, int granularity,
443                                           Error **errp);
444 void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
445 BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs);
446 int bdrv_get_dirty(BlockDriverState *bs, BdrvDirtyBitmap *bitmap, int64_t sector);
447 void bdrv_set_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap,
448                            int64_t cur_sector, int nr_sectors);
449 void bdrv_reset_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap,
450                              int64_t cur_sector, int nr_sectors);
451 void bdrv_dirty_iter_init(BlockDriverState *bs,
452                           BdrvDirtyBitmap *bitmap, struct HBitmapIter *hbi);
453 int64_t bdrv_get_dirty_count(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
454 
455 void bdrv_enable_copy_on_read(BlockDriverState *bs);
456 void bdrv_disable_copy_on_read(BlockDriverState *bs);
457 
458 void bdrv_ref(BlockDriverState *bs);
459 void bdrv_unref(BlockDriverState *bs);
460 
461 bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
462 void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
463 void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
464 void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
465 void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
466 bool bdrv_op_blocker_is_empty(BlockDriverState *bs);
467 
468 typedef enum {
469     BLKDBG_L1_UPDATE,
470 
471     BLKDBG_L1_GROW_ALLOC_TABLE,
472     BLKDBG_L1_GROW_WRITE_TABLE,
473     BLKDBG_L1_GROW_ACTIVATE_TABLE,
474 
475     BLKDBG_L2_LOAD,
476     BLKDBG_L2_UPDATE,
477     BLKDBG_L2_UPDATE_COMPRESSED,
478     BLKDBG_L2_ALLOC_COW_READ,
479     BLKDBG_L2_ALLOC_WRITE,
480 
481     BLKDBG_READ_AIO,
482     BLKDBG_READ_BACKING_AIO,
483     BLKDBG_READ_COMPRESSED,
484 
485     BLKDBG_WRITE_AIO,
486     BLKDBG_WRITE_COMPRESSED,
487 
488     BLKDBG_VMSTATE_LOAD,
489     BLKDBG_VMSTATE_SAVE,
490 
491     BLKDBG_COW_READ,
492     BLKDBG_COW_WRITE,
493 
494     BLKDBG_REFTABLE_LOAD,
495     BLKDBG_REFTABLE_GROW,
496     BLKDBG_REFTABLE_UPDATE,
497 
498     BLKDBG_REFBLOCK_LOAD,
499     BLKDBG_REFBLOCK_UPDATE,
500     BLKDBG_REFBLOCK_UPDATE_PART,
501     BLKDBG_REFBLOCK_ALLOC,
502     BLKDBG_REFBLOCK_ALLOC_HOOKUP,
503     BLKDBG_REFBLOCK_ALLOC_WRITE,
504     BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
505     BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
506     BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
507 
508     BLKDBG_CLUSTER_ALLOC,
509     BLKDBG_CLUSTER_ALLOC_BYTES,
510     BLKDBG_CLUSTER_FREE,
511 
512     BLKDBG_FLUSH_TO_OS,
513     BLKDBG_FLUSH_TO_DISK,
514 
515     BLKDBG_PWRITEV_RMW_HEAD,
516     BLKDBG_PWRITEV_RMW_AFTER_HEAD,
517     BLKDBG_PWRITEV_RMW_TAIL,
518     BLKDBG_PWRITEV_RMW_AFTER_TAIL,
519     BLKDBG_PWRITEV,
520     BLKDBG_PWRITEV_ZERO,
521     BLKDBG_PWRITEV_DONE,
522 
523     BLKDBG_EMPTY_IMAGE_PREPARE,
524 
525     BLKDBG_EVENT_MAX,
526 } BlkDebugEvent;
527 
528 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
529 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
530 
531 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
532                            const char *tag);
533 int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
534 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
535 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
536 
537 /**
538  * bdrv_get_aio_context:
539  *
540  * Returns: the currently bound #AioContext
541  */
542 AioContext *bdrv_get_aio_context(BlockDriverState *bs);
543 
544 /**
545  * bdrv_set_aio_context:
546  *
547  * Changes the #AioContext used for fd handlers, timers, and BHs by this
548  * BlockDriverState and all its children.
549  *
550  * This function must be called from the old #AioContext or with a lock held so
551  * the old #AioContext is not executing.
552  */
553 void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
554 
555 void bdrv_io_plug(BlockDriverState *bs);
556 void bdrv_io_unplug(BlockDriverState *bs);
557 void bdrv_flush_io_queue(BlockDriverState *bs);
558 
559 BlockAcctStats *bdrv_get_stats(BlockDriverState *bs);
560 
561 #endif
562