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