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