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