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