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
   8 /* block.c */
   9 typedef struct BlockDriver BlockDriver;
  10
  11 typedef struct BlockDriverInfo {
  12     /* in bytes, 0 if irrelevant */
  13     int cluster_size;
  14     /* offset at which the VM state can be saved (0 if not possible) */
  15     int64_t vm_state_offset;
  16 } BlockDriverInfo;
  17
  18 typedef struct QEMUSnapshotInfo {
  19     char id_str[128]; /* unique snapshot id */
  20     /* the following fields are informative. They are not needed for
  21        the consistency of the snapshot */
  22     char name[256]; /* user choosen name */
  23     uint32_t vm_state_size; /* VM state info size */
  24     uint32_t date_sec; /* UTC date of the snapshot */
  25     uint32_t date_nsec;
  26     uint64_t vm_clock_nsec; /* VM clock relative to boot */
  27 } QEMUSnapshotInfo;
  28
  29 #define BDRV_O_RDONLY      0x0000
  30 #define BDRV_O_RDWR        0x0002
  31 #define BDRV_O_ACCESS      0x0003
  32 #define BDRV_O_CREAT       0x0004 /* create an empty file */
  33 #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
  34 #define BDRV_O_FILE        0x0010 /* open as a raw file (do not try to
  35                                      use a disk image format on top of
  36                                      it (default for
  37                                      bdrv_file_open()) */
  38 #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
  39 #define BDRV_O_CACHE_WB    0x0040 /* use write-back caching */
  40 #define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */
  41
  42 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
  43
  44 #define BDRV_SECTOR_BITS   9
  45 #define BDRV_SECTOR_SIZE   (1 << BDRV_SECTOR_BITS)
  46 #define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1);
  47
  48 void bdrv_info(Monitor *mon);
  49 void bdrv_info_stats(Monitor *mon);
  50
  51 void bdrv_init(void);
  52 void bdrv_init_with_whitelist(void);
  53 BlockDriver *bdrv_find_format(const char *format_name);
  54 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
  55 int bdrv_create(BlockDriver *drv, const char* filename,
  56     QEMUOptionParameter *options);
  57 int bdrv_create2(BlockDriver *drv,
  58                  const char *filename, int64_t size_in_sectors,
  59                  const char *backing_file, const char *backing_format,
  60                  int flags);
  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 int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
  66                BlockDriver *drv);
  67 void bdrv_close(BlockDriverState *bs);
  68 int bdrv_check(BlockDriverState *bs);
  69 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
  70               uint8_t *buf, int nb_sectors);
  71 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
  72                const uint8_t *buf, int nb_sectors);
  73 int bdrv_pread(BlockDriverState *bs, int64_t offset,
  74                void *buf, int count);
  75 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
  76                 const void *buf, int count);
  77 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
  78 int64_t bdrv_getlength(BlockDriverState *bs);
  79 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
  80 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
  81 int bdrv_commit(BlockDriverState *bs);
  82 void bdrv_register(BlockDriver *bdrv);
  83
  84 /* async block I/O */
  85 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
  86 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
  87 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
  88                                      int sector_num);
  89 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
  90                                  QEMUIOVector *iov, int nb_sectors,
  91                                  BlockDriverCompletionFunc *cb, void *opaque);
  92 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
  93                                   QEMUIOVector *iov, int nb_sectors,
  94                                   BlockDriverCompletionFunc *cb, void *opaque);
  95 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
  96                                  BlockDriverCompletionFunc *cb, void *opaque);
  97 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
  98
  99 typedef struct BlockRequest {
 100     /* Fields to be filled by multiwrite caller */
 101     int64_t sector;
 102     int nb_sectors;
 103     QEMUIOVector *qiov;
 104     BlockDriverCompletionFunc *cb;
 105     void *opaque;
 106
 107     /* Filled by multiwrite implementation */
 108     int error;
 109 } BlockRequest;
 110
 111 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
 112     int num_reqs);
 113
 114 /* sg packet commands */
 115 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
 116 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
 117         unsigned long int req, void *buf,
 118         BlockDriverCompletionFunc *cb, void *opaque);
 119
 120 /* Ensure contents are flushed to disk.  */
 121 void bdrv_flush(BlockDriverState *bs);
 122 void bdrv_flush_all(void);
 123
 124 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 125         int *pnum);
 126
 127 #define BDRV_TYPE_HD     0
 128 #define BDRV_TYPE_CDROM  1
 129 #define BDRV_TYPE_FLOPPY 2
 130 #define BIOS_ATA_TRANSLATION_AUTO   0
 131 #define BIOS_ATA_TRANSLATION_NONE   1
 132 #define BIOS_ATA_TRANSLATION_LBA    2
 133 #define BIOS_ATA_TRANSLATION_LARGE  3
 134 #define BIOS_ATA_TRANSLATION_RECHS  4
 135
 136 void bdrv_set_geometry_hint(BlockDriverState *bs,
 137                             int cyls, int heads, int secs);
 138 void bdrv_set_type_hint(BlockDriverState *bs, int type);
 139 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
 140 void bdrv_get_geometry_hint(BlockDriverState *bs,
 141                             int *pcyls, int *pheads, int *psecs);
 142 int bdrv_get_type_hint(BlockDriverState *bs);
 143 int bdrv_get_translation_hint(BlockDriverState *bs);
 144 int bdrv_is_removable(BlockDriverState *bs);
 145 int bdrv_is_read_only(BlockDriverState *bs);
 146 int bdrv_set_read_only(BlockDriverState *bs, int read_only);
 147 int bdrv_is_sg(BlockDriverState *bs);
 148 int bdrv_enable_write_cache(BlockDriverState *bs);
 149 int bdrv_is_inserted(BlockDriverState *bs);
 150 int bdrv_media_changed(BlockDriverState *bs);
 151 int bdrv_is_locked(BlockDriverState *bs);
 152 void bdrv_set_locked(BlockDriverState *bs, int locked);
 153 int bdrv_eject(BlockDriverState *bs, int eject_flag);
 154 void bdrv_set_change_cb(BlockDriverState *bs,
 155                         void (*change_cb)(void *opaque), void *opaque);
 156 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
 157 BlockDriverState *bdrv_find(const char *name);
 158 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
 159                   void *opaque);
 160 int bdrv_is_encrypted(BlockDriverState *bs);
 161 int bdrv_key_required(BlockDriverState *bs);
 162 int bdrv_set_key(BlockDriverState *bs, const char *key);
 163 int bdrv_query_missing_keys(void);
 164 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 165                          void *opaque);
 166 const char *bdrv_get_device_name(BlockDriverState *bs);
 167 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
 168                           const uint8_t *buf, int nb_sectors);
 169 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
 170
 171 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
 172 void bdrv_get_backing_filename(BlockDriverState *bs,
 173                                char *filename, int filename_size);
 174 int bdrv_snapshot_create(BlockDriverState *bs,
 175                          QEMUSnapshotInfo *sn_info);
 176 int bdrv_snapshot_goto(BlockDriverState *bs,
 177                        const char *snapshot_id);
 178 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
 179 int bdrv_snapshot_list(BlockDriverState *bs,
 180                        QEMUSnapshotInfo **psn_info);
 181 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
 182
 183 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
 184 int path_is_absolute(const char *path);
 185 void path_combine(char *dest, int dest_size,
 186                   const char *base_path,
 187                   const char *filename);
 188
 189 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
 190                       int64_t pos, int size);
 191
 192 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
 193                       int64_t pos, int size);
 194
 195 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
 196
 197 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
 198 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
 199 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
 200                       int nr_sectors);
 201 #endif