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