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