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