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