xref: /openbmc/qemu/include/block/block.h (revision 5692399f)
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_REPLACE,
179     BLOCK_OP_TYPE_MAX,
180 } BlockOpType;
181 
182 void bdrv_iostatus_enable(BlockDriverState *bs);
183 void bdrv_iostatus_reset(BlockDriverState *bs);
184 void bdrv_iostatus_disable(BlockDriverState *bs);
185 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
186 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
187 void bdrv_info_print(Monitor *mon, const QObject *data);
188 void bdrv_info(Monitor *mon, QObject **ret_data);
189 void bdrv_stats_print(Monitor *mon, const QObject *data);
190 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
191 
192 /* disk I/O throttling */
193 void bdrv_io_limits_enable(BlockDriverState *bs);
194 void bdrv_io_limits_disable(BlockDriverState *bs);
195 
196 void bdrv_init(void);
197 void bdrv_init_with_whitelist(void);
198 BlockDriver *bdrv_find_protocol(const char *filename,
199                                 bool allow_protocol_prefix);
200 BlockDriver *bdrv_find_format(const char *format_name);
201 BlockDriver *bdrv_find_whitelisted_format(const char *format_name,
202                                           bool readonly);
203 int bdrv_create(BlockDriver *drv, const char* filename,
204                 QemuOpts *opts, Error **errp);
205 int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
206 BlockDriverState *bdrv_new(const char *device_name, Error **errp);
207 void bdrv_make_anon(BlockDriverState *bs);
208 void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
209 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
210 int bdrv_parse_cache_flags(const char *mode, int *flags);
211 int bdrv_parse_discard_flags(const char *mode, int *flags);
212 int bdrv_open_image(BlockDriverState **pbs, const char *filename,
213                     QDict *options, const char *bdref_key, int flags,
214                     bool allow_none, Error **errp);
215 void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
216 int bdrv_open_backing_file(BlockDriverState *bs, QDict *options, Error **errp);
217 int bdrv_append_temp_snapshot(BlockDriverState *bs, int flags, Error **errp);
218 int bdrv_open(BlockDriverState **pbs, const char *filename,
219               const char *reference, QDict *options, int flags,
220               BlockDriver *drv, Error **errp);
221 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
222                                     BlockDriverState *bs, int flags);
223 int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
224 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
225 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
226                         BlockReopenQueue *queue, Error **errp);
227 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
228 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
229 void bdrv_close(BlockDriverState *bs);
230 void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
231 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
232 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
233 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
234 void *bdrv_get_attached_dev(BlockDriverState *bs);
235 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
236                       void *opaque);
237 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
238 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
239 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
240 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
241 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
242               uint8_t *buf, int nb_sectors);
243 int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
244                           uint8_t *buf, int nb_sectors);
245 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
246                const uint8_t *buf, int nb_sectors);
247 int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
248                int nb_sectors, BdrvRequestFlags flags);
249 BlockDriverAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num,
250                                         int nb_sectors, BdrvRequestFlags flags,
251                                         BlockDriverCompletionFunc *cb, void *opaque);
252 int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
253 int bdrv_pread(BlockDriverState *bs, int64_t offset,
254                void *buf, int count);
255 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
256                 const void *buf, int count);
257 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
258 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
259     const void *buf, int count);
260 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
261     int nb_sectors, QEMUIOVector *qiov);
262 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
263     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
264 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
265     int nb_sectors, QEMUIOVector *qiov);
266 /*
267  * Efficiently zero a region of the disk image.  Note that this is a regular
268  * I/O request like read or write and should have a reasonable size.  This
269  * function is not suitable for zeroing the entire image in a single request
270  * because it may allocate memory for the entire region.
271  */
272 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
273     int nb_sectors, BdrvRequestFlags flags);
274 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
275     const char *backing_file);
276 int bdrv_get_backing_file_depth(BlockDriverState *bs);
277 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
278 int64_t bdrv_getlength(BlockDriverState *bs);
279 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
280 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
281 void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
282 int bdrv_commit(BlockDriverState *bs);
283 int bdrv_commit_all(void);
284 int bdrv_change_backing_file(BlockDriverState *bs,
285     const char *backing_file, const char *backing_fmt);
286 void bdrv_register(BlockDriver *bdrv);
287 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
288                            BlockDriverState *base,
289                            const char *backing_file_str);
290 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
291                                     BlockDriverState *bs);
292 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
293 
294 
295 typedef struct BdrvCheckResult {
296     int corruptions;
297     int leaks;
298     int check_errors;
299     int corruptions_fixed;
300     int leaks_fixed;
301     int64_t image_end_offset;
302     BlockFragInfo bfi;
303 } BdrvCheckResult;
304 
305 typedef enum {
306     BDRV_FIX_LEAKS    = 1,
307     BDRV_FIX_ERRORS   = 2,
308 } BdrvCheckMode;
309 
310 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
311 
312 int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts);
313 
314 /* external snapshots */
315 bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
316                                       BlockDriverState *candidate);
317 bool bdrv_is_first_non_filter(BlockDriverState *candidate);
318 
319 /* check if a named node can be replaced when doing drive-mirror */
320 BlockDriverState *check_to_replace_node(const char *node_name, Error **errp);
321 
322 /* async block I/O */
323 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
324                                      int sector_num);
325 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
326                                  QEMUIOVector *iov, int nb_sectors,
327                                  BlockDriverCompletionFunc *cb, void *opaque);
328 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
329                                   QEMUIOVector *iov, int nb_sectors,
330                                   BlockDriverCompletionFunc *cb, void *opaque);
331 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
332                                  BlockDriverCompletionFunc *cb, void *opaque);
333 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
334                                    int64_t sector_num, int nb_sectors,
335                                    BlockDriverCompletionFunc *cb, void *opaque);
336 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
337 
338 typedef struct BlockRequest {
339     /* Fields to be filled by multiwrite caller */
340     int64_t sector;
341     int nb_sectors;
342     int flags;
343     QEMUIOVector *qiov;
344     BlockDriverCompletionFunc *cb;
345     void *opaque;
346 
347     /* Filled by multiwrite implementation */
348     int error;
349 } BlockRequest;
350 
351 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
352     int num_reqs);
353 
354 /* sg packet commands */
355 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
356 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
357         unsigned long int req, void *buf,
358         BlockDriverCompletionFunc *cb, void *opaque);
359 
360 /* Invalidate any cached metadata used by image formats */
361 void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
362 void bdrv_invalidate_cache_all(Error **errp);
363 
364 void bdrv_clear_incoming_migration_all(void);
365 
366 /* Ensure contents are flushed to disk.  */
367 int bdrv_flush(BlockDriverState *bs);
368 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
369 int bdrv_flush_all(void);
370 void bdrv_close_all(void);
371 void bdrv_drain_all(void);
372 
373 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
374 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
375 int bdrv_has_zero_init_1(BlockDriverState *bs);
376 int bdrv_has_zero_init(BlockDriverState *bs);
377 bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
378 bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
379 int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
380                               int nb_sectors, int *pnum);
381 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
382                       int *pnum);
383 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
384                             int64_t sector_num, int nb_sectors, int *pnum);
385 
386 void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
387                        BlockdevOnError on_write_error);
388 BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
389 BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
390 void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
391                        bool is_read, int error);
392 int bdrv_is_read_only(BlockDriverState *bs);
393 int bdrv_is_sg(BlockDriverState *bs);
394 int bdrv_enable_write_cache(BlockDriverState *bs);
395 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
396 int bdrv_is_inserted(BlockDriverState *bs);
397 int bdrv_media_changed(BlockDriverState *bs);
398 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
399 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
400 const char *bdrv_get_format_name(BlockDriverState *bs);
401 BlockDriverState *bdrv_find(const char *name);
402 BlockDriverState *bdrv_find_node(const char *node_name);
403 BlockDeviceInfoList *bdrv_named_nodes_list(void);
404 BlockDriverState *bdrv_lookup_bs(const char *device,
405                                  const char *node_name,
406                                  Error **errp);
407 bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
408 BlockDriverState *bdrv_next(BlockDriverState *bs);
409 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
410                   void *opaque);
411 int bdrv_is_encrypted(BlockDriverState *bs);
412 int bdrv_key_required(BlockDriverState *bs);
413 int bdrv_set_key(BlockDriverState *bs, const char *key);
414 int bdrv_query_missing_keys(void);
415 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
416                          void *opaque);
417 const char *bdrv_get_device_name(BlockDriverState *bs);
418 int bdrv_get_flags(BlockDriverState *bs);
419 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
420                           const uint8_t *buf, int nb_sectors);
421 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
422 ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
423 void bdrv_round_to_clusters(BlockDriverState *bs,
424                             int64_t sector_num, int nb_sectors,
425                             int64_t *cluster_sector_num,
426                             int *cluster_nb_sectors);
427 
428 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
429 void bdrv_get_backing_filename(BlockDriverState *bs,
430                                char *filename, int filename_size);
431 void bdrv_get_full_backing_filename(BlockDriverState *bs,
432                                     char *dest, size_t sz);
433 int bdrv_is_snapshot(BlockDriverState *bs);
434 
435 int path_is_absolute(const char *path);
436 void path_combine(char *dest, int dest_size,
437                   const char *base_path,
438                   const char *filename);
439 
440 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
441 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
442                       int64_t pos, int size);
443 
444 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
445                       int64_t pos, int size);
446 
447 void bdrv_img_create(const char *filename, const char *fmt,
448                      const char *base_filename, const char *base_fmt,
449                      char *options, uint64_t img_size, int flags,
450                      Error **errp, bool quiet);
451 
452 /* Returns the alignment in bytes that is required so that no bounce buffer
453  * is required throughout the stack */
454 size_t bdrv_opt_mem_align(BlockDriverState *bs);
455 void bdrv_set_guest_block_size(BlockDriverState *bs, int align);
456 void *qemu_blockalign(BlockDriverState *bs, size_t size);
457 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
458 
459 struct HBitmapIter;
460 typedef struct BdrvDirtyBitmap BdrvDirtyBitmap;
461 BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs, int granularity,
462                                           Error **errp);
463 void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
464 BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs);
465 int bdrv_get_dirty(BlockDriverState *bs, BdrvDirtyBitmap *bitmap, int64_t sector);
466 void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
467 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
468 void bdrv_dirty_iter_init(BlockDriverState *bs,
469                           BdrvDirtyBitmap *bitmap, struct HBitmapIter *hbi);
470 int64_t bdrv_get_dirty_count(BlockDriverState *bs, BdrvDirtyBitmap *bitmap);
471 
472 void bdrv_enable_copy_on_read(BlockDriverState *bs);
473 void bdrv_disable_copy_on_read(BlockDriverState *bs);
474 
475 void bdrv_ref(BlockDriverState *bs);
476 void bdrv_unref(BlockDriverState *bs);
477 
478 bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
479 void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
480 void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
481 void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
482 void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
483 bool bdrv_op_blocker_is_empty(BlockDriverState *bs);
484 
485 enum BlockAcctType {
486     BDRV_ACCT_READ,
487     BDRV_ACCT_WRITE,
488     BDRV_ACCT_FLUSH,
489     BDRV_MAX_IOTYPE,
490 };
491 
492 typedef struct BlockAcctCookie {
493     int64_t bytes;
494     int64_t start_time_ns;
495     enum BlockAcctType type;
496 } BlockAcctCookie;
497 
498 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
499         int64_t bytes, enum BlockAcctType type);
500 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
501 
502 typedef enum {
503     BLKDBG_L1_UPDATE,
504 
505     BLKDBG_L1_GROW_ALLOC_TABLE,
506     BLKDBG_L1_GROW_WRITE_TABLE,
507     BLKDBG_L1_GROW_ACTIVATE_TABLE,
508 
509     BLKDBG_L2_LOAD,
510     BLKDBG_L2_UPDATE,
511     BLKDBG_L2_UPDATE_COMPRESSED,
512     BLKDBG_L2_ALLOC_COW_READ,
513     BLKDBG_L2_ALLOC_WRITE,
514 
515     BLKDBG_READ_AIO,
516     BLKDBG_READ_BACKING_AIO,
517     BLKDBG_READ_COMPRESSED,
518 
519     BLKDBG_WRITE_AIO,
520     BLKDBG_WRITE_COMPRESSED,
521 
522     BLKDBG_VMSTATE_LOAD,
523     BLKDBG_VMSTATE_SAVE,
524 
525     BLKDBG_COW_READ,
526     BLKDBG_COW_WRITE,
527 
528     BLKDBG_REFTABLE_LOAD,
529     BLKDBG_REFTABLE_GROW,
530     BLKDBG_REFTABLE_UPDATE,
531 
532     BLKDBG_REFBLOCK_LOAD,
533     BLKDBG_REFBLOCK_UPDATE,
534     BLKDBG_REFBLOCK_UPDATE_PART,
535     BLKDBG_REFBLOCK_ALLOC,
536     BLKDBG_REFBLOCK_ALLOC_HOOKUP,
537     BLKDBG_REFBLOCK_ALLOC_WRITE,
538     BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
539     BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
540     BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
541 
542     BLKDBG_CLUSTER_ALLOC,
543     BLKDBG_CLUSTER_ALLOC_BYTES,
544     BLKDBG_CLUSTER_FREE,
545 
546     BLKDBG_FLUSH_TO_OS,
547     BLKDBG_FLUSH_TO_DISK,
548 
549     BLKDBG_PWRITEV_RMW_HEAD,
550     BLKDBG_PWRITEV_RMW_AFTER_HEAD,
551     BLKDBG_PWRITEV_RMW_TAIL,
552     BLKDBG_PWRITEV_RMW_AFTER_TAIL,
553     BLKDBG_PWRITEV,
554     BLKDBG_PWRITEV_ZERO,
555     BLKDBG_PWRITEV_DONE,
556 
557     BLKDBG_EVENT_MAX,
558 } BlkDebugEvent;
559 
560 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
561 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
562 
563 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
564                            const char *tag);
565 int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
566 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
567 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
568 
569 /**
570  * bdrv_get_aio_context:
571  *
572  * Returns: the currently bound #AioContext
573  */
574 AioContext *bdrv_get_aio_context(BlockDriverState *bs);
575 
576 /**
577  * bdrv_set_aio_context:
578  *
579  * Changes the #AioContext used for fd handlers, timers, and BHs by this
580  * BlockDriverState and all its children.
581  *
582  * This function must be called from the old #AioContext or with a lock held so
583  * the old #AioContext is not executing.
584  */
585 void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
586 
587 void bdrv_io_plug(BlockDriverState *bs);
588 void bdrv_io_unplug(BlockDriverState *bs);
589 void bdrv_flush_io_queue(BlockDriverState *bs);
590 
591 #endif
592