include/block/block.h

   1 #ifndef BLOCK_H
   2 #define BLOCK_H
   3
   4 #include "block/aio.h"
   5 #include "qemu-common.h"
   6 #include "qemu/option.h"
   7 #include "block/coroutine.h"
   8 #include "qapi/qmp/qobject.h"
   9 #include "qapi-types.h"
  10
  11 /* block.c */
  12 typedef struct BlockDriver BlockDriver;
  13 typedef struct BlockJob BlockJob;
  14
  15 typedef struct BlockDriverInfo {
  16     /* in bytes, 0 if irrelevant */
  17     int cluster_size;
  18     /* offset at which the VM state can be saved (0 if not possible) */
  19     int64_t vm_state_offset;
  20     bool is_dirty;
  21 } BlockDriverInfo;
  22
  23 typedef struct BlockFragInfo {
  24     uint64_t allocated_clusters;
  25     uint64_t total_clusters;
  26     uint64_t fragmented_clusters;
  27     uint64_t compressed_clusters;
  28 } BlockFragInfo;
  29
  30 typedef struct QEMUSnapshotInfo {
  31     char id_str[128]; /* unique snapshot id */
  32     /* the following fields are informative. They are not needed for
  33        the consistency of the snapshot */
  34     char name[256]; /* user chosen name */
  35     uint64_t vm_state_size; /* VM state info size */
  36     uint32_t date_sec; /* UTC date of the snapshot */
  37     uint32_t date_nsec;
  38     uint64_t vm_clock_nsec; /* VM clock relative to boot */
  39 } QEMUSnapshotInfo;
  40
  41 /* Callbacks for block device models */
  42 typedef struct BlockDevOps {
  43     /*
  44      * Runs when virtual media changed (monitor commands eject, change)
  45      * Argument load is true on load and false on eject.
  46      * Beware: doesn't run when a host device's physical media
  47      * changes.  Sure would be useful if it did.
  48      * Device models with removable media must implement this callback.
  49      */
  50     void (*change_media_cb)(void *opaque, bool load);
  51     /*
  52      * Runs when an eject request is issued from the monitor, the tray
  53      * is closed, and the medium is locked.
  54      * Device models that do not implement is_medium_locked will not need
  55      * this callback.  Device models that can lock the medium or tray might
  56      * want to implement the callback and unlock the tray when "force" is
  57      * true, even if they do not support eject requests.
  58      */
  59     void (*eject_request_cb)(void *opaque, bool force);
  60     /*
  61      * Is the virtual tray open?
  62      * Device models implement this only when the device has a tray.
  63      */
  64     bool (*is_tray_open)(void *opaque);
  65     /*
  66      * Is the virtual medium locked into the device?
  67      * Device models implement this only when device has such a lock.
  68      */
  69     bool (*is_medium_locked)(void *opaque);
  70     /*
  71      * Runs when the size changed (e.g. monitor command block_resize)
  72      */
  73     void (*resize_cb)(void *opaque);
  74 } BlockDevOps;
  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_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
  88 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
  89
  90 #define BDRV_SECTOR_BITS   9
  91 #define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
  92 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
  93
  94 typedef enum {
  95     BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
  96 } BlockErrorAction;
  97
  98 typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;
  99
 100 typedef struct BDRVReopenState {
 101     BlockDriverState *bs;
 102     int flags;
 103     void *opaque;
 104 } BDRVReopenState;
 105
 106
 107 void bdrv_iostatus_enable(BlockDriverState *bs);
 108 void bdrv_iostatus_reset(BlockDriverState *bs);
 109 void bdrv_iostatus_disable(BlockDriverState *bs);
 110 bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
 111 void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
 112 void bdrv_info_print(Monitor *mon, const QObject *data);
 113 void bdrv_info(Monitor *mon, QObject **ret_data);
 114 void bdrv_stats_print(Monitor *mon, const QObject *data);
 115 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
 116
 117 /* disk I/O throttling */
 118 void bdrv_io_limits_enable(BlockDriverState *bs);
 119 void bdrv_io_limits_disable(BlockDriverState *bs);
 120 bool bdrv_io_limits_enabled(BlockDriverState *bs);
 121
 122 void bdrv_init(void);
 123 void bdrv_init_with_whitelist(void);
 124 BlockDriver *bdrv_find_protocol(const char *filename);
 125 BlockDriver *bdrv_find_format(const char *format_name);
 126 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
 127 int bdrv_create(BlockDriver *drv, const char* filename,
 128     QEMUOptionParameter *options);
 129 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
 130 BlockDriverState *bdrv_new(const char *device_name);
 131 void bdrv_make_anon(BlockDriverState *bs);
 132 void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
 133 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
 134 void bdrv_delete(BlockDriverState *bs);
 135 int bdrv_parse_cache_flags(const char *mode, int *flags);
 136 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
 137 int bdrv_open_backing_file(BlockDriverState *bs);
 138 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
 139               BlockDriver *drv);
 140 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
 141                                     BlockDriverState *bs, int flags);
 142 int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
 143 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
 144 int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
 145                         BlockReopenQueue *queue, Error **errp);
 146 void bdrv_reopen_commit(BDRVReopenState *reopen_state);
 147 void bdrv_reopen_abort(BDRVReopenState *reopen_state);
 148 void bdrv_close(BlockDriverState *bs);
 149 void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
 150 int bdrv_attach_dev(BlockDriverState *bs, void *dev);
 151 void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
 152 void bdrv_detach_dev(BlockDriverState *bs, void *dev);
 153 void *bdrv_get_attached_dev(BlockDriverState *bs);
 154 void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
 155                       void *opaque);
 156 void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
 157 bool bdrv_dev_has_removable_media(BlockDriverState *bs);
 158 bool bdrv_dev_is_tray_open(BlockDriverState *bs);
 159 bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
 160 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
 161               uint8_t *buf, int nb_sectors);
 162 int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
 163                           uint8_t *buf, int nb_sectors);
 164 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
 165                const uint8_t *buf, int nb_sectors);
 166 int bdrv_pread(BlockDriverState *bs, int64_t offset,
 167                void *buf, int count);
 168 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
 169                 const void *buf, int count);
 170 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
 171     const void *buf, int count);
 172 int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
 173     int nb_sectors, QEMUIOVector *qiov);
 174 int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
 175     int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
 176 int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
 177     int nb_sectors, QEMUIOVector *qiov);
 178 /*
 179  * Efficiently zero a region of the disk image.  Note that this is a regular
 180  * I/O request like read or write and should have a reasonable size.  This
 181  * function is not suitable for zeroing the entire image in a single request
 182  * because it may allocate memory for the entire region.
 183  */
 184 int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
 185     int nb_sectors);
 186 int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
 187     int nb_sectors, int *pnum);
 188 int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
 189                                             BlockDriverState *base,
 190                                             int64_t sector_num,
 191                                             int nb_sectors, int *pnum);
 192 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
 193     const char *backing_file);
 194 int bdrv_get_backing_file_depth(BlockDriverState *bs);
 195 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
 196 int64_t bdrv_getlength(BlockDriverState *bs);
 197 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
 198 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
 199 int bdrv_commit(BlockDriverState *bs);
 200 int bdrv_commit_all(void);
 201 int bdrv_change_backing_file(BlockDriverState *bs,
 202     const char *backing_file, const char *backing_fmt);
 203 void bdrv_register(BlockDriver *bdrv);
 204 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
 205                            BlockDriverState *base);
 206 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
 207                                     BlockDriverState *bs);
 208 BlockDriverState *bdrv_find_base(BlockDriverState *bs);
 209
 210
 211 typedef struct BdrvCheckResult {
 212     int corruptions;
 213     int leaks;
 214     int check_errors;
 215     int corruptions_fixed;
 216     int leaks_fixed;
 217     int64_t image_end_offset;
 218     BlockFragInfo bfi;
 219 } BdrvCheckResult;
 220
 221 typedef enum {
 222     BDRV_FIX_LEAKS    = 1,
 223     BDRV_FIX_ERRORS   = 2,
 224 } BdrvCheckMode;
 225
 226 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix);
 227
 228 /* async block I/O */
 229 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
 230                                      int sector_num);
 231 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
 232                                  QEMUIOVector *iov, int nb_sectors,
 233                                  BlockDriverCompletionFunc *cb, void *opaque);
 234 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
 235                                   QEMUIOVector *iov, int nb_sectors,
 236                                   BlockDriverCompletionFunc *cb, void *opaque);
 237 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
 238                                  BlockDriverCompletionFunc *cb, void *opaque);
 239 BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
 240                                    int64_t sector_num, int nb_sectors,
 241                                    BlockDriverCompletionFunc *cb, void *opaque);
 242 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
 243
 244 typedef struct BlockRequest {
 245     /* Fields to be filled by multiwrite caller */
 246     int64_t sector;
 247     int nb_sectors;
 248     QEMUIOVector *qiov;
 249     BlockDriverCompletionFunc *cb;
 250     void *opaque;
 251
 252     /* Filled by multiwrite implementation */
 253     int error;
 254 } BlockRequest;
 255
 256 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
 257     int num_reqs);
 258
 259 /* sg packet commands */
 260 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
 261 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
 262         unsigned long int req, void *buf,
 263         BlockDriverCompletionFunc *cb, void *opaque);
 264
 265 /* Invalidate any cached metadata used by image formats */
 266 void bdrv_invalidate_cache(BlockDriverState *bs);
 267 void bdrv_invalidate_cache_all(void);
 268
 269 void bdrv_clear_incoming_migration_all(void);
 270
 271 /* Ensure contents are flushed to disk.  */
 272 int bdrv_flush(BlockDriverState *bs);
 273 int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
 274 void bdrv_flush_all(void);
 275 void bdrv_close_all(void);
 276 void bdrv_drain_all(void);
 277
 278 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
 279 int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
 280 int bdrv_has_zero_init(BlockDriverState *bs);
 281 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 282                       int *pnum);
 283 int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
 284                             int64_t sector_num, int nb_sectors, int *pnum);
 285
 286 void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
 287                        BlockdevOnError on_write_error);
 288 BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
 289 BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
 290 void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
 291                        bool is_read, int error);
 292 int bdrv_is_read_only(BlockDriverState *bs);
 293 int bdrv_is_sg(BlockDriverState *bs);
 294 int bdrv_enable_write_cache(BlockDriverState *bs);
 295 void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
 296 int bdrv_is_inserted(BlockDriverState *bs);
 297 int bdrv_media_changed(BlockDriverState *bs);
 298 void bdrv_lock_medium(BlockDriverState *bs, bool locked);
 299 void bdrv_eject(BlockDriverState *bs, bool eject_flag);
 300 const char *bdrv_get_format_name(BlockDriverState *bs);
 301 BlockDriverState *bdrv_find(const char *name);
 302 BlockDriverState *bdrv_next(BlockDriverState *bs);
 303 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
 304                   void *opaque);
 305 int bdrv_is_encrypted(BlockDriverState *bs);
 306 int bdrv_key_required(BlockDriverState *bs);
 307 int bdrv_set_key(BlockDriverState *bs, const char *key);
 308 int bdrv_query_missing_keys(void);
 309 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 310                          void *opaque);
 311 const char *bdrv_get_device_name(BlockDriverState *bs);
 312 int bdrv_get_flags(BlockDriverState *bs);
 313 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
 314                           const uint8_t *buf, int nb_sectors);
 315 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
 316 void bdrv_round_to_clusters(BlockDriverState *bs,
 317                             int64_t sector_num, int nb_sectors,
 318                             int64_t *cluster_sector_num,
 319                             int *cluster_nb_sectors);
 320
 321 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
 322 void bdrv_get_backing_filename(BlockDriverState *bs,
 323                                char *filename, int filename_size);
 324 void bdrv_get_full_backing_filename(BlockDriverState *bs,
 325                                     char *dest, size_t sz);
 326 BlockInfo *bdrv_query_info(BlockDriverState *s);
 327 BlockStats *bdrv_query_stats(const BlockDriverState *bs);
 328 int bdrv_can_snapshot(BlockDriverState *bs);
 329 int bdrv_is_snapshot(BlockDriverState *bs);
 330 BlockDriverState *bdrv_snapshots(void);
 331 int bdrv_snapshot_create(BlockDriverState *bs,
 332                          QEMUSnapshotInfo *sn_info);
 333 int bdrv_snapshot_goto(BlockDriverState *bs,
 334                        const char *snapshot_id);
 335 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
 336 int bdrv_snapshot_list(BlockDriverState *bs,
 337                        QEMUSnapshotInfo **psn_info);
 338 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
 339                            const char *snapshot_name);
 340 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
 341
 342 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
 343 int path_is_absolute(const char *path);
 344 void path_combine(char *dest, int dest_size,
 345                   const char *base_path,
 346                   const char *filename);
 347
 348 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
 349                       int64_t pos, int size);
 350
 351 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
 352                       int64_t pos, int size);
 353
 354 void bdrv_img_create(const char *filename, const char *fmt,
 355                      const char *base_filename, const char *base_fmt,
 356                      char *options, uint64_t img_size, int flags,
 357                      Error **errp, bool quiet);
 358
 359 void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
 360 void *qemu_blockalign(BlockDriverState *bs, size_t size);
 361 bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);
 362
 363 struct HBitmapIter;
 364 void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity);
 365 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
 366 void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
 367 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
 368 void bdrv_dirty_iter_init(BlockDriverState *bs, struct HBitmapIter *hbi);
 369 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
 370
 371 void bdrv_enable_copy_on_read(BlockDriverState *bs);
 372 void bdrv_disable_copy_on_read(BlockDriverState *bs);
 373
 374 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
 375 int bdrv_in_use(BlockDriverState *bs);
 376
 377 #ifdef CONFIG_LINUX_AIO
 378 int raw_get_aio_fd(BlockDriverState *bs);
 379 #else
 380 static inline int raw_get_aio_fd(BlockDriverState *bs)
 381 {
 382     return -ENOTSUP;
 383 }
 384 #endif
 385
 386 enum BlockAcctType {
 387     BDRV_ACCT_READ,
 388     BDRV_ACCT_WRITE,
 389     BDRV_ACCT_FLUSH,
 390     BDRV_MAX_IOTYPE,
 391 };
 392
 393 typedef struct BlockAcctCookie {
 394     int64_t bytes;
 395     int64_t start_time_ns;
 396     enum BlockAcctType type;
 397 } BlockAcctCookie;
 398
 399 void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
 400         int64_t bytes, enum BlockAcctType type);
 401 void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);
 402
 403 typedef enum {
 404     BLKDBG_L1_UPDATE,
 405
 406     BLKDBG_L1_GROW_ALLOC_TABLE,
 407     BLKDBG_L1_GROW_WRITE_TABLE,
 408     BLKDBG_L1_GROW_ACTIVATE_TABLE,
 409
 410     BLKDBG_L2_LOAD,
 411     BLKDBG_L2_UPDATE,
 412     BLKDBG_L2_UPDATE_COMPRESSED,
 413     BLKDBG_L2_ALLOC_COW_READ,
 414     BLKDBG_L2_ALLOC_WRITE,
 415
 416     BLKDBG_READ_AIO,
 417     BLKDBG_READ_BACKING_AIO,
 418     BLKDBG_READ_COMPRESSED,
 419
 420     BLKDBG_WRITE_AIO,
 421     BLKDBG_WRITE_COMPRESSED,
 422
 423     BLKDBG_VMSTATE_LOAD,
 424     BLKDBG_VMSTATE_SAVE,
 425
 426     BLKDBG_COW_READ,
 427     BLKDBG_COW_WRITE,
 428
 429     BLKDBG_REFTABLE_LOAD,
 430     BLKDBG_REFTABLE_GROW,
 431
 432     BLKDBG_REFBLOCK_LOAD,
 433     BLKDBG_REFBLOCK_UPDATE,
 434     BLKDBG_REFBLOCK_UPDATE_PART,
 435     BLKDBG_REFBLOCK_ALLOC,
 436     BLKDBG_REFBLOCK_ALLOC_HOOKUP,
 437     BLKDBG_REFBLOCK_ALLOC_WRITE,
 438     BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
 439     BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
 440     BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
 441
 442     BLKDBG_CLUSTER_ALLOC,
 443     BLKDBG_CLUSTER_ALLOC_BYTES,
 444     BLKDBG_CLUSTER_FREE,
 445
 446     BLKDBG_EVENT_MAX,
 447 } BlkDebugEvent;
 448
 449 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
 450 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
 451
 452 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
 453                            const char *tag);
 454 int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
 455 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);
 456
 457 #endif