block.h

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