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