include/block/block.h

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