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 #define BDRV_O_NO_FLUSH    0x0200 /* disable flushing on this disk */
  37
  38 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
  39
  40 #define BDRV_SECTOR_BITS   9
  41 #define BDRV_SECTOR_SIZE   (1ULL << BDRV_SECTOR_BITS)
  42 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1)
  43
  44 typedef enum {
  45     BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
  46     BLOCK_ERR_STOP_ANY
  47 } BlockErrorAction;
  48
  49 typedef enum {
  50     BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
  51 } BlockMonEventAction;
  52
  53 void bdrv_mon_event(const BlockDriverState *bdrv,
  54                     BlockMonEventAction action, int is_read);
  55 void bdrv_info_print(Monitor *mon, const QObject *data);
  56 void bdrv_info(Monitor *mon, QObject **ret_data);
  57 void bdrv_stats_print(Monitor *mon, const QObject *data);
  58 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
  59
  60 void bdrv_init(void);
  61 void bdrv_init_with_whitelist(void);
  62 BlockDriver *bdrv_find_protocol(const char *filename);
  63 BlockDriver *bdrv_find_format(const char *format_name);
  64 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
  65 int bdrv_create(BlockDriver *drv, const char* filename,
  66     QEMUOptionParameter *options);
  67 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
  68 BlockDriverState *bdrv_new(const char *device_name);
  69 void bdrv_delete(BlockDriverState *bs);
  70 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
  71 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
  72               BlockDriver *drv);
  73 void bdrv_close(BlockDriverState *bs);
  74 int bdrv_check(BlockDriverState *bs);
  75 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
  76               uint8_t *buf, int nb_sectors);
  77 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
  78                const uint8_t *buf, int nb_sectors);
  79 int bdrv_pread(BlockDriverState *bs, int64_t offset,
  80                void *buf, int count);
  81 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
  82                 const void *buf, int count);
  83 int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
  84     const void *buf, int count);
  85 int bdrv_write_sync(BlockDriverState *bs, int64_t sector_num,
  86     const uint8_t *buf, int nb_sectors);
  87 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
  88 int64_t bdrv_getlength(BlockDriverState *bs);
  89 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
  90 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
  91 int bdrv_commit(BlockDriverState *bs);
  92 void bdrv_commit_all(void);
  93 int bdrv_change_backing_file(BlockDriverState *bs,
  94     const char *backing_file, const char *backing_fmt);
  95 void bdrv_register(BlockDriver *bdrv);
  96
  97 /* async block I/O */
  98 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
  99 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
 100 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
 101                                      int sector_num);
 102 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
 103                                  QEMUIOVector *iov, int nb_sectors,
 104                                  BlockDriverCompletionFunc *cb, void *opaque);
 105 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
 106                                   QEMUIOVector *iov, int nb_sectors,
 107                                   BlockDriverCompletionFunc *cb, void *opaque);
 108 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
 109                                  BlockDriverCompletionFunc *cb, void *opaque);
 110 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
 111
 112 typedef struct BlockRequest {
 113     /* Fields to be filled by multiwrite caller */
 114     int64_t sector;
 115     int nb_sectors;
 116     QEMUIOVector *qiov;
 117     BlockDriverCompletionFunc *cb;
 118     void *opaque;
 119
 120     /* Filled by multiwrite implementation */
 121     int error;
 122 } BlockRequest;
 123
 124 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
 125     int num_reqs);
 126
 127 /* sg packet commands */
 128 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
 129 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
 130         unsigned long int req, void *buf,
 131         BlockDriverCompletionFunc *cb, void *opaque);
 132
 133 /* Ensure contents are flushed to disk.  */
 134 void bdrv_flush(BlockDriverState *bs);
 135 void bdrv_flush_all(void);
 136 void bdrv_close_all(void);
 137
 138 int bdrv_has_zero_init(BlockDriverState *bs);
 139 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 140         int *pnum);
 141
 142 #define BDRV_TYPE_HD     0
 143 #define BDRV_TYPE_CDROM  1
 144 #define BDRV_TYPE_FLOPPY 2
 145 #define BIOS_ATA_TRANSLATION_AUTO   0
 146 #define BIOS_ATA_TRANSLATION_NONE   1
 147 #define BIOS_ATA_TRANSLATION_LBA    2
 148 #define BIOS_ATA_TRANSLATION_LARGE  3
 149 #define BIOS_ATA_TRANSLATION_RECHS  4
 150
 151 void bdrv_set_geometry_hint(BlockDriverState *bs,
 152                             int cyls, int heads, int secs);
 153 void bdrv_set_type_hint(BlockDriverState *bs, int type);
 154 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
 155 void bdrv_get_geometry_hint(BlockDriverState *bs,
 156                             int *pcyls, int *pheads, int *psecs);
 157 int bdrv_get_type_hint(BlockDriverState *bs);
 158 int bdrv_get_translation_hint(BlockDriverState *bs);
 159 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
 160                        BlockErrorAction on_write_error);
 161 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
 162 int bdrv_is_removable(BlockDriverState *bs);
 163 int bdrv_is_read_only(BlockDriverState *bs);
 164 int bdrv_is_sg(BlockDriverState *bs);
 165 int bdrv_enable_write_cache(BlockDriverState *bs);
 166 int bdrv_is_inserted(BlockDriverState *bs);
 167 int bdrv_media_changed(BlockDriverState *bs);
 168 int bdrv_is_locked(BlockDriverState *bs);
 169 void bdrv_set_locked(BlockDriverState *bs, int locked);
 170 int bdrv_eject(BlockDriverState *bs, int eject_flag);
 171 void bdrv_set_change_cb(BlockDriverState *bs,
 172                         void (*change_cb)(void *opaque), void *opaque);
 173 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
 174 BlockDriverState *bdrv_find(const char *name);
 175 BlockDriverState *bdrv_next(BlockDriverState *bs);
 176 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
 177                   void *opaque);
 178 int bdrv_is_encrypted(BlockDriverState *bs);
 179 int bdrv_key_required(BlockDriverState *bs);
 180 int bdrv_set_key(BlockDriverState *bs, const char *key);
 181 int bdrv_query_missing_keys(void);
 182 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 183                          void *opaque);
 184 const char *bdrv_get_device_name(BlockDriverState *bs);
 185 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
 186                           const uint8_t *buf, int nb_sectors);
 187 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
 188
 189 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
 190 void bdrv_get_backing_filename(BlockDriverState *bs,
 191                                char *filename, int filename_size);
 192 int bdrv_can_snapshot(BlockDriverState *bs);
 193 int bdrv_snapshot_create(BlockDriverState *bs,
 194                          QEMUSnapshotInfo *sn_info);
 195 int bdrv_snapshot_goto(BlockDriverState *bs,
 196                        const char *snapshot_id);
 197 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
 198 int bdrv_snapshot_list(BlockDriverState *bs,
 199                        QEMUSnapshotInfo **psn_info);
 200 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
 201
 202 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
 203 int path_is_absolute(const char *path);
 204 void path_combine(char *dest, int dest_size,
 205                   const char *base_path,
 206                   const char *filename);
 207
 208 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
 209                       int64_t pos, int size);
 210
 211 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
 212                       int64_t pos, int size);
 213
 214 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
 215
 216 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
 217 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
 218 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
 219                       int nr_sectors);
 220 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
 221
 222
 223 typedef enum {
 224     BLKDBG_L1_UPDATE,
 225
 226     BLKDBG_L1_GROW_ALLOC_TABLE,
 227     BLKDBG_L1_GROW_WRITE_TABLE,
 228     BLKDBG_L1_GROW_ACTIVATE_TABLE,
 229
 230     BLKDBG_L2_LOAD,
 231     BLKDBG_L2_UPDATE,
 232     BLKDBG_L2_UPDATE_COMPRESSED,
 233     BLKDBG_L2_ALLOC_COW_READ,
 234     BLKDBG_L2_ALLOC_WRITE,
 235
 236     BLKDBG_READ,
 237     BLKDBG_READ_AIO,
 238     BLKDBG_READ_BACKING,
 239     BLKDBG_READ_BACKING_AIO,
 240     BLKDBG_READ_COMPRESSED,
 241
 242     BLKDBG_WRITE_AIO,
 243     BLKDBG_WRITE_COMPRESSED,
 244
 245     BLKDBG_VMSTATE_LOAD,
 246     BLKDBG_VMSTATE_SAVE,
 247
 248     BLKDBG_COW_READ,
 249     BLKDBG_COW_WRITE,
 250
 251     BLKDBG_REFTABLE_LOAD,
 252     BLKDBG_REFTABLE_GROW,
 253
 254     BLKDBG_REFBLOCK_LOAD,
 255     BLKDBG_REFBLOCK_UPDATE,
 256     BLKDBG_REFBLOCK_UPDATE_PART,
 257     BLKDBG_REFBLOCK_ALLOC,
 258     BLKDBG_REFBLOCK_ALLOC_HOOKUP,
 259     BLKDBG_REFBLOCK_ALLOC_WRITE,
 260     BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
 261     BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
 262     BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
 263
 264     BLKDBG_CLUSTER_ALLOC,
 265     BLKDBG_CLUSTER_ALLOC_BYTES,
 266     BLKDBG_CLUSTER_FREE,
 267
 268     BLKDBG_EVENT_MAX,
 269 } BlkDebugEvent;
 270
 271 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
 272 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
 273
 274 #endif