]>
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" |
da1fa91d | 7 | #include "qemu-coroutine.h" |
d15e5465 | 8 | #include "qobject.h" |
a76bab49 | 9 | |
faf07963 | 10 | /* block.c */ |
faf07963 PB |
11 | typedef struct BlockDriver BlockDriver; |
12 | ||
faf07963 PB |
13 | typedef struct BlockDriverInfo { |
14 | /* in bytes, 0 if irrelevant */ | |
15 | int cluster_size; | |
16 | /* offset at which the VM state can be saved (0 if not possible) */ | |
17 | int64_t vm_state_offset; | |
18 | } BlockDriverInfo; | |
19 | ||
20 | typedef struct QEMUSnapshotInfo { | |
21 | char id_str[128]; /* unique snapshot id */ | |
22 | /* the following fields are informative. They are not needed for | |
23 | the consistency of the snapshot */ | |
24 | char name[256]; /* user choosen name */ | |
25 | uint32_t vm_state_size; /* VM state info size */ | |
26 | uint32_t date_sec; /* UTC date of the snapshot */ | |
27 | uint32_t date_nsec; | |
28 | uint64_t vm_clock_nsec; /* VM clock relative to boot */ | |
29 | } QEMUSnapshotInfo; | |
30 | ||
145feb17 | 31 | /* Callbacks for block device models */ |
0e49de52 | 32 | typedef struct BlockDevOps { |
145feb17 MA |
33 | /* |
34 | * Runs when virtual media changed (monitor commands eject, change) | |
35 | * Beware: doesn't run when a host device's physical media | |
36 | * changes. Sure would be useful if it did. | |
37 | */ | |
38 | void (*change_media_cb)(void *opaque); | |
39 | /* | |
40 | * Runs when the size changed (e.g. monitor command block_resize) | |
41 | */ | |
42 | void (*resize_cb)(void *opaque); | |
0e49de52 MA |
43 | } BlockDevOps; |
44 | ||
faf07963 | 45 | #define BDRV_O_RDWR 0x0002 |
faf07963 | 46 | #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ |
9f7965c7 AL |
47 | #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ |
48 | #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */ | |
5c6c3a6c | 49 | #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */ |
b783e409 | 50 | #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */ |
016f5cf6 | 51 | #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */ |
9f7965c7 | 52 | |
ceb25e5c | 53 | #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH) |
faf07963 | 54 | |
6ea44308 | 55 | #define BDRV_SECTOR_BITS 9 |
c63782cb | 56 | #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS) |
3abbc4d9 | 57 | #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1) |
6ea44308 | 58 | |
abd7f68d MA |
59 | typedef enum { |
60 | BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC, | |
61 | BLOCK_ERR_STOP_ANY | |
62 | } BlockErrorAction; | |
63 | ||
2582bfed LC |
64 | typedef enum { |
65 | BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP | |
66 | } BlockMonEventAction; | |
67 | ||
68 | void bdrv_mon_event(const BlockDriverState *bdrv, | |
69 | BlockMonEventAction action, int is_read); | |
d15e5465 LC |
70 | void bdrv_info_print(Monitor *mon, const QObject *data); |
71 | void bdrv_info(Monitor *mon, QObject **ret_data); | |
218a536a LC |
72 | void bdrv_stats_print(Monitor *mon, const QObject *data); |
73 | void bdrv_info_stats(Monitor *mon, QObject **ret_data); | |
faf07963 PB |
74 | |
75 | void bdrv_init(void); | |
eb852011 | 76 | void bdrv_init_with_whitelist(void); |
b50cbabc | 77 | BlockDriver *bdrv_find_protocol(const char *filename); |
faf07963 | 78 | BlockDriver *bdrv_find_format(const char *format_name); |
eb852011 | 79 | BlockDriver *bdrv_find_whitelisted_format(const char *format_name); |
0e7e1989 KW |
80 | int bdrv_create(BlockDriver *drv, const char* filename, |
81 | QEMUOptionParameter *options); | |
84a12e66 | 82 | int bdrv_create_file(const char* filename, QEMUOptionParameter *options); |
faf07963 | 83 | BlockDriverState *bdrv_new(const char *device_name); |
d22b2f41 | 84 | void bdrv_make_anon(BlockDriverState *bs); |
faf07963 | 85 | void bdrv_delete(BlockDriverState *bs); |
c3993cdc | 86 | int bdrv_parse_cache_flags(const char *mode, int *flags); |
faf07963 | 87 | int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags); |
d6e9098e KW |
88 | int bdrv_open(BlockDriverState *bs, const char *filename, int flags, |
89 | BlockDriver *drv); | |
faf07963 | 90 | void bdrv_close(BlockDriverState *bs); |
fa879d62 MA |
91 | int bdrv_attach_dev(BlockDriverState *bs, void *dev); |
92 | void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev); | |
93 | void bdrv_detach_dev(BlockDriverState *bs, void *dev); | |
94 | void *bdrv_get_attached_dev(BlockDriverState *bs); | |
0e49de52 MA |
95 | void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops, |
96 | void *opaque); | |
faf07963 PB |
97 | int bdrv_read(BlockDriverState *bs, int64_t sector_num, |
98 | uint8_t *buf, int nb_sectors); | |
99 | int bdrv_write(BlockDriverState *bs, int64_t sector_num, | |
100 | const uint8_t *buf, int nb_sectors); | |
101 | int bdrv_pread(BlockDriverState *bs, int64_t offset, | |
102 | void *buf, int count); | |
103 | int bdrv_pwrite(BlockDriverState *bs, int64_t offset, | |
104 | const void *buf, int count); | |
f08145fe KW |
105 | int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset, |
106 | const void *buf, int count); | |
da1fa91d KW |
107 | int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num, |
108 | int nb_sectors, QEMUIOVector *qiov); | |
109 | int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num, | |
110 | int nb_sectors, QEMUIOVector *qiov); | |
faf07963 PB |
111 | int bdrv_truncate(BlockDriverState *bs, int64_t offset); |
112 | int64_t bdrv_getlength(BlockDriverState *bs); | |
4a1d5e1f | 113 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs); |
96b8f136 | 114 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); |
f3d54fc4 | 115 | void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs); |
faf07963 | 116 | int bdrv_commit(BlockDriverState *bs); |
6ab4b5ab | 117 | void bdrv_commit_all(void); |
756e6736 KW |
118 | int bdrv_change_backing_file(BlockDriverState *bs, |
119 | const char *backing_file, const char *backing_fmt); | |
5efa9d5a AL |
120 | void bdrv_register(BlockDriver *bdrv); |
121 | ||
e076f338 KW |
122 | |
123 | typedef struct BdrvCheckResult { | |
124 | int corruptions; | |
125 | int leaks; | |
126 | int check_errors; | |
127 | } BdrvCheckResult; | |
128 | ||
129 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res); | |
130 | ||
faf07963 PB |
131 | /* async block I/O */ |
132 | typedef struct BlockDriverAIOCB BlockDriverAIOCB; | |
133 | typedef void BlockDriverCompletionFunc(void *opaque, int ret); | |
7cd1e32a | 134 | typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector, |
39aa9a12 | 135 | int sector_num); |
3b69e4b9 AL |
136 | BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num, |
137 | QEMUIOVector *iov, int nb_sectors, | |
138 | BlockDriverCompletionFunc *cb, void *opaque); | |
139 | BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num, | |
140 | QEMUIOVector *iov, int nb_sectors, | |
141 | BlockDriverCompletionFunc *cb, void *opaque); | |
b2e12bc6 | 142 | BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs, |
39aa9a12 | 143 | BlockDriverCompletionFunc *cb, void *opaque); |
faf07963 PB |
144 | void bdrv_aio_cancel(BlockDriverAIOCB *acb); |
145 | ||
40b4f539 KW |
146 | typedef struct BlockRequest { |
147 | /* Fields to be filled by multiwrite caller */ | |
148 | int64_t sector; | |
149 | int nb_sectors; | |
150 | QEMUIOVector *qiov; | |
151 | BlockDriverCompletionFunc *cb; | |
152 | void *opaque; | |
153 | ||
154 | /* Filled by multiwrite implementation */ | |
155 | int error; | |
156 | } BlockRequest; | |
157 | ||
158 | int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, | |
159 | int num_reqs); | |
160 | ||
7d780669 | 161 | /* sg packet commands */ |
221f715d AL |
162 | int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); |
163 | BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, | |
164 | unsigned long int req, void *buf, | |
165 | BlockDriverCompletionFunc *cb, void *opaque); | |
7d780669 | 166 | |
faf07963 | 167 | /* Ensure contents are flushed to disk. */ |
205ef796 | 168 | int bdrv_flush(BlockDriverState *bs); |
c6ca28d6 | 169 | void bdrv_flush_all(void); |
2bc93fed | 170 | void bdrv_close_all(void); |
c6ca28d6 | 171 | |
bb8bf76f | 172 | int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors); |
f2feebbd | 173 | int bdrv_has_zero_init(BlockDriverState *bs); |
f58c7b35 | 174 | int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, |
39aa9a12 | 175 | int *pnum); |
faf07963 | 176 | |
faf07963 PB |
177 | #define BIOS_ATA_TRANSLATION_AUTO 0 |
178 | #define BIOS_ATA_TRANSLATION_NONE 1 | |
179 | #define BIOS_ATA_TRANSLATION_LBA 2 | |
180 | #define BIOS_ATA_TRANSLATION_LARGE 3 | |
181 | #define BIOS_ATA_TRANSLATION_RECHS 4 | |
182 | ||
183 | void bdrv_set_geometry_hint(BlockDriverState *bs, | |
184 | int cyls, int heads, int secs); | |
faf07963 PB |
185 | void bdrv_set_translation_hint(BlockDriverState *bs, int translation); |
186 | void bdrv_get_geometry_hint(BlockDriverState *bs, | |
187 | int *pcyls, int *pheads, int *psecs); | |
5bbdbb46 BS |
188 | typedef enum FDriveType { |
189 | FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */ | |
190 | FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */ | |
191 | FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */ | |
192 | FDRIVE_DRV_NONE = 0x03, /* No drive connected */ | |
193 | } FDriveType; | |
194 | ||
195 | void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads, | |
196 | int *max_track, int *last_sect, | |
197 | FDriveType drive_in, FDriveType *drive); | |
faf07963 | 198 | int bdrv_get_translation_hint(BlockDriverState *bs); |
abd7f68d MA |
199 | void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error, |
200 | BlockErrorAction on_write_error); | |
201 | BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read); | |
7d0d6950 | 202 | void bdrv_set_removable(BlockDriverState *bs, int removable); |
faf07963 PB |
203 | int bdrv_is_removable(BlockDriverState *bs); |
204 | int bdrv_is_read_only(BlockDriverState *bs); | |
985a03b0 | 205 | int bdrv_is_sg(BlockDriverState *bs); |
e900a7b7 | 206 | int bdrv_enable_write_cache(BlockDriverState *bs); |
faf07963 PB |
207 | int bdrv_is_inserted(BlockDriverState *bs); |
208 | int bdrv_media_changed(BlockDriverState *bs); | |
209 | int bdrv_is_locked(BlockDriverState *bs); | |
210 | void bdrv_set_locked(BlockDriverState *bs, int locked); | |
aea2a33c | 211 | int bdrv_eject(BlockDriverState *bs, int eject_flag); |
faf07963 PB |
212 | void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size); |
213 | BlockDriverState *bdrv_find(const char *name); | |
2f399b0a | 214 | BlockDriverState *bdrv_next(BlockDriverState *bs); |
51de9760 AL |
215 | void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), |
216 | void *opaque); | |
faf07963 | 217 | int bdrv_is_encrypted(BlockDriverState *bs); |
c0f4ce77 | 218 | int bdrv_key_required(BlockDriverState *bs); |
faf07963 | 219 | int bdrv_set_key(BlockDriverState *bs, const char *key); |
c0f4ce77 | 220 | int bdrv_query_missing_keys(void); |
faf07963 PB |
221 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
222 | void *opaque); | |
223 | const char *bdrv_get_device_name(BlockDriverState *bs); | |
224 | int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, | |
225 | const uint8_t *buf, int nb_sectors); | |
226 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); | |
227 | ||
045df330 | 228 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs); |
faf07963 PB |
229 | void bdrv_get_backing_filename(BlockDriverState *bs, |
230 | char *filename, int filename_size); | |
feeee5ac | 231 | int bdrv_can_snapshot(BlockDriverState *bs); |
199630b6 | 232 | int bdrv_is_snapshot(BlockDriverState *bs); |
f9092b10 | 233 | BlockDriverState *bdrv_snapshots(void); |
faf07963 PB |
234 | int bdrv_snapshot_create(BlockDriverState *bs, |
235 | QEMUSnapshotInfo *sn_info); | |
236 | int bdrv_snapshot_goto(BlockDriverState *bs, | |
237 | const char *snapshot_id); | |
238 | int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id); | |
239 | int bdrv_snapshot_list(BlockDriverState *bs, | |
240 | QEMUSnapshotInfo **psn_info); | |
51ef6727 | 241 | int bdrv_snapshot_load_tmp(BlockDriverState *bs, |
242 | const char *snapshot_name); | |
faf07963 PB |
243 | char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn); |
244 | ||
245 | char *get_human_readable_size(char *buf, int buf_size, int64_t size); | |
246 | int path_is_absolute(const char *path); | |
247 | void path_combine(char *dest, int dest_size, | |
248 | const char *base_path, | |
249 | const char *filename); | |
250 | ||
45566e9c CH |
251 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
252 | int64_t pos, int size); | |
178e08a5 | 253 | |
45566e9c CH |
254 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
255 | int64_t pos, int size); | |
178e08a5 | 256 | |
f88e1a42 JS |
257 | int bdrv_img_create(const char *filename, const char *fmt, |
258 | const char *base_filename, const char *base_fmt, | |
259 | char *options, uint64_t img_size, int flags); | |
260 | ||
23bd90d2 | 261 | #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048 |
6ea44308 | 262 | |
7cd1e32a LS |
263 | void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable); |
264 | int bdrv_get_dirty(BlockDriverState *bs, int64_t sector); | |
a55eb92c JK |
265 | void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, |
266 | int nr_sectors); | |
aaa0eb75 | 267 | int64_t bdrv_get_dirty_count(BlockDriverState *bs); |
8b9b0cc2 | 268 | |
db593f25 MT |
269 | void bdrv_set_in_use(BlockDriverState *bs, int in_use); |
270 | int bdrv_in_use(BlockDriverState *bs); | |
8b9b0cc2 | 271 | |
a597e79c CH |
272 | enum BlockAcctType { |
273 | BDRV_ACCT_READ, | |
274 | BDRV_ACCT_WRITE, | |
275 | BDRV_ACCT_FLUSH, | |
276 | BDRV_MAX_IOTYPE, | |
277 | }; | |
278 | ||
279 | typedef struct BlockAcctCookie { | |
280 | int64_t bytes; | |
c488c7f6 | 281 | int64_t start_time_ns; |
a597e79c CH |
282 | enum BlockAcctType type; |
283 | } BlockAcctCookie; | |
284 | ||
285 | void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, | |
286 | int64_t bytes, enum BlockAcctType type); | |
287 | void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie); | |
288 | ||
8b9b0cc2 | 289 | typedef enum { |
8252278a KW |
290 | BLKDBG_L1_UPDATE, |
291 | ||
292 | BLKDBG_L1_GROW_ALLOC_TABLE, | |
293 | BLKDBG_L1_GROW_WRITE_TABLE, | |
294 | BLKDBG_L1_GROW_ACTIVATE_TABLE, | |
295 | ||
296 | BLKDBG_L2_LOAD, | |
297 | BLKDBG_L2_UPDATE, | |
298 | BLKDBG_L2_UPDATE_COMPRESSED, | |
299 | BLKDBG_L2_ALLOC_COW_READ, | |
300 | BLKDBG_L2_ALLOC_WRITE, | |
301 | ||
302 | BLKDBG_READ, | |
303 | BLKDBG_READ_AIO, | |
304 | BLKDBG_READ_BACKING, | |
305 | BLKDBG_READ_BACKING_AIO, | |
306 | BLKDBG_READ_COMPRESSED, | |
307 | ||
308 | BLKDBG_WRITE_AIO, | |
309 | BLKDBG_WRITE_COMPRESSED, | |
310 | ||
311 | BLKDBG_VMSTATE_LOAD, | |
312 | BLKDBG_VMSTATE_SAVE, | |
313 | ||
314 | BLKDBG_COW_READ, | |
315 | BLKDBG_COW_WRITE, | |
316 | ||
317 | BLKDBG_REFTABLE_LOAD, | |
318 | BLKDBG_REFTABLE_GROW, | |
319 | ||
320 | BLKDBG_REFBLOCK_LOAD, | |
321 | BLKDBG_REFBLOCK_UPDATE, | |
322 | BLKDBG_REFBLOCK_UPDATE_PART, | |
323 | BLKDBG_REFBLOCK_ALLOC, | |
324 | BLKDBG_REFBLOCK_ALLOC_HOOKUP, | |
325 | BLKDBG_REFBLOCK_ALLOC_WRITE, | |
326 | BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS, | |
327 | BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE, | |
328 | BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE, | |
329 | ||
330 | BLKDBG_CLUSTER_ALLOC, | |
331 | BLKDBG_CLUSTER_ALLOC_BYTES, | |
332 | BLKDBG_CLUSTER_FREE, | |
333 | ||
8b9b0cc2 KW |
334 | BLKDBG_EVENT_MAX, |
335 | } BlkDebugEvent; | |
336 | ||
337 | #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt) | |
338 | void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event); | |
339 | ||
faf07963 | 340 | #endif |
a597e79c | 341 |