]>
Commit | Line | Data |
---|---|---|
faf07963 PB |
1 | #ifndef BLOCK_H |
2 | #define BLOCK_H | |
3 | ||
a76bab49 | 4 | #include "qemu-aio.h" |
3b69e4b9 | 5 | #include "qemu-common.h" |
0e7e1989 | 6 | #include "qemu-option.h" |
d15e5465 | 7 | #include "qobject.h" |
a76bab49 | 8 | |
faf07963 | 9 | /* block.c */ |
faf07963 PB |
10 | typedef struct BlockDriver BlockDriver; |
11 | ||
faf07963 PB |
12 | typedef struct BlockDriverInfo { |
13 | /* in bytes, 0 if irrelevant */ | |
14 | int cluster_size; | |
15 | /* offset at which the VM state can be saved (0 if not possible) */ | |
16 | int64_t vm_state_offset; | |
17 | } BlockDriverInfo; | |
18 | ||
19 | typedef struct QEMUSnapshotInfo { | |
20 | char id_str[128]; /* unique snapshot id */ | |
21 | /* the following fields are informative. They are not needed for | |
22 | the consistency of the snapshot */ | |
23 | char name[256]; /* user choosen name */ | |
24 | uint32_t vm_state_size; /* VM state info size */ | |
25 | uint32_t date_sec; /* UTC date of the snapshot */ | |
26 | uint32_t date_nsec; | |
27 | uint64_t vm_clock_nsec; /* VM clock relative to boot */ | |
28 | } QEMUSnapshotInfo; | |
29 | ||
30 | #define BDRV_O_RDONLY 0x0000 | |
31 | #define BDRV_O_RDWR 0x0002 | |
32 | #define BDRV_O_ACCESS 0x0003 | |
33 | #define BDRV_O_CREAT 0x0004 /* create an empty file */ | |
34 | #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ | |
35 | #define BDRV_O_FILE 0x0010 /* open as a raw file (do not try to | |
36 | use a disk image format on top of | |
37 | it (default for | |
38 | bdrv_file_open()) */ | |
9f7965c7 AL |
39 | #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ |
40 | #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */ | |
5c6c3a6c | 41 | #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */ |
b783e409 | 42 | #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ |
9f7965c7 | 43 | |
0aa217e4 | 44 | #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB) |
faf07963 | 45 | |
6ea44308 JK |
46 | #define BDRV_SECTOR_BITS 9 |
47 | #define BDRV_SECTOR_SIZE (1 << BDRV_SECTOR_BITS) | |
48 | #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1); | |
49 | ||
d15e5465 LC |
50 | void bdrv_info_print(Monitor *mon, const QObject *data); |
51 | void bdrv_info(Monitor *mon, QObject **ret_data); | |
218a536a LC |
52 | void bdrv_stats_print(Monitor *mon, const QObject *data); |
53 | void bdrv_info_stats(Monitor *mon, QObject **ret_data); | |
faf07963 PB |
54 | |
55 | void bdrv_init(void); | |
eb852011 | 56 | void bdrv_init_with_whitelist(void); |
faf07963 | 57 | BlockDriver *bdrv_find_format(const char *format_name); |
eb852011 | 58 | BlockDriver *bdrv_find_whitelisted_format(const char *format_name); |
0e7e1989 KW |
59 | int bdrv_create(BlockDriver *drv, const char* filename, |
60 | QEMUOptionParameter *options); | |
5eb45639 AL |
61 | int bdrv_create2(BlockDriver *drv, |
62 | const char *filename, int64_t size_in_sectors, | |
63 | const char *backing_file, const char *backing_format, | |
64 | int flags); | |
faf07963 PB |
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); | |
e97fc193 | 72 | int bdrv_check(BlockDriverState *bs); |
faf07963 PB |
73 | int bdrv_read(BlockDriverState *bs, int64_t sector_num, |
74 | uint8_t *buf, int nb_sectors); | |
75 | int bdrv_write(BlockDriverState *bs, int64_t sector_num, | |
76 | const uint8_t *buf, int nb_sectors); | |
77 | int bdrv_pread(BlockDriverState *bs, int64_t offset, | |
78 | void *buf, int count); | |
79 | int bdrv_pwrite(BlockDriverState *bs, int64_t offset, | |
80 | const void *buf, int count); | |
81 | int bdrv_truncate(BlockDriverState *bs, int64_t offset); | |
82 | int64_t bdrv_getlength(BlockDriverState *bs); | |
96b8f136 | 83 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); |
f3d54fc4 | 84 | void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs); |
faf07963 | 85 | int bdrv_commit(BlockDriverState *bs); |
756e6736 KW |
86 | int bdrv_change_backing_file(BlockDriverState *bs, |
87 | const char *backing_file, const char *backing_fmt); | |
5efa9d5a AL |
88 | void bdrv_register(BlockDriver *bdrv); |
89 | ||
faf07963 PB |
90 | /* async block I/O */ |
91 | typedef struct BlockDriverAIOCB BlockDriverAIOCB; | |
92 | typedef void BlockDriverCompletionFunc(void *opaque, int ret); | |
7cd1e32a LS |
93 | typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector, |
94 | int sector_num); | |
3b69e4b9 AL |
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); | |
b2e12bc6 CH |
101 | BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs, |
102 | BlockDriverCompletionFunc *cb, void *opaque); | |
faf07963 PB |
103 | void bdrv_aio_cancel(BlockDriverAIOCB *acb); |
104 | ||
40b4f539 KW |
105 | typedef struct BlockRequest { |
106 | /* Fields to be filled by multiwrite caller */ | |
107 | int64_t sector; | |
108 | int nb_sectors; | |
109 | QEMUIOVector *qiov; | |
110 | BlockDriverCompletionFunc *cb; | |
111 | void *opaque; | |
112 | ||
113 | /* Filled by multiwrite implementation */ | |
114 | int error; | |
115 | } BlockRequest; | |
116 | ||
117 | int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, | |
118 | int num_reqs); | |
119 | ||
7d780669 | 120 | /* sg packet commands */ |
221f715d AL |
121 | int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); |
122 | BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, | |
123 | unsigned long int req, void *buf, | |
124 | BlockDriverCompletionFunc *cb, void *opaque); | |
7d780669 | 125 | |
faf07963 PB |
126 | /* Ensure contents are flushed to disk. */ |
127 | void bdrv_flush(BlockDriverState *bs); | |
c6ca28d6 AL |
128 | void bdrv_flush_all(void); |
129 | ||
f58c7b35 TS |
130 | int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, |
131 | int *pnum); | |
faf07963 PB |
132 | |
133 | #define BDRV_TYPE_HD 0 | |
134 | #define BDRV_TYPE_CDROM 1 | |
135 | #define BDRV_TYPE_FLOPPY 2 | |
136 | #define BIOS_ATA_TRANSLATION_AUTO 0 | |
137 | #define BIOS_ATA_TRANSLATION_NONE 1 | |
138 | #define BIOS_ATA_TRANSLATION_LBA 2 | |
139 | #define BIOS_ATA_TRANSLATION_LARGE 3 | |
140 | #define BIOS_ATA_TRANSLATION_RECHS 4 | |
141 | ||
142 | void bdrv_set_geometry_hint(BlockDriverState *bs, | |
143 | int cyls, int heads, int secs); | |
144 | void bdrv_set_type_hint(BlockDriverState *bs, int type); | |
145 | void bdrv_set_translation_hint(BlockDriverState *bs, int translation); | |
146 | void bdrv_get_geometry_hint(BlockDriverState *bs, | |
147 | int *pcyls, int *pheads, int *psecs); | |
148 | int bdrv_get_type_hint(BlockDriverState *bs); | |
149 | int bdrv_get_translation_hint(BlockDriverState *bs); | |
150 | int bdrv_is_removable(BlockDriverState *bs); | |
151 | int bdrv_is_read_only(BlockDriverState *bs); | |
59f2689d | 152 | int bdrv_set_read_only(BlockDriverState *bs, int read_only); |
985a03b0 | 153 | int bdrv_is_sg(BlockDriverState *bs); |
e900a7b7 | 154 | int bdrv_enable_write_cache(BlockDriverState *bs); |
faf07963 PB |
155 | int bdrv_is_inserted(BlockDriverState *bs); |
156 | int bdrv_media_changed(BlockDriverState *bs); | |
157 | int bdrv_is_locked(BlockDriverState *bs); | |
158 | void bdrv_set_locked(BlockDriverState *bs, int locked); | |
aea2a33c | 159 | int bdrv_eject(BlockDriverState *bs, int eject_flag); |
faf07963 PB |
160 | void bdrv_set_change_cb(BlockDriverState *bs, |
161 | void (*change_cb)(void *opaque), void *opaque); | |
162 | void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size); | |
163 | BlockDriverState *bdrv_find(const char *name); | |
51de9760 AL |
164 | void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), |
165 | void *opaque); | |
faf07963 | 166 | int bdrv_is_encrypted(BlockDriverState *bs); |
c0f4ce77 | 167 | int bdrv_key_required(BlockDriverState *bs); |
faf07963 | 168 | int bdrv_set_key(BlockDriverState *bs, const char *key); |
c0f4ce77 | 169 | int bdrv_query_missing_keys(void); |
faf07963 PB |
170 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
171 | void *opaque); | |
172 | const char *bdrv_get_device_name(BlockDriverState *bs); | |
173 | int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, | |
174 | const uint8_t *buf, int nb_sectors); | |
175 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); | |
176 | ||
045df330 | 177 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs); |
faf07963 PB |
178 | void bdrv_get_backing_filename(BlockDriverState *bs, |
179 | char *filename, int filename_size); | |
180 | int bdrv_snapshot_create(BlockDriverState *bs, | |
181 | QEMUSnapshotInfo *sn_info); | |
182 | int bdrv_snapshot_goto(BlockDriverState *bs, | |
183 | const char *snapshot_id); | |
184 | int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id); | |
185 | int bdrv_snapshot_list(BlockDriverState *bs, | |
186 | QEMUSnapshotInfo **psn_info); | |
187 | char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn); | |
188 | ||
189 | char *get_human_readable_size(char *buf, int buf_size, int64_t size); | |
190 | int path_is_absolute(const char *path); | |
191 | void path_combine(char *dest, int dest_size, | |
192 | const char *base_path, | |
193 | const char *filename); | |
194 | ||
45566e9c CH |
195 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
196 | int64_t pos, int size); | |
178e08a5 | 197 | |
45566e9c CH |
198 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
199 | int64_t pos, int size); | |
178e08a5 | 200 | |
23bd90d2 | 201 | #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048 |
6ea44308 | 202 | |
7cd1e32a LS |
203 | void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable); |
204 | int bdrv_get_dirty(BlockDriverState *bs, int64_t sector); | |
a55eb92c JK |
205 | void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, |
206 | int nr_sectors); | |
faf07963 | 207 | #endif |