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