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