include/block/block.h

   1 #ifndef BLOCK_H
   2 #define BLOCK_H
   3
   4 #include "block/aio.h"
   5 #include "qemu/iov.h"
   6 #include "qemu/option.h"
   7 #include "qemu/coroutine.h"
   8 #include "block/accounting.h"
   9 #include "block/dirty-bitmap.h"
  10 #include "qapi/qmp/qobject.h"
  11 #include "qapi-types.h"
  12 #include "qemu/hbitmap.h"
  13
  14 /* block.c */
  15 typedef struct BlockDriver BlockDriver;
  16 typedef struct BlockJob BlockJob;
  17 typedef struct BdrvChild BdrvChild;
  18 typedef struct BdrvChildRole BdrvChildRole;
  19 typedef struct BlockJobTxn BlockJobTxn;
  20
  21 typedef struct BlockDriverInfo {
  22     /* in bytes, 0 if irrelevant */
  23     int cluster_size;
  24     /* offset at which the VM state can be saved (0 if not possible) */
  25     int64_t vm_state_offset;
  26     bool is_dirty;
  27     /*
  28      * True if unallocated blocks read back as zeroes. This is equivalent
  29      * to the LBPRZ flag in the SCSI logical block provisioning page.
  30      */
  31     bool unallocated_blocks_are_zero;
  32     /*
  33      * True if the driver can optimize writing zeroes by unmapping
  34      * sectors. This is equivalent to the BLKDISCARDZEROES ioctl in Linux
  35      * with the difference that in qemu a discard is allowed to silently
  36      * fail. Therefore we have to use bdrv_write_zeroes with the
  37      * BDRV_REQ_MAY_UNMAP flag for an optimized zero write with unmapping.
  38      * After this call the driver has to guarantee that the contents read
  39      * back as zero. It is additionally required that the block device is
  40      * opened with BDRV_O_UNMAP flag for this to work.
  41      */
  42     bool can_write_zeroes_with_unmap;
  43     /*
  44      * True if this block driver only supports compressed writes
  45      */
  46     bool needs_compressed_writes;
  47 } BlockDriverInfo;
  48
  49 typedef struct BlockFragInfo {
  50     uint64_t allocated_clusters;
  51     uint64_t total_clusters;
  52     uint64_t fragmented_clusters;
  53     uint64_t compressed_clusters;
  54 } BlockFragInfo;
  55
  56 typedef enum {
  57     BDRV_REQ_COPY_ON_READ       = 0x1,
  58     BDRV_REQ_ZERO_WRITE         = 0x2,
  59     /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver
  60      * is allowed to optimize a write zeroes request by unmapping (discarding)
  61      * blocks if it is guaranteed that the result will read back as
  62      * zeroes. The flag is only passed to the driver if the block device is
  63      * opened with BDRV_O_UNMAP.
  64      */
  65     BDRV_REQ_MAY_UNMAP          = 0x4,
  66     BDRV_REQ_NO_SERIALISING     = 0x8,
  67 } BdrvRequestFlags;
  68
  69 typedef struct BlockSizes {
  70     uint32_t phys;
  71     uint32_t log;
  72 } BlockSizes;
  73
  74 typedef struct HDGeometry {
  75     uint32_t heads;
  76     uint32_t sectors;
  77     uint32_t cylinders;
  78 } HDGeometry;
  79
  80 #define BDRV_O_RDWR        0x0002
  81 #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
  82 #define BDRV_O_TEMPORARY   0x0010 /* delete the file after use */
  83 #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
  84 #define BDRV_O_CACHE_WB    0x0040 /* use write-back caching */
  85 #define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */
  86 #define BDRV_O_NO_BACKING  0x0100 /* don't open the backing file */
  87 #define BDRV_O_NO_FLUSH    0x0200 /* disable flushing on this disk */
  88 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
  89 #define BDRV_O_INACTIVE    0x0800  /* consistency hint for migration handoff */
  90 #define BDRV_O_CHECK       0x1000  /* open solely for consistency check */
  91 #define BDRV_O_ALLOW_RDWR  0x2000  /* allow reopen to change from r/o to r/w */
  92 #define BDRV_O_UNMAP       0x4000  /* execute guest UNMAP/TRIM operations */
  93 #define BDRV_O_PROTOCOL    0x8000  /* if no block driver is explicitly given:
  94                                       select an appropriate protocol driver,
  95                                       ignoring the format layer */
  96 #define BDRV_O_NO_IO       0x10000 /* don't initialize for I/O */
  97
  98 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
  99
 100
 101 /* Option names of options parsed by the block layer */
 102
 103 #define BDRV_OPT_CACHE_WB       "cache.writeback"
 104 #define BDRV_OPT_CACHE_DIRECT   "cache.direct"
 105 #define BDRV_OPT_CACHE_NO_FLUSH "cache.no-flush"
 106
 107
 108 #define BDRV_SECTOR_BITS   9
 109 #define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
 110 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
 111
 112 #define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \
 113                                      INT_MAX >> BDRV_SECTOR_BITS)
 114
 115 /*
 116  * Allocation status flags
 117  * BDRV_BLOCK_DATA: data is read from a file returned by bdrv_get_block_status.
 118  * BDRV_BLOCK_ZERO: sectors read as zero
 119  * BDRV_BLOCK_OFFSET_VALID: sector stored as raw data in a file returned by
 120  *                          bdrv_get_block_status.
 121  * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this
 122  *                       layer (as opposed to the backing file)
 123  * BDRV_BLOCK_RAW: used internally to indicate that the request
 124  *                 was answered by the raw driver and that one
 125  *                 should look in bs->file directly.
 126  *
 127  * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
 128  * bs->file where sector data can be read from as raw data.
 129  *
 130  * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
 131  *
 132  * DATA ZERO OFFSET_VALID
 133  *  t    t        t       sectors read as zero, bs->file is zero at offset
 134  *  t    f        t       sectors read as valid from bs->file at offset
 135  *  f    t        t       sectors preallocated, read as zero, bs->file not
 136  *                        necessarily zero at offset
 137  *  f    f        t       sectors preallocated but read from backing_hd,
 138  *                        bs->file contains garbage at offset
 139  *  t    t        f       sectors preallocated, read as zero, unknown offset
 140  *  t    f        f       sectors read from unknown file or offset
 141  *  f    t        f       not allocated or unknown offset, read as zero
 142  *  f    f        f       not allocated or unknown offset, read from backing_hd
 143  */
 144 #define BDRV_BLOCK_DATA         0x01
 145 #define BDRV_BLOCK_ZERO         0x02
 146 #define BDRV_BLOCK_OFFSET_VALID 0x04
 147 #define BDRV_BLOCK_RAW          0x08
 148 #define BDRV_BLOCK_ALLOCATED    0x10
 149 #define BDRV_BLOCK_OFFSET_MASK  BDRV_SECTOR_MASK
 150
 151 typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
 152
 153 typedef struct BDRVReopenState {
 154     BlockDriverState *bs;
 155     int flags;
 156     QDict *options;
 157     QDict *explicit_options;
 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_SOURCE,
 169     BLOCK_OP_TYPE_COMMIT_TARGET,
 170     BLOCK_OP_TYPE_DATAPLANE,
 171     BLOCK_OP_TYPE_DRIVE_DEL,
 172     BLOCK_OP_TYPE_EJECT,
 173     BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
 174     BLOCK_OP_TYPE_INTERNAL_SNAPSHOT,
 175     BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE,
 176     BLOCK_OP_TYPE_MIRROR_SOURCE,
 177     BLOCK_OP_TYPE_MIRROR_TARGET,
 178     BLOCK_OP_TYPE_RESIZE,
 179     BLOCK_OP_TYPE_STREAM,
 180     BLOCK_OP_TYPE_REPLACE,
 181     BLOCK_OP_TYPE_MAX,
 182 } BlockOpType;
 183
 184 void bdrv_info_print(Monitor *mon, const QObject *data);
 185 void bdrv_info(Monitor *mon, QObject **ret_data);
 186 void bdrv_stats_print(Monitor *mon, const QObject *data);
 187 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
 188
 189 /* disk I/O throttling */
 190 void bdrv_io_limits_enable(BlockDriverState *bs, const char *group);
 191 void bdrv_io_limits_disable(BlockDriverState *bs);
 192 void bdrv_io_limits_update_group(BlockDriverState *bs, const char *group);
 193
 194 void bdrv_init(void);
 195 void bdrv_init_with_whitelist(void);
 196 bool bdrv_uses_whitelist(void);
 197 BlockDriver *bdrv_find_protocol(const char *filename,
 198                                 bool allow_protocol_prefix,
 199                                 Error **errp);
 200 BlockDriver *bdrv_find_format(const char *format_name);
 201 int bdrv_create(BlockDriver *drv, const char* filename,
 202                 QemuOpts *opts, Error **errp);
 203 int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
 204 BlockDriverState *bdrv_new_root(void);
 205 BlockDriverState *bdrv_new(void);
 206 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
 207 void bdrv_replace_in_backing_chain(BlockDriverState *old,
 208                                    BlockDriverState *new);
 209
 210 int bdrv_parse_cache_flags(const char *mode, int *flags);
 211 int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough);
 212 int bdrv_parse_discard_flags(const char *mode, int *flags);
 213 BdrvChild *bdrv_open_child(const char *filename,
 214                            QDict *options, const char *bdref_key,
 215                            BlockDriverState* parent,
 216                            const BdrvChildRole *child_role,
 217                            bool allow_none, Error **errp);
 218 void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
 219 int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
 220                            const char *bdref_key, Error **errp);
 221 int bdrv_open(BlockDriverState **pbs, const char *filename,
 222               const char *reference, QDict *options, int flags, Error **errp);
 223 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
 224                                     BlockDriverState *bs,
 225                                     QDict *options, int flags);
 226 int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
 227 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
 228 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
 229                         BlockReopenQueue *queue, Error **errp);
 230 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
 231 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
 232 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
 233               uint8_t *buf, int nb_sectors);
 234 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
 235                const uint8_t *buf, int nb_sectors);
 236 int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
 237                int nb_sectors, BdrvRequestFlags flags);
 238 BlockAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num,
 239                                   int nb_sectors, BdrvRequestFlags flags,
 240                                   BlockCompletionFunc *cb, void *opaque);
 241 int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
 242 int bdrv_pread(BlockDriverState *bs, int64_t offset,
 243                void *buf, int count);
 244 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
 245                 const void *buf, int count);
 246 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
 247 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
 248     const void *buf, int count);
 249 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
 250     int nb_sectors, QEMUIOVector *qiov);
 251 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
 252     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 253 int coroutine_fn bdrv_co_readv_no_serialising(BlockDriverState *bs,
 254     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 255 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
 256     int nb_sectors, QEMUIOVector *qiov);
 257 /*
 258  * Efficiently zero a region of the disk image.  Note that this is a regular
 259  * I/O request like read or write and should have a reasonable size.  This
 260  * function is not suitable for zeroing the entire image in a single request
 261  * because it may allocate memory for the entire region.
 262  */
 263 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
 264     int nb_sectors, BdrvRequestFlags flags);
 265 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
 266     const char *backing_file);
 267 int bdrv_get_backing_file_depth(BlockDriverState *bs);
 268 void bdrv_refresh_filename(BlockDriverState *bs);
 269 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
 270 int64_t bdrv_nb_sectors(BlockDriverState *bs);
 271 int64_t bdrv_getlength(BlockDriverState *bs);
 272 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
 273 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
 274 void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
 275 int bdrv_commit(BlockDriverState *bs);
 276 int bdrv_change_backing_file(BlockDriverState *bs,
 277     const char *backing_file, const char *backing_fmt);
 278 void bdrv_register(BlockDriver *bdrv);
 279 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
 280                            BlockDriverState *base,
 281                            const char *backing_file_str);
 282 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
 283                                     BlockDriverState *bs);
 284 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
 285
 286
 287 typedef struct BdrvCheckResult {
 288     int corruptions;
 289     int leaks;
 290     int check_errors;
 291     int corruptions_fixed;
 292     int leaks_fixed;
 293     int64_t image_end_offset;
 294     BlockFragInfo bfi;
 295 } BdrvCheckResult;
 296
 297 typedef enum {
 298     BDRV_FIX_LEAKS    = 1,
 299     BDRV_FIX_ERRORS   = 2,
 300 } BdrvCheckMode;
 301
 302 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
 303
 304 /* The units of offset and total_work_size may be chosen arbitrarily by the
 305  * block driver; total_work_size may change during the course of the amendment
 306  * operation */
 307 typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset,
 308                                       int64_t total_work_size, void *opaque);
 309 int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
 310                        BlockDriverAmendStatusCB *status_cb, void *cb_opaque);
 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 /* check if a named node can be replaced when doing drive-mirror */
 318 BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
 319                                         const char *node_name, Error **errp);
 320
 321 /* async block I/O */
 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     union {
 339         struct {
 340             int64_t sector;
 341             int nb_sectors;
 342             int flags;
 343             QEMUIOVector *qiov;
 344         };
 345         struct {
 346             int req;
 347             void *buf;
 348         };
 349     };
 350     BlockCompletionFunc *cb;
 351     void *opaque;
 352
 353     /* Filled by multiwrite implementation */
 354     int error;
 355 } BlockRequest;
 356
 357 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
 358     int num_reqs);
 359
 360 /* sg packet commands */
 361 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
 362 BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
 363         unsigned long int req, void *buf,
 364         BlockCompletionFunc *cb, void *opaque);
 365
 366 /* Invalidate any cached metadata used by image formats */
 367 void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
 368 void bdrv_invalidate_cache_all(Error **errp);
 369 int bdrv_inactivate_all(void);
 370
 371 /* Ensure contents are flushed to disk.  */
 372 int bdrv_flush(BlockDriverState *bs);
 373 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
 374 void bdrv_close_all(void);
 375 void bdrv_drain(BlockDriverState *bs);
 376 void bdrv_drain_all(void);
 377
 378 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
 379 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
 380 int bdrv_has_zero_init_1(BlockDriverState *bs);
 381 int bdrv_has_zero_init(BlockDriverState *bs);
 382 bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
 383 bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
 384 int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
 385                               int nb_sectors, int *pnum,
 386                               BlockDriverState **file);
 387 int64_t bdrv_get_block_status_above(BlockDriverState *bs,
 388                                     BlockDriverState *base,
 389                                     int64_t sector_num,
 390                                     int nb_sectors, int *pnum,
 391                                     BlockDriverState **file);
 392 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 393                       int *pnum);
 394 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
 395                             int64_t sector_num, int nb_sectors, int *pnum);
 396
 397 int bdrv_is_read_only(BlockDriverState *bs);
 398 int bdrv_is_sg(BlockDriverState *bs);
 399 int bdrv_enable_write_cache(BlockDriverState *bs);
 400 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
 401 bool bdrv_is_inserted(BlockDriverState *bs);
 402 int bdrv_media_changed(BlockDriverState *bs);
 403 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
 404 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
 405 const char *bdrv_get_format_name(BlockDriverState *bs);
 406 BlockDriverState *bdrv_find_node(const char *node_name);
 407 BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp);
 408 BlockDriverState *bdrv_lookup_bs(const char *device,
 409                                  const char *node_name,
 410                                  Error **errp);
 411 bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
 412 BlockDriverState *bdrv_next_node(BlockDriverState *bs);
 413 BlockDriverState *bdrv_next(BlockDriverState *bs);
 414 BlockDriverState *bdrv_next_monitor_owned(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 *qemu_blockalign(BlockDriverState *bs, size_t size);
 470 void *qemu_blockalign0(BlockDriverState *bs, size_t size);
 471 void *qemu_try_blockalign(BlockDriverState *bs, size_t size);
 472 void *qemu_try_blockalign0(BlockDriverState *bs, size_t size);
 473 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
 474
 475 void bdrv_enable_copy_on_read(BlockDriverState *bs);
 476 void bdrv_disable_copy_on_read(BlockDriverState *bs);
 477
 478 void bdrv_ref(BlockDriverState *bs);
 479 void bdrv_unref(BlockDriverState *bs);
 480 void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child);
 481
 482 bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
 483 void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
 484 void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
 485 void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
 486 void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
 487 bool bdrv_op_blocker_is_empty(BlockDriverState *bs);
 488
 489 #define BLKDBG_EVENT(child, evt) \
 490     do { \
 491         if (child) { \
 492             bdrv_debug_event(child->bs, evt); \
 493         } \
 494     } while (0)
 495
 496 void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event);
 497
 498 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
 499                            const char *tag);
 500 int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
 501 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
 502 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
 503
 504 /**
 505  * bdrv_get_aio_context:
 506  *
 507  * Returns: the currently bound #AioContext
 508  */
 509 AioContext *bdrv_get_aio_context(BlockDriverState *bs);
 510
 511 /**
 512  * bdrv_set_aio_context:
 513  *
 514  * Changes the #AioContext used for fd handlers, timers, and BHs by this
 515  * BlockDriverState and all its children.
 516  *
 517  * This function must be called with iothread lock held.
 518  */
 519 void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
 520 int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz);
 521 int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo);
 522
 523 void bdrv_io_plug(BlockDriverState *bs);
 524 void bdrv_io_unplug(BlockDriverState *bs);
 525 void bdrv_flush_io_queue(BlockDriverState *bs);
 526
 527 /**
 528  * bdrv_drained_begin:
 529  *
 530  * Begin a quiesced section for exclusive access to the BDS, by disabling
 531  * external request sources including NBD server and device model. Note that
 532  * this doesn't block timers or coroutines from submitting more requests, which
 533  * means block_job_pause is still necessary.
 534  *
 535  * This function can be recursive.
 536  */
 537 void bdrv_drained_begin(BlockDriverState *bs);
 538
 539 /**
 540  * bdrv_drained_end:
 541  *
 542  * End a quiescent section started by bdrv_drained_begin().
 543  */
 544 void bdrv_drained_end(BlockDriverState *bs);
 545
 546 #endif