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