include/block/block.h

   1 #ifndef BLOCK_H
   2 #define BLOCK_H
   3
   4 #include "block/aio.h"
   5 #include "qemu/iov.h"
   6 #include "qemu/option.h"
   7 #include "qemu/coroutine.h"
   8 #include "block/accounting.h"
   9 #include "block/dirty-bitmap.h"
  10 #include "block/blockjob.h"
  11 #include "qapi/qmp/qobject.h"
  12 #include "qapi-types.h"
  13 #include "qemu/hbitmap.h"
  14
  15 /* block.c */
  16 typedef struct BlockDriver BlockDriver;
  17 typedef struct BdrvChild BdrvChild;
  18 typedef struct BdrvChildRole BdrvChildRole;
  19
  20 typedef struct BlockDriverInfo {
  21     /* in bytes, 0 if irrelevant */
  22     int cluster_size;
  23     /* offset at which the VM state can be saved (0 if not possible) */
  24     int64_t vm_state_offset;
  25     bool is_dirty;
  26     /*
  27      * True if unallocated blocks read back as zeroes. This is equivalent
  28      * to the LBPRZ flag in the SCSI logical block provisioning page.
  29      */
  30     bool unallocated_blocks_are_zero;
  31     /*
  32      * True if the driver can optimize writing zeroes by unmapping
  33      * sectors. This is equivalent to the BLKDISCARDZEROES ioctl in Linux
  34      * with the difference that in qemu a discard is allowed to silently
  35      * fail. Therefore we have to use bdrv_pwrite_zeroes with the
  36      * BDRV_REQ_MAY_UNMAP flag for an optimized zero write with unmapping.
  37      * After this call the driver has to guarantee that the contents read
  38      * back as zero. It is additionally required that the block device is
  39      * opened with BDRV_O_UNMAP flag for this to work.
  40      */
  41     bool can_write_zeroes_with_unmap;
  42     /*
  43      * True if this block driver only supports compressed writes
  44      */
  45     bool needs_compressed_writes;
  46 } BlockDriverInfo;
  47
  48 typedef struct BlockFragInfo {
  49     uint64_t allocated_clusters;
  50     uint64_t total_clusters;
  51     uint64_t fragmented_clusters;
  52     uint64_t compressed_clusters;
  53 } BlockFragInfo;
  54
  55 typedef enum {
  56     BDRV_REQ_COPY_ON_READ       = 0x1,
  57     BDRV_REQ_ZERO_WRITE         = 0x2,
  58     /* The BDRV_REQ_MAY_UNMAP flag is used to indicate that the block driver
  59      * is allowed to optimize a write zeroes request by unmapping (discarding)
  60      * blocks if it is guaranteed that the result will read back as
  61      * zeroes. The flag is only passed to the driver if the block device is
  62      * opened with BDRV_O_UNMAP.
  63      */
  64     BDRV_REQ_MAY_UNMAP          = 0x4,
  65     BDRV_REQ_NO_SERIALISING     = 0x8,
  66     BDRV_REQ_FUA                = 0x10,
  67     BDRV_REQ_WRITE_COMPRESSED   = 0x20,
  68
  69     /* Mask of valid flags */
  70     BDRV_REQ_MASK               = 0x3f,
  71 } BdrvRequestFlags;
  72
  73 typedef struct BlockSizes {
  74     uint32_t phys;
  75     uint32_t log;
  76 } BlockSizes;
  77
  78 typedef struct HDGeometry {
  79     uint32_t heads;
  80     uint32_t sectors;
  81     uint32_t cylinders;
  82 } HDGeometry;
  83
  84 #define BDRV_O_RDWR        0x0002
  85 #define BDRV_O_RESIZE      0x0004 /* request permission for resizing the node */
  86 #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
  87 #define BDRV_O_TEMPORARY   0x0010 /* delete the file after use */
  88 #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
  89 #define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */
  90 #define BDRV_O_NO_BACKING  0x0100 /* don't open the backing file */
  91 #define BDRV_O_NO_FLUSH    0x0200 /* disable flushing on this disk */
  92 #define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
  93 #define BDRV_O_INACTIVE    0x0800  /* consistency hint for migration handoff */
  94 #define BDRV_O_CHECK       0x1000  /* open solely for consistency check */
  95 #define BDRV_O_ALLOW_RDWR  0x2000  /* allow reopen to change from r/o to r/w */
  96 #define BDRV_O_UNMAP       0x4000  /* execute guest UNMAP/TRIM operations */
  97 #define BDRV_O_PROTOCOL    0x8000  /* if no block driver is explicitly given:
  98                                       select an appropriate protocol driver,
  99                                       ignoring the format layer */
 100 #define BDRV_O_NO_IO       0x10000 /* don't initialize for I/O */
 101
 102 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_NO_FLUSH)
 103
 104
 105 /* Option names of options parsed by the block layer */
 106
 107 #define BDRV_OPT_CACHE_WB       "cache.writeback"
 108 #define BDRV_OPT_CACHE_DIRECT   "cache.direct"
 109 #define BDRV_OPT_CACHE_NO_FLUSH "cache.no-flush"
 110 #define BDRV_OPT_READ_ONLY      "read-only"
 111 #define BDRV_OPT_DISCARD        "discard"
 112 #define BDRV_OPT_FORCE_SHARE    "force-share"
 113
 114
 115 #define BDRV_SECTOR_BITS   9
 116 #define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
 117 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
 118
 119 #define BDRV_REQUEST_MAX_SECTORS MIN(SIZE_MAX >> BDRV_SECTOR_BITS, \
 120                                      INT_MAX >> BDRV_SECTOR_BITS)
 121 #define BDRV_REQUEST_MAX_BYTES (BDRV_REQUEST_MAX_SECTORS << BDRV_SECTOR_BITS)
 122
 123 /*
 124  * Allocation status flags
 125  * BDRV_BLOCK_DATA: data is read from a file returned by bdrv_get_block_status.
 126  * BDRV_BLOCK_ZERO: sectors read as zero
 127  * BDRV_BLOCK_OFFSET_VALID: sector stored as raw data in a file returned by
 128  *                          bdrv_get_block_status.
 129  * BDRV_BLOCK_ALLOCATED: the content of the block is determined by this
 130  *                       layer (as opposed to the backing file)
 131  * BDRV_BLOCK_RAW: used internally to indicate that the request
 132  *                 was answered by the raw driver and that one
 133  *                 should look in bs->file directly.
 134  *
 135  * If BDRV_BLOCK_OFFSET_VALID is set, bits 9-62 represent the offset in
 136  * bs->file where sector data can be read from as raw data.
 137  *
 138  * DATA == 0 && ZERO == 0 means that data is read from backing_hd if present.
 139  *
 140  * DATA ZERO OFFSET_VALID
 141  *  t    t        t       sectors read as zero, bs->file is zero at offset
 142  *  t    f        t       sectors read as valid from bs->file at offset
 143  *  f    t        t       sectors preallocated, read as zero, bs->file not
 144  *                        necessarily zero at offset
 145  *  f    f        t       sectors preallocated but read from backing_hd,
 146  *                        bs->file contains garbage at offset
 147  *  t    t        f       sectors preallocated, read as zero, unknown offset
 148  *  t    f        f       sectors read from unknown file or offset
 149  *  f    t        f       not allocated or unknown offset, read as zero
 150  *  f    f        f       not allocated or unknown offset, read from backing_hd
 151  */
 152 #define BDRV_BLOCK_DATA         0x01
 153 #define BDRV_BLOCK_ZERO         0x02
 154 #define BDRV_BLOCK_OFFSET_VALID 0x04
 155 #define BDRV_BLOCK_RAW          0x08
 156 #define BDRV_BLOCK_ALLOCATED    0x10
 157 #define BDRV_BLOCK_OFFSET_MASK  BDRV_SECTOR_MASK
 158
 159 typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
 160
 161 typedef struct BDRVReopenState {
 162     BlockDriverState *bs;
 163     int flags;
 164     QDict *options;
 165     QDict *explicit_options;
 166     void *opaque;
 167 } BDRVReopenState;
 168
 169 /*
 170  * Block operation types
 171  */
 172 typedef enum BlockOpType {
 173     BLOCK_OP_TYPE_BACKUP_SOURCE,
 174     BLOCK_OP_TYPE_BACKUP_TARGET,
 175     BLOCK_OP_TYPE_CHANGE,
 176     BLOCK_OP_TYPE_COMMIT_SOURCE,
 177     BLOCK_OP_TYPE_COMMIT_TARGET,
 178     BLOCK_OP_TYPE_DATAPLANE,
 179     BLOCK_OP_TYPE_DRIVE_DEL,
 180     BLOCK_OP_TYPE_EJECT,
 181     BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT,
 182     BLOCK_OP_TYPE_INTERNAL_SNAPSHOT,
 183     BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE,
 184     BLOCK_OP_TYPE_MIRROR_SOURCE,
 185     BLOCK_OP_TYPE_MIRROR_TARGET,
 186     BLOCK_OP_TYPE_RESIZE,
 187     BLOCK_OP_TYPE_STREAM,
 188     BLOCK_OP_TYPE_REPLACE,
 189     BLOCK_OP_TYPE_MAX,
 190 } BlockOpType;
 191
 192 /* Block node permission constants */
 193 enum {
 194     /**
 195      * A user that has the "permission" of consistent reads is guaranteed that
 196      * their view of the contents of the block device is complete and
 197      * self-consistent, representing the contents of a disk at a specific
 198      * point.
 199      *
 200      * For most block devices (including their backing files) this is true, but
 201      * the property cannot be maintained in a few situations like for
 202      * intermediate nodes of a commit block job.
 203      */
 204     BLK_PERM_CONSISTENT_READ    = 0x01,
 205
 206     /** This permission is required to change the visible disk contents. */
 207     BLK_PERM_WRITE              = 0x02,
 208
 209     /**
 210      * This permission (which is weaker than BLK_PERM_WRITE) is both enough and
 211      * required for writes to the block node when the caller promises that
 212      * the visible disk content doesn't change.
 213      */
 214     BLK_PERM_WRITE_UNCHANGED    = 0x04,
 215
 216     /** This permission is required to change the size of a block node. */
 217     BLK_PERM_RESIZE             = 0x08,
 218
 219     /**
 220      * This permission is required to change the node that this BdrvChild
 221      * points to.
 222      */
 223     BLK_PERM_GRAPH_MOD          = 0x10,
 224
 225     BLK_PERM_ALL                = 0x1f,
 226 };
 227
 228 char *bdrv_perm_names(uint64_t perm);
 229
 230 /* disk I/O throttling */
 231 void bdrv_init(void);
 232 void bdrv_init_with_whitelist(void);
 233 bool bdrv_uses_whitelist(void);
 234 BlockDriver *bdrv_find_protocol(const char *filename,
 235                                 bool allow_protocol_prefix,
 236                                 Error **errp);
 237 BlockDriver *bdrv_find_format(const char *format_name);
 238 int bdrv_create(BlockDriver *drv, const char* filename,
 239                 QemuOpts *opts, Error **errp);
 240 int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp);
 241 BlockDriverState *bdrv_new(void);
 242 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top,
 243                  Error **errp);
 244 void bdrv_replace_node(BlockDriverState *from, BlockDriverState *to,
 245                        Error **errp);
 246
 247 int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough);
 248 int bdrv_parse_discard_flags(const char *mode, int *flags);
 249 BdrvChild *bdrv_open_child(const char *filename,
 250                            QDict *options, const char *bdref_key,
 251                            BlockDriverState* parent,
 252                            const BdrvChildRole *child_role,
 253                            bool allow_none, Error **errp);
 254 void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd,
 255                          Error **errp);
 256 int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
 257                            const char *bdref_key, Error **errp);
 258 BlockDriverState *bdrv_open(const char *filename, const char *reference,
 259                             QDict *options, int flags, Error **errp);
 260 BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name,
 261                                        int flags, Error **errp);
 262 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
 263                                     BlockDriverState *bs,
 264                                     QDict *options, int flags);
 265 int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp);
 266 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
 267 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
 268                         BlockReopenQueue *queue, Error **errp);
 269 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
 270 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
 271 int bdrv_read(BdrvChild *child, int64_t sector_num,
 272               uint8_t *buf, int nb_sectors);
 273 int bdrv_write(BdrvChild *child, int64_t sector_num,
 274                const uint8_t *buf, int nb_sectors);
 275 int bdrv_pwrite_zeroes(BdrvChild *child, int64_t offset,
 276                        int count, BdrvRequestFlags flags);
 277 int bdrv_make_zero(BdrvChild *child, BdrvRequestFlags flags);
 278 int bdrv_pread(BdrvChild *child, int64_t offset, void *buf, int bytes);
 279 int bdrv_preadv(BdrvChild *child, int64_t offset, QEMUIOVector *qiov);
 280 int bdrv_pwrite(BdrvChild *child, int64_t offset, const void *buf, int bytes);
 281 int bdrv_pwritev(BdrvChild *child, int64_t offset, QEMUIOVector *qiov);
 282 int bdrv_pwrite_sync(BdrvChild *child, int64_t offset,
 283                      const void *buf, int count);
 284 int coroutine_fn bdrv_co_readv(BdrvChild *child, int64_t sector_num,
 285                                int nb_sectors, QEMUIOVector *qiov);
 286 int coroutine_fn bdrv_co_writev(BdrvChild *child, int64_t sector_num,
 287                                int nb_sectors, QEMUIOVector *qiov);
 288 /*
 289  * Efficiently zero a region of the disk image.  Note that this is a regular
 290  * I/O request like read or write and should have a reasonable size.  This
 291  * function is not suitable for zeroing the entire image in a single request
 292  * because it may allocate memory for the entire region.
 293  */
 294 int coroutine_fn bdrv_co_pwrite_zeroes(BdrvChild *child, int64_t offset,
 295                                        int count, BdrvRequestFlags flags);
 296 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
 297     const char *backing_file);
 298 int bdrv_get_backing_file_depth(BlockDriverState *bs);
 299 void bdrv_refresh_filename(BlockDriverState *bs);
 300 int bdrv_truncate(BdrvChild *child, int64_t offset, Error **errp);
 301 int64_t bdrv_nb_sectors(BlockDriverState *bs);
 302 int64_t bdrv_getlength(BlockDriverState *bs);
 303 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
 304 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
 305 void bdrv_refresh_limits(BlockDriverState *bs, Error **errp);
 306 int bdrv_commit(BlockDriverState *bs);
 307 int bdrv_change_backing_file(BlockDriverState *bs,
 308     const char *backing_file, const char *backing_fmt);
 309 void bdrv_register(BlockDriver *bdrv);
 310 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
 311                            BlockDriverState *base,
 312                            const char *backing_file_str);
 313 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
 314                                     BlockDriverState *bs);
 315 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
 316
 317
 318 typedef struct BdrvCheckResult {
 319     int corruptions;
 320     int leaks;
 321     int check_errors;
 322     int corruptions_fixed;
 323     int leaks_fixed;
 324     int64_t image_end_offset;
 325     BlockFragInfo bfi;
 326 } BdrvCheckResult;
 327
 328 typedef enum {
 329     BDRV_FIX_LEAKS    = 1,
 330     BDRV_FIX_ERRORS   = 2,
 331 } BdrvCheckMode;
 332
 333 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
 334
 335 /* The units of offset and total_work_size may be chosen arbitrarily by the
 336  * block driver; total_work_size may change during the course of the amendment
 337  * operation */
 338 typedef void BlockDriverAmendStatusCB(BlockDriverState *bs, int64_t offset,
 339                                       int64_t total_work_size, void *opaque);
 340 int bdrv_amend_options(BlockDriverState *bs_new, QemuOpts *opts,
 341                        BlockDriverAmendStatusCB *status_cb, void *cb_opaque);
 342
 343 /* external snapshots */
 344 bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
 345                                       BlockDriverState *candidate);
 346 bool bdrv_is_first_non_filter(BlockDriverState *candidate);
 347
 348 /* check if a named node can be replaced when doing drive-mirror */
 349 BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
 350                                         const char *node_name, Error **errp);
 351
 352 /* async block I/O */
 353 BlockAIOCB *bdrv_aio_readv(BdrvChild *child, int64_t sector_num,
 354                            QEMUIOVector *iov, int nb_sectors,
 355                            BlockCompletionFunc *cb, void *opaque);
 356 BlockAIOCB *bdrv_aio_writev(BdrvChild *child, int64_t sector_num,
 357                             QEMUIOVector *iov, int nb_sectors,
 358                             BlockCompletionFunc *cb, void *opaque);
 359 BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs,
 360                            BlockCompletionFunc *cb, void *opaque);
 361 void bdrv_aio_cancel(BlockAIOCB *acb);
 362 void bdrv_aio_cancel_async(BlockAIOCB *acb);
 363
 364 /* sg packet commands */
 365 int bdrv_co_ioctl(BlockDriverState *bs, int req, void *buf);
 366
 367 /* Invalidate any cached metadata used by image formats */
 368 void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp);
 369 void bdrv_invalidate_cache_all(Error **errp);
 370 int bdrv_inactivate_all(void);
 371
 372 void blk_resume_after_migration(Error **errp);
 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 coroutine_fn bdrv_co_drain(BlockDriverState *bs);
 381 void bdrv_drain_all_begin(void);
 382 void bdrv_drain_all_end(void);
 383 void bdrv_drain_all(void);
 384
 385 #define BDRV_POLL_WHILE(bs, cond) ({                       \
 386     bool waited_ = false;                                  \
 387     bool busy_ = true;                                     \
 388     BlockDriverState *bs_ = (bs);                          \
 389     AioContext *ctx_ = bdrv_get_aio_context(bs_);          \
 390     if (aio_context_in_iothread(ctx_)) {                   \
 391         while ((cond) || busy_) {                          \
 392             busy_ = aio_poll(ctx_, (cond));                \
 393             waited_ |= !!(cond) | busy_;                   \
 394         }                                                  \
 395     } else {                                               \
 396         assert(qemu_get_current_aio_context() ==           \
 397                qemu_get_aio_context());                    \
 398         /* Ask bdrv_dec_in_flight to wake up the main      \
 399          * QEMU AioContext.  Extra I/O threads never take  \
 400          * other I/O threads' AioContexts (see for example \
 401          * block_job_defer_to_main_loop for how to do it). \
 402          */                                                \
 403         assert(!bs_->wakeup);                              \
 404         bs_->wakeup = true;                                \
 405         while (busy_) {                                    \
 406             if ((cond)) {                                  \
 407                 waited_ = busy_ = true;                    \
 408                 aio_context_release(ctx_);                 \
 409                 aio_poll(qemu_get_aio_context(), true);    \
 410                 aio_context_acquire(ctx_);                 \
 411             } else {                                       \
 412                 busy_ = aio_poll(ctx_, false);             \
 413                 waited_ |= busy_;                          \
 414             }                                              \
 415         }                                                  \
 416         bs_->wakeup = false;                               \
 417     }                                                      \
 418     waited_; })
 419
 420 int bdrv_pdiscard(BlockDriverState *bs, int64_t offset, int count);
 421 int bdrv_co_pdiscard(BlockDriverState *bs, int64_t offset, int count);
 422 int bdrv_has_zero_init_1(BlockDriverState *bs);
 423 int bdrv_has_zero_init(BlockDriverState *bs);
 424 bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs);
 425 bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs);
 426 int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num,
 427                               int nb_sectors, int *pnum,
 428                               BlockDriverState **file);
 429 int64_t bdrv_get_block_status_above(BlockDriverState *bs,
 430                                     BlockDriverState *base,
 431                                     int64_t sector_num,
 432                                     int nb_sectors, int *pnum,
 433                                     BlockDriverState **file);
 434 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 435                       int *pnum);
 436 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
 437                             int64_t sector_num, int nb_sectors, int *pnum);
 438
 439 bool bdrv_is_read_only(BlockDriverState *bs);
 440 int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, Error **errp);
 441 int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp);
 442 bool bdrv_is_sg(BlockDriverState *bs);
 443 bool bdrv_is_inserted(BlockDriverState *bs);
 444 int bdrv_media_changed(BlockDriverState *bs);
 445 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
 446 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
 447 const char *bdrv_get_format_name(BlockDriverState *bs);
 448 BlockDriverState *bdrv_find_node(const char *node_name);
 449 BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp);
 450 BlockDriverState *bdrv_lookup_bs(const char *device,
 451                                  const char *node_name,
 452                                  Error **errp);
 453 bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base);
 454 BlockDriverState *bdrv_next_node(BlockDriverState *bs);
 455
 456 typedef struct BdrvNextIterator {
 457     enum {
 458         BDRV_NEXT_BACKEND_ROOTS,
 459         BDRV_NEXT_MONITOR_OWNED,
 460     } phase;
 461     BlockBackend *blk;
 462     BlockDriverState *bs;
 463 } BdrvNextIterator;
 464
 465 BlockDriverState *bdrv_first(BdrvNextIterator *it);
 466 BlockDriverState *bdrv_next(BdrvNextIterator *it);
 467
 468 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs);
 469 bool bdrv_is_encrypted(BlockDriverState *bs);
 470 bool bdrv_key_required(BlockDriverState *bs);
 471 int bdrv_set_key(BlockDriverState *bs, const char *key);
 472 void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp);
 473 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 474                          void *opaque);
 475 const char *bdrv_get_node_name(const BlockDriverState *bs);
 476 const char *bdrv_get_device_name(const BlockDriverState *bs);
 477 const char *bdrv_get_device_or_node_name(const BlockDriverState *bs);
 478 int bdrv_get_flags(BlockDriverState *bs);
 479 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
 480 ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs);
 481 void bdrv_round_sectors_to_clusters(BlockDriverState *bs,
 482                                     int64_t sector_num, int nb_sectors,
 483                                     int64_t *cluster_sector_num,
 484                                     int *cluster_nb_sectors);
 485 void bdrv_round_to_clusters(BlockDriverState *bs,
 486                             int64_t offset, unsigned int bytes,
 487                             int64_t *cluster_offset,
 488                             unsigned int *cluster_bytes);
 489
 490 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
 491 void bdrv_get_backing_filename(BlockDriverState *bs,
 492                                char *filename, int filename_size);
 493 void bdrv_get_full_backing_filename(BlockDriverState *bs,
 494                                     char *dest, size_t sz, Error **errp);
 495 void bdrv_get_full_backing_filename_from_filename(const char *backed,
 496                                                   const char *backing,
 497                                                   char *dest, size_t sz,
 498                                                   Error **errp);
 499
 500 int path_has_protocol(const char *path);
 501 int path_is_absolute(const char *path);
 502 void path_combine(char *dest, int dest_size,
 503                   const char *base_path,
 504                   const char *filename);
 505
 506 int bdrv_readv_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
 507 int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos);
 508 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
 509                       int64_t pos, int size);
 510
 511 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
 512                       int64_t pos, int size);
 513
 514 void bdrv_img_create(const char *filename, const char *fmt,
 515                      const char *base_filename, const char *base_fmt,
 516                      char *options, uint64_t img_size, int flags,
 517                      bool quiet, Error **errp);
 518
 519 /* Returns the alignment in bytes that is required so that no bounce buffer
 520  * is required throughout the stack */
 521 size_t bdrv_min_mem_align(BlockDriverState *bs);
 522 /* Returns optimal alignment in bytes for bounce buffer */
 523 size_t bdrv_opt_mem_align(BlockDriverState *bs);
 524 void *qemu_blockalign(BlockDriverState *bs, size_t size);
 525 void *qemu_blockalign0(BlockDriverState *bs, size_t size);
 526 void *qemu_try_blockalign(BlockDriverState *bs, size_t size);
 527 void *qemu_try_blockalign0(BlockDriverState *bs, size_t size);
 528 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
 529
 530 void bdrv_enable_copy_on_read(BlockDriverState *bs);
 531 void bdrv_disable_copy_on_read(BlockDriverState *bs);
 532
 533 void bdrv_ref(BlockDriverState *bs);
 534 void bdrv_unref(BlockDriverState *bs);
 535 void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child);
 536 BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs,
 537                              BlockDriverState *child_bs,
 538                              const char *child_name,
 539                              const BdrvChildRole *child_role,
 540                              Error **errp);
 541
 542 bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp);
 543 void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason);
 544 void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason);
 545 void bdrv_op_block_all(BlockDriverState *bs, Error *reason);
 546 void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason);
 547 bool bdrv_op_blocker_is_empty(BlockDriverState *bs);
 548
 549 #define BLKDBG_EVENT(child, evt) \
 550     do { \
 551         if (child) { \
 552             bdrv_debug_event(child->bs, evt); \
 553         } \
 554     } while (0)
 555
 556 void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event);
 557
 558 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
 559                            const char *tag);
 560 int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag);
 561 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
 562 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
 563
 564 /**
 565  * bdrv_get_aio_context:
 566  *
 567  * Returns: the currently bound #AioContext
 568  */
 569 AioContext *bdrv_get_aio_context(BlockDriverState *bs);
 570
 571 /**
 572  * Transfer control to @co in the aio context of @bs
 573  */
 574 void bdrv_coroutine_enter(BlockDriverState *bs, Coroutine *co);
 575
 576 /**
 577  * bdrv_set_aio_context:
 578  *
 579  * Changes the #AioContext used for fd handlers, timers, and BHs by this
 580  * BlockDriverState and all its children.
 581  *
 582  * This function must be called with iothread lock held.
 583  */
 584 void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context);
 585 int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz);
 586 int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo);
 587
 588 void bdrv_io_plug(BlockDriverState *bs);
 589 void bdrv_io_unplug(BlockDriverState *bs);
 590
 591 /**
 592  * bdrv_parent_drained_begin:
 593  *
 594  * Begin a quiesced section of all users of @bs. This is part of
 595  * bdrv_drained_begin.
 596  */
 597 void bdrv_parent_drained_begin(BlockDriverState *bs);
 598
 599 /**
 600  * bdrv_parent_drained_end:
 601  *
 602  * End a quiesced section of all users of @bs. This is part of
 603  * bdrv_drained_end.
 604  */
 605 void bdrv_parent_drained_end(BlockDriverState *bs);
 606
 607 /**
 608  * bdrv_drained_begin:
 609  *
 610  * Begin a quiesced section for exclusive access to the BDS, by disabling
 611  * external request sources including NBD server and device model. Note that
 612  * this doesn't block timers or coroutines from submitting more requests, which
 613  * means block_job_pause is still necessary.
 614  *
 615  * This function can be recursive.
 616  */
 617 void bdrv_drained_begin(BlockDriverState *bs);
 618
 619 /**
 620  * bdrv_drained_end:
 621  *
 622  * End a quiescent section started by bdrv_drained_begin().
 623  */
 624 void bdrv_drained_end(BlockDriverState *bs);
 625
 626 void bdrv_add_child(BlockDriverState *parent, BlockDriverState *child,
 627                     Error **errp);
 628 void bdrv_del_child(BlockDriverState *parent, BdrvChild *child, Error **errp);
 629
 630 #endif