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