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