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