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     BDRV_REQ_FUA                = 0x10,
  68 } BdrvRequestFlags;
  69
  70 typedef struct BlockSizes {
  71     uint32_t phys;
  72     uint32_t log;
  73 } BlockSizes;
  74
  75 typedef struct HDGeometry {
  76     uint32_t heads;
  77     uint32_t sectors;
  78     uint32_t cylinders;
  79 } HDGeometry;
  80
  81 #define BDRV_O_RDWR        0x0002
  82 #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
  83 #define BDRV_O_TEMPORARY   0x0010 /* delete the file after use */
  84 #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
  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_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_init(void);
 191 void bdrv_init_with_whitelist(void);
 192 bool bdrv_uses_whitelist(void);
 193 BlockDriver *bdrv_find_protocol(const char *filename,
 194                                 bool allow_protocol_prefix,
 195                                 Error **errp);
 196 BlockDriver *bdrv_find_format(const char *format_name);
 197 int bdrv_create(BlockDriver *drv, const char* filename,
 198                 QemuOpts *opts, Error **errp);
 199 int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
 200 BlockDriverState *bdrv_new_root(void);
 201 BlockDriverState *bdrv_new(void);
 202 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
 203 void bdrv_replace_in_backing_chain(BlockDriverState *old,
 204                                    BlockDriverState *new);
 205
 206 int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough);
 207 int bdrv_parse_discard_flags(const char *mode, int *flags);
 208 BdrvChild *bdrv_open_child(const char *filename,
 209                            QDict *options, const char *bdref_key,
 210                            BlockDriverState* parent,
 211                            const BdrvChildRole *child_role,
 212                            bool allow_none, Error **errp);
 213 void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd);
 214 int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
 215                            const char *bdref_key, Error **errp);
 216 int bdrv_open(BlockDriverState **pbs, const char *filename,
 217               const char *reference, QDict *options, int flags, Error **errp);
 218 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
 219                                     BlockDriverState *bs,
 220                                     QDict *options, int flags);
 221 int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
 222 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
 223 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
 224                         BlockReopenQueue *queue, Error **errp);
 225 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
 226 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
 227 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
 228               uint8_t *buf, int nb_sectors);
 229 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
 230                const uint8_t *buf, int nb_sectors);
 231 int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num,
 232                int nb_sectors, BdrvRequestFlags flags);
 233 BlockAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, int64_t sector_num,
 234                                   int nb_sectors, BdrvRequestFlags flags,
 235                                   BlockCompletionFunc *cb, void *opaque);
 236 int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags);
 237 int bdrv_pread(BlockDriverState *bs, int64_t offset,
 238                void *buf, int count);
 239 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
 240                 const void *buf, int count);
 241 int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov);
 242 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
 243     const void *buf, int count);
 244 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
 245     int nb_sectors, QEMUIOVector *qiov);
 246 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
 247     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 248 int coroutine_fn bdrv_co_readv_no_serialising(BlockDriverState *bs,
 249     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 250 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
 251     int nb_sectors, QEMUIOVector *qiov);
 252 /*
 253  * Efficiently zero a region of the disk image.  Note that this is a regular
 254  * I/O request like read or write and should have a reasonable size.  This
 255  * function is not suitable for zeroing the entire image in a single request
 256  * because it may allocate memory for the entire region.
 257  */
 258 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
 259     int nb_sectors, BdrvRequestFlags flags);
 260 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
 261     const char *backing_file);
 262 int bdrv_get_backing_file_depth(BlockDriverState *bs);
 263 void bdrv_refresh_filename(BlockDriverState *bs);
 264 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
 265 int64_t bdrv_nb_sectors(BlockDriverState *bs);
 266 int64_t bdrv_getlength(BlockDriverState *bs);
 267 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
 268 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
 269 void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
 270 int bdrv_commit(BlockDriverState *bs);
 271 int bdrv_change_backing_file(BlockDriverState *bs,
 272     const char *backing_file, const char *backing_fmt);
 273 void bdrv_register(BlockDriver *bdrv);
 274 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
 275                            BlockDriverState *base,
 276                            const char *backing_file_str);
 277 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
 278                                     BlockDriverState *bs);
 279 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
 280
 281
 282 typedef struct BdrvCheckResult {
 283     int corruptions;
 284     int leaks;
 285     int check_errors;
 286     int corruptions_fixed;
 287     int leaks_fixed;
 288     int64_t image_end_offset;
 289     BlockFragInfo bfi;
 290 } BdrvCheckResult;
 291
 292 typedef enum {
 293     BDRV_FIX_LEAKS    = 1,
 294     BDRV_FIX_ERRORS   = 2,
 295 } BdrvCheckMode;
 296
 297 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
 298
 299 /* The units of offset and total_work_size may be chosen arbitrarily by the
 300  * block driver; total_work_size may change during the course of the amendment
 301  * operation */
 302 typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset,
 303                                       int64_t total_work_size, void *opaque);
 304 int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
 305                        BlockDriverAmendStatusCB *status_cb, void *cb_opaque);
 306
 307 /* external snapshots */
 308 bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
 309                                       BlockDriverState *candidate);
 310 bool bdrv_is_first_non_filter(BlockDriverState *candidate);
 311
 312 /* check if a named node can be replaced when doing drive-mirror */
 313 BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
 314                                         const char *node_name, Error **errp);
 315
 316 /* async block I/O */
 317 BlockAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
 318                            QEMUIOVector *iov, int nb_sectors,
 319                            BlockCompletionFunc *cb, void *opaque);
 320 BlockAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
 321                             QEMUIOVector *iov, int nb_sectors,
 322                             BlockCompletionFunc *cb, void *opaque);
 323 BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
 324                            BlockCompletionFunc *cb, void *opaque);
 325 BlockAIOCB *bdrv_aio_discard(BlockDriverState *bs,
 326                              int64_t sector_num, int nb_sectors,
 327                              BlockCompletionFunc *cb, void *opaque);
 328 void bdrv_aio_cancel(BlockAIOCB *acb);
 329 void bdrv_aio_cancel_async(BlockAIOCB *acb);
 330
 331 typedef struct BlockRequest {
 332     /* Fields to be filled by multiwrite caller */
 333     union {
 334         struct {
 335             int64_t sector;
 336             int nb_sectors;
 337             int flags;
 338             QEMUIOVector *qiov;
 339         };
 340         struct {
 341             int req;
 342             void *buf;
 343         };
 344     };
 345     BlockCompletionFunc *cb;
 346     void *opaque;
 347
 348     /* Filled by multiwrite implementation */
 349     int error;
 350 } BlockRequest;
 351
 352 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
 353     int num_reqs);
 354
 355 /* sg packet commands */
 356 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
 357 BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
 358         unsigned long int req, void *buf,
 359         BlockCompletionFunc *cb, void *opaque);
 360
 361 /* Invalidate any cached metadata used by image formats */
 362 void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
 363 void bdrv_invalidate_cache_all(Error **errp);
 364 int bdrv_inactivate_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 void bdrv_close_all(void);
 370 void bdrv_drain(BlockDriverState *bs);
 371 void coroutine_fn bdrv_co_drain(BlockDriverState *bs);
 372 void bdrv_drain_all(void);
 373
 374 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
 375 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
 376 int bdrv_has_zero_init_1(BlockDriverState *bs);
 377 int bdrv_has_zero_init(BlockDriverState *bs);
 378 bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
 379 bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
 380 int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
 381                               int nb_sectors, int *pnum,
 382                               BlockDriverState **file);
 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                                     BlockDriverState **file);
 388 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 389                       int *pnum);
 390 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
 391                             int64_t sector_num, int nb_sectors, int *pnum);
 392
 393 int bdrv_is_read_only(BlockDriverState *bs);
 394 int bdrv_is_sg(BlockDriverState *bs);
 395 bool bdrv_is_inserted(BlockDriverState *bs);
 396 int bdrv_media_changed(BlockDriverState *bs);
 397 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
 398 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
 399 const char *bdrv_get_format_name(BlockDriverState *bs);
 400 BlockDriverState *bdrv_find_node(const char *node_name);
 401 BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp);
 402 BlockDriverState *bdrv_lookup_bs(const char *device,
 403                                  const char *node_name,
 404                                  Error **errp);
 405 bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
 406 BlockDriverState *bdrv_next_node(BlockDriverState *bs);
 407 BlockDriverState *bdrv_next(BlockDriverState *bs);
 408 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs);
 409 int bdrv_is_encrypted(BlockDriverState *bs);
 410 int bdrv_key_required(BlockDriverState *bs);
 411 int bdrv_set_key(BlockDriverState *bs, const char *key);
 412 void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp);
 413 int bdrv_query_missing_keys(void);
 414 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 415                          void *opaque);
 416 const char *bdrv_get_node_name(const BlockDriverState *bs);
 417 const char *bdrv_get_device_name(const BlockDriverState *bs);
 418 const char *bdrv_get_device_or_node_name(const BlockDriverState *bs);
 419 int bdrv_get_flags(BlockDriverState *bs);
 420 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
 421                           const uint8_t *buf, int nb_sectors);
 422 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
 423 ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
 424 void bdrv_round_to_clusters(BlockDriverState *bs,
 425                             int64_t sector_num, int nb_sectors,
 426                             int64_t *cluster_sector_num,
 427                             int *cluster_nb_sectors);
 428
 429 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
 430 void bdrv_get_backing_filename(BlockDriverState *bs,
 431                                char *filename, int filename_size);
 432 void bdrv_get_full_backing_filename(BlockDriverState *bs,
 433                                     char *dest, size_t sz, Error **errp);
 434 void bdrv_get_full_backing_filename_from_filename(const char *backed,
 435                                                   const char *backing,
 436                                                   char *dest, size_t sz,
 437                                                   Error **errp);
 438 int bdrv_is_snapshot(BlockDriverState *bs);
 439
 440 int path_has_protocol(const char *path);
 441 int path_is_absolute(const char *path);
 442 void path_combine(char *dest, int dest_size,
 443                   const char *base_path,
 444                   const char *filename);
 445
 446 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
 447 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
 448                       int64_t pos, int size);
 449
 450 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
 451                       int64_t pos, int size);
 452
 453 void bdrv_img_create(const char *filename, const char *fmt,
 454                      const char *base_filename, const char *base_fmt,
 455                      char *options, uint64_t img_size, int flags,
 456                      Error **errp, bool quiet);
 457
 458 /* Returns the alignment in bytes that is required so that no bounce buffer
 459  * is required throughout the stack */
 460 size_t bdrv_min_mem_align(BlockDriverState *bs);
 461 /* Returns optimal alignment in bytes for bounce buffer */
 462 size_t bdrv_opt_mem_align(BlockDriverState *bs);
 463 void *qemu_blockalign(BlockDriverState *bs, size_t size);
 464 void *qemu_blockalign0(BlockDriverState *bs, size_t size);
 465 void *qemu_try_blockalign(BlockDriverState *bs, size_t size);
 466 void *qemu_try_blockalign0(BlockDriverState *bs, size_t size);
 467 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
 468
 469 void bdrv_enable_copy_on_read(BlockDriverState *bs);
 470 void bdrv_disable_copy_on_read(BlockDriverState *bs);
 471
 472 void bdrv_ref(BlockDriverState *bs);
 473 void bdrv_unref(BlockDriverState *bs);
 474 void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child);
 475 BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs,
 476                              BlockDriverState *child_bs,
 477                              const char *child_name,
 478                              const BdrvChildRole *child_role);
 479
 480 bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
 481 void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
 482 void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
 483 void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
 484 void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
 485 bool bdrv_op_blocker_is_empty(BlockDriverState *bs);
 486
 487 #define BLKDBG_EVENT(child, evt) \
 488     do { \
 489         if (child) { \
 490             bdrv_debug_event(child->bs, evt); \
 491         } \
 492     } while (0)
 493
 494 void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event);
 495
 496 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
 497                            const char *tag);
 498 int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
 499 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
 500 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
 501
 502 /**
 503  * bdrv_get_aio_context:
 504  *
 505  * Returns: the currently bound #AioContext
 506  */
 507 AioContext *bdrv_get_aio_context(BlockDriverState *bs);
 508
 509 /**
 510  * bdrv_set_aio_context:
 511  *
 512  * Changes the #AioContext used for fd handlers, timers, and BHs by this
 513  * BlockDriverState and all its children.
 514  *
 515  * This function must be called with iothread lock held.
 516  */
 517 void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
 518 int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz);
 519 int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo);
 520
 521 void bdrv_io_plug(BlockDriverState *bs);
 522 void bdrv_io_unplug(BlockDriverState *bs);
 523 void bdrv_io_unplugged_begin(BlockDriverState *bs);
 524 void bdrv_io_unplugged_end(BlockDriverState *bs);
 525
 526 /**
 527  * bdrv_drained_begin:
 528  *
 529  * Begin a quiesced section for exclusive access to the BDS, by disabling
 530  * external request sources including NBD server and device model. Note that
 531  * this doesn't block timers or coroutines from submitting more requests, which
 532  * means block_job_pause is still necessary.
 533  *
 534  * This function can be recursive.
 535  */
 536 void bdrv_drained_begin(BlockDriverState *bs);
 537
 538 /**
 539  * bdrv_drained_end:
 540  *
 541  * End a quiescent section started by bdrv_drained_begin().
 542  */
 543 void bdrv_drained_end(BlockDriverState *bs);
 544
 545 void bdrv_add_child(BlockDriverState *parent, BlockDriverState *child,
 546                     Error **errp);
 547 void bdrv_del_child(BlockDriverState *parent, BdrvChild *child, Error **errp);
 548
 549 #endif