block.h

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