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