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