block.h

   1 #ifndef BLOCK_H
   2 #define BLOCK_H
   3
   4 #include "qemu-aio.h"
   5
   6 /* block.c */
   7 typedef struct BlockDriver BlockDriver;
   8
   9 extern BlockDriver bdrv_raw;
  10 extern BlockDriver bdrv_host_device;
  11 extern BlockDriver bdrv_cow;
  12 extern BlockDriver bdrv_qcow;
  13 extern BlockDriver bdrv_vmdk;
  14 extern BlockDriver bdrv_cloop;
  15 extern BlockDriver bdrv_dmg;
  16 extern BlockDriver bdrv_bochs;
  17 extern BlockDriver bdrv_vpc;
  18 extern BlockDriver bdrv_vvfat;
  19 extern BlockDriver bdrv_qcow2;
  20 extern BlockDriver bdrv_parallels;
  21 extern BlockDriver bdrv_nbd;
  22
  23 typedef struct BlockDriverInfo {
  24     /* in bytes, 0 if irrelevant */
  25     int cluster_size;
  26     /* offset at which the VM state can be saved (0 if not possible) */
  27     int64_t vm_state_offset;
  28 } BlockDriverInfo;
  29
  30 typedef struct QEMUSnapshotInfo {
  31     char id_str[128]; /* unique snapshot id */
  32     /* the following fields are informative. They are not needed for
  33        the consistency of the snapshot */
  34     char name[256]; /* user choosen name */
  35     uint32_t vm_state_size; /* VM state info size */
  36     uint32_t date_sec; /* UTC date of the snapshot */
  37     uint32_t date_nsec;
  38     uint64_t vm_clock_nsec; /* VM clock relative to boot */
  39 } QEMUSnapshotInfo;
  40
  41 #define BDRV_O_RDONLY      0x0000
  42 #define BDRV_O_RDWR        0x0002
  43 #define BDRV_O_ACCESS      0x0003
  44 #define BDRV_O_CREAT       0x0004 /* create an empty file */
  45 #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
  46 #define BDRV_O_FILE        0x0010 /* open as a raw file (do not try to
  47                                      use a disk image format on top of
  48                                      it (default for
  49                                      bdrv_file_open()) */
  50 #define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
  51 #define BDRV_O_CACHE_WB    0x0040 /* use write-back caching */
  52
  53 #define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
  54
  55 void bdrv_info(void);
  56 void bdrv_info_stats(void);
  57
  58 void bdrv_init(void);
  59 BlockDriver *bdrv_find_format(const char *format_name);
  60 int bdrv_create(BlockDriver *drv,
  61                 const char *filename, int64_t size_in_sectors,
  62                 const char *backing_file, int flags);
  63 BlockDriverState *bdrv_new(const char *device_name);
  64 void bdrv_delete(BlockDriverState *bs);
  65 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
  66 int bdrv_open(BlockDriverState *bs, const char *filename, int flags);
  67 int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
  68                BlockDriver *drv);
  69 void bdrv_close(BlockDriverState *bs);
  70 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
  71               uint8_t *buf, int nb_sectors);
  72 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
  73                const uint8_t *buf, int nb_sectors);
  74 int bdrv_pread(BlockDriverState *bs, int64_t offset,
  75                void *buf, int count);
  76 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
  77                 const void *buf, int count);
  78 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
  79 int64_t bdrv_getlength(BlockDriverState *bs);
  80 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
  81 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
  82 int bdrv_commit(BlockDriverState *bs);
  83 /* async block I/O */
  84 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
  85 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
  86
  87 BlockDriverAIOCB *bdrv_aio_read(BlockDriverState *bs, int64_t sector_num,
  88                                 uint8_t *buf, int nb_sectors,
  89                                 BlockDriverCompletionFunc *cb, void *opaque);
  90 BlockDriverAIOCB *bdrv_aio_write(BlockDriverState *bs, int64_t sector_num,
  91                                  const uint8_t *buf, int nb_sectors,
  92                                  BlockDriverCompletionFunc *cb, void *opaque);
  93 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
  94
  95 int qemu_key_check(BlockDriverState *bs, const char *name);
  96
  97 /* Ensure contents are flushed to disk.  */
  98 void bdrv_flush(BlockDriverState *bs);
  99 void bdrv_flush_all(void);
 100
 101 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 102         int *pnum);
 103
 104 #define BDRV_TYPE_HD     0
 105 #define BDRV_TYPE_CDROM  1
 106 #define BDRV_TYPE_FLOPPY 2
 107 #define BIOS_ATA_TRANSLATION_AUTO   0
 108 #define BIOS_ATA_TRANSLATION_NONE   1
 109 #define BIOS_ATA_TRANSLATION_LBA    2
 110 #define BIOS_ATA_TRANSLATION_LARGE  3
 111 #define BIOS_ATA_TRANSLATION_RECHS  4
 112
 113 void bdrv_flush_all(void);
 114
 115 void bdrv_set_geometry_hint(BlockDriverState *bs,
 116                             int cyls, int heads, int secs);
 117 void bdrv_set_type_hint(BlockDriverState *bs, int type);
 118 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
 119 void bdrv_get_geometry_hint(BlockDriverState *bs,
 120                             int *pcyls, int *pheads, int *psecs);
 121 int bdrv_get_type_hint(BlockDriverState *bs);
 122 int bdrv_get_translation_hint(BlockDriverState *bs);
 123 int bdrv_is_removable(BlockDriverState *bs);
 124 int bdrv_is_read_only(BlockDriverState *bs);
 125 int bdrv_is_sg(BlockDriverState *bs);
 126 int bdrv_is_inserted(BlockDriverState *bs);
 127 int bdrv_media_changed(BlockDriverState *bs);
 128 int bdrv_is_locked(BlockDriverState *bs);
 129 void bdrv_set_locked(BlockDriverState *bs, int locked);
 130 void bdrv_eject(BlockDriverState *bs, int eject_flag);
 131 void bdrv_set_change_cb(BlockDriverState *bs,
 132                         void (*change_cb)(void *opaque), void *opaque);
 133 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
 134 BlockDriverState *bdrv_find(const char *name);
 135 void bdrv_iterate(void (*it)(void *opaque, const char *name), void *opaque);
 136 int bdrv_is_encrypted(BlockDriverState *bs);
 137 int bdrv_set_key(BlockDriverState *bs, const char *key);
 138 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
 139                          void *opaque);
 140 const char *bdrv_get_device_name(BlockDriverState *bs);
 141 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
 142                           const uint8_t *buf, int nb_sectors);
 143 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
 144
 145 void bdrv_get_backing_filename(BlockDriverState *bs,
 146                                char *filename, int filename_size);
 147 int bdrv_snapshot_create(BlockDriverState *bs,
 148                          QEMUSnapshotInfo *sn_info);
 149 int bdrv_snapshot_goto(BlockDriverState *bs,
 150                        const char *snapshot_id);
 151 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
 152 int bdrv_snapshot_list(BlockDriverState *bs,
 153                        QEMUSnapshotInfo **psn_info);
 154 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
 155 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
 156
 157 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
 158 int path_is_absolute(const char *path);
 159 void path_combine(char *dest, int dest_size,
 160                   const char *base_path,
 161                   const char *filename);
 162
 163 #endif