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