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