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