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