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 "qobject.h"
   8
   9 /* block.c */
  10 typedef struct BlockDriver BlockDriver;
  11
  12 typedef struct BlockDriverInfo {
  13     /* in bytes, 0 if irrelevant */
  14     int cluster_size;
  15     /* offset at which the VM state can be saved (0 if not possible) */
  16     int64_t vm_state_offset;
  17 } BlockDriverInfo;
  18
  19 typedef struct QEMUSnapshotInfo {
  20     char id_str[128]; /* unique snapshot id */
  21     /* the following fields are informative. They are not needed for
  22        the consistency of the snapshot */
  23     char name[256]; /* user choosen name */
  24     uint32_t vm_state_size; /* VM state info size */
  25     uint32_t date_sec; /* UTC date of the snapshot */
  26     uint32_t date_nsec;
  27     uint64_t vm_clock_nsec; /* VM clock relative to boot */
  28 } QEMUSnapshotInfo;
  29
  30 #define BDRV_O_RDWR        0x0002
  31 #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
  32 #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
  33 #define BDRV_O_CACHE_WB    0x0040 /* use write-back caching */
  34 #define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */
  35 #define BDRV_O_NO_BACKING  0x0100 /* don't open the backing file */
  36
  37 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
  38
  39 #define BDRV_SECTOR_BITS   9
  40 #define BDRV_SECTOR_SIZE   (1 << BDRV_SECTOR_BITS)
  41 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
  42
  43 typedef enum {
  44     BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
  45 } BlockMonEventAction;
  46
  47 void bdrv_mon_event(const BlockDriverState *bdrv,
  48                     BlockMonEventAction action, int is_read);
  49 void bdrv_info_print(Monitor *mon, const QObject *data);
  50 void bdrv_info(Monitor *mon, QObject **ret_data);
  51 void bdrv_stats_print(Monitor *mon, const QObject *data);
  52 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
  53
  54 void bdrv_init(void);
  55 void bdrv_init_with_whitelist(void);
  56 BlockDriver *bdrv_find_format(const char *format_name);
  57 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
  58 int bdrv_create(BlockDriver *drv, const char* filename,
  59     QEMUOptionParameter *options);
  60 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
  61 BlockDriverState *bdrv_new(const char *device_name);
  62 void bdrv_delete(BlockDriverState *bs);
  63 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
  64 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
  65               BlockDriver *drv);
  66 void bdrv_close(BlockDriverState *bs);
  67 int bdrv_check(BlockDriverState *bs);
  68 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
  69               uint8_t *buf, int nb_sectors);
  70 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
  71                const uint8_t *buf, int nb_sectors);
  72 int bdrv_pread(BlockDriverState *bs, int64_t offset,
  73                void *buf, int count);
  74 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
  75                 const void *buf, int count);
  76 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
  77 int64_t bdrv_getlength(BlockDriverState *bs);
  78 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
  79 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
  80 int bdrv_commit(BlockDriverState *bs);
  81 int bdrv_change_backing_file(BlockDriverState *bs,
  82     const char *backing_file, const char *backing_fmt);
  83 void bdrv_register(BlockDriver *bdrv);
  84
  85 /* async block I/O */
  86 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
  87 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
  88 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
  89                                      int sector_num);
  90 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
  91                                  QEMUIOVector *iov, int nb_sectors,
  92                                  BlockDriverCompletionFunc *cb, void *opaque);
  93 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
  94                                   QEMUIOVector *iov, int nb_sectors,
  95                                   BlockDriverCompletionFunc *cb, void *opaque);
  96 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
  97                                  BlockDriverCompletionFunc *cb, void *opaque);
  98 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
  99
 100 typedef struct BlockRequest {
 101     /* Fields to be filled by multiwrite caller */
 102     int64_t sector;
 103     int nb_sectors;
 104     QEMUIOVector *qiov;
 105     BlockDriverCompletionFunc *cb;
 106     void *opaque;
 107
 108     /* Filled by multiwrite implementation */
 109     int error;
 110 } BlockRequest;
 111
 112 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
 113     int num_reqs);
 114
 115 /* sg packet commands */
 116 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
 117 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
 118         unsigned long int req, void *buf,
 119         BlockDriverCompletionFunc *cb, void *opaque);
 120
 121 /* Ensure contents are flushed to disk.  */
 122 void bdrv_flush(BlockDriverState *bs);
 123 void bdrv_flush_all(void);
 124
 125 int bdrv_has_zero_init(BlockDriverState *bs);
 126 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 127         int *pnum);
 128
 129 #define BDRV_TYPE_HD     0
 130 #define BDRV_TYPE_CDROM  1
 131 #define BDRV_TYPE_FLOPPY 2
 132 #define BIOS_ATA_TRANSLATION_AUTO   0
 133 #define BIOS_ATA_TRANSLATION_NONE   1
 134 #define BIOS_ATA_TRANSLATION_LBA    2
 135 #define BIOS_ATA_TRANSLATION_LARGE  3
 136 #define BIOS_ATA_TRANSLATION_RECHS  4
 137
 138 void bdrv_set_geometry_hint(BlockDriverState *bs,
 139                             int cyls, int heads, int secs);
 140 void bdrv_set_type_hint(BlockDriverState *bs, int type);
 141 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
 142 void bdrv_get_geometry_hint(BlockDriverState *bs,
 143                             int *pcyls, int *pheads, int *psecs);
 144 int bdrv_get_type_hint(BlockDriverState *bs);
 145 int bdrv_get_translation_hint(BlockDriverState *bs);
 146 int bdrv_is_removable(BlockDriverState *bs);
 147 int bdrv_is_read_only(BlockDriverState *bs);
 148 int bdrv_is_sg(BlockDriverState *bs);
 149 int bdrv_enable_write_cache(BlockDriverState *bs);
 150 int bdrv_is_inserted(BlockDriverState *bs);
 151 int bdrv_media_changed(BlockDriverState *bs);
 152 int bdrv_is_locked(BlockDriverState *bs);
 153 void bdrv_set_locked(BlockDriverState *bs, int locked);
 154 int bdrv_eject(BlockDriverState *bs, int eject_flag);
 155 void bdrv_set_change_cb(BlockDriverState *bs,
 156                         void (*change_cb)(void *opaque), void *opaque);
 157 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
 158 BlockDriverState *bdrv_find(const char *name);
 159 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
 160                   void *opaque);
 161 int bdrv_is_encrypted(BlockDriverState *bs);
 162 int bdrv_key_required(BlockDriverState *bs);
 163 int bdrv_set_key(BlockDriverState *bs, const char *key);
 164 int bdrv_query_missing_keys(void);
 165 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 166                          void *opaque);
 167 const char *bdrv_get_device_name(BlockDriverState *bs);
 168 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
 169                           const uint8_t *buf, int nb_sectors);
 170 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
 171
 172 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
 173 void bdrv_get_backing_filename(BlockDriverState *bs,
 174                                char *filename, int filename_size);
 175 int bdrv_snapshot_create(BlockDriverState *bs,
 176                          QEMUSnapshotInfo *sn_info);
 177 int bdrv_snapshot_goto(BlockDriverState *bs,
 178                        const char *snapshot_id);
 179 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
 180 int bdrv_snapshot_list(BlockDriverState *bs,
 181                        QEMUSnapshotInfo **psn_info);
 182 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
 183
 184 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
 185 int path_is_absolute(const char *path);
 186 void path_combine(char *dest, int dest_size,
 187                   const char *base_path,
 188                   const char *filename);
 189
 190 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
 191                       int64_t pos, int size);
 192
 193 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
 194                       int64_t pos, int size);
 195
 196 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
 197
 198 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
 199 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
 200 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
 201                       int nr_sectors);
 202 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
 203
 204
 205 typedef enum {
 206     BLKDBG_L1_UPDATE,
 207
 208     BLKDBG_L1_GROW_ALLOC_TABLE,
 209     BLKDBG_L1_GROW_WRITE_TABLE,
 210     BLKDBG_L1_GROW_ACTIVATE_TABLE,
 211
 212     BLKDBG_L2_LOAD,
 213     BLKDBG_L2_UPDATE,
 214     BLKDBG_L2_UPDATE_COMPRESSED,
 215     BLKDBG_L2_ALLOC_COW_READ,
 216     BLKDBG_L2_ALLOC_WRITE,
 217
 218     BLKDBG_READ,
 219     BLKDBG_READ_AIO,
 220     BLKDBG_READ_BACKING,
 221     BLKDBG_READ_BACKING_AIO,
 222     BLKDBG_READ_COMPRESSED,
 223
 224     BLKDBG_WRITE_AIO,
 225     BLKDBG_WRITE_COMPRESSED,
 226
 227     BLKDBG_VMSTATE_LOAD,
 228     BLKDBG_VMSTATE_SAVE,
 229
 230     BLKDBG_COW_READ,
 231     BLKDBG_COW_WRITE,
 232
 233     BLKDBG_REFTABLE_LOAD,
 234     BLKDBG_REFTABLE_GROW,
 235
 236     BLKDBG_REFBLOCK_LOAD,
 237     BLKDBG_REFBLOCK_UPDATE,
 238     BLKDBG_REFBLOCK_UPDATE_PART,
 239     BLKDBG_REFBLOCK_ALLOC,
 240     BLKDBG_REFBLOCK_ALLOC_HOOKUP,
 241     BLKDBG_REFBLOCK_ALLOC_WRITE,
 242     BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
 243     BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
 244     BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
 245
 246     BLKDBG_CLUSTER_ALLOC,
 247     BLKDBG_CLUSTER_ALLOC_BYTES,
 248     BLKDBG_CLUSTER_FREE,
 249
 250     BLKDBG_EVENT_MAX,
 251 } BlkDebugEvent;
 252
 253 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
 254 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
 255
 256 #endif