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