block: Remove type hint, it's guest matter, doesn't belong here
[qemu.git] / block.h
1 #ifndef BLOCK_H
2 #define BLOCK_H
3
4 #include "qemu-aio.h"
5 #include "qemu-common.h"
6 #include "qemu-option.h"
7 #include "qobject.h"
8
9 /* block.c */
10 typedef struct BlockDriver BlockDriver;
11
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_RDWR 0x0002
31 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
32 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
33 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
34 #define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
35 #define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
36 #define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
37
38 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)
39
40 #define BDRV_SECTOR_BITS 9
41 #define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
42 #define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
43
44 typedef enum {
45 BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
46 BLOCK_ERR_STOP_ANY
47 } BlockErrorAction;
48
49 typedef enum {
50 BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
51 } BlockMonEventAction;
52
53 void bdrv_mon_event(const BlockDriverState *bdrv,
54 BlockMonEventAction action, int is_read);
55 void bdrv_info_print(Monitor *mon, const QObject *data);
56 void bdrv_info(Monitor *mon, QObject **ret_data);
57 void bdrv_stats_print(Monitor *mon, const QObject *data);
58 void bdrv_info_stats(Monitor *mon, QObject **ret_data);
59
60 void bdrv_init(void);
61 void bdrv_init_with_whitelist(void);
62 BlockDriver *bdrv_find_protocol(const char *filename);
63 BlockDriver *bdrv_find_format(const char *format_name);
64 BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
65 int bdrv_create(BlockDriver *drv, const char* filename,
66 QEMUOptionParameter *options);
67 int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
68 BlockDriverState *bdrv_new(const char *device_name);
69 void bdrv_make_anon(BlockDriverState *bs);
70 void bdrv_delete(BlockDriverState *bs);
71 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
72 int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
73 BlockDriver *drv);
74 void bdrv_close(BlockDriverState *bs);
75 int bdrv_attach(BlockDriverState *bs, DeviceState *qdev);
76 void bdrv_detach(BlockDriverState *bs, DeviceState *qdev);
77 DeviceState *bdrv_get_attached(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_pwrite_sync(BlockDriverState *bs, int64_t offset,
87 const void *buf, int count);
88 int bdrv_write_sync(BlockDriverState *bs, int64_t sector_num,
89 const uint8_t *buf, int nb_sectors);
90 int bdrv_truncate(BlockDriverState *bs, int64_t offset);
91 int64_t bdrv_getlength(BlockDriverState *bs);
92 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
93 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
94 int bdrv_commit(BlockDriverState *bs);
95 void bdrv_commit_all(void);
96 int bdrv_change_backing_file(BlockDriverState *bs,
97 const char *backing_file, const char *backing_fmt);
98 void bdrv_register(BlockDriver *bdrv);
99
100
101 typedef struct BdrvCheckResult {
102 int corruptions;
103 int leaks;
104 int check_errors;
105 } BdrvCheckResult;
106
107 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);
108
109 /* async block I/O */
110 typedef struct BlockDriverAIOCB BlockDriverAIOCB;
111 typedef void BlockDriverCompletionFunc(void *opaque, int ret);
112 typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
113 int sector_num);
114 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
115 QEMUIOVector *iov, int nb_sectors,
116 BlockDriverCompletionFunc *cb, void *opaque);
117 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
118 QEMUIOVector *iov, int nb_sectors,
119 BlockDriverCompletionFunc *cb, void *opaque);
120 BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
121 BlockDriverCompletionFunc *cb, void *opaque);
122 void bdrv_aio_cancel(BlockDriverAIOCB *acb);
123
124 typedef struct BlockRequest {
125 /* Fields to be filled by multiwrite caller */
126 int64_t sector;
127 int nb_sectors;
128 QEMUIOVector *qiov;
129 BlockDriverCompletionFunc *cb;
130 void *opaque;
131
132 /* Filled by multiwrite implementation */
133 int error;
134 } BlockRequest;
135
136 int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
137 int num_reqs);
138
139 /* sg packet commands */
140 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
141 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
142 unsigned long int req, void *buf,
143 BlockDriverCompletionFunc *cb, void *opaque);
144
145 /* Ensure contents are flushed to disk. */
146 int bdrv_flush(BlockDriverState *bs);
147 void bdrv_flush_all(void);
148 void bdrv_close_all(void);
149
150 int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
151 int bdrv_has_zero_init(BlockDriverState *bs);
152 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
153 int *pnum);
154
155 #define BIOS_ATA_TRANSLATION_AUTO 0
156 #define BIOS_ATA_TRANSLATION_NONE 1
157 #define BIOS_ATA_TRANSLATION_LBA 2
158 #define BIOS_ATA_TRANSLATION_LARGE 3
159 #define BIOS_ATA_TRANSLATION_RECHS 4
160
161 void bdrv_set_geometry_hint(BlockDriverState *bs,
162 int cyls, int heads, int secs);
163 void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
164 void bdrv_get_geometry_hint(BlockDriverState *bs,
165 int *pcyls, int *pheads, int *psecs);
166 typedef enum FDriveType {
167 FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */
168 FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */
169 FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */
170 FDRIVE_DRV_NONE = 0x03, /* No drive connected */
171 } FDriveType;
172
173 void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
174 int *max_track, int *last_sect,
175 FDriveType drive_in, FDriveType *drive);
176 int bdrv_get_translation_hint(BlockDriverState *bs);
177 void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
178 BlockErrorAction on_write_error);
179 BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
180 void bdrv_set_removable(BlockDriverState *bs, int removable);
181 int bdrv_is_removable(BlockDriverState *bs);
182 int bdrv_is_read_only(BlockDriverState *bs);
183 int bdrv_is_sg(BlockDriverState *bs);
184 int bdrv_enable_write_cache(BlockDriverState *bs);
185 int bdrv_is_inserted(BlockDriverState *bs);
186 int bdrv_media_changed(BlockDriverState *bs);
187 int bdrv_is_locked(BlockDriverState *bs);
188 void bdrv_set_locked(BlockDriverState *bs, int locked);
189 int bdrv_eject(BlockDriverState *bs, int eject_flag);
190 void bdrv_set_change_cb(BlockDriverState *bs,
191 void (*change_cb)(void *opaque, int reason),
192 void *opaque);
193 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
194 BlockDriverState *bdrv_find(const char *name);
195 BlockDriverState *bdrv_next(BlockDriverState *bs);
196 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
197 void *opaque);
198 int bdrv_is_encrypted(BlockDriverState *bs);
199 int bdrv_key_required(BlockDriverState *bs);
200 int bdrv_set_key(BlockDriverState *bs, const char *key);
201 int bdrv_query_missing_keys(void);
202 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
203 void *opaque);
204 const char *bdrv_get_device_name(BlockDriverState *bs);
205 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
206 const uint8_t *buf, int nb_sectors);
207 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
208
209 const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
210 void bdrv_get_backing_filename(BlockDriverState *bs,
211 char *filename, int filename_size);
212 int bdrv_can_snapshot(BlockDriverState *bs);
213 int bdrv_is_snapshot(BlockDriverState *bs);
214 BlockDriverState *bdrv_snapshots(void);
215 int bdrv_snapshot_create(BlockDriverState *bs,
216 QEMUSnapshotInfo *sn_info);
217 int bdrv_snapshot_goto(BlockDriverState *bs,
218 const char *snapshot_id);
219 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
220 int bdrv_snapshot_list(BlockDriverState *bs,
221 QEMUSnapshotInfo **psn_info);
222 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
223 const char *snapshot_name);
224 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
225
226 char *get_human_readable_size(char *buf, int buf_size, int64_t size);
227 int path_is_absolute(const char *path);
228 void path_combine(char *dest, int dest_size,
229 const char *base_path,
230 const char *filename);
231
232 int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
233 int64_t pos, int size);
234
235 int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
236 int64_t pos, int size);
237
238 int bdrv_img_create(const char *filename, const char *fmt,
239 const char *base_filename, const char *base_fmt,
240 char *options, uint64_t img_size, int flags);
241
242 #define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
243
244 void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
245 int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
246 void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
247 int nr_sectors);
248 int64_t bdrv_get_dirty_count(BlockDriverState *bs);
249
250 void bdrv_set_in_use(BlockDriverState *bs, int in_use);
251 int bdrv_in_use(BlockDriverState *bs);
252
253 typedef enum {
254 BLKDBG_L1_UPDATE,
255
256 BLKDBG_L1_GROW_ALLOC_TABLE,
257 BLKDBG_L1_GROW_WRITE_TABLE,
258 BLKDBG_L1_GROW_ACTIVATE_TABLE,
259
260 BLKDBG_L2_LOAD,
261 BLKDBG_L2_UPDATE,
262 BLKDBG_L2_UPDATE_COMPRESSED,
263 BLKDBG_L2_ALLOC_COW_READ,
264 BLKDBG_L2_ALLOC_WRITE,
265
266 BLKDBG_READ,
267 BLKDBG_READ_AIO,
268 BLKDBG_READ_BACKING,
269 BLKDBG_READ_BACKING_AIO,
270 BLKDBG_READ_COMPRESSED,
271
272 BLKDBG_WRITE_AIO,
273 BLKDBG_WRITE_COMPRESSED,
274
275 BLKDBG_VMSTATE_LOAD,
276 BLKDBG_VMSTATE_SAVE,
277
278 BLKDBG_COW_READ,
279 BLKDBG_COW_WRITE,
280
281 BLKDBG_REFTABLE_LOAD,
282 BLKDBG_REFTABLE_GROW,
283
284 BLKDBG_REFBLOCK_LOAD,
285 BLKDBG_REFBLOCK_UPDATE,
286 BLKDBG_REFBLOCK_UPDATE_PART,
287 BLKDBG_REFBLOCK_ALLOC,
288 BLKDBG_REFBLOCK_ALLOC_HOOKUP,
289 BLKDBG_REFBLOCK_ALLOC_WRITE,
290 BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
291 BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
292 BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
293
294 BLKDBG_CLUSTER_ALLOC,
295 BLKDBG_CLUSTER_ALLOC_BYTES,
296 BLKDBG_CLUSTER_FREE,
297
298 BLKDBG_EVENT_MAX,
299 } BlkDebugEvent;
300
301 #define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
302 void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
303
304 #endif