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